da4b7ec84138047591c04b3152841d81a4681269
[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.86"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2015
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" "deferred deliveries"
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"&.
1989 Exim used to
1990 have a compile option for including A6 record support but this has now been
1991 withdrawn.
1992
1993
1994
1995 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1996 .cindex "lookup modules"
1997 .cindex "dynamic modules"
1998 .cindex ".so building"
1999 On some platforms, Exim supports not compiling all lookup types directly into
2000 the main binary, instead putting some into external modules which can be loaded
2001 on demand.
2002 This permits packagers to build Exim with support for lookups with extensive
2003 library dependencies without requiring all users to install all of those
2004 dependencies.
2005 Most, but not all, lookup types can be built this way.
2006
2007 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2008 installed; Exim will only load modules from that directory, as a security
2009 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2010 for your OS; see &_OS/Makefile-Linux_& for an example.
2011 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2012 see &_src/EDITME_& for details.
2013
2014 Then, for each module to be loaded dynamically, define the relevant
2015 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2016 For example, this will build in lsearch but load sqlite and mysql support
2017 on demand:
2018 .code
2019 LOOKUP_LSEARCH=yes
2020 LOOKUP_SQLITE=2
2021 LOOKUP_MYSQL=2
2022 .endd
2023
2024
2025 .section "The building process" "SECID29"
2026 .cindex "build directory"
2027 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2028 created, run &'make'& at the top level. It determines the architecture and
2029 operating system types, and creates a build directory if one does not exist.
2030 For example, on a Sun system running Solaris 8, the directory
2031 &_build-SunOS5-5.8-sparc_& is created.
2032 .cindex "symbolic link" "to source files"
2033 Symbolic links to relevant source files are installed in the build directory.
2034
2035 If this is the first time &'make'& has been run, it calls a script that builds
2036 a make file inside the build directory, using the configuration files from the
2037 &_Local_& directory. The new make file is then passed to another instance of
2038 &'make'&. This does the real work, building a number of utility scripts, and
2039 then compiling and linking the binaries for the Exim monitor (if configured), a
2040 number of utility programs, and finally Exim itself. The command &`make
2041 makefile`& can be used to force a rebuild of the make file in the build
2042 directory, should this ever be necessary.
2043
2044 If you have problems building Exim, check for any comments there may be in the
2045 &_README_& file concerning your operating system, and also take a look at the
2046 FAQ, where some common problems are covered.
2047
2048
2049
2050 .section 'Output from &"make"&' "SECID283"
2051 The output produced by the &'make'& process for compile lines is often very
2052 unreadable, because these lines can be very long. For this reason, the normal
2053 output is suppressed by default, and instead output similar to that which
2054 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2055 each module that is being compiled or linked. However, it is still possible to
2056 get the full output, by calling &'make'& like this:
2057 .code
2058 FULLECHO='' make -e
2059 .endd
2060 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2061 command reflection in &'make'&. When you ask for the full output, it is
2062 given in addition to the short output.
2063
2064
2065
2066 .section "Overriding build-time options for Exim" "SECToverride"
2067 .cindex "build-time options, overriding"
2068 The main make file that is created at the beginning of the building process
2069 consists of the concatenation of a number of files which set configuration
2070 values, followed by a fixed set of &'make'& instructions. If a value is set
2071 more than once, the last setting overrides any previous ones. This provides a
2072 convenient way of overriding defaults. The files that are concatenated are, in
2073 order:
2074 .display
2075 &_OS/Makefile-Default_&
2076 &_OS/Makefile-_&<&'ostype'&>
2077 &_Local/Makefile_&
2078 &_Local/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile-_&<&'archtype'&>
2080 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2081 &_OS/Makefile-Base_&
2082 .endd
2083 .cindex "&_Local/Makefile_&"
2084 .cindex "building Exim" "operating system type"
2085 .cindex "building Exim" "architecture type"
2086 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2087 architecture type. &_Local/Makefile_& is required to exist, and the building
2088 process fails if it is absent. The other three &_Local_& files are optional,
2089 and are often not needed.
2090
2091 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2092 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2093 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2094 values are used, thereby providing a means of forcing particular settings.
2095 Otherwise, the scripts try to get values from the &%uname%& command. If this
2096 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2097 of &'ad hoc'& transformations are then applied, to produce the standard names
2098 that Exim expects. You can run these scripts directly from the shell in order
2099 to find out what values are being used on your system.
2100
2101
2102 &_OS/Makefile-Default_& contains comments about the variables that are set
2103 therein. Some (but not all) are mentioned below. If there is something that
2104 needs changing, review the contents of this file and the contents of the make
2105 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2106 default values are.
2107
2108
2109 .cindex "building Exim" "overriding default settings"
2110 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2111 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2112 need to change the original files. Instead, you should make the changes by
2113 putting the new values in an appropriate &_Local_& file. For example,
2114 .cindex "Tru64-Unix build-time settings"
2115 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2116 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2117 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2118 called with the option &%-std1%&, to make it recognize some of the features of
2119 Standard C that Exim uses. (Most other compilers recognize Standard C by
2120 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2121 containing the lines
2122 .code
2123 CC=cc
2124 CFLAGS=-std1
2125 .endd
2126 If you are compiling for just one operating system, it may be easier to put
2127 these lines directly into &_Local/Makefile_&.
2128
2129 Keeping all your local configuration settings separate from the distributed
2130 files makes it easy to transfer them to new versions of Exim simply by copying
2131 the contents of the &_Local_& directory.
2132
2133
2134 .cindex "NIS lookup type" "including support for"
2135 .cindex "NIS+ lookup type" "including support for"
2136 .cindex "LDAP" "including support for"
2137 .cindex "lookup" "inclusion in binary"
2138 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2139 lookup, but not all systems have these components installed, so the default is
2140 not to include the relevant code in the binary. All the different kinds of file
2141 and database lookup that Exim supports are implemented as separate code modules
2142 which are included only if the relevant compile-time options are set. In the
2143 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2144 .code
2145 LOOKUP_LDAP=yes
2146 LOOKUP_NIS=yes
2147 LOOKUP_NISPLUS=yes
2148 .endd
2149 and similar settings apply to the other lookup types. They are all listed in
2150 &_src/EDITME_&. In many cases the relevant include files and interface
2151 libraries need to be installed before compiling Exim.
2152 .cindex "cdb" "including support for"
2153 However, there are some optional lookup types (such as cdb) for which
2154 the code is entirely contained within Exim, and no external include
2155 files or libraries are required. When a lookup type is not included in the
2156 binary, attempts to configure Exim to use it cause run time configuration
2157 errors.
2158
2159 .cindex "pkg-config" "lookups"
2160 .cindex "pkg-config" "authenticators"
2161 Many systems now use a tool called &'pkg-config'& to encapsulate information
2162 about how to compile against a library; Exim has some initial support for
2163 being able to use pkg-config for lookups and authenticators.  For any given
2164 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2165 variable with the &`_PC`& suffix in the name and assign as the value the
2166 name of the package to be queried.  The results of querying via the
2167 &'pkg-config'& command will be added to the appropriate Makefile variables
2168 with &`+=`& directives, so your version of &'make'& will need to support that
2169 syntax.  For instance:
2170 .code
2171 LOOKUP_SQLITE=yes
2172 LOOKUP_SQLITE_PC=sqlite3
2173 AUTH_GSASL=yes
2174 AUTH_GSASL_PC=libgsasl
2175 AUTH_HEIMDAL_GSSAPI=yes
2176 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2177 .endd
2178
2179 .cindex "Perl" "including support for"
2180 Exim can be linked with an embedded Perl interpreter, allowing Perl
2181 subroutines to be called during string expansion. To enable this facility,
2182 .code
2183 EXIM_PERL=perl.o
2184 .endd
2185 must be defined in &_Local/Makefile_&. Details of this facility are given in
2186 chapter &<<CHAPperl>>&.
2187
2188 .cindex "X11 libraries, location of"
2189 The location of the X11 libraries is something that varies a lot between
2190 operating systems, and there may be different versions of X11 to cope
2191 with. Exim itself makes no use of X11, but if you are compiling the Exim
2192 monitor, the X11 libraries must be available.
2193 The following three variables are set in &_OS/Makefile-Default_&:
2194 .code
2195 X11=/usr/X11R6
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib
2198 .endd
2199 These are overridden in some of the operating-system configuration files. For
2200 example, in &_OS/Makefile-SunOS5_& there is
2201 .code
2202 X11=/usr/openwin
2203 XINCLUDE=-I$(X11)/include
2204 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2205 .endd
2206 If you need to override the default setting for your operating system, place a
2207 definition of all three of these variables into your
2208 &_Local/Makefile-<ostype>_& file.
2209
2210 .cindex "EXTRALIBS"
2211 If you need to add any extra libraries to the link steps, these can be put in a
2212 variable called EXTRALIBS, which appears in all the link commands, but by
2213 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2214 command for linking the main Exim binary, and not for any associated utilities.
2215
2216 .cindex "DBM libraries" "configuration for building"
2217 There is also DBMLIB, which appears in the link commands for binaries that
2218 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2219 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2220 binary, and which can be used, for example, to include additional X11
2221 libraries.
2222
2223 .cindex "configuration file" "editing"
2224 The make file copes with rebuilding Exim correctly if any of the configuration
2225 files are edited. However, if an optional configuration file is deleted, it is
2226 necessary to touch the associated non-optional file (that is,
2227 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2228
2229
2230 .section "OS-specific header files" "SECID30"
2231 .cindex "&_os.h_&"
2232 .cindex "building Exim" "OS-specific C header files"
2233 The &_OS_& directory contains a number of files with names of the form
2234 &_os.h-<ostype>_&. These are system-specific C header files that should not
2235 normally need to be changed. There is a list of macro settings that are
2236 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2237 are porting Exim to a new operating system.
2238
2239
2240
2241 .section "Overriding build-time options for the monitor" "SECID31"
2242 .cindex "building Eximon"
2243 A similar process is used for overriding things when building the Exim monitor,
2244 where the files that are involved are
2245 .display
2246 &_OS/eximon.conf-Default_&
2247 &_OS/eximon.conf-_&<&'ostype'&>
2248 &_Local/eximon.conf_&
2249 &_Local/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf-_&<&'archtype'&>
2251 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2252 .endd
2253 .cindex "&_Local/eximon.conf_&"
2254 As with Exim itself, the final three files need not exist, and in this case the
2255 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2256 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2257 variables of the same name, preceded by EXIMON_. For example, setting
2258 EXIMON_LOG_DEPTH in the environment overrides the value of
2259 LOG_DEPTH at run time.
2260 .ecindex IIDbuex
2261
2262
2263 .section "Installing Exim binaries and scripts" "SECID32"
2264 .cindex "installing Exim"
2265 .cindex "BIN_DIRECTORY"
2266 The command &`make install`& runs the &(exim_install)& script with no
2267 arguments. The script copies binaries and utility scripts into the directory
2268 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2269 .cindex "setuid" "installing Exim with"
2270 The install script copies files only if they are newer than the files they are
2271 going to replace. The Exim binary is required to be owned by root and have the
2272 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2273 install`& as root so that it can set up the Exim binary in this way. However, in
2274 some special situations (for example, if a host is doing no local deliveries)
2275 it may be possible to run Exim without making the binary setuid root (see
2276 chapter &<<CHAPsecurity>>& for details).
2277
2278 .cindex "CONFIGURE_FILE"
2279 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2280 in &_Local/Makefile_&. If this names a single file, and the file does not
2281 exist, the default configuration file &_src/configure.default_& is copied there
2282 by the installation script. If a run time configuration file already exists, it
2283 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2284 alternative files, no default is installed.
2285
2286 .cindex "system aliases file"
2287 .cindex "&_/etc/aliases_&"
2288 One change is made to the default configuration file when it is installed: the
2289 default configuration contains a router that references a system aliases file.
2290 The path to this file is set to the value specified by
2291 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2292 If the system aliases file does not exist, the installation script creates it,
2293 and outputs a comment to the user.
2294
2295 The created file contains no aliases, but it does contain comments about the
2296 aliases a site should normally have. Mail aliases have traditionally been
2297 kept in &_/etc/aliases_&. However, some operating systems are now using
2298 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2299 Exim's configuration if necessary.
2300
2301 The default configuration uses the local host's name as the only local domain,
2302 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2303 running as the local user. System aliases and &_.forward_& files in users' home
2304 directories are supported, but no NIS or NIS+ support is configured. Domains
2305 other than the name of the local host are routed using the DNS, with delivery
2306 over SMTP.
2307
2308 It is possible to install Exim for special purposes (such as building a binary
2309 distribution) in a private part of the file system. You can do this by a
2310 command such as
2311 .code
2312 make DESTDIR=/some/directory/ install
2313 .endd
2314 This has the effect of pre-pending the specified directory to all the file
2315 paths, except the name of the system aliases file that appears in the default
2316 configuration. (If a default alias file is created, its name &'is'& modified.)
2317 For backwards compatibility, ROOT is used if DESTDIR is not set,
2318 but this usage is deprecated.
2319
2320 .cindex "installing Exim" "what is not installed"
2321 Running &'make install'& does not copy the Exim 4 conversion script
2322 &'convert4r4'&. You will probably run this only once if you are
2323 upgrading from Exim 3. None of the documentation files in the &_doc_&
2324 directory are copied, except for the info files when you have set
2325 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2326
2327 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2328 to their names. The Exim binary itself, however, is handled differently. It is
2329 installed under a name that includes the version number and the compile number,
2330 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2331 called &_exim_& to point to the binary. If you are updating a previous version
2332 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2333 from the directory (as seen by other processes).
2334
2335 .cindex "installing Exim" "testing the script"
2336 If you want to see what the &'make install'& will do before running it for
2337 real, you can pass the &%-n%& option to the installation script by this
2338 command:
2339 .code
2340 make INSTALL_ARG=-n install
2341 .endd
2342 The contents of the variable INSTALL_ARG are passed to the installation
2343 script. You do not need to be root to run this test. Alternatively, you can run
2344 the installation script directly, but this must be from within the build
2345 directory. For example, from the top-level Exim directory you could use this
2346 command:
2347 .code
2348 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2349 .endd
2350 .cindex "installing Exim" "install script options"
2351 There are two other options that can be supplied to the installation script.
2352
2353 .ilist
2354 &%-no_chown%& bypasses the call to change the owner of the installed binary
2355 to root, and the call to make it a setuid binary.
2356 .next
2357 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2358 installed binary.
2359 .endlist
2360
2361 INSTALL_ARG can be used to pass these options to the script. For example:
2362 .code
2363 make INSTALL_ARG=-no_symlink install
2364 .endd
2365 The installation script can also be given arguments specifying which files are
2366 to be copied. For example, to install just the Exim binary, and nothing else,
2367 without creating the symbolic link, you could use:
2368 .code
2369 make INSTALL_ARG='-no_symlink exim' install
2370 .endd
2371
2372
2373
2374 .section "Installing info documentation" "SECTinsinfdoc"
2375 .cindex "installing Exim" "&'info'& documentation"
2376 Not all systems use the GNU &'info'& system for documentation, and for this
2377 reason, the Texinfo source of Exim's documentation is not included in the main
2378 distribution. Instead it is available separately from the ftp site (see section
2379 &<<SECTavail>>&).
2380
2381 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2382 source of the documentation is found in the source tree, running &`make
2383 install`& automatically builds the info files and installs them.
2384
2385
2386
2387 .section "Setting up the spool directory" "SECID33"
2388 .cindex "spool directory" "creating"
2389 When it starts up, Exim tries to create its spool directory if it does not
2390 exist. The Exim uid and gid are used for the owner and group of the spool
2391 directory. Sub-directories are automatically created in the spool directory as
2392 necessary.
2393
2394
2395
2396
2397 .section "Testing" "SECID34"
2398 .cindex "testing" "installation"
2399 Having installed Exim, you can check that the run time configuration file is
2400 syntactically valid by running the following command, which assumes that the
2401 Exim binary directory is within your PATH environment variable:
2402 .code
2403 exim -bV
2404 .endd
2405 If there are any errors in the configuration file, Exim outputs error messages.
2406 Otherwise it outputs the version number and build date,
2407 the DBM library that is being used, and information about which drivers and
2408 other optional code modules are included in the binary.
2409 Some simple routing tests can be done by using the address testing option. For
2410 example,
2411 .display
2412 &`exim -bt`& <&'local username'&>
2413 .endd
2414 should verify that it recognizes a local mailbox, and
2415 .display
2416 &`exim -bt`& <&'remote address'&>
2417 .endd
2418 a remote one. Then try getting it to deliver mail, both locally and remotely.
2419 This can be done by passing messages directly to Exim, without going through a
2420 user agent. For example:
2421 .code
2422 exim -v postmaster@your.domain.example
2423 From: user@your.domain.example
2424 To: postmaster@your.domain.example
2425 Subject: Testing Exim
2426
2427 This is a test message.
2428 ^D
2429 .endd
2430 The &%-v%& option causes Exim to output some verification of what it is doing.
2431 In this case you should see copies of three log lines, one for the message's
2432 arrival, one for its delivery, and one containing &"Completed"&.
2433
2434 .cindex "delivery" "problems with"
2435 If you encounter problems, look at Exim's log files (&'mainlog'& and
2436 &'paniclog'&) to see if there is any relevant information there. Another source
2437 of information is running Exim with debugging turned on, by specifying the
2438 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2439 with debugging turned on by a command of the form
2440 .display
2441 &`exim -d -M`& <&'exim-message-id'&>
2442 .endd
2443 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2444 produces rather a lot of output, but you can cut this down to specific areas.
2445 For example, if you use &%-d-all+route%& only the debugging information
2446 relevant to routing is included. (See the &%-d%& option in chapter
2447 &<<CHAPcommandline>>& for more details.)
2448
2449 .cindex '&"sticky"& bit'
2450 .cindex "lock files"
2451 One specific problem that has shown up on some sites is the inability to do
2452 local deliveries into a shared mailbox directory, because it does not have the
2453 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2454 writing to a mailbox file, and if it cannot create the lock file, the delivery
2455 is deferred. You can get round this either by setting the &"sticky bit"& on the
2456 directory, or by setting a specific group for local deliveries and allowing
2457 that group to create files in the directory (see the comments above the
2458 &(local_delivery)& transport in the default configuration file). Another
2459 approach is to configure Exim not to use lock files, but just to rely on
2460 &[fcntl()]& locking instead. However, you should do this only if all user
2461 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2462 see chapter &<<CHAPappendfile>>&.
2463
2464 One thing that cannot be tested on a system that is already running an MTA is
2465 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2466 &%-oX%& option can be used to run an Exim daemon that listens on some other
2467 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2468 &'exim_checkaccess'& utility can be used to check out policy controls on
2469 incoming SMTP mail.
2470
2471 Testing a new version on a system that is already running Exim can most easily
2472 be done by building a binary with a different CONFIGURE_FILE setting. From
2473 within the run time configuration, all other file and directory names
2474 that Exim uses can be altered, in order to keep it entirely clear of the
2475 production version.
2476
2477
2478 .section "Replacing another MTA with Exim" "SECID35"
2479 .cindex "replacing another MTA"
2480 Building and installing Exim for the first time does not of itself put it in
2481 general use. The name by which the system's MTA is called by mail user agents
2482 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2483 operating system), and it is necessary to make this name point to the &'exim'&
2484 binary in order to get the user agents to pass messages to Exim. This is
2485 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2486 or &_/usr/lib/sendmail_&
2487 .cindex "symbolic link" "to &'exim'& binary"
2488 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2489 privilege and executable status from the old MTA. It is then necessary to stop
2490 and restart the mailer daemon, if one is running.
2491
2492 .cindex "FreeBSD, MTA indirection"
2493 .cindex "&_/etc/mail/mailer.conf_&"
2494 Some operating systems have introduced alternative ways of switching MTAs. For
2495 example, if you are running FreeBSD, you need to edit the file
2496 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2497 described. A typical example of the contents of this file for running Exim is
2498 as follows:
2499 .code
2500 sendmail            /usr/exim/bin/exim
2501 send-mail           /usr/exim/bin/exim
2502 mailq               /usr/exim/bin/exim -bp
2503 newaliases          /usr/bin/true
2504 .endd
2505 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2506 your Exim installation is &"live"&. Check it by sending a message from your
2507 favourite user agent.
2508
2509 You should consider what to tell your users about the change of MTA. Exim may
2510 have different capabilities to what was previously running, and there are
2511 various operational differences such as the text of messages produced by
2512 command line options and in bounce messages. If you allow your users to make
2513 use of Exim's filtering capabilities, you should make the document entitled
2514 &'Exim's interface to mail filtering'& available to them.
2515
2516
2517
2518 .section "Upgrading Exim" "SECID36"
2519 .cindex "upgrading Exim"
2520 If you are already running Exim on your host, building and installing a new
2521 version automatically makes it available to MUAs, or any other programs that
2522 call the MTA directly. However, if you are running an Exim daemon, you do need
2523 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2524 new binary. You do not need to stop processing mail in order to install a new
2525 version of Exim. The install script does not modify an existing runtime
2526 configuration file.
2527
2528
2529
2530
2531 .section "Stopping the Exim daemon on Solaris" "SECID37"
2532 .cindex "Solaris" "stopping Exim on"
2533 The standard command for stopping the mailer daemon on Solaris is
2534 .code
2535 /etc/init.d/sendmail stop
2536 .endd
2537 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2538 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2539 for the text &"sendmail"&; this is not present because the actual program name
2540 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2541 solution is to replace the line that finds the process id with something like
2542 .code
2543 pid=`cat /var/spool/exim/exim-daemon.pid`
2544 .endd
2545 to obtain the daemon's pid directly from the file that Exim saves it in.
2546
2547 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2548 still be received from local processes, and if automatic delivery is configured
2549 (the normal case), deliveries will still occur.
2550
2551
2552
2553
2554 . ////////////////////////////////////////////////////////////////////////////
2555 . ////////////////////////////////////////////////////////////////////////////
2556
2557 .chapter "The Exim command line" "CHAPcommandline"
2558 .scindex IIDclo1 "command line" "options"
2559 .scindex IIDclo2 "options" "command line"
2560 Exim's command line takes the standard Unix form of a sequence of options,
2561 each starting with a hyphen character, followed by a number of arguments. The
2562 options are compatible with the main options of Sendmail, and there are also
2563 some additional options, some of which are compatible with Smail 3. Certain
2564 combinations of options do not make sense, and provoke an error if used.
2565 The form of the arguments depends on which options are set.
2566
2567
2568 .section "Setting options by program name" "SECID38"
2569 .cindex "&'mailq'&"
2570 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2571 were present before any other options.
2572 The &%-bp%& option requests a listing of the contents of the mail queue on the
2573 standard output.
2574 This feature is for compatibility with some systems that contain a command of
2575 that name in one of the standard libraries, symbolically linked to
2576 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2577
2578 .cindex "&'rsmtp'&"
2579 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2580 were present before any other options, for compatibility with Smail. The
2581 &%-bS%& option is used for reading in a number of messages in batched SMTP
2582 format.
2583
2584 .cindex "&'rmail'&"
2585 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2586 &%-oee%& options were present before any other options, for compatibility with
2587 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2588
2589 .cindex "&'runq'&"
2590 .cindex "queue runner"
2591 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2592 were present before any other options, for compatibility with Smail. The &%-q%&
2593 option causes a single queue runner process to be started.
2594
2595 .cindex "&'newaliases'&"
2596 .cindex "alias file" "building"
2597 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2598 If Exim is called under the name &'newaliases'& it behaves as if the option
2599 &%-bi%& were present before any other options, for compatibility with Sendmail.
2600 This option is used for rebuilding Sendmail's alias file. Exim does not have
2601 the concept of a single alias file, but can be configured to run a given
2602 command if called with the &%-bi%& option.
2603
2604
2605 .section "Trusted and admin users" "SECTtrustedadmin"
2606 Some Exim options are available only to &'trusted users'& and others are
2607 available only to &'admin users'&. In the description below, the phrases &"Exim
2608 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2609 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2610 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2611
2612 .ilist
2613 .cindex "trusted users" "definition of"
2614 .cindex "user" "trusted definition of"
2615 The trusted users are root, the Exim user, any user listed in the
2616 &%trusted_users%& configuration option, and any user whose current group or any
2617 supplementary group is one of those listed in the &%trusted_groups%&
2618 configuration option. Note that the Exim group is not automatically trusted.
2619
2620 .cindex '&"From"& line'
2621 .cindex "envelope sender"
2622 Trusted users are always permitted to use the &%-f%& option or a leading
2623 &"From&~"& line to specify the envelope sender of a message that is passed to
2624 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2625 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2626 users to set envelope senders.
2627
2628 .cindex "&'From:'& header line"
2629 .cindex "&'Sender:'& header line"
2630 For a trusted user, there is never any check on the contents of the &'From:'&
2631 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2632 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2633
2634 Trusted users may also specify a host name, host address, interface address,
2635 protocol name, ident value, and authentication data when submitting a message
2636 locally. Thus, they are able to insert messages into Exim's queue locally that
2637 have the characteristics of messages received from a remote host. Untrusted
2638 users may in some circumstances use &%-f%&, but can never set the other values
2639 that are available to trusted users.
2640 .next
2641 .cindex "user" "admin definition of"
2642 .cindex "admin user" "definition of"
2643 The admin users are root, the Exim user, and any user that is a member of the
2644 Exim group or of any group listed in the &%admin_groups%& configuration option.
2645 The current group does not have to be one of these groups.
2646
2647 Admin users are permitted to list the queue, and to carry out certain
2648 operations on messages, for example, to force delivery failures. It is also
2649 necessary to be an admin user in order to see the full information provided by
2650 the Exim monitor, and full debugging output.
2651
2652 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2653 Exim to attempt delivery of messages on its queue is restricted to admin users.
2654 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2655 option false (that is, specifying &%no_prod_requires_admin%&).
2656
2657 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2658 is restricted to admin users unless &%queue_list_requires_admin%& is set
2659 false.
2660 .endlist
2661
2662
2663 &*Warning*&: If you configure your system so that admin users are able to
2664 edit Exim's configuration file, you are giving those users an easy way of
2665 getting root. There is further discussion of this issue at the start of chapter
2666 &<<CHAPconf>>&.
2667
2668
2669
2670
2671 .section "Command line options" "SECID39"
2672 Exim's command line options are described in alphabetical order below. If none
2673 of the options that specifies a specific action (such as starting the daemon or
2674 a queue runner, or testing an address, or receiving a message in a specific
2675 format, or listing the queue) are present, and there is at least one argument
2676 on the command line, &%-bm%& (accept a local message on the standard input,
2677 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2678 outputs a brief message about itself and exits.
2679
2680 . ////////////////////////////////////////////////////////////////////////////
2681 . Insert a stylized XML comment here, to identify the start of the command line
2682 . options. This is for the benefit of the Perl script that automatically
2683 . creates a man page for the options.
2684 . ////////////////////////////////////////////////////////////////////////////
2685
2686 .literal xml
2687 <!-- === Start of command line options === -->
2688 .literal off
2689
2690
2691 .vlist
2692 .vitem &%--%&
2693 .oindex "--"
2694 .cindex "options" "command line; terminating"
2695 This is a pseudo-option whose only purpose is to terminate the options and
2696 therefore to cause subsequent command line items to be treated as arguments
2697 rather than options, even if they begin with hyphens.
2698
2699 .vitem &%--help%&
2700 .oindex "&%--help%&"
2701 This option causes Exim to output a few sentences stating what it is.
2702 The same output is generated if the Exim binary is called with no options and
2703 no arguments.
2704
2705 .vitem &%--version%&
2706 .oindex "&%--version%&"
2707 This option is an alias for &%-bV%& and causes version information to be
2708 displayed.
2709
2710 .vitem &%-Ac%& &&&
2711        &%-Am%&
2712 .oindex "&%-Ac%&"
2713 .oindex "&%-Am%&"
2714 These options are used by Sendmail for selecting configuration files and are
2715 ignored by Exim.
2716
2717 .vitem &%-B%&<&'type'&>
2718 .oindex "&%-B%&"
2719 .cindex "8-bit characters"
2720 .cindex "Sendmail compatibility" "8-bit characters"
2721 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2722 clean; it ignores this option.
2723
2724 .vitem &%-bd%&
2725 .oindex "&%-bd%&"
2726 .cindex "daemon"
2727 .cindex "SMTP" "listener"
2728 .cindex "queue runner"
2729 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2730 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2731 that the daemon should also initiate periodic queue runs.
2732
2733 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2734 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2735 disconnect from the controlling terminal. When running this way, it can be
2736 stopped by pressing ctrl-C.
2737
2738 By default, Exim listens for incoming connections to the standard SMTP port on
2739 all the host's running interfaces. However, it is possible to listen on other
2740 ports, on multiple ports, and only on specific interfaces. Chapter
2741 &<<CHAPinterfaces>>& contains a description of the options that control this.
2742
2743 When a listening daemon
2744 .cindex "daemon" "process id (pid)"
2745 .cindex "pid (process id)" "of daemon"
2746 is started without the use of &%-oX%& (that is, without overriding the normal
2747 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2748 in Exim's spool directory. This location can be overridden by setting
2749 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2750 running as root.
2751
2752 When &%-oX%& is used on the command line to start a listening daemon, the
2753 process id is not written to the normal pid file path. However, &%-oP%& can be
2754 used to specify a path on the command line if a pid file is required.
2755
2756 The SIGHUP signal
2757 .cindex "SIGHUP"
2758 .cindex "daemon" "restarting"
2759 can be used to cause the daemon to re-execute itself. This should be done
2760 whenever Exim's configuration file, or any file that is incorporated into it by
2761 means of the &%.include%& facility, is changed, and also whenever a new version
2762 of Exim is installed. It is not necessary to do this when other files that are
2763 referenced from the configuration (for example, alias files) are changed,
2764 because these are reread each time they are used.
2765
2766 .vitem &%-bdf%&
2767 .oindex "&%-bdf%&"
2768 This option has the same effect as &%-bd%& except that it never disconnects
2769 from the controlling terminal, even when no debugging is specified.
2770
2771 .vitem &%-be%&
2772 .oindex "&%-be%&"
2773 .cindex "testing" "string expansion"
2774 .cindex "expansion" "testing"
2775 Run Exim in expansion testing mode. Exim discards its root privilege, to
2776 prevent ordinary users from using this mode to read otherwise inaccessible
2777 files. If no arguments are given, Exim runs interactively, prompting for lines
2778 of data. Otherwise, it processes each argument in turn.
2779
2780 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2781 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2782 used without command line arguments. If successful, it uses the &[readline()]&
2783 function, which provides extensive line-editing facilities, for reading the
2784 test data. A line history is supported.
2785
2786 Long expansion expressions can be split over several lines by using backslash
2787 continuations. As in Exim's run time configuration, white space at the start of
2788 continuation lines is ignored. Each argument or data line is passed through the
2789 string expansion mechanism, and the result is output. Variable values from the
2790 configuration file (for example, &$qualify_domain$&) are available, but no
2791 message-specific values (such as &$sender_domain$&) are set, because no message
2792 is being processed (but see &%-bem%& and &%-Mset%&).
2793
2794 &*Note*&: If you use this mechanism to test lookups, and you change the data
2795 files or databases you are using, you must exit and restart Exim before trying
2796 the same lookup again. Otherwise, because each Exim process caches the results
2797 of lookups, you will just get the same result as before.
2798
2799 .vitem &%-bem%&&~<&'filename'&>
2800 .oindex "&%-bem%&"
2801 .cindex "testing" "string expansion"
2802 .cindex "expansion" "testing"
2803 This option operates like &%-be%& except that it must be followed by the name
2804 of a file. For example:
2805 .code
2806 exim -bem /tmp/testmessage
2807 .endd
2808 The file is read as a message (as if receiving a locally-submitted non-SMTP
2809 message) before any of the test expansions are done. Thus, message-specific
2810 variables such as &$message_size$& and &$header_from:$& are available. However,
2811 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2812 recipients are read from the headers in the normal way, and are shown in the
2813 &$recipients$& variable. Note that recipients cannot be given on the command
2814 line, because further arguments are taken as strings to expand (just like
2815 &%-be%&).
2816
2817 .vitem &%-bF%&&~<&'filename'&>
2818 .oindex "&%-bF%&"
2819 .cindex "system filter" "testing"
2820 .cindex "testing" "system filter"
2821 This option is the same as &%-bf%& except that it assumes that the filter being
2822 tested is a system filter. The additional commands that are available only in
2823 system filters are recognized.
2824
2825 .vitem &%-bf%&&~<&'filename'&>
2826 .oindex "&%-bf%&"
2827 .cindex "filter" "testing"
2828 .cindex "testing" "filter file"
2829 .cindex "forward file" "testing"
2830 .cindex "testing" "forward file"
2831 .cindex "Sieve filter" "testing"
2832 This option runs Exim in user filter testing mode; the file is the filter file
2833 to be tested, and a test message must be supplied on the standard input. If
2834 there are no message-dependent tests in the filter, an empty file can be
2835 supplied.
2836
2837 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2838 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2839 filter and a user filter in the same run. For example:
2840 .code
2841 exim -bF /system/filter -bf /user/filter </test/message
2842 .endd
2843 This is helpful when the system filter adds header lines or sets filter
2844 variables that are used by the user filter.
2845
2846 If the test filter file does not begin with one of the special lines
2847 .code
2848 # Exim filter
2849 # Sieve filter
2850 .endd
2851 it is taken to be a normal &_.forward_& file, and is tested for validity under
2852 that interpretation. See sections &<<SECTitenonfilred>>& to
2853 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2854 redirection lists.
2855
2856 The result of an Exim command that uses &%-bf%&, provided no errors are
2857 detected, is a list of the actions that Exim would try to take if presented
2858 with the message for real. More details of filter testing are given in the
2859 separate document entitled &'Exim's interfaces to mail filtering'&.
2860
2861 When testing a filter file,
2862 .cindex "&""From""& line"
2863 .cindex "envelope sender"
2864 .oindex "&%-f%&" "for filter testing"
2865 the envelope sender can be set by the &%-f%& option,
2866 or by a &"From&~"& line at the start of the test message. Various parameters
2867 that would normally be taken from the envelope recipient address of the message
2868 can be set by means of additional command line options (see the next four
2869 options).
2870
2871 .vitem &%-bfd%&&~<&'domain'&>
2872 .oindex "&%-bfd%&"
2873 .vindex "&$qualify_domain$&"
2874 This sets the domain of the recipient address when a filter file is being
2875 tested by means of the &%-bf%& option. The default is the value of
2876 &$qualify_domain$&.
2877
2878 .vitem &%-bfl%&&~<&'local&~part'&>
2879 .oindex "&%-bfl%&"
2880 This sets the local part of the recipient address when a filter file is being
2881 tested by means of the &%-bf%& option. The default is the username of the
2882 process that calls Exim. A local part should be specified with any prefix or
2883 suffix stripped, because that is how it appears to the filter when a message is
2884 actually being delivered.
2885
2886 .vitem &%-bfp%&&~<&'prefix'&>
2887 .oindex "&%-bfp%&"
2888 This sets the prefix of the local part of the recipient address when a filter
2889 file is being tested by means of the &%-bf%& option. The default is an empty
2890 prefix.
2891
2892 .vitem &%-bfs%&&~<&'suffix'&>
2893 .oindex "&%-bfs%&"
2894 This sets the suffix of the local part of the recipient address when a filter
2895 file is being tested by means of the &%-bf%& option. The default is an empty
2896 suffix.
2897
2898 .vitem &%-bh%&&~<&'IP&~address'&>
2899 .oindex "&%-bh%&"
2900 .cindex "testing" "incoming SMTP"
2901 .cindex "SMTP" "testing incoming"
2902 .cindex "testing" "relay control"
2903 .cindex "relaying" "testing configuration"
2904 .cindex "policy control" "testing"
2905 .cindex "debugging" "&%-bh%& option"
2906 This option runs a fake SMTP session as if from the given IP address, using the
2907 standard input and output. The IP address may include a port number at the end,
2908 after a full stop. For example:
2909 .code
2910 exim -bh 10.9.8.7.1234
2911 exim -bh fe80::a00:20ff:fe86:a061.5678
2912 .endd
2913 When an IPv6 address is given, it is converted into canonical form. In the case
2914 of the second example above, the value of &$sender_host_address$& after
2915 conversion to the canonical form is
2916 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2917
2918 Comments as to what is going on are written to the standard error file. These
2919 include lines beginning with &"LOG"& for anything that would have been logged.
2920 This facility is provided for testing configuration options for incoming
2921 messages, to make sure they implement the required policy. For example, you can
2922 test your relay controls using &%-bh%&.
2923
2924 &*Warning 1*&:
2925 .cindex "RFC 1413"
2926 You can test features of the configuration that rely on ident (RFC 1413)
2927 information by using the &%-oMt%& option. However, Exim cannot actually perform
2928 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2929 connection.
2930
2931 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2932 are also skipped when testing using &%-bh%&. If you want these callouts to
2933 occur, use &%-bhc%& instead.
2934
2935 Messages supplied during the testing session are discarded, and nothing is
2936 written to any of the real log files. There may be pauses when DNS (and other)
2937 lookups are taking place, and of course these may time out. The &%-oMi%& option
2938 can be used to specify a specific IP interface and port if this is important,
2939 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2940 session were authenticated.
2941
2942 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2943 output just states whether a given recipient address from a given host is
2944 acceptable or not. See section &<<SECTcheckaccess>>&.
2945
2946 Features such as authentication and encryption, where the client input is not
2947 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2948 specialized SMTP test program such as
2949 &url(http://jetmore.org/john/code/#swaks,swaks).
2950
2951 .vitem &%-bhc%&&~<&'IP&~address'&>
2952 .oindex "&%-bhc%&"
2953 This option operates in the same way as &%-bh%&, except that address
2954 verification callouts are performed if required. This includes consulting and
2955 updating the callout cache database.
2956
2957 .vitem &%-bi%&
2958 .oindex "&%-bi%&"
2959 .cindex "alias file" "building"
2960 .cindex "building alias file"
2961 .cindex "Sendmail compatibility" "&%-bi%& option"
2962 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2963 Exim does not have the concept of a single alias file, and so it cannot mimic
2964 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2965 tend to appear in various scripts such as NIS make files, so the option must be
2966 recognized.
2967
2968 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2969 configuration option is run, under the uid and gid of the caller of Exim. If
2970 the &%-oA%& option is used, its value is passed to the command as an argument.
2971 The command set by &%bi_command%& may not contain arguments. The command can
2972 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2973 if this is required. If the &%bi_command%& option is not set, calling Exim with
2974 &%-bi%& is a no-op.
2975
2976 . // Keep :help first, then the rest in alphabetical order
2977 .vitem &%-bI:help%&
2978 .oindex "&%-bI:help%&"
2979 .cindex "querying exim information"
2980 We shall provide various options starting &`-bI:`& for querying Exim for
2981 information.  The output of many of these will be intended for machine
2982 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2983 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2984 options shall cause Exim to exit after producing the requested output.
2985
2986 .vitem &%-bI:dscp%&
2987 .oindex "&%-bI:dscp%&"
2988 .cindex "DSCP" "values"
2989 This option causes Exim to emit an alphabetically sorted list of all
2990 recognised DSCP names.
2991
2992 .vitem &%-bI:sieve%&
2993 .oindex "&%-bI:sieve%&"
2994 .cindex "Sieve filter" "capabilities"
2995 This option causes Exim to emit an alphabetically sorted list of all supported
2996 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2997 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2998 &`SIEVE`& capability response line.  As the precise list may depend upon
2999 compile-time build options, which this option will adapt to, this is the only
3000 way to guarantee a correct response.
3001
3002 .vitem &%-bm%&
3003 .oindex "&%-bm%&"
3004 .cindex "local message reception"
3005 This option runs an Exim receiving process that accepts an incoming,
3006 locally-generated message on the standard input. The recipients are given as the
3007 command arguments (except when &%-t%& is also present &-- see below). Each
3008 argument can be a comma-separated list of RFC 2822 addresses. This is the
3009 default option for selecting the overall action of an Exim call; it is assumed
3010 if no other conflicting option is present.
3011
3012 If any addresses in the message are unqualified (have no domain), they are
3013 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3014 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3015 suppressing this for special cases.
3016
3017 Policy checks on the contents of local messages can be enforced by means of
3018 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3019
3020 .cindex "return code" "for &%-bm%&"
3021 The return code is zero if the message is successfully accepted. Otherwise, the
3022 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3023
3024 The format
3025 .cindex "message" "format"
3026 .cindex "format" "message"
3027 .cindex "&""From""& line"
3028 .cindex "UUCP" "&""From""& line"
3029 .cindex "Sendmail compatibility" "&""From""& line"
3030 of the message must be as defined in RFC 2822, except that, for
3031 compatibility with Sendmail and Smail, a line in one of the forms
3032 .code
3033 From sender Fri Jan  5 12:55 GMT 1997
3034 From sender Fri, 5 Jan 97 12:55:01
3035 .endd
3036 (with the weekday optional, and possibly with additional text after the date)
3037 is permitted to appear at the start of the message. There appears to be no
3038 authoritative specification of the format of this line. Exim recognizes it by
3039 matching against the regular expression defined by the &%uucp_from_pattern%&
3040 option, which can be changed if necessary.
3041
3042 .oindex "&%-f%&" "overriding &""From""& line"
3043 The specified sender is treated as if it were given as the argument to the
3044 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3045 preference to the address taken from the message. The caller of Exim must be a
3046 trusted user for the sender of a message to be set in this way.
3047
3048 .vitem &%-bmalware%&&~<&'filename'&>
3049 .oindex "&%-bmalware%&"
3050 .cindex "testing", "malware"
3051 .cindex "malware scan test"
3052 This debugging option causes Exim to scan the given file,
3053 using the malware scanning framework.  The option of &%av_scanner%& influences
3054 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3055 the expansion should have defaults which apply to this invocation.  ACLs are
3056 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3057 will never be populated and &%-bmalware%& will fail.
3058
3059 Exim will have changed working directory before resolving the filename, so
3060 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3061 user when it tries to open the file, rather than as the invoking user.
3062 This option requires admin privileges.
3063
3064 The &%-bmalware%& option will not be extended to be more generally useful,
3065 there are better tools for file-scanning.  This option exists to help
3066 administrators verify their Exim and AV scanner configuration.
3067
3068 .vitem &%-bnq%&
3069 .oindex "&%-bnq%&"
3070 .cindex "address qualification, suppressing"
3071 By default, Exim automatically qualifies unqualified addresses (those
3072 without domains) that appear in messages that are submitted locally (that
3073 is, not over TCP/IP). This qualification applies both to addresses in
3074 envelopes, and addresses in header lines. Sender addresses are qualified using
3075 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3076 defaults to the value of &%qualify_domain%&).
3077
3078 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3079 being used to re-submit messages that originally came from remote hosts after
3080 content scanning, you probably do not want to qualify unqualified addresses in
3081 header lines. (Such lines will be present only if you have not enabled a header
3082 syntax check in the appropriate ACL.)
3083
3084 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3085 messages that originate on the local host. When this is used, unqualified
3086 addresses in the envelope provoke errors (causing message rejection) and
3087 unqualified addresses in header lines are left alone.
3088
3089
3090 .vitem &%-bP%&
3091 .oindex "&%-bP%&"
3092 .cindex "configuration options" "extracting"
3093 .cindex "options" "configuration &-- extracting"
3094 If this option is given with no arguments, it causes the values of all Exim's
3095 main configuration options to be written to the standard output. The values
3096 of one or more specific options can be requested by giving their names as
3097 arguments, for example:
3098 .code
3099 exim -bP qualify_domain hold_domains
3100 .endd
3101 .cindex "hiding configuration option values"
3102 .cindex "configuration options" "hiding value of"
3103 .cindex "options" "hiding value of"
3104 However, any option setting that is preceded by the word &"hide"& in the
3105 configuration file is not shown in full, except to an admin user. For other
3106 users, the output is as in this example:
3107 .code
3108 mysql_servers = <value not displayable>
3109 .endd
3110 If &%configure_file%& is given as an argument, the name of the run time
3111 configuration file is output.
3112 If a list of configuration files was supplied, the value that is output here
3113 is the name of the file that was actually used.
3114
3115 .cindex "options" "hiding name of"
3116 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3117 name will not be output.
3118
3119 .cindex "daemon" "process id (pid)"
3120 .cindex "pid (process id)" "of daemon"
3121 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3122 directories where log files and daemon pid files are written are output,
3123 respectively. If these values are unset, log files are written in a
3124 sub-directory of the spool directory called &%log%&, and the pid file is
3125 written directly into the spool directory.
3126
3127 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3128 .code
3129 exim -bP +local_domains
3130 .endd
3131 it searches for a matching named list of any type (domain, host, address, or
3132 local part) and outputs what it finds.
3133
3134 .cindex "options" "router &-- extracting"
3135 .cindex "options" "transport &-- extracting"
3136 .cindex "options" "authenticator &-- extracting"
3137 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3138 followed by the name of an appropriate driver instance, the option settings for
3139 that driver are output. For example:
3140 .code
3141 exim -bP transport local_delivery
3142 .endd
3143 The generic driver options are output first, followed by the driver's private
3144 options. A list of the names of drivers of a particular type can be obtained by
3145 using one of the words &%router_list%&, &%transport_list%&, or
3146 &%authenticator_list%&, and a complete list of all drivers with their option
3147 settings can be obtained by using &%routers%&, &%transports%&, or
3148 &%authenticators%&.
3149
3150 .cindex "options" "macro &-- extracting"
3151 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3152 are available, similarly to the drivers.  Because macros are sometimes used
3153 for storing passwords, this option is restricted.
3154 The output format is one item per line.
3155
3156 .vitem &%-bp%&
3157 .oindex "&%-bp%&"
3158 .cindex "queue" "listing messages on"
3159 .cindex "listing" "messages on the queue"
3160 This option requests a listing of the contents of the mail queue on the
3161 standard output. If the &%-bp%& option is followed by a list of message ids,
3162 just those messages are listed. By default, this option can be used only by an
3163 admin user. However, the &%queue_list_requires_admin%& option can be set false
3164 to allow any user to see the queue.
3165
3166 Each message on the queue is displayed as in the following example:
3167 .code
3168 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3169           red.king@looking-glass.fict.example
3170           <other addresses>
3171 .endd
3172 .cindex "message" "size in queue listing"
3173 .cindex "size" "of message"
3174 The first line contains the length of time the message has been on the queue
3175 (in this case 25 minutes), the size of the message (2.9K), the unique local
3176 identifier for the message, and the message sender, as contained in the
3177 envelope. For bounce messages, the sender address is empty, and appears as
3178 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3179 the default sender address, the user's login name is shown in parentheses
3180 before the sender address.
3181
3182 .cindex "frozen messages" "in queue listing"
3183 If the message is frozen (attempts to deliver it are suspended) then the text
3184 &"*** frozen ***"& is displayed at the end of this line.
3185
3186 The recipients of the message (taken from the envelope, not the headers) are
3187 displayed on subsequent lines. Those addresses to which the message has already
3188 been delivered are marked with the letter D. If an original address gets
3189 expanded into several addresses via an alias or forward file, the original is
3190 displayed with a D only when deliveries for all of its child addresses are
3191 complete.
3192
3193
3194 .vitem &%-bpa%&
3195 .oindex "&%-bpa%&"
3196 This option operates like &%-bp%&, but in addition it shows delivered addresses
3197 that were generated from the original top level address(es) in each message by
3198 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3199 of just &"D"&.
3200
3201
3202 .vitem &%-bpc%&
3203 .oindex "&%-bpc%&"
3204 .cindex "queue" "count of messages on"
3205 This option counts the number of messages on the queue, and writes the total
3206 to the standard output. It is restricted to admin users, unless
3207 &%queue_list_requires_admin%& is set false.
3208
3209
3210 .vitem &%-bpr%&
3211 .oindex "&%-bpr%&"
3212 This option operates like &%-bp%&, but the output is not sorted into
3213 chronological order of message arrival. This can speed it up when there are
3214 lots of messages on the queue, and is particularly useful if the output is
3215 going to be post-processed in a way that doesn't need the sorting.
3216
3217 .vitem &%-bpra%&
3218 .oindex "&%-bpra%&"
3219 This option is a combination of &%-bpr%& and &%-bpa%&.
3220
3221 .vitem &%-bpru%&
3222 .oindex "&%-bpru%&"
3223 This option is a combination of &%-bpr%& and &%-bpu%&.
3224
3225
3226 .vitem &%-bpu%&
3227 .oindex "&%-bpu%&"
3228 This option operates like &%-bp%& but shows only undelivered top-level
3229 addresses for each message displayed. Addresses generated by aliasing or
3230 forwarding are not shown, unless the message was deferred after processing by a
3231 router with the &%one_time%& option set.
3232
3233
3234 .vitem &%-brt%&
3235 .oindex "&%-brt%&"
3236 .cindex "testing" "retry configuration"
3237 .cindex "retry" "configuration testing"
3238 This option is for testing retry rules, and it must be followed by up to three
3239 arguments. It causes Exim to look for a retry rule that matches the values
3240 and to write it to the standard output. For example:
3241 .code
3242 exim -brt bach.comp.mus.example
3243 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3244 .endd
3245 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3246 argument, which is required, can be a complete address in the form
3247 &'local_part@domain'&, or it can be just a domain name. If the second argument
3248 contains a dot, it is interpreted as an optional second domain name; if no
3249 retry rule is found for the first argument, the second is tried. This ties in
3250 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3251 rule is found that matches the host, one that matches the mail domain is
3252 sought. Finally, an argument that is the name of a specific delivery error, as
3253 used in setting up retry rules, can be given. For example:
3254 .code
3255 exim -brt haydn.comp.mus.example quota_3d
3256 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3257 .endd
3258
3259 .vitem &%-brw%&
3260 .oindex "&%-brw%&"
3261 .cindex "testing" "rewriting"
3262 .cindex "rewriting" "testing"
3263 This option is for testing address rewriting rules, and it must be followed by
3264 a single argument, consisting of either a local part without a domain, or a
3265 complete address with a fully qualified domain. Exim outputs how this address
3266 would be rewritten for each possible place it might appear. See chapter
3267 &<<CHAPrewrite>>& for further details.
3268
3269 .vitem &%-bS%&
3270 .oindex "&%-bS%&"
3271 .cindex "SMTP" "batched incoming"
3272 .cindex "batched SMTP input"
3273 This option is used for batched SMTP input, which is an alternative interface
3274 for non-interactive local message submission. A number of messages can be
3275 submitted in a single run. However, despite its name, this is not really SMTP
3276 input. Exim reads each message's envelope from SMTP commands on the standard
3277 input, but generates no responses. If the caller is trusted, or
3278 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3279 believed; otherwise the sender is always the caller of Exim.
3280
3281 The message itself is read from the standard input, in SMTP format (leading
3282 dots doubled), terminated by a line containing just a single dot. An error is
3283 provoked if the terminating dot is missing. A further message may then follow.
3284
3285 As for other local message submissions, the contents of incoming batch SMTP
3286 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3287 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3288 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3289
3290 Some other SMTP commands are recognized in the input. HELO and EHLO act
3291 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3292 QUIT quits, ignoring the rest of the standard input.
3293
3294 .cindex "return code" "for &%-bS%&"
3295 If any error is encountered, reports are written to the standard output and
3296 error streams, and Exim gives up immediately. The return code is 0 if no error
3297 was detected; it is 1 if one or more messages were accepted before the error
3298 was detected; otherwise it is 2.
3299
3300 More details of input using batched SMTP are given in section
3301 &<<SECTincomingbatchedSMTP>>&.
3302
3303 .vitem &%-bs%&
3304 .oindex "&%-bs%&"
3305 .cindex "SMTP" "local input"
3306 .cindex "local SMTP input"
3307 This option causes Exim to accept one or more messages by reading SMTP commands
3308 on the standard input, and producing SMTP replies on the standard output. SMTP
3309 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3310 Some user agents use this interface as a way of passing locally-generated
3311 messages to the MTA.
3312
3313 In
3314 .cindex "sender" "source of"
3315 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3316 set, the senders of messages are taken from the SMTP MAIL commands.
3317 Otherwise the content of these commands is ignored and the sender is set up as
3318 the calling user. Unqualified addresses are automatically qualified using
3319 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3320 &%-bnq%& option is used.
3321
3322 .cindex "inetd"
3323 The
3324 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3325 using a listening daemon. Exim can distinguish the two cases by checking
3326 whether the standard input is a TCP/IP socket. When Exim is called from
3327 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3328 above concerning senders and qualification do not apply. In this situation,
3329 Exim behaves in exactly the same way as it does when receiving a message via
3330 the listening daemon.
3331
3332 .vitem &%-bt%&
3333 .oindex "&%-bt%&"
3334 .cindex "testing" "addresses"
3335 .cindex "address" "testing"
3336 This option runs Exim in address testing mode, in which each argument is taken
3337 as a recipient address to be tested for deliverability. The results are
3338 written to the standard output. If a test fails, and the caller is not an admin
3339 user, no details of the failure are output, because these might contain
3340 sensitive information such as usernames and passwords for database lookups.
3341
3342 If no arguments are given, Exim runs in an interactive manner, prompting with a
3343 right angle bracket for addresses to be tested.
3344
3345 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3346 &[readline()]& function, because it is running as &'root'& and there are
3347 security issues.
3348
3349 Each address is handled as if it were the recipient address of a message
3350 (compare the &%-bv%& option). It is passed to the routers and the result is
3351 written to the standard output. However, any router that has
3352 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3353 genuine routing tests if your first router passes everything to a scanner
3354 program.
3355
3356 .cindex "return code" "for &%-bt%&"
3357 The return code is 2 if any address failed outright; it is 1 if no address
3358 failed outright but at least one could not be resolved for some reason. Return
3359 code 0 is given only when all addresses succeed.
3360
3361 .cindex "duplicate addresses"
3362 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3363 addresses after routing is complete, so that only one delivery takes place.
3364 This does not happen when testing with &%-bt%&; the full results of routing are
3365 always shown.
3366
3367 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3368 routers in the configuration makes any tests on the sender address of a
3369 message,
3370 .oindex "&%-f%&" "for address testing"
3371 you can use the &%-f%& option to set an appropriate sender when running
3372 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3373 default qualifying domain. However, if you have set up (for example) routers
3374 whose behaviour depends on the contents of an incoming message, you cannot test
3375 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3376 doing such tests.
3377
3378 .vitem &%-bV%&
3379 .oindex "&%-bV%&"
3380 .cindex "version number of Exim"
3381 This option causes Exim to write the current version number, compilation
3382 number, and compilation date of the &'exim'& binary to the standard output.
3383 It also lists the DBM library that is being used, the optional modules (such as
3384 specific lookup types), the drivers that are included in the binary, and the
3385 name of the run time configuration file that is in use.
3386
3387 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3388 configuration file. However, this is a static check only. It cannot check
3389 values that are to be expanded. For example, although a misspelt ACL verb is
3390 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3391 alone to discover (for example) all the typos in the configuration; some
3392 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3393 dynamic testing facilities.
3394
3395 .vitem &%-bv%&
3396 .oindex "&%-bv%&"
3397 .cindex "verifying address" "using &%-bv%&"
3398 .cindex "address" "verification"
3399 This option runs Exim in address verification mode, in which each argument is
3400 taken as a recipient address to be verified by the routers. (This does
3401 not involve any verification callouts). During normal operation, verification
3402 happens mostly as a consequence processing a &%verify%& condition in an ACL
3403 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3404 including callouts, see the &%-bh%& and &%-bhc%& options.
3405
3406 If verification fails, and the caller is not an admin user, no details of the
3407 failure are output, because these might contain sensitive information such as
3408 usernames and passwords for database lookups.
3409
3410 If no arguments are given, Exim runs in an interactive manner, prompting with a
3411 right angle bracket for addresses to be verified.
3412
3413 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3414 &[readline()]& function, because it is running as &'exim'& and there are
3415 security issues.
3416
3417 Verification differs from address testing (the &%-bt%& option) in that routers
3418 that have &%no_verify%& set are skipped, and if the address is accepted by a
3419 router that has &%fail_verify%& set, verification fails. The address is
3420 verified as a recipient if &%-bv%& is used; to test verification for a sender
3421 address, &%-bvs%& should be used.
3422
3423 If the &%-v%& option is not set, the output consists of a single line for each
3424 address, stating whether it was verified or not, and giving a reason in the
3425 latter case. Without &%-v%&, generating more than one address by redirection
3426 causes verification to end successfully, without considering the generated
3427 addresses. However, if just one address is generated, processing continues,
3428 and the generated address must verify successfully for the overall verification
3429 to succeed.
3430
3431 When &%-v%& is set, more details are given of how the address has been handled,
3432 and in the case of address redirection, all the generated addresses are also
3433 considered. Verification may succeed for some and fail for others.
3434
3435 The
3436 .cindex "return code" "for &%-bv%&"
3437 return code is 2 if any address failed outright; it is 1 if no address
3438 failed outright but at least one could not be resolved for some reason. Return
3439 code 0 is given only when all addresses succeed.
3440
3441 If any of the routers in the configuration makes any tests on the sender
3442 address of a message, you should use the &%-f%& option to set an appropriate
3443 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3444 calling user at the default qualifying domain.
3445
3446 .vitem &%-bvs%&
3447 .oindex "&%-bvs%&"
3448 This option acts like &%-bv%&, but verifies the address as a sender rather
3449 than a recipient address. This affects any rewriting and qualification that
3450 might happen.
3451
3452 .vitem &%-bw%&
3453 .oindex "&%-bw%&"
3454 .cindex "daemon"
3455 .cindex "inetd"
3456 .cindex "inetd" "wait mode"
3457 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3458 similarly to the &%-bd%& option.  All port specifications on the command-line
3459 and in the configuration file are ignored.  Queue-running may not be specified.
3460
3461 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3462 listening for connections.  This permits the system to start up and have
3463 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3464 each port only when the first connection is received.
3465
3466 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3467 which the daemon will exit, which should cause inetd to listen once more.
3468
3469 .vitem &%-C%&&~<&'filelist'&>
3470 .oindex "&%-C%&"
3471 .cindex "configuration file" "alternate"
3472 .cindex "CONFIGURE_FILE"
3473 .cindex "alternate configuration file"
3474 This option causes Exim to find the run time configuration file from the given
3475 list instead of from the list specified by the CONFIGURE_FILE
3476 compile-time setting. Usually, the list will consist of just a single file
3477 name, but it can be a colon-separated list of names. In this case, the first
3478 file that exists is used. Failure to open an existing file stops Exim from
3479 proceeding any further along the list, and an error is generated.
3480
3481 When this option is used by a caller other than root, and the list is different
3482 from the compiled-in list, Exim gives up its root privilege immediately, and
3483 runs with the real and effective uid and gid set to those of the caller.
3484 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3485 file contains a list of full pathnames, one per line, for configuration files
3486 which are trusted. Root privilege is retained for any configuration file so
3487 listed, as long as the caller is the Exim user (or the user specified in the
3488 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3489 not writeable by inappropriate users or groups.
3490
3491 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3492 configuration using &%-C%& right through message reception and delivery,
3493 even if the caller is root. The reception works, but by that time, Exim is
3494 running as the Exim user, so when it re-executes to regain privilege for the
3495 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3496 test reception and delivery using two separate commands (one to put a message
3497 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3498
3499 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3500 prefix string with which any file named in a &%-C%& command line option
3501 must start. In addition, the file name must not contain the sequence &`/../`&.
3502 However, if the value of the &%-C%& option is identical to the value of
3503 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3504 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3505 unset, any file name can be used with &%-C%&.
3506
3507 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3508 to a directory to which only root has access. This prevents someone who has
3509 broken into the Exim account from running a privileged Exim with an arbitrary
3510 configuration file.
3511
3512 The &%-C%& facility is useful for ensuring that configuration files are
3513 syntactically correct, but cannot be used for test deliveries, unless the
3514 caller is privileged, or unless it is an exotic configuration that does not
3515 require privilege. No check is made on the owner or group of the files
3516 specified by this option.
3517
3518
3519 .vitem &%-D%&<&'macro'&>=<&'value'&>
3520 .oindex "&%-D%&"
3521 .cindex "macro" "setting on command line"
3522 This option can be used to override macro definitions in the configuration file
3523 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3524 unprivileged caller, it causes Exim to give up its root privilege.
3525 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3526 completely disabled, and its use causes an immediate error exit.
3527
3528 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3529 colon-separated list of macros which are considered safe and, if &%-D%& only
3530 supplies macros from this list, and the values are acceptable, then Exim will
3531 not give up root privilege if the caller is root, the Exim run-time user, or
3532 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3533 to be removed in the future.  Acceptable values for the macros satisfy the
3534 regexp: &`^[A-Za-z0-9_/.-]*$`&
3535
3536 The entire option (including equals sign if present) must all be within one
3537 command line item. &%-D%& can be used to set the value of a macro to the empty
3538 string, in which case the equals sign is optional. These two commands are
3539 synonymous:
3540 .code
3541 exim -DABC  ...
3542 exim -DABC= ...
3543 .endd
3544 To include spaces in a macro definition item, quotes must be used. If you use
3545 quotes, spaces are permitted around the macro name and the equals sign. For
3546 example:
3547 .code
3548 exim '-D ABC = something' ...
3549 .endd
3550 &%-D%& may be repeated up to 10 times on a command line.
3551
3552
3553 .vitem &%-d%&<&'debug&~options'&>
3554 .oindex "&%-d%&"
3555 .cindex "debugging" "list of selectors"
3556 .cindex "debugging" "&%-d%& option"
3557 This option causes debugging information to be written to the standard
3558 error stream. It is restricted to admin users because debugging output may show
3559 database queries that contain password information. Also, the details of users'
3560 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3561 writes an error message to the standard error stream and exits with a non-zero
3562 return code.
3563
3564 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3565 standard debugging data is output. This can be reduced, or increased to include
3566 some more rarely needed information, by directly following &%-d%& with a string
3567 made up of names preceded by plus or minus characters. These add or remove sets
3568 of debugging data, respectively. For example, &%-d+filter%& adds filter
3569 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3570 no spaces are allowed in the debug setting. The available debugging categories
3571 are:
3572 .display
3573 &`acl            `& ACL interpretation
3574 &`auth           `& authenticators
3575 &`deliver        `& general delivery logic
3576 &`dns            `& DNS lookups (see also resolver)
3577 &`dnsbl          `& DNS black list (aka RBL) code
3578 &`exec           `& arguments for &[execv()]& calls
3579 &`expand         `& detailed debugging for string expansions
3580 &`filter         `& filter handling
3581 &`hints_lookup   `& hints data lookups
3582 &`host_lookup    `& all types of name-to-IP address handling
3583 &`ident          `& ident lookup
3584 &`interface      `& lists of local interfaces
3585 &`lists          `& matching things in lists
3586 &`load           `& system load checks
3587 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3588                     &<<CHAPlocalscan>>&)
3589 &`lookup         `& general lookup code and all lookups
3590 &`memory         `& memory handling
3591 &`pid            `& add pid to debug output lines
3592 &`process_info   `& setting info for the process log
3593 &`queue_run      `& queue runs
3594 &`receive        `& general message reception logic
3595 &`resolver       `& turn on the DNS resolver's debugging output
3596 &`retry          `& retry handling
3597 &`rewrite        `& address rewriting
3598 &`route          `& address routing
3599 &`timestamp      `& add timestamp to debug output lines
3600 &`tls            `& TLS logic
3601 &`transport      `& transports
3602 &`uid            `& changes of uid/gid and looking up uid/gid
3603 &`verify         `& address verification logic
3604 &`all            `& almost all of the above (see below), and also &%-v%&
3605 .endd
3606 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3607 for &`-all`&. The reason for this is that &`+all`& is something that people
3608 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3609 is included, an awful lot of output that is very rarely of interest is
3610 generated, so it now has to be explicitly requested. However, &`-all`& does
3611 turn everything off.
3612
3613 .cindex "resolver, debugging output"
3614 .cindex "DNS resolver, debugging output"
3615 The &`resolver`& option produces output only if the DNS resolver was compiled
3616 with DEBUG enabled. This is not the case in some operating systems. Also,
3617 unfortunately, debugging output from the DNS resolver is written to stdout
3618 rather than stderr.
3619
3620 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3621 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3622 However, the &`pid`& selector is forced when debugging is turned on for a
3623 daemon, which then passes it on to any re-executed Exims. Exim also
3624 automatically adds the pid to debug lines when several remote deliveries are
3625 run in parallel.
3626
3627 The &`timestamp`& selector causes the current time to be inserted at the start
3628 of all debug output lines. This can be useful when trying to track down delays
3629 in processing.
3630
3631 If the &%debug_print%& option is set in any driver, it produces output whenever
3632 any debugging is selected, or if &%-v%& is used.
3633
3634 .vitem &%-dd%&<&'debug&~options'&>
3635 .oindex "&%-dd%&"
3636 This option behaves exactly like &%-d%& except when used on a command that
3637 starts a daemon process. In that case, debugging is turned off for the
3638 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3639 behaviour of the daemon without creating as much output as full debugging does.
3640
3641 .vitem &%-dropcr%&
3642 .oindex "&%-dropcr%&"
3643 This is an obsolete option that is now a no-op. It used to affect the way Exim
3644 handled CR and LF characters in incoming messages. What happens now is
3645 described in section &<<SECTlineendings>>&.
3646
3647 .vitem &%-E%&
3648 .oindex "&%-E%&"
3649 .cindex "bounce message" "generating"
3650 This option specifies that an incoming message is a locally-generated delivery
3651 failure report. It is used internally by Exim when handling delivery failures
3652 and is not intended for external use. Its only effect is to stop Exim
3653 generating certain messages to the postmaster, as otherwise message cascades
3654 could occur in some situations. As part of the same option, a message id may
3655 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3656 new message contains the id, following &"R="&, as a cross-reference.
3657
3658 .vitem &%-e%&&'x'&
3659 .oindex "&%-e%&&'x'&"
3660 There are a number of Sendmail options starting with &%-oe%& which seem to be
3661 called by various programs without the leading &%o%& in the option. For
3662 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3663 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3664
3665 .vitem &%-F%&&~<&'string'&>
3666 .oindex "&%-F%&"
3667 .cindex "sender" "name"
3668 .cindex "name" "of sender"
3669 This option sets the sender's full name for use when a locally-generated
3670 message is being accepted. In the absence of this option, the user's &'gecos'&
3671 entry from the password data is used. As users are generally permitted to alter
3672 their &'gecos'& entries, no security considerations are involved. White space
3673 between &%-F%& and the <&'string'&> is optional.
3674
3675 .vitem &%-f%&&~<&'address'&>
3676 .oindex "&%-f%&"
3677 .cindex "sender" "address"
3678 .cindex "address" "sender"
3679 .cindex "trusted users"
3680 .cindex "envelope sender"
3681 .cindex "user" "trusted"
3682 This option sets the address of the envelope sender of a locally-generated
3683 message (also known as the return path). The option can normally be used only
3684 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3685 users to use it.
3686
3687 Processes running as root or the Exim user are always trusted. Other
3688 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3689 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3690 of a local message is set to the caller's login name at the default qualify
3691 domain.
3692
3693 There is one exception to the restriction on the use of &%-f%&: an empty sender
3694 can be specified by any user, trusted or not, to create a message that can
3695 never provoke a bounce. An empty sender can be specified either as an empty
3696 string, or as a pair of angle brackets with nothing between them, as in these
3697 examples of shell commands:
3698 .code
3699 exim -f '<>' user@domain
3700 exim -f "" user@domain
3701 .endd
3702 In addition, the use of &%-f%& is not restricted when testing a filter file
3703 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3704 &%-bv%& options.
3705
3706 Allowing untrusted users to change the sender address does not of itself make
3707 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3708 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3709 though this can be overridden by setting &%no_local_from_check%&.
3710
3711 White
3712 .cindex "&""From""& line"
3713 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3714 given as two arguments or one combined argument). The sender of a
3715 locally-generated message can also be set (when permitted) by an initial
3716 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3717 if &%-f%& is also present, it overrides &"From&~"&.
3718
3719 .vitem &%-G%&
3720 .oindex "&%-G%&"
3721 .cindex "submission fixups, suppressing (command-line)"
3722 This option is equivalent to an ACL applying:
3723 .code
3724 control = suppress_local_fixups
3725 .endd
3726 for every message received.  Note that Sendmail will complain about such
3727 bad formatting, where Exim silently just does not fix it up.  This may change
3728 in future.
3729
3730 As this affects audit information, the caller must be a trusted user to use
3731 this option.
3732
3733 .vitem &%-h%&&~<&'number'&>
3734 .oindex "&%-h%&"
3735 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3736 This option is accepted for compatibility with Sendmail, but has no effect. (In
3737 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3738 headers.)
3739
3740 .vitem &%-i%&
3741 .oindex "&%-i%&"
3742 .cindex "Solaris" "&'mail'& command"
3743 .cindex "dot" "in incoming non-SMTP message"
3744 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3745 line by itself should not terminate an incoming, non-SMTP message. I can find
3746 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3747 command in Solaris 2.4 uses it. See also &%-ti%&.
3748
3749 .vitem &%-L%&&~<&'tag'&>
3750 .oindex "&%-L%&"
3751 .cindex "syslog" "process name; set with flag"
3752 This option is equivalent to setting &%syslog_processname%& in the config
3753 file and setting &%log_file_path%& to &`syslog`&.
3754 Its use is restricted to administrators.  The configuration file has to be
3755 read and parsed, to determine access rights, before this is set and takes
3756 effect, so early configuration file errors will not honour this flag.
3757
3758 The tag should not be longer than 32 characters.
3759
3760 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3761 .oindex "&%-M%&"
3762 .cindex "forcing delivery"
3763 .cindex "delivery" "forcing attempt"
3764 .cindex "frozen messages" "forcing delivery"
3765 This option requests Exim to run a delivery attempt on each message in turn. If
3766 any of the messages are frozen, they are automatically thawed before the
3767 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3768 and &%hold_domains%& are ignored.
3769
3770 Retry
3771 .cindex "hints database" "overriding retry hints"
3772 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3773 the normal retry time has not yet been reached. This option requires the caller
3774 to be an admin user. However, there is an option called &%prod_requires_admin%&
3775 which can be set false to relax this restriction (and also the same requirement
3776 for the &%-q%&, &%-R%&, and &%-S%& options).
3777
3778 The deliveries happen synchronously, that is, the original Exim process does
3779 not terminate until all the delivery attempts have finished. No output is
3780 produced unless there is a serious error. If you want to see what is happening,
3781 use the &%-v%& option as well, or inspect Exim's main log.
3782
3783 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3784 .oindex "&%-Mar%&"
3785 .cindex "message" "adding recipients"
3786 .cindex "recipient" "adding"
3787 This option requests Exim to add the addresses to the list of recipients of the
3788 message (&"ar"& for &"add recipients"&). The first argument must be a message
3789 id, and the remaining ones must be email addresses. However, if the message is
3790 active (in the middle of a delivery attempt), it is not altered. This option
3791 can be used only by an admin user.
3792
3793 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3794         &~<&'message&~id'&>"
3795 .oindex "&%-MC%&"
3796 .cindex "SMTP" "passed connection"
3797 .cindex "SMTP" "multiple deliveries"
3798 .cindex "multiple SMTP deliveries"
3799 This option is not intended for use by external callers. It is used internally
3800 by Exim to invoke another instance of itself to deliver a waiting message using
3801 an existing SMTP connection, which is passed as the standard input. Details are
3802 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3803 must be root or the Exim user in order to use it.
3804
3805 .vitem &%-MCA%&
3806 .oindex "&%-MCA%&"
3807 This option is not intended for use by external callers. It is used internally
3808 by Exim in conjunction with the &%-MC%& option. It signifies that the
3809 connection to the remote host has been authenticated.
3810
3811 .vitem &%-MCD%&
3812 .oindex "&%-MCD%&"
3813 This option is not intended for use by external callers. It is used internally
3814 by Exim in conjunction with the &%-MC%& option. It signifies that the
3815 remote host supports the ESMTP &_DSN_& extension.
3816
3817 .vitem &%-MCP%&
3818 .oindex "&%-MCP%&"
3819 This option is not intended for use by external callers. It is used internally
3820 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3821 which Exim is connected supports pipelining.
3822
3823 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3824 .oindex "&%-MCQ%&"
3825 This option is not intended for use by external callers. It is used internally
3826 by Exim in conjunction with the &%-MC%& option when the original delivery was
3827 started by a queue runner. It passes on the process id of the queue runner,
3828 together with the file descriptor number of an open pipe. Closure of the pipe
3829 signals the final completion of the sequence of processes that are passing
3830 messages through the same SMTP connection.
3831
3832 .vitem &%-MCS%&
3833 .oindex "&%-MCS%&"
3834 This option is not intended for use by external callers. It is used internally
3835 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3836 SMTP SIZE option should be used on messages delivered down the existing
3837 connection.
3838
3839 .vitem &%-MCT%&
3840 .oindex "&%-MCT%&"
3841 This option is not intended for use by external callers. It is used internally
3842 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3843 host to which Exim is connected supports TLS encryption.
3844
3845 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3846 .oindex "&%-Mc%&"
3847 .cindex "hints database" "not overridden by &%-Mc%&"
3848 .cindex "delivery" "manually started &-- not forced"
3849 This option requests Exim to run a delivery attempt on each message in turn,
3850 but unlike the &%-M%& option, it does check for retry hints, and respects any
3851 that are found. This option is not very useful to external callers. It is
3852 provided mainly for internal use by Exim when it needs to re-invoke itself in
3853 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3854 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3855 respects retry times and other options such as &%hold_domains%& that are
3856 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3857 If you want to run a specific delivery as if in a queue run, you should use
3858 &%-q%& with a message id argument. A distinction between queue run deliveries
3859 and other deliveries is made in one or two places.
3860
3861 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3862 .oindex "&%-Mes%&"
3863 .cindex "message" "changing sender"
3864 .cindex "sender" "changing"
3865 This option requests Exim to change the sender address in the message to the
3866 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3867 &"edit sender"&). There must be exactly two arguments. The first argument must
3868 be a message id, and the second one an email address. However, if the message
3869 is active (in the middle of a delivery attempt), its status is not altered.
3870 This option can be used only by an admin user.
3871
3872 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3873 .oindex "&%-Mf%&"
3874 .cindex "freezing messages"
3875 .cindex "message" "manually freezing"
3876 This option requests Exim to mark each listed message as &"frozen"&. This
3877 prevents any delivery attempts taking place until the message is &"thawed"&,
3878 either manually or as a result of the &%auto_thaw%& configuration option.
3879 However, if any of the messages are active (in the middle of a delivery
3880 attempt), their status is not altered. This option can be used only by an admin
3881 user.
3882
3883 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3884 .oindex "&%-Mg%&"
3885 .cindex "giving up on messages"
3886 .cindex "message" "abandoning delivery attempts"
3887 .cindex "delivery" "abandoning further attempts"
3888 This option requests Exim to give up trying to deliver the listed messages,
3889 including any that are frozen. However, if any of the messages are active,
3890 their status is not altered. For non-bounce messages, a delivery error message
3891 is sent to the sender, containing the text &"cancelled by administrator"&.
3892 Bounce messages are just discarded. This option can be used only by an admin
3893 user.
3894
3895 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3896 .oindex "&%-Mmad%&"
3897 .cindex "delivery" "cancelling all"
3898 This option requests Exim to mark all the recipient addresses in the messages
3899 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3900 message is active (in the middle of a delivery attempt), its status is not
3901 altered. This option can be used only by an admin user.
3902
3903 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3904 .oindex "&%-Mmd%&"
3905 .cindex "delivery" "cancelling by address"
3906 .cindex "recipient" "removing"
3907 .cindex "removing recipients"
3908 This option requests Exim to mark the given addresses as already delivered
3909 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3910 the remaining ones must be email addresses. These are matched to recipient
3911 addresses in the message in a case-sensitive manner. If the message is active
3912 (in the middle of a delivery attempt), its status is not altered. This option
3913 can be used only by an admin user.
3914
3915 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3916 .oindex "&%-Mrm%&"
3917 .cindex "removing messages"
3918 .cindex "abandoning mail"
3919 .cindex "message" "manually discarding"
3920 This option requests Exim to remove the given messages from the queue. No
3921 bounce messages are sent; each message is simply forgotten. However, if any of
3922 the messages are active, their status is not altered. This option can be used
3923 only by an admin user or by the user who originally caused the message to be
3924 placed on the queue.
3925
3926 .vitem &%-Mset%&&~<&'message&~id'&>
3927 .oindex "&%-Mset%&
3928 .cindex "testing" "string expansion"
3929 .cindex "expansion" "testing"
3930 This option is useful only in conjunction with &%-be%& (that is, when testing
3931 string expansions). Exim loads the given message from its spool before doing
3932 the test expansions, thus setting message-specific variables such as
3933 &$message_size$& and the header variables. The &$recipients$& variable is made
3934 available. This feature is provided to make it easier to test expansions that
3935 make use of these variables. However, this option can be used only by an admin
3936 user. See also &%-bem%&.
3937
3938 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3939 .oindex "&%-Mt%&"
3940 .cindex "thawing messages"
3941 .cindex "unfreezing messages"
3942 .cindex "frozen messages" "thawing"
3943 .cindex "message" "thawing frozen"
3944 This option requests Exim to &"thaw"& any of the listed messages that are
3945 &"frozen"&, so that delivery attempts can resume. However, if any of the
3946 messages are active, their status is not altered. This option can be used only
3947 by an admin user.
3948
3949 .vitem &%-Mvb%&&~<&'message&~id'&>
3950 .oindex "&%-Mvb%&"
3951 .cindex "listing" "message body"
3952 .cindex "message" "listing body of"
3953 This option causes the contents of the message body (-D) spool file to be
3954 written to the standard output. This option can be used only by an admin user.
3955
3956 .vitem &%-Mvc%&&~<&'message&~id'&>
3957 .oindex "&%-Mvc%&"
3958 .cindex "message" "listing in RFC 2822 format"
3959 .cindex "listing" "message in RFC 2822 format"
3960 This option causes a copy of the complete message (header lines plus body) to
3961 be written to the standard output in RFC 2822 format. This option can be used
3962 only by an admin user.
3963
3964 .vitem &%-Mvh%&&~<&'message&~id'&>
3965 .oindex "&%-Mvh%&"
3966 .cindex "listing" "message headers"
3967 .cindex "header lines" "listing"
3968 .cindex "message" "listing header lines"
3969 This option causes the contents of the message headers (-H) spool file to be
3970 written to the standard output. This option can be used only by an admin user.
3971
3972 .vitem &%-Mvl%&&~<&'message&~id'&>
3973 .oindex "&%-Mvl%&"
3974 .cindex "listing" "message log"
3975 .cindex "message" "listing message log"
3976 This option causes the contents of the message log spool file to be written to
3977 the standard output. This option can be used only by an admin user.
3978
3979 .vitem &%-m%&
3980 .oindex "&%-m%&"
3981 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3982 treats it that way too.
3983
3984 .vitem &%-N%&
3985 .oindex "&%-N%&"
3986 .cindex "debugging" "&%-N%& option"
3987 .cindex "debugging" "suppressing delivery"
3988 This is a debugging option that inhibits delivery of a message at the transport
3989 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3990 it just doesn't actually transport the message, but instead behaves as if it
3991 had successfully done so. However, it does not make any updates to the retry
3992 database, and the log entries for deliveries are flagged with &"*>"& rather
3993 than &"=>"&.
3994
3995 Because &%-N%& discards any message to which it applies, only root or the Exim
3996 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
3997 words, an ordinary user can use it only when supplying an incoming message to
3998 which it will apply. Although transportation never fails when &%-N%& is set, an
3999 address may be deferred because of a configuration problem on a transport, or a
4000 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4001 the message, and applies to any subsequent delivery attempts that may happen
4002 for that message.
4003
4004 .vitem &%-n%&
4005 .oindex "&%-n%&"
4006 This option is interpreted by Sendmail to mean &"no aliasing"&.
4007 For normal modes of operation, it is ignored by Exim.
4008 When combined with &%-bP%& it suppresses the name of an option from being output.
4009
4010 .vitem &%-O%&&~<&'data'&>
4011 .oindex "&%-O%&"
4012 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4013 Exim.
4014
4015 .vitem &%-oA%&&~<&'file&~name'&>
4016 .oindex "&%-oA%&"
4017 .cindex "Sendmail compatibility" "&%-oA%& option"
4018 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4019 alternative alias file name. Exim handles &%-bi%& differently; see the
4020 description above.
4021
4022 .vitem &%-oB%&&~<&'n'&>
4023 .oindex "&%-oB%&"
4024 .cindex "SMTP" "passed connection"
4025 .cindex "SMTP" "multiple deliveries"
4026 .cindex "multiple SMTP deliveries"
4027 This is a debugging option which limits the maximum number of messages that can
4028 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4029 transport. If <&'n'&> is omitted, the limit is set to 1.
4030
4031 .vitem &%-odb%&
4032 .oindex "&%-odb%&"
4033 .cindex "background delivery"
4034 .cindex "delivery" "in the background"
4035 This option applies to all modes in which Exim accepts incoming messages,
4036 including the listening daemon. It requests &"background"& delivery of such
4037 messages, which means that the accepting process automatically starts a
4038 delivery process for each message received, but does not wait for the delivery
4039 processes to finish.
4040
4041 When all the messages have been received, the reception process exits,
4042 leaving the delivery processes to finish in their own time. The standard output
4043 and error streams are closed at the start of each delivery process.
4044 This is the default action if none of the &%-od%& options are present.
4045
4046 If one of the queueing options in the configuration file
4047 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4048 overrides it if &%queue_only_override%& is set true, which is the default
4049 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4050
4051 .vitem &%-odf%&
4052 .oindex "&%-odf%&"
4053 .cindex "foreground delivery"
4054 .cindex "delivery" "in the foreground"
4055 This option requests &"foreground"& (synchronous) delivery when Exim has
4056 accepted a locally-generated message. (For the daemon it is exactly the same as
4057 &%-odb%&.) A delivery process is automatically started to deliver the message,
4058 and Exim waits for it to complete before proceeding.
4059
4060 The original Exim reception process does not finish until the delivery
4061 process for the final message has ended. The standard error stream is left open
4062 during deliveries.
4063
4064 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4065 false and one of the queueing options in the configuration file is in effect.
4066
4067 If there is a temporary delivery error during foreground delivery, the
4068 message is left on the queue for later delivery, and the original reception
4069 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4070 restricted configuration that never queues messages.
4071
4072
4073 .vitem &%-odi%&
4074 .oindex "&%-odi%&"
4075 This option is synonymous with &%-odf%&. It is provided for compatibility with
4076 Sendmail.
4077
4078 .vitem &%-odq%&
4079 .oindex "&%-odq%&"
4080 .cindex "non-immediate delivery"
4081 .cindex "delivery" "suppressing immediate"
4082 .cindex "queueing incoming messages"
4083 This option applies to all modes in which Exim accepts incoming messages,
4084 including the listening daemon. It specifies that the accepting process should
4085 not automatically start a delivery process for each message received. Messages
4086 are placed on the queue, and remain there until a subsequent queue runner
4087 process encounters them. There are several configuration options (such as
4088 &%queue_only%&) that can be used to queue incoming messages under certain
4089 conditions. This option overrides all of them and also &%-odqs%&. It always
4090 forces queueing.
4091
4092 .vitem &%-odqs%&
4093 .oindex "&%-odqs%&"
4094 .cindex "SMTP" "delaying delivery"
4095 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4096 However, like &%-odb%& and &%-odi%&, this option has no effect if
4097 &%queue_only_override%& is false and one of the queueing options in the
4098 configuration file is in effect.
4099
4100 When &%-odqs%& does operate, a delivery process is started for each incoming
4101 message, in the background by default, but in the foreground if &%-odi%& is
4102 also present. The recipient addresses are routed, and local deliveries are done
4103 in the normal way. However, if any SMTP deliveries are required, they are not
4104 done at this time, so the message remains on the queue until a subsequent queue
4105 runner process encounters it. Because routing was done, Exim knows which
4106 messages are waiting for which hosts, and so a number of messages for the same
4107 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4108 configuration option has the same effect for specific domains. See also the
4109 &%-qq%& option.
4110
4111 .vitem &%-oee%&
4112 .oindex "&%-oee%&"
4113 .cindex "error" "reporting"
4114 If an error is detected while a non-SMTP message is being received (for
4115 example, a malformed address), the error is reported to the sender in a mail
4116 message.
4117
4118 .cindex "return code" "for &%-oee%&"
4119 Provided
4120 this error message is successfully sent, the Exim receiving process
4121 exits with a return code of zero. If not, the return code is 2 if the problem
4122 is that the original message has no recipients, or 1 for any other error.
4123 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4124
4125 .vitem &%-oem%&
4126 .oindex "&%-oem%&"
4127 .cindex "error" "reporting"
4128 .cindex "return code" "for &%-oem%&"
4129 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4130 return code, whether or not the error message was successfully sent.
4131 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4132
4133 .vitem &%-oep%&
4134 .oindex "&%-oep%&"
4135 .cindex "error" "reporting"
4136 If an error is detected while a non-SMTP message is being received, the
4137 error is reported by writing a message to the standard error file (stderr).
4138 .cindex "return code" "for &%-oep%&"
4139 The return code is 1 for all errors.
4140
4141 .vitem &%-oeq%&
4142 .oindex "&%-oeq%&"
4143 .cindex "error" "reporting"
4144 This option is supported for compatibility with Sendmail, but has the same
4145 effect as &%-oep%&.
4146
4147 .vitem &%-oew%&
4148 .oindex "&%-oew%&"
4149 .cindex "error" "reporting"
4150 This option is supported for compatibility with Sendmail, but has the same
4151 effect as &%-oem%&.
4152
4153 .vitem &%-oi%&
4154 .oindex "&%-oi%&"
4155 .cindex "dot" "in incoming non-SMTP message"
4156 This option, which has the same effect as &%-i%&, specifies that a dot on a
4157 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4158 single dot does terminate, though Exim does no special processing for other
4159 lines that start with a dot. This option is set by default if Exim is called as
4160 &'rmail'&. See also &%-ti%&.
4161
4162 .vitem &%-oitrue%&
4163 .oindex "&%-oitrue%&"
4164 This option is treated as synonymous with &%-oi%&.
4165
4166 .vitem &%-oMa%&&~<&'host&~address'&>
4167 .oindex "&%-oMa%&"
4168 .cindex "sender" "host address, specifying for local message"
4169 A number of options starting with &%-oM%& can be used to set values associated
4170 with remote hosts on locally-submitted messages (that is, messages not received
4171 over TCP/IP). These options can be used by any caller in conjunction with the
4172 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4173 other circumstances, they are ignored unless the caller is trusted.
4174
4175 The &%-oMa%& option sets the sender host address. This may include a port
4176 number at the end, after a full stop (period). For example:
4177 .code
4178 exim -bs -oMa 10.9.8.7.1234
4179 .endd
4180 An alternative syntax is to enclose the IP address in square brackets,
4181 followed by a colon and the port number:
4182 .code
4183 exim -bs -oMa [10.9.8.7]:1234
4184 .endd
4185 The IP address is placed in the &$sender_host_address$& variable, and the
4186 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4187 are present on the command line, the sender host IP address is taken from
4188 whichever one is last.
4189
4190 .vitem &%-oMaa%&&~<&'name'&>
4191 .oindex "&%-oMaa%&"
4192 .cindex "authentication" "name, specifying for local message"
4193 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4194 option sets the value of &$sender_host_authenticated$& (the authenticator
4195 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4196 This option can be used with &%-bh%& and &%-bs%& to set up an
4197 authenticated SMTP session without actually using the SMTP AUTH command.
4198
4199 .vitem &%-oMai%&&~<&'string'&>
4200 .oindex "&%-oMai%&"
4201 .cindex "authentication" "id, specifying for local message"
4202 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4203 option sets the value of &$authenticated_id$& (the id that was authenticated).
4204 This overrides the default value (the caller's login id, except with &%-bh%&,
4205 where there is no default) for messages from local sources. See chapter
4206 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4207
4208 .vitem &%-oMas%&&~<&'address'&>
4209 .oindex "&%-oMas%&"
4210 .cindex "authentication" "sender, specifying for local message"
4211 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4212 option sets the authenticated sender value in &$authenticated_sender$&. It
4213 overrides the sender address that is created from the caller's login id for
4214 messages from local sources, except when &%-bh%& is used, when there is no
4215 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4216 specified on a MAIL command overrides this value. See chapter
4217 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4218
4219 .vitem &%-oMi%&&~<&'interface&~address'&>
4220 .oindex "&%-oMi%&"
4221 .cindex "interface" "address, specifying for local message"
4222 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4223 option sets the IP interface address value. A port number may be included,
4224 using the same syntax as for &%-oMa%&. The interface address is placed in
4225 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4226
4227 .vitem &%-oMm%&&~<&'message&~reference'&>
4228 .oindex "&%-oMm%&"
4229 .cindex "message reference" "message reference, specifying for local message"
4230 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4231 option sets the message reference, e.g. message-id, and is logged during
4232 delivery. This is useful when some kind of audit trail is required to tie
4233 messages together. The format of the message reference is checked and will
4234 abort if the format is invalid. The option will only be accepted if exim is
4235 running in trusted mode, not as any regular user.
4236
4237 The best example of a message reference is when Exim sends a bounce message.
4238 The message reference is the message-id of the original message for which Exim
4239 is sending the bounce.
4240
4241 .vitem &%-oMr%&&~<&'protocol&~name'&>
4242 .oindex "&%-oMr%&"
4243 .cindex "protocol, specifying for local message"
4244 .vindex "&$received_protocol$&"
4245 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4246 option sets the received protocol value that is stored in
4247 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4248 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4249 SMTP protocol names (see the description of &$received_protocol$& in section
4250 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4251 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4252 be set by &%-oMr%&.
4253
4254 .vitem &%-oMs%&&~<&'host&~name'&>
4255 .oindex "&%-oMs%&"
4256 .cindex "sender" "host name, specifying for local message"
4257 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4258 option sets the sender host name in &$sender_host_name$&. When this option is
4259 present, Exim does not attempt to look up a host name from an IP address; it
4260 uses the name it is given.
4261
4262 .vitem &%-oMt%&&~<&'ident&~string'&>
4263 .oindex "&%-oMt%&"
4264 .cindex "sender" "ident string, specifying for local message"
4265 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4266 option sets the sender ident value in &$sender_ident$&. The default setting for
4267 local callers is the login id of the calling process, except when &%-bh%& is
4268 used, when there is no default.
4269
4270 .vitem &%-om%&
4271 .oindex "&%-om%&"
4272 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4273 In Sendmail, this option means &"me too"&, indicating that the sender of a
4274 message should receive a copy of the message if the sender appears in an alias
4275 expansion. Exim always does this, so the option does nothing.
4276
4277 .vitem &%-oo%&
4278 .oindex "&%-oo%&"
4279 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4280 This option is ignored. In Sendmail it specifies &"old style headers"&,
4281 whatever that means.
4282
4283 .vitem &%-oP%&&~<&'path'&>
4284 .oindex "&%-oP%&"
4285 .cindex "pid (process id)" "of daemon"
4286 .cindex "daemon" "process id (pid)"
4287 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4288 value. The option specifies the file to which the process id of the daemon is
4289 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4290 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4291 because in those cases, the normal pid file is not used.
4292
4293 .vitem &%-or%&&~<&'time'&>
4294 .oindex "&%-or%&"
4295 .cindex "timeout" "for non-SMTP input"
4296 This option sets a timeout value for incoming non-SMTP messages. If it is not
4297 set, Exim will wait forever for the standard input. The value can also be set
4298 by the &%receive_timeout%& option. The format used for specifying times is
4299 described in section &<<SECTtimeformat>>&.
4300
4301 .vitem &%-os%&&~<&'time'&>
4302 .oindex "&%-os%&"
4303 .cindex "timeout" "for SMTP input"
4304 .cindex "SMTP" "input timeout"
4305 This option sets a timeout value for incoming SMTP messages. The timeout
4306 applies to each SMTP command and block of data. The value can also be set by
4307 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4308 for specifying times is described in section &<<SECTtimeformat>>&.
4309
4310 .vitem &%-ov%&
4311 .oindex "&%-ov%&"
4312 This option has exactly the same effect as &%-v%&.
4313
4314 .vitem &%-oX%&&~<&'number&~or&~string'&>
4315 .oindex "&%-oX%&"
4316 .cindex "TCP/IP" "setting listening ports"
4317 .cindex "TCP/IP" "setting listening interfaces"
4318 .cindex "port" "receiving TCP/IP"
4319 This option is relevant only when the &%-bd%& (start listening daemon) option
4320 is also given. It controls which ports and interfaces the daemon uses. Details
4321 of the syntax, and how it interacts with configuration file options, are given
4322 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4323 file is written unless &%-oP%& is also present to specify a pid file name.
4324
4325 .vitem &%-pd%&
4326 .oindex "&%-pd%&"
4327 .cindex "Perl" "starting the interpreter"
4328 This option applies when an embedded Perl interpreter is linked with Exim (see
4329 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4330 option, forcing the starting of the interpreter to be delayed until it is
4331 needed.
4332
4333 .vitem &%-ps%&
4334 .oindex "&%-ps%&"
4335 .cindex "Perl" "starting the interpreter"
4336 This option applies when an embedded Perl interpreter is linked with Exim (see
4337 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4338 option, forcing the starting of the interpreter to occur as soon as Exim is
4339 started.
4340
4341 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4342 .oindex "&%-p%&"
4343 For compatibility with Sendmail, this option is equivalent to
4344 .display
4345 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4346 .endd
4347 It sets the incoming protocol and host name (for trusted callers). The
4348 host name and its colon can be omitted when only the protocol is to be set.
4349 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4350 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4351 or &`s`& using this option (but that does not seem a real limitation).
4352
4353 .vitem &%-q%&
4354 .oindex "&%-q%&"
4355 .cindex "queue runner" "starting manually"
4356 This option is normally restricted to admin users. However, there is a
4357 configuration option called &%prod_requires_admin%& which can be set false to
4358 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4359 and &%-S%& options).
4360
4361 .cindex "queue runner" "description of operation"
4362 The &%-q%& option starts one queue runner process. This scans the queue of
4363 waiting messages, and runs a delivery process for each one in turn. It waits
4364 for each delivery process to finish before starting the next one. A delivery
4365 process may not actually do any deliveries if the retry times for the addresses
4366 have not been reached. Use &%-qf%& (see below) if you want to override this.
4367
4368 If
4369 .cindex "SMTP" "passed connection"
4370 .cindex "SMTP" "multiple deliveries"
4371 .cindex "multiple SMTP deliveries"
4372 the delivery process spawns other processes to deliver other messages down
4373 passed SMTP connections, the queue runner waits for these to finish before
4374 proceeding.
4375
4376 When all the queued messages have been considered, the original queue runner
4377 process terminates. In other words, a single pass is made over the waiting
4378 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4379 this to be repeated periodically.
4380
4381 Exim processes the waiting messages in an unpredictable order. It isn't very
4382 random, but it is likely to be different each time, which is all that matters.
4383 If one particular message screws up a remote MTA, other messages to the same
4384 MTA have a chance of getting through if they get tried first.
4385
4386 It is possible to cause the messages to be processed in lexical message id
4387 order, which is essentially the order in which they arrived, by setting the
4388 &%queue_run_in_order%& option, but this is not recommended for normal use.
4389
4390 .vitem &%-q%&<&'qflags'&>
4391 The &%-q%& option may be followed by one or more flag letters that change its
4392 behaviour. They are all optional, but if more than one is present, they must
4393 appear in the correct order. Each flag is described in a separate item below.
4394
4395 .vitem &%-qq...%&
4396 .oindex "&%-qq%&"
4397 .cindex "queue" "double scanning"
4398 .cindex "queue" "routing"
4399 .cindex "routing" "whole queue before delivery"
4400 An option starting with &%-qq%& requests a two-stage queue run. In the first
4401 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4402 every domain. Addresses are routed, local deliveries happen, but no remote
4403 transports are run.
4404
4405 .cindex "hints database" "remembering routing"
4406 The hints database that remembers which messages are waiting for specific hosts
4407 is updated, as if delivery to those hosts had been deferred. After this is
4408 complete, a second, normal queue scan happens, with routing and delivery taking
4409 place as normal. Messages that are routed to the same host should mostly be
4410 delivered down a single SMTP
4411 .cindex "SMTP" "passed connection"
4412 .cindex "SMTP" "multiple deliveries"
4413 .cindex "multiple SMTP deliveries"
4414 connection because of the hints that were set up during the first queue scan.
4415 This option may be useful for hosts that are connected to the Internet
4416 intermittently.
4417
4418 .vitem &%-q[q]i...%&
4419 .oindex "&%-qi%&"
4420 .cindex "queue" "initial delivery"
4421 If the &'i'& flag is present, the queue runner runs delivery processes only for
4422 those messages that haven't previously been tried. (&'i'& stands for &"initial
4423 delivery"&.) This can be helpful if you are putting messages on the queue using
4424 &%-odq%& and want a queue runner just to process the new messages.
4425
4426 .vitem &%-q[q][i]f...%&
4427 .oindex "&%-qf%&"
4428 .cindex "queue" "forcing delivery"
4429 .cindex "delivery" "forcing in queue run"
4430 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4431 message, whereas without &'f'& only those non-frozen addresses that have passed
4432 their retry times are tried.
4433
4434 .vitem &%-q[q][i]ff...%&
4435 .oindex "&%-qff%&"
4436 .cindex "frozen messages" "forcing delivery"
4437 If &'ff'& is present, a delivery attempt is forced for every message, whether
4438 frozen or not.
4439
4440 .vitem &%-q[q][i][f[f]]l%&
4441 .oindex "&%-ql%&"
4442 .cindex "queue" "local deliveries only"
4443 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4444 be done. If a message requires any remote deliveries, it remains on the queue
4445 for later delivery.
4446
4447 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4448 .cindex "queue" "delivering specific messages"
4449 When scanning the queue, Exim can be made to skip over messages whose ids are
4450 lexically less than a given value by following the &%-q%& option with a
4451 starting message id. For example:
4452 .code
4453 exim -q 0t5C6f-0000c8-00
4454 .endd
4455 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4456 second message id is given, messages whose ids are lexically greater than it
4457 are also skipped. If the same id is given twice, for example,
4458 .code
4459 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4460 .endd
4461 just one delivery process is started, for that message. This differs from
4462 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4463 that it counts as a delivery from a queue run. Note that the selection
4464 mechanism does not affect the order in which the messages are scanned. There
4465 are also other ways of selecting specific sets of messages for delivery in a
4466 queue run &-- see &%-R%& and &%-S%&.
4467
4468 .vitem &%-q%&<&'qflags'&><&'time'&>
4469 .cindex "queue runner" "starting periodically"
4470 .cindex "periodic queue running"
4471 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4472 starting a queue runner process at intervals specified by the given time value
4473 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4474 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4475 single daemon process handles both functions. A common way of starting up a
4476 combined daemon at system boot time is to use a command such as
4477 .code
4478 /usr/exim/bin/exim -bd -q30m
4479 .endd
4480 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4481 process every 30 minutes.
4482
4483 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4484 pid file is written unless one is explicitly requested by the &%-oP%& option.
4485
4486 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4487 .oindex "&%-qR%&"
4488 This option is synonymous with &%-R%&. It is provided for Sendmail
4489 compatibility.
4490
4491 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4492 .oindex "&%-qS%&"
4493 This option is synonymous with &%-S%&.
4494
4495 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4496 .oindex "&%-R%&"
4497 .cindex "queue runner" "for specific recipients"
4498 .cindex "delivery" "to given domain"
4499 .cindex "domain" "delivery to"
4500 The <&'rsflags'&> may be empty, in which case the white space before the string
4501 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4502 which are the possible values for <&'rsflags'&>. White space is required if
4503 <&'rsflags'&> is not empty.
4504
4505 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4506 perform a single queue run, except that, when scanning the messages on the
4507 queue, Exim processes only those that have at least one undelivered recipient
4508 address containing the given string, which is checked in a case-independent
4509 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4510 regular expression; otherwise it is a literal string.
4511
4512 If you want to do periodic queue runs for messages with specific recipients,
4513 you can combine &%-R%& with &%-q%& and a time value. For example:
4514 .code
4515 exim -q25m -R @special.domain.example
4516 .endd
4517 This example does a queue run for messages with recipients in the given domain
4518 every 25 minutes. Any additional flags that are specified with &%-q%& are
4519 applied to each queue run.
4520
4521 Once a message is selected for delivery by this mechanism, all its addresses
4522 are processed. For the first selected message, Exim overrides any retry
4523 information and forces a delivery attempt for each undelivered address. This
4524 means that if delivery of any address in the first message is successful, any
4525 existing retry information is deleted, and so delivery attempts for that
4526 address in subsequently selected messages (which are processed without forcing)
4527 will run. However, if delivery of any address does not succeed, the retry
4528 information is updated, and in subsequently selected messages, the failing
4529 address will be skipped.
4530
4531 .cindex "frozen messages" "forcing delivery"
4532 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4533 all selected messages, not just the first; frozen messages are included when
4534 &'ff'& is present.
4535
4536 The &%-R%& option makes it straightforward to initiate delivery of all messages
4537 to a given domain after a host has been down for some time. When the SMTP
4538 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4539 effect is to run Exim with the &%-R%& option, but it can be configured to run
4540 an arbitrary command instead.
4541
4542 .vitem &%-r%&
4543 .oindex "&%-r%&"
4544 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4545
4546 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4547 .oindex "&%-S%&"
4548 .cindex "delivery" "from given sender"
4549 .cindex "queue runner" "for specific senders"
4550 This option acts like &%-R%& except that it checks the string against each
4551 message's sender instead of against the recipients. If &%-R%& is also set, both
4552 conditions must be met for a message to be selected. If either of the options
4553 has &'f'& or &'ff'& in its flags, the associated action is taken.
4554
4555 .vitem &%-Tqt%&&~<&'times'&>
4556 .oindex "&%-Tqt%&"
4557 This is an option that is exclusively for use by the Exim testing suite. It is not
4558 recognized when Exim is run normally. It allows for the setting up of explicit
4559 &"queue times"& so that various warning/retry features can be tested.
4560
4561 .vitem &%-t%&
4562 .oindex "&%-t%&"
4563 .cindex "recipient" "extracting from header lines"
4564 .cindex "&'Bcc:'& header line"
4565 .cindex "&'Cc:'& header line"
4566 .cindex "&'To:'& header line"
4567 When Exim is receiving a locally-generated, non-SMTP message on its standard
4568 input, the &%-t%& option causes the recipients of the message to be obtained
4569 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4570 from the command arguments. The addresses are extracted before any rewriting
4571 takes place and the &'Bcc:'& header line, if present, is then removed.
4572
4573 .cindex "Sendmail compatibility" "&%-t%& option"
4574 If the command has any arguments, they specify addresses to which the message
4575 is &'not'& to be delivered. That is, the argument addresses are removed from
4576 the recipients list obtained from the headers. This is compatible with Smail 3
4577 and in accordance with the documented behaviour of several versions of
4578 Sendmail, as described in man pages on a number of operating systems (e.g.
4579 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4580 argument addresses to those obtained from the headers, and the O'Reilly
4581 Sendmail book documents it that way. Exim can be made to add argument addresses
4582 instead of subtracting them by setting the option
4583 &%extract_addresses_remove_arguments%& false.
4584
4585 .cindex "&%Resent-%& header lines" "with &%-t%&"
4586 If there are any &%Resent-%& header lines in the message, Exim extracts
4587 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4588 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4589 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4590 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4591
4592 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4593 message is resent several times). The RFC also specifies that they should be
4594 added at the front of the message, and separated by &'Received:'& lines. It is
4595 not at all clear how &%-t%& should operate in the present of multiple sets,
4596 nor indeed exactly what constitutes a &"set"&.
4597 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4598 are often added at the end of the header, and if a message is resent more than
4599 once, it is common for the original set of &%Resent-%& headers to be renamed as
4600 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4601
4602 .vitem &%-ti%&
4603 .oindex "&%-ti%&"
4604 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4605 compatibility with Sendmail.
4606
4607 .vitem &%-tls-on-connect%&
4608 .oindex "&%-tls-on-connect%&"
4609 .cindex "TLS" "use without STARTTLS"
4610 .cindex "TLS" "automatic start"
4611 This option is available when Exim is compiled with TLS support. It forces all
4612 incoming SMTP connections to behave as if the incoming port is listed in the
4613 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4614 &<<CHAPTLS>>& for further details.
4615
4616
4617 .vitem &%-U%&
4618 .oindex "&%-U%&"
4619 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4620 Sendmail uses this option for &"initial message submission"&, and its
4621 documentation states that in future releases, it may complain about
4622 syntactically invalid messages rather than fixing them when this flag is not
4623 set. Exim ignores this option.
4624
4625 .vitem &%-v%&
4626 .oindex "&%-v%&"
4627 This option causes Exim to write information to the standard error stream,
4628 describing what it is doing. In particular, it shows the log lines for
4629 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4630 dialogue is shown. Some of the log lines shown may not actually be written to
4631 the log if the setting of &%log_selector%& discards them. Any relevant
4632 selectors are shown with each log line. If none are shown, the logging is
4633 unconditional.
4634
4635 .vitem &%-x%&
4636 .oindex "&%-x%&"
4637 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4638 National Language Support extended characters in the body of the mail item"&).
4639 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4640 this option.
4641
4642 .vitem &%-X%&&~<&'logfile'&>
4643 .oindex "&%-X%&"
4644 This option is interpreted by Sendmail to cause debug information to be sent
4645 to the named file.  It is ignored by Exim.
4646
4647 .vitem &%-z%&&~<&'log-line'&>
4648 .oindex "&%-z%&"
4649 This option writes its argument to Exim's logfile.
4650 Use is restricted to administrators; the intent is for operational notes.
4651 Quotes should be used to maintain a multi-word item as a single argument,
4652 under most shells.
4653 .endlist
4654
4655 .ecindex IIDclo1
4656 .ecindex IIDclo2
4657
4658
4659 . ////////////////////////////////////////////////////////////////////////////
4660 . Insert a stylized DocBook comment here, to identify the end of the command
4661 . line options. This is for the benefit of the Perl script that automatically
4662 . creates a man page for the options.
4663 . ////////////////////////////////////////////////////////////////////////////
4664
4665 .literal xml
4666 <!-- === End of command line options === -->
4667 .literal off
4668
4669
4670
4671
4672
4673 . ////////////////////////////////////////////////////////////////////////////
4674 . ////////////////////////////////////////////////////////////////////////////
4675
4676
4677 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4678          "The runtime configuration file"
4679
4680 .cindex "run time configuration"
4681 .cindex "configuration file" "general description"
4682 .cindex "CONFIGURE_FILE"
4683 .cindex "configuration file" "errors in"
4684 .cindex "error" "in configuration file"
4685 .cindex "return code" "for bad configuration"
4686 Exim uses a single run time configuration file that is read whenever an Exim
4687 binary is executed. Note that in normal operation, this happens frequently,
4688 because Exim is designed to operate in a distributed manner, without central
4689 control.
4690
4691 If a syntax error is detected while reading the configuration file, Exim
4692 writes a message on the standard error, and exits with a non-zero return code.
4693 The message is also written to the panic log. &*Note*&: Only simple syntax
4694 errors can be detected at this time. The values of any expanded options are
4695 not checked until the expansion happens, even when the expansion does not
4696 actually alter the string.
4697
4698 The name of the configuration file is compiled into the binary for security
4699 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4700 most configurations, this specifies a single file. However, it is permitted to
4701 give a colon-separated list of file names, in which case Exim uses the first
4702 existing file in the list.
4703
4704 .cindex "EXIM_USER"
4705 .cindex "EXIM_GROUP"
4706 .cindex "CONFIGURE_OWNER"
4707 .cindex "CONFIGURE_GROUP"
4708 .cindex "configuration file" "ownership"
4709 .cindex "ownership" "configuration file"
4710 The run time configuration file must be owned by root or by the user that is
4711 specified at compile time by the CONFIGURE_OWNER option (if set). The
4712 configuration file must not be world-writeable, or group-writeable unless its
4713 group is the root group or the one specified at compile time by the
4714 CONFIGURE_GROUP option.
4715
4716 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4717 to root, anybody who is able to edit the run time configuration file has an
4718 easy way to run commands as root. If you specify a user or group in the
4719 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4720 who are members of that group will trivially be able to obtain root privileges.
4721
4722 Up to Exim version 4.72, the run time configuration file was also permitted to
4723 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4724 since it offered a simple privilege escalation for any attacker who managed to
4725 compromise the Exim user account.
4726
4727 A default configuration file, which will work correctly in simple situations,
4728 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4729 defines just one file name, the installation process copies the default
4730 configuration to a new file of that name if it did not previously exist. If
4731 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4732 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4733 configuration.
4734
4735
4736
4737 .section "Using a different configuration file" "SECID40"
4738 .cindex "configuration file" "alternate"
4739 A one-off alternate configuration can be specified by the &%-C%& command line
4740 option, which may specify a single file or a list of files. However, when
4741 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4742 unless the argument for &%-C%& is identical to the built-in value from
4743 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4744 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4745 is useful mainly for checking the syntax of configuration files before
4746 installing them. No owner or group checks are done on a configuration file
4747 specified by &%-C%&, if root privilege has been dropped.
4748
4749 Even the Exim user is not trusted to specify an arbitrary configuration file
4750 with the &%-C%& option to be used with root privileges, unless that file is
4751 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4752 testing a configuration using &%-C%& right through message reception and
4753 delivery, even if the caller is root. The reception works, but by that time,
4754 Exim is running as the Exim user, so when it re-execs to regain privilege for
4755 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4756 can test reception and delivery using two separate commands (one to put a
4757 message on the queue, using &%-odq%&, and another to do the delivery, using
4758 &%-M%&).
4759
4760 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4761 prefix string with which any file named in a &%-C%& command line option must
4762 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4763 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4764 name can be used with &%-C%&.
4765
4766 One-off changes to a configuration can be specified by the &%-D%& command line
4767 option, which defines and overrides values for macros used inside the
4768 configuration file. However, like &%-C%&, the use of this option by a
4769 non-privileged user causes Exim to discard its root privilege.
4770 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4771 completely disabled, and its use causes an immediate error exit.
4772
4773 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4774 to declare certain macro names trusted, such that root privilege will not
4775 necessarily be discarded.
4776 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4777 considered safe and, if &%-D%& only supplies macros from this list, and the
4778 values are acceptable, then Exim will not give up root privilege if the caller
4779 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4780 transition mechanism and is expected to be removed in the future.  Acceptable
4781 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4782
4783 Some sites may wish to use the same Exim binary on different machines that
4784 share a file system, but to use different configuration files on each machine.
4785 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4786 looks for a file whose name is the configuration file name followed by a dot
4787 and the machine's node name, as obtained from the &[uname()]& function. If this
4788 file does not exist, the standard name is tried. This processing occurs for
4789 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4790
4791 In some esoteric situations different versions of Exim may be run under
4792 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4793 help with this. See the comments in &_src/EDITME_& for details.
4794
4795
4796
4797 .section "Configuration file format" "SECTconffilfor"
4798 .cindex "configuration file" "format of"
4799 .cindex "format" "configuration file"
4800 Exim's configuration file is divided into a number of different parts. General
4801 option settings must always appear at the start of the file. The other parts
4802 are all optional, and may appear in any order. Each part other than the first
4803 is introduced by the word &"begin"& followed by at least one literal
4804 space, and the name of the part. The optional parts are:
4805
4806 .ilist
4807 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4808 &<<CHAPACL>>&).
4809 .next
4810 .cindex "AUTH" "configuration"
4811 &'authenticators'&: Configuration settings for the authenticator drivers. These
4812 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4813 .next
4814 &'routers'&: Configuration settings for the router drivers. Routers process
4815 addresses and determine how the message is to be delivered (see chapters
4816 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4817 .next
4818 &'transports'&: Configuration settings for the transport drivers. Transports
4819 define mechanisms for copying messages to destinations (see chapters
4820 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4821 .next
4822 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4823 If there is no retry section, or if it is empty (that is, no retry rules are
4824 defined), Exim will not retry deliveries. In this situation, temporary errors
4825 are treated the same as permanent errors. Retry rules are discussed in chapter
4826 &<<CHAPretry>>&.
4827 .next
4828 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4829 when new addresses are generated during delivery. Rewriting is discussed in
4830 chapter &<<CHAPrewrite>>&.
4831 .next
4832 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4833 want to use this feature, you must set
4834 .code
4835 LOCAL_SCAN_HAS_OPTIONS=yes
4836 .endd
4837 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4838 facility are given in chapter &<<CHAPlocalscan>>&.
4839 .endlist
4840
4841 .cindex "configuration file" "leading white space in"
4842 .cindex "configuration file" "trailing white space in"
4843 .cindex "white space" "in configuration file"
4844 Leading and trailing white space in configuration lines is always ignored.
4845
4846 Blank lines in the file, and lines starting with a # character (ignoring
4847 leading white space) are treated as comments and are ignored. &*Note*&: A
4848 # character other than at the beginning of a line is not treated specially,
4849 and does not introduce a comment.
4850
4851 Any non-comment line can be continued by ending it with a backslash. Note that
4852 the general rule for white space means that trailing white space after the
4853 backslash and leading white space at the start of continuation
4854 lines is ignored. Comment lines beginning with # (but not empty lines) may
4855 appear in the middle of a sequence of continuation lines.
4856
4857 A convenient way to create a configuration file is to start from the
4858 default, which is supplied in &_src/configure.default_&, and add, delete, or
4859 change settings as required.
4860
4861 The ACLs, retry rules, and rewriting rules have their own syntax which is
4862 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4863 respectively. The other parts of the configuration file have some syntactic
4864 items in common, and these are described below, from section &<<SECTcos>>&
4865 onwards. Before that, the inclusion, macro, and conditional facilities are
4866 described.
4867
4868
4869
4870 .section "File inclusions in the configuration file" "SECID41"
4871 .cindex "inclusions in configuration file"
4872 .cindex "configuration file" "including other files"
4873 .cindex "&`.include`& in configuration file"
4874 .cindex "&`.include_if_exists`& in configuration file"
4875 You can include other files inside Exim's run time configuration file by
4876 using this syntax:
4877 .display
4878 &`.include`& <&'file name'&>
4879 &`.include_if_exists`& <&'file name'&>
4880 .endd
4881 on a line by itself. Double quotes round the file name are optional. If you use
4882 the first form, a configuration error occurs if the file does not exist; the
4883 second form does nothing for non-existent files. In all cases, an absolute file
4884 name is required.
4885
4886 Includes may be nested to any depth, but remember that Exim reads its
4887 configuration file often, so it is a good idea to keep them to a minimum.
4888 If you change the contents of an included file, you must HUP the daemon,
4889 because an included file is read only when the configuration itself is read.
4890
4891 The processing of inclusions happens early, at a physical line level, so, like
4892 comment lines, an inclusion can be used in the middle of an option setting,
4893 for example:
4894 .code
4895 hosts_lookup = a.b.c \
4896                .include /some/file
4897 .endd
4898 Include processing happens after macro processing (see below). Its effect is to
4899 process the lines of the included file as if they occurred inline where the
4900 inclusion appears.
4901
4902
4903
4904 .section "Macros in the configuration file" "SECTmacrodefs"
4905 .cindex "macro" "description of"
4906 .cindex "configuration file" "macros"
4907 If a line in the main part of the configuration (that is, before the first
4908 &"begin"& line) begins with an upper case letter, it is taken as a macro
4909 definition, and must be of the form
4910 .display
4911 <&'name'&> = <&'rest of line'&>
4912 .endd
4913 The name must consist of letters, digits, and underscores, and need not all be
4914 in upper case, though that is recommended. The rest of the line, including any
4915 continuations, is the replacement text, and has leading and trailing white
4916 space removed. Quotes are not removed. The replacement text can never end with
4917 a backslash character, but this doesn't seem to be a serious limitation.
4918
4919 Macros may also be defined between router, transport, authenticator, or ACL
4920 definitions. They may not, however, be defined within an individual driver or
4921 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4922
4923 .section "Macro substitution" "SECID42"
4924 Once a macro is defined, all subsequent lines in the file (and any included
4925 files) are scanned for the macro name; if there are several macros, the line is
4926 scanned for each in turn, in the order in which the macros are defined. The
4927 replacement text is not re-scanned for the current macro, though it is scanned
4928 for subsequently defined macros. For this reason, a macro name may not contain
4929 the name of a previously defined macro as a substring. You could, for example,
4930 define
4931 .display
4932 &`ABCD_XYZ = `&<&'something'&>
4933 &`ABCD = `&<&'something else'&>
4934 .endd
4935 but putting the definitions in the opposite order would provoke a configuration
4936 error. Macro expansion is applied to individual physical lines from the file,
4937 before checking for line continuation or file inclusion (see above). If a line
4938 consists solely of a macro name, and the expansion of the macro is empty, the
4939 line is ignored. A macro at the start of a line may turn the line into a
4940 comment line or a &`.include`& line.
4941
4942
4943 .section "Redefining macros" "SECID43"
4944 Once defined, the value of a macro can be redefined later in the configuration
4945 (or in an included file). Redefinition is specified by using &'=='& instead of
4946 &'='&. For example:
4947 .code
4948 MAC =  initial value
4949 ...
4950 MAC == updated value
4951 .endd
4952 Redefinition does not alter the order in which the macros are applied to the
4953 subsequent lines of the configuration file. It is still the same order in which
4954 the macros were originally defined. All that changes is the macro's value.
4955 Redefinition makes it possible to accumulate values. For example:
4956 .code
4957 MAC =  initial value
4958 ...
4959 MAC == MAC and something added
4960 .endd
4961 This can be helpful in situations where the configuration file is built
4962 from a number of other files.
4963
4964 .section "Overriding macro values" "SECID44"
4965 The values set for macros in the configuration file can be overridden by the
4966 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4967 used, unless called by root or the Exim user. A definition on the command line
4968 using the &%-D%& option causes all definitions and redefinitions within the
4969 file to be ignored.
4970
4971
4972
4973 .section "Example of macro usage" "SECID45"
4974 As an example of macro usage, consider a configuration where aliases are looked
4975 up in a MySQL database. It helps to keep the file less cluttered if long
4976 strings such as SQL statements are defined separately as macros, for example:
4977 .code
4978 ALIAS_QUERY = select mailbox from user where \
4979               login='${quote_mysql:$local_part}';
4980 .endd
4981 This can then be used in a &(redirect)& router setting like this:
4982 .code
4983 data = ${lookup mysql{ALIAS_QUERY}}
4984 .endd
4985 In earlier versions of Exim macros were sometimes used for domain, host, or
4986 address lists. In Exim 4 these are handled better by named lists &-- see
4987 section &<<SECTnamedlists>>&.
4988
4989
4990 .section "Conditional skips in the configuration file" "SECID46"
4991 .cindex "configuration file" "conditional skips"
4992 .cindex "&`.ifdef`&"
4993 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4994 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4995 portions of the configuration file. The processing happens whenever the file is
4996 read (that is, when an Exim binary starts to run).
4997
4998 The implementation is very simple. Instances of the first four directives must
4999 be followed by text that includes the names of one or macros. The condition
5000 that is tested is whether or not any macro substitution has taken place in the
5001 line. Thus:
5002 .code
5003 .ifdef AAA
5004 message_size_limit = 50M
5005 .else
5006 message_size_limit = 100M
5007 .endif
5008 .endd
5009 sets a message size limit of 50M if the macro &`AAA`& is defined
5010 (or &`A`& or &`AA`&), and 100M
5011 otherwise. If there is more than one macro named on the line, the condition
5012 is true if any of them are defined. That is, it is an &"or"& condition. To
5013 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5014
5015 Although you can use a macro expansion to generate one of these directives,
5016 it is not very useful, because the condition &"there was a macro substitution
5017 in this line"& will always be true.
5018
5019 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5020 to clarify complicated nestings.
5021
5022
5023
5024 .section "Common option syntax" "SECTcos"
5025 .cindex "common option syntax"
5026 .cindex "syntax of common options"
5027 .cindex "configuration file" "common option syntax"
5028 For the main set of options, driver options, and &[local_scan()]& options,
5029 each setting is on a line by itself, and starts with a name consisting of
5030 lower-case letters and underscores. Many options require a data value, and in
5031 these cases the name must be followed by an equals sign (with optional white
5032 space) and then the value. For example:
5033 .code
5034 qualify_domain = mydomain.example.com
5035 .endd
5036 .cindex "hiding configuration option values"
5037 .cindex "configuration options" "hiding value of"
5038 .cindex "options" "hiding value of"
5039 Some option settings may contain sensitive data, for example, passwords for
5040 accessing databases. To stop non-admin users from using the &%-bP%& command
5041 line option to read these values, you can precede the option settings with the
5042 word &"hide"&. For example:
5043 .code
5044 hide mysql_servers = localhost/users/admin/secret-password
5045 .endd
5046 For non-admin users, such options are displayed like this:
5047 .code
5048 mysql_servers = <value not displayable>
5049 .endd
5050 If &"hide"& is used on a driver option, it hides the value of that option on
5051 all instances of the same driver.
5052
5053 The following sections describe the syntax used for the different data types
5054 that are found in option settings.
5055
5056
5057 .section "Boolean options" "SECID47"
5058 .cindex "format" "boolean"
5059 .cindex "boolean configuration values"
5060 .oindex "&%no_%&&'xxx'&"
5061 .oindex "&%not_%&&'xxx'&"
5062 Options whose type is given as boolean are on/off switches. There are two
5063 different ways of specifying such options: with and without a data value. If
5064 the option name is specified on its own without data, the switch is turned on;
5065 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5066 boolean options may be followed by an equals sign and one of the words
5067 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5068 the following two settings have exactly the same effect:
5069 .code
5070 queue_only
5071 queue_only = true
5072 .endd
5073 The following two lines also have the same (opposite) effect:
5074 .code
5075 no_queue_only
5076 queue_only = false
5077 .endd
5078 You can use whichever syntax you prefer.
5079
5080
5081
5082
5083 .section "Integer values" "SECID48"
5084 .cindex "integer configuration values"
5085 .cindex "format" "integer"
5086 If an option's type is given as &"integer"&, the value can be given in decimal,
5087 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5088 number is assumed. Otherwise, it is treated as an octal number unless it starts
5089 with the characters &"0x"&, in which case the remainder is interpreted as a
5090 hexadecimal number.
5091
5092 If an integer value is followed by the letter K, it is multiplied by 1024; if
5093 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5094 of integer option settings are output, values which are an exact multiple of
5095 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5096 and M. The printing style is independent of the actual input format that was
5097 used.
5098
5099
5100 .section "Octal integer values" "SECID49"
5101 .cindex "integer format"
5102 .cindex "format" "octal integer"
5103 If an option's type is given as &"octal integer"&, its value is always
5104 interpreted as an octal number, whether or not it starts with the digit zero.
5105 Such options are always output in octal.
5106
5107
5108 .section "Fixed point numbers" "SECID50"
5109 .cindex "fixed point configuration values"
5110 .cindex "format" "fixed point"
5111 If an option's type is given as &"fixed-point"&, its value must be a decimal
5112 integer, optionally followed by a decimal point and up to three further digits.
5113
5114
5115
5116 .section "Time intervals" "SECTtimeformat"
5117 .cindex "time interval" "specifying in configuration"
5118 .cindex "format" "time interval"
5119 A time interval is specified as a sequence of numbers, each followed by one of
5120 the following letters, with no intervening white space:
5121
5122 .table2 30pt
5123 .irow &%s%& seconds
5124 .irow &%m%& minutes
5125 .irow &%h%& hours
5126 .irow &%d%& days
5127 .irow &%w%& weeks
5128 .endtable
5129
5130 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5131 intervals are output in the same format. Exim does not restrict the values; it
5132 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5133
5134
5135
5136 .section "String values" "SECTstrings"
5137 .cindex "string" "format of configuration values"
5138 .cindex "format" "string"
5139 If an option's type is specified as &"string"&, the value can be specified with
5140 or without double-quotes. If it does not start with a double-quote, the value
5141 consists of the remainder of the line plus any continuation lines, starting at
5142 the first character after any leading white space, with trailing white space
5143 removed, and with no interpretation of the characters in the string. Because
5144 Exim removes comment lines (those beginning with #) at an early stage, they can
5145 appear in the middle of a multi-line string. The following two settings are
5146 therefore equivalent:
5147 .code
5148 trusted_users = uucp:mail
5149 trusted_users = uucp:\
5150                 # This comment line is ignored
5151                 mail
5152 .endd
5153 .cindex "string" "quoted"
5154 .cindex "escape characters in quoted strings"
5155 If a string does start with a double-quote, it must end with a closing
5156 double-quote, and any backslash characters other than those used for line
5157 continuation are interpreted as escape characters, as follows:
5158
5159 .table2 100pt
5160 .irow &`\\`&                     "single backslash"
5161 .irow &`\n`&                     "newline"
5162 .irow &`\r`&                     "carriage return"
5163 .irow &`\t`&                     "tab"
5164 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5165 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5166                                    character"
5167 .endtable
5168
5169 If a backslash is followed by some other character, including a double-quote
5170 character, that character replaces the pair.
5171
5172 Quoting is necessary only if you want to make use of the backslash escapes to
5173 insert special characters, or if you need to specify a value with leading or
5174 trailing spaces. These cases are rare, so quoting is almost never needed in
5175 current versions of Exim. In versions of Exim before 3.14, quoting was required
5176 in order to continue lines, so you may come across older configuration files
5177 and examples that apparently quote unnecessarily.
5178
5179
5180 .section "Expanded strings" "SECID51"
5181 .cindex "expansion" "definition of"
5182 Some strings in the configuration file are subjected to &'string expansion'&,
5183 by which means various parts of the string may be changed according to the
5184 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5185 is as just described; in particular, the handling of backslashes in quoted
5186 strings is done as part of the input process, before expansion takes place.
5187 However, backslash is also an escape character for the expander, so any
5188 backslashes that are required for that reason must be doubled if they are
5189 within a quoted configuration string.
5190
5191
5192 .section "User and group names" "SECID52"
5193 .cindex "user name" "format of"
5194 .cindex "format" "user name"
5195 .cindex "groups" "name format"
5196 .cindex "format" "group name"
5197 User and group names are specified as strings, using the syntax described
5198 above, but the strings are interpreted specially. A user or group name must
5199 either consist entirely of digits, or be a name that can be looked up using the
5200 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5201
5202
5203 .section "List construction" "SECTlistconstruct"
5204 .cindex "list" "syntax of in configuration"
5205 .cindex "format" "list item in configuration"
5206 .cindex "string" "list, definition of"
5207 The data for some configuration options is a list of items, with colon as the
5208 default separator. Many of these options are shown with type &"string list"& in
5209 the descriptions later in this document. Others are listed as &"domain list"&,
5210 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5211 are all the same; however, those other than &"string list"& are subject to
5212 particular kinds of interpretation, as described in chapter
5213 &<<CHAPdomhosaddlists>>&.
5214
5215 In all these cases, the entire list is treated as a single string as far as the
5216 input syntax is concerned. The &%trusted_users%& setting in section
5217 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5218 in a list, it must be entered as two colons. Leading and trailing white space
5219 on each item in a list is ignored. This makes it possible to include items that
5220 start with a colon, and in particular, certain forms of IPv6 address. For
5221 example, the list
5222 .code
5223 local_interfaces = 127.0.0.1 : ::::1
5224 .endd
5225 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5226
5227 &*Note*&: Although leading and trailing white space is ignored in individual
5228 list items, it is not ignored when parsing the list. The space after the first
5229 colon in the example above is necessary. If it were not there, the list would
5230 be interpreted as the two items 127.0.0.1:: and 1.
5231
5232 .section "Changing list separators" "SECTlistsepchange"
5233 .cindex "list separator" "changing"
5234 .cindex "IPv6" "addresses in lists"
5235 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5236 introduced to allow the separator character to be changed. If a list begins
5237 with a left angle bracket, followed by any punctuation character, that
5238 character is used instead of colon as the list separator. For example, the list
5239 above can be rewritten to use a semicolon separator like this:
5240 .code
5241 local_interfaces = <; 127.0.0.1 ; ::1
5242 .endd
5243 This facility applies to all lists, with the exception of the list in
5244 &%log_file_path%&. It is recommended that the use of non-colon separators be
5245 confined to circumstances where they really are needed.
5246
5247 .cindex "list separator" "newline as"
5248 .cindex "newline" "as list separator"
5249 It is also possible to use newline and other control characters (those with
5250 code values less than 32, plus DEL) as separators in lists. Such separators
5251 must be provided literally at the time the list is processed. For options that
5252 are string-expanded, you can write the separator using a normal escape
5253 sequence. This will be processed by the expander before the string is
5254 interpreted as a list. For example, if a newline-separated list of domains is
5255 generated by a lookup, you can process it directly by a line such as this:
5256 .code
5257 domains = <\n ${lookup mysql{.....}}
5258 .endd
5259 This avoids having to change the list separator in such data. You are unlikely
5260 to want to use a control character as a separator in an option that is not
5261 expanded, because the value is literal text. However, it can be done by giving
5262 the value in quotes. For example:
5263 .code
5264 local_interfaces = "<\n 127.0.0.1 \n ::1"
5265 .endd
5266 Unlike printing character separators, which can be included in list items by
5267 doubling, it is not possible to include a control character as data when it is
5268 set as the separator. Two such characters in succession are interpreted as
5269 enclosing an empty list item.
5270
5271
5272
5273 .section "Empty items in lists" "SECTempitelis"
5274 .cindex "list" "empty item in"
5275 An empty item at the end of a list is always ignored. In other words, trailing
5276 separator characters are ignored. Thus, the list in
5277 .code
5278 senders = user@domain :
5279 .endd
5280 contains only a single item. If you want to include an empty string as one item
5281 in a list, it must not be the last item. For example, this list contains three
5282 items, the second of which is empty:
5283 .code
5284 senders = user1@domain : : user2@domain
5285 .endd
5286 &*Note*&: There must be white space between the two colons, as otherwise they
5287 are interpreted as representing a single colon data character (and the list
5288 would then contain just one item). If you want to specify a list that contains
5289 just one, empty item, you can do it as in this example:
5290 .code
5291 senders = :
5292 .endd
5293 In this case, the first item is empty, and the second is discarded because it
5294 is at the end of the list.
5295
5296
5297
5298
5299 .section "Format of driver configurations" "SECTfordricon"
5300 .cindex "drivers" "configuration format"
5301 There are separate parts in the configuration for defining routers, transports,
5302 and authenticators. In each part, you are defining a number of driver
5303 instances, each with its own set of options. Each driver instance is defined by
5304 a sequence of lines like this:
5305 .display
5306 <&'instance name'&>:
5307   <&'option'&>
5308   ...
5309   <&'option'&>
5310 .endd
5311 In the following example, the instance name is &(localuser)&, and it is
5312 followed by three options settings:
5313 .code
5314 localuser:
5315   driver = accept
5316   check_local_user
5317   transport = local_delivery
5318 .endd
5319 For each driver instance, you specify which Exim code module it uses &-- by the
5320 setting of the &%driver%& option &-- and (optionally) some configuration
5321 settings. For example, in the case of transports, if you want a transport to
5322 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5323 a local file you would use the &(appendfile)& driver. Each of the drivers is
5324 described in detail in its own separate chapter later in this manual.
5325
5326 You can have several routers, transports, or authenticators that are based on
5327 the same underlying driver (each must have a different instance name).
5328
5329 The order in which routers are defined is important, because addresses are
5330 passed to individual routers one by one, in order. The order in which
5331 transports are defined does not matter at all. The order in which
5332 authenticators are defined is used only when Exim, as a client, is searching
5333 them to find one that matches an authentication mechanism offered by the
5334 server.
5335
5336 .cindex "generic options"
5337 .cindex "options" "generic &-- definition of"
5338 Within a driver instance definition, there are two kinds of option: &'generic'&
5339 and &'private'&. The generic options are those that apply to all drivers of the
5340 same type (that is, all routers, all transports or all authenticators). The
5341 &%driver%& option is a generic option that must appear in every definition.
5342 .cindex "private options"
5343 The private options are special for each driver, and none need appear, because
5344 they all have default values.
5345
5346 The options may appear in any order, except that the &%driver%& option must
5347 precede any private options, since these depend on the particular driver. For
5348 this reason, it is recommended that &%driver%& always be the first option.
5349
5350 Driver instance names, which are used for reference in log entries and
5351 elsewhere, can be any sequence of letters, digits, and underscores (starting
5352 with a letter) and must be unique among drivers of the same type. A router and
5353 a transport (for example) can each have the same name, but no two router
5354 instances can have the same name. The name of a driver instance should not be
5355 confused with the name of the underlying driver module. For example, the
5356 configuration lines:
5357 .code
5358 remote_smtp:
5359   driver = smtp
5360 .endd
5361 create an instance of the &(smtp)& transport driver whose name is
5362 &(remote_smtp)&. The same driver code can be used more than once, with
5363 different instance names and different option settings each time. A second
5364 instance of the &(smtp)& transport, with different options, might be defined
5365 thus:
5366 .code
5367 special_smtp:
5368   driver = smtp
5369   port = 1234
5370   command_timeout = 10s
5371 .endd
5372 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5373 these transport instances from routers, and these names would appear in log
5374 lines.
5375
5376 Comment lines may be present in the middle of driver specifications. The full
5377 list of option settings for any particular driver instance, including all the
5378 defaulted values, can be extracted by making use of the &%-bP%& command line
5379 option.
5380
5381
5382
5383
5384
5385
5386 . ////////////////////////////////////////////////////////////////////////////
5387 . ////////////////////////////////////////////////////////////////////////////
5388
5389 .chapter "The default configuration file" "CHAPdefconfil"
5390 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5391 .cindex "default" "configuration file &""walk through""&"
5392 The default configuration file supplied with Exim as &_src/configure.default_&
5393 is sufficient for a host with simple mail requirements. As an introduction to
5394 the way Exim is configured, this chapter &"walks through"& the default
5395 configuration, giving brief explanations of the settings. Detailed descriptions
5396 of the options are given in subsequent chapters. The default configuration file
5397 itself contains extensive comments about ways you might want to modify the
5398 initial settings. However, note that there are many options that are not
5399 mentioned at all in the default configuration.
5400
5401
5402
5403 .section "Main configuration settings" "SECTdefconfmain"
5404 The main (global) configuration option settings must always come first in the
5405 file. The first thing you'll see in the file, after some initial comments, is
5406 the line
5407 .code
5408 # primary_hostname =
5409 .endd
5410 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5411 to know the official, fully qualified name of your host, and this is where you
5412 can specify it. However, in most cases you do not need to set this option. When
5413 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5414
5415 The first three non-comment configuration lines are as follows:
5416 .code
5417 domainlist local_domains    = @
5418 domainlist relay_to_domains =
5419 hostlist   relay_from_hosts = 127.0.0.1
5420 .endd
5421 These are not, in fact, option settings. They are definitions of two named
5422 domain lists and one named host list. Exim allows you to give names to lists of
5423 domains, hosts, and email addresses, in order to make it easier to manage the
5424 configuration file (see section &<<SECTnamedlists>>&).
5425
5426 The first line defines a domain list called &'local_domains'&; this is used
5427 later in the configuration to identify domains that are to be delivered
5428 on the local host.
5429
5430 .cindex "@ in a domain list"
5431 There is just one item in this list, the string &"@"&. This is a special form
5432 of entry which means &"the name of the local host"&. Thus, if the local host is
5433 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5434 be delivered locally. Because the local host's name is referenced indirectly,
5435 the same configuration file can be used on different hosts.
5436
5437 The second line defines a domain list called &'relay_to_domains'&, but the
5438 list itself is empty. Later in the configuration we will come to the part that
5439 controls mail relaying through the local host; it allows relaying to any
5440 domains in this list. By default, therefore, no relaying on the basis of a mail
5441 domain is permitted.
5442
5443 The third line defines a host list called &'relay_from_hosts'&. This list is
5444 used later in the configuration to permit relaying from any host or IP address
5445 that matches the list. The default contains just the IP address of the IPv4
5446 loopback interface, which means that processes on the local host are able to
5447 submit mail for relaying by sending it over TCP/IP to that interface. No other
5448 hosts are permitted to submit messages for relaying.
5449
5450 Just to be sure there's no misunderstanding: at this point in the configuration
5451 we aren't actually setting up any controls. We are just defining some domains
5452 and hosts that will be used in the controls that are specified later.
5453
5454 The next two configuration lines are genuine option settings:
5455 .code
5456 acl_smtp_rcpt = acl_check_rcpt
5457 acl_smtp_data = acl_check_data
5458 .endd
5459 These options specify &'Access Control Lists'& (ACLs) that are to be used
5460 during an incoming SMTP session for every recipient of a message (every RCPT
5461 command), and after the contents of the message have been received,
5462 respectively. The names of the lists are &'acl_check_rcpt'& and
5463 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5464 section of the configuration. The RCPT ACL controls which recipients are
5465 accepted for an incoming message &-- if a configuration does not provide an ACL
5466 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5467 contents of a message to be checked.
5468
5469 Two commented-out option settings are next:
5470 .code
5471 # av_scanner = clamd:/tmp/clamd
5472 # spamd_address = 127.0.0.1 783
5473 .endd
5474 These are example settings that can be used when Exim is compiled with the
5475 content-scanning extension. The first specifies the interface to the virus
5476 scanner, and the second specifies the interface to SpamAssassin. Further
5477 details are given in chapter &<<CHAPexiscan>>&.
5478
5479 Three more commented-out option settings follow:
5480 .code
5481 # tls_advertise_hosts = *
5482 # tls_certificate = /etc/ssl/exim.crt
5483 # tls_privatekey = /etc/ssl/exim.pem
5484 .endd
5485 These are example settings that can be used when Exim is compiled with
5486 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5487 first one specifies the list of clients that are allowed to use TLS when
5488 connecting to this server; in this case the wildcard means all clients. The
5489 other options specify where Exim should find its TLS certificate and private
5490 key, which together prove the server's identity to any clients that connect.
5491 More details are given in chapter &<<CHAPTLS>>&.
5492
5493 Another two commented-out option settings follow:
5494 .code
5495 # daemon_smtp_ports = 25 : 465 : 587
5496 # tls_on_connect_ports = 465
5497 .endd
5498 .cindex "port" "465 and 587"
5499 .cindex "port" "for message submission"
5500 .cindex "message" "submission, ports for"
5501 .cindex "ssmtp protocol"
5502 .cindex "smtps protocol"
5503 .cindex "SMTP" "ssmtp protocol"
5504 .cindex "SMTP" "smtps protocol"
5505 These options provide better support for roaming users who wish to use this
5506 server for message submission. They are not much use unless you have turned on
5507 TLS (as described in the previous paragraph) and authentication (about which
5508 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5509 on end-user networks, so RFC 4409 specifies that message submission should use
5510 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5511 configured to use port 587 correctly, so these settings also enable the
5512 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5513 &<<SECTsupobssmt>>&).
5514
5515 Two more commented-out options settings follow:
5516 .code
5517 # qualify_domain =
5518 # qualify_recipient =
5519 .endd
5520 The first of these specifies a domain that Exim uses when it constructs a
5521 complete email address from a local login name. This is often needed when Exim
5522 receives a message from a local process. If you do not set &%qualify_domain%&,
5523 the value of &%primary_hostname%& is used. If you set both of these options,
5524 you can have different qualification domains for sender and recipient
5525 addresses. If you set only the first one, its value is used in both cases.
5526
5527 .cindex "domain literal" "recognizing format"
5528 The following line must be uncommented if you want Exim to recognize
5529 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5530 (an IP address within square brackets) instead of a named domain.
5531 .code
5532 # allow_domain_literals
5533 .endd
5534 The RFCs still require this form, but many people think that in the modern
5535 Internet it makes little sense to permit mail to be sent to specific hosts by
5536 quoting their IP addresses. This ancient format has been used by people who
5537 try to abuse hosts by using them for unwanted relaying. However, some
5538 people believe there are circumstances (for example, messages addressed to
5539 &'postmaster'&) where domain literals are still useful.
5540
5541 The next configuration line is a kind of trigger guard:
5542 .code
5543 never_users = root
5544 .endd
5545 It specifies that no delivery must ever be run as the root user. The normal
5546 convention is to set up &'root'& as an alias for the system administrator. This
5547 setting is a guard against slips in the configuration.
5548 The list of users specified by &%never_users%& is not, however, the complete
5549 list; the build-time configuration in &_Local/Makefile_& has an option called
5550 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5551 contents of &%never_users%& are added to this list. By default
5552 FIXED_NEVER_USERS also specifies root.
5553
5554 When a remote host connects to Exim in order to send mail, the only information
5555 Exim has about the host's identity is its IP address. The next configuration
5556 line,
5557 .code
5558 host_lookup = *
5559 .endd
5560 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5561 in order to get a host name. This improves the quality of the logging
5562 information, but if you feel it is too expensive, you can remove it entirely,
5563 or restrict the lookup to hosts on &"nearby"& networks.
5564 Note that it is not always possible to find a host name from an IP address,
5565 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5566 unreachable.
5567
5568 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5569 1413 (hence their names):
5570 .code
5571 rfc1413_hosts = *
5572 rfc1413_query_timeout = 0s
5573 .endd
5574 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5575 Few hosts offer RFC1413 service these days; calls have to be
5576 terminated by a timeout and this needlessly delays the startup
5577 of an incoming SMTP connection.
5578 If you have hosts for which you trust RFC1413 and need this
5579 information, you can change this.
5580
5581 This line enables an efficiency SMTP option.  It is negotiated by clients
5582 and not expected to cause problems but can be disabled if needed.
5583 .code
5584 prdr_enable = true
5585 .endd
5586
5587 When Exim receives messages over SMTP connections, it expects all addresses to
5588 be fully qualified with a domain, as required by the SMTP definition. However,
5589 if you are running a server to which simple clients submit messages, you may
5590 find that they send unqualified addresses. The two commented-out options:
5591 .code
5592 # sender_unqualified_hosts =
5593 # recipient_unqualified_hosts =
5594 .endd
5595 show how you can specify hosts that are permitted to send unqualified sender
5596 and recipient addresses, respectively.
5597
5598 The &%log_selector%& option is used to increase the detail of logging
5599 over the default:
5600 .code
5601 log_selector = +smtp_protocol_error +smtp_syntax_error \
5602                +tls_certificate_verified
5603 .endd
5604
5605 The &%percent_hack_domains%& option is also commented out:
5606 .code
5607 # percent_hack_domains =
5608 .endd
5609 It provides a list of domains for which the &"percent hack"& is to operate.
5610 This is an almost obsolete form of explicit email routing. If you do not know
5611 anything about it, you can safely ignore this topic.
5612
5613 The last two settings in the main part of the default configuration are
5614 concerned with messages that have been &"frozen"& on Exim's queue. When a
5615 message is frozen, Exim no longer continues to try to deliver it. Freezing
5616 occurs when a bounce message encounters a permanent failure because the sender
5617 address of the original message that caused the bounce is invalid, so the
5618 bounce cannot be delivered. This is probably the most common case, but there
5619 are also other conditions that cause freezing, and frozen messages are not
5620 always bounce messages.
5621 .code
5622 ignore_bounce_errors_after = 2d
5623 timeout_frozen_after = 7d
5624 .endd
5625 The first of these options specifies that failing bounce messages are to be
5626 discarded after 2 days on the queue. The second specifies that any frozen
5627 message (whether a bounce message or not) is to be timed out (and discarded)
5628 after a week. In this configuration, the first setting ensures that no failing
5629 bounce message ever lasts a week.
5630
5631
5632
5633 .section "ACL configuration" "SECID54"
5634 .cindex "default" "ACLs"
5635 .cindex "&ACL;" "default configuration"
5636 In the default configuration, the ACL section follows the main configuration.
5637 It starts with the line
5638 .code
5639 begin acl
5640 .endd
5641 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5642 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5643 and &%acl_smtp_data%& above.
5644
5645 .cindex "RCPT" "ACL for"
5646 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5647 RCPT command specifies one of the message's recipients. The ACL statements
5648 are considered in order, until the recipient address is either accepted or
5649 rejected. The RCPT command is then accepted or rejected, according to the
5650 result of the ACL processing.
5651 .code
5652 acl_check_rcpt:
5653 .endd
5654 This line, consisting of a name terminated by a colon, marks the start of the
5655 ACL, and names it.
5656 .code
5657 accept  hosts = :
5658 .endd
5659 This ACL statement accepts the recipient if the sending host matches the list.
5660 But what does that strange list mean? It doesn't actually contain any host
5661 names or IP addresses. The presence of the colon puts an empty item in the
5662 list; Exim matches this only if the incoming message did not come from a remote
5663 host, because in that case, the remote hostname is empty. The colon is
5664 important. Without it, the list itself is empty, and can never match anything.
5665
5666 What this statement is doing is to accept unconditionally all recipients in
5667 messages that are submitted by SMTP from local processes using the standard
5668 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5669 manner.
5670 .code
5671 deny    message       = Restricted characters in address
5672         domains       = +local_domains
5673         local_parts   = ^[.] : ^.*[@%!/|]
5674
5675 deny    message       = Restricted characters in address
5676         domains       = !+local_domains
5677         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5678 .endd
5679 These statements are concerned with local parts that contain any of the
5680 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5681 Although these characters are entirely legal in local parts (in the case of
5682 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5683 in Internet mail addresses.
5684
5685 The first three have in the past been associated with explicitly routed
5686 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5687 option). Addresses containing these characters are regularly tried by spammers
5688 in an attempt to bypass relaying restrictions, and also by open relay testing
5689 programs. Unless you really need them it is safest to reject these characters
5690 at this early stage. This configuration is heavy-handed in rejecting these
5691 characters for all messages it accepts from remote hosts. This is a deliberate
5692 policy of being as safe as possible.
5693
5694 The first rule above is stricter, and is applied to messages that are addressed
5695 to one of the local domains handled by this host. This is implemented by the
5696 first condition, which restricts it to domains that are listed in the
5697 &'local_domains'& domain list. The &"+"& character is used to indicate a
5698 reference to a named list. In this configuration, there is just one domain in
5699 &'local_domains'&, but in general there may be many.
5700
5701 The second condition on the first statement uses two regular expressions to
5702 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5703 or &"|"&. If you have local accounts that include these characters, you will
5704 have to modify this rule.
5705
5706 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5707 allows them because they have been encountered in practice. (Consider the
5708 common convention of local parts constructed as
5709 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5710 the author of Exim, who has no second initial.) However, a local part starting
5711 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5712 file name (for example, for a mailing list). This is also true for local parts
5713 that contain slashes. A pipe symbol can also be troublesome if the local part
5714 is incorporated unthinkingly into a shell command line.
5715
5716 The second rule above applies to all other domains, and is less strict. This
5717 allows your own users to send outgoing messages to sites that use slashes
5718 and vertical bars in their local parts. It blocks local parts that begin
5719 with a dot, slash, or vertical bar, but allows these characters within the
5720 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5721 and &"!"& is blocked, as before. The motivation here is to prevent your users
5722 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5723 .code
5724 accept  local_parts   = postmaster
5725         domains       = +local_domains
5726 .endd
5727 This statement, which has two conditions, accepts an incoming address if the
5728 local part is &'postmaster'& and the domain is one of those listed in the
5729 &'local_domains'& domain list. The &"+"& character is used to indicate a
5730 reference to a named list. In this configuration, there is just one domain in
5731 &'local_domains'&, but in general there may be many.
5732
5733 The presence of this statement means that mail to postmaster is never blocked
5734 by any of the subsequent tests. This can be helpful while sorting out problems
5735 in cases where the subsequent tests are incorrectly denying access.
5736 .code
5737 require verify        = sender
5738 .endd
5739 This statement requires the sender address to be verified before any subsequent
5740 ACL statement can be used. If verification fails, the incoming recipient
5741 address is refused. Verification consists of trying to route the address, to
5742 see if a bounce message could be delivered to it. In the case of remote
5743 addresses, basic verification checks only the domain, but &'callouts'& can be
5744 used for more verification if required. Section &<<SECTaddressverification>>&
5745 discusses the details of address verification.
5746 .code
5747 accept  hosts         = +relay_from_hosts
5748         control       = submission
5749 .endd
5750 This statement accepts the address if the message is coming from one of the
5751 hosts that are defined as being allowed to relay through this host. Recipient
5752 verification is omitted here, because in many cases the clients are dumb MUAs
5753 that do not cope well with SMTP error responses. For the same reason, the
5754 second line specifies &"submission mode"& for messages that are accepted. This
5755 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5756 messages that are deficient in some way, for example, because they lack a
5757 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5758 probably add recipient verification here, and disable submission mode.
5759 .code
5760 accept  authenticated = *
5761         control       = submission
5762 .endd
5763 This statement accepts the address if the client host has authenticated itself.
5764 Submission mode is again specified, on the grounds that such messages are most
5765 likely to come from MUAs. The default configuration does not define any
5766 authenticators, though it does include some nearly complete commented-out
5767 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5768 fact authenticate until you complete the authenticator definitions.
5769 .code
5770 require message = relay not permitted
5771         domains = +local_domains : +relay_to_domains
5772 .endd
5773 This statement rejects the address if its domain is neither a local domain nor
5774 one of the domains for which this host is a relay.
5775 .code
5776 require verify = recipient
5777 .endd
5778 This statement requires the recipient address to be verified; if verification
5779 fails, the address is rejected.
5780 .code
5781 # deny    message     = rejected because $sender_host_address \
5782 #                       is in a black list at $dnslist_domain\n\
5783 #                       $dnslist_text
5784 #         dnslists    = black.list.example
5785 #
5786 # warn    dnslists    = black.list.example
5787 #         add_header  = X-Warning: $sender_host_address is in \
5788 #                       a black list at $dnslist_domain
5789 #         log_message = found in $dnslist_domain
5790 .endd
5791 These commented-out lines are examples of how you could configure Exim to check
5792 sending hosts against a DNS black list. The first statement rejects messages
5793 from blacklisted hosts, whereas the second just inserts a warning header
5794 line.
5795 .code
5796 # require verify = csa
5797 .endd
5798 This commented-out line is an example of how you could turn on client SMTP
5799 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5800 records.
5801 .code
5802 accept
5803 .endd
5804 The final statement in the first ACL unconditionally accepts any recipient
5805 address that has successfully passed all the previous tests.
5806 .code
5807 acl_check_data:
5808 .endd
5809 This line marks the start of the second ACL, and names it. Most of the contents
5810 of this ACL are commented out:
5811 .code
5812 # deny    malware   = *
5813 #         message   = This message contains a virus \
5814 #                     ($malware_name).
5815 .endd
5816 These lines are examples of how to arrange for messages to be scanned for
5817 viruses when Exim has been compiled with the content-scanning extension, and a
5818 suitable virus scanner is installed. If the message is found to contain a
5819 virus, it is rejected with the given custom error message.
5820 .code
5821 # warn    spam      = nobody
5822 #         message   = X-Spam_score: $spam_score\n\
5823 #                     X-Spam_score_int: $spam_score_int\n\
5824 #                     X-Spam_bar: $spam_bar\n\
5825 #                     X-Spam_report: $spam_report
5826 .endd
5827 These lines are an example of how to arrange for messages to be scanned by
5828 SpamAssassin when Exim has been compiled with the content-scanning extension,
5829 and SpamAssassin has been installed. The SpamAssassin check is run with
5830 &`nobody`& as its user parameter, and the results are added to the message as a
5831 series of extra header line. In this case, the message is not rejected,
5832 whatever the spam score.
5833 .code
5834 accept
5835 .endd
5836 This final line in the DATA ACL accepts the message unconditionally.
5837
5838
5839 .section "Router configuration" "SECID55"
5840 .cindex "default" "routers"
5841 .cindex "routers" "default"
5842 The router configuration comes next in the default configuration, introduced
5843 by the line
5844 .code
5845 begin routers
5846 .endd
5847 Routers are the modules in Exim that make decisions about where to send
5848 messages. An address is passed to each router in turn, until it is either
5849 accepted, or failed. This means that the order in which you define the routers
5850 matters. Each router is fully described in its own chapter later in this
5851 manual. Here we give only brief overviews.
5852 .code
5853 # domain_literal:
5854 #   driver = ipliteral
5855 #   domains = !+local_domains
5856 #   transport = remote_smtp
5857 .endd
5858 .cindex "domain literal" "default router"
5859 This router is commented out because the majority of sites do not want to
5860 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5861 you uncomment this router, you also need to uncomment the setting of
5862 &%allow_domain_literals%& in the main part of the configuration.
5863 .code
5864 dnslookup:
5865   driver = dnslookup
5866   domains = ! +local_domains
5867   transport = remote_smtp
5868   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5869   no_more
5870 .endd
5871 The first uncommented router handles addresses that do not involve any local
5872 domains. This is specified by the line
5873 .code
5874 domains = ! +local_domains
5875 .endd
5876 The &%domains%& option lists the domains to which this router applies, but the
5877 exclamation mark is a negation sign, so the router is used only for domains
5878 that are not in the domain list called &'local_domains'& (which was defined at
5879 the start of the configuration). The plus sign before &'local_domains'&
5880 indicates that it is referring to a named list. Addresses in other domains are
5881 passed on to the following routers.
5882
5883 The name of the router driver is &(dnslookup)&,
5884 and is specified by the &%driver%& option. Do not be confused by the fact that
5885 the name of this router instance is the same as the name of the driver. The
5886 instance name is arbitrary, but the name set in the &%driver%& option must be
5887 one of the driver modules that is in the Exim binary.
5888
5889 The &(dnslookup)& router routes addresses by looking up their domains in the
5890 DNS in order to obtain a list of hosts to which the address is routed. If the
5891 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5892 specified by the &%transport%& option. If the router does not find the domain
5893 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5894 the address fails and is bounced.
5895
5896 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5897 be entirely ignored. This option is present because a number of cases have been
5898 encountered where MX records in the DNS point to host names
5899 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5900 Completely ignoring these IP addresses causes Exim to fail to route the
5901 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5902 continue to try to deliver the message periodically until the address timed
5903 out.
5904 .code
5905 system_aliases:
5906   driver = redirect
5907   allow_fail
5908   allow_defer
5909   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5910 # user = exim
5911   file_transport = address_file
5912   pipe_transport = address_pipe
5913 .endd
5914 Control reaches this and subsequent routers only for addresses in the local
5915 domains. This router checks to see whether the local part is defined as an
5916 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5917 data that it looks up from that file. If no data is found for the local part,
5918 the value of the &%data%& option is empty, causing the address to be passed to
5919 the next router.
5920
5921 &_/etc/aliases_& is a conventional name for the system aliases file that is
5922 often used. That is why it is referenced by from the default configuration
5923 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5924 &_Local/Makefile_& before building Exim.
5925 .code
5926 userforward:
5927   driver = redirect
5928   check_local_user
5929 # local_part_suffix = +* : -*
5930 # local_part_suffix_optional
5931   file = $home/.forward
5932 # allow_filter
5933   no_verify
5934   no_expn
5935   check_ancestor
5936   file_transport = address_file
5937   pipe_transport = address_pipe
5938   reply_transport = address_reply
5939 .endd
5940 This is the most complicated router in the default configuration. It is another
5941 redirection router, but this time it is looking for forwarding data set up by
5942 individual users. The &%check_local_user%& setting specifies a check that the
5943 local part of the address is the login name of a local user. If it is not, the
5944 router is skipped. The two commented options that follow &%check_local_user%&,
5945 namely:
5946 .code
5947 # local_part_suffix = +* : -*
5948 # local_part_suffix_optional
5949 .endd
5950 .vindex "&$local_part_suffix$&"
5951 show how you can specify the recognition of local part suffixes. If the first
5952 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5953 by any sequence of characters, is removed from the local part and placed in the
5954 variable &$local_part_suffix$&. The second suffix option specifies that the
5955 presence of a suffix in the local part is optional. When a suffix is present,
5956 the check for a local login uses the local part with the suffix removed.
5957
5958 When a local user account is found, the file called &_.forward_& in the user's
5959 home directory is consulted. If it does not exist, or is empty, the router
5960 declines. Otherwise, the contents of &_.forward_& are interpreted as
5961 redirection data (see chapter &<<CHAPredirect>>& for more details).
5962
5963 .cindex "Sieve filter" "enabling in default router"
5964 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5965 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5966 is commented out by default), the contents of the file are interpreted as a set
5967 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5968 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5969 separate document entitled &'Exim's interfaces to mail filtering'&.
5970
5971 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5972 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5973 There are two reasons for doing this:
5974
5975 .olist
5976 Whether or not a local user has a &_.forward_& file is not really relevant when
5977 checking an address for validity; it makes sense not to waste resources doing
5978 unnecessary work.
5979 .next
5980 More importantly, when Exim is verifying addresses or handling an EXPN
5981 command during an SMTP session, it is running as the Exim user, not as root.
5982 The group is the Exim group, and no additional groups are set up.
5983 It may therefore not be possible for Exim to read users' &_.forward_& files at
5984 this time.
5985 .endlist
5986
5987 The setting of &%check_ancestor%& prevents the router from generating a new
5988 address that is the same as any previous address that was redirected. (This
5989 works round a problem concerning a bad interaction between aliasing and
5990 forwarding &-- see section &<<SECTredlocmai>>&).
5991
5992 The final three option settings specify the transports that are to be used when
5993 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5994 auto-reply, respectively. For example, if a &_.forward_& file contains
5995 .code
5996 a.nother@elsewhere.example, /home/spqr/archive
5997 .endd
5998 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5999 transport.
6000 .code
6001 localuser:
6002   driver = accept
6003   check_local_user
6004 # local_part_suffix = +* : -*
6005 # local_part_suffix_optional
6006   transport = local_delivery
6007 .endd
6008 The final router sets up delivery into local mailboxes, provided that the local
6009 part is the name of a local login, by accepting the address and assigning it to
6010 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6011 routers, so the address is bounced. The commented suffix settings fulfil the
6012 same purpose as they do for the &(userforward)& router.
6013
6014
6015 .section "Transport configuration" "SECID56"
6016 .cindex "default" "transports"
6017 .cindex "transports" "default"
6018 Transports define mechanisms for actually delivering messages. They operate
6019 only when referenced from routers, so the order in which they are defined does
6020 not matter. The transports section of the configuration starts with
6021 .code
6022 begin transports
6023 .endd
6024 One remote transport and four local transports are defined.
6025 .code
6026 remote_smtp:
6027   driver = smtp
6028   hosts_try_prdr = *
6029 .endd
6030 This transport is used for delivering messages over SMTP connections.
6031 The list of remote hosts comes from the router.
6032 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6033 It is negotiated between client and server
6034 and not expected to cause problems but can be disabled if needed.
6035 All other options are defaulted.
6036 .code
6037 local_delivery:
6038   driver = appendfile
6039   file = /var/mail/$local_part
6040   delivery_date_add
6041   envelope_to_add
6042   return_path_add
6043 # group = mail
6044 # mode = 0660
6045 .endd
6046 This &(appendfile)& transport is used for local delivery to user mailboxes in
6047 traditional BSD mailbox format. By default it runs under the uid and gid of the
6048 local user, which requires the sticky bit to be set on the &_/var/mail_&
6049 directory. Some systems use the alternative approach of running mail deliveries
6050 under a particular group instead of using the sticky bit. The commented options
6051 show how this can be done.
6052
6053 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6054 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6055 similarly-named options above.
6056 .code
6057 address_pipe:
6058   driver = pipe
6059   return_output
6060 .endd
6061 This transport is used for handling deliveries to pipes that are generated by
6062 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6063 option specifies that any output on stdout or stderr generated by the pipe is to
6064 be returned to the sender.
6065 .code
6066 address_file:
6067   driver = appendfile
6068   delivery_date_add
6069   envelope_to_add
6070   return_path_add
6071 .endd
6072 This transport is used for handling deliveries to files that are generated by
6073 redirection. The name of the file is not specified in this instance of
6074 &(appendfile)&, because it comes from the &(redirect)& router.
6075 .code
6076 address_reply:
6077   driver = autoreply
6078 .endd
6079 This transport is used for handling automatic replies generated by users'
6080 filter files.
6081
6082
6083
6084 .section "Default retry rule" "SECID57"
6085 .cindex "retry" "default rule"
6086 .cindex "default" "retry rule"
6087 The retry section of the configuration file contains rules which affect the way
6088 Exim retries deliveries that cannot be completed at the first attempt. It is
6089 introduced by the line
6090 .code
6091 begin retry
6092 .endd
6093 In the default configuration, there is just one rule, which applies to all
6094 errors:
6095 .code
6096 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6097 .endd
6098 This causes any temporarily failing address to be retried every 15 minutes for
6099 2 hours, then at intervals starting at one hour and increasing by a factor of
6100 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6101 is not delivered after 4 days of temporary failure, it is bounced.
6102
6103 If the retry section is removed from the configuration, or is empty (that is,
6104 if no retry rules are defined), Exim will not retry deliveries. This turns
6105 temporary errors into permanent errors.
6106
6107
6108 .section "Rewriting configuration" "SECID58"
6109 The rewriting section of the configuration, introduced by
6110 .code
6111 begin rewrite
6112 .endd
6113 contains rules for rewriting addresses in messages as they arrive. There are no
6114 rewriting rules in the default configuration file.
6115
6116
6117
6118 .section "Authenticators configuration" "SECTdefconfauth"
6119 .cindex "AUTH" "configuration"
6120 The authenticators section of the configuration, introduced by
6121 .code
6122 begin authenticators
6123 .endd
6124 defines mechanisms for the use of the SMTP AUTH command. The default
6125 configuration file contains two commented-out example authenticators
6126 which support plaintext username/password authentication using the
6127 standard PLAIN mechanism and the traditional but non-standard LOGIN
6128 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6129 to support most MUA software.
6130
6131 The example PLAIN authenticator looks like this:
6132 .code
6133 #PLAIN:
6134 #  driver                  = plaintext
6135 #  server_set_id           = $auth2
6136 #  server_prompts          = :
6137 #  server_condition        = Authentication is not yet configured
6138 #  server_advertise_condition = ${if def:tls_in_cipher }
6139 .endd
6140 And the example LOGIN authenticator looks like this:
6141 .code
6142 #LOGIN:
6143 #  driver                  = plaintext
6144 #  server_set_id           = $auth1
6145 #  server_prompts          = <| Username: | Password:
6146 #  server_condition        = Authentication is not yet configured
6147 #  server_advertise_condition = ${if def:tls_in_cipher }
6148 .endd
6149
6150 The &%server_set_id%& option makes Exim remember the authenticated username
6151 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6152 &%server_prompts%& option configures the &(plaintext)& authenticator so
6153 that it implements the details of the specific authentication mechanism,
6154 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6155 when Exim offers authentication to clients; in the examples, this is only
6156 when TLS or SSL has been started, so to enable the authenticators you also
6157 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6158
6159 The &%server_condition%& setting defines how to verify that the username and
6160 password are correct. In the examples it just produces an error message.
6161 To make the authenticators work, you can use a string expansion
6162 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6163
6164 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6165 usercode and password are in different positions.
6166 Chapter &<<CHAPplaintext>>& covers both.
6167
6168 .ecindex IIDconfiwal
6169
6170
6171
6172 . ////////////////////////////////////////////////////////////////////////////
6173 . ////////////////////////////////////////////////////////////////////////////
6174
6175 .chapter "Regular expressions" "CHAPregexp"
6176
6177 .cindex "regular expressions" "library"
6178 .cindex "PCRE"
6179 Exim supports the use of regular expressions in many of its options. It
6180 uses the PCRE regular expression library; this provides regular expression
6181 matching that is compatible with Perl 5. The syntax and semantics of
6182 regular expressions is discussed in many Perl reference books, and also in
6183 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6184 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6185
6186 The documentation for the syntax and semantics of the regular expressions that
6187 are supported by PCRE is included in the PCRE distribution, and no further
6188 description is included here. The PCRE functions are called from Exim using
6189 the default option settings (that is, with no PCRE options set), except that
6190 the PCRE_CASELESS option is set when the matching is required to be
6191 case-insensitive.
6192
6193 In most cases, when a regular expression is required in an Exim configuration,
6194 it has to start with a circumflex, in order to distinguish it from plain text
6195 or an &"ends with"& wildcard. In this example of a configuration setting, the
6196 second item in the colon-separated list is a regular expression.
6197 .code
6198 domains = a.b.c : ^\\d{3} : *.y.z : ...
6199 .endd
6200 The doubling of the backslash is required because of string expansion that
6201 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6202 of this issue, and a way of avoiding the need for doubling backslashes. The
6203 regular expression that is eventually used in this example contains just one
6204 backslash. The circumflex is included in the regular expression, and has the
6205 normal effect of &"anchoring"& it to the start of the string that is being
6206 matched.
6207
6208 There are, however, two cases where a circumflex is not required for the
6209 recognition of a regular expression: these are the &%match%& condition in a
6210 string expansion, and the &%matches%& condition in an Exim filter file. In
6211 these cases, the relevant string is always treated as a regular expression; if
6212 it does not start with a circumflex, the expression is not anchored, and can
6213 match anywhere in the subject string.
6214
6215 In all cases, if you want a regular expression to match at the end of a string,
6216 you must code the $ metacharacter to indicate this. For example:
6217 .code
6218 domains = ^\\d{3}\\.example
6219 .endd
6220 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6221 You need to use:
6222 .code
6223 domains = ^\\d{3}\\.example\$
6224 .endd
6225 if you want &'example'& to be the top-level domain. The backslash before the
6226 $ is needed because string expansion also interprets dollar characters.
6227
6228
6229
6230 . ////////////////////////////////////////////////////////////////////////////
6231 . ////////////////////////////////////////////////////////////////////////////
6232
6233 .chapter "File and database lookups" "CHAPfdlookup"
6234 .scindex IIDfidalo1 "file" "lookups"
6235 .scindex IIDfidalo2 "database" "lookups"
6236 .cindex "lookup" "description of"
6237 Exim can be configured to look up data in files or databases as it processes
6238 messages. Two different kinds of syntax are used:
6239
6240 .olist
6241 A string that is to be expanded may contain explicit lookup requests. These
6242 cause parts of the string to be replaced by data that is obtained from the
6243 lookup. Lookups of this type are conditional expansion items. Different results
6244 can be defined for the cases of lookup success and failure. See chapter
6245 &<<CHAPexpand>>&, where string expansions are described in detail.
6246 The key for the lookup is specified as part of the string expansion.
6247 .next
6248 Lists of domains, hosts, and email addresses can contain lookup requests as a
6249 way of avoiding excessively long linear lists. In this case, the data that is
6250 returned by the lookup is often (but not always) discarded; whether the lookup
6251 succeeds or fails is what really counts. These kinds of list are described in
6252 chapter &<<CHAPdomhosaddlists>>&.
6253 The key for the lookup is given by the context in which the list is expanded.
6254 .endlist
6255
6256 String expansions, lists, and lookups interact with each other in such a way
6257 that there is no order in which to describe any one of them that does not
6258 involve references to the others. Each of these three chapters makes more sense
6259 if you have read the other two first. If you are reading this for the first
6260 time, be aware that some of it will make a lot more sense after you have read
6261 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6262
6263 .section "Examples of different lookup syntax" "SECID60"
6264 It is easy to confuse the two different kinds of lookup, especially as the
6265 lists that may contain the second kind are always expanded before being
6266 processed as lists. Therefore, they may also contain lookups of the first kind.
6267 Be careful to distinguish between the following two examples:
6268 .code
6269 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6270 domains = lsearch;/some/file
6271 .endd
6272 The first uses a string expansion, the result of which must be a domain list.
6273 No strings have been specified for a successful or a failing lookup; the
6274 defaults in this case are the looked-up data and an empty string, respectively.
6275 The expansion takes place before the string is processed as a list, and the
6276 file that is searched could contain lines like this:
6277 .code
6278 192.168.3.4: domain1:domain2:...
6279 192.168.1.9: domain3:domain4:...
6280 .endd
6281 When the lookup succeeds, the result of the expansion is a list of domains (and
6282 possibly other types of item that are allowed in domain lists).
6283
6284 In the second example, the lookup is a single item in a domain list. It causes
6285 Exim to use a lookup to see if the domain that is being processed can be found
6286 in the file. The file could contains lines like this:
6287 .code
6288 domain1:
6289 domain2:
6290 .endd
6291 Any data that follows the keys is not relevant when checking that the domain
6292 matches the list item.
6293
6294 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6295 Consider a file containing lines like this:
6296 .code
6297 192.168.5.6: lsearch;/another/file
6298 .endd
6299 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6300 first &%domains%& setting above generates the second setting, which therefore
6301 causes a second lookup to occur.
6302
6303 The rest of this chapter describes the different lookup types that are
6304 available. Any of them can be used in any part of the configuration where a
6305 lookup is permitted.
6306
6307
6308 .section "Lookup types" "SECID61"
6309 .cindex "lookup" "types of"
6310 .cindex "single-key lookup" "definition of"
6311 Two different types of data lookup are implemented:
6312
6313 .ilist
6314 The &'single-key'& type requires the specification of a file in which to look,
6315 and a single key to search for. The key must be a non-empty string for the
6316 lookup to succeed. The lookup type determines how the file is searched.
6317 .next
6318 .cindex "query-style lookup" "definition of"
6319 The &'query-style'& type accepts a generalized database query. No particular
6320 key value is assumed by Exim for query-style lookups. You can use whichever
6321 Exim variables you need to construct the database query.
6322 .endlist
6323
6324 The code for each lookup type is in a separate source file that is included in
6325 the binary of Exim only if the corresponding compile-time option is set. The
6326 default settings in &_src/EDITME_& are:
6327 .code
6328 LOOKUP_DBM=yes
6329 LOOKUP_LSEARCH=yes
6330 .endd
6331 which means that only linear searching and DBM lookups are included by default.
6332 For some types of lookup (e.g. SQL databases), you need to install appropriate
6333 libraries and header files before building Exim.
6334
6335
6336
6337
6338 .section "Single-key lookup types" "SECTsinglekeylookups"
6339 .cindex "lookup" "single-key types"
6340 .cindex "single-key lookup" "list of types"
6341 The following single-key lookup types are implemented:
6342
6343 .ilist
6344 .cindex "cdb" "description of"
6345 .cindex "lookup" "cdb"
6346 .cindex "binary zero" "in lookup key"
6347 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6348 string without a terminating binary zero. The cdb format is designed for
6349 indexed files that are read frequently and never updated, except by total
6350 re-creation. As such, it is particularly suitable for large files containing
6351 aliases or other indexed data referenced by an MTA. Information about cdb can
6352 be found in several places:
6353 .display
6354 &url(http://www.pobox.com/~djb/cdb.html)
6355 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6356 &url(http://packages.debian.org/stable/utils/freecdb.html)
6357 .endd
6358 A cdb distribution is not needed in order to build Exim with cdb support,
6359 because the code for reading cdb files is included directly in Exim itself.
6360 However, no means of building or testing cdb files is provided with Exim, so
6361 you need to obtain a cdb distribution in order to do this.
6362 .next
6363 .cindex "DBM" "lookup type"
6364 .cindex "lookup" "dbm"
6365 .cindex "binary zero" "in lookup key"
6366 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6367 DBM file by looking up the record with the given key. A terminating binary
6368 zero is included in the key that is passed to the DBM library. See section
6369 &<<SECTdb>>& for a discussion of DBM libraries.
6370
6371 .cindex "Berkeley DB library" "file format"
6372 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6373 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6374 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6375 the DB_UNKNOWN option. This enables it to handle any of the types of database
6376 that the library supports, and can be useful for accessing DBM files created by
6377 other applications. (For earlier DB versions, DB_HASH is always used.)
6378 .next
6379 .cindex "lookup" "dbmjz"
6380 .cindex "lookup" "dbm &-- embedded NULs"
6381 .cindex "sasldb2"
6382 .cindex "dbmjz lookup type"
6383 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6384 interpreted as an Exim list; the elements of the list are joined together with
6385 ASCII NUL characters to form the lookup key.  An example usage would be to
6386 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6387 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6388 &(cram_md5)& authenticator.
6389 .next
6390 .cindex "lookup" "dbmnz"
6391 .cindex "lookup" "dbm &-- terminating zero"
6392 .cindex "binary zero" "in lookup key"
6393 .cindex "Courier"
6394 .cindex "&_/etc/userdbshadow.dat_&"
6395 .cindex "dbmnz lookup type"
6396 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6397 is not included in the key that is passed to the DBM library. You may need this
6398 if you want to look up data in files that are created by or shared with some
6399 other application that does not use terminating zeros. For example, you need to
6400 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6401 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6402 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6403 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6404 .next
6405 .cindex "lookup" "dsearch"
6406 .cindex "dsearch lookup type"
6407 &(dsearch)&: The given file must be a directory; this is searched for an entry
6408 whose name is the key by calling the &[lstat()]& function. The key may not
6409 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6410 the lookup is the name of the entry, which may be a file, directory,
6411 symbolic link, or any other kind of directory entry. An example of how this
6412 lookup can be used to support virtual domains is given in section
6413 &<<SECTvirtualdomains>>&.
6414 .next
6415 .cindex "lookup" "iplsearch"
6416 .cindex "iplsearch lookup type"
6417 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6418 terminated by a colon or white space or the end of the line. The keys in the
6419 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6420 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6421 being interpreted as a key terminator. For example:
6422 .code
6423 1.2.3.4:           data for 1.2.3.4
6424 192.168.0.0/16:    data for 192.168.0.0/16
6425 "abcd::cdab":      data for abcd::cdab
6426 "abcd:abcd::/32"   data for abcd:abcd::/32
6427 .endd
6428 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6429 file is searched linearly, using the CIDR masks where present, until a matching
6430 key is found. The first key that matches is used; there is no attempt to find a
6431 &"best"& match. Apart from the way the keys are matched, the processing for
6432 &(iplsearch)& is the same as for &(lsearch)&.
6433
6434 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6435 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6436 lookup types support only literal keys.
6437
6438 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6439 the implicit key is the host's IP address rather than its name (see section
6440 &<<SECThoslispatsikey>>&).
6441 .next
6442 .cindex "linear search"
6443 .cindex "lookup" "lsearch"
6444 .cindex "lsearch lookup type"
6445 .cindex "case sensitivity" "in lsearch lookup"
6446 &(lsearch)&: The given file is a text file that is searched linearly for a
6447 line beginning with the search key, terminated by a colon or white space or the
6448 end of the line. The search is case-insensitive; that is, upper and lower case
6449 letters are treated as the same. The first occurrence of the key that is found
6450 in the file is used.
6451
6452 White space between the key and the colon is permitted. The remainder of the
6453 line, with leading and trailing white space removed, is the data. This can be
6454 continued onto subsequent lines by starting them with any amount of white
6455 space, but only a single space character is included in the data at such a
6456 junction. If the data begins with a colon, the key must be terminated by a
6457 colon, for example:
6458 .code
6459 baduser:  :fail:
6460 .endd
6461 Empty lines and lines beginning with # are ignored, even if they occur in the
6462 middle of an item. This is the traditional textual format of alias files. Note
6463 that the keys in an &(lsearch)& file are literal strings. There is no
6464 wildcarding of any kind.
6465
6466 .cindex "lookup" "lsearch &-- colons in keys"
6467 .cindex "white space" "in lsearch key"
6468 In most &(lsearch)& files, keys are not required to contain colons or #
6469 characters, or white space. However, if you need this feature, it is available.
6470 If a key begins with a doublequote character, it is terminated only by a
6471 matching quote (or end of line), and the normal escaping rules apply to its
6472 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6473 quoted keys (exactly as for unquoted keys). There is no special handling of
6474 quotes for the data part of an &(lsearch)& line.
6475
6476 .next
6477 .cindex "NIS lookup type"
6478 .cindex "lookup" "NIS"
6479 .cindex "binary zero" "in lookup key"
6480 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6481 the given key, without a terminating binary zero. There is a variant called
6482 &(nis0)& which does include the terminating binary zero in the key. This is
6483 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6484 aliases; the full map names must be used.
6485
6486 .next
6487 .cindex "wildlsearch lookup type"
6488 .cindex "lookup" "wildlsearch"
6489 .cindex "nwildlsearch lookup type"
6490 .cindex "lookup" "nwildlsearch"
6491 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6492 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6493 the file may be wildcarded. The difference between these two lookup types is
6494 that for &(wildlsearch)&, each key in the file is string-expanded before being
6495 used, whereas for &(nwildlsearch)&, no expansion takes place.
6496
6497 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6498 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6499 file that are regular expressions can be made case-sensitive by the use of
6500 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6501
6502 . ==== As this is a nested list, any displays it contains must be indented
6503 . ==== as otherwise they are too far to the left.
6504
6505 .olist
6506 The string may begin with an asterisk to mean &"ends with"&. For example:
6507 .code
6508     *.a.b.c       data for anything.a.b.c
6509     *fish         data for anythingfish
6510 .endd
6511 .next
6512 The string may begin with a circumflex to indicate a regular expression. For
6513 example, for &(wildlsearch)&:
6514 .code
6515     ^\N\d+\.a\.b\N    data for <digits>.a.b
6516 .endd
6517 Note the use of &`\N`& to disable expansion of the contents of the regular
6518 expression. If you are using &(nwildlsearch)&, where the keys are not
6519 string-expanded, the equivalent entry is:
6520 .code
6521     ^\d+\.a\.b        data for <digits>.a.b
6522 .endd
6523 The case-insensitive flag is set at the start of compiling the regular
6524 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6525 For example, to make the entire pattern case-sensitive:
6526 .code
6527     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6528 .endd
6529
6530 If the regular expression contains white space or colon characters, you must
6531 either quote it (see &(lsearch)& above), or represent these characters in other
6532 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6533 colon. This may be easier than quoting, because if you quote, you have to
6534 escape all the backslashes inside the quotes.
6535
6536 &*Note*&: It is not possible to capture substrings in a regular expression
6537 match for later use, because the results of all lookups are cached. If a lookup
6538 is repeated, the result is taken from the cache, and no actual pattern matching
6539 takes place. The values of all the numeric variables are unset after a
6540 &((n)wildlsearch)& match.
6541
6542 .next
6543 Although I cannot see it being of much use, the general matching function that
6544 is used to implement &((n)wildlsearch)& means that the string may begin with a
6545 lookup name terminated by a semicolon, and followed by lookup data. For
6546 example:
6547 .code
6548     cdb;/some/file  data for keys that match the file
6549 .endd
6550 The data that is obtained from the nested lookup is discarded.
6551 .endlist olist
6552
6553 Keys that do not match any of these patterns are interpreted literally. The
6554 continuation rules for the data are the same as for &(lsearch)&, and keys may
6555 be followed by optional colons.
6556
6557 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6558 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6559 lookup types support only literal keys.
6560 .endlist ilist
6561
6562
6563 .section "Query-style lookup types" "SECID62"
6564 .cindex "lookup" "query-style types"
6565 .cindex "query-style lookup" "list of types"
6566 The supported query-style lookup types are listed below. Further details about
6567 many of them are given in later sections.
6568
6569 .ilist
6570 .cindex "DNS" "as a lookup type"
6571 .cindex "lookup" "DNS"
6572 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6573 are given in the supplied query. The resulting data is the contents of the
6574 records. See section &<<SECTdnsdb>>&.
6575 .next
6576 .cindex "InterBase lookup type"
6577 .cindex "lookup" "InterBase"
6578 &(ibase)&: This does a lookup in an InterBase database.
6579 .next
6580 .cindex "LDAP" "lookup type"
6581 .cindex "lookup" "LDAP"
6582 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6583 returns attributes from a single entry. There is a variant called &(ldapm)&
6584 that permits values from multiple entries to be returned. A third variant
6585 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6586 any attribute values. See section &<<SECTldap>>&.
6587 .next
6588 .cindex "MySQL" "lookup type"
6589 .cindex "lookup" "MySQL"
6590 &(mysql)&: The format of the query is an SQL statement that is passed to a
6591 MySQL database. See section &<<SECTsql>>&.
6592 .next
6593 .cindex "NIS+ lookup type"
6594 .cindex "lookup" "NIS+"
6595 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6596 the field to be returned. See section &<<SECTnisplus>>&.
6597 .next
6598 .cindex "Oracle" "lookup type"
6599 .cindex "lookup" "Oracle"
6600 &(oracle)&: The format of the query is an SQL statement that is passed to an
6601 Oracle database. See section &<<SECTsql>>&.
6602 .next
6603 .cindex "lookup" "passwd"
6604 .cindex "passwd lookup type"
6605 .cindex "&_/etc/passwd_&"
6606 &(passwd)& is a query-style lookup with queries that are just user names. The
6607 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6608 success, the result string is the same as you would get from an &(lsearch)&
6609 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6610 password value. For example:
6611 .code
6612 *:42:42:King Rat:/home/kr:/bin/bash
6613 .endd
6614 .next
6615 .cindex "PostgreSQL lookup type"
6616 .cindex "lookup" "PostgreSQL"
6617 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6618 PostgreSQL database. See section &<<SECTsql>>&.
6619
6620 .next
6621 .cindex "sqlite lookup type"
6622 .cindex "lookup" "sqlite"
6623 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6624 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6625
6626 .next
6627 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6628 not likely to be useful in normal operation.
6629 .next
6630 .cindex "whoson lookup type"
6631 .cindex "lookup" "whoson"
6632 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6633 allows a server to check whether a particular (dynamically allocated) IP
6634 address is currently allocated to a known (trusted) user and, optionally, to
6635 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6636 at one time for &"POP before SMTP"& authentication, but that approach has been
6637 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6638 &"POP before SMTP"& checking using ACL statements such as
6639 .code
6640 require condition = \
6641   ${lookup whoson {$sender_host_address}{yes}{no}}
6642 .endd
6643 The query consists of a single IP address. The value returned is the name of
6644 the authenticated user, which is stored in the variable &$value$&. However, in
6645 this example, the data in &$value$& is not used; the result of the lookup is
6646 one of the fixed strings &"yes"& or &"no"&.
6647 .endlist
6648
6649
6650
6651 .section "Temporary errors in lookups" "SECID63"
6652 .cindex "lookup" "temporary error in"
6653 Lookup functions can return temporary error codes if the lookup cannot be
6654 completed. For example, an SQL or LDAP database might be unavailable. For this
6655 reason, it is not advisable to use a lookup that might do this for critical
6656 options such as a list of local domains.
6657
6658 When a lookup cannot be completed in a router or transport, delivery
6659 of the message (to the relevant address) is deferred, as for any other
6660 temporary error. In other circumstances Exim may assume the lookup has failed,
6661 or may give up altogether.
6662
6663
6664
6665 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6666 .cindex "wildcard lookups"
6667 .cindex "lookup" "default values"
6668 .cindex "lookup" "wildcard"
6669 .cindex "lookup" "* added to type"
6670 .cindex "default" "in single-key lookups"
6671 In this context, a &"default value"& is a value specified by the administrator
6672 that is to be used if a lookup fails.
6673
6674 &*Note:*& This section applies only to single-key lookups. For query-style
6675 lookups, the facilities of the query language must be used. An attempt to
6676 specify a default for a query-style lookup provokes an error.
6677
6678 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6679 and the initial lookup fails, the key &"*"& is looked up in the file to
6680 provide a default value. See also the section on partial matching below.
6681
6682 .cindex "*@ with single-key lookup"
6683 .cindex "lookup" "*@ added to type"
6684 .cindex "alias file" "per-domain default"
6685 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6686 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6687 character, a second lookup is done with everything before the last @ replaced
6688 by *. This makes it possible to provide per-domain defaults in alias files
6689 that include the domains in the keys. If the second lookup fails (or doesn't
6690 take place because there is no @ in the key), &"*"& is looked up.
6691 For example, a &(redirect)& router might contain:
6692 .code
6693 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6694 .endd
6695 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6696 looks up these keys, in this order:
6697 .code
6698 jane@eyre.example
6699 *@eyre.example
6700 *
6701 .endd
6702 The data is taken from whichever key it finds first. &*Note*&: In an
6703 &(lsearch)& file, this does not mean the first of these keys in the file. A
6704 complete scan is done for each key, and only if it is not found at all does
6705 Exim move on to try the next key.
6706
6707
6708
6709 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6710 .cindex "partial matching"
6711 .cindex "wildcard lookups"
6712 .cindex "lookup" "partial matching"
6713 .cindex "lookup" "wildcard"
6714 .cindex "asterisk" "in search type"
6715 The normal operation of a single-key lookup is to search the file for an exact
6716 match with the given key. However, in a number of situations where domains are
6717 being looked up, it is useful to be able to do partial matching. In this case,
6718 information in the file that has a key starting with &"*."& is matched by any
6719 domain that ends with the components that follow the full stop. For example, if
6720 a key in a DBM file is
6721 .code
6722 *.dates.fict.example
6723 .endd
6724 then when partial matching is enabled this is matched by (amongst others)
6725 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6726 by &'dates.fict.example'&, if that does not appear as a separate key in the
6727 file.
6728
6729 &*Note*&: Partial matching is not available for query-style lookups. It is
6730 also not available for any lookup items in address lists (see section
6731 &<<SECTaddresslist>>&).
6732
6733 Partial matching is implemented by doing a series of separate lookups using
6734 keys constructed by modifying the original subject key. This means that it can
6735 be used with any of the single-key lookup types, provided that
6736 partial matching keys
6737 beginning with a special prefix (default &"*."&) are included in the data file.
6738 Keys in the file that do not begin with the prefix are matched only by
6739 unmodified subject keys when partial matching is in use.
6740
6741 Partial matching is requested by adding the string &"partial-"& to the front of
6742 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6743 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6744 is added at the start of the subject key, and it is looked up again. If that
6745 fails, further lookups are tried with dot-separated components removed from the
6746 start of the subject key, one-by-one, and &"*."& added on the front of what
6747 remains.
6748
6749 A minimum number of two non-* components are required. This can be adjusted
6750 by including a number before the hyphen in the search type. For example,
6751 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6752 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6753 subject key is &'2250.dates.fict.example'& then the following keys are looked
6754 up when the minimum number of non-* components is two:
6755 .code
6756 2250.dates.fict.example
6757 *.2250.dates.fict.example
6758 *.dates.fict.example
6759 *.fict.example
6760 .endd
6761 As soon as one key in the sequence is successfully looked up, the lookup
6762 finishes.
6763
6764 .cindex "lookup" "partial matching &-- changing prefix"
6765 .cindex "prefix" "for partial matching"
6766 The use of &"*."& as the partial matching prefix is a default that can be
6767 changed. The motivation for this feature is to allow Exim to operate with file
6768 formats that are used by other MTAs. A different prefix can be supplied in
6769 parentheses instead of the hyphen after &"partial"&. For example:
6770 .code
6771 domains = partial(.)lsearch;/some/file
6772 .endd
6773 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6774 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6775 components is unchanged). The prefix may consist of any punctuation characters
6776 other than a closing parenthesis. It may be empty, for example:
6777 .code
6778 domains = partial1()cdb;/some/file
6779 .endd
6780 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6781 &`a.b.c`&, &`b.c`&, and &`c`&.
6782
6783 If &"partial0"& is specified, what happens at the end (when the lookup with
6784 just one non-wild component has failed, and the original key is shortened right
6785 down to the null string) depends on the prefix:
6786
6787 .ilist
6788 If the prefix has zero length, the whole lookup fails.
6789 .next
6790 If the prefix has length 1, a lookup for just the prefix is done. For
6791 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6792 .next
6793 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6794 remainder is looked up. With the default prefix, therefore, the final lookup is
6795 for &"*"& on its own.
6796 .next
6797 Otherwise, the whole prefix is looked up.
6798 .endlist
6799
6800
6801 If the search type ends in &"*"& or &"*@"& (see section
6802 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6803 this implies happens after all partial lookups have failed. If &"partial0"& is
6804 specified, adding &"*"& to the search type has no effect with the default
6805 prefix, because the &"*"& key is already included in the sequence of partial
6806 lookups. However, there might be a use for lookup types such as
6807 &"partial0(.)lsearch*"&.
6808
6809 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6810 in domain lists and the like. Partial matching works only in terms of
6811 dot-separated components; a key such as &`*fict.example`&
6812 in a database file is useless, because the asterisk in a partial matching
6813 subject key is always followed by a dot.
6814
6815
6816
6817
6818 .section "Lookup caching" "SECID64"
6819 .cindex "lookup" "caching"
6820 .cindex "caching" "lookup data"
6821 Exim caches all lookup results in order to avoid needless repetition of
6822 lookups. However, because (apart from the daemon) Exim operates as a collection
6823 of independent, short-lived processes, this caching applies only within a
6824 single Exim process. There is no inter-process lookup caching facility.
6825
6826 For single-key lookups, Exim keeps the relevant files open in case there is
6827 another lookup that needs them. In some types of configuration this can lead to
6828 many files being kept open for messages with many recipients. To avoid hitting
6829 the operating system limit on the number of simultaneously open files, Exim
6830 closes the least recently used file when it needs to open more files than its
6831 own internal limit, which can be changed via the &%lookup_open_max%& option.
6832
6833 The single-key lookup files are closed and the lookup caches are flushed at
6834 strategic points during delivery &-- for example, after all routing is
6835 complete.
6836
6837
6838
6839
6840 .section "Quoting lookup data" "SECID65"
6841 .cindex "lookup" "quoting"
6842 .cindex "quoting" "in lookups"
6843 When data from an incoming message is included in a query-style lookup, there
6844 is the possibility of special characters in the data messing up the syntax of
6845 the query. For example, a NIS+ query that contains
6846 .code
6847 [name=$local_part]
6848 .endd
6849 will be broken if the local part happens to contain a closing square bracket.
6850 For NIS+, data can be enclosed in double quotes like this:
6851 .code
6852 [name="$local_part"]
6853 .endd
6854 but this still leaves the problem of a double quote in the data. The rule for
6855 NIS+ is that double quotes must be doubled. Other lookup types have different
6856 rules, and to cope with the differing requirements, an expansion operator
6857 of the following form is provided:
6858 .code
6859 ${quote_<lookup-type>:<string>}
6860 .endd
6861 For example, the safest way to write the NIS+ query is
6862 .code
6863 [name="${quote_nisplus:$local_part}"]
6864 .endd
6865 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6866 operator can be used for all lookup types, but has no effect for single-key
6867 lookups, since no quoting is ever needed in their key strings.
6868
6869
6870
6871
6872 .section "More about dnsdb" "SECTdnsdb"
6873 .cindex "dnsdb lookup"
6874 .cindex "lookup" "dnsdb"
6875 .cindex "DNS" "as a lookup type"
6876 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6877 of a record type and a domain name, separated by an equals sign. For example,
6878 an expansion string could contain:
6879 .code
6880 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6881 .endd
6882 If the lookup succeeds, the result is placed in &$value$&, which in this case
6883 is used on its own as the result. If the lookup does not succeed, the
6884 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6885 &<<SECTforexpfai>>& for an explanation of what this means.
6886
6887 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6888 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6889 If no type is given, TXT is assumed.
6890
6891 For any record type, if multiple records are found, the data is returned as a
6892 concatenation, with newline as the default separator. The order, of course,
6893 depends on the DNS resolver. You can specify a different separator character
6894 between multiple records by putting a right angle-bracket followed immediately
6895 by the new separator at the start of the query. For example:
6896 .code
6897 ${lookup dnsdb{>: a=host1.example}}
6898 .endd
6899 It is permitted to specify a space as the separator character. Further
6900 white space is ignored.
6901 For lookup types that return multiple fields per record,
6902 an alternate field separator can be specified using a comma after the main
6903 separator character, followed immediately by the field separator.
6904
6905 .cindex "PTR record" "in &(dnsdb)& lookup"
6906 When the type is PTR,
6907 the data can be an IP address, written as normal; inversion and the addition of
6908 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6909 .code
6910 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6911 .endd
6912 If the data for a PTR record is not a syntactically valid IP address, it is not
6913 altered and nothing is added.
6914
6915 .cindex "MX record" "in &(dnsdb)& lookup"
6916 .cindex "SRV record" "in &(dnsdb)& lookup"
6917 For an MX lookup, both the preference value and the host name are returned for
6918 each record, separated by a space. For an SRV lookup, the priority, weight,
6919 port, and host name are returned for each record, separated by spaces.
6920 The field separator can be modified as above.
6921
6922 .cindex "TXT record" "in &(dnsdb)& lookup"
6923 .cindex "SPF record" "in &(dnsdb)& lookup"
6924 For TXT records with multiple items of data, only the first item is returned,
6925 unless a field separator is specified.
6926 To concatenate items without a separator, use a semicolon instead.
6927 For SPF records the
6928 default behaviour is to concatenate multiple items without using a separator.
6929 .code
6930 ${lookup dnsdb{>\n,: txt=a.b.example}}
6931 ${lookup dnsdb{>\n; txt=a.b.example}}
6932 ${lookup dnsdb{spf=example.org}}
6933 .endd
6934 It is permitted to specify a space as the separator character. Further
6935 white space is ignored.
6936
6937 .cindex "SOA record" "in &(dnsdb)& lookup"
6938 For an SOA lookup, while no result is obtained the lookup is redone with
6939 successively more leading components dropped from the given domain.
6940 Only the primary-nameserver field is returned unless a field separator is
6941 specified.
6942 .code
6943 ${lookup dnsdb{>:,; soa=a.b.example.com}}
6944 .endd
6945
6946 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6947 .cindex "dnsdb modifiers"
6948 .cindex "modifiers" "dnsdb"
6949 .cindex "options" "dnsdb"
6950 Modifiers for &(dnsdb)& lookups are given by optional keywords,
6951 each followed by a comma,
6952 that may appear before the record type.
6953
6954 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6955 temporary DNS error for any of them, the behaviour is controlled by
6956 a defer-option modifier.
6957 The possible keywords are
6958 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6959 With &"strict"& behaviour, any temporary DNS error causes the
6960 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6961 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6962 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6963 error causes the whole lookup to defer only if none of the other lookups
6964 succeed. The default is &"lax"&, so the following lookups are equivalent:
6965 .code
6966 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6967 ${lookup dnsdb{a=one.host.com:two.host.com}}
6968 .endd
6969 Thus, in the default case, as long as at least one of the DNS lookups
6970 yields some data, the lookup succeeds.
6971
6972 .cindex "DNSSEC" "dns lookup"
6973 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6974 The possible keywords are
6975 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6976 With &"strict"& or &"lax"& DNSSEC information is requested
6977 with the lookup.
6978 With &"strict"& a response from the DNS resolver that
6979 is not labelled as authenticated data
6980 is treated as equivalent to a temporary DNS error.
6981 The default is &"never"&.
6982
6983 See also the &$lookup_dnssec_authenticated$& variable.
6984
6985 .cindex timeout "dns lookup"
6986 .cindex "DNS" timeout
6987 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
6988 The form is &"retrans_VAL"& where VAL is an Exim time specification
6989 (e.g. &"5s"&).
6990 The default value is set by the main configuration option &%dns_retrans%&.
6991
6992 Retries for the dnsdb lookup can be controlled by a retry modifier.
6993 The form if &"retry_VAL"& where VAL is an integer.
6994 The default count is set by the main configuration option &%dns_retry%&.
6995
6996 .new
6997 .cindex cacheing "of dns lookup"
6998 .cindex TTL "of dns lookup"
6999 .cindex DNS TTL
7000 Dnsdb lookup results are cached within a single process (and its children).
7001 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7002 value of the set of returned DNS records.
7003 .wen
7004
7005
7006 .section "Pseudo dnsdb record types" "SECID66"
7007 .cindex "MX record" "in &(dnsdb)& lookup"
7008 By default, both the preference value and the host name are returned for
7009 each MX record, separated by a space. If you want only host names, you can use
7010 the pseudo-type MXH:
7011 .code
7012 ${lookup dnsdb{mxh=a.b.example}}
7013 .endd
7014 In this case, the preference values are omitted, and just the host names are
7015 returned.
7016
7017 .cindex "name server for enclosing domain"
7018 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7019 records on the given domain, but if none are found, it removes the first
7020 component of the domain name, and tries again. This process continues until NS
7021 records are found or there are no more components left (or there is a DNS
7022 error). In other words, it may return the name servers for a top-level domain,
7023 but it never returns the root name servers. If there are no NS records for the
7024 top-level domain, the lookup fails. Consider these examples:
7025 .code
7026 ${lookup dnsdb{zns=xxx.quercite.com}}
7027 ${lookup dnsdb{zns=xxx.edu}}
7028 .endd
7029 Assuming that in each case there are no NS records for the full domain name,
7030 the first returns the name servers for &%quercite.com%&, and the second returns
7031 the name servers for &%edu%&.
7032
7033 You should be careful about how you use this lookup because, unless the
7034 top-level domain does not exist, the lookup always returns some host names. The
7035 sort of use to which this might be put is for seeing if the name servers for a
7036 given domain are on a blacklist. You can probably assume that the name servers
7037 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7038 such a list.
7039
7040 .cindex "CSA" "in &(dnsdb)& lookup"
7041 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7042 records according to the CSA rules, which are described in section
7043 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7044 not sufficient because of the extra parent domain search behaviour of CSA. The
7045 result of a successful lookup such as:
7046 .code
7047 ${lookup dnsdb {csa=$sender_helo_name}}
7048 .endd
7049 has two space-separated fields: an authorization code and a target host name.
7050 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7051 authorization required but absent, or &"?"& for unknown.
7052
7053 .cindex "A+" "in &(dnsdb)& lookup"
7054 The pseudo-type A+ performs an AAAA
7055 and then an A lookup.  All results are returned; defer processing
7056 (see below) is handled separately for each lookup.  Example:
7057 .code
7058 ${lookup dnsdb {>; a+=$sender_helo_name}}
7059 .endd
7060
7061
7062 .section "Multiple dnsdb lookups" "SECID67"
7063 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7064 However, you can specify a list of domains or IP addresses in a single
7065 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7066 the default separator, but with the ability to change this. For example:
7067 .code
7068 ${lookup dnsdb{one.domain.com:two.domain.com}}
7069 ${lookup dnsdb{a=one.host.com:two.host.com}}
7070 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7071 .endd
7072 In order to retain backwards compatibility, there is one special case: if
7073 the lookup type is PTR and no change of separator is specified, Exim looks
7074 to see if the rest of the string is precisely one IPv6 address. In this
7075 case, it does not treat it as a list.
7076
7077 The data from each lookup is concatenated, with newline separators by default,
7078 in the same way that multiple DNS records for a single item are handled. A
7079 different separator can be specified, as described above.
7080
7081
7082
7083
7084 .section "More about LDAP" "SECTldap"
7085 .cindex "LDAP" "lookup, more about"
7086 .cindex "lookup" "LDAP"
7087 .cindex "Solaris" "LDAP"
7088 The original LDAP implementation came from the University of Michigan; this has
7089 become &"Open LDAP"&, and there are now two different releases. Another
7090 implementation comes from Netscape, and Solaris 7 and subsequent releases
7091 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7092 the lookup function level, their error handling is different. For this reason
7093 it is necessary to set a compile-time variable when building Exim with LDAP, to
7094 indicate which LDAP library is in use. One of the following should appear in
7095 your &_Local/Makefile_&:
7096 .code
7097 LDAP_LIB_TYPE=UMICHIGAN
7098 LDAP_LIB_TYPE=OPENLDAP1
7099 LDAP_LIB_TYPE=OPENLDAP2
7100 LDAP_LIB_TYPE=NETSCAPE
7101 LDAP_LIB_TYPE=SOLARIS
7102 .endd
7103 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7104 same interface as the University of Michigan version.
7105
7106 There are three LDAP lookup types in Exim. These behave slightly differently in
7107 the way they handle the results of a query:
7108
7109 .ilist
7110 &(ldap)& requires the result to contain just one entry; if there are more, it
7111 gives an error.
7112 .next
7113 &(ldapdn)& also requires the result to contain just one entry, but it is the
7114 Distinguished Name that is returned rather than any attribute values.
7115 .next
7116 &(ldapm)& permits the result to contain more than one entry; the attributes
7117 from all of them are returned.
7118 .endlist
7119
7120
7121 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7122 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7123 the data returned by a successful lookup is described in the next section.
7124 First we explain how LDAP queries are coded.
7125
7126
7127 .section "Format of LDAP queries" "SECTforldaque"
7128 .cindex "LDAP" "query format"
7129 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7130 the configuration of a &(redirect)& router one might have this setting:
7131 .code
7132 data = ${lookup ldap \
7133   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7134   c=UK?mailbox?base?}}
7135 .endd
7136 .cindex "LDAP" "with TLS"
7137 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7138 secure (encrypted) LDAP connections. The second of these ensures that an
7139 encrypted TLS connection is used.
7140
7141 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7142 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7143 See the &%ldap_start_tls%& option.
7144
7145 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7146 controlled. Every part of the TLS configuration can be configured by settings in
7147 &_exim.conf_&. Depending on the version of the client libraries installed on
7148 your system, some of the initialization may have required setting options in
7149 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7150 certificates. This revealed a nuance where the current UID that exim was
7151 running as could affect which config files it read. With Exim 4.83, these
7152 methods become optional, only taking effect if not specifically set in
7153 &_exim.conf_&.
7154
7155
7156 .section "LDAP quoting" "SECID68"
7157 .cindex "LDAP" "quoting"
7158 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7159 and the second because the LDAP query is represented as a URL. Furthermore,
7160 within an LDAP query, two different kinds of quoting are required. For this
7161 reason, there are two different LDAP-specific quoting operators.
7162
7163 The &%quote_ldap%& operator is designed for use on strings that are part of
7164 filter specifications. Conceptually, it first does the following conversions on
7165 the string:
7166 .code
7167 *   =>   \2A
7168 (   =>   \28
7169 )   =>   \29
7170 \   =>   \5C
7171 .endd
7172 in accordance with RFC 2254. The resulting string is then quoted according
7173 to the rules for URLs, that is, all non-alphanumeric characters except
7174 .code
7175 ! $ ' - . _ ( ) * +
7176 .endd
7177 are converted to their hex values, preceded by a percent sign. For example:
7178 .code
7179 ${quote_ldap: a(bc)*, a<yz>; }
7180 .endd
7181 yields
7182 .code
7183 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7184 .endd
7185 Removing the URL quoting, this is (with a leading and a trailing space):
7186 .code
7187 a\28bc\29\2A, a<yz>;
7188 .endd
7189 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7190 base DN specifications in queries. Conceptually, it first converts the string
7191 by inserting a backslash in front of any of the following characters:
7192 .code
7193 , + " \ < > ;
7194 .endd
7195 It also inserts a backslash before any leading spaces or # characters, and
7196 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7197 is then quoted according to the rules for URLs. For example:
7198 .code
7199 ${quote_ldap_dn: a(bc)*, a<yz>; }
7200 .endd
7201 yields
7202 .code
7203 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7204 .endd
7205 Removing the URL quoting, this is (with a trailing space):
7206 .code
7207 \ a(bc)*\, a\<yz\>\;\
7208 .endd
7209 There are some further comments about quoting in the section on LDAP
7210 authentication below.
7211
7212
7213 .section "LDAP connections" "SECID69"
7214 .cindex "LDAP" "connections"
7215 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7216 is in use, via a Unix domain socket. The example given above does not specify
7217 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7218 by starting it with
7219 .code
7220 ldap://<hostname>:<port>/...
7221 .endd
7222 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7223 used. When no server is specified in a query, a list of default servers is
7224 taken from the &%ldap_default_servers%& configuration option. This supplies a
7225 colon-separated list of servers which are tried in turn until one successfully
7226 handles a query, or there is a serious error. Successful handling either
7227 returns the requested data, or indicates that it does not exist. Serious errors
7228 are syntactical, or multiple values when only a single value is expected.
7229 Errors which cause the next server to be tried are connection failures, bind
7230 failures, and timeouts.
7231
7232 For each server name in the list, a port number can be given. The standard way
7233 of specifying a host and port is to use a colon separator (RFC 1738). Because
7234 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7235 doubled. For example
7236 .code
7237 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7238 .endd
7239 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7240 to the LDAP library with no server name, and the library's default (normally
7241 the local host) is used.
7242
7243 If you are using the OpenLDAP library, you can connect to an LDAP server using
7244 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7245 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7246 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7247 not available.
7248
7249 For this type of connection, instead of a host name for the server, a pathname
7250 for the socket is required, and the port number is not relevant. The pathname
7251 can be specified either as an item in &%ldap_default_servers%&, or inline in
7252 the query. In the former case, you can have settings such as
7253 .code
7254 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7255 .endd
7256 When the pathname is given in the query, you have to escape the slashes as
7257 &`%2F`& to fit in with the LDAP URL syntax. For example:
7258 .code
7259 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7260 .endd
7261 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7262 a pathname, it uses the Unix domain socket code, even if the query actually
7263 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7264 socket connection. This behaviour means that you can use a setting of
7265 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7266 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7267 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7268 backup host.
7269
7270 If an explicit &`ldapi`& type is given in a query when a host name is
7271 specified, an error is diagnosed. However, if there are more items in
7272 &%ldap_default_servers%&, they are tried. In other words:
7273
7274 .ilist
7275 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7276 interface.
7277 .next
7278 Using &`ldapi`& with a host name causes an error.
7279 .endlist
7280
7281
7282 Using &`ldapi`& with no host or path in the query, and no setting of
7283 &%ldap_default_servers%&, does whatever the library does by default.
7284
7285
7286
7287 .section "LDAP authentication and control information" "SECID70"
7288 .cindex "LDAP" "authentication"
7289 The LDAP URL syntax provides no way of passing authentication and other control
7290 information to the server. To make this possible, the URL in an LDAP query may
7291 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7292 spaces. If a value contains spaces it must be enclosed in double quotes, and
7293 when double quotes are used, backslash is interpreted in the usual way inside
7294 them. The following names are recognized:
7295 .display
7296 &`DEREFERENCE`&  set the dereferencing parameter
7297 &`NETTIME    `&  set a timeout for a network operation
7298 &`USER       `&  set the DN, for authenticating the LDAP bind
7299 &`PASS       `&  set the password, likewise
7300 &`REFERRALS  `&  set the referrals parameter
7301 &`SERVERS    `&  set alternate server list for this query only
7302 &`SIZE       `&  set the limit for the number of entries returned
7303 &`TIME       `&  set the maximum waiting time for a query
7304 .endd
7305 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7306 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7307 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7308 library from trying to follow referrals issued by the LDAP server.
7309
7310 The name CONNECT is an obsolete name for NETTIME, retained for
7311 backwards compatibility. This timeout (specified as a number of seconds) is
7312 enforced from the client end for operations that can be carried out over a
7313 network. Specifically, it applies to network connections and calls to the
7314 &'ldap_result()'& function. If the value is greater than zero, it is used if
7315 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7316 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7317 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7318 Netscape SDK; for OpenLDAP no action is taken.
7319
7320 The TIME parameter (also a number of seconds) is passed to the server to
7321 set a server-side limit on the time taken to complete a search.
7322
7323 The SERVERS parameter allows you to specify an alternate list of ldap servers
7324 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7325 default list of ldap servers, and a single lookup can specify a single ldap
7326 server to use.  But when you need to do a lookup with a list of servers that is
7327 different than the default list (maybe different order, maybe a completely
7328 different set of servers), the SERVERS parameter allows you to specify this
7329 alternate list (colon-separated).
7330
7331 Here is an example of an LDAP query in an Exim lookup that uses some of these
7332 values. This is a single line, folded to fit on the page:
7333 .code
7334 ${lookup ldap
7335   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7336   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7337   {$value}fail}
7338 .endd
7339 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7340 any of the auxiliary data. Exim configuration settings that include lookups
7341 which contain password information should be preceded by &"hide"& to prevent
7342 non-admin users from using the &%-bP%& option to see their values.
7343
7344 The auxiliary data items may be given in any order. The default is no
7345 connection timeout (the system timeout is used), no user or password, no limit
7346 on the number of entries returned, and no time limit on queries.
7347
7348 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7349 removes any URL quoting that it may contain before passing it LDAP. Apparently
7350 some libraries do this for themselves, but some do not. Removing the URL
7351 quoting has two advantages:
7352
7353 .ilist
7354 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7355 DNs as with DNs inside actual queries.
7356 .next
7357 It permits spaces inside USER= DNs.
7358 .endlist
7359
7360 For example, a setting such as
7361 .code
7362 USER=cn=${quote_ldap_dn:$1}
7363 .endd
7364 should work even if &$1$& contains spaces.
7365
7366 Expanded data for the PASS= value should be quoted using the &%quote%&
7367 expansion operator, rather than the LDAP quote operators. The only reason this
7368 field needs quoting is to ensure that it conforms to the Exim syntax, which
7369 does not allow unquoted spaces. For example:
7370 .code
7371 PASS=${quote:$3}
7372 .endd
7373 The LDAP authentication mechanism can be used to check passwords as part of
7374 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7375 &<<CHAPexpand>>&.
7376
7377
7378
7379 .section "Format of data returned by LDAP" "SECID71"
7380 .cindex "LDAP" "returned data formats"
7381 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7382 as a sequence of values, for example
7383 .code
7384 cn=manager, o=University of Cambridge, c=UK
7385 .endd
7386 The &(ldap)& lookup type generates an error if more than one entry matches the
7387 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7388 the result between the data from different entries. It is possible for multiple
7389 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7390 you know that whatever values are returned all came from a single entry in the
7391 directory.
7392
7393 In the common case where you specify a single attribute in your LDAP query, the
7394 result is not quoted, and does not contain the attribute name. If the attribute
7395 has multiple values, they are separated by commas.
7396
7397 If you specify multiple attributes, the result contains space-separated, quoted
7398 strings, each preceded by the attribute name and an equals sign. Within the
7399 quotes, the quote character, backslash, and newline are escaped with
7400 backslashes, and commas are used to separate multiple values for the attribute.
7401 Any commas in attribute values are doubled
7402 (permitting treatment of the values as a comma-separated list).
7403 Apart from the escaping, the string within quotes takes the same form as the
7404 output when a single attribute is requested. Specifying no attributes is the
7405 same as specifying all of an entry's attributes.
7406
7407 Here are some examples of the output format. The first line of each pair is an
7408 LDAP query, and the second is the data that is returned. The attribute called
7409 &%attr1%& has two values, one of them with an embedded comma, whereas
7410 &%attr2%& has only one value:
7411 .code
7412 ldap:///o=base?attr1?sub?(uid=fred)
7413 value1.1,value1,,2
7414
7415 ldap:///o=base?attr2?sub?(uid=fred)
7416 value two
7417
7418 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7419 attr1="value1.1,value1,,2" attr2="value two"
7420
7421 ldap:///o=base??sub?(uid=fred)
7422 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7423 .endd
7424 You can
7425 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7426 results of LDAP lookups.
7427 The &%extract%& operator in string expansions can be used to pick out
7428 individual fields from data that consists of &'key'&=&'value'& pairs.
7429 The &%listextract%& operator should be used to pick out individual values
7430 of attributes, even when only a single value is expected.
7431 The doubling of embedded commas allows you to use the returned data as a
7432 comma separated list (using the "<," syntax for changing the input list separator).
7433
7434
7435
7436
7437 .section "More about NIS+" "SECTnisplus"
7438 .cindex "NIS+ lookup type"
7439 .cindex "lookup" "NIS+"
7440 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7441 and field name. If this is given, the result of a successful query is the
7442 contents of the named field; otherwise the result consists of a concatenation
7443 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7444 values containing spaces are quoted. For example, the query
7445 .code
7446 [name=mg1456],passwd.org_dir
7447 .endd
7448 might return the string
7449 .code
7450 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7451 home=/home/mg1456 shell=/bin/bash shadow=""
7452 .endd
7453 (split over two lines here to fit on the page), whereas
7454 .code
7455 [name=mg1456],passwd.org_dir:gcos
7456 .endd
7457 would just return
7458 .code
7459 Martin Guerre
7460 .endd
7461 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7462 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7463 operator is to double any quote characters within the text.
7464
7465
7466
7467 .section "SQL lookups" "SECTsql"
7468 .cindex "SQL lookup types"
7469 .cindex "MySQL" "lookup type"
7470 .cindex "PostgreSQL lookup type"
7471 .cindex "lookup" "MySQL"
7472 .cindex "lookup" "PostgreSQL"
7473 .cindex "Oracle" "lookup type"
7474 .cindex "lookup" "Oracle"
7475 .cindex "InterBase lookup type"
7476 .cindex "lookup" "InterBase"
7477 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7478 databases. Queries for these databases contain SQL statements, so an example
7479 might be
7480 .code
7481 ${lookup mysql{select mailbox from users where id='userx'}\
7482   {$value}fail}
7483 .endd
7484 If the result of the query contains more than one field, the data for each
7485 field in the row is returned, preceded by its name, so the result of
7486 .code
7487 ${lookup pgsql{select home,name from users where id='userx'}\
7488   {$value}}
7489 .endd
7490 might be
7491 .code
7492 home=/home/userx name="Mister X"
7493 .endd
7494 Empty values and values containing spaces are double quoted, with embedded
7495 quotes escaped by a backslash. If the result of the query contains just one
7496 field, the value is passed back verbatim, without a field name, for example:
7497 .code
7498 Mister X
7499 .endd
7500 If the result of the query yields more than one row, it is all concatenated,
7501 with a newline between the data for each row.
7502
7503
7504 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7505 .cindex "MySQL" "lookup type"
7506 .cindex "PostgreSQL lookup type"
7507 .cindex "lookup" "MySQL"
7508 .cindex "lookup" "PostgreSQL"
7509 .cindex "Oracle" "lookup type"
7510 .cindex "lookup" "Oracle"
7511 .cindex "InterBase lookup type"
7512 .cindex "lookup" "InterBase"
7513 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7514 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7515 option (as appropriate) must be set to a colon-separated list of server
7516 information.
7517 (For MySQL and PostgreSQL only, the global option need not be set if all
7518 queries contain their own server information &-- see section
7519 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7520 items: host name, database name, user name, and password. In the case of
7521 Oracle, the host name field is used for the &"service name"&, and the database
7522 name field is not used and should be empty. For example:
7523 .code
7524 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7525 .endd
7526 Because password data is sensitive, you should always precede the setting with
7527 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7528 option. Here is an example where two MySQL servers are listed:
7529 .code
7530 hide mysql_servers = localhost/users/root/secret:\
7531                      otherhost/users/root/othersecret
7532 .endd
7533 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7534 because this is a colon-separated list, the colon has to be doubled. For each
7535 query, these parameter groups are tried in order until a connection is made and
7536 a query is successfully processed. The result of a query may be that no data is
7537 found, but that is still a successful query. In other words, the list of
7538 servers provides a backup facility, not a list of different places to look.
7539
7540 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7541 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7542 respectively, and the characters single-quote, double-quote, and backslash
7543 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7544 addition, escapes the percent and underscore characters. This cannot be done
7545 for MySQL because these escapes are not recognized in contexts where these
7546 characters are not special.
7547
7548 .section "Specifying the server in the query" "SECTspeserque"
7549 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7550 it is possible to specify a list of servers with an individual query. This is
7551 done by starting the query with
7552 .display
7553 &`servers=`&&'server1:server2:server3:...'&&`;`&
7554 .endd
7555 Each item in the list may take one of two forms:
7556 .olist
7557 If it contains no slashes it is assumed to be just a host name. The appropriate
7558 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7559 of the same name, and the remaining parameters (database, user, password) are
7560 taken from there.
7561 .next
7562 If it contains any slashes, it is taken as a complete parameter set.
7563 .endlist
7564 The list of servers is used in exactly the same way as the global list.
7565 Once a connection to a server has happened and a query has been
7566 successfully executed, processing of the lookup ceases.
7567
7568 This feature is intended for use in master/slave situations where updates
7569 are occurring and you want to update the master rather than a slave. If the
7570 master is in the list as a backup for reading, you might have a global setting
7571 like this:
7572 .code
7573 mysql_servers = slave1/db/name/pw:\
7574                 slave2/db/name/pw:\
7575                 master/db/name/pw
7576 .endd
7577 In an updating lookup, you could then write:
7578 .code
7579 ${lookup mysql{servers=master; UPDATE ...} }
7580 .endd
7581 That query would then be sent only to the master server. If, on the other hand,
7582 the master is not to be used for reading, and so is not present in the global
7583 option, you can still update it by a query of this form:
7584 .code
7585 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7586 .endd
7587
7588
7589 .section "Special MySQL features" "SECID73"
7590 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7591 causes a connection to the server on the local host by means of a Unix domain
7592 socket. An alternate socket can be specified in parentheses. The full syntax of
7593 each item in &%mysql_servers%& is:
7594 .display
7595 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7596   <&'user'&>/<&'password'&>
7597 .endd
7598 Any of the three sub-parts of the first field can be omitted. For normal use on
7599 the local host it can be left blank or set to just &"localhost"&.
7600
7601 No database need be supplied &-- but if it is absent here, it must be given in
7602 the queries.
7603
7604 If a MySQL query is issued that does not request any data (an insert, update,
7605 or delete command), the result of the lookup is the number of rows affected.
7606
7607 &*Warning*&: This can be misleading. If an update does not actually change
7608 anything (for example, setting a field to the value it already has), the result
7609 is zero because no rows are affected.
7610
7611
7612 .section "Special PostgreSQL features" "SECID74"
7613 PostgreSQL lookups can also use Unix domain socket connections to the database.
7614 This is usually faster and costs less CPU time than a TCP/IP connection.
7615 However it can be used only if the mail server runs on the same machine as the
7616 database server. A configuration line for PostgreSQL via Unix domain sockets
7617 looks like this:
7618 .code
7619 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7620 .endd
7621 In other words, instead of supplying a host name, a path to the socket is
7622 given. The path name is enclosed in parentheses so that its slashes aren't
7623 visually confused with the delimiters for the other server parameters.
7624
7625 If a PostgreSQL query is issued that does not request any data (an insert,
7626 update, or delete command), the result of the lookup is the number of rows
7627 affected.
7628
7629 .section "More about SQLite" "SECTsqlite"
7630 .cindex "lookup" "SQLite"
7631 .cindex "sqlite lookup type"
7632 SQLite is different to the other SQL lookups because a file name is required in
7633 addition to the SQL query. An SQLite database is a single file, and there is no
7634 daemon as in the other SQL databases. The interface to Exim requires the name
7635 of the file, as an absolute path, to be given at the start of the query. It is
7636 separated from the query by white space. This means that the path name cannot
7637 contain white space. Here is a lookup expansion example:
7638 .code
7639 ${lookup sqlite {/some/thing/sqlitedb \
7640   select name from aliases where id='userx';}}
7641 .endd
7642 In a list, the syntax is similar. For example:
7643 .code
7644 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7645    select * from relays where ip='$sender_host_address';
7646 .endd
7647 The only character affected by the &%quote_sqlite%& operator is a single
7648 quote, which it doubles.
7649
7650 The SQLite library handles multiple simultaneous accesses to the database
7651 internally. Multiple readers are permitted, but only one process can
7652 update at once. Attempts to access the database while it is being updated
7653 are rejected after a timeout period, during which the SQLite library
7654 waits for the lock to be released. In Exim, the default timeout is set
7655 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7656 option.
7657 .ecindex IIDfidalo1
7658 .ecindex IIDfidalo2
7659
7660
7661 . ////////////////////////////////////////////////////////////////////////////
7662 . ////////////////////////////////////////////////////////////////////////////
7663
7664 .chapter "Domain, host, address, and local part lists" &&&
7665          "CHAPdomhosaddlists" &&&
7666          "Domain, host, and address lists"
7667 .scindex IIDdohoadli "lists of domains; hosts; etc."
7668 A number of Exim configuration options contain lists of domains, hosts,
7669 email addresses, or local parts. For example, the &%hold_domains%& option
7670 contains a list of domains whose delivery is currently suspended. These lists
7671 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7672 arguments to expansion conditions such as &%match_domain%&.
7673
7674 Each item in one of these lists is a pattern to be matched against a domain,
7675 host, email address, or local part, respectively. In the sections below, the
7676 different types of pattern for each case are described, but first we cover some
7677 general facilities that apply to all four kinds of list.
7678
7679 Note that other parts of Exim use a &'string list'& which does not
7680 support all the complexity available in
7681 domain, host, address and local part lists.
7682
7683
7684
7685 .section "Expansion of lists" "SECID75"
7686 .cindex "expansion" "of lists"
7687 Each list is expanded as a single string before it is used. The result of
7688 expansion must be a list, possibly containing empty items, which is split up
7689 into separate items for matching. By default, colon is the separator character,
7690 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7691 &<<SECTempitelis>>& for details of the list syntax; the second of these
7692 discusses the way to specify empty list items.
7693
7694
7695 If the string expansion is forced to fail, Exim behaves as if the item it is
7696 testing (domain, host, address, or local part) is not in the list. Other
7697 expansion failures cause temporary errors.
7698
7699 If an item in a list is a regular expression, backslashes, dollars and possibly
7700 other special characters in the expression must be protected against
7701 misinterpretation by the string expander. The easiest way to do this is to use
7702 the &`\N`& expansion feature to indicate that the contents of the regular
7703 expression should not be expanded. For example, in an ACL you might have:
7704 .code
7705 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7706                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7707 .endd
7708 The first item is a regular expression that is protected from expansion by
7709 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7710 senders based on the receiving domain.
7711
7712
7713
7714
7715 .section "Negated items in lists" "SECID76"
7716 .cindex "list" "negation"
7717 .cindex "negation" "in lists"
7718 Items in a list may be positive or negative. Negative items are indicated by a
7719 leading exclamation mark, which may be followed by optional white space. A list
7720 defines a set of items (domains, etc). When Exim processes one of these lists,
7721 it is trying to find out whether a domain, host, address, or local part
7722 (respectively) is in the set that is defined by the list. It works like this:
7723
7724 The list is scanned from left to right. If a positive item is matched, the
7725 subject that is being checked is in the set; if a negative item is matched, the
7726 subject is not in the set. If the end of the list is reached without the
7727 subject having matched any of the patterns, it is in the set if the last item
7728 was a negative one, but not if it was a positive one. For example, the list in
7729 .code
7730 domainlist relay_to_domains = !a.b.c : *.b.c
7731 .endd
7732 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7733 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7734 list is positive. However, if the setting were
7735 .code
7736 domainlist relay_to_domains = !a.b.c
7737 .endd
7738 then all domains other than &'a.b.c'& would match because the last item in the
7739 list is negative. In other words, a list that ends with a negative item behaves
7740 as if it had an extra item &`:*`& on the end.
7741
7742 Another way of thinking about positive and negative items in lists is to read
7743 the connector as &"or"& after a positive item and as &"and"& after a negative
7744 item.
7745
7746
7747
7748 .section "File names in lists" "SECTfilnamlis"
7749 .cindex "list" "file name in"
7750 If an item in a domain, host, address, or local part list is an absolute file
7751 name (beginning with a slash character), each line of the file is read and
7752 processed as if it were an independent item in the list, except that further
7753 file names are not allowed,
7754 and no expansion of the data from the file takes place.
7755 Empty lines in the file are ignored, and the file may also contain comment
7756 lines:
7757
7758 .ilist
7759 For domain and host lists, if a # character appears anywhere in a line of the
7760 file, it and all following characters are ignored.
7761 .next
7762 Because local parts may legitimately contain # characters, a comment in an
7763 address list or local part list file is recognized only if # is preceded by
7764 white space or the start of the line. For example:
7765 .code
7766 not#comment@x.y.z   # but this is a comment
7767 .endd
7768 .endlist
7769
7770 Putting a file name in a list has the same effect as inserting each line of the
7771 file as an item in the list (blank lines and comments excepted). However, there
7772 is one important difference: the file is read each time the list is processed,
7773 so if its contents vary over time, Exim's behaviour changes.
7774
7775 If a file name is preceded by an exclamation mark, the sense of any match
7776 within the file is inverted. For example, if
7777 .code
7778 hold_domains = !/etc/nohold-domains
7779 .endd
7780 and the file contains the lines
7781 .code
7782 !a.b.c
7783 *.b.c
7784 .endd
7785 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7786 any domain matching &`*.b.c`& is not.
7787
7788
7789
7790 .section "An lsearch file is not an out-of-line list" "SECID77"
7791 As will be described in the sections that follow, lookups can be used in lists
7792 to provide indexed methods of checking list membership. There has been some
7793 confusion about the way &(lsearch)& lookups work in lists. Because
7794 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7795 sometimes thought that it is allowed to contain wild cards and other kinds of
7796 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7797 always fixed strings, just as for any other single-key lookup type.
7798
7799 If you want to use a file to contain wild-card patterns that form part of a
7800 list, just give the file name on its own, without a search type, as described
7801 in the previous section. You could also use the &(wildlsearch)& or
7802 &(nwildlsearch)&, but there is no advantage in doing this.
7803
7804
7805
7806
7807 .section "Named lists" "SECTnamedlists"
7808 .cindex "named lists"
7809 .cindex "list" "named"
7810 A list of domains, hosts, email addresses, or local parts can be given a name
7811 which is then used to refer to the list elsewhere in the configuration. This is
7812 particularly convenient if the same list is required in several different
7813 places. It also allows lists to be given meaningful names, which can improve
7814 the readability of the configuration. For example, it is conventional to define
7815 a domain list called &'local_domains'& for all the domains that are handled
7816 locally on a host, using a configuration line such as
7817 .code
7818 domainlist local_domains = localhost:my.dom.example
7819 .endd
7820 Named lists are referenced by giving their name preceded by a plus sign, so,
7821 for example, a router that is intended to handle local domains would be
7822 configured with the line
7823 .code
7824 domains = +local_domains
7825 .endd
7826 The first router in a configuration is often one that handles all domains
7827 except the local ones, using a configuration with a negated item like this:
7828 .code
7829 dnslookup:
7830   driver = dnslookup
7831   domains = ! +local_domains
7832   transport = remote_smtp
7833   no_more
7834 .endd
7835 The four kinds of named list are created by configuration lines starting with
7836 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7837 respectively. Then there follows the name that you are defining, followed by an
7838 equals sign and the list itself. For example:
7839 .code
7840 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7841 addresslist bad_senders = cdb;/etc/badsenders
7842 .endd
7843 A named list may refer to other named lists:
7844 .code
7845 domainlist  dom1 = first.example : second.example
7846 domainlist  dom2 = +dom1 : third.example
7847 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7848 .endd
7849 &*Warning*&: If the last item in a referenced list is a negative one, the
7850 effect may not be what you intended, because the negation does not propagate
7851 out to the higher level. For example, consider:
7852 .code
7853 domainlist  dom1 = !a.b
7854 domainlist  dom2 = +dom1 : *.b
7855 .endd
7856 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7857 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7858 means it matches the second list as well. The effect is not the same as
7859 .code
7860 domainlist  dom2 = !a.b : *.b
7861 .endd
7862 where &'x.y'& does not match. It's best to avoid negation altogether in
7863 referenced lists if you can.
7864
7865 Named lists may have a performance advantage. When Exim is routing an
7866 address or checking an incoming message, it caches the result of tests on named
7867 lists. So, if you have a setting such as
7868 .code
7869 domains = +local_domains
7870 .endd
7871 on several of your routers
7872 or in several ACL statements,
7873 the actual test is done only for the first one. However, the caching works only
7874 if there are no expansions within the list itself or any sublists that it
7875 references. In other words, caching happens only for lists that are known to be
7876 the same each time they are referenced.
7877
7878 By default, there may be up to 16 named lists of each type. This limit can be
7879 extended by changing a compile-time variable. The use of domain and host lists
7880 is recommended for concepts such as local domains, relay domains, and relay
7881 hosts. The default configuration is set up like this.
7882
7883
7884
7885 .section "Named lists compared with macros" "SECID78"
7886 .cindex "list" "named compared with macro"
7887 .cindex "macro" "compared with named list"
7888 At first sight, named lists might seem to be no different from macros in the
7889 configuration file. However, macros are just textual substitutions. If you
7890 write
7891 .code
7892 ALIST = host1 : host2
7893 auth_advertise_hosts = !ALIST
7894 .endd
7895 it probably won't do what you want, because that is exactly the same as
7896 .code
7897 auth_advertise_hosts = !host1 : host2
7898 .endd
7899 Notice that the second host name is not negated. However, if you use a host
7900 list, and write
7901 .code
7902 hostlist alist = host1 : host2
7903 auth_advertise_hosts = ! +alist
7904 .endd
7905 the negation applies to the whole list, and so that is equivalent to
7906 .code
7907 auth_advertise_hosts = !host1 : !host2
7908 .endd
7909
7910
7911 .section "Named list caching" "SECID79"
7912 .cindex "list" "caching of named"
7913 .cindex "caching" "named lists"
7914 While processing a message, Exim caches the result of checking a named list if
7915 it is sure that the list is the same each time. In practice, this means that
7916 the cache operates only if the list contains no $ characters, which guarantees
7917 that it will not change when it is expanded. Sometimes, however, you may have
7918 an expanded list that you know will be the same each time within a given
7919 message. For example:
7920 .code
7921 domainlist special_domains = \
7922            ${lookup{$sender_host_address}cdb{/some/file}}
7923 .endd
7924 This provides a list of domains that depends only on the sending host's IP
7925 address. If this domain list is referenced a number of times (for example,
7926 in several ACL lines, or in several routers) the result of the check is not
7927 cached by default, because Exim does not know that it is going to be the
7928 same list each time.
7929
7930 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7931 cache the result anyway. For example:
7932 .code
7933 domainlist_cache special_domains = ${lookup{...
7934 .endd
7935 If you do this, you should be absolutely sure that caching is going to do
7936 the right thing in all cases. When in doubt, leave it out.
7937
7938
7939
7940 .section "Domain lists" "SECTdomainlist"
7941 .cindex "domain list" "patterns for"
7942 .cindex "list" "domain list"
7943 Domain lists contain patterns that are to be matched against a mail domain.
7944 The following types of item may appear in domain lists:
7945
7946 .ilist
7947 .cindex "primary host name"
7948 .cindex "host name" "matched in domain list"
7949 .oindex "&%primary_hostname%&"
7950 .cindex "domain list" "matching primary host name"
7951 .cindex "@ in a domain list"
7952 If a pattern consists of a single @ character, it matches the local host name,
7953 as set by the &%primary_hostname%& option (or defaulted). This makes it
7954 possible to use the same configuration file on several different hosts that
7955 differ only in their names.
7956 .next
7957 .cindex "@[] in a domain list"
7958 .cindex "domain list" "matching local IP interfaces"
7959 .cindex "domain literal"
7960 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7961 in square brackets (as in an email address that contains a domain literal), but
7962 only if that IP address is recognized as local for email routing purposes. The
7963 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7964 control which of a host's several IP addresses are treated as local.
7965 In today's Internet, the use of domain literals is controversial.
7966 .next
7967 .cindex "@mx_any"
7968 .cindex "@mx_primary"
7969 .cindex "@mx_secondary"
7970 .cindex "domain list" "matching MX pointers to local host"
7971 If a pattern consists of the string &`@mx_any`& it matches any domain that
7972 has an MX record pointing to the local host or to any host that is listed in
7973 .oindex "&%hosts_treat_as_local%&"
7974 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7975 are similar, except that the first matches only when a primary MX target is the
7976 local host, and the second only when no primary MX target is the local host,
7977 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7978 preference value &-- there may of course be more than one of them.
7979
7980 The MX lookup that takes place when matching a pattern of this type is
7981 performed with the resolver options for widening names turned off. Thus, for
7982 example, a single-component domain will &'not'& be expanded by adding the
7983 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7984 options of the &(dnslookup)& router for a discussion of domain widening.
7985
7986 Sometimes you may want to ignore certain IP addresses when using one of these
7987 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7988 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7989 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7990 on a router). For example:
7991 .code
7992 domains = @mx_any/ignore=127.0.0.1
7993 .endd
7994 This example matches any domain that has an MX record pointing to one of
7995 the local host's IP addresses other than 127.0.0.1.
7996
7997 The list of IP addresses is in fact processed by the same code that processes
7998 host lists, so it may contain CIDR-coded network specifications and it may also
7999 contain negative items.
8000
8001 Because the list of IP addresses is a sublist within a domain list, you have to
8002 be careful about delimiters if there is more than one address. Like any other
8003 list, the default delimiter can be changed. Thus, you might have:
8004 .code
8005 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8006           an.other.domain : ...
8007 .endd
8008 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8009 involved, it is easiest to change the delimiter for the main list as well:
8010 .code
8011 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8012           an.other.domain ? ...
8013 .endd
8014 .next
8015 .cindex "asterisk" "in domain list"
8016 .cindex "domain list" "asterisk in"
8017 .cindex "domain list" "matching &""ends with""&"
8018 If a pattern starts with an asterisk, the remaining characters of the pattern
8019 are compared with the terminating characters of the domain. The use of &"*"& in
8020 domain lists differs from its use in partial matching lookups. In a domain
8021 list, the character following the asterisk need not be a dot, whereas partial
8022 matching works only in terms of dot-separated components. For example, a domain
8023 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8024 &'cipher.key.ex'&.
8025
8026 .next
8027 .cindex "regular expressions" "in domain list"
8028 .cindex "domain list" "matching regular expression"
8029 If a pattern starts with a circumflex character, it is treated as a regular
8030 expression, and matched against the domain using a regular expression matching
8031 function. The circumflex is treated as part of the regular expression.
8032 Email domains are case-independent, so this regular expression match is by
8033 default case-independent, but you can make it case-dependent by starting it
8034 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8035 are given in chapter &<<CHAPregexp>>&.
8036
8037 &*Warning*&: Because domain lists are expanded before being processed, you
8038 must escape any backslash and dollar characters in the regular expression, or
8039 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8040 it is not to be expanded (unless you really do want to build a regular
8041 expression by expansion, of course).
8042 .next
8043 .cindex "lookup" "in domain list"
8044 .cindex "domain list" "matching by lookup"
8045 If a pattern starts with the name of a single-key lookup type followed by a
8046 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8047 must be a file name in a suitable format for the lookup type. For example, for
8048 &"cdb;"& it must be an absolute path:
8049 .code
8050 domains = cdb;/etc/mail/local_domains.cdb
8051 .endd
8052 The appropriate type of lookup is done on the file using the domain name as the
8053 key. In most cases, the data that is looked up is not used; Exim is interested
8054 only in whether or not the key is present in the file. However, when a lookup
8055 is used for the &%domains%& option on a router
8056 or a &%domains%& condition in an ACL statement, the data is preserved in the
8057 &$domain_data$& variable and can be referred to in other router options or
8058 other statements in the same ACL.
8059
8060 .next
8061 Any of the single-key lookup type names may be preceded by
8062 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8063 .code
8064 domains = partial-dbm;/partial/domains
8065 .endd
8066 This causes partial matching logic to be invoked; a description of how this
8067 works is given in section &<<SECTpartiallookup>>&.
8068
8069 .next
8070 .cindex "asterisk" "in lookup type"
8071 Any of the single-key lookup types may be followed by an asterisk. This causes
8072 a default lookup for a key consisting of a single asterisk to be done if the
8073 original lookup fails. This is not a useful feature when using a domain list to
8074 select particular domains (because any domain would match), but it might have
8075 value if the result of the lookup is being used via the &$domain_data$&
8076 expansion variable.
8077 .next
8078 If the pattern starts with the name of a query-style lookup type followed by a
8079 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8080 pattern must be an appropriate query for the lookup type, as described in
8081 chapter &<<CHAPfdlookup>>&. For example:
8082 .code
8083 hold_domains = mysql;select domain from holdlist \
8084   where domain = '${quote_mysql:$domain}';
8085 .endd
8086 In most cases, the data that is looked up is not used (so for an SQL query, for
8087 example, it doesn't matter what field you select). Exim is interested only in
8088 whether or not the query succeeds. However, when a lookup is used for the
8089 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8090 variable and can be referred to in other options.
8091 .next
8092 .cindex "domain list" "matching literal domain name"
8093 If none of the above cases apply, a caseless textual comparison is made
8094 between the pattern and the domain.
8095 .endlist
8096
8097 Here is an example that uses several different kinds of pattern:
8098 .code
8099 domainlist funny_domains = \
8100   @ : \
8101   lib.unseen.edu : \
8102   *.foundation.fict.example : \
8103   \N^[1-2]\d{3}\.fict\.example$\N : \
8104   partial-dbm;/opt/data/penguin/book : \
8105   nis;domains.byname : \
8106   nisplus;[name=$domain,status=local],domains.org_dir
8107 .endd
8108 There are obvious processing trade-offs among the various matching modes. Using
8109 an asterisk is faster than a regular expression, and listing a few names
8110 explicitly probably is too. The use of a file or database lookup is expensive,
8111 but may be the only option if hundreds of names are required. Because the
8112 patterns are tested in order, it makes sense to put the most commonly matched
8113 patterns earlier.
8114
8115
8116
8117 .section "Host lists" "SECThostlist"
8118 .cindex "host list" "patterns in"
8119 .cindex "list" "host list"
8120 Host lists are used to control what remote hosts are allowed to do. For
8121 example, some hosts may be allowed to use the local host as a relay, and some
8122 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8123 two different ways, by name or by IP address. In a host list, some types of
8124 pattern are matched to a host name, and some are matched to an IP address.
8125 You need to be particularly careful with this when single-key lookups are
8126 involved, to ensure that the right value is being used as the key.
8127
8128
8129 .section "Special host list patterns" "SECID80"
8130 .cindex "empty item in hosts list"
8131 .cindex "host list" "empty string in"
8132 If a host list item is the empty string, it matches only when no remote host is
8133 involved. This is the case when a message is being received from a local
8134 process using SMTP on the standard input, that is, when a TCP/IP connection is
8135 not used.
8136
8137 .cindex "asterisk" "in host list"
8138 The special pattern &"*"& in a host list matches any host or no host. Neither
8139 the IP address nor the name is actually inspected.
8140
8141
8142
8143 .section "Host list patterns that match by IP address" "SECThoslispatip"
8144 .cindex "host list" "matching IP addresses"
8145 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8146 the incoming address actually appears in the IPv6 host as
8147 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8148 list, it is converted into a traditional IPv4 address first. (Not all operating
8149 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8150 concerns.)
8151
8152 The following types of pattern in a host list check the remote host by
8153 inspecting its IP address:
8154
8155 .ilist
8156 If the pattern is a plain domain name (not a regular expression, not starting
8157 with *, not a lookup of any kind), Exim calls the operating system function
8158 to find the associated IP address(es). Exim uses the newer
8159 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8160 This typically causes a forward DNS lookup of the name. The result is compared
8161 with the IP address of the subject host.
8162
8163 If there is a temporary problem (such as a DNS timeout) with the host name
8164 lookup, a temporary error occurs. For example, if the list is being used in an
8165 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8166 temporary SMTP error code. If no IP address can be found for the host name,
8167 what happens is described in section &<<SECTbehipnot>>& below.
8168
8169 .next
8170 .cindex "@ in a host list"
8171 If the pattern is &"@"&, the primary host name is substituted and used as a
8172 domain name, as just described.
8173
8174 .next
8175 If the pattern is an IP address, it is matched against the IP address of the
8176 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8177 IPv6 addresses can be given in colon-separated format, but the colons have to
8178 be doubled so as not to be taken as item separators when the default list
8179 separator is used. IPv6 addresses are recognized even when Exim is compiled
8180 without IPv6 support. This means that if they appear in a host list on an
8181 IPv4-only host, Exim will not treat them as host names. They are just addresses
8182 that can never match a client host.
8183
8184 .next
8185 .cindex "@[] in a host list"
8186 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8187 the local host. For example, if the local host is an IPv4 host with one
8188 interface address 10.45.23.56, these two ACL statements have the same effect:
8189 .code
8190 accept hosts = 127.0.0.1 : 10.45.23.56
8191 accept hosts = @[]
8192 .endd
8193 .next
8194 .cindex "CIDR notation"
8195 If the pattern is an IP address followed by a slash and a mask length (for
8196 example 10.11.42.0/24), it is matched against the IP address of the subject
8197 host under the given mask. This allows, an entire network of hosts to be
8198 included (or excluded) by a single item. The mask uses CIDR notation; it
8199 specifies the number of address bits that must match, starting from the most
8200 significant end of the address.
8201
8202 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8203 of a range of addresses. It is the number of bits in the network portion of the
8204 address. The above example specifies a 24-bit netmask, so it matches all 256
8205 addresses in the 10.11.42.0 network. An item such as
8206 .code
8207 192.168.23.236/31
8208 .endd
8209 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8210 32 for an IPv4 address is the same as no mask at all; just a single address
8211 matches.
8212
8213 Here is another example which shows an IPv4 and an IPv6 network:
8214 .code
8215 recipient_unqualified_hosts = 192.168.0.0/16: \
8216                               3ffe::ffff::836f::::/48
8217 .endd
8218 The doubling of list separator characters applies only when these items
8219 appear inline in a host list. It is not required when indirecting via a file.
8220 For example:
8221 .code
8222 recipient_unqualified_hosts = /opt/exim/unqualnets
8223 .endd
8224 could make use of a file containing
8225 .code
8226 172.16.0.0/12
8227 3ffe:ffff:836f::/48
8228 .endd
8229 to have exactly the same effect as the previous example. When listing IPv6
8230 addresses inline, it is usually more convenient to use the facility for
8231 changing separator characters. This list contains the same two networks:
8232 .code
8233 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8234                                  3ffe:ffff:836f::/48
8235 .endd
8236 The separator is changed to semicolon by the leading &"<;"& at the start of the
8237 list.
8238 .endlist
8239
8240
8241
8242 .section "Host list patterns for single-key lookups by host address" &&&
8243          "SECThoslispatsikey"
8244 .cindex "host list" "lookup of IP address"
8245 When a host is to be identified by a single-key lookup of its complete IP
8246 address, the pattern takes this form:
8247 .display
8248 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8249 .endd
8250 For example:
8251 .code
8252 hosts_lookup = net-cdb;/hosts-by-ip.db
8253 .endd
8254 The text form of the IP address of the subject host is used as the lookup key.
8255 IPv6 addresses are converted to an unabbreviated form, using lower case
8256 letters, with dots as separators because colon is the key terminator in
8257 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8258 quoting the keys, but this is a facility that was added later.] The data
8259 returned by the lookup is not used.
8260
8261 .cindex "IP address" "masking"
8262 .cindex "host list" "masked IP address"
8263 Single-key lookups can also be performed using masked IP addresses, using
8264 patterns of this form:
8265 .display
8266 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8267 .endd
8268 For example:
8269 .code
8270 net24-dbm;/networks.db
8271 .endd
8272 The IP address of the subject host is masked using <&'number'&> as the mask
8273 length. A textual string is constructed from the masked value, followed by the
8274 mask, and this is used as the lookup key. For example, if the host's IP address
8275 is 192.168.34.6, the key that is looked up for the above example is
8276 &"192.168.34.0/24"&.
8277
8278 When an IPv6 address is converted to a string, dots are normally used instead
8279 of colons, so that keys in &(lsearch)& files need not contain colons (which
8280 terminate &(lsearch)& keys). This was implemented some time before the ability
8281 to quote keys was made available in &(lsearch)& files. However, the more
8282 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8283 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8284 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8285 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8286 addresses are always used.
8287
8288 Ideally, it would be nice to tidy up this anomalous situation by changing to
8289 colons in all cases, given that quoting is now available for &(lsearch)&.
8290 However, this would be an incompatible change that might break some existing
8291 configurations.
8292
8293 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8294 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8295 the former case the key strings include the mask value, whereas in the latter
8296 case the IP address is used on its own.
8297
8298
8299
8300 .section "Host list patterns that match by host name" "SECThoslispatnam"
8301 .cindex "host" "lookup failures"
8302 .cindex "unknown host name"
8303 .cindex "host list" "matching host name"
8304 There are several types of pattern that require Exim to know the name of the
8305 remote host. These are either wildcard patterns or lookups by name. (If a
8306 complete hostname is given without any wildcarding, it is used to find an IP
8307 address to match against, as described in section &<<SECThoslispatip>>&
8308 above.)
8309
8310 If the remote host name is not already known when Exim encounters one of these
8311 patterns, it has to be found from the IP address.
8312 Although many sites on the Internet are conscientious about maintaining reverse
8313 DNS data for their hosts, there are also many that do not do this.
8314 Consequently, a name cannot always be found, and this may lead to unwanted
8315 effects. Take care when configuring host lists with wildcarded name patterns.
8316 Consider what will happen if a name cannot be found.
8317
8318 Because of the problems of determining host names from IP addresses, matching
8319 against host names is not as common as matching against IP addresses.
8320
8321 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8322 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8323 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8324 are done can be changed by setting the &%host_lookup_order%& option. For
8325 security, once Exim has found one or more names, it looks up the IP addresses
8326 for these names and compares them with the IP address that it started with.
8327 Only those names whose IP addresses match are accepted. Any other names are
8328 discarded. If no names are left, Exim behaves as if the host name cannot be
8329 found. In the most common case there is only one name and one IP address.
8330
8331 There are some options that control what happens if a host name cannot be
8332 found. These are described in section &<<SECTbehipnot>>& below.
8333
8334 .cindex "host" "alias for"
8335 .cindex "alias for host"
8336 As a result of aliasing, hosts may have more than one name. When processing any
8337 of the following types of pattern, all the host's names are checked:
8338
8339 .ilist
8340 .cindex "asterisk" "in host list"
8341 If a pattern starts with &"*"& the remainder of the item must match the end of
8342 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8343 &'.b.c'&. This special simple form is provided because this is a very common
8344 requirement. Other kinds of wildcarding require the use of a regular
8345 expression.
8346 .next
8347 .cindex "regular expressions" "in host list"
8348 .cindex "host list" "regular expression in"
8349 If the item starts with &"^"& it is taken to be a regular expression which is
8350 matched against the host name. Host names are case-independent, so this regular
8351 expression match is by default case-independent, but you can make it
8352 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8353 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8354 example,
8355 .code
8356 ^(a|b)\.c\.d$
8357 .endd
8358 is a regular expression that matches either of the two hosts &'a.c.d'& or
8359 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8360 that backslash and dollar characters are not misinterpreted as part of the
8361 string expansion. The simplest way to do this is to use &`\N`& to mark that
8362 part of the string as non-expandable. For example:
8363 .code
8364 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8365 .endd
8366 &*Warning*&: If you want to match a complete host name, you must include the
8367 &`$`& terminating metacharacter in the regular expression, as in the above
8368 example. Without it, a match at the start of the host name is all that is
8369 required.
8370 .endlist
8371
8372
8373
8374
8375 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8376 .cindex "host" "lookup failures, permanent"
8377 While processing a host list, Exim may need to look up an IP address from a
8378 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8379 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8380 behaviour when it fails to find the information it is seeking is the same.
8381
8382 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8383 apply to temporary DNS errors, whose handling is described in the next section.
8384
8385 .cindex "&`+include_unknown`&"
8386 .cindex "&`+ignore_unknown`&"
8387 Exim parses a host list from left to right. If it encounters a permanent
8388 lookup failure in any item in the host list before it has found a match,
8389 Exim treats it as a failure and the default behavior is as if the host
8390 does not match the list. This may not always be what you want to happen.
8391 To change Exim's behaviour, the special items &`+include_unknown`& or
8392 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8393 not recognized in an indirected file).
8394
8395 .ilist
8396 If any item that follows &`+include_unknown`& requires information that
8397 cannot found, Exim behaves as if the host does match the list. For example,
8398 .code
8399 host_reject_connection = +include_unknown:*.enemy.ex
8400 .endd
8401 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8402 any hosts whose name it cannot find.
8403
8404 .next
8405 If any item that follows &`+ignore_unknown`& requires information that cannot
8406 be found, Exim ignores that item and proceeds to the rest of the list. For
8407 example:
8408 .code
8409 accept hosts = +ignore_unknown : friend.example : \
8410                192.168.4.5
8411 .endd
8412 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8413 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8414 name can be found for 192.168.4.5, it is rejected.
8415 .endlist
8416
8417 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8418 list. The effect of each one lasts until the next, or until the end of the
8419 list.
8420
8421 .section "Mixing wildcarded host names and addresses in host lists" &&&
8422          "SECTmixwilhos"
8423 .cindex "host list" "mixing names and addresses in"
8424
8425 This section explains the host/ip processing logic with the same concepts
8426 as the previous section, but specifically addresses what happens when a
8427 wildcarded hostname is one of the items in the hostlist.
8428
8429 .ilist
8430 If you have name lookups or wildcarded host names and
8431 IP addresses in the same host list, you should normally put the IP
8432 addresses first. For example, in an ACL you could have:
8433 .code
8434 accept hosts = 10.9.8.7 : *.friend.example
8435 .endd
8436 The reason you normally would order it this way lies in the
8437 left-to-right way that Exim processes lists.  It can test IP addresses
8438 without doing any DNS lookups, but when it reaches an item that requires
8439 a host name, it fails if it cannot find a host name to compare with the
8440 pattern. If the above list is given in the opposite order, the
8441 &%accept%& statement fails for a host whose name cannot be found, even
8442 if its IP address is 10.9.8.7.
8443
8444 .next
8445 If you really do want to do the name check first, and still recognize the IP
8446 address, you can rewrite the ACL like this:
8447 .code
8448 accept hosts = *.friend.example
8449 accept hosts = 10.9.8.7
8450 .endd
8451 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8452 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8453 &`+ignore_unknown`&, which was discussed in depth in the first example in
8454 this section.
8455 .endlist
8456
8457
8458 .section "Temporary DNS errors when looking up host information" &&&
8459          "SECTtemdnserr"
8460 .cindex "host" "lookup failures, temporary"
8461 .cindex "&`+include_defer`&"
8462 .cindex "&`+ignore_defer`&"
8463 A temporary DNS lookup failure normally causes a defer action (except when
8464 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8465 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8466 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8467 section. These options should be used with care, probably only in non-critical
8468 host lists such as whitelists.
8469
8470
8471
8472 .section "Host list patterns for single-key lookups by host name" &&&
8473          "SECThoslispatnamsk"
8474 .cindex "unknown host name"
8475 .cindex "host list" "matching host name"
8476 If a pattern is of the form
8477 .display
8478 <&'single-key-search-type'&>;<&'search-data'&>
8479 .endd
8480 for example
8481 .code
8482 dbm;/host/accept/list
8483 .endd
8484 a single-key lookup is performed, using the host name as its key. If the
8485 lookup succeeds, the host matches the item. The actual data that is looked up
8486 is not used.
8487
8488 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8489 keys in the file, not IP addresses. If you want to do lookups based on IP
8490 addresses, you must precede the search type with &"net-"& (see section
8491 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8492 two items in the same list, one doing an address lookup and one doing a name
8493 lookup, both using the same file.
8494
8495
8496
8497 .section "Host list patterns for query-style lookups" "SECID81"
8498 If a pattern is of the form
8499 .display
8500 <&'query-style-search-type'&>;<&'query'&>
8501 .endd
8502 the query is obeyed, and if it succeeds, the host matches the item. The actual
8503 data that is looked up is not used. The variables &$sender_host_address$& and
8504 &$sender_host_name$& can be used in the query. For example:
8505 .code
8506 hosts_lookup = pgsql;\
8507   select ip from hostlist where ip='$sender_host_address'
8508 .endd
8509 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8510 can use the &%sg%& expansion item to change this if you need to. If you want to
8511 use masked IP addresses in database queries, you can use the &%mask%& expansion
8512 operator.
8513
8514 If the query contains a reference to &$sender_host_name$&, Exim automatically
8515 looks up the host name if it has not already done so. (See section
8516 &<<SECThoslispatnam>>& for comments on finding host names.)
8517
8518 Historical note: prior to release 4.30, Exim would always attempt to find a
8519 host name before running the query, unless the search type was preceded by
8520 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8521 still recognized for query-style lookups, but its presence or absence has no
8522 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8523 See section &<<SECThoslispatsikey>>&.)
8524
8525
8526
8527
8528
8529 .section "Address lists" "SECTaddresslist"
8530 .cindex "list" "address list"
8531 .cindex "address list" "empty item"
8532 .cindex "address list" "patterns"
8533 Address lists contain patterns that are matched against mail addresses. There
8534 is one special case to be considered: the sender address of a bounce message is
8535 always empty. You can test for this by providing an empty item in an address
8536 list. For example, you can set up a router to process bounce messages by
8537 using this option setting:
8538 .code
8539 senders = :
8540 .endd
8541 The presence of the colon creates an empty item. If you do not provide any
8542 data, the list is empty and matches nothing. The empty sender can also be
8543 detected by a regular expression that matches an empty string,
8544 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8545
8546 Non-empty items in an address list can be straightforward email addresses. For
8547 example:
8548 .code
8549 senders = jbc@askone.example : hs@anacreon.example
8550 .endd
8551 A certain amount of wildcarding is permitted. If a pattern contains an @
8552 character, but is not a regular expression and does not begin with a
8553 semicolon-terminated lookup type (described below), the local part of the
8554 subject address is compared with the local part of the pattern, which may start
8555 with an asterisk. If the local parts match, the domain is checked in exactly
8556 the same way as for a pattern in a domain list. For example, the domain can be
8557 wildcarded, refer to a named list, or be a lookup:
8558 .code
8559 deny senders = *@*.spamming.site:\
8560                *@+hostile_domains:\
8561                bozo@partial-lsearch;/list/of/dodgy/sites:\
8562                *@dbm;/bad/domains.db
8563 .endd
8564 .cindex "local part" "starting with !"
8565 .cindex "address list" "local part starting with !"
8566 If a local part that begins with an exclamation mark is required, it has to be
8567 specified using a regular expression, because otherwise the exclamation mark is
8568 treated as a sign of negation, as is standard in lists.
8569
8570 If a non-empty pattern that is not a regular expression or a lookup does not
8571 contain an @ character, it is matched against the domain part of the subject
8572 address. The only two formats that are recognized this way are a literal
8573 domain, or a domain pattern that starts with *. In both these cases, the effect
8574 is the same as if &`*@`& preceded the pattern. For example:
8575 .code
8576 deny senders = enemy.domain : *.enemy.domain
8577 .endd
8578
8579 The following kinds of more complicated address list pattern can match any
8580 address, including the empty address that is characteristic of bounce message
8581 senders:
8582
8583 .ilist
8584 .cindex "regular expressions" "in address list"
8585 .cindex "address list" "regular expression in"
8586 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8587 done against the complete address, with the pattern as the regular expression.
8588 You must take care that backslash and dollar characters are not misinterpreted
8589 as part of the string expansion. The simplest way to do this is to use &`\N`&
8590 to mark that part of the string as non-expandable. For example:
8591 .code
8592 deny senders = \N^.*this.*@example\.com$\N : \
8593                \N^\d{8}.+@spamhaus.example$\N : ...
8594 .endd
8595 The &`\N`& sequences are removed by the expansion, so these items do indeed
8596 start with &"^"& by the time they are being interpreted as address patterns.
8597
8598 .next
8599 .cindex "address list" "lookup for complete address"
8600 Complete addresses can be looked up by using a pattern that starts with a
8601 lookup type terminated by a semicolon, followed by the data for the lookup. For
8602 example:
8603 .code
8604 deny senders = cdb;/etc/blocked.senders : \
8605   mysql;select address from blocked where \
8606   address='${quote_mysql:$sender_address}'
8607 .endd
8608 Both query-style and single-key lookup types can be used. For a single-key
8609 lookup type, Exim uses the complete address as the key. However, empty keys are
8610 not supported for single-key lookups, so a match against the empty address
8611 always fails. This restriction does not apply to query-style lookups.
8612
8613 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8614 cannot be used, and is ignored if specified, with an entry being written to the
8615 panic log.
8616 .cindex "*@ with single-key lookup"
8617 However, you can configure lookup defaults, as described in section
8618 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8619 default. For example, with this lookup:
8620 .code
8621 accept senders = lsearch*@;/some/file
8622 .endd
8623 the file could contains lines like this:
8624 .code
8625 user1@domain1.example
8626 *@domain2.example
8627 .endd
8628 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8629 that are tried is:
8630 .code
8631 nimrod@jaeger.example
8632 *@jaeger.example
8633 *
8634 .endd
8635 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8636 would mean that every address matches, thus rendering the test useless.
8637
8638 &*Warning 2*&: Do not confuse these two kinds of item:
8639 .code
8640 deny recipients = dbm*@;/some/file
8641 deny recipients = *@dbm;/some/file
8642 .endd
8643 The first does a whole address lookup, with defaulting, as just described,
8644 because it starts with a lookup type. The second matches the local part and
8645 domain independently, as described in a bullet point below.
8646 .endlist
8647
8648
8649 The following kinds of address list pattern can match only non-empty addresses.
8650 If the subject address is empty, a match against any of these pattern types
8651 always fails.
8652
8653
8654 .ilist
8655 .cindex "@@ with single-key lookup"
8656 .cindex "address list" "@@ lookup type"
8657 .cindex "address list" "split local part and domain"
8658 If a pattern starts with &"@@"& followed by a single-key lookup item
8659 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8660 split into a local part and a domain. The domain is looked up in the file. If
8661 it is not found, there is no match. If it is found, the data that is looked up
8662 from the file is treated as a colon-separated list of local part patterns, each
8663 of which is matched against the subject local part in turn.
8664
8665 .cindex "asterisk" "in address list"
8666 The lookup may be a partial one, and/or one involving a search for a default
8667 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8668 patterns that are looked up can be regular expressions or begin with &"*"&, or
8669 even be further lookups. They may also be independently negated. For example,
8670 with
8671 .code
8672 deny senders = @@dbm;/etc/reject-by-domain
8673 .endd
8674 the data from which the DBM file is built could contain lines like
8675 .code
8676 baddomain.com:  !postmaster : *
8677 .endd
8678 to reject all senders except &%postmaster%& from that domain.
8679
8680 .cindex "local part" "starting with !"
8681 If a local part that actually begins with an exclamation mark is required, it
8682 has to be specified using a regular expression. In &(lsearch)& files, an entry
8683 may be split over several lines by indenting the second and subsequent lines,
8684 but the separating colon must still be included at line breaks. White space
8685 surrounding the colons is ignored. For example:
8686 .code
8687 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8688   spammer3 : spammer4
8689 .endd
8690 As in all colon-separated lists in Exim, a colon can be included in an item by
8691 doubling.
8692
8693 If the last item in the list starts with a right angle-bracket, the remainder
8694 of the item is taken as a new key to look up in order to obtain a continuation
8695 list of local parts. The new key can be any sequence of characters. Thus one
8696 might have entries like
8697 .code
8698 aol.com: spammer1 : spammer 2 : >*
8699 xyz.com: spammer3 : >*
8700 *:       ^\d{8}$
8701 .endd
8702 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8703 local parts for all domains, in addition to the specific local parts listed for
8704 each domain. Of course, using this feature costs another lookup each time a
8705 chain is followed, but the effort needed to maintain the data is reduced.
8706
8707 .cindex "loop" "in lookups"
8708 It is possible to construct loops using this facility, and in order to catch
8709 them, the chains may be no more than fifty items long.
8710
8711 .next
8712 The @@<&'lookup'&> style of item can also be used with a query-style
8713 lookup, but in this case, the chaining facility is not available. The lookup
8714 can only return a single list of local parts.
8715 .endlist
8716
8717 &*Warning*&: There is an important difference between the address list items
8718 in these two examples:
8719 .code
8720 senders = +my_list
8721 senders = *@+my_list
8722 .endd
8723 In the first one, &`my_list`& is a named address list, whereas in the second
8724 example it is a named domain list.
8725
8726
8727
8728
8729 .section "Case of letters in address lists" "SECTcasletadd"
8730 .cindex "case of local parts"
8731 .cindex "address list" "case forcing"
8732 .cindex "case forcing in address lists"
8733 Domains in email addresses are always handled caselessly, but for local parts
8734 case may be significant on some systems (see &%caseful_local_part%& for how
8735 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8736 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8737 blocking lists should be done in a case-independent manner. Since most address
8738 lists in Exim are used for this kind of control, Exim attempts to do this by
8739 default.
8740
8741 The domain portion of an address is always lowercased before matching it to an
8742 address list. The local part is lowercased by default, and any string
8743 comparisons that take place are done caselessly. This means that the data in
8744 the address list itself, in files included as plain file names, and in any file
8745 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8746 keys in files that are looked up by a search type other than &(lsearch)& (which
8747 works caselessly) must be in lower case, because these lookups are not
8748 case-independent.
8749
8750 .cindex "&`+caseful`&"
8751 To allow for the possibility of caseful address list matching, if an item in
8752 an address list is the string &"+caseful"&, the original case of the local
8753 part is restored for any comparisons that follow, and string comparisons are no
8754 longer case-independent. This does not affect the domain, which remains in
8755 lower case. However, although independent matches on the domain alone are still
8756 performed caselessly, regular expressions that match against an entire address
8757 become case-sensitive after &"+caseful"& has been seen.
8758
8759
8760
8761 .section "Local part lists" "SECTlocparlis"
8762 .cindex "list" "local part list"
8763 .cindex "local part" "list"
8764 Case-sensitivity in local part lists is handled in the same way as for address
8765 lists, as just described. The &"+caseful"& item can be used if required. In a
8766 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8767 set false, the subject is lowercased and the matching is initially
8768 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8769 matching in the local part list, but not elsewhere in the router. If
8770 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8771 option is case-sensitive from the start.
8772
8773 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8774 comments are handled in the same way as address lists &-- they are recognized
8775 only if the # is preceded by white space or the start of the line.
8776 Otherwise, local part lists are matched in the same way as domain lists, except
8777 that the special items that refer to the local host (&`@`&, &`@[]`&,
8778 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8779 Refer to section &<<SECTdomainlist>>& for details of the other available item
8780 types.
8781 .ecindex IIDdohoadli
8782
8783
8784
8785
8786 . ////////////////////////////////////////////////////////////////////////////
8787 . ////////////////////////////////////////////////////////////////////////////
8788
8789 .chapter "String expansions" "CHAPexpand"
8790 .scindex IIDstrexp "expansion" "of strings"
8791 Many strings in Exim's run time configuration are expanded before use. Some of
8792 them are expanded every time they are used; others are expanded only once.
8793
8794 When a string is being expanded it is copied verbatim from left to right except
8795 when a dollar or backslash character is encountered. A dollar specifies the
8796 start of a portion of the string that is interpreted and replaced as described
8797 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8798 escape character, as described in the following section.
8799
8800 Whether a string is expanded depends upon the context.  Usually this is solely
8801 dependent upon the option for which a value is sought; in this documentation,
8802 options for which string expansion is performed are marked with &dagger; after
8803 the data type.  ACL rules always expand strings.  A couple of expansion
8804 conditions do not expand some of the brace-delimited branches, for security
8805 reasons.
8806
8807
8808
8809 .section "Literal text in expanded strings" "SECTlittext"
8810 .cindex "expansion" "including literal text"
8811 An uninterpreted dollar can be included in an expanded string by putting a
8812 backslash in front of it. A backslash can be used to prevent any special
8813 character being treated specially in an expansion, including backslash itself.
8814 If the string appears in quotes in the configuration file, two backslashes are
8815 required because the quotes themselves cause interpretation of backslashes when
8816 the string is read in (see section &<<SECTstrings>>&).
8817
8818 .cindex "expansion" "non-expandable substrings"
8819 A portion of the string can specified as non-expandable by placing it between
8820 two occurrences of &`\N`&. This is particularly useful for protecting regular
8821 expressions, which often contain backslashes and dollar signs. For example:
8822 .code
8823 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8824 .endd
8825 On encountering the first &`\N`&, the expander copies subsequent characters
8826 without interpretation until it reaches the next &`\N`& or the end of the
8827 string.
8828
8829
8830
8831 .section "Character escape sequences in expanded strings" "SECID82"
8832 .cindex "expansion" "escape sequences"
8833 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8834 expanded string is recognized as an escape sequence for the character newline,
8835 carriage return, or tab, respectively. A backslash followed by up to three
8836 octal digits is recognized as an octal encoding for a single character, and a
8837 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8838 encoding.
8839
8840 These escape sequences are also recognized in quoted strings when they are read
8841 in. Their interpretation in expansions as well is useful for unquoted strings,
8842 and for other cases such as looked-up strings that are then expanded.
8843
8844
8845 .section "Testing string expansions" "SECID83"
8846 .cindex "expansion" "testing"
8847 .cindex "testing" "string expansion"
8848 .oindex "&%-be%&"
8849 Many expansions can be tested by calling Exim with the &%-be%& option. This
8850 takes the command arguments, or lines from the standard input if there are no
8851 arguments, runs them through the string expansion code, and writes the results
8852 to the standard output. Variables based on configuration values are set up, but
8853 since no message is being processed, variables such as &$local_part$& have no
8854 value. Nevertheless the &%-be%& option can be useful for checking out file and
8855 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8856 and &%nhash%&.
8857
8858 Exim gives up its root privilege when it is called with the &%-be%& option, and
8859 instead runs under the uid and gid it was called with, to prevent users from
8860 using &%-be%& for reading files to which they do not have access.
8861
8862 .oindex "&%-bem%&"
8863 If you want to test expansions that include variables whose values are taken
8864 from a message, there are two other options that can be used. The &%-bem%&
8865 option is like &%-be%& except that it is followed by a file name. The file is
8866 read as a message before doing the test expansions. For example:
8867 .code
8868 exim -bem /tmp/test.message '$h_subject:'
8869 .endd
8870 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8871 Exim message identifier. For example:
8872 .code
8873 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8874 .endd
8875 This loads the message from Exim's spool before doing the test expansions, and
8876 is therefore restricted to admin users.
8877
8878
8879 .section "Forced expansion failure" "SECTforexpfai"
8880 .cindex "expansion" "forced failure"
8881 A number of expansions that are described in the following section have
8882 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8883 (which are sometimes called &"curly brackets"&). Which of the two strings is
8884 used depends on some condition that is evaluated as part of the expansion. If,
8885 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8886 the entire string expansion fails in a way that can be detected by the code
8887 that requested the expansion. This is called &"forced expansion failure"&, and
8888 its consequences depend on the circumstances. In some cases it is no different
8889 from any other expansion failure, but in others a different action may be
8890 taken. Such variations are mentioned in the documentation of the option that is
8891 being expanded.
8892
8893
8894
8895
8896 .section "Expansion items" "SECTexpansionitems"
8897 The following items are recognized in expanded strings. White space may be used
8898 between sub-items that are keywords or substrings enclosed in braces inside an
8899 outer set of braces, to improve readability. &*Warning*&: Within braces,
8900 white space is significant.
8901
8902 .vlist
8903 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8904 .cindex "expansion" "variables"
8905 Substitute the contents of the named variable, for example:
8906 .code
8907 $local_part
8908 ${domain}
8909 .endd
8910 The second form can be used to separate the name from subsequent alphanumeric
8911 characters. This form (using braces) is available only for variables; it does
8912 &'not'& apply to message headers. The names of the variables are given in
8913 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8914 given, the expansion fails.
8915
8916 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8917 .cindex "expansion" "operators"
8918 The string is first itself expanded, and then the operation specified by
8919 <&'op'&> is applied to it. For example:
8920 .code
8921 ${lc:$local_part}
8922 .endd
8923 The string starts with the first character after the colon, which may be
8924 leading white space. A list of operators is given in section &<<SECTexpop>>&
8925 below. The operator notation is used for simple expansion items that have just
8926 one argument, because it reduces the number of braces and therefore makes the
8927 string easier to understand.
8928
8929 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8930 This item inserts &"basic"& header lines. It is described with the &%header%&
8931 expansion item below.
8932
8933
8934 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8935 .cindex "expansion" "calling an acl"
8936 .cindex "&%acl%&" "call from expansion"
8937 The name and zero to nine argument strings are first expanded separately.  The expanded
8938 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8939 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8940 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8941 and may use the variables; if another acl expansion is used the values
8942 are restored after it returns.  If the ACL sets
8943 a value using a "message =" modifier and returns accept or deny, the value becomes
8944 the result of the expansion.
8945 If no message is set and the ACL returns accept or deny
8946 the expansion result is an empty string.
8947 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8948
8949
8950 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8951        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8952 .cindex "expansion" "extracting cerificate fields"
8953 .cindex "&%certextract%&" "certificate fields"
8954 .cindex "certificate" "extracting fields"
8955 The <&'certificate'&> must be a variable of type certificate.
8956 The field name is expanded and used to retrieve the relevant field from
8957 the certificate.  Supported fields are:
8958 .display
8959 &`version        `&
8960 &`serial_number  `&
8961 &`subject        `& RFC4514 DN
8962 &`issuer         `& RFC4514 DN
8963 &`notbefore      `& time
8964 &`notafter       `& time
8965 &`sig_algorithm  `&
8966 &`signature      `&
8967 &`subj_altname   `& tagged list
8968 &`ocsp_uri       `& list
8969 &`crl_uri        `& list
8970 .endd
8971 If the field is found,
8972 <&'string2'&> is expanded, and replaces the whole item;
8973 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8974 variable &$value$& contains the value that has been extracted. Afterwards, it
8975 is restored to any previous value it might have had.
8976
8977 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8978 key is not found. If {<&'string2'&>} is also omitted, the value that was
8979 extracted is used.
8980
8981 Some field names take optional modifiers, appended and separated by commas.
8982
8983 The field selectors marked as "RFC4514" above
8984 output a Distinguished Name string which is
8985 not quite
8986 parseable by Exim as a comma-separated tagged list
8987 (the exceptions being elements containing commas).
8988 RDN elements of a single type may be selected by
8989 a modifier of the type label; if so the expansion
8990 result is a list (newline-separated by default).
8991 The separator may be changed by another modifier of
8992 a right angle-bracket followed immediately by the new separator.
8993 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8994
8995 The field selectors marked as "time" above
8996 take an optional modifier of "int"
8997 for which the result is the number of seconds since epoch.
8998 Otherwise the result is a human-readable string
8999 in the timezone selected by the main "timezone" option.
9000
9001 The field selectors marked as "list" above return a list,
9002 newline-separated by default,
9003 (embedded separator characters in elements are doubled).
9004 The separator may be changed by a modifier of
9005 a right angle-bracket followed immediately by the new separator.
9006
9007 The field selectors marked as "tagged" above
9008 prefix each list element with a type string and an equals sign.
9009 Elements of only one type may be selected by a modifier
9010 which is one of "dns", "uri" or "mail";
9011 if so the element tags are omitted.
9012
9013 If not otherwise noted field values are presented in human-readable form.
9014
9015 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9016        {*&<&'arg'&>&*}...}*&"
9017 .cindex &%dlfunc%&
9018 This expansion dynamically loads and then calls a locally-written C function.
9019 This functionality is available only if Exim is compiled with
9020 .code
9021 EXPAND_DLFUNC=yes
9022 .endd
9023 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9024 object so that it doesn't reload the same object file in the same Exim process
9025 (but of course Exim does start new processes frequently).
9026
9027 There may be from zero to eight arguments to the function. When compiling
9028 a local function that is to be called in this way, &_local_scan.h_& should be
9029 included. The Exim variables and functions that are defined by that API
9030 are also available for dynamically loaded functions. The function itself
9031 must have the following type:
9032 .code
9033 int dlfunction(uschar **yield, int argc, uschar *argv[])
9034 .endd
9035 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9036 function should return one of the following values:
9037
9038 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9039 into the expanded string that is being built.
9040
9041 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9042 from &'yield'&, if it is set.
9043
9044 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9045 taken from &'yield'& if it is set.
9046
9047 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9048
9049 When compiling a function that is to be used in this way with gcc,
9050 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9051 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9052
9053
9054 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9055 .cindex "expansion" "extracting value from environment"
9056 .cindex "environment" "value from"
9057 The key is first expanded separately, and leading and trailing white space
9058 removed.
9059 This is then searched for as a name in the environment.
9060 If a variable is found then its value is placed in &$value$&
9061 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9062
9063 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9064 appear, for example:
9065 .code
9066 ${env{USER}{$value} fail }
9067 .endd
9068 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9069 {<&'string1'&>} must be present for &"fail"& to be recognized.
9070
9071 If {<&'string2'&>} is omitted an empty string is substituted on
9072 search failure.
9073 If {<&'string1'&>} is omitted the search result is substituted on
9074 search success.
9075
9076
9077 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9078        {*&<&'string3'&>&*}}*&"
9079 .cindex "expansion" "extracting substrings by key"
9080 .cindex "&%extract%&" "substrings by key"
9081 The key and <&'string1'&> are first expanded separately. Leading and trailing
9082 white space is removed from the key (but not from any of the strings). The key
9083 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9084 form:
9085 .display
9086 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9087 .endd
9088 .vindex "&$value$&"
9089 where the equals signs and spaces (but not both) are optional. If any of the
9090 values contain white space, they must be enclosed in double quotes, and any
9091 values that are enclosed in double quotes are subject to escape processing as
9092 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9093 for the value that corresponds to the key. The search is case-insensitive. If
9094 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9095 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9096 variable &$value$& contains the value that has been extracted. Afterwards, it
9097 is restored to any previous value it might have had.
9098
9099 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9100 key is not found. If {<&'string2'&>} is also omitted, the value that was
9101 extracted is used. Thus, for example, these two expansions are identical, and
9102 yield &"2001"&:
9103 .code
9104 ${extract{gid}{uid=1984 gid=2001}}
9105 ${extract{gid}{uid=1984 gid=2001}{$value}}
9106 .endd
9107 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9108 appear, for example:
9109 .code
9110 ${extract{Z}{A=... B=...}{$value} fail }
9111 .endd
9112 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9113 {<&'string2'&>} must be present for &"fail"& to be recognized.
9114
9115
9116 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9117         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9118 .cindex "expansion" "extracting substrings by number"
9119 .cindex "&%extract%&" "substrings by number"
9120 The <&'number'&> argument must consist entirely of decimal digits,
9121 apart from leading and trailing white space, which is ignored.
9122 This is what distinguishes this form of &%extract%& from the previous kind. It
9123 behaves in the same way, except that, instead of extracting a named field, it
9124 extracts from <&'string1'&> the field whose number is given as the first
9125 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9126 <&'string3'&> as before.
9127
9128 The fields in the string are separated by any one of the characters in the
9129 separator string. These may include space or tab characters.
9130 The first field is numbered one. If the number is negative, the fields are
9131 counted from the end of the string, with the rightmost one numbered -1. If the
9132 number given is zero, the entire string is returned. If the modulus of the
9133 number is greater than the number of fields in the string, the result is the
9134 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9135 provided. For example:
9136 .code
9137 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9138 .endd
9139 yields &"42"&, and
9140 .code
9141 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9142 .endd
9143 yields &"99"&. Two successive separators mean that the field between them is
9144 empty (for example, the fifth field above).
9145
9146
9147 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9148 .cindex "list" "selecting by condition"
9149 .cindex "expansion" "selecting from list by condition"
9150 .vindex "&$item$&"
9151 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9152 default, but the separator can be changed in the usual way. For each item
9153 in this list, its value is place in &$item$&, and then the condition is
9154 evaluated. If the condition is true, &$item$& is added to the output as an
9155 item in a new list; if the condition is false, the item is discarded. The
9156 separator used for the output list is the same as the one used for the
9157 input, but a separator setting is not included in the output. For example:
9158 .code
9159 ${filter{a:b:c}{!eq{$item}{b}}
9160 .endd
9161 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9162 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9163
9164
9165 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9166 .cindex "hash function" "textual"
9167 .cindex "expansion" "textual hash"
9168 This is a textual hashing function, and was the first to be implemented in
9169 early versions of Exim. In current releases, there are other hashing functions
9170 (numeric, MD5, and SHA-1), which are described below.
9171
9172 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9173 <&'n'&>. If you are using fixed values for these numbers, that is, if
9174 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9175 use the simpler operator notation that avoids some of the braces:
9176 .code
9177 ${hash_<n>_<m>:<string>}
9178 .endd
9179 The second number is optional (in both notations). If <&'n'&> is greater than
9180 or equal to the length of the string, the expansion item returns the string.
9181 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9182 function to the string. The new string consists of characters taken from the
9183 first <&'m'&> characters of the string
9184 .code
9185 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9186 .endd
9187 If <&'m'&> is not present the value 26 is used, so that only lower case
9188 letters appear. For example:
9189 .display
9190 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9191 &`$hash{5}{monty}}           `&   yields  &`monty`&
9192 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9193 .endd
9194
9195 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9196         &*$h_*&<&'header&~name'&>&*:*&" &&&
9197        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9198         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9199        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9200         &*$rh_*&<&'header&~name'&>&*:*&"
9201 .cindex "expansion" "header insertion"
9202 .vindex "&$header_$&"
9203 .vindex "&$bheader_$&"
9204 .vindex "&$rheader_$&"
9205 .cindex "header lines" "in expansion strings"
9206 .cindex "header lines" "character sets"
9207 .cindex "header lines" "decoding"
9208 Substitute the contents of the named message header line, for example
9209 .code
9210 $header_reply-to:
9211 .endd
9212 The newline that terminates a header line is not included in the expansion, but
9213 internal newlines (caused by splitting the header line over several physical
9214 lines) may be present.
9215
9216 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9217 the data in the header line is interpreted.
9218
9219 .ilist
9220 .cindex "white space" "in header lines"
9221 &%rheader%& gives the original &"raw"& content of the header line, with no
9222 processing at all, and without the removal of leading and trailing white space.
9223
9224 .next
9225 .cindex "base64 encoding" "in header lines"
9226 &%bheader%& removes leading and trailing white space, and then decodes base64
9227 or quoted-printable MIME &"words"& within the header text, but does no
9228 character set translation. If decoding of what looks superficially like a MIME
9229 &"word"& fails, the raw string is returned. If decoding
9230 .cindex "binary zero" "in header line"
9231 produces a binary zero character, it is replaced by a question mark &-- this is
9232 what Exim does for binary zeros that are actually received in header lines.
9233
9234 .next
9235 &%header%& tries to translate the string as decoded by &%bheader%& to a
9236 standard character set. This is an attempt to produce the same string as would
9237 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9238 returned. Translation is attempted only on operating systems that support the
9239 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9240 a system Makefile or in &_Local/Makefile_&.
9241 .endlist ilist
9242
9243 In a filter file, the target character set for &%header%& can be specified by a
9244 command of the following form:
9245 .code
9246 headers charset "UTF-8"
9247 .endd
9248 This command affects all references to &$h_$& (or &$header_$&) expansions in
9249 subsequently obeyed filter commands. In the absence of this command, the target
9250 character set in a filter is taken from the setting of the &%headers_charset%&
9251 option in the runtime configuration. The value of this option defaults to the
9252 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9253 ISO-8859-1.
9254
9255 Header names follow the syntax of RFC 2822, which states that they may contain
9256 any printing characters except space and colon. Consequently, curly brackets
9257 &'do not'& terminate header names, and should not be used to enclose them as
9258 if they were variables. Attempting to do so causes a syntax error.
9259
9260 Only header lines that are common to all copies of a message are visible to
9261 this mechanism. These are the original header lines that are received with the
9262 message, and any that are added by an ACL statement or by a system
9263 filter. Header lines that are added to a particular copy of a message by a
9264 router or transport are not accessible.
9265
9266 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9267 before the DATA ACL, because the header structure is not set up until the
9268 message is received. Header lines that are added in a RCPT ACL (for example)
9269 are saved until the message's incoming header lines are available, at which
9270 point they are added. When a DATA ACL is running, however, header lines added
9271 by earlier ACLs are visible.
9272
9273 Upper case and lower case letters are synonymous in header names. If the
9274 following character is white space, the terminating colon may be omitted, but
9275 this is not recommended, because you may then forget it when it is needed. When
9276 white space terminates the header name, this white space is included in the
9277 expanded string.  If the message does not contain the given header, the
9278 expansion item is replaced by an empty string. (See the &%def%& condition in
9279 section &<<SECTexpcond>>& for a means of testing for the existence of a
9280 header.)
9281
9282 If there is more than one header with the same name, they are all concatenated
9283 to form the substitution string, up to a maximum length of 64K. Unless
9284 &%rheader%& is being used, leading and trailing white space is removed from
9285 each header before concatenation, and a completely empty header is ignored. A
9286 newline character is then inserted between non-empty headers, but there is no
9287 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9288 those headers that contain lists of addresses, a comma is also inserted at the
9289 junctions between headers. This does not happen for the &%rheader%& expansion.
9290
9291
9292 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9293 .cindex "expansion" "hmac hashing"
9294 .cindex &%hmac%&
9295 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9296 shared secret and some text into a message authentication code, as specified in
9297 RFC 2104. This differs from &`${md5:secret_text...}`& or
9298 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9299 cryptographic hash, allowing for authentication that is not possible with MD5
9300 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9301 present. For example:
9302 .code
9303 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9304 .endd
9305 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9306 produces:
9307 .code
9308 dd97e3ba5d1a61b5006108f8c8252953
9309 .endd
9310 As an example of how this might be used, you might put in the main part of
9311 an Exim configuration:
9312 .code
9313 SPAMSCAN_SECRET=cohgheeLei2thahw
9314 .endd
9315 In a router or a transport you could then have:
9316 .code
9317 headers_add = \
9318   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9319   ${hmac{md5}{SPAMSCAN_SECRET}\
9320   {${primary_hostname},${message_exim_id},$h_message-id:}}
9321 .endd
9322 Then given a message, you can check where it was scanned by looking at the
9323 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9324 this header line is authentic by recomputing the authentication code from the
9325 host name, message ID and the &'Message-id:'& header line. This can be done
9326 using Exim's &%-be%& option, or by other means, for example by using the
9327 &'hmac_md5_hex()'& function in Perl.
9328
9329
9330 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9331 .cindex "expansion" "conditional"
9332 .cindex "&%if%&, expansion item"
9333 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9334 item; otherwise <&'string2'&> is used. The available conditions are described
9335 in section &<<SECTexpcond>>& below. For example:
9336 .code
9337 ${if eq {$local_part}{postmaster} {yes}{no} }
9338 .endd
9339 The second string need not be present; if it is not and the condition is not
9340 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9341 be present instead of the second string (without any curly brackets). In this
9342 case, the expansion is forced to fail if the condition is not true (see section
9343 &<<SECTforexpfai>>&).
9344
9345 If both strings are omitted, the result is the string &`true`& if the condition
9346 is true, and the empty string if the condition is false. This makes it less
9347 cumbersome to write custom ACL and router conditions. For example, instead of
9348 .code
9349 condition = ${if >{$acl_m4}{3}{true}{false}}
9350 .endd
9351 you can use
9352 .code
9353 condition = ${if >{$acl_m4}{3}}
9354 .endd
9355
9356 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9357 .cindex "expansion" "string truncation"
9358 .cindex "&%length%& expansion item"
9359 The &%length%& item is used to extract the initial portion of a string. Both
9360 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9361 you are using a fixed value for the number, that is, if <&'string1'&> does not
9362 change when expanded, you can use the simpler operator notation that avoids
9363 some of the braces:
9364 .code
9365 ${length_<n>:<string>}
9366 .endd
9367 The result of this item is either the first <&'n'&> characters or the whole
9368 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9369 &%strlen%&, which gives the length of a string.
9370
9371
9372 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9373         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9374 .cindex "expansion" "extracting list elements by number"
9375 .cindex "&%listextract%&" "extract list elements by number"
9376 .cindex "list" "extracting elements by number"
9377 The <&'number'&> argument must consist entirely of decimal digits,
9378 apart from an optional leading minus,
9379 and leading and trailing white space (which is ignored).
9380
9381 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9382 default, but the separator can be changed in the usual way.
9383
9384 The first field of the list is numbered one.
9385 If the number is negative, the fields are
9386 counted from the end of the list, with the rightmost one numbered -1.
9387 The numbered element of the list is extracted and placed in &$value$&,
9388 then <&'string2'&> is expanded as the result.
9389
9390 If the modulus of the
9391 number is zero or greater than the number of fields in the string,
9392 the result is the expansion of <&'string3'&>.
9393
9394 For example:
9395 .code
9396 ${listextract{2}{x:42:99}}
9397 .endd
9398 yields &"42"&, and
9399 .code
9400 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9401 .endd
9402 yields &"result: 42"&.
9403
9404 If {<&'string3'&>} is omitted, an empty string is used for string3.
9405 If {<&'string2'&>} is also omitted, the value that was
9406 extracted is used.
9407 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9408
9409
9410 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9411         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9412 This is the first of one of two different types of lookup item, which are both
9413 described in the next item.
9414
9415 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9416         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9417 .cindex "expansion" "lookup in"
9418 .cindex "file" "lookups"
9419 .cindex "lookup" "in expanded string"
9420 The two forms of lookup item specify data lookups in files and databases, as
9421 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9422 lookups, and the second is used for query-style lookups. The <&'key'&>,
9423 <&'file'&>, and <&'query'&> strings are expanded before use.
9424
9425 If there is any white space in a lookup item which is part of a filter command,
9426 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9427 other place where white space is significant, the lookup item must be enclosed
9428 in double quotes. The use of data lookups in users' filter files may be locked
9429 out by the system administrator.
9430
9431 .vindex "&$value$&"
9432 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9433 During its expansion, the variable &$value$& contains the data returned by the
9434 lookup. Afterwards it reverts to the value it had previously (at the outer
9435 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9436 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9437 string on failure. If <&'string2'&> is provided, it can itself be a nested
9438 lookup, thus providing a mechanism for looking up a default value when the
9439 original lookup fails.
9440
9441 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9442 data for the outer lookup while the parameters of the second lookup are
9443 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9444 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9445 appear, and in this case, if the lookup fails, the entire expansion is forced
9446 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9447 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9448 successful lookup, and nothing in the case of failure.
9449
9450 For single-key lookups, the string &"partial"& is permitted to precede the
9451 search type in order to do partial matching, and * or *@ may follow a search
9452 type to request default lookups if the key does not match (see sections
9453 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9454
9455 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9456 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9457 and non-wild parts of the key during the expansion of the replacement text.
9458 They return to their previous values at the end of the lookup item.
9459
9460 This example looks up the postmaster alias in the conventional alias file:
9461 .code
9462 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9463 .endd
9464 This example uses NIS+ to look up the full name of the user corresponding to
9465 the local part of an address, forcing the expansion to fail if it is not found:
9466 .code
9467 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9468   {$value}fail}
9469 .endd
9470
9471
9472 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9473 .cindex "expansion" "list creation"
9474 .vindex "&$item$&"
9475 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9476 default, but the separator can be changed in the usual way. For each item
9477 in this list, its value is place in &$item$&, and then <&'string2'&> is
9478 expanded and added to the output as an item in a new list. The separator used
9479 for the output list is the same as the one used for the input, but a separator
9480 setting is not included in the output. For example:
9481 .code
9482 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9483 .endd
9484 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9485 value of &$item$& is restored to what it was before. See also the &*filter*&
9486 and &*reduce*& expansion items.
9487
9488 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9489 .cindex "expansion" "numeric hash"
9490 .cindex "hash function" "numeric"
9491 The three strings are expanded; the first two must yield numbers. Call them
9492 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9493 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9494 can use the simpler operator notation that avoids some of the braces:
9495 .code
9496 ${nhash_<n>_<m>:<string>}
9497 .endd
9498 The second number is optional (in both notations). If there is only one number,
9499 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9500 processed by a div/mod hash function that returns two numbers, separated by a
9501 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9502 example,
9503 .code
9504 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9505 .endd
9506 returns the string &"6/33"&.
9507
9508
9509
9510 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9511 .cindex "Perl" "use in expanded string"
9512 .cindex "expansion" "calling Perl from"
9513 This item is available only if Exim has been built to include an embedded Perl
9514 interpreter. The subroutine name and the arguments are first separately
9515 expanded, and then the Perl subroutine is called with those arguments. No
9516 additional arguments need be given; the maximum number permitted, including the
9517 name of the subroutine, is nine.
9518
9519 The return value of the subroutine is inserted into the expanded string, unless
9520 the return value is &%undef%&. In that case, the expansion fails in the same
9521 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9522 Whatever you return is evaluated in a scalar context. For example, if you
9523 return the name of a Perl vector, the return value is the size of the vector,
9524 not its contents.
9525
9526 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9527 with the error message that was passed to &%die%&. More details of the embedded
9528 Perl facility are given in chapter &<<CHAPperl>>&.
9529
9530 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9531 out the use of this expansion item in filter files.
9532
9533
9534 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9535 .cindex "&%prvs%& expansion item"
9536 The first argument is a complete email address and the second is secret
9537 keystring. The third argument, specifying a key number, is optional. If absent,
9538 it defaults to 0. The result of the expansion is a prvs-signed email address,
9539 to be typically used with the &%return_path%& option on an &(smtp)& transport
9540 as part of a bounce address tag validation (BATV) scheme. For more discussion
9541 and an example, see section &<<SECTverifyPRVS>>&.
9542
9543 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9544         {*&<&'string'&>&*}}*&"
9545 .cindex "&%prvscheck%& expansion item"
9546 This expansion item is the complement of the &%prvs%& item. It is used for
9547 checking prvs-signed addresses. If the expansion of the first argument does not
9548 yield a syntactically valid prvs-signed address, the whole item expands to the
9549 empty string. When the first argument does expand to a syntactically valid
9550 prvs-signed address, the second argument is expanded, with the prvs-decoded
9551 version of the address and the key number extracted from the address in the
9552 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9553
9554 These two variables can be used in the expansion of the second argument to
9555 retrieve the secret. The validity of the prvs-signed address is then checked
9556 against the secret. The result is stored in the variable &$prvscheck_result$&,
9557 which is empty for failure or &"1"& for success.
9558
9559 The third argument is optional; if it is missing, it defaults to an empty
9560 string. This argument is now expanded. If the result is an empty string, the
9561 result of the expansion is the decoded version of the address. This is the case
9562 whether or not the signature was valid. Otherwise, the result of the expansion
9563 is the expansion of the third argument.
9564
9565 All three variables can be used in the expansion of the third argument.
9566 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9567 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9568
9569 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9570 .cindex "expansion" "inserting an entire file"
9571 .cindex "file" "inserting into expansion"
9572 .cindex "&%readfile%& expansion item"
9573 The file name and end-of-line string are first expanded separately. The file is
9574 then read, and its contents replace the entire item. All newline characters in
9575 the file are replaced by the end-of-line string if it is present. Otherwise,
9576 newlines are left in the string.
9577 String expansion is not applied to the contents of the file. If you want this,
9578 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9579 the string expansion fails.
9580
9581 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9582 locks out the use of this expansion item in filter files.
9583
9584
9585
9586 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9587         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9588 .cindex "expansion" "inserting from a socket"
9589 .cindex "socket, use of in expansion"
9590 .cindex "&%readsocket%& expansion item"
9591 This item inserts data from a Unix domain or TCP socket into the expanded
9592 string. The minimal way of using it uses just two arguments, as in these
9593 examples:
9594 .code
9595 ${readsocket{/socket/name}{request string}}
9596 ${readsocket{inet:some.host:1234}{request string}}
9597 .endd
9598 For a Unix domain socket, the first substring must be the path to the socket.
9599 For an Internet socket, the first substring must contain &`inet:`& followed by
9600 a host name or IP address, followed by a colon and a port, which can be a
9601 number or the name of a TCP port in &_/etc/services_&. An IP address may
9602 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9603 example:
9604 .code
9605 ${readsocket{inet:[::1]:1234}{request string}}
9606 .endd
9607 Only a single host name may be given, but if looking it up yields more than
9608 one IP address, they are each tried in turn until a connection is made. For
9609 both kinds of socket, Exim makes a connection, writes the request string
9610 (unless it is an empty string) and reads from the socket until an end-of-file
9611 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9612 extend what can be done. Firstly, you can vary the timeout. For example:
9613 .code
9614 ${readsocket{/socket/name}{request string}{3s}}
9615 .endd
9616 A fourth argument allows you to change any newlines that are in the data
9617 that is read, in the same way as for &%readfile%& (see above). This example
9618 turns them into spaces:
9619 .code
9620 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9621 .endd
9622 As with all expansions, the substrings are expanded before the processing
9623 happens. Errors in these sub-expansions cause the expansion to fail. In
9624 addition, the following errors can occur:
9625
9626 .ilist
9627 Failure to create a socket file descriptor;
9628 .next
9629 Failure to connect the socket;
9630 .next
9631 Failure to write the request string;
9632 .next
9633 Timeout on reading from the socket.
9634 .endlist
9635
9636 By default, any of these errors causes the expansion to fail. However, if
9637 you supply a fifth substring, it is expanded and used when any of the above
9638 errors occurs. For example:
9639 .code
9640 ${readsocket{/socket/name}{request string}{3s}{\n}\
9641   {socket failure}}
9642 .endd
9643 You can test for the existence of a Unix domain socket by wrapping this
9644 expansion in &`${if exists`&, but there is a race condition between that test
9645 and the actual opening of the socket, so it is safer to use the fifth argument
9646 if you want to be absolutely sure of avoiding an expansion error for a
9647 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9648
9649 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9650 locks out the use of this expansion item in filter files.
9651
9652
9653 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9654 .cindex "expansion" "reducing a list to a scalar"
9655 .cindex "list" "reducing to a scalar"
9656 .vindex "&$value$&"
9657 .vindex "&$item$&"
9658 This operation reduces a list to a single, scalar string. After expansion,
9659 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9660 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9661 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9662 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9663 them. The result of that expansion is assigned to &$value$& before the next
9664 iteration. When the end of the list is reached, the final value of &$value$& is
9665 added to the expansion output. The &*reduce*& expansion item can be used in a
9666 number of ways. For example, to add up a list of numbers:
9667 .code
9668 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9669 .endd
9670 The result of that expansion would be &`6`&. The maximum of a list of numbers
9671 can be found:
9672 .code
9673 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9674 .endd
9675 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9676 restored to what they were before. See also the &*filter*& and &*map*&
9677 expansion items.
9678
9679 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9680 This item inserts &"raw"& header lines. It is described with the &%header%&
9681 expansion item above.
9682
9683 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9684         {*&<&'string2'&>&*}}*&"
9685 .cindex "expansion" "running a command"
9686 .cindex "&%run%& expansion item"
9687 The command and its arguments are first expanded as one string. The string is
9688 split apart into individual arguments by spaces, and then the command is run
9689 in a separate process, but under the same uid and gid.  As in other command
9690 executions from Exim, a shell is not used by default. If the command requires
9691 a shell, you must explicitly code it.
9692
9693 Since the arguments are split by spaces, when there is a variable expansion
9694 which has an empty result, it will cause the situation that the argument will
9695 simply be omitted when the program is actually executed by Exim. If the
9696 script/program requires a specific number of arguments and the expanded
9697 variable could possibly result in this empty expansion, the variable must be
9698 quoted. This is more difficult if the expanded variable itself could result
9699 in a string containing quotes, because it would interfere with the quotes
9700 around the command arguments. A possible guard against this is to wrap the
9701 variable in the &%sg%& operator to change any quote marks to some other
9702 character.
9703
9704 The standard input for the command exists, but is empty. The standard output
9705 and standard error are set to the same file descriptor.
9706 .cindex "return code" "from &%run%& expansion"
9707 .vindex "&$value$&"
9708 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9709 and replaces the entire item; during this expansion, the standard output/error
9710 from the command is in the variable &$value$&. If the command fails,
9711 <&'string2'&>, if present, is expanded and used. Once again, during the
9712 expansion, the standard output/error from the command is in the variable
9713 &$value$&.
9714
9715 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9716 can be the word &"fail"& (not in braces) to force expansion failure if the
9717 command does not succeed. If both strings are omitted, the result is contents
9718 of the standard output/error on success, and nothing on failure.
9719
9720 .vindex "&$run_in_acl$&"
9721 The standard output/error of the command is put in the variable &$value$&.
9722 In this ACL example, the output of a command is logged for the admin to
9723 troubleshoot:
9724 .code
9725 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9726       log_message  = Output of id: $value
9727 .endd
9728 If the command requires shell idioms, such as the > redirect operator, the
9729 shell must be invoked directly, such as with:
9730 .code
9731 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9732 .endd
9733
9734 .vindex "&$runrc$&"
9735 The return code from the command is put in the variable &$runrc$&, and this
9736 remains set afterwards, so in a filter file you can do things like this:
9737 .code
9738 if "${run{x y z}{}}$runrc" is 1 then ...
9739   elif $runrc is 2 then ...
9740   ...
9741 endif
9742 .endd
9743 If execution of the command fails (for example, the command does not exist),
9744 the return code is 127 &-- the same code that shells use for non-existent
9745 commands.
9746
9747 &*Warning*&: In a router or transport, you cannot assume the order in which
9748 option values are expanded, except for those preconditions whose order of
9749 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9750 by the expansion of one option, and use it in another.
9751
9752 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9753 out the use of this expansion item in filter files.
9754
9755
9756 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9757 .cindex "expansion" "string substitution"
9758 .cindex "&%sg%& expansion item"
9759 This item works like Perl's substitution operator (s) with the global (/g)
9760 option; hence its name. However, unlike the Perl equivalent, Exim does not
9761 modify the subject string; instead it returns the modified string for insertion
9762 into the overall expansion. The item takes three arguments: the subject string,
9763 a regular expression, and a substitution string. For example:
9764 .code
9765 ${sg{abcdefabcdef}{abc}{xyz}}
9766 .endd
9767 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9768 if any $ or \ characters are required in the regular expression or in the
9769 substitution string, they have to be escaped. For example:
9770 .code
9771 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9772 .endd
9773 yields &"defabc"&, and
9774 .code
9775 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9776 .endd
9777 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9778 the regular expression from string expansion.
9779
9780
9781
9782 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9783 .cindex sorting "a list"
9784 .cindex list sorting
9785 .cindex expansion "list sorting"
9786 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9787 default, but the separator can be changed in the usual way.
9788 The <&'comparator'&> argument is interpreted as the operator
9789 of a two-argument expansion condition.
9790 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9791 The comparison should return true when applied to two values
9792 if the first value should sort before the second value.
9793 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9794 the element being placed in &$item$&,
9795 to give values for comparison.
9796
9797 The item result is a sorted list,
9798 with the original list separator,
9799 of the list elements (in full) of the original.
9800
9801 Examples:
9802 .code
9803 ${sort{3:2:1:4}{<}{$item}}
9804 .endd
9805 sorts a list of numbers, and
9806 .code
9807 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9808 .endd
9809 will sort an MX lookup into priority order.
9810
9811
9812 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9813 .cindex "&%substr%& expansion item"
9814 .cindex "substring extraction"
9815 .cindex "expansion" "substring extraction"
9816 The three strings are expanded; the first two must yield numbers. Call them
9817 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9818 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9819 can use the simpler operator notation that avoids some of the braces:
9820 .code
9821 ${substr_<n>_<m>:<string>}
9822 .endd
9823 The second number is optional (in both notations).
9824 If it is absent in the simpler format, the preceding underscore must also be
9825 omitted.
9826
9827 The &%substr%& item can be used to extract more general substrings than
9828 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9829 length required. For example
9830 .code
9831 ${substr{3}{2}{$local_part}}
9832 .endd
9833 If the starting offset is greater than the string length the result is the
9834 null string; if the length plus starting offset is greater than the string
9835 length, the result is the right-hand part of the string, starting from the
9836 given offset. The first character in the string has offset zero.
9837
9838 The &%substr%& expansion item can take negative offset values to count
9839 from the right-hand end of its operand. The last character is offset -1, the
9840 second-last is offset -2, and so on. Thus, for example,
9841 .code
9842 ${substr{-5}{2}{1234567}}
9843 .endd
9844 yields &"34"&. If the absolute value of a negative offset is greater than the
9845 length of the string, the substring starts at the beginning of the string, and
9846 the length is reduced by the amount of overshoot. Thus, for example,
9847 .code
9848 ${substr{-5}{2}{12}}
9849 .endd
9850 yields an empty string, but
9851 .code
9852 ${substr{-3}{2}{12}}
9853 .endd
9854 yields &"1"&.
9855
9856 When the second number is omitted from &%substr%&, the remainder of the string
9857 is taken if the offset is positive. If it is negative, all characters in the
9858 string preceding the offset point are taken. For example, an offset of -1 and
9859 no length, as in these semantically identical examples:
9860 .code
9861 ${substr_-1:abcde}
9862 ${substr{-1}{abcde}}
9863 .endd
9864 yields all but the last character of the string, that is, &"abcd"&.
9865
9866
9867
9868 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9869         {*&<&'replacements'&>&*}}*&"
9870 .cindex "expansion" "character translation"
9871 .cindex "&%tr%& expansion item"
9872 This item does single-character translation on its subject string. The second
9873 argument is a list of characters to be translated in the subject string. Each
9874 matching character is replaced by the corresponding character from the
9875 replacement list. For example
9876 .code
9877 ${tr{abcdea}{ac}{13}}
9878 .endd
9879 yields &`1b3de1`&. If there are duplicates in the second character string, the
9880 last occurrence is used. If the third string is shorter than the second, its
9881 last character is replicated. However, if it is empty, no translation takes
9882 place.
9883 .endlist
9884
9885
9886
9887 .section "Expansion operators" "SECTexpop"
9888 .cindex "expansion" "operators"
9889 For expansion items that perform transformations on a single argument string,
9890 the &"operator"& notation is used because it is simpler and uses fewer braces.
9891 The substring is first expanded before the operation is applied to it. The
9892 following operations can be performed:
9893
9894 .vlist
9895 .vitem &*${address:*&<&'string'&>&*}*&
9896 .cindex "expansion" "RFC 2822 address handling"
9897 .cindex "&%address%& expansion item"
9898 The string is interpreted as an RFC 2822 address, as it might appear in a
9899 header line, and the effective address is extracted from it. If the string does
9900 not parse successfully, the result is empty.
9901
9902
9903 .vitem &*${addresses:*&<&'string'&>&*}*&
9904 .cindex "expansion" "RFC 2822 address handling"
9905 .cindex "&%addresses%& expansion item"
9906 The string (after expansion) is interpreted as a list of addresses in RFC
9907 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9908 operative address (&'local-part@domain'&) is extracted from each item, and the
9909 result of the expansion is a colon-separated list, with appropriate
9910 doubling of colons should any happen to be present in the email addresses.
9911 Syntactically invalid RFC2822 address items are omitted from the output.
9912
9913 It is possible to specify a character other than colon for the output
9914 separator by starting the string with > followed by the new separator
9915 character. For example:
9916 .code
9917 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9918 .endd
9919 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9920 expansion item, which extracts the working address from a single RFC2822
9921 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9922 processing lists.
9923
9924 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9925 a strict interpretation of header line formatting.  Exim parses the bare,
9926 unquoted portion of an email address and if it finds a comma, treats it as an
9927 email address separator. For the example header line:
9928 .code
9929 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9930 .endd
9931 The first example below demonstrates that Q-encoded email addresses are parsed
9932 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9933 It does not see the comma because it's still encoded as "=2C".  The second
9934 example below is passed the contents of &`$header_from:`&, meaning it gets
9935 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9936 The third example shows that the presence of a comma is skipped when it is
9937 quoted.
9938 .code
9939 # exim -be '${addresses:From: \
9940 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9941 user@example.com
9942 # exim -be '${addresses:From: Last, First <user@example.com>}'
9943 Last:user@example.com
9944 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9945 user@example.com
9946 .endd
9947
9948 .vitem &*${base62:*&<&'digits'&>&*}*&
9949 .cindex "&%base62%& expansion item"
9950 .cindex "expansion" "conversion to base 62"
9951 The string must consist entirely of decimal digits. The number is converted to
9952 base 62 and output as a string of six characters, including leading zeros. In
9953 the few operating environments where Exim uses base 36 instead of base 62 for
9954 its message identifiers (because those systems do not have case-sensitive file
9955 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9956 be absolutely clear: this is &'not'& base64 encoding.
9957
9958 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9959 .cindex "&%base62d%& expansion item"
9960 .cindex "expansion" "conversion to base 62"
9961 The string must consist entirely of base-62 digits, or, in operating
9962 environments where Exim uses base 36 instead of base 62 for its message
9963 identifiers, base-36 digits. The number is converted to decimal and output as a
9964 string.
9965
9966
9967 .vitem &*${domain:*&<&'string'&>&*}*&
9968 .cindex "domain" "extraction"
9969 .cindex "expansion" "domain extraction"
9970 The string is interpreted as an RFC 2822 address and the domain is extracted
9971 from it. If the string does not parse successfully, the result is empty.
9972
9973
9974 .vitem &*${escape:*&<&'string'&>&*}*&
9975 .cindex "expansion" "escaping non-printing characters"
9976 .cindex "&%escape%& expansion item"
9977 If the string contains any non-printing characters, they are converted to
9978 escape sequences starting with a backslash. Whether characters with the most
9979 significant bit set (so-called &"8-bit characters"&) count as printing or not
9980 is controlled by the &%print_topbitchars%& option.
9981
9982
9983 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9984 .cindex "expansion" "expression evaluation"
9985 .cindex "expansion" "arithmetic expression"
9986 .cindex "&%eval%& expansion item"
9987 These items supports simple arithmetic and bitwise logical operations in
9988 expansion strings. The string (after expansion) must be a conventional
9989 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9990 logical operators, and parentheses. All operations are carried out using
9991 integer arithmetic. The operator priorities are as follows (the same as in the
9992 C programming language):
9993 .table2 70pt 300pt
9994 .irow &'highest:'& "not (~), negate (-)"
9995 .irow ""   "multiply (*), divide (/), remainder (%)"
9996 .irow ""   "plus (+), minus (-)"
9997 .irow ""   "shift-left (<<), shift-right (>>)"
9998 .irow ""   "and (&&)"
9999 .irow ""   "xor (^)"
10000 .irow &'lowest:'&  "or (|)"
10001 .endtable
10002 Binary operators with the same priority are evaluated from left to right. White
10003 space is permitted before or after operators.
10004
10005 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10006 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10007 decimal, even if they start with a leading zero; hexadecimal numbers are not
10008 permitted. This can be useful when processing numbers extracted from dates or
10009 times, which often do have leading zeros.
10010
10011 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10012 or 1024*1024*1024,
10013 respectively. Negative numbers are supported. The result of the computation is
10014 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10015
10016 .display
10017 &`${eval:1+1}            `&  yields 2
10018 &`${eval:1+2*3}          `&  yields 7
10019 &`${eval:(1+2)*3}        `&  yields 9
10020 &`${eval:2+42%5}         `&  yields 4
10021 &`${eval:0xc&amp;5}          `&  yields 4
10022 &`${eval:0xc|5}          `&  yields 13
10023 &`${eval:0xc^5}          `&  yields 9
10024 &`${eval:0xc>>1}         `&  yields 6
10025 &`${eval:0xc<<1}         `&  yields 24
10026 &`${eval:~255&amp;0x1234}    `&  yields 4608
10027 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10028 .endd
10029
10030 As a more realistic example, in an ACL you might have
10031 .code
10032 deny   message = Too many bad recipients
10033        condition =                    \
10034          ${if and {                   \
10035            {>{$rcpt_count}{10}}       \
10036            {                          \
10037            <                          \
10038              {$recipients_count}      \
10039              {${eval:$rcpt_count/2}}  \
10040            }                          \
10041          }{yes}{no}}
10042 .endd
10043 The condition is true if there have been more than 10 RCPT commands and
10044 fewer than half of them have resulted in a valid recipient.
10045
10046
10047 .vitem &*${expand:*&<&'string'&>&*}*&
10048 .cindex "expansion" "re-expansion of substring"
10049 The &%expand%& operator causes a string to be expanded for a second time. For
10050 example,
10051 .code
10052 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10053 .endd
10054 first looks up a string in a file while expanding the operand for &%expand%&,
10055 and then re-expands what it has found.
10056
10057
10058 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10059 .cindex "Unicode"
10060 .cindex "UTF-8" "conversion from"
10061 .cindex "expansion" "UTF-8 conversion"
10062 .cindex "&%from_utf8%& expansion item"
10063 The world is slowly moving towards Unicode, although there are no standards for
10064 email yet. However, other applications (including some databases) are starting
10065 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10066 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10067 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10068 the result is an undefined sequence of bytes.
10069
10070 Unicode code points with values less than 256 are compatible with ASCII and
10071 ISO-8859-1 (also known as Latin-1).
10072 For example, character 169 is the copyright symbol in both cases, though the
10073 way it is encoded is different. In UTF-8, more than one byte is needed for
10074 characters with code values greater than 127, whereas ISO-8859-1 is a
10075 single-byte encoding (but thereby limited to 256 characters). This makes
10076 translation from UTF-8 to ISO-8859-1 straightforward.
10077
10078
10079 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10080 .cindex "hash function" "textual"
10081 .cindex "expansion" "textual hash"
10082 The &%hash%& operator is a simpler interface to the hashing function that can
10083 be used when the two parameters are fixed numbers (as opposed to strings that
10084 change when expanded). The effect is the same as
10085 .code
10086 ${hash{<n>}{<m>}{<string>}}
10087 .endd
10088 See the description of the general &%hash%& item above for details. The
10089 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10090
10091
10092
10093 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10094 .cindex "base64 encoding" "conversion from hex"
10095 .cindex "expansion" "hex to base64"
10096 .cindex "&%hex2b64%& expansion item"
10097 This operator converts a hex string into one that is base64 encoded. This can
10098 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10099
10100
10101
10102 .vitem &*${hexquote:*&<&'string'&>&*}*&
10103 .cindex "quoting" "hex-encoded unprintable characters"
10104 .cindex "&%hexquote%& expansion item"
10105 This operator converts non-printable characters in a string into a hex
10106 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10107 as is, and other byte values are converted to &`\xNN`&, for example a
10108 byte value 127 is converted to &`\x7f`&.
10109
10110
10111 .vitem &*${lc:*&<&'string'&>&*}*&
10112 .cindex "case forcing in strings"
10113 .cindex "string" "case forcing"
10114 .cindex "lower casing"
10115 .cindex "expansion" "case forcing"
10116 .cindex "&%lc%& expansion item"
10117 This forces the letters in the string into lower-case, for example:
10118 .code
10119 ${lc:$local_part}
10120 .endd
10121
10122 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10123 .cindex "expansion" "string truncation"
10124 .cindex "&%length%& expansion item"
10125 The &%length%& operator is a simpler interface to the &%length%& function that
10126 can be used when the parameter is a fixed number (as opposed to a string that
10127 changes when expanded). The effect is the same as
10128 .code
10129 ${length{<number>}{<string>}}
10130 .endd
10131 See the description of the general &%length%& item above for details. Note that
10132 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10133 when &%length%& is used as an operator.
10134
10135
10136 .vitem &*${listcount:*&<&'string'&>&*}*&
10137 .cindex "expansion" "list item count"
10138 .cindex "list" "item count"
10139 .cindex "list" "count of items"
10140 .cindex "&%listcount%& expansion item"
10141 The string is interpreted as a list and the number of items is returned.
10142
10143
10144 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10145 .cindex "expansion" "named list"
10146 .cindex "&%listnamed%& expansion item"
10147 The name is interpreted as a named list and the content of the list is returned,
10148 expanding any referenced lists, re-quoting as needed for colon-separation.
10149 If the optional type is given it must be one of "a", "d", "h" or "l"
10150 and selects address-, domain-, host- or localpart- lists to search among respectively.
10151 Otherwise all types are searched in an undefined order and the first
10152 matching list is returned.
10153
10154
10155 .vitem &*${local_part:*&<&'string'&>&*}*&
10156 .cindex "expansion" "local part extraction"
10157 .cindex "&%local_part%& expansion item"
10158 The string is interpreted as an RFC 2822 address and the local part is
10159 extracted from it. If the string does not parse successfully, the result is
10160 empty.
10161
10162
10163 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10164 .cindex "masked IP address"
10165 .cindex "IP address" "masking"
10166 .cindex "CIDR notation"
10167 .cindex "expansion" "IP address masking"
10168 .cindex "&%mask%& expansion item"
10169 If the form of the string to be operated on is not an IP address followed by a
10170 slash and an integer (that is, a network address in CIDR notation), the
10171 expansion fails. Otherwise, this operator converts the IP address to binary,
10172 masks off the least significant bits according to the bit count, and converts
10173 the result back to text, with mask appended. For example,
10174 .code
10175 ${mask:10.111.131.206/28}
10176 .endd
10177 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10178 be mostly used for looking up masked addresses in files, the result for an IPv6
10179 address uses dots to separate components instead of colons, because colon
10180 terminates a key string in lsearch files. So, for example,
10181 .code
10182 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10183 .endd
10184 returns the string
10185 .code
10186 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10187 .endd
10188 Letters in IPv6 addresses are always output in lower case.
10189
10190
10191 .vitem &*${md5:*&<&'string'&>&*}*&
10192 .cindex "MD5 hash"
10193 .cindex "expansion" "MD5 hash"
10194 .cindex "certificate fingerprint"
10195 .cindex "&%md5%& expansion item"
10196 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10197 as a 32-digit hexadecimal number, in which any letters are in lower case.
10198
10199
10200 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10201 .cindex "expansion" "numeric hash"
10202 .cindex "hash function" "numeric"
10203 The &%nhash%& operator is a simpler interface to the numeric hashing function
10204 that can be used when the two parameters are fixed numbers (as opposed to
10205 strings that change when expanded). The effect is the same as
10206 .code
10207 ${nhash{<n>}{<m>}{<string>}}
10208 .endd
10209 See the description of the general &%nhash%& item above for details.
10210
10211
10212 .vitem &*${quote:*&<&'string'&>&*}*&
10213 .cindex "quoting" "in string expansions"
10214 .cindex "expansion" "quoting"
10215 .cindex "&%quote%& expansion item"
10216 The &%quote%& operator puts its argument into double quotes if it
10217 is an empty string or
10218 contains anything other than letters, digits, underscores, dots, and hyphens.
10219 Any occurrences of double quotes and backslashes are escaped with a backslash.
10220 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10221 respectively For example,
10222 .code
10223 ${quote:ab"*"cd}
10224 .endd
10225 becomes
10226 .code
10227 "ab\"*\"cd"
10228 .endd
10229 The place where this is useful is when the argument is a substitution from a
10230 variable or a message header.
10231
10232 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10233 .cindex "&%quote_local_part%& expansion item"
10234 This operator is like &%quote%&, except that it quotes the string only if
10235 required to do so by the rules of RFC 2822 for quoting local parts. For
10236 example, a plus sign would not cause quoting (but it would for &%quote%&).
10237 If you are creating a new email address from the contents of &$local_part$&
10238 (or any other unknown data), you should always use this operator.
10239
10240
10241 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10242 .cindex "quoting" "lookup-specific"
10243 This operator applies lookup-specific quoting rules to the string. Each
10244 query-style lookup type has its own quoting rules which are described with
10245 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10246 .code
10247 ${quote_ldap:two * two}
10248 .endd
10249 returns
10250 .code
10251 two%20%5C2A%20two
10252 .endd
10253 For single-key lookup types, no quoting is ever necessary and this operator
10254 yields an unchanged string.
10255
10256
10257 .vitem &*${randint:*&<&'n'&>&*}*&
10258 .cindex "random number"
10259 This operator returns a somewhat random number which is less than the
10260 supplied number and is at least 0.  The quality of this randomness depends
10261 on how Exim was built; the values are not suitable for keying material.
10262 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10263 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10264 for versions of GnuTLS with that function.
10265 Otherwise, the implementation may be arc4random(), random() seeded by
10266 srandomdev() or srandom(), or a custom implementation even weaker than
10267 random().
10268
10269
10270 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10271 .cindex "expansion" "IP address"
10272 This operator reverses an IP address; for IPv4 addresses, the result is in
10273 dotted-quad decimal form, while for IPv6 addresses the result is in
10274 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10275 for DNS.  For example,
10276 .code
10277 ${reverse_ip:192.0.2.4}
10278 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10279 .endd
10280 returns
10281 .code
10282 4.2.0.192
10283 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
10284 .endd
10285
10286
10287 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10288 .cindex "expansion" "RFC 2047"
10289 .cindex "RFC 2047" "expansion operator"
10290 .cindex "&%rfc2047%& expansion item"
10291 This operator encodes text according to the rules of RFC 2047. This is an
10292 encoding that is used in header lines to encode non-ASCII characters. It is
10293 assumed that the input string is in the encoding specified by the
10294 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10295 contains only characters in the range 33&--126, and no instances of the
10296 characters
10297 .code
10298 ? = ( ) < > @ , ; : \ " . [ ] _
10299 .endd
10300 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10301 string, using as many &"encoded words"& as necessary to encode all the
10302 characters.
10303
10304
10305 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10306 .cindex "expansion" "RFC 2047"
10307 .cindex "RFC 2047" "decoding"
10308 .cindex "&%rfc2047d%& expansion item"
10309 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10310 bytes are replaced by question marks. Characters are converted into the
10311 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10312 not recognized unless &%check_rfc2047_length%& is set false.
10313
10314 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10315 access a header line, RFC 2047 decoding is done automatically. You do not need
10316 to use this operator as well.
10317
10318
10319
10320 .vitem &*${rxquote:*&<&'string'&>&*}*&
10321 .cindex "quoting" "in regular expressions"
10322 .cindex "regular expressions" "quoting"
10323 .cindex "&%rxquote%& expansion item"
10324 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10325 characters in its argument. This is useful when substituting the values of
10326 variables or headers inside regular expressions.
10327
10328
10329 .vitem &*${sha1:*&<&'string'&>&*}*&
10330 .cindex "SHA-1 hash"
10331 .cindex "expansion" "SHA-1 hashing"
10332 .cindex "certificate fingerprint"
10333 .cindex "&%sha2%& expansion item"
10334 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10335 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10336
10337
10338 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10339 .cindex "SHA-256 hash"
10340 .cindex "certificate fingerprint"
10341 .cindex "expansion" "SHA-256 hashing"
10342 .cindex "&%sha256%& expansion item"
10343 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10344 certificate,
10345 and returns
10346 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10347 Only arguments which are a single variable of certificate type are supported.
10348
10349
10350 .vitem &*${stat:*&<&'string'&>&*}*&
10351 .cindex "expansion" "statting a file"
10352 .cindex "file" "extracting characteristics"
10353 .cindex "&%stat%& expansion item"
10354 The string, after expansion, must be a file path. A call to the &[stat()]&
10355 function is made for this path. If &[stat()]& fails, an error occurs and the
10356 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10357 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10358 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10359 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10360 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10361 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10362 can extract individual fields using the &%extract%& expansion item.
10363
10364 The use of the &%stat%& expansion in users' filter files can be locked out by
10365 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10366 systems for files larger than 2GB.
10367
10368 .vitem &*${str2b64:*&<&'string'&>&*}*&
10369 .cindex "expansion" "base64 encoding"
10370 .cindex "base64 encoding" "in string expansion"
10371 .cindex "&%str2b64%& expansion item"
10372 This operator converts a string into one that is base64 encoded.
10373
10374
10375
10376 .vitem &*${strlen:*&<&'string'&>&*}*&
10377 .cindex "expansion" "string length"
10378 .cindex "string" "length in expansion"
10379 .cindex "&%strlen%& expansion item"
10380 The item is replace by the length of the expanded string, expressed as a
10381 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10382
10383
10384 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10385 .cindex "&%substr%& expansion item"
10386 .cindex "substring extraction"
10387 .cindex "expansion" "substring expansion"
10388 The &%substr%& operator is a simpler interface to the &%substr%& function that
10389 can be used when the two parameters are fixed numbers (as opposed to strings
10390 that change when expanded). The effect is the same as
10391 .code
10392 ${substr{<start>}{<length>}{<string>}}
10393 .endd
10394 See the description of the general &%substr%& item above for details. The
10395 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10396
10397 .vitem &*${time_eval:*&<&'string'&>&*}*&
10398 .cindex "&%time_eval%& expansion item"
10399 .cindex "time interval" "decoding"
10400 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10401 seconds.
10402
10403 .vitem &*${time_interval:*&<&'string'&>&*}*&
10404 .cindex "&%time_interval%& expansion item"
10405 .cindex "time interval" "formatting"
10406 The argument (after sub-expansion) must be a sequence of decimal digits that
10407 represents an interval of time as a number of seconds. It is converted into a
10408 number of larger units and output in Exim's normal time format, for example,
10409 &`1w3d4h2m6s`&.
10410
10411 .vitem &*${uc:*&<&'string'&>&*}*&
10412 .cindex "case forcing in strings"
10413 .cindex "string" "case forcing"
10414 .cindex "upper casing"
10415 .cindex "expansion" "case forcing"
10416 .cindex "&%uc%& expansion item"
10417 This forces the letters in the string into upper-case.
10418
10419 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10420 .cindex "correction of invalid utf-8 sequences in strings"
10421 .cindex "utf-8" "utf-8 sequences"
10422 .cindex "incorrect utf-8"
10423 .cindex "expansion" "utf-8 forcing"
10424 .cindex "&%utf8clean%& expansion item"
10425 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10426 .endlist
10427
10428
10429
10430
10431
10432
10433 .section "Expansion conditions" "SECTexpcond"
10434 .scindex IIDexpcond "expansion" "conditions"
10435 The following conditions are available for testing by the &%${if%& construct
10436 while expanding strings:
10437
10438 .vlist
10439 .vitem &*!*&<&'condition'&>
10440 .cindex "expansion" "negating a condition"
10441 .cindex "negation" "in expansion condition"
10442 Preceding any condition with an exclamation mark negates the result of the
10443 condition.
10444
10445 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10446 .cindex "numeric comparison"
10447 .cindex "expansion" "numeric comparison"
10448 There are a number of symbolic operators for doing numeric comparisons. They
10449 are:
10450 .display
10451 &`=   `&   equal
10452 &`==  `&   equal
10453 &`>   `&   greater
10454 &`>=  `&   greater or equal
10455 &`<   `&   less
10456 &`<=  `&   less or equal
10457 .endd
10458 For example:
10459 .code
10460 ${if >{$message_size}{10M} ...
10461 .endd
10462 Note that the general negation operator provides for inequality testing. The
10463 two strings must take the form of optionally signed decimal integers,
10464 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10465 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10466 As a special case, the numerical value of an empty string is taken as
10467 zero.
10468
10469 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10470 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10471 10M, not if 10M is larger than &$message_size$&.
10472
10473
10474 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10475         {*&<&'arg2'&>&*}...}*&
10476 .cindex "expansion" "calling an acl"
10477 .cindex "&%acl%&" "expansion condition"
10478 The name and zero to nine argument strings are first expanded separately.  The expanded
10479 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10480 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10481 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10482 and may use the variables; if another acl expansion is used the values
10483 are restored after it returns.  If the ACL sets
10484 a value using a "message =" modifier the variable $value becomes
10485 the result of the expansion, otherwise it is empty.
10486 If the ACL returns accept the condition is true; if deny, false.
10487 If the ACL returns defer the result is a forced-fail.
10488
10489 .vitem &*bool&~{*&<&'string'&>&*}*&
10490 .cindex "expansion" "boolean parsing"
10491 .cindex "&%bool%& expansion condition"
10492 This condition turns a string holding a true or false representation into
10493 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10494 (case-insensitively); also integer numbers map to true if non-zero,
10495 false if zero.
10496 An empty string is treated as false.
10497 Leading and trailing whitespace is ignored;
10498 thus a string consisting only of whitespace is false.
10499 All other string values will result in expansion failure.
10500
10501 When combined with ACL variables, this expansion condition will let you
10502 make decisions in one place and act on those decisions in another place.
10503 For example:
10504 .code
10505 ${if bool{$acl_m_privileged_sender} ...
10506 .endd
10507
10508
10509 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10510 .cindex "expansion" "boolean parsing"
10511 .cindex "&%bool_lax%& expansion condition"
10512 Like &%bool%&, this condition turns a string into a boolean state.  But
10513 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10514 loose definition that the Router &%condition%& option uses.  The empty string
10515 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10516 true.  Leading and trailing whitespace is ignored.
10517
10518 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10519
10520 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10521 .cindex "expansion" "encrypted comparison"
10522 .cindex "encrypted strings, comparing"
10523 .cindex "&%crypteq%& expansion condition"
10524 This condition is included in the Exim binary if it is built to support any
10525 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10526 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10527 included in the binary.
10528
10529 The &%crypteq%& condition has two arguments. The first is encrypted and
10530 compared against the second, which is already encrypted. The second string may
10531 be in the LDAP form for storing encrypted strings, which starts with the
10532 encryption type in curly brackets, followed by the data. If the second string
10533 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10534 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10535 Typically this will be a field from a password file. An example of an encrypted
10536 string in LDAP form is:
10537 .code
10538 {md5}CY9rzUYh03PK3k6DJie09g==
10539 .endd
10540 If such a string appears directly in an expansion, the curly brackets have to
10541 be quoted, because they are part of the expansion syntax. For example:
10542 .code
10543 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10544 .endd
10545 The following encryption types (whose names are matched case-independently) are
10546 supported:
10547
10548 .ilist
10549 .cindex "MD5 hash"
10550 .cindex "base64 encoding" "in encrypted password"
10551 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10552 printable characters to compare with the remainder of the second string. If the
10553 length of the comparison string is 24, Exim assumes that it is base64 encoded
10554 (as in the above example). If the length is 32, Exim assumes that it is a
10555 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10556 comparison fails.
10557
10558 .next
10559 .cindex "SHA-1 hash"
10560 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10561 printable characters to compare with the remainder of the second string. If the
10562 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10563 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10564 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10565
10566 .next
10567 .cindex "&[crypt()]&"
10568 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10569 only the first eight characters of the password. However, in modern operating
10570 systems this is no longer true, and in many cases the entire password is used,
10571 whatever its length.
10572
10573 .next
10574 .cindex "&[crypt16()]&"
10575 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10576 use up to 16 characters of the password in some operating systems. Again, in
10577 modern operating systems, more characters may be used.
10578 .endlist
10579 Exim has its own version of &[crypt16()]&, which is just a double call to
10580 &[crypt()]&. For operating systems that have their own version, setting
10581 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10582 operating system version instead of its own. This option is set by default in
10583 the OS-dependent &_Makefile_& for those operating systems that are known to
10584 support &[crypt16()]&.
10585
10586 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10587 it was not using the same algorithm as some operating systems' versions. It
10588 turns out that as well as &[crypt16()]& there is a function called
10589 &[bigcrypt()]& in some operating systems. This may or may not use the same
10590 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10591
10592 However, since there is now a move away from the traditional &[crypt()]&
10593 functions towards using SHA1 and other algorithms, tidying up this area of
10594 Exim is seen as very low priority.
10595
10596 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10597 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10598 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10599 default is &`{crypt}`&. Whatever the default, you can always use either
10600 function by specifying it explicitly in curly brackets.
10601
10602 .vitem &*def:*&<&'variable&~name'&>
10603 .cindex "expansion" "checking for empty variable"
10604 .cindex "&%def%& expansion condition"
10605 The &%def%& condition must be followed by the name of one of the expansion
10606 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10607 variable does not contain the empty string. For example:
10608 .code
10609 ${if def:sender_ident {from $sender_ident}}
10610 .endd
10611 Note that the variable name is given without a leading &%$%& character. If the
10612 variable does not exist, the expansion fails.
10613
10614 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10615         &~&*def:h_*&<&'header&~name'&>&*:*&"
10616 .cindex "expansion" "checking header line existence"
10617 This condition is true if a message is being processed and the named header
10618 exists in the message. For example,
10619 .code
10620 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10621 .endd
10622 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10623 the header name must be terminated by a colon if white space does not follow.
10624
10625 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10626        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10627 .cindex "string" "comparison"
10628 .cindex "expansion" "string comparison"
10629 .cindex "&%eq%& expansion condition"
10630 .cindex "&%eqi%& expansion condition"
10631 The two substrings are first expanded. The condition is true if the two
10632 resulting strings are identical. For &%eq%& the comparison includes the case of
10633 letters, whereas for &%eqi%& the comparison is case-independent.
10634
10635 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10636 .cindex "expansion" "file existence test"
10637 .cindex "file" "existence test"
10638 .cindex "&%exists%&, expansion condition"
10639 The substring is first expanded and then interpreted as an absolute path. The
10640 condition is true if the named file (or directory) exists. The existence test
10641 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10642 users' filter files may be locked out by the system administrator.
10643
10644 .vitem &*first_delivery*&
10645 .cindex "delivery" "first"
10646 .cindex "first delivery"
10647 .cindex "expansion" "first delivery test"
10648 .cindex "&%first_delivery%& expansion condition"
10649 This condition, which has no data, is true during a message's first delivery
10650 attempt. It is false during any subsequent delivery attempts.
10651
10652
10653 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10654        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10655 .cindex "list" "iterative conditions"
10656 .cindex "expansion" "&*forall*& condition"
10657 .cindex "expansion" "&*forany*& condition"
10658 .vindex "&$item$&"
10659 These conditions iterate over a list. The first argument is expanded to form
10660 the list. By default, the list separator is a colon, but it can be changed by
10661 the normal method. The second argument is interpreted as a condition that is to
10662 be applied to each item in the list in turn. During the interpretation of the
10663 condition, the current list item is placed in a variable called &$item$&.
10664 .ilist
10665 For &*forany*&, interpretation stops if the condition is true for any item, and
10666 the result of the whole condition is true. If the condition is false for all
10667 items in the list, the overall condition is false.
10668 .next
10669 For &*forall*&, interpretation stops if the condition is false for any item,
10670 and the result of the whole condition is false. If the condition is true for
10671 all items in the list, the overall condition is true.
10672 .endlist
10673 Note that negation of &*forany*& means that the condition must be false for all
10674 items for the overall condition to succeed, and negation of &*forall*& means
10675 that the condition must be false for at least one item. In this example, the
10676 list separator is changed to a comma:
10677 .code
10678 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10679 .endd
10680 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10681 being processed, to enable these expansion items to be nested.
10682
10683 To scan a named list, expand it with the &*listnamed*& operator.
10684
10685
10686 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10687        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10688 .cindex "string" "comparison"
10689 .cindex "expansion" "string comparison"
10690 .cindex "&%ge%& expansion condition"
10691 .cindex "&%gei%& expansion condition"
10692 The two substrings are first expanded. The condition is true if the first
10693 string is lexically greater than or equal to the second string. For &%ge%& the
10694 comparison includes the case of letters, whereas for &%gei%& the comparison is
10695 case-independent.
10696
10697 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10698        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10699 .cindex "string" "comparison"
10700 .cindex "expansion" "string comparison"
10701 .cindex "&%gt%& expansion condition"
10702 .cindex "&%gti%& expansion condition"
10703 The two substrings are first expanded. The condition is true if the first
10704 string is lexically greater than the second string. For &%gt%& the comparison
10705 includes the case of letters, whereas for &%gti%& the comparison is
10706 case-independent.
10707
10708 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10709        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10710 .cindex "string" "comparison"
10711 .cindex "list" "iterative conditions"
10712 Both strings are expanded; the second string is treated as a list of simple
10713 strings; if the first string is a member of the second, then the condition
10714 is true.
10715
10716 These are simpler to use versions of the more powerful &*forany*& condition.
10717 Examples, and the &*forany*& equivalents:
10718 .code
10719 ${if inlist{needle}{foo:needle:bar}}
10720   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10721 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10722   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10723 .endd
10724
10725 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10726        &*isip4&~{*&<&'string'&>&*}*& &&&
10727        &*isip6&~{*&<&'string'&>&*}*&
10728 .cindex "IP address" "testing string format"
10729 .cindex "string" "testing for IP address"
10730 .cindex "&%isip%& expansion condition"
10731 .cindex "&%isip4%& expansion condition"
10732 .cindex "&%isip6%& expansion condition"
10733 The substring is first expanded, and then tested to see if it has the form of
10734 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10735 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10736
10737 For an IPv4 address, the test is for four dot-separated components, each of
10738 which consists of from one to three digits. For an IPv6 address, up to eight
10739 colon-separated components are permitted, each containing from one to four
10740 hexadecimal digits. There may be fewer than eight components if an empty
10741 component (adjacent colons) is present. Only one empty component is permitted.
10742
10743 &*Note*&: The checks are just on the form of the address; actual numerical
10744 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10745 check. The main use of these tests is to distinguish between IP addresses and
10746 host names, or between IPv4 and IPv6 addresses. For example, you could use
10747 .code
10748 ${if isip4{$sender_host_address}...
10749 .endd
10750 to test which IP version an incoming SMTP connection is using.
10751
10752 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10753 .cindex "LDAP" "use for authentication"
10754 .cindex "expansion" "LDAP authentication test"
10755 .cindex "&%ldapauth%& expansion condition"
10756 This condition supports user authentication using LDAP. See section
10757 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10758 queries. For this use, the query must contain a user name and password. The
10759 query itself is not used, and can be empty. The condition is true if the
10760 password is not empty, and the user name and password are accepted by the LDAP
10761 server. An empty password is rejected without calling LDAP because LDAP binds
10762 with an empty password are considered anonymous regardless of the username, and
10763 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10764 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10765 this can be used.
10766
10767
10768 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10769        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10770 .cindex "string" "comparison"
10771 .cindex "expansion" "string comparison"
10772 .cindex "&%le%& expansion condition"
10773 .cindex "&%lei%& expansion condition"
10774 The two substrings are first expanded. The condition is true if the first
10775 string is lexically less than or equal to the second string. For &%le%& the
10776 comparison includes the case of letters, whereas for &%lei%& the comparison is
10777 case-independent.
10778
10779 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10780        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10781 .cindex "string" "comparison"
10782 .cindex "expansion" "string comparison"
10783 .cindex "&%lt%& expansion condition"
10784 .cindex "&%lti%& expansion condition"
10785 The two substrings are first expanded. The condition is true if the first
10786 string is lexically less than the second string. For &%lt%& the comparison
10787 includes the case of letters, whereas for &%lti%& the comparison is
10788 case-independent.
10789
10790
10791 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10792 .cindex "expansion" "regular expression comparison"
10793 .cindex "regular expressions" "match in expanded string"
10794 .cindex "&%match%& expansion condition"
10795 The two substrings are first expanded. The second is then treated as a regular
10796 expression and applied to the first. Because of the pre-expansion, if the
10797 regular expression contains dollar, or backslash characters, they must be
10798 escaped. Care must also be taken if the regular expression contains braces
10799 (curly brackets). A closing brace must be escaped so that it is not taken as a
10800 premature termination of <&'string2'&>. The easiest approach is to use the
10801 &`\N`& feature to disable expansion of the regular expression.
10802 For example,
10803 .code
10804 ${if match {$local_part}{\N^\d{3}\N} ...
10805 .endd
10806 If the whole expansion string is in double quotes, further escaping of
10807 backslashes is also required.
10808
10809 The condition is true if the regular expression match succeeds.
10810 The regular expression is not required to begin with a circumflex
10811 metacharacter, but if there is no circumflex, the expression is not anchored,
10812 and it may match anywhere in the subject, not just at the start. If you want
10813 the pattern to match at the end of the subject, you must include the &`$`&
10814 metacharacter at an appropriate point.
10815
10816 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10817 At the start of an &%if%& expansion the values of the numeric variable
10818 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10819 succeeds causes them to be reset to the substrings of that condition and they
10820 will have these values during the expansion of the success string. At the end
10821 of the &%if%& expansion, the previous values are restored. After testing a
10822 combination of conditions using &%or%&, the subsequent values of the numeric
10823 variables are those of the condition that succeeded.
10824
10825 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10826 .cindex "&%match_address%& expansion condition"
10827 See &*match_local_part*&.
10828
10829 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10830 .cindex "&%match_domain%& expansion condition"
10831 See &*match_local_part*&.
10832
10833 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10834 .cindex "&%match_ip%& expansion condition"
10835 This condition matches an IP address to a list of IP address patterns. It must
10836 be followed by two argument strings. The first (after expansion) must be an IP
10837 address or an empty string. The second (not expanded) is a restricted host
10838 list that can match only an IP address, not a host name. For example:
10839 .code
10840 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10841 .endd
10842 The specific types of host list item that are permitted in the list are:
10843
10844 .ilist
10845 An IP address, optionally with a CIDR mask.
10846 .next
10847 A single asterisk, which matches any IP address.
10848 .next
10849 An empty item, which matches only if the IP address is empty. This could be
10850 useful for testing for a locally submitted message or one from specific hosts
10851 in a single test such as
10852 . ==== As this is a nested list, any displays it contains must be indented
10853 . ==== as otherwise they are too far to the left. This comment applies to
10854 . ==== the use of xmlto plus fop. There's no problem when formatting with
10855 . ==== sdop, with or without the extra indent.
10856 .code
10857   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10858 .endd
10859 where the first item in the list is the empty string.
10860 .next
10861 The item @[] matches any of the local host's interface addresses.
10862 .next
10863 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10864 even if &`net-`& is not specified. There is never any attempt to turn the IP
10865 address into a host name. The most common type of linear search for
10866 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10867 masks. For example:
10868 .code
10869   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10870 .endd
10871 It is of course possible to use other kinds of lookup, and in such a case, you
10872 do need to specify the &`net-`& prefix if you want to specify a specific
10873 address mask, for example:
10874 .code
10875   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10876 .endd
10877 However, unless you are combining a &%match_ip%& condition with others, it is
10878 just as easy to use the fact that a lookup is itself a condition, and write:
10879 .code
10880   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10881 .endd
10882 .endlist ilist
10883
10884 Note that <&'string2'&> is not itself subject to string expansion, unless
10885 Exim was built with the EXPAND_LISTMATCH_RHS option.
10886
10887 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10888
10889 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10890 .cindex "domain list" "in expansion condition"
10891 .cindex "address list" "in expansion condition"
10892 .cindex "local part" "list, in expansion condition"
10893 .cindex "&%match_local_part%& expansion condition"
10894 This condition, together with &%match_address%& and &%match_domain%&, make it
10895 possible to test domain, address, and local part lists within expansions. Each
10896 condition requires two arguments: an item and a list to match. A trivial
10897 example is:
10898 .code
10899 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10900 .endd
10901 In each case, the second argument may contain any of the allowable items for a
10902 list of the appropriate type. Also, because the second argument (after
10903 expansion) is a standard form of list, it is possible to refer to a named list.
10904 Thus, you can use conditions like this:
10905 .code
10906 ${if match_domain{$domain}{+local_domains}{...
10907 .endd
10908 .cindex "&`+caseful`&"
10909 For address lists, the matching starts off caselessly, but the &`+caseful`&
10910 item can be used, as in all address lists, to cause subsequent items to
10911 have their local parts matched casefully. Domains are always matched
10912 caselessly.
10913
10914 Note that <&'string2'&> is not itself subject to string expansion, unless
10915 Exim was built with the EXPAND_LISTMATCH_RHS option.
10916
10917 &*Note*&: Host lists are &'not'& supported in this way. This is because
10918 hosts have two identities: a name and an IP address, and it is not clear
10919 how to specify cleanly how such a test would work. However, IP addresses can be
10920 matched using &%match_ip%&.
10921
10922 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10923 .cindex "PAM authentication"
10924 .cindex "AUTH" "with PAM"
10925 .cindex "Solaris" "PAM support"
10926 .cindex "expansion" "PAM authentication test"
10927 .cindex "&%pam%& expansion condition"
10928 &'Pluggable Authentication Modules'&
10929 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10930 available in the latest releases of Solaris and in some GNU/Linux
10931 distributions. The Exim support, which is intended for use in conjunction with
10932 the SMTP AUTH command, is available only if Exim is compiled with
10933 .code
10934 SUPPORT_PAM=yes
10935 .endd
10936 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10937 in some releases of GNU/Linux &%-ldl%& is also needed.
10938
10939 The argument string is first expanded, and the result must be a
10940 colon-separated list of strings. Leading and trailing white space is ignored.
10941 The PAM module is initialized with the service name &"exim"& and the user name
10942 taken from the first item in the colon-separated data string (<&'string1'&>).
10943 The remaining items in the data string are passed over in response to requests
10944 from the authentication function. In the simple case there will only be one
10945 request, for a password, so the data consists of just two strings.
10946
10947 There can be problems if any of the strings are permitted to contain colon
10948 characters. In the usual way, these have to be doubled to avoid being taken as
10949 separators. If the data is being inserted from a variable, the &%sg%& expansion
10950 item can be used to double any existing colons. For example, the configuration
10951 of a LOGIN authenticator might contain this setting:
10952 .code
10953 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10954 .endd
10955 For a PLAIN authenticator you could use:
10956 .code
10957 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10958 .endd
10959 In some operating systems, PAM authentication can be done only from a process
10960 running as root. Since Exim is running as the Exim user when receiving
10961 messages, this means that PAM cannot be used directly in those systems.
10962 A patched version of the &'pam_unix'& module that comes with the
10963 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10964 The patched module allows one special uid/gid combination, in addition to root,
10965 to authenticate. If you build the patched module to allow the Exim user and
10966 group, PAM can then be used from an Exim authenticator.
10967
10968
10969 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10970 .cindex "&'pwcheck'& daemon"
10971 .cindex "Cyrus"
10972 .cindex "expansion" "&'pwcheck'& authentication test"
10973 .cindex "&%pwcheck%& expansion condition"
10974 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10975 This is one way of making it possible for passwords to be checked by a process
10976 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10977 deprecated. Its replacement is &'saslauthd'& (see below).
10978
10979 The pwcheck support is not included in Exim by default. You need to specify
10980 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10981 building Exim. For example:
10982 .code
10983 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10984 .endd
10985 You do not need to install the full Cyrus software suite in order to use
10986 the pwcheck daemon. You can compile and install just the daemon alone
10987 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10988 access to the &_/var/pwcheck_& directory.
10989
10990 The &%pwcheck%& condition takes one argument, which must be the user name and
10991 password, separated by a colon. For example, in a LOGIN authenticator
10992 configuration, you might have this:
10993 .code
10994 server_condition = ${if pwcheck{$auth1:$auth2}}
10995 .endd
10996 Again, for a PLAIN authenticator configuration, this would be:
10997 .code
10998 server_condition = ${if pwcheck{$auth2:$auth3}}
10999 .endd
11000 .vitem &*queue_running*&
11001 .cindex "queue runner" "detecting when delivering from"
11002 .cindex "expansion" "queue runner test"
11003 .cindex "&%queue_running%& expansion condition"
11004 This condition, which has no data, is true during delivery attempts that are
11005 initiated by queue runner processes, and false otherwise.
11006
11007
11008 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11009 .cindex "Radius"
11010 .cindex "expansion" "Radius authentication"
11011 .cindex "&%radius%& expansion condition"
11012 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11013 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11014 the Radius client configuration file in order to build Exim with Radius
11015 support.
11016
11017 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11018 library, using the original API. If you are using release 0.4.0 or later of
11019 this library, you need to set
11020 .code
11021 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11022 .endd
11023 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11024 &%libradius%& library that comes with FreeBSD. To do this, set
11025 .code
11026 RADIUS_LIB_TYPE=RADLIB
11027 .endd
11028 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11029 You may also have to supply a suitable setting in EXTRALIBS so that the
11030 Radius library can be found when Exim is linked.
11031
11032 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11033 Radius client library, which calls the Radius server. The condition is true if
11034 the authentication is successful. For example:
11035 .code
11036 server_condition = ${if radius{<arguments>}}
11037 .endd
11038
11039
11040 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11041         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11042 .cindex "&'saslauthd'& daemon"
11043 .cindex "Cyrus"
11044 .cindex "expansion" "&'saslauthd'& authentication test"
11045 .cindex "&%saslauthd%& expansion condition"
11046 This condition supports user authentication using the Cyrus &'saslauthd'&
11047 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11048 Using this daemon is one way of making it possible for passwords to be checked
11049 by a process that is not running as root.
11050
11051 The saslauthd support is not included in Exim by default. You need to specify
11052 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11053 building Exim. For example:
11054 .code
11055 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11056 .endd
11057 You do not need to install the full Cyrus software suite in order to use
11058 the saslauthd daemon. You can compile and install just the daemon alone
11059 from the Cyrus SASL library.
11060
11061 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11062 two are mandatory. For example:
11063 .code
11064 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11065 .endd
11066 The service and the realm are optional (which is why the arguments are enclosed
11067 in their own set of braces). For details of the meaning of the service and
11068 realm, and how to run the daemon, consult the Cyrus documentation.
11069 .endlist vlist
11070
11071
11072
11073 .section "Combining expansion conditions" "SECID84"
11074 .cindex "expansion" "combining conditions"
11075 Several conditions can be tested at once by combining them using the &%and%&
11076 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11077 conditions on their own, and precede their lists of sub-conditions. Each
11078 sub-condition must be enclosed in braces within the overall braces that contain
11079 the list. No repetition of &%if%& is used.
11080
11081
11082 .vlist
11083 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11084 .cindex "&""or""& expansion condition"
11085 .cindex "expansion" "&""or""& of conditions"
11086 The sub-conditions are evaluated from left to right. The condition is true if
11087 any one of the sub-conditions is true.
11088 For example,
11089 .code
11090 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11091 .endd
11092 When a true sub-condition is found, the following ones are parsed but not
11093 evaluated. If there are several &"match"& sub-conditions the values of the
11094 numeric variables afterwards are taken from the first one that succeeds.
11095
11096 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11097 .cindex "&""and""& expansion condition"
11098 .cindex "expansion" "&""and""& of conditions"
11099 The sub-conditions are evaluated from left to right. The condition is true if
11100 all of the sub-conditions are true. If there are several &"match"&
11101 sub-conditions, the values of the numeric variables afterwards are taken from
11102 the last one. When a false sub-condition is found, the following ones are
11103 parsed but not evaluated.
11104 .endlist
11105 .ecindex IIDexpcond
11106
11107
11108
11109
11110 .section "Expansion variables" "SECTexpvar"
11111 .cindex "expansion" "variables, list of"
11112 This section contains an alphabetical list of all the expansion variables. Some
11113 of them are available only when Exim is compiled with specific options such as
11114 support for TLS or the content scanning extension.
11115
11116 .vlist
11117 .vitem "&$0$&, &$1$&, etc"
11118 .cindex "numerical variables (&$1$& &$2$& etc)"
11119 When a &%match%& expansion condition succeeds, these variables contain the
11120 captured substrings identified by the regular expression during subsequent
11121 processing of the success string of the containing &%if%& expansion item.
11122 In the expansion condition case
11123 they do not retain their values afterwards; in fact, their previous
11124 values are restored at the end of processing an &%if%& item. The numerical
11125 variables may also be set externally by some other matching process which
11126 precedes the expansion of the string. For example, the commands available in
11127 Exim filter files include an &%if%& command with its own regular expression
11128 matching condition.
11129
11130 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11131 Within an acl condition, expansion condition or expansion item
11132 any arguments are copied to these variables,
11133 any unused variables being made empty.
11134
11135 .vitem "&$acl_c...$&"
11136 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11137 can be given any name that starts with &$acl_c$& and is at least six characters
11138 long, but the sixth character must be either a digit or an underscore. For
11139 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11140 variables persist throughout the lifetime of an SMTP connection. They can be
11141 used to pass information between ACLs and between different invocations of the
11142 same ACL. When a message is received, the values of these variables are saved
11143 with the message, and can be accessed by filters, routers, and transports
11144 during subsequent delivery.
11145
11146 .vitem "&$acl_m...$&"
11147 These variables are like the &$acl_c...$& variables, except that their values
11148 are reset after a message has been received. Thus, if several messages are
11149 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11150 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11151 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11152 message is received, the values of these variables are saved with the message,
11153 and can be accessed by filters, routers, and transports during subsequent
11154 delivery.
11155
11156 .vitem &$acl_narg$&
11157 Within an acl condition, expansion condition or expansion item
11158 this variable has the number of arguments.
11159
11160 .vitem &$acl_verify_message$&
11161 .vindex "&$acl_verify_message$&"
11162 After an address verification has failed, this variable contains the failure
11163 message. It retains its value for use in subsequent modifiers. The message can
11164 be preserved by coding like this:
11165 .code
11166 warn !verify = sender
11167      set acl_m0 = $acl_verify_message
11168 .endd
11169 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11170 &%log_message%& modifiers, to include information about the verification
11171 failure.
11172
11173 .vitem &$address_data$&
11174 .vindex "&$address_data$&"
11175 This variable is set by means of the &%address_data%& option in routers. The
11176 value then remains with the address while it is processed by subsequent routers
11177 and eventually a transport. If the transport is handling multiple addresses,
11178 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11179 for more details. &*Note*&: The contents of &$address_data$& are visible in
11180 user filter files.
11181
11182 If &$address_data$& is set when the routers are called from an ACL to verify
11183 a recipient address, the final value is still in the variable for subsequent
11184 conditions and modifiers of the ACL statement. If routing the address caused it
11185 to be redirected to just one address, the child address is also routed as part
11186 of the verification, and in this case the final value of &$address_data$& is
11187 from the child's routing.
11188
11189 If &$address_data$& is set when the routers are called from an ACL to verify a
11190 sender address, the final value is also preserved, but this time in
11191 &$sender_address_data$&, to distinguish it from data from a recipient
11192 address.
11193
11194 In both cases (recipient and sender verification), the value does not persist
11195 after the end of the current ACL statement. If you want to preserve
11196 these values for longer, you can save them in ACL variables.
11197
11198 .vitem &$address_file$&
11199 .vindex "&$address_file$&"
11200 When, as a result of aliasing, forwarding, or filtering, a message is directed
11201 to a specific file, this variable holds the name of the file when the transport
11202 is running. At other times, the variable is empty. For example, using the
11203 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11204 .code
11205 /home/r2d2/savemail
11206 .endd
11207 then when the &(address_file)& transport is running, &$address_file$&
11208 contains the text string &`/home/r2d2/savemail`&.
11209 .cindex "Sieve filter" "value of &$address_file$&"
11210 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11211 then up to the transport configuration to generate an appropriate absolute path
11212 to the relevant file.
11213
11214 .vitem &$address_pipe$&
11215 .vindex "&$address_pipe$&"
11216 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11217 this variable holds the pipe command when the transport is running.
11218
11219 .vitem "&$auth1$& &-- &$auth3$&"
11220 .vindex "&$auth1$&, &$auth2$&, etc"
11221 These variables are used in SMTP authenticators (see chapters
11222 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11223
11224 .vitem &$authenticated_id$&
11225 .cindex "authentication" "id"
11226 .vindex "&$authenticated_id$&"
11227 When a server successfully authenticates a client it may be configured to
11228 preserve some of the authentication information in the variable
11229 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11230 user/password authenticator configuration might preserve the user name for use
11231 in the routers. Note that this is not the same information that is saved in
11232 &$sender_host_authenticated$&.
11233 When a message is submitted locally (that is, not over a TCP connection)
11234 the value of &$authenticated_id$& is normally the login name of the calling
11235 process. However, a trusted user can override this by means of the &%-oMai%&
11236 command line option.
11237
11238 .vitem &$authenticated_fail_id$&
11239 .cindex "authentication" "fail" "id"
11240 .vindex "&$authenticated_fail_id$&"
11241 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11242 will contain the failed authentication id. If more than one authentication
11243 id is attempted, it will contain only the last one. The variable is
11244 available for processing in the ACL's, generally the quit or notquit ACL.
11245 A message to a local recipient could still be accepted without requiring
11246 authentication, which means this variable could also be visible in all of
11247 the ACL's as well.
11248
11249
11250 .vitem &$authenticated_sender$&
11251 .cindex "sender" "authenticated"
11252 .cindex "authentication" "sender"
11253 .cindex "AUTH" "on MAIL command"
11254 .vindex "&$authenticated_sender$&"
11255 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11256 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11257 described in section &<<SECTauthparamail>>&. Unless the data is the string
11258 &"<>"&, it is set as the authenticated sender of the message, and the value is
11259 available during delivery in the &$authenticated_sender$& variable. If the
11260 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11261
11262 .vindex "&$qualify_domain$&"
11263 When a message is submitted locally (that is, not over a TCP connection), the
11264 value of &$authenticated_sender$& is an address constructed from the login
11265 name of the calling process and &$qualify_domain$&, except that a trusted user
11266 can override this by means of the &%-oMas%& command line option.
11267
11268
11269 .vitem &$authentication_failed$&
11270 .cindex "authentication" "failure"
11271 .vindex "&$authentication_failed$&"
11272 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11273 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11274 possible to distinguish between &"did not try to authenticate"&
11275 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11276 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11277 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11278 negative response to an AUTH command, including (for example) an attempt to use
11279 an undefined mechanism.
11280
11281 .vitem &$av_failed$&
11282 .cindex "content scanning" "AV scanner failure"
11283 This variable is available when Exim is compiled with the content-scanning
11284 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11285 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11286 the ACL malware condition.
11287
11288 .vitem &$body_linecount$&
11289 .cindex "message body" "line count"
11290 .cindex "body of message" "line count"
11291 .vindex "&$body_linecount$&"
11292 When a message is being received or delivered, this variable contains the
11293 number of lines in the message's body. See also &$message_linecount$&.
11294
11295 .vitem &$body_zerocount$&
11296 .cindex "message body" "binary zero count"
11297 .cindex "body of message" "binary zero count"
11298 .cindex "binary zero" "in message body"
11299 .vindex "&$body_zerocount$&"
11300 When a message is being received or delivered, this variable contains the
11301 number of binary zero bytes (ASCII NULs) in the message's body.
11302
11303 .vitem &$bounce_recipient$&
11304 .vindex "&$bounce_recipient$&"
11305 This is set to the recipient address of a bounce message while Exim is creating
11306 it. It is useful if a customized bounce message text file is in use (see
11307 chapter &<<CHAPemsgcust>>&).
11308
11309 .vitem &$bounce_return_size_limit$&
11310 .vindex "&$bounce_return_size_limit$&"
11311 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11312 up to a multiple of 1000. It is useful when a customized error message text
11313 file is in use (see chapter &<<CHAPemsgcust>>&).
11314
11315 .vitem &$caller_gid$&
11316 .cindex "gid (group id)" "caller"
11317 .vindex "&$caller_gid$&"
11318 The real group id under which the process that called Exim was running. This is
11319 not the same as the group id of the originator of a message (see
11320 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11321 incarnation normally contains the Exim gid.
11322
11323 .vitem &$caller_uid$&
11324 .cindex "uid (user id)" "caller"
11325 .vindex "&$caller_uid$&"
11326 The real user id under which the process that called Exim was running. This is
11327 not the same as the user id of the originator of a message (see
11328 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11329 incarnation normally contains the Exim uid.
11330
11331 .vitem &$callout_address$&
11332 .vindex "&$callout_address$&"
11333 After a callout for verification, spamd or malware daemon service, the
11334 address that was connected to.
11335
11336 .vitem &$compile_number$&
11337 .vindex "&$compile_number$&"
11338 The building process for Exim keeps a count of the number
11339 of times it has been compiled. This serves to distinguish different
11340 compilations of the same version of the program.
11341
11342 .vitem &$config_dir$&
11343 .vindex "&$config_dir$&"
11344 The directory name of the main configuration file. That is, the content of
11345 &$config_file$& with the last component stripped. The value does not
11346 contain the trailing slash. If &$config_file$& does not contain a slash,
11347 &$config_dir$& is ".".
11348
11349 .vitem &$config_file$&
11350 .vindex "&$config_file$&"
11351 The name of the main configuration file Exim is using.
11352
11353 .vitem &$demime_errorlevel$&
11354 .vindex "&$demime_errorlevel$&"
11355 This variable is available when Exim is compiled with
11356 the content-scanning extension and the obsolete &%demime%& condition. For
11357 details, see section &<<SECTdemimecond>>&.
11358
11359 .vitem &$demime_reason$&
11360 .vindex "&$demime_reason$&"
11361 This variable is available when Exim is compiled with the
11362 content-scanning extension and the obsolete &%demime%& condition. For details,
11363 see section &<<SECTdemimecond>>&.
11364
11365 .vitem &$dkim_cur_signer$& &&&
11366        &$dkim_verify_status$& &&&
11367        &$dkim_verify_reason$& &&&
11368        &$dkim_domain$& &&&
11369        &$dkim_identity$& &&&
11370        &$dkim_selector$& &&&
11371        &$dkim_algo$& &&&
11372        &$dkim_canon_body$& &&&
11373        &$dkim_canon_headers$& &&&
11374        &$dkim_copiedheaders$& &&&
11375        &$dkim_bodylength$& &&&
11376        &$dkim_created$& &&&
11377        &$dkim_expires$& &&&
11378        &$dkim_headernames$& &&&
11379        &$dkim_key_testing$& &&&
11380        &$dkim_key_nosubdomains$& &&&
11381        &$dkim_key_srvtype$& &&&
11382        &$dkim_key_granularity$& &&&
11383        &$dkim_key_notes$&
11384 These variables are only available within the DKIM ACL.
11385 For details see chapter &<<CHAPdkim>>&.
11386
11387 .vitem &$dkim_signers$&
11388 .vindex &$dkim_signers$&
11389 When a message has been received this variable contains
11390 a colon-separated list of signer domains and identities for the message.
11391 For details see chapter &<<CHAPdkim>>&.
11392
11393 .vitem &$dnslist_domain$& &&&
11394        &$dnslist_matched$& &&&
11395        &$dnslist_text$& &&&
11396        &$dnslist_value$&
11397 .vindex "&$dnslist_domain$&"
11398 .vindex "&$dnslist_matched$&"
11399 .vindex "&$dnslist_text$&"
11400 .vindex "&$dnslist_value$&"
11401 .cindex "black list (DNS)"
11402 When a DNS (black) list lookup succeeds, these variables are set to contain
11403 the following data from the lookup: the list's domain name, the key that was
11404 looked up, the contents of any associated TXT record, and the value from the
11405 main A record. See section &<<SECID204>>& for more details.
11406
11407 .vitem &$domain$&
11408 .vindex "&$domain$&"
11409 When an address is being routed, or delivered on its own, this variable
11410 contains the domain. Uppercase letters in the domain are converted into lower
11411 case for &$domain$&.
11412
11413 Global address rewriting happens when a message is received, so the value of
11414 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11415 is set during user filtering, but not during system filtering, because a
11416 message may have many recipients and the system filter is called just once.
11417
11418 When more than one address is being delivered at once (for example, several
11419 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11420 have the same domain. Transports can be restricted to handling only one domain
11421 at a time if the value of &$domain$& is required at transport time &-- this is
11422 the default for local transports. For further details of the environment in
11423 which local transports are run, see chapter &<<CHAPenvironment>>&.
11424
11425 .oindex "&%delay_warning_condition%&"
11426 At the end of a delivery, if all deferred addresses have the same domain, it is
11427 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11428
11429 The &$domain$& variable is also used in some other circumstances:
11430
11431 .ilist
11432 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11433 the recipient address. The domain of the &'sender'& address is in
11434 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11435 normally set during the running of the MAIL ACL. However, if the sender address
11436 is verified with a callout during the MAIL ACL, the sender domain is placed in
11437 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11438 the &(smtp)& transport.
11439
11440 .next
11441 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11442 &$domain$& contains the domain portion of the address that is being rewritten;
11443 it can be used in the expansion of the replacement address, for example, to
11444 rewrite domains by file lookup.
11445
11446 .next
11447 With one important exception, whenever a domain list is being scanned,
11448 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11449 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11450 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11451 that, in a RCPT ACL, the sender domain list can be dependent on the
11452 recipient domain (which is what is in &$domain$& at this time).
11453
11454 .next
11455 .cindex "ETRN" "value of &$domain$&"
11456 .oindex "&%smtp_etrn_command%&"
11457 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11458 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11459 .endlist
11460
11461
11462 .vitem &$domain_data$&
11463 .vindex "&$domain_data$&"
11464 When the &%domains%& option on a router matches a domain by
11465 means of a lookup, the data read by the lookup is available during the running
11466 of the router as &$domain_data$&. In addition, if the driver routes the
11467 address to a transport, the value is available in that transport. If the
11468 transport is handling multiple addresses, the value from the first address is
11469 used.
11470
11471 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11472 domain by means of a lookup. The data read by the lookup is available during
11473 the rest of the ACL statement. In all other situations, this variable expands
11474 to nothing.
11475
11476 .vitem &$exim_gid$&
11477 .vindex "&$exim_gid$&"
11478 This variable contains the numerical value of the Exim group id.
11479
11480 .vitem &$exim_path$&
11481 .vindex "&$exim_path$&"
11482 This variable contains the path to the Exim binary.
11483
11484 .vitem &$exim_uid$&
11485 .vindex "&$exim_uid$&"
11486 This variable contains the numerical value of the Exim user id.
11487
11488 .vitem &$exim_version$&
11489 .vindex "&$exim_version$&"
11490 This variable contains the version string of the Exim build.
11491 The first character is a major version number, currently 4.
11492 Then after a dot, the next group of digits is a minor version number.
11493 There may be other characters following the minor version.
11494
11495 .vitem &$found_extension$&
11496 .vindex "&$found_extension$&"
11497 This variable is available when Exim is compiled with the
11498 content-scanning extension and the obsolete &%demime%& condition. For details,
11499 see section &<<SECTdemimecond>>&.
11500
11501 .vitem &$header_$&<&'name'&>
11502 This is not strictly an expansion variable. It is expansion syntax for
11503 inserting the message header line with the given name. Note that the name must
11504 be terminated by colon or white space, because it may contain a wide variety of
11505 characters. Note also that braces must &'not'& be used.
11506
11507 .vitem &$headers_added$&
11508 .vindex "&$headers_added$&"
11509 Within an ACL this variable contains the headers added so far by
11510 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11511 The headers are a newline-separated list.
11512
11513 .vitem &$home$&
11514 .vindex "&$home$&"
11515 When the &%check_local_user%& option is set for a router, the user's home
11516 directory is placed in &$home$& when the check succeeds. In particular, this
11517 means it is set during the running of users' filter files. A router may also
11518 explicitly set a home directory for use by a transport; this can be overridden
11519 by a setting on the transport itself.
11520
11521 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11522 of the environment variable HOME.
11523
11524 .vitem &$host$&
11525 .vindex "&$host$&"
11526 If a router assigns an address to a transport (any transport), and passes a
11527 list of hosts with the address, the value of &$host$& when the transport starts
11528 to run is the name of the first host on the list. Note that this applies both
11529 to local and remote transports.
11530
11531 .cindex "transport" "filter"
11532 .cindex "filter" "transport filter"
11533 For the &(smtp)& transport, if there is more than one host, the value of
11534 &$host$& changes as the transport works its way through the list. In
11535 particular, when the &(smtp)& transport is expanding its options for encryption
11536 using TLS, or for specifying a transport filter (see chapter
11537 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11538 is connected.
11539
11540 When used in the client part of an authenticator configuration (see chapter
11541 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11542 client is connected.
11543
11544
11545 .vitem &$host_address$&
11546 .vindex "&$host_address$&"
11547 This variable is set to the remote host's IP address whenever &$host$& is set
11548 for a remote connection. It is also set to the IP address that is being checked
11549 when the &%ignore_target_hosts%& option is being processed.
11550
11551 .vitem &$host_data$&
11552 .vindex "&$host_data$&"
11553 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11554 result of the lookup is made available in the &$host_data$& variable. This
11555 allows you, for example, to do things like this:
11556 .code
11557 deny  hosts = net-lsearch;/some/file
11558 message = $host_data
11559 .endd
11560 .vitem &$host_lookup_deferred$&
11561 .cindex "host name" "lookup, failure of"
11562 .vindex "&$host_lookup_deferred$&"
11563 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11564 message comes from a remote host and there is an attempt to look up the host's
11565 name from its IP address, and the attempt is not successful, one of these
11566 variables is set to &"1"&.
11567
11568 .ilist
11569 If the lookup receives a definite negative response (for example, a DNS lookup
11570 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11571
11572 .next
11573 If there is any kind of problem during the lookup, such that Exim cannot
11574 tell whether or not the host name is defined (for example, a timeout for a DNS
11575 lookup), &$host_lookup_deferred$& is set to &"1"&.
11576 .endlist ilist
11577
11578 Looking up a host's name from its IP address consists of more than just a
11579 single reverse lookup. Exim checks that a forward lookup of at least one of the
11580 names it receives from a reverse lookup yields the original IP address. If this
11581 is not the case, Exim does not accept the looked up name(s), and
11582 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11583 IP address (for example, the existence of a PTR record in the DNS) is not
11584 sufficient on its own for the success of a host name lookup. If the reverse
11585 lookup succeeds, but there is a lookup problem such as a timeout when checking
11586 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11587 &"1"&. See also &$sender_host_name$&.
11588
11589 .vitem &$host_lookup_failed$&
11590 .vindex "&$host_lookup_failed$&"
11591 See &$host_lookup_deferred$&.
11592
11593 .vitem &$host_port$&
11594 .vindex "&$host_port$&"
11595 This variable is set to the remote host's TCP port whenever &$host$& is set
11596 for an outbound connection.
11597
11598
11599 .vitem &$inode$&
11600 .vindex "&$inode$&"
11601 The only time this variable is set is while expanding the &%directory_file%&
11602 option in the &(appendfile)& transport. The variable contains the inode number
11603 of the temporary file which is about to be renamed. It can be used to construct
11604 a unique name for the file.
11605
11606 .vitem &$interface_address$&
11607 .vindex "&$interface_address$&"
11608 This is an obsolete name for &$received_ip_address$&.
11609
11610 .vitem &$interface_port$&
11611 .vindex "&$interface_port$&"
11612 This is an obsolete name for &$received_port$&.
11613
11614 .vitem &$item$&
11615 .vindex "&$item$&"
11616 This variable is used during the expansion of &*forall*& and &*forany*&
11617 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11618 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11619 empty.
11620
11621 .vitem &$ldap_dn$&
11622 .vindex "&$ldap_dn$&"
11623 This variable, which is available only when Exim is compiled with LDAP support,
11624 contains the DN from the last entry in the most recently successful LDAP
11625 lookup.
11626
11627 .vitem &$load_average$&
11628 .vindex "&$load_average$&"
11629 This variable contains the system load average, multiplied by 1000 so that it
11630 is an integer. For example, if the load average is 0.21, the value of the
11631 variable is 210. The value is recomputed every time the variable is referenced.
11632
11633 .vitem &$local_part$&
11634 .vindex "&$local_part$&"
11635 When an address is being routed, or delivered on its own, this
11636 variable contains the local part. When a number of addresses are being
11637 delivered together (for example, multiple RCPT commands in an SMTP
11638 session), &$local_part$& is not set.
11639
11640 Global address rewriting happens when a message is received, so the value of
11641 &$local_part$& during routing and delivery is the value after rewriting.
11642 &$local_part$& is set during user filtering, but not during system filtering,
11643 because a message may have many recipients and the system filter is called just
11644 once.
11645
11646 .vindex "&$local_part_prefix$&"
11647 .vindex "&$local_part_suffix$&"
11648 If a local part prefix or suffix has been recognized, it is not included in the
11649 value of &$local_part$& during routing and subsequent delivery. The values of
11650 any prefix or suffix are in &$local_part_prefix$& and
11651 &$local_part_suffix$&, respectively.
11652
11653 When a message is being delivered to a file, pipe, or autoreply transport as a
11654 result of aliasing or forwarding, &$local_part$& is set to the local part of
11655 the parent address, not to the file name or command (see &$address_file$& and
11656 &$address_pipe$&).
11657
11658 When an ACL is running for a RCPT command, &$local_part$& contains the
11659 local part of the recipient address.
11660
11661 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11662 &$local_part$& contains the local part of the address that is being rewritten;
11663 it can be used in the expansion of the replacement address, for example.
11664
11665 In all cases, all quoting is removed from the local part. For example, for both
11666 the addresses
11667 .code
11668 "abc:xyz"@test.example
11669 abc\:xyz@test.example
11670 .endd
11671 the value of &$local_part$& is
11672 .code
11673 abc:xyz
11674 .endd
11675 If you use &$local_part$& to create another address, you should always wrap it
11676 inside a quoting operator. For example, in a &(redirect)& router you could
11677 have:
11678 .code
11679 data = ${quote_local_part:$local_part}@new.domain.example
11680 .endd
11681 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11682 to process local parts in a case-dependent manner in a router, you can set the
11683 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11684
11685 .vitem &$local_part_data$&
11686 .vindex "&$local_part_data$&"
11687 When the &%local_parts%& option on a router matches a local part by means of a
11688 lookup, the data read by the lookup is available during the running of the
11689 router as &$local_part_data$&. In addition, if the driver routes the address
11690 to a transport, the value is available in that transport. If the transport is
11691 handling multiple addresses, the value from the first address is used.
11692
11693 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11694 matches a local part by means of a lookup. The data read by the lookup is
11695 available during the rest of the ACL statement. In all other situations, this
11696 variable expands to nothing.
11697
11698 .vitem &$local_part_prefix$&
11699 .vindex "&$local_part_prefix$&"
11700 When an address is being routed or delivered, and a
11701 specific prefix for the local part was recognized, it is available in this
11702 variable, having been removed from &$local_part$&.
11703
11704 .vitem &$local_part_suffix$&
11705 .vindex "&$local_part_suffix$&"
11706 When an address is being routed or delivered, and a
11707 specific suffix for the local part was recognized, it is available in this
11708 variable, having been removed from &$local_part$&.
11709
11710 .vitem &$local_scan_data$&
11711 .vindex "&$local_scan_data$&"
11712 This variable contains the text returned by the &[local_scan()]& function when
11713 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11714
11715 .vitem &$local_user_gid$&
11716 .vindex "&$local_user_gid$&"
11717 See &$local_user_uid$&.
11718
11719 .vitem &$local_user_uid$&
11720 .vindex "&$local_user_uid$&"
11721 This variable and &$local_user_gid$& are set to the uid and gid after the
11722 &%check_local_user%& router precondition succeeds. This means that their values
11723 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11724 and &%condition%&), for the &%address_data%& expansion, and for any
11725 router-specific expansions. At all other times, the values in these variables
11726 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11727
11728 .vitem &$localhost_number$&
11729 .vindex "&$localhost_number$&"
11730 This contains the expanded value of the
11731 &%localhost_number%& option. The expansion happens after the main options have
11732 been read.
11733
11734 .vitem &$log_inodes$&
11735 .vindex "&$log_inodes$&"
11736 The number of free inodes in the disk partition where Exim's
11737 log files are being written. The value is recalculated whenever the variable is
11738 referenced. If the relevant file system does not have the concept of inodes,
11739 the value of is -1. See also the &%check_log_inodes%& option.
11740
11741 .vitem &$log_space$&
11742 .vindex "&$log_space$&"
11743 The amount of free space (as a number of kilobytes) in the disk
11744 partition where Exim's log files are being written. The value is recalculated
11745 whenever the variable is referenced. If the operating system does not have the
11746 ability to find the amount of free space (only true for experimental systems),
11747 the space value is -1. See also the &%check_log_space%& option.
11748
11749
11750 .vitem &$lookup_dnssec_authenticated$&
11751 .vindex "&$lookup_dnssec_authenticated$&"
11752 This variable is set after a DNS lookup done by
11753 a dnsdb lookup expansion, dnslookup router or smtp transport.
11754 .cindex "DNS" "DNSSEC"
11755 It will be empty if &(DNSSEC)& was not requested,
11756 &"no"& if the result was not labelled as authenticated data
11757 and &"yes"& if it was.
11758 Results that are labelled as authoritative answer that match
11759 the &%dns_trust_aa%& configuration variable count also
11760 as authenticated data.
11761
11762 .vitem &$mailstore_basename$&
11763 .vindex "&$mailstore_basename$&"
11764 This variable is set only when doing deliveries in &"mailstore"& format in the
11765 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11766 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11767 contains the basename of the files that are being written, that is, the name
11768 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11769 variable is empty.
11770
11771 .vitem &$malware_name$&
11772 .vindex "&$malware_name$&"
11773 This variable is available when Exim is compiled with the
11774 content-scanning extension. It is set to the name of the virus that was found
11775 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11776
11777 .vitem &$max_received_linelength$&
11778 .vindex "&$max_received_linelength$&"
11779 .cindex "maximum" "line length"
11780 .cindex "line length" "maximum"
11781 This variable contains the number of bytes in the longest line that was
11782 received as part of the message, not counting the line termination
11783 character(s).
11784
11785 .vitem &$message_age$&
11786 .cindex "message" "age of"
11787 .vindex "&$message_age$&"
11788 This variable is set at the start of a delivery attempt to contain the number
11789 of seconds since the message was received. It does not change during a single
11790 delivery attempt.
11791
11792 .vitem &$message_body$&
11793 .cindex "body of message" "expansion variable"
11794 .cindex "message body" "in expansion"
11795 .cindex "binary zero" "in message body"
11796 .vindex "&$message_body$&"
11797 .oindex "&%message_body_visible%&"
11798 This variable contains the initial portion of a message's body while it is
11799 being delivered, and is intended mainly for use in filter files. The maximum
11800 number of characters of the body that are put into the variable is set by the
11801 &%message_body_visible%& configuration option; the default is 500.
11802
11803 .oindex "&%message_body_newlines%&"
11804 By default, newlines are converted into spaces in &$message_body$&, to make it
11805 easier to search for phrases that might be split over a line break. However,
11806 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11807 zeros are always converted into spaces.
11808
11809 .vitem &$message_body_end$&
11810 .cindex "body of message" "expansion variable"
11811 .cindex "message body" "in expansion"
11812 .vindex "&$message_body_end$&"
11813 This variable contains the final portion of a message's
11814 body while it is being delivered. The format and maximum size are as for
11815 &$message_body$&.
11816
11817 .vitem &$message_body_size$&
11818 .cindex "body of message" "size"
11819 .cindex "message body" "size"
11820 .vindex "&$message_body_size$&"
11821 When a message is being delivered, this variable contains the size of the body
11822 in bytes. The count starts from the character after the blank line that
11823 separates the body from the header. Newlines are included in the count. See
11824 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11825
11826 .vitem &$message_exim_id$&
11827 .vindex "&$message_exim_id$&"
11828 When a message is being received or delivered, this variable contains the
11829 unique message id that is generated and used by Exim to identify the message.
11830 An id is not created for a message until after its header has been successfully
11831 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11832 line; it is the local id that Exim assigns to the message, for example:
11833 &`1BXTIK-0001yO-VA`&.
11834
11835 .vitem &$message_headers$&
11836 .vindex &$message_headers$&
11837 This variable contains a concatenation of all the header lines when a message
11838 is being processed, except for lines added by routers or transports. The header
11839 lines are separated by newline characters. Their contents are decoded in the
11840 same way as a header line that is inserted by &%bheader%&.
11841
11842 .vitem &$message_headers_raw$&
11843 .vindex &$message_headers_raw$&
11844 This variable is like &$message_headers$& except that no processing of the
11845 contents of header lines is done.
11846
11847 .vitem &$message_id$&
11848 This is an old name for &$message_exim_id$&. It is now deprecated.
11849
11850 .vitem &$message_linecount$&
11851 .vindex "&$message_linecount$&"
11852 This variable contains the total number of lines in the header and body of the
11853 message. Compare &$body_linecount$&, which is the count for the body only.
11854 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11855 number of lines received. Before delivery happens (that is, before filters,
11856 routers, and transports run) the count is increased to include the
11857 &'Received:'& header line that Exim standardly adds, and also any other header
11858 lines that are added by ACLs. The blank line that separates the message header
11859 from the body is not counted.
11860
11861 As with the special case of &$message_size$&, during the expansion of the
11862 appendfile transport's maildir_tag option in maildir format, the value of
11863 &$message_linecount$& is the precise size of the number of newlines in the
11864 file that has been written (minus one for the blank line between the
11865 header and the body).
11866
11867 Here is an example of the use of this variable in a DATA ACL:
11868 .code
11869 deny message   = Too many lines in message header
11870      condition = \
11871       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11872 .endd
11873 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11874 message has not yet been received.
11875
11876 .vitem &$message_size$&
11877 .cindex "size" "of message"
11878 .cindex "message" "size"
11879 .vindex "&$message_size$&"
11880 When a message is being processed, this variable contains its size in bytes. In
11881 most cases, the size includes those headers that were received with the
11882 message, but not those (such as &'Envelope-to:'&) that are added to individual
11883 deliveries as they are written. However, there is one special case: during the
11884 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11885 doing a delivery in maildir format, the value of &$message_size$& is the
11886 precise size of the file that has been written. See also
11887 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11888
11889 .cindex "RCPT" "value of &$message_size$&"
11890 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11891 contains the size supplied on the MAIL command, or -1 if no size was given. The
11892 value may not, of course, be truthful.
11893
11894 .vitem &$mime_$&&'xxx'&
11895 A number of variables whose names start with &$mime$& are
11896 available when Exim is compiled with the content-scanning extension. For
11897 details, see section &<<SECTscanmimepart>>&.
11898
11899 .vitem "&$n0$& &-- &$n9$&"
11900 These variables are counters that can be incremented by means
11901 of the &%add%& command in filter files.
11902
11903 .vitem &$original_domain$&
11904 .vindex "&$domain$&"
11905 .vindex "&$original_domain$&"
11906 When a top-level address is being processed for delivery, this contains the
11907 same value as &$domain$&. However, if a &"child"& address (for example,
11908 generated by an alias, forward, or filter file) is being processed, this
11909 variable contains the domain of the original address (lower cased). This
11910 differs from &$parent_domain$& only when there is more than one level of
11911 aliasing or forwarding. When more than one address is being delivered in a
11912 single transport run, &$original_domain$& is not set.
11913
11914 If a new address is created by means of a &%deliver%& command in a system
11915 filter, it is set up with an artificial &"parent"& address. This has the local
11916 part &'system-filter'& and the default qualify domain.
11917
11918 .vitem &$original_local_part$&
11919 .vindex "&$local_part$&"
11920 .vindex "&$original_local_part$&"
11921 When a top-level address is being processed for delivery, this contains the
11922 same value as &$local_part$&, unless a prefix or suffix was removed from the
11923 local part, because &$original_local_part$& always contains the full local
11924 part. When a &"child"& address (for example, generated by an alias, forward, or
11925 filter file) is being processed, this variable contains the full local part of
11926 the original address.
11927
11928 If the router that did the redirection processed the local part
11929 case-insensitively, the value in &$original_local_part$& is in lower case.
11930 This variable differs from &$parent_local_part$& only when there is more than
11931 one level of aliasing or forwarding. When more than one address is being
11932 delivered in a single transport run, &$original_local_part$& is not set.
11933
11934 If a new address is created by means of a &%deliver%& command in a system
11935 filter, it is set up with an artificial &"parent"& address. This has the local
11936 part &'system-filter'& and the default qualify domain.
11937
11938 .vitem &$originator_gid$&
11939 .cindex "gid (group id)" "of originating user"
11940 .cindex "sender" "gid"
11941 .vindex "&$caller_gid$&"
11942 .vindex "&$originator_gid$&"
11943 This variable contains the value of &$caller_gid$& that was set when the
11944 message was received. For messages received via the command line, this is the
11945 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11946 normally the gid of the Exim user.
11947
11948 .vitem &$originator_uid$&
11949 .cindex "uid (user id)" "of originating user"
11950 .cindex "sender" "uid"
11951 .vindex "&$caller_uid$&"
11952 .vindex "&$originaltor_uid$&"
11953 The value of &$caller_uid$& that was set when the message was received. For
11954 messages received via the command line, this is the uid of the sending user.
11955 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11956 user.
11957
11958 .vitem &$parent_domain$&
11959 .vindex "&$parent_domain$&"
11960 This variable is similar to &$original_domain$& (see
11961 above), except that it refers to the immediately preceding parent address.
11962
11963 .vitem &$parent_local_part$&
11964 .vindex "&$parent_local_part$&"
11965 This variable is similar to &$original_local_part$&
11966 (see above), except that it refers to the immediately preceding parent address.
11967
11968 .vitem &$pid$&
11969 .cindex "pid (process id)" "of current process"
11970 .vindex "&$pid$&"
11971 This variable contains the current process id.
11972
11973 .vitem &$pipe_addresses$&
11974 .cindex "filter" "transport filter"
11975 .cindex "transport" "filter"
11976 .vindex "&$pipe_addresses$&"
11977 This is not an expansion variable, but is mentioned here because the string
11978 &`$pipe_addresses`& is handled specially in the command specification for the
11979 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11980 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11981 It cannot be used in general expansion strings, and provokes an &"unknown
11982 variable"& error if encountered.
11983
11984 .vitem &$primary_hostname$&
11985 .vindex "&$primary_hostname$&"
11986 This variable contains the value set by &%primary_hostname%& in the
11987 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11988 a single-component name, Exim calls &[gethostbyname()]& (or
11989 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11990 qualified host name. See also &$smtp_active_hostname$&.
11991
11992
11993 .vitem &$prvscheck_address$&
11994 This variable is used in conjunction with the &%prvscheck%& expansion item,
11995 which is described in sections &<<SECTexpansionitems>>& and
11996 &<<SECTverifyPRVS>>&.
11997
11998 .vitem &$prvscheck_keynum$&
11999 This variable is used in conjunction with the &%prvscheck%& expansion item,
12000 which is described in sections &<<SECTexpansionitems>>& and
12001 &<<SECTverifyPRVS>>&.
12002
12003 .vitem &$prvscheck_result$&
12004 This variable is used in conjunction with the &%prvscheck%& expansion item,
12005 which is described in sections &<<SECTexpansionitems>>& and
12006 &<<SECTverifyPRVS>>&.
12007
12008 .vitem &$qualify_domain$&
12009 .vindex "&$qualify_domain$&"
12010 The value set for the &%qualify_domain%& option in the configuration file.
12011
12012 .vitem &$qualify_recipient$&
12013 .vindex "&$qualify_recipient$&"
12014 The value set for the &%qualify_recipient%& option in the configuration file,
12015 or if not set, the value of &$qualify_domain$&.
12016
12017 .vitem &$rcpt_count$&
12018 .vindex "&$rcpt_count$&"
12019 When a message is being received by SMTP, this variable contains the number of
12020 RCPT commands received for the current message. If this variable is used in a
12021 RCPT ACL, its value includes the current command.
12022
12023 .vitem &$rcpt_defer_count$&
12024 .vindex "&$rcpt_defer_count$&"
12025 .cindex "4&'xx'& responses" "count of"
12026 When a message is being received by SMTP, this variable contains the number of
12027 RCPT commands in the current message that have previously been rejected with a
12028 temporary (4&'xx'&) response.
12029
12030 .vitem &$rcpt_fail_count$&
12031 .vindex "&$rcpt_fail_count$&"
12032 When a message is being received by SMTP, this variable contains the number of
12033 RCPT commands in the current message that have previously been rejected with a
12034 permanent (5&'xx'&) response.
12035
12036 .vitem &$received_count$&
12037 .vindex "&$received_count$&"
12038 This variable contains the number of &'Received:'& header lines in the message,
12039 including the one added by Exim (so its value is always greater than zero). It
12040 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12041 delivering.
12042
12043 .vitem &$received_for$&
12044 .vindex "&$received_for$&"
12045 If there is only a single recipient address in an incoming message, this
12046 variable contains that address when the &'Received:'& header line is being
12047 built. The value is copied after recipient rewriting has happened, but before
12048 the &[local_scan()]& function is run.
12049
12050 .vitem &$received_ip_address$&
12051 .vindex "&$received_ip_address$&"
12052 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12053 variable is set to the address of the local IP interface, and &$received_port$&
12054 is set to the local port number. (The remote IP address and port are in
12055 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12056 the port value is -1 unless it has been set using the &%-oMi%& command line
12057 option.
12058
12059 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12060 could be used, for example, to make the file name for a TLS certificate depend
12061 on which interface and/or port is being used for the incoming connection. The
12062 values of &$received_ip_address$& and &$received_port$& are saved with any
12063 messages that are received, thus making these variables available at delivery
12064 time.
12065 For outbound connections see &$sending_ip_address$&.
12066
12067 .vitem &$received_port$&
12068 .vindex "&$received_port$&"
12069 See &$received_ip_address$&.
12070
12071 .vitem &$received_protocol$&
12072 .vindex "&$received_protocol$&"
12073 When a message is being processed, this variable contains the name of the
12074 protocol by which it was received. Most of the names used by Exim are defined
12075 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12076 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12077 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12078 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12079 connection and the client was successfully authenticated.
12080
12081 Exim uses the protocol name &"smtps"& for the case when encryption is
12082 automatically set up on connection without the use of STARTTLS (see
12083 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12084 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12085 where the client initially uses EHLO, sets up an encrypted connection using
12086 STARTTLS, and then uses HELO afterwards.
12087
12088 The &%-oMr%& option provides a way of specifying a custom protocol name for
12089 messages that are injected locally by trusted callers. This is commonly used to
12090 identify messages that are being re-injected after some kind of scanning.
12091
12092 .vitem &$received_time$&
12093 .vindex "&$received_time$&"
12094 This variable contains the date and time when the current message was received,
12095 as a number of seconds since the start of the Unix epoch.
12096
12097 .vitem &$recipient_data$&
12098 .vindex "&$recipient_data$&"
12099 This variable is set after an indexing lookup success in an ACL &%recipients%&
12100 condition. It contains the data from the lookup, and the value remains set
12101 until the next &%recipients%& test. Thus, you can do things like this:
12102 .display
12103 &`require recipients  = cdb*@;/some/file`&
12104 &`deny    `&&'some further test involving'& &`$recipient_data`&
12105 .endd
12106 &*Warning*&: This variable is set only when a lookup is used as an indexing
12107 method in the address list, using the semicolon syntax as in the example above.
12108 The variable is not set for a lookup that is used as part of the string
12109 expansion that all such lists undergo before being interpreted.
12110
12111 .vitem &$recipient_verify_failure$&
12112 .vindex "&$recipient_verify_failure$&"
12113 In an ACL, when a recipient verification fails, this variable contains
12114 information about the failure. It is set to one of the following words:
12115
12116 .ilist
12117 &"qualify"&: The address was unqualified (no domain), and the message
12118 was neither local nor came from an exempted host.
12119
12120 .next
12121 &"route"&: Routing failed.
12122
12123 .next
12124 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12125 or before the MAIL command (that is, on initial connection, HELO, or
12126 MAIL).
12127
12128 .next
12129 &"recipient"&: The RCPT command in a callout was rejected.
12130 .next
12131
12132 &"postmaster"&: The postmaster check in a callout was rejected.
12133 .endlist
12134
12135 The main use of this variable is expected to be to distinguish between
12136 rejections of MAIL and rejections of RCPT.
12137
12138 .vitem &$recipients$&
12139 .vindex "&$recipients$&"
12140 This variable contains a list of envelope recipients for a message. A comma and
12141 a space separate the addresses in the replacement text. However, the variable
12142 is not generally available, to prevent exposure of Bcc recipients in
12143 unprivileged users' filter files. You can use &$recipients$& only in these
12144 cases:
12145
12146 .olist
12147 In a system filter file.
12148 .next
12149 In the ACLs associated with the DATA command and with non-SMTP messages, that
12150 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12151 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12152 &%acl_not_smtp_mime%&.
12153 .next
12154 From within a &[local_scan()]& function.
12155 .endlist
12156
12157
12158 .vitem &$recipients_count$&
12159 .vindex "&$recipients_count$&"
12160 When a message is being processed, this variable contains the number of
12161 envelope recipients that came with the message. Duplicates are not excluded
12162 from the count. While a message is being received over SMTP, the number
12163 increases for each accepted recipient. It can be referenced in an ACL.
12164
12165
12166 .vitem &$regex_match_string$&
12167 .vindex "&$regex_match_string$&"
12168 This variable is set to contain the matching regular expression after a
12169 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12170
12171 .vitem "&$regex1$&, &$regex2$&, etc"
12172 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12173 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12174 these variables contain the
12175 captured substrings identified by the regular expression.
12176
12177
12178 .vitem &$reply_address$&
12179 .vindex "&$reply_address$&"
12180 When a message is being processed, this variable contains the contents of the
12181 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12182 contents of the &'From:'& header line. Apart from the removal of leading
12183 white space, the value is not processed in any way. In particular, no RFC 2047
12184 decoding or character code translation takes place.
12185
12186 .vitem &$return_path$&
12187 .vindex "&$return_path$&"
12188 When a message is being delivered, this variable contains the return path &--
12189 the sender field that will be sent as part of the envelope. It is not enclosed
12190 in <> characters. At the start of routing an address, &$return_path$& has the
12191 same value as &$sender_address$&, but if, for example, an incoming message to a
12192 mailing list has been expanded by a router which specifies a different address
12193 for bounce messages, &$return_path$& subsequently contains the new bounce
12194 address, whereas &$sender_address$& always contains the original sender address
12195 that was received with the message. In other words, &$sender_address$& contains
12196 the incoming envelope sender, and &$return_path$& contains the outgoing
12197 envelope sender.
12198
12199 .vitem &$return_size_limit$&
12200 .vindex "&$return_size_limit$&"
12201 This is an obsolete name for &$bounce_return_size_limit$&.
12202
12203 .vitem &$router_name$&
12204 .cindex "router" "name"
12205 .cindex "name" "of router"
12206 .vindex "&$router_name$&"
12207 During the running of a router this variable contains its name.
12208
12209 .vitem &$runrc$&
12210 .cindex "return code" "from &%run%& expansion"
12211 .vindex "&$runrc$&"
12212 This variable contains the return code from a command that is run by the
12213 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12214 assume the order in which option values are expanded, except for those
12215 preconditions whose order of testing is documented. Therefore, you cannot
12216 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12217 another.
12218
12219 .vitem &$self_hostname$&
12220 .oindex "&%self%&" "value of host name"
12221 .vindex "&$self_hostname$&"
12222 When an address is routed to a supposedly remote host that turns out to be the
12223 local host, what happens is controlled by the &%self%& generic router option.
12224 One of its values causes the address to be passed to another router. When this
12225 happens, &$self_hostname$& is set to the name of the local host that the
12226 original router encountered. In other circumstances its contents are null.
12227
12228 .vitem &$sender_address$&
12229 .vindex "&$sender_address$&"
12230 When a message is being processed, this variable contains the sender's address
12231 that was received in the message's envelope. The case of letters in the address
12232 is retained, in both the local part and the domain. For bounce messages, the
12233 value of this variable is the empty string. See also &$return_path$&.
12234
12235 .vitem &$sender_address_data$&
12236 .vindex "&$address_data$&"
12237 .vindex "&$sender_address_data$&"
12238 If &$address_data$& is set when the routers are called from an ACL to verify a
12239 sender address, the final value is preserved in &$sender_address_data$&, to
12240 distinguish it from data from a recipient address. The value does not persist
12241 after the end of the current ACL statement. If you want to preserve it for
12242 longer, you can save it in an ACL variable.
12243
12244 .vitem &$sender_address_domain$&
12245 .vindex "&$sender_address_domain$&"
12246 The domain portion of &$sender_address$&.
12247
12248 .vitem &$sender_address_local_part$&
12249 .vindex "&$sender_address_local_part$&"
12250 The local part portion of &$sender_address$&.
12251
12252 .vitem &$sender_data$&
12253 .vindex "&$sender_data$&"
12254 This variable is set after a lookup success in an ACL &%senders%& condition or
12255 in a router &%senders%& option. It contains the data from the lookup, and the
12256 value remains set until the next &%senders%& test. Thus, you can do things like
12257 this:
12258 .display
12259 &`require senders      = cdb*@;/some/file`&
12260 &`deny    `&&'some further test involving'& &`$sender_data`&
12261 .endd
12262 &*Warning*&: This variable is set only when a lookup is used as an indexing
12263 method in the address list, using the semicolon syntax as in the example above.
12264 The variable is not set for a lookup that is used as part of the string
12265 expansion that all such lists undergo before being interpreted.
12266
12267 .vitem &$sender_fullhost$&
12268 .vindex "&$sender_fullhost$&"
12269 When a message is received from a remote host, this variable contains the host
12270 name and IP address in a single string. It ends with the IP address in square
12271 brackets, followed by a colon and a port number if the logging of ports is
12272 enabled. The format of the rest of the string depends on whether the host
12273 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12274 looking up its IP address. (Looking up the IP address can be forced by the
12275 &%host_lookup%& option, independent of verification.) A plain host name at the
12276 start of the string is a verified host name; if this is not present,
12277 verification either failed or was not requested. A host name in parentheses is
12278 the argument of a HELO or EHLO command. This is omitted if it is identical to
12279 the verified host name or to the host's IP address in square brackets.
12280
12281 .vitem &$sender_helo_dnssec$&
12282 .vindex "&$sender_helo_dnssec$&"
12283 This boolean variable is true if a successful HELO verification was
12284 .cindex "DNS" "DNSSEC"
12285 done using DNS information the resolver library stated was authenticated data.
12286
12287 .vitem &$sender_helo_name$&
12288 .vindex "&$sender_helo_name$&"
12289 When a message is received from a remote host that has issued a HELO or EHLO
12290 command, the argument of that command is placed in this variable. It is also
12291 set if HELO or EHLO is used when a message is received using SMTP locally via
12292 the &%-bs%& or &%-bS%& options.
12293
12294 .vitem &$sender_host_address$&
12295 .vindex "&$sender_host_address$&"
12296 When a message is received from a remote host using SMTP,
12297 this variable contains that
12298 host's IP address. For locally non-SMTP submitted messages, it is empty.
12299
12300 .vitem &$sender_host_authenticated$&
12301 .vindex "&$sender_host_authenticated$&"
12302 This variable contains the name (not the public name) of the authenticator
12303 driver that successfully authenticated the client from which the message was
12304 received. It is empty if there was no successful authentication. See also
12305 &$authenticated_id$&.
12306
12307 .vitem &$sender_host_dnssec$&
12308 .vindex "&$sender_host_dnssec$&"
12309 If an attempt to populate &$sender_host_name$& has been made
12310 (by reference, &%hosts_lookup%& or
12311 otherwise) then this boolean will have been set true if, and only if, the
12312 resolver library states that both
12313 the reverse and forward DNS were authenticated data.  At all
12314 other times, this variable is false.
12315
12316 .cindex "DNS" "DNSSEC"
12317 It is likely that you will need to coerce DNSSEC support on in the resolver
12318 library, by setting:
12319 .code
12320 dns_dnssec_ok = 1
12321 .endd
12322
12323 Exim does not perform DNSSEC validation itself, instead leaving that to a
12324 validating resolver (e.g. unbound, or bind with suitable configuration).
12325
12326 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12327 mechanism in the list, then this variable will be false.
12328
12329
12330 .vitem &$sender_host_name$&
12331 .vindex "&$sender_host_name$&"
12332 When a message is received from a remote host, this variable contains the
12333 host's name as obtained by looking up its IP address. For messages received by
12334 other means, this variable is empty.
12335
12336 .vindex "&$host_lookup_failed$&"
12337 If the host name has not previously been looked up, a reference to
12338 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12339 A looked up name is accepted only if it leads back to the original IP address
12340 via a forward lookup. If either the reverse or the forward lookup fails to find
12341 any data, or if the forward lookup does not yield the original IP address,
12342 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12343
12344 .vindex "&$host_lookup_deferred$&"
12345 However, if either of the lookups cannot be completed (for example, there is a
12346 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12347 &$host_lookup_failed$& remains set to &"0"&.
12348
12349 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12350 host name again if there is a subsequent reference to &$sender_host_name$&
12351 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12352 is set to &"1"&.
12353
12354 Exim does not automatically look up every calling host's name. If you want
12355 maximum efficiency, you should arrange your configuration so that it avoids
12356 these lookups altogether. The lookup happens only if one or more of the
12357 following are true:
12358
12359 .ilist
12360 A string containing &$sender_host_name$& is expanded.
12361 .next
12362 The calling host matches the list in &%host_lookup%&. In the default
12363 configuration, this option is set to *, so it must be changed if lookups are
12364 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12365 .next
12366 Exim needs the host name in order to test an item in a host list. The items
12367 that require this are described in sections &<<SECThoslispatnam>>& and
12368 &<<SECThoslispatnamsk>>&.
12369 .next
12370 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12371 In this case, the host name is required to compare with the name quoted in any
12372 EHLO or HELO commands that the client issues.
12373 .next
12374 The remote host issues a EHLO or HELO command that quotes one of the
12375 domains in &%helo_lookup_domains%&. The default value of this option is
12376 . ==== As this is a nested list, any displays it contains must be indented
12377 . ==== as otherwise they are too far to the left.
12378 .code
12379   helo_lookup_domains = @ : @[]
12380 .endd
12381 which causes a lookup if a remote host (incorrectly) gives the server's name or
12382 IP address in an EHLO or HELO command.
12383 .endlist
12384
12385
12386 .vitem &$sender_host_port$&
12387 .vindex "&$sender_host_port$&"
12388 When a message is received from a remote host, this variable contains the port
12389 number that was used on the remote host.
12390
12391 .vitem &$sender_ident$&
12392 .vindex "&$sender_ident$&"
12393 When a message is received from a remote host, this variable contains the
12394 identification received in response to an RFC 1413 request. When a message has
12395 been received locally, this variable contains the login name of the user that
12396 called Exim.
12397
12398 .vitem &$sender_rate_$&&'xxx'&
12399 A number of variables whose names begin &$sender_rate_$& are set as part of the
12400 &%ratelimit%& ACL condition. Details are given in section
12401 &<<SECTratelimiting>>&.
12402
12403 .vitem &$sender_rcvhost$&
12404 .cindex "DNS" "reverse lookup"
12405 .cindex "reverse DNS lookup"
12406 .vindex "&$sender_rcvhost$&"
12407 This is provided specifically for use in &'Received:'& headers. It starts with
12408 either the verified host name (as obtained from a reverse DNS lookup) or, if
12409 there is no verified host name, the IP address in square brackets. After that
12410 there may be text in parentheses. When the first item is a verified host name,
12411 the first thing in the parentheses is the IP address in square brackets,
12412 followed by a colon and a port number if port logging is enabled. When the
12413 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12414 the parentheses.
12415
12416 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12417 was used and its argument was not identical to the real host name or IP
12418 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12419 all three items are present in the parentheses, a newline and tab are inserted
12420 into the string, to improve the formatting of the &'Received:'& header.
12421
12422 .vitem &$sender_verify_failure$&
12423 .vindex "&$sender_verify_failure$&"
12424 In an ACL, when a sender verification fails, this variable contains information
12425 about the failure. The details are the same as for
12426 &$recipient_verify_failure$&.
12427
12428 .vitem &$sending_ip_address$&
12429 .vindex "&$sending_ip_address$&"
12430 This variable is set whenever an outgoing SMTP connection to another host has
12431 been set up. It contains the IP address of the local interface that is being
12432 used. This is useful if a host that has more than one IP address wants to take
12433 on different personalities depending on which one is being used. For incoming
12434 connections, see &$received_ip_address$&.
12435
12436 .vitem &$sending_port$&
12437 .vindex "&$sending_port$&"
12438 This variable is set whenever an outgoing SMTP connection to another host has
12439 been set up. It contains the local port that is being used. For incoming
12440 connections, see &$received_port$&.
12441
12442 .vitem &$smtp_active_hostname$&
12443 .vindex "&$smtp_active_hostname$&"
12444 During an incoming SMTP session, this variable contains the value of the active
12445 host name, as specified by the &%smtp_active_hostname%& option. The value of
12446 &$smtp_active_hostname$& is saved with any message that is received, so its
12447 value can be consulted during routing and delivery.
12448
12449 .vitem &$smtp_command$&
12450 .vindex "&$smtp_command$&"
12451 During the processing of an incoming SMTP command, this variable contains the
12452 entire command. This makes it possible to distinguish between HELO and EHLO in
12453 the HELO ACL, and also to distinguish between commands such as these:
12454 .code
12455 MAIL FROM:<>
12456 MAIL FROM: <>
12457 .endd
12458 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12459 command, the address in &$smtp_command$& is the original address before any
12460 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12461 the address after SMTP-time rewriting.
12462
12463 .vitem &$smtp_command_argument$&
12464 .cindex "SMTP" "command, argument for"
12465 .vindex "&$smtp_command_argument$&"
12466 While an ACL is running to check an SMTP command, this variable contains the
12467 argument, that is, the text that follows the command name, with leading white
12468 space removed. Following the introduction of &$smtp_command$&, this variable is
12469 somewhat redundant, but is retained for backwards compatibility.
12470
12471 .vitem &$smtp_count_at_connection_start$&
12472 .vindex "&$smtp_count_at_connection_start$&"
12473 This variable is set greater than zero only in processes spawned by the Exim
12474 daemon for handling incoming SMTP connections. The name is deliberately long,
12475 in order to emphasize what the contents are. When the daemon accepts a new
12476 connection, it increments this variable. A copy of the variable is passed to
12477 the child process that handles the connection, but its value is fixed, and
12478 never changes. It is only an approximation of how many incoming connections
12479 there actually are, because many other connections may come and go while a
12480 single connection is being processed. When a child process terminates, the
12481 daemon decrements its copy of the variable.
12482
12483 .vitem "&$sn0$& &-- &$sn9$&"
12484 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12485 that were current at the end of the system filter file. This allows a system
12486 filter file to set values that can be tested in users' filter files. For
12487 example, a system filter could set a value indicating how likely it is that a
12488 message is junk mail.
12489
12490 .vitem &$spam_$&&'xxx'&
12491 A number of variables whose names start with &$spam$& are available when Exim
12492 is compiled with the content-scanning extension. For details, see section
12493 &<<SECTscanspamass>>&.
12494
12495
12496 .vitem &$spool_directory$&
12497 .vindex "&$spool_directory$&"
12498 The name of Exim's spool directory.
12499
12500 .vitem &$spool_inodes$&
12501 .vindex "&$spool_inodes$&"
12502 The number of free inodes in the disk partition where Exim's spool files are
12503 being written. The value is recalculated whenever the variable is referenced.
12504 If the relevant file system does not have the concept of inodes, the value of
12505 is -1. See also the &%check_spool_inodes%& option.
12506
12507 .vitem &$spool_space$&
12508 .vindex "&$spool_space$&"
12509 The amount of free space (as a number of kilobytes) in the disk partition where
12510 Exim's spool files are being written. The value is recalculated whenever the
12511 variable is referenced. If the operating system does not have the ability to
12512 find the amount of free space (only true for experimental systems), the space
12513 value is -1. For example, to check in an ACL that there is at least 50
12514 megabytes free on the spool, you could write:
12515 .code
12516 condition = ${if > {$spool_space}{50000}}
12517 .endd
12518 See also the &%check_spool_space%& option.
12519
12520
12521 .vitem &$thisaddress$&
12522 .vindex "&$thisaddress$&"
12523 This variable is set only during the processing of the &%foranyaddress%&
12524 command in a filter file. Its use is explained in the description of that
12525 command, which can be found in the separate document entitled &'Exim's
12526 interfaces to mail filtering'&.
12527
12528 .vitem &$tls_in_bits$&
12529 .vindex "&$tls_in_bits$&"
12530 Contains an approximation of the TLS cipher's bit-strength
12531 on the inbound connection; the meaning of
12532 this depends upon the TLS implementation used.
12533 If TLS has not been negotiated, the value will be 0.
12534 The value of this is automatically fed into the Cyrus SASL authenticator
12535 when acting as a server, to specify the "external SSF" (a SASL term).
12536
12537 The deprecated &$tls_bits$& variable refers to the inbound side
12538 except when used in the context of an outbound SMTP delivery, when it refers to
12539 the outbound.
12540
12541 .vitem &$tls_out_bits$&
12542 .vindex "&$tls_out_bits$&"
12543 Contains an approximation of the TLS cipher's bit-strength
12544 on an outbound SMTP connection; the meaning of
12545 this depends upon the TLS implementation used.
12546 If TLS has not been negotiated, the value will be 0.
12547
12548 .vitem &$tls_in_ourcert$&
12549 .vindex "&$tls_in_ourcert$&"
12550 This variable refers to the certificate presented to the peer of an
12551 inbound connection when the message was received.
12552 It is only useful as the argument of a
12553 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12554 or a &%def%& condition.
12555
12556 .vitem &$tls_in_peercert$&
12557 .vindex "&$tls_in_peercert$&"
12558 This variable refers to the certificate presented by the peer of an
12559 inbound connection when the message was received.
12560 It is only useful as the argument of a
12561 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12562 or a &%def%& condition.
12563 If certificate verification fails it may refer to a failing chain element
12564 which is not the leaf.
12565
12566 .vitem &$tls_out_ourcert$&
12567 .vindex "&$tls_out_ourcert$&"
12568 This variable refers to the certificate presented to the peer of an
12569 outbound connection.  It is only useful as the argument of a
12570 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12571 or a &%def%& condition.
12572
12573 .vitem &$tls_out_peercert$&
12574 .vindex "&$tls_out_peercert$&"
12575 This variable refers to the certificate presented by the peer of an
12576 outbound connection.  It is only useful as the argument of a
12577 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12578 or a &%def%& condition.
12579 If certificate verification fails it may refer to a failing chain element
12580 which is not the leaf.
12581
12582 .vitem &$tls_in_certificate_verified$&
12583 .vindex "&$tls_in_certificate_verified$&"
12584 This variable is set to &"1"& if a TLS certificate was verified when the
12585 message was received, and &"0"& otherwise.
12586
12587 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12588 except when used in the context of an outbound SMTP delivery, when it refers to
12589 the outbound.
12590
12591 .vitem &$tls_out_certificate_verified$&
12592 .vindex "&$tls_out_certificate_verified$&"
12593 This variable is set to &"1"& if a TLS certificate was verified when an
12594 outbound SMTP connection was made,
12595 and &"0"& otherwise.
12596
12597 .vitem &$tls_in_cipher$&
12598 .vindex "&$tls_in_cipher$&"
12599 .vindex "&$tls_cipher$&"
12600 When a message is received from a remote host over an encrypted SMTP
12601 connection, this variable is set to the cipher suite that was negotiated, for
12602 example DES-CBC3-SHA. In other circumstances, in particular, for message
12603 received over unencrypted connections, the variable is empty. Testing
12604 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12605 non-encrypted connections during ACL processing.
12606
12607 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12608 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12609 becomes the same as &$tls_out_cipher$&.
12610
12611 .vitem &$tls_out_cipher$&
12612 .vindex "&$tls_out_cipher$&"
12613 This variable is
12614 cleared before any outgoing SMTP connection is made,
12615 and then set to the outgoing cipher suite if one is negotiated. See chapter
12616 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12617 details of the &(smtp)& transport.
12618
12619 .vitem &$tls_in_ocsp$&
12620 .vindex "&$tls_in_ocsp$&"
12621 When a message is received from a remote client connection
12622 the result of any OCSP request from the client is encoded in this variable:
12623 .code
12624 0 OCSP proof was not requested (default value)
12625 1 No response to request
12626 2 Response not verified
12627 3 Verification failed
12628 4 Verification succeeded
12629 .endd
12630
12631 .vitem &$tls_out_ocsp$&
12632 .vindex "&$tls_out_ocsp$&"
12633 When a message is sent to a remote host connection
12634 the result of any OCSP request made is encoded in this variable.
12635 See &$tls_in_ocsp$& for values.
12636
12637 .vitem &$tls_in_peerdn$&
12638 .vindex "&$tls_in_peerdn$&"
12639 .vindex "&$tls_peerdn$&"
12640 When a message is received from a remote host over an encrypted SMTP
12641 connection, and Exim is configured to request a certificate from the client,
12642 the value of the Distinguished Name of the certificate is made available in the
12643 &$tls_in_peerdn$& during subsequent processing.
12644 If certificate verification fails it may refer to a failing chain element
12645 which is not the leaf.
12646
12647 The deprecated &$tls_peerdn$& variable refers to the inbound side
12648 except when used in the context of an outbound SMTP delivery, when it refers to
12649 the outbound.
12650
12651 .vitem &$tls_out_peerdn$&
12652 .vindex "&$tls_out_peerdn$&"
12653 When a message is being delivered to a remote host over an encrypted SMTP
12654 connection, and Exim is configured to request a certificate from the server,
12655 the value of the Distinguished Name of the certificate is made available in the
12656 &$tls_out_peerdn$& during subsequent processing.
12657 If certificate verification fails it may refer to a failing chain element
12658 which is not the leaf.
12659
12660 .vitem &$tls_in_sni$&
12661 .vindex "&$tls_in_sni$&"
12662 .vindex "&$tls_sni$&"
12663 .cindex "TLS" "Server Name Indication"
12664 When a TLS session is being established, if the client sends the Server
12665 Name Indication extension, the value will be placed in this variable.
12666 If the variable appears in &%tls_certificate%& then this option and
12667 some others, described in &<<SECTtlssni>>&,
12668 will be re-expanded early in the TLS session, to permit
12669 a different certificate to be presented (and optionally a different key to be
12670 used) to the client, based upon the value of the SNI extension.
12671
12672 The deprecated &$tls_sni$& variable refers to the inbound side
12673 except when used in the context of an outbound SMTP delivery, when it refers to
12674 the outbound.
12675
12676 .vitem &$tls_out_sni$&
12677 .vindex "&$tls_out_sni$&"
12678 .cindex "TLS" "Server Name Indication"
12679 During outbound
12680 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12681 the transport.
12682
12683 .vitem &$tod_bsdinbox$&
12684 .vindex "&$tod_bsdinbox$&"
12685 The time of day and the date, in the format required for BSD-style mailbox
12686 files, for example: Thu Oct 17 17:14:09 1995.
12687
12688 .vitem &$tod_epoch$&
12689 .vindex "&$tod_epoch$&"
12690 The time and date as a number of seconds since the start of the Unix epoch.
12691
12692 .vitem &$tod_epoch_l$&
12693 .vindex "&$tod_epoch_l$&"
12694 The time and date as a number of microseconds since the start of the Unix epoch.
12695
12696 .vitem &$tod_full$&
12697 .vindex "&$tod_full$&"
12698 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12699 +0100. The timezone is always given as a numerical offset from UTC, with
12700 positive values used for timezones that are ahead (east) of UTC, and negative
12701 values for those that are behind (west).
12702
12703 .vitem &$tod_log$&
12704 .vindex "&$tod_log$&"
12705 The time and date in the format used for writing Exim's log files, for example:
12706 1995-10-12 15:32:29, but without a timezone.
12707
12708 .vitem &$tod_logfile$&
12709 .vindex "&$tod_logfile$&"
12710 This variable contains the date in the format yyyymmdd. This is the format that
12711 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12712 flag.
12713
12714 .vitem &$tod_zone$&
12715 .vindex "&$tod_zone$&"
12716 This variable contains the numerical value of the local timezone, for example:
12717 -0500.
12718
12719 .vitem &$tod_zulu$&
12720 .vindex "&$tod_zulu$&"
12721 This variable contains the UTC date and time in &"Zulu"& format, as specified
12722 by ISO 8601, for example: 20030221154023Z.
12723
12724 .vitem &$transport_name$&
12725 .cindex "transport" "name"
12726 .cindex "name" "of transport"
12727 .vindex "&$transport_name$&"
12728 During the running of a transport, this variable contains its name.
12729
12730 .vitem &$value$&
12731 .vindex "&$value$&"
12732 This variable contains the result of an expansion lookup, extraction operation,
12733 or external command, as described above. It is also used during a
12734 &*reduce*& expansion.
12735
12736 .vitem &$verify_mode$&
12737 .vindex "&$verify_mode$&"
12738 While a router or transport is being run in verify mode
12739 or for cutthrough delivery,
12740 contains "S" for sender-verification or "R" for recipient-verification.
12741 Otherwise, empty.
12742
12743 .vitem &$version_number$&
12744 .vindex "&$version_number$&"
12745 The version number of Exim.
12746
12747 .vitem &$warn_message_delay$&
12748 .vindex "&$warn_message_delay$&"
12749 This variable is set only during the creation of a message warning about a
12750 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12751
12752 .vitem &$warn_message_recipients$&
12753 .vindex "&$warn_message_recipients$&"
12754 This variable is set only during the creation of a message warning about a
12755 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12756 .endlist
12757 .ecindex IIDstrexp
12758
12759
12760
12761 . ////////////////////////////////////////////////////////////////////////////
12762 . ////////////////////////////////////////////////////////////////////////////
12763
12764 .chapter "Embedded Perl" "CHAPperl"
12765 .scindex IIDperl "Perl" "calling from Exim"
12766 Exim can be built to include an embedded Perl interpreter. When this is done,
12767 Perl subroutines can be called as part of the string expansion process. To make
12768 use of the Perl support, you need version 5.004 or later of Perl installed on
12769 your system. To include the embedded interpreter in the Exim binary, include
12770 the line
12771 .code
12772 EXIM_PERL = perl.o
12773 .endd
12774 in your &_Local/Makefile_& and then build Exim in the normal way.
12775
12776
12777 .section "Setting up so Perl can be used" "SECID85"
12778 .oindex "&%perl_startup%&"
12779 Access to Perl subroutines is via a global configuration option called
12780 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12781 no &%perl_startup%& option in the Exim configuration file then no Perl
12782 interpreter is started and there is almost no overhead for Exim (since none of
12783 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12784 option then the associated value is taken to be Perl code which is executed in
12785 a newly created Perl interpreter.
12786
12787 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12788 need backslashes before any characters to escape special meanings. The option
12789 should usually be something like
12790 .code
12791 perl_startup = do '/etc/exim.pl'
12792 .endd
12793 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12794 use from Exim. Exim can be configured either to start up a Perl interpreter as
12795 soon as it is entered, or to wait until the first time it is needed. Starting
12796 the interpreter at the beginning ensures that it is done while Exim still has
12797 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12798 fact used in a particular run. Also, note that this does not mean that Exim is
12799 necessarily running as root when Perl is called at a later time. By default,
12800 the interpreter is started only when it is needed, but this can be changed in
12801 two ways:
12802
12803 .ilist
12804 .oindex "&%perl_at_start%&"
12805 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12806 a startup when Exim is entered.
12807 .next
12808 The command line option &%-ps%& also requests a startup when Exim is entered,
12809 overriding the setting of &%perl_at_start%&.
12810 .endlist
12811
12812 There is also a command line option &%-pd%& (for delay) which suppresses the
12813 initial startup, even if &%perl_at_start%& is set.
12814
12815
12816 .section "Calling Perl subroutines" "SECID86"
12817 When the configuration file includes a &%perl_startup%& option you can make use
12818 of the string expansion item to call the Perl subroutines that are defined
12819 by the &%perl_startup%& code. The operator is used in any of the following
12820 forms:
12821 .code
12822 ${perl{foo}}
12823 ${perl{foo}{argument}}
12824 ${perl{foo}{argument1}{argument2} ... }
12825 .endd
12826 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12827 arguments may be passed. Passing more than this results in an expansion failure
12828 with an error message of the form
12829 .code
12830 Too many arguments passed to Perl subroutine "foo" (max is 8)
12831 .endd
12832 The return value of the Perl subroutine is evaluated in a scalar context before
12833 it is passed back to Exim to be inserted into the expanded string. If the
12834 return value is &'undef'&, the expansion is forced to fail in the same way as
12835 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12836 by obeying Perl's &%die%& function, the expansion fails with the error message
12837 that was passed to &%die%&.
12838
12839
12840 .section "Calling Exim functions from Perl" "SECID87"
12841 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12842 is available to call back into Exim's string expansion function. For example,
12843 the Perl code
12844 .code
12845 my $lp = Exim::expand_string('$local_part');
12846 .endd
12847 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12848 Note those are single quotes and not double quotes to protect against
12849 &$local_part$& being interpolated as a Perl variable.
12850
12851 If the string expansion is forced to fail by a &"fail"& item, the result of
12852 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12853 expansion string, the Perl call from the original expansion string fails with
12854 an appropriate error message, in the same way as if &%die%& were used.
12855
12856 .cindex "debugging" "from embedded Perl"
12857 .cindex "log" "writing from embedded Perl"
12858 Two other Exim functions are available for use from within Perl code.
12859 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12860 debugging is enabled. If you want a newline at the end, you must supply it.
12861 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12862 timestamp. In this case, you should not supply a terminating newline.
12863
12864
12865 .section "Use of standard output and error by Perl" "SECID88"
12866 .cindex "Perl" "standard output and error"
12867 You should not write to the standard error or output streams from within your
12868 Perl code, as it is not defined how these are set up. In versions of Exim
12869 before 4.50, it is possible for the standard output or error to refer to the
12870 SMTP connection during message reception via the daemon. Writing to this stream
12871 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12872 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12873 avoided, but the output is lost.
12874
12875 .cindex "Perl" "use of &%warn%&"
12876 The Perl &%warn%& statement writes to the standard error stream by default.
12877 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12878 you have no control. When Exim starts up the Perl interpreter, it arranges for
12879 output from the &%warn%& statement to be written to the Exim main log. You can
12880 change this by including appropriate Perl magic somewhere in your Perl code.
12881 For example, to discard &%warn%& output completely, you need this:
12882 .code
12883 $SIG{__WARN__} = sub { };
12884 .endd
12885 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12886 example, the code for the subroutine is empty, so it does nothing, but you can
12887 include any Perl code that you like. The text of the &%warn%& message is passed
12888 as the first subroutine argument.
12889 .ecindex IIDperl
12890
12891
12892 . ////////////////////////////////////////////////////////////////////////////
12893 . ////////////////////////////////////////////////////////////////////////////
12894
12895 .chapter "Starting the daemon and the use of network interfaces" &&&
12896          "CHAPinterfaces" &&&
12897          "Starting the daemon"
12898 .cindex "daemon" "starting"
12899 .cindex "interface" "listening"
12900 .cindex "network interface"
12901 .cindex "interface" "network"
12902 .cindex "IP address" "for listening"
12903 .cindex "daemon" "listening IP addresses"
12904 .cindex "TCP/IP" "setting listening interfaces"
12905 .cindex "TCP/IP" "setting listening ports"
12906 A host that is connected to a TCP/IP network may have one or more physical
12907 hardware network interfaces. Each of these interfaces may be configured as one
12908 or more &"logical"& interfaces, which are the entities that a program actually
12909 works with. Each of these logical interfaces is associated with an IP address.
12910 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12911 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12912 knowledge about the host's interfaces for use in three different circumstances:
12913
12914 .olist
12915 When a listening daemon is started, Exim needs to know which interfaces
12916 and ports to listen on.
12917 .next
12918 When Exim is routing an address, it needs to know which IP addresses
12919 are associated with local interfaces. This is required for the correct
12920 processing of MX lists by removing the local host and others with the
12921 same or higher priority values. Also, Exim needs to detect cases
12922 when an address is routed to an IP address that in fact belongs to the
12923 local host. Unless the &%self%& router option or the &%allow_localhost%&
12924 option of the smtp transport is set (as appropriate), this is treated
12925 as an error situation.
12926 .next
12927 When Exim connects to a remote host, it may need to know which interface to use
12928 for the outgoing connection.
12929 .endlist
12930
12931
12932 Exim's default behaviour is likely to be appropriate in the vast majority
12933 of cases. If your host has only one interface, and you want all its IP
12934 addresses to be treated in the same way, and you are using only the
12935 standard SMTP port, you should not need to take any special action. The
12936 rest of this chapter does not apply to you.
12937
12938 In a more complicated situation you may want to listen only on certain
12939 interfaces, or on different ports, and for this reason there are a number of
12940 options that can be used to influence Exim's behaviour. The rest of this
12941 chapter describes how they operate.
12942
12943 When a message is received over TCP/IP, the interface and port that were
12944 actually used are set in &$received_ip_address$& and &$received_port$&.
12945
12946
12947
12948 .section "Starting a listening daemon" "SECID89"
12949 When a listening daemon is started (by means of the &%-bd%& command line
12950 option), the interfaces and ports on which it listens are controlled by the
12951 following options:
12952
12953 .ilist
12954 &%daemon_smtp_ports%& contains a list of default ports
12955 or service names.
12956 (For backward compatibility, this option can also be specified in the singular.)
12957 .next
12958 &%local_interfaces%& contains list of interface IP addresses on which to
12959 listen. Each item may optionally also specify a port.
12960 .endlist
12961
12962 The default list separator in both cases is a colon, but this can be changed as
12963 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12964 it is usually best to change the separator to avoid having to double all the
12965 colons. For example:
12966 .code
12967 local_interfaces = <; 127.0.0.1 ; \
12968                       192.168.23.65 ; \
12969                       ::1 ; \
12970                       3ffe:ffff:836f::fe86:a061
12971 .endd
12972 There are two different formats for specifying a port along with an IP address
12973 in &%local_interfaces%&:
12974
12975 .olist
12976 The port is added onto the address with a dot separator. For example, to listen
12977 on port 1234 on two different IP addresses:
12978 .code
12979 local_interfaces = <; 192.168.23.65.1234 ; \
12980                       3ffe:ffff:836f::fe86:a061.1234
12981 .endd
12982 .next
12983 The IP address is enclosed in square brackets, and the port is added
12984 with a colon separator, for example:
12985 .code
12986 local_interfaces = <; [192.168.23.65]:1234 ; \
12987                       [3ffe:ffff:836f::fe86:a061]:1234
12988 .endd
12989 .endlist
12990
12991 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12992 default setting contains just one port:
12993 .code
12994 daemon_smtp_ports = smtp
12995 .endd
12996 If more than one port is listed, each interface that does not have its own port
12997 specified listens on all of them. Ports that are listed in
12998 &%daemon_smtp_ports%& can be identified either by name (defined in
12999 &_/etc/services_&) or by number. However, when ports are given with individual
13000 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13001
13002
13003
13004 .section "Special IP listening addresses" "SECID90"
13005 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13006 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13007 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13008 instead of setting up separate listening sockets for each interface. The
13009 default value of &%local_interfaces%& is
13010 .code
13011 local_interfaces = 0.0.0.0
13012 .endd
13013 when Exim is built without IPv6 support; otherwise it is:
13014 .code
13015 local_interfaces = <; ::0 ; 0.0.0.0
13016 .endd
13017 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13018
13019
13020
13021 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13022 The &%-oX%& command line option can be used to override the values of
13023 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13024 instance. Another way of doing this would be to use macros and the &%-D%&
13025 option. However, &%-oX%& can be used by any admin user, whereas modification of
13026 the runtime configuration by &%-D%& is allowed only when the caller is root or
13027 exim.
13028
13029 The value of &%-oX%& is a list of items. The default colon separator can be
13030 changed in the usual way if required. If there are any items that do not
13031 contain dots or colons (that is, are not IP addresses), the value of
13032 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13033 items that do contain dots or colons, the value of &%local_interfaces%& is
13034 replaced by those items. Thus, for example,
13035 .code
13036 -oX 1225
13037 .endd
13038 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13039 whereas
13040 .code
13041 -oX 192.168.34.5.1125
13042 .endd
13043 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13044 (However, since &%local_interfaces%& now contains no items without ports, the
13045 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13046
13047
13048
13049 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13050 .cindex "ssmtp protocol"
13051 .cindex "smtps protocol"
13052 .cindex "SMTP" "ssmtp protocol"
13053 .cindex "SMTP" "smtps protocol"
13054 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13055 before the STARTTLS command was standardized for SMTP. Some legacy clients
13056 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13057 list of port numbers or service names,
13058 connections to those ports must use SSMTP. The most
13059 common use of this option is expected to be
13060 .code
13061 tls_on_connect_ports = 465
13062 .endd
13063 because 465 is the usual port number used by the legacy clients. There is also
13064 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13065 this way when a daemon is started.
13066
13067 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13068 daemon to listen on those ports. You must still specify them in
13069 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13070 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13071 connections via the daemon.)
13072
13073
13074
13075
13076 .section "IPv6 address scopes" "SECID92"
13077 .cindex "IPv6" "address scopes"
13078 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13079 can, in principle, have the same link-local IPv6 address on different
13080 interfaces. Thus, additional information is needed, over and above the IP
13081 address, to distinguish individual interfaces. A convention of using a
13082 percent sign followed by something (often the interface name) has been
13083 adopted in some cases, leading to addresses like this:
13084 .code
13085 fe80::202:b3ff:fe03:45c1%eth0
13086 .endd
13087 To accommodate this usage, a percent sign followed by an arbitrary string is
13088 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13089 to convert a textual IPv6 address for actual use. This function recognizes the
13090 percent convention in operating systems that support it, and it processes the
13091 address appropriately. Unfortunately, some older libraries have problems with
13092 &[getaddrinfo()]&. If
13093 .code
13094 IPV6_USE_INET_PTON=yes
13095 .endd
13096 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13097 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13098 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13099 function.) Of course, this means that the additional functionality of
13100 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13101
13102 .section "Disabling IPv6" "SECID93"
13103 .cindex "IPv6" "disabling"
13104 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13105 run on a host whose kernel does not support IPv6. The binary will fall back to
13106 using IPv4, but it may waste resources looking up AAAA records, and trying to
13107 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13108 .oindex "&%disable_ipv6%&"
13109 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13110 activities take place. AAAA records are never looked up, and any IPv6 addresses
13111 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13112 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13113 to handle IPv6 literal addresses.
13114
13115 On the other hand, when IPv6 is in use, there may be times when you want to
13116 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13117 option to globally suppress the lookup of AAAA records for specified domains,
13118 and you can use the &%ignore_target_hosts%& generic router option to ignore
13119 IPv6 addresses in an individual router.
13120
13121
13122
13123 .section "Examples of starting a listening daemon" "SECID94"
13124 The default case in an IPv6 environment is
13125 .code
13126 daemon_smtp_ports = smtp
13127 local_interfaces = <; ::0 ; 0.0.0.0
13128 .endd
13129 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13130 Either one or two sockets may be used, depending on the characteristics of
13131 the TCP/IP stack. (This is complicated and messy; for more information,
13132 read the comments in the &_daemon.c_& source file.)
13133
13134 To specify listening on ports 25 and 26 on all interfaces:
13135 .code
13136 daemon_smtp_ports = 25 : 26
13137 .endd
13138 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13139 .code
13140 local_interfaces = <; ::0.25     ; ::0.26 \
13141                       0.0.0.0.25 ; 0.0.0.0.26
13142 .endd
13143 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13144 IPv4 loopback address only:
13145 .code
13146 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13147 .endd
13148 To specify listening on the default port on specific interfaces only:
13149 .code
13150 local_interfaces = 10.0.0.67 : 192.168.34.67
13151 .endd
13152 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13153
13154
13155
13156 .section "Recognizing the local host" "SECTreclocipadd"
13157 The &%local_interfaces%& option is also used when Exim needs to determine
13158 whether or not an IP address refers to the local host. That is, the IP
13159 addresses of all the interfaces on which a daemon is listening are always
13160 treated as local.
13161
13162 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13163 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13164 available interfaces from the operating system, and extracts the relevant
13165 (that is, IPv4 or IPv6) addresses to use for checking.
13166
13167 Some systems set up large numbers of virtual interfaces in order to provide
13168 many virtual web servers. In this situation, you may want to listen for
13169 email on only a few of the available interfaces, but nevertheless treat all
13170 interfaces as local when routing. You can do this by setting
13171 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13172 &"all"& wildcard values. These addresses are recognized as local, but are not
13173 used for listening. Consider this example:
13174 .code
13175 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13176                       192.168.53.235 ; \
13177                       3ffe:2101:12:1:a00:20ff:fe86:a061
13178
13179 extra_local_interfaces = <; ::0 ; 0.0.0.0
13180 .endd
13181 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13182 address, but all available interface addresses are treated as local when
13183 Exim is routing.
13184
13185 In some environments the local host name may be in an MX list, but with an IP
13186 address that is not assigned to any local interface. In other cases it may be
13187 desirable to treat other host names as if they referred to the local host. Both
13188 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13189 This contains host names rather than IP addresses. When a host is referenced
13190 during routing, either via an MX record or directly, it is treated as the local
13191 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13192 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13193
13194
13195
13196 .section "Delivering to a remote host" "SECID95"
13197 Delivery to a remote host is handled by the smtp transport. By default, it
13198 allows the system's TCP/IP functions to choose which interface to use (if
13199 there is more than one) when connecting to a remote host. However, the
13200 &%interface%& option can be set to specify which interface is used. See the
13201 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13202 details.
13203
13204
13205
13206
13207 . ////////////////////////////////////////////////////////////////////////////
13208 . ////////////////////////////////////////////////////////////////////////////
13209
13210 .chapter "Main configuration" "CHAPmainconfig"
13211 .scindex IIDconfima "configuration file" "main section"
13212 .scindex IIDmaiconf "main configuration"
13213 The first part of the run time configuration file contains three types of item:
13214
13215 .ilist
13216 Macro definitions: These lines start with an upper case letter. See section
13217 &<<SECTmacrodefs>>& for details of macro processing.
13218 .next
13219 Named list definitions: These lines start with one of the words &"domainlist"&,
13220 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13221 section &<<SECTnamedlists>>&.
13222 .next
13223 Main configuration settings: Each setting occupies one line of the file
13224 (with possible continuations). If any setting is preceded by the word
13225 &"hide"&, the &%-bP%& command line option displays its value to admin users
13226 only. See section &<<SECTcos>>& for a description of the syntax of these option
13227 settings.
13228 .endlist
13229
13230 This chapter specifies all the main configuration options, along with their
13231 types and default values. For ease of finding a particular option, they appear
13232 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13233 are now so many options, they are first listed briefly in functional groups, as
13234 an aid to finding the name of the option you are looking for. Some options are
13235 listed in more than one group.
13236
13237 .section "Miscellaneous" "SECID96"
13238 .table2
13239 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13240 .row &%disable_ipv6%&                "do no IPv6 processing"
13241 .row &%keep_malformed%&              "for broken files &-- should not happen"
13242 .row &%localhost_number%&            "for unique message ids in clusters"
13243 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13244 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13245 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13246 .row &%print_topbitchars%&           "top-bit characters are printing"
13247 .row &%timezone%&                    "force time zone"
13248 .endtable
13249
13250
13251 .section "Exim parameters" "SECID97"
13252 .table2
13253 .row &%exim_group%&                  "override compiled-in value"
13254 .row &%exim_path%&                   "override compiled-in value"
13255 .row &%exim_user%&                   "override compiled-in value"
13256 .row &%primary_hostname%&            "default from &[uname()]&"
13257 .row &%split_spool_directory%&       "use multiple directories"
13258 .row &%spool_directory%&             "override compiled-in value"
13259 .endtable
13260
13261
13262
13263 .section "Privilege controls" "SECID98"
13264 .table2
13265 .row &%admin_groups%&                "groups that are Exim admin users"
13266 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13267 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13268 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13269 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13270 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13271 .row &%never_users%&                 "do not run deliveries as these"
13272 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13273 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13274 .row &%trusted_groups%&              "groups that are trusted"
13275 .row &%trusted_users%&               "users that are trusted"
13276 .endtable
13277
13278
13279
13280 .section "Logging" "SECID99"
13281 .table2
13282 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13283 .row &%log_file_path%&               "override compiled-in value"
13284 .row &%log_selector%&                "set/unset optional logging"
13285 .row &%log_timezone%&                "add timezone to log lines"
13286 .row &%message_logs%&                "create per-message logs"
13287 .row &%preserve_message_logs%&       "after message completion"
13288 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13289 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13290 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13291 .row &%syslog_facility%&             "set syslog &""facility""& field"
13292 .row &%syslog_processname%&          "set syslog &""ident""& field"
13293 .row &%syslog_timestamp%&            "timestamp syslog lines"
13294 .row &%write_rejectlog%&             "control use of message log"
13295 .endtable
13296
13297
13298
13299 .section "Frozen messages" "SECID100"
13300 .table2
13301 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13302 .row &%freeze_tell%&                 "send message when freezing"
13303 .row &%move_frozen_messages%&        "to another directory"
13304 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13305 .endtable
13306
13307
13308
13309 .section "Data lookups" "SECID101"
13310 .table2
13311 .row &%ibase_servers%&               "InterBase servers"
13312 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13313 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13314 .row &%ldap_cert_file%&              "client cert file for LDAP"
13315 .row &%ldap_cert_key%&               "client key file for LDAP"
13316 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13317 .row &%ldap_default_servers%&        "used if no server in query"
13318 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13319 .row &%ldap_start_tls%&              "require TLS within LDAP"
13320 .row &%ldap_version%&                "set protocol version"
13321 .row &%lookup_open_max%&             "lookup files held open"
13322 .row &%mysql_servers%&               "default MySQL servers"
13323 .row &%oracle_servers%&              "Oracle servers"
13324 .row &%pgsql_servers%&               "default PostgreSQL servers"
13325 .row &%sqlite_lock_timeout%&         "as it says"
13326 .endtable
13327
13328
13329
13330 .section "Message ids" "SECID102"
13331 .table2
13332 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13333 .row &%message_id_header_text%&      "ditto"
13334 .endtable
13335
13336
13337
13338 .section "Embedded Perl Startup" "SECID103"
13339 .table2
13340 .row &%perl_at_start%&               "always start the interpreter"
13341 .row &%perl_startup%&                "code to obey when starting Perl"
13342 .endtable
13343
13344
13345
13346 .section "Daemon" "SECID104"
13347 .table2
13348 .row &%daemon_smtp_ports%&           "default ports"
13349 .row &%daemon_startup_retries%&      "number of times to retry"
13350 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13351 .row &%extra_local_interfaces%&      "not necessarily listened on"
13352 .row &%local_interfaces%&            "on which to listen, with optional ports"
13353 .row &%pid_file_path%&               "override compiled-in value"
13354 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13355 .endtable
13356
13357
13358
13359 .section "Resource control" "SECID105"
13360 .table2
13361 .row &%check_log_inodes%&            "before accepting a message"
13362 .row &%check_log_space%&             "before accepting a message"
13363 .row &%check_spool_inodes%&          "before accepting a message"
13364 .row &%check_spool_space%&           "before accepting a message"
13365 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13366 .row &%queue_only_load%&             "queue incoming if load high"
13367 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13368 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13369 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13370 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13371 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13372 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13373 .row &%smtp_accept_max_per_connection%& "messages per connection"
13374 .row &%smtp_accept_max_per_host%&    "connections from one host"
13375 .row &%smtp_accept_queue%&           "queue mail if more connections"
13376 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13377                                            connection"
13378 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13379 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13380 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13381 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13382 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13383 .endtable
13384
13385
13386
13387 .section "Policy controls" "SECID106"
13388 .table2
13389 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13390 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13391 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13392 .row &%acl_smtp_auth%&               "ACL for AUTH"
13393 .row &%acl_smtp_connect%&            "ACL for connection"
13394 .row &%acl_smtp_data%&               "ACL for DATA"
13395 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13396 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13397 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13398 .row &%acl_smtp_expn%&               "ACL for EXPN"
13399 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13400 .row &%acl_smtp_mail%&               "ACL for MAIL"
13401 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13402 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13403 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13404 .row &%acl_smtp_predata%&            "ACL for start of data"
13405 .row &%acl_smtp_quit%&               "ACL for QUIT"
13406 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13407 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13408 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13409 .row &%av_scanner%&                  "specify virus scanner"
13410 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13411                                       words""&"
13412 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13413 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13414 .row &%header_maxsize%&              "total size of message header"
13415 .row &%header_line_maxsize%&         "individual header line limit"
13416 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13417 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13418 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13419 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13420 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13421 .row &%host_lookup%&                 "host name looked up for these hosts"
13422 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13423 .row &%host_reject_connection%&      "reject connection from these hosts"
13424 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13425 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13426 .row &%message_size_limit%&          "for all messages"
13427 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13428 .row &%spamd_address%&               "set interface to SpamAssassin"
13429 .row &%strict_acl_vars%&             "object to unset ACL variables"
13430 .endtable
13431
13432
13433
13434 .section "Callout cache" "SECID107"
13435 .table2
13436 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13437                                          item"
13438 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13439                                          item"
13440 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13441 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13442 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13443 .endtable
13444
13445
13446
13447 .section "TLS" "SECID108"
13448 .table2
13449 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13450 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13451 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13452 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13453 .row &%tls_certificate%&             "location of server certificate"
13454 .row &%tls_crl%&                     "certificate revocation list"
13455 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13456 .row &%tls_dhparam%&                 "DH parameters for server"
13457 .row &%tls_eccurve%&                 "EC curve selection for server"
13458 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13459 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13460 .row &%tls_privatekey%&              "location of server private key"
13461 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13462 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13463 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13464 .row &%tls_verify_certificates%&     "expected client certificates"
13465 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13466 .endtable
13467
13468
13469
13470 .section "Local user handling" "SECID109"
13471 .table2
13472 .row &%finduser_retries%&            "useful in NIS environments"
13473 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13474 .row &%gecos_pattern%&               "ditto"
13475 .row &%max_username_length%&         "for systems that truncate"
13476 .row &%unknown_login%&               "used when no login name found"
13477 .row &%unknown_username%&            "ditto"
13478 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13479 .row &%uucp_from_sender%&            "ditto"
13480 .endtable
13481
13482
13483
13484 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13485 .table2
13486 .row &%header_maxsize%&              "total size of message header"
13487 .row &%header_line_maxsize%&         "individual header line limit"
13488 .row &%message_size_limit%&          "applies to all messages"
13489 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13490 .row &%received_header_text%&        "expanded to make &'Received:'&"
13491 .row &%received_headers_max%&        "for mail loop detection"
13492 .row &%recipients_max%&              "limit per message"
13493 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13494 .endtable
13495
13496
13497
13498
13499 .section "Non-SMTP incoming messages" "SECID111"
13500 .table2
13501 .row &%receive_timeout%&             "for non-SMTP messages"
13502 .endtable
13503
13504
13505
13506
13507
13508 .section "Incoming SMTP messages" "SECID112"
13509 See also the &'Policy controls'& section above.
13510
13511 .table2
13512 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13513 .row &%host_lookup%&                 "host name looked up for these hosts"
13514 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13515 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13516 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13517 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13518 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13519 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13520 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13521 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13522 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13523 .row &%smtp_accept_max_per_connection%& "messages per connection"
13524 .row &%smtp_accept_max_per_host%&    "connections from one host"
13525 .row &%smtp_accept_queue%&           "queue mail if more connections"
13526 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13527                                            connection"
13528 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13529 .row &%smtp_active_hostname%&        "host name to use in messages"
13530 .row &%smtp_banner%&                 "text for welcome banner"
13531 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13532 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13533 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13534 .row &%smtp_etrn_command%&           "what to run for ETRN"
13535 .row &%smtp_etrn_serialize%&         "only one at once"
13536 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13537 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13538 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13539 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13540 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13541 .row &%smtp_receive_timeout%&        "per command or data line"
13542 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13543 .row &%smtp_return_error_details%&   "give detail on rejections"
13544 .endtable
13545
13546
13547
13548 .section "SMTP extensions" "SECID113"
13549 .table2
13550 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13551 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13552 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13553 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13554 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13555 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13556 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13557 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13558 .endtable
13559
13560
13561
13562 .section "Processing messages" "SECID114"
13563 .table2
13564 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13565 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13566 .row &%allow_utf8_domains%&          "in addresses"
13567 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13568                                       words""&"
13569 .row &%delivery_date_remove%&        "from incoming messages"
13570 .row &%envelope_to_remove%&          "from incoming messages"
13571 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13572 .row &%headers_charset%&             "default for translations"
13573 .row &%qualify_domain%&              "default for senders"
13574 .row &%qualify_recipient%&           "default for recipients"
13575 .row &%return_path_remove%&          "from incoming messages"
13576 .row &%strip_excess_angle_brackets%& "in addresses"
13577 .row &%strip_trailing_dot%&          "at end of addresses"
13578 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13579 .endtable
13580
13581
13582
13583 .section "System filter" "SECID115"
13584 .table2
13585 .row &%system_filter%&               "locate system filter"
13586 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13587                                             directory"
13588 .row &%system_filter_file_transport%& "transport for delivery to a file"
13589 .row &%system_filter_group%&         "group for filter running"
13590 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13591 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13592 .row &%system_filter_user%&          "user for filter running"
13593 .endtable
13594
13595
13596
13597 .section "Routing and delivery" "SECID116"
13598 .table2
13599 .row &%disable_ipv6%&                "do no IPv6 processing"
13600 .row &%dns_again_means_nonexist%&    "for broken domains"
13601 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13602 .row &%dns_dnssec_ok%&               "parameter for resolver"
13603 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13604 .row &%dns_retrans%&                 "parameter for resolver"
13605 .row &%dns_retry%&                   "parameter for resolver"
13606 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13607 .row &%dns_use_edns0%&               "parameter for resolver"
13608 .row &%hold_domains%&                "hold delivery for these domains"
13609 .row &%local_interfaces%&            "for routing checks"
13610 .row &%queue_domains%&               "no immediate delivery for these"
13611 .row &%queue_only%&                  "no immediate delivery at all"
13612 .row &%queue_only_file%&             "no immediate delivery if file exists"
13613 .row &%queue_only_load%&             "no immediate delivery if load is high"
13614 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13615 .row &%queue_only_override%&         "allow command line to override"
13616 .row &%queue_run_in_order%&          "order of arrival"
13617 .row &%queue_run_max%&               "of simultaneous queue runners"
13618 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13619 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13620 .row &%remote_sort_domains%&         "order of remote deliveries"
13621 .row &%retry_data_expire%&           "timeout for retry data"
13622 .row &%retry_interval_max%&          "safety net for retry rules"
13623 .endtable
13624
13625
13626
13627 .section "Bounce and warning messages" "SECID117"
13628 .table2
13629 .row &%bounce_message_file%&         "content of bounce"
13630 .row &%bounce_message_text%&         "content of bounce"
13631 .row &%bounce_return_body%&          "include body if returning message"
13632 .row &%bounce_return_message%&       "include original message in bounce"
13633 .row &%bounce_return_size_limit%&    "limit on returned message"
13634 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13635 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13636 .row &%errors_copy%&                 "copy bounce messages"
13637 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13638 .row &%delay_warning%&               "time schedule"
13639 .row &%delay_warning_condition%&     "condition for warning messages"
13640 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13641 .row &%smtp_return_error_details%&   "give detail on rejections"
13642 .row &%warn_message_file%&           "content of warning message"
13643 .endtable
13644
13645
13646
13647 .section "Alphabetical list of main options" "SECTalomo"
13648 Those options that undergo string expansion before use are marked with
13649 &dagger;.
13650
13651 .option accept_8bitmime main boolean true
13652 .cindex "8BITMIME"
13653 .cindex "8-bit characters"
13654 .cindex "log" "selectors"
13655 .cindex "log" "8BITMIME"
13656 This option causes Exim to send 8BITMIME in its response to an SMTP
13657 EHLO command, and to accept the BODY= parameter on MAIL commands.
13658 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13659 takes no steps to do anything special with messages received by this route.
13660
13661 Historically Exim kept this option off by default, but the maintainers
13662 feel that in today's Internet, this causes more problems than it solves.
13663 It now defaults to true.
13664 A more detailed analysis of the issues is provided by Dan Bernstein:
13665 .display
13666 &url(http://cr.yp.to/smtp/8bitmime.html)
13667 .endd
13668
13669 To log received 8BITMIME status use
13670 .code
13671 log_selector = +8bitmime
13672 .endd
13673
13674 .option acl_not_smtp main string&!! unset
13675 .cindex "&ACL;" "for non-SMTP messages"
13676 .cindex "non-SMTP messages" "ACLs for"
13677 This option defines the ACL that is run when a non-SMTP message has been
13678 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13679 further details.
13680
13681 .option acl_not_smtp_mime main string&!! unset
13682 This option defines the ACL that is run for individual MIME parts of non-SMTP
13683 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13684 SMTP messages.
13685
13686 .option acl_not_smtp_start main string&!! unset
13687 .cindex "&ACL;" "at start of non-SMTP message"
13688 .cindex "non-SMTP messages" "ACLs for"
13689 This option defines the ACL that is run before Exim starts reading a
13690 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13691
13692 .option acl_smtp_auth main string&!! unset
13693 .cindex "&ACL;" "setting up for SMTP commands"
13694 .cindex "AUTH" "ACL for"
13695 This option defines the ACL that is run when an SMTP AUTH command is
13696 received. See chapter &<<CHAPACL>>& for further details.
13697
13698 .option acl_smtp_connect main string&!! unset
13699 .cindex "&ACL;" "on SMTP connection"
13700 This option defines the ACL that is run when an SMTP connection is received.
13701 See chapter &<<CHAPACL>>& for further details.
13702
13703 .option acl_smtp_data main string&!! unset
13704 .cindex "DATA" "ACL for"
13705 This option defines the ACL that is run after an SMTP DATA command has been
13706 processed and the message itself has been received, but before the final
13707 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13708
13709 .option acl_smtp_data_prdr main string&!! accept
13710 .cindex "PRDR" "ACL for"
13711 .cindex "DATA" "PRDR ACL for"
13712 .cindex "&ACL;" "PRDR-related"
13713 .cindex "&ACL;" "per-user data processing"
13714 This option defines the ACL that,
13715 if the PRDR feature has been negotiated,
13716 is run for each recipient after an SMTP DATA command has been
13717 processed and the message itself has been received, but before the
13718 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13719
13720 .option acl_smtp_dkim main string&!! unset
13721 .cindex DKIM "ACL for"
13722 This option defines the ACL that is run for each DKIM signature
13723 of a received message.
13724 See chapter &<<CHAPdkim>>& for further details.
13725
13726 .option acl_smtp_etrn main string&!! unset
13727 .cindex "ETRN" "ACL for"
13728 This option defines the ACL that is run when an SMTP ETRN command is
13729 received. See chapter &<<CHAPACL>>& for further details.
13730
13731 .option acl_smtp_expn main string&!! unset
13732 .cindex "EXPN" "ACL for"
13733 This option defines the ACL that is run when an SMTP EXPN command is
13734 received. See chapter &<<CHAPACL>>& for further details.
13735
13736 .option acl_smtp_helo main string&!! unset
13737 .cindex "EHLO" "ACL for"
13738 .cindex "HELO" "ACL for"
13739 This option defines the ACL that is run when an SMTP EHLO or HELO
13740 command is received. See chapter &<<CHAPACL>>& for further details.
13741
13742
13743 .option acl_smtp_mail main string&!! unset
13744 .cindex "MAIL" "ACL for"
13745 This option defines the ACL that is run when an SMTP MAIL command is
13746 received. See chapter &<<CHAPACL>>& for further details.
13747
13748 .option acl_smtp_mailauth main string&!! unset
13749 .cindex "AUTH" "on MAIL command"
13750 This option defines the ACL that is run when there is an AUTH parameter on
13751 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13752 &<<CHAPSMTPAUTH>>& for details of authentication.
13753
13754 .option acl_smtp_mime main string&!! unset
13755 .cindex "MIME content scanning" "ACL for"
13756 This option is available when Exim is built with the content-scanning
13757 extension. It defines the ACL that is run for each MIME part in a message. See
13758 section &<<SECTscanmimepart>>& for details.
13759
13760 .option acl_smtp_notquit main string&!! unset
13761 .cindex "not-QUIT, ACL for"
13762 This option defines the ACL that is run when an SMTP session
13763 ends without a QUIT command being received.
13764 See chapter &<<CHAPACL>>& for further details.
13765
13766 .option acl_smtp_predata main string&!! unset
13767 This option defines the ACL that is run when an SMTP DATA command is
13768 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13769 further details.
13770
13771 .option acl_smtp_quit main string&!! unset
13772 .cindex "QUIT, ACL for"
13773 This option defines the ACL that is run when an SMTP QUIT command is
13774 received. See chapter &<<CHAPACL>>& for further details.
13775
13776 .option acl_smtp_rcpt main string&!! unset
13777 .cindex "RCPT" "ACL for"
13778 This option defines the ACL that is run when an SMTP RCPT command is
13779 received. See chapter &<<CHAPACL>>& for further details.
13780
13781 .option acl_smtp_starttls main string&!! unset
13782 .cindex "STARTTLS, ACL for"
13783 This option defines the ACL that is run when an SMTP STARTTLS command is
13784 received. See chapter &<<CHAPACL>>& for further details.
13785
13786 .option acl_smtp_vrfy main string&!! unset
13787 .cindex "VRFY" "ACL for"
13788 This option defines the ACL that is run when an SMTP VRFY command is
13789 received. See chapter &<<CHAPACL>>& for further details.
13790
13791 .option admin_groups main "string list&!!" unset
13792 .cindex "admin user"
13793 This option is expanded just once, at the start of Exim's processing. If the
13794 current group or any of the supplementary groups of an Exim caller is in this
13795 colon-separated list, the caller has admin privileges. If all your system
13796 programmers are in a specific group, for example, you can give them all Exim
13797 admin privileges by putting that group in &%admin_groups%&. However, this does
13798 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13799 To permit this, you have to add individuals to the Exim group.
13800
13801 .option allow_domain_literals main boolean false
13802 .cindex "domain literal"
13803 If this option is set, the RFC 2822 domain literal format is permitted in
13804 email addresses. The option is not set by default, because the domain literal
13805 format is not normally required these days, and few people know about it. It
13806 has, however, been exploited by mail abusers.
13807
13808 Unfortunately, it seems that some DNS black list maintainers are using this
13809 format to report black listing to postmasters. If you want to accept messages
13810 addressed to your hosts by IP address, you need to set
13811 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13812 domains (defined in the named domain list &%local_domains%& in the default
13813 configuration). This &"magic string"& matches the domain literal form of all
13814 the local host's IP addresses.
13815
13816
13817 .option allow_mx_to_ip main boolean false
13818 .cindex "MX record" "pointing to IP address"
13819 It appears that more and more DNS zone administrators are breaking the rules
13820 and putting domain names that look like IP addresses on the right hand side of
13821 MX records. Exim follows the rules and rejects this, giving an error message
13822 that explains the misconfiguration. However, some other MTAs support this
13823 practice, so to avoid &"Why can't Exim do this?"& complaints,
13824 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13825 recommended, except when you have no other choice.
13826
13827 .option allow_utf8_domains main boolean false
13828 .cindex "domain" "UTF-8 characters in"
13829 .cindex "UTF-8" "in domain name"
13830 Lots of discussion is going on about internationalized domain names. One
13831 camp is strongly in favour of just using UTF-8 characters, and it seems
13832 that at least two other MTAs permit this. This option allows Exim users to
13833 experiment if they wish.
13834
13835 If it is set true, Exim's domain parsing function allows valid
13836 UTF-8 multicharacters to appear in domain name components, in addition to
13837 letters, digits, and hyphens. However, just setting this option is not
13838 enough; if you want to look up these domain names in the DNS, you must also
13839 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13840 suitable setting is:
13841 .code
13842 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13843   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13844 .endd
13845 Alternatively, you can just disable this feature by setting
13846 .code
13847 dns_check_names_pattern =
13848 .endd
13849 That is, set the option to an empty string so that no check is done.
13850
13851
13852 .option auth_advertise_hosts main "host list&!!" *
13853 .cindex "authentication" "advertising"
13854 .cindex "AUTH" "advertising"
13855 If any server authentication mechanisms are configured, Exim advertises them in
13856 response to an EHLO command only if the calling host matches this list.
13857 Otherwise, Exim does not advertise AUTH.
13858 Exim does not accept AUTH commands from clients to which it has not
13859 advertised the availability of AUTH. The advertising of individual
13860 authentication mechanisms can be controlled by the use of the
13861 &%server_advertise_condition%& generic authenticator option on the individual
13862 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13863
13864 Certain mail clients (for example, Netscape) require the user to provide a name
13865 and password for authentication if AUTH is advertised, even though it may
13866 not be needed (the host may accept messages from hosts on its local LAN without
13867 authentication, for example). The &%auth_advertise_hosts%& option can be used
13868 to make these clients more friendly by excluding them from the set of hosts to
13869 which Exim advertises AUTH.
13870
13871 .cindex "AUTH" "advertising when encrypted"
13872 If you want to advertise the availability of AUTH only when the connection
13873 is encrypted using TLS, you can make use of the fact that the value of this
13874 option is expanded, with a setting like this:
13875 .code
13876 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13877 .endd
13878 .vindex "&$tls_in_cipher$&"
13879 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13880 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13881 expansion is *, which matches all hosts.
13882
13883
13884 .option auto_thaw main time 0s
13885 .cindex "thawing messages"
13886 .cindex "unfreezing messages"
13887 If this option is set to a time greater than zero, a queue runner will try a
13888 new delivery attempt on any frozen message, other than a bounce message, if
13889 this much time has passed since it was frozen. This may result in the message
13890 being re-frozen if nothing has changed since the last attempt. It is a way of
13891 saying &"keep on trying, even though there are big problems"&.
13892
13893 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13894 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13895 thought to be very useful any more, and its use should probably be avoided.
13896
13897
13898 .option av_scanner main string "see below"
13899 This option is available if Exim is built with the content-scanning extension.
13900 It specifies which anti-virus scanner to use. The default value is:
13901 .code
13902 sophie:/var/run/sophie
13903 .endd
13904 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13905 before use. See section &<<SECTscanvirus>>& for further details.
13906
13907
13908 .option bi_command main string unset
13909 .oindex "&%-bi%&"
13910 This option supplies the name of a command that is run when Exim is called with
13911 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13912 just the command name, it is not a complete command line. If an argument is
13913 required, it must come from the &%-oA%& command line option.
13914
13915
13916 .option bounce_message_file main string unset
13917 .cindex "bounce message" "customizing"
13918 .cindex "customizing" "bounce message"
13919 This option defines a template file containing paragraphs of text to be used
13920 for constructing bounce messages.  Details of the file's contents are given in
13921 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13922
13923
13924 .option bounce_message_text main string unset
13925 When this option is set, its contents are included in the default bounce
13926 message immediately after &"This message was created automatically by mail
13927 delivery software."& It is not used if &%bounce_message_file%& is set.
13928
13929 .option bounce_return_body main boolean true
13930 .cindex "bounce message" "including body"
13931 This option controls whether the body of an incoming message is included in a
13932 bounce message when &%bounce_return_message%& is true. The default setting
13933 causes the entire message, both header and body, to be returned (subject to the
13934 value of &%bounce_return_size_limit%&). If this option is false, only the
13935 message header is included. In the case of a non-SMTP message containing an
13936 error that is detected during reception, only those header lines preceding the
13937 point at which the error was detected are returned.
13938 .cindex "bounce message" "including original"
13939
13940 .option bounce_return_message main boolean true
13941 If this option is set false, none of the original message is included in
13942 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13943 &%bounce_return_body%&.
13944
13945
13946 .option bounce_return_size_limit main integer 100K
13947 .cindex "size" "of bounce, limit"
13948 .cindex "bounce message" "size limit"
13949 .cindex "limit" "bounce message size"
13950 This option sets a limit in bytes on the size of messages that are returned to
13951 senders as part of bounce messages when &%bounce_return_message%& is true. The
13952 limit should be less than the value of the global &%message_size_limit%& and of
13953 any &%message_size_limit%& settings on transports, to allow for the bounce text
13954 that Exim generates. If this option is set to zero there is no limit.
13955
13956 When the body of any message that is to be included in a bounce message is
13957 greater than the limit, it is truncated, and a comment pointing this out is
13958 added at the top. The actual cutoff may be greater than the value given, owing
13959 to the use of buffering for transferring the message in chunks (typically 8K in
13960 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13961 messages.
13962
13963 .option bounce_sender_authentication main string unset
13964 .cindex "bounce message" "sender authentication"
13965 .cindex "authentication" "bounce message"
13966 .cindex "AUTH" "on bounce message"
13967 This option provides an authenticated sender address that is sent with any
13968 bounce messages generated by Exim that are sent over an authenticated SMTP
13969 connection. A typical setting might be:
13970 .code
13971 bounce_sender_authentication = mailer-daemon@my.domain.example
13972 .endd
13973 which would cause bounce messages to be sent using the SMTP command:
13974 .code
13975 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13976 .endd
13977 The value of &%bounce_sender_authentication%& must always be a complete email
13978 address.
13979
13980 .option callout_domain_negative_expire main time 3h
13981 .cindex "caching" "callout timeouts"
13982 .cindex "callout" "caching timeouts"
13983 This option specifies the expiry time for negative callout cache data for a
13984 domain. See section &<<SECTcallver>>& for details of callout verification, and
13985 section &<<SECTcallvercache>>& for details of the caching.
13986
13987
13988 .option callout_domain_positive_expire main time 7d
13989 This option specifies the expiry time for positive callout cache data for a
13990 domain. See section &<<SECTcallver>>& for details of callout verification, and
13991 section &<<SECTcallvercache>>& for details of the caching.
13992
13993
13994 .option callout_negative_expire main time 2h
13995 This option specifies the expiry time for negative callout cache data for an
13996 address. See section &<<SECTcallver>>& for details of callout verification, and
13997 section &<<SECTcallvercache>>& for details of the caching.
13998
13999
14000 .option callout_positive_expire main time 24h
14001 This option specifies the expiry time for positive callout cache data for an
14002 address. See section &<<SECTcallver>>& for details of callout verification, and
14003 section &<<SECTcallvercache>>& for details of the caching.
14004
14005
14006 .option callout_random_local_part main string&!! "see below"
14007 This option defines the &"random"& local part that can be used as part of
14008 callout verification. The default value is
14009 .code
14010 $primary_hostname-$tod_epoch-testing
14011 .endd
14012 See section &<<CALLaddparcall>>& for details of how this value is used.
14013
14014
14015 .option check_log_inodes main integer 0
14016 See &%check_spool_space%& below.
14017
14018
14019 .option check_log_space main integer 0
14020 See &%check_spool_space%& below.
14021
14022 .oindex "&%check_rfc2047_length%&"
14023 .cindex "RFC 2047" "disabling length check"
14024 .option check_rfc2047_length main boolean true
14025 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14026 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14027 word; strings to be encoded that exceed this length are supposed to use
14028 multiple encoded words. By default, Exim does not recognize encoded words that
14029 exceed the maximum length. However, it seems that some software, in violation
14030 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14031 set false, Exim recognizes encoded words of any length.
14032
14033
14034 .option check_spool_inodes main integer 0
14035 See &%check_spool_space%& below.
14036
14037
14038 .option check_spool_space main integer 0
14039 .cindex "checking disk space"
14040 .cindex "disk space, checking"
14041 .cindex "spool directory" "checking space"
14042 The four &%check_...%& options allow for checking of disk resources before a
14043 message is accepted.
14044
14045 .vindex "&$log_inodes$&"
14046 .vindex "&$log_space$&"
14047 .vindex "&$spool_inodes$&"
14048 .vindex "&$spool_space$&"
14049 When any of these options are set, they apply to all incoming messages. If you
14050 want to apply different checks to different kinds of message, you can do so by
14051 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14052 &$spool_space$& in an ACL with appropriate additional conditions.
14053
14054
14055 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14056 either value is greater than zero, for example:
14057 .code
14058 check_spool_space = 10M
14059 check_spool_inodes = 100
14060 .endd
14061 The spool partition is the one that contains the directory defined by
14062 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14063 transit.
14064
14065 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14066 files are written if either is greater than zero. These should be set only if
14067 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14068
14069 If there is less space or fewer inodes than requested, Exim refuses to accept
14070 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14071 error response to the MAIL command. If ESMTP is in use and there was a
14072 SIZE parameter on the MAIL command, its value is added to the
14073 &%check_spool_space%& value, and the check is performed even if
14074 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14075
14076 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14077 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14078
14079 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14080 failure a message is written to stderr and Exim exits with a non-zero code, as
14081 it obviously cannot send an error message of any kind.
14082
14083 .option daemon_smtp_ports main string &`smtp`&
14084 .cindex "port" "for daemon"
14085 .cindex "TCP/IP" "setting listening ports"
14086 This option specifies one or more default SMTP ports on which the Exim daemon
14087 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14088 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14089
14090 .option daemon_startup_retries main integer 9
14091 .cindex "daemon startup, retrying"
14092 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14093 the daemon at startup when it cannot immediately bind a listening socket
14094 (typically because the socket is already in use): &%daemon_startup_retries%&
14095 defines the number of retries after the first failure, and
14096 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14097
14098 .option daemon_startup_sleep main time 30s
14099 See &%daemon_startup_retries%&.
14100
14101 .option delay_warning main "time list" 24h
14102 .cindex "warning of delay"
14103 .cindex "delay warning, specifying"
14104 When a message is delayed, Exim sends a warning message to the sender at
14105 intervals specified by this option. The data is a colon-separated list of times
14106 after which to send warning messages. If the value of the option is an empty
14107 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14108 message has been on the queue for longer than the last time, the last interval
14109 between the times is used to compute subsequent warning times. For example,
14110 with
14111 .code
14112 delay_warning = 4h:8h:24h
14113 .endd
14114 the first message is sent after 4 hours, the second after 8 hours, and
14115 the third one after 24 hours. After that, messages are sent every 16 hours,
14116 because that is the interval between the last two times on the list. If you set
14117 just one time, it specifies the repeat interval. For example, with:
14118 .code
14119 delay_warning = 6h
14120 .endd
14121 messages are repeated every six hours. To stop warnings after a given time, set
14122 a very large time at the end of the list. For example:
14123 .code
14124 delay_warning = 2h:12h:99d
14125 .endd
14126 Note that the option is only evaluated at the time a delivery attempt fails,
14127 which depends on retry and queue-runner configuration.
14128 Typically retries will be configured more frequently than warning messages.
14129
14130 .option delay_warning_condition main string&!! "see below"
14131 .vindex "&$domain$&"
14132 The string is expanded at the time a warning message might be sent. If all the
14133 deferred addresses have the same domain, it is set in &$domain$& during the
14134 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14135 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14136 &"false"& (the comparison being done caselessly) then the warning message is
14137 not sent. The default is:
14138 .code
14139 delay_warning_condition = ${if or {\
14140   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14141   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14142   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14143   } {no}{yes}}
14144 .endd
14145 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14146 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14147 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14148 &"auto-replied"& in an &'Auto-Submitted:'& header.
14149
14150 .option deliver_drop_privilege main boolean false
14151 .cindex "unprivileged delivery"
14152 .cindex "delivery" "unprivileged"
14153 If this option is set true, Exim drops its root privilege at the start of a
14154 delivery process, and runs as the Exim user throughout. This severely restricts
14155 the kinds of local delivery that are possible, but is viable in certain types
14156 of configuration. There is a discussion about the use of root privilege in
14157 chapter &<<CHAPsecurity>>&.
14158
14159 .option deliver_queue_load_max main fixed-point unset
14160 .cindex "load average"
14161 .cindex "queue runner" "abandoning"
14162 When this option is set, a queue run is abandoned if the system load average
14163 becomes greater than the value of the option. The option has no effect on
14164 ancient operating systems on which Exim cannot determine the load average.
14165 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14166
14167
14168 .option delivery_date_remove main boolean true
14169 .cindex "&'Delivery-date:'& header line"
14170 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14171 message when it is delivered, in exactly the same way as &'Return-path:'& is
14172 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14173 should not be present in incoming messages, and this option causes them to be
14174 removed at the time the message is received, to avoid any problems that might
14175 occur when a delivered message is subsequently sent on to some other recipient.
14176
14177 .option disable_fsync main boolean false
14178 .cindex "&[fsync()]&, disabling"
14179 This option is available only if Exim was built with the compile-time option
14180 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14181 a runtime configuration generates an &"unknown option"& error. You should not
14182 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14183 really, really, really understand what you are doing. &'No pre-compiled
14184 distributions of Exim should ever make this option available.'&
14185
14186 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14187 updated files' data to be written to disc before continuing. Unexpected events
14188 such as crashes and power outages may cause data to be lost or scrambled.
14189 Here be Dragons. &*Beware.*&
14190
14191
14192 .option disable_ipv6 main boolean false
14193 .cindex "IPv6" "disabling"
14194 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14195 activities take place. AAAA records are never looked up, and any IPv6 addresses
14196 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14197 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14198 to handle IPv6 literal addresses.
14199
14200
14201 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14202 .cindex DKIM "controlling calls to the ACL"
14203 This option gives a list of DKIM domains for which the DKIM ACL is run.
14204 It is expanded after the message is received; by default it runs
14205 the ACL once for each signature in the message.
14206 See chapter &<<CHAPdkim>>&.
14207
14208
14209 .option dns_again_means_nonexist main "domain list&!!" unset
14210 .cindex "DNS" "&""try again""& response; overriding"
14211 DNS lookups give a &"try again"& response for the DNS errors
14212 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14213 keep trying to deliver a message, or to give repeated temporary errors to
14214 incoming mail. Sometimes the effect is caused by a badly set up name server and
14215 may persist for a long time. If a domain which exhibits this problem matches
14216 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14217 This option should be used with care. You can make it apply to reverse lookups
14218 by a setting such as this:
14219 .code
14220 dns_again_means_nonexist = *.in-addr.arpa
14221 .endd
14222 This option applies to all DNS lookups that Exim does. It also applies when the
14223 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14224 since these are most likely to be caused by DNS lookup problems. The
14225 &(dnslookup)& router has some options of its own for controlling what happens
14226 when lookups for MX or SRV records give temporary errors. These more specific
14227 options are applied after this global option.
14228
14229 .option dns_check_names_pattern main string "see below"
14230 .cindex "DNS" "pre-check of name syntax"
14231 When this option is set to a non-empty string, it causes Exim to check domain
14232 names for characters that are not allowed in host names before handing them to
14233 the DNS resolver, because some resolvers give temporary errors for names that
14234 contain unusual characters. If a domain name contains any unwanted characters,
14235 a &"not found"& result is forced, and the resolver is not called. The check is
14236 done by matching the domain name against a regular expression, which is the
14237 value of this option. The default pattern is
14238 .code
14239 dns_check_names_pattern = \
14240   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14241 .endd
14242 which permits only letters, digits, slashes, and hyphens in components, but
14243 they must start and end with a letter or digit. Slashes are not, in fact,
14244 permitted in host names, but they are found in certain NS records (which can be
14245 accessed in Exim by using a &%dnsdb%& lookup). If you set
14246 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14247 empty string.
14248
14249 .option dns_csa_search_limit main integer 5
14250 This option controls the depth of parental searching for CSA SRV records in the
14251 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14252
14253 .option dns_csa_use_reverse main boolean true
14254 This option controls whether or not an IP address, given as a CSA domain, is
14255 reversed and looked up in the reverse DNS, as described in more detail in
14256 section &<<SECTverifyCSA>>&.
14257
14258
14259 .option dns_dnssec_ok main integer -1
14260 .cindex "DNS" "resolver options"
14261 .cindex "DNS" "DNSSEC"
14262 If this option is set to a non-negative number then Exim will initialise the
14263 DNS resolver library to either use or not use DNSSEC, overriding the system
14264 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14265
14266 If the resolver library does not support DNSSEC then this option has no effect.
14267
14268
14269 .option dns_ipv4_lookup main "domain list&!!" unset
14270 .cindex "IPv6" "DNS lookup for AAAA records"
14271 .cindex "DNS" "IPv6 lookup for AAAA records"
14272 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14273 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14274 (A records) when trying to find IP addresses for hosts, unless the host's
14275 domain matches this list.
14276
14277 This is a fudge to help with name servers that give big delays or otherwise do
14278 not work for the AAAA record type. In due course, when the world's name
14279 servers have all been upgraded, there should be no need for this option.
14280
14281
14282 .option dns_retrans main time 0s
14283 .cindex "DNS" "resolver options"
14284 .cindex timeout "dns lookup"
14285 .cindex "DNS" timeout
14286 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14287 retransmission and retry parameters for DNS lookups. Values of zero (the
14288 defaults) leave the system default settings unchanged. The first value is the
14289 time between retries, and the second is the number of retries. It isn't
14290 totally clear exactly how these settings affect the total time a DNS lookup may
14291 take. I haven't found any documentation about timeouts on DNS lookups; these
14292 parameter values are available in the external resolver interface structure,
14293 but nowhere does it seem to describe how they are used or what you might want
14294 to set in them.
14295 See also the &%slow_lookup_log%& option.
14296
14297
14298 .option dns_retry main integer 0
14299 See &%dns_retrans%& above.
14300
14301
14302 .option dns_trust_aa main "domain list&!!" unset
14303 .cindex "DNS" "resolver options"
14304 .cindex "DNS" "DNSSEC"
14305 If this option is set then lookup results marked with the AA bit
14306 (Authoritative Answer) are trusted the same way as if they were
14307 DNSSEC-verified. The authority section's name of the answer must
14308 match with this expanded domain list.
14309
14310 Use this option only if you talk directly to a resolver that is
14311 authoritative for some zones and does not set the AD (Authentic Data)
14312 bit in the answer. Some DNS servers may have an configuration option to
14313 mark the answers from their own zones as verified (they set the AD bit).
14314 Others do not have this option. It is considered as poor practice using
14315 a resolver that is an authoritative server for some zones.
14316
14317 Use this option only if you really have to (e.g. if you want
14318 to use DANE for remote delivery to a server that is listed in the DNS
14319 zones that your resolver is authoritative for).
14320
14321 If the DNS answer packet has the AA bit set and contains resource record
14322 in the answer section, the name of the first NS record appearing in the
14323 authority section is compared against the list. If the answer packet is
14324 authoritative but the answer section is empty, the name of the first SOA
14325 record in the authoritative section is used instead.
14326
14327 .cindex "DNS" "resolver options"
14328 .option dns_use_edns0 main integer -1
14329 .cindex "DNS" "resolver options"
14330 .cindex "DNS" "EDNS0"
14331 If this option is set to a non-negative number then Exim will initialise the
14332 DNS resolver library to either use or not use EDNS0 extensions, overriding
14333 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14334 on.
14335
14336 If the resolver library does not support EDNS0 then this option has no effect.
14337
14338
14339 .option drop_cr main boolean false
14340 This is an obsolete option that is now a no-op. It used to affect the way Exim
14341 handled CR and LF characters in incoming messages. What happens now is
14342 described in section &<<SECTlineendings>>&.
14343
14344 .option dsn_advertise_hosts main "host list&!!" unset
14345 .cindex "bounce messages" "success"
14346 .cindex "DSN" "success"
14347 .cindex "Delivery Status Notification" "success"
14348 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14349 and accepted from, these hosts.
14350 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14351 and RET and ORCPT options on MAIL FROM commands.
14352 A NOTIFY=SUCCESS option requests success-DSN messages.
14353 A NOTIFY= option with no argument requests that no delay or failure DSNs
14354 are sent.
14355
14356 .option dsn_from main "string&!!" "see below"
14357 .cindex "&'From:'& header line" "in bounces"
14358 .cindex "bounce messages" "&'From:'& line, specifying"
14359 This option can be used to vary the contents of &'From:'& header lines in
14360 bounces and other automatically generated messages (&"Delivery Status
14361 Notifications"& &-- hence the name of the option). The default setting is:
14362 .code
14363 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14364 .endd
14365 The value is expanded every time it is needed. If the expansion fails, a
14366 panic is logged, and the default value is used.
14367
14368 .option envelope_to_remove main boolean true
14369 .cindex "&'Envelope-to:'& header line"
14370 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14371 message when it is delivered, in exactly the same way as &'Return-path:'& is
14372 handled. &'Envelope-to:'& records the original recipient address from the
14373 message's envelope that caused the delivery to happen. Such headers should not
14374 be present in incoming messages, and this option causes them to be removed at
14375 the time the message is received, to avoid any problems that might occur when a
14376 delivered message is subsequently sent on to some other recipient.
14377
14378
14379 .option errors_copy main "string list&!!" unset
14380 .cindex "bounce message" "copy to other address"
14381 .cindex "copy of bounce message"
14382 Setting this option causes Exim to send bcc copies of bounce messages that it
14383 generates to other addresses. &*Note*&: This does not apply to bounce messages
14384 coming from elsewhere. The value of the option is a colon-separated list of
14385 items. Each item consists of a pattern, terminated by white space, followed by
14386 a comma-separated list of email addresses. If a pattern contains spaces, it
14387 must be enclosed in double quotes.
14388
14389 Each pattern is processed in the same way as a single item in an address list
14390 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14391 the bounce message, the message is copied to the addresses on the list. The
14392 items are scanned in order, and once a matching one is found, no further items
14393 are examined. For example:
14394 .code
14395 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14396               rqps@mydomain   hostmaster@mydomain.example,\
14397                               postmaster@mydomain.example
14398 .endd
14399 .vindex "&$domain$&"
14400 .vindex "&$local_part$&"
14401 The address list is expanded before use. The expansion variables &$local_part$&
14402 and &$domain$& are set from the original recipient of the error message, and if
14403 there was any wildcard matching in the pattern, the expansion
14404 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14405 variables &$0$&, &$1$&, etc. are set in the normal way.
14406
14407
14408 .option errors_reply_to main string unset
14409 .cindex "bounce message" "&'Reply-to:'& in"
14410 By default, Exim's bounce and delivery warning messages contain the header line
14411 .display
14412 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14413 .endd
14414 .oindex &%quota_warn_message%&
14415 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14416 A warning message that is generated by the &%quota_warn_message%& option in an
14417 &(appendfile)& transport may contain its own &'From:'& header line that
14418 overrides the default.
14419
14420 Experience shows that people reply to bounce messages. If the
14421 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14422 and warning messages. For example:
14423 .code
14424 errors_reply_to = postmaster@my.domain.example
14425 .endd
14426 The value of the option is not expanded. It must specify a valid RFC 2822
14427 address. However, if a warning message that is generated by the
14428 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14429 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14430 not used.
14431
14432
14433 .option exim_group main string "compile-time configured"
14434 .cindex "gid (group id)" "Exim's own"
14435 .cindex "Exim group"
14436 This option changes the gid under which Exim runs when it gives up root
14437 privilege. The default value is compiled into the binary. The value of this
14438 option is used only when &%exim_user%& is also set. Unless it consists entirely
14439 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14440 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14441 security issues.
14442
14443
14444 .option exim_path main string "see below"
14445 .cindex "Exim binary, path name"
14446 This option specifies the path name of the Exim binary, which is used when Exim
14447 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14448 the directory configured at compile time by the BIN_DIRECTORY setting. It
14449 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14450 other place.
14451 &*Warning*&: Do not use a macro to define the value of this option, because
14452 you will break those Exim utilities that scan the configuration file to find
14453 where the binary is. (They then use the &%-bP%& option to extract option
14454 settings such as the value of &%spool_directory%&.)
14455
14456
14457 .option exim_user main string "compile-time configured"
14458 .cindex "uid (user id)" "Exim's own"
14459 .cindex "Exim user"
14460 This option changes the uid under which Exim runs when it gives up root
14461 privilege. The default value is compiled into the binary. Ownership of the run
14462 time configuration file and the use of the &%-C%& and &%-D%& command line
14463 options is checked against the values in the binary, not what is set here.
14464
14465 Unless it consists entirely of digits, the string is looked up using
14466 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14467 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14468 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14469
14470
14471 .option extra_local_interfaces main "string list" unset
14472 This option defines network interfaces that are to be considered local when
14473 routing, but which are not used for listening by the daemon. See section
14474 &<<SECTreclocipadd>>& for details.
14475
14476
14477 . Allow this long option name to split; give it unsplit as a fifth argument
14478 . for the automatic .oindex that is generated by .option.
14479
14480 .option "extract_addresses_remove_arguments" main boolean true &&&
14481          extract_addresses_remove_arguments
14482 .oindex "&%-t%&"
14483 .cindex "command line" "addresses with &%-t%&"
14484 .cindex "Sendmail compatibility" "&%-t%& option"
14485 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14486 are present on the command line when the &%-t%& option is used to build an
14487 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14488 line addresses are removed from the recipients list. This is also how Smail
14489 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14490 command line addresses are added to those obtained from the header lines. When
14491 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14492 argument headers. If it is set false, Exim adds rather than removes argument
14493 addresses.
14494
14495
14496 .option finduser_retries main integer 0
14497 .cindex "NIS, retrying user lookups"
14498 On systems running NIS or other schemes in which user and group information is
14499 distributed from a remote system, there can be times when &[getpwnam()]& and
14500 related functions fail, even when given valid data, because things time out.
14501 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14502 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14503 many extra times to find a user or a group, waiting for one second between
14504 retries.
14505
14506 .cindex "&_/etc/passwd_&" "multiple reading of"
14507 You should not set this option greater than zero if your user information is in
14508 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14509 search the file multiple times for non-existent users, and also cause delay.
14510
14511
14512
14513 .option freeze_tell main "string list, comma separated" unset
14514 .cindex "freezing messages" "sending a message when freezing"
14515 On encountering certain errors, or when configured to do so in a system filter,
14516 ACL, or special router, Exim freezes a message. This means that no further
14517 delivery attempts take place until an administrator thaws the message, or the
14518 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14519 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14520 warning message whenever it freezes something, unless the message it is
14521 freezing is a locally-generated bounce message. (Without this exception there
14522 is the possibility of looping.) The warning message is sent to the addresses
14523 supplied as the comma-separated value of this option. If several of the
14524 message's addresses cause freezing, only a single message is sent. If the
14525 freezing was automatic, the reason(s) for freezing can be found in the message
14526 log. If you configure freezing in a filter or ACL, you must arrange for any
14527 logging that you require.
14528
14529
14530 .option gecos_name main string&!! unset
14531 .cindex "HP-UX"
14532 .cindex "&""gecos""& field, parsing"
14533 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14534 password file to hold other information in addition to users' real names. Exim
14535 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14536 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14537 of the field are used unchanged, except that, if an ampersand is encountered,
14538 it is replaced by the user's login name with the first character forced to
14539 upper case, since this is a convention that is observed on many systems.
14540
14541 When these options are set, &%gecos_pattern%& is treated as a regular
14542 expression that is to be applied to the field (again with && replaced by the
14543 login name), and if it matches, &%gecos_name%& is expanded and used as the
14544 user's name.
14545
14546 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14547 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14548 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14549 name terminates at the first comma, the following can be used:
14550 .code
14551 gecos_pattern = ([^,]*)
14552 gecos_name = $1
14553 .endd
14554
14555 .option gecos_pattern main string unset
14556 See &%gecos_name%& above.
14557
14558
14559 .option gnutls_compat_mode main boolean unset
14560 This option controls whether GnuTLS is used in compatibility mode in an Exim
14561 server. This reduces security slightly, but improves interworking with older
14562 implementations of TLS.
14563
14564
14565 option gnutls_allow_auto_pkcs11 main boolean unset
14566 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14567 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14568
14569 See
14570 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14571 for documentation.
14572
14573
14574
14575 .option headers_charset main string "see below"
14576 This option sets a default character set for translating from encoded MIME
14577 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14578 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14579 ultimate default is ISO-8859-1. For more details see the description of header
14580 insertions in section &<<SECTexpansionitems>>&.
14581
14582
14583
14584 .option header_maxsize main integer "see below"
14585 .cindex "header section" "maximum size of"
14586 .cindex "limit" "size of message header section"
14587 This option controls the overall maximum size of a message's header
14588 section. The default is the value of HEADER_MAXSIZE in
14589 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14590 sections are rejected.
14591
14592
14593 .option header_line_maxsize main integer 0
14594 .cindex "header lines" "maximum size of"
14595 .cindex "limit" "size of one header line"
14596 This option limits the length of any individual header line in a message, after
14597 all the continuations have been joined together. Messages with individual
14598 header lines that are longer than the limit are rejected. The default value of
14599 zero means &"no limit"&.
14600
14601
14602
14603
14604 .option helo_accept_junk_hosts main "host list&!!" unset
14605 .cindex "HELO" "accepting junk data"
14606 .cindex "EHLO" "accepting junk data"
14607 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14608 mail, and gives an error response for invalid data. Unfortunately, there are
14609 some SMTP clients that send syntactic junk. They can be accommodated by setting
14610 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14611 if you want to do semantic checking.
14612 See also &%helo_allow_chars%& for a way of extending the permitted character
14613 set.
14614
14615
14616 .option helo_allow_chars main string unset
14617 .cindex "HELO" "underscores in"
14618 .cindex "EHLO" "underscores in"
14619 .cindex "underscore in EHLO/HELO"
14620 This option can be set to a string of rogue characters that are permitted in
14621 all EHLO and HELO names in addition to the standard letters, digits,
14622 hyphens, and dots. If you really must allow underscores, you can set
14623 .code
14624 helo_allow_chars = _
14625 .endd
14626 Note that the value is one string, not a list.
14627
14628
14629 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14630 .cindex "HELO" "forcing reverse lookup"
14631 .cindex "EHLO" "forcing reverse lookup"
14632 If the domain given by a client in a HELO or EHLO command matches this
14633 list, a reverse lookup is done in order to establish the host's true name. The
14634 default forces a lookup if the client host gives the server's name or any of
14635 its IP addresses (in brackets), something that broken clients have been seen to
14636 do.
14637
14638
14639 .option helo_try_verify_hosts main "host list&!!" unset
14640 .cindex "HELO verifying" "optional"
14641 .cindex "EHLO" "verifying, optional"
14642 By default, Exim just checks the syntax of HELO and EHLO commands (see
14643 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14644 to do more extensive checking of the data supplied by these commands. The ACL
14645 condition &`verify = helo`& is provided to make this possible.
14646 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14647 to force the check to occur. From release 4.53 onwards, this is no longer
14648 necessary. If the check has not been done before &`verify = helo`& is
14649 encountered, it is done at that time. Consequently, this option is obsolete.
14650 Its specification is retained here for backwards compatibility.
14651
14652 When an EHLO or HELO command is received, if the calling host matches
14653 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14654 EHLO command either:
14655
14656 .ilist
14657 is an IP literal matching the calling address of the host, or
14658 .next
14659 .cindex "DNS" "reverse lookup"
14660 .cindex "reverse DNS lookup"
14661 matches the host name that Exim obtains by doing a reverse lookup of the
14662 calling host address, or
14663 .next
14664 when looked up in DNS yields the calling host address.
14665 .endlist
14666
14667 However, the EHLO or HELO command is not rejected if any of the checks
14668 fail. Processing continues, but the result of the check is remembered, and can
14669 be detected later in an ACL by the &`verify = helo`& condition.
14670
14671 If DNS was used for successful verification, the variable
14672 .cindex "DNS" "DNSSEC"
14673 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14674
14675 .option helo_verify_hosts main "host list&!!" unset
14676 .cindex "HELO verifying" "mandatory"
14677 .cindex "EHLO" "verifying, mandatory"
14678 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14679 backwards compatibility. For hosts that match this option, Exim checks the host
14680 name given in the HELO or EHLO in the same way as for
14681 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14682 rejected with a 550 error, and entries are written to the main and reject logs.
14683 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14684 error.
14685
14686 .option hold_domains main "domain list&!!" unset
14687 .cindex "domain" "delaying delivery"
14688 .cindex "delivery" "delaying certain domains"
14689 This option allows mail for particular domains to be held on the queue
14690 manually. The option is overridden if a message delivery is forced with the
14691 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14692 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14693 item in &%hold_domains%&, no routing or delivery for that address is done, and
14694 it is deferred every time the message is looked at.
14695
14696 This option is intended as a temporary operational measure for delaying the
14697 delivery of mail while some problem is being sorted out, or some new
14698 configuration tested. If you just want to delay the processing of some
14699 domains until a queue run occurs, you should use &%queue_domains%& or
14700 &%queue_smtp_domains%&, not &%hold_domains%&.
14701
14702 A setting of &%hold_domains%& does not override Exim's code for removing
14703 messages from the queue if they have been there longer than the longest retry
14704 time in any retry rule. If you want to hold messages for longer than the normal
14705 retry times, insert a dummy retry rule with a long retry time.
14706
14707
14708 .option host_lookup main "host list&!!" unset
14709 .cindex "host name" "lookup, forcing"
14710 Exim does not look up the name of a calling host from its IP address unless it
14711 is required to compare against some host list, or the host matches
14712 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14713 option (which normally contains IP addresses rather than host names). The
14714 default configuration file contains
14715 .code
14716 host_lookup = *
14717 .endd
14718 which causes a lookup to happen for all hosts. If the expense of these lookups
14719 is felt to be too great, the setting can be changed or removed.
14720
14721 After a successful reverse lookup, Exim does a forward lookup on the name it
14722 has obtained, to verify that it yields the IP address that it started with. If
14723 this check fails, Exim behaves as if the name lookup failed.
14724
14725 .vindex "&$host_lookup_failed$&"
14726 .vindex "&$sender_host_name$&"
14727 After any kind of failure, the host name (in &$sender_host_name$&) remains
14728 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14729 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14730 &`verify = reverse_host_lookup`& in ACLs.
14731
14732
14733 .option host_lookup_order main "string list" &`bydns:byaddr`&
14734 This option specifies the order of different lookup methods when Exim is trying
14735 to find a host name from an IP address. The default is to do a DNS lookup
14736 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14737 if that fails. You can change the order of these lookups, or omit one entirely,
14738 if you want.
14739
14740 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14741 multiple PTR records in the DNS and the IP address is not listed in
14742 &_/etc/hosts_&. Different operating systems give different results in this
14743 case. That is why the default tries a DNS lookup first.
14744
14745
14746
14747 .option host_reject_connection main "host list&!!" unset
14748 .cindex "host" "rejecting connections from"
14749 If this option is set, incoming SMTP calls from the hosts listed are rejected
14750 as soon as the connection is made.
14751 This option is obsolete, and retained only for backward compatibility, because
14752 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14753 connections immediately.
14754
14755 The ability to give an immediate rejection (either by this option or using an
14756 ACL) is provided for use in unusual cases. Many hosts will just try again,
14757 sometimes without much delay. Normally, it is better to use an ACL to reject
14758 incoming messages at a later stage, such as after RCPT commands. See
14759 chapter &<<CHAPACL>>&.
14760
14761
14762 .option hosts_connection_nolog main "host list&!!" unset
14763 .cindex "host" "not logging connections from"
14764 This option defines a list of hosts for which connection logging does not
14765 happen, even though the &%smtp_connection%& log selector is set. For example,
14766 you might want not to log SMTP connections from local processes, or from
14767 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14768 the daemon; you should therefore strive to restrict its value to a short inline
14769 list of IP addresses and networks. To disable logging SMTP connections from
14770 local processes, you must create a host list with an empty item. For example:
14771 .code
14772 hosts_connection_nolog = :
14773 .endd
14774 If the &%smtp_connection%& log selector is not set, this option has no effect.
14775
14776
14777
14778 .option hosts_treat_as_local main "domain list&!!" unset
14779 .cindex "local host" "domains treated as"
14780 .cindex "host" "treated as local"
14781 If this option is set, any host names that match the domain list are treated as
14782 if they were the local host when Exim is scanning host lists obtained from MX
14783 records
14784 or other sources. Note that the value of this option is a domain list, not a
14785 host list, because it is always used to check host names, not IP addresses.
14786
14787 This option also applies when Exim is matching the special items
14788 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14789 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14790 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14791 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14792 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14793 interfaces and recognizing the local host.
14794
14795
14796 .option ibase_servers main "string list" unset
14797 .cindex "InterBase" "server list"
14798 This option provides a list of InterBase servers and associated connection data,
14799 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14800 The option is available only if Exim has been built with InterBase support.
14801
14802
14803
14804 .option ignore_bounce_errors_after main time 10w
14805 .cindex "bounce message" "discarding"
14806 .cindex "discarding bounce message"
14807 This option affects the processing of bounce messages that cannot be delivered,
14808 that is, those that suffer a permanent delivery failure. (Bounce messages that
14809 suffer temporary delivery failures are of course retried in the usual way.)
14810
14811 After a permanent delivery failure, bounce messages are frozen,
14812 because there is no sender to whom they can be returned. When a frozen bounce
14813 message has been on the queue for more than the given time, it is unfrozen at
14814 the next queue run, and a further delivery is attempted. If delivery fails
14815 again, the bounce message is discarded. This makes it possible to keep failed
14816 bounce messages around for a shorter time than the normal maximum retry time
14817 for frozen messages. For example,
14818 .code
14819 ignore_bounce_errors_after = 12h
14820 .endd
14821 retries failed bounce message deliveries after 12 hours, discarding any further
14822 failures. If the value of this option is set to a zero time period, bounce
14823 failures are discarded immediately. Setting a very long time (as in the default
14824 value) has the effect of disabling this option. For ways of automatically
14825 dealing with other kinds of frozen message, see &%auto_thaw%& and
14826 &%timeout_frozen_after%&.
14827
14828
14829 .option ignore_fromline_hosts main "host list&!!" unset
14830 .cindex "&""From""& line"
14831 .cindex "UUCP" "&""From""& line"
14832 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14833 the headers of a message. By default this is treated as the start of the
14834 message's body, which means that any following headers are not recognized as
14835 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14836 match those hosts that insist on sending it. If the sender is actually a local
14837 process rather than a remote host, and is using &%-bs%& to inject the messages,
14838 &%ignore_fromline_local%& must be set to achieve this effect.
14839
14840
14841 .option ignore_fromline_local main boolean false
14842 See &%ignore_fromline_hosts%& above.
14843
14844
14845 .option keep_malformed main time 4d
14846 This option specifies the length of time to keep messages whose spool files
14847 have been corrupted in some way. This should, of course, never happen. At the
14848 next attempt to deliver such a message, it gets removed. The incident is
14849 logged.
14850
14851
14852 .option ldap_ca_cert_dir main string unset
14853 .cindex "LDAP", "TLS CA certificate directory"
14854 This option indicates which directory contains CA certificates for verifying
14855 a TLS certificate presented by an LDAP server.
14856 While Exim does not provide a default value, your SSL library may.
14857 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14858 and constrained to be a directory.
14859
14860
14861 .option ldap_ca_cert_file main string unset
14862 .cindex "LDAP", "TLS CA certificate file"
14863 This option indicates which file contains CA certificates for verifying
14864 a TLS certificate presented by an LDAP server.
14865 While Exim does not provide a default value, your SSL library may.
14866 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14867 and constrained to be a file.
14868
14869
14870 .option ldap_cert_file main string unset
14871 .cindex "LDAP" "TLS client certificate file"
14872 This option indicates which file contains an TLS client certificate which
14873 Exim should present to the LDAP server during TLS negotiation.
14874 Should be used together with &%ldap_cert_key%&.
14875
14876
14877 .option ldap_cert_key main string unset
14878 .cindex "LDAP" "TLS client key file"
14879 This option indicates which file contains the secret/private key to use
14880 to prove identity to the LDAP server during TLS negotiation.
14881 Should be used together with &%ldap_cert_file%&, which contains the
14882 identity to be proven.
14883
14884
14885 .option ldap_cipher_suite main string unset
14886 .cindex "LDAP" "TLS cipher suite"
14887 This controls the TLS cipher-suite negotiation during TLS negotiation with
14888 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14889 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14890
14891
14892 .option ldap_default_servers main "string list" unset
14893 .cindex "LDAP" "default servers"
14894 This option provides a list of LDAP servers which are tried in turn when an
14895 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14896 details of LDAP queries. This option is available only when Exim has been built
14897 with LDAP support.
14898
14899
14900 .option ldap_require_cert main string unset.
14901 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14902 This should be one of the values "hard", "demand", "allow", "try" or "never".
14903 A value other than one of these is interpreted as "never".
14904 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14905 Although Exim does not set a default, the LDAP library probably defaults
14906 to hard/demand.
14907
14908
14909 .option ldap_start_tls main boolean false
14910 .cindex "LDAP" "whether or not to negotiate TLS"
14911 If set, Exim will attempt to negotiate TLS with the LDAP server when
14912 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14913 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14914 of SSL-on-connect.
14915 In the event of failure to negotiate TLS, the action taken is controlled
14916 by &%ldap_require_cert%&.
14917
14918
14919 .option ldap_version main integer unset
14920 .cindex "LDAP" "protocol version, forcing"
14921 This option can be used to force Exim to set a specific protocol version for
14922 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14923 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14924 the LDAP headers; otherwise it is 2. This option is available only when Exim
14925 has been built with LDAP support.
14926
14927
14928
14929 .option local_from_check main boolean true
14930 .cindex "&'Sender:'& header line" "disabling addition of"
14931 .cindex "&'From:'& header line" "disabling checking of"
14932 When a message is submitted locally (that is, not over a TCP/IP connection) by
14933 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14934 checks that the &'From:'& header line matches the login of the calling user and
14935 the domain specified by &%qualify_domain%&.
14936
14937 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14938 locally submitted message is automatically qualified by Exim, unless the
14939 &%-bnq%& command line option is used.
14940
14941 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14942 on the local part. If the &'From:'& header line does not match, Exim adds a
14943 &'Sender:'& header with an address constructed from the calling user's login
14944 and the default qualify domain.
14945
14946 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14947 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14948 &'Sender:'& header lines supplied by untrusted users, you must also set
14949 &%local_sender_retain%& to be true.
14950
14951 .cindex "envelope sender"
14952 These options affect only the header lines in the message. The envelope sender
14953 is still forced to be the login id at the qualify domain unless
14954 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14955
14956 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14957 request similar header line checking. See section &<<SECTthesenhea>>&, which
14958 has more details about &'Sender:'& processing.
14959
14960
14961
14962
14963 .option local_from_prefix main string unset
14964 When Exim checks the &'From:'& header line of locally submitted messages for
14965 matching the login id (see &%local_from_check%& above), it can be configured to
14966 ignore certain prefixes and suffixes in the local part of the address. This is
14967 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14968 appropriate lists, in the same form as the &%local_part_prefix%& and
14969 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14970 example, if
14971 .code
14972 local_from_prefix = *-
14973 .endd
14974 is set, a &'From:'& line containing
14975 .code
14976 From: anything-user@your.domain.example
14977 .endd
14978 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14979 matches the actual sender address that is constructed from the login name and
14980 qualify domain.
14981
14982
14983 .option local_from_suffix main string unset
14984 See &%local_from_prefix%& above.
14985
14986
14987 .option local_interfaces main "string list" "see below"
14988 This option controls which network interfaces are used by the daemon for
14989 listening; they are also used to identify the local host when routing. Chapter
14990 &<<CHAPinterfaces>>& contains a full description of this option and the related
14991 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14992 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14993 &%local_interfaces%& is
14994 .code
14995 local_interfaces = 0.0.0.0
14996 .endd
14997 when Exim is built without IPv6 support; otherwise it is
14998 .code
14999 local_interfaces = <; ::0 ; 0.0.0.0
15000 .endd
15001
15002 .option local_scan_timeout main time 5m
15003 .cindex "timeout" "for &[local_scan()]& function"
15004 .cindex "&[local_scan()]& function" "timeout"
15005 This timeout applies to the &[local_scan()]& function (see chapter
15006 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15007 the incoming message is rejected with a temporary error if it is an SMTP
15008 message. For a non-SMTP message, the message is dropped and Exim ends with a
15009 non-zero code. The incident is logged on the main and reject logs.
15010
15011
15012
15013 .option local_sender_retain main boolean false
15014 .cindex "&'Sender:'& header line" "retaining from local submission"
15015 When a message is submitted locally (that is, not over a TCP/IP connection) by
15016 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15017 do not want this to happen, you must set &%local_sender_retain%&, and you must
15018 also set &%local_from_check%& to be false (Exim will complain if you do not).
15019 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15020 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15021
15022
15023
15024
15025 .option localhost_number main string&!! unset
15026 .cindex "host" "locally unique number for"
15027 .cindex "message ids" "with multiple hosts"
15028 .vindex "&$localhost_number$&"
15029 Exim's message ids are normally unique only within the local host. If
15030 uniqueness among a set of hosts is required, each host must set a different
15031 value for the &%localhost_number%& option. The string is expanded immediately
15032 after reading the configuration file (so that a number can be computed from the
15033 host name, for example) and the result of the expansion must be a number in the
15034 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15035 systems). This is available in subsequent string expansions via the variable
15036 &$localhost_number$&. When &%localhost_number is set%&, the final two
15037 characters of the message id, instead of just being a fractional part of the
15038 time, are computed from the time and the local host number as described in
15039 section &<<SECTmessiden>>&.
15040
15041
15042
15043 .option log_file_path main "string list&!!" "set at compile time"
15044 .cindex "log" "file path for"
15045 This option sets the path which is used to determine the names of Exim's log
15046 files, or indicates that logging is to be to syslog, or both. It is expanded
15047 when Exim is entered, so it can, for example, contain a reference to the host
15048 name. If no specific path is set for the log files at compile or run time,
15049 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15050 they are written in a sub-directory called &_log_& in Exim's spool directory.
15051 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15052 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15053 used. If this string is fixed at your installation (contains no expansion
15054 variables) it is recommended that you do not set this option in the
15055 configuration file, but instead supply the path using LOG_FILE_PATH in
15056 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15057 early on &-- in particular, failure to read the configuration file.
15058
15059
15060 .option log_selector main string unset
15061 .cindex "log" "selectors"
15062 This option can be used to reduce or increase the number of things that Exim
15063 writes to its log files. Its argument is made up of names preceded by plus or
15064 minus characters. For example:
15065 .code
15066 log_selector = +arguments -retry_defer
15067 .endd
15068 A list of possible names and what they control is given in the chapter on
15069 logging, in section &<<SECTlogselector>>&.
15070
15071
15072 .option log_timezone main boolean false
15073 .cindex "log" "timezone for entries"
15074 .vindex "&$tod_log$&"
15075 .vindex "&$tod_zone$&"
15076 By default, the timestamps on log lines are in local time without the
15077 timezone. This means that if your timezone changes twice a year, the timestamps
15078 in log lines are ambiguous for an hour when the clocks go back. One way of
15079 avoiding this problem is to set the timezone to UTC. An alternative is to set
15080 &%log_timezone%& true. This turns on the addition of the timezone offset to
15081 timestamps in log lines. Turning on this option can add quite a lot to the size
15082 of log files because each line is extended by 6 characters. Note that the
15083 &$tod_log$& variable contains the log timestamp without the zone, but there is
15084 another variable called &$tod_zone$& that contains just the timezone offset.
15085
15086
15087 .option lookup_open_max main integer 25
15088 .cindex "too many open files"
15089 .cindex "open files, too many"
15090 .cindex "file" "too many open"
15091 .cindex "lookup" "maximum open files"
15092 .cindex "limit" "open files for lookups"
15093 This option limits the number of simultaneously open files for single-key
15094 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15095 Exim normally keeps these files open during routing, because often the same
15096 file is required several times. If the limit is reached, Exim closes the least
15097 recently used file. Note that if you are using the &'ndbm'& library, it
15098 actually opens two files for each logical DBM database, though it still counts
15099 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15100 open files"& errors with NDBM, you need to reduce the value of
15101 &%lookup_open_max%&.
15102
15103
15104 .option max_username_length main integer 0
15105 .cindex "length of login name"
15106 .cindex "user name" "maximum length"
15107 .cindex "limit" "user name length"
15108 Some operating systems are broken in that they truncate long arguments to
15109 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15110 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15111 an argument that is longer behaves as if &[getpwnam()]& failed.
15112
15113
15114 .option message_body_newlines main bool false
15115 .cindex "message body" "newlines in variables"
15116 .cindex "newline" "in message body variables"
15117 .vindex "&$message_body$&"
15118 .vindex "&$message_body_end$&"
15119 By default, newlines in the message body are replaced by spaces when setting
15120 the &$message_body$& and &$message_body_end$& expansion variables. If this
15121 option is set true, this no longer happens.
15122
15123
15124 .option message_body_visible main integer 500
15125 .cindex "body of message" "visible size"
15126 .cindex "message body" "visible size"
15127 .vindex "&$message_body$&"
15128 .vindex "&$message_body_end$&"
15129 This option specifies how much of a message's body is to be included in the
15130 &$message_body$& and &$message_body_end$& expansion variables.
15131
15132
15133 .option message_id_header_domain main string&!! unset
15134 .cindex "&'Message-ID:'& header line"
15135 If this option is set, the string is expanded and used as the right hand side
15136 (domain) of the &'Message-ID:'& header that Exim creates if a
15137 locally-originated incoming message does not have one. &"Locally-originated"&
15138 means &"not received over TCP/IP."&
15139 Otherwise, the primary host name is used.
15140 Only letters, digits, dot and hyphen are accepted; any other characters are
15141 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15142 empty string, the option is ignored.
15143
15144
15145 .option message_id_header_text main string&!! unset
15146 If this variable is set, the string is expanded and used to augment the text of
15147 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15148 message does not have one. The text of this header is required by RFC 2822 to
15149 take the form of an address. By default, Exim uses its internal message id as
15150 the local part, and the primary host name as the domain. If this option is set,
15151 it is expanded, and provided the expansion is not forced to fail, and does not
15152 yield an empty string, the result is inserted into the header immediately
15153 before the @, separated from the internal message id by a dot. Any characters
15154 that are illegal in an address are automatically converted into hyphens. This
15155 means that variables such as &$tod_log$& can be used, because the spaces and
15156 colons will become hyphens.
15157
15158
15159 .option message_logs main boolean true
15160 .cindex "message logs" "disabling"
15161 .cindex "log" "message log; disabling"
15162 If this option is turned off, per-message log files are not created in the
15163 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15164 Exim, by reducing the number of files involved in handling a message from a
15165 minimum of four (header spool file, body spool file, delivery journal, and
15166 per-message log) to three. The other major I/O activity is Exim's main log,
15167 which is not affected by this option.
15168
15169
15170 .option message_size_limit main string&!! 50M
15171 .cindex "message" "size limit"
15172 .cindex "limit" "message size"
15173 .cindex "size" "of message, limit"
15174 This option limits the maximum size of message that Exim will process. The
15175 value is expanded for each incoming connection so, for example, it can be made
15176 to depend on the IP address of the remote host for messages arriving via
15177 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15178 optionally followed by K or M.
15179
15180 &*Note*&: This limit cannot be made to depend on a message's sender or any
15181 other properties of an individual message, because it has to be advertised in
15182 the server's response to EHLO. String expansion failure causes a temporary
15183 error. A value of zero means no limit, but its use is not recommended. See also
15184 &%bounce_return_size_limit%&.
15185
15186 Incoming SMTP messages are failed with a 552 error if the limit is
15187 exceeded; locally-generated messages either get a stderr message or a delivery
15188 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15189 an oversized message is logged in both the main and the reject logs. See also
15190 the generic transport option &%message_size_limit%&, which limits the size of
15191 message that an individual transport can process.
15192
15193 If you use a virus-scanner and set this option to to a value larger than the
15194 maximum size that your virus-scanner is configured to support, you may get
15195 failures triggered by large mails.  The right size to configure for the
15196 virus-scanner depends upon what data is passed and the options in use but it's
15197 probably safest to just set it to a little larger than this value.  E.g., with a
15198 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15199 some problems may result.
15200
15201 A value of 0 will disable size limit checking; Exim will still advertise the
15202 SIZE extension in an EHLO response, but without a limit, so as to permit
15203 SMTP clients to still indicate the message size along with the MAIL verb.
15204
15205
15206 .option move_frozen_messages main boolean false
15207 .cindex "frozen messages" "moving"
15208 This option, which is available only if Exim has been built with the setting
15209 .code
15210 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15211 .endd
15212 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15213 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15214 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15215 standard utilities for handling such moved messages, and they do not show up in
15216 lists generated by &%-bp%& or by the Exim monitor.
15217
15218
15219 .option mua_wrapper main boolean false
15220 Setting this option true causes Exim to run in a very restrictive mode in which
15221 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15222 contains a full description of this facility.
15223
15224
15225
15226 .option mysql_servers main "string list" unset
15227 .cindex "MySQL" "server list"
15228 This option provides a list of MySQL servers and associated connection data, to
15229 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15230 option is available only if Exim has been built with MySQL support.
15231
15232
15233 .option never_users main "string list&!!" unset
15234 This option is expanded just once, at the start of Exim's processing. Local
15235 message deliveries are normally run in processes that are setuid to the
15236 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15237 It is usually desirable to prevent any deliveries from running as root, as a
15238 safety precaution.
15239
15240 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15241 list of users that must not be used for local deliveries. This list is fixed in
15242 the binary and cannot be overridden by the configuration file. By default, it
15243 contains just the single user name &"root"&. The &%never_users%& runtime option
15244 can be used to add more users to the fixed list.
15245
15246 If a message is to be delivered as one of the users on the fixed list or the
15247 &%never_users%& list, an error occurs, and delivery is deferred. A common
15248 example is
15249 .code
15250 never_users = root:daemon:bin
15251 .endd
15252 Including root is redundant if it is also on the fixed list, but it does no
15253 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15254 transport driver.
15255
15256
15257 .option openssl_options main "string list" "+no_sslv2"
15258 .cindex "OpenSSL "compatibility options"
15259 This option allows an administrator to adjust the SSL options applied
15260 by OpenSSL to connections.  It is given as a space-separated list of items,
15261 each one to be +added or -subtracted from the current value.
15262
15263 This option is only available if Exim is built against OpenSSL.  The values
15264 available for this option vary according to the age of your OpenSSL install.
15265 The &"all"& value controls a subset of flags which are available, typically
15266 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15267 list the values known on your system and Exim should support all the
15268 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15269 names lose the leading &"SSL_OP_"& and are lower-cased.
15270
15271 Note that adjusting the options can have severe impact upon the security of
15272 SSL as used by Exim.  It is possible to disable safety checks and shoot
15273 yourself in the foot in various unpleasant ways.  This option should not be
15274 adjusted lightly.  An unrecognised item will be detected at startup, by
15275 invoking Exim with the &%-bV%& flag.
15276
15277 The option affects Exim operating both as a server and as a client.
15278
15279 Historical note: prior to release 4.80, Exim defaulted this value to
15280 "+dont_insert_empty_fragments", which may still be needed for compatibility
15281 with some clients, but which lowers security by increasing exposure to
15282 some now infamous attacks.
15283
15284 Examples:
15285 .code
15286 # Make both old MS and old Eudora happy:
15287 openssl_options = -all +microsoft_big_sslv3_buffer \
15288                        +dont_insert_empty_fragments
15289
15290 # Disable older protocol versions:
15291 openssl_options = +no_sslv2 +no_sslv3
15292 .endd
15293
15294 Possible options may include:
15295 .ilist
15296 &`all`&
15297 .next
15298 &`allow_unsafe_legacy_renegotiation`&
15299 .next
15300 &`cipher_server_preference`&
15301 .next
15302 &`dont_insert_empty_fragments`&
15303 .next
15304 &`ephemeral_rsa`&
15305 .next
15306 &`legacy_server_connect`&
15307 .next
15308 &`microsoft_big_sslv3_buffer`&
15309 .next
15310 &`microsoft_sess_id_bug`&
15311 .next
15312 &`msie_sslv2_rsa_padding`&
15313 .next
15314 &`netscape_challenge_bug`&
15315 .next
15316 &`netscape_reuse_cipher_change_bug`&
15317 .next
15318 &`no_compression`&
15319 .next
15320 &`no_session_resumption_on_renegotiation`&
15321 .next
15322 &`no_sslv2`&
15323 .next
15324 &`no_sslv3`&
15325 .next
15326 &`no_ticket`&
15327 .next
15328 &`no_tlsv1`&
15329 .next
15330 &`no_tlsv1_1`&
15331 .next
15332 &`no_tlsv1_2`&
15333 .next
15334 &`safari_ecdhe_ecdsa_bug`&
15335 .next
15336 &`single_dh_use`&
15337 .next
15338 &`single_ecdh_use`&
15339 .next
15340 &`ssleay_080_client_dh_bug`&
15341 .next
15342 &`sslref2_reuse_cert_type_bug`&
15343 .next
15344 &`tls_block_padding_bug`&
15345 .next
15346 &`tls_d5_bug`&
15347 .next
15348 &`tls_rollback_bug`&
15349 .endlist
15350
15351 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15352 all clients connecting using the MacOS SecureTransport TLS facility prior
15353 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15354 to negotiate TLS then this option value might help, provided that your OpenSSL
15355 release is new enough to contain this work-around.  This may be a situation
15356 where you have to upgrade OpenSSL to get buggy clients working.
15357
15358
15359 .option oracle_servers main "string list" unset
15360 .cindex "Oracle" "server list"
15361 This option provides a list of Oracle servers and associated connection data,
15362 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15363 The option is available only if Exim has been built with Oracle support.
15364
15365
15366 .option percent_hack_domains main "domain list&!!" unset
15367 .cindex "&""percent hack""&"
15368 .cindex "source routing" "in email address"
15369 .cindex "address" "source-routed"
15370 The &"percent hack"& is the convention whereby a local part containing a
15371 percent sign is re-interpreted as a new email address, with the percent
15372 replaced by @. This is sometimes called &"source routing"&, though that term is
15373 also applied to RFC 2822 addresses that begin with an @ character. If this
15374 option is set, Exim implements the percent facility for those domains listed,
15375 but no others. This happens before an incoming SMTP address is tested against
15376 an ACL.
15377
15378 &*Warning*&: The &"percent hack"& has often been abused by people who are
15379 trying to get round relaying restrictions. For this reason, it is best avoided
15380 if at all possible. Unfortunately, a number of less security-conscious MTAs
15381 implement it unconditionally. If you are running Exim on a gateway host, and
15382 routing mail through to internal MTAs without processing the local parts, it is
15383 a good idea to reject recipient addresses with percent characters in their
15384 local parts. Exim's default configuration does this.
15385
15386
15387 .option perl_at_start main boolean false
15388 This option is available only when Exim is built with an embedded Perl
15389 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15390
15391
15392 .option perl_startup main string unset
15393 This option is available only when Exim is built with an embedded Perl
15394 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15395
15396
15397 .option pgsql_servers main "string list" unset
15398 .cindex "PostgreSQL lookup type" "server list"
15399 This option provides a list of PostgreSQL servers and associated connection
15400 data, to be used in conjunction with &(pgsql)& lookups (see section
15401 &<<SECID72>>&). The option is available only if Exim has been built with
15402 PostgreSQL support.
15403
15404
15405 .option pid_file_path main string&!! "set at compile time"
15406 .cindex "daemon" "pid file path"
15407 .cindex "pid file, path for"
15408 This option sets the name of the file to which the Exim daemon writes its
15409 process id. The string is expanded, so it can contain, for example, references
15410 to the host name:
15411 .code
15412 pid_file_path = /var/log/$primary_hostname/exim.pid
15413 .endd
15414 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15415 spool directory.
15416 The value set by the option can be overridden by the &%-oP%& command line
15417 option. A pid file is not written if a &"non-standard"& daemon is run by means
15418 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15419
15420
15421 .option pipelining_advertise_hosts main "host list&!!" *
15422 .cindex "PIPELINING" "suppressing advertising"
15423 This option can be used to suppress the advertisement of the SMTP
15424 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15425 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15426 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15427 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15428 that clients will use it; &"out of order"& commands that are &"expected"& do
15429 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15430
15431
15432 .option prdr_enable main boolean false
15433 .cindex "PRDR" "enabling on server"
15434 This option can be used to enable the Per-Recipient Data Response extension
15435 to SMTP, defined by Eric Hall.
15436 If the option is set, PRDR is advertised by Exim when operating as a server.
15437 If the client requests PRDR, and more than one recipient, for a message
15438 an additional ACL is called for each recipient after the message content
15439 is received.  See section &<<SECTPRDRACL>>&.
15440
15441 .option preserve_message_logs main boolean false
15442 .cindex "message logs" "preserving"
15443 If this option is set, message log files are not deleted when messages are
15444 completed. Instead, they are moved to a sub-directory of the spool directory
15445 called &_msglog.OLD_&, where they remain available for statistical or debugging
15446 purposes. This is a dangerous option to set on systems with any appreciable
15447 volume of mail. Use with care!
15448
15449
15450 .option primary_hostname main string "see below"
15451 .cindex "name" "of local host"
15452 .cindex "host" "name of local"
15453 .cindex "local host" "name of"
15454 .vindex "&$primary_hostname$&"
15455 This specifies the name of the current host. It is used in the default EHLO or
15456 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15457 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15458 The value is also used by default in some SMTP response messages from an Exim
15459 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15460
15461 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15462 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15463 contains only one component, Exim passes it to &[gethostbyname()]& (or
15464 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15465 version. The variable &$primary_hostname$& contains the host name, whether set
15466 explicitly by this option, or defaulted.
15467
15468
15469 .option print_topbitchars main boolean false
15470 .cindex "printing characters"
15471 .cindex "8-bit characters"
15472 By default, Exim considers only those characters whose codes lie in the range
15473 32&--126 to be printing characters. In a number of circumstances (for example,
15474 when writing log entries) non-printing characters are converted into escape
15475 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15476 is set, code values of 128 and above are also considered to be printing
15477 characters.
15478
15479 This option also affects the header syntax checks performed by the
15480 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15481 the user's full name when constructing From: and Sender: addresses (as
15482 described in section &<<SECTconstr>>&). Setting this option can cause
15483 Exim to generate eight bit message headers that do not conform to the
15484 standards.
15485
15486
15487 .option process_log_path main string unset
15488 .cindex "process log path"
15489 .cindex "log" "process log"
15490 .cindex "&'exiwhat'&"
15491 This option sets the name of the file to which an Exim process writes its
15492 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15493 utility script. If this option is unset, the file called &_exim-process.info_&
15494 in Exim's spool directory is used. The ability to specify the name explicitly
15495 can be useful in environments where two different Exims are running, using
15496 different spool directories.
15497
15498
15499 .option prod_requires_admin main boolean true
15500 .oindex "&%-M%&"
15501 .oindex "&%-R%&"
15502 .oindex "&%-q%&"
15503 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15504 admin user unless &%prod_requires_admin%& is set false. See also
15505 &%queue_list_requires_admin%&.
15506
15507
15508 .option qualify_domain main string "see below"
15509 .cindex "domain" "for qualifying addresses"
15510 .cindex "address" "qualification"
15511 This option specifies the domain name that is added to any envelope sender
15512 addresses that do not have a domain qualification. It also applies to
15513 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15514 are accepted by default only for locally-generated messages. Qualification is
15515 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15516 locally-generated messages, unless the &%-bnq%& command line option is used.
15517
15518 Messages from external sources must always contain fully qualified addresses,
15519 unless the sending host matches &%sender_unqualified_hosts%& or
15520 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15521 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15522 necessary. Internally, Exim always works with fully qualified envelope
15523 addresses. If &%qualify_domain%& is not set, it defaults to the
15524 &%primary_hostname%& value.
15525
15526
15527 .option qualify_recipient main string "see below"
15528 This option allows you to specify a different domain for qualifying recipient
15529 addresses to the one that is used for senders. See &%qualify_domain%& above.
15530
15531
15532
15533 .option queue_domains main "domain list&!!" unset
15534 .cindex "domain" "specifying non-immediate delivery"
15535 .cindex "queueing incoming messages"
15536 .cindex "message" "queueing certain domains"
15537 This option lists domains for which immediate delivery is not required.
15538 A delivery process is started whenever a message is received, but only those
15539 domains that do not match are processed. All other deliveries wait until the
15540 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15541
15542
15543 .option queue_list_requires_admin main boolean true
15544 .oindex "&%-bp%&"
15545 The &%-bp%& command-line option, which lists the messages that are on the
15546 queue, requires the caller to be an admin user unless
15547 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15548
15549
15550 .option queue_only main boolean false
15551 .cindex "queueing incoming messages"
15552 .cindex "message" "queueing unconditionally"
15553 If &%queue_only%& is set, a delivery process is not automatically started
15554 whenever a message is received. Instead, the message waits on the queue for the
15555 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15556 delivered immediately when certain conditions (such as heavy load) occur.
15557
15558 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15559 and &%-odi%& command line options override &%queue_only%& unless
15560 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15561 &%queue_only_load%&, and &%smtp_accept_queue%&.
15562
15563
15564 .option queue_only_file main string unset
15565 .cindex "queueing incoming messages"
15566 .cindex "message" "queueing by file existence"
15567 This option can be set to a colon-separated list of absolute path names, each
15568 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15569 it tests for the existence of each listed path using a call to &[stat()]&. For
15570 each path that exists, the corresponding queueing option is set.
15571 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15572 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15573 .code
15574 queue_only_file = smtp/some/file
15575 .endd
15576 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15577 &_/some/file_& exists.
15578
15579
15580 .option queue_only_load main fixed-point unset
15581 .cindex "load average"
15582 .cindex "queueing incoming messages"
15583 .cindex "message" "queueing by load"
15584 If the system load average is higher than this value, incoming messages from
15585 all sources are queued, and no automatic deliveries are started. If this
15586 happens during local or remote SMTP input, all subsequent messages received on
15587 the same SMTP connection are queued by default, whatever happens to the load in
15588 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15589 false.
15590
15591 Deliveries will subsequently be performed by queue runner processes. This
15592 option has no effect on ancient operating systems on which Exim cannot
15593 determine the load average. See also &%deliver_queue_load_max%& and
15594 &%smtp_load_reserve%&.
15595
15596
15597 .option queue_only_load_latch main boolean true
15598 .cindex "load average" "re-evaluating per message"
15599 When this option is true (the default), once one message has been queued
15600 because the load average is higher than the value set by &%queue_only_load%&,
15601 all subsequent messages received on the same SMTP connection are also queued.
15602 This is a deliberate choice; even though the load average may fall below the
15603 threshold, it doesn't seem right to deliver later messages on the same
15604 connection when not delivering earlier ones. However, there are special
15605 circumstances such as very long-lived connections from scanning appliances
15606 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15607 should be set false. This causes the value of the load average to be
15608 re-evaluated for each message.
15609
15610
15611 .option queue_only_override main boolean true
15612 .cindex "queueing incoming messages"
15613 When this option is true, the &%-od%&&'x'& command line options override the
15614 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15615 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15616 to override; they are accepted, but ignored.
15617
15618
15619 .option queue_run_in_order main boolean false
15620 .cindex "queue runner" "processing messages in order"
15621 If this option is set, queue runs happen in order of message arrival instead of
15622 in an arbitrary order. For this to happen, a complete list of the entire queue
15623 must be set up before the deliveries start. When the queue is all held in a
15624 single directory (the default), a single list is created for both the ordered
15625 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15626 single list is not created when &%queue_run_in_order%& is false. In this case,
15627 the sub-directories are processed one at a time (in a random order), and this
15628 avoids setting up one huge list for the whole queue. Thus, setting
15629 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15630 when the queue is large, because of the extra work in setting up the single,
15631 large list. In most situations, &%queue_run_in_order%& should not be set.
15632
15633
15634
15635 .option queue_run_max main integer 5
15636 .cindex "queue runner" "maximum number of"
15637 This controls the maximum number of queue runner processes that an Exim daemon
15638 can run simultaneously. This does not mean that it starts them all at once,
15639 but rather that if the maximum number are still running when the time comes to
15640 start another one, it refrains from starting another one. This can happen with
15641 very large queues and/or very sluggish deliveries. This option does not,
15642 however, interlock with other processes, so additional queue runners can be
15643 started by other means, or by killing and restarting the daemon.
15644
15645 Setting this option to zero does not suppress queue runs; rather, it disables
15646 the limit, allowing any number of simultaneous queue runner processes to be
15647 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15648 the daemon's command line.
15649
15650 .option queue_smtp_domains main "domain list&!!" unset
15651 .cindex "queueing incoming messages"
15652 .cindex "message" "queueing remote deliveries"
15653 When this option is set, a delivery process is started whenever a message is
15654 received, routing is performed, and local deliveries take place.
15655 However, if any SMTP deliveries are required for domains that match
15656 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15657 message waits on the queue for the next queue run. Since routing of the message
15658 has taken place, Exim knows to which remote hosts it must be delivered, and so
15659 when the queue run happens, multiple messages for the same host are delivered
15660 over a single SMTP connection. The &%-odqs%& command line option causes all
15661 SMTP deliveries to be queued in this way, and is equivalent to setting
15662 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15663 &%queue_domains%&.
15664
15665
15666 .option receive_timeout main time 0s
15667 .cindex "timeout" "for non-SMTP input"
15668 This option sets the timeout for accepting a non-SMTP message, that is, the
15669 maximum time that Exim waits when reading a message on the standard input. If
15670 the value is zero, it will wait for ever. This setting is overridden by the
15671 &%-or%& command line option. The timeout for incoming SMTP messages is
15672 controlled by &%smtp_receive_timeout%&.
15673
15674 .option received_header_text main string&!! "see below"
15675 .cindex "customizing" "&'Received:'& header"
15676 .cindex "&'Received:'& header line" "customizing"
15677 This string defines the contents of the &'Received:'& message header that is
15678 added to each message, except for the timestamp, which is automatically added
15679 on at the end (preceded by a semicolon). The string is expanded each time it is
15680 used. If the expansion yields an empty string, no &'Received:'& header line is
15681 added to the message. Otherwise, the string should start with the text
15682 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15683 header lines. The default setting is:
15684
15685 .code
15686 received_header_text = Received: \
15687   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15688   {${if def:sender_ident \
15689   {from ${quote_local_part:$sender_ident} }}\
15690   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15691   by $primary_hostname \
15692   ${if def:received_protocol {with $received_protocol}} \
15693   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15694   (Exim $version_number)\n\t\
15695   ${if def:sender_address \
15696   {(envelope-from <$sender_address>)\n\t}}\
15697   id $message_exim_id\
15698   ${if def:received_for {\n\tfor $received_for}}
15699 .endd
15700
15701 The reference to the TLS cipher is omitted when Exim is built without TLS
15702 support. The use of conditional expansions ensures that this works for both
15703 locally generated messages and messages received from remote hosts, giving
15704 header lines such as the following:
15705 .code
15706 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15707 by marley.carol.example with esmtp (Exim 4.00)
15708 (envelope-from <bob@carol.example>)
15709 id 16IOWa-00019l-00
15710 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15711 Received: by scrooge.carol.example with local (Exim 4.00)
15712 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15713 .endd
15714 Until the body of the message has been received, the timestamp is the time when
15715 the message started to be received. Once the body has arrived, and all policy
15716 checks have taken place, the timestamp is updated to the time at which the
15717 message was accepted.
15718
15719
15720 .option received_headers_max main integer 30
15721 .cindex "loop" "prevention"
15722 .cindex "mail loop prevention"
15723 .cindex "&'Received:'& header line" "counting"
15724 When a message is to be delivered, the number of &'Received:'& headers is
15725 counted, and if it is greater than this parameter, a mail loop is assumed to
15726 have occurred, the delivery is abandoned, and an error message is generated.
15727 This applies to both local and remote deliveries.
15728
15729
15730 .option recipient_unqualified_hosts main "host list&!!" unset
15731 .cindex "unqualified addresses"
15732 .cindex "host" "unqualified addresses from"
15733 This option lists those hosts from which Exim is prepared to accept unqualified
15734 recipient addresses in message envelopes. The addresses are made fully
15735 qualified by the addition of the &%qualify_recipient%& value. This option also
15736 affects message header lines. Exim does not reject unqualified recipient
15737 addresses in headers, but it qualifies them only if the message came from a
15738 host that matches &%recipient_unqualified_hosts%&,
15739 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15740 option was not set.
15741
15742
15743 .option recipients_max main integer 0
15744 .cindex "limit" "number of recipients"
15745 .cindex "recipient" "maximum number"
15746 If this option is set greater than zero, it specifies the maximum number of
15747 original recipients for any message. Additional recipients that are generated
15748 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15749 all recipients over the limit; earlier recipients are delivered as normal.
15750 Non-SMTP messages with too many recipients are failed, and no deliveries are
15751 done.
15752
15753 .cindex "RCPT" "maximum number of incoming"
15754 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15755 RCPT commands in a single message.
15756
15757
15758 .option recipients_max_reject main boolean false
15759 If this option is set true, Exim rejects SMTP messages containing too many
15760 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15761 error to the eventual DATA command. Otherwise (the default) it gives a 452
15762 error to the surplus RCPT commands and accepts the message on behalf of the
15763 initial set of recipients. The remote server should then re-send the message
15764 for the remaining recipients at a later time.
15765
15766
15767 .option remote_max_parallel main integer 2
15768 .cindex "delivery" "parallelism for remote"
15769 This option controls parallel delivery of one message to a number of remote
15770 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15771 does all the remote deliveries for a message one by one. Otherwise, if a single
15772 message has to be delivered to more than one remote host, or if several copies
15773 have to be sent to the same remote host, up to &%remote_max_parallel%&
15774 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15775 deliveries are required, the maximum number of processes are started, and as
15776 each one finishes, another is begun. The order of starting processes is the
15777 same as if sequential delivery were being done, and can be controlled by the
15778 &%remote_sort_domains%& option. If parallel delivery takes place while running
15779 with debugging turned on, the debugging output from each delivery process is
15780 tagged with its process id.
15781
15782 This option controls only the maximum number of parallel deliveries for one
15783 message in one Exim delivery process. Because Exim has no central queue
15784 manager, there is no way of controlling the total number of simultaneous
15785 deliveries if the configuration allows a delivery attempt as soon as a message
15786 is received.
15787
15788 .cindex "number of deliveries"
15789 .cindex "delivery" "maximum number of"
15790 If you want to control the total number of deliveries on the system, you
15791 need to set the &%queue_only%& option. This ensures that all incoming messages
15792 are added to the queue without starting a delivery process. Then set up an Exim
15793 daemon to start queue runner processes at appropriate intervals (probably
15794 fairly often, for example, every minute), and limit the total number of queue
15795 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15796 delivers only one message at a time, the maximum number of deliveries that can
15797 then take place at once is &%queue_run_max%& multiplied by
15798 &%remote_max_parallel%&.
15799
15800 If it is purely remote deliveries you want to control, use
15801 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15802 doing the SMTP routing before queueing, so that several messages for the same
15803 host will eventually get delivered down the same connection.
15804
15805
15806 .option remote_sort_domains main "domain list&!!" unset
15807 .cindex "sorting remote deliveries"
15808 .cindex "delivery" "sorting remote"
15809 When there are a number of remote deliveries for a message, they are sorted by
15810 domain into the order given by this list. For example,
15811 .code
15812 remote_sort_domains = *.cam.ac.uk:*.uk
15813 .endd
15814 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15815 then to those in the &%uk%& domain, then to any others.
15816
15817
15818 .option retry_data_expire main time 7d
15819 .cindex "hints database" "data expiry"
15820 This option sets a &"use before"& time on retry information in Exim's hints
15821 database. Any older retry data is ignored. This means that, for example, once a
15822 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15823 past failures.
15824
15825
15826 .option retry_interval_max main time 24h
15827 .cindex "retry" "limit on interval"
15828 .cindex "limit" "on retry interval"
15829 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15830 intervals between delivery attempts for messages that cannot be delivered
15831 straight away. This option sets an overall limit to the length of time between
15832 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15833 the default value.
15834
15835
15836 .option return_path_remove main boolean true
15837 .cindex "&'Return-path:'& header line" "removing"
15838 RFC 2821, section 4.4, states that an SMTP server must insert a
15839 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15840 The &'Return-path:'& header preserves the sender address as received in the
15841 MAIL command. This description implies that this header should not be present
15842 in an incoming message. If &%return_path_remove%& is true, any existing
15843 &'Return-path:'& headers are removed from messages at the time they are
15844 received. Exim's transports have options for adding &'Return-path:'& headers at
15845 the time of delivery. They are normally used only for final local deliveries.
15846
15847
15848 .option return_size_limit main integer 100K
15849 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15850
15851
15852 .option rfc1413_hosts main "host list&!!" @[]
15853 .cindex "RFC 1413"
15854 .cindex "host" "for RFC 1413 calls"
15855 RFC 1413 identification calls are made to any client host which matches
15856 an item in the list.
15857 The default value specifies just this host, being any local interface
15858 for the system.
15859
15860 .option rfc1413_query_timeout main time 0s
15861 .cindex "RFC 1413" "query timeout"
15862 .cindex "timeout" "for RFC 1413 call"
15863 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15864 no RFC 1413 calls are ever made.
15865
15866
15867 .option sender_unqualified_hosts main "host list&!!" unset
15868 .cindex "unqualified addresses"
15869 .cindex "host" "unqualified addresses from"
15870 This option lists those hosts from which Exim is prepared to accept unqualified
15871 sender addresses. The addresses are made fully qualified by the addition of
15872 &%qualify_domain%&. This option also affects message header lines. Exim does
15873 not reject unqualified addresses in headers that contain sender addresses, but
15874 it qualifies them only if the message came from a host that matches
15875 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15876 using TCP/IP), and the &%-bnq%& option was not set.
15877
15878
15879 .option slow_lookup_log main integer 0
15880 .cindex "logging" "slow lookups"
15881 .cindex "dns" "logging slow lookups"
15882 This option controls logging of slow lookups.
15883 If the value is nonzero it is taken as a number of milliseconds
15884 and lookups taking longer than this are logged.
15885 Currently this applies only to DNS lookups.
15886
15887
15888
15889 .option smtp_accept_keepalive main boolean true
15890 .cindex "keepalive" "on incoming connection"
15891 This option controls the setting of the SO_KEEPALIVE option on incoming
15892 TCP/IP socket connections. When set, it causes the kernel to probe idle
15893 connections periodically, by sending packets with &"old"& sequence numbers. The
15894 other end of the connection should send an acknowledgment if the connection is
15895 still okay or a reset if the connection has been aborted. The reason for doing
15896 this is that it has the beneficial effect of freeing up certain types of
15897 connection that can get stuck when the remote host is disconnected without
15898 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15899 hours to detect unreachable hosts.
15900
15901
15902
15903 .option smtp_accept_max main integer 20
15904 .cindex "limit" "incoming SMTP connections"
15905 .cindex "SMTP" "incoming connection count"
15906 .cindex "inetd"
15907 This option specifies the maximum number of simultaneous incoming SMTP calls
15908 that Exim will accept. It applies only to the listening daemon; there is no
15909 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15910 value is set to zero, no limit is applied. However, it is required to be
15911 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15912 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15913
15914 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15915 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15916 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15917 and &%smtp_load_reserve%& are then checked before accepting the connection.
15918
15919
15920 .option smtp_accept_max_nonmail main integer 10
15921 .cindex "limit" "non-mail SMTP commands"
15922 .cindex "SMTP" "limiting non-mail commands"
15923 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15924 the connection if there are too many. This option defines &"too many"&. The
15925 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15926 client looping sending EHLO, for example. The check is applied only if the
15927 client host matches &%smtp_accept_max_nonmail_hosts%&.
15928
15929 When a new message is expected, one occurrence of RSET is not counted. This
15930 allows a client to send one RSET between messages (this is not necessary,
15931 but some clients do it). Exim also allows one uncounted occurrence of HELO
15932 or EHLO, and one occurrence of STARTTLS between messages. After
15933 starting up a TLS session, another EHLO is expected, and so it too is not
15934 counted. The first occurrence of AUTH in a connection, or immediately
15935 following STARTTLS is not counted. Otherwise, all commands other than
15936 MAIL, RCPT, DATA, and QUIT are counted.
15937
15938
15939 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15940 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15941 check by setting this option. The default value makes it apply to all hosts. By
15942 changing the value, you can exclude any badly-behaved hosts that you have to
15943 live with.
15944
15945
15946 . Allow this long option name to split; give it unsplit as a fifth argument
15947 . for the automatic .oindex that is generated by .option.
15948 . We insert " &~&~" which is both pretty nasty visually and results in
15949 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15950 . zero-width-space, which would be nicer visually and results in (at least)
15951 . html that Firefox will split on when it's forced to reflow (rather than
15952 . inserting a horizontal scrollbar).  However, the text is still not
15953 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15954 . the option name to split.
15955
15956 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15957          smtp_accept_max_per_connection
15958 .cindex "SMTP" "limiting incoming message count"
15959 .cindex "limit" "messages per SMTP connection"
15960 The value of this option limits the number of MAIL commands that Exim is
15961 prepared to accept over a single SMTP connection, whether or not each command
15962 results in the transfer of a message. After the limit is reached, a 421
15963 response is given to subsequent MAIL commands. This limit is a safety
15964 precaution against a client that goes mad (incidents of this type have been
15965 seen).
15966
15967
15968 .option smtp_accept_max_per_host main string&!! unset
15969 .cindex "limit" "SMTP connections from one host"
15970 .cindex "host" "limiting SMTP connections from"
15971 This option restricts the number of simultaneous IP connections from a single
15972 host (strictly, from a single IP address) to the Exim daemon. The option is
15973 expanded, to enable different limits to be applied to different hosts by
15974 reference to &$sender_host_address$&. Once the limit is reached, additional
15975 connection attempts from the same host are rejected with error code 421. This
15976 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15977 of zero imposes no limit. If this option is set greater than zero, it is
15978 required that &%smtp_accept_max%& be non-zero.
15979
15980 &*Warning*&: When setting this option you should not use any expansion
15981 constructions that take an appreciable amount of time. The expansion and test
15982 happen in the main daemon loop, in order to reject additional connections
15983 without forking additional processes (otherwise a denial-of-service attack
15984 could cause a vast number or processes to be created). While the daemon is
15985 doing this processing, it cannot accept any other incoming connections.
15986
15987
15988
15989 .option smtp_accept_queue main integer 0
15990 .cindex "SMTP" "incoming connection count"
15991 .cindex "queueing incoming messages"
15992 .cindex "message" "queueing by SMTP connection count"
15993 If the number of simultaneous incoming SMTP connections being handled via the
15994 listening daemon exceeds this value, messages received by SMTP are just placed
15995 on the queue; no delivery processes are started automatically. The count is
15996 fixed at the start of an SMTP connection. It cannot be updated in the
15997 subprocess that receives messages, and so the queueing or not queueing applies
15998 to all messages received in the same connection.
15999
16000 A value of zero implies no limit, and clearly any non-zero value is useful only
16001 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16002 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16003 various &%-od%&&'x'& command line options.
16004
16005
16006 . See the comment on smtp_accept_max_per_connection
16007
16008 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16009          smtp_accept_queue_per_connection
16010 .cindex "queueing incoming messages"
16011 .cindex "message" "queueing by message count"
16012 This option limits the number of delivery processes that Exim starts
16013 automatically when receiving messages via SMTP, whether via the daemon or by
16014 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16015 and the number of messages received in a single SMTP session exceeds this
16016 number, subsequent messages are placed on the queue, but no delivery processes
16017 are started. This helps to limit the number of Exim processes when a server
16018 restarts after downtime and there is a lot of mail waiting for it on other
16019 systems. On large systems, the default should probably be increased, and on
16020 dial-in client systems it should probably be set to zero (that is, disabled).
16021
16022
16023 .option smtp_accept_reserve main integer 0
16024 .cindex "SMTP" "incoming call count"
16025 .cindex "host" "reserved"
16026 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16027 number of SMTP connections that are reserved for connections from the hosts
16028 that are specified in &%smtp_reserve_hosts%&. The value set in
16029 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16030 restricted to this number of connections; the option specifies a minimum number
16031 of connection slots for them, not a maximum. It is a guarantee that this group
16032 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16033 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16034 individual host.
16035
16036 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16037 set to 5, once there are 45 active connections (from any hosts), new
16038 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16039 provided the other criteria for acceptance are met.
16040
16041
16042 .option smtp_active_hostname main string&!! unset
16043 .cindex "host" "name in SMTP responses"
16044 .cindex "SMTP" "host name in responses"
16045 .vindex "&$primary_hostname$&"
16046 This option is provided for multi-homed servers that want to masquerade as
16047 several different hosts. At the start of an incoming SMTP connection, its value
16048 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16049 responses. For example, it is used as domain name in the response to an
16050 incoming HELO or EHLO command.
16051
16052 .vindex "&$smtp_active_hostname$&"
16053 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16054 is saved with any messages that are received. It is therefore available for use
16055 in routers and transports when the message is later delivered.
16056
16057 If this option is unset, or if its expansion is forced to fail, or if the
16058 expansion results in an empty string, the value of &$primary_hostname$& is
16059 used. Other expansion failures cause a message to be written to the main and
16060 panic logs, and the SMTP command receives a temporary error. Typically, the
16061 value of &%smtp_active_hostname%& depends on the incoming interface address.
16062 For example:
16063 .code
16064 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16065   {cox.mydomain}{box.mydomain}}
16066 .endd
16067
16068 Although &$smtp_active_hostname$& is primarily concerned with incoming
16069 messages, it is also used as the default for HELO commands in callout
16070 verification if there is no remote transport from which to obtain a
16071 &%helo_data%& value.
16072
16073 .option smtp_banner main string&!! "see below"
16074 .cindex "SMTP" "welcome banner"
16075 .cindex "banner for SMTP"
16076 .cindex "welcome banner for SMTP"
16077 .cindex "customizing" "SMTP banner"
16078 This string, which is expanded every time it is used, is output as the initial
16079 positive response to an SMTP connection. The default setting is:
16080 .code
16081 smtp_banner = $smtp_active_hostname ESMTP Exim \
16082   $version_number $tod_full
16083 .endd
16084 Failure to expand the string causes a panic error. If you want to create a
16085 multiline response to the initial SMTP connection, use &"\n"& in the string at
16086 appropriate points, but not at the end. Note that the 220 code is not included
16087 in this string. Exim adds it automatically (several times in the case of a
16088 multiline response).
16089
16090
16091 .option smtp_check_spool_space main boolean true
16092 .cindex "checking disk space"
16093 .cindex "disk space, checking"
16094 .cindex "spool directory" "checking space"
16095 When this option is set, if an incoming SMTP session encounters the SIZE
16096 option on a MAIL command, it checks that there is enough space in the
16097 spool directory's partition to accept a message of that size, while still
16098 leaving free the amount specified by &%check_spool_space%& (even if that value
16099 is zero). If there isn't enough space, a temporary error code is returned.
16100
16101
16102 .option smtp_connect_backlog main integer 20
16103 .cindex "connection backlog"
16104 .cindex "SMTP" "connection backlog"
16105 .cindex "backlog of connections"
16106 This option specifies a maximum number of waiting SMTP connections. Exim passes
16107 this value to the TCP/IP system when it sets up its listener. Once this number
16108 of connections are waiting for the daemon's attention, subsequent connection
16109 attempts are refused at the TCP/IP level. At least, that is what the manuals
16110 say; in some circumstances such connection attempts have been observed to time
16111 out instead. For large systems it is probably a good idea to increase the
16112 value (to 50, say). It also gives some protection against denial-of-service
16113 attacks by SYN flooding.
16114
16115
16116 .option smtp_enforce_sync main boolean true
16117 .cindex "SMTP" "synchronization checking"
16118 .cindex "synchronization checking in SMTP"
16119 The SMTP protocol specification requires the client to wait for a response from
16120 the server at certain points in the dialogue. Without PIPELINING these
16121 synchronization points are after every command; with PIPELINING they are
16122 fewer, but they still exist.
16123
16124 Some spamming sites send out a complete set of SMTP commands without waiting
16125 for any response. Exim protects against this by rejecting a message if the
16126 client has sent further input when it should not have. The error response &"554
16127 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16128 for this error cannot be perfect because of transmission delays (unexpected
16129 input may be on its way but not yet received when Exim checks). However, it
16130 does detect many instances.
16131
16132 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16133 If you want to disable the check selectively (for example, only for certain
16134 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16135 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16136
16137
16138
16139 .option smtp_etrn_command main string&!! unset
16140 .cindex "ETRN" "command to be run"
16141 .vindex "&$domain$&"
16142 If this option is set, the given command is run whenever an SMTP ETRN
16143 command is received from a host that is permitted to issue such commands (see
16144 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16145 are independently expanded. The expansion variable &$domain$& is set to the
16146 argument of the ETRN command, and no syntax checking is done on it. For
16147 example:
16148 .code
16149 smtp_etrn_command = /etc/etrn_command $domain \
16150                     $sender_host_address
16151 .endd
16152 A new process is created to run the command, but Exim does not wait for it to
16153 complete. Consequently, its status cannot be checked. If the command cannot be
16154 run, a line is written to the panic log, but the ETRN caller still receives
16155 a 250 success response. Exim is normally running under its own uid when
16156 receiving SMTP, so it is not possible for it to change the uid before running
16157 the command.
16158
16159
16160 .option smtp_etrn_serialize main boolean true
16161 .cindex "ETRN" "serializing"
16162 When this option is set, it prevents the simultaneous execution of more than
16163 one identical command as a result of ETRN in an SMTP connection. See
16164 section &<<SECTETRN>>& for details.
16165
16166
16167 .option smtp_load_reserve main fixed-point unset
16168 .cindex "load average"
16169 If the system load average ever gets higher than this, incoming SMTP calls are
16170 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16171 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16172 the load is over the limit. The option has no effect on ancient operating
16173 systems on which Exim cannot determine the load average. See also
16174 &%deliver_queue_load_max%& and &%queue_only_load%&.
16175
16176
16177
16178 .option smtp_max_synprot_errors main integer 3
16179 .cindex "SMTP" "limiting syntax and protocol errors"
16180 .cindex "limit" "SMTP syntax and protocol errors"
16181 Exim rejects SMTP commands that contain syntax or protocol errors. In
16182 particular, a syntactically invalid email address, as in this command:
16183 .code
16184 RCPT TO:<abc xyz@a.b.c>
16185 .endd
16186 causes immediate rejection of the command, before any other tests are done.
16187 (The ACL cannot be run if there is no valid address to set up for it.) An
16188 example of a protocol error is receiving RCPT before MAIL. If there are
16189 too many syntax or protocol errors in one SMTP session, the connection is
16190 dropped. The limit is set by this option.
16191
16192 .cindex "PIPELINING" "expected errors"
16193 When the PIPELINING extension to SMTP is in use, some protocol errors are
16194 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16195 Exim assumes that PIPELINING will be used if it advertises it (see
16196 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16197 not count towards the limit.
16198
16199
16200
16201 .option smtp_max_unknown_commands main integer 3
16202 .cindex "SMTP" "limiting unknown commands"
16203 .cindex "limit" "unknown SMTP commands"
16204 If there are too many unrecognized commands in an incoming SMTP session, an
16205 Exim server drops the connection. This is a defence against some kinds of abuse
16206 that subvert web
16207 clients
16208 into making connections to SMTP ports; in these circumstances, a number of
16209 non-SMTP command lines are sent first.
16210
16211
16212
16213 .option smtp_ratelimit_hosts main "host list&!!" unset
16214 .cindex "SMTP" "rate limiting"
16215 .cindex "limit" "rate of message arrival"
16216 .cindex "RCPT" "rate limiting"
16217 Some sites find it helpful to be able to limit the rate at which certain hosts
16218 can send them messages, and the rate at which an individual message can specify
16219 recipients.
16220
16221 Exim has two rate-limiting facilities. This section describes the older
16222 facility, which can limit rates within a single connection. The newer
16223 &%ratelimit%& ACL condition can limit rates across all connections. See section
16224 &<<SECTratelimiting>>& for details of the newer facility.
16225
16226 When a host matches &%smtp_ratelimit_hosts%&, the values of
16227 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16228 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16229 respectively. Each option, if set, must contain a set of four comma-separated
16230 values:
16231
16232 .ilist
16233 A threshold, before which there is no rate limiting.
16234 .next
16235 An initial time delay. Unlike other times in Exim, numbers with decimal
16236 fractional parts are allowed here.
16237 .next
16238 A factor by which to increase the delay each time.
16239 .next
16240 A maximum value for the delay. This should normally be less than 5 minutes,
16241 because after that time, the client is liable to timeout the SMTP command.
16242 .endlist
16243
16244 For example, these settings have been used successfully at the site which
16245 first suggested this feature, for controlling mail from their customers:
16246 .code
16247 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16248 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16249 .endd
16250 The first setting specifies delays that are applied to MAIL commands after
16251 two have been received over a single connection. The initial delay is 0.5
16252 seconds, increasing by a factor of 1.05 each time. The second setting applies
16253 delays to RCPT commands when more than four occur in a single message.
16254
16255
16256 .option smtp_ratelimit_mail main string unset
16257 See &%smtp_ratelimit_hosts%& above.
16258
16259
16260 .option smtp_ratelimit_rcpt main string unset
16261 See &%smtp_ratelimit_hosts%& above.
16262
16263
16264 .option smtp_receive_timeout main time&!! 5m
16265 .cindex "timeout" "for SMTP input"
16266 .cindex "SMTP" "input timeout"
16267 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16268 input, including batch SMTP. If a line of input (either an SMTP command or a
16269 data line) is not received within this time, the SMTP connection is dropped and
16270 the message is abandoned.
16271 A line is written to the log containing one of the following messages:
16272 .code
16273 SMTP command timeout on connection from...
16274 SMTP data timeout on connection from...
16275 .endd
16276 The former means that Exim was expecting to read an SMTP command; the latter
16277 means that it was in the DATA phase, reading the contents of a message.
16278
16279 If the first character of the option is a &"$"& the option is
16280 expanded before use and may depend on
16281 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16282
16283
16284 .oindex "&%-os%&"
16285 The value set by this option can be overridden by the
16286 &%-os%& command-line option. A setting of zero time disables the timeout, but
16287 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16288 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16289 timeout is controlled by &%receive_timeout%& and &%-or%&.
16290
16291
16292 .option smtp_reserve_hosts main "host list&!!" unset
16293 This option defines hosts for which SMTP connections are reserved; see
16294 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16295
16296
16297 .option smtp_return_error_details main boolean false
16298 .cindex "SMTP" "details policy failures"
16299 .cindex "policy control" "rejection, returning details"
16300 In the default state, Exim uses bland messages such as
16301 &"Administrative prohibition"& when it rejects SMTP commands for policy
16302 reasons. Many sysadmins like this because it gives away little information
16303 to spammers. However, some other sysadmins who are applying strict checking
16304 policies want to give out much fuller information about failures. Setting
16305 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16306 example, instead of &"Administrative prohibition"&, it might give:
16307 .code
16308 550-Rejected after DATA: '>' missing at end of address:
16309 550 failing address in "From" header is: <user@dom.ain
16310 .endd
16311
16312 .option spamd_address main string "see below"
16313 This option is available when Exim is compiled with the content-scanning
16314 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16315 The default value is
16316 .code
16317 127.0.0.1 783
16318 .endd
16319 See section &<<SECTscanspamass>>& for more details.
16320
16321
16322
16323 .option split_spool_directory main boolean false
16324 .cindex "multiple spool directories"
16325 .cindex "spool directory" "split"
16326 .cindex "directories, multiple"
16327 If this option is set, it causes Exim to split its input directory into 62
16328 subdirectories, each with a single alphanumeric character as its name. The
16329 sixth character of the message id is used to allocate messages to
16330 subdirectories; this is the least significant base-62 digit of the time of
16331 arrival of the message.
16332
16333 Splitting up the spool in this way may provide better performance on systems
16334 where there are long mail queues, by reducing the number of files in any one
16335 directory. The msglog directory is also split up in a similar way to the input
16336 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16337 are still placed in the single directory &_msglog.OLD_&.
16338
16339 It is not necessary to take any special action for existing messages when
16340 changing &%split_spool_directory%&. Exim notices messages that are in the
16341 &"wrong"& place, and continues to process them. If the option is turned off
16342 after a period of being on, the subdirectories will eventually empty and be
16343 automatically deleted.
16344
16345 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16346 changes. Instead of creating a list of all messages in the queue, and then
16347 trying to deliver each one in turn, it constructs a list of those in one
16348 sub-directory and tries to deliver them, before moving on to the next
16349 sub-directory. The sub-directories are processed in a random order. This
16350 spreads out the scanning of the input directories, and uses less memory. It is
16351 particularly beneficial when there are lots of messages on the queue. However,
16352 if &%queue_run_in_order%& is set, none of this new processing happens. The
16353 entire queue has to be scanned and sorted before any deliveries can start.
16354
16355
16356 .option spool_directory main string&!! "set at compile time"
16357 .cindex "spool directory" "path to"
16358 This defines the directory in which Exim keeps its spool, that is, the messages
16359 it is waiting to deliver. The default value is taken from the compile-time
16360 configuration setting, if there is one. If not, this option must be set. The
16361 string is expanded, so it can contain, for example, a reference to
16362 &$primary_hostname$&.
16363
16364 If the spool directory name is fixed on your installation, it is recommended
16365 that you set it at build time rather than from this option, particularly if the
16366 log files are being written to the spool directory (see &%log_file_path%&).
16367 Otherwise log files cannot be used for errors that are detected early on, such
16368 as failures in the configuration file.
16369
16370 By using this option to override the compiled-in path, it is possible to run
16371 tests of Exim without using the standard spool.
16372
16373 .option sqlite_lock_timeout main time 5s
16374 .cindex "sqlite lookup type" "lock timeout"
16375 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16376 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16377
16378 .option strict_acl_vars main boolean false
16379 .cindex "&ACL;" "variables, handling unset"
16380 This option controls what happens if a syntactically valid but undefined ACL
16381 variable is referenced. If it is false (the default), an empty string
16382 is substituted; if it is true, an error is generated. See section
16383 &<<SECTaclvariables>>& for details of ACL variables.
16384
16385 .option strip_excess_angle_brackets main boolean false
16386 .cindex "angle brackets, excess"
16387 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16388 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16389 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16390 passed on to another MTA, the excess angle brackets are not passed on. If this
16391 option is not set, multiple pairs of angle brackets cause a syntax error.
16392
16393
16394 .option strip_trailing_dot main boolean false
16395 .cindex "trailing dot on domain"
16396 .cindex "dot" "trailing on domain"
16397 If this option is set, a trailing dot at the end of a domain in an address is
16398 ignored. If this is in the envelope and the message is passed on to another
16399 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16400 domain causes a syntax error.
16401 However, addresses in header lines are checked only when an ACL requests header
16402 syntax checking.
16403
16404
16405 .option syslog_duplication main boolean true
16406 .cindex "syslog" "duplicate log lines; suppressing"
16407 When Exim is logging to syslog, it writes the log lines for its three
16408 separate logs at different syslog priorities so that they can in principle
16409 be separated on the logging hosts. Some installations do not require this
16410 separation, and in those cases, the duplication of certain log lines is a
16411 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16412 particular log line is written to syslog. For lines that normally go to
16413 both the main log and the reject log, the reject log version (possibly
16414 containing message header lines) is written, at LOG_NOTICE priority.
16415 Lines that normally go to both the main and the panic log are written at
16416 the LOG_ALERT priority.
16417
16418
16419 .option syslog_facility main string unset
16420 .cindex "syslog" "facility; setting"
16421 This option sets the syslog &"facility"& name, used when Exim is logging to
16422 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16423 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16424 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16425 details of Exim's logging.
16426
16427
16428
16429 .option syslog_processname main string &`exim`&
16430 .cindex "syslog" "process name; setting"
16431 This option sets the syslog &"ident"& name, used when Exim is logging to
16432 syslog. The value must be no longer than 32 characters. See chapter
16433 &<<CHAPlog>>& for details of Exim's logging.
16434
16435
16436
16437 .option syslog_timestamp main boolean true
16438 .cindex "syslog" "timestamps"
16439 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16440 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16441 details of Exim's logging.
16442
16443
16444 .option system_filter main string&!! unset
16445 .cindex "filter" "system filter"
16446 .cindex "system filter" "specifying"
16447 .cindex "Sieve filter" "not available for system filter"
16448 This option specifies an Exim filter file that is applied to all messages at
16449 the start of each delivery attempt, before any routing is done. System filters
16450 must be Exim filters; they cannot be Sieve filters. If the system filter
16451 generates any deliveries to files or pipes, or any new mail messages, the
16452 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16453 which transports are to be used. Details of this facility are given in chapter
16454 &<<CHAPsystemfilter>>&.
16455
16456
16457 .option system_filter_directory_transport main string&!! unset
16458 .vindex "&$address_file$&"
16459 This sets the name of the transport driver that is to be used when the
16460 &%save%& command in a system message filter specifies a path ending in &"/"&,
16461 implying delivery of each message into a separate file in some directory.
16462 During the delivery, the variable &$address_file$& contains the path name.
16463
16464
16465 .option system_filter_file_transport main string&!! unset
16466 .cindex "file" "transport for system filter"
16467 This sets the name of the transport driver that is to be used when the &%save%&
16468 command in a system message filter specifies a path not ending in &"/"&. During
16469 the delivery, the variable &$address_file$& contains the path name.
16470
16471 .option system_filter_group main string unset
16472 .cindex "gid (group id)" "system filter"
16473 This option is used only when &%system_filter_user%& is also set. It sets the
16474 gid under which the system filter is run, overriding any gid that is associated
16475 with the user. The value may be numerical or symbolic.
16476
16477 .option system_filter_pipe_transport main string&!! unset
16478 .cindex "&(pipe)& transport" "for system filter"
16479 .vindex "&$address_pipe$&"
16480 This specifies the transport driver that is to be used when a &%pipe%& command
16481 is used in a system filter. During the delivery, the variable &$address_pipe$&
16482 contains the pipe command.
16483
16484
16485 .option system_filter_reply_transport main string&!! unset
16486 .cindex "&(autoreply)& transport" "for system filter"
16487 This specifies the transport driver that is to be used when a &%mail%& command
16488 is used in a system filter.
16489
16490
16491 .option system_filter_user main string unset
16492 .cindex "uid (user id)" "system filter"
16493 If this option is set to root, the system filter is run in the main Exim
16494 delivery process, as root.  Otherwise, the system filter runs in a separate
16495 process, as the given user, defaulting to the Exim run-time user.
16496 Unless the string consists entirely of digits, it
16497 is looked up in the password data. Failure to find the named user causes a
16498 configuration error. The gid is either taken from the password data, or
16499 specified by &%system_filter_group%&. When the uid is specified numerically,
16500 &%system_filter_group%& is required to be set.
16501
16502 If the system filter generates any pipe, file, or reply deliveries, the uid
16503 under which the filter is run is used when transporting them, unless a
16504 transport option overrides.
16505
16506
16507 .option tcp_nodelay main boolean true
16508 .cindex "daemon" "TCP_NODELAY on sockets"
16509 .cindex "Nagle algorithm"
16510 .cindex "TCP_NODELAY on listening sockets"
16511 If this option is set false, it stops the Exim daemon setting the
16512 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16513 turns off the &"Nagle algorithm"&, which is a way of improving network
16514 performance in interactive (character-by-character) situations. Turning it off
16515 should improve Exim's performance a bit, so that is what happens by default.
16516 However, it appears that some broken clients cannot cope, and time out. Hence
16517 this option. It affects only those sockets that are set up for listening by the
16518 daemon. Sockets created by the smtp transport for delivering mail always set
16519 TCP_NODELAY.
16520
16521
16522 .option timeout_frozen_after main time 0s
16523 .cindex "frozen messages" "timing out"
16524 .cindex "timeout" "frozen messages"
16525 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16526 message of any kind that has been on the queue for longer than the given time
16527 is automatically cancelled at the next queue run. If the frozen message is a
16528 bounce message, it is just discarded; otherwise, a bounce is sent to the
16529 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16530 If you want to timeout frozen bounce messages earlier than other kinds of
16531 frozen message, see &%ignore_bounce_errors_after%&.
16532
16533 &*Note:*& the default value of zero means no timeouts; with this setting,
16534 frozen messages remain on the queue forever (except for any frozen bounce
16535 messages that are released by &%ignore_bounce_errors_after%&).
16536
16537
16538 .option timezone main string unset
16539 .cindex "timezone, setting"
16540 The value of &%timezone%& is used to set the environment variable TZ while
16541 running Exim (if it is different on entry). This ensures that all timestamps
16542 created by Exim are in the required timezone. If you want all your timestamps
16543 to be in UTC (aka GMT) you should set
16544 .code
16545 timezone = UTC
16546 .endd
16547 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16548 or, if that is not set, from the value of the TZ environment variable when Exim
16549 is built. If &%timezone%& is set to the empty string, either at build or run
16550 time, any existing TZ variable is removed from the environment when Exim
16551 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16552 unfortunately not all, operating systems.
16553
16554
16555 .option tls_advertise_hosts main "host list&!!" unset
16556 .cindex "TLS" "advertising"
16557 .cindex "encryption" "on SMTP connection"
16558 .cindex "SMTP" "encrypted connection"
16559 When Exim is built with support for TLS encrypted connections, the availability
16560 of the STARTTLS command to set up an encrypted session is advertised in
16561 response to EHLO only to those client hosts that match this option. See
16562 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16563
16564
16565 .option tls_certificate main string&!! unset
16566 .cindex "TLS" "server certificate; location of"
16567 .cindex "certificate" "server, location of"
16568 The value of this option is expanded, and must then be the absolute path to a
16569 file which contains the server's certificates. The server's private key is also
16570 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16571 &<<CHAPTLS>>& for further details.
16572
16573 &*Note*&: The certificates defined by this option are used only when Exim is
16574 receiving incoming messages as a server. If you want to supply certificates for
16575 use when sending messages as a client, you must set the &%tls_certificate%&
16576 option in the relevant &(smtp)& transport.
16577
16578 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16579 if the OpenSSL build supports TLS extensions and the TLS client sends the
16580 Server Name Indication extension, then this option and others documented in
16581 &<<SECTtlssni>>& will be re-expanded.
16582
16583 .option tls_crl main string&!! unset
16584 .cindex "TLS" "server certificate revocation list"
16585 .cindex "certificate" "revocation list for server"
16586 This option specifies a certificate revocation list. The expanded value must
16587 be the name of a file that contains a CRL in PEM format.
16588
16589 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16590
16591
16592 .option tls_dh_max_bits main integer 2236
16593 .cindex "TLS" "D-H bit count"
16594 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16595 the chosen TLS library.  That value might prove to be too high for
16596 interoperability.  This option provides a maximum clamp on the value
16597 suggested, trading off security for interoperability.
16598
16599 The value must be at least 1024.
16600
16601 The value 2236 was chosen because, at time of adding the option, it was the
16602 hard-coded maximum value supported by the NSS cryptographic library, as used
16603 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16604
16605 If you prefer more security and are willing to break some clients, raise this
16606 number.
16607
16608 Note that the value passed to GnuTLS for *generating* a new prime may be a
16609 little less than this figure, because GnuTLS is inexact and may produce a
16610 larger prime than requested.
16611
16612
16613 .option tls_dhparam main string&!! unset
16614 .cindex "TLS" "D-H parameters for server"
16615 The value of this option is expanded and indicates the source of DH parameters
16616 to be used by Exim.
16617
16618 If it is a filename starting with a &`/`&, then it names a file from which DH
16619 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16620 PKCS#3 representation of the DH prime.  If the file does not exist, for
16621 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16622 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16623 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16624 and treated as though the &%tls_dhparam%& were set to "none".
16625
16626 If this option expands to the string "none", then no DH parameters will be
16627 loaded by Exim.
16628
16629 If this option expands to the string "historic" and Exim is using GnuTLS, then
16630 Exim will attempt to load a file from inside the spool directory.  If the file
16631 does not exist, Exim will attempt to create it.
16632 See section &<<SECTgnutlsparam>>& for further details.
16633
16634 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16635 a default DH prime; the default is the 2048 bit prime described in section
16636 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16637 in IKE is assigned number 23.
16638
16639 Otherwise, the option must expand to the name used by Exim for any of a number
16640 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16641 "ike" followed by the number used by IKE, of "default" which corresponds to
16642 "ike23".
16643
16644 The available primes are:
16645 &`ike1`&, &`ike2`&, &`ike5`&,
16646 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16647 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16648
16649 Some of these will be too small to be accepted by clients.
16650 Some may be too large to be accepted by clients.
16651
16652 The TLS protocol does not negotiate an acceptable size for this; clients tend
16653 to hard-drop connections if what is offered by the server is unacceptable,
16654 whether too large or too small, and there's no provision for the client to
16655 tell the server what these constraints are.  Thus, as a server operator, you
16656 need to make an educated guess as to what is most likely to work for your
16657 userbase.
16658
16659 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16660 is most likely to maximise interoperability.  The upper bound comes from
16661 applications using the Mozilla Network Security Services (NSS) library, which
16662 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16663 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16664 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16665 acceptable bound from 1024 to 2048.
16666
16667
16668 .option tls_eccurve main string&!! prime256v1
16669 .cindex TLS "EC cryptography"
16670 If built with a recent-enough version of OpenSSL,
16671 this option selects a EC curve for use by Exim.
16672
16673 Curve names of the form &'prime256v1'& are accepted.
16674 For even more-recent library versions, names of the form &'P-512'&
16675 are also accepted, plus the special value &'auto'&
16676 which tell the library to choose.
16677
16678 If the option is set to an empty string, no EC curves will be enabled.
16679
16680
16681 .option tls_ocsp_file main string&!! unset
16682 .cindex TLS "certificate status"
16683 .cindex TLS "OCSP proof file"
16684 This option
16685 must if set expand to the absolute path to a file which contains a current
16686 status proof for the server's certificate, as obtained from the
16687 Certificate Authority.
16688
16689 .new
16690 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
16691 .wen
16692
16693
16694 .option tls_on_connect_ports main "string list" unset
16695 .cindex SSMTP
16696 .cindex SMTPS
16697 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16698 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16699 set up without waiting for the client to issue a STARTTLS command. For
16700 further details, see section &<<SECTsupobssmt>>&.
16701
16702
16703
16704 .option tls_privatekey main string&!! unset
16705 .cindex "TLS" "server private key; location of"
16706 The value of this option is expanded, and must then be the absolute path to a
16707 file which contains the server's private key. If this option is unset, or if
16708 the expansion is forced to fail, or the result is an empty string, the private
16709 key is assumed to be in the same file as the server's certificates. See chapter
16710 &<<CHAPTLS>>& for further details.
16711
16712 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16713
16714
16715 .option tls_remember_esmtp main boolean false
16716 .cindex "TLS" "esmtp state; remembering"
16717 .cindex "TLS" "broken clients"
16718 If this option is set true, Exim violates the RFCs by remembering that it is in
16719 &"esmtp"& state after successfully negotiating a TLS session. This provides
16720 support for broken clients that fail to send a new EHLO after starting a
16721 TLS session.
16722
16723
16724 .option tls_require_ciphers main string&!! unset
16725 .cindex "TLS" "requiring specific ciphers"
16726 .cindex "cipher" "requiring specific"
16727 This option controls which ciphers can be used for incoming TLS connections.
16728 The &(smtp)& transport has an option of the same name for controlling outgoing
16729 connections. This option is expanded for each connection, so can be varied for
16730 different clients if required. The value of this option must be a list of
16731 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16732 in somewhat different ways. If GnuTLS is being used, the client controls the
16733 preference order of the available ciphers. Details are given in sections
16734 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16735
16736
16737 .option tls_try_verify_hosts main "host list&!!" unset
16738 .cindex "TLS" "client certificate verification"
16739 .cindex "certificate" "verification of client"
16740 See &%tls_verify_hosts%& below.
16741
16742
16743 .option tls_verify_certificates main string&!! system
16744 .cindex "TLS" "client certificate verification"
16745 .cindex "certificate" "verification of client"
16746 The value of this option is expanded, and must then be either the
16747 word "system"
16748 or the absolute path to
16749 a file or directory containing permitted certificates for clients that
16750 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16751
16752 The "system" value for the option will use a
16753 system default location compiled into the SSL library.
16754 This is not available for GnuTLS versions preceding 3.0.20,
16755 and will be taken as empty; an explicit location
16756 must be specified.
16757
16758 The use of a directory for the option value is not available for GnuTLS versions
16759 preceding 3.3.6 and a single file must be used.
16760
16761 With OpenSSL the certificates specified
16762 explicitly
16763 either by file or directory
16764 are added to those given by the system default location.
16765
16766 These certificates should be for the certificate authorities trusted, rather
16767 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16768 the value is a file then the certificates are sent by Exim as a server to
16769 connecting clients, defining the list of accepted certificate authorities.
16770 Thus the values defined should be considered public data.  To avoid this,
16771 use the explicit directory version.
16772
16773 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16774
16775 A forced expansion failure or setting to an empty string is equivalent to
16776 being unset.
16777
16778
16779 .option tls_verify_hosts main "host list&!!" unset
16780 .cindex "TLS" "client certificate verification"
16781 .cindex "certificate" "verification of client"
16782 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16783 certificates from clients. The expected certificates are defined by
16784 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16785 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16786 &%tls_verify_certificates%& is not set.
16787
16788 Any client that matches &%tls_verify_hosts%& is constrained by
16789 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16790 present one of the listed certificates. If it does not, the connection is
16791 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16792 the host to use TLS. It can still send SMTP commands through unencrypted
16793 connections. Forcing a client to use TLS has to be done separately using an
16794 ACL to reject inappropriate commands when the connection is not encrypted.
16795
16796 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16797 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16798 certificate and checks it against &%tls_verify_certificates%&, but does not
16799 abort the connection if there is no certificate or if it does not match. This
16800 state can be detected in an ACL, which makes it possible to implement policies
16801 such as &"accept for relay only if a verified certificate has been received,
16802 but accept for local delivery if encrypted, even without a verified
16803 certificate"&.
16804
16805 Client hosts that match neither of these lists are not asked to present
16806 certificates.
16807
16808
16809 .option trusted_groups main "string list&!!" unset
16810 .cindex "trusted groups"
16811 .cindex "groups" "trusted"
16812 This option is expanded just once, at the start of Exim's processing. If this
16813 option is set, any process that is running in one of the listed groups, or
16814 which has one of them as a supplementary group, is trusted. The groups can be
16815 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16816 details of what trusted callers are permitted to do. If neither
16817 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16818 are trusted.
16819
16820 .option trusted_users main "string list&!!" unset
16821 .cindex "trusted users"
16822 .cindex "user" "trusted"
16823 This option is expanded just once, at the start of Exim's processing. If this
16824 option is set, any process that is running as one of the listed users is
16825 trusted. The users can be specified numerically or by name. See section
16826 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16827 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16828 Exim user are trusted.
16829
16830 .option unknown_login main string&!! unset
16831 .cindex "uid (user id)" "unknown caller"
16832 .vindex "&$caller_uid$&"
16833 This is a specialized feature for use in unusual configurations. By default, if
16834 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16835 gives up. The &%unknown_login%& option can be used to set a login name to be
16836 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16837 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16838 is used for the user's real name (gecos field), unless this has been set by the
16839 &%-F%& option.
16840
16841 .option unknown_username main string unset
16842 See &%unknown_login%&.
16843
16844 .option untrusted_set_sender main "address list&!!" unset
16845 .cindex "trusted users"
16846 .cindex "sender" "setting by untrusted user"
16847 .cindex "untrusted user setting sender"
16848 .cindex "user" "untrusted setting sender"
16849 .cindex "envelope sender"
16850 When an untrusted user submits a message to Exim using the standard input, Exim
16851 normally creates an envelope sender address from the user's login and the
16852 default qualification domain. Data from the &%-f%& option (for setting envelope
16853 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16854 is used) is ignored.
16855
16856 However, untrusted users are permitted to set an empty envelope sender address,
16857 to declare that a message should never generate any bounces. For example:
16858 .code
16859 exim -f '<>' user@domain.example
16860 .endd
16861 .vindex "&$sender_ident$&"
16862 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16863 other envelope sender addresses in a controlled way. When it is set, untrusted
16864 users are allowed to set envelope sender addresses that match any of the
16865 patterns in the list. Like all address lists, the string is expanded. The
16866 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16867 users to setting senders that start with their login ids
16868 followed by a hyphen
16869 by a setting like this:
16870 .code
16871 untrusted_set_sender = ^$sender_ident-
16872 .endd
16873 If you want to allow untrusted users to set envelope sender addresses without
16874 restriction, you can use
16875 .code
16876 untrusted_set_sender = *
16877 .endd
16878 The &%untrusted_set_sender%& option applies to all forms of local input, but
16879 only to the setting of the envelope sender. It does not permit untrusted users
16880 to use the other options which trusted user can use to override message
16881 parameters. Furthermore, it does not stop Exim from removing an existing
16882 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16883 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16884 overriding these actions. The handling of the &'Sender:'& header is also
16885 described in section &<<SECTthesenhea>>&.
16886
16887 The log line for a message's arrival shows the envelope sender following
16888 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16889 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16890 envelope sender address, the user's login is shown in parentheses after the
16891 sender address.
16892
16893
16894 .option uucp_from_pattern main string "see below"
16895 .cindex "&""From""& line"
16896 .cindex "UUCP" "&""From""& line"
16897 Some applications that pass messages to an MTA via a command line interface use
16898 an initial line starting with &"From&~"& to pass the envelope sender. In
16899 particular, this is used by UUCP software. Exim recognizes such a line by means
16900 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16901 matches, the sender address is constructed by expanding the contents of
16902 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16903 default pattern recognizes lines in the following two forms:
16904 .code
16905 From ph10 Fri Jan  5 12:35 GMT 1996
16906 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16907 .endd
16908 The pattern can be seen by running
16909 .code
16910 exim -bP uucp_from_pattern
16911 .endd
16912 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16913 year in the second case. The first word after &"From&~"& is matched in the
16914 regular expression by a parenthesized subpattern. The default value for
16915 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16916 (&"ph10"& in the example above) as the message's sender. See also
16917 &%ignore_fromline_hosts%&.
16918
16919
16920 .option uucp_from_sender main string&!! &`$1`&
16921 See &%uucp_from_pattern%& above.
16922
16923
16924 .option warn_message_file main string unset
16925 .cindex "warning of delay" "customizing the message"
16926 .cindex "customizing" "warning message"
16927 This option defines a template file containing paragraphs of text to be used
16928 for constructing the warning message which is sent by Exim when a message has
16929 been on the queue for a specified amount of time, as specified by
16930 &%delay_warning%&. Details of the file's contents are given in chapter
16931 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16932
16933
16934 .option write_rejectlog main boolean true
16935 .cindex "reject log" "disabling"
16936 If this option is set false, Exim no longer writes anything to the reject log.
16937 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16938 .ecindex IIDconfima
16939 .ecindex IIDmaiconf
16940
16941
16942
16943
16944 . ////////////////////////////////////////////////////////////////////////////
16945 . ////////////////////////////////////////////////////////////////////////////
16946
16947 .chapter "Generic options for routers" "CHAProutergeneric"
16948 .scindex IIDgenoprou1 "options" "generic; for routers"
16949 .scindex IIDgenoprou2 "generic options" "router"
16950 This chapter describes the generic options that apply to all routers.
16951 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16952
16953 For a general description of how a router operates, see sections
16954 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16955 which the preconditions are tested. The order of expansion of the options that
16956 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16957 &%headers_remove%&, &%transport%&.
16958
16959
16960
16961 .option address_data routers string&!! unset
16962 .cindex "router" "data attached to address"
16963 The string is expanded just before the router is run, that is, after all the
16964 precondition tests have succeeded. If the expansion is forced to fail, the
16965 router declines, the value of &%address_data%& remains unchanged, and the
16966 &%more%& option controls what happens next. Other expansion failures cause
16967 delivery of the address to be deferred.
16968
16969 .vindex "&$address_data$&"
16970 When the expansion succeeds, the value is retained with the address, and can be
16971 accessed using the variable &$address_data$& in the current router, subsequent
16972 routers, and the eventual transport.
16973
16974 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16975 that runs a user's filter file, the contents of &$address_data$& are accessible
16976 in the filter. This is not normally a problem, because such data is usually
16977 either not confidential or it &"belongs"& to the current user, but if you do
16978 put confidential data into &$address_data$& you need to remember this point.
16979
16980 Even if the router declines or passes, the value of &$address_data$& remains
16981 with the address, though it can be changed by another &%address_data%& setting
16982 on a subsequent router. If a router generates child addresses, the value of
16983 &$address_data$& propagates to them. This also applies to the special kind of
16984 &"child"& that is generated by a router with the &%unseen%& option.
16985
16986 The idea of &%address_data%& is that you can use it to look up a lot of data
16987 for the address once, and then pick out parts of the data later. For example,
16988 you could use a single LDAP lookup to return a string of the form
16989 .code
16990 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16991 .endd
16992 In the transport you could pick out the mailbox by a setting such as
16993 .code
16994 file = ${extract{mailbox}{$address_data}}
16995 .endd
16996 This makes the configuration file less messy, and also reduces the number of
16997 lookups (though Exim does cache lookups).
16998
16999 .vindex "&$sender_address_data$&"
17000 .vindex "&$address_data$&"
17001 The &%address_data%& facility is also useful as a means of passing information
17002 from one router to another, and from a router to a transport. In addition, if
17003 &$address_data$& is set by a router when verifying a recipient address from an
17004 ACL, it remains available for use in the rest of the ACL statement. After
17005 verifying a sender, the value is transferred to &$sender_address_data$&.
17006
17007
17008
17009 .option address_test routers&!? boolean true
17010 .oindex "&%-bt%&"
17011 .cindex "router" "skipping when address testing"
17012 If this option is set false, the router is skipped when routing is being tested
17013 by means of the &%-bt%& command line option. This can be a convenience when
17014 your first router sends messages to an external scanner, because it saves you
17015 having to set the &"already scanned"& indicator when testing real address
17016 routing.
17017
17018
17019
17020 .option cannot_route_message routers string&!! unset
17021 .cindex "router" "customizing &""cannot route""& message"
17022 .cindex "customizing" "&""cannot route""& message"
17023 This option specifies a text message that is used when an address cannot be
17024 routed because Exim has run out of routers. The default message is
17025 &"Unrouteable address"&. This option is useful only on routers that have
17026 &%more%& set false, or on the very last router in a configuration, because the
17027 value that is used is taken from the last router that is considered. This
17028 includes a router that is skipped because its preconditions are not met, as
17029 well as a router that declines. For example, using the default configuration,
17030 you could put:
17031 .code
17032 cannot_route_message = Remote domain not found in DNS
17033 .endd
17034 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17035 and
17036 .code
17037 cannot_route_message = Unknown local user
17038 .endd
17039 on the final router that checks for local users. If string expansion fails for
17040 this option, the default message is used. Unless the expansion failure was
17041 explicitly forced, a message about the failure is written to the main and panic
17042 logs, in addition to the normal message about the routing failure.
17043
17044
17045 .option caseful_local_part routers boolean false
17046 .cindex "case of local parts"
17047 .cindex "router" "case of local parts"
17048 By default, routers handle the local parts of addresses in a case-insensitive
17049 manner, though the actual case is preserved for transmission with the message.
17050 If you want the case of letters to be significant in a router, you must set
17051 this option true. For individual router options that contain address or local
17052 part lists (for example, &%local_parts%&), case-sensitive matching can be
17053 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17054 more details.
17055
17056 .vindex "&$local_part$&"
17057 .vindex "&$original_local_part$&"
17058 .vindex "&$parent_local_part$&"
17059 The value of the &$local_part$& variable is forced to lower case while a
17060 router is running unless &%caseful_local_part%& is set. When a router assigns
17061 an address to a transport, the value of &$local_part$& when the transport runs
17062 is the same as it was in the router. Similarly, when a router generates child
17063 addresses by aliasing or forwarding, the values of &$original_local_part$&
17064 and &$parent_local_part$& are those that were used by the redirecting router.
17065
17066 This option applies to the processing of an address by a router. When a
17067 recipient address is being processed in an ACL, there is a separate &%control%&
17068 modifier that can be used to specify case-sensitive processing within the ACL
17069 (see section &<<SECTcontrols>>&).
17070
17071
17072
17073 .option check_local_user routers&!? boolean false
17074 .cindex "local user, checking in router"
17075 .cindex "router" "checking for local user"
17076 .cindex "&_/etc/passwd_&"
17077 .vindex "&$home$&"
17078 When this option is true, Exim checks that the local part of the recipient
17079 address (with affixes removed if relevant) is the name of an account on the
17080 local system. The check is done by calling the &[getpwnam()]& function rather
17081 than trying to read &_/etc/passwd_& directly. This means that other methods of
17082 holding password data (such as NIS) are supported. If the local part is a local
17083 user, &$home$& is set from the password data, and can be tested in other
17084 preconditions that are evaluated after this one (the order of evaluation is
17085 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17086 overridden by &%router_home_directory%&. If the local part is not a local user,
17087 the router is skipped.
17088
17089 If you want to check that the local part is either the name of a local user
17090 or matches something else, you cannot combine &%check_local_user%& with a
17091 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17092 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17093 setting to achieve this. For example:
17094 .code
17095 local_parts = passwd;$local_part : lsearch;/etc/other/users
17096 .endd
17097 Note, however, that the side effects of &%check_local_user%& (such as setting
17098 up a home directory) do not occur when a &(passwd)& lookup is used in a
17099 &%local_parts%& (or any other) precondition.
17100
17101
17102
17103 .option condition routers&!? string&!! unset
17104 .cindex "router" "customized precondition"
17105 This option specifies a general precondition test that has to succeed for the
17106 router to be called. The &%condition%& option is the last precondition to be
17107 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17108 result is a forced failure, or an empty string, or one of the strings &"0"& or
17109 &"no"& or &"false"& (checked without regard to the case of the letters), the
17110 router is skipped, and the address is offered to the next one.
17111
17112 If the result is any other value, the router is run (as this is the last
17113 precondition to be evaluated, all the other preconditions must be true).
17114
17115 This option is unusual in that multiple &%condition%& options may be present.
17116 All &%condition%& options must succeed.
17117
17118 The &%condition%& option provides a means of applying custom conditions to the
17119 running of routers. Note that in the case of a simple conditional expansion,
17120 the default expansion values are exactly what is wanted. For example:
17121 .code
17122 condition = ${if >{$message_age}{600}}
17123 .endd
17124 Because of the default behaviour of the string expansion, this is equivalent to
17125 .code
17126 condition = ${if >{$message_age}{600}{true}{}}
17127 .endd
17128
17129 A multiple condition example, which succeeds:
17130 .code
17131 condition = ${if >{$message_age}{600}}
17132 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17133 condition = foobar
17134 .endd
17135
17136 If the expansion fails (other than forced failure) delivery is deferred. Some
17137 of the other precondition options are common special cases that could in fact
17138 be specified using &%condition%&.
17139
17140 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17141 are far older, and use one set of semantics.  ACLs are newer and when
17142 they were created, the ACL &%condition%& process was given far stricter
17143 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17144 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17145 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17146 Router rules processing behavior.
17147
17148 This is best illustrated in an example:
17149 .code
17150 # If used in an ACL condition will fail with a syntax error, but
17151 # in a router condition any extra characters are treated as a string
17152
17153 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17154 true {yes} {no}}
17155
17156 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17157  {yes} {no}}
17158 .endd
17159 In each example above, the &%if%& statement actually ends after
17160 &"{google.com}}"&.  Since no true or false braces were defined, the
17161 default &%if%& behavior is to return a boolean true or a null answer
17162 (which evaluates to false). The rest of the line is then treated as a
17163 string. So the first example resulted in the boolean answer &"true"&
17164 with the string &" {yes} {no}}"& appended to it. The second example
17165 resulted in the null output (indicating false) with the string
17166 &" {yes} {no}}"& appended to it.
17167
17168 In fact you can put excess forward braces in too.  In the router
17169 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17170 mean something, like after a &"$"& or when required as part of a
17171 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17172 string characters.
17173
17174 Thus, in a Router, the above expansion strings will both always evaluate
17175 true, as the result of expansion is a non-empty string which doesn't
17176 match an explicit false value.  This can be tricky to debug.  By
17177 contrast, in an ACL either of those strings will always result in an
17178 expansion error because the result doesn't look sufficiently boolean.
17179
17180
17181 .option debug_print routers string&!! unset
17182 .cindex "testing" "variables in drivers"
17183 If this option is set and debugging is enabled (see the &%-d%& command line
17184 option) or in address-testing mode (see the &%-bt%& command line option),
17185 the string is expanded and included in the debugging output.
17186 If expansion of the string fails, the error message is written to the debugging
17187 output, and Exim carries on processing.
17188 This option is provided to help with checking out the values of variables and
17189 so on when debugging router configurations. For example, if a &%condition%&
17190 option appears not to be working, &%debug_print%& can be used to output the
17191 variables it references. The output happens after checks for &%domains%&,
17192 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17193 are tested. A newline is added to the text if it does not end with one.
17194 The variable &$router_name$& contains the name of the router.
17195
17196
17197
17198 .option disable_logging routers boolean false
17199 If this option is set true, nothing is logged for any routing errors
17200 or for any deliveries caused by this router. You should not set this option
17201 unless you really, really know what you are doing. See also the generic
17202 transport option of the same name.
17203
17204 .option dnssec_request_domains routers "domain list&!!" unset
17205 .cindex "MX record" "security"
17206 .cindex "DNSSEC" "MX lookup"
17207 .cindex "security" "MX lookup"
17208 .cindex "DNS" "DNSSEC"
17209 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17210 the dnssec request bit set.
17211 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17212
17213 .option dnssec_require_domains routers "domain list&!!" unset
17214 .cindex "MX record" "security"
17215 .cindex "DNSSEC" "MX lookup"
17216 .cindex "security" "MX lookup"
17217 .cindex "DNS" "DNSSEC"
17218 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17219 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17220 (AD bit) set will be ignored and logged as a host-lookup failure.
17221 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17222
17223
17224 .option domains routers&!? "domain list&!!" unset
17225 .cindex "router" "restricting to specific domains"
17226 .vindex "&$domain_data$&"
17227 If this option is set, the router is skipped unless the current domain matches
17228 the list. If the match is achieved by means of a file lookup, the data that the
17229 lookup returned for the domain is placed in &$domain_data$& for use in string
17230 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17231 a list of the order in which preconditions are evaluated.
17232
17233
17234
17235 .option driver routers string unset
17236 This option must always be set. It specifies which of the available routers is
17237 to be used.
17238
17239
17240 .option dsn_lasthop routers boolean false
17241 .cindex "DSN" "success"
17242 .cindex "Delivery Status Notification" "success"
17243 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17244 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17245 instead send a success DSN as if the next hop does not support DSN.
17246 Not effective on redirect routers.
17247
17248
17249
17250 .option errors_to routers string&!! unset
17251 .cindex "envelope sender"
17252 .cindex "router" "changing address for errors"
17253 If a router successfully handles an address, it may assign the address to a
17254 transport for delivery or it may generate child addresses. In both cases, if
17255 there is a delivery problem during later processing, the resulting bounce
17256 message is sent to the address that results from expanding this string,
17257 provided that the address verifies successfully. The &%errors_to%& option is
17258 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17259
17260 The &%errors_to%& setting associated with an address can be overridden if it
17261 subsequently passes through other routers that have their own &%errors_to%&
17262 settings, or if the message is delivered by a transport with a &%return_path%&
17263 setting.
17264
17265 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17266 the expansion fails to verify, the errors address associated with the incoming
17267 address is used. At top level, this is the envelope sender. A non-forced
17268 expansion failure causes delivery to be deferred.
17269
17270 If an address for which &%errors_to%& has been set ends up being delivered over
17271 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17272 any bounces that are generated by other MTAs on the delivery route are also
17273 sent there. You can set &%errors_to%& to the empty string by either of these
17274 settings:
17275 .code
17276 errors_to =
17277 errors_to = ""
17278 .endd
17279 An expansion item that yields an empty string has the same effect. If you do
17280 this, a locally detected delivery error for addresses processed by this router
17281 no longer gives rise to a bounce message; the error is discarded. If the
17282 address is delivered to a remote host, the return path is set to &`<>`&, unless
17283 overridden by the &%return_path%& option on the transport.
17284
17285 .vindex "&$address_data$&"
17286 If for some reason you want to discard local errors, but use a non-empty
17287 MAIL command for remote delivery, you can preserve the original return
17288 path in &$address_data$& in the router, and reinstate it in the transport by
17289 setting &%return_path%&.
17290
17291 The most common use of &%errors_to%& is to direct mailing list bounces to the
17292 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17293 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17294
17295
17296
17297 .option expn routers&!? boolean true
17298 .cindex "address" "testing"
17299 .cindex "testing" "addresses"
17300 .cindex "EXPN" "router skipping"
17301 .cindex "router" "skipping for EXPN"
17302 If this option is turned off, the router is skipped when testing an address
17303 as a result of processing an SMTP EXPN command. You might, for example,
17304 want to turn it off on a router for users' &_.forward_& files, while leaving it
17305 on for the system alias file.
17306 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17307 are evaluated.
17308
17309 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17310 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17311 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17312
17313
17314
17315 .option fail_verify routers boolean false
17316 .cindex "router" "forcing verification failure"
17317 Setting this option has the effect of setting both &%fail_verify_sender%& and
17318 &%fail_verify_recipient%& to the same value.
17319
17320
17321
17322 .option fail_verify_recipient routers boolean false
17323 If this option is true and an address is accepted by this router when
17324 verifying a recipient, verification fails.
17325
17326
17327
17328 .option fail_verify_sender routers boolean false
17329 If this option is true and an address is accepted by this router when
17330 verifying a sender, verification fails.
17331
17332
17333
17334 .option fallback_hosts routers "string list" unset
17335 .cindex "router" "fallback hosts"
17336 .cindex "fallback" "hosts specified on router"
17337 String expansion is not applied to this option. The argument must be a
17338 colon-separated list of host names or IP addresses. The list separator can be
17339 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17340 each name or address. In fact, the format of each item is exactly the same as
17341 defined for the list of hosts in a &(manualroute)& router (see section
17342 &<<SECTformatonehostitem>>&).
17343
17344 If a router queues an address for a remote transport, this host list is
17345 associated with the address, and used instead of the transport's fallback host
17346 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17347 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17348 transport for further details.
17349
17350
17351 .option group routers string&!! "see below"
17352 .cindex "gid (group id)" "local delivery"
17353 .cindex "local transports" "uid and gid"
17354 .cindex "transport" "local"
17355 .cindex "router" "setting group"
17356 When a router queues an address for a transport, and the transport does not
17357 specify a group, the group given here is used when running the delivery
17358 process.
17359 The group may be specified numerically or by name. If expansion fails, the
17360 error is logged and delivery is deferred.
17361 The default is unset, unless &%check_local_user%& is set, when the default
17362 is taken from the password information. See also &%initgroups%& and &%user%&
17363 and the discussion in chapter &<<CHAPenvironment>>&.
17364
17365
17366
17367 .option headers_add routers list&!! unset
17368 .cindex "header lines" "adding"
17369 .cindex "router" "adding header lines"
17370 This option specifies a list of text headers,
17371 newline-separated (by default, changeable in the usual way),
17372 that is associated with any addresses that are accepted by the router.
17373 Each item is separately expanded, at routing time.  However, this
17374 option has no effect when an address is just being verified. The way in which
17375 the text is used to add header lines at transport time is described in section
17376 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17377 message is in the process of being transported. This means that references to
17378 header lines in string expansions in the transport's configuration do not
17379 &"see"& the added header lines.
17380
17381 The &%headers_add%& option is expanded after &%errors_to%&, but before
17382 &%headers_remove%& and &%transport%&. If an item is empty, or if
17383 an item expansion is forced to fail, the item has no effect. Other expansion
17384 failures are treated as configuration errors.
17385
17386 Unlike most options, &%headers_add%& can be specified multiple times
17387 for a router; all listed headers are added.
17388
17389 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17390 router that has the &%one_time%& option set.
17391
17392 .cindex "duplicate addresses"
17393 .oindex "&%unseen%&"
17394 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17395 additions are deleted when the address is passed on to subsequent routers.
17396 For a &%redirect%& router, if a generated address is the same as the incoming
17397 address, this can lead to duplicate addresses with different header
17398 modifications. Exim does not do duplicate deliveries (except, in certain
17399 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17400 which of the duplicates is discarded, so this ambiguous situation should be
17401 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17402
17403
17404
17405 .option headers_remove routers list&!! unset
17406 .cindex "header lines" "removing"
17407 .cindex "router" "removing header lines"
17408 This option specifies a list of text headers,
17409 colon-separated (by default, changeable in the usual way),
17410 that is associated with any addresses that are accepted by the router.
17411 Each item is separately expanded, at routing time.  However, this
17412 option has no effect when an address is just being verified. The way in which
17413 the text is used to remove header lines at transport time is described in
17414 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17415 the message is in the process of being transported. This means that references
17416 to header lines in string expansions in the transport's configuration still
17417 &"see"& the original header lines.
17418
17419 The &%headers_remove%& option is expanded after &%errors_to%& and
17420 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17421 the item has no effect. Other expansion failures are treated as configuration
17422 errors.
17423
17424 Unlike most options, &%headers_remove%& can be specified multiple times
17425 for a router; all listed headers are removed.
17426
17427 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17428 router that has the &%one_time%& option set.
17429
17430 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17431 removal requests are deleted when the address is passed on to subsequent
17432 routers, and this can lead to problems with duplicates -- see the similar
17433 warning for &%headers_add%& above.
17434
17435 &*Warning 3*&: Because of the separate expansion of the list items,
17436 items that contain a list separator must have it doubled.
17437 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17438
17439
17440
17441 .option ignore_target_hosts routers "host list&!!" unset
17442 .cindex "IP address" "discarding"
17443 .cindex "router" "discarding IP addresses"
17444 Although this option is a host list, it should normally contain IP address
17445 entries rather than names. If any host that is looked up by the router has an
17446 IP address that matches an item in this list, Exim behaves as if that IP
17447 address did not exist. This option allows you to cope with rogue DNS entries
17448 like
17449 .code
17450 remote.domain.example.  A  127.0.0.1
17451 .endd
17452 by setting
17453 .code
17454 ignore_target_hosts = 127.0.0.1
17455 .endd
17456 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17457 discarded in this way, the router declines. In a conventional configuration, an
17458 attempt to mail to such a domain would normally provoke the &"unrouteable
17459 domain"& error, and an attempt to verify an address in the domain would fail.
17460 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17461 router declines if presented with one of the listed addresses.
17462
17463 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17464 means of the first or the second of the following settings, respectively:
17465 .code
17466 ignore_target_hosts = 0.0.0.0/0
17467 ignore_target_hosts = <; 0::0/0
17468 .endd
17469 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17470 in the second line matches all IPv6 addresses.
17471
17472 This option may also be useful for ignoring link-local and site-local IPv6
17473 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17474 is expanded before use as a list, it is possible to make it dependent on the
17475 domain that is being routed.
17476
17477 .vindex "&$host_address$&"
17478 During its expansion, &$host_address$& is set to the IP address that is being
17479 checked.
17480
17481 .option initgroups routers boolean false
17482 .cindex "additional groups"
17483 .cindex "groups" "additional"
17484 .cindex "local transports" "uid and gid"
17485 .cindex "transport" "local"
17486 If the router queues an address for a transport, and this option is true, and
17487 the uid supplied by the router is not overridden by the transport, the
17488 &[initgroups()]& function is called when running the transport to ensure that
17489 any additional groups associated with the uid are set up. See also &%group%&
17490 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17491
17492
17493
17494 .option local_part_prefix routers&!? "string list" unset
17495 .cindex "router" "prefix for local part"
17496 .cindex "prefix" "for local part, used in router"
17497 If this option is set, the router is skipped unless the local part starts with
17498 one of the given strings, or &%local_part_prefix_optional%& is true. See
17499 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17500 evaluated.
17501
17502 The list is scanned from left to right, and the first prefix that matches is
17503 used. A limited form of wildcard is available; if the prefix begins with an
17504 asterisk, it matches the longest possible sequence of arbitrary characters at
17505 the start of the local part. An asterisk should therefore always be followed by
17506 some character that does not occur in normal local parts.
17507 .cindex "multiple mailboxes"
17508 .cindex "mailbox" "multiple"
17509 Wildcarding can be used to set up multiple user mailboxes, as described in
17510 section &<<SECTmulbox>>&.
17511
17512 .vindex "&$local_part$&"
17513 .vindex "&$local_part_prefix$&"
17514 During the testing of the &%local_parts%& option, and while the router is
17515 running, the prefix is removed from the local part, and is available in the
17516 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17517 the router accepts the address, this remains true during subsequent delivery by
17518 a transport. In particular, the local part that is transmitted in the RCPT
17519 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17520 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17521 the relevant transport.
17522
17523 When an address is being verified, &%local_part_prefix%& affects only the
17524 behaviour of the router. If the callout feature of verification is in use, this
17525 means that the full address, including the prefix, will be used during the
17526 callout.
17527
17528 The prefix facility is commonly used to handle local parts of the form
17529 &%owner-something%&. Another common use is to support local parts of the form
17530 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17531 to tell a user their forwarding is broken &-- by placing a router like this one
17532 immediately before the router that handles &_.forward_& files:
17533 .code
17534 real_localuser:
17535   driver = accept
17536   local_part_prefix = real-
17537   check_local_user
17538   transport = local_delivery
17539 .endd
17540 For security, it would probably be a good idea to restrict the use of this
17541 router to locally-generated messages, using a condition such as this:
17542 .code
17543   condition = ${if match {$sender_host_address}\
17544                          {\N^(|127\.0\.0\.1)$\N}}
17545 .endd
17546
17547 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17548 both conditions must be met if not optional. Care must be taken if wildcards
17549 are used in both a prefix and a suffix on the same router. Different
17550 separator characters must be used to avoid ambiguity.
17551
17552
17553 .option local_part_prefix_optional routers boolean false
17554 See &%local_part_prefix%& above.
17555
17556
17557
17558 .option local_part_suffix routers&!? "string list" unset
17559 .cindex "router" "suffix for local part"
17560 .cindex "suffix for local part" "used in router"
17561 This option operates in the same way as &%local_part_prefix%&, except that the
17562 local part must end (rather than start) with the given string, the
17563 &%local_part_suffix_optional%& option determines whether the suffix is
17564 mandatory, and the wildcard * character, if present, must be the last
17565 character of the suffix. This option facility is commonly used to handle local
17566 parts of the form &%something-request%& and multiple user mailboxes of the form
17567 &%username-foo%&.
17568
17569
17570 .option local_part_suffix_optional routers boolean false
17571 See &%local_part_suffix%& above.
17572
17573
17574
17575 .option local_parts routers&!? "local part list&!!" unset
17576 .cindex "router" "restricting to specific local parts"
17577 .cindex "local part" "checking in router"
17578 The router is run only if the local part of the address matches the list.
17579 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17580 are evaluated, and
17581 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17582 string is expanded, it is possible to make it depend on the domain, for
17583 example:
17584 .code
17585 local_parts = dbm;/usr/local/specials/$domain
17586 .endd
17587 .vindex "&$local_part_data$&"
17588 If the match is achieved by a lookup, the data that the lookup returned
17589 for the local part is placed in the variable &$local_part_data$& for use in
17590 expansions of the router's private options. You might use this option, for
17591 example, if you have a large number of local virtual domains, and you want to
17592 send all postmaster mail to the same place without having to set up an alias in
17593 each virtual domain:
17594 .code
17595 postmaster:
17596   driver = redirect
17597   local_parts = postmaster
17598   data = postmaster@real.domain.example
17599 .endd
17600
17601
17602 .option log_as_local routers boolean "see below"
17603 .cindex "log" "delivery line"
17604 .cindex "delivery" "log line format"
17605 Exim has two logging styles for delivery, the idea being to make local
17606 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17607 recipient address is given just as the local part, without a domain. The use of
17608 this style is controlled by this option. It defaults to true for the &(accept)&
17609 router, and false for all the others. This option applies only when a
17610 router assigns an address to a transport. It has no effect on routers that
17611 redirect addresses.
17612
17613
17614
17615 .option more routers boolean&!! true
17616 The result of string expansion for this option must be a valid boolean value,
17617 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17618 result causes an error, and delivery is deferred. If the expansion is forced to
17619 fail, the default value for the option (true) is used. Other failures cause
17620 delivery to be deferred.
17621
17622 If this option is set false, and the router declines to handle the address, no
17623 further routers are tried, routing fails, and the address is bounced.
17624 .oindex "&%self%&"
17625 However, if the router explicitly passes an address to the following router by
17626 means of the setting
17627 .code
17628 self = pass
17629 .endd
17630 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17631 does not affect the behaviour if one of the precondition tests fails. In that
17632 case, the address is always passed to the next router.
17633
17634 Note that &%address_data%& is not considered to be a precondition. If its
17635 expansion is forced to fail, the router declines, and the value of &%more%&
17636 controls what happens next.
17637
17638
17639 .option pass_on_timeout routers boolean false
17640 .cindex "timeout" "of router"
17641 .cindex "router" "timeout"
17642 If a router times out during a host lookup, it normally causes deferral of the
17643 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17644 router, overriding &%no_more%&. This may be helpful for systems that are
17645 intermittently connected to the Internet, or those that want to pass to a smart
17646 host any messages that cannot immediately be delivered.
17647
17648 There are occasional other temporary errors that can occur while doing DNS
17649 lookups. They are treated in the same way as a timeout, and this option
17650 applies to all of them.
17651
17652
17653
17654 .option pass_router routers string unset
17655 .cindex "router" "go to after &""pass""&"
17656 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17657 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17658 routing to continue, and overriding a false setting of &%more%&. When one of
17659 these routers returns &"pass"&, the address is normally handed on to the next
17660 router in sequence. This can be changed by setting &%pass_router%& to the name
17661 of another router. However (unlike &%redirect_router%&) the named router must
17662 be below the current router, to avoid loops. Note that this option applies only
17663 to the special case of &"pass"&. It does not apply when a router returns
17664 &"decline"& because it cannot handle an address.
17665
17666
17667
17668 .option redirect_router routers string unset
17669 .cindex "router" "start at after redirection"
17670 Sometimes an administrator knows that it is pointless to reprocess addresses
17671 generated from alias or forward files with the same router again. For
17672 example, if an alias file translates real names into login ids there is no
17673 point searching the alias file a second time, especially if it is a large file.
17674
17675 The &%redirect_router%& option can be set to the name of any router instance.
17676 It causes the routing of any generated addresses to start at the named router
17677 instead of at the first router. This option has no effect if the router in
17678 which it is set does not generate new addresses.
17679
17680
17681
17682 .option require_files routers&!? "string list&!!" unset
17683 .cindex "file" "requiring for router"
17684 .cindex "router" "requiring file existence"
17685 This option provides a general mechanism for predicating the running of a
17686 router on the existence or non-existence of certain files or directories.
17687 Before running a router, as one of its precondition tests, Exim works its way
17688 through the &%require_files%& list, expanding each item separately.
17689
17690 Because the list is split before expansion, any colons in expansion items must
17691 be doubled, or the facility for using a different list separator must be used.
17692 If any expansion is forced to fail, the item is ignored. Other expansion
17693 failures cause routing of the address to be deferred.
17694
17695 If any expanded string is empty, it is ignored. Otherwise, except as described
17696 below, each string must be a fully qualified file path, optionally preceded by
17697 &"!"&. The paths are passed to the &[stat()]& function to test for the
17698 existence of the files or directories. The router is skipped if any paths not
17699 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17700
17701 .cindex "NFS"
17702 If &[stat()]& cannot determine whether a file exists or not, delivery of
17703 the message is deferred. This can happen when NFS-mounted filesystems are
17704 unavailable.
17705
17706 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17707 options, so you cannot use it to check for the existence of a file in which to
17708 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17709 full list of the order in which preconditions are evaluated.) However, as
17710 these options are all expanded, you can use the &%exists%& expansion condition
17711 to make such tests. The &%require_files%& option is intended for checking files
17712 that the router may be going to use internally, or which are needed by a
17713 transport (for example &_.procmailrc_&).
17714
17715 During delivery, the &[stat()]& function is run as root, but there is a
17716 facility for some checking of the accessibility of a file by another user.
17717 This is not a proper permissions check, but just a &"rough"& check that
17718 operates as follows:
17719
17720 If an item in a &%require_files%& list does not contain any forward slash
17721 characters, it is taken to be the user (and optional group, separated by a
17722 comma) to be checked for subsequent files in the list. If no group is specified
17723 but the user is specified symbolically, the gid associated with the uid is
17724 used. For example:
17725 .code
17726 require_files = mail:/some/file
17727 require_files = $local_part:$home/.procmailrc
17728 .endd
17729 If a user or group name in a &%require_files%& list does not exist, the
17730 &%require_files%& condition fails.
17731
17732 Exim performs the check by scanning along the components of the file path, and
17733 checking the access for the given uid and gid. It checks for &"x"& access on
17734 directories, and &"r"& access on the final file. Note that this means that file
17735 access control lists, if the operating system has them, are ignored.
17736
17737 &*Warning 1*&: When the router is being run to verify addresses for an
17738 incoming SMTP message, Exim is not running as root, but under its own uid. This
17739 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17740 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17741 user is not permitted to read one of the directories on the file's path.
17742
17743 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17744 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17745 without root access. In this case, if a check for access by a particular user
17746 is requested, Exim creates a subprocess that runs as that user, and tries the
17747 check again in that process.
17748
17749 The default action for handling an unresolved EACCES is to consider it to
17750 be caused by a configuration error, and routing is deferred because the
17751 existence or non-existence of the file cannot be determined. However, in some
17752 circumstances it may be desirable to treat this condition as if the file did
17753 not exist. If the file name (or the exclamation mark that precedes the file
17754 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17755 as if the file did not exist. For example:
17756 .code
17757 require_files = +/some/file
17758 .endd
17759 If the router is not an essential part of verification (for example, it
17760 handles users' &_.forward_& files), another solution is to set the &%verify%&
17761 option false so that the router is skipped when verifying.
17762
17763
17764
17765 .option retry_use_local_part routers boolean "see below"
17766 .cindex "hints database" "retry keys"
17767 .cindex "local part" "in retry keys"
17768 When a delivery suffers a temporary routing failure, a retry record is created
17769 in Exim's hints database. For addresses whose routing depends only on the
17770 domain, the key for the retry record should not involve the local part, but for
17771 other addresses, both the domain and the local part should be included.
17772 Usually, remote routing is of the former kind, and local routing is of the
17773 latter kind.
17774
17775 This option controls whether the local part is used to form the key for retry
17776 hints for addresses that suffer temporary errors while being handled by this
17777 router. The default value is true for any router that has &%check_local_user%&
17778 set, and false otherwise. Note that this option does not apply to hints keys
17779 for transport delays; they are controlled by a generic transport option of the
17780 same name.
17781
17782 The setting of &%retry_use_local_part%& applies only to the router on which it
17783 appears. If the router generates child addresses, they are routed
17784 independently; this setting does not become attached to them.
17785
17786
17787
17788 .option router_home_directory routers string&!! unset
17789 .cindex "router" "home directory for"
17790 .cindex "home directory" "for router"
17791 .vindex "&$home$&"
17792 This option sets a home directory for use while the router is running. (Compare
17793 &%transport_home_directory%&, which sets a home directory for later
17794 transporting.) In particular, if used on a &(redirect)& router, this option
17795 sets a value for &$home$& while a filter is running. The value is expanded;
17796 forced expansion failure causes the option to be ignored &-- other failures
17797 cause the router to defer.
17798
17799 Expansion of &%router_home_directory%& happens immediately after the
17800 &%check_local_user%& test (if configured), before any further expansions take
17801 place.
17802 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17803 are evaluated.)
17804 While the router is running, &%router_home_directory%& overrides the value of
17805 &$home$& that came from &%check_local_user%&.
17806
17807 When a router accepts an address and assigns it to a local transport (including
17808 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17809 delivery), the home directory setting for the transport is taken from the first
17810 of these values that is set:
17811
17812 .ilist
17813 The &%home_directory%& option on the transport;
17814 .next
17815 The &%transport_home_directory%& option on the router;
17816 .next
17817 The password data if &%check_local_user%& is set on the router;
17818 .next
17819 The &%router_home_directory%& option on the router.
17820 .endlist
17821
17822 In other words, &%router_home_directory%& overrides the password data for the
17823 router, but not for the transport.
17824
17825
17826
17827 .option self routers string freeze
17828 .cindex "MX record" "pointing to local host"
17829 .cindex "local host" "MX pointing to"
17830 This option applies to those routers that use a recipient address to find a
17831 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17832 and &(manualroute)& routers.
17833 Certain configurations of the &(queryprogram)& router can also specify a list
17834 of remote hosts.
17835 Usually such routers are configured to send the message to a remote host via an
17836 &(smtp)& transport. The &%self%& option specifies what happens when the first
17837 host on the list turns out to be the local host.
17838 The way in which Exim checks for the local host is described in section
17839 &<<SECTreclocipadd>>&.
17840
17841 Normally this situation indicates either an error in Exim's configuration (for
17842 example, the router should be configured not to process this domain), or an
17843 error in the DNS (for example, the MX should not point to this host). For this
17844 reason, the default action is to log the incident, defer the address, and
17845 freeze the message. The following alternatives are provided for use in special
17846 cases:
17847
17848 .vlist
17849 .vitem &%defer%&
17850 Delivery of the message is tried again later, but the message is not frozen.
17851
17852 .vitem "&%reroute%&: <&'domain'&>"
17853 The domain is changed to the given domain, and the address is passed back to
17854 be reprocessed by the routers. No rewriting of headers takes place. This
17855 behaviour is essentially a redirection.
17856
17857 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17858 The domain is changed to the given domain, and the address is passed back to be
17859 reprocessed by the routers. Any headers that contain the original domain are
17860 rewritten.
17861
17862 .vitem &%pass%&
17863 .oindex "&%more%&"
17864 .vindex "&$self_hostname$&"
17865 The router passes the address to the next router, or to the router named in the
17866 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17867 subsequent routing and delivery, the variable &$self_hostname$& contains the
17868 name of the local host that the router encountered. This can be used to
17869 distinguish between different cases for hosts with multiple names. The
17870 combination
17871 .code
17872 self = pass
17873 no_more
17874 .endd
17875 ensures that only those addresses that routed to the local host are passed on.
17876 Without &%no_more%&, addresses that were declined for other reasons would also
17877 be passed to the next router.
17878
17879 .vitem &%fail%&
17880 Delivery fails and an error report is generated.
17881
17882 .vitem &%send%&
17883 .cindex "local host" "sending to"
17884 The anomaly is ignored and the address is queued for the transport. This
17885 setting should be used with extreme caution. For an &(smtp)& transport, it
17886 makes sense only in cases where the program that is listening on the SMTP port
17887 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17888 different configuration file that handles the domain in another way.
17889 .endlist
17890
17891
17892
17893 .option senders routers&!? "address list&!!" unset
17894 .cindex "router" "checking senders"
17895 If this option is set, the router is skipped unless the message's sender
17896 address matches something on the list.
17897 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17898 are evaluated.
17899
17900 There are issues concerning verification when the running of routers is
17901 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17902 setting, it sets the sender to the null string. When using the &%-bt%& option
17903 to check a configuration file, it is necessary also to use the &%-f%& option to
17904 set an appropriate sender. For incoming mail, the sender is unset when
17905 verifying the sender, but is available when verifying any recipients. If the
17906 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17907 matters.
17908
17909
17910 .option translate_ip_address routers string&!! unset
17911 .cindex "IP address" "translating"
17912 .cindex "packet radio"
17913 .cindex "router" "IP address translation"
17914 There exist some rare networking situations (for example, packet radio) where
17915 it is helpful to be able to translate IP addresses generated by normal routing
17916 mechanisms into other IP addresses, thus performing a kind of manual IP
17917 routing. This should be done only if the normal IP routing of the TCP/IP stack
17918 is inadequate or broken. Because this is an extremely uncommon requirement, the
17919 code to support this option is not included in the Exim binary unless
17920 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17921
17922 .vindex "&$host_address$&"
17923 The &%translate_ip_address%& string is expanded for every IP address generated
17924 by the router, with the generated address set in &$host_address$&. If the
17925 expansion is forced to fail, no action is taken.
17926 For any other expansion error, delivery of the message is deferred.
17927 If the result of the expansion is an IP address, that replaces the original
17928 address; otherwise the result is assumed to be a host name &-- this is looked
17929 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17930 produce one or more replacement IP addresses. For example, to subvert all IP
17931 addresses in some specific networks, this could be added to a router:
17932 .code
17933 translate_ip_address = \
17934   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17935     {$value}fail}}
17936 .endd
17937 The file would contain lines like
17938 .code
17939 10.2.3.128/26    some.host
17940 10.8.4.34/26     10.44.8.15
17941 .endd
17942 You should not make use of this facility unless you really understand what you
17943 are doing.
17944
17945
17946
17947 .option transport routers string&!! unset
17948 This option specifies the transport to be used when a router accepts an address
17949 and sets it up for delivery. A transport is never needed if a router is used
17950 only for verification. The value of the option is expanded at routing time,
17951 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17952 and result must be the name of one of the configured transports. If it is not,
17953 delivery is deferred.
17954
17955 The &%transport%& option is not used by the &(redirect)& router, but it does
17956 have some private options that set up transports for pipe and file deliveries
17957 (see chapter &<<CHAPredirect>>&).
17958
17959
17960
17961 .option transport_current_directory routers string&!! unset
17962 .cindex "current directory for local transport"
17963 This option associates a current directory with any address that is routed
17964 to a local transport. This can happen either because a transport is
17965 explicitly configured for the router, or because it generates a delivery to a
17966 file or a pipe. During the delivery process (that is, at transport time), this
17967 option string is expanded and is set as the current directory, unless
17968 overridden by a setting on the transport.
17969 If the expansion fails for any reason, including forced failure, an error is
17970 logged, and delivery is deferred.
17971 See chapter &<<CHAPenvironment>>& for details of the local delivery
17972 environment.
17973
17974
17975
17976
17977 .option transport_home_directory routers string&!! "see below"
17978 .cindex "home directory" "for local transport"
17979 This option associates a home directory with any address that is routed to a
17980 local transport. This can happen either because a transport is explicitly
17981 configured for the router, or because it generates a delivery to a file or a
17982 pipe. During the delivery process (that is, at transport time), the option
17983 string is expanded and is set as the home directory, unless overridden by a
17984 setting of &%home_directory%& on the transport.
17985 If the expansion fails for any reason, including forced failure, an error is
17986 logged, and delivery is deferred.
17987
17988 If the transport does not specify a home directory, and
17989 &%transport_home_directory%& is not set for the router, the home directory for
17990 the transport is taken from the password data if &%check_local_user%& is set for
17991 the router. Otherwise it is taken from &%router_home_directory%& if that option
17992 is set; if not, no home directory is set for the transport.
17993
17994 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17995 environment.
17996
17997
17998
17999
18000 .option unseen routers boolean&!! false
18001 .cindex "router" "carrying on after success"
18002 The result of string expansion for this option must be a valid boolean value,
18003 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18004 result causes an error, and delivery is deferred. If the expansion is forced to
18005 fail, the default value for the option (false) is used. Other failures cause
18006 delivery to be deferred.
18007
18008 When this option is set true, routing does not cease if the router accepts the
18009 address. Instead, a copy of the incoming address is passed to the next router,
18010 overriding a false setting of &%more%&. There is little point in setting
18011 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18012 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18013 sometimes true and sometimes false).
18014
18015 .cindex "copy of message (&%unseen%& option)"
18016 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18017 qualifier in filter files. It can be used to cause copies of messages to be
18018 delivered to some other destination, while also carrying out a normal delivery.
18019 In effect, the current address is made into a &"parent"& that has two children
18020 &-- one that is delivered as specified by this router, and a clone that goes on
18021 to be routed further. For this reason, &%unseen%& may not be combined with the
18022 &%one_time%& option in a &(redirect)& router.
18023
18024 &*Warning*&: Header lines added to the address (or specified for removal) by
18025 this router or by previous routers affect the &"unseen"& copy of the message
18026 only. The clone that continues to be processed by further routers starts with
18027 no added headers and none specified for removal. For a &%redirect%& router, if
18028 a generated address is the same as the incoming address, this can lead to
18029 duplicate addresses with different header modifications. Exim does not do
18030 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18031 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18032 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18033 &%redirect%& router may be of help.
18034
18035 Unlike the handling of header modifications, any data that was set by the
18036 &%address_data%& option in the current or previous routers &'is'& passed on to
18037 subsequent routers.
18038
18039
18040 .option user routers string&!! "see below"
18041 .cindex "uid (user id)" "local delivery"
18042 .cindex "local transports" "uid and gid"
18043 .cindex "transport" "local"
18044 .cindex "router" "user for filter processing"
18045 .cindex "filter" "user for processing"
18046 When a router queues an address for a transport, and the transport does not
18047 specify a user, the user given here is used when running the delivery process.
18048 The user may be specified numerically or by name. If expansion fails, the
18049 error is logged and delivery is deferred.
18050 This user is also used by the &(redirect)& router when running a filter file.
18051 The default is unset, except when &%check_local_user%& is set. In this case,
18052 the default is taken from the password information. If the user is specified as
18053 a name, and &%group%& is not set, the group associated with the user is used.
18054 See also &%initgroups%& and &%group%& and the discussion in chapter
18055 &<<CHAPenvironment>>&.
18056
18057
18058
18059 .option verify routers&!? boolean true
18060 Setting this option has the effect of setting &%verify_sender%& and
18061 &%verify_recipient%& to the same value.
18062
18063
18064 .option verify_only routers&!? boolean false
18065 .cindex "EXPN" "with &%verify_only%&"
18066 .oindex "&%-bv%&"
18067 .cindex "router" "used only when verifying"
18068 If this option is set, the router is used only when verifying an address,
18069 delivering in cutthrough mode or
18070 testing with the &%-bv%& option, not when actually doing a delivery, testing
18071 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18072 restricted to verifying only senders or recipients by means of
18073 &%verify_sender%& and &%verify_recipient%&.
18074
18075 &*Warning*&: When the router is being run to verify addresses for an incoming
18076 SMTP message, Exim is not running as root, but under its own uid. If the router
18077 accesses any files, you need to make sure that they are accessible to the Exim
18078 user or group.
18079
18080
18081 .option verify_recipient routers&!? boolean true
18082 If this option is false, the router is skipped when verifying recipient
18083 addresses,
18084 delivering in cutthrough mode
18085 or testing recipient verification using &%-bv%&.
18086 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18087 are evaluated.
18088 See also the &$verify_mode$& variable.
18089
18090
18091 .option verify_sender routers&!? boolean true
18092 If this option is false, the router is skipped when verifying sender addresses
18093 or testing sender verification using &%-bvs%&.
18094 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18095 are evaluated.
18096 See also the &$verify_mode$& variable.
18097 .ecindex IIDgenoprou1
18098 .ecindex IIDgenoprou2
18099
18100
18101
18102
18103
18104
18105 . ////////////////////////////////////////////////////////////////////////////
18106 . ////////////////////////////////////////////////////////////////////////////
18107
18108 .chapter "The accept router" "CHID4"
18109 .cindex "&(accept)& router"
18110 .cindex "routers" "&(accept)&"
18111 The &(accept)& router has no private options of its own. Unless it is being
18112 used purely for verification (see &%verify_only%&) a transport is required to
18113 be defined by the generic &%transport%& option. If the preconditions that are
18114 specified by generic options are met, the router accepts the address and queues
18115 it for the given transport. The most common use of this router is for setting
18116 up deliveries to local mailboxes. For example:
18117 .code
18118 localusers:
18119   driver = accept
18120   domains = mydomain.example
18121   check_local_user
18122   transport = local_delivery
18123 .endd
18124 The &%domains%& condition in this example checks the domain of the address, and
18125 &%check_local_user%& checks that the local part is the login of a local user.
18126 When both preconditions are met, the &(accept)& router runs, and queues the
18127 address for the &(local_delivery)& transport.
18128
18129
18130
18131
18132
18133
18134 . ////////////////////////////////////////////////////////////////////////////
18135 . ////////////////////////////////////////////////////////////////////////////
18136
18137 .chapter "The dnslookup router" "CHAPdnslookup"
18138 .scindex IIDdnsrou1 "&(dnslookup)& router"
18139 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18140 The &(dnslookup)& router looks up the hosts that handle mail for the
18141 recipient's domain in the DNS. A transport must always be set for this router,
18142 unless &%verify_only%& is set.
18143
18144 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18145 SRV records. If none are found, or if SRV support is not configured,
18146 MX records are looked up. If no MX records exist, address records are sought.
18147 However, &%mx_domains%& can be set to disable the direct use of address
18148 records.
18149
18150 MX records of equal priority are sorted by Exim into a random order. Exim then
18151 looks for address records for the host names obtained from MX or SRV records.
18152 When a host has more than one IP address, they are sorted into a random order,
18153 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18154 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18155 generic option, the router declines.
18156
18157 Unless they have the highest priority (lowest MX value), MX records that point
18158 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18159 are discarded, together with any other MX records of equal or lower priority.
18160
18161 .cindex "MX record" "pointing to local host"
18162 .cindex "local host" "MX pointing to"
18163 .oindex "&%self%&" "in &(dnslookup)& router"
18164 If the host pointed to by the highest priority MX record, or looked up as an
18165 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18166 happens is controlled by the generic &%self%& option.
18167
18168
18169 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18170 There have been problems with DNS servers when SRV records are looked up.
18171 Some misbehaving servers return a DNS error or timeout when a non-existent
18172 SRV record is sought. Similar problems have in the past been reported for
18173 MX records. The global &%dns_again_means_nonexist%& option can help with this
18174 problem, but it is heavy-handed because it is a global option.
18175
18176 For this reason, there are two options, &%srv_fail_domains%& and
18177 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18178 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18179 an attempt to look up an SRV or MX record causes one of these results, and the
18180 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18181 such record"&. In the case of an SRV lookup, this means that the router
18182 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18183 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18184 case routing fails.
18185
18186
18187 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18188 .cindex "&(dnslookup)& router" "declines"
18189 There are a few cases where a &(dnslookup)& router will decline to accept
18190 an address; if such a router is expected to handle "all remaining non-local
18191 domains", then it is important to set &%no_more%&.
18192
18193 The router will defer rather than decline if the domain
18194 is found in the &%fail_defer_domains%& router option.
18195
18196 Reasons for a &(dnslookup)& router to decline currently include:
18197 .ilist
18198 The domain does not exist in DNS
18199 .next
18200 The domain exists but the MX record's host part is just "."; this is a common
18201 convention (borrowed from SRV) used to indicate that there is no such service
18202 for this domain and to not fall back to trying A/AAAA records.
18203 .next
18204 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18205 .next
18206 MX record points to a non-existent host.
18207 .next
18208 MX record points to an IP address and the main section option
18209 &%allow_mx_to_ip%& is not set.
18210 .next
18211 MX records exist and point to valid hosts, but all hosts resolve only to
18212 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18213 .next
18214 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18215 &%dns_check_names_pattern%& for handling one variant of this)
18216 .next
18217 &%check_secondary_mx%& is set on this router but the local host can
18218 not be found in the MX records (see below)
18219 .endlist
18220
18221
18222
18223
18224 .section "Private options for dnslookup" "SECID118"
18225 .cindex "options" "&(dnslookup)& router"
18226 The private options for the &(dnslookup)& router are as follows:
18227
18228 .option check_secondary_mx dnslookup boolean false
18229 .cindex "MX record" "checking for secondary"
18230 If this option is set, the router declines unless the local host is found in
18231 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18232 process domains for which the local host is a secondary mail exchanger
18233 differently to other domains. The way in which Exim decides whether a host is
18234 the local host is described in section &<<SECTreclocipadd>>&.
18235
18236
18237 .option check_srv dnslookup string&!! unset
18238 .cindex "SRV record" "enabling use of"
18239 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18240 addition to MX and address records. The support is disabled by default. To
18241 enable SRV support, set the &%check_srv%& option to the name of the service
18242 required. For example,
18243 .code
18244 check_srv = smtp
18245 .endd
18246 looks for SRV records that refer to the normal smtp service. The option is
18247 expanded, so the service name can vary from message to message or address
18248 to address. This might be helpful if SRV records are being used for a
18249 submission service. If the expansion is forced to fail, the &%check_srv%&
18250 option is ignored, and the router proceeds to look for MX records in the
18251 normal way.
18252
18253 When the expansion succeeds, the router searches first for SRV records for
18254 the given service (it assumes TCP protocol). A single SRV record with a
18255 host name that consists of just a single dot indicates &"no such service for
18256 this domain"&; if this is encountered, the router declines. If other kinds of
18257 SRV record are found, they are used to construct a host list for delivery
18258 according to the rules of RFC 2782. MX records are not sought in this case.
18259
18260 When no SRV records are found, MX records (and address records) are sought in
18261 the traditional way. In other words, SRV records take precedence over MX
18262 records, just as MX records take precedence over address records. Note that
18263 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18264 defined it. It is apparently believed that MX records are sufficient for email
18265 and that SRV records should not be used for this purpose. However, SRV records
18266 have an additional &"weight"& feature which some people might find useful when
18267 trying to split an SMTP load between hosts of different power.
18268
18269 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18270 when there is a DNS lookup error.
18271
18272
18273
18274
18275 .option fail_defer_domains dnslookup "domain list&!!" unset
18276 .cindex "MX record" "not found"
18277 DNS lookups for domains matching &%fail_defer_domains%&
18278 which find no matching record will cause the router to defer
18279 rather than the default behaviour of decline.
18280 This maybe be useful for queueing messages for a newly created
18281 domain while the DNS configuration is not ready.
18282 However, it will result in any message with mistyped domains
18283 also being queued.
18284
18285
18286 .option mx_domains dnslookup "domain list&!!" unset
18287 .cindex "MX record" "required to exist"
18288 .cindex "SRV record" "required to exist"
18289 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18290 record in order to be recognized. (The name of this option could be improved.)
18291 For example, if all the mail hosts in &'fict.example'& are known to have MX
18292 records, except for those in &'discworld.fict.example'&, you could use this
18293 setting:
18294 .code
18295 mx_domains = ! *.discworld.fict.example : *.fict.example
18296 .endd
18297 This specifies that messages addressed to a domain that matches the list but
18298 has no MX record should be bounced immediately instead of being routed using
18299 the address record.
18300
18301
18302 .option mx_fail_domains dnslookup "domain list&!!" unset
18303 If the DNS lookup for MX records for one of the domains in this list causes a
18304 DNS lookup error, Exim behaves as if no MX records were found. See section
18305 &<<SECTprowitdnsloo>>& for more discussion.
18306
18307
18308
18309
18310 .option qualify_single dnslookup boolean true
18311 .cindex "DNS" "resolver options"
18312 .cindex "DNS" "qualifying single-component names"
18313 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18314 lookups. Typically, but not standardly, this causes the resolver to qualify
18315 single-component names with the default domain. For example, on a machine
18316 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18317 &'thesaurus.ref.example'& inside the resolver. For details of what your
18318 resolver actually does, consult your man pages for &'resolver'& and
18319 &'resolv.conf'&.
18320
18321
18322
18323 .option rewrite_headers dnslookup boolean true
18324 .cindex "rewriting" "header lines"
18325 .cindex "header lines" "rewriting"
18326 If the domain name in the address that is being processed is not fully
18327 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18328 an address is specified as &'dormouse@teaparty'&, the domain might be
18329 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18330 occur as a result of setting the &%widen_domains%& option. If
18331 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18332 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18333 header lines of the message are rewritten with the full domain name.
18334
18335 This option should be turned off only when it is known that no message is
18336 ever going to be sent outside an environment where the abbreviation makes
18337 sense.
18338
18339 When an MX record is looked up in the DNS and matches a wildcard record, name
18340 servers normally return a record containing the name that has been looked up,
18341 making it impossible to detect whether a wildcard was present or not. However,
18342 some name servers have recently been seen to return the wildcard entry. If the
18343 name returned by a DNS lookup begins with an asterisk, it is not used for
18344 header rewriting.
18345
18346
18347 .option same_domain_copy_routing dnslookup boolean false
18348 .cindex "address" "copying routing"
18349 Addresses with the same domain are normally routed by the &(dnslookup)& router
18350 to the same list of hosts. However, this cannot be presumed, because the router
18351 options and preconditions may refer to the local part of the address. By
18352 default, therefore, Exim routes each address in a message independently. DNS
18353 servers run caches, so repeated DNS lookups are not normally expensive, and in
18354 any case, personal messages rarely have more than a few recipients.
18355
18356 If you are running mailing lists with large numbers of subscribers at the same
18357 domain, and you are using a &(dnslookup)& router which is independent of the
18358 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18359 lookups for identical domains in one message. In this case, when &(dnslookup)&
18360 routes an address to a remote transport, any other unrouted addresses in the
18361 message that have the same domain are automatically given the same routing
18362 without processing them independently,
18363 provided the following conditions are met:
18364
18365 .ilist
18366 No router that processed the address specified &%headers_add%& or
18367 &%headers_remove%&.
18368 .next
18369 The router did not change the address in any way, for example, by &"widening"&
18370 the domain.
18371 .endlist
18372
18373
18374
18375
18376 .option search_parents dnslookup boolean false
18377 .cindex "DNS" "resolver options"
18378 When this option is true, the resolver option RES_DNSRCH is set for DNS
18379 lookups. This is different from the &%qualify_single%& option in that it
18380 applies to domains containing dots. Typically, but not standardly, it causes
18381 the resolver to search for the name in the current domain and in parent
18382 domains. For example, on a machine in the &'fict.example'& domain, if looking
18383 up &'teaparty.wonderland'& failed, the resolver would try
18384 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18385 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18386
18387 Setting this option true can cause problems in domains that have a wildcard MX
18388 record, because any domain that does not have its own MX record matches the
18389 local wildcard.
18390
18391
18392
18393 .option srv_fail_domains dnslookup "domain list&!!" unset
18394 If the DNS lookup for SRV records for one of the domains in this list causes a
18395 DNS lookup error, Exim behaves as if no SRV records were found. See section
18396 &<<SECTprowitdnsloo>>& for more discussion.
18397
18398
18399
18400
18401 .option widen_domains dnslookup "string list" unset
18402 .cindex "domain" "partial; widening"
18403 If a DNS lookup fails and this option is set, each of its strings in turn is
18404 added onto the end of the domain, and the lookup is tried again. For example,
18405 if
18406 .code
18407 widen_domains = fict.example:ref.example
18408 .endd
18409 is set and a lookup of &'klingon.dictionary'& fails,
18410 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18411 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18412 and &%search_parents%& options can cause some widening to be undertaken inside
18413 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18414 when verifying, unless &%rewrite_headers%& is false (not the default).
18415
18416
18417 .section "Effect of qualify_single and search_parents" "SECID119"
18418 When a domain from an envelope recipient is changed by the resolver as a result
18419 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18420 corresponding address in the message's header lines unless &%rewrite_headers%&
18421 is set false. Exim then re-routes the address, using the full domain.
18422
18423 These two options affect only the DNS lookup that takes place inside the router
18424 for the domain of the address that is being routed. They do not affect lookups
18425 such as that implied by
18426 .code
18427 domains = @mx_any
18428 .endd
18429 that may happen while processing a router precondition before the router is
18430 entered. No widening ever takes place for these lookups.
18431 .ecindex IIDdnsrou1
18432 .ecindex IIDdnsrou2
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442 . ////////////////////////////////////////////////////////////////////////////
18443 . ////////////////////////////////////////////////////////////////////////////
18444
18445 .chapter "The ipliteral router" "CHID5"
18446 .cindex "&(ipliteral)& router"
18447 .cindex "domain literal" "routing"
18448 .cindex "routers" "&(ipliteral)&"
18449 This router has no private options. Unless it is being used purely for
18450 verification (see &%verify_only%&) a transport is required to be defined by the
18451 generic &%transport%& option. The router accepts the address if its domain part
18452 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18453 router handles the address
18454 .code
18455 root@[192.168.1.1]
18456 .endd
18457 by setting up delivery to the host with that IP address. IPv4 domain literals
18458 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18459 are similar, but the address is preceded by &`ipv6:`&. For example:
18460 .code
18461 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18462 .endd
18463 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18464 grounds that sooner or later somebody will try it.
18465
18466 .oindex "&%self%&" "in &(ipliteral)& router"
18467 If the IP address matches something in &%ignore_target_hosts%&, the router
18468 declines. If an IP literal turns out to refer to the local host, the generic
18469 &%self%& option determines what happens.
18470
18471 The RFCs require support for domain literals; however, their use is
18472 controversial in today's Internet. If you want to use this router, you must
18473 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18474 Exim will not recognize the domain literal syntax in addresses.
18475
18476
18477
18478 . ////////////////////////////////////////////////////////////////////////////
18479 . ////////////////////////////////////////////////////////////////////////////
18480
18481 .chapter "The iplookup router" "CHID6"
18482 .cindex "&(iplookup)& router"
18483 .cindex "routers" "&(iplookup)&"
18484 The &(iplookup)& router was written to fulfil a specific requirement in
18485 Cambridge University (which in fact no longer exists). For this reason, it is
18486 not included in the binary of Exim by default. If you want to include it, you
18487 must set
18488 .code
18489 ROUTER_IPLOOKUP=yes
18490 .endd
18491 in your &_Local/Makefile_& configuration file.
18492
18493 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18494 connection to one or more specific hosts. The host can then return the same or
18495 a different address &-- in effect rewriting the recipient address in the
18496 message's envelope. The new address is then passed on to subsequent routers. If
18497 this process fails, the address can be passed on to other routers, or delivery
18498 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18499 must not be specified for it.
18500
18501 .cindex "options" "&(iplookup)& router"
18502 .option hosts iplookup string unset
18503 This option must be supplied. Its value is a colon-separated list of host
18504 names. The hosts are looked up using &[gethostbyname()]&
18505 (or &[getipnodebyname()]& when available)
18506 and are tried in order until one responds to the query. If none respond, what
18507 happens is controlled by &%optional%&.
18508
18509
18510 .option optional iplookup boolean false
18511 If &%optional%& is true, if no response is obtained from any host, the address
18512 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18513 delivery to the address is deferred.
18514
18515
18516 .option port iplookup integer 0
18517 .cindex "port" "&(iplookup)& router"
18518 This option must be supplied. It specifies the port number for the TCP or UDP
18519 call.
18520
18521
18522 .option protocol iplookup string udp
18523 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18524 protocols is to be used.
18525
18526
18527 .option query iplookup string&!! "see below"
18528 This defines the content of the query that is sent to the remote hosts. The
18529 default value is:
18530 .code
18531 $local_part@$domain $local_part@$domain
18532 .endd
18533 The repetition serves as a way of checking that a response is to the correct
18534 query in the default case (see &%response_pattern%& below).
18535
18536
18537 .option reroute iplookup string&!! unset
18538 If this option is not set, the rerouted address is precisely the byte string
18539 returned by the remote host, up to the first white space, if any. If set, the
18540 string is expanded to form the rerouted address. It can include parts matched
18541 in the response by &%response_pattern%& by means of numeric variables such as
18542 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18543 whether or not a pattern is in use. In all cases, the rerouted address must end
18544 up in the form &'local_part@domain'&.
18545
18546
18547 .option response_pattern iplookup string unset
18548 This option can be set to a regular expression that is applied to the string
18549 returned from the remote host. If the pattern does not match the response, the
18550 router declines. If &%response_pattern%& is not set, no checking of the
18551 response is done, unless the query was defaulted, in which case there is a
18552 check that the text returned after the first white space is the original
18553 address. This checks that the answer that has been received is in response to
18554 the correct question. For example, if the response is just a new domain, the
18555 following could be used:
18556 .code
18557 response_pattern = ^([^@]+)$
18558 reroute = $local_part@$1
18559 .endd
18560
18561 .option timeout iplookup time 5s
18562 This specifies the amount of time to wait for a response from the remote
18563 machine. The same timeout is used for the &[connect()]& function for a TCP
18564 call. It does not apply to UDP.
18565
18566
18567
18568
18569 . ////////////////////////////////////////////////////////////////////////////
18570 . ////////////////////////////////////////////////////////////////////////////
18571
18572 .chapter "The manualroute router" "CHID7"
18573 .scindex IIDmanrou1 "&(manualroute)& router"
18574 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18575 .cindex "domain" "manually routing"
18576 The &(manualroute)& router is so-called because it provides a way of manually
18577 routing an address according to its domain. It is mainly used when you want to
18578 route addresses to remote hosts according to your own rules, bypassing the
18579 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18580 route to local transports, a facility that may be useful if you want to save
18581 messages for dial-in hosts in local files.
18582
18583 The &(manualroute)& router compares a list of domain patterns with the domain
18584 it is trying to route. If there is no match, the router declines. Each pattern
18585 has associated with it a list of hosts and some other optional data, which may
18586 include a transport. The combination of a pattern and its data is called a
18587 &"routing rule"&. For patterns that do not have an associated transport, the
18588 generic &%transport%& option must specify a transport, unless the router is
18589 being used purely for verification (see &%verify_only%&).
18590
18591 .vindex "&$host$&"
18592 In the case of verification, matching the domain pattern is sufficient for the
18593 router to accept the address. When actually routing an address for delivery,
18594 an address that matches a domain pattern is queued for the associated
18595 transport. If the transport is not a local one, a host list must be associated
18596 with the pattern; IP addresses are looked up for the hosts, and these are
18597 passed to the transport along with the mail address. For local transports, a
18598 host list is optional. If it is present, it is passed in &$host$& as a single
18599 text string.
18600
18601 The list of routing rules can be provided as an inline string in
18602 &%route_list%&, or the data can be obtained by looking up the domain in a file
18603 or database by setting &%route_data%&. Only one of these settings may appear in
18604 any one instance of &(manualroute)&. The format of routing rules is described
18605 below, following the list of private options.
18606
18607
18608 .section "Private options for manualroute" "SECTprioptman"
18609
18610 .cindex "options" "&(manualroute)& router"
18611 The private options for the &(manualroute)& router are as follows:
18612
18613 .option host_all_ignored manualroute string defer
18614 See &%host_find_failed%&.
18615
18616 .option host_find_failed manualroute string freeze
18617 This option controls what happens when &(manualroute)& tries to find an IP
18618 address for a host, and the host does not exist. The option can be set to one
18619 of the following values:
18620 .code
18621 decline
18622 defer
18623 fail
18624 freeze
18625 ignore
18626 pass
18627 .endd
18628 The default (&"freeze"&) assumes that this state is a serious configuration
18629 error. The difference between &"pass"& and &"decline"& is that the former
18630 forces the address to be passed to the next router (or the router defined by
18631 &%pass_router%&),
18632 .oindex "&%more%&"
18633 overriding &%no_more%&, whereas the latter passes the address to the next
18634 router only if &%more%& is true.
18635
18636 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18637 cannot be found. If all the hosts in the list are ignored, the behaviour is
18638 controlled by the &%host_all_ignored%& option. This takes the same values
18639 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18640
18641 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18642 state; if a host lookup gets a temporary error, delivery is deferred unless the
18643 generic &%pass_on_timeout%& option is set.
18644
18645
18646 .option hosts_randomize manualroute boolean false
18647 .cindex "randomized host list"
18648 .cindex "host" "list of; randomized"
18649 If this option is set, the order of the items in a host list in a routing rule
18650 is randomized each time the list is used, unless an option in the routing rule
18651 overrides (see below). Randomizing the order of a host list can be used to do
18652 crude load sharing. However, if more than one mail address is routed by the
18653 same router to the same host list, the host lists are considered to be the same
18654 (even though they may be randomized into different orders) for the purpose of
18655 deciding whether to batch the deliveries into a single SMTP transaction.
18656
18657 When &%hosts_randomize%& is true, a host list may be split
18658 into groups whose order is separately randomized. This makes it possible to
18659 set up MX-like behaviour. The boundaries between groups are indicated by an
18660 item that is just &`+`& in the host list. For example:
18661 .code
18662 route_list = * host1:host2:host3:+:host4:host5
18663 .endd
18664 The order of the first three hosts and the order of the last two hosts is
18665 randomized for each use, but the first three always end up before the last two.
18666 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18667 randomized host list is passed to an &(smtp)& transport that also has
18668 &%hosts_randomize set%&, the list is not re-randomized.
18669
18670
18671 .option route_data manualroute string&!! unset
18672 If this option is set, it must expand to yield the data part of a routing rule.
18673 Typically, the expansion string includes a lookup based on the domain. For
18674 example:
18675 .code
18676 route_data = ${lookup{$domain}dbm{/etc/routes}}
18677 .endd
18678 If the expansion is forced to fail, or the result is an empty string, the
18679 router declines. Other kinds of expansion failure cause delivery to be
18680 deferred.
18681
18682
18683 .option route_list manualroute "string list" unset
18684 This string is a list of routing rules, in the form defined below. Note that,
18685 unlike most string lists, the items are separated by semicolons. This is so
18686 that they may contain colon-separated host lists.
18687
18688
18689 .option same_domain_copy_routing manualroute boolean false
18690 .cindex "address" "copying routing"
18691 Addresses with the same domain are normally routed by the &(manualroute)&
18692 router to the same list of hosts. However, this cannot be presumed, because the
18693 router options and preconditions may refer to the local part of the address. By
18694 default, therefore, Exim routes each address in a message independently. DNS
18695 servers run caches, so repeated DNS lookups are not normally expensive, and in
18696 any case, personal messages rarely have more than a few recipients.
18697
18698 If you are running mailing lists with large numbers of subscribers at the same
18699 domain, and you are using a &(manualroute)& router which is independent of the
18700 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18701 lookups for identical domains in one message. In this case, when
18702 &(manualroute)& routes an address to a remote transport, any other unrouted
18703 addresses in the message that have the same domain are automatically given the
18704 same routing without processing them independently. However, this is only done
18705 if &%headers_add%& and &%headers_remove%& are unset.
18706
18707
18708
18709
18710 .section "Routing rules in route_list" "SECID120"
18711 The value of &%route_list%& is a string consisting of a sequence of routing
18712 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18713 entered as two semicolons. Alternatively, the list separator can be changed as
18714 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18715 Empty rules are ignored. The format of each rule is
18716 .display
18717 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18718 .endd
18719 The following example contains two rules, each with a simple domain pattern and
18720 no options:
18721 .code
18722 route_list = \
18723   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18724   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18725 .endd
18726 The three parts of a rule are separated by white space. The pattern and the
18727 list of hosts can be enclosed in quotes if necessary, and if they are, the
18728 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18729 single domain pattern, which is the only mandatory item in the rule. The
18730 pattern is in the same format as one item in a domain list (see section
18731 &<<SECTdomainlist>>&),
18732 except that it may not be the name of an interpolated file.
18733 That is, it may be wildcarded, or a regular expression, or a file or database
18734 lookup (with semicolons doubled, because of the use of semicolon as a separator
18735 in a &%route_list%&).
18736
18737 The rules in &%route_list%& are searched in order until one of the patterns
18738 matches the domain that is being routed. The list of hosts and then options are
18739 then used as described below. If there is no match, the router declines. When
18740 &%route_list%& is set, &%route_data%& must not be set.
18741
18742
18743
18744 .section "Routing rules in route_data" "SECID121"
18745 The use of &%route_list%& is convenient when there are only a small number of
18746 routing rules. For larger numbers, it is easier to use a file or database to
18747 hold the routing information, and use the &%route_data%& option instead.
18748 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18749 Most commonly, &%route_data%& is set as a string that contains an
18750 expansion lookup. For example, suppose we place two routing rules in a file
18751 like this:
18752 .code
18753 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18754 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18755 .endd
18756 This data can be accessed by setting
18757 .code
18758 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18759 .endd
18760 Failure of the lookup results in an empty string, causing the router to
18761 decline. However, you do not have to use a lookup in &%route_data%&. The only
18762 requirement is that the result of expanding the string is a list of hosts,
18763 possibly followed by options, separated by white space. The list of hosts must
18764 be enclosed in quotes if it contains white space.
18765
18766
18767
18768
18769 .section "Format of the list of hosts" "SECID122"
18770 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18771 always separately expanded before use. If the expansion fails, the router
18772 declines. The result of the expansion must be a colon-separated list of names
18773 and/or IP addresses, optionally also including ports. The format of each item
18774 in the list is described in the next section. The list separator can be changed
18775 as described in section &<<SECTlistconstruct>>&.
18776
18777 If the list of hosts was obtained from a &%route_list%& item, the following
18778 variables are set during its expansion:
18779
18780 .ilist
18781 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18782 If the domain was matched against a regular expression, the numeric variables
18783 &$1$&, &$2$&, etc. may be set. For example:
18784 .code
18785 route_list = ^domain(\d+)   host-$1.text.example
18786 .endd
18787 .next
18788 &$0$& is always set to the entire domain.
18789 .next
18790 &$1$& is also set when partial matching is done in a file lookup.
18791
18792 .next
18793 .vindex "&$value$&"
18794 If the pattern that matched the domain was a lookup item, the data that was
18795 looked up is available in the expansion variable &$value$&. For example:
18796 .code
18797 route_list = lsearch;;/some/file.routes  $value
18798 .endd
18799 .endlist
18800
18801 Note the doubling of the semicolon in the pattern that is necessary because
18802 semicolon is the default route list separator.
18803
18804
18805
18806 .section "Format of one host item" "SECTformatonehostitem"
18807 Each item in the list of hosts is either a host name or an IP address,
18808 optionally with an attached port number. When no port is given, an IP address
18809 is not enclosed in brackets. When a port is specified, it overrides the port
18810 specification on the transport. The port is separated from the name or address
18811 by a colon. This leads to some complications:
18812
18813 .ilist
18814 Because colon is the default separator for the list of hosts, either
18815 the colon that specifies a port must be doubled, or the list separator must
18816 be changed. The following two examples have the same effect:
18817 .code
18818 route_list = * "host1.tld::1225 : host2.tld::1226"
18819 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18820 .endd
18821 .next
18822 When IPv6 addresses are involved, it gets worse, because they contain
18823 colons of their own. To make this case easier, it is permitted to
18824 enclose an IP address (either v4 or v6) in square brackets if a port
18825 number follows. For example:
18826 .code
18827 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18828 .endd
18829 .endlist
18830
18831 .section "How the list of hosts is used" "SECThostshowused"
18832 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18833 the hosts is tried, in the order specified, when carrying out the SMTP
18834 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18835 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18836 transport.
18837
18838 Hosts may be listed by name or by IP address. An unadorned name in the list of
18839 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18840 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18841 records in the DNS. For example:
18842 .code
18843 route_list = *  x.y.z:p.q.r/MX:e.f.g
18844 .endd
18845 If this feature is used with a port specifier, the port must come last. For
18846 example:
18847 .code
18848 route_list = *  dom1.tld/mx::1225
18849 .endd
18850 If the &%hosts_randomize%& option is set, the order of the items in the list is
18851 randomized before any lookups are done. Exim then scans the list; for any name
18852 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18853 be an interface on the local host and the item is not the first in the list,
18854 Exim discards it and any subsequent items. If it is the first item, what
18855 happens is controlled by the
18856 .oindex "&%self%&" "in &(manualroute)& router"
18857 &%self%& option of the router.
18858
18859 A name on the list that is followed by &`/MX`& is replaced with the list of
18860 hosts obtained by looking up MX records for the name. This is always a DNS
18861 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18862 below) are not relevant here. The order of these hosts is determined by the
18863 preference values in the MX records, according to the usual rules. Because
18864 randomizing happens before the MX lookup, it does not affect the order that is
18865 defined by MX preferences.
18866
18867 If the local host is present in the sublist obtained from MX records, but is
18868 not the most preferred host in that list, it and any equally or less
18869 preferred hosts are removed before the sublist is inserted into the main list.
18870
18871 If the local host is the most preferred host in the MX list, what happens
18872 depends on where in the original list of hosts the &`/MX`& item appears. If it
18873 is not the first item (that is, there are previous hosts in the main list),
18874 Exim discards this name and any subsequent items in the main list.
18875
18876 If the MX item is first in the list of hosts, and the local host is the
18877 most preferred host, what happens is controlled by the &%self%& option of the
18878 router.
18879
18880 DNS failures when lookup up the MX records are treated in the same way as DNS
18881 failures when looking up IP addresses: &%pass_on_timeout%& and
18882 &%host_find_failed%& are used when relevant.
18883
18884 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18885 whether obtained from an MX lookup or not.
18886
18887
18888
18889 .section "How the options are used" "SECThowoptused"
18890 The options are a sequence of words; in practice no more than three are ever
18891 present. One of the words can be the name of a transport; this overrides the
18892 &%transport%& option on the router for this particular routing rule only. The
18893 other words (if present) control randomization of the list of hosts on a
18894 per-rule basis, and how the IP addresses of the hosts are to be found when
18895 routing to a remote transport. These options are as follows:
18896
18897 .ilist
18898 &%randomize%&: randomize the order of the hosts in this list, overriding the
18899 setting of &%hosts_randomize%& for this routing rule only.
18900 .next
18901 &%no_randomize%&: do not randomize the order of the hosts in this list,
18902 overriding the setting of &%hosts_randomize%& for this routing rule only.
18903 .next
18904 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18905 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18906 also look in &_/etc/hosts_& or other sources of information.
18907 .next
18908 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18909 no address records are found. If there is a temporary DNS error (such as a
18910 timeout), delivery is deferred.
18911 .endlist
18912
18913 For example:
18914 .code
18915 route_list = domain1  host1:host2:host3  randomize bydns;\
18916              domain2  host4:host5
18917 .endd
18918 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18919 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18920 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18921 or &[gethostbyname()]&, and the result of the lookup is the result of that
18922 call.
18923
18924 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18925 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18926 instead of TRY_AGAIN. That is why the default action is to try a DNS
18927 lookup first. Only if that gives a definite &"no such host"& is the local
18928 function called.
18929
18930
18931
18932 If no IP address for a host can be found, what happens is controlled by the
18933 &%host_find_failed%& option.
18934
18935 .vindex "&$host$&"
18936 When an address is routed to a local transport, IP addresses are not looked up.
18937 The host list is passed to the transport in the &$host$& variable.
18938
18939
18940
18941 .section "Manualroute examples" "SECID123"
18942 In some of the examples that follow, the presence of the &%remote_smtp%&
18943 transport, as defined in the default configuration file, is assumed:
18944
18945 .ilist
18946 .cindex "smart host" "example router"
18947 The &(manualroute)& router can be used to forward all external mail to a
18948 &'smart host'&. If you have set up, in the main part of the configuration, a
18949 named domain list that contains your local domains, for example:
18950 .code
18951 domainlist local_domains = my.domain.example
18952 .endd
18953 You can arrange for all other domains to be routed to a smart host by making
18954 your first router something like this:
18955 .code
18956 smart_route:
18957   driver = manualroute
18958   domains = !+local_domains
18959   transport = remote_smtp
18960   route_list = * smarthost.ref.example
18961 .endd
18962 This causes all non-local addresses to be sent to the single host
18963 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18964 they are tried in order
18965 (but you can use &%hosts_randomize%& to vary the order each time).
18966 Another way of configuring the same thing is this:
18967 .code
18968 smart_route:
18969   driver = manualroute
18970   transport = remote_smtp
18971   route_list = !+local_domains  smarthost.ref.example
18972 .endd
18973 There is no difference in behaviour between these two routers as they stand.
18974 However, they behave differently if &%no_more%& is added to them. In the first
18975 example, the router is skipped if the domain does not match the &%domains%&
18976 precondition; the following router is always tried. If the router runs, it
18977 always matches the domain and so can never decline. Therefore, &%no_more%&
18978 would have no effect. In the second case, the router is never skipped; it
18979 always runs. However, if it doesn't match the domain, it declines. In this case
18980 &%no_more%& would prevent subsequent routers from running.
18981
18982 .next
18983 .cindex "mail hub example"
18984 A &'mail hub'& is a host which receives mail for a number of domains via MX
18985 records in the DNS and delivers it via its own private routing mechanism. Often
18986 the final destinations are behind a firewall, with the mail hub being the one
18987 machine that can connect to machines both inside and outside the firewall. The
18988 &(manualroute)& router is usually used on a mail hub to route incoming messages
18989 to the correct hosts. For a small number of domains, the routing can be inline,
18990 using the &%route_list%& option, but for a larger number a file or database
18991 lookup is easier to manage.
18992
18993 If the domain names are in fact the names of the machines to which the mail is
18994 to be sent by the mail hub, the configuration can be quite simple. For
18995 example:
18996 .code
18997 hub_route:
18998   driver = manualroute
18999   transport = remote_smtp
19000   route_list = *.rhodes.tvs.example  $domain
19001 .endd
19002 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19003 whose names are the same as the mail domains. A similar approach can be taken
19004 if the host name can be obtained from the domain name by a string manipulation
19005 that the expansion facilities can handle. Otherwise, a lookup based on the
19006 domain can be used to find the host:
19007 .code
19008 through_firewall:
19009   driver = manualroute
19010   transport = remote_smtp
19011   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19012 .endd
19013 The result of the lookup must be the name or IP address of the host (or
19014 hosts) to which the address is to be routed. If the lookup fails, the route
19015 data is empty, causing the router to decline. The address then passes to the
19016 next router.
19017
19018 .next
19019 .cindex "batched SMTP output example"
19020 .cindex "SMTP" "batched outgoing; example"
19021 You can use &(manualroute)& to deliver messages to pipes or files in batched
19022 SMTP format for onward transportation by some other means. This is one way of
19023 storing mail for a dial-up host when it is not connected. The route list entry
19024 can be as simple as a single domain name in a configuration like this:
19025 .code
19026 save_in_file:
19027   driver = manualroute
19028   transport = batchsmtp_appendfile
19029   route_list = saved.domain.example
19030 .endd
19031 though often a pattern is used to pick up more than one domain. If there are
19032 several domains or groups of domains with different transport requirements,
19033 different transports can be listed in the routing information:
19034 .code
19035 save_in_file:
19036   driver = manualroute
19037   route_list = \
19038     *.saved.domain1.example  $domain  batch_appendfile; \
19039     *.saved.domain2.example  \
19040       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19041       batch_pipe
19042 .endd
19043 .vindex "&$domain$&"
19044 .vindex "&$host$&"
19045 The first of these just passes the domain in the &$host$& variable, which
19046 doesn't achieve much (since it is also in &$domain$&), but the second does a
19047 file lookup to find a value to pass, causing the router to decline to handle
19048 the address if the lookup fails.
19049
19050 .next
19051 .cindex "UUCP" "example of router for"
19052 Routing mail directly to UUCP software is a specific case of the use of
19053 &(manualroute)& in a gateway to another mail environment. This is an example of
19054 one way it can be done:
19055 .code
19056 # Transport
19057 uucp:
19058   driver = pipe
19059   user = nobody
19060   command = /usr/local/bin/uux -r - \
19061     ${substr_-5:$host}!rmail ${local_part}
19062   return_fail_output = true
19063
19064 # Router
19065 uucphost:
19066   transport = uucp
19067   driver = manualroute
19068   route_data = \
19069     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19070 .endd
19071 The file &_/usr/local/exim/uucphosts_& contains entries like
19072 .code
19073 darksite.ethereal.example:           darksite.UUCP
19074 .endd
19075 It can be set up more simply without adding and removing &".UUCP"& but this way
19076 makes clear the distinction between the domain name
19077 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19078 .endlist
19079 .ecindex IIDmanrou1
19080 .ecindex IIDmanrou2
19081
19082
19083
19084
19085
19086
19087
19088
19089 . ////////////////////////////////////////////////////////////////////////////
19090 . ////////////////////////////////////////////////////////////////////////////
19091
19092 .chapter "The queryprogram router" "CHAPdriverlast"
19093 .scindex IIDquerou1 "&(queryprogram)& router"
19094 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19095 .cindex "routing" "by external program"
19096 The &(queryprogram)& router routes an address by running an external command
19097 and acting on its output. This is an expensive way to route, and is intended
19098 mainly for use in lightly-loaded systems, or for performing experiments.
19099 However, if it is possible to use the precondition options (&%domains%&,
19100 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19101 be used in special cases, even on a busy host. There are the following private
19102 options:
19103 .cindex "options" "&(queryprogram)& router"
19104
19105 .option command queryprogram string&!! unset
19106 This option must be set. It specifies the command that is to be run. The
19107 command is split up into a command name and arguments, and then each is
19108 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19109 &<<CHAPpipetransport>>&).
19110
19111
19112 .option command_group queryprogram string unset
19113 .cindex "gid (group id)" "in &(queryprogram)& router"
19114 This option specifies a gid to be set when running the command while routing an
19115 address for deliver. It must be set if &%command_user%& specifies a numerical
19116 uid. If it begins with a digit, it is interpreted as the numerical value of the
19117 gid. Otherwise it is looked up using &[getgrnam()]&.
19118
19119
19120 .option command_user queryprogram string unset
19121 .cindex "uid (user id)" "for &(queryprogram)&"
19122 This option must be set. It specifies the uid which is set when running the
19123 command while routing an address for delivery. If the value begins with a digit,
19124 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19125 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19126 not set, a value for the gid also.
19127
19128 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19129 root, which it does during a normal delivery in a conventional configuration.
19130 However, when an address is being verified during message reception, Exim is
19131 usually running as the Exim user, not as root. If the &(queryprogram)& router
19132 is called from a non-root process, Exim cannot change uid or gid before running
19133 the command. In this circumstance the command runs under the current uid and
19134 gid.
19135
19136
19137 .option current_directory queryprogram string /
19138 This option specifies an absolute path which is made the current directory
19139 before running the command.
19140
19141
19142 .option timeout queryprogram time 1h
19143 If the command does not complete within the timeout period, its process group
19144 is killed and the message is frozen. A value of zero time specifies no
19145 timeout.
19146
19147
19148 The standard output of the command is connected to a pipe, which is read when
19149 the command terminates. It should consist of a single line of output,
19150 containing up to five fields, separated by white space. The maximum length of
19151 the line is 1023 characters. Longer lines are silently truncated. The first
19152 field is one of the following words (case-insensitive):
19153
19154 .ilist
19155 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19156 below).
19157 .next
19158 &'Decline'&: the router declines; pass the address to the next router, unless
19159 &%no_more%& is set.
19160 .next
19161 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19162 subsequent text on the line is an error message. If the router is run as part
19163 of address verification during an incoming SMTP message, the message is
19164 included in the SMTP response.
19165 .next
19166 &'Defer'&: routing could not be completed at this time; try again later. Any
19167 subsequent text on the line is an error message which is logged. It is not
19168 included in any SMTP response.
19169 .next
19170 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19171 .next
19172 &'Pass'&: pass the address to the next router (or the router specified by
19173 &%pass_router%&), overriding &%no_more%&.
19174 .next
19175 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19176 new addresses, which are routed independently, starting with the first router,
19177 or the router specified by &%redirect_router%&, if set.
19178 .endlist
19179
19180 When the first word is &'accept'&, the remainder of the line consists of a
19181 number of keyed data values, as follows (split into two lines here, to fit on
19182 the page):
19183 .code
19184 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19185 LOOKUP=byname|bydns DATA=<text>
19186 .endd
19187 The data items can be given in any order, and all are optional. If no transport
19188 is included, the transport specified by the generic &%transport%& option is
19189 used. The list of hosts and the lookup type are needed only if the transport is
19190 an &(smtp)& transport that does not itself supply a list of hosts.
19191
19192 The format of the list of hosts is the same as for the &(manualroute)& router.
19193 As well as host names and IP addresses with optional port numbers, as described
19194 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19195 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19196 (see section &<<SECThostshowused>>&).
19197
19198 If the lookup type is not specified, Exim behaves as follows when trying to
19199 find an IP address for each host: First, a DNS lookup is done. If this yields
19200 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19201 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19202 result of the lookup is the result of that call.
19203
19204 .vindex "&$address_data$&"
19205 If the DATA field is set, its value is placed in the &$address_data$&
19206 variable. For example, this return line
19207 .code
19208 accept hosts=x1.y.example:x2.y.example data="rule1"
19209 .endd
19210 routes the address to the default transport, passing a list of two hosts. When
19211 the transport runs, the string &"rule1"& is in &$address_data$&.
19212 .ecindex IIDquerou1
19213 .ecindex IIDquerou2
19214
19215
19216
19217
19218 . ////////////////////////////////////////////////////////////////////////////
19219 . ////////////////////////////////////////////////////////////////////////////
19220
19221 .chapter "The redirect router" "CHAPredirect"
19222 .scindex IIDredrou1 "&(redirect)& router"
19223 .scindex IIDredrou2 "routers" "&(redirect)&"
19224 .cindex "alias file" "in a &(redirect)& router"
19225 .cindex "address redirection" "&(redirect)& router"
19226 The &(redirect)& router handles several kinds of address redirection. Its most
19227 common uses are for resolving local part aliases from a central alias file
19228 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19229 files, but it has many other potential uses. The incoming address can be
19230 redirected in several different ways:
19231
19232 .ilist
19233 It can be replaced by one or more new addresses which are themselves routed
19234 independently.
19235 .next
19236 It can be routed to be delivered to a given file or directory.
19237 .next
19238 It can be routed to be delivered to a specified pipe command.
19239 .next
19240 It can cause an automatic reply to be generated.
19241 .next
19242 It can be forced to fail, optionally with a custom error message.
19243 .next
19244 It can be temporarily deferred, optionally with a custom message.
19245 .next
19246 It can be discarded.
19247 .endlist
19248
19249 The generic &%transport%& option must not be set for &(redirect)& routers.
19250 However, there are some private options which define transports for delivery to
19251 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19252 &%pipe_transport%& and &%reply_transport%& descriptions below.
19253
19254 If success DSNs have been requested
19255 .cindex "DSN" "success"
19256 .cindex "Delivery Status Notification" "success"
19257 redirection triggers one and the DSN options are not passed any further.
19258
19259
19260
19261 .section "Redirection data" "SECID124"
19262 The router operates by interpreting a text string which it obtains either by
19263 expanding the contents of the &%data%& option, or by reading the entire
19264 contents of a file whose name is given in the &%file%& option. These two
19265 options are mutually exclusive. The first is commonly used for handling system
19266 aliases, in a configuration like this:
19267 .code
19268 system_aliases:
19269   driver = redirect
19270   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19271 .endd
19272 If the lookup fails, the expanded string in this example is empty. When the
19273 expansion of &%data%& results in an empty string, the router declines. A forced
19274 expansion failure also causes the router to decline; other expansion failures
19275 cause delivery to be deferred.
19276
19277 A configuration using &%file%& is commonly used for handling users'
19278 &_.forward_& files, like this:
19279 .code
19280 userforward:
19281   driver = redirect
19282   check_local_user
19283   file = $home/.forward
19284   no_verify
19285 .endd
19286 If the file does not exist, or causes no action to be taken (for example, it is
19287 empty or consists only of comments), the router declines. &*Warning*&: This
19288 is not the case when the file contains syntactically valid items that happen to
19289 yield empty addresses, for example, items containing only RFC 2822 address
19290 comments.
19291
19292
19293
19294 .section "Forward files and address verification" "SECID125"
19295 .cindex "address redirection" "while verifying"
19296 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19297 &_.forward_& files, as in the example above. There are two reasons for this:
19298
19299 .ilist
19300 When Exim is receiving an incoming SMTP message from a remote host, it is
19301 running under the Exim uid, not as root. Exim is unable to change uid to read
19302 the file as the user, and it may not be able to read it as the Exim user. So in
19303 practice the router may not be able to operate.
19304 .next
19305 However, even when the router can operate, the existence of a &_.forward_& file
19306 is unimportant when verifying an address. What should be checked is whether the
19307 local part is a valid user name or not. Cutting out the redirection processing
19308 saves some resources.
19309 .endlist
19310
19311
19312
19313
19314
19315
19316 .section "Interpreting redirection data" "SECID126"
19317 .cindex "Sieve filter" "specifying in redirection data"
19318 .cindex "filter" "specifying in redirection data"
19319 The contents of the data string, whether obtained from &%data%& or &%file%&,
19320 can be interpreted in two different ways:
19321
19322 .ilist
19323 If the &%allow_filter%& option is set true, and the data begins with the text
19324 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19325 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19326 respectively. Details of the syntax and semantics of filter files are described
19327 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19328 document is intended for use by end users.
19329 .next
19330 Otherwise, the data must be a comma-separated list of redirection items, as
19331 described in the next section.
19332 .endlist
19333
19334 When a message is redirected to a file (a &"mail folder"&), the file name given
19335 in a non-filter redirection list must always be an absolute path. A filter may
19336 generate a relative path &-- how this is handled depends on the transport's
19337 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19338 for the &(appendfile)& transport.
19339
19340
19341
19342 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19343 .cindex "address redirection" "non-filter list items"
19344 When the redirection data is not an Exim or Sieve filter, for example, if it
19345 comes from a conventional alias or forward file, it consists of a list of
19346 addresses, file names, pipe commands, or certain special items (see section
19347 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19348 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19349 depending on their default values. The items in the list are separated by
19350 commas or newlines.
19351 If a comma is required in an item, the entire item must be enclosed in double
19352 quotes.
19353
19354 Lines starting with a # character are comments, and are ignored, and # may
19355 also appear following a comma, in which case everything between the # and the
19356 next newline character is ignored.
19357
19358 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19359 double quotes are retained because some forms of mail address require their use
19360 (but never to enclose the entire address). In the following description,
19361 &"item"& refers to what remains after any surrounding double quotes have been
19362 removed.
19363
19364 .vindex "&$local_part$&"
19365 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19366 and the expansion contains a reference to &$local_part$&, you should make use
19367 of the &%quote_local_part%& expansion operator, in case the local part contains
19368 special characters. For example, to redirect all mail for the domain
19369 &'obsolete.example'&, retaining the existing local part, you could use this
19370 setting:
19371 .code
19372 data = ${quote_local_part:$local_part}@newdomain.example
19373 .endd
19374
19375
19376 .section "Redirecting to a local mailbox" "SECTredlocmai"
19377 .cindex "routing" "loops in"
19378 .cindex "loop" "while routing, avoidance of"
19379 .cindex "address redirection" "to local mailbox"
19380 A redirection item may safely be the same as the address currently under
19381 consideration. This does not cause a routing loop, because a router is
19382 automatically skipped if any ancestor of the address that is being processed
19383 is the same as the current address and was processed by the current router.
19384 Such an address is therefore passed to the following routers, so it is handled
19385 as if there were no redirection. When making this loop-avoidance test, the
19386 complete local part, including any prefix or suffix, is used.
19387
19388 .cindex "address redirection" "local part without domain"
19389 Specifying the same local part without a domain is a common usage in personal
19390 filter files when the user wants to have messages delivered to the local
19391 mailbox and also forwarded elsewhere. For example, the user whose login is
19392 &'cleo'& might have a &_.forward_& file containing this:
19393 .code
19394 cleo, cleopatra@egypt.example
19395 .endd
19396 .cindex "backslash in alias file"
19397 .cindex "alias file" "backslash in"
19398 For compatibility with other MTAs, such unqualified local parts may be
19399 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19400 it does make a difference if more than one domain is being handled
19401 synonymously.
19402
19403 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19404 2822 address that does not include a domain, the item is qualified using the
19405 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19406 addresses are qualified using the value in &%qualify_recipient%&, but you can
19407 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19408
19409 Care must be taken if there are alias names for local users.
19410 Consider an MTA handling a single local domain where the system alias file
19411 contains:
19412 .code
19413 Sam.Reman: spqr
19414 .endd
19415 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19416 messages in the local mailbox, and also forward copies elsewhere. He creates
19417 this forward file:
19418 .code
19419 Sam.Reman, spqr@reme.elsewhere.example
19420 .endd
19421 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19422 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19423 second time round, because it has previously routed it,
19424 and the following routers presumably cannot handle the alias. The forward file
19425 should really contain
19426 .code
19427 spqr, spqr@reme.elsewhere.example
19428 .endd
19429 but because this is such a common error, the &%check_ancestor%& option (see
19430 below) exists to provide a way to get round it. This is normally set on a
19431 &(redirect)& router that is handling users' &_.forward_& files.
19432
19433
19434
19435 .section "Special items in redirection lists" "SECTspecitredli"
19436 In addition to addresses, the following types of item may appear in redirection
19437 lists (that is, in non-filter redirection data):
19438
19439 .ilist
19440 .cindex "pipe" "in redirection list"
19441 .cindex "address redirection" "to pipe"
19442 An item is treated as a pipe command if it begins with &"|"& and does not parse
19443 as a valid RFC 2822 address that includes a domain. A transport for running the
19444 command must be specified by the &%pipe_transport%& option.
19445 Normally, either the router or the transport specifies a user and a group under
19446 which to run the delivery. The default is to use the Exim user and group.
19447
19448 Single or double quotes can be used for enclosing the individual arguments of
19449 the pipe command; no interpretation of escapes is done for single quotes. If
19450 the command contains a comma character, it is necessary to put the whole item
19451 in double quotes, for example:
19452 .code
19453 "|/some/command ready,steady,go"
19454 .endd
19455 since items in redirection lists are terminated by commas. Do not, however,
19456 quote just the command. An item such as
19457 .code
19458 |"/some/command ready,steady,go"
19459 .endd
19460 is interpreted as a pipe with a rather strange command name, and no arguments.
19461
19462 Note that the above example assumes that the text comes from a lookup source
19463 of some sort, so that the quotes are part of the data.  If composing a
19464 redirect router with a &%data%& option directly specifying this command, the
19465 quotes will be used by the configuration parser to define the extent of one
19466 string, but will not be passed down into the redirect router itself.  There
19467 are two main approaches to get around this: escape quotes to be part of the
19468 data itself, or avoid using this mechanism and instead create a custom
19469 transport with the &%command%& option set and reference that transport from
19470 an &%accept%& router.
19471
19472 .next
19473 .cindex "file" "in redirection list"
19474 .cindex "address redirection" "to file"
19475 An item is interpreted as a path name if it begins with &"/"& and does not
19476 parse as a valid RFC 2822 address that includes a domain. For example,
19477 .code
19478 /home/world/minbari
19479 .endd
19480 is treated as a file name, but
19481 .code
19482 /s=molari/o=babylon/@x400gate.way
19483 .endd
19484 is treated as an address. For a file name, a transport must be specified using
19485 the &%file_transport%& option. However, if the generated path name ends with a
19486 forward slash character, it is interpreted as a directory name rather than a
19487 file name, and &%directory_transport%& is used instead.
19488
19489 Normally, either the router or the transport specifies a user and a group under
19490 which to run the delivery. The default is to use the Exim user and group.
19491
19492 .cindex "&_/dev/null_&"
19493 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19494 bypassed at a high level, and the log entry shows &"**bypassed**"&
19495 instead of a transport name. In this case the user and group are not used.
19496
19497 .next
19498 .cindex "included address list"
19499 .cindex "address redirection" "included external list"
19500 If an item is of the form
19501 .code
19502 :include:<path name>
19503 .endd
19504 a list of further items is taken from the given file and included at that
19505 point. &*Note*&: Such a file can not be a filter file; it is just an
19506 out-of-line addition to the list. The items in the included list are separated
19507 by commas or newlines and are not subject to expansion. If this is the first
19508 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19509 the alias name. This example is incorrect:
19510 .code
19511 list1    :include:/opt/lists/list1
19512 .endd
19513 It must be given as
19514 .code
19515 list1:   :include:/opt/lists/list1
19516 .endd
19517 .next
19518 .cindex "address redirection" "to black hole"
19519 Sometimes you want to throw away mail to a particular local part. Making the
19520 &%data%& option expand to an empty string does not work, because that causes
19521 the router to decline. Instead, the alias item
19522 .cindex "black hole"
19523 .cindex "abandoning mail"
19524 &':blackhole:'& can be used. It does what its name implies. No delivery is
19525 done, and no error message is generated. This has the same effect as specifying
19526 &_/dev/null_& as a destination, but it can be independently disabled.
19527
19528 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19529 delivery is done for the original local part, even if other redirection items
19530 are present. If you are generating a multi-item list (for example, by reading a
19531 database) and need the ability to provide a no-op item, you must use
19532 &_/dev/null_&.
19533
19534 .next
19535 .cindex "delivery" "forcing failure"
19536 .cindex "delivery" "forcing deferral"
19537 .cindex "failing delivery" "forcing"
19538 .cindex "deferred delivery, forcing"
19539 .cindex "customizing" "failure message"
19540 An attempt to deliver a particular address can be deferred or forced to fail by
19541 redirection items of the form
19542 .code
19543 :defer:
19544 :fail:
19545 .endd
19546 respectively. When a redirection list contains such an item, it applies
19547 to the entire redirection; any other items in the list are ignored. Any
19548 text following &':fail:'& or &':defer:'& is placed in the error text
19549 associated with the failure. For example, an alias file might contain:
19550 .code
19551 X.Employee:  :fail: Gone away, no forwarding address
19552 .endd
19553 In the case of an address that is being verified from an ACL or as the subject
19554 of a
19555 .cindex "VRFY" "error text, display of"
19556 VRFY command, the text is included in the SMTP error response by
19557 default.
19558 .cindex "EXPN" "error text, display of"
19559 The text is not included in the response to an EXPN command. In non-SMTP cases
19560 the text is included in the error message that Exim generates.
19561
19562 .cindex "SMTP" "error codes"
19563 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19564 &':fail:'&. However, if the message starts with three digits followed by a
19565 space, optionally followed by an extended code of the form &'n.n.n'&, also
19566 followed by a space, and the very first digit is the same as the default error
19567 code, the code from the message is used instead. If the very first digit is
19568 incorrect, a panic error is logged, and the default code is used. You can
19569 suppress the use of the supplied code in a redirect router by setting the
19570 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19571 ignored.
19572
19573 .vindex "&$acl_verify_message$&"
19574 In an ACL, an explicitly provided message overrides the default, but the
19575 default message is available in the variable &$acl_verify_message$& and can
19576 therefore be included in a custom message if this is desired.
19577
19578 Normally the error text is the rest of the redirection list &-- a comma does
19579 not terminate it &-- but a newline does act as a terminator. Newlines are not
19580 normally present in alias expansions. In &(lsearch)& lookups they are removed
19581 as part of the continuation process, but they may exist in other kinds of
19582 lookup and in &':include:'& files.
19583
19584 During routing for message delivery (as opposed to verification), a redirection
19585 containing &':fail:'& causes an immediate failure of the incoming address,
19586 whereas &':defer:'& causes the message to remain on the queue so that a
19587 subsequent delivery attempt can happen at a later time. If an address is
19588 deferred for too long, it will ultimately fail, because the normal retry
19589 rules still apply.
19590
19591 .next
19592 .cindex "alias file" "exception to default"
19593 Sometimes it is useful to use a single-key search type with a default (see
19594 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19595 for exceptions to the default. These can be handled by aliasing them to
19596 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19597 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19598 results in an empty redirection list has the same effect.
19599 .endlist
19600
19601
19602 .section "Duplicate addresses" "SECTdupaddr"
19603 .cindex "duplicate addresses"
19604 .cindex "address duplicate, discarding"
19605 .cindex "pipe" "duplicated"
19606 Exim removes duplicate addresses from the list to which it is delivering, so as
19607 to deliver just one copy to each address. This does not apply to deliveries
19608 routed to pipes by different immediate parent addresses, but an indirect
19609 aliasing scheme of the type
19610 .code
19611 pipe:       |/some/command $local_part
19612 localpart1: pipe
19613 localpart2: pipe
19614 .endd
19615 does not work with a message that is addressed to both local parts, because
19616 when the second is aliased to the intermediate local part &"pipe"& it gets
19617 discarded as being the same as a previously handled address. However, a scheme
19618 such as
19619 .code
19620 localpart1: |/some/command $local_part
19621 localpart2: |/some/command $local_part
19622 .endd
19623 does result in two different pipe deliveries, because the immediate parents of
19624 the pipes are distinct.
19625
19626
19627
19628 .section "Repeated redirection expansion" "SECID128"
19629 .cindex "repeated redirection expansion"
19630 .cindex "address redirection" "repeated for each delivery attempt"
19631 When a message cannot be delivered to all of its recipients immediately,
19632 leading to two or more delivery attempts, redirection expansion is carried out
19633 afresh each time for those addresses whose children were not all previously
19634 delivered. If redirection is being used as a mailing list, this can lead to new
19635 members of the list receiving copies of old messages. The &%one_time%& option
19636 can be used to avoid this.
19637
19638
19639 .section "Errors in redirection lists" "SECID129"
19640 .cindex "address redirection" "errors"
19641 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19642 error is skipped, and an entry is written to the main log. This may be useful
19643 for mailing lists that are automatically managed. Otherwise, if an error is
19644 detected while generating the list of new addresses, the original address is
19645 deferred. See also &%syntax_errors_to%&.
19646
19647
19648
19649 .section "Private options for the redirect router" "SECID130"
19650
19651 .cindex "options" "&(redirect)& router"
19652 The private options for the &(redirect)& router are as follows:
19653
19654
19655 .option allow_defer redirect boolean false
19656 Setting this option allows the use of &':defer:'& in non-filter redirection
19657 data, or the &%defer%& command in an Exim filter file.
19658
19659
19660 .option allow_fail redirect boolean false
19661 .cindex "failing delivery" "from filter"
19662 If this option is true, the &':fail:'& item can be used in a redirection list,
19663 and the &%fail%& command may be used in an Exim filter file.
19664
19665
19666 .option allow_filter redirect boolean false
19667 .cindex "filter" "enabling use of"
19668 .cindex "Sieve filter" "enabling use of"
19669 Setting this option allows Exim to interpret redirection data that starts with
19670 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19671 are some features of Exim filter files that some administrators may wish to
19672 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19673
19674 It is also possible to lock out Exim filters or Sieve filters while allowing
19675 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19676
19677
19678 The filter is run using the uid and gid set by the generic &%user%& and
19679 &%group%& options. These take their defaults from the password data if
19680 &%check_local_user%& is set, so in the normal case of users' personal filter
19681 files, the filter is run as the relevant user. When &%allow_filter%& is set
19682 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19683
19684
19685
19686 .option allow_freeze redirect boolean false
19687 .cindex "freezing messages" "allowing in filter"
19688 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19689 This command is more normally encountered in system filters, and is disabled by
19690 default for redirection filters because it isn't something you usually want to
19691 let ordinary users do.
19692
19693
19694
19695 .option check_ancestor redirect boolean false
19696 This option is concerned with handling generated addresses that are the same
19697 as some address in the list of redirection ancestors of the current address.
19698 Although it is turned off by default in the code, it is set in the default
19699 configuration file for handling users' &_.forward_& files. It is recommended
19700 for this use of the &(redirect)& router.
19701
19702 When &%check_ancestor%& is set, if a generated address (including the domain)
19703 is the same as any ancestor of the current address, it is replaced by a copy of
19704 the current address. This helps in the case where local part A is aliased to B,
19705 and B has a &_.forward_& file pointing back to A. For example, within a single
19706 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19707 &_&~jb/.forward_& contains:
19708 .code
19709 \Joe.Bloggs, <other item(s)>
19710 .endd
19711 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19712 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19713 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19714 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19715 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19716 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19717 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19718 original address. See also the &%repeat_use%& option below.
19719
19720
19721 .option check_group redirect boolean "see below"
19722 When the &%file%& option is used, the group owner of the file is checked only
19723 when this option is set. The permitted groups are those listed in the
19724 &%owngroups%& option, together with the user's default group if
19725 &%check_local_user%& is set. If the file has the wrong group, routing is
19726 deferred. The default setting for this option is true if &%check_local_user%&
19727 is set and the &%modemask%& option permits the group write bit, or if the
19728 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19729
19730
19731
19732 .option check_owner redirect boolean "see below"
19733 When the &%file%& option is used, the owner of the file is checked only when
19734 this option is set. If &%check_local_user%& is set, the local user is
19735 permitted; otherwise the owner must be one of those listed in the &%owners%&
19736 option. The default value for this option is true if &%check_local_user%& or
19737 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19738
19739
19740 .option data redirect string&!! unset
19741 This option is mutually exclusive with &%file%&. One or other of them must be
19742 set, but not both. The contents of &%data%& are expanded, and then used as the
19743 list of forwarding items, or as a set of filtering instructions. If the
19744 expansion is forced to fail, or the result is an empty string or a string that
19745 has no effect (consists entirely of comments), the router declines.
19746
19747 When filtering instructions are used, the string must begin with &"#Exim
19748 filter"&, and all comments in the string, including this initial one, must be
19749 terminated with newline characters. For example:
19750 .code
19751 data = #Exim filter\n\
19752        if $h_to: contains Exim then save $home/mail/exim endif
19753 .endd
19754 If you are reading the data from a database where newlines cannot be included,
19755 you can use the &${sg}$& expansion item to turn the escape string of your
19756 choice into a newline.
19757
19758
19759 .option directory_transport redirect string&!! unset
19760 A &(redirect)& router sets up a direct delivery to a directory when a path name
19761 ending with a slash is specified as a new &"address"&. The transport used is
19762 specified by this option, which, after expansion, must be the name of a
19763 configured transport. This should normally be an &(appendfile)& transport.
19764
19765
19766 .option file redirect string&!! unset
19767 This option specifies the name of a file that contains the redirection data. It
19768 is mutually exclusive with the &%data%& option. The string is expanded before
19769 use; if the expansion is forced to fail, the router declines. Other expansion
19770 failures cause delivery to be deferred. The result of a successful expansion
19771 must be an absolute path. The entire file is read and used as the redirection
19772 data. If the data is an empty string or a string that has no effect (consists
19773 entirely of comments), the router declines.
19774
19775 .cindex "NFS" "checking for file existence"
19776 If the attempt to open the file fails with a &"does not exist"& error, Exim
19777 runs a check on the containing directory,
19778 unless &%ignore_enotdir%& is true (see below).
19779 If the directory does not appear to exist, delivery is deferred. This can
19780 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19781 is a mount problem. If the containing directory does exist, but the file does
19782 not, the router declines.
19783
19784
19785 .option file_transport redirect string&!! unset
19786 .vindex "&$address_file$&"
19787 A &(redirect)& router sets up a direct delivery to a file when a path name not
19788 ending in a slash is specified as a new &"address"&. The transport used is
19789 specified by this option, which, after expansion, must be the name of a
19790 configured transport. This should normally be an &(appendfile)& transport. When
19791 it is running, the file name is in &$address_file$&.
19792
19793
19794 .option filter_prepend_home redirect boolean true
19795 When this option is true, if a &(save)& command in an Exim filter specifies a
19796 relative path, and &$home$& is defined, it is automatically prepended to the
19797 relative path. If this option is set false, this action does not happen. The
19798 relative path is then passed to the transport unmodified.
19799
19800
19801 .option forbid_blackhole redirect boolean false
19802 If this option is true, the &':blackhole:'& item may not appear in a
19803 redirection list.
19804
19805
19806 .option forbid_exim_filter redirect boolean false
19807 If this option is set true, only Sieve filters are permitted when
19808 &%allow_filter%& is true.
19809
19810
19811
19812
19813 .option forbid_file redirect boolean false
19814 .cindex "delivery" "to file; forbidding"
19815 .cindex "Sieve filter" "forbidding delivery to a file"
19816 .cindex "Sieve filter" "&""keep""& facility; disabling"
19817 If this option is true, this router may not generate a new address that
19818 specifies delivery to a local file or directory, either from a filter or from a
19819 conventional forward file. This option is forced to be true if &%one_time%& is
19820 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19821 locks out the Sieve's &"keep"& facility.
19822
19823
19824 .option forbid_filter_dlfunc redirect boolean false
19825 .cindex "filter" "locking out certain features"
19826 If this option is true, string expansions in Exim filters are not allowed to
19827 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19828 functions.
19829
19830 .option forbid_filter_existstest redirect boolean false
19831 .cindex "expansion" "statting a file"
19832 If this option is true, string expansions in Exim filters are not allowed to
19833 make use of the &%exists%& condition or the &%stat%& expansion item.
19834
19835 .option forbid_filter_logwrite redirect boolean false
19836 If this option is true, use of the logging facility in Exim filters is not
19837 permitted. Logging is in any case available only if the filter is being run
19838 under some unprivileged uid (which is normally the case for ordinary users'
19839 &_.forward_& files).
19840
19841
19842 .option forbid_filter_lookup redirect boolean false
19843 If this option is true, string expansions in Exim filter files are not allowed
19844 to make use of &%lookup%& items.
19845
19846
19847 .option forbid_filter_perl redirect boolean false
19848 This option has an effect only if Exim is built with embedded Perl support. If
19849 it is true, string expansions in Exim filter files are not allowed to make use
19850 of the embedded Perl support.
19851
19852
19853 .option forbid_filter_readfile redirect boolean false
19854 If this option is true, string expansions in Exim filter files are not allowed
19855 to make use of &%readfile%& items.
19856
19857
19858 .option forbid_filter_readsocket redirect boolean false
19859 If this option is true, string expansions in Exim filter files are not allowed
19860 to make use of &%readsocket%& items.
19861
19862
19863 .option forbid_filter_reply redirect boolean false
19864 If this option is true, this router may not generate an automatic reply
19865 message. Automatic replies can be generated only from Exim or Sieve filter
19866 files, not from traditional forward files. This option is forced to be true if
19867 &%one_time%& is set.
19868
19869
19870 .option forbid_filter_run redirect boolean false
19871 If this option is true, string expansions in Exim filter files are not allowed
19872 to make use of &%run%& items.
19873
19874
19875 .option forbid_include redirect boolean false
19876 If this option is true, items of the form
19877 .code
19878 :include:<path name>
19879 .endd
19880 are not permitted in non-filter redirection lists.
19881
19882
19883 .option forbid_pipe redirect boolean false
19884 .cindex "delivery" "to pipe; forbidding"
19885 If this option is true, this router may not generate a new address which
19886 specifies delivery to a pipe, either from an Exim filter or from a conventional
19887 forward file. This option is forced to be true if &%one_time%& is set.
19888
19889
19890 .option forbid_sieve_filter redirect boolean false
19891 If this option is set true, only Exim filters are permitted when
19892 &%allow_filter%& is true.
19893
19894
19895 .cindex "SMTP" "error codes"
19896 .option forbid_smtp_code redirect boolean false
19897 If this option is set true, any SMTP error codes that are present at the start
19898 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19899 the default codes (451 and 550, respectively) are always used.
19900
19901
19902
19903
19904 .option hide_child_in_errmsg redirect boolean false
19905 .cindex "bounce message" "redirection details; suppressing"
19906 If this option is true, it prevents Exim from quoting a child address if it
19907 generates a bounce or delay message for it. Instead it says &"an address
19908 generated from <&'the top level address'&>"&. Of course, this applies only to
19909 bounces generated locally. If a message is forwarded to another host, &'its'&
19910 bounce may well quote the generated address.
19911
19912
19913 .option ignore_eacces redirect boolean false
19914 .cindex "EACCES"
19915 If this option is set and an attempt to open a redirection file yields the
19916 EACCES error (permission denied), the &(redirect)& router behaves as if the
19917 file did not exist.
19918
19919
19920 .option ignore_enotdir redirect boolean false
19921 .cindex "ENOTDIR"
19922 If this option is set and an attempt to open a redirection file yields the
19923 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19924 router behaves as if the file did not exist.
19925
19926 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19927 router that has the &%file%& option set discovers that the file does not exist
19928 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19929 against unmounted NFS directories. If the parent can not be statted, delivery
19930 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19931 is set, because that option tells Exim to ignore &"something on the path is not
19932 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19933 that some operating systems give ENOENT where others give ENOTDIR.
19934
19935
19936
19937 .option include_directory redirect string unset
19938 If this option is set, the path names of any &':include:'& items in a
19939 redirection list must start with this directory.
19940
19941
19942 .option modemask redirect "octal integer" 022
19943 This specifies mode bits which must not be set for a file specified by the
19944 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19945
19946
19947 .option one_time redirect boolean false
19948 .cindex "one-time aliasing/forwarding expansion"
19949 .cindex "alias file" "one-time expansion"
19950 .cindex "forward file" "one-time expansion"
19951 .cindex "mailing lists" "one-time expansion"
19952 .cindex "address redirection" "one-time expansion"
19953 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19954 files each time it tries to deliver a message causes a problem when one or more
19955 of the generated addresses fails be delivered at the first attempt. The problem
19956 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19957 but of what happens when the redirection list changes during the time that the
19958 message is on Exim's queue. This is particularly true in the case of mailing
19959 lists, where new subscribers might receive copies of messages that were posted
19960 before they subscribed.
19961
19962 If &%one_time%& is set and any addresses generated by the router fail to
19963 deliver at the first attempt, the failing addresses are added to the message as
19964 &"top level"& addresses, and the parent address that generated them is marked
19965 &"delivered"&. Thus, redirection does not happen again at the next delivery
19966 attempt.
19967
19968 &*Warning 1*&: Any header line addition or removal that is specified by this
19969 router would be lost if delivery did not succeed at the first attempt. For this
19970 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19971 permitted when &%one_time%& is set.
19972
19973 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19974 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19975 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19976
19977 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19978 &%one_time%&.
19979
19980 The original top-level address is remembered with each of the generated
19981 addresses, and is output in any log messages. However, any intermediate parent
19982 addresses are not recorded. This makes a difference to the log only if
19983 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19984 typically be used for mailing lists, where there is normally just one level of
19985 expansion.
19986
19987
19988 .option owners redirect "string list" unset
19989 .cindex "ownership" "alias file"
19990 .cindex "ownership" "forward file"
19991 .cindex "alias file" "ownership"
19992 .cindex "forward file" "ownership"
19993 This specifies a list of permitted owners for the file specified by &%file%&.
19994 This list is in addition to the local user when &%check_local_user%& is set.
19995 See &%check_owner%& above.
19996
19997
19998 .option owngroups redirect "string list" unset
19999 This specifies a list of permitted groups for the file specified by &%file%&.
20000 The list is in addition to the local user's primary group when
20001 &%check_local_user%& is set. See &%check_group%& above.
20002
20003
20004 .option pipe_transport redirect string&!! unset
20005 .vindex "&$address_pipe$&"
20006 A &(redirect)& router sets up a direct delivery to a pipe when a string
20007 starting with a vertical bar character is specified as a new &"address"&. The
20008 transport used is specified by this option, which, after expansion, must be the
20009 name of a configured transport. This should normally be a &(pipe)& transport.
20010 When the transport is run, the pipe command is in &$address_pipe$&.
20011
20012
20013 .option qualify_domain redirect string&!! unset
20014 .vindex "&$qualify_recipient$&"
20015 If this option is set, and an unqualified address (one without a domain) is
20016 generated, and that address would normally be qualified by the global setting
20017 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20018 expanding this string. If the expansion fails, the router declines. If you want
20019 to revert to the default, you can have the expansion generate
20020 &$qualify_recipient$&.
20021
20022 This option applies to all unqualified addresses generated by Exim filters,
20023 but for traditional &_.forward_& files, it applies only to addresses that are
20024 not preceded by a backslash. Sieve filters cannot generate unqualified
20025 addresses.
20026
20027 .option qualify_preserve_domain redirect boolean false
20028 .cindex "domain" "in redirection; preserving"
20029 .cindex "preserving domain in redirection"
20030 .cindex "address redirection" "domain; preserving"
20031 If this option is set, the router's local &%qualify_domain%& option must not be
20032 set (a configuration error occurs if it is). If an unqualified address (one
20033 without a domain) is generated, it is qualified with the domain of the parent
20034 address (the immediately preceding ancestor) instead of the global
20035 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20036 this applies whether or not the address is preceded by a backslash.
20037
20038
20039 .option repeat_use redirect boolean true
20040 If this option is set false, the router is skipped for a child address that has
20041 any ancestor that was routed by this router. This test happens before any of
20042 the other preconditions are tested. Exim's default anti-looping rules skip
20043 only when the ancestor is the same as the current address. See also
20044 &%check_ancestor%& above and the generic &%redirect_router%& option.
20045
20046
20047 .option reply_transport redirect string&!! unset
20048 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20049 &%vacation%& command is used in a filter file. The transport used is specified
20050 by this option, which, after expansion, must be the name of a configured
20051 transport. This should normally be an &(autoreply)& transport. Other transports
20052 are unlikely to do anything sensible or useful.
20053
20054
20055 .option rewrite redirect boolean true
20056 .cindex "address redirection" "disabling rewriting"
20057 If this option is set false, addresses generated by the router are not
20058 subject to address rewriting. Otherwise, they are treated like new addresses
20059 and are rewritten according to the global rewriting rules.
20060
20061
20062 .option sieve_subaddress redirect string&!! unset
20063 The value of this option is passed to a Sieve filter to specify the
20064 :subaddress part of an address.
20065
20066 .option sieve_useraddress redirect string&!! unset
20067 The value of this option is passed to a Sieve filter to specify the :user part
20068 of an address. However, if it is unset, the entire original local part
20069 (including any prefix or suffix) is used for :user.
20070
20071
20072 .option sieve_vacation_directory redirect string&!! unset
20073 .cindex "Sieve filter" "vacation directory"
20074 To enable the &"vacation"& extension for Sieve filters, you must set
20075 &%sieve_vacation_directory%& to the directory where vacation databases are held
20076 (do not put anything else in that directory), and ensure that the
20077 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20078 needs their own directory; Exim will create it if necessary.
20079
20080
20081
20082 .option skip_syntax_errors redirect boolean false
20083 .cindex "forward file" "broken"
20084 .cindex "address redirection" "broken files"
20085 .cindex "alias file" "broken"
20086 .cindex "broken alias or forward files"
20087 .cindex "ignoring faulty addresses"
20088 .cindex "skipping faulty addresses"
20089 .cindex "error" "skipping bad syntax"
20090 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20091 non-filter redirection data are skipped, and each failing address is logged. If
20092 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20093 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20094 are expanded and placed at the head of the error message generated by
20095 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20096 be the same address as the generic &%errors_to%& option. The
20097 &%skip_syntax_errors%& option is often used when handling mailing lists.
20098
20099 If all the addresses in a redirection list are skipped because of syntax
20100 errors, the router declines to handle the original address, and it is passed to
20101 the following routers.
20102
20103 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20104 error in the filter causes filtering to be abandoned without any action being
20105 taken. The incident is logged, and the router declines to handle the address,
20106 so it is passed to the following routers.
20107
20108 .cindex "Sieve filter" "syntax errors in"
20109 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20110 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20111 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20112
20113 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20114 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20115 option, used with an address that does not get redirected, can be used to
20116 notify users of these errors, by means of a router like this:
20117 .code
20118 userforward:
20119   driver = redirect
20120   allow_filter
20121   check_local_user
20122   file = $home/.forward
20123   file_transport = address_file
20124   pipe_transport = address_pipe
20125   reply_transport = address_reply
20126   no_verify
20127   skip_syntax_errors
20128   syntax_errors_to = real-$local_part@$domain
20129   syntax_errors_text = \
20130    This is an automatically generated message. An error has\n\
20131    been found in your .forward file. Details of the error are\n\
20132    reported below. While this error persists, you will receive\n\
20133    a copy of this message for every message that is addressed\n\
20134    to you. If your .forward file is a filter file, or if it is\n\
20135    a non-filter file containing no valid forwarding addresses,\n\
20136    a copy of each incoming message will be put in your normal\n\
20137    mailbox. If a non-filter file contains at least one valid\n\
20138    forwarding address, forwarding to the valid addresses will\n\
20139    happen, and those will be the only deliveries that occur.
20140 .endd
20141 You also need a router to ensure that local addresses that are prefixed by
20142 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20143 put this immediately before the &(userforward)& router:
20144 .code
20145 real_localuser:
20146   driver = accept
20147   check_local_user
20148   local_part_prefix = real-
20149   transport = local_delivery
20150 .endd
20151 For security, it would probably be a good idea to restrict the use of this
20152 router to locally-generated messages, using a condition such as this:
20153 .code
20154   condition = ${if match {$sender_host_address}\
20155                          {\N^(|127\.0\.0\.1)$\N}}
20156 .endd
20157
20158
20159 .option syntax_errors_text redirect string&!! unset
20160 See &%skip_syntax_errors%& above.
20161
20162
20163 .option syntax_errors_to redirect string unset
20164 See &%skip_syntax_errors%& above.
20165 .ecindex IIDredrou1
20166 .ecindex IIDredrou2
20167
20168
20169
20170
20171
20172
20173 . ////////////////////////////////////////////////////////////////////////////
20174 . ////////////////////////////////////////////////////////////////////////////
20175
20176 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20177          "Environment for local transports"
20178 .scindex IIDenvlotra1 "local transports" "environment for"
20179 .scindex IIDenvlotra2 "environment for local transports"
20180 .scindex IIDenvlotra3 "transport" "local; environment for"
20181 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20182 transport can be thought of as similar to a pipe.) Exim always runs transports
20183 in subprocesses, under specified uids and gids. Typical deliveries to local
20184 mailboxes run under the uid and gid of the local user.
20185
20186 Exim also sets a specific current directory while running the transport; for
20187 some transports a home directory setting is also relevant. The &(pipe)&
20188 transport is the only one that sets up environment variables; see section
20189 &<<SECTpipeenv>>& for details.
20190
20191 The values used for the uid, gid, and the directories may come from several
20192 different places. In many cases, the router that handles the address associates
20193 settings with that address as a result of its &%check_local_user%&, &%group%&,
20194 or &%user%& options. However, values may also be given in the transport's own
20195 configuration, and these override anything that comes from the router.
20196
20197
20198
20199 .section "Concurrent deliveries" "SECID131"
20200 .cindex "concurrent deliveries"
20201 .cindex "simultaneous deliveries"
20202 If two different messages for the same local recipient arrive more or less
20203 simultaneously, the two delivery processes are likely to run concurrently. When
20204 the &(appendfile)& transport is used to write to a file, Exim applies locking
20205 rules to stop concurrent processes from writing to the same file at the same
20206 time.
20207
20208 However, when you use a &(pipe)& transport, it is up to you to arrange any
20209 locking that is needed. Here is a silly example:
20210 .code
20211 my_transport:
20212   driver = pipe
20213   command = /bin/sh -c 'cat >>/some/file'
20214 .endd
20215 This is supposed to write the message at the end of the file. However, if two
20216 messages arrive at the same time, the file will be scrambled. You can use the
20217 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20218 file using the same algorithm that Exim itself uses.
20219
20220
20221
20222
20223 .section "Uids and gids" "SECTenvuidgid"
20224 .cindex "local transports" "uid and gid"
20225 .cindex "transport" "local; uid and gid"
20226 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20227 overrides any group that the router set in the address, even if &%user%& is not
20228 set for the transport. This makes it possible, for example, to run local mail
20229 delivery under the uid of the recipient (set by the router), but in a special
20230 group (set by the transport). For example:
20231 .code
20232 # Routers ...
20233 # User/group are set by check_local_user in this router
20234 local_users:
20235   driver = accept
20236   check_local_user
20237   transport = group_delivery
20238
20239 # Transports ...
20240 # This transport overrides the group
20241 group_delivery:
20242   driver = appendfile
20243   file = /var/spool/mail/$local_part
20244   group = mail
20245 .endd
20246 If &%user%& is set for a transport, its value overrides what is set in the
20247 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20248 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20249 set.
20250
20251 .oindex "&%initgroups%&"
20252 When the uid is taken from the transport's configuration, the &[initgroups()]&
20253 function is called for the groups associated with that uid if the
20254 &%initgroups%& option is set for the transport. When the uid is not specified
20255 by the transport, but is associated with the address by a router, the option
20256 for calling &[initgroups()]& is taken from the router configuration.
20257
20258 .cindex "&(pipe)& transport" "uid for"
20259 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20260 is set and &%user%& is not set, the uid of the process that called Exim to
20261 receive the message is used, and if &%group%& is not set, the corresponding
20262 original gid is also used.
20263
20264 This is the detailed preference order for obtaining a gid; the first of the
20265 following that is set is used:
20266
20267 .ilist
20268 A &%group%& setting of the transport;
20269 .next
20270 A &%group%& setting of the router;
20271 .next
20272 A gid associated with a user setting of the router, either as a result of
20273 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20274 .next
20275 The group associated with a non-numeric &%user%& setting of the transport;
20276 .next
20277 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20278 the uid is the creator's uid;
20279 .next
20280 The Exim gid if the Exim uid is being used as a default.
20281 .endlist
20282
20283 If, for example, the user is specified numerically on the router and there are
20284 no group settings, no gid is available. In this situation, an error occurs.
20285 This is different for the uid, for which there always is an ultimate default.
20286 The first of the following that is set is used:
20287
20288 .ilist
20289 A &%user%& setting of the transport;
20290 .next
20291 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20292 .next
20293 A &%user%& setting of the router;
20294 .next
20295 A &%check_local_user%& setting of the router;
20296 .next
20297 The Exim uid.
20298 .endlist
20299
20300 Of course, an error will still occur if the uid that is chosen is on the
20301 &%never_users%& list.
20302
20303
20304
20305
20306
20307 .section "Current and home directories" "SECID132"
20308 .cindex "current directory for local transport"
20309 .cindex "home directory" "for local transport"
20310 .cindex "transport" "local; home directory for"
20311 .cindex "transport" "local; current directory for"
20312 Routers may set current and home directories for local transports by means of
20313 the &%transport_current_directory%& and &%transport_home_directory%& options.
20314 However, if the transport's &%current_directory%& or &%home_directory%& options
20315 are set, they override the router's values. In detail, the home directory
20316 for a local transport is taken from the first of these values that is set:
20317
20318 .ilist
20319 The &%home_directory%& option on the transport;
20320 .next
20321 The &%transport_home_directory%& option on the router;
20322 .next
20323 The password data if &%check_local_user%& is set on the router;
20324 .next
20325 The &%router_home_directory%& option on the router.
20326 .endlist
20327
20328 The current directory is taken from the first of these values that is set:
20329
20330 .ilist
20331 The &%current_directory%& option on the transport;
20332 .next
20333 The &%transport_current_directory%& option on the router.
20334 .endlist
20335
20336
20337 If neither the router nor the transport sets a current directory, Exim uses the
20338 value of the home directory, if it is set. Otherwise it sets the current
20339 directory to &_/_& before running a local transport.
20340
20341
20342
20343 .section "Expansion variables derived from the address" "SECID133"
20344 .vindex "&$domain$&"
20345 .vindex "&$local_part$&"
20346 .vindex "&$original_domain$&"
20347 Normally a local delivery is handling a single address, and in that case the
20348 variables such as &$domain$& and &$local_part$& are set during local
20349 deliveries. However, in some circumstances more than one address may be handled
20350 at once (for example, while writing batch SMTP for onward transmission by some
20351 other means). In this case, the variables associated with the local part are
20352 never set, &$domain$& is set only if all the addresses have the same domain,
20353 and &$original_domain$& is never set.
20354 .ecindex IIDenvlotra1
20355 .ecindex IIDenvlotra2
20356 .ecindex IIDenvlotra3
20357
20358
20359
20360
20361
20362
20363
20364 . ////////////////////////////////////////////////////////////////////////////
20365 . ////////////////////////////////////////////////////////////////////////////
20366
20367 .chapter "Generic options for transports" "CHAPtransportgeneric"
20368 .scindex IIDgenoptra1 "generic options" "transport"
20369 .scindex IIDgenoptra2 "options" "generic; for transports"
20370 .scindex IIDgenoptra3 "transport" "generic options for"
20371 The following generic options apply to all transports:
20372
20373
20374 .option body_only transports boolean false
20375 .cindex "transport" "body only"
20376 .cindex "message" "transporting body only"
20377 .cindex "body of message" "transporting"
20378 If this option is set, the message's headers are not transported. It is
20379 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20380 or &(pipe)& transports, the settings of &%message_prefix%& and
20381 &%message_suffix%& should be checked, because this option does not
20382 automatically suppress them.
20383
20384
20385 .option current_directory transports string&!! unset
20386 .cindex "transport" "current directory for"
20387 This specifies the current directory that is to be set while running the
20388 transport, overriding any value that may have been set by the router.
20389 If the expansion fails for any reason, including forced failure, an error is
20390 logged, and delivery is deferred.
20391
20392
20393 .option disable_logging transports boolean false
20394 If this option is set true, nothing is logged for any
20395 deliveries by the transport or for any
20396 transport errors. You should not set this option unless you really, really know
20397 what you are doing.
20398
20399
20400 .option debug_print transports string&!! unset
20401 .cindex "testing" "variables in drivers"
20402 If this option is set and debugging is enabled (see the &%-d%& command line
20403 option), the string is expanded and included in the debugging output when the
20404 transport is run.
20405 If expansion of the string fails, the error message is written to the debugging
20406 output, and Exim carries on processing.
20407 This facility is provided to help with checking out the values of variables and
20408 so on when debugging driver configurations. For example, if a &%headers_add%&
20409 option is not working properly, &%debug_print%& could be used to output the
20410 variables it references. A newline is added to the text if it does not end with
20411 one.
20412 The variables &$transport_name$& and &$router_name$& contain the name of the
20413 transport and the router that called it.
20414
20415 .option delivery_date_add transports boolean false
20416 .cindex "&'Delivery-date:'& header line"
20417 If this option is true, a &'Delivery-date:'& header is added to the message.
20418 This gives the actual time the delivery was made. As this is not a standard
20419 header, Exim has a configuration option (&%delivery_date_remove%&) which
20420 requests its removal from incoming messages, so that delivered messages can
20421 safely be resent to other recipients.
20422
20423
20424 .option driver transports string unset
20425 This specifies which of the available transport drivers is to be used.
20426 There is no default, and this option must be set for every transport.
20427
20428
20429 .option envelope_to_add transports boolean false
20430 .cindex "&'Envelope-to:'& header line"
20431 If this option is true, an &'Envelope-to:'& header is added to the message.
20432 This gives the original address(es) in the incoming envelope that caused this
20433 delivery to happen. More than one address may be present if the transport is
20434 configured to handle several addresses at once, or if more than one original
20435 address was redirected to the same final address. As this is not a standard
20436 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20437 its removal from incoming messages, so that delivered messages can safely be
20438 resent to other recipients.
20439
20440
20441 .option group transports string&!! "Exim group"
20442 .cindex "transport" "group; specifying"
20443 This option specifies a gid for running the transport process, overriding any
20444 value that the router supplies, and also overriding any value associated with
20445 &%user%& (see below).
20446
20447
20448 .option headers_add transports list&!! unset
20449 .cindex "header lines" "adding in transport"
20450 .cindex "transport" "header lines; adding"
20451 This option specifies a list of text headers,
20452 newline-separated (by default, changeable in the usual way),
20453 which are (separately) expanded and added to the header
20454 portion of a message as it is transported, as described in section
20455 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20456 routers. If the result of the expansion is an empty string, or if the expansion
20457 is forced to fail, no action is taken. Other expansion failures are treated as
20458 errors and cause the delivery to be deferred.
20459
20460 Unlike most options, &%headers_add%& can be specified multiple times
20461 for a transport; all listed headers are added.
20462
20463
20464 .option headers_only transports boolean false
20465 .cindex "transport" "header lines only"
20466 .cindex "message" "transporting headers only"
20467 .cindex "header lines" "transporting"
20468 If this option is set, the message's body is not transported. It is mutually
20469 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20470 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20471 checked, since this option does not automatically suppress them.
20472
20473
20474 .option headers_remove transports list&!! unset
20475 .cindex "header lines" "removing"
20476 .cindex "transport" "header lines; removing"
20477 This option specifies a list of header names,
20478 colon-separated (by default, changeable in the usual way);
20479 these headers are omitted from the message as it is transported, as described
20480 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20481 routers.
20482 Each list item is separately expanded.
20483 If the result of the expansion is an empty string, or if the expansion
20484 is forced to fail, no action is taken. Other expansion failures are treated as
20485 errors and cause the delivery to be deferred.
20486
20487 Unlike most options, &%headers_remove%& can be specified multiple times
20488 for a router; all listed headers are removed.
20489
20490 &*Warning*&: Because of the separate expansion of the list items,
20491 items that contain a list separator must have it doubled.
20492 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20493
20494
20495
20496 .option headers_rewrite transports string unset
20497 .cindex "transport" "header lines; rewriting"
20498 .cindex "rewriting" "at transport time"
20499 This option allows addresses in header lines to be rewritten at transport time,
20500 that is, as the message is being copied to its destination. The contents of the
20501 option are a colon-separated list of rewriting rules. Each rule is in exactly
20502 the same form as one of the general rewriting rules that are applied when a
20503 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20504 example,
20505 .code
20506 headers_rewrite = a@b c@d f : \
20507                   x@y w@z
20508 .endd
20509 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20510 &'w@z'& in all address-bearing header lines. The rules are applied to the
20511 header lines just before they are written out at transport time, so they affect
20512 only those copies of the message that pass through the transport. However, only
20513 the message's original header lines, and any that were added by a system
20514 filter, are rewritten. If a router or transport adds header lines, they are not
20515 affected by this option. These rewriting rules are &'not'& applied to the
20516 envelope. You can change the return path using &%return_path%&, but you cannot
20517 change envelope recipients at this time.
20518
20519
20520 .option home_directory transports string&!! unset
20521 .cindex "transport" "home directory for"
20522 .vindex "&$home$&"
20523 This option specifies a home directory setting for a local transport,
20524 overriding any value that may be set by the router. The home directory is
20525 placed in &$home$& while expanding the transport's private options. It is also
20526 used as the current directory if no current directory is set by the
20527 &%current_directory%& option on the transport or the
20528 &%transport_current_directory%& option on the router. If the expansion fails
20529 for any reason, including forced failure, an error is logged, and delivery is
20530 deferred.
20531
20532
20533 .option initgroups transports boolean false
20534 .cindex "additional groups"
20535 .cindex "groups" "additional"
20536 .cindex "transport" "group; additional"
20537 If this option is true and the uid for the delivery process is provided by the
20538 transport, the &[initgroups()]& function is called when running the transport
20539 to ensure that any additional groups associated with the uid are set up.
20540
20541
20542 .new
20543 .option max_parallel transports integer&!! unset
20544 .cindex limit "transport parallelism"
20545 .cindex transport "parallel processes"
20546 .cindex transport "concurrency limit"
20547 .cindex "delivery" "parallelism for transport"
20548 If this option is set and expands to an integer greater than zero
20549 it limits the number of concurrent runs of the transport.
20550 The control does not apply to shadow transports.
20551
20552 .cindex "hints database" "transport concurrency control"
20553 Exim implements this control by means of a hints database in which a record is
20554 incremented whenever a transport process is beaing created. The record
20555 is decremented and possibly removed when the process terminates.
20556 Obviously there is scope for
20557 records to get left lying around if there is a system or program crash. To
20558 guard against this, Exim ignores any records that are more than six hours old.
20559
20560 If you use this option, you should also arrange to delete the
20561 relevant hints database whenever your system reboots. The names of the files
20562 start with &_misc_& and they are kept in the &_spool/db_& directory. There
20563 may be one or two files, depending on the type of DBM in use. The same files
20564 are used for ETRN and smtp transport serialization.
20565 .wen
20566
20567
20568 .option message_size_limit transports string&!! 0
20569 .cindex "limit" "message size per transport"
20570 .cindex "size" "of message, limit"
20571 .cindex "transport" "message size; limiting"
20572 This option controls the size of messages passed through the transport. It is
20573 expanded before use; the result of the expansion must be a sequence of decimal
20574 digits, optionally followed by K or M. If the expansion fails for any reason,
20575 including forced failure, or if the result is not of the required form,
20576 delivery is deferred. If the value is greater than zero and the size of a
20577 message exceeds this limit, the address is failed. If there is any chance that
20578 the resulting bounce message could be routed to the same transport, you should
20579 ensure that &%return_size_limit%& is less than the transport's
20580 &%message_size_limit%&, as otherwise the bounce message will fail to get
20581 delivered.
20582
20583
20584
20585 .option rcpt_include_affixes transports boolean false
20586 .cindex "prefix" "for local part, including in envelope"
20587 .cindex "suffix for local part" "including in envelope"
20588 .cindex "local part" "prefix"
20589 .cindex "local part" "suffix"
20590 When this option is false (the default), and an address that has had any
20591 affixes (prefixes or suffixes) removed from the local part is delivered by any
20592 form of SMTP or LMTP, the affixes are not included. For example, if a router
20593 that contains
20594 .code
20595 local_part_prefix = *-
20596 .endd
20597 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20598 is delivered with
20599 .code
20600 RCPT TO:<xyz@some.domain>
20601 .endd
20602 This is also the case when an ACL-time callout is being used to verify a
20603 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20604 whole local part is included in the RCPT command. This option applies to BSMTP
20605 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20606 &(lmtp)& and &(smtp)& transports.
20607
20608
20609 .option retry_use_local_part transports boolean "see below"
20610 .cindex "hints database" "retry keys"
20611 When a delivery suffers a temporary failure, a retry record is created
20612 in Exim's hints database. For remote deliveries, the key for the retry record
20613 is based on the name and/or IP address of the failing remote host. For local
20614 deliveries, the key is normally the entire address, including both the local
20615 part and the domain. This is suitable for most common cases of local delivery
20616 temporary failure &-- for example, exceeding a mailbox quota should delay only
20617 deliveries to that mailbox, not to the whole domain.
20618
20619 However, in some special cases you may want to treat a temporary local delivery
20620 as a failure associated with the domain, and not with a particular local part.
20621 (For example, if you are storing all mail for some domain in files.) You can do
20622 this by setting &%retry_use_local_part%& false.
20623
20624 For all the local transports, its default value is true. For remote transports,
20625 the default value is false for tidiness, but changing the value has no effect
20626 on a remote transport in the current implementation.
20627
20628
20629 .option return_path transports string&!! unset
20630 .cindex "envelope sender"
20631 .cindex "transport" "return path; changing"
20632 .cindex "return path" "changing in transport"
20633 If this option is set, the string is expanded at transport time and replaces
20634 the existing return path (envelope sender) value in the copy of the message
20635 that is being delivered. An empty return path is permitted. This feature is
20636 designed for remote deliveries, where the value of this option is used in the
20637 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20638 only effect is to change the address that is placed in the &'Return-path:'&
20639 header line, if one is added to the message (see the next option).
20640
20641 &*Note:*& A changed return path is not logged unless you add
20642 &%return_path_on_delivery%& to the log selector.
20643
20644 .vindex "&$return_path$&"
20645 The expansion can refer to the existing value via &$return_path$&. This is
20646 either the message's envelope sender, or an address set by the
20647 &%errors_to%& option on a router. If the expansion is forced to fail, no
20648 replacement occurs; if it fails for another reason, delivery is deferred. This
20649 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20650 section &<<SECTverp>>&.
20651
20652 &*Note*&: If a delivery error is detected locally, including the case when a
20653 remote server rejects a message at SMTP time, the bounce message is not sent to
20654 the value of this option. It is sent to the previously set errors address.
20655 This defaults to the incoming sender address, but can be changed by setting
20656 &%errors_to%& in a router.
20657
20658
20659
20660 .option return_path_add transports boolean false
20661 .cindex "&'Return-path:'& header line"
20662 If this option is true, a &'Return-path:'& header is added to the message.
20663 Although the return path is normally available in the prefix line of BSD
20664 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20665 have easy access to it.
20666
20667 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20668 the delivery SMTP server makes the final delivery"&. This implies that this
20669 header should not be present in incoming messages. Exim has a configuration
20670 option, &%return_path_remove%&, which requests removal of this header from
20671 incoming messages, so that delivered messages can safely be resent to other
20672 recipients.
20673
20674
20675 .option shadow_condition transports string&!! unset
20676 See &%shadow_transport%& below.
20677
20678
20679 .option shadow_transport transports string unset
20680 .cindex "shadow transport"
20681 .cindex "transport" "shadow"
20682 A local transport may set the &%shadow_transport%& option to the name of
20683 another local transport. Shadow remote transports are not supported.
20684
20685 Whenever a delivery to the main transport succeeds, and either
20686 &%shadow_condition%& is unset, or its expansion does not result in the empty
20687 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20688 passed to the shadow transport, with the same delivery address or addresses. If
20689 expansion fails, no action is taken except that non-forced expansion failures
20690 cause a log line to be written.
20691
20692 The result of the shadow transport is discarded and does not affect the
20693 subsequent processing of the message. Only a single level of shadowing is
20694 provided; the &%shadow_transport%& option is ignored on any transport when it
20695 is running as a shadow. Options concerned with output from pipes are also
20696 ignored. The log line for the successful delivery has an item added on the end,
20697 of the form
20698 .code
20699 ST=<shadow transport name>
20700 .endd
20701 If the shadow transport did not succeed, the error message is put in
20702 parentheses afterwards. Shadow transports can be used for a number of different
20703 purposes, including keeping more detailed log information than Exim normally
20704 provides, and implementing automatic acknowledgment policies based on message
20705 headers that some sites insist on.
20706
20707
20708 .option transport_filter transports string&!! unset
20709 .cindex "transport" "filter"
20710 .cindex "filter" "transport filter"
20711 This option sets up a filtering (in the Unix shell sense) process for messages
20712 at transport time. It should not be confused with mail filtering as set up by
20713 individual users or via a system filter.
20714
20715 When the message is about to be written out, the command specified by
20716 &%transport_filter%& is started up in a separate, parallel process, and
20717 the entire message, including the header lines, is passed to it on its standard
20718 input (this in fact is done from a third process, to avoid deadlock). The
20719 command must be specified as an absolute path.
20720
20721 The lines of the message that are written to the transport filter are
20722 terminated by newline (&"\n"&). The message is passed to the filter before any
20723 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20724 lines beginning with a dot, and also before any processing implied by the
20725 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20726 &(pipe)& transports.
20727
20728 The standard error for the filter process is set to the same destination as its
20729 standard output; this is read and written to the message's ultimate
20730 destination. The process that writes the message to the filter, the
20731 filter itself, and the original process that reads the result and delivers it
20732 are all run in parallel, like a shell pipeline.
20733
20734 The filter can perform any transformations it likes, but of course should take
20735 care not to break RFC 2822 syntax. Exim does not check the result, except to
20736 test for a final newline when SMTP is in use. All messages transmitted over
20737 SMTP must end with a newline, so Exim supplies one if it is missing.
20738
20739 .cindex "content scanning" "per user"
20740 A transport filter can be used to provide content-scanning on a per-user basis
20741 at delivery time if the only required effect of the scan is to modify the
20742 message. For example, a content scan could insert a new header line containing
20743 a spam score. This could be interpreted by a filter in the user's MUA. It is
20744 not possible to discard a message at this stage.
20745
20746 .cindex "SMTP" "SIZE"
20747 A problem might arise if the filter increases the size of a message that is
20748 being sent down an SMTP connection. If the receiving SMTP server has indicated
20749 support for the SIZE parameter, Exim will have sent the size of the message
20750 at the start of the SMTP session. If what is actually sent is substantially
20751 more, the server might reject the message. This can be worked round by setting
20752 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20753 additions to the message, or to disable the use of SIZE altogether.
20754
20755 .vindex "&$pipe_addresses$&"
20756 The value of the &%transport_filter%& option is the command string for starting
20757 the filter, which is run directly from Exim, not under a shell. The string is
20758 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20759 Exim breaks it up into arguments and then expands each argument separately (see
20760 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20761 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20762 of arguments, one for each address that applies to this delivery. (This isn't
20763 an ideal name for this feature here, but as it was already implemented for the
20764 &(pipe)& transport, it seemed sensible not to change it.)
20765
20766 .vindex "&$host$&"
20767 .vindex "&$host_address$&"
20768 The expansion variables &$host$& and &$host_address$& are available when the
20769 transport is a remote one. They contain the name and IP address of the host to
20770 which the message is being sent. For example:
20771 .code
20772 transport_filter = /some/directory/transport-filter.pl \
20773   $host $host_address $sender_address $pipe_addresses
20774 .endd
20775
20776 Two problems arise if you want to use more complicated expansion items to
20777 generate transport filter commands, both of which due to the fact that the
20778 command is split up &'before'& expansion.
20779 .ilist
20780 If an expansion item contains white space, you must quote it, so that it is all
20781 part of the same command item. If the entire option setting is one such
20782 expansion item, you have to take care what kind of quoting you use. For
20783 example:
20784 .code
20785 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20786 .endd
20787 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20788 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20789 stripped by Exim when it read the option's value. When the value is used, if
20790 the single quotes were missing, the line would be split into two items,
20791 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20792 Exim tried to expand the first one.
20793 .next
20794 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20795 expansion cannot generate multiple arguments, or a command name followed by
20796 arguments. Consider this example:
20797 .code
20798 transport_filter = ${lookup{$host}lsearch{/a/file}\
20799                     {$value}{/bin/cat}}
20800 .endd
20801 The result of the lookup is interpreted as the name of the command, even
20802 if it contains white space. The simplest way round this is to use a shell:
20803 .code
20804 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20805                                {$value}{/bin/cat}}
20806 .endd
20807 .endlist
20808
20809 The filter process is run under the same uid and gid as the normal delivery.
20810 For remote deliveries this is the Exim uid/gid by default. The command should
20811 normally yield a zero return code. Transport filters are not supposed to fail.
20812 A non-zero code is taken to mean that the transport filter encountered some
20813 serious problem. Delivery of the message is deferred; the message remains on
20814 the queue and is tried again later. It is not possible to cause a message to be
20815 bounced from a transport filter.
20816
20817 If a transport filter is set on an autoreply transport, the original message is
20818 passed through the filter as it is being copied into the newly generated
20819 message, which happens if the &%return_message%& option is set.
20820
20821
20822 .option transport_filter_timeout transports time 5m
20823 .cindex "transport" "filter, timeout"
20824 When Exim is reading the output of a transport filter, it applies a timeout
20825 that can be set by this option. Exceeding the timeout is normally treated as a
20826 temporary delivery failure. However, if a transport filter is used with a
20827 &(pipe)& transport, a timeout in the transport filter is treated in the same
20828 way as a timeout in the pipe command itself. By default, a timeout is a hard
20829 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20830 becomes a temporary error.
20831
20832
20833 .option user transports string&!! "Exim user"
20834 .cindex "uid (user id)" "local delivery"
20835 .cindex "transport" "user, specifying"
20836 This option specifies the user under whose uid the delivery process is to be
20837 run, overriding any uid that may have been set by the router. If the user is
20838 given as a name, the uid is looked up from the password data, and the
20839 associated group is taken as the value of the gid to be used if the &%group%&
20840 option is not set.
20841
20842 For deliveries that use local transports, a user and group are normally
20843 specified explicitly or implicitly (for example, as a result of
20844 &%check_local_user%&) by the router or transport.
20845
20846 .cindex "hints database" "access by remote transport"
20847 For remote transports, you should leave this option unset unless you really are
20848 sure you know what you are doing. When a remote transport is running, it needs
20849 to be able to access Exim's hints databases, because each host may have its own
20850 retry data.
20851 .ecindex IIDgenoptra1
20852 .ecindex IIDgenoptra2
20853 .ecindex IIDgenoptra3
20854
20855
20856
20857
20858
20859
20860 . ////////////////////////////////////////////////////////////////////////////
20861 . ////////////////////////////////////////////////////////////////////////////
20862
20863 .chapter "Address batching in local transports" "CHAPbatching" &&&
20864          "Address batching"
20865 .cindex "transport" "local; address batching in"
20866 The only remote transport (&(smtp)&) is normally configured to handle more than
20867 one address at a time, so that when several addresses are routed to the same
20868 remote host, just one copy of the message is sent. Local transports, however,
20869 normally handle one address at a time. That is, a separate instance of the
20870 transport is run for each address that is routed to the transport. A separate
20871 copy of the message is delivered each time.
20872
20873 .cindex "batched local delivery"
20874 .oindex "&%batch_max%&"
20875 .oindex "&%batch_id%&"
20876 In special cases, it may be desirable to handle several addresses at once in a
20877 local transport, for example:
20878
20879 .ilist
20880 In an &(appendfile)& transport, when storing messages in files for later
20881 delivery by some other means, a single copy of the message with multiple
20882 recipients saves space.
20883 .next
20884 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20885 a single copy saves time, and is the normal way LMTP is expected to work.
20886 .next
20887 In a &(pipe)& transport, when passing the message
20888 to a scanner program or
20889 to some other delivery mechanism such as UUCP, multiple recipients may be
20890 acceptable.
20891 .endlist
20892
20893 These three local transports all have the same options for controlling multiple
20894 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20895 repeating the information for each transport, these options are described here.
20896
20897 The &%batch_max%& option specifies the maximum number of addresses that can be
20898 delivered together in a single run of the transport. Its default value is one
20899 (no batching). When more than one address is routed to a transport that has a
20900 &%batch_max%& value greater than one, the addresses are delivered in a batch
20901 (that is, in a single run of the transport with multiple recipients), subject
20902 to certain conditions:
20903
20904 .ilist
20905 .vindex "&$local_part$&"
20906 If any of the transport's options contain a reference to &$local_part$&, no
20907 batching is possible.
20908 .next
20909 .vindex "&$domain$&"
20910 If any of the transport's options contain a reference to &$domain$&, only
20911 addresses with the same domain are batched.
20912 .next
20913 .cindex "customizing" "batching condition"
20914 If &%batch_id%& is set, it is expanded for each address, and only those
20915 addresses with the same expanded value are batched. This allows you to specify
20916 customized batching conditions. Failure of the expansion for any reason,
20917 including forced failure, disables batching, but it does not stop the delivery
20918 from taking place.
20919 .next
20920 Batched addresses must also have the same errors address (where to send
20921 delivery errors), the same header additions and removals, the same user and
20922 group for the transport, and if a host list is present, the first host must
20923 be the same.
20924 .endlist
20925
20926 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20927 both when the file or pipe command is specified in the transport, and when it
20928 is specified by a &(redirect)& router, but all the batched addresses must of
20929 course be routed to the same file or pipe command. These two transports have an
20930 option called &%use_bsmtp%&, which causes them to deliver the message in
20931 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20932 &%check_string%& and &%escape_string%& options are forced to the values
20933 .code
20934 check_string = "."
20935 escape_string = ".."
20936 .endd
20937 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20938 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20939 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20940
20941 .cindex "&'Envelope-to:'& header line"
20942 If the generic &%envelope_to_add%& option is set for a batching transport, the
20943 &'Envelope-to:'& header that is added to the message contains all the addresses
20944 that are being processed together. If you are using a batching &(appendfile)&
20945 transport without &%use_bsmtp%&, the only way to preserve the recipient
20946 addresses is to set the &%envelope_to_add%& option.
20947
20948 .cindex "&(pipe)& transport" "with multiple addresses"
20949 .vindex "&$pipe_addresses$&"
20950 If you are using a &(pipe)& transport without BSMTP, and setting the
20951 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20952 the command. This is not a true variable; it is a bit of magic that causes each
20953 of the recipient addresses to be inserted into the command as a separate
20954 argument. This provides a way of accessing all the addresses that are being
20955 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20956 are specified by a &(redirect)& router.
20957
20958
20959
20960
20961 . ////////////////////////////////////////////////////////////////////////////
20962 . ////////////////////////////////////////////////////////////////////////////
20963
20964 .chapter "The appendfile transport" "CHAPappendfile"
20965 .scindex IIDapptra1 "&(appendfile)& transport"
20966 .scindex IIDapptra2 "transports" "&(appendfile)&"
20967 .cindex "directory creation"
20968 .cindex "creating directories"
20969 The &(appendfile)& transport delivers a message by appending it to an existing
20970 file, or by creating an entirely new file in a specified directory. Single
20971 files to which messages are appended can be in the traditional Unix mailbox
20972 format, or optionally in the MBX format supported by the Pine MUA and
20973 University of Washington IMAP daemon, &'inter alia'&. When each message is
20974 being delivered as a separate file, &"maildir"& format can optionally be used
20975 to give added protection against failures that happen part-way through the
20976 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20977 supported. For all file formats, Exim attempts to create as many levels of
20978 directory as necessary, provided that &%create_directory%& is set.
20979
20980 The code for the optional formats is not included in the Exim binary by
20981 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20982 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20983 included.
20984
20985 .cindex "quota" "system"
20986 Exim recognizes system quota errors, and generates an appropriate message. Exim
20987 also supports its own quota control within the transport, for use when the
20988 system facility is unavailable or cannot be used for some reason.
20989
20990 If there is an error while appending to a file (for example, quota exceeded or
20991 partition filled), Exim attempts to reset the file's length and last
20992 modification time back to what they were before. If there is an error while
20993 creating an entirely new file, the new file is removed.
20994
20995 Before appending to a file, a number of security checks are made, and the
20996 file is locked. A detailed description is given below, after the list of
20997 private options.
20998
20999 The &(appendfile)& transport is most commonly used for local deliveries to
21000 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21001 putting messages into files for remote delivery by some means other than Exim.
21002 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21003 option).
21004
21005
21006
21007 .section "The file and directory options" "SECTfildiropt"
21008 The &%file%& option specifies a single file, to which the message is appended;
21009 the &%directory%& option specifies a directory, in which a new file containing
21010 the message is created. Only one of these two options can be set, and for
21011 normal deliveries to mailboxes, one of them &'must'& be set.
21012
21013 .vindex "&$address_file$&"
21014 .vindex "&$local_part$&"
21015 However, &(appendfile)& is also used for delivering messages to files or
21016 directories whose names (or parts of names) are obtained from alias,
21017 forwarding, or filtering operations (for example, a &%save%& command in a
21018 user's Exim filter). When such a transport is running, &$local_part$& contains
21019 the local part that was aliased or forwarded, and &$address_file$& contains the
21020 name (or partial name) of the file or directory generated by the redirection
21021 operation. There are two cases:
21022
21023 .ilist
21024 If neither &%file%& nor &%directory%& is set, the redirection operation
21025 must specify an absolute path (one that begins with &`/`&). This is the most
21026 common case when users with local accounts use filtering to sort mail into
21027 different folders. See for example, the &(address_file)& transport in the
21028 default configuration. If the path ends with a slash, it is assumed to be the
21029 name of a directory. A delivery to a directory can also be forced by setting
21030 &%maildir_format%& or &%mailstore_format%&.
21031 .next
21032 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21033 used to determine the file or directory name for the delivery. Normally, the
21034 contents of &$address_file$& are used in some way in the string expansion.
21035 .endlist
21036
21037
21038 .cindex "Sieve filter" "configuring &(appendfile)&"
21039 .cindex "Sieve filter" "relative mailbox path handling"
21040 As an example of the second case, consider an environment where users do not
21041 have home directories. They may be permitted to use Exim filter commands of the
21042 form:
21043 .code
21044 save folder23
21045 .endd
21046 or Sieve filter commands of the form:
21047 .code
21048 require "fileinto";
21049 fileinto "folder23";
21050 .endd
21051 In this situation, the expansion of &%file%& or &%directory%& in the transport
21052 must transform the relative path into an appropriate absolute file name. In the
21053 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21054 is used as a result of a &"keep"& action in the filter. This example shows one
21055 way of handling this requirement:
21056 .code
21057 file = ${if eq{$address_file}{inbox} \
21058             {/var/mail/$local_part} \
21059             {${if eq{${substr_0_1:$address_file}}{/} \
21060                   {$address_file} \
21061                   {$home/mail/$address_file} \
21062             }} \
21063        }
21064 .endd
21065 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21066 location, absolute paths are used without change, and other folders are in the
21067 &_mail_& directory within the home directory.
21068
21069 &*Note 1*&: While processing an Exim filter, a relative path such as
21070 &_folder23_& is turned into an absolute path if a home directory is known to
21071 the router. In particular, this is the case if &%check_local_user%& is set. If
21072 you want to prevent this happening at routing time, you can set
21073 &%router_home_directory%& empty. This forces the router to pass the relative
21074 path to the transport.
21075
21076 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21077 the &%file%& or &%directory%& option is still used if it is set.
21078
21079
21080
21081
21082 .section "Private options for appendfile" "SECID134"
21083 .cindex "options" "&(appendfile)& transport"
21084
21085
21086
21087 .option allow_fifo appendfile boolean false
21088 .cindex "fifo (named pipe)"
21089 .cindex "named pipe (fifo)"
21090 .cindex "pipe" "named (fifo)"
21091 Setting this option permits delivery to named pipes (FIFOs) as well as to
21092 regular files. If no process is reading the named pipe at delivery time, the
21093 delivery is deferred.
21094
21095
21096 .option allow_symlink appendfile boolean false
21097 .cindex "symbolic link" "to mailbox"
21098 .cindex "mailbox" "symbolic link"
21099 By default, &(appendfile)& will not deliver if the path name for the file is
21100 that of a symbolic link. Setting this option relaxes that constraint, but there
21101 are security issues involved in the use of symbolic links. Be sure you know
21102 what you are doing if you set this. Details of exactly what this option affects
21103 are included in the discussion which follows this list of options.
21104
21105
21106 .option batch_id appendfile string&!! unset
21107 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21108 However, batching is automatically disabled for &(appendfile)& deliveries that
21109 happen as a result of forwarding or aliasing or other redirection directly to a
21110 file.
21111
21112
21113 .option batch_max appendfile integer 1
21114 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21115
21116
21117 .option check_group appendfile boolean false
21118 When this option is set, the group owner of the file defined by the &%file%&
21119 option is checked to see that it is the same as the group under which the
21120 delivery process is running. The default setting is false because the default
21121 file mode is 0600, which means that the group is irrelevant.
21122
21123
21124 .option check_owner appendfile boolean true
21125 When this option is set, the owner of the file defined by the &%file%& option
21126 is checked to ensure that it is the same as the user under which the delivery
21127 process is running.
21128
21129
21130 .option check_string appendfile string "see below"
21131 .cindex "&""From""& line"
21132 As &(appendfile)& writes the message, the start of each line is tested for
21133 matching &%check_string%&, and if it does, the initial matching characters are
21134 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21135 a literal string, not a regular expression, and the case of any letters it
21136 contains is significant.
21137
21138 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21139 are forced to &"."& and &".."& respectively, and any settings in the
21140 configuration are ignored. Otherwise, they default to &"From&~"& and
21141 &">From&~"& when the &%file%& option is set, and unset when any of the
21142 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21143
21144 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21145 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21146 &"From&~"& indicates the start of a new message. All four options need changing
21147 if another format is used. For example, to deliver to mailboxes in MMDF format:
21148 .cindex "MMDF format mailbox"
21149 .cindex "mailbox" "MMDF format"
21150 .code
21151 check_string = "\1\1\1\1\n"
21152 escape_string = "\1\1\1\1 \n"
21153 message_prefix = "\1\1\1\1\n"
21154 message_suffix = "\1\1\1\1\n"
21155 .endd
21156 .option create_directory appendfile boolean true
21157 .cindex "directory creation"
21158 When this option is true, Exim attempts to create any missing superior
21159 directories for the file that it is about to write. A created directory's mode
21160 is given by the &%directory_mode%& option.
21161
21162 The group ownership of a newly created directory is highly dependent on the
21163 operating system (and possibly the file system) that is being used. For
21164 example, in Solaris, if the parent directory has the setgid bit set, its group
21165 is propagated to the child; if not, the currently set group is used. However,
21166 in FreeBSD, the parent's group is always used.
21167
21168
21169
21170 .option create_file appendfile string anywhere
21171 This option constrains the location of files and directories that are created
21172 by this transport. It applies to files defined by the &%file%& option and
21173 directories defined by the &%directory%& option. In the case of maildir
21174 delivery, it applies to the top level directory, not the maildir directories
21175 beneath.
21176
21177 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21178 &"belowhome"&. In the second and third cases, a home directory must have been
21179 set for the transport. This option is not useful when an explicit file name is
21180 given for normal mailbox deliveries. It is intended for the case when file
21181 names are generated from users' &_.forward_& files. These are usually handled
21182 by an &(appendfile)& transport called &%address_file%&. See also
21183 &%file_must_exist%&.
21184
21185
21186 .option directory appendfile string&!! unset
21187 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21188 or &%directory%& must be set, unless the delivery is the direct result of a
21189 redirection (see section &<<SECTfildiropt>>&).
21190
21191 When &%directory%& is set, the string is expanded, and the message is delivered
21192 into a new file or files in or below the given directory, instead of being
21193 appended to a single mailbox file. A number of different formats are provided
21194 (see &%maildir_format%& and &%mailstore_format%&), and see section
21195 &<<SECTopdir>>& for further details of this form of delivery.
21196
21197
21198 .option directory_file appendfile string&!! "see below"
21199 .cindex "base62"
21200 .vindex "&$inode$&"
21201 When &%directory%& is set, but neither &%maildir_format%& nor
21202 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21203 whose name is obtained by expanding this string. The default value is:
21204 .code
21205 q${base62:$tod_epoch}-$inode
21206 .endd
21207 This generates a unique name from the current time, in base 62 form, and the
21208 inode of the file. The variable &$inode$& is available only when expanding this
21209 option.
21210
21211
21212 .option directory_mode appendfile "octal integer" 0700
21213 If &(appendfile)& creates any directories as a result of the
21214 &%create_directory%& option, their mode is specified by this option.
21215
21216
21217 .option escape_string appendfile string "see description"
21218 See &%check_string%& above.
21219
21220
21221 .option file appendfile string&!! unset
21222 This option is mutually exclusive with the &%directory%& option, but one of
21223 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21224 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21225 specifies a single file, to which the message is appended. One or more of
21226 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21227 &%file%&.
21228
21229 .cindex "NFS" "lock file"
21230 .cindex "locking files"
21231 .cindex "lock files"
21232 If you are using more than one host to deliver over NFS into the same
21233 mailboxes, you should always use lock files.
21234
21235 The string value is expanded for each delivery, and must yield an absolute
21236 path. The most common settings of this option are variations on one of these
21237 examples:
21238 .code
21239 file = /var/spool/mail/$local_part
21240 file = /home/$local_part/inbox
21241 file = $home/inbox
21242 .endd
21243 .cindex "&""sticky""& bit"
21244 In the first example, all deliveries are done into the same directory. If Exim
21245 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21246 create a file in the directory, so the &"sticky"& bit must be turned on for
21247 deliveries to be possible, or alternatively the &%group%& option can be used to
21248 run the delivery under a group id which has write access to the directory.
21249
21250
21251
21252 .option file_format appendfile string unset
21253 .cindex "file" "mailbox; checking existing format"
21254 This option requests the transport to check the format of an existing file
21255 before adding to it. The check consists of matching a specific string at the
21256 start of the file. The value of the option consists of an even number of
21257 colon-separated strings. The first of each pair is the test string, and the
21258 second is the name of a transport. If the transport associated with a matched
21259 string is not the current transport, control is passed over to the other
21260 transport. For example, suppose the standard &(local_delivery)& transport has
21261 this added to it:
21262 .code
21263 file_format = "From       : local_delivery :\
21264                \1\1\1\1\n : local_mmdf_delivery"
21265 .endd
21266 Mailboxes that begin with &"From"& are still handled by this transport, but if
21267 a mailbox begins with four binary ones followed by a newline, control is passed
21268 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21269 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21270 is assumed to match the current transport. If the start of a mailbox doesn't
21271 match any string, or if the transport named for a given string is not defined,
21272 delivery is deferred.
21273
21274
21275 .option file_must_exist appendfile boolean false
21276 If this option is true, the file specified by the &%file%& option must exist.
21277 A temporary error occurs if it does not, causing delivery to be deferred.
21278 If this option is false, the file is created if it does not exist.
21279
21280
21281 .option lock_fcntl_timeout appendfile time 0s
21282 .cindex "timeout" "mailbox locking"
21283 .cindex "mailbox" "locking, blocking and non-blocking"
21284 .cindex "locking files"
21285 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21286 when locking an open mailbox file. If the call fails, the delivery process
21287 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21288 Non-blocking calls are used so that the file is not kept open during the wait
21289 for the lock; the reason for this is to make it as safe as possible for
21290 deliveries over NFS in the case when processes might be accessing an NFS
21291 mailbox without using a lock file. This should not be done, but
21292 misunderstandings and hence misconfigurations are not unknown.
21293
21294 On a busy system, however, the performance of a non-blocking lock approach is
21295 not as good as using a blocking lock with a timeout. In this case, the waiting
21296 is done inside the system call, and Exim's delivery process acquires the lock
21297 and can proceed as soon as the previous lock holder releases it.
21298
21299 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21300 timeout, are used. There may still be some retrying: the maximum number of
21301 retries is
21302 .code
21303 (lock_retries * lock_interval) / lock_fcntl_timeout
21304 .endd
21305 rounded up to the next whole number. In other words, the total time during
21306 which &(appendfile)& is trying to get a lock is roughly the same, unless
21307 &%lock_fcntl_timeout%& is set very large.
21308
21309 You should consider setting this option if you are getting a lot of delayed
21310 local deliveries because of errors of the form
21311 .code
21312 failed to lock mailbox /some/file (fcntl)
21313 .endd
21314
21315 .option lock_flock_timeout appendfile time 0s
21316 This timeout applies to file locking when using &[flock()]& (see
21317 &%use_flock%&); the timeout operates in a similar manner to
21318 &%lock_fcntl_timeout%&.
21319
21320
21321 .option lock_interval appendfile time 3s
21322 This specifies the time to wait between attempts to lock the file. See below
21323 for details of locking.
21324
21325
21326 .option lock_retries appendfile integer 10
21327 This specifies the maximum number of attempts to lock the file. A value of zero
21328 is treated as 1. See below for details of locking.
21329
21330
21331 .option lockfile_mode appendfile "octal integer" 0600
21332 This specifies the mode of the created lock file, when a lock file is being
21333 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21334
21335
21336 .option lockfile_timeout appendfile time 30m
21337 .cindex "timeout" "mailbox locking"
21338 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21339 exists and is older than this value, it is assumed to have been left behind by
21340 accident, and Exim attempts to remove it.
21341
21342
21343 .option mailbox_filecount appendfile string&!! unset
21344 .cindex "mailbox" "specifying size of"
21345 .cindex "size" "of mailbox"
21346 If this option is set, it is expanded, and the result is taken as the current
21347 number of files in the mailbox. It must be a decimal number, optionally
21348 followed by K or M. This provides a way of obtaining this information from an
21349 external source that maintains the data.
21350
21351
21352 .option mailbox_size appendfile string&!! unset
21353 .cindex "mailbox" "specifying size of"
21354 .cindex "size" "of mailbox"
21355 If this option is set, it is expanded, and the result is taken as the current
21356 size the mailbox. It must be a decimal number, optionally followed by K or M.
21357 This provides a way of obtaining this information from an external source that
21358 maintains the data. This is likely to be helpful for maildir deliveries where
21359 it is computationally expensive to compute the size of a mailbox.
21360
21361
21362
21363 .option maildir_format appendfile boolean false
21364 .cindex "maildir format" "specifying"
21365 If this option is set with the &%directory%& option, the delivery is into a new
21366 file, in the &"maildir"& format that is used by other mail software. When the
21367 transport is activated directly from a &(redirect)& router (for example, the
21368 &(address_file)& transport in the default configuration), setting
21369 &%maildir_format%& causes the path received from the router to be treated as a
21370 directory, whether or not it ends with &`/`&. This option is available only if
21371 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21372 &<<SECTmaildirdelivery>>& below for further details.
21373
21374
21375 .option maildir_quota_directory_regex appendfile string "See below"
21376 .cindex "maildir format" "quota; directories included in"
21377 .cindex "quota" "maildir; directories included in"
21378 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21379 a regular expression for specifying directories, relative to the quota
21380 directory (see &%quota_directory%&), that should be included in the quota
21381 calculation. The default value is:
21382 .code
21383 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21384 .endd
21385 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21386 (directories whose names begin with a dot). If you want to exclude the
21387 &_Trash_&
21388 folder from the count (as some sites do), you need to change this setting to
21389 .code
21390 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21391 .endd
21392 This uses a negative lookahead in the regular expression to exclude the
21393 directory whose name is &_.Trash_&. When a directory is excluded from quota
21394 calculations, quota processing is bypassed for any messages that are delivered
21395 directly into that directory.
21396
21397
21398 .option maildir_retries appendfile integer 10
21399 This option specifies the number of times to retry when writing a file in
21400 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21401
21402
21403 .option maildir_tag appendfile string&!! unset
21404 This option applies only to deliveries in maildir format, and is described in
21405 section &<<SECTmaildirdelivery>>& below.
21406
21407
21408 .option maildir_use_size_file appendfile&!! boolean false
21409 .cindex "maildir format" "&_maildirsize_& file"
21410 The result of string expansion for this option must be a valid boolean value.
21411 If it is true, it enables support for &_maildirsize_& files. Exim
21412 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21413 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21414 value is zero. See &%maildir_quota_directory_regex%& above and section
21415 &<<SECTmaildirdelivery>>& below for further details.
21416
21417 .option maildirfolder_create_regex appendfile string unset
21418 .cindex "maildir format" "&_maildirfolder_& file"
21419 .cindex "&_maildirfolder_&, creating"
21420 The value of this option is a regular expression. If it is unset, it has no
21421 effect. Otherwise, before a maildir delivery takes place, the pattern is
21422 matched against the name of the maildir directory, that is, the directory
21423 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21424 delivery. If there is a match, Exim checks for the existence of a file called
21425 &_maildirfolder_& in the directory, and creates it if it does not exist.
21426 See section &<<SECTmaildirdelivery>>& for more details.
21427
21428
21429 .option mailstore_format appendfile boolean false
21430 .cindex "mailstore format" "specifying"
21431 If this option is set with the &%directory%& option, the delivery is into two
21432 new files in  &"mailstore"& format. The option is available only if
21433 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21434 below for further details.
21435
21436
21437 .option mailstore_prefix appendfile string&!! unset
21438 This option applies only to deliveries in mailstore format, and is described in
21439 section &<<SECTopdir>>& below.
21440
21441
21442 .option mailstore_suffix appendfile string&!! unset
21443 This option applies only to deliveries in mailstore format, and is described in
21444 section &<<SECTopdir>>& below.
21445
21446
21447 .option mbx_format appendfile boolean false
21448 .cindex "locking files"
21449 .cindex "file" "locking"
21450 .cindex "file" "MBX format"
21451 .cindex "MBX format, specifying"
21452 This option is available only if Exim has been compiled with SUPPORT_MBX
21453 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21454 the message is appended to the mailbox file in MBX format instead of
21455 traditional Unix format. This format is supported by Pine4 and its associated
21456 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21457
21458 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21459 automatically changed by the use of &%mbx_format%&. They should normally be set
21460 empty when using MBX format, so this option almost always appears in this
21461 combination:
21462 .code
21463 mbx_format = true
21464 message_prefix =
21465 message_suffix =
21466 .endd
21467 If none of the locking options are mentioned in the configuration,
21468 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21469 is possible to specify the other kinds of locking with &%mbx_format%&, but
21470 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21471 interworks with &'c-client'&, providing for shared access to the mailbox. It
21472 should not be used if any program that does not use this form of locking is
21473 going to access the mailbox, nor should it be used if the mailbox file is NFS
21474 mounted, because it works only when the mailbox is accessed from a single host.
21475
21476 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21477 the standard version of &'c-client'&, because as long as it has a mailbox open
21478 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21479 append messages to it.
21480
21481
21482 .option message_prefix appendfile string&!! "see below"
21483 .cindex "&""From""& line"
21484 The string specified here is expanded and output at the start of every message.
21485 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21486 in which case it is:
21487 .code
21488 message_prefix = "From ${if def:return_path{$return_path}\
21489   {MAILER-DAEMON}} $tod_bsdinbox\n"
21490 .endd
21491 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21492 &`\n`& to &`\r\n`& in &%message_prefix%&.
21493
21494 .option message_suffix appendfile string&!! "see below"
21495 The string specified here is expanded and output at the end of every message.
21496 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21497 in which case it is a single newline character. The suffix can be suppressed by
21498 setting
21499 .code
21500 message_suffix =
21501 .endd
21502 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21503 &`\n`& to &`\r\n`& in &%message_suffix%&.
21504
21505 .option mode appendfile "octal integer" 0600
21506 If the output file is created, it is given this mode. If it already exists and
21507 has wider permissions, they are reduced to this mode. If it has narrower
21508 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21509 if the delivery is the result of a &%save%& command in a filter file specifying
21510 a particular mode, the mode of the output file is always forced to take that
21511 value, and this option is ignored.
21512
21513
21514 .option mode_fail_narrower appendfile boolean true
21515 This option applies in the case when an existing mailbox file has a narrower
21516 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21517 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21518 continues with the delivery attempt, using the existing mode of the file.
21519
21520
21521 .option notify_comsat appendfile boolean false
21522 If this option is true, the &'comsat'& daemon is notified after every
21523 successful delivery to a user mailbox. This is the daemon that notifies logged
21524 on users about incoming mail.
21525
21526
21527 .option quota appendfile string&!! unset
21528 .cindex "quota" "imposed by Exim"
21529 This option imposes a limit on the size of the file to which Exim is appending,
21530 or to the total space used in the directory tree when the &%directory%& option
21531 is set. In the latter case, computation of the space used is expensive, because
21532 all the files in the directory (and any sub-directories) have to be
21533 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21534 &%maildir_use_size_file%& for ways to avoid this in environments where users
21535 have no shell access to their mailboxes).
21536
21537 As there is no interlock against two simultaneous deliveries into a
21538 multi-file mailbox, it is possible for the quota to be overrun in this case.
21539 For single-file mailboxes, of course, an interlock is a necessity.
21540
21541 A file's size is taken as its &'used'& value. Because of blocking effects, this
21542 may be a lot less than the actual amount of disk space allocated to the file.
21543 If the sizes of a number of files are being added up, the rounding effect can
21544 become quite noticeable, especially on systems that have large block sizes.
21545 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21546 the obvious value which users understand most easily.
21547
21548 The value of the option is expanded, and must then be a numerical value
21549 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21550 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21551 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21552 be handled.
21553
21554 &*Note*&: A value of zero is interpreted as &"no quota"&.
21555
21556 The expansion happens while Exim is running as root, before it changes uid for
21557 the delivery. This means that files that are inaccessible to the end user can
21558 be used to hold quota values that are looked up in the expansion. When delivery
21559 fails because this quota is exceeded, the handling of the error is as for
21560 system quota failures.
21561
21562 By default, Exim's quota checking mimics system quotas, and restricts the
21563 mailbox to the specified maximum size, though the value is not accurate to the
21564 last byte, owing to separator lines and additional headers that may get added
21565 during message delivery. When a mailbox is nearly full, large messages may get
21566 refused even though small ones are accepted, because the size of the current
21567 message is added to the quota when the check is made. This behaviour can be
21568 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21569 for exceeding the quota does not include the current message. Thus, deliveries
21570 continue until the quota has been exceeded; thereafter, no further messages are
21571 delivered. See also &%quota_warn_threshold%&.
21572
21573
21574 .option quota_directory appendfile string&!! unset
21575 This option defines the directory to check for quota purposes when delivering
21576 into individual files. The default is the delivery directory, or, if a file
21577 called &_maildirfolder_& exists in a maildir directory, the parent of the
21578 delivery directory.
21579
21580
21581 .option quota_filecount appendfile string&!! 0
21582 This option applies when the &%directory%& option is set. It limits the total
21583 number of files in the directory (compare the inode limit in system quotas). It
21584 can only be used if &%quota%& is also set. The value is expanded; an expansion
21585 failure causes delivery to be deferred. A value of zero is interpreted as
21586 &"no quota"&.
21587
21588
21589 .option quota_is_inclusive appendfile boolean true
21590 See &%quota%& above.
21591
21592
21593 .option quota_size_regex appendfile string unset
21594 This option applies when one of the delivery modes that writes a separate file
21595 for each message is being used. When Exim wants to find the size of one of
21596 these files in order to test the quota, it first checks &%quota_size_regex%&.
21597 If this is set to a regular expression that matches the file name, and it
21598 captures one string, that string is interpreted as a representation of the
21599 file's size. The value of &%quota_size_regex%& is not expanded.
21600
21601 This feature is useful only when users have no shell access to their mailboxes
21602 &-- otherwise they could defeat the quota simply by renaming the files. This
21603 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21604 the file length to the file name. For example:
21605 .code
21606 maildir_tag = ,S=$message_size
21607 quota_size_regex = ,S=(\d+)
21608 .endd
21609 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21610 number of lines in the message.
21611
21612 The regular expression should not assume that the length is at the end of the
21613 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21614 sometimes add other information onto the ends of message file names.
21615
21616 Section &<<SECID136>>& contains further information.
21617
21618
21619 .option quota_warn_message appendfile string&!! "see below"
21620 See below for the use of this option. If it is not set when
21621 &%quota_warn_threshold%& is set, it defaults to
21622 .code
21623 quota_warn_message = "\
21624   To: $local_part@$domain\n\
21625   Subject: Your mailbox\n\n\
21626   This message is automatically created \
21627   by mail delivery software.\n\n\
21628   The size of your mailbox has exceeded \
21629   a warning threshold that is\n\
21630   set by the system administrator.\n"
21631 .endd
21632
21633
21634 .option quota_warn_threshold appendfile string&!! 0
21635 .cindex "quota" "warning threshold"
21636 .cindex "mailbox" "size warning"
21637 .cindex "size" "of mailbox"
21638 This option is expanded in the same way as &%quota%& (see above). If the
21639 resulting value is greater than zero, and delivery of the message causes the
21640 size of the file or total space in the directory tree to cross the given
21641 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21642 may be specified as a percentage of it by following the value with a percent
21643 sign. For example:
21644 .code
21645 quota = 10M
21646 quota_warn_threshold = 75%
21647 .endd
21648 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21649 percent sign is ignored.
21650
21651 The warning message itself is specified by the &%quota_warn_message%& option,
21652 and it must start with a &'To:'& header line containing the recipient(s) of the
21653 warning message. These do not necessarily have to include the recipient(s) of
21654 the original message. A &'Subject:'& line should also normally be supplied. You
21655 can include any other header lines that you want. If you do not include a
21656 &'From:'& line, the default is:
21657 .code
21658 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21659 .endd
21660 .oindex &%errors_reply_to%&
21661 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21662 option.
21663
21664 The &%quota%& option does not have to be set in order to use this option; they
21665 are independent of one another except when the threshold is specified as a
21666 percentage.
21667
21668
21669 .option use_bsmtp appendfile boolean false
21670 .cindex "envelope sender"
21671 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21672 format, with the envelope sender and recipient(s) included as SMTP commands. If
21673 you want to include a leading HELO command with such messages, you can do
21674 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21675 for details of batch SMTP.
21676
21677
21678 .option use_crlf appendfile boolean false
21679 .cindex "carriage return"
21680 .cindex "linefeed"
21681 This option causes lines to be terminated with the two-character CRLF sequence
21682 (carriage return, linefeed) instead of just a linefeed character. In the case
21683 of batched SMTP, the byte sequence written to the file is then an exact image
21684 of what would be sent down a real SMTP connection.
21685
21686 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21687 (which are used to supply the traditional &"From&~"& and blank line separators
21688 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21689 carriage return characters if these are needed. In cases where these options
21690 have non-empty defaults, the values end with a single linefeed, so they must be
21691 changed to end with &`\r\n`& if &%use_crlf%& is set.
21692
21693
21694 .option use_fcntl_lock appendfile boolean "see below"
21695 This option controls the use of the &[fcntl()]& function to lock a file for
21696 exclusive use when a message is being appended. It is set by default unless
21697 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21698 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21699 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21700
21701
21702 .option use_flock_lock appendfile boolean false
21703 This option is provided to support the use of &[flock()]& for file locking, for
21704 the few situations where it is needed. Most modern operating systems support
21705 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21706 each other. Exim uses &[fcntl()]& locking by default.
21707
21708 This option is required only if you are using an operating system where
21709 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21710 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21711 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21712
21713 .cindex "Solaris" "&[flock()]& support"
21714 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21715 have it (and some, I think, provide a not quite right version built on top of
21716 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21717 the ability to use it, and any attempt to do so will cause a configuration
21718 error.
21719
21720 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21721 is just being mapped onto &[fcntl()]& by the OS).
21722
21723
21724 .option use_lockfile appendfile boolean "see below"
21725 If this option is turned off, Exim does not attempt to create a lock file when
21726 appending to a mailbox file. In this situation, the only locking is by
21727 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21728 sure that every MUA that is ever going to look at your users' mailboxes uses
21729 &[fcntl()]& rather than a lock file, and even then only when you are not
21730 delivering over NFS from more than one host.
21731
21732 .cindex "NFS" "lock file"
21733 In order to append to an NFS file safely from more than one host, it is
21734 necessary to take out a lock &'before'& opening the file, and the lock file
21735 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21736 file corruption.
21737
21738 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21739 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21740 except when &%mbx_format%& is set.
21741
21742
21743 .option use_mbx_lock appendfile boolean "see below"
21744 This option is available only if Exim has been compiled with SUPPORT_MBX
21745 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21746 locking rules be used. It is set by default if &%mbx_format%& is set and none
21747 of the locking options are mentioned in the configuration. The locking rules
21748 are the same as are used by the &'c-client'& library that underlies Pine and
21749 the IMAP4 and POP daemons that come with it (see the discussion below). The
21750 rules allow for shared access to the mailbox. However, this kind of locking
21751 does not work when the mailbox is NFS mounted.
21752
21753 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21754 &%use_flock_lock%& to control what kind of locking is used in implementing the
21755 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21756 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21757
21758
21759
21760
21761 .section "Operational details for appending" "SECTopappend"
21762 .cindex "appending to a file"
21763 .cindex "file" "appending"
21764 Before appending to a file, the following preparations are made:
21765
21766 .ilist
21767 If the name of the file is &_/dev/null_&, no action is taken, and a success
21768 return is given.
21769
21770 .next
21771 .cindex "directory creation"
21772 If any directories on the file's path are missing, Exim creates them if the
21773 &%create_directory%& option is set. A created directory's mode is given by the
21774 &%directory_mode%& option.
21775
21776 .next
21777 If &%file_format%& is set, the format of an existing file is checked. If this
21778 indicates that a different transport should be used, control is passed to that
21779 transport.
21780
21781 .next
21782 .cindex "file" "locking"
21783 .cindex "locking files"
21784 .cindex "NFS" "lock file"
21785 If &%use_lockfile%& is set, a lock file is built in a way that will work
21786 reliably over NFS, as follows:
21787
21788 .olist
21789 Create a &"hitching post"& file whose name is that of the lock file with the
21790 current time, primary host name, and process id added, by opening for writing
21791 as a new file. If this fails with an access error, delivery is deferred.
21792 .next
21793 Close the hitching post file, and hard link it to the lock file name.
21794 .next
21795 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21796 Unlink the hitching post name.
21797 .next
21798 Otherwise, use &[stat()]& to get information about the hitching post file, and
21799 then unlink hitching post name. If the number of links is exactly two, creation
21800 of the lock file succeeded but something (for example, an NFS server crash and
21801 restart) caused this fact not to be communicated to the &[link()]& call.
21802 .next
21803 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21804 up to &%lock_retries%& times. However, since any program that writes to a
21805 mailbox should complete its task very quickly, it is reasonable to time out old
21806 lock files that are normally the result of user agent and system crashes. If an
21807 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21808 it before trying again.
21809 .endlist olist
21810
21811 .next
21812 A call is made to &[lstat()]& to discover whether the main file exists, and if
21813 so, what its characteristics are. If &[lstat()]& fails for any reason other
21814 than non-existence, delivery is deferred.
21815
21816 .next
21817 .cindex "symbolic link" "to mailbox"
21818 .cindex "mailbox" "symbolic link"
21819 If the file does exist and is a symbolic link, delivery is deferred, unless the
21820 &%allow_symlink%& option is set, in which case the ownership of the link is
21821 checked, and then &[stat()]& is called to find out about the real file, which
21822 is then subjected to the checks below. The check on the top-level link
21823 ownership prevents one user creating a link for another's mailbox in a sticky
21824 directory, though allowing symbolic links in this case is definitely not a good
21825 idea. If there is a chain of symbolic links, the intermediate ones are not
21826 checked.
21827
21828 .next
21829 If the file already exists but is not a regular file, or if the file's owner
21830 and group (if the group is being checked &-- see &%check_group%& above) are
21831 different from the user and group under which the delivery is running,
21832 delivery is deferred.
21833
21834 .next
21835 If the file's permissions are more generous than specified, they are reduced.
21836 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21837 is set false, in which case the delivery is tried using the existing
21838 permissions.
21839
21840 .next
21841 The file's inode number is saved, and the file is then opened for appending.
21842 If this fails because the file has vanished, &(appendfile)& behaves as if it
21843 hadn't existed (see below). For any other failures, delivery is deferred.
21844
21845 .next
21846 If the file is opened successfully, check that the inode number hasn't
21847 changed, that it is still a regular file, and that the owner and permissions
21848 have not changed. If anything is wrong, defer delivery and freeze the message.
21849
21850 .next
21851 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21852 option is set. Otherwise, check that the file is being created in a permitted
21853 directory if the &%create_file%& option is set (deferring on failure), and then
21854 open for writing as a new file, with the O_EXCL and O_CREAT options,
21855 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21856 set). In this case, which can happen if the link points to a non-existent file,
21857 the file is opened for writing using O_CREAT but not O_EXCL, because
21858 that prevents link following.
21859
21860 .next
21861 .cindex "loop" "while file testing"
21862 If opening fails because the file exists, obey the tests given above for
21863 existing files. However, to avoid looping in a situation where the file is
21864 being continuously created and destroyed, the exists/not-exists loop is broken
21865 after 10 repetitions, and the message is then frozen.
21866
21867 .next
21868 If opening fails with any other error, defer delivery.
21869
21870 .next
21871 .cindex "file" "locking"
21872 .cindex "locking files"
21873 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21874 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21875 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21876 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21877 file, and an exclusive lock on the file whose name is
21878 .code
21879 /tmp/.<device-number>.<inode-number>
21880 .endd
21881 using the device and inode numbers of the open mailbox file, in accordance with
21882 the MBX locking rules. This file is created with a mode that is specified by
21883 the &%lockfile_mode%& option.
21884
21885 If Exim fails to lock the file, there are two possible courses of action,
21886 depending on the value of the locking timeout. This is obtained from
21887 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21888
21889 If the timeout value is zero, the file is closed, Exim waits for
21890 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21891 to lock it again. This happens up to &%lock_retries%& times, after which the
21892 delivery is deferred.
21893
21894 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21895 &[flock()]& are used (with the given timeout), so there has already been some
21896 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21897 immediately. It retries up to
21898 .code
21899 (lock_retries * lock_interval) / <timeout>
21900 .endd
21901 times (rounded up).
21902 .endlist
21903
21904 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21905 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21906
21907
21908 .section "Operational details for delivery to a new file" "SECTopdir"
21909 .cindex "delivery" "to single file"
21910 .cindex "&""From""& line"
21911 When the &%directory%& option is set instead of &%file%&, each message is
21912 delivered into a newly-created file or set of files. When &(appendfile)& is
21913 activated directly from a &(redirect)& router, neither &%file%& nor
21914 &%directory%& is normally set, because the path for delivery is supplied by the
21915 router. (See for example, the &(address_file)& transport in the default
21916 configuration.) In this case, delivery is to a new file if either the path name
21917 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21918
21919 No locking is required while writing the message to a new file, so the various
21920 locking options of the transport are ignored. The &"From"& line that by default
21921 separates messages in a single file is not normally needed, nor is the escaping
21922 of message lines that start with &"From"&, and there is no need to ensure a
21923 newline at the end of each message. Consequently, the default values for
21924 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21925 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21926
21927 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21928 the files in the delivery directory by default. However, you can specify a
21929 different directory by setting &%quota_directory%&. Also, for maildir
21930 deliveries (see below) the &_maildirfolder_& convention is honoured.
21931
21932
21933 .cindex "maildir format"
21934 .cindex "mailstore format"
21935 There are three different ways in which delivery to individual files can be
21936 done, controlled by the settings of the &%maildir_format%& and
21937 &%mailstore_format%& options. Note that code to support maildir or mailstore
21938 formats is not included in the binary unless SUPPORT_MAILDIR or
21939 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21940
21941 .cindex "directory creation"
21942 In all three cases an attempt is made to create the directory and any necessary
21943 sub-directories if they do not exist, provided that the &%create_directory%&
21944 option is set (the default). The location of a created directory can be
21945 constrained by setting &%create_file%&. A created directory's mode is given by
21946 the &%directory_mode%& option. If creation fails, or if the
21947 &%create_directory%& option is not set when creation is required, delivery is
21948 deferred.
21949
21950
21951
21952 .section "Maildir delivery" "SECTmaildirdelivery"
21953 .cindex "maildir format" "description of"
21954 If the &%maildir_format%& option is true, Exim delivers each message by writing
21955 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21956 directory that is defined by the &%directory%& option (the &"delivery
21957 directory"&). If the delivery is successful, the file is renamed into the
21958 &_new_& subdirectory.
21959
21960 In the file name, <&'stime'&> is the current time of day in seconds, and
21961 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21962 Exim checks that the time-of-day clock has moved on by at least one microsecond
21963 before terminating the delivery process. This guarantees uniqueness for the
21964 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21965 opening it. If any response other than ENOENT (does not exist) is given,
21966 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21967
21968 Before Exim carries out a maildir delivery, it ensures that subdirectories
21969 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21970 do not exist, Exim tries to create them and any superior directories in their
21971 path, subject to the &%create_directory%& and &%create_file%& options. If the
21972 &%maildirfolder_create_regex%& option is set, and the regular expression it
21973 contains matches the delivery directory, Exim also ensures that a file called
21974 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21975 &_maildirfolder_& file cannot be created, delivery is deferred.
21976
21977 These features make it possible to use Exim to create all the necessary files
21978 and directories in a maildir mailbox, including subdirectories for maildir++
21979 folders. Consider this example:
21980 .code
21981 maildir_format = true
21982 directory = /var/mail/$local_part\
21983            ${if eq{$local_part_suffix}{}{}\
21984            {/.${substr_1:$local_part_suffix}}}
21985 maildirfolder_create_regex = /\.[^/]+$
21986 .endd
21987 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21988 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21989 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21990 not match this name, so Exim will not look for or create the file
21991 &_/var/mail/pimbo/maildirfolder_&, though it will create
21992 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21993
21994 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21995 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21996 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21997 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21998 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21999
22000 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22001 not inadvertently match the toplevel maildir directory, because a
22002 &_maildirfolder_& file at top level would completely break quota calculations.
22003
22004 .cindex "quota" "in maildir delivery"
22005 .cindex "maildir++"
22006 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22007 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22008 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22009 Exim assumes the directory is a maildir++ folder directory, which is one level
22010 down from the user's top level mailbox directory. This causes it to start at
22011 the parent directory instead of the current directory when calculating the
22012 amount of space used.
22013
22014 One problem with delivering into a multi-file mailbox is that it is
22015 computationally expensive to compute the size of the mailbox for quota
22016 checking. Various approaches have been taken to reduce the amount of work
22017 needed. The next two sections describe two of them. A third alternative is to
22018 use some external process for maintaining the size data, and use the expansion
22019 of the &%mailbox_size%& option as a way of importing it into Exim.
22020
22021
22022
22023
22024 .section "Using tags to record message sizes" "SECID135"
22025 If &%maildir_tag%& is set, the string is expanded for each delivery.
22026 When the maildir file is renamed into the &_new_& sub-directory, the
22027 tag is added to its name. However, if adding the tag takes the length of the
22028 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22029 the tag is dropped and the maildir file is created with no tag.
22030
22031
22032 .vindex "&$message_size$&"
22033 Tags can be used to encode the size of files in their names; see
22034 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22035 happens after the message has been written. The value of the &$message_size$&
22036 variable is set to the number of bytes actually written. If the expansion is
22037 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22038 be deferred. The expanded tag may contain any printing characters except &"/"&.
22039 Non-printing characters in the string are ignored; if the resulting string is
22040 empty, it is ignored. If it starts with an alphanumeric character, a leading
22041 colon is inserted; this default has not proven to be the path that popular
22042 maildir implementations have chosen (but changing it in Exim would break
22043 backwards compatibility).
22044
22045 For one common implementation, you might set:
22046 .code
22047 maildir_tag = ,S=${message_size}
22048 .endd
22049 but you should check the documentation of the other software to be sure.
22050
22051 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22052 as this allows Exim to extract the size from your tag, instead of having to
22053 &[stat()]& each message file.
22054
22055
22056 .section "Using a maildirsize file" "SECID136"
22057 .cindex "quota" "in maildir delivery"
22058 .cindex "maildir format" "&_maildirsize_& file"
22059 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22060 storing quota and message size information in a file called &_maildirsize_&
22061 within the toplevel maildir directory. If this file does not exist, Exim
22062 creates it, setting the quota from the &%quota%& option of the transport. If
22063 the maildir directory itself does not exist, it is created before any attempt
22064 to write a &_maildirsize_& file.
22065
22066 The &_maildirsize_& file is used to hold information about the sizes of
22067 messages in the maildir, thus speeding up quota calculations. The quota value
22068 in the file is just a cache; if the quota is changed in the transport, the new
22069 value overrides the cached value when the next message is delivered. The cache
22070 is maintained for the benefit of other programs that access the maildir and
22071 need to know the quota.
22072
22073 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22074 file is maintained (with a zero quota setting), but no quota is imposed.
22075
22076 A regular expression is available for controlling which directories in the
22077 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22078 See the description of the &%maildir_quota_directory_regex%& option above for
22079 details.
22080
22081
22082 .section "Mailstore delivery" "SECID137"
22083 .cindex "mailstore format" "description of"
22084 If the &%mailstore_format%& option is true, each message is written as two
22085 files in the given directory. A unique base name is constructed from the
22086 message id and the current delivery process, and the files that are written use
22087 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22088 contains the message's envelope, and the &_.msg_& file contains the message
22089 itself. The base name is placed in the variable &$mailstore_basename$&.
22090
22091 During delivery, the envelope is first written to a file with the suffix
22092 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22093 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22094 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22095 file before accessing either of them. An alternative approach is to wait for
22096 the absence of a &_.tmp_& file.
22097
22098 The envelope file starts with any text defined by the &%mailstore_prefix%&
22099 option, expanded and terminated by a newline if there isn't one. Then follows
22100 the sender address on one line, then all the recipient addresses, one per line.
22101 There can be more than one recipient only if the &%batch_max%& option is set
22102 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22103 appended to the file, followed by a newline if it does not end with one.
22104
22105 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22106 failure, it is ignored. Other expansion errors are treated as serious
22107 configuration errors, and delivery is deferred. The variable
22108 &$mailstore_basename$& is available for use during these expansions.
22109
22110
22111 .section "Non-special new file delivery" "SECID138"
22112 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22113 file is created directly in the named directory. For example, when delivering
22114 messages into files in batched SMTP format for later delivery to some host (see
22115 section &<<SECTbatchSMTP>>&), a setting such as
22116 .code
22117 directory = /var/bsmtp/$host
22118 .endd
22119 might be used. A message is written to a file with a temporary name, which is
22120 then renamed when the delivery is complete. The final name is obtained by
22121 expanding the contents of the &%directory_file%& option.
22122 .ecindex IIDapptra1
22123 .ecindex IIDapptra2
22124
22125
22126
22127
22128
22129
22130 . ////////////////////////////////////////////////////////////////////////////
22131 . ////////////////////////////////////////////////////////////////////////////
22132
22133 .chapter "The autoreply transport" "CHID8"
22134 .scindex IIDauttra1 "transports" "&(autoreply)&"
22135 .scindex IIDauttra2 "&(autoreply)& transport"
22136 The &(autoreply)& transport is not a true transport in that it does not cause
22137 the message to be transmitted. Instead, it generates a new mail message as an
22138 automatic reply to the incoming message. &'References:'& and
22139 &'Auto-Submitted:'& header lines are included. These are constructed according
22140 to the rules in RFCs 2822 and 3834, respectively.
22141
22142 If the router that passes the message to this transport does not have the
22143 &%unseen%& option set, the original message (for the current recipient) is not
22144 delivered anywhere. However, when the &%unseen%& option is set on the router
22145 that passes the message to this transport, routing of the address continues, so
22146 another router can set up a normal message delivery.
22147
22148
22149 The &(autoreply)& transport is usually run as the result of mail filtering, a
22150 &"vacation"& message being the standard example. However, it can also be run
22151 directly from a router like any other transport. To reduce the possibility of
22152 message cascades, messages created by the &(autoreply)& transport always have
22153 empty envelope sender addresses, like bounce messages.
22154
22155 The parameters of the message to be sent can be specified in the configuration
22156 by options described below. However, these are used only when the address
22157 passed to the transport does not contain its own reply information. When the
22158 transport is run as a consequence of a
22159 &%mail%&
22160 or &%vacation%& command in a filter file, the parameters of the message are
22161 supplied by the filter, and passed with the address. The transport's options
22162 that define the message are then ignored (so they are not usually set in this
22163 case). The message is specified entirely by the filter or by the transport; it
22164 is never built from a mixture of options. However, the &%file_optional%&,
22165 &%mode%&, and &%return_message%& options apply in all cases.
22166
22167 &(Autoreply)& is implemented as a local transport. When used as a result of a
22168 command in a user's filter file, &(autoreply)& normally runs under the uid and
22169 gid of the user, and with appropriate current and home directories (see chapter
22170 &<<CHAPenvironment>>&).
22171
22172 There is a subtle difference between routing a message to a &(pipe)& transport
22173 that generates some text to be returned to the sender, and routing it to an
22174 &(autoreply)& transport. This difference is noticeable only if more than one
22175 address from the same message is so handled. In the case of a pipe, the
22176 separate outputs from the different addresses are gathered up and returned to
22177 the sender in a single message, whereas if &(autoreply)& is used, a separate
22178 message is generated for each address that is passed to it.
22179
22180 Non-printing characters are not permitted in the header lines generated for the
22181 message that &(autoreply)& creates, with the exception of newlines that are
22182 immediately followed by white space. If any non-printing characters are found,
22183 the transport defers.
22184 Whether characters with the top bit set count as printing characters or not is
22185 controlled by the &%print_topbitchars%& global option.
22186
22187 If any of the generic options for manipulating headers (for example,
22188 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22189 of the original message that is included in the generated message when
22190 &%return_message%& is set. They do not apply to the generated message itself.
22191
22192 .vindex "&$sender_address$&"
22193 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22194 the message, indicating that there were no recipients, it does not treat this
22195 as an error. This means that autoreplies sent to &$sender_address$& when this
22196 is empty (because the incoming message is a bounce message) do not cause
22197 problems. They are just discarded.
22198
22199
22200
22201 .section "Private options for autoreply" "SECID139"
22202 .cindex "options" "&(autoreply)& transport"
22203
22204 .option bcc autoreply string&!! unset
22205 This specifies the addresses that are to receive &"blind carbon copies"& of the
22206 message when the message is specified by the transport.
22207
22208
22209 .option cc autoreply string&!! unset
22210 This specifies recipients of the message and the contents of the &'Cc:'& header
22211 when the message is specified by the transport.
22212
22213
22214 .option file autoreply string&!! unset
22215 The contents of the file are sent as the body of the message when the message
22216 is specified by the transport. If both &%file%& and &%text%& are set, the text
22217 string comes first.
22218
22219
22220 .option file_expand autoreply boolean false
22221 If this is set, the contents of the file named by the &%file%& option are
22222 subjected to string expansion as they are added to the message.
22223
22224
22225 .option file_optional autoreply boolean false
22226 If this option is true, no error is generated if the file named by the &%file%&
22227 option or passed with the address does not exist or cannot be read.
22228
22229
22230 .option from autoreply string&!! unset
22231 This specifies the contents of the &'From:'& header when the message is
22232 specified by the transport.
22233
22234
22235 .option headers autoreply string&!! unset
22236 This specifies additional RFC 2822 headers that are to be added to the message
22237 when the message is specified by the transport. Several can be given by using
22238 &"\n"& to separate them. There is no check on the format.
22239
22240
22241 .option log autoreply string&!! unset
22242 This option names a file in which a record of every message sent is logged when
22243 the message is specified by the transport.
22244
22245
22246 .option mode autoreply "octal integer" 0600
22247 If either the log file or the &"once"& file has to be created, this mode is
22248 used.
22249
22250
22251 .option never_mail autoreply "address list&!!" unset
22252 If any run of the transport creates a message with a recipient that matches any
22253 item in the list, that recipient is quietly discarded. If all recipients are
22254 discarded, no message is created. This applies both when the recipients are
22255 generated by a filter and when they are specified in the transport.
22256
22257
22258
22259 .option once autoreply string&!! unset
22260 This option names a file or DBM database in which a record of each &'To:'&
22261 recipient is kept when the message is specified by the transport. &*Note*&:
22262 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22263
22264 If &%once%& is unset, or is set to an empty string, the message is always sent.
22265 By default, if &%once%& is set to a non-empty file name, the message
22266 is not sent if a potential recipient is already listed in the database.
22267 However, if the &%once_repeat%& option specifies a time greater than zero, the
22268 message is sent if that much time has elapsed since a message was last sent to
22269 this recipient. A setting of zero time for &%once_repeat%& (the default)
22270 prevents a message from being sent a second time &-- in this case, zero means
22271 infinity.
22272
22273 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22274 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22275 greater than zero, it changes the way Exim implements the &%once%& option.
22276 Instead of using a DBM file to record every recipient it sends to, it uses a
22277 regular file, whose size will never get larger than the given value.
22278
22279 In the file, Exim keeps a linear list of recipient addresses and the times at
22280 which they were sent messages. If the file is full when a new address needs to
22281 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22282 means that a given recipient may receive multiple messages, but at
22283 unpredictable intervals that depend on the rate of turnover of addresses in the
22284 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22285
22286
22287 .option once_file_size autoreply integer 0
22288 See &%once%& above.
22289
22290
22291 .option once_repeat autoreply time&!! 0s
22292 See &%once%& above.
22293 After expansion, the value of this option must be a valid time value.
22294
22295
22296 .option reply_to autoreply string&!! unset
22297 This specifies the contents of the &'Reply-To:'& header when the message is
22298 specified by the transport.
22299
22300
22301 .option return_message autoreply boolean false
22302 If this is set, a copy of the original message is returned with the new
22303 message, subject to the maximum size set in the &%return_size_limit%& global
22304 configuration option.
22305
22306
22307 .option subject autoreply string&!! unset
22308 This specifies the contents of the &'Subject:'& header when the message is
22309 specified by the transport. It is tempting to quote the original subject in
22310 automatic responses. For example:
22311 .code
22312 subject = Re: $h_subject:
22313 .endd
22314 There is a danger in doing this, however. It may allow a third party to
22315 subscribe your users to an opt-in mailing list, provided that the list accepts
22316 bounce messages as subscription confirmations. Well-managed lists require a
22317 non-bounce message to confirm a subscription, so the danger is relatively
22318 small.
22319
22320
22321
22322 .option text autoreply string&!! unset
22323 This specifies a single string to be used as the body of the message when the
22324 message is specified by the transport. If both &%text%& and &%file%& are set,
22325 the text comes first.
22326
22327
22328 .option to autoreply string&!! unset
22329 This specifies recipients of the message and the contents of the &'To:'& header
22330 when the message is specified by the transport.
22331 .ecindex IIDauttra1
22332 .ecindex IIDauttra2
22333
22334
22335
22336
22337 . ////////////////////////////////////////////////////////////////////////////
22338 . ////////////////////////////////////////////////////////////////////////////
22339
22340 .chapter "The lmtp transport" "CHAPLMTP"
22341 .cindex "transports" "&(lmtp)&"
22342 .cindex "&(lmtp)& transport"
22343 .cindex "LMTP" "over a pipe"
22344 .cindex "LMTP" "over a socket"
22345 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22346 specified command
22347 or by interacting with a Unix domain socket.
22348 This transport is something of a cross between the &(pipe)& and &(smtp)&
22349 transports. Exim also has support for using LMTP over TCP/IP; this is
22350 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22351 to be of minority interest, the default build-time configure in &_src/EDITME_&
22352 has it commented out. You need to ensure that
22353 .code
22354 TRANSPORT_LMTP=yes
22355 .endd
22356 .cindex "options" "&(lmtp)& transport"
22357 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22358 included in the Exim binary. The private options of the &(lmtp)& transport are
22359 as follows:
22360
22361 .option batch_id lmtp string&!! unset
22362 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22363
22364
22365 .option batch_max lmtp integer 1
22366 This limits the number of addresses that can be handled in a single delivery.
22367 Most LMTP servers can handle several addresses at once, so it is normally a
22368 good idea to increase this value. See the description of local delivery
22369 batching in chapter &<<CHAPbatching>>&.
22370
22371
22372 .option command lmtp string&!! unset
22373 This option must be set if &%socket%& is not set. The string is a command which
22374 is run in a separate process. It is split up into a command name and list of
22375 arguments, each of which is separately expanded (so expansion cannot change the
22376 number of arguments). The command is run directly, not via a shell. The message
22377 is passed to the new process using the standard input and output to operate the
22378 LMTP protocol.
22379
22380 .option ignore_quota lmtp boolean false
22381 .cindex "LMTP" "ignoring quota errors"
22382 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22383 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22384 in its response to the LHLO command.
22385
22386 .option socket lmtp string&!! unset
22387 This option must be set if &%command%& is not set. The result of expansion must
22388 be the name of a Unix domain socket. The transport connects to the socket and
22389 delivers the message to it using the LMTP protocol.
22390
22391
22392 .option timeout lmtp time 5m
22393 The transport is aborted if the created process or Unix domain socket does not
22394 respond to LMTP commands or message input within this timeout. Delivery
22395 is deferred, and will be tried again later. Here is an example of a typical
22396 LMTP transport:
22397 .code
22398 lmtp:
22399   driver = lmtp
22400   command = /some/local/lmtp/delivery/program
22401   batch_max = 20
22402   user = exim
22403 .endd
22404 This delivers up to 20 addresses at a time, in a mixture of domains if
22405 necessary, running as the user &'exim'&.
22406
22407
22408
22409 . ////////////////////////////////////////////////////////////////////////////
22410 . ////////////////////////////////////////////////////////////////////////////
22411
22412 .chapter "The pipe transport" "CHAPpipetransport"
22413 .scindex IIDpiptra1 "transports" "&(pipe)&"
22414 .scindex IIDpiptra2 "&(pipe)& transport"
22415 The &(pipe)& transport is used to deliver messages via a pipe to a command
22416 running in another process. One example is the use of &(pipe)& as a
22417 pseudo-remote transport for passing messages to some other delivery mechanism
22418 (such as UUCP). Another is the use by individual users to automatically process
22419 their incoming messages. The &(pipe)& transport can be used in one of the
22420 following ways:
22421
22422 .ilist
22423 .vindex "&$local_part$&"
22424 A router routes one address to a transport in the normal way, and the
22425 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22426 contains the local part of the address (as usual), and the command that is run
22427 is specified by the &%command%& option on the transport.
22428 .next
22429 .vindex "&$pipe_addresses$&"
22430 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22431 transport can handle more than one address in a single run. In this case, when
22432 more than one address is routed to the transport, &$local_part$& is not set
22433 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22434 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22435 that are routed to the transport.
22436 .next
22437 .vindex "&$address_pipe$&"
22438 A router redirects an address directly to a pipe command (for example, from an
22439 alias or forward file). In this case, &$address_pipe$& contains the text of the
22440 pipe command, and the &%command%& option on the transport is ignored unless
22441 &%force_command%& is set. If only one address is being transported
22442 (&%batch_max%& is not greater than one, or only one address was redirected to
22443 this pipe command), &$local_part$& contains the local part that was redirected.
22444 .endlist
22445
22446
22447 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22448 deliver messages over pipes using the LMTP interactive protocol. This is
22449 implemented by the &(lmtp)& transport.
22450
22451 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22452 &_.forward_& file, the command runs under the uid and gid of that user. In
22453 other cases, the uid and gid have to be specified explicitly, either on the
22454 transport or on the router that handles the address. Current and &"home"&
22455 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22456 details of the local delivery environment and chapter &<<CHAPbatching>>&
22457 for a discussion of local delivery batching.
22458
22459
22460 .section "Concurrent delivery" "SECID140"
22461 If two messages arrive at almost the same time, and both are routed to a pipe
22462 delivery, the two pipe transports may be run concurrently. You must ensure that
22463 any pipe commands you set up are robust against this happening. If the commands
22464 write to a file, the &%exim_lock%& utility might be of use.
22465 .new
22466 Alternatively the &%max_parallel%& option could be used with a value
22467 of "1" to enforce serialization.
22468 .wen
22469
22470
22471
22472
22473 .section "Returned status and data" "SECID141"
22474 .cindex "&(pipe)& transport" "returned data"
22475 If the command exits with a non-zero return code, the delivery is deemed to
22476 have failed, unless either the &%ignore_status%& option is set (in which case
22477 the return code is treated as zero), or the return code is one of those listed
22478 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22479 later"&. In this case, delivery is deferred. Details of a permanent failure are
22480 logged, but are not included in the bounce message, which merely contains
22481 &"local delivery failed"&.
22482
22483 If the command exits on a signal and the &%freeze_signal%& option is set then
22484 the message will be frozen in the queue. If that option is not set, a bounce
22485 will be sent as normal.
22486
22487 If the return code is greater than 128 and the command being run is a shell
22488 script, it normally means that the script was terminated by a signal whose
22489 value is the return code minus 128. The &%freeze_signal%& option does not
22490 apply in this case.
22491
22492 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22493 return code is set to 127. This is the value that a shell returns if it is
22494 asked to run a non-existent command. The wording for the log line suggests that
22495 a non-existent command may be the problem.
22496
22497 The &%return_output%& option can affect the result of a pipe delivery. If it is
22498 set and the command produces any output on its standard output or standard
22499 error streams, the command is considered to have failed, even if it gave a zero
22500 return code or if &%ignore_status%& is set. The output from the command is
22501 included as part of the bounce message. The &%return_fail_output%& option is
22502 similar, except that output is returned only when the command exits with a
22503 failure return code, that is, a value other than zero or a code that matches
22504 &%temp_errors%&.
22505
22506
22507
22508 .section "How the command is run" "SECThowcommandrun"
22509 .cindex "&(pipe)& transport" "path for command"
22510 The command line is (by default) broken down into a command name and arguments
22511 by the &(pipe)& transport itself. The &%allow_commands%& and
22512 &%restrict_to_path%& options can be used to restrict the commands that may be
22513 run.
22514
22515 .cindex "quoting" "in pipe command"
22516 Unquoted arguments are delimited by white space. If an argument appears in
22517 double quotes, backslash is interpreted as an escape character in the usual
22518 way. If an argument appears in single quotes, no escaping is done.
22519
22520 String expansion is applied to the command line except when it comes from a
22521 traditional &_.forward_& file (commands from a filter file are expanded). The
22522 expansion is applied to each argument in turn rather than to the whole line.
22523 For this reason, any string expansion item that contains white space must be
22524 quoted so as to be contained within a single argument. A setting such as
22525 .code
22526 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22527 .endd
22528 will not work, because the expansion item gets split between several
22529 arguments. You have to write
22530 .code
22531 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22532 .endd
22533 to ensure that it is all in one argument. The expansion is done in this way,
22534 argument by argument, so that the number of arguments cannot be changed as a
22535 result of expansion, and quotes or backslashes in inserted variables do not
22536 interact with external quoting. However, this leads to problems if you want to
22537 generate multiple arguments (or the command name plus arguments) from a single
22538 expansion. In this situation, the simplest solution is to use a shell. For
22539 example:
22540 .code
22541 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22542 .endd
22543
22544 .cindex "transport" "filter"
22545 .cindex "filter" "transport filter"
22546 .vindex "&$pipe_addresses$&"
22547 Special handling takes place when an argument consists of precisely the text
22548 &`$pipe_addresses`&. This is not a general expansion variable; the only
22549 place this string is recognized is when it appears as an argument for a pipe or
22550 transport filter command. It causes each address that is being handled to be
22551 inserted in the argument list at that point &'as a separate argument'&. This
22552 avoids any problems with spaces or shell metacharacters, and is of use when a
22553 &(pipe)& transport is handling groups of addresses in a batch.
22554
22555 If &%force_command%& is enabled on the transport, Special handling takes place
22556 for an argument that consists of precisely the text &`$address_pipe`&.  It
22557 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22558 argument is inserted in the argument list at that point
22559 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22560 the only item in the argument; in fact, if it were then &%force_command%&
22561 should behave as a no-op.  Rather, it should be used to adjust the command
22562 run while preserving the argument vector separation.
22563
22564 After splitting up into arguments and expansion, the resulting command is run
22565 in a subprocess directly from the transport, &'not'& under a shell. The
22566 message that is being delivered is supplied on the standard input, and the
22567 standard output and standard error are both connected to a single pipe that is
22568 read by Exim. The &%max_output%& option controls how much output the command
22569 may produce, and the &%return_output%& and &%return_fail_output%& options
22570 control what is done with it.
22571
22572 Not running the command under a shell (by default) lessens the security risks
22573 in cases when a command from a user's filter file is built out of data that was
22574 taken from an incoming message. If a shell is required, it can of course be
22575 explicitly specified as the command to be run. However, there are circumstances
22576 where existing commands (for example, in &_.forward_& files) expect to be run
22577 under a shell and cannot easily be modified. To allow for these cases, there is
22578 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22579 works. Instead of breaking up the command line as just described, it expands it
22580 as a single string and passes the result to &_/bin/sh_&. The
22581 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22582 with &%use_shell%&, and the whole mechanism is inherently less secure.
22583
22584
22585
22586 .section "Environment variables" "SECTpipeenv"
22587 .cindex "&(pipe)& transport" "environment for command"
22588 .cindex "environment for pipe transport"
22589 The environment variables listed below are set up when the command is invoked.
22590 This list is a compromise for maximum compatibility with other MTAs. Note that
22591 the &%environment%& option can be used to add additional variables to this
22592 environment.
22593 .display
22594 &`DOMAIN            `&   the domain of the address
22595 &`HOME              `&   the home directory, if set
22596 &`HOST              `&   the host name when called from a router (see below)
22597 &`LOCAL_PART        `&   see below
22598 &`LOCAL_PART_PREFIX `&   see below
22599 &`LOCAL_PART_SUFFIX `&   see below
22600 &`LOGNAME           `&   see below
22601 &`MESSAGE_ID        `&   Exim's local ID for the message
22602 &`PATH              `&   as specified by the &%path%& option below
22603 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22604 &`RECIPIENT         `&   the complete recipient address
22605 &`SENDER            `&   the sender of the message (empty if a bounce)
22606 &`SHELL             `&   &`/bin/sh`&
22607 &`TZ                `&   the value of the &%timezone%& option, if set
22608 &`USER              `&   see below
22609 .endd
22610 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22611 router, LOCAL_PART is set to the local part of the address. When it is
22612 called as a result of a forward or alias expansion, LOCAL_PART is set to
22613 the local part of the address that was expanded. In both cases, any affixes are
22614 removed from the local part, and made available in LOCAL_PART_PREFIX and
22615 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22616 same value as LOCAL_PART for compatibility with other MTAs.
22617
22618 .cindex "HOST"
22619 HOST is set only when a &(pipe)& transport is called from a router that
22620 associates hosts with an address, typically when using &(pipe)& as a
22621 pseudo-remote transport. HOST is set to the first host name specified by
22622 the router.
22623
22624 .cindex "HOME"
22625 If the transport's generic &%home_directory%& option is set, its value is used
22626 for the HOME environment variable. Otherwise, a home directory may be set
22627 by the router's &%transport_home_directory%& option, which defaults to the
22628 user's home directory if &%check_local_user%& is set.
22629
22630
22631 .section "Private options for pipe" "SECID142"
22632 .cindex "options" "&(pipe)& transport"
22633
22634
22635
22636 .option allow_commands pipe "string list&!!" unset
22637 .cindex "&(pipe)& transport" "permitted commands"
22638 The string is expanded, and is then interpreted as a colon-separated list of
22639 permitted commands. If &%restrict_to_path%& is not set, the only commands
22640 permitted are those in the &%allow_commands%& list. They need not be absolute
22641 paths; the &%path%& option is still used for relative paths. If
22642 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22643 in the &%allow_commands%& list, or a name without any slashes that is found on
22644 the path. In other words, if neither &%allow_commands%& nor
22645 &%restrict_to_path%& is set, there is no restriction on the command, but
22646 otherwise only commands that are permitted by one or the other are allowed. For
22647 example, if
22648 .code
22649 allow_commands = /usr/bin/vacation
22650 .endd
22651 and &%restrict_to_path%& is not set, the only permitted command is
22652 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22653 &%use_shell%& is set.
22654
22655
22656 .option batch_id pipe string&!! unset
22657 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22658
22659
22660 .option batch_max pipe integer 1
22661 This limits the number of addresses that can be handled in a single delivery.
22662 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22663
22664
22665 .option check_string pipe string unset
22666 As &(pipe)& writes the message, the start of each line is tested for matching
22667 &%check_string%&, and if it does, the initial matching characters are replaced
22668 by the contents of &%escape_string%&, provided both are set. The value of
22669 &%check_string%& is a literal string, not a regular expression, and the case of
22670 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22671 of &%check_string%& and &%escape_string%& are forced to values that implement
22672 the SMTP escaping protocol. Any settings made in the configuration file are
22673 ignored.
22674
22675
22676 .option command pipe string&!! unset
22677 This option need not be set when &(pipe)& is being used to deliver to pipes
22678 obtained directly from address redirections. In other cases, the option must be
22679 set, to provide a command to be run. It need not yield an absolute path (see
22680 the &%path%& option below). The command is split up into separate arguments by
22681 Exim, and each argument is separately expanded, as described in section
22682 &<<SECThowcommandrun>>& above.
22683
22684
22685 .option environment pipe string&!! unset
22686 .cindex "&(pipe)& transport" "environment for command"
22687 .cindex "environment for &(pipe)& transport"
22688 This option is used to add additional variables to the environment in which the
22689 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22690 a string which is expanded, and then interpreted as a colon-separated list of
22691 environment settings of the form <&'name'&>=<&'value'&>.
22692
22693
22694 .option escape_string pipe string unset
22695 See &%check_string%& above.
22696
22697
22698 .option freeze_exec_fail pipe boolean false
22699 .cindex "exec failure"
22700 .cindex "failure of exec"
22701 .cindex "&(pipe)& transport" "failure of exec"
22702 Failure to exec the command in a pipe transport is by default treated like
22703 any other failure while running the command. However, if &%freeze_exec_fail%&
22704 is set, failure to exec is treated specially, and causes the message to be
22705 frozen, whatever the setting of &%ignore_status%&.
22706
22707
22708 .option freeze_signal pipe boolean false
22709 .cindex "signal exit"
22710 .cindex "&(pipe)& transport", "signal exit"
22711 Normally if the process run by a command in a pipe transport exits on a signal,
22712 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22713 frozen in Exim's queue instead.
22714
22715
22716 .option force_command pipe boolean false
22717 .cindex "force command"
22718 .cindex "&(pipe)& transport", "force command"
22719 Normally when a router redirects an address directly to a pipe command
22720 the &%command%& option on the transport is ignored.  If &%force_command%&
22721 is set, the &%command%& option will used. This is especially
22722 useful for forcing a wrapper or additional argument to be added to the
22723 command. For example:
22724 .code
22725 command = /usr/bin/remote_exec myhost -- $address_pipe
22726 force_command
22727 .endd
22728
22729 Note that &$address_pipe$& is handled specially in &%command%& when
22730 &%force_command%& is set, expanding out to the original argument vector as
22731 separate items, similarly to a Unix shell &`"$@"`& construct.
22732
22733
22734 .option ignore_status pipe boolean false
22735 If this option is true, the status returned by the subprocess that is set up to
22736 run the command is ignored, and Exim behaves as if zero had been returned.
22737 Otherwise, a non-zero status or termination by signal causes an error return
22738 from the transport unless the status value is one of those listed in
22739 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22740
22741 &*Note*&: This option does not apply to timeouts, which do not return a status.
22742 See the &%timeout_defer%& option for how timeouts are handled.
22743
22744
22745 .option log_defer_output pipe boolean false
22746 .cindex "&(pipe)& transport" "logging output"
22747 If this option is set, and the status returned by the command is
22748 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22749 and any output was produced on stdout or stderr, the first line of it is
22750 written to the main log.
22751
22752
22753 .option log_fail_output pipe boolean false
22754 If this option is set, and the command returns any output on stdout or
22755 stderr, and also ends with a return code that is neither zero nor one of
22756 the return codes listed in &%temp_errors%& (that is, the delivery
22757 failed), the first line of output is written to the main log. This
22758 option and &%log_output%& are mutually exclusive.  Only one of them may
22759 be set.
22760
22761
22762 .option log_output pipe boolean false
22763 If this option is set and the command returns any output on stdout or
22764 stderr, the first line of output is written to the main log, whatever
22765 the return code. This option and &%log_fail_output%& are mutually
22766 exclusive. Only one of them may be set.
22767
22768
22769 .option max_output pipe integer 20K
22770 This specifies the maximum amount of output that the command may produce on its
22771 standard output and standard error file combined. If the limit is exceeded, the
22772 process running the command is killed. This is intended as a safety measure to
22773 catch runaway processes. The limit is applied independently of the settings of
22774 the options that control what is done with such output (for example,
22775 &%return_output%&). Because of buffering effects, the amount of output may
22776 exceed the limit by a small amount before Exim notices.
22777
22778
22779 .option message_prefix pipe string&!! "see below"
22780 The string specified here is expanded and output at the start of every message.
22781 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22782 .code
22783 message_prefix = \
22784   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22785   ${tod_bsdinbox}\n
22786 .endd
22787 .cindex "Cyrus"
22788 .cindex "&%tmail%&"
22789 .cindex "&""From""& line"
22790 This is required by the commonly used &_/usr/bin/vacation_& program.
22791 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22792 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22793 setting
22794 .code
22795 message_prefix =
22796 .endd
22797 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22798 &`\n`& to &`\r\n`& in &%message_prefix%&.
22799
22800
22801 .option message_suffix pipe string&!! "see below"
22802 The string specified here is expanded and output at the end of every message.
22803 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22804 The suffix can be suppressed by setting
22805 .code
22806 message_suffix =
22807 .endd
22808 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22809 &`\n`& to &`\r\n`& in &%message_suffix%&.
22810
22811
22812 .option path pipe string "see below"
22813 This option specifies the string that is set up in the PATH environment
22814 variable of the subprocess. The default is:
22815 .code
22816 /bin:/usr/bin
22817 .endd
22818 If the &%command%& option does not yield an absolute path name, the command is
22819 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22820 apply to a command specified as a transport filter.
22821
22822
22823 .option permit_coredump pipe boolean false
22824 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22825 a core-dump of a pipe command, enable this command.  This enables core-dumps
22826 during delivery and affects both the Exim binary and the pipe command run.
22827 It is recommended that this option remain off unless and until you have a need
22828 for it and that this only be enabled when needed, as the risk of excessive
22829 resource consumption can be quite high.  Note also that Exim is typically
22830 installed as a setuid binary and most operating systems will inhibit coredumps
22831 of these by default, so further OS-specific action may be required.
22832
22833
22834 .option pipe_as_creator pipe boolean false
22835 .cindex "uid (user id)" "local delivery"
22836 If the generic &%user%& option is not set and this option is true, the delivery
22837 process is run under the uid that was in force when Exim was originally called
22838 to accept the message. If the group id is not otherwise set (via the generic
22839 &%group%& option), the gid that was in force when Exim was originally called to
22840 accept the message is used.
22841
22842
22843 .option restrict_to_path pipe boolean false
22844 When this option is set, any command name not listed in &%allow_commands%& must
22845 contain no slashes. The command is searched for only in the directories listed
22846 in the &%path%& option. This option is intended for use in the case when a pipe
22847 command has been generated from a user's &_.forward_& file. This is usually
22848 handled by a &(pipe)& transport called &%address_pipe%&.
22849
22850
22851 .option return_fail_output pipe boolean false
22852 If this option is true, and the command produced any output and ended with a
22853 return code other than zero or one of the codes listed in &%temp_errors%& (that
22854 is, the delivery failed), the output is returned in the bounce message.
22855 However, if the message has a null sender (that is, it is itself a bounce
22856 message), output from the command is discarded. This option and
22857 &%return_output%& are mutually exclusive. Only one of them may be set.
22858
22859
22860
22861 .option return_output pipe boolean false
22862 If this option is true, and the command produced any output, the delivery is
22863 deemed to have failed whatever the return code from the command, and the output
22864 is returned in the bounce message. Otherwise, the output is just discarded.
22865 However, if the message has a null sender (that is, it is a bounce message),
22866 output from the command is always discarded, whatever the setting of this
22867 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22868 of them may be set.
22869
22870
22871
22872 .option temp_errors pipe "string list" "see below"
22873 .cindex "&(pipe)& transport" "temporary failure"
22874 This option contains either a colon-separated list of numbers, or a single
22875 asterisk. If &%ignore_status%& is false
22876 and &%return_output%& is not set,
22877 and the command exits with a non-zero return code, the failure is treated as
22878 temporary and the delivery is deferred if the return code matches one of the
22879 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22880 codes are treated as permanent errors. The default setting contains the codes
22881 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22882 compiled on a system that does not define these macros, it assumes values of 75
22883 and 73, respectively.
22884
22885
22886 .option timeout pipe time 1h
22887 If the command fails to complete within this time, it is killed. This normally
22888 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22889 specifies no timeout. In order to ensure that any subprocesses created by the
22890 command are also killed, Exim makes the initial process a process group leader,
22891 and kills the whole process group on a timeout. However, this can be defeated
22892 if one of the processes starts a new process group.
22893
22894 .option timeout_defer pipe boolean false
22895 A timeout in a &(pipe)& transport, either in the command that the transport
22896 runs, or in a transport filter that is associated with it, is by default
22897 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22898 is set true, both kinds of timeout become temporary errors, causing the
22899 delivery to be deferred.
22900
22901 .option umask pipe "octal integer" 022
22902 This specifies the umask setting for the subprocess that runs the command.
22903
22904
22905 .option use_bsmtp pipe boolean false
22906 .cindex "envelope sender"
22907 If this option is set true, the &(pipe)& transport writes messages in &"batch
22908 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22909 commands. If you want to include a leading HELO command with such messages,
22910 you can do so by setting the &%message_prefix%& option. See section
22911 &<<SECTbatchSMTP>>& for details of batch SMTP.
22912
22913 .option use_classresources pipe boolean false
22914 .cindex "class resources (BSD)"
22915 This option is available only when Exim is running on FreeBSD, NetBSD, or
22916 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22917 resource limits when a &(pipe)& transport is run to perform a delivery. The
22918 limits for the uid under which the pipe is to run are obtained from the login
22919 class database.
22920
22921
22922 .option use_crlf pipe boolean false
22923 .cindex "carriage return"
22924 .cindex "linefeed"
22925 This option causes lines to be terminated with the two-character CRLF sequence
22926 (carriage return, linefeed) instead of just a linefeed character. In the case
22927 of batched SMTP, the byte sequence written to the pipe is then an exact image
22928 of what would be sent down a real SMTP connection.
22929
22930 The contents of the &%message_prefix%& and &%message_suffix%& options are
22931 written verbatim, so must contain their own carriage return characters if these
22932 are needed. When &%use_bsmtp%& is not set, the default values for both
22933 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22934 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22935
22936
22937 .option use_shell pipe boolean false
22938 .vindex "&$pipe_addresses$&"
22939 If this option is set, it causes the command to be passed to &_/bin/sh_&
22940 instead of being run directly from the transport, as described in section
22941 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22942 where the command is expected to be run under a shell and cannot easily be
22943 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22944 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22945 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22946 its &%-c%& option.
22947
22948
22949
22950 .section "Using an external local delivery agent" "SECID143"
22951 .cindex "local delivery" "using an external agent"
22952 .cindex "&'procmail'&"
22953 .cindex "external local delivery"
22954 .cindex "delivery" "&'procmail'&"
22955 .cindex "delivery" "by external agent"
22956 The &(pipe)& transport can be used to pass all messages that require local
22957 delivery to a separate local delivery agent such as &%procmail%&. When doing
22958 this, care must be taken to ensure that the pipe is run under an appropriate
22959 uid and gid. In some configurations one wants this to be a uid that is trusted
22960 by the delivery agent to supply the correct sender of the message. It may be
22961 necessary to recompile or reconfigure the delivery agent so that it trusts an
22962 appropriate user. The following is an example transport and router
22963 configuration for &%procmail%&:
22964 .code
22965 # transport
22966 procmail_pipe:
22967   driver = pipe
22968   command = /usr/local/bin/procmail -d $local_part
22969   return_path_add
22970   delivery_date_add
22971   envelope_to_add
22972   check_string = "From "
22973   escape_string = ">From "
22974   umask = 077
22975   user = $local_part
22976   group = mail
22977
22978 # router
22979 procmail:
22980   driver = accept
22981   check_local_user
22982   transport = procmail_pipe
22983 .endd
22984 In this example, the pipe is run as the local user, but with the group set to
22985 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22986 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22987 user to supply a correct sender address. If you do not specify either a
22988 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22989 home directory is the user's home directory by default.
22990
22991 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22992 .code
22993 IFS=" "
22994 .endd
22995 as shown in some &%procmail%& documentation, because Exim does not by default
22996 use a shell to run pipe commands.
22997
22998 .cindex "Cyrus"
22999 The next example shows a transport and a router for a system where local
23000 deliveries are handled by the Cyrus IMAP server.
23001 .code
23002 # transport
23003 local_delivery_cyrus:
23004   driver = pipe
23005   command = /usr/cyrus/bin/deliver \
23006             -m ${substr_1:$local_part_suffix} -- $local_part
23007   user = cyrus
23008   group = mail
23009   return_output
23010   log_output
23011   message_prefix =
23012   message_suffix =
23013
23014 # router
23015 local_user_cyrus:
23016   driver = accept
23017   check_local_user
23018   local_part_suffix = .*
23019   transport = local_delivery_cyrus
23020 .endd
23021 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23022 &%return_output%& to cause any text written by Cyrus to be returned to the
23023 sender.
23024 .ecindex IIDpiptra1
23025 .ecindex IIDpiptra2
23026
23027
23028 . ////////////////////////////////////////////////////////////////////////////
23029 . ////////////////////////////////////////////////////////////////////////////
23030
23031 .chapter "The smtp transport" "CHAPsmtptrans"
23032 .scindex IIDsmttra1 "transports" "&(smtp)&"
23033 .scindex IIDsmttra2 "&(smtp)& transport"
23034 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23035 or LMTP protocol. The list of hosts to try can either be taken from the address
23036 that is being processed (having been set up by the router), or specified
23037 explicitly for the transport. Timeout and retry processing (see chapter
23038 &<<CHAPretry>>&) is applied to each IP address independently.
23039
23040
23041 .section "Multiple messages on a single connection" "SECID144"
23042 The sending of multiple messages over a single TCP/IP connection can arise in
23043 two ways:
23044
23045 .ilist
23046 If a message contains more than &%max_rcpt%& (see below) addresses that are
23047 routed to the same host, more than one copy of the message has to be sent to
23048 that host. In this situation, multiple copies may be sent in a single run of
23049 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23050 does when it has too many addresses to send in one message also depends on the
23051 value of the global &%remote_max_parallel%& option. Details are given in
23052 section &<<SECToutSMTPTCP>>&.)
23053 .next
23054 .cindex "hints database" "remembering routing"
23055 When a message has been successfully delivered over a TCP/IP connection, Exim
23056 looks in its hints database to see if there are any other messages awaiting a
23057 connection to the same host. If there are, a new delivery process is started
23058 for one of them, and the current TCP/IP connection is passed on to it. The new
23059 process may in turn send multiple copies and possibly create yet another
23060 process.
23061 .endlist
23062
23063
23064 For each copy sent over the same TCP/IP connection, a sequence counter is
23065 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23066 no further messages are sent over that connection.
23067
23068
23069
23070 .section "Use of the $host and $host_address variables" "SECID145"
23071 .vindex "&$host$&"
23072 .vindex "&$host_address$&"
23073 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23074 &$host_address$& are the name and IP address of the first host on the host list
23075 passed by the router. However, when the transport is about to connect to a
23076 specific host, and while it is connected to that host, &$host$& and
23077 &$host_address$& are set to the values for that host. These are the values
23078 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23079 &%serialize_hosts%&, and the various TLS options are expanded.
23080
23081
23082 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23083 .vindex &$tls_bits$&
23084 .vindex &$tls_cipher$&
23085 .vindex &$tls_peerdn$&
23086 .vindex &$tls_sni$&
23087 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23088 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23089 are the values that were set when the message was received.
23090 These are the values that are used for options that are expanded before any
23091 SMTP connections are made. Just before each connection is made, these four
23092 variables are emptied. If TLS is subsequently started, they are set to the
23093 appropriate values for the outgoing connection, and these are the values that
23094 are in force when any authenticators are run and when the
23095 &%authenticated_sender%& option is expanded.
23096
23097 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23098 and will be removed in a future release.
23099
23100
23101 .section "Private options for smtp" "SECID146"
23102 .cindex "options" "&(smtp)& transport"
23103 The private options of the &(smtp)& transport are as follows:
23104
23105
23106 .option address_retry_include_sender smtp boolean true
23107 .cindex "4&'xx'& responses" "retrying after"
23108 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23109 is the combination of sender and recipient that is delayed in subsequent queue
23110 runs until the retry time is reached. You can delay the recipient without
23111 reference to the sender (which is what earlier versions of Exim did), by
23112 setting &%address_retry_include_sender%& false. However, this can lead to
23113 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23114
23115 .option allow_localhost smtp boolean false
23116 .cindex "local host" "sending to"
23117 .cindex "fallback" "hosts specified on transport"
23118 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23119 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23120 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23121 the delivery anyway. This should be used only in special cases when the
23122 configuration ensures that no looping will result (for example, a differently
23123 configured Exim is listening on the port to which the message is sent).
23124
23125
23126 .option authenticated_sender smtp string&!! unset
23127 .cindex "Cyrus"
23128 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23129 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23130 overriding any existing authenticated sender value. If the string expansion is
23131 forced to fail, the option is ignored. Other expansion failures cause delivery
23132 to be deferred. If the result of expansion is an empty string, that is also
23133 ignored.
23134
23135 The expansion happens after the outgoing connection has been made and TLS
23136 started, if required. This means that the &$host$&, &$host_address$&,
23137 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23138 particular connection.
23139
23140 If the SMTP session is not authenticated, the expansion of
23141 &%authenticated_sender%& still happens (and can cause the delivery to be
23142 deferred if it fails), but no AUTH= item is added to MAIL commands
23143 unless &%authenticated_sender_force%& is true.
23144
23145 This option allows you to use the &(smtp)& transport in LMTP mode to
23146 deliver mail to Cyrus IMAP and provide the proper local part as the
23147 &"authenticated sender"&, via a setting such as:
23148 .code
23149 authenticated_sender = $local_part
23150 .endd
23151 This removes the need for IMAP subfolders to be assigned special ACLs to
23152 allow direct delivery to those subfolders.
23153
23154 Because of expected uses such as that just described for Cyrus (when no
23155 domain is involved), there is no checking on the syntax of the provided
23156 value.
23157
23158
23159 .option authenticated_sender_force smtp boolean false
23160 If this option is set true, the &%authenticated_sender%& option's value
23161 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23162 authenticated as a client.
23163
23164
23165 .option command_timeout smtp time 5m
23166 This sets a timeout for receiving a response to an SMTP command that has been
23167 sent out. It is also used when waiting for the initial banner line from the
23168 remote host. Its value must not be zero.
23169
23170
23171 .option connect_timeout smtp time 5m
23172 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23173 to a remote host. A setting of zero allows the system timeout (typically
23174 several minutes) to act. To have any effect, the value of this option must be
23175 less than the system timeout. However, it has been observed that on some
23176 systems there is no system timeout, which is why the default value for this
23177 option is 5 minutes, a value recommended by RFC 1123.
23178
23179
23180 .option connection_max_messages smtp integer 500
23181 .cindex "SMTP" "passed connection"
23182 .cindex "SMTP" "multiple deliveries"
23183 .cindex "multiple SMTP deliveries"
23184 This controls the maximum number of separate message deliveries that are sent
23185 over a single TCP/IP connection. If the value is zero, there is no limit.
23186 For testing purposes, this value can be overridden by the &%-oB%& command line
23187 option.
23188
23189
23190 .option data_timeout smtp time 5m
23191 This sets a timeout for the transmission of each block in the data portion of
23192 the message. As a result, the overall timeout for a message depends on the size
23193 of the message. Its value must not be zero. See also &%final_timeout%&.
23194
23195
23196 .option delay_after_cutoff smtp boolean true
23197 This option controls what happens when all remote IP addresses for a given
23198 domain have been inaccessible for so long that they have passed their retry
23199 cutoff times.
23200
23201 In the default state, if the next retry time has not been reached for any of
23202 them, the address is bounced without trying any deliveries. In other words,
23203 Exim delays retrying an IP address after the final cutoff time until a new
23204 retry time is reached, and can therefore bounce an address without ever trying
23205 a delivery, when machines have been down for a long time. Some people are
23206 unhappy at this prospect, so...
23207
23208 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23209 addresses are past their final cutoff time, Exim tries to deliver to those
23210 IP addresses that have not been tried since the message arrived. If there are
23211 none, of if they all fail, the address is bounced. In other words, it does not
23212 delay when a new message arrives, but immediately tries those expired IP
23213 addresses that haven't been tried since the message arrived. If there is a
23214 continuous stream of messages for the dead hosts, unsetting
23215 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23216 to them.
23217
23218
23219 .option dns_qualify_single smtp boolean true
23220 If the &%hosts%& or &%fallback_hosts%& option is being used,
23221 and the &%gethostbyname%& option is false,
23222 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23223 in chapter &<<CHAPdnslookup>>& for more details.
23224
23225
23226 .option dns_search_parents smtp boolean false
23227 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23228 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23229 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23230 details.
23231
23232
23233 .option dnssec_request_domains smtp "domain list&!!" unset
23234 .cindex "MX record" "security"
23235 .cindex "DNSSEC" "MX lookup"
23236 .cindex "security" "MX lookup"
23237 .cindex "DNS" "DNSSEC"
23238 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23239 the dnssec request bit set.
23240 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23241
23242
23243
23244 .option dnssec_require_domains smtp "domain list&!!" unset
23245 .cindex "MX record" "security"
23246 .cindex "DNSSEC" "MX lookup"
23247 .cindex "security" "MX lookup"
23248 .cindex "DNS" "DNSSEC"
23249 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23250 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23251 (AD bit) set will be ignored and logged as a host-lookup failure.
23252 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23253
23254
23255
23256 .option dscp smtp string&!! unset
23257 .cindex "DCSP" "outbound"
23258 This option causes the DSCP value associated with a socket to be set to one
23259 of a number of fixed strings or to numeric value.
23260 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23261 Common values include &`throughput`&, &`mincost`&, and on newer systems
23262 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23263
23264 The outbound packets from Exim will be marked with this value in the header
23265 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23266 that these values will have any effect, not be stripped by networking
23267 equipment, or do much of anything without cooperation with your Network
23268 Engineer and those of all network operators between the source and destination.
23269
23270
23271 .option fallback_hosts smtp "string list" unset
23272 .cindex "fallback" "hosts specified on transport"
23273 String expansion is not applied to this option. The argument must be a
23274 colon-separated list of host names or IP addresses, optionally also including
23275 port numbers, though the separator can be changed, as described in section
23276 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23277 item in a &%route_list%& setting for the &(manualroute)& router, as described
23278 in section &<<SECTformatonehostitem>>&.
23279
23280 Fallback hosts can also be specified on routers, which associate them with the
23281 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23282 &%fallback_hosts%& specified on the transport is used only if the address does
23283 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23284 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23285 However, &%hosts_randomize%& does apply to fallback host lists.
23286
23287 If Exim is unable to deliver to any of the hosts for a particular address, and
23288 the errors are not permanent rejections, the address is put on a separate
23289 transport queue with its host list replaced by the fallback hosts, unless the
23290 address was routed via MX records and the current host was in the original MX
23291 list. In that situation, the fallback host list is not used.
23292
23293 Once normal deliveries are complete, the fallback queue is delivered by
23294 re-running the same transports with the new host lists. If several failing
23295 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23296 copy of the message is sent.
23297
23298 The resolution of the host names on the fallback list is controlled by the
23299 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23300 both to cases when the host list comes with the address and when it is taken
23301 from &%hosts%&. This option provides a &"use a smart host only if delivery
23302 fails"& facility.
23303
23304
23305 .option final_timeout smtp time 10m
23306 This is the timeout that applies while waiting for the response to the final
23307 line containing just &"."& that terminates a message. Its value must not be
23308 zero.
23309
23310 .option gethostbyname smtp boolean false
23311 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23312 being used, names are looked up using &[gethostbyname()]&
23313 (or &[getipnodebyname()]& when available)
23314 instead of using the DNS. Of course, that function may in fact use the DNS, but
23315 it may also consult other sources of information such as &_/etc/hosts_&.
23316
23317 .option gnutls_compat_mode smtp boolean unset
23318 This option controls whether GnuTLS is used in compatibility mode in an Exim
23319 server. This reduces security slightly, but improves interworking with older
23320 implementations of TLS.
23321
23322 .option helo_data smtp string&!! "see below"
23323 .cindex "HELO" "argument, setting"
23324 .cindex "EHLO" "argument, setting"
23325 .cindex "LHLO argument setting"
23326 The value of this option is expanded after a connection to a another host has
23327 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23328 command that starts the outgoing SMTP or LMTP session. The default value of the
23329 option is:
23330 .code
23331 $primary_hostname
23332 .endd
23333 During the expansion, the variables &$host$& and &$host_address$& are set to
23334 the identity of the remote host, and the variables &$sending_ip_address$& and
23335 &$sending_port$& are set to the local IP address and port number that are being
23336 used. These variables can be used to generate different values for different
23337 servers or different local IP addresses. For example, if you want the string
23338 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23339 interface address, you could use this:
23340 .code
23341 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23342   {$primary_hostname}}
23343 .endd
23344 The use of &%helo_data%& applies both to sending messages and when doing
23345 callouts.
23346
23347 .option hosts smtp "string list&!!" unset
23348 Hosts are associated with an address by a router such as &(dnslookup)&, which
23349 finds the hosts by looking up the address domain in the DNS, or by
23350 &(manualroute)&, which has lists of hosts in its configuration. However,
23351 email addresses can be passed to the &(smtp)& transport by any router, and not
23352 all of them can provide an associated list of hosts.
23353
23354 The &%hosts%& option specifies a list of hosts to be used if the address being
23355 processed does not have any hosts associated with it. The hosts specified by
23356 &%hosts%& are also used, whether or not the address has its own hosts, if
23357 &%hosts_override%& is set.
23358
23359 The string is first expanded, before being interpreted as a colon-separated
23360 list of host names or IP addresses, possibly including port numbers. The
23361 separator may be changed to something other than colon, as described in section
23362 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23363 item in a &%route_list%& setting for the &(manualroute)& router, as described
23364 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23365 of the &(manualroute)& router is not available here.
23366
23367 If the expansion fails, delivery is deferred. Unless the failure was caused by
23368 the inability to complete a lookup, the error is logged to the panic log as
23369 well as the main log. Host names are looked up either by searching directly for
23370 address records in the DNS or by calling &[gethostbyname()]& (or
23371 &[getipnodebyname()]& when available), depending on the setting of the
23372 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23373 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23374 address are used.
23375
23376 During delivery, the hosts are tried in order, subject to their retry status,
23377 unless &%hosts_randomize%& is set.
23378
23379
23380 .option hosts_avoid_esmtp smtp "host list&!!" unset
23381 .cindex "ESMTP, avoiding use of"
23382 .cindex "HELO" "forcing use of"
23383 .cindex "EHLO" "avoiding use of"
23384 .cindex "PIPELINING" "avoiding the use of"
23385 This option is for use with broken hosts that announce ESMTP facilities (for
23386 example, PIPELINING) and then fail to implement them properly. When a host
23387 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23388 start of the SMTP session. This means that it cannot use any of the ESMTP
23389 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23390
23391
23392 .option hosts_avoid_pipelining smtp "host list&!!" unset
23393 .cindex "PIPELINING" "avoiding the use of"
23394 Exim will not use the SMTP PIPELINING extension when delivering to any host
23395 that matches this list, even if the server host advertises PIPELINING support.
23396
23397
23398 .option hosts_avoid_tls smtp "host list&!!" unset
23399 .cindex "TLS" "avoiding for certain hosts"
23400 Exim will not try to start a TLS session when delivering to any host that
23401 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23402
23403 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23404 .cindex "TLS" "avoiding for certain hosts"
23405 Exim will not try to start a TLS session for a verify callout,
23406 or when delivering in cutthrough mode,
23407 to any host that matches this list.
23408
23409
23410 .option hosts_max_try smtp integer 5
23411 .cindex "host" "maximum number to try"
23412 .cindex "limit" "number of hosts tried"
23413 .cindex "limit" "number of MX tried"
23414 .cindex "MX record" "maximum tried"
23415 This option limits the number of IP addresses that are tried for any one
23416 delivery in cases where there are temporary delivery errors. Section
23417 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23418
23419
23420 .option hosts_max_try_hardlimit smtp integer 50
23421 This is an additional check on the maximum number of IP addresses that Exim
23422 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23423 why it exists.
23424
23425
23426
23427 .option hosts_nopass_tls smtp "host list&!!" unset
23428 .cindex "TLS" "passing connection"
23429 .cindex "multiple SMTP deliveries"
23430 .cindex "TLS" "multiple message deliveries"
23431 For any host that matches this list, a connection on which a TLS session has
23432 been started will not be passed to a new delivery process for sending another
23433 message on the same connection. See section &<<SECTmulmessam>>& for an
23434 explanation of when this might be needed.
23435
23436
23437 .option hosts_override smtp boolean false
23438 If this option is set and the &%hosts%& option is also set, any hosts that are
23439 attached to the address are ignored, and instead the hosts specified by the
23440 &%hosts%& option are always used. This option does not apply to
23441 &%fallback_hosts%&.
23442
23443
23444 .option hosts_randomize smtp boolean false
23445 .cindex "randomized host list"
23446 .cindex "host" "list of; randomized"
23447 .cindex "fallback" "randomized hosts"
23448 If this option is set, and either the list of hosts is taken from the
23449 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23450 were not obtained from MX records (this includes fallback hosts from the
23451 router), and were not randomized by the router, the order of trying the hosts
23452 is randomized each time the transport runs. Randomizing the order of a host
23453 list can be used to do crude load sharing.
23454
23455 When &%hosts_randomize%& is true, a host list may be split into groups whose
23456 order is separately randomized. This makes it possible to set up MX-like
23457 behaviour. The boundaries between groups are indicated by an item that is just
23458 &`+`& in the host list. For example:
23459 .code
23460 hosts = host1:host2:host3:+:host4:host5
23461 .endd
23462 The order of the first three hosts and the order of the last two hosts is
23463 randomized for each use, but the first three always end up before the last two.
23464 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23465
23466 .option hosts_require_auth smtp "host list&!!" unset
23467 .cindex "authentication" "required by client"
23468 This option provides a list of servers for which authentication must succeed
23469 before Exim will try to transfer a message. If authentication fails for
23470 servers which are not in this list, Exim tries to send unauthenticated. If
23471 authentication fails for one of these servers, delivery is deferred. This
23472 temporary error is detectable in the retry rules, so it can be turned into a
23473 hard failure if required. See also &%hosts_try_auth%&, and chapter
23474 &<<CHAPSMTPAUTH>>& for details of authentication.
23475
23476
23477 .option hosts_request_ocsp smtp "host list&!!" *
23478 .cindex "TLS" "requiring for certain servers"
23479 Exim will request a Certificate Status on a
23480 TLS session for any host that matches this list.
23481 &%tls_verify_certificates%& should also be set for the transport.
23482
23483 .option hosts_require_ocsp smtp "host list&!!" unset
23484 .cindex "TLS" "requiring for certain servers"
23485 Exim will request, and check for a valid Certificate Status being given, on a
23486 TLS session for any host that matches this list.
23487 &%tls_verify_certificates%& should also be set for the transport.
23488
23489 .option hosts_require_tls smtp "host list&!!" unset
23490 .cindex "TLS" "requiring for certain servers"
23491 Exim will insist on using a TLS session when delivering to any host that
23492 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23493 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23494 incoming messages, use an appropriate ACL.
23495
23496 .option hosts_try_auth smtp "host list&!!" unset
23497 .cindex "authentication" "optional in client"
23498 This option provides a list of servers to which, provided they announce
23499 authentication support, Exim will attempt to authenticate as a client when it
23500 connects. If authentication fails, Exim will try to transfer the message
23501 unauthenticated. See also &%hosts_require_auth%&, and chapter
23502 &<<CHAPSMTPAUTH>>& for details of authentication.
23503
23504 .option hosts_try_prdr smtp "host list&!!" *
23505 .cindex "PRDR" "enabling, optional in client"
23506 This option provides a list of servers to which, provided they announce
23507 PRDR support, Exim will attempt to negotiate PRDR
23508 for multi-recipient messages.
23509 The option can usually be left as default.
23510
23511 .option interface smtp "string list&!!" unset
23512 .cindex "bind IP address"
23513 .cindex "IP address" "binding"
23514 .vindex "&$host$&"
23515 .vindex "&$host_address$&"
23516 This option specifies which interface to bind to when making an outgoing SMTP
23517 call. The value is an IP address, not an interface name such as
23518 &`eth0`&. Do not confuse this with the interface address that was used when a
23519 message was received, which is in &$received_ip_address$&, formerly known as
23520 &$interface_address$&. The name was changed to minimize confusion with the
23521 outgoing interface address. There is no variable that contains an outgoing
23522 interface address because, unless it is set by this option, its value is
23523 unknown.
23524
23525 During the expansion of the &%interface%& option the variables &$host$& and
23526 &$host_address$& refer to the host to which a connection is about to be made
23527 during the expansion of the string. Forced expansion failure, or an empty
23528 string result causes the option to be ignored. Otherwise, after expansion, the
23529 string must be a list of IP addresses, colon-separated by default, but the
23530 separator can be changed in the usual way. For example:
23531 .code
23532 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23533 .endd
23534 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23535 connection. If none of them are the correct type, the option is ignored. If
23536 &%interface%& is not set, or is ignored, the system's IP functions choose which
23537 interface to use if the host has more than one.
23538
23539
23540 .option keepalive smtp boolean true
23541 .cindex "keepalive" "on outgoing connection"
23542 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23543 connections. When set, it causes the kernel to probe idle connections
23544 periodically, by sending packets with &"old"& sequence numbers. The other end
23545 of the connection should send a acknowledgment if the connection is still okay
23546 or a reset if the connection has been aborted. The reason for doing this is
23547 that it has the beneficial effect of freeing up certain types of connection
23548 that can get stuck when the remote host is disconnected without tidying up the
23549 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23550 unreachable hosts.
23551
23552
23553 .option lmtp_ignore_quota smtp boolean false
23554 .cindex "LMTP" "ignoring quota errors"
23555 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23556 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23557 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23558
23559 .option max_rcpt smtp integer 100
23560 .cindex "RCPT" "maximum number of outgoing"
23561 This option limits the number of RCPT commands that are sent in a single
23562 SMTP message transaction. Each set of addresses is treated independently, and
23563 so can cause parallel connections to the same host if &%remote_max_parallel%&
23564 permits this.
23565
23566
23567 .option multi_domain smtp boolean&!! true
23568 .vindex "&$domain$&"
23569 When this option is set, the &(smtp)& transport can handle a number of
23570 addresses containing a mixture of different domains provided they all resolve
23571 to the same list of hosts. Turning the option off restricts the transport to
23572 handling only one domain at a time. This is useful if you want to use
23573 &$domain$& in an expansion for the transport, because it is set only when there
23574 is a single domain involved in a remote delivery.
23575
23576 It is expanded per-address and can depend on any of
23577 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23578 &$host$&, &$host_address$& and &$host_port$&.
23579
23580 .option port smtp string&!! "see below"
23581 .cindex "port" "sending TCP/IP"
23582 .cindex "TCP/IP" "setting outgoing port"
23583 This option specifies the TCP/IP port on the server to which Exim connects.
23584 &*Note:*& Do not confuse this with the port that was used when a message was
23585 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23586 The name was changed to minimize confusion with the outgoing port. There is no
23587 variable that contains an outgoing port.
23588
23589 If the value of this option begins with a digit it is taken as a port number;
23590 otherwise it is looked up using &[getservbyname()]&. The default value is
23591 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23592 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23593 is deferred.
23594
23595
23596
23597 .option protocol smtp string smtp
23598 .cindex "LMTP" "over TCP/IP"
23599 .cindex "ssmtp protocol" "outbound"
23600 .cindex "TLS" "SSL-on-connect outbound"
23601 .vindex "&$port$&"
23602 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23603 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23604 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23605 deliveries into closed message stores. Exim also has support for running LMTP
23606 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23607
23608 If this option is set to &"smtps"&, the default value for the &%port%& option
23609 changes to &"smtps"&, and the transport initiates TLS immediately after
23610 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23611 The Internet standards bodies strongly discourage use of this mode.
23612
23613
23614 .option retry_include_ip_address smtp boolean&!! true
23615 Exim normally includes both the host name and the IP address in the key it
23616 constructs for indexing retry data after a temporary delivery failure. This
23617 means that when one of several IP addresses for a host is failing, it gets
23618 tried periodically (controlled by the retry rules), but use of the other IP
23619 addresses is not affected.
23620
23621 However, in some dialup environments hosts are assigned a different IP address
23622 each time they connect. In this situation the use of the IP address as part of
23623 the retry key leads to undesirable behaviour. Setting this option false causes
23624 Exim to use only the host name.
23625 Since it is expanded it can be made to depend on the host or domain.
23626
23627
23628 .option serialize_hosts smtp "host list&!!" unset
23629 .cindex "serializing connections"
23630 .cindex "host" "serializing connections"
23631 Because Exim operates in a distributed manner, if several messages for the same
23632 host arrive at around the same time, more than one simultaneous connection to
23633 the remote host can occur. This is not usually a problem except when there is a
23634 slow link between the hosts. In that situation it may be helpful to restrict
23635 Exim to one connection at a time. This can be done by setting
23636 &%serialize_hosts%& to match the relevant hosts.
23637
23638 .cindex "hints database" "serializing deliveries to a host"
23639 Exim implements serialization by means of a hints database in which a record is
23640 written whenever a process connects to one of the restricted hosts. The record
23641 is deleted when the connection is completed. Obviously there is scope for
23642 records to get left lying around if there is a system or program crash. To
23643 guard against this, Exim ignores any records that are more than six hours old.
23644
23645 If you set up this kind of serialization, you should also arrange to delete the
23646 relevant hints database whenever your system reboots. The names of the files
23647 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23648 may be one or two files, depending on the type of DBM in use. The same files
23649 are used for ETRN serialization.
23650
23651 .new
23652 See also the &%max_parallel%& generic transport option.
23653 .wen
23654
23655
23656 .option size_addition smtp integer 1024
23657 .cindex "SMTP" "SIZE"
23658 .cindex "message" "size issue for transport filter"
23659 .cindex "size" "of message"
23660 .cindex "transport" "filter"
23661 .cindex "filter" "transport filter"
23662 If a remote SMTP server indicates that it supports the SIZE option of the
23663 MAIL command, Exim uses this to pass over the message size at the start of
23664 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23665 sends, to allow for headers and other text that may be added during delivery by
23666 configuration options or in a transport filter. It may be necessary to increase
23667 this if a lot of text is added to messages.
23668
23669 Alternatively, if the value of &%size_addition%& is set negative, it disables
23670 the use of the SIZE option altogether.
23671
23672
23673 .option tls_certificate smtp string&!! unset
23674 .cindex "TLS" "client certificate, location of"
23675 .cindex "certificate" "client, location of"
23676 .vindex "&$host$&"
23677 .vindex "&$host_address$&"
23678 The value of this option must be the absolute path to a file which contains the
23679 client's certificate, for possible use when sending a message over an encrypted
23680 connection. The values of &$host$& and &$host_address$& are set to the name and
23681 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23682 details of TLS.
23683
23684 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23685 certificate when sending messages as a client. The global option of the same
23686 name specifies the certificate for Exim as a server; it is not automatically
23687 assumed that the same certificate should be used when Exim is operating as a
23688 client.
23689
23690
23691 .option tls_crl smtp string&!! unset
23692 .cindex "TLS" "client certificate revocation list"
23693 .cindex "certificate" "revocation list for client"
23694 This option specifies a certificate revocation list. The expanded value must
23695 be the name of a file that contains a CRL in PEM format.
23696
23697
23698 .option tls_dh_min_bits smtp integer 1024
23699 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23700 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23701 key agreement is negotiated, the server will provide a large prime number
23702 for use.  This option establishes the minimum acceptable size of that number.
23703 If the parameter offered by the server is too small, then the TLS handshake
23704 will fail.
23705
23706 Only supported when using GnuTLS.
23707
23708
23709 .option tls_privatekey smtp string&!! unset
23710 .cindex "TLS" "client private key, location of"
23711 .vindex "&$host$&"
23712 .vindex "&$host_address$&"
23713 The value of this option must be the absolute path to a file which contains the
23714 client's private key. This is used when sending a message over an encrypted
23715 connection using a client certificate. The values of &$host$& and
23716 &$host_address$& are set to the name and address of the server during the
23717 expansion. If this option is unset, or the expansion is forced to fail, or the
23718 result is an empty string, the private key is assumed to be in the same file as
23719 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23720
23721
23722 .option tls_require_ciphers smtp string&!! unset
23723 .cindex "TLS" "requiring specific ciphers"
23724 .cindex "cipher" "requiring specific"
23725 .vindex "&$host$&"
23726 .vindex "&$host_address$&"
23727 The value of this option must be a list of permitted cipher suites, for use
23728 when setting up an outgoing encrypted connection. (There is a global option of
23729 the same name for controlling incoming connections.) The values of &$host$& and
23730 &$host_address$& are set to the name and address of the server during the
23731 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23732 is used in different ways by OpenSSL and GnuTLS (see sections
23733 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23734 ciphers is a preference order.
23735
23736
23737
23738 .option tls_sni smtp string&!! unset
23739 .cindex "TLS" "Server Name Indication"
23740 .vindex "&$tls_sni$&"
23741 If this option is set then it sets the $tls_out_sni variable and causes any
23742 TLS session to pass this value as the Server Name Indication extension to
23743 the remote side, which can be used by the remote side to select an appropriate
23744 certificate and private key for the session.
23745
23746 See &<<SECTtlssni>>& for more information.
23747
23748 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23749 TLS extensions.
23750
23751
23752
23753
23754 .option tls_tempfail_tryclear smtp boolean true
23755 .cindex "4&'xx'& responses" "to STARTTLS"
23756 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23757 setting up a TLS session, this option determines whether or not Exim should try
23758 to deliver the message unencrypted. If it is set false, delivery to the
23759 current host is deferred; if there are other hosts, they are tried. If this
23760 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23761 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23762 TLS negotiation fails, Exim closes the current connection (because it is in an
23763 unknown state), opens a new one to the same host, and then tries the delivery
23764 in clear.
23765
23766
23767 .option tls_try_verify_hosts smtp "host list&!!" *
23768 .cindex "TLS" "server certificate verification"
23769 .cindex "certificate" "verification of server"
23770 This option gives a list of hosts for which, on encrypted connections,
23771 certificate verification will be tried but need not succeed.
23772 The &%tls_verify_certificates%& option must also be set.
23773 Note that unless the host is in this list
23774 TLS connections will be denied to hosts using self-signed certificates
23775 when &%tls_verify_certificates%& is matched.
23776 The &$tls_out_certificate_verified$& variable is set when
23777 certificate verification succeeds.
23778
23779
23780 .option tls_verify_cert_hostnames smtp "host list&!!" *
23781 .cindex "TLS" "server certificate hostname verification"
23782 .cindex "certificate" "verification of server"
23783 This option give a list of hosts for which,
23784 while verifying the server certificate,
23785 checks will be included on the host name
23786 (note that this will generally be the result of a DNS MX lookup)
23787 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23788 limited to being the initial component of a 3-or-more component FQDN.
23789
23790 There is no equivalent checking on client certificates.
23791
23792
23793 .option tls_verify_certificates smtp string&!! system
23794 .cindex "TLS" "server certificate verification"
23795 .cindex "certificate" "verification of server"
23796 .vindex "&$host$&"
23797 .vindex "&$host_address$&"
23798 The value of this option must be either the
23799 word "system"
23800 or the absolute path to
23801 a file or directory containing permitted certificates for servers,
23802 for use when setting up an encrypted connection.
23803
23804 The "system" value for the option will use a location compiled into the SSL library.
23805 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23806 is taken as empty and an explicit location
23807 must be specified.
23808
23809 The use of a directory for the option value is not available for GnuTLS versions
23810 preceding 3.3.6 and a single file must be used.
23811
23812 With OpenSSL the certificates specified
23813 explicitly
23814 either by file or directory
23815 are added to those given by the system default location.
23816
23817 The values of &$host$& and
23818 &$host_address$& are set to the name and address of the server during the
23819 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23820
23821 For back-compatibility,
23822 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23823 (a single-colon empty list counts as being set)
23824 and certificate verification fails the TLS connection is closed.
23825
23826
23827 .option tls_verify_hosts smtp "host list&!!" unset
23828 .cindex "TLS" "server certificate verification"
23829 .cindex "certificate" "verification of server"
23830 This option gives a list of hosts for which. on encrypted connections,
23831 certificate verification must succeed.
23832 The &%tls_verify_certificates%& option must also be set.
23833 If both this option and &%tls_try_verify_hosts%& are unset
23834 operation is as if this option selected all hosts.
23835
23836
23837
23838
23839 .section "How the limits for the number of hosts to try are used" &&&
23840          "SECTvalhosmax"
23841 .cindex "host" "maximum number to try"
23842 .cindex "limit" "hosts; maximum number tried"
23843 There are two options that are concerned with the number of hosts that are
23844 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23845 &%hosts_max_try_hardlimit%&.
23846
23847
23848 The &%hosts_max_try%& option limits the number of hosts that are tried
23849 for a single delivery. However, despite the term &"host"& in its name, the
23850 option actually applies to each IP address independently. In other words, a
23851 multihomed host is treated as several independent hosts, just as it is for
23852 retrying.
23853
23854 Many of the larger ISPs have multiple MX records which often point to
23855 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23856 created as a result of routing one of these domains.
23857
23858 Trying every single IP address on such a long list does not seem sensible; if
23859 several at the top of the list fail, it is reasonable to assume there is some
23860 problem that is likely to affect all of them. Roughly speaking, the value of
23861 &%hosts_max_try%& is the maximum number that are tried before deferring the
23862 delivery. However, the logic cannot be quite that simple.
23863
23864 Firstly, IP addresses that are skipped because their retry times have not
23865 arrived do not count, and in addition, addresses that are past their retry
23866 limits are also not counted, even when they are tried. This means that when
23867 some IP addresses are past their retry limits, more than the value of
23868 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23869 that all IP addresses are considered before timing out an email address (but
23870 see below for an exception).
23871
23872 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23873 list to see if there is a subsequent host with a different (higher valued) MX.
23874 If there is, that host is considered next, and the current IP address is used
23875 but not counted. This behaviour helps in the case of a domain with a retry rule
23876 that hardly ever delays any hosts, as is now explained:
23877
23878 Consider the case of a long list of hosts with one MX value, and a few with a
23879 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23880 hosts at the top of the list are tried at first. With the default retry rule,
23881 which specifies increasing retry times, the higher MX hosts are eventually
23882 tried when those at the top of the list are skipped because they have not
23883 reached their retry times.
23884
23885 However, it is common practice to put a fixed short retry time on domains for
23886 large ISPs, on the grounds that their servers are rarely down for very long.
23887 Unfortunately, these are exactly the domains that tend to resolve to long lists
23888 of hosts. The short retry time means that the lowest MX hosts are tried every
23889 time. The attempts may be in a different order because of random sorting, but
23890 without the special MX check, the higher MX hosts would never be tried until
23891 all the lower MX hosts had timed out (which might be several days), because
23892 there are always some lower MX hosts that have reached their retry times. With
23893 the special check, Exim considers at least one IP address from each MX value at
23894 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23895 reached.
23896
23897 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23898 particular, Exim normally eventually tries all the IP addresses before timing
23899 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23900 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23901 been set up with hundreds of IP addresses for some domains. It can
23902 take a very long time indeed for an address to time out in these cases.
23903
23904 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23905 Exim never tries more than this number of IP addresses; if it hits this limit
23906 and they are all timed out, the email address is bounced, even though not all
23907 possible IP addresses have been tried.
23908 .ecindex IIDsmttra1
23909 .ecindex IIDsmttra2
23910
23911
23912
23913
23914
23915 . ////////////////////////////////////////////////////////////////////////////
23916 . ////////////////////////////////////////////////////////////////////////////
23917
23918 .chapter "Address rewriting" "CHAPrewrite"
23919 .scindex IIDaddrew "rewriting" "addresses"
23920 There are some circumstances in which Exim automatically rewrites domains in
23921 addresses. The two most common are when an address is given without a domain
23922 (referred to as an &"unqualified address"&) or when an address contains an
23923 abbreviated domain that is expanded by DNS lookup.
23924
23925 Unqualified envelope addresses are accepted only for locally submitted
23926 messages, or for messages that are received from hosts matching
23927 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23928 appropriate. Unqualified addresses in header lines are qualified if they are in
23929 locally submitted messages, or messages from hosts that are permitted to send
23930 unqualified envelope addresses. Otherwise, unqualified addresses in header
23931 lines are neither qualified nor rewritten.
23932
23933 One situation in which Exim does &'not'& automatically rewrite a domain is
23934 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23935 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23936 do this. The new RFCs do not contain this suggestion.
23937
23938
23939 .section "Explicitly configured address rewriting" "SECID147"
23940 This chapter describes the rewriting rules that can be used in the
23941 main rewrite section of the configuration file, and also in the generic
23942 &%headers_rewrite%& option that can be set on any transport.
23943
23944 Some people believe that configured address rewriting is a Mortal Sin.
23945 Others believe that life is not possible without it. Exim provides the
23946 facility; you do not have to use it.
23947
23948 The main rewriting rules that appear in the &"rewrite"& section of the
23949 configuration file are applied to addresses in incoming messages, both envelope
23950 addresses and addresses in header lines. Each rule specifies the types of
23951 address to which it applies.
23952
23953 Whether or not addresses in header lines are rewritten depends on the origin of
23954 the headers and the type of rewriting. Global rewriting, that is, rewriting
23955 rules from the rewrite section of the configuration file, is applied only to
23956 those headers that were received with the message. Header lines that are added
23957 by ACLs or by a system filter or by individual routers or transports (which
23958 are specific to individual recipient addresses) are not rewritten by the global
23959 rules.
23960
23961 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23962 applies all headers except those added by routers and transports. That is, as
23963 well as the headers that were received with the message, it also applies to
23964 headers that were added by an ACL or a system filter.
23965
23966
23967 In general, rewriting addresses from your own system or domain has some
23968 legitimacy. Rewriting other addresses should be done only with great care and
23969 in special circumstances. The author of Exim believes that rewriting should be
23970 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23971 Although it can sometimes be used as a routing tool, this is very strongly
23972 discouraged.
23973
23974 There are two commonly encountered circumstances where rewriting is used, as
23975 illustrated by these examples:
23976
23977 .ilist
23978 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23979 exchange mail with each other behind a firewall, but there is only a single
23980 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23981 &'hitch.fict.example'& when sending mail off-site.
23982 .next
23983 A host rewrites the local parts of its own users so that, for example,
23984 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23985 .endlist
23986
23987
23988
23989 .section "When does rewriting happen?" "SECID148"
23990 .cindex "rewriting" "timing of"
23991 .cindex "&ACL;" "rewriting addresses in"
23992 Configured address rewriting can take place at several different stages of a
23993 message's processing.
23994
23995 .vindex "&$sender_address$&"
23996 At the start of an ACL for MAIL, the sender address may have been rewritten
23997 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23998 ordinary rewrite rules have yet been applied. If, however, the sender address
23999 is verified in the ACL, it is rewritten before verification, and remains
24000 rewritten thereafter. The subsequent value of &$sender_address$& is the
24001 rewritten address. This also applies if sender verification happens in a
24002 RCPT ACL. Otherwise, when the sender address is not verified, it is
24003 rewritten as soon as a message's header lines have been received.
24004
24005 .vindex "&$domain$&"
24006 .vindex "&$local_part$&"
24007 Similarly, at the start of an ACL for RCPT, the current recipient's address
24008 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24009 rewrite rules have yet been applied to it. However, the behaviour is different
24010 from the sender address when a recipient is verified. The address is rewritten
24011 for the verification, but the rewriting is not remembered at this stage. The
24012 value of &$local_part$& and &$domain$& after verification are always the same
24013 as they were before (that is, they contain the unrewritten &-- except for
24014 SMTP-time rewriting &-- address).
24015
24016 As soon as a message's header lines have been received, all the envelope
24017 recipient addresses are permanently rewritten, and rewriting is also applied to
24018 the addresses in the header lines (if configured). This happens before adding
24019 any header lines that were specified in MAIL or RCPT ACLs, and
24020 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24021 before the DATA ACL and &[local_scan()]& functions are run.
24022
24023 When an address is being routed, either for delivery or for verification,
24024 rewriting is applied immediately to child addresses that are generated by
24025 redirection, unless &%no_rewrite%& is set on the router.
24026
24027 .cindex "envelope sender" "rewriting at transport time"
24028 .cindex "rewriting" "at transport time"
24029 .cindex "header lines" "rewriting at transport time"
24030 At transport time, additional rewriting of addresses in header lines can be
24031 specified by setting the generic &%headers_rewrite%& option on a transport.
24032 This option contains rules that are identical in form to those in the rewrite
24033 section of the configuration file. They are applied to the original message
24034 header lines and any that were added by ACLs or a system filter. They are not
24035 applied to header lines that are added by routers or the transport.
24036
24037 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24038 transport option. However, it is not possible to rewrite envelope recipients at
24039 transport time.
24040
24041
24042
24043
24044 .section "Testing the rewriting rules that apply on input" "SECID149"
24045 .cindex "rewriting" "testing"
24046 .cindex "testing" "rewriting"
24047 Exim's input rewriting configuration appears in a part of the run time
24048 configuration file headed by &"begin rewrite"&. It can be tested by the
24049 &%-brw%& command line option. This takes an address (which can be a full RFC
24050 2822 address) as its argument. The output is a list of how the address would be
24051 transformed by the rewriting rules for each of the different places it might
24052 appear in an incoming message, that is, for each different header and for the
24053 envelope sender and recipient fields. For example,
24054 .code
24055 exim -brw ph10@exim.workshop.example
24056 .endd
24057 might produce the output
24058 .code
24059 sender: Philip.Hazel@exim.workshop.example
24060 from: Philip.Hazel@exim.workshop.example
24061 to: ph10@exim.workshop.example
24062 cc: ph10@exim.workshop.example
24063 bcc: ph10@exim.workshop.example
24064 reply-to: Philip.Hazel@exim.workshop.example
24065 env-from: Philip.Hazel@exim.workshop.example
24066 env-to: ph10@exim.workshop.example
24067 .endd
24068 which shows that rewriting has been set up for that address when used in any of
24069 the source fields, but not when it appears as a recipient address. At the
24070 present time, there is no equivalent way of testing rewriting rules that are
24071 set for a particular transport.
24072
24073
24074 .section "Rewriting rules" "SECID150"
24075 .cindex "rewriting" "rules"
24076 The rewrite section of the configuration file consists of lines of rewriting
24077 rules in the form
24078 .display
24079 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24080 .endd
24081 Rewriting rules that are specified for the &%headers_rewrite%& generic
24082 transport option are given as a colon-separated list. Each item in the list
24083 takes the same form as a line in the main rewriting configuration (except that
24084 any colons must be doubled, of course).
24085
24086 The formats of source patterns and replacement strings are described below.
24087 Each is terminated by white space, unless enclosed in double quotes, in which
24088 case normal quoting conventions apply inside the quotes. The flags are single
24089 characters which may appear in any order. Spaces and tabs between them are
24090 ignored.
24091
24092 For each address that could potentially be rewritten, the rules are scanned in
24093 order, and replacements for the address from earlier rules can themselves be
24094 replaced by later rules (but see the &"q"& and &"R"& flags).
24095
24096 The order in which addresses are rewritten is undefined, may change between
24097 releases, and must not be relied on, with one exception: when a message is
24098 received, the envelope sender is always rewritten first, before any header
24099 lines are rewritten. For example, the replacement string for a rewrite of an
24100 address in &'To:'& must not assume that the message's address in &'From:'& has
24101 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24102 that the envelope sender has already been rewritten.
24103
24104 .vindex "&$domain$&"
24105 .vindex "&$local_part$&"
24106 The variables &$local_part$& and &$domain$& can be used in the replacement
24107 string to refer to the address that is being rewritten. Note that lookup-driven
24108 rewriting can be done by a rule of the form
24109 .code
24110 *@*   ${lookup ...
24111 .endd
24112 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24113 refer to the address that is being rewritten.
24114
24115
24116 .section "Rewriting patterns" "SECID151"
24117 .cindex "rewriting" "patterns"
24118 .cindex "address list" "in a rewriting pattern"
24119 The source pattern in a rewriting rule is any item which may appear in an
24120 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24121 single-item address list, which means that it is expanded before being tested
24122 against the address. As always, if you use a regular expression as a pattern,
24123 you must take care to escape dollar and backslash characters, or use the &`\N`&
24124 facility to suppress string expansion within the regular expression.
24125
24126 Domains in patterns should be given in lower case. Local parts in patterns are
24127 case-sensitive. If you want to do case-insensitive matching of local parts, you
24128 can use a regular expression that starts with &`^(?i)`&.
24129
24130 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24131 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24132 depending on the type of match which occurred. These can be used in the
24133 replacement string to insert portions of the incoming address. &$0$& always
24134 refers to the complete incoming address. When a regular expression is used, the
24135 numerical variables are set from its capturing subexpressions. For other types
24136 of pattern they are set as follows:
24137
24138 .ilist
24139 If a local part or domain starts with an asterisk, the numerical variables
24140 refer to the character strings matched by asterisks, with &$1$& associated with
24141 the first asterisk, and &$2$& with the second, if present. For example, if the
24142 pattern
24143 .code
24144 *queen@*.fict.example
24145 .endd
24146 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24147 .code
24148 $0 = hearts-queen@wonderland.fict.example
24149 $1 = hearts-
24150 $2 = wonderland
24151 .endd
24152 Note that if the local part does not start with an asterisk, but the domain
24153 does, it is &$1$& that contains the wild part of the domain.
24154
24155 .next
24156 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24157 of the domain are placed in the next available numerical variables. Suppose,
24158 for example, that the address &'foo@bar.baz.example'& is processed by a
24159 rewriting rule of the form
24160 .display
24161 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24162 .endd
24163 and the key in the file that matches the domain is &`*.baz.example`&. Then
24164 .code
24165 $1 = foo
24166 $2 = bar
24167 $3 = baz.example
24168 .endd
24169 If the address &'foo@baz.example'& is looked up, this matches the same
24170 wildcard file entry, and in this case &$2$& is set to the empty string, but
24171 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24172 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24173 whole domain. For non-partial domain lookups, no numerical variables are set.
24174 .endlist
24175
24176
24177 .section "Rewriting replacements" "SECID152"
24178 .cindex "rewriting" "replacements"
24179 If the replacement string for a rule is a single asterisk, addresses that
24180 match the pattern and the flags are &'not'& rewritten, and no subsequent
24181 rewriting rules are scanned. For example,
24182 .code
24183 hatta@lookingglass.fict.example  *  f
24184 .endd
24185 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24186 &'From:'& headers.
24187
24188 .vindex "&$domain$&"
24189 .vindex "&$local_part$&"
24190 If the replacement string is not a single asterisk, it is expanded, and must
24191 yield a fully qualified address. Within the expansion, the variables
24192 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24193 Any letters they contain retain their original case &-- they are not lower
24194 cased. The numerical variables are set up according to the type of pattern that
24195 matched the address, as described above. If the expansion is forced to fail by
24196 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24197 current rule is abandoned, but subsequent rules may take effect. Any other
24198 expansion failure causes the entire rewriting operation to be abandoned, and an
24199 entry written to the panic log.
24200
24201
24202
24203 .section "Rewriting flags" "SECID153"
24204 There are three different kinds of flag that may appear on rewriting rules:
24205
24206 .ilist
24207 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24208 c, f, h, r, s, t.
24209 .next
24210 A flag that specifies rewriting at SMTP time: S.
24211 .next
24212 Flags that control the rewriting process: Q, q, R, w.
24213 .endlist
24214
24215 For rules that are part of the &%headers_rewrite%& generic transport option,
24216 E, F, T, and S are not permitted.
24217
24218
24219
24220 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24221          "SECID154"
24222 .cindex "rewriting" "flags"
24223 If none of the following flag letters, nor the &"S"& flag (see section
24224 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24225 and to both the sender and recipient fields of the envelope, whereas a
24226 transport-time rewriting rule just applies to all headers. Otherwise, the
24227 rewriting rule is skipped unless the relevant addresses are being processed.
24228 .display
24229 &`E`&       rewrite all envelope fields
24230 &`F`&       rewrite the envelope From field
24231 &`T`&       rewrite the envelope To field
24232 &`b`&       rewrite the &'Bcc:'& header
24233 &`c`&       rewrite the &'Cc:'& header
24234 &`f`&       rewrite the &'From:'& header
24235 &`h`&       rewrite all headers
24236 &`r`&       rewrite the &'Reply-To:'& header
24237 &`s`&       rewrite the &'Sender:'& header
24238 &`t`&       rewrite the &'To:'& header
24239 .endd
24240 "All headers" means all of the headers listed above that can be selected
24241 individually, plus their &'Resent-'& versions. It does not include
24242 other headers such as &'Subject:'& etc.
24243
24244 You should be particularly careful about rewriting &'Sender:'& headers, and
24245 restrict this to special known cases in your own domains.
24246
24247
24248 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24249 .cindex "SMTP" "rewriting malformed addresses"
24250 .cindex "RCPT" "rewriting argument of"
24251 .cindex "MAIL" "rewriting argument of"
24252 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24253 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24254 before any other processing; even before syntax checking. The pattern is
24255 required to be a regular expression, and it is matched against the whole of the
24256 data for the command, including any surrounding angle brackets.
24257
24258 .vindex "&$domain$&"
24259 .vindex "&$local_part$&"
24260 This form of rewrite rule allows for the handling of addresses that are not
24261 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24262 input). Because the input is not required to be a syntactically valid address,
24263 the variables &$local_part$& and &$domain$& are not available during the
24264 expansion of the replacement string. The result of rewriting replaces the
24265 original address in the MAIL or RCPT command.
24266
24267
24268 .section "Flags controlling the rewriting process" "SECID155"
24269 There are four flags which control the way the rewriting process works. These
24270 take effect only when a rule is invoked, that is, when the address is of the
24271 correct type (matches the flags) and matches the pattern:
24272
24273 .ilist
24274 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24275 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24276 absence of &"Q"& the rewritten address must always include a domain.
24277 .next
24278 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24279 even if no rewriting actually takes place because of a &"fail"& in the
24280 expansion. The &"q"& flag is not effective if the address is of the wrong type
24281 (does not match the flags) or does not match the pattern.
24282 .next
24283 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24284 address, up to ten times. It can be combined with the &"q"& flag, to stop
24285 rewriting once it fails to match (after at least one successful rewrite).
24286 .next
24287 .cindex "rewriting" "whole addresses"
24288 When an address in a header is rewritten, the rewriting normally applies only
24289 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24290 left unchanged. For example, rewriting might change
24291 .code
24292 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24293 .endd
24294 into
24295 .code
24296 From: Ford Prefect <prefectf@hitch.fict.example>
24297 .endd
24298 .cindex "RFC 2047"
24299 Sometimes there is a need to replace the whole address item, and this can be
24300 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24301 causes an address in a header line to be rewritten, the entire address is
24302 replaced, not just the working part. The replacement must be a complete RFC
24303 2822 address, including the angle brackets if necessary. If text outside angle
24304 brackets contains a character whose value is greater than 126 or less than 32
24305 (except for tab), the text is encoded according to RFC 2047. The character set
24306 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24307
24308 When the &"w"& flag is set on a rule that causes an envelope address to be
24309 rewritten, all but the working part of the replacement address is discarded.
24310 .endlist
24311
24312
24313 .section "Rewriting examples" "SECID156"
24314 Here is an example of the two common rewriting paradigms:
24315 .code
24316 *@*.hitch.fict.example  $1@hitch.fict.example
24317 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24318                      {$value}fail}@hitch.fict.example bctfrF
24319 .endd
24320 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24321 the string expansion to fail if the lookup does not succeed. In this context it
24322 has the effect of leaving the original address unchanged, but Exim goes on to
24323 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24324 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24325 explicitly, which would cause the rewritten address to be the same as before,
24326 at the cost of a small bit of processing. Not supplying either of these is an
24327 error, since the rewritten address would then contain no local part.
24328
24329 The first example above replaces the domain with a superior, more general
24330 domain. This may not be desirable for certain local parts. If the rule
24331 .code
24332 root@*.hitch.fict.example  *
24333 .endd
24334 were inserted before the first rule, rewriting would be suppressed for the
24335 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24336
24337 Rewriting can be made conditional on a number of tests, by making use of
24338 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24339 messages that originate outside the local host:
24340 .code
24341 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24342                          {$1@hitch.fict.example}fail}"
24343 .endd
24344 The replacement string is quoted in this example because it contains white
24345 space.
24346
24347 .cindex "rewriting" "bang paths"
24348 .cindex "bang paths" "rewriting"
24349 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24350 an address it treats it as an unqualified local part which it qualifies with
24351 the local qualification domain (if the source of the message is local or if the
24352 remote host is permitted to send unqualified addresses). Rewriting can
24353 sometimes be used to handle simple bang paths with a fixed number of
24354 components. For example, the rule
24355 .code
24356 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24357 .endd
24358 rewrites a two-component bang path &'host.name!user'& as the domain address
24359 &'user@host.name'&. However, there is a security implication in using this as
24360 a global rewriting rule for envelope addresses. It can provide a backdoor
24361 method for using your system as a relay, because the incoming addresses appear
24362 to be local. If the bang path addresses are received via SMTP, it is safer to
24363 use the &"S"& flag to rewrite them as they are received, so that relay checking
24364 can be done on the rewritten addresses.
24365 .ecindex IIDaddrew
24366
24367
24368
24369
24370
24371 . ////////////////////////////////////////////////////////////////////////////
24372 . ////////////////////////////////////////////////////////////////////////////
24373
24374 .chapter "Retry configuration" "CHAPretry"
24375 .scindex IIDretconf1 "retry" "configuration, description of"
24376 .scindex IIDregconf2 "configuration file" "retry section"
24377 The &"retry"& section of the runtime configuration file contains a list of
24378 retry rules that control how often Exim tries to deliver messages that cannot
24379 be delivered at the first attempt. If there are no retry rules (the section is
24380 empty or not present), there are no retries. In this situation, temporary
24381 errors are treated as permanent. The default configuration contains a single,
24382 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24383 line option can be used to test which retry rule will be used for a given
24384 address, domain and error.
24385
24386 The most common cause of retries is temporary failure to deliver to a remote
24387 host because the host is down, or inaccessible because of a network problem.
24388 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24389 address) basis, not on a per-message basis. Thus, if one message has recently
24390 been delayed, delivery of a new message to the same host is not immediately
24391 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24392 log selector is set, the message
24393 .cindex "retry" "time not reached"
24394 &"retry time not reached"& is written to the main log whenever a delivery is
24395 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24396 the handling of errors during remote deliveries.
24397
24398 Retry processing applies to routing as well as to delivering, except as covered
24399 in the next paragraph. The retry rules do not distinguish between these
24400 actions. It is not possible, for example, to specify different behaviour for
24401 failures to route the domain &'snark.fict.example'& and failures to deliver to
24402 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24403 added complication, so did not implement it. However, although they share the
24404 same retry rule, the actual retry times for routing and transporting a given
24405 domain are maintained independently.
24406
24407 When a delivery is not part of a queue run (typically an immediate delivery on
24408 receipt of a message), the routers are always run, and local deliveries are
24409 always attempted, even if retry times are set for them. This makes for better
24410 behaviour if one particular message is causing problems (for example, causing
24411 quota overflow, or provoking an error in a filter file). If such a delivery
24412 suffers a temporary failure, the retry data is updated as normal, and
24413 subsequent delivery attempts from queue runs occur only when the retry time for
24414 the local address is reached.
24415
24416 .section "Changing retry rules" "SECID157"
24417 If you change the retry rules in your configuration, you should consider
24418 whether or not to delete the retry data that is stored in Exim's spool area in
24419 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24420 always safe; that is why they are called &"hints"&.
24421
24422 The hints retry data contains suggested retry times based on the previous
24423 rules. In the case of a long-running problem with a remote host, it might
24424 record the fact that the host has timed out. If your new rules increase the
24425 timeout time for such a host, you should definitely remove the old retry data
24426 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24427 messages that it should now be retaining.
24428
24429
24430
24431 .section "Format of retry rules" "SECID158"
24432 .cindex "retry" "rules"
24433 Each retry rule occupies one line and consists of three or four parts,
24434 separated by white space: a pattern, an error name, an optional list of sender
24435 addresses, and a list of retry parameters. The pattern and sender lists must be
24436 enclosed in double quotes if they contain white space. The rules are searched
24437 in order until one is found where the pattern, error name, and sender list (if
24438 present) match the failing host or address, the error that occurred, and the
24439 message's sender, respectively.
24440
24441
24442 The pattern is any single item that may appear in an address list (see section
24443 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24444 which means that it is expanded before being tested against the address that
24445 has been delayed. A negated address list item is permitted. Address
24446 list processing treats a plain domain name as if it were preceded by &"*@"&,
24447 which makes it possible for many retry rules to start with just a domain. For
24448 example,
24449 .code
24450 lookingglass.fict.example        *  F,24h,30m;
24451 .endd
24452 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24453 whereas
24454 .code
24455 alice@lookingglass.fict.example  *  F,24h,30m;
24456 .endd
24457 applies only to temporary failures involving the local part &%alice%&.
24458 In practice, almost all rules start with a domain name pattern without a local
24459 part.
24460
24461 .cindex "regular expressions" "in retry rules"
24462 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24463 must match a complete address, not just a domain, because that is how regular
24464 expressions work in address lists.
24465 .display
24466 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24467 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24468 .endd
24469
24470
24471 .section "Choosing which retry rule to use for address errors" "SECID159"
24472 When Exim is looking for a retry rule after a routing attempt has failed (for
24473 example, after a DNS timeout), each line in the retry configuration is tested
24474 against the complete address only if &%retry_use_local_part%& is set for the
24475 router. Otherwise, only the domain is used, except when matching against a
24476 regular expression, when the local part of the address is replaced with &"*"&.
24477 A domain on its own can match a domain pattern, or a pattern that starts with
24478 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24479 &%check_local_user%& is true, and false for other routers.
24480
24481 Similarly, when Exim is looking for a retry rule after a local delivery has
24482 failed (for example, after a mailbox full error), each line in the retry
24483 configuration is tested against the complete address only if
24484 &%retry_use_local_part%& is set for the transport (it defaults true for all
24485 local transports).
24486
24487 .cindex "4&'xx'& responses" "retry rules for"
24488 However, when Exim is looking for a retry rule after a remote delivery attempt
24489 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24490 whole address is always used as the key when searching the retry rules. The
24491 rule that is found is used to create a retry time for the combination of the
24492 failing address and the message's sender. It is the combination of sender and
24493 recipient that is delayed in subsequent queue runs until its retry time is
24494 reached. You can delay the recipient without regard to the sender by setting
24495 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24496 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24497 commands.
24498
24499
24500
24501 .section "Choosing which retry rule to use for host and message errors" &&&
24502          "SECID160"
24503 For a temporary error that is not related to an individual address (for
24504 example, a connection timeout), each line in the retry configuration is checked
24505 twice. First, the name of the remote host is used as a domain name (preceded by
24506 &"*@"& when matching a regular expression). If this does not match the line,
24507 the domain from the email address is tried in a similar fashion. For example,
24508 suppose the MX records for &'a.b.c.example'& are
24509 .code
24510 a.b.c.example  MX  5  x.y.z.example
24511                MX  6  p.q.r.example
24512                MX  7  m.n.o.example
24513 .endd
24514 and the retry rules are
24515 .code
24516 p.q.r.example    *      F,24h,30m;
24517 a.b.c.example    *      F,4d,45m;
24518 .endd
24519 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24520 first rule matches neither the host nor the domain, so Exim looks at the second
24521 rule. This does not match the host, but it does match the domain, so it is used
24522 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24523 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24524 first retry rule is used, because it matches the host.
24525
24526 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24527 first rule to determine retry times, but for all the other hosts for the domain
24528 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24529 routing to &'a.b.c.example'& suffers a temporary failure.
24530
24531 &*Note*&: The host name is used when matching the patterns, not its IP address.
24532 However, if a message is routed directly to an IP address without the use of a
24533 host name, for example, if a &(manualroute)& router contains a setting such as:
24534 .code
24535 route_list = *.a.example  192.168.34.23
24536 .endd
24537 then the &"host name"& that is used when searching for a retry rule is the
24538 textual form of the IP address.
24539
24540 .section "Retry rules for specific errors" "SECID161"
24541 .cindex "retry" "specific errors; specifying"
24542 The second field in a retry rule is the name of a particular error, or an
24543 asterisk, which matches any error. The errors that can be tested for are:
24544
24545 .vlist
24546 .vitem &%auth_failed%&
24547 Authentication failed when trying to send to a host in the
24548 &%hosts_require_auth%& list in an &(smtp)& transport.
24549
24550 .vitem &%data_4xx%&
24551 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24552 after the command, or after sending the message's data.
24553
24554 .vitem &%mail_4xx%&
24555 A 4&'xx'& error was received for an outgoing MAIL command.
24556
24557 .vitem &%rcpt_4xx%&
24558 A 4&'xx'& error was received for an outgoing RCPT command.
24559 .endlist
24560
24561 For the three 4&'xx'& errors, either the first or both of the x's can be given
24562 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24563 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24564 and have retries every ten minutes with a one-hour timeout, you could set up a
24565 retry rule of this form:
24566 .code
24567 the.domain.name  rcpt_452   F,1h,10m
24568 .endd
24569 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24570 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24571
24572 .vlist
24573 .vitem &%lost_connection%&
24574 A server unexpectedly closed the SMTP connection. There may, of course,
24575 legitimate reasons for this (host died, network died), but if it repeats a lot
24576 for the same host, it indicates something odd.
24577
24578 .vitem &%lookup%&
24579 A DNS lookup for a host failed.
24580 Note that a &%dnslookup%& router will need to have matched
24581 its &%fail_defer_domains%& option for this retry type to be usable.
24582 Also note that a &%manualroute%& router will probably need
24583 its &%host_find_failed%& option set to &%defer%&.
24584
24585 .vitem &%refused_MX%&
24586 A connection to a host obtained from an MX record was refused.
24587
24588 .vitem &%refused_A%&
24589 A connection to a host not obtained from an MX record was refused.
24590
24591 .vitem &%refused%&
24592 A connection was refused.
24593
24594 .vitem &%timeout_connect_MX%&
24595 A connection attempt to a host obtained from an MX record timed out.
24596
24597 .vitem &%timeout_connect_A%&
24598 A connection attempt to a host not obtained from an MX record timed out.
24599
24600 .vitem &%timeout_connect%&
24601 A connection attempt timed out.
24602
24603 .vitem &%timeout_MX%&
24604 There was a timeout while connecting or during an SMTP session with a host
24605 obtained from an MX record.
24606
24607 .vitem &%timeout_A%&
24608 There was a timeout while connecting or during an SMTP session with a host not
24609 obtained from an MX record.
24610
24611 .vitem &%timeout%&
24612 There was a timeout while connecting or during an SMTP session.
24613
24614 .vitem &%tls_required%&
24615 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24616 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24617 to STARTTLS, or there was a problem setting up the TLS connection.
24618
24619 .vitem &%quota%&
24620 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24621 transport.
24622
24623 .vitem &%quota_%&<&'time'&>
24624 .cindex "quota" "error testing in retry rule"
24625 .cindex "retry" "quota error testing"
24626 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24627 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24628 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24629 for four days.
24630 .endlist
24631
24632 .cindex "mailbox" "time of last read"
24633 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24634 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24635 it should be based on the last time that the user accessed the mailbox.
24636 However, it is not always possible to determine this. Exim uses the following
24637 heuristic rules:
24638
24639 .ilist
24640 If the mailbox is a single file, the time of last access (the &"atime"&) is
24641 used. As no new messages are being delivered (because the mailbox is over
24642 quota), Exim does not access the file, so this is the time of last user access.
24643 .next
24644 .cindex "maildir format" "time of last read"
24645 For a maildir delivery, the time of last modification of the &_new_&
24646 subdirectory is used. As the mailbox is over quota, no new files are created in
24647 the &_new_& subdirectory, because no new messages are being delivered. Any
24648 change to the &_new_& subdirectory is therefore assumed to be the result of an
24649 MUA moving a new message to the &_cur_& directory when it is first read. The
24650 time that is used is therefore the last time that the user read a new message.
24651 .next
24652 For other kinds of multi-file mailbox, the time of last access cannot be
24653 obtained, so a retry rule that uses this type of error field is never matched.
24654 .endlist
24655
24656 The quota errors apply both to system-enforced quotas and to Exim's own quota
24657 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24658 when a local delivery is deferred because a partition is full (the ENOSPC
24659 error).
24660
24661
24662
24663 .section "Retry rules for specified senders" "SECID162"
24664 .cindex "retry" "rules; sender-specific"
24665 You can specify retry rules that apply only when the failing message has a
24666 specific sender. In particular, this can be used to define retry rules that
24667 apply only to bounce messages. The third item in a retry rule can be of this
24668 form:
24669 .display
24670 &`senders=`&<&'address list'&>
24671 .endd
24672 The retry timings themselves are then the fourth item. For example:
24673 .code
24674 *   rcpt_4xx   senders=:   F,1h,30m
24675 .endd
24676 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24677 host. If the address list contains white space, it must be enclosed in quotes.
24678 For example:
24679 .code
24680 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24681 .endd
24682 &*Warning*&: This facility can be unhelpful if it is used for host errors
24683 (which do not depend on the recipient). The reason is that the sender is used
24684 only to match the retry rule. Once the rule has been found for a host error,
24685 its contents are used to set a retry time for the host, and this will apply to
24686 all messages, not just those with specific senders.
24687
24688 When testing retry rules using &%-brt%&, you can supply a sender using the
24689 &%-f%& command line option, like this:
24690 .code
24691 exim -f "" -brt user@dom.ain
24692 .endd
24693 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24694 list is never matched.
24695
24696
24697
24698
24699
24700 .section "Retry parameters" "SECID163"
24701 .cindex "retry" "parameters in rules"
24702 The third (or fourth, if a senders list is present) field in a retry rule is a
24703 sequence of retry parameter sets, separated by semicolons. Each set consists of
24704 .display
24705 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24706 .endd
24707 The letter identifies the algorithm for computing a new retry time; the cutoff
24708 time is the time beyond which this algorithm no longer applies, and the
24709 arguments vary the algorithm's action. The cutoff time is measured from the
24710 time that the first failure for the domain (combined with the local part if
24711 relevant) was detected, not from the time the message was received.
24712
24713 .cindex "retry" "algorithms"
24714 .cindex "retry" "fixed intervals"
24715 .cindex "retry" "increasing intervals"
24716 .cindex "retry" "random intervals"
24717 The available algorithms are:
24718
24719 .ilist
24720 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24721 the interval.
24722 .next
24723 &'G'&: retry at geometrically increasing intervals. The first argument
24724 specifies a starting value for the interval, and the second a multiplier, which
24725 is used to increase the size of the interval at each retry.
24726 .next
24727 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24728 retry, the previous interval is multiplied by the factor in order to get a
24729 maximum for the next interval. The minimum interval is the first argument of
24730 the parameter, and an actual interval is chosen randomly between them. Such a
24731 rule has been found to be helpful in cluster configurations when all the
24732 members of the cluster restart at once, and may therefore synchronize their
24733 queue processing times.
24734 .endlist
24735
24736 When computing the next retry time, the algorithm definitions are scanned in
24737 order until one whose cutoff time has not yet passed is reached. This is then
24738 used to compute a new retry time that is later than the current time. In the
24739 case of fixed interval retries, this simply means adding the interval to the
24740 current time. For geometrically increasing intervals, retry intervals are
24741 computed from the rule's parameters until one that is greater than the previous
24742 interval is found. The main configuration variable
24743 .cindex "limit" "retry interval"
24744 .cindex "retry" "interval, maximum"
24745 .oindex "&%retry_interval_max%&"
24746 &%retry_interval_max%& limits the maximum interval between retries. It
24747 cannot be set greater than &`24h`&, which is its default value.
24748
24749 A single remote domain may have a number of hosts associated with it, and each
24750 host may have more than one IP address. Retry algorithms are selected on the
24751 basis of the domain name, but are applied to each IP address independently. If,
24752 for example, a host has two IP addresses and one is unusable, Exim will
24753 generate retry times for it and will not try to use it until its next retry
24754 time comes. Thus the good IP address is likely to be tried first most of the
24755 time.
24756
24757 .cindex "hints database" "use for retrying"
24758 Retry times are hints rather than promises. Exim does not make any attempt to
24759 run deliveries exactly at the computed times. Instead, a queue runner process
24760 starts delivery processes for delayed messages periodically, and these attempt
24761 new deliveries only for those addresses that have passed their next retry time.
24762 If a new message arrives for a deferred address, an immediate delivery attempt
24763 occurs only if the address has passed its retry time. In the absence of new
24764 messages, the minimum time between retries is the interval between queue runner
24765 processes. There is not much point in setting retry times of five minutes if
24766 your queue runners happen only once an hour, unless there are a significant
24767 number of incoming messages (which might be the case on a system that is
24768 sending everything to a smart host, for example).
24769
24770 The data in the retry hints database can be inspected by using the
24771 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24772 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24773 &'exinext'& utility script can be used to find out what the next retry times
24774 are for the hosts associated with a particular mail domain, and also for local
24775 deliveries that have been deferred.
24776
24777
24778 .section "Retry rule examples" "SECID164"
24779 Here are some example retry rules:
24780 .code
24781 alice@wonderland.fict.example quota_5d  F,7d,3h
24782 wonderland.fict.example       quota_5d
24783 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24784 lookingglass.fict.example     *         F,24h,30m;
24785 *                 refused_A   F,2h,20m;
24786 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24787 .endd
24788 The first rule sets up special handling for mail to
24789 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24790 mailbox has not been read for at least 5 days. Retries continue every three
24791 hours for 7 days. The second rule handles over-quota errors for all other local
24792 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24793 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24794 fail are bounced immediately if the mailbox has not been read for at least 5
24795 days.
24796
24797 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24798 happen every 15 minutes for an hour, then with geometrically increasing
24799 intervals until two days have passed since a delivery first failed. After the
24800 first hour there is a delay of one hour, then two hours, then four hours, and
24801 so on (this is a rather extreme example).
24802
24803 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24804 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24805 all other domains, with special action for connection refusal from hosts that
24806 were not obtained from an MX record.
24807
24808 The final rule in a retry configuration should always have asterisks in the
24809 first two fields so as to provide a general catch-all for any addresses that do
24810 not have their own special handling. This example tries every 15 minutes for 2
24811 hours, then with intervals starting at one hour and increasing by a factor of
24812 1.5 up to 16 hours, then every 8 hours up to 5 days.
24813
24814
24815
24816 .section "Timeout of retry data" "SECID165"
24817 .cindex "timeout" "of retry data"
24818 .oindex "&%retry_data_expire%&"
24819 .cindex "hints database" "data expiry"
24820 .cindex "retry" "timeout of data"
24821 Exim timestamps the data that it writes to its retry hints database. When it
24822 consults the data during a delivery it ignores any that is older than the value
24823 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24824 been tried for 7 days, Exim will try to deliver to it immediately a message
24825 arrives, and if that fails, it will calculate a retry time as if it were
24826 failing for the first time.
24827
24828 This improves the behaviour for messages routed to rarely-used hosts such as MX
24829 backups. If such a host was down at one time, and happens to be down again when
24830 Exim tries a month later, using the old retry data would imply that it had been
24831 down all the time, which is not a justified assumption.
24832
24833 If a host really is permanently dead, this behaviour causes a burst of retries
24834 every now and again, but only if messages routed to it are rare. If there is a
24835 message at least once every 7 days the retry data never expires.
24836
24837
24838
24839
24840 .section "Long-term failures" "SECID166"
24841 .cindex "delivery failure, long-term"
24842 .cindex "retry" "after long-term failure"
24843 Special processing happens when an email address has been failing for so long
24844 that the cutoff time for the last algorithm is reached. For example, using the
24845 default retry rule:
24846 .code
24847 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24848 .endd
24849 the cutoff time is four days. Reaching the retry cutoff is independent of how
24850 long any specific message has been failing; it is the length of continuous
24851 failure for the recipient address that counts.
24852
24853 When the cutoff time is reached for a local delivery, or for all the IP
24854 addresses associated with a remote delivery, a subsequent delivery failure
24855 causes Exim to give up on the address, and a bounce message is generated.
24856 In order to cater for new messages that use the failing address, a next retry
24857 time is still computed from the final algorithm, and is used as follows:
24858
24859 For local deliveries, one delivery attempt is always made for any subsequent
24860 messages. If this delivery fails, the address fails immediately. The
24861 post-cutoff retry time is not used.
24862
24863 If the delivery is remote, there are two possibilities, controlled by the
24864 .oindex "&%delay_after_cutoff%&"
24865 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24866 default. Until the post-cutoff retry time for one of the IP addresses is
24867 reached, the failing email address is bounced immediately, without a delivery
24868 attempt taking place. After that time, one new delivery attempt is made to
24869 those IP addresses that are past their retry times, and if that still fails,
24870 the address is bounced and new retry times are computed.
24871
24872 In other words, when all the hosts for a given email address have been failing
24873 for a long time, Exim bounces rather then defers until one of the hosts' retry
24874 times is reached. Then it tries once, and bounces if that attempt fails. This
24875 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24876 to a broken destination, but if the host does recover, Exim will eventually
24877 notice.
24878
24879 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24880 addresses are past their final cutoff time, Exim tries to deliver to those IP
24881 addresses that have not been tried since the message arrived. If there are
24882 no suitable IP addresses, or if they all fail, the address is bounced. In other
24883 words, it does not delay when a new message arrives, but tries the expired
24884 addresses immediately, unless they have been tried since the message arrived.
24885 If there is a continuous stream of messages for the failing domains, setting
24886 &%delay_after_cutoff%& false means that there will be many more attempts to
24887 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24888 true.
24889
24890 .section "Deliveries that work intermittently" "SECID167"
24891 .cindex "retry" "intermittently working deliveries"
24892 Some additional logic is needed to cope with cases where a host is
24893 intermittently available, or when a message has some attribute that prevents
24894 its delivery when others to the same address get through. In this situation,
24895 because some messages are successfully delivered, the &"retry clock"& for the
24896 host or address keeps getting reset by the successful deliveries, and so
24897 failing messages remain on the queue for ever because the cutoff time is never
24898 reached.
24899
24900 Two exceptional actions are applied to prevent this happening. The first
24901 applies to errors that are related to a message rather than a remote host.
24902 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24903 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24904 commands, and quota failures. For this type of error, if a message's arrival
24905 time is earlier than the &"first failed"& time for the error, the earlier time
24906 is used when scanning the retry rules to decide when to try next and when to
24907 time out the address.
24908
24909 The exceptional second action applies in all cases. If a message has been on
24910 the queue for longer than the cutoff time of any applicable retry rule for a
24911 given address, a delivery is attempted for that address, even if it is not yet
24912 time, and if this delivery fails, the address is timed out. A new retry time is
24913 not computed in this case, so that other messages for the same address are
24914 considered immediately.
24915 .ecindex IIDretconf1
24916 .ecindex IIDregconf2
24917
24918
24919
24920
24921
24922
24923 . ////////////////////////////////////////////////////////////////////////////
24924 . ////////////////////////////////////////////////////////////////////////////
24925
24926 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24927 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24928 .scindex IIDauthconf2 "authentication"
24929 The &"authenticators"& section of Exim's run time configuration is concerned
24930 with SMTP authentication. This facility is an extension to the SMTP protocol,
24931 described in RFC 2554, which allows a client SMTP host to authenticate itself
24932 to a server. This is a common way for a server to recognize clients that are
24933 permitted to use it as a relay. SMTP authentication is not of relevance to the
24934 transfer of mail between servers that have no managerial connection with each
24935 other.
24936
24937 .cindex "AUTH" "description of"
24938 Very briefly, the way SMTP authentication works is as follows:
24939
24940 .ilist
24941 The server advertises a number of authentication &'mechanisms'& in response to
24942 the client's EHLO command.
24943 .next
24944 The client issues an AUTH command, naming a specific mechanism. The command
24945 may, optionally, contain some authentication data.
24946 .next
24947 The server may issue one or more &'challenges'&, to which the client must send
24948 appropriate responses. In simple authentication mechanisms, the challenges are
24949 just prompts for user names and passwords. The server does not have to issue
24950 any challenges &-- in some mechanisms the relevant data may all be transmitted
24951 with the AUTH command.
24952 .next
24953 The server either accepts or denies authentication.
24954 .next
24955 If authentication succeeds, the client may optionally make use of the AUTH
24956 option on the MAIL command to pass an authenticated sender in subsequent
24957 mail transactions. Authentication lasts for the remainder of the SMTP
24958 connection.
24959 .next
24960 If authentication fails, the client may give up, or it may try a different
24961 authentication mechanism, or it may try transferring mail over the
24962 unauthenticated connection.
24963 .endlist
24964
24965 If you are setting up a client, and want to know which authentication
24966 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24967 SMTP port) on the server, and issue an EHLO command. The response to this
24968 includes the list of supported mechanisms. For example:
24969 .display
24970 &`$ `&&*&`telnet server.example 25`&*&
24971 &`Trying 192.168.34.25...`&
24972 &`Connected to server.example.`&
24973 &`Escape character is &#x0027;^]&#x0027;.`&
24974 &`220 server.example ESMTP Exim 4.20 ...`&
24975 &*&`ehlo client.example`&*&
24976 &`250-server.example Hello client.example [10.8.4.5]`&
24977 &`250-SIZE 52428800`&
24978 &`250-PIPELINING`&
24979 &`250-AUTH PLAIN`&
24980 &`250 HELP`&
24981 .endd
24982 The second-last line of this example output shows that the server supports
24983 authentication using the PLAIN mechanism. In Exim, the different authentication
24984 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24985 routers and transports, which authenticators are included in the binary is
24986 controlled by build-time definitions. The following are currently available,
24987 included by setting
24988 .code
24989 AUTH_CRAM_MD5=yes
24990 AUTH_CYRUS_SASL=yes
24991 AUTH_DOVECOT=yes
24992 AUTH_GSASL=yes
24993 AUTH_HEIMDAL_GSSAPI=yes
24994 AUTH_PLAINTEXT=yes
24995 AUTH_SPA=yes
24996 AUTH_TLS=yes
24997 .endd
24998 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24999 authentication mechanism (RFC 2195), and the second provides an interface to
25000 the Cyrus SASL authentication library.
25001 The third is an interface to Dovecot's authentication system, delegating the
25002 work via a socket interface.
25003 The fourth provides an interface to the GNU SASL authentication library, which
25004 provides mechanisms but typically not data sources.
25005 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25006 supporting setting a server keytab.
25007 The sixth can be configured to support
25008 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25009 not formally documented, but used by several MUAs. The seventh authenticator
25010 supports Microsoft's &'Secure Password Authentication'& mechanism.
25011 The eighth is an Exim authenticator but not an SMTP one;
25012 instead it can use information from a TLS negotiation.
25013
25014 The authenticators are configured using the same syntax as other drivers (see
25015 section &<<SECTfordricon>>&). If no authenticators are required, no
25016 authentication section need be present in the configuration file. Each
25017 authenticator can in principle have both server and client functions. When Exim
25018 is receiving SMTP mail, it is acting as a server; when it is sending out
25019 messages over SMTP, it is acting as a client. Authenticator configuration
25020 options are provided for use in both these circumstances.
25021
25022 To make it clear which options apply to which situation, the prefixes
25023 &%server_%& and &%client_%& are used on option names that are specific to
25024 either the server or the client function, respectively. Server and client
25025 functions are disabled if none of their options are set. If an authenticator is
25026 to be used for both server and client functions, a single definition, using
25027 both sets of options, is required. For example:
25028 .code
25029 cram:
25030   driver = cram_md5
25031   public_name = CRAM-MD5
25032   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25033   client_name = ph10
25034   client_secret = secret2
25035 .endd
25036 The &%server_%& option is used when Exim is acting as a server, and the
25037 &%client_%& options when it is acting as a client.
25038
25039 Descriptions of the individual authenticators are given in subsequent chapters.
25040 The remainder of this chapter covers the generic options for the
25041 authenticators, followed by general discussion of the way authentication works
25042 in Exim.
25043
25044 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25045 per-mechanism basis.  Please read carefully to determine which variables hold
25046 account labels such as usercodes and which hold passwords or other
25047 authenticating data.
25048
25049 Note that some mechanisms support two different identifiers for accounts: the
25050 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25051 and &'authz'& are commonly encountered.  The American spelling is standard here.
25052 Conceptually, authentication data such as passwords are tied to the identifier
25053 used to authenticate; servers may have rules to permit one user to act as a
25054 second user, so that after login the session is treated as though that second
25055 user had logged in.  That second user is the &'authorization id'&.  A robust
25056 configuration might confirm that the &'authz'& field is empty or matches the
25057 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25058 as verified data, the &'authz'& as an unverified request which the server might
25059 choose to honour.
25060
25061 A &'realm'& is a text string, typically a domain name, presented by a server
25062 to a client to help it select an account and credentials to use.  In some
25063 mechanisms, the client and server provably agree on the realm, but clients
25064 typically can not treat the realm as secure data to be blindly trusted.
25065
25066
25067
25068 .section "Generic options for authenticators" "SECID168"
25069 .cindex "authentication" "generic options"
25070 .cindex "options" "generic; for authenticators"
25071
25072 .option client_condition authenticators string&!! unset
25073 When Exim is authenticating as a client, it skips any authenticator whose
25074 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25075 used, for example, to skip plain text authenticators when the connection is not
25076 encrypted by a setting such as:
25077 .code
25078 client_condition = ${if !eq{$tls_out_cipher}{}}
25079 .endd
25080
25081
25082 .option client_set_id authenticators string&!! unset
25083 When client authentication succeeds, this condition is expanded; the
25084 result is used in the log lines for outbound messages.
25085 Typically it will be the user name used for authentication.
25086
25087
25088 .option driver authenticators string unset
25089 This option must always be set. It specifies which of the available
25090 authenticators is to be used.
25091
25092
25093 .option public_name authenticators string unset
25094 This option specifies the name of the authentication mechanism that the driver
25095 implements, and by which it is known to the outside world. These names should
25096 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25097 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25098 defaults to the driver's instance name.
25099
25100
25101 .option server_advertise_condition authenticators string&!! unset
25102 When a server is about to advertise an authentication mechanism, the condition
25103 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25104 mechanism is not advertised.
25105 If the expansion fails, the mechanism is not advertised. If the failure was not
25106 forced, and was not caused by a lookup defer, the incident is logged.
25107 See section &<<SECTauthexiser>>& below for further discussion.
25108
25109
25110 .option server_condition authenticators string&!! unset
25111 This option must be set for a &%plaintext%& server authenticator, where it
25112 is used directly to control authentication. See section &<<SECTplainserver>>&
25113 for details.
25114
25115 For the &(gsasl)& authenticator, this option is required for various
25116 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25117
25118 For the other authenticators, &%server_condition%& can be used as an additional
25119 authentication or authorization mechanism that is applied after the other
25120 authenticator conditions succeed. If it is set, it is expanded when the
25121 authenticator would otherwise return a success code. If the expansion is forced
25122 to fail, authentication fails. Any other expansion failure causes a temporary
25123 error code to be returned. If the result of a successful expansion is an empty
25124 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25125 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25126 other result, a temporary error code is returned, with the expanded string as
25127 the error text.
25128
25129
25130 .option server_debug_print authenticators string&!! unset
25131 If this option is set and authentication debugging is enabled (see the &%-d%&
25132 command line option), the string is expanded and included in the debugging
25133 output when the authenticator is run as a server. This can help with checking
25134 out the values of variables.
25135 If expansion of the string fails, the error message is written to the debugging
25136 output, and Exim carries on processing.
25137
25138
25139 .option server_set_id authenticators string&!! unset
25140 .vindex "&$authenticated_id$&"
25141 When an Exim server successfully authenticates a client, this string is
25142 expanded using data from the authentication, and preserved for any incoming
25143 messages in the variable &$authenticated_id$&. It is also included in the log
25144 lines for incoming messages. For example, a user/password authenticator
25145 configuration might preserve the user name that was used to authenticate, and
25146 refer to it subsequently during delivery of the message.
25147 If expansion fails, the option is ignored.
25148
25149
25150 .option server_mail_auth_condition authenticators string&!! unset
25151 This option allows a server to discard authenticated sender addresses supplied
25152 as part of MAIL commands in SMTP connections that are authenticated by the
25153 driver on which &%server_mail_auth_condition%& is set. The option is not used
25154 as part of the authentication process; instead its (unexpanded) value is
25155 remembered for later use.
25156 How it is used is described in the following section.
25157
25158
25159
25160
25161
25162 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25163 .cindex "authentication" "sender; authenticated"
25164 .cindex "AUTH" "on MAIL command"
25165 When a client supplied an AUTH= item on a MAIL command, Exim applies
25166 the following checks before accepting it as the authenticated sender of the
25167 message:
25168
25169 .ilist
25170 If the connection is not using extended SMTP (that is, HELO was used rather
25171 than EHLO), the use of AUTH= is a syntax error.
25172 .next
25173 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25174 .next
25175 .vindex "&$authenticated_sender$&"
25176 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25177 running, the value of &$authenticated_sender$& is set to the value obtained
25178 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25179 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25180 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25181 given for the MAIL command.
25182 .next
25183 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25184 is accepted and placed in &$authenticated_sender$& only if the client has
25185 authenticated.
25186 .next
25187 If the AUTH= value was accepted by either of the two previous rules, and
25188 the client has authenticated, and the authenticator has a setting for the
25189 &%server_mail_auth_condition%&, the condition is checked at this point. The
25190 valued that was saved from the authenticator is expanded. If the expansion
25191 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25192 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25193 the value of &$authenticated_sender$& is retained and passed on with the
25194 message.
25195 .endlist
25196
25197
25198 When &$authenticated_sender$& is set for a message, it is passed on to other
25199 hosts to which Exim authenticates as a client. Do not confuse this value with
25200 &$authenticated_id$&, which is a string obtained from the authentication
25201 process, and which is not usually a complete email address.
25202
25203 .vindex "&$sender_address$&"
25204 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25205 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25206 therefore make use of &$authenticated_sender$&. The converse is not true: the
25207 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25208 ACL is run.
25209
25210
25211
25212 .section "Authentication on an Exim server" "SECTauthexiser"
25213 .cindex "authentication" "on an Exim server"
25214 When Exim receives an EHLO command, it advertises the public names of those
25215 authenticators that are configured as servers, subject to the following
25216 conditions:
25217
25218 .ilist
25219 The client host must match &%auth_advertise_hosts%& (default *).
25220 .next
25221 It the &%server_advertise_condition%& option is set, its expansion must not
25222 yield the empty string, &"0"&, &"no"&, or &"false"&.
25223 .endlist
25224
25225 The order in which the authenticators are defined controls the order in which
25226 the mechanisms are advertised.
25227
25228 Some mail clients (for example, some versions of Netscape) require the user to
25229 provide a name and password for authentication whenever AUTH is advertised,
25230 even though authentication may not in fact be needed (for example, Exim may be
25231 set up to allow unconditional relaying from the client by an IP address check).
25232 You can make such clients more friendly by not advertising AUTH to them.
25233 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25234 that runs for RCPT) to relay without authentication, you should set
25235 .code
25236 auth_advertise_hosts = ! 10.9.8.0/24
25237 .endd
25238 so that no authentication mechanisms are advertised to them.
25239
25240 The &%server_advertise_condition%& controls the advertisement of individual
25241 authentication mechanisms. For example, it can be used to restrict the
25242 advertisement of a particular mechanism to encrypted connections, by a setting
25243 such as:
25244 .code
25245 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25246 .endd
25247 .vindex "&$tls_in_cipher$&"
25248 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25249 yields &"yes"&, which allows the advertisement to happen.
25250
25251 When an Exim server receives an AUTH command from a client, it rejects it
25252 immediately if AUTH was not advertised in response to an earlier EHLO
25253 command. This is the case if
25254
25255 .ilist
25256 The client host does not match &%auth_advertise_hosts%&; or
25257 .next
25258 No authenticators are configured with server options; or
25259 .next
25260 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25261 server authenticators.
25262 .endlist
25263
25264
25265 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25266 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25267 AUTH is accepted from any client host.
25268
25269 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25270 server authentication mechanism that was advertised in response to EHLO and
25271 that matches the one named in the AUTH command. If it finds one, it runs
25272 the appropriate authentication protocol, and authentication either succeeds or
25273 fails. If there is no matching advertised mechanism, the AUTH command is
25274 rejected with a 504 error.
25275
25276 .vindex "&$received_protocol$&"
25277 .vindex "&$sender_host_authenticated$&"
25278 When a message is received from an authenticated host, the value of
25279 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25280 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25281 public name) of the authenticator driver that successfully authenticated the
25282 client from which the message was received. This variable is empty if there was
25283 no successful authentication.
25284
25285
25286
25287
25288 .section "Testing server authentication" "SECID169"
25289 .cindex "authentication" "testing a server"
25290 .cindex "AUTH" "testing a server"
25291 .cindex "base64 encoding" "creating authentication test data"
25292 Exim's &%-bh%& option can be useful for testing server authentication
25293 configurations. The data for the AUTH command has to be sent using base64
25294 encoding. A quick way to produce such data for testing is the following Perl
25295 script:
25296 .code
25297 use MIME::Base64;
25298 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25299 .endd
25300 .cindex "binary zero" "in authentication data"
25301 This interprets its argument as a Perl string, and then encodes it. The
25302 interpretation as a Perl string allows binary zeros, which are required for
25303 some kinds of authentication, to be included in the data. For example, a
25304 command line to run this script on such data might be
25305 .code
25306 encode '\0user\0password'
25307 .endd
25308 Note the use of single quotes to prevent the shell interpreting the
25309 backslashes, so that they can be interpreted by Perl to specify characters
25310 whose code value is zero.
25311
25312 &*Warning 1*&: If either of the user or password strings starts with an octal
25313 digit, you must use three zeros instead of one after the leading backslash. If
25314 you do not, the octal digit that starts your string will be incorrectly
25315 interpreted as part of the code for the first character.
25316
25317 &*Warning 2*&: If there are characters in the strings that Perl interprets
25318 specially, you must use a Perl escape to prevent them being misinterpreted. For
25319 example, a command such as
25320 .code
25321 encode '\0user@domain.com\0pas$$word'
25322 .endd
25323 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25324
25325 If you have the &%mimencode%& command installed, another way to do produce
25326 base64-encoded strings is to run the command
25327 .code
25328 echo -e -n `\0user\0password' | mimencode
25329 .endd
25330 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25331 in the argument, and the &%-n%& option specifies no newline at the end of its
25332 output. However, not all versions of &%echo%& recognize these options, so you
25333 should check your version before relying on this suggestion.
25334
25335
25336
25337 .section "Authentication by an Exim client" "SECID170"
25338 .cindex "authentication" "on an Exim client"
25339 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25340 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25341 announces support for authentication, and the host matches an entry in either
25342 of these options, Exim (as a client) tries to authenticate as follows:
25343
25344 .ilist
25345 For each authenticator that is configured as a client, in the order in which
25346 they are defined in the configuration, it searches the authentication
25347 mechanisms announced by the server for one whose name matches the public name
25348 of the authenticator.
25349 .next
25350 .vindex "&$host$&"
25351 .vindex "&$host_address$&"
25352 When it finds one that matches, it runs the authenticator's client code. The
25353 variables &$host$& and &$host_address$& are available for any string expansions
25354 that the client might do. They are set to the server's name and IP address. If
25355 any expansion is forced to fail, the authentication attempt is abandoned, and
25356 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25357 delivery to be deferred.
25358 .next
25359 If the result of the authentication attempt is a temporary error or a timeout,
25360 Exim abandons trying to send the message to the host for the moment. It will
25361 try again later. If there are any backup hosts available, they are tried in the
25362 usual way.
25363 .next
25364 If the response to authentication is a permanent error (5&'xx'& code), Exim
25365 carries on searching the list of authenticators and tries another one if
25366 possible. If all authentication attempts give permanent errors, or if there are
25367 no attempts because no mechanisms match (or option expansions force failure),
25368 what happens depends on whether the host matches &%hosts_require_auth%& or
25369 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25370 delivery is deferred. The error can be detected in the retry rules, and thereby
25371 turned into a permanent error if you wish. In the second case, Exim tries to
25372 deliver the message unauthenticated.
25373 .endlist
25374
25375 .cindex "AUTH" "on MAIL command"
25376 When Exim has authenticated itself to a remote server, it adds the AUTH
25377 parameter to the MAIL commands it sends, if it has an authenticated sender for
25378 the message. If the message came from a remote host, the authenticated sender
25379 is the one that was receiving on an incoming MAIL command, provided that the
25380 incoming connection was authenticated and the &%server_mail_auth%& condition
25381 allowed the authenticated sender to be retained. If a local process calls Exim
25382 to send a message, the sender address that is built from the login name and
25383 &%qualify_domain%& is treated as authenticated. However, if the
25384 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25385 the authenticated sender that was received with the message.
25386 .ecindex IIDauthconf1
25387 .ecindex IIDauthconf2
25388
25389
25390
25391
25392
25393
25394 . ////////////////////////////////////////////////////////////////////////////
25395 . ////////////////////////////////////////////////////////////////////////////
25396
25397 .chapter "The plaintext authenticator" "CHAPplaintext"
25398 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25399 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25400 The &(plaintext)& authenticator can be configured to support the PLAIN and
25401 LOGIN authentication mechanisms, both of which transfer authentication data as
25402 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25403 security risk; you are strongly advised to insist on the use of SMTP encryption
25404 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25405 use unencrypted plain text, you should not use the same passwords for SMTP
25406 connections as you do for login accounts.
25407
25408 .section "Plaintext options" "SECID171"
25409 .cindex "options" "&(plaintext)& authenticator (server)"
25410 When configured as a server, &(plaintext)& uses the following options:
25411
25412 .option server_condition authenticators string&!! unset
25413 This is actually a global authentication option, but it must be set in order to
25414 configure the &(plaintext)& driver as a server. Its use is described below.
25415
25416 .option server_prompts plaintext string&!! unset
25417 The contents of this option, after expansion, must be a colon-separated list of
25418 prompt strings. If expansion fails, a temporary authentication rejection is
25419 given.
25420
25421 .section "Using plaintext in a server" "SECTplainserver"
25422 .cindex "AUTH" "in &(plaintext)& authenticator"
25423 .cindex "binary zero" "in &(plaintext)& authenticator"
25424 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25425         "in &(plaintext)& authenticator"
25426 .vindex "&$auth1$&, &$auth2$&, etc"
25427 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25428
25429 When running as a server, &(plaintext)& performs the authentication test by
25430 expanding a string. The data sent by the client with the AUTH command, or in
25431 response to subsequent prompts, is base64 encoded, and so may contain any byte
25432 values when decoded. If any data is supplied with the command, it is treated as
25433 a list of strings, separated by NULs (binary zeros), the first three of which
25434 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25435 (neither LOGIN nor PLAIN uses more than three strings).
25436
25437 For compatibility with previous releases of Exim, the values are also placed in
25438 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25439 variables for this purpose is now deprecated, as it can lead to confusion in
25440 string expansions that also use them for other things.
25441
25442 If there are more strings in &%server_prompts%& than the number of strings
25443 supplied with the AUTH command, the remaining prompts are used to obtain more
25444 data. Each response from the client may be a list of NUL-separated strings.
25445
25446 .vindex "&$authenticated_id$&"
25447 Once a sufficient number of data strings have been received,
25448 &%server_condition%& is expanded. If the expansion is forced to fail,
25449 authentication fails. Any other expansion failure causes a temporary error code
25450 to be returned. If the result of a successful expansion is an empty string,
25451 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25452 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25453 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25454 For any other result, a temporary error code is returned, with the expanded
25455 string as the error text
25456
25457 &*Warning*&: If you use a lookup in the expansion to find the user's
25458 password, be sure to make the authentication fail if the user is unknown.
25459 There are good and bad examples at the end of the next section.
25460
25461
25462
25463 .section "The PLAIN authentication mechanism" "SECID172"
25464 .cindex "PLAIN authentication mechanism"
25465 .cindex "authentication" "PLAIN mechanism"
25466 .cindex "binary zero" "in &(plaintext)& authenticator"
25467 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25468 sent as one item of data (that is, one combined string containing two NUL
25469 separators). The data is sent either as part of the AUTH command, or
25470 subsequently in response to an empty prompt from the server.
25471
25472 The second and third strings are a user name and a corresponding password.
25473 Using a single fixed user name and password as an example, this could be
25474 configured as follows:
25475 .code
25476 fixed_plain:
25477   driver = plaintext
25478   public_name = PLAIN
25479   server_prompts = :
25480   server_condition = \
25481     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25482   server_set_id = $auth2
25483 .endd
25484 Note that the default result strings from &%if%& (&"true"& or an empty string)
25485 are exactly what we want here, so they need not be specified. Obviously, if the
25486 password contains expansion-significant characters such as dollar, backslash,
25487 or closing brace, they have to be escaped.
25488
25489 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25490 the end of a string list are ignored). If all the data comes as part of the
25491 AUTH command, as is commonly the case, the prompt is not used. This
25492 authenticator is advertised in the response to EHLO as
25493 .code
25494 250-AUTH PLAIN
25495 .endd
25496 and a client host can authenticate itself by sending the command
25497 .code
25498 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25499 .endd
25500 As this contains three strings (more than the number of prompts), no further
25501 data is required from the client. Alternatively, the client may just send
25502 .code
25503 AUTH PLAIN
25504 .endd
25505 to initiate authentication, in which case the server replies with an empty
25506 prompt. The client must respond with the combined data string.
25507
25508 The data string is base64 encoded, as required by the RFC. This example,
25509 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25510 represents a zero byte. This is split up into three strings, the first of which
25511 is empty. The &%server_condition%& option in the authenticator checks that the
25512 second two are &`username`& and &`mysecret`& respectively.
25513
25514 Having just one fixed user name and password, as in this example, is not very
25515 realistic, though for a small organization with only a handful of
25516 authenticating clients it could make sense.
25517
25518 A more sophisticated instance of this authenticator could use the user name in
25519 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25520 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25521 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25522 This is an incorrect example:
25523 .code
25524 server_condition = \
25525   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25526 .endd
25527 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25528 which it then compares to the supplied password (&$auth3$&). Why is this example
25529 incorrect? It works fine for existing users, but consider what happens if a
25530 non-existent user name is given. The lookup fails, but as no success/failure
25531 strings are given for the lookup, it yields an empty string. Thus, to defeat
25532 the authentication, all a client has to do is to supply a non-existent user
25533 name and an empty password. The correct way of writing this test is:
25534 .code
25535 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25536   {${if eq{$value}{$auth3}}} {false}}
25537 .endd
25538 In this case, if the lookup succeeds, the result is checked; if the lookup
25539 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25540 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25541 always fails if its second argument is empty. However, the second way of
25542 writing the test makes the logic clearer.
25543
25544
25545 .section "The LOGIN authentication mechanism" "SECID173"
25546 .cindex "LOGIN authentication mechanism"
25547 .cindex "authentication" "LOGIN mechanism"
25548 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25549 in a number of programs. No data is sent with the AUTH command. Instead, a
25550 user name and password are supplied separately, in response to prompts. The
25551 plaintext authenticator can be configured to support this as in this example:
25552 .code
25553 fixed_login:
25554   driver = plaintext
25555   public_name = LOGIN
25556   server_prompts = User Name : Password
25557   server_condition = \
25558     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25559   server_set_id = $auth1
25560 .endd
25561 Because of the way plaintext operates, this authenticator accepts data supplied
25562 with the AUTH command (in contravention of the specification of LOGIN), but
25563 if the client does not supply it (as is the case for LOGIN clients), the prompt
25564 strings are used to obtain two data items.
25565
25566 Some clients are very particular about the precise text of the prompts. For
25567 example, Outlook Express is reported to recognize only &"Username:"& and
25568 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25569 strings. It uses the &%ldapauth%& expansion condition to check the user
25570 name and password by binding to an LDAP server:
25571 .code
25572 login:
25573   driver = plaintext
25574   public_name = LOGIN
25575   server_prompts = Username:: : Password::
25576   server_condition = ${if and{{ \
25577     !eq{}{$auth1} }{ \
25578     ldapauth{\
25579       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25580       pass=${quote:$auth2} \
25581       ldap://ldap.example.org/} }} }
25582   server_set_id = uid=$auth1,ou=people,o=example.org
25583 .endd
25584 We have to check that the username is not empty before using it, because LDAP
25585 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25586 operator to correctly quote the DN for authentication. However, the basic
25587 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25588 correct one to use for the password, because quoting is needed only to make
25589 the password conform to the Exim syntax. At the LDAP level, the password is an
25590 uninterpreted string.
25591
25592
25593 .section "Support for different kinds of authentication" "SECID174"
25594 A number of string expansion features are provided for the purpose of
25595 interfacing to different ways of user authentication. These include checking
25596 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25597 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25598 &<<SECTexpcond>>&.
25599
25600
25601
25602
25603 .section "Using plaintext in a client" "SECID175"
25604 .cindex "options" "&(plaintext)& authenticator (client)"
25605 The &(plaintext)& authenticator has two client options:
25606
25607 .option client_ignore_invalid_base64 plaintext boolean false
25608 If the client receives a server prompt that is not a valid base64 string,
25609 authentication is abandoned by default. However, if this option is set true,
25610 the error in the challenge is ignored and the client sends the response as
25611 usual.
25612
25613 .option client_send plaintext string&!! unset
25614 The string is a colon-separated list of authentication data strings. Each
25615 string is independently expanded before being sent to the server. The first
25616 string is sent with the AUTH command; any more strings are sent in response
25617 to prompts from the server. Before each string is expanded, the value of the
25618 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25619 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25620 way. Thus, the prompt that is received in response to sending the first string
25621 (with the AUTH command) can be used in the expansion of the second string, and
25622 so on. If an invalid base64 string is received when
25623 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25624 &$auth$&<&'n'&> variable.
25625
25626 &*Note*&: You cannot use expansion to create multiple strings, because
25627 splitting takes priority and happens first.
25628
25629 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25630 the data, further processing is applied to each string before it is sent. If
25631 there are any single circumflex characters in the string, they are converted to
25632 NULs. Should an actual circumflex be required as data, it must be doubled in
25633 the string.
25634
25635 This is an example of a client configuration that implements the PLAIN
25636 authentication mechanism with a fixed user name and password:
25637 .code
25638 fixed_plain:
25639   driver = plaintext
25640   public_name = PLAIN
25641   client_send = ^username^mysecret
25642 .endd
25643 The lack of colons means that the entire text is sent with the AUTH
25644 command, with the circumflex characters converted to NULs. A similar example
25645 that uses the LOGIN mechanism is:
25646 .code
25647 fixed_login:
25648   driver = plaintext
25649   public_name = LOGIN
25650   client_send = : username : mysecret
25651 .endd
25652 The initial colon means that the first string is empty, so no data is sent with
25653 the AUTH command itself. The remaining strings are sent in response to
25654 prompts.
25655 .ecindex IIDplaiauth1
25656 .ecindex IIDplaiauth2
25657
25658
25659
25660
25661 . ////////////////////////////////////////////////////////////////////////////
25662 . ////////////////////////////////////////////////////////////////////////////
25663
25664 .chapter "The cram_md5 authenticator" "CHID9"
25665 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25666 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25667 .cindex "CRAM-MD5 authentication mechanism"
25668 .cindex "authentication" "CRAM-MD5 mechanism"
25669 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25670 sends a challenge string to the client, and the response consists of a user
25671 name and the CRAM-MD5 digest of the challenge string combined with a secret
25672 string (password) which is known to both server and client. Thus, the secret
25673 is not sent over the network as plain text, which makes this authenticator more
25674 secure than &(plaintext)&. However, the downside is that the secret has to be
25675 available in plain text at either end.
25676
25677
25678 .section "Using cram_md5 as a server" "SECID176"
25679 .cindex "options" "&(cram_md5)& authenticator (server)"
25680 This authenticator has one server option, which must be set to configure the
25681 authenticator as a server:
25682
25683 .option server_secret cram_md5 string&!! unset
25684 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25685 When the server receives the client's response, the user name is placed in
25686 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25687 obtain the password for that user. The server then computes the CRAM-MD5 digest
25688 that the client should have sent, and checks that it received the correct
25689 string. If the expansion of &%server_secret%& is forced to fail, authentication
25690 fails. If the expansion fails for some other reason, a temporary error code is
25691 returned to the client.
25692
25693 For compatibility with previous releases of Exim, the user name is also placed
25694 in &$1$&. However, the use of this variables for this purpose is now
25695 deprecated, as it can lead to confusion in string expansions that also use
25696 numeric variables for other things.
25697
25698 For example, the following authenticator checks that the user name given by the
25699 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25700 user name, authentication fails.
25701 .code
25702 fixed_cram:
25703   driver = cram_md5
25704   public_name = CRAM-MD5
25705   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25706   server_set_id = $auth1
25707 .endd
25708 .vindex "&$authenticated_id$&"
25709 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25710 name in &$authenticated_id$&. A more typical configuration might look up the
25711 secret string in a file, using the user name as the key. For example:
25712 .code
25713 lookup_cram:
25714   driver = cram_md5
25715   public_name = CRAM-MD5
25716   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25717                   {$value}fail}
25718   server_set_id = $auth1
25719 .endd
25720 Note that this expansion explicitly forces failure if the lookup fails
25721 because &$auth1$& contains an unknown user name.
25722
25723 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25724 using the relevant libraries, you need to know the realm to specify in the
25725 lookup and then ask for the &"userPassword"& attribute for that user in that
25726 realm, with:
25727 .code
25728 cyrusless_crammd5:
25729   driver = cram_md5
25730   public_name = CRAM-MD5
25731   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25732                   dbmjz{/etc/sasldb2}{$value}fail}
25733   server_set_id = $auth1
25734 .endd
25735
25736 .section "Using cram_md5 as a client" "SECID177"
25737 .cindex "options" "&(cram_md5)& authenticator (client)"
25738 When used as a client, the &(cram_md5)& authenticator has two options:
25739
25740
25741
25742 .option client_name cram_md5 string&!! "the primary host name"
25743 This string is expanded, and the result used as the user name data when
25744 computing the response to the server's challenge.
25745
25746
25747 .option client_secret cram_md5 string&!! unset
25748 This option must be set for the authenticator to work as a client. Its value is
25749 expanded and the result used as the secret string when computing the response.
25750
25751
25752 .vindex "&$host$&"
25753 .vindex "&$host_address$&"
25754 Different user names and secrets can be used for different servers by referring
25755 to &$host$& or &$host_address$& in the options. Forced failure of either
25756 expansion string is treated as an indication that this authenticator is not
25757 prepared to handle this case. Exim moves on to the next configured client
25758 authenticator. Any other expansion failure causes Exim to give up trying to
25759 send the message to the current server.
25760
25761 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25762 strings, is:
25763 .code
25764 fixed_cram:
25765   driver = cram_md5
25766   public_name = CRAM-MD5
25767   client_name = ph10
25768   client_secret = secret
25769 .endd
25770 .ecindex IIDcramauth1
25771 .ecindex IIDcramauth2
25772
25773
25774
25775 . ////////////////////////////////////////////////////////////////////////////
25776 . ////////////////////////////////////////////////////////////////////////////
25777
25778 .chapter "The cyrus_sasl authenticator" "CHID10"
25779 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25780 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25781 .cindex "Cyrus" "SASL library"
25782 .cindex "Kerberos"
25783 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25784 Digital Ltd (&url(http://www.aldigital.co.uk)).
25785
25786 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25787 library implementation of the RFC 2222 (&"Simple Authentication and Security
25788 Layer"&). This library supports a number of authentication mechanisms,
25789 including PLAIN and LOGIN, but also several others that Exim does not support
25790 directly. In particular, there is support for Kerberos authentication.
25791
25792 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25793 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25794 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25795 name of the driver to determine which mechanism to support.
25796
25797 Where access to some kind of secret file is required, for example in GSSAPI
25798 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25799 user, and that the Cyrus SASL library has no way of escalating privileges
25800 by default. You may also find you need to set environment variables,
25801 depending on the driver you are using.
25802
25803 The application name provided by Exim is &"exim"&, so various SASL options may
25804 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25805 Kerberos, note that because of limitations in the GSSAPI interface,
25806 changing the server keytab might need to be communicated down to the Kerberos
25807 layer independently. The mechanism for doing so is dependent upon the Kerberos
25808 implementation.
25809
25810 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25811 may be set to point to an alternative keytab file. Exim will pass this
25812 variable through from its own inherited environment when started as root or the
25813 Exim user. The keytab file needs to be readable by the Exim user.
25814 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25815 environment variable.  In practice, for those releases, the Cyrus authenticator
25816 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25817 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25818
25819
25820 .section "Using cyrus_sasl as a server" "SECID178"
25821 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25822 (on a successful authentication) into &$auth1$&. For compatibility with
25823 previous releases of Exim, the username is also placed in &$1$&. However, the
25824 use of this variable for this purpose is now deprecated, as it can lead to
25825 confusion in string expansions that also use numeric variables for other
25826 things.
25827
25828
25829 .option server_hostname cyrus_sasl string&!! "see below"
25830 This option selects the hostname that is used when communicating with the
25831 library. The default value is &`$primary_hostname`&. It is up to the underlying
25832 SASL plug-in what it does with this data.
25833
25834
25835 .option server_mech cyrus_sasl string "see below"
25836 This option selects the authentication mechanism this driver should use. The
25837 default is the value of the generic &%public_name%& option. This option allows
25838 you to use a different underlying mechanism from the advertised name. For
25839 example:
25840 .code
25841 sasl:
25842   driver = cyrus_sasl
25843   public_name = X-ANYTHING
25844   server_mech = CRAM-MD5
25845   server_set_id = $auth1
25846 .endd
25847
25848 .option server_realm cyrus_sasl string&!! unset
25849 This specifies the SASL realm that the server claims to be in.
25850
25851
25852 .option server_service cyrus_sasl string &`smtp`&
25853 This is the SASL service that the server claims to implement.
25854
25855
25856 For straightforward cases, you do not need to set any of the authenticator's
25857 private options. All you need to do is to specify an appropriate mechanism as
25858 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25859 PLAIN, you could have two authenticators as follows:
25860 .code
25861 sasl_cram_md5:
25862   driver = cyrus_sasl
25863   public_name = CRAM-MD5
25864   server_set_id = $auth1
25865
25866 sasl_plain:
25867   driver = cyrus_sasl
25868   public_name = PLAIN
25869   server_set_id = $auth2
25870 .endd
25871 Cyrus SASL does implement the LOGIN authentication method, even though it is
25872 not a standard method. It is disabled by default in the source distribution,
25873 but it is present in many binary distributions.
25874 .ecindex IIDcyrauth1
25875 .ecindex IIDcyrauth2
25876
25877
25878
25879
25880 . ////////////////////////////////////////////////////////////////////////////
25881 . ////////////////////////////////////////////////////////////////////////////
25882 .chapter "The dovecot authenticator" "CHAPdovecot"
25883 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25884 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25885 This authenticator is an interface to the authentication facility of the
25886 Dovecot POP/IMAP server, which can support a number of authentication methods.
25887 Note that Dovecot must be configured to use auth-client not auth-userdb.
25888 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25889 to use the same mechanisms for SMTP authentication. This is a server
25890 authenticator only. There is only one option:
25891
25892 .option server_socket dovecot string unset
25893
25894 This option must specify the socket that is the interface to Dovecot
25895 authentication. The &%public_name%& option must specify an authentication
25896 mechanism that Dovecot is configured to support. You can have several
25897 authenticators for different mechanisms. For example:
25898 .code
25899 dovecot_plain:
25900   driver = dovecot
25901   public_name = PLAIN
25902   server_socket = /var/run/dovecot/auth-client
25903   server_set_id = $auth1
25904
25905 dovecot_ntlm:
25906   driver = dovecot
25907   public_name = NTLM
25908   server_socket = /var/run/dovecot/auth-client
25909   server_set_id = $auth1
25910 .endd
25911 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25912 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25913 option is passed in the Dovecot authentication command. If, for a TLS
25914 connection, a client certificate has been verified, the &"valid-client-cert"&
25915 option is passed. When authentication succeeds, the identity of the user
25916 who authenticated is placed in &$auth1$&.
25917 .ecindex IIDdcotauth1
25918 .ecindex IIDdcotauth2
25919
25920
25921 . ////////////////////////////////////////////////////////////////////////////
25922 . ////////////////////////////////////////////////////////////////////////////
25923 .chapter "The gsasl authenticator" "CHAPgsasl"
25924 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25925 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25926 .cindex "authentication" "GNU SASL"
25927 .cindex "authentication" "SASL"
25928 .cindex "authentication" "EXTERNAL"
25929 .cindex "authentication" "ANONYMOUS"
25930 .cindex "authentication" "PLAIN"
25931 .cindex "authentication" "LOGIN"
25932 .cindex "authentication" "DIGEST-MD5"
25933 .cindex "authentication" "CRAM-MD5"
25934 .cindex "authentication" "SCRAM-SHA-1"
25935 The &(gsasl)& authenticator provides server integration for the GNU SASL
25936 library and the mechanisms it provides.  This is new as of the 4.80 release
25937 and there are a few areas where the library does not let Exim smoothly
25938 scale to handle future authentication mechanisms, so no guarantee can be
25939 made that any particular new authentication mechanism will be supported
25940 without code changes in Exim.
25941
25942
25943 .option server_channelbinding gsasl boolean false
25944 Some authentication mechanisms are able to use external context at both ends
25945 of the session to bind the authentication to that context, and fail the
25946 authentication process if that context differs.  Specifically, some TLS
25947 ciphersuites can provide identifying information about the cryptographic
25948 context.
25949
25950 This means that certificate identity and verification becomes a non-issue,
25951 as a man-in-the-middle attack will cause the correct client and server to
25952 see different identifiers and authentication will fail.
25953
25954 This is currently only supported when using the GnuTLS library.  This is
25955 only usable by mechanisms which support "channel binding"; at time of
25956 writing, that's the SCRAM family.
25957
25958 This defaults off to ensure smooth upgrade across Exim releases, in case
25959 this option causes some clients to start failing.  Some future release
25960 of Exim may switch the default to be true.
25961
25962
25963 .option server_hostname gsasl string&!! "see below"
25964 This option selects the hostname that is used when communicating with the
25965 library. The default value is &`$primary_hostname`&.
25966 Some mechanisms will use this data.
25967
25968
25969 .option server_mech gsasl string "see below"
25970 This option selects the authentication mechanism this driver should use. The
25971 default is the value of the generic &%public_name%& option. This option allows
25972 you to use a different underlying mechanism from the advertised name. For
25973 example:
25974 .code
25975 sasl:
25976   driver = gsasl
25977   public_name = X-ANYTHING
25978   server_mech = CRAM-MD5
25979   server_set_id = $auth1
25980 .endd
25981
25982
25983 .option server_password gsasl string&!! unset
25984 Various mechanisms need access to the cleartext password on the server, so
25985 that proof-of-possession can be demonstrated on the wire, without sending
25986 the password itself.
25987
25988 The data available for lookup varies per mechanism.
25989 In all cases, &$auth1$& is set to the &'authentication id'&.
25990 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25991 if available, else the empty string.
25992 The &$auth3$& variable will always be the &'realm'& if available,
25993 else the empty string.
25994
25995 A forced failure will cause authentication to defer.
25996
25997 If using this option, it may make sense to set the &%server_condition%&
25998 option to be simply "true".
25999
26000
26001 .option server_realm gsasl string&!! unset
26002 This specifies the SASL realm that the server claims to be in.
26003 Some mechanisms will use this data.
26004
26005
26006 .option server_scram_iter gsasl string&!! unset
26007 This option provides data for the SCRAM family of mechanisms.
26008 &$auth1$& is not available at evaluation time.
26009 (This may change, as we receive feedback on use)
26010
26011
26012 .option server_scram_salt gsasl string&!! unset
26013 This option provides data for the SCRAM family of mechanisms.
26014 &$auth1$& is not available at evaluation time.
26015 (This may change, as we receive feedback on use)
26016
26017
26018 .option server_service gsasl string &`smtp`&
26019 This is the SASL service that the server claims to implement.
26020 Some mechanisms will use this data.
26021
26022
26023 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26024 .vindex "&$auth1$&, &$auth2$&, etc"
26025 These may be set when evaluating specific options, as detailed above.
26026 They will also be set when evaluating &%server_condition%&.
26027
26028 Unless otherwise stated below, the &(gsasl)& integration will use the following
26029 meanings for these variables:
26030
26031 .ilist
26032 .vindex "&$auth1$&"
26033 &$auth1$&: the &'authentication id'&
26034 .next
26035 .vindex "&$auth2$&"
26036 &$auth2$&: the &'authorization id'&
26037 .next
26038 .vindex "&$auth3$&"
26039 &$auth3$&: the &'realm'&
26040 .endlist
26041
26042 On a per-mechanism basis:
26043
26044 .ilist
26045 .cindex "authentication" "EXTERNAL"
26046 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26047 the &%server_condition%& option must be present.
26048 .next
26049 .cindex "authentication" "ANONYMOUS"
26050 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26051 the &%server_condition%& option must be present.
26052 .next
26053 .cindex "authentication" "GSSAPI"
26054 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26055 &$auth2$& will be set to the &'authorization id'&,
26056 the &%server_condition%& option must be present.
26057 .endlist
26058
26059 An &'anonymous token'& is something passed along as an unauthenticated
26060 identifier; this is analogous to FTP anonymous authentication passing an
26061 email address, or software-identifier@, as the "password".
26062
26063
26064 An example showing the password having the realm specified in the callback
26065 and demonstrating a Cyrus SASL to GSASL migration approach is:
26066 .code
26067 gsasl_cyrusless_crammd5:
26068   driver = gsasl
26069   public_name = CRAM-MD5
26070   server_realm = imap.example.org
26071   server_password = ${lookup{$auth1:$auth3:userPassword}\
26072                     dbmjz{/etc/sasldb2}{$value}fail}
26073   server_set_id = ${quote:$auth1}
26074   server_condition = yes
26075 .endd
26076
26077
26078 . ////////////////////////////////////////////////////////////////////////////
26079 . ////////////////////////////////////////////////////////////////////////////
26080
26081 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26082 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26083 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26084 .cindex "authentication" "GSSAPI"
26085 .cindex "authentication" "Kerberos"
26086 The &(heimdal_gssapi)& authenticator provides server integration for the
26087 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26088 reliably.
26089
26090 .option server_hostname heimdal_gssapi string&!! "see below"
26091 This option selects the hostname that is used, with &%server_service%&,
26092 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26093 identifier.  The default value is &`$primary_hostname`&.
26094
26095 .option server_keytab heimdal_gssapi string&!! unset
26096 If set, then Heimdal will not use the system default keytab (typically
26097 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26098 The value should be a pathname, with no &"file:"& prefix.
26099
26100 .option server_service heimdal_gssapi string&!! "smtp"
26101 This option specifies the service identifier used, in conjunction with
26102 &%server_hostname%&, for building the identifier for finding credentials
26103 from the keytab.
26104
26105
26106 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26107 Beware that these variables will typically include a realm, thus will appear
26108 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26109 not verified, so a malicious client can set it to anything.
26110
26111 The &$auth1$& field should be safely trustable as a value from the Key
26112 Distribution Center.  Note that these are not quite email addresses.
26113 Each identifier is for a role, and so the left-hand-side may include a
26114 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26115
26116 .vindex "&$auth1$&, &$auth2$&, etc"
26117 .ilist
26118 .vindex "&$auth1$&"
26119 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26120 .next
26121 .vindex "&$auth2$&"
26122 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26123 authentication.  If that was empty, this will also be set to the
26124 GSS Display Name.
26125 .endlist
26126
26127
26128 . ////////////////////////////////////////////////////////////////////////////
26129 . ////////////////////////////////////////////////////////////////////////////
26130
26131 .chapter "The spa authenticator" "CHAPspa"
26132 .scindex IIDspaauth1 "&(spa)& authenticator"
26133 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26134 .cindex "authentication" "Microsoft Secure Password"
26135 .cindex "authentication" "NTLM"
26136 .cindex "Microsoft Secure Password Authentication"
26137 .cindex "NTLM authentication"
26138 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26139 Password Authentication'& mechanism,
26140 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26141 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26142 taken from the Samba project (&url(http://www.samba.org)). The code for the
26143 server side was subsequently contributed by Tom Kistner. The mechanism works as
26144 follows:
26145
26146 .ilist
26147 After the AUTH command has been accepted, the client sends an SPA
26148 authentication request based on the user name and optional domain.
26149 .next
26150 The server sends back a challenge.
26151 .next
26152 The client builds a challenge response which makes use of the user's password
26153 and sends it to the server, which then accepts or rejects it.
26154 .endlist
26155
26156 Encryption is used to protect the password in transit.
26157
26158
26159
26160 .section "Using spa as a server" "SECID179"
26161 .cindex "options" "&(spa)& authenticator (server)"
26162 The &(spa)& authenticator has just one server option:
26163
26164 .option server_password spa string&!! unset
26165 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26166 This option is expanded, and the result must be the cleartext password for the
26167 authenticating user, whose name is at this point in &$auth1$&. For
26168 compatibility with previous releases of Exim, the user name is also placed in
26169 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26170 it can lead to confusion in string expansions that also use numeric variables
26171 for other things. For example:
26172 .code
26173 spa:
26174   driver = spa
26175   public_name = NTLM
26176   server_password = \
26177     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26178 .endd
26179 If the expansion is forced to fail, authentication fails. Any other expansion
26180 failure causes a temporary error code to be returned.
26181
26182
26183
26184
26185
26186 .section "Using spa as a client" "SECID180"
26187 .cindex "options" "&(spa)& authenticator (client)"
26188 The &(spa)& authenticator has the following client options:
26189
26190
26191
26192 .option client_domain spa string&!! unset
26193 This option specifies an optional domain for the authentication.
26194
26195
26196 .option client_password spa string&!! unset
26197 This option specifies the user's password, and must be set.
26198
26199
26200 .option client_username spa string&!! unset
26201 This option specifies the user name, and must be set. Here is an example of a
26202 configuration of this authenticator for use with the mail servers at
26203 &'msn.com'&:
26204 .code
26205 msn:
26206   driver = spa
26207   public_name = MSN
26208   client_username = msn/msn_username
26209   client_password = msn_plaintext_password
26210   client_domain = DOMAIN_OR_UNSET
26211 .endd
26212 .ecindex IIDspaauth1
26213 .ecindex IIDspaauth2
26214
26215
26216
26217
26218
26219 . ////////////////////////////////////////////////////////////////////////////
26220 . ////////////////////////////////////////////////////////////////////////////
26221
26222 .chapter "The tls authenticator" "CHAPtlsauth"
26223 .scindex IIDtlsauth1 "&(tls)& authenticator"
26224 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26225 .cindex "authentication" "Client Certificate"
26226 .cindex "authentication" "X509"
26227 .cindex "Certificate-based authentication"
26228 The &(tls)& authenticator provides server support for
26229 authentication based on client certificates.
26230
26231 It is not an SMTP authentication mechanism and is not
26232 advertised by the server as part of the SMTP EHLO response.
26233 It is an Exim authenticator in the sense that it affects
26234 the protocol element of the log line, can be tested for
26235 by the &%authenticated%& ACL condition, and can set
26236 the &$authenticated_id$& variable.
26237
26238 The client must present a verifiable certificate,
26239 for which it must have been requested via the
26240 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26241 (see &<<CHAPTLS>>&).
26242
26243 If an authenticator of this type is configured it is
26244 run before any SMTP-level communication is done,
26245 and can authenticate the connection.
26246 If it does, SMTP authentication is not offered.
26247
26248 A maximum of one authenticator of this type may be present.
26249
26250
26251 .cindex "options" "&(tls)& authenticator (server)"
26252 The &(tls)& authenticator has three server options:
26253
26254 .option server_param1 tls string&!! unset
26255 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26256 This option is expanded after the TLS negotiation and
26257 the result is placed in &$auth1$&.
26258 If the expansion is forced to fail, authentication fails. Any other expansion
26259 failure causes a temporary error code to be returned.
26260
26261 .option server_param2 tls string&!! unset
26262 .option server_param3 tls string&!! unset
26263 As above, for &$auth2$& and &$auth3$&.
26264
26265 &%server_param1%& may also be spelled &%server_param%&.
26266
26267
26268 Example:
26269 .code
26270 tls:
26271   driver = tls
26272   server_param1 =     ${certextract {subj_altname,mail,>:} \
26273                                     {$tls_in_peercert}}
26274   server_condition =  ${if forany {$auth1} \
26275                             {!= {0} \
26276                                 {${lookup ldap{ldap:///\
26277                          mailname=${quote_ldap_dn:${lc:$item}},\
26278                          ou=users,LDAP_DC?mailid} {$value}{0} \
26279                        }    }   } }
26280   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26281 .endd
26282 .ecindex IIDtlsauth1
26283 .ecindex IIDtlsauth2
26284
26285
26286 Note that because authentication is traditionally an SMTP operation,
26287 the &%authenticated%& ACL condition cannot be used in
26288 a connect- or helo-ACL.
26289
26290
26291
26292 . ////////////////////////////////////////////////////////////////////////////
26293 . ////////////////////////////////////////////////////////////////////////////
26294
26295 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26296          "Encrypted SMTP connections"
26297 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26298 .scindex IIDencsmtp2 "SMTP" "encryption"
26299 .cindex "TLS" "on SMTP connection"
26300 .cindex "OpenSSL"
26301 .cindex "GnuTLS"
26302 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26303 Sockets Layer), is implemented by making use of the OpenSSL library or the
26304 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26305 cryptographic code in the Exim distribution itself for implementing TLS. In
26306 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26307 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26308 You also need to understand the basic concepts of encryption at a managerial
26309 level, and in particular, the way that public keys, private keys, and
26310 certificates are used.
26311
26312 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26313 connection is established, the client issues a STARTTLS command. If the
26314 server accepts this, the client and the server negotiate an encryption
26315 mechanism. If the negotiation succeeds, the data that subsequently passes
26316 between them is encrypted.
26317
26318 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26319 and if so, what cipher suite is in use, whether the client supplied a
26320 certificate, and whether or not that certificate was verified. This makes it
26321 possible for an Exim server to deny or accept certain commands based on the
26322 encryption state.
26323
26324 &*Warning*&: Certain types of firewall and certain anti-virus products can
26325 disrupt TLS connections. You need to turn off SMTP scanning for these products
26326 in order to get TLS to work.
26327
26328
26329
26330 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26331          "SECID284"
26332 .cindex "ssmtp protocol"
26333 .cindex "smtps protocol"
26334 .cindex "SMTP" "ssmtp protocol"
26335 .cindex "SMTP" "smtps protocol"
26336 Early implementations of encrypted SMTP used a different TCP port from normal
26337 SMTP, and expected an encryption negotiation to start immediately, instead of
26338 waiting for a STARTTLS command from the client using the standard SMTP
26339 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26340 allocated for this purpose.
26341
26342 This approach was abandoned when encrypted SMTP was standardized, but there are
26343 still some legacy clients that use it. Exim supports these clients by means of
26344 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26345 numbers; the most common use is expected to be:
26346 .code
26347 tls_on_connect_ports = 465
26348 .endd
26349 The port numbers specified by this option apply to all SMTP connections, both
26350 via the daemon and via &'inetd'&. You still need to specify all the ports that
26351 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26352 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26353 an extra port &-- rather, it specifies different behaviour on a port that is
26354 defined elsewhere.
26355
26356 There is also a &%-tls-on-connect%& command line option. This overrides
26357 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26358
26359
26360
26361
26362
26363
26364 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26365 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26366 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26367 followed later, when the first versions of GnuTLS were released. To build Exim
26368 to use GnuTLS, you need to set
26369 .code
26370 USE_GNUTLS=yes
26371 .endd
26372 in Local/Makefile, in addition to
26373 .code
26374 SUPPORT_TLS=yes
26375 .endd
26376 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26377 include files and libraries for GnuTLS can be found.
26378
26379 There are some differences in usage when using GnuTLS instead of OpenSSL:
26380
26381 .ilist
26382 The &%tls_verify_certificates%& option
26383 cannot be the path of a directory
26384 for GnuTLS versions before 3.3.6
26385 (for later versions, or OpenSSL, it can be either).
26386 .next
26387 The default value for &%tls_dhparam%& differs for historical reasons.
26388 .next
26389 .vindex "&$tls_in_peerdn$&"
26390 .vindex "&$tls_out_peerdn$&"
26391 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26392 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26393 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26394 .next
26395 OpenSSL identifies cipher suites using hyphens as separators, for example:
26396 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26397 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26398 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26399 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26400 to handle its own older variants) when processing lists of cipher suites in the
26401 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26402 option).
26403 .next
26404 The &%tls_require_ciphers%& options operate differently, as described in the
26405 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26406 .next
26407 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26408 When using OpenSSL, this option is ignored.
26409 (If an API is found to let OpenSSL be configured in this way,
26410 let the Exim Maintainers know and we'll likely use it).
26411 .next
26412 Some other recently added features may only be available in one or the other.
26413 This should be documented with the feature.  If the documentation does not
26414 explicitly state that the feature is infeasible in the other TLS
26415 implementation, then patches are welcome.
26416 .endlist
26417
26418
26419 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26420 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26421 an explicit path; if the latter, then the text about generation still applies,
26422 but not the chosen filename.
26423 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26424 See the documentation of &%tls_dhparam%& for more information.
26425
26426 GnuTLS uses D-H parameters that may take a substantial amount of time
26427 to compute. It is unreasonable to re-compute them for every TLS session.
26428 Therefore, Exim keeps this data in a file in its spool directory, called
26429 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26430 of bits requested.
26431 The file is owned by the Exim user and is readable only by
26432 its owner. Every Exim process that start up GnuTLS reads the D-H
26433 parameters from this file. If the file does not exist, the first Exim process
26434 that needs it computes the data and writes it to a temporary file which is
26435 renamed once it is complete. It does not matter if several Exim processes do
26436 this simultaneously (apart from wasting a few resources). Once a file is in
26437 place, new Exim processes immediately start using it.
26438
26439 For maximum security, the parameters that are stored in this file should be
26440 recalculated periodically, the frequency depending on your paranoia level.
26441 If you are avoiding using the fixed D-H primes published in RFCs, then you
26442 are concerned about some advanced attacks and will wish to do this; if you do
26443 not regenerate then you might as well stick to the standard primes.
26444
26445 Arranging this is easy in principle; just delete the file when you want new
26446 values to be computed. However, there may be a problem. The calculation of new
26447 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26448 If the system is not very active, &_/dev/random_& may delay returning data
26449 until enough randomness (entropy) is available. This may cause Exim to hang for
26450 a substantial amount of time, causing timeouts on incoming connections.
26451
26452 The solution is to generate the parameters externally to Exim. They are stored
26453 in &_gnutls-params-N_& in PEM format, which means that they can be
26454 generated externally using the &(certtool)& command that is part of GnuTLS.
26455
26456 To replace the parameters with new ones, instead of deleting the file
26457 and letting Exim re-create it, you can generate new parameters using
26458 &(certtool)& and, when this has been done, replace Exim's cache file by
26459 renaming. The relevant commands are something like this:
26460 .code
26461 # ls
26462 [ look for file; assume gnutls-params-2236 is the most recent ]
26463 # rm -f new-params
26464 # touch new-params
26465 # chown exim:exim new-params
26466 # chmod 0600 new-params
26467 # certtool --generate-dh-params --bits 2236 >>new-params
26468 # openssl dhparam -noout -text -in new-params | head
26469 [ check the first line, make sure it's not more than 2236;
26470   if it is, then go back to the start ("rm") and repeat
26471   until the size generated is at most the size requested ]
26472 # chmod 0400 new-params
26473 # mv new-params gnutls-params-2236
26474 .endd
26475 If Exim never has to generate the parameters itself, the possibility of
26476 stalling is removed.
26477
26478 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26479 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26480 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26481 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26482 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26483 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26484 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26485 which applies to all D-H usage, client or server.  If the value returned by
26486 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26487 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26488 limit, which is still much higher than Exim historically used.
26489
26490 The filename and bits used will change as the GnuTLS maintainers change the
26491 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26492 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26493 2432 bits, while NSS is limited to 2236 bits.
26494
26495 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26496 increase the chance of the generated prime actually being within acceptable
26497 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26498 procedure above.  There is no sane procedure available to Exim to double-check
26499 the size of the generated prime, so it might still be too large.
26500
26501
26502 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26503 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26504 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26505 There is a function in the OpenSSL library that can be passed a list of cipher
26506 suites before the cipher negotiation takes place. This specifies which ciphers
26507 are acceptable. The list is colon separated and may contain names like
26508 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26509 directly to this function call.
26510 Many systems will install the OpenSSL manual-pages, so you may have
26511 &'ciphers(1)'& available to you.
26512 The following quotation from the OpenSSL
26513 documentation specifies what forms of item are allowed in the cipher string:
26514
26515 .ilist
26516 It can consist of a single cipher suite such as RC4-SHA.
26517 .next
26518 It can represent a list of cipher suites containing a certain algorithm,
26519 or cipher suites of a certain type. For example SHA1 represents all
26520 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26521 SSL v3 algorithms.
26522 .next
26523 Lists of cipher suites can be combined in a single cipher string using
26524 the + character. This is used as a logical and operation. For example
26525 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26526 algorithms.
26527 .endlist
26528
26529 Each cipher string can be optionally preceded by one of the characters &`!`&,
26530 &`-`& or &`+`&.
26531 .ilist
26532 If &`!`& is used, the ciphers are permanently deleted from the list. The
26533 ciphers deleted can never reappear in the list even if they are explicitly
26534 stated.
26535 .next
26536 If &`-`& is used, the ciphers are deleted from the list, but some or all
26537 of the ciphers can be added again by later options.
26538 .next
26539 If &`+`& is used, the ciphers are moved to the end of the list. This
26540 option does not add any new ciphers; it just moves matching existing ones.
26541 .endlist
26542
26543 If none of these characters is present, the string is interpreted as
26544 a list of ciphers to be appended to the current preference list. If the list
26545 includes any ciphers already present they will be ignored: that is, they will
26546 not be moved to the end of the list.
26547 .endlist
26548
26549 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26550 string:
26551 .code
26552 # note single-quotes to get ! past any shell history expansion
26553 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26554 .endd
26555
26556 This example will let the library defaults be permitted on the MX port, where
26557 there's probably no identity verification anyway, but ups the ante on the
26558 submission ports where the administrator might have some influence on the
26559 choice of clients used:
26560 .code
26561 # OpenSSL variant; see man ciphers(1)
26562 tls_require_ciphers = ${if =={$received_port}{25}\
26563                            {DEFAULT}\
26564                            {HIGH:!MD5:!SHA1}}
26565 .endd
26566
26567
26568
26569 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26570          "SECTreqciphgnu"
26571 .cindex "GnuTLS" "specifying parameters for"
26572 .cindex "TLS" "specifying ciphers (GnuTLS)"
26573 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26574 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26575 .cindex "TLS" "specifying protocols (GnuTLS)"
26576 .cindex "TLS" "specifying priority string (GnuTLS)"
26577 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26578 The GnuTLS library allows the caller to provide a "priority string", documented
26579 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26580 ciphersuite specification in OpenSSL.
26581
26582 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26583 and controls both protocols and ciphers.
26584
26585 The &%tls_require_ciphers%& option is available both as an global option,
26586 controlling how Exim behaves as a server, and also as an option of the
26587 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26588 the value is string expanded.  The resulting string is not an Exim list and
26589 the string is given to the GnuTLS library, so that Exim does not need to be
26590 aware of future feature enhancements of GnuTLS.
26591
26592 Documentation of the strings accepted may be found in the GnuTLS manual, under
26593 "Priority strings".  This is online as
26594 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26595 but beware that this relates to GnuTLS 3, which may be newer than the version
26596 installed on your system.  If you are using GnuTLS 3,
26597 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26598 on that site can be used to test a given string.
26599
26600 For example:
26601 .code
26602 # Disable older versions of protocols
26603 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26604 .endd
26605
26606 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26607 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26608 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26609
26610 This example will let the library defaults be permitted on the MX port, where
26611 there's probably no identity verification anyway, and lowers security further
26612 by increasing compatibility; but this ups the ante on the submission ports
26613 where the administrator might have some influence on the choice of clients
26614 used:
26615 .code
26616 # GnuTLS variant
26617 tls_require_ciphers = ${if =={$received_port}{25}\
26618                            {NORMAL:%COMPAT}\
26619                            {SECURE128}}
26620 .endd
26621
26622
26623 .section "Configuring an Exim server to use TLS" "SECID182"
26624 .cindex "TLS" "configuring an Exim server"
26625 When Exim has been built with TLS support, it advertises the availability of
26626 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26627 but not to any others. The default value of this option is unset, which means
26628 that STARTTLS is not advertised at all. This default is chosen because you
26629 need to set some other options in order to make TLS available, and also it is
26630 sensible for systems that want to use TLS only as a client.
26631
26632 If a client issues a STARTTLS command and there is some configuration
26633 problem in the server, the command is rejected with a 454 error. If the client
26634 persists in trying to issue SMTP commands, all except QUIT are rejected
26635 with the error
26636 .code
26637 554 Security failure
26638 .endd
26639 If a STARTTLS command is issued within an existing TLS session, it is
26640 rejected with a 554 error code.
26641
26642 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26643 match some hosts. You can, of course, set it to * to match all hosts.
26644 However, this is not all you need to do. TLS sessions to a server won't work
26645 without some further configuration at the server end.
26646
26647 It is rumoured that all existing clients that support TLS/SSL use RSA
26648 encryption. To make this work you need to set, in the server,
26649 .code
26650 tls_certificate = /some/file/name
26651 tls_privatekey = /some/file/name
26652 .endd
26653 These options are, in fact, expanded strings, so you can make them depend on
26654 the identity of the client that is connected if you wish. The first file
26655 contains the server's X509 certificate, and the second contains the private key
26656 that goes with it. These files need to be
26657 PEM format and readable by the Exim user, and must
26658 always be given as full path names.
26659 The key must not be password-protected.
26660 They can be the same file if both the
26661 certificate and the key are contained within it. If &%tls_privatekey%& is not
26662 set, or if its expansion is forced to fail or results in an empty string, this
26663 is assumed to be the case. The certificate file may also contain intermediate
26664 certificates that need to be sent to the client to enable it to authenticate
26665 the server's certificate.
26666
26667 If you do not understand about certificates and keys, please try to find a
26668 source of this background information, which is not Exim-specific. (There are a
26669 few comments below in section &<<SECTcerandall>>&.)
26670
26671 &*Note*&: These options do not apply when Exim is operating as a client &--
26672 they apply only in the case of a server. If you need to use a certificate in an
26673 Exim client, you must set the options of the same names in an &(smtp)&
26674 transport.
26675
26676 With just these options, an Exim server will be able to use TLS. It does not
26677 require the client to have a certificate (but see below for how to insist on
26678 this). There is one other option that may be needed in other situations. If
26679 .code
26680 tls_dhparam = /some/file/name
26681 .endd
26682 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26683 with the parameters contained in the file.
26684 Set this to &`none`& to disable use of DH entirely, by making no prime
26685 available:
26686 .code
26687 tls_dhparam = none
26688 .endd
26689 This may also be set to a string identifying a standard prime to be used for
26690 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26691 used is &`ike23`&.  There are a few standard primes available, see the
26692 documentation for &%tls_dhparam%& for the complete list.
26693
26694 See the command
26695 .code
26696 openssl dhparam
26697 .endd
26698 for a way of generating file data.
26699
26700 The strings supplied for these three options are expanded every time a client
26701 host connects. It is therefore possible to use different certificates and keys
26702 for different hosts, if you so wish, by making use of the client's IP address
26703 in &$sender_host_address$& to control the expansion. If a string expansion is
26704 forced to fail, Exim behaves as if the option is not set.
26705
26706 .cindex "cipher" "logging"
26707 .cindex "log" "TLS cipher"
26708 .vindex "&$tls_in_cipher$&"
26709 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26710 an incoming TLS connection. It is included in the &'Received:'& header of an
26711 incoming message (by default &-- you can, of course, change this), and it is
26712 also included in the log line that records a message's arrival, keyed by
26713 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26714 condition can be used to test for specific cipher suites in ACLs.
26715
26716 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26717 can check the name of the cipher suite and vary their actions accordingly. The
26718 cipher suite names vary, depending on which TLS library is being used. For
26719 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26720 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26721 documentation for more details.
26722
26723 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26724 (again depending on the &%tls_cipher%& log selector).
26725
26726
26727 .section "Requesting and verifying client certificates" "SECID183"
26728 .cindex "certificate" "verification of client"
26729 .cindex "TLS" "client certificate verification"
26730 If you want an Exim server to request a certificate when negotiating a TLS
26731 session with a client, you must set either &%tls_verify_hosts%& or
26732 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26733 apply to all TLS connections. For any host that matches one of these options,
26734 Exim requests a certificate as part of the setup of the TLS session. The
26735 contents of the certificate are verified by comparing it with a list of
26736 expected certificates.
26737 These may be the system default set (depending on library version),
26738 an explicit file or,
26739 depending on library version, a directory, identified by
26740 &%tls_verify_certificates%&.
26741
26742 A file can contain multiple certificates, concatenated end to end. If a
26743 directory is used
26744 (OpenSSL only),
26745 each certificate must be in a separate file, with a name (or a symbolic link)
26746 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26747 certificate. You can compute the relevant hash by running the command
26748 .code
26749 openssl x509 -hash -noout -in /cert/file
26750 .endd
26751 where &_/cert/file_& contains a single certificate.
26752
26753 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26754 what happens if the client does not supply a certificate, or if the certificate
26755 does not match any of the certificates in the collection named by
26756 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26757 attempt to set up a TLS session is aborted, and the incoming connection is
26758 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26759 session continues. ACLs that run for subsequent SMTP commands can detect the
26760 fact that no certificate was verified, and vary their actions accordingly. For
26761 example, you can insist on a certificate before accepting a message for
26762 relaying, but not when the message is destined for local delivery.
26763
26764 .vindex "&$tls_in_peerdn$&"
26765 When a client supplies a certificate (whether it verifies or not), the value of
26766 the Distinguished Name of the certificate is made available in the variable
26767 &$tls_in_peerdn$& during subsequent processing of the message.
26768
26769 .cindex "log" "distinguished name"
26770 Because it is often a long text string, it is not included in the log line or
26771 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26772 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26773 &%received_header_text%& to change the &'Received:'& header. When no
26774 certificate is supplied, &$tls_in_peerdn$& is empty.
26775
26776
26777 .section "Revoked certificates" "SECID184"
26778 .cindex "TLS" "revoked certificates"
26779 .cindex "revocation list"
26780 .cindex "certificate" "revocation list"
26781 .cindex "OCSP" "stapling"
26782 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26783 certificates are revoked. If you have such a list, you can pass it to an Exim
26784 server using the global option called &%tls_crl%& and to an Exim client using
26785 an identically named option for the &(smtp)& transport. In each case, the value
26786 of the option is expanded and must then be the name of a file that contains a
26787 CRL in PEM format.
26788 The downside is that clients have to periodically re-download a potentially huge
26789 file from every certificate authority they know of.
26790
26791 The way with most moving parts at query time is Online Certificate
26792 Status Protocol (OCSP), where the client verifies the certificate
26793 against an OCSP server run by the CA.  This lets the CA track all
26794 usage of the certs.  It requires running software with access to the
26795 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26796 is based on HTTP and can be proxied accordingly.
26797
26798 The only widespread OCSP server implementation (known to this writer)
26799 comes as part of OpenSSL and aborts on an invalid request, such as
26800 connecting to the port and then disconnecting.  This requires
26801 re-entering the passphrase each time some random client does this.
26802
26803 The third way is OCSP Stapling; in this, the server using a certificate
26804 issued by the CA periodically requests an OCSP proof of validity from
26805 the OCSP server, then serves it up inline as part of the TLS
26806 negotiation.   This approach adds no extra round trips, does not let the
26807 CA track users, scales well with number of certs issued by the CA and is
26808 resilient to temporary OCSP server failures, as long as the server
26809 starts retrying to fetch an OCSP proof some time before its current
26810 proof expires.  The downside is that it requires server support.
26811
26812 Unless Exim is built with the support disabled,
26813 .new
26814 or with GnuTLS earlier than version 3.3.16 / 3.4.8
26815 .wen
26816 support for OCSP stapling is included.
26817
26818 There is a global option called &%tls_ocsp_file%&.
26819 The file specified therein is expected to be in DER format, and contain
26820 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26821 option will be re-expanded for SNI, if the &%tls_certificate%& option
26822 contains &`tls_in_sni`&, as per other TLS options.
26823
26824 Exim does not at this time implement any support for fetching a new OCSP
26825 proof.  The burden is on the administrator to handle this, outside of
26826 Exim.  The file specified should be replaced atomically, so that the
26827 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26828 on each connection, so a new file will be handled transparently on the
26829 next connection.
26830
26831 When built with OpenSSL Exim will check for a valid next update timestamp
26832 in the OCSP proof; if not present, or if the proof has expired, it will be
26833 ignored.
26834
26835 For the client to be able to verify the stapled OCSP the server must
26836 also supply, in its stapled information, any intermediate
26837 certificates for the chain leading to the OCSP proof from the signer
26838 of the server certificate.  There may be zero or one such. These
26839 intermediate certificates should be added to the server OCSP stapling
26840 file named by &%tls_ocsp_file%&.
26841
26842 Note that the proof only covers the terminal server certificate,
26843 not any of the chain from CA to it.
26844
26845 There is no current way to staple a proof for a client certificate.
26846
26847 .code
26848   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26849   OCSP server is supplied.  The server URL may be included in the
26850   server certificate, if the CA is helpful.
26851
26852   One failure mode seen was the OCSP Signer cert expiring before the end
26853   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26854   noted this as invalid overall, but the re-fetch script did not.
26855 .endd
26856
26857
26858
26859
26860 .section "Configuring an Exim client to use TLS" "SECID185"
26861 .cindex "cipher" "logging"
26862 .cindex "log" "TLS cipher"
26863 .cindex "log" "distinguished name"
26864 .cindex "TLS" "configuring an Exim client"
26865 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26866 deliveries as well as to incoming, the latter one causing logging of the
26867 server certificate's DN. The remaining client configuration for TLS is all
26868 within the &(smtp)& transport.
26869
26870 It is not necessary to set any options to have TLS work in the &(smtp)&
26871 transport. If Exim is built with TLS support, and TLS is advertised by a
26872 server, the &(smtp)& transport always tries to start a TLS session. However,
26873 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26874 transport) to a list of server hosts for which TLS should not be used.
26875
26876 If you do not want Exim to attempt to send messages unencrypted when an attempt
26877 to set up an encrypted connection fails in any way, you can set
26878 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26879 those hosts, delivery is always deferred if an encrypted connection cannot be
26880 set up. If there are any other hosts for the address, they are tried in the
26881 usual way.
26882
26883 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26884 the message unencrypted. It always does this if the response to STARTTLS is
26885 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26886 session after a success response code, what happens is controlled by the
26887 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26888 delivery to this host is deferred, and other hosts (if available) are tried. If
26889 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26890 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26891 negotiation fails, Exim closes the current connection (because it is in an
26892 unknown state), opens a new one to the same host, and then tries the delivery
26893 unencrypted.
26894
26895 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26896 transport provide the client with a certificate, which is passed to the server
26897 if it requests it. If the server is Exim, it will request a certificate only if
26898 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26899
26900 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26901 specifies a collection of expected server certificates.
26902 These may be the system default set (depending on library version),
26903 a file or,
26904 depending on library version, a directory,
26905 must name a file or,
26906 for OpenSSL only (not GnuTLS), a directory.
26907 The client verifies the server's certificate
26908 against this collection, taking into account any revoked certificates that are
26909 in the list defined by &%tls_crl%&.
26910 Failure to verify fails the TLS connection unless either of the
26911 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26912
26913 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26914 certificate verification to the listed servers.  Verification either must
26915 or need not succeed respectively.
26916
26917 The &(smtp)& transport has two OCSP-related options:
26918 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26919 is requested and required for the connection to proceed.  The default
26920 value is empty.
26921 &%hosts_request_ocsp%&; a host-list for which (additionally)
26922 a Certificate Status is requested (but not necessarily verified).  The default
26923 value is "*" meaning that requests are made unless configured
26924 otherwise.
26925
26926 The host(s) should also be in &%hosts_require_tls%&, and
26927 &%tls_verify_certificates%& configured for the transport,
26928 for OCSP to be relevant.
26929
26930 If
26931 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26932 list of permitted cipher suites. If either of these checks fails, delivery to
26933 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26934 alternative hosts, if any.
26935
26936  &*Note*&:
26937 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26938 is operating as a client. Exim does not assume that a server certificate (set
26939 by the global options of the same name) should also be used when operating as a
26940 client.
26941
26942 .vindex "&$host$&"
26943 .vindex "&$host_address$&"
26944 All the TLS options in the &(smtp)& transport are expanded before use, with
26945 &$host$& and &$host_address$& containing the name and address of the server to
26946 which the client is connected. Forced failure of an expansion causes Exim to
26947 behave as if the relevant option were unset.
26948
26949 .vindex &$tls_out_bits$&
26950 .vindex &$tls_out_cipher$&
26951 .vindex &$tls_out_peerdn$&
26952 .vindex &$tls_out_sni$&
26953 Before an SMTP connection is established, the
26954 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26955 variables are emptied. (Until the first connection, they contain the values
26956 that were set when the message was received.) If STARTTLS is subsequently
26957 successfully obeyed, these variables are set to the relevant values for the
26958 outgoing connection.
26959
26960
26961
26962 .section "Use of TLS Server Name Indication" "SECTtlssni"
26963 .cindex "TLS" "Server Name Indication"
26964 .vindex "&$tls_in_sni$&"
26965 .oindex "&%tls_in_sni%&"
26966 With TLS1.0 or above, there is an extension mechanism by which extra
26967 information can be included at various points in the protocol.  One of these
26968 extensions, documented in RFC 6066 (and before that RFC 4366) is
26969 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26970 client in the initial handshake, so that the server can examine the servername
26971 within and possibly choose to use different certificates and keys (and more)
26972 for this session.
26973
26974 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
26975 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26976 address.
26977
26978 With SMTP to MX, there are the same problems here as in choosing the identity
26979 against which to validate a certificate: you can't rely on insecure DNS to
26980 provide the identity which you then cryptographically verify.  So this will
26981 be of limited use in that environment.
26982
26983 With SMTP to Submission, there is a well-defined hostname which clients are
26984 connecting to and can validate certificates against.  Thus clients &*can*&
26985 choose to include this information in the TLS negotiation.  If this becomes
26986 wide-spread, then hosters can choose to present different certificates to
26987 different clients.  Or even negotiate different cipher suites.
26988
26989 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26990 if not empty, will be sent on a TLS session as part of the handshake.  There's
26991 nothing more to it.  Choosing a sensible value not derived insecurely is the
26992 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26993 for the lifetime of the client connection (including during authentication).
26994
26995 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26996 received from a client.
26997 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26998
26999 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27000 option (prior to expansion) then the following options will be re-expanded
27001 during TLS session handshake, to permit alternative values to be chosen:
27002
27003 .ilist
27004 .vindex "&%tls_certificate%&"
27005 &%tls_certificate%&
27006 .next
27007 .vindex "&%tls_crl%&"
27008 &%tls_crl%&
27009 .next
27010 .vindex "&%tls_privatekey%&"
27011 &%tls_privatekey%&
27012 .next
27013 .vindex "&%tls_verify_certificates%&"
27014 &%tls_verify_certificates%&
27015 .next
27016 .vindex "&%tls_ocsp_file%&"
27017 &%tls_ocsp_file%&
27018 .endlist
27019
27020 Great care should be taken to deal with matters of case, various injection
27021 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27022 can always be referenced; it is important to remember that &$tls_sni$& is
27023 arbitrary unverified data provided prior to authentication.
27024
27025 The Exim developers are proceeding cautiously and so far no other TLS options
27026 are re-expanded.
27027
27028 When Exim is built against OpenSSL, OpenSSL must have been built with support
27029 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27030 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27031 see &`-servername`& in the output, then OpenSSL has support.
27032
27033 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27034 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27035 built, then you have SNI support).
27036
27037
27038
27039 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27040          "SECTmulmessam"
27041 .cindex "multiple SMTP deliveries with TLS"
27042 .cindex "TLS" "multiple message deliveries"
27043 Exim sends multiple messages down the same TCP/IP connection by starting up
27044 an entirely new delivery process for each message, passing the socket from
27045 one process to the next. This implementation does not fit well with the use
27046 of TLS, because there is quite a lot of state information associated with a TLS
27047 connection, not just a socket identification. Passing all the state information
27048 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27049 session before passing the socket to a new process. The new process may then
27050 try to start a new TLS session, and if successful, may try to re-authenticate
27051 if AUTH is in use, before sending the next message.
27052
27053 The RFC is not clear as to whether or not an SMTP session continues in clear
27054 after TLS has been shut down, or whether TLS may be restarted again later, as
27055 just described. However, if the server is Exim, this shutdown and
27056 reinitialization works. It is not known which (if any) other servers operate
27057 successfully if the client closes a TLS session and continues with unencrypted
27058 SMTP, but there are certainly some that do not work. For such servers, Exim
27059 should not pass the socket to another process, because the failure of the
27060 subsequent attempt to use it would cause Exim to record a temporary host error,
27061 and delay other deliveries to that host.
27062
27063 To test for this case, Exim sends an EHLO command to the server after
27064 closing down the TLS session. If this fails in any way, the connection is
27065 closed instead of being passed to a new delivery process, but no retry
27066 information is recorded.
27067
27068 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27069 &(smtp)& transport to match those hosts for which Exim should not pass
27070 connections to new processes if TLS has been used.
27071
27072
27073
27074
27075 .section "Certificates and all that" "SECTcerandall"
27076 .cindex "certificate" "references to discussion"
27077 In order to understand fully how TLS works, you need to know about
27078 certificates, certificate signing, and certificate authorities. This is not the
27079 place to give a tutorial, especially as I do not know very much about it
27080 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27081 to Apache, currently at
27082 .display
27083 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27084 .endd
27085 Other parts of the &'modssl'& documentation are also helpful, and have
27086 links to further files.
27087 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27088 0-201-61598-3), contains both introductory and more in-depth descriptions.
27089 Some sample programs taken from the book are available from
27090 .display
27091 &url(http://www.rtfm.com/openssl-examples/)
27092 .endd
27093
27094
27095 .section "Certificate chains" "SECID186"
27096 The file named by &%tls_certificate%& may contain more than one
27097 certificate. This is useful in the case where the certificate that is being
27098 sent is validated by an intermediate certificate which the other end does
27099 not have. Multiple certificates must be in the correct order in the file.
27100 First the host's certificate itself, then the first intermediate
27101 certificate to validate the issuer of the host certificate, then the next
27102 intermediate certificate to validate the issuer of the first intermediate
27103 certificate, and so on, until finally (optionally) the root certificate.
27104 The root certificate must already be trusted by the recipient for
27105 validation to succeed, of course, but if it's not preinstalled, sending the
27106 root certificate along with the rest makes it available for the user to
27107 install if the receiving end is a client MUA that can interact with a user.
27108
27109 Note that certificates using MD5 are unlikely to work on today's Internet;
27110 even if your libraries allow loading them for use in Exim when acting as a
27111 server, increasingly clients will not accept such certificates.  The error
27112 diagnostics in such a case can be frustratingly vague.
27113
27114
27115
27116 .section "Self-signed certificates" "SECID187"
27117 .cindex "certificate" "self-signed"
27118 You can create a self-signed certificate using the &'req'& command provided
27119 with OpenSSL, like this:
27120 . ==== Do not shorten the duration here without reading and considering
27121 . ==== the text below.  Please leave it at 9999 days.
27122 .code
27123 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27124             -days 9999 -nodes
27125 .endd
27126 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27127 delimited and so can be identified independently. The &%-days%& option
27128 specifies a period for which the certificate is valid. The &%-nodes%& option is
27129 important: if you do not set it, the key is encrypted with a passphrase
27130 that you are prompted for, and any use that is made of the key causes more
27131 prompting for the passphrase. This is not helpful if you are going to use
27132 this certificate and key in an MTA, where prompting is not possible.
27133
27134 . ==== I expect to still be working 26 years from now.  The less technical
27135 . ==== debt I create, in terms of storing up trouble for my later years, the
27136 . ==== happier I will be then.  We really have reached the point where we
27137 . ==== should start, at the very least, provoking thought and making folks
27138 . ==== pause before proceeding, instead of leaving all the fixes until two
27139 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27140 . ==== -pdp, 2012
27141 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27142 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27143 the above command might produce a date in the past.  Think carefully about
27144 the lifetime of the systems you're deploying, and either reduce the duration
27145 of the certificate or reconsider your platform deployment.  (At time of
27146 writing, reducing the duration is the most likely choice, but the inexorable
27147 progression of time takes us steadily towards an era where this will not
27148 be a sensible resolution).
27149
27150 A self-signed certificate made in this way is sufficient for testing, and
27151 may be adequate for all your requirements if you are mainly interested in
27152 encrypting transfers, and not in secure identification.
27153
27154 However, many clients require that the certificate presented by the server be a
27155 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27156 certificate. In this situation, the self-signed certificate described above
27157 must be installed on the client host as a trusted root &'certification
27158 authority'& (CA), and the certificate used by Exim must be a user certificate
27159 signed with that self-signed certificate.
27160
27161 For information on creating self-signed CA certificates and using them to sign
27162 user certificates, see the &'General implementation overview'& chapter of the
27163 Open-source PKI book, available online at
27164 &url(http://ospkibook.sourceforge.net/).
27165 .ecindex IIDencsmtp1
27166 .ecindex IIDencsmtp2
27167
27168
27169
27170 . ////////////////////////////////////////////////////////////////////////////
27171 . ////////////////////////////////////////////////////////////////////////////
27172
27173 .chapter "Access control lists" "CHAPACL"
27174 .scindex IIDacl "&ACL;" "description"
27175 .cindex "control of incoming mail"
27176 .cindex "message" "controlling incoming"
27177 .cindex "policy control" "access control lists"
27178 Access Control Lists (ACLs) are defined in a separate section of the run time
27179 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27180 name, terminated by a colon. Here is a complete ACL section that contains just
27181 one very small ACL:
27182 .code
27183 begin acl
27184 small_acl:
27185   accept   hosts = one.host.only
27186 .endd
27187 You can have as many lists as you like in the ACL section, and the order in
27188 which they appear does not matter. The lists are self-terminating.
27189
27190 The majority of ACLs are used to control Exim's behaviour when it receives
27191 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27192 when a local process submits a message using SMTP by specifying the &%-bs%&
27193 option. The most common use is for controlling which recipients are accepted
27194 in incoming messages. In addition, you can define an ACL that is used to check
27195 local non-SMTP messages. The default configuration file contains an example of
27196 a realistic ACL for checking RCPT commands. This is discussed in chapter
27197 &<<CHAPdefconfil>>&.
27198
27199
27200 .section "Testing ACLs" "SECID188"
27201 The &%-bh%& command line option provides a way of testing your ACL
27202 configuration locally by running a fake SMTP session with which you interact.
27203 The host &'relay-test.mail-abuse.org'& provides a service for checking your
27204 relaying configuration (see section &<<SECTcheralcon>>& for more details).
27205
27206
27207
27208 .section "Specifying when ACLs are used" "SECID189"
27209 .cindex "&ACL;" "options for specifying"
27210 In order to cause an ACL to be used, you have to name it in one of the relevant
27211 options in the main part of the configuration. These options are:
27212 .cindex "AUTH" "ACL for"
27213 .cindex "DATA" "ACLs for"
27214 .cindex "ETRN" "ACL for"
27215 .cindex "EXPN" "ACL for"
27216 .cindex "HELO" "ACL for"
27217 .cindex "EHLO" "ACL for"
27218 .cindex "DKIM" "ACL for"
27219 .cindex "MAIL" "ACL for"
27220 .cindex "QUIT, ACL for"
27221 .cindex "RCPT" "ACL for"
27222 .cindex "STARTTLS, ACL for"
27223 .cindex "VRFY" "ACL for"
27224 .cindex "SMTP" "connection, ACL for"
27225 .cindex "non-SMTP messages" "ACLs for"
27226 .cindex "MIME content scanning" "ACL for"
27227 .cindex "PRDR" "ACL for"
27228
27229 .table2 140pt
27230 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27231 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27232 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27233 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27234 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27235 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27236 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27237 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27238 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27239 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27240 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27241 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27242 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27243 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27244 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27245 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27246 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27247 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27248 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27249 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27250 .endtable
27251
27252 For example, if you set
27253 .code
27254 acl_smtp_rcpt = small_acl
27255 .endd
27256 the little ACL defined above is used whenever Exim receives a RCPT command
27257 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27258 done when RCPT commands arrive. A rejection of RCPT should cause the
27259 sending MTA to give up on the recipient address contained in the RCPT
27260 command, whereas rejection at other times may cause the client MTA to keep on
27261 trying to deliver the message. It is therefore recommended that you do as much
27262 testing as possible at RCPT time.
27263
27264
27265 .section "The non-SMTP ACLs" "SECID190"
27266 .cindex "non-SMTP messages" "ACLs for"
27267 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27268 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27269 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27270 the state of the SMTP connection such as encryption and authentication) are not
27271 relevant and are forbidden in these ACLs. However, the sender and recipients
27272 are known, so the &%senders%& and &%sender_domains%& conditions and the
27273 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27274 &$authenticated_sender$& are also available. You can specify added header lines
27275 in any of these ACLs.
27276
27277 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27278 non-SMTP message, before any of the message has been read. (This is the
27279 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27280 batched SMTP input, it runs after the DATA command has been reached. The
27281 result of this ACL is ignored; it cannot be used to reject a message. If you
27282 really need to, you could set a value in an ACL variable here and reject based
27283 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27284 controls, and in particular, it can be used to set
27285 .code
27286 control = suppress_local_fixups
27287 .endd
27288 This cannot be used in the other non-SMTP ACLs because by the time they are
27289 run, it is too late.
27290
27291 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27292 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27293
27294 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27295 kind of rejection is treated as permanent, because there is no way of sending a
27296 temporary error for these kinds of message.
27297
27298
27299 .section "The SMTP connect ACL" "SECID191"
27300 .cindex "SMTP" "connection, ACL for"
27301 .oindex &%smtp_banner%&
27302 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27303 session, after the test specified by &%host_reject_connection%& (which is now
27304 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27305 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27306 the message override the banner message that is otherwise specified by the
27307 &%smtp_banner%& option.
27308
27309
27310 .section "The EHLO/HELO ACL" "SECID192"
27311 .cindex "EHLO" "ACL for"
27312 .cindex "HELO" "ACL for"
27313 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27314 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27315 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27316 Note that a client may issue more than one EHLO or HELO command in an SMTP
27317 session, and indeed is required to issue a new EHLO or HELO after successfully
27318 setting up encryption following a STARTTLS command.
27319
27320 If the command is accepted by an &%accept%& verb that has a &%message%&
27321 modifier, the message may not contain more than one line (it will be truncated
27322 at the first newline and a panic logged if it does). Such a message cannot
27323 affect the EHLO options that are listed on the second and subsequent lines of
27324 an EHLO response.
27325
27326
27327 .section "The DATA ACLs" "SECID193"
27328 .cindex "DATA" "ACLs for"
27329 Two ACLs are associated with the DATA command, because it is two-stage
27330 command, with two responses being sent to the client.
27331 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27332 is obeyed. This gives you control after all the RCPT commands, but before
27333 the message itself is received. It offers the opportunity to give a negative
27334 response to the DATA command before the data is transmitted. Header lines
27335 added by MAIL or RCPT ACLs are not visible at this time, but any that
27336 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27337
27338 You cannot test the contents of the message, for example, to verify addresses
27339 in the headers, at RCPT time or when the DATA command is received. Such
27340 tests have to appear in the ACL that is run after the message itself has been
27341 received, before the final response to the DATA command is sent. This is
27342 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27343 associated with the DATA command.
27344
27345 For both of these ACLs, it is not possible to reject individual recipients. An
27346 error response rejects the entire message. Unfortunately, it is known that some
27347 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27348 before or after the data) correctly &-- they keep the message on their queues
27349 and try again later, but that is their problem, though it does waste some of
27350 your resources.
27351
27352 The &%acl_smtp_data%& ACL is run after
27353 the &%acl_smtp_data_prdr%&,
27354 the &%acl_smtp_dkim%&
27355 and the &%acl_smtp_mime%& ACLs.
27356
27357 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27358 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27359 enabled (which is the default).
27360
27361 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27362 received, and is executed for each DKIM signature found in a message.  If not
27363 otherwise specified, the default action is to accept.
27364
27365 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27366
27367 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27368
27369
27370 .section "The SMTP MIME ACL" "SECID194"
27371 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27372 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27373
27374 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27375
27376
27377 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27378 .cindex "PRDR" "ACL for"
27379 .oindex "&%prdr_enable%&"
27380 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27381 with PRDR support enabled (which is the default).
27382 It becomes active only when the PRDR feature is negotiated between
27383 client and server for a message, and more than one recipient
27384 has been accepted.
27385
27386 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
27387 has been received, and is executed once for each recipient of the message
27388 with &$local_part$& and &$domain$& valid.
27389 The test may accept, defer or deny for individual recipients.
27390 The &%acl_smtp_data%& will still be called after this ACL and
27391 can reject the message overall, even if this ACL has accepted it
27392 for some or all recipients.
27393
27394 PRDR may be used to support per-user content filtering.  Without it
27395 one must defer any recipient after the first that has a different
27396 content-filter configuration.  With PRDR, the RCPT-time check
27397 for this can be disabled when the MAIL-time $smtp_command included
27398 "PRDR".  Any required difference in behaviour of the main DATA-time
27399 ACL should however depend on the PRDR-time ACL having run, as Exim
27400 will avoid doing so in some situations (e.g.  single-recipient mails).
27401
27402 See also the &%prdr_enable%& global option
27403 and the &%hosts_try_prdr%& smtp transport option.
27404
27405 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27406 If the ACL is not defined, processing completes as if
27407 the feature was not requested by the client.
27408
27409 .section "The QUIT ACL" "SECTQUITACL"
27410 .cindex "QUIT, ACL for"
27411 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27412 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27413 does not in fact control any access.
27414 For this reason, it may only accept
27415 or warn as its final result.
27416
27417 This ACL can be used for tasks such as custom logging at the end of an SMTP
27418 session. For example, you can use ACL variables in other ACLs to count
27419 messages, recipients, etc., and log the totals at QUIT time using one or
27420 more &%logwrite%& modifiers on a &%warn%& verb.
27421
27422 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27423 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27424
27425 You do not need to have a final &%accept%&, but if you do, you can use a
27426 &%message%& modifier to specify custom text that is sent as part of the 221
27427 response to QUIT.
27428
27429 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27430 failure (for example, failure to open a log file, or when Exim is bombing out
27431 because it has detected an unrecoverable error), all SMTP commands from the
27432 client are given temporary error responses until QUIT is received or the
27433 connection is closed. In these special cases, the QUIT ACL does not run.
27434
27435
27436 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27437 .vindex &$acl_smtp_notquit$&
27438 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27439 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27440 trouble, such as being unable to write to its log files, this ACL is not run,
27441 because it might try to do things (such as write to log files) that make the
27442 situation even worse.
27443
27444 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27445 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27446 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27447 and &%warn%&.
27448
27449 .vindex &$smtp_notquit_reason$&
27450 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27451 to a string that indicates the reason for the termination of the SMTP
27452 connection. The possible values are:
27453 .table2
27454 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27455 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27456 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27457 .irow &`connection-lost`&          "The SMTP connection has been lost"
27458 .irow &`data-timeout`&             "Timeout while reading message data"
27459 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27460 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27461 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27462 .irow &`synchronization-error`&    "SMTP synchronization error"
27463 .irow &`tls-failed`&               "TLS failed to start"
27464 .endtable
27465 In most cases when an SMTP connection is closed without having received QUIT,
27466 Exim sends an SMTP response message before actually closing the connection.
27467 With the exception of the &`acl-drop`& case, the default message can be
27468 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27469 &%drop%& verb in another ACL, it is the message from the other ACL that is
27470 used.
27471
27472
27473 .section "Finding an ACL to use" "SECID195"
27474 .cindex "&ACL;" "finding which to use"
27475 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27476 you can use different ACLs in different circumstances. For example,
27477 .code
27478 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27479                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27480 .endd
27481 In the default configuration file there are some example settings for
27482 providing an RFC 4409 message submission service on port 587 and a
27483 non-standard &"smtps"& service on port 465. You can use a string
27484 expansion like this to choose an ACL for MUAs on these ports which is
27485 more appropriate for this purpose than the default ACL on port 25.
27486
27487 The expanded string does not have to be the name of an ACL in the
27488 configuration file; there are other possibilities. Having expanded the
27489 string, Exim searches for an ACL as follows:
27490
27491 .ilist
27492 If the string begins with a slash, Exim uses it as a file name, and reads its
27493 contents as an ACL. The lines are processed in the same way as lines in the
27494 Exim configuration file. In particular, continuation lines are supported, blank
27495 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27496 If the file does not exist or cannot be read, an error occurs (typically
27497 causing a temporary failure of whatever caused the ACL to be run). For example:
27498 .code
27499 acl_smtp_data = /etc/acls/\
27500   ${lookup{$sender_host_address}lsearch\
27501   {/etc/acllist}{$value}{default}}
27502 .endd
27503 This looks up an ACL file to use on the basis of the host's IP address, falling
27504 back to a default if the lookup fails. If an ACL is successfully read from a
27505 file, it is retained in memory for the duration of the Exim process, so that it
27506 can be re-used without having to re-read the file.
27507 .next
27508 If the string does not start with a slash, and does not contain any spaces,
27509 Exim searches the ACL section of the configuration for an ACL whose name
27510 matches the string.
27511 .next
27512 If no named ACL is found, or if the string contains spaces, Exim parses
27513 the string as an inline ACL. This can save typing in cases where you just
27514 want to have something like
27515 .code
27516 acl_smtp_vrfy = accept
27517 .endd
27518 in order to allow free use of the VRFY command. Such a string may contain
27519 newlines; it is processed in the same way as an ACL that is read from a file.
27520 .endlist
27521
27522
27523
27524
27525 .section "ACL return codes" "SECID196"
27526 .cindex "&ACL;" "return codes"
27527 Except for the QUIT ACL, which does not affect the SMTP return code (see
27528 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27529 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27530 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27531 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27532 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27533 This also causes a 4&'xx'& return code.
27534
27535 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27536 &"deny"&, because there is no mechanism for passing temporary errors to the
27537 submitters of non-SMTP messages.
27538
27539
27540 ACLs that are relevant to message reception may also return &"discard"&. This
27541 has the effect of &"accept"&, but causes either the entire message or an
27542 individual recipient address to be discarded. In other words, it is a
27543 blackholing facility. Use it with care.
27544
27545 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27546 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27547 RCPT ACL is to discard just the one recipient address. If there are no
27548 recipients left when the message's data is received, the DATA ACL is not
27549 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27550 remaining recipients. The &"discard"& return is not permitted for the
27551 &%acl_smtp_predata%& ACL.
27552
27553
27554 .cindex "&[local_scan()]& function" "when all recipients discarded"
27555 The &[local_scan()]& function is always run, even if there are no remaining
27556 recipients; it may create new recipients.
27557
27558
27559
27560 .section "Unset ACL options" "SECID197"
27561 .cindex "&ACL;" "unset options"
27562 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27563 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27564 not defined at all. For any defined ACL, the default action when control
27565 reaches the end of the ACL statements is &"deny"&.
27566
27567 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27568 these two are ACLs that are used only for their side effects. They cannot be
27569 used to accept or reject anything.
27570
27571 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27572 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27573 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27574 when the ACL is not defined is &"accept"&.
27575
27576 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27577 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27578 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27579 messages over an SMTP connection. For an example, see the ACL in the default
27580 configuration file.
27581
27582
27583
27584
27585 .section "Data for message ACLs" "SECID198"
27586 .cindex "&ACL;" "data for message ACL"
27587 .vindex &$domain$&
27588 .vindex &$local_part$&
27589 .vindex &$sender_address$&
27590 .vindex &$sender_host_address$&
27591 .vindex &$smtp_command$&
27592 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27593 that contain information about the host and the message's sender (for example,
27594 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27595 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27596 &$local_part$& are set from the argument address. The entire SMTP command
27597 is available in &$smtp_command$&.
27598
27599 When an ACL for the AUTH parameter of MAIL is running, the variables that
27600 contain information about the host are set, but &$sender_address$& is not yet
27601 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27602 how it is used.
27603
27604 .vindex "&$message_size$&"
27605 The &$message_size$& variable is set to the value of the SIZE parameter on
27606 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27607 that parameter is not given. The value is updated to the true message size by
27608 the time the final DATA ACL is run (after the message data has been
27609 received).
27610
27611 .vindex "&$rcpt_count$&"
27612 .vindex "&$recipients_count$&"
27613 The &$rcpt_count$& variable increases by one for each RCPT command received.
27614 The &$recipients_count$& variable increases by one each time a RCPT command is
27615 accepted, so while an ACL for RCPT is being processed, it contains the number
27616 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27617 &$rcpt_count$& contains the total number of RCPT commands, and
27618 &$recipients_count$& contains the total number of accepted recipients.
27619
27620
27621
27622
27623
27624 .section "Data for non-message ACLs" "SECTdatfornon"
27625 .cindex "&ACL;" "data for non-message ACL"
27626 .vindex &$smtp_command_argument$&
27627 .vindex &$smtp_command$&
27628 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27629 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27630 and the entire SMTP command is available in &$smtp_command$&.
27631 These variables can be tested using a &%condition%& condition. For example,
27632 here is an ACL for use with AUTH, which insists that either the session is
27633 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27634 does not permit authentication methods that use cleartext passwords on
27635 unencrypted connections.
27636 .code
27637 acl_check_auth:
27638   accept encrypted = *
27639   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27640                      {CRAM-MD5}}
27641   deny   message   = TLS encryption or CRAM-MD5 required
27642 .endd
27643 (Another way of applying this restriction is to arrange for the authenticators
27644 that use cleartext passwords not to be advertised when the connection is not
27645 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27646 option to do this.)
27647
27648
27649
27650 .section "Format of an ACL" "SECID199"
27651 .cindex "&ACL;" "format of"
27652 .cindex "&ACL;" "verbs, definition of"
27653 An individual ACL consists of a number of statements. Each statement starts
27654 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27655 Modifiers can change the way the verb operates, define error and log messages,
27656 set variables, insert delays, and vary the processing of accepted messages.
27657
27658 If all the conditions are met, the verb is obeyed. The same condition may be
27659 used (with different arguments) more than once in the same statement. This
27660 provides a means of specifying an &"and"& conjunction between conditions. For
27661 example:
27662 .code
27663 deny  dnslists = list1.example
27664 dnslists = list2.example
27665 .endd
27666 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27667 the conditions and modifiers when it reaches a condition that fails. What
27668 happens then depends on the verb (and in one case, on a special modifier). Not
27669 all the conditions make sense at every testing point. For example, you cannot
27670 test a sender address in the ACL that is run for a VRFY command.
27671
27672
27673 .section "ACL verbs" "SECID200"
27674 The ACL verbs are as follows:
27675
27676 .ilist
27677 .cindex "&%accept%& ACL verb"
27678 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27679 of the conditions are not met, what happens depends on whether &%endpass%&
27680 appears among the conditions (for syntax see below). If the failing condition
27681 is before &%endpass%&, control is passed to the next ACL statement; if it is
27682 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27683 check a RCPT command:
27684 .code
27685 accept domains = +local_domains
27686 endpass
27687 verify = recipient
27688 .endd
27689 If the recipient domain does not match the &%domains%& condition, control
27690 passes to the next statement. If it does match, the recipient is verified, and
27691 the command is accepted if verification succeeds. However, if verification
27692 fails, the ACL yields &"deny"&, because the failing condition is after
27693 &%endpass%&.
27694
27695 The &%endpass%& feature has turned out to be confusing to many people, so its
27696 use is not recommended nowadays. It is always possible to rewrite an ACL so
27697 that &%endpass%& is not needed, and it is no longer used in the default
27698 configuration.
27699
27700 .cindex "&%message%& ACL modifier" "with &%accept%&"
27701 If a &%message%& modifier appears on an &%accept%& statement, its action
27702 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27703 (when an &%accept%& verb either accepts or passes control to the next
27704 statement), &%message%& can be used to vary the message that is sent when an
27705 SMTP command is accepted. For example, in a RCPT ACL you could have:
27706 .display
27707 &`accept  `&<&'some conditions'&>
27708 &`        message = OK, I will allow you through today`&
27709 .endd
27710 You can specify an SMTP response code, optionally followed by an &"extended
27711 response code"& at the start of the message, but the first digit must be the
27712 same as would be sent by default, which is 2 for an &%accept%& verb.
27713
27714 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27715 an error message that is used when access is denied. This behaviour is retained
27716 for backward compatibility, but current &"best practice"& is to avoid the use
27717 of &%endpass%&.
27718
27719
27720 .next
27721 .cindex "&%defer%& ACL verb"
27722 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27723 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27724 &%defer%& is the same as &%deny%&, because there is no way of sending a
27725 temporary error. For a RCPT command, &%defer%& is much the same as using a
27726 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27727 be used in any ACL, and even for a recipient it might be a simpler approach.
27728
27729
27730 .next
27731 .cindex "&%deny%& ACL verb"
27732 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27733 the conditions are not met, control is passed to the next ACL statement. For
27734 example,
27735 .code
27736 deny dnslists = blackholes.mail-abuse.org
27737 .endd
27738 rejects commands from hosts that are on a DNS black list.
27739
27740
27741 .next
27742 .cindex "&%discard%& ACL verb"
27743 &%discard%&: This verb behaves like &%accept%&, except that it returns
27744 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27745 that are concerned with receiving messages. When all the conditions are true,
27746 the sending entity receives a &"success"& response. However, &%discard%& causes
27747 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27748 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27749 message's recipients are discarded. Recipients that are discarded before DATA
27750 do not appear in the log line when the &%received_recipients%& log selector is set.
27751
27752 If the &%log_message%& modifier is set when &%discard%& operates,
27753 its contents are added to the line that is automatically written to the log.
27754 The &%message%& modifier operates exactly as it does for &%accept%&.
27755
27756
27757 .next
27758 .cindex "&%drop%& ACL verb"
27759 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27760 forcibly closed after the 5&'xx'& error message has been sent. For example:
27761 .code
27762 drop   message   = I don't take more than 20 RCPTs
27763        condition = ${if > {$rcpt_count}{20}}
27764 .endd
27765 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27766 The connection is always dropped after sending a 550 response.
27767
27768 .next
27769 .cindex "&%require%& ACL verb"
27770 &%require%&: If all the conditions are met, control is passed to the next ACL
27771 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27772 example, when checking a RCPT command,
27773 .code
27774 require message = Sender did not verify
27775         verify  = sender
27776 .endd
27777 passes control to subsequent statements only if the message's sender can be
27778 verified. Otherwise, it rejects the command. Note the positioning of the
27779 &%message%& modifier, before the &%verify%& condition. The reason for this is
27780 discussed in section &<<SECTcondmodproc>>&.
27781
27782 .next
27783 .cindex "&%warn%& ACL verb"
27784 &%warn%&: If all the conditions are true, a line specified by the
27785 &%log_message%& modifier is written to Exim's main log. Control always passes
27786 to the next ACL statement. If any condition is false, the log line is not
27787 written. If an identical log line is requested several times in the same
27788 message, only one copy is actually written to the log. If you want to force
27789 duplicates to be written, use the &%logwrite%& modifier instead.
27790
27791 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27792 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27793 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27794 first failing condition. There is more about adding header lines in section
27795 &<<SECTaddheadacl>>&.
27796
27797 If any condition on a &%warn%& statement cannot be completed (that is, there is
27798 some sort of defer), the log line specified by &%log_message%& is not written.
27799 This does not include the case of a forced failure from a lookup, which
27800 is considered to be a successful completion. After a defer, no further
27801 conditions or modifiers in the &%warn%& statement are processed. The incident
27802 is logged, and the ACL continues to be processed, from the next statement
27803 onwards.
27804
27805
27806 .vindex "&$acl_verify_message$&"
27807 When one of the &%warn%& conditions is an address verification that fails, the
27808 text of the verification failure message is in &$acl_verify_message$&. If you
27809 want this logged, you must set it up explicitly. For example:
27810 .code
27811 warn   !verify = sender
27812        log_message = sender verify failed: $acl_verify_message
27813 .endd
27814 .endlist
27815
27816 At the end of each ACL there is an implicit unconditional &%deny%&.
27817
27818 As you can see from the examples above, the conditions and modifiers are
27819 written one to a line, with the first one on the same line as the verb, and
27820 subsequent ones on following lines. If you have a very long condition, you can
27821 continue it onto several physical lines by the usual backslash continuation
27822 mechanism. It is conventional to align the conditions vertically.
27823
27824
27825
27826 .section "ACL variables" "SECTaclvariables"
27827 .cindex "&ACL;" "variables"
27828 There are some special variables that can be set during ACL processing. They
27829 can be used to pass information between different ACLs, different invocations
27830 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27831 transports, and filters that are used to deliver a message. The names of these
27832 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27833 an underscore, but the remainder of the name can be any sequence of
27834 alphanumeric characters and underscores that you choose. There is no limit on
27835 the number of ACL variables. The two sets act as follows:
27836 .ilist
27837 The values of those variables whose names begin with &$acl_c$& persist
27838 throughout an SMTP connection. They are never reset. Thus, a value that is set
27839 while receiving one message is still available when receiving the next message
27840 on the same SMTP connection.
27841 .next
27842 The values of those variables whose names begin with &$acl_m$& persist only
27843 while a message is being received. They are reset afterwards. They are also
27844 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27845 .endlist
27846
27847 When a message is accepted, the current values of all the ACL variables are
27848 preserved with the message and are subsequently made available at delivery
27849 time. The ACL variables are set by a modifier called &%set%&. For example:
27850 .code
27851 accept hosts = whatever
27852        set acl_m4 = some value
27853 accept authenticated = *
27854        set acl_c_auth = yes
27855 .endd
27856 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27857 be set. If you want to set a variable without taking any action, you can use a
27858 &%warn%& verb without any other modifiers or conditions.
27859
27860 .oindex &%strict_acl_vars%&
27861 What happens if a syntactically valid but undefined ACL variable is
27862 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27863 false (the default), an empty string is substituted; if it is true, an
27864 error is generated.
27865
27866 Versions of Exim before 4.64 have a limited set of numbered variables, but
27867 their names are compatible, so there is no problem with upgrading.
27868
27869
27870 .section "Condition and modifier processing" "SECTcondmodproc"
27871 .cindex "&ACL;" "conditions; processing"
27872 .cindex "&ACL;" "modifiers; processing"
27873 An exclamation mark preceding a condition negates its result. For example:
27874 .code
27875 deny   domains = *.dom.example
27876       !verify  = recipient
27877 .endd
27878 causes the ACL to return &"deny"& if the recipient domain ends in
27879 &'dom.example'& and the recipient address cannot be verified. Sometimes
27880 negation can be used on the right-hand side of a condition. For example, these
27881 two statements are equivalent:
27882 .code
27883 deny  hosts = !192.168.3.4
27884 deny !hosts =  192.168.3.4
27885 .endd
27886 However, for many conditions (&%verify%& being a good example), only left-hand
27887 side negation of the whole condition is possible.
27888
27889 The arguments of conditions and modifiers are expanded. A forced failure
27890 of an expansion causes a condition to be ignored, that is, it behaves as if the
27891 condition is true. Consider these two statements:
27892 .code
27893 accept  senders = ${lookup{$host_name}lsearch\
27894                   {/some/file}{$value}fail}
27895 accept  senders = ${lookup{$host_name}lsearch\
27896                   {/some/file}{$value}{}}
27897 .endd
27898 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27899 the returned list is searched, but if the lookup fails the behaviour is
27900 different in the two cases. The &%fail%& in the first statement causes the
27901 condition to be ignored, leaving no further conditions. The &%accept%& verb
27902 therefore succeeds. The second statement, however, generates an empty list when
27903 the lookup fails. No sender can match an empty list, so the condition fails,
27904 and therefore the &%accept%& also fails.
27905
27906 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27907 specify actions that are taken as the conditions for a statement are checked;
27908 others specify text for messages that are used when access is denied or a
27909 warning is generated. The &%control%& modifier affects the way an incoming
27910 message is handled.
27911
27912 The positioning of the modifiers in an ACL statement is important, because the
27913 processing of a verb ceases as soon as its outcome is known. Only those
27914 modifiers that have already been encountered will take effect. For example,
27915 consider this use of the &%message%& modifier:
27916 .code
27917 require message = Can't verify sender
27918         verify  = sender
27919         message = Can't verify recipient
27920         verify  = recipient
27921         message = This message cannot be used
27922 .endd
27923 If sender verification fails, Exim knows that the result of the statement is
27924 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27925 so its text is used as the error message. If sender verification succeeds, but
27926 recipient verification fails, the second message is used. If recipient
27927 verification succeeds, the third message becomes &"current"&, but is never used
27928 because there are no more conditions to cause failure.
27929
27930 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27931 modifier that is used, because all the conditions must be true for rejection to
27932 happen. Specifying more than one &%message%& modifier does not make sense, and
27933 the message can even be specified after all the conditions. For example:
27934 .code
27935 deny   hosts = ...
27936       !senders = *@my.domain.example
27937        message = Invalid sender from client host
27938 .endd
27939 The &"deny"& result does not happen until the end of the statement is reached,
27940 by which time Exim has set up the message.
27941
27942
27943
27944 .section "ACL modifiers" "SECTACLmodi"
27945 .cindex "&ACL;" "modifiers; list of"
27946 The ACL modifiers are as follows:
27947
27948 .vlist
27949 .vitem &*add_header*&&~=&~<&'text'&>
27950 This modifier specifies one or more header lines that are to be added to an
27951 incoming message, assuming, of course, that the message is ultimately
27952 accepted. For details, see section &<<SECTaddheadacl>>&.
27953
27954 .vitem &*continue*&&~=&~<&'text'&>
27955 .cindex "&%continue%& ACL modifier"
27956 .cindex "database" "updating in ACL"
27957 This modifier does nothing of itself, and processing of the ACL always
27958 continues with the next condition or modifier. The value of &%continue%& is in
27959 the side effects of expanding its argument. Typically this could be used to
27960 update a database. It is really just a syntactic tidiness, to avoid having to
27961 write rather ugly lines like this:
27962 .display
27963 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27964 .endd
27965 Instead, all you need is
27966 .display
27967 &`continue = `&<&'some expansion'&>
27968 .endd
27969
27970 .vitem &*control*&&~=&~<&'text'&>
27971 .cindex "&%control%& ACL modifier"
27972 This modifier affects the subsequent processing of the SMTP connection or of an
27973 incoming message that is accepted. The effect of the first type of control
27974 lasts for the duration of the connection, whereas the effect of the second type
27975 lasts only until the current message has been received. The message-specific
27976 controls always apply to the whole message, not to individual recipients,
27977 even if the &%control%& modifier appears in a RCPT ACL.
27978
27979 As there are now quite a few controls that can be applied, they are described
27980 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27981 in several different ways. For example:
27982
27983 . ==== As this is a nested list, any displays it contains must be indented
27984 . ==== as otherwise they are too far to the left. That comment applies only
27985 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27986 . ==== way.
27987
27988 .ilist
27989 It can be at the end of an &%accept%& statement:
27990 .code
27991     accept  ...some conditions
27992             control = queue_only
27993 .endd
27994 In this case, the control is applied when this statement yields &"accept"&, in
27995 other words, when the conditions are all true.
27996
27997 .next
27998 It can be in the middle of an &%accept%& statement:
27999 .code
28000     accept  ...some conditions...
28001             control = queue_only
28002             ...some more conditions...
28003 .endd
28004 If the first set of conditions are true, the control is applied, even if the
28005 statement does not accept because one of the second set of conditions is false.
28006 In this case, some subsequent statement must yield &"accept"& for the control
28007 to be relevant.
28008
28009 .next
28010 It can be used with &%warn%& to apply the control, leaving the
28011 decision about accepting or denying to a subsequent verb. For
28012 example:
28013 .code
28014     warn    ...some conditions...
28015             control = freeze
28016     accept  ...
28017 .endd
28018 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28019 &%logwrite%&, so it does not add anything to the message and does not write a
28020 log entry.
28021
28022 .next
28023 If you want to apply a control unconditionally, you can use it with a
28024 &%require%& verb. For example:
28025 .code
28026     require  control = no_multiline_responses
28027 .endd
28028 .endlist
28029
28030 .vitem &*delay*&&~=&~<&'time'&>
28031 .cindex "&%delay%& ACL modifier"
28032 .oindex "&%-bh%&"
28033 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28034 the time interval before proceeding. However, when testing Exim using the
28035 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28036 output instead). The time is given in the usual Exim notation, and the delay
28037 happens as soon as the modifier is processed. In an SMTP session, pending
28038 output is flushed before the delay is imposed.
28039
28040 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28041 example:
28042 .code
28043 deny    ...some conditions...
28044         delay = 30s
28045 .endd
28046 The delay happens if all the conditions are true, before the statement returns
28047 &"deny"&. Compare this with:
28048 .code
28049 deny    delay = 30s
28050         ...some conditions...
28051 .endd
28052 which waits for 30s before processing the conditions. The &%delay%& modifier
28053 can also be used with &%warn%& and together with &%control%&:
28054 .code
28055 warn    ...some conditions...
28056         delay = 2m
28057         control = freeze
28058 accept  ...
28059 .endd
28060
28061 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28062 responses to several commands are no longer buffered and sent in one packet (as
28063 they would normally be) because all output is flushed before imposing the
28064 delay. This optimization is disabled so that a number of small delays do not
28065 appear to the client as one large aggregated delay that might provoke an
28066 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28067 using a &%control%& modifier to set &%no_delay_flush%&.
28068
28069
28070 .vitem &*endpass*&
28071 .cindex "&%endpass%& ACL modifier"
28072 This modifier, which has no argument, is recognized only in &%accept%& and
28073 &%discard%& statements. It marks the boundary between the conditions whose
28074 failure causes control to pass to the next statement, and the conditions whose
28075 failure causes the ACL to return &"deny"&. This concept has proved to be
28076 confusing to some people, so the use of &%endpass%& is no longer recommended as
28077 &"best practice"&. See the description of &%accept%& above for more details.
28078
28079
28080 .vitem &*log_message*&&~=&~<&'text'&>
28081 .cindex "&%log_message%& ACL modifier"
28082 This modifier sets up a message that is used as part of the log message if the
28083 ACL denies access or a &%warn%& statement's conditions are true. For example:
28084 .code
28085 require log_message = wrong cipher suite $tls_in_cipher
28086         encrypted   = DES-CBC3-SHA
28087 .endd
28088 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28089 example:
28090 .display
28091 &`discard `&<&'some conditions'&>
28092 &`        log_message = Discarded $local_part@$domain because...`&
28093 .endd
28094 When access is denied, &%log_message%& adds to any underlying error message
28095 that may exist because of a condition failure. For example, while verifying a
28096 recipient address, a &':fail:'& redirection might have already set up a
28097 message.
28098
28099 The message may be defined before the conditions to which it applies, because
28100 the string expansion does not happen until Exim decides that access is to be
28101 denied. This means that any variables that are set by the condition are
28102 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28103 variables are set after a DNS black list lookup succeeds. If the expansion of
28104 &%log_message%& fails, or if the result is an empty string, the modifier is
28105 ignored.
28106
28107 .vindex "&$acl_verify_message$&"
28108 If you want to use a &%warn%& statement to log the result of an address
28109 verification, you can use &$acl_verify_message$& to include the verification
28110 error message.
28111
28112 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28113 the start of the logged message. If the same warning log message is requested
28114 more than once while receiving  a single email message, only one copy is
28115 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28116 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28117 is logged for a successful &%warn%& statement.
28118
28119 If &%log_message%& is not present and there is no underlying error message (for
28120 example, from the failure of address verification), but &%message%& is present,
28121 the &%message%& text is used for logging rejections. However, if any text for
28122 logging contains newlines, only the first line is logged. In the absence of
28123 both &%log_message%& and &%message%&, a default built-in message is used for
28124 logging rejections.
28125
28126
28127 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28128 .cindex "&%log_reject_target%& ACL modifier"
28129 .cindex "logging in ACL" "specifying which log"
28130 This modifier makes it possible to specify which logs are used for messages
28131 about ACL rejections. Its argument is a colon-separated list of words that can
28132 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28133 may be empty, in which case a rejection is not logged at all. For example, this
28134 ACL fragment writes no logging information when access is denied:
28135 .display
28136 &`deny `&<&'some conditions'&>
28137 &`     log_reject_target =`&
28138 .endd
28139 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28140 permanent and temporary rejections. Its effect lasts for the rest of the
28141 current ACL.
28142
28143
28144 .vitem &*logwrite*&&~=&~<&'text'&>
28145 .cindex "&%logwrite%& ACL modifier"
28146 .cindex "logging in ACL" "immediate"
28147 This modifier writes a message to a log file as soon as it is encountered when
28148 processing an ACL. (Compare &%log_message%&, which, except in the case of
28149 &%warn%& and &%discard%&, is used only if the ACL statement denies
28150 access.) The &%logwrite%& modifier can be used to log special incidents in
28151 ACLs. For example:
28152 .display
28153 &`accept `&<&'some special conditions'&>
28154 &`       control  = freeze`&
28155 &`       logwrite = froze message because ...`&
28156 .endd
28157 By default, the message is written to the main log. However, it may begin
28158 with a colon, followed by a comma-separated list of log names, and then
28159 another colon, to specify exactly which logs are to be written. For
28160 example:
28161 .code
28162 logwrite = :main,reject: text for main and reject logs
28163 logwrite = :panic: text for panic log only
28164 .endd
28165
28166
28167 .vitem &*message*&&~=&~<&'text'&>
28168 .cindex "&%message%& ACL modifier"
28169 This modifier sets up a text string that is expanded and used as a response
28170 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28171 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28172 there is some complication if &%endpass%& is involved; see the description of
28173 &%accept%& for details.)
28174
28175 The expansion of the message happens at the time Exim decides that the ACL is
28176 to end, not at the time it processes &%message%&. If the expansion fails, or
28177 generates an empty string, the modifier is ignored. Here is an example where
28178 &%message%& must be specified first, because the ACL ends with a rejection if
28179 the &%hosts%& condition fails:
28180 .code
28181 require  message = Host not recognized
28182          hosts = 10.0.0.0/8
28183 .endd
28184 (Once a condition has failed, no further conditions or modifiers are
28185 processed.)
28186
28187 .cindex "SMTP" "error codes"
28188 .oindex "&%smtp_banner%&
28189 For ACLs that are triggered by SMTP commands, the message is returned as part
28190 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28191 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28192 is accepted. In the case of the connect ACL, accepting with a message modifier
28193 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28194 accept message may not contain more than one line (otherwise it will be
28195 truncated at the first newline and a panic logged), and it cannot affect the
28196 EHLO options.
28197
28198 When SMTP is involved, the message may begin with an overriding response code,
28199 consisting of three digits optionally followed by an &"extended response code"&
28200 of the form &'n.n.n'&, each code being followed by a space. For example:
28201 .code
28202 deny  message = 599 1.2.3 Host not welcome
28203       hosts = 192.168.34.0/24
28204 .endd
28205 The first digit of the supplied response code must be the same as would be sent
28206 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28207 access, but for the predata ACL, note that the default success code is 354, not
28208 2&'xx'&.
28209
28210 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28211 the message modifier cannot override the 221 response code.
28212
28213 The text in a &%message%& modifier is literal; any quotes are taken as
28214 literals, but because the string is expanded, backslash escapes are processed
28215 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28216 response.
28217
28218 .vindex "&$acl_verify_message$&"
28219 For ACLs that are called by an &%acl =%& ACL condition, the message is
28220 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28221
28222 If &%message%& is used on a statement that verifies an address, the message
28223 specified overrides any message that is generated by the verification process.
28224 However, the original message is available in the variable
28225 &$acl_verify_message$&, so you can incorporate it into your message if you
28226 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28227 routers to be passed back as part of the SMTP response, you should either not
28228 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28229
28230 For compatibility with previous releases of Exim, a &%message%& modifier that
28231 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28232 modifier, but this usage is now deprecated. However, &%message%& acts only when
28233 all the conditions are true, wherever it appears in an ACL command, whereas
28234 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28235 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28236 effect.
28237
28238
28239 .vitem &*remove_header*&&~=&~<&'text'&>
28240 This modifier specifies one or more header names in a colon-separated list
28241  that are to be removed from an incoming message, assuming, of course, that
28242 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28243
28244
28245 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28246 .cindex "&%set%& ACL modifier"
28247 This modifier puts a value into one of the ACL variables (see section
28248 &<<SECTaclvariables>>&).
28249
28250
28251 .vitem &*udpsend*&&~=&~<&'parameters'&>
28252 This modifier sends a UDP packet, for purposes such as statistics
28253 collection or behaviour monitoring. The parameters are expanded, and
28254 the result of the expansion must be a colon-separated list consisting
28255 of a destination server, port number, and the packet contents. The
28256 server can be specified as a host name or IPv4 or IPv6 address. The
28257 separator can be changed with the usual angle bracket syntax. For
28258 example, you might want to collect information on which hosts connect
28259 when:
28260 .code
28261 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28262              $tod_zulu $sender_host_address
28263 .endd
28264 .endlist
28265
28266
28267
28268
28269 .section "Use of the control modifier" "SECTcontrols"
28270 .cindex "&%control%& ACL modifier"
28271 The &%control%& modifier supports the following settings:
28272
28273 .vlist
28274 .vitem &*control&~=&~allow_auth_unadvertised*&
28275 This modifier allows a client host to use the SMTP AUTH command even when it
28276 has not been advertised in response to EHLO. Furthermore, because there are
28277 apparently some really broken clients that do this, Exim will accept AUTH after
28278 HELO (rather than EHLO) when this control is set. It should be used only if you
28279 really need it, and you should limit its use to those broken clients that do
28280 not work without it. For example:
28281 .code
28282 warn hosts   = 192.168.34.25
28283      control = allow_auth_unadvertised
28284 .endd
28285 Normally, when an Exim server receives an AUTH command, it checks the name of
28286 the authentication mechanism that is given in the command to ensure that it
28287 matches an advertised mechanism. When this control is set, the check that a
28288 mechanism has been advertised is bypassed. Any configured mechanism can be used
28289 by the client. This control is permitted only in the connection and HELO ACLs.
28290
28291
28292 .vitem &*control&~=&~caseful_local_part*& &&&
28293        &*control&~=&~caselower_local_part*&
28294 .cindex "&ACL;" "case of local part in"
28295 .cindex "case of local parts"
28296 .vindex "&$local_part$&"
28297 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28298 (that is, during RCPT processing). By default, the contents of &$local_part$&
28299 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28300 any uppercase letters in the original local part are restored in &$local_part$&
28301 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28302 is encountered.
28303
28304 These controls affect only the current recipient. Moreover, they apply only to
28305 local part handling that takes place directly in the ACL (for example, as a key
28306 in lookups). If a test to verify the recipient is obeyed, the case-related
28307 handling of the local part during the verification is controlled by the router
28308 configuration (see the &%caseful_local_part%& generic router option).
28309
28310 This facility could be used, for example, to add a spam score to local parts
28311 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28312 spam score:
28313 .code
28314 warn  control = caseful_local_part
28315       set acl_m4 = ${eval:\
28316                      $acl_m4 + \
28317                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28318                     }
28319       control = caselower_local_part
28320 .endd
28321 Notice that we put back the lower cased version afterwards, assuming that
28322 is what is wanted for subsequent tests.
28323
28324
28325 .vitem &*control&~=&~cutthrough_delivery*&
28326 .cindex "&ACL;" "cutthrough routing"
28327 .cindex "cutthrough" "requesting"
28328 This option requests delivery be attempted while the item is being received.
28329
28330 The option is usable in the RCPT ACL.
28331 If enabled for a message received via smtp and routed to an smtp transport,
28332 and only one transport, interface, destination host and port combination
28333 is used for all recipients of the message,
28334 then the delivery connection is made while the receiving connection is open
28335 and data is copied from one to the other.
28336
28337 An attempt to set this option for any recipient but the first
28338 for a mail will be quietly ignored.
28339 If a recipient-verify callout connection is subsequently
28340 requested in the same ACL it is held open and used for
28341 any subsequent recipients and the data,
28342 otherwise one is made after the initial RCPT ACL completes.
28343
28344 Note that routers are used in verify mode,
28345 and cannot depend on content of received headers.
28346 Note also that headers cannot be
28347 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28348 Headers may be modified by routers (subject to the above) and transports.
28349
28350 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28351 of outgoing messages is done, because it sends data to the ultimate destination
28352 before the entire message has been received from the source.
28353 It is not supported for messages received with the SMTP PRDR option in use.
28354
28355 Should the ultimate destination system positively accept or reject the mail,
28356 a corresponding indication is given to the source system and nothing is queued.
28357 If there is a temporary error the item is queued for later delivery in the
28358 usual fashion. If the item is successfully delivered in cutthrough mode
28359 the delivery log lines are tagged with ">>" rather than "=>" and appear
28360 before the acceptance "<=" line.
28361
28362 Delivery in this mode avoids the generation of a bounce mail to a
28363 (possibly faked)
28364 sender when the destination system is doing content-scan based rejection.
28365
28366
28367 .vitem &*control&~=&~debug/*&<&'options'&>
28368 .cindex "&ACL;" "enabling debug logging"
28369 .cindex "debugging" "enabling from an ACL"
28370 This control turns on debug logging, almost as though Exim had been invoked
28371 with &`-d`&, with the output going to a new logfile, by default called
28372 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28373 may access any variables already defined.  The logging may be adjusted with
28374 the &'opts'& option, which takes the same values as the &`-d`& command-line
28375 option.  Some examples (which depend on variables that don't exist in all
28376 contexts):
28377 .code
28378       control = debug
28379       control = debug/tag=.$sender_host_address
28380       control = debug/opts=+expand+acl
28381       control = debug/tag=.$message_exim_id/opts=+expand
28382 .endd
28383
28384
28385 .vitem &*control&~=&~dkim_disable_verify*&
28386 .cindex "disable DKIM verify"
28387 .cindex "DKIM" "disable verify"
28388 This control turns off DKIM verification processing entirely.  For details on
28389 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28390
28391
28392 .vitem &*control&~=&~dscp/*&<&'value'&>
28393 .cindex "&ACL;" "setting DSCP value"
28394 .cindex "DSCP" "inbound"
28395 This option causes the DSCP value associated with the socket for the inbound
28396 connection to be adjusted to a given value, given as one of a number of fixed
28397 strings or to numeric value.
28398 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28399 Common values include &`throughput`&, &`mincost`&, and on newer systems
28400 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28401
28402 The outbound packets from Exim will be marked with this value in the header
28403 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28404 that these values will have any effect, not be stripped by networking
28405 equipment, or do much of anything without cooperation with your Network
28406 Engineer and those of all network operators between the source and destination.
28407
28408
28409 .vitem &*control&~=&~enforce_sync*& &&&
28410        &*control&~=&~no_enforce_sync*&
28411 .cindex "SMTP" "synchronization checking"
28412 .cindex "synchronization checking in SMTP"
28413 These controls make it possible to be selective about when SMTP synchronization
28414 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28415 state of the switch (it is true by default). See the description of this option
28416 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28417
28418 The effect of these two controls lasts for the remainder of the SMTP
28419 connection. They can appear in any ACL except the one for the non-SMTP
28420 messages. The most straightforward place to put them is in the ACL defined by
28421 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28422 before the first synchronization check. The expected use is to turn off the
28423 synchronization checks for badly-behaved hosts that you nevertheless need to
28424 work with.
28425
28426
28427 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28428 .cindex "fake defer"
28429 .cindex "defer, fake"
28430 This control works in exactly the same way as &%fakereject%& (described below)
28431 except that it causes an SMTP 450 response after the message data instead of a
28432 550 response. You must take care when using &%fakedefer%& because it causes the
28433 messages to be duplicated when the sender retries. Therefore, you should not
28434 use &%fakedefer%& if the message is to be delivered normally.
28435
28436 .vitem &*control&~=&~fakereject/*&<&'message'&>
28437 .cindex "fake rejection"
28438 .cindex "rejection, fake"
28439 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28440 words, only when an SMTP message is being received. If Exim accepts the
28441 message, instead the final 250 response, a 550 rejection message is sent.
28442 However, Exim proceeds to deliver the message as normal. The control applies
28443 only to the current message, not to any subsequent ones that may be received in
28444 the same SMTP connection.
28445
28446 The text for the 550 response is taken from the &%control%& modifier. If no
28447 message is supplied, the following is used:
28448 .code
28449 550-Your message has been rejected but is being
28450 550-kept for evaluation.
28451 550-If it was a legitimate message, it may still be
28452 550 delivered to the target recipient(s).
28453 .endd
28454 This facility should be used with extreme caution.
28455
28456 .vitem &*control&~=&~freeze*&
28457 .cindex "frozen messages" "forcing in ACL"
28458 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28459 other words, only when a message is being received. If the message is accepted,
28460 it is placed on Exim's queue and frozen. The control applies only to the
28461 current message, not to any subsequent ones that may be received in the same
28462 SMTP connection.
28463
28464 This modifier can optionally be followed by &`/no_tell`&. If the global option
28465 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28466 is told about the freezing), provided all the &*control=freeze*& modifiers that
28467 are obeyed for the current message have the &`/no_tell`& option.
28468
28469 .vitem &*control&~=&~no_delay_flush*&
28470 .cindex "SMTP" "output flushing, disabling for delay"
28471 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28472 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28473 use. This control, as long as it is encountered before the &%delay%& modifier,
28474 disables such output flushing.
28475
28476 .vitem &*control&~=&~no_callout_flush*&
28477 .cindex "SMTP" "output flushing, disabling for callout"
28478 Exim normally flushes SMTP output before performing a callout in an ACL, to
28479 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28480 use. This control, as long as it is encountered before the &%verify%& condition
28481 that causes the callout, disables such output flushing.
28482
28483 .vitem &*control&~=&~no_mbox_unspool*&
28484 This control is available when Exim is compiled with the content scanning
28485 extension. Content scanning may require a copy of the current message, or parts
28486 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28487 or spam scanner. Normally, such copies are deleted when they are no longer
28488 needed. If this control is set, the copies are not deleted. The control applies
28489 only to the current message, not to any subsequent ones that may be received in
28490 the same SMTP connection. It is provided for debugging purposes and is unlikely
28491 to be useful in production.
28492
28493 .vitem &*control&~=&~no_multiline_responses*&
28494 .cindex "multiline responses, suppressing"
28495 This control is permitted for any ACL except the one for non-SMTP messages.
28496 It seems that there are broken clients in use that cannot handle multiline
28497 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28498
28499 If this control is set, multiline SMTP responses from ACL rejections are
28500 suppressed. One way of doing this would have been to put out these responses as
28501 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28502 (&"use multiline responses for more"& it says &-- ha!), and some of the
28503 responses might get close to that. So this facility, which is after all only a
28504 sop to broken clients, is implemented by doing two very easy things:
28505
28506 .ilist
28507 Extra information that is normally output as part of a rejection caused by
28508 sender verification failure is omitted. Only the final line (typically &"sender
28509 verification failed"&) is sent.
28510 .next
28511 If a &%message%& modifier supplies a multiline response, only the first
28512 line is output.
28513 .endlist
28514
28515 The setting of the switch can, of course, be made conditional on the
28516 calling host. Its effect lasts until the end of the SMTP connection.
28517
28518 .vitem &*control&~=&~no_pipelining*&
28519 .cindex "PIPELINING" "suppressing advertising"
28520 This control turns off the advertising of the PIPELINING extension to SMTP in
28521 the current session. To be useful, it must be obeyed before Exim sends its
28522 response to an EHLO command. Therefore, it should normally appear in an ACL
28523 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28524 &%pipelining_advertise_hosts%&.
28525
28526 .vitem &*control&~=&~queue_only*&
28527 .oindex "&%queue_only%&"
28528 .cindex "queueing incoming messages"
28529 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28530 other words, only when a message is being received. If the message is accepted,
28531 it is placed on Exim's queue and left there for delivery by a subsequent queue
28532 runner. No immediate delivery process is started. In other words, it has the
28533 effect as the &%queue_only%& global option. However, the control applies only
28534 to the current message, not to any subsequent ones that may be received in the
28535 same SMTP connection.
28536
28537 .vitem &*control&~=&~submission/*&<&'options'&>
28538 .cindex "message" "submission"
28539 .cindex "submission mode"
28540 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28541 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28542 the current message is a submission from a local MUA. In this case, Exim
28543 operates in &"submission mode"&, and applies certain fixups to the message if
28544 necessary. For example, it adds a &'Date:'& header line if one is not present.
28545 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28546 late (the message has already been created).
28547
28548 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28549 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28550 submission mode; the available options for this control are described there.
28551 The control applies only to the current message, not to any subsequent ones
28552 that may be received in the same SMTP connection.
28553
28554 .vitem &*control&~=&~suppress_local_fixups*&
28555 .cindex "submission fixups, suppressing"
28556 This control applies to locally submitted (non TCP/IP) messages, and is the
28557 complement of &`control = submission`&. It disables the fixups that are
28558 normally applied to locally-submitted messages. Specifically:
28559
28560 .ilist
28561 Any &'Sender:'& header line is left alone (in this respect, it is a
28562 dynamic version of &%local_sender_retain%&).
28563 .next
28564 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28565 .next
28566 There is no check that &'From:'& corresponds to the actual sender.
28567 .endlist ilist
28568
28569 This control may be useful when a remotely-originated message is accepted,
28570 passed to some scanning program, and then re-submitted for delivery. It can be
28571 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28572 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28573 data is read.
28574
28575 &*Note:*& This control applies only to the current message, not to any others
28576 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28577 .endlist vlist
28578
28579
28580 .section "Summary of message fixup control" "SECTsummesfix"
28581 All four possibilities for message fixups can be specified:
28582
28583 .ilist
28584 Locally submitted, fixups applied: the default.
28585 .next
28586 Locally submitted, no fixups applied: use
28587 &`control = suppress_local_fixups`&.
28588 .next
28589 Remotely submitted, no fixups applied: the default.
28590 .next
28591 Remotely submitted, fixups applied: use &`control = submission`&.
28592 .endlist
28593
28594
28595
28596 .section "Adding header lines in ACLs" "SECTaddheadacl"
28597 .cindex "header lines" "adding in an ACL"
28598 .cindex "header lines" "position of added lines"
28599 .cindex "&%add_header%& ACL modifier"
28600 The &%add_header%& modifier can be used to add one or more extra header lines
28601 to an incoming message, as in this example:
28602 .code
28603 warn dnslists = sbl.spamhaus.org : \
28604                 dialup.mail-abuse.org
28605      add_header = X-blacklisted-at: $dnslist_domain
28606 .endd
28607 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28608 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28609 receiving a message). The message must ultimately be accepted for
28610 &%add_header%& to have any significant effect. You can use &%add_header%& with
28611 any ACL verb, including &%deny%& (though this is potentially useful only in a
28612 RCPT ACL).
28613
28614 Headers will not be added to the message if the modifier is used in
28615 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28616
28617 Leading and trailing newlines are removed from
28618 the data for the &%add_header%& modifier; if it then
28619 contains one or more newlines that
28620 are not followed by a space or a tab, it is assumed to contain multiple header
28621 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28622 front of any line that is not a valid header line.
28623
28624 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28625 They are added to the message before processing the DATA and MIME ACLs.
28626 However, if an identical header line is requested more than once, only one copy
28627 is actually added to the message. Further header lines may be accumulated
28628 during the DATA and MIME ACLs, after which they are added to the message, again
28629 with duplicates suppressed. Thus, it is possible to add two identical header
28630 lines to an SMTP message, but only if one is added before DATA and one after.
28631 In the case of non-SMTP messages, new headers are accumulated during the
28632 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28633 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28634 are included in the entry that is written to the reject log.
28635
28636 .cindex "header lines" "added; visibility of"
28637 Header lines are not visible in string expansions
28638 of message headers
28639 until they are added to the
28640 message. It follows that header lines defined in the MAIL, RCPT, and predata
28641 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28642 header lines that are added by the DATA or MIME ACLs are not visible in those
28643 ACLs. Because of this restriction, you cannot use header lines as a way of
28644 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28645 this, you can use ACL variables, as described in section
28646 &<<SECTaclvariables>>&.
28647
28648 The list of headers yet to be added is given by the &%$headers_added%& variable.
28649
28650 The &%add_header%& modifier acts immediately as it is encountered during the
28651 processing of an ACL. Notice the difference between these two cases:
28652 .display
28653 &`accept add_header = ADDED: some text`&
28654 &`       `&<&'some condition'&>
28655
28656 &`accept `&<&'some condition'&>
28657 &`       add_header = ADDED: some text`&
28658 .endd
28659 In the first case, the header line is always added, whether or not the
28660 condition is true. In the second case, the header line is added only if the
28661 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28662 ACL statement. All those that are encountered before a condition fails are
28663 honoured.
28664
28665 .cindex "&%warn%& ACL verb"
28666 For compatibility with previous versions of Exim, a &%message%& modifier for a
28667 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28668 effect only if all the conditions are true, even if it appears before some of
28669 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28670 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28671 are present on a &%warn%& verb, both are processed according to their
28672 specifications.
28673
28674 By default, new header lines are added to a message at the end of the existing
28675 header lines. However, you can specify that any particular header line should
28676 be added right at the start (before all the &'Received:'& lines), immediately
28677 after the first block of &'Received:'& lines, or immediately before any line
28678 that is not a &'Received:'& or &'Resent-something:'& header.
28679
28680 This is done by specifying &":at_start:"&, &":after_received:"&, or
28681 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28682 header line, respectively. (Header text cannot start with a colon, as there has
28683 to be a header name first.) For example:
28684 .code
28685 warn add_header = \
28686        :after_received:X-My-Header: something or other...
28687 .endd
28688 If more than one header line is supplied in a single &%add_header%& modifier,
28689 each one is treated independently and can therefore be placed differently. If
28690 you add more than one line at the start, or after the Received: block, they end
28691 up in reverse order.
28692
28693 &*Warning*&: This facility currently applies only to header lines that are
28694 added in an ACL. It does NOT work for header lines that are added in a
28695 system filter or in a router or transport.
28696
28697
28698
28699 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28700 .cindex "header lines" "removing in an ACL"
28701 .cindex "header lines" "position of removed lines"
28702 .cindex "&%remove_header%& ACL modifier"
28703 The &%remove_header%& modifier can be used to remove one or more header lines
28704 from an incoming message, as in this example:
28705 .code
28706 warn   message        = Remove internal headers
28707        remove_header  = x-route-mail1 : x-route-mail2
28708 .endd
28709 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28710 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28711 receiving a message). The message must ultimately be accepted for
28712 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28713 with any ACL verb, including &%deny%&, though this is really not useful for
28714 any verb that doesn't result in a delivered message.
28715
28716 Headers will not be removed to the message if the modifier is used in
28717 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28718
28719 More than one header can be removed at the same time by using a colon separated
28720 list of header names. The header matching is case insensitive. Wildcards are
28721 not permitted, nor is list expansion performed, so you cannot use hostlists to
28722 create a list of headers, however both connection and message variable expansion
28723 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28724 .code
28725 warn   hosts           = +internal_hosts
28726        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28727 warn   message         = Remove internal headers
28728        remove_header   = $acl_c_ihdrs
28729 .endd
28730 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28731 They are removed from the message before processing the DATA and MIME ACLs.
28732 There is no harm in attempting to remove the same header twice nor is removing
28733 a non-existent header. Further header lines to be removed may be accumulated
28734 during the DATA and MIME ACLs, after which they are removed from the message,
28735 if present. In the case of non-SMTP messages, headers to be removed are
28736 accumulated during the non-SMTP ACLs, and are removed from the message after
28737 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28738 ACL, there really is no effect because there is no logging of what headers
28739 would have been removed.
28740
28741 .cindex "header lines" "removed; visibility of"
28742 Header lines are not visible in string expansions until the DATA phase when it
28743 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28744 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28745 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28746 this restriction, you cannot use header lines as a way of controlling data
28747 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28748 you should instead use ACL variables, as described in section
28749 &<<SECTaclvariables>>&.
28750
28751 The &%remove_header%& modifier acts immediately as it is encountered during the
28752 processing of an ACL. Notice the difference between these two cases:
28753 .display
28754 &`accept remove_header = X-Internal`&
28755 &`       `&<&'some condition'&>
28756
28757 &`accept `&<&'some condition'&>
28758 &`       remove_header = X-Internal`&
28759 .endd
28760 In the first case, the header line is always removed, whether or not the
28761 condition is true. In the second case, the header line is removed only if the
28762 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28763 same ACL statement. All those that are encountered before a condition fails
28764 are honoured.
28765
28766 &*Warning*&: This facility currently applies only to header lines that are
28767 present during ACL processing. It does NOT remove header lines that are added
28768 in a system filter or in a router or transport.
28769
28770
28771
28772
28773 .section "ACL conditions" "SECTaclconditions"
28774 .cindex "&ACL;" "conditions; list of"
28775 Some of the conditions listed in this section are available only when Exim is
28776 compiled with the content-scanning extension. They are included here briefly
28777 for completeness. More detailed descriptions can be found in the discussion on
28778 content scanning in chapter &<<CHAPexiscan>>&.
28779
28780 Not all conditions are relevant in all circumstances. For example, testing
28781 senders and recipients does not make sense in an ACL that is being run as the
28782 result of the arrival of an ETRN command, and checks on message headers can be
28783 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28784 can use the same condition (with different parameters) more than once in the
28785 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28786 The conditions are as follows:
28787
28788
28789 .vlist
28790 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28791 .cindex "&ACL;" "nested"
28792 .cindex "&ACL;" "indirect"
28793 .cindex "&ACL;" "arguments"
28794 .cindex "&%acl%& ACL condition"
28795 The possible values of the argument are the same as for the
28796 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28797 &"accept"& the condition is true; if it returns &"deny"& the condition is
28798 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28799 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28800 condition false. This means that further processing of the &%warn%& verb
28801 ceases, but processing of the ACL continues.
28802
28803 If the argument is a named ACL, up to nine space-separated optional values
28804 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28805 and $acl_narg is set to the count of values.
28806 Previous values of these variables are restored after the call returns.
28807 The name and values are expanded separately.
28808 Note that spaces in complex expansions which are used as arguments
28809 will act as argument separators.
28810
28811 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28812 the connection is dropped. If it returns &"discard"&, the verb must be
28813 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28814 conditions are tested.
28815
28816 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28817 loops. This condition allows you to use different ACLs in different
28818 circumstances. For example, different ACLs can be used to handle RCPT commands
28819 for different local users or different local domains.
28820
28821 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28822 .cindex "&%authenticated%& ACL condition"
28823 .cindex "authentication" "ACL checking"
28824 .cindex "&ACL;" "testing for authentication"
28825 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28826 the name of the authenticator is tested against the list. To test for
28827 authentication by any authenticator, you can set
28828 .code
28829 authenticated = *
28830 .endd
28831
28832 .vitem &*condition&~=&~*&<&'string'&>
28833 .cindex "&%condition%& ACL condition"
28834 .cindex "customizing" "ACL condition"
28835 .cindex "&ACL;" "customized test"
28836 .cindex "&ACL;" "testing, customized"
28837 This feature allows you to make up custom conditions. If the result of
28838 expanding the string is an empty string, the number zero, or one of the strings
28839 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28840 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28841 any other value, some error is assumed to have occurred, and the ACL returns
28842 &"defer"&. However, if the expansion is forced to fail, the condition is
28843 ignored. The effect is to treat it as true, whether it is positive or
28844 negative.
28845
28846 .vitem &*decode&~=&~*&<&'location'&>
28847 .cindex "&%decode%& ACL condition"
28848 This condition is available only when Exim is compiled with the
28849 content-scanning extension, and it is allowed only in the ACL defined by
28850 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28851 If all goes well, the condition is true. It is false only if there are
28852 problems such as a syntax error or a memory shortage. For more details, see
28853 chapter &<<CHAPexiscan>>&.
28854
28855 .vitem &*demime&~=&~*&<&'extension&~list'&>
28856 .cindex "&%demime%& ACL condition"
28857 This condition is available only when Exim is compiled with the
28858 content-scanning extension. Its use is described in section
28859 &<<SECTdemimecond>>&.
28860
28861 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28862 .cindex "&%dnslists%& ACL condition"
28863 .cindex "DNS list" "in ACL"
28864 .cindex "black list (DNS)"
28865 .cindex "&ACL;" "testing a DNS list"
28866 This condition checks for entries in DNS black lists. These are also known as
28867 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28868 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28869 different variants of this condition to describe briefly here. See sections
28870 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28871
28872 .vitem &*domains&~=&~*&<&'domain&~list'&>
28873 .cindex "&%domains%& ACL condition"
28874 .cindex "domain" "ACL checking"
28875 .cindex "&ACL;" "testing a recipient domain"
28876 .vindex "&$domain_data$&"
28877 This condition is relevant only after a RCPT command. It checks that the domain
28878 of the recipient address is in the domain list. If percent-hack processing is
28879 enabled, it is done before this test is done. If the check succeeds with a
28880 lookup, the result of the lookup is placed in &$domain_data$& until the next
28881 &%domains%& test.
28882
28883 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28884 use &%domains%& in a DATA ACL.
28885
28886
28887 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28888 .cindex "&%encrypted%& ACL condition"
28889 .cindex "encryption" "checking in an ACL"
28890 .cindex "&ACL;" "testing for encryption"
28891 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28892 name of the cipher suite in use is tested against the list. To test for
28893 encryption without testing for any specific cipher suite(s), set
28894 .code
28895 encrypted = *
28896 .endd
28897
28898
28899 .vitem &*hosts&~=&~*&<&'host&~list'&>
28900 .cindex "&%hosts%& ACL condition"
28901 .cindex "host" "ACL checking"
28902 .cindex "&ACL;" "testing the client host"
28903 This condition tests that the calling host matches the host list. If you have
28904 name lookups or wildcarded host names and IP addresses in the same host list,
28905 you should normally put the IP addresses first. For example, you could have:
28906 .code
28907 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28908 .endd
28909 The lookup in this example uses the host name for its key. This is implied by
28910 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28911 and it wouldn't matter which way round you had these two items.)
28912
28913 The reason for the problem with host names lies in the left-to-right way that
28914 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28915 but when it reaches an item that requires a host name, it fails if it cannot
28916 find a host name to compare with the pattern. If the above list is given in the
28917 opposite order, the &%accept%& statement fails for a host whose name cannot be
28918 found, even if its IP address is 10.9.8.7.
28919
28920 If you really do want to do the name check first, and still recognize the IP
28921 address even if the name lookup fails, you can rewrite the ACL like this:
28922 .code
28923 accept hosts = dbm;/etc/friendly/hosts
28924 accept hosts = 10.9.8.7
28925 .endd
28926 The default action on failing to find the host name is to assume that the host
28927 is not in the list, so the first &%accept%& statement fails. The second
28928 statement can then check the IP address.
28929
28930 .vindex "&$host_data$&"
28931 If a &%hosts%& condition is satisfied by means of a lookup, the result
28932 of the lookup is made available in the &$host_data$& variable. This
28933 allows you, for example, to set up a statement like this:
28934 .code
28935 deny  hosts = net-lsearch;/some/file
28936 message = $host_data
28937 .endd
28938 which gives a custom error message for each denied host.
28939
28940 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28941 .cindex "&%local_parts%& ACL condition"
28942 .cindex "local part" "ACL checking"
28943 .cindex "&ACL;" "testing a local part"
28944 .vindex "&$local_part_data$&"
28945 This condition is relevant only after a RCPT command. It checks that the local
28946 part of the recipient address is in the list. If percent-hack processing is
28947 enabled, it is done before this test. If the check succeeds with a lookup, the
28948 result of the lookup is placed in &$local_part_data$&, which remains set until
28949 the next &%local_parts%& test.
28950
28951 .vitem &*malware&~=&~*&<&'option'&>
28952 .cindex "&%malware%& ACL condition"
28953 .cindex "&ACL;" "virus scanning"
28954 .cindex "&ACL;" "scanning for viruses"
28955 This condition is available only when Exim is compiled with the
28956 content-scanning extension. It causes the incoming message to be scanned for
28957 viruses. For details, see chapter &<<CHAPexiscan>>&.
28958
28959 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28960 .cindex "&%mime_regex%& ACL condition"
28961 .cindex "&ACL;" "testing by regex matching"
28962 This condition is available only when Exim is compiled with the
28963 content-scanning extension, and it is allowed only in the ACL defined by
28964 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28965 with any of the regular expressions. For details, see chapter
28966 &<<CHAPexiscan>>&.
28967
28968 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28969 .cindex "rate limiting"
28970 This condition can be used to limit the rate at which a user or host submits
28971 messages. Details are given in section &<<SECTratelimiting>>&.
28972
28973 .vitem &*recipients&~=&~*&<&'address&~list'&>
28974 .cindex "&%recipients%& ACL condition"
28975 .cindex "recipient" "ACL checking"
28976 .cindex "&ACL;" "testing a recipient"
28977 This condition is relevant only after a RCPT command. It checks the entire
28978 recipient address against a list of recipients.
28979
28980 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28981 .cindex "&%regex%& ACL condition"
28982 .cindex "&ACL;" "testing by regex matching"
28983 This condition is available only when Exim is compiled with the
28984 content-scanning extension, and is available only in the DATA, MIME, and
28985 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28986 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28987
28988 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28989 .cindex "&%sender_domains%& ACL condition"
28990 .cindex "sender" "ACL checking"
28991 .cindex "&ACL;" "testing a sender domain"
28992 .vindex "&$domain$&"
28993 .vindex "&$sender_address_domain$&"
28994 This condition tests the domain of the sender of the message against the given
28995 domain list. &*Note*&: The domain of the sender address is in
28996 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28997 of this condition. This is an exception to the general rule for testing domain
28998 lists. It is done this way so that, if this condition is used in an ACL for a
28999 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29000 influence the sender checking.
29001
29002 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29003 relaying, because sender addresses are easily, and commonly, forged.
29004
29005 .vitem &*senders&~=&~*&<&'address&~list'&>
29006 .cindex "&%senders%& ACL condition"
29007 .cindex "sender" "ACL checking"
29008 .cindex "&ACL;" "testing a sender"
29009 This condition tests the sender of the message against the given list. To test
29010 for a bounce message, which has an empty sender, set
29011 .code
29012 senders = :
29013 .endd
29014 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29015 relaying, because sender addresses are easily, and commonly, forged.
29016
29017 .vitem &*spam&~=&~*&<&'username'&>
29018 .cindex "&%spam%& ACL condition"
29019 .cindex "&ACL;" "scanning for spam"
29020 This condition is available only when Exim is compiled with the
29021 content-scanning extension. It causes the incoming message to be scanned by
29022 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29023
29024 .vitem &*verify&~=&~certificate*&
29025 .cindex "&%verify%& ACL condition"
29026 .cindex "TLS" "client certificate verification"
29027 .cindex "certificate" "verification of client"
29028 .cindex "&ACL;" "certificate verification"
29029 .cindex "&ACL;" "testing a TLS certificate"
29030 This condition is true in an SMTP session if the session is encrypted, and a
29031 certificate was received from the client, and the certificate was verified. The
29032 server requests a certificate only if the client matches &%tls_verify_hosts%&
29033 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29034
29035 .vitem &*verify&~=&~csa*&
29036 .cindex "CSA verification"
29037 This condition checks whether the sending host (the client) is authorized to
29038 send email. Details of how this works are given in section
29039 &<<SECTverifyCSA>>&.
29040
29041 .vitem &*verify&~=&~header_names_ascii*&
29042 .cindex "&%verify%& ACL condition"
29043 .cindex "&ACL;" "verifying header names only ASCII"
29044 .cindex "header lines" "verifying header names only ASCII"
29045 .cindex "verifying" "header names only ASCII"
29046 This condition is relevant only in an ACL that is run after a message has been
29047 received, that is, in an ACL specified by &%acl_smtp_data%& or
29048 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29049 there are no non-ASCII characters, also excluding control characters.  The
29050 allowable characters are decimal ASCII values 33 through 126.
29051
29052 Exim itself will handle headers with non-ASCII characters, but it can cause
29053 problems for downstream applications, so this option will allow their
29054 detection and rejection in the DATA ACL's.
29055
29056 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29057 .cindex "&%verify%& ACL condition"
29058 .cindex "&ACL;" "verifying sender in the header"
29059 .cindex "header lines" "verifying the sender in"
29060 .cindex "sender" "verifying in header"
29061 .cindex "verifying" "sender in header"
29062 This condition is relevant only in an ACL that is run after a message has been
29063 received, that is, in an ACL specified by &%acl_smtp_data%& or
29064 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29065 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29066 is loosely thought of as a &"sender"& address (hence the name of the test).
29067 However, an address that appears in one of these headers need not be an address
29068 that accepts bounce messages; only sender addresses in envelopes are required
29069 to accept bounces. Therefore, if you use the callout option on this check, you
29070 might want to arrange for a non-empty address in the MAIL command.
29071
29072 Details of address verification and the options are given later, starting at
29073 section &<<SECTaddressverification>>& (callouts are described in section
29074 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29075 condition to restrict it to bounce messages only:
29076 .code
29077 deny    senders = :
29078         message = A valid sender header is required for bounces
29079        !verify  = header_sender
29080 .endd
29081
29082 .vitem &*verify&~=&~header_syntax*&
29083 .cindex "&%verify%& ACL condition"
29084 .cindex "&ACL;" "verifying header syntax"
29085 .cindex "header lines" "verifying syntax"
29086 .cindex "verifying" "header syntax"
29087 This condition is relevant only in an ACL that is run after a message has been
29088 received, that is, in an ACL specified by &%acl_smtp_data%& or
29089 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29090 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29091 and &'Bcc:'&), returning true if there are no problems.
29092 Unqualified addresses (local parts without domains) are
29093 permitted only in locally generated messages and from hosts that match
29094 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29095 appropriate.
29096
29097 Note that this condition is a syntax check only. However, a common spamming
29098 ploy used to be to send syntactically invalid headers such as
29099 .code
29100 To: @
29101 .endd
29102 and this condition can be used to reject such messages, though they are not as
29103 common as they used to be.
29104
29105 .vitem &*verify&~=&~helo*&
29106 .cindex "&%verify%& ACL condition"
29107 .cindex "&ACL;" "verifying HELO/EHLO"
29108 .cindex "HELO" "verifying"
29109 .cindex "EHLO" "verifying"
29110 .cindex "verifying" "EHLO"
29111 .cindex "verifying" "HELO"
29112 This condition is true if a HELO or EHLO command has been received from the
29113 client host, and its contents have been verified. If there has been no previous
29114 attempt to verify the HELO/EHLO contents, it is carried out when this
29115 condition is encountered. See the description of the &%helo_verify_hosts%& and
29116 &%helo_try_verify_hosts%& options for details of how to request verification
29117 independently of this condition.
29118
29119 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29120 option), this condition is always true.
29121
29122
29123 .vitem &*verify&~=&~not_blind*&
29124 .cindex "verifying" "not blind"
29125 .cindex "bcc recipients, verifying none"
29126 This condition checks that there are no blind (bcc) recipients in the message.
29127 Every envelope recipient must appear either in a &'To:'& header line or in a
29128 &'Cc:'& header line for this condition to be true. Local parts are checked
29129 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29130 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29131 used only in a DATA or non-SMTP ACL.
29132
29133 There are, of course, many legitimate messages that make use of blind (bcc)
29134 recipients. This check should not be used on its own for blocking messages.
29135
29136
29137 .vitem &*verify&~=&~recipient/*&<&'options'&>
29138 .cindex "&%verify%& ACL condition"
29139 .cindex "&ACL;" "verifying recipient"
29140 .cindex "recipient" "verifying"
29141 .cindex "verifying" "recipient"
29142 .vindex "&$address_data$&"
29143 This condition is relevant only after a RCPT command. It verifies the current
29144 recipient. Details of address verification are given later, starting at section
29145 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29146 of &$address_data$& is the last value that was set while routing the address.
29147 This applies even if the verification fails. When an address that is being
29148 verified is redirected to a single address, verification continues with the new
29149 address, and in that case, the subsequent value of &$address_data$& is the
29150 value for the child address.
29151
29152 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29153 .cindex "&%verify%& ACL condition"
29154 .cindex "&ACL;" "verifying host reverse lookup"
29155 .cindex "host" "verifying reverse lookup"
29156 This condition ensures that a verified host name has been looked up from the IP
29157 address of the client host. (This may have happened already if the host name
29158 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29159 Verification ensures that the host name obtained from a reverse DNS lookup, or
29160 one of its aliases, does, when it is itself looked up in the DNS, yield the
29161 original IP address.
29162
29163 There is one possible option, &`defer_ok`&.  If this is present and a
29164 DNS operation returns a temporary error, the verify condition succeeds.
29165
29166 If this condition is used for a locally generated message (that is, when there
29167 is no client host involved), it always succeeds.
29168
29169 .vitem &*verify&~=&~sender/*&<&'options'&>
29170 .cindex "&%verify%& ACL condition"
29171 .cindex "&ACL;" "verifying sender"
29172 .cindex "sender" "verifying"
29173 .cindex "verifying" "sender"
29174 This condition is relevant only after a MAIL or RCPT command, or after a
29175 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29176 the message's sender is empty (that is, this is a bounce message), the
29177 condition is true. Otherwise, the sender address is verified.
29178
29179 .vindex "&$address_data$&"
29180 .vindex "&$sender_address_data$&"
29181 If there is data in the &$address_data$& variable at the end of routing, its
29182 value is placed in &$sender_address_data$& at the end of verification. This
29183 value can be used in subsequent conditions and modifiers in the same ACL
29184 statement. It does not persist after the end of the current statement. If you
29185 want to preserve the value for longer, you can save it in an ACL variable.
29186
29187 Details of verification are given later, starting at section
29188 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29189 to avoid doing it more than once per message.
29190
29191 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29192 .cindex "&%verify%& ACL condition"
29193 This is a variation of the previous option, in which a modified address is
29194 verified as a sender.
29195 .endlist
29196
29197
29198
29199 .section "Using DNS lists" "SECTmorednslists"
29200 .cindex "DNS list" "in ACL"
29201 .cindex "black list (DNS)"
29202 .cindex "&ACL;" "testing a DNS list"
29203 In its simplest form, the &%dnslists%& condition tests whether the calling host
29204 is on at least one of a number of DNS lists by looking up the inverted IP
29205 address in one or more DNS domains. (Note that DNS list domains are not mail
29206 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29207 special options instead.) For example, if the calling host's IP
29208 address is 192.168.62.43, and the ACL statement is
29209 .code
29210 deny dnslists = blackholes.mail-abuse.org : \
29211                 dialups.mail-abuse.org
29212 .endd
29213 the following records are looked up:
29214 .code
29215 43.62.168.192.blackholes.mail-abuse.org
29216 43.62.168.192.dialups.mail-abuse.org
29217 .endd
29218 As soon as Exim finds an existing DNS record, processing of the list stops.
29219 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29220 to test that a host is on more than one list (an &"and"& conjunction), you can
29221 use two separate conditions:
29222 .code
29223 deny dnslists = blackholes.mail-abuse.org
29224      dnslists = dialups.mail-abuse.org
29225 .endd
29226 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29227 behaves as if the host does not match the list item, that is, as if the DNS
29228 record does not exist. If there are further items in the DNS list, they are
29229 processed.
29230
29231 This is usually the required action when &%dnslists%& is used with &%deny%&
29232 (which is the most common usage), because it prevents a DNS failure from
29233 blocking mail. However, you can change this behaviour by putting one of the
29234 following special items in the list:
29235 .display
29236 &`+include_unknown `&   behave as if the item is on the list
29237 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29238 &`+defer_unknown   `&   give a temporary error
29239 .endd
29240 .cindex "&`+include_unknown`&"
29241 .cindex "&`+exclude_unknown`&"
29242 .cindex "&`+defer_unknown`&"
29243 Each of these applies to any subsequent items on the list. For example:
29244 .code
29245 deny dnslists = +defer_unknown : foo.bar.example
29246 .endd
29247 Testing the list of domains stops as soon as a match is found. If you want to
29248 warn for one list and block for another, you can use two different statements:
29249 .code
29250 deny  dnslists = blackholes.mail-abuse.org
29251 warn  message  = X-Warn: sending host is on dialups list
29252       dnslists = dialups.mail-abuse.org
29253 .endd
29254 .cindex cacheing "of dns lookup"
29255 .cindex DNS TTL
29256 DNS list lookups are cached by Exim for the duration of the SMTP session
29257 .new
29258 (but limited by the DNS return TTL value),
29259 .wen
29260 so a lookup based on the IP address is done at most once for any incoming
29261 connection (assuming long-enough TTL).
29262 Exim does not share information between multiple incoming
29263 connections (but your local name server cache should be active).
29264
29265
29266
29267 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29268 .cindex "DNS list" "keyed by explicit IP address"
29269 By default, the IP address that is used in a DNS list lookup is the IP address
29270 of the calling host. However, you can specify another IP address by listing it
29271 after the domain name, introduced by a slash. For example:
29272 .code
29273 deny dnslists = black.list.tld/192.168.1.2
29274 .endd
29275 This feature is not very helpful with explicit IP addresses; it is intended for
29276 use with IP addresses that are looked up, for example, the IP addresses of the
29277 MX hosts or nameservers of an email sender address. For an example, see section
29278 &<<SECTmulkeyfor>>& below.
29279
29280
29281
29282
29283 .section "DNS lists keyed on domain names" "SECID202"
29284 .cindex "DNS list" "keyed by domain name"
29285 There are some lists that are keyed on domain names rather than inverted IP
29286 addresses (see for example the &'domain based zones'& link at
29287 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29288 with these lists. You can change the name that is looked up in a DNS list by
29289 listing it after the domain name, introduced by a slash. For example,
29290 .code
29291 deny  message  = Sender's domain is listed at $dnslist_domain
29292       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29293 .endd
29294 This particular example is useful only in ACLs that are obeyed after the
29295 RCPT or DATA commands, when a sender address is available. If (for
29296 example) the message's sender is &'user@tld.example'& the name that is looked
29297 up by this example is
29298 .code
29299 tld.example.dsn.rfc-ignorant.org
29300 .endd
29301 A single &%dnslists%& condition can contain entries for both names and IP
29302 addresses. For example:
29303 .code
29304 deny dnslists = sbl.spamhaus.org : \
29305                 dsn.rfc-ignorant.org/$sender_address_domain
29306 .endd
29307 The first item checks the sending host's IP address; the second checks a domain
29308 name. The whole condition is true if either of the DNS lookups succeeds.
29309
29310
29311
29312
29313 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29314 .cindex "DNS list" "multiple keys for"
29315 The syntax described above for looking up explicitly-defined values (either
29316 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29317 name for the DNS list, what follows the slash can in fact be a list of items.
29318 As with all lists in Exim, the default separator is a colon. However, because
29319 this is a sublist within the list of DNS blacklist domains, it is necessary
29320 either to double the separators like this:
29321 .code
29322 dnslists = black.list.tld/name.1::name.2
29323 .endd
29324 or to change the separator character, like this:
29325 .code
29326 dnslists = black.list.tld/<;name.1;name.2
29327 .endd
29328 If an item in the list is an IP address, it is inverted before the DNS
29329 blacklist domain is appended. If it is not an IP address, no inversion
29330 occurs. Consider this condition:
29331 .code
29332 dnslists = black.list.tld/<;192.168.1.2;a.domain
29333 .endd
29334 The DNS lookups that occur are:
29335 .code
29336 2.1.168.192.black.list.tld
29337 a.domain.black.list.tld
29338 .endd
29339 Once a DNS record has been found (that matches a specific IP return
29340 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29341 are done. If there is a temporary DNS error, the rest of the sublist of domains
29342 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29343 only if no other DNS lookup in this sublist succeeds. In other words, a
29344 successful lookup for any of the items in the sublist overrides a temporary
29345 error for a previous item.
29346
29347 The ability to supply a list of items after the slash is in some sense just a
29348 syntactic convenience. These two examples have the same effect:
29349 .code
29350 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29351 dnslists = black.list.tld/a.domain::b.domain
29352 .endd
29353 However, when the data for the list is obtained from a lookup, the second form
29354 is usually much more convenient. Consider this example:
29355 .code
29356 deny message  = The mail servers for the domain \
29357                 $sender_address_domain \
29358                 are listed at $dnslist_domain ($dnslist_value); \
29359                 see $dnslist_text.
29360      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29361                                    ${lookup dnsdb {>|mxh=\
29362                                    $sender_address_domain} }} }
29363 .endd
29364 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29365 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29366 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29367 of expanding the condition might be something like this:
29368 .code
29369 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29370 .endd
29371 Thus, this example checks whether or not the IP addresses of the sender
29372 domain's mail servers are on the Spamhaus black list.
29373
29374 The key that was used for a successful DNS list lookup is put into the variable
29375 &$dnslist_matched$& (see section &<<SECID204>>&).
29376
29377
29378
29379
29380 .section "Data returned by DNS lists" "SECID203"
29381 .cindex "DNS list" "data returned from"
29382 DNS lists are constructed using address records in the DNS. The original RBL
29383 just used the address 127.0.0.1 on the right hand side of each record, but the
29384 RBL+ list and some other lists use a number of values with different meanings.
29385 The values used on the RBL+ list are:
29386 .display
29387 127.1.0.1  RBL
29388 127.1.0.2  DUL
29389 127.1.0.3  DUL and RBL
29390 127.1.0.4  RSS
29391 127.1.0.5  RSS and RBL
29392 127.1.0.6  RSS and DUL
29393 127.1.0.7  RSS and DUL and RBL
29394 .endd
29395 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29396 different values. Some DNS lists may return more than one address record;
29397 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29398
29399
29400 .section "Variables set from DNS lists" "SECID204"
29401 .cindex "expansion" "variables, set from DNS list"
29402 .cindex "DNS list" "variables set from"
29403 .vindex "&$dnslist_domain$&"
29404 .vindex "&$dnslist_matched$&"
29405 .vindex "&$dnslist_text$&"
29406 .vindex "&$dnslist_value$&"
29407 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29408 the name of the overall domain that matched (for example,
29409 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29410 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29411 the DNS record. When the key is an IP address, it is not reversed in
29412 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29413 cases, for example:
29414 .code
29415 deny dnslists = spamhaus.example
29416 .endd
29417 the key is also available in another variable (in this case,
29418 &$sender_host_address$&). In more complicated cases, however, this is not true.
29419 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29420 might generate a dnslists lookup like this:
29421 .code
29422 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29423 .endd
29424 If this condition succeeds, the value in &$dnslist_matched$& might be
29425 &`192.168.6.7`& (for example).
29426
29427 If more than one address record is returned by the DNS lookup, all the IP
29428 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29429 The variable &$dnslist_text$& contains the contents of any associated TXT
29430 record. For lists such as RBL+ the TXT record for a merged entry is often not
29431 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29432 information.
29433
29434 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29435 &-- although these appear before the condition in the ACL, they are not
29436 expanded until after it has failed. For example:
29437 .code
29438 deny    hosts = !+local_networks
29439         message = $sender_host_address is listed \
29440                   at $dnslist_domain
29441         dnslists = rbl-plus.mail-abuse.example
29442 .endd
29443
29444
29445
29446 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29447 .cindex "DNS list" "matching specific returned data"
29448 You can add an equals sign and an IP address after a &%dnslists%& domain name
29449 in order to restrict its action to DNS records with a matching right hand side.
29450 For example,
29451 .code
29452 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29453 .endd
29454 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29455 any address record is considered to be a match. For the moment, we assume
29456 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29457 describes how multiple records are handled.
29458
29459 More than one IP address may be given for checking, using a comma as a
29460 separator. These are alternatives &-- if any one of them matches, the
29461 &%dnslists%& condition is true. For example:
29462 .code
29463 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29464 .endd
29465 If you want to specify a constraining address list and also specify names or IP
29466 addresses to be looked up, the constraining address list must be specified
29467 first. For example:
29468 .code
29469 deny dnslists = dsn.rfc-ignorant.org\
29470                 =127.0.0.2/$sender_address_domain
29471 .endd
29472
29473 If the character &`&&`& is used instead of &`=`&, the comparison for each
29474 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29475 In other words, the listed addresses are used as bit masks. The comparison is
29476 true if all the bits in the mask are present in the address that is being
29477 tested. For example:
29478 .code
29479 dnslists = a.b.c&0.0.0.3
29480 .endd
29481 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29482 want to test whether one bit or another bit is present (as opposed to both
29483 being present), you must use multiple values. For example:
29484 .code
29485 dnslists = a.b.c&0.0.0.1,0.0.0.2
29486 .endd
29487 matches if the final component of the address is an odd number or two times
29488 an odd number.
29489
29490
29491
29492 .section "Negated DNS matching conditions" "SECID205"
29493 You can supply a negative list of IP addresses as part of a &%dnslists%&
29494 condition. Whereas
29495 .code
29496 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29497 .endd
29498 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29499 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29500 .code
29501 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29502 .endd
29503 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29504 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29505 words, the result of the test is inverted if an exclamation mark appears before
29506 the &`=`& (or the &`&&`&) sign.
29507
29508 &*Note*&: This kind of negation is not the same as negation in a domain,
29509 host, or address list (which is why the syntax is different).
29510
29511 If you are using just one list, the negation syntax does not gain you much. The
29512 previous example is precisely equivalent to
29513 .code
29514 deny  dnslists = a.b.c
29515      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29516 .endd
29517 However, if you are using multiple lists, the negation syntax is clearer.
29518 Consider this example:
29519 .code
29520 deny  dnslists = sbl.spamhaus.org : \
29521                  list.dsbl.org : \
29522                  dnsbl.njabl.org!=127.0.0.3 : \
29523                  relays.ordb.org
29524 .endd
29525 Using only positive lists, this would have to be:
29526 .code
29527 deny  dnslists = sbl.spamhaus.org : \
29528                  list.dsbl.org
29529 deny  dnslists = dnsbl.njabl.org
29530      !dnslists = dnsbl.njabl.org=127.0.0.3
29531 deny  dnslists = relays.ordb.org
29532 .endd
29533 which is less clear, and harder to maintain.
29534
29535
29536
29537
29538 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29539 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29540 thereby providing more than one IP address. When an item in a &%dnslists%& list
29541 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29542 the match to specific results from the DNS lookup, there are two ways in which
29543 the checking can be handled. For example, consider the condition:
29544 .code
29545 dnslists = a.b.c=127.0.0.1
29546 .endd
29547 What happens if the DNS lookup for the incoming IP address yields both
29548 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29549 condition true because at least one given value was found, or is it false
29550 because at least one of the found values was not listed? And how does this
29551 affect negated conditions? Both possibilities are provided for with the help of
29552 additional separators &`==`& and &`=&&`&.
29553
29554 .ilist
29555 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29556 IP addresses matches one of the listed addresses. For the example above, the
29557 condition is true because 127.0.0.1 matches.
29558 .next
29559 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29560 looked up IP addresses matches one of the listed addresses. If the condition is
29561 changed to:
29562 .code
29563 dnslists = a.b.c==127.0.0.1
29564 .endd
29565 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29566 false because 127.0.0.2 is not listed. You would need to have:
29567 .code
29568 dnslists = a.b.c==127.0.0.1,127.0.0.2
29569 .endd
29570 for the condition to be true.
29571 .endlist
29572
29573 When &`!`& is used to negate IP address matching, it inverts the result, giving
29574 the precise opposite of the behaviour above. Thus:
29575 .ilist
29576 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29577 addresses matches one of the listed addresses. Consider:
29578 .code
29579 dnslists = a.b.c!&0.0.0.1
29580 .endd
29581 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29582 false because 127.0.0.1 matches.
29583 .next
29584 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29585 looked up IP address that does not match. Consider:
29586 .code
29587 dnslists = a.b.c!=&0.0.0.1
29588 .endd
29589 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29590 true, because 127.0.0.2 does not match. You would need to have:
29591 .code
29592 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29593 .endd
29594 for the condition to be false.
29595 .endlist
29596 When the DNS lookup yields only a single IP address, there is no difference
29597 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29598
29599
29600
29601
29602 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29603 .cindex "DNS list" "information from merged"
29604 When the facility for restricting the matching IP values in a DNS list is used,
29605 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29606 the true reason for rejection. This happens when lists are merged and the IP
29607 address in the A record is used to distinguish them; unfortunately there is
29608 only one TXT record. One way round this is not to use merged lists, but that
29609 can be inefficient because it requires multiple DNS lookups where one would do
29610 in the vast majority of cases when the host of interest is not on any of the
29611 lists.
29612
29613 A less inefficient way of solving this problem is available. If
29614 two domain names, comma-separated, are given, the second is used first to
29615 do an initial check, making use of any IP value restrictions that are set.
29616 If there is a match, the first domain is used, without any IP value
29617 restrictions, to get the TXT record. As a byproduct of this, there is also
29618 a check that the IP being tested is indeed on the first list. The first
29619 domain is the one that is put in &$dnslist_domain$&. For example:
29620 .code
29621 reject message  = \
29622          rejected because $sender_host_address is blacklisted \
29623          at $dnslist_domain\n$dnslist_text
29624        dnslists = \
29625          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29626          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29627 .endd
29628 For the first blacklist item, this starts by doing a lookup in
29629 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29630 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29631 value, and as long as something is found, it looks for the corresponding TXT
29632 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29633 The second blacklist item is processed similarly.
29634
29635 If you are interested in more than one merged list, the same list must be
29636 given several times, but because the results of the DNS lookups are cached,
29637 the DNS calls themselves are not repeated. For example:
29638 .code
29639 reject dnslists = \
29640          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29641          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29642          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29643          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29644 .endd
29645 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29646 values matches (or if no record is found), this is the only lookup that is
29647 done. Only if there is a match is one of the more specific lists consulted.
29648
29649
29650
29651 .section "DNS lists and IPv6" "SECTmorednslistslast"
29652 .cindex "IPv6" "DNS black lists"
29653 .cindex "DNS list" "IPv6 usage"
29654 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29655 nibble by nibble. For example, if the calling host's IP address is
29656 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29657 .code
29658 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29659   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29660 .endd
29661 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29662 lists contain wildcard records, intended for IPv4, that interact badly with
29663 IPv6. For example, the DNS entry
29664 .code
29665 *.3.some.list.example.    A    127.0.0.1
29666 .endd
29667 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29668 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29669
29670 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29671 &%condition%& condition, as in this example:
29672 .code
29673 deny   condition = ${if isip4{$sender_host_address}}
29674        dnslists  = some.list.example
29675 .endd
29676
29677 If an explicit key is being used for a DNS lookup and it may be an IPv6
29678 address you should specify alternate list separators for both the outer
29679 (DNS list name) list and inner (lookup keys) list:
29680 .code
29681        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29682 .endd
29683
29684 .section "Rate limiting incoming messages" "SECTratelimiting"
29685 .cindex "rate limiting" "client sending"
29686 .cindex "limiting client sending rates"
29687 .oindex "&%smtp_ratelimit_*%&"
29688 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29689 which clients can send email. This is more powerful than the
29690 &%smtp_ratelimit_*%& options, because those options control the rate of
29691 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29692 works across all connections (concurrent and sequential) from the same client
29693 host. The syntax of the &%ratelimit%& condition is:
29694 .display
29695 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29696 .endd
29697 If the average client sending rate is less than &'m'& messages per time
29698 period &'p'& then the condition is false; otherwise it is true.
29699
29700 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29701 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29702 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29703 of &'p'&.
29704
29705 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29706 time interval, for example, &`8h`& for eight hours. A larger time constant
29707 means that it takes Exim longer to forget a client's past behaviour. The
29708 parameter &'m'& is the maximum number of messages that a client is permitted to
29709 send in each time interval. It also specifies the number of messages permitted
29710 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29711 constant, you can allow a client to send more messages in a burst without
29712 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29713 both small, messages must be sent at an even rate.
29714
29715 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29716 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29717 when deploying the &%ratelimit%& ACL condition. The script prints usage
29718 instructions when it is run with no arguments.
29719
29720 The key is used to look up the data for calculating the client's average
29721 sending rate. This data is stored in Exim's spool directory, alongside the
29722 retry and other hints databases. The default key is &$sender_host_address$&,
29723 which means Exim computes the sending rate of each client host IP address.
29724 By changing the key you can change how Exim identifies clients for the purpose
29725 of ratelimiting. For example, to limit the sending rate of each authenticated
29726 user, independent of the computer they are sending from, set the key to
29727 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29728 example, &$authenticated_id$& is only meaningful if the client has
29729 authenticated (which you can check with the &%authenticated%& ACL condition).
29730
29731 The lookup key does not have to identify clients: If you want to limit the
29732 rate at which a recipient receives messages, you can use the key
29733 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29734 ACL.
29735
29736 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29737 specifies what Exim measures the rate of, for example messages or recipients
29738 or bytes. You can adjust the measurement using the &%unique=%& and/or
29739 &%count=%& options. You can also control when Exim updates the recorded rate
29740 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29741 separated by a slash, like the other parameters. They may appear in any order.
29742
29743 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29744 any options that alter the meaning of the stored data. The limit &'m'& is not
29745 stored, so you can alter the configured maximum rate and Exim will still
29746 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29747 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29748 behaviour. The lookup key is not affected by changes to the update mode and
29749 the &%count=%& option.
29750
29751
29752 .section "Ratelimit options for what is being measured" "ratoptmea"
29753 .cindex "rate limiting" "per_* options"
29754 The &%per_conn%& option limits the client's connection rate. It is not
29755 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29756 &%acl_not_smtp_start%& ACLs.
29757
29758 The &%per_mail%& option limits the client's rate of sending messages. This is
29759 the default if none of the &%per_*%& options is specified. It can be used in
29760 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29761 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29762
29763 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29764 the same ACLs as the &%per_mail%& option, though it is best to use this option
29765 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29766 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29767 in its MAIL command, which may be inaccurate or completely missing. You can
29768 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29769 in kilobytes, megabytes, or gigabytes, respectively.
29770
29771 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29772 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29773 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29774 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29775 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
29776 in either case the rate limiting engine will see a message with many
29777 recipients as a large high-speed burst.
29778
29779 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29780 number of different recipients that the client has sent messages to in the
29781 last time period. That is, if the client repeatedly sends messages to the same
29782 recipient, its measured rate is not increased. This option can only be used in
29783 &%acl_smtp_rcpt%&.
29784
29785 The &%per_cmd%& option causes Exim to recompute the rate every time the
29786 condition is processed. This can be used to limit the rate of any SMTP
29787 command. If it is used in multiple ACLs it can limit the aggregate rate of
29788 multiple different commands.
29789
29790 The &%count=%& option can be used to alter how much Exim adds to the client's
29791 measured rate. For example, the &%per_byte%& option is equivalent to
29792 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29793 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29794 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29795
29796 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29797
29798
29799 .section "Ratelimit update modes" "ratoptupd"
29800 .cindex "rate limiting" "reading data without updating"
29801 You can specify one of three options with the &%ratelimit%& condition to
29802 control when its database is updated. This section describes the &%readonly%&
29803 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29804
29805 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29806 previously-computed rate to check against the limit.
29807
29808 For example, you can test the client's sending rate and deny it access (when
29809 it is too fast) in the connect ACL. If the client passes this check then it
29810 can go on to send a message, in which case its recorded rate will be updated
29811 in the MAIL ACL. Subsequent connections from the same client will check this
29812 new rate.
29813 .code
29814 acl_check_connect:
29815  deny ratelimit = 100 / 5m / readonly
29816     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29817                   (max $sender_rate_limit)
29818 # ...
29819 acl_check_mail:
29820  warn ratelimit = 100 / 5m / strict
29821     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29822                   (max $sender_rate_limit)
29823 .endd
29824
29825 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29826 processing a message then it may increase the client's measured rate more than
29827 it should. For example, this will happen if you check the &%per_rcpt%& option
29828 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29829 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29830 multiple update problems by using the &%readonly%& option on later ratelimit
29831 checks.
29832
29833 The &%per_*%& options described above do not make sense in some ACLs. If you
29834 use a &%per_*%& option in an ACL where it is not normally permitted then the
29835 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29836 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29837 next section) so you must specify the &%readonly%& option explicitly.
29838
29839
29840 .section "Ratelimit options for handling fast clients" "ratoptfast"
29841 .cindex "rate limiting" "strict and leaky modes"
29842 If a client's average rate is greater than the maximum, the rate limiting
29843 engine can react in two possible ways, depending on the presence of the
29844 &%strict%& or &%leaky%& update modes. This is independent of the other
29845 counter-measures (such as rejecting the message) that may be specified by the
29846 rest of the ACL.
29847
29848 The &%leaky%& (default) option means that the client's recorded rate is not
29849 updated if it is above the limit. The effect of this is that Exim measures the
29850 client's average rate of successfully sent email, which cannot be greater than
29851 the maximum allowed. If the client is over the limit it may suffer some
29852 counter-measures (as specified in the ACL), but it will still be able to send
29853 email at the configured maximum rate, whatever the rate of its attempts. This
29854 is generally the better choice if you have clients that retry automatically.
29855 For example, it does not prevent a sender with an over-aggressive retry rate
29856 from getting any email through.
29857
29858 The &%strict%& option means that the client's recorded rate is always
29859 updated. The effect of this is that Exim measures the client's average rate
29860 of attempts to send email, which can be much higher than the maximum it is
29861 actually allowed. If the client is over the limit it may be subjected to
29862 counter-measures by the ACL. It must slow down and allow sufficient time to
29863 pass that its computed rate falls below the maximum before it can send email
29864 again. The time (the number of smoothing periods) it must wait and not
29865 attempt to send mail can be calculated with this formula:
29866 .code
29867         ln(peakrate/maxrate)
29868 .endd
29869
29870
29871 .section "Limiting the rate of different events" "ratoptuniq"
29872 .cindex "rate limiting" "counting unique events"
29873 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29874 rate of different events. For example, the &%per_addr%& option uses this
29875 mechanism to count the number of different recipients that the client has
29876 sent messages to in the last time period; it is equivalent to
29877 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29878 measure the rate that a client uses different sender addresses with the
29879 options &`per_mail/unique=$sender_address`&.
29880
29881 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29882 has seen for that key. The whole set is thrown away when it is older than the
29883 rate smoothing period &'p'&, so each different event is counted at most once
29884 per period. In the &%leaky%& update mode, an event that causes the client to
29885 go over the limit is not added to the set, in the same way that the client's
29886 recorded rate is not updated in the same situation.
29887
29888 When you combine the &%unique=%& and &%readonly%& options, the specific
29889 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29890 rate.
29891
29892 The &%unique=%& mechanism needs more space in the ratelimit database than the
29893 other &%ratelimit%& options in order to store the event set. The number of
29894 unique values is potentially as large as the rate limit, so the extra space
29895 required increases with larger limits.
29896
29897 The uniqueification is not perfect: there is a small probability that Exim
29898 will think a new event has happened before. If the sender's rate is less than
29899 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29900 the measured rate can go above the limit, in which case Exim may under-count
29901 events by a significant margin. Fortunately, if the rate is high enough (2.7
29902 times the limit) that the false positive rate goes above 9%, then Exim will
29903 throw away the over-full event set before the measured rate falls below the
29904 limit. Therefore the only harm should be that exceptionally high sending rates
29905 are logged incorrectly; any countermeasures you configure will be as effective
29906 as intended.
29907
29908
29909 .section "Using rate limiting" "useratlim"
29910 Exim's other ACL facilities are used to define what counter-measures are taken
29911 when the rate limit is exceeded. This might be anything from logging a warning
29912 (for example, while measuring existing sending rates in order to define
29913 policy), through time delays to slow down fast senders, up to rejecting the
29914 message. For example:
29915 .code
29916 # Log all senders' rates
29917 warn ratelimit = 0 / 1h / strict
29918      log_message = Sender rate $sender_rate / $sender_rate_period
29919
29920 # Slow down fast senders; note the need to truncate $sender_rate
29921 # at the decimal point.
29922 warn ratelimit = 100 / 1h / per_rcpt / strict
29923      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29924                    $sender_rate_limit }s
29925
29926 # Keep authenticated users under control
29927 deny authenticated = *
29928      ratelimit = 100 / 1d / strict / $authenticated_id
29929
29930 # System-wide rate limit
29931 defer message = Sorry, too busy. Try again later.
29932      ratelimit = 10 / 1s / $primary_hostname
29933
29934 # Restrict incoming rate from each host, with a default
29935 # set using a macro and special cases looked up in a table.
29936 defer message = Sender rate exceeds $sender_rate_limit \
29937                messages per $sender_rate_period
29938      ratelimit = ${lookup {$sender_host_address} \
29939                    cdb {DB/ratelimits.cdb} \
29940                    {$value} {RATELIMIT} }
29941 .endd
29942 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29943 especially with the &%per_rcpt%& option, you may suffer from a performance
29944 bottleneck caused by locking on the ratelimit hints database. Apart from
29945 making your ACLs less complicated, you can reduce the problem by using a
29946 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29947 this means that Exim will lose its hints data after a reboot (including retry
29948 hints, the callout cache, and ratelimit data).
29949
29950
29951
29952 .section "Address verification" "SECTaddressverification"
29953 .cindex "verifying address" "options for"
29954 .cindex "policy control" "address verification"
29955 Several of the &%verify%& conditions described in section
29956 &<<SECTaclconditions>>& cause addresses to be verified. Section
29957 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29958 The verification conditions can be followed by options that modify the
29959 verification process. The options are separated from the keyword and from each
29960 other by slashes, and some of them contain parameters. For example:
29961 .code
29962 verify = sender/callout
29963 verify = recipient/defer_ok/callout=10s,defer_ok
29964 .endd
29965 The first stage of address verification, which always happens, is to run the
29966 address through the routers, in &"verify mode"&. Routers can detect the
29967 difference between verification and routing for delivery, and their actions can
29968 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29969 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29970 The available options are as follows:
29971
29972 .ilist
29973 If the &%callout%& option is specified, successful routing to one or more
29974 remote hosts is followed by a &"callout"& to those hosts as an additional
29975 check. Callouts and their sub-options are discussed in the next section.
29976 .next
29977 If there is a defer error while doing verification routing, the ACL
29978 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29979 options, the condition is forced to be true instead. Note that this is a main
29980 verification option as well as a suboption for callouts.
29981 .next
29982 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29983 discusses the reporting of sender address verification failures.
29984 .next
29985 The &%success_on_redirect%& option causes verification always to succeed
29986 immediately after a successful redirection. By default, if a redirection
29987 generates just one address, that address is also verified. See further
29988 discussion in section &<<SECTredirwhilveri>>&.
29989 .endlist
29990
29991 .cindex "verifying address" "differentiating failures"
29992 .vindex "&$recipient_verify_failure$&"
29993 .vindex "&$sender_verify_failure$&"
29994 .vindex "&$acl_verify_message$&"
29995 After an address verification failure, &$acl_verify_message$& contains the
29996 error message that is associated with the failure. It can be preserved by
29997 coding like this:
29998 .code
29999 warn  !verify = sender
30000        set acl_m0 = $acl_verify_message
30001 .endd
30002 If you are writing your own custom rejection message or log message when
30003 denying access, you can use this variable to include information about the
30004 verification failure.
30005
30006 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30007 appropriate) contains one of the following words:
30008
30009 .ilist
30010 &%qualify%&: The address was unqualified (no domain), and the message
30011 was neither local nor came from an exempted host.
30012 .next
30013 &%route%&: Routing failed.
30014 .next
30015 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30016 occurred at or before the MAIL command (that is, on initial
30017 connection, HELO, or MAIL).
30018 .next
30019 &%recipient%&: The RCPT command in a callout was rejected.
30020 .next
30021 &%postmaster%&: The postmaster check in a callout was rejected.
30022 .endlist
30023
30024 The main use of these variables is expected to be to distinguish between
30025 rejections of MAIL and rejections of RCPT in callouts.
30026
30027
30028
30029
30030 .section "Callout verification" "SECTcallver"
30031 .cindex "verifying address" "by callout"
30032 .cindex "callout" "verification"
30033 .cindex "SMTP" "callout verification"
30034 For non-local addresses, routing verifies the domain, but is unable to do any
30035 checking of the local part. There are situations where some means of verifying
30036 the local part is desirable. One way this can be done is to make an SMTP
30037 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30038 a subsequent host for a recipient address, to see if the host accepts the
30039 address. We use the term &'callout'& to cover both cases. Note that for a
30040 sender address, the callback is not to the client host that is trying to
30041 deliver the message, but to one of the hosts that accepts incoming mail for the
30042 sender's domain.
30043
30044 Exim does not do callouts by default. If you want them to happen, you must
30045 request them by setting appropriate options on the &%verify%& condition, as
30046 described below. This facility should be used with care, because it can add a
30047 lot of resource usage to the cost of verifying an address. However, Exim does
30048 cache the results of callouts, which helps to reduce the cost. Details of
30049 caching are in section &<<SECTcallvercache>>&.
30050
30051 Recipient callouts are usually used only between hosts that are controlled by
30052 the same administration. For example, a corporate gateway host could use
30053 callouts to check for valid recipients on an internal mailserver. A successful
30054 callout does not guarantee that a real delivery to the address would succeed;
30055 on the other hand, a failing callout does guarantee that a delivery would fail.
30056
30057 If the &%callout%& option is present on a condition that verifies an address, a
30058 second stage of verification occurs if the address is successfully routed to
30059 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30060 &(manualroute)& router, where the router specifies the hosts. However, if a
30061 router that does not set up hosts routes to an &(smtp)& transport with a
30062 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30063 &%hosts_override%& set, its hosts are always used, whether or not the router
30064 supplies a host list.
30065 Callouts are only supported on &(smtp)& transports.
30066
30067 The port that is used is taken from the transport, if it is specified and is a
30068 remote transport. (For routers that do verification only, no transport need be
30069 specified.) Otherwise, the default SMTP port is used. If a remote transport
30070 specifies an outgoing interface, this is used; otherwise the interface is not
30071 specified. Likewise, the text that is used for the HELO command is taken from
30072 the transport's &%helo_data%& option; if there is no transport, the value of
30073 &$smtp_active_hostname$& is used.
30074
30075 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30076 test whether a bounce message could be delivered to the sender address. The
30077 following SMTP commands are sent:
30078 .display
30079 &`HELO `&<&'local host name'&>
30080 &`MAIL FROM:<>`&
30081 &`RCPT TO:`&<&'the address to be tested'&>
30082 &`QUIT`&
30083 .endd
30084 LHLO is used instead of HELO if the transport's &%protocol%& option is
30085 set to &"lmtp"&.
30086
30087 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30088 settings.
30089
30090 A recipient callout check is similar. By default, it also uses an empty address
30091 for the sender. This default is chosen because most hosts do not make use of
30092 the sender address when verifying a recipient. Using the same address means
30093 that a single cache entry can be used for each recipient. Some sites, however,
30094 do make use of the sender address when verifying. These are catered for by the
30095 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30096
30097 If the response to the RCPT command is a 2&'xx'& code, the verification
30098 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30099 Exim tries the next host, if any. If there is a problem with all the remote
30100 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30101 &%callout%& option is given, in which case the condition is forced to succeed.
30102
30103 .cindex "SMTP" "output flushing, disabling for callout"
30104 A callout may take a little time. For this reason, Exim normally flushes SMTP
30105 output before performing a callout in an ACL, to avoid unexpected timeouts in
30106 clients when the SMTP PIPELINING extension is in use. The flushing can be
30107 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30108
30109
30110
30111
30112 .section "Additional parameters for callouts" "CALLaddparcall"
30113 .cindex "callout" "additional parameters for"
30114 The &%callout%& option can be followed by an equals sign and a number of
30115 optional parameters, separated by commas. For example:
30116 .code
30117 verify = recipient/callout=10s,defer_ok
30118 .endd
30119 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30120 separate verify options, is retained for backwards compatibility, but is now
30121 deprecated. The additional parameters for &%callout%& are as follows:
30122
30123
30124 .vlist
30125 .vitem <&'a&~time&~interval'&>
30126 .cindex "callout" "timeout, specifying"
30127 This specifies the timeout that applies for the callout attempt to each host.
30128 For example:
30129 .code
30130 verify = sender/callout=5s
30131 .endd
30132 The default is 30 seconds. The timeout is used for each response from the
30133 remote host. It is also used for the initial connection, unless overridden by
30134 the &%connect%& parameter.
30135
30136
30137 .vitem &*connect&~=&~*&<&'time&~interval'&>
30138 .cindex "callout" "connection timeout, specifying"
30139 This parameter makes it possible to set a different (usually smaller) timeout
30140 for making the SMTP connection. For example:
30141 .code
30142 verify = sender/callout=5s,connect=1s
30143 .endd
30144 If not specified, this timeout defaults to the general timeout value.
30145
30146 .vitem &*defer_ok*&
30147 .cindex "callout" "defer, action on"
30148 When this parameter is present, failure to contact any host, or any other kind
30149 of temporary error, is treated as success by the ACL. However, the cache is not
30150 updated in this circumstance.
30151
30152 .vitem &*fullpostmaster*&
30153 .cindex "callout" "full postmaster check"
30154 This operates like the &%postmaster%& option (see below), but if the check for
30155 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30156 accordance with the specification in RFC 2821. The RFC states that the
30157 unqualified address &'postmaster'& should be accepted.
30158
30159
30160 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30161 .cindex "callout" "sender when verifying header"
30162 When verifying addresses in header lines using the &%header_sender%&
30163 verification option, Exim behaves by default as if the addresses are envelope
30164 sender addresses from a message. Callout verification therefore tests to see
30165 whether a bounce message could be delivered, by using an empty address in the
30166 MAIL command. However, it is arguable that these addresses might never be used
30167 as envelope senders, and could therefore justifiably reject bounce messages
30168 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30169 address to use in the MAIL command. For example:
30170 .code
30171 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30172 .endd
30173 This parameter is available only for the &%header_sender%& verification option.
30174
30175
30176 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30177 .cindex "callout" "overall timeout, specifying"
30178 This parameter sets an overall timeout for performing a callout verification.
30179 For example:
30180 .code
30181 verify = sender/callout=5s,maxwait=30s
30182 .endd
30183 This timeout defaults to four times the callout timeout for individual SMTP
30184 commands. The overall timeout applies when there is more than one host that can
30185 be tried. The timeout is checked before trying the next host. This prevents
30186 very long delays if there are a large number of hosts and all are timing out
30187 (for example, when network connections are timing out).
30188
30189
30190 .vitem &*no_cache*&
30191 .cindex "callout" "cache, suppressing"
30192 .cindex "caching callout, suppressing"
30193 When this parameter is given, the callout cache is neither read nor updated.
30194
30195 .vitem &*postmaster*&
30196 .cindex "callout" "postmaster; checking"
30197 When this parameter is set, a successful callout check is followed by a similar
30198 check for the local part &'postmaster'& at the same domain. If this address is
30199 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30200 the postmaster check is recorded in a cache record; if it is a failure, this is
30201 used to fail subsequent callouts for the domain without a connection being
30202 made, until the cache record expires.
30203
30204 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30205 The postmaster check uses an empty sender in the MAIL command by default.
30206 You can use this parameter to do a postmaster check using a different address.
30207 For example:
30208 .code
30209 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30210 .endd
30211 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30212 one overrides. The &%postmaster%& parameter is equivalent to this example:
30213 .code
30214 require  verify = sender/callout=postmaster_mailfrom=
30215 .endd
30216 &*Warning*&: The caching arrangements for postmaster checking do not take
30217 account of the sender address. It is assumed that either the empty address or
30218 a fixed non-empty address will be used. All that Exim remembers is that the
30219 postmaster check for the domain succeeded or failed.
30220
30221
30222 .vitem &*random*&
30223 .cindex "callout" "&""random""& check"
30224 When this parameter is set, before doing the normal callout check, Exim does a
30225 check for a &"random"& local part at the same domain. The local part is not
30226 really random &-- it is defined by the expansion of the option
30227 &%callout_random_local_part%&, which defaults to
30228 .code
30229 $primary_hostname-$tod_epoch-testing
30230 .endd
30231 The idea here is to try to determine whether the remote host accepts all local
30232 parts without checking. If it does, there is no point in doing callouts for
30233 specific local parts. If the &"random"& check succeeds, the result is saved in
30234 a cache record, and used to force the current and subsequent callout checks to
30235 succeed without a connection being made, until the cache record expires.
30236
30237 .vitem &*use_postmaster*&
30238 .cindex "callout" "sender for recipient check"
30239 This parameter applies to recipient callouts only. For example:
30240 .code
30241 deny  !verify = recipient/callout=use_postmaster
30242 .endd
30243 .vindex "&$qualify_domain$&"
30244 It causes a non-empty postmaster address to be used in the MAIL command when
30245 performing the callout for the recipient, and also for a &"random"& check if
30246 that is configured. The local part of the address is &`postmaster`& and the
30247 domain is the contents of &$qualify_domain$&.
30248
30249 .vitem &*use_sender*&
30250 This option applies to recipient callouts only. For example:
30251 .code
30252 require  verify = recipient/callout=use_sender
30253 .endd
30254 It causes the message's actual sender address to be used in the MAIL
30255 command when performing the callout, instead of an empty address. There is no
30256 need to use this option unless you know that the called hosts make use of the
30257 sender when checking recipients. If used indiscriminately, it reduces the
30258 usefulness of callout caching.
30259 .endlist
30260
30261 If you use any of the parameters that set a non-empty sender for the MAIL
30262 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30263 &%use_sender%&), you should think about possible loops. Recipient checking is
30264 usually done between two hosts that are under the same management, and the host
30265 that receives the callouts is not normally configured to do callouts itself.
30266 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30267 these circumstances.
30268
30269 However, if you use a non-empty sender address for a callout to an arbitrary
30270 host, there is the likelihood that the remote host will itself initiate a
30271 callout check back to your host. As it is checking what appears to be a message
30272 sender, it is likely to use an empty address in MAIL, thus avoiding a
30273 callout loop. However, to be on the safe side it would be best to set up your
30274 own ACLs so that they do not do sender verification checks when the recipient
30275 is the address you use for header sender or postmaster callout checking.
30276
30277 Another issue to think about when using non-empty senders for callouts is
30278 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30279 by the sender/recipient combination; thus, for any given recipient, many more
30280 actual callouts are performed than when an empty sender or postmaster is used.
30281
30282
30283
30284
30285 .section "Callout caching" "SECTcallvercache"
30286 .cindex "hints database" "callout cache"
30287 .cindex "callout" "cache, description of"
30288 .cindex "caching" "callout"
30289 Exim caches the results of callouts in order to reduce the amount of resources
30290 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30291 option. A hints database called &"callout"& is used for the cache. Two
30292 different record types are used: one records the result of a callout check for
30293 a specific address, and the other records information that applies to the
30294 entire domain (for example, that it accepts the local part &'postmaster'&).
30295
30296 When an original callout fails, a detailed SMTP error message is given about
30297 the failure. However, for subsequent failures use the cache data, this message
30298 is not available.
30299
30300 The expiry times for negative and positive address cache records are
30301 independent, and can be set by the global options &%callout_negative_expire%&
30302 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30303
30304 If a host gives a negative response to an SMTP connection, or rejects any
30305 commands up to and including
30306 .code
30307 MAIL FROM:<>
30308 .endd
30309 (but not including the MAIL command with a non-empty address),
30310 any callout attempt is bound to fail. Exim remembers such failures in a
30311 domain cache record, which it uses to fail callouts for the domain without
30312 making new connections, until the domain record times out. There are two
30313 separate expiry times for domain cache records:
30314 &%callout_domain_negative_expire%& (default 3h) and
30315 &%callout_domain_positive_expire%& (default 7d).
30316
30317 Domain records expire when the negative expiry time is reached if callouts
30318 cannot be made for the domain, or if the postmaster check failed.
30319 Otherwise, they expire when the positive expiry time is reached. This
30320 ensures that, for example, a host that stops accepting &"random"& local parts
30321 will eventually be noticed.
30322
30323 The callout caching mechanism is based on the domain of the address that is
30324 being tested. If the domain routes to several hosts, it is assumed that their
30325 behaviour will be the same.
30326
30327
30328
30329 .section "Sender address verification reporting" "SECTsenaddver"
30330 .cindex "verifying" "suppressing error details"
30331 See section &<<SECTaddressverification>>& for a general discussion of
30332 verification. When sender verification fails in an ACL, the details of the
30333 failure are given as additional output lines before the 550 response to the
30334 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30335 you might see:
30336 .code
30337 MAIL FROM:<xyz@abc.example>
30338 250 OK
30339 RCPT TO:<pqr@def.example>
30340 550-Verification failed for <xyz@abc.example>
30341 550-Called:   192.168.34.43
30342 550-Sent:     RCPT TO:<xyz@abc.example>
30343 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30344 550 Sender verification failed
30345 .endd
30346 If more than one RCPT command fails in the same way, the details are given
30347 only for the first of them. However, some administrators do not want to send
30348 out this much information. You can suppress the details by adding
30349 &`/no_details`& to the ACL statement that requests sender verification. For
30350 example:
30351 .code
30352 verify = sender/no_details
30353 .endd
30354
30355 .section "Redirection while verifying" "SECTredirwhilveri"
30356 .cindex "verifying" "redirection while"
30357 .cindex "address redirection" "while verifying"
30358 A dilemma arises when a local address is redirected by aliasing or forwarding
30359 during verification: should the generated addresses themselves be verified,
30360 or should the successful expansion of the original address be enough to verify
30361 it? By default, Exim takes the following pragmatic approach:
30362
30363 .ilist
30364 When an incoming address is redirected to just one child address, verification
30365 continues with the child address, and if that fails to verify, the original
30366 verification also fails.
30367 .next
30368 When an incoming address is redirected to more than one child address,
30369 verification does not continue. A success result is returned.
30370 .endlist
30371
30372 This seems the most reasonable behaviour for the common use of aliasing as a
30373 way of redirecting different local parts to the same mailbox. It means, for
30374 example, that a pair of alias entries of the form
30375 .code
30376 A.Wol:   aw123
30377 aw123:   :fail: Gone away, no forwarding address
30378 .endd
30379 work as expected, with both local parts causing verification failure. When a
30380 redirection generates more than one address, the behaviour is more like a
30381 mailing list, where the existence of the alias itself is sufficient for
30382 verification to succeed.
30383
30384 It is possible, however, to change the default behaviour so that all successful
30385 redirections count as successful verifications, however many new addresses are
30386 generated. This is specified by the &%success_on_redirect%& verification
30387 option. For example:
30388 .code
30389 require verify = recipient/success_on_redirect/callout=10s
30390 .endd
30391 In this example, verification succeeds if a router generates a new address, and
30392 the callout does not occur, because no address was routed to a remote host.
30393
30394 When verification is being tested via the &%-bv%& option, the treatment of
30395 redirections is as just described, unless the &%-v%& or any debugging option is
30396 also specified. In that case, full verification is done for every generated
30397 address and a report is output for each of them.
30398
30399
30400
30401 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30402 .cindex "CSA" "verifying"
30403 Client SMTP Authorization is a system that allows a site to advertise
30404 which machines are and are not permitted to send email. This is done by placing
30405 special SRV records in the DNS; these are looked up using the client's HELO
30406 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30407 Authorization checks in Exim are performed by the ACL condition:
30408 .code
30409 verify = csa
30410 .endd
30411 This fails if the client is not authorized. If there is a DNS problem, or if no
30412 valid CSA SRV record is found, or if the client is authorized, the condition
30413 succeeds. These three cases can be distinguished using the expansion variable
30414 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30415 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30416 be likely to cause problems for legitimate email.
30417
30418 The error messages produced by the CSA code include slightly more
30419 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30420 looking up the CSA SRV record, or problems looking up the CSA target
30421 address record. There are four reasons for &$csa_status$& being &"fail"&:
30422
30423 .ilist
30424 The client's host name is explicitly not authorized.
30425 .next
30426 The client's IP address does not match any of the CSA target IP addresses.
30427 .next
30428 The client's host name is authorized but it has no valid target IP addresses
30429 (for example, the target's addresses are IPv6 and the client is using IPv4).
30430 .next
30431 The client's host name has no CSA SRV record but a parent domain has asserted
30432 that all subdomains must be explicitly authorized.
30433 .endlist
30434
30435 The &%csa%& verification condition can take an argument which is the domain to
30436 use for the DNS query. The default is:
30437 .code
30438 verify = csa/$sender_helo_name
30439 .endd
30440 This implementation includes an extension to CSA. If the query domain
30441 is an address literal such as [192.0.2.95], or if it is a bare IP
30442 address, Exim searches for CSA SRV records in the reverse DNS as if
30443 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30444 meaningful to say:
30445 .code
30446 verify = csa/$sender_host_address
30447 .endd
30448 In fact, this is the check that Exim performs if the client does not say HELO.
30449 This extension can be turned off by setting the main configuration option
30450 &%dns_csa_use_reverse%& to be false.
30451
30452 If a CSA SRV record is not found for the domain itself, a search
30453 is performed through its parent domains for a record which might be
30454 making assertions about subdomains. The maximum depth of this search is limited
30455 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30456 default. Exim does not look for CSA SRV records in a top level domain, so the
30457 default settings handle HELO domains as long as seven
30458 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30459 of legitimate HELO domains.
30460
30461 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30462 direct SRV lookups, this is not sufficient because of the extra parent domain
30463 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30464 addresses into lookups in the reverse DNS space. The result of a successful
30465 lookup such as:
30466 .code
30467 ${lookup dnsdb {csa=$sender_helo_name}}
30468 .endd
30469 has two space-separated fields: an authorization code and a target host name.
30470 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30471 authorization required but absent, or &"?"& for unknown.
30472
30473
30474
30475
30476 .section "Bounce address tag validation" "SECTverifyPRVS"
30477 .cindex "BATV, verifying"
30478 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30479 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30480 Genuine incoming bounce messages should therefore always be addressed to
30481 recipients that have a valid tag. This scheme is a way of detecting unwanted
30482 bounce messages caused by sender address forgeries (often called &"collateral
30483 spam"&), because the recipients of such messages do not include valid tags.
30484
30485 There are two expansion items to help with the implementation of the BATV
30486 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30487 the original envelope sender address by using a simple key to add a hash of the
30488 address and some time-based randomizing information. The &%prvs%& expansion
30489 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30490 The syntax of these expansion items is described in section
30491 &<<SECTexpansionitems>>&.
30492
30493 As an example, suppose the secret per-address keys are stored in an MySQL
30494 database. A query to look up the key for an address could be defined as a macro
30495 like this:
30496 .code
30497 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30498                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30499                 }{$value}}
30500 .endd
30501 Suppose also that the senders who make use of BATV are defined by an address
30502 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30503 use this:
30504 .code
30505 # Bounces: drop unsigned addresses for BATV senders
30506 deny message = This address does not send an unsigned reverse path
30507      senders = :
30508      recipients = +batv_senders
30509
30510 # Bounces: In case of prvs-signed address, check signature.
30511 deny message = Invalid reverse path signature.
30512      senders = :
30513      condition  = ${prvscheck {$local_part@$domain}\
30514                   {PRVSCHECK_SQL}{1}}
30515      !condition = $prvscheck_result
30516 .endd
30517 The first statement rejects recipients for bounce messages that are addressed
30518 to plain BATV sender addresses, because it is known that BATV senders do not
30519 send out messages with plain sender addresses. The second statement rejects
30520 recipients that are prvs-signed, but with invalid signatures (either because
30521 the key is wrong, or the signature has timed out).
30522
30523 A non-prvs-signed address is not rejected by the second statement, because the
30524 &%prvscheck%& expansion yields an empty string if its first argument is not a
30525 prvs-signed address, thus causing the &%condition%& condition to be false. If
30526 the first argument is a syntactically valid prvs-signed address, the yield is
30527 the third string (in this case &"1"&), whether or not the cryptographic and
30528 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30529 of the checks (empty for failure, &"1"& for success).
30530
30531 There is one more issue you must consider when implementing prvs-signing:
30532 you have to ensure that the routers accept prvs-signed addresses and
30533 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30534 router to remove the signature with a configuration along these lines:
30535 .code
30536 batv_redirect:
30537   driver = redirect
30538   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30539 .endd
30540 This works because, if the third argument of &%prvscheck%& is empty, the result
30541 of the expansion of a prvs-signed address is the decoded value of the original
30542 address. This router should probably be the first of your routers that handles
30543 local addresses.
30544
30545 To create BATV-signed addresses in the first place, a transport of this form
30546 can be used:
30547 .code
30548 external_smtp_batv:
30549   driver = smtp
30550   return_path = ${prvs {$return_path} \
30551                        {${lookup mysql{SELECT \
30552                        secret FROM batv_prvs WHERE \
30553                        sender='${quote_mysql:$sender_address}'} \
30554                        {$value}fail}}}
30555 .endd
30556 If no key can be found for the existing return path, no signing takes place.
30557
30558
30559
30560 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30561 .cindex "&ACL;" "relay control"
30562 .cindex "relaying" "control by ACL"
30563 .cindex "policy control" "relay control"
30564 An MTA is said to &'relay'& a message if it receives it from some host and
30565 delivers it directly to another host as a result of a remote address contained
30566 within it. Redirecting a local address via an alias or forward file and then
30567 passing the message on to another host is not relaying,
30568 .cindex "&""percent hack""&"
30569 but a redirection as a result of the &"percent hack"& is.
30570
30571 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30572 A host which is acting as a gateway or an MX backup is concerned with incoming
30573 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30574 a host which is acting as a smart host for a number of clients is concerned
30575 with outgoing relaying from those clients to the Internet at large. Often the
30576 same host is fulfilling both functions,
30577 . ///
30578 . as illustrated in the diagram below,
30579 . ///
30580 but in principle these two kinds of relaying are entirely independent. What is
30581 not wanted is the transmission of mail from arbitrary remote hosts through your
30582 system to arbitrary domains.
30583
30584
30585 You can implement relay control by means of suitable statements in the ACL that
30586 runs for each RCPT command. For convenience, it is often easiest to use
30587 Exim's named list facility to define the domains and hosts involved. For
30588 example, suppose you want to do the following:
30589
30590 .ilist
30591 Deliver a number of domains to mailboxes on the local host (or process them
30592 locally in some other way). Let's say these are &'my.dom1.example'& and
30593 &'my.dom2.example'&.
30594 .next
30595 Relay mail for a number of other domains for which you are the secondary MX.
30596 These might be &'friend1.example'& and &'friend2.example'&.
30597 .next
30598 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30599 Suppose your LAN is 192.168.45.0/24.
30600 .endlist
30601
30602
30603 In the main part of the configuration, you put the following definitions:
30604 .code
30605 domainlist local_domains    = my.dom1.example : my.dom2.example
30606 domainlist relay_to_domains = friend1.example : friend2.example
30607 hostlist   relay_from_hosts = 192.168.45.0/24
30608 .endd
30609 Now you can use these definitions in the ACL that is run for every RCPT
30610 command:
30611 .code
30612 acl_check_rcpt:
30613   accept domains = +local_domains : +relay_to_domains
30614   accept hosts   = +relay_from_hosts
30615 .endd
30616 The first statement accepts any RCPT command that contains an address in
30617 the local or relay domains. For any other domain, control passes to the second
30618 statement, which accepts the command only if it comes from one of the relay
30619 hosts. In practice, you will probably want to make your ACL more sophisticated
30620 than this, for example, by including sender and recipient verification. The
30621 default configuration includes a more comprehensive example, which is described
30622 in chapter &<<CHAPdefconfil>>&.
30623
30624
30625
30626 .section "Checking a relay configuration" "SECTcheralcon"
30627 .cindex "relaying" "checking control of"
30628 You can check the relay characteristics of your configuration in the same way
30629 that you can test any ACL behaviour for an incoming SMTP connection, by using
30630 the &%-bh%& option to run a fake SMTP session with which you interact.
30631
30632 For specifically testing for unwanted relaying, the host
30633 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30634 host from the host on which Exim is running, using the normal telnet port, you
30635 will see a normal telnet connection message and then quite a long delay. Be
30636 patient. The remote host is making an SMTP connection back to your host, and
30637 trying a number of common probes to test for open relay vulnerability. The
30638 results of the tests will eventually appear on your terminal.
30639 .ecindex IIDacl
30640
30641
30642
30643 . ////////////////////////////////////////////////////////////////////////////
30644 . ////////////////////////////////////////////////////////////////////////////
30645
30646 .chapter "Content scanning at ACL time" "CHAPexiscan"
30647 .scindex IIDcosca "content scanning" "at ACL time"
30648 The extension of Exim to include content scanning at ACL time, formerly known
30649 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30650 was integrated into the main source for Exim release 4.50, and Tom continues to
30651 maintain it. Most of the wording of this chapter is taken from Tom's
30652 specification.
30653
30654 It is also possible to scan the content of messages at other times. The
30655 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30656 scanning after all the ACLs have run. A transport filter can be used to scan
30657 messages at delivery time (see the &%transport_filter%& option, described in
30658 chapter &<<CHAPtransportgeneric>>&).
30659
30660 If you want to include the ACL-time content-scanning features when you compile
30661 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30662 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30663
30664 .ilist
30665 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30666 for all MIME parts for SMTP and non-SMTP messages, respectively.
30667 .next
30668 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30669 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30670 run at the end of message reception (the &%acl_smtp_data%& ACL).
30671 .next
30672 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30673 of messages, or parts of messages, for debugging purposes.
30674 .next
30675 Additional expansion variables that are set in the new ACL and by the new
30676 conditions.
30677 .next
30678 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30679 .endlist
30680
30681 There is another content-scanning configuration option for &_Local/Makefile_&,
30682 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30683 condition is compiled, in addition to all the other content-scanning features.
30684
30685 Content-scanning is continually evolving, and new features are still being
30686 added. While such features are still unstable and liable to incompatible
30687 changes, they are made available in Exim by setting options whose names begin
30688 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30689 this manual. You can find out about them by reading the file called
30690 &_doc/experimental.txt_&.
30691
30692 All the content-scanning facilities work on a MBOX copy of the message that is
30693 temporarily created in a file called:
30694 .display
30695 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30696 .endd
30697 The &_.eml_& extension is a friendly hint to virus scanners that they can
30698 expect an MBOX-like structure inside that file. The file is created when the
30699 first content scanning facility is called. Subsequent calls to content
30700 scanning conditions open the same file again. The directory is recursively
30701 removed when the &%acl_smtp_data%& ACL has finished running, unless
30702 .code
30703 control = no_mbox_unspool
30704 .endd
30705 has been encountered. When the MIME ACL decodes files, they are put into the
30706 same directory by default.
30707
30708
30709
30710 .section "Scanning for viruses" "SECTscanvirus"
30711 .cindex "virus scanning"
30712 .cindex "content scanning" "for viruses"
30713 .cindex "content scanning" "the &%malware%& condition"
30714 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30715 It supports a &"generic"& interface to scanners called via the shell, and
30716 specialized interfaces for &"daemon"& type virus scanners, which are resident
30717 in memory and thus are much faster.
30718
30719 A timeout of 2 minutes is applied to a scanner call (by default);
30720 if it expires then a defer action is taken.
30721
30722 .oindex "&%av_scanner%&"
30723 You can set the &%av_scanner%& option in the main part of the configuration
30724 to specify which scanner to use, together with any additional options that
30725 are needed. The basic syntax is as follows:
30726 .display
30727 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30728 .endd
30729 If you do not set &%av_scanner%&, it defaults to
30730 .code
30731 av_scanner = sophie:/var/run/sophie
30732 .endd
30733 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30734 before use.
30735 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30736 The following scanner types are supported in this release:
30737
30738 .vlist
30739 .vitem &%avast%&
30740 .cindex "virus scanners" "avast"
30741 This is the scanner daemon of Avast. It has been tested with Avast Core
30742 Security (currently at version 1.1.7).
30743 You can get a trial version at &url(http://www.avast.com) or for Linux
30744 at &url(http://www.avast.com/linux-server-antivirus).
30745 This scanner type takes one option,
30746 which can be either a full path to a UNIX socket,
30747 or host and port specifiers separated by white space.
30748 The host may be a name or an IP address; the port is either a
30749 single number or a pair of numbers with a dash between.
30750 Any further options are given, on separate lines,
30751 to the daemon as options before the main scan command.
30752 For example:
30753 .code
30754 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30755 av_scanner = avast:192.168.2.22 5036
30756 .endd
30757 If you omit the argument, the default path
30758 &_/var/run/avast/scan.sock_&
30759 is used.
30760 If you use a remote host,
30761 you need to make Exim's spool directory available to it,
30762 as the scanner is passed a file path, not file contents.
30763 For information about available commands and their options you may use
30764 .code
30765 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30766     FLAGS
30767     SENSITIVITY
30768     PACK
30769 .endd
30770
30771
30772 .vitem &%aveserver%&
30773 .cindex "virus scanners" "Kaspersky"
30774 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30775 at &url(http://www.kaspersky.com). This scanner type takes one option,
30776 which is the path to the daemon's UNIX socket. The default is shown in this
30777 example:
30778 .code
30779 av_scanner = aveserver:/var/run/aveserver
30780 .endd
30781
30782
30783 .vitem &%clamd%&
30784 .cindex "virus scanners" "clamd"
30785 This daemon-type scanner is GPL and free. You can get it at
30786 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30787 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30788 in the MIME ACL. This is no longer believed to be necessary.
30789
30790 The options are a list of server specifiers, which may be
30791 a UNIX socket specification,
30792 a TCP socket specification,
30793 or a (global) option.
30794
30795 A socket specification consists of a space-separated list.
30796 For a Unix socket the first element is a full path for the socket,
30797 for a TCP socket the first element is the IP address
30798 and the second a port number,
30799 Any further elements are per-server (non-global) options.
30800 These per-server options are supported:
30801 .code
30802 retry=<timespec>        Retry on connect fail
30803 .endd
30804
30805 The &`retry`& option specifies a time after which a single retry for
30806 a failed connect is made.  The default is to not retry.
30807
30808 If a Unix socket file is specified, only one server is supported.
30809
30810 Examples:
30811 .code
30812 av_scanner = clamd:/opt/clamd/socket
30813 av_scanner = clamd:192.0.2.3 1234
30814 av_scanner = clamd:192.0.2.3 1234:local
30815 av_scanner = clamd:192.0.2.3 1234 retry=10s
30816 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30817 .endd
30818 If the value of av_scanner points to a UNIX socket file or contains the
30819 &`local`&
30820 option, then the ClamAV interface will pass a filename containing the data
30821 to be scanned, which will should normally result in less I/O happening and be
30822 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30823 Exim does not assume that there is a common filesystem with the remote host.
30824 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30825 you be running a version of ClamAV prior to 0.95.
30826
30827 The final example shows that multiple TCP targets can be specified.  Exim will
30828 randomly use one for each incoming email (i.e. it load balances them).  Note
30829 that only TCP targets may be used if specifying a list of scanners; a UNIX
30830 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30831 unavailable, Exim will try the remaining one(s) until it finds one that works.
30832 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30833 not keep track of scanner state between multiple messages, and the scanner
30834 selection is random, so the message will get logged in the mainlog for each
30835 email that the down scanner gets chosen first (message wrapped to be readable):
30836 .code
30837 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30838    clamd: connection to localhost, port 3310 failed
30839    (Connection refused)
30840 .endd
30841
30842 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30843 contributing the code for this scanner.
30844
30845 .vitem &%cmdline%&
30846 .cindex "virus scanners" "command line interface"
30847 This is the keyword for the generic command line scanner interface. It can be
30848 used to attach virus scanners that are invoked from the shell. This scanner
30849 type takes 3 mandatory options:
30850
30851 .olist
30852 The full path and name of the scanner binary, with all command line options,
30853 and a placeholder (&`%s`&) for the directory to scan.
30854
30855 .next
30856 A regular expression to match against the STDOUT and STDERR output of the
30857 virus scanner. If the expression matches, a virus was found. You must make
30858 absolutely sure that this expression matches on &"virus found"&. This is called
30859 the &"trigger"& expression.
30860
30861 .next
30862 Another regular expression, containing exactly one pair of parentheses, to
30863 match the name of the virus found in the scanners output. This is called the
30864 &"name"& expression.
30865 .endlist olist
30866
30867 For example, Sophos Sweep reports a virus on a line like this:
30868 .code
30869 Virus 'W32/Magistr-B' found in file ./those.bat
30870 .endd
30871 For the trigger expression, we can match the phrase &"found in file"&. For the
30872 name expression, we want to extract the W32/Magistr-B string, so we can match
30873 for the single quotes left and right of it. Altogether, this makes the
30874 configuration setting:
30875 .code
30876 av_scanner = cmdline:\
30877              /path/to/sweep -ss -all -rec -archive %s:\
30878              found in file:'(.+)'
30879 .endd
30880 .vitem &%drweb%&
30881 .cindex "virus scanners" "DrWeb"
30882 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30883 takes one option,
30884 either a full path to a UNIX socket,
30885 or host and port specifiers separated by white space.
30886 The host may be a name or an IP address; the port is either a
30887 single number or a pair of numbers with a dash between.
30888 For example:
30889 .code
30890 av_scanner = drweb:/var/run/drwebd.sock
30891 av_scanner = drweb:192.168.2.20 31337
30892 .endd
30893 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30894 is used. Thanks to Alex Miller for contributing the code for this scanner.
30895
30896 .vitem &%f-protd%&
30897 .cindex "virus scanners" "f-protd"
30898 The f-protd scanner is accessed via HTTP over TCP.
30899 One argument is taken, being a space-separated hostname and port number
30900 (or port-range).
30901 For example:
30902 .code
30903 av_scanner = f-protd:localhost 10200-10204
30904 .endd
30905 If you omit the argument, the default values show above are used.
30906
30907 .vitem &%fsecure%&
30908 .cindex "virus scanners" "F-Secure"
30909 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30910 argument which is the path to a UNIX socket. For example:
30911 .code
30912 av_scanner = fsecure:/path/to/.fsav
30913 .endd
30914 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30915 Thelmen for contributing the code for this scanner.
30916
30917 .vitem &%kavdaemon%&
30918 .cindex "virus scanners" "Kaspersky"
30919 This is the scanner daemon of Kaspersky Version 4. This version of the
30920 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30921 scanner type takes one option, which is the path to the daemon's UNIX socket.
30922 For example:
30923 .code
30924 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30925 .endd
30926 The default path is &_/var/run/AvpCtl_&.
30927
30928 .vitem &%mksd%&
30929 .cindex "virus scanners" "mksd"
30930 This is a daemon type scanner that is aimed mainly at Polish users, though some
30931 parts of documentation are now available in English. You can get it at
30932 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30933 the maximum number of processes used simultaneously to scan the attachments,
30934 provided that the demime facility is employed and also provided that mksd has
30935 been run with at least the same number of child processes. For example:
30936 .code
30937 av_scanner = mksd:2
30938 .endd
30939 You can safely omit this option (the default value is 1).
30940
30941 .vitem &%sock%&
30942 .cindex "virus scanners" "simple socket-connected"
30943 This is a general-purpose way of talking to simple scanner daemons
30944 running on the local machine.
30945 There are four options:
30946 an address (which may be an IP address and port, or the path of a Unix socket),
30947 a commandline to send (may include a single %s which will be replaced with
30948 the path to the mail file to be scanned),
30949 an RE to trigger on from the returned data,
30950 an RE to extract malware_name from the returned data.
30951 For example:
30952 .code
30953 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30954 .endd
30955 Default for the socket specifier is &_/tmp/malware.sock_&.
30956 Default for the commandline is &_%s\n_&.
30957 Both regular-expressions are required.
30958
30959 .vitem &%sophie%&
30960 .cindex "virus scanners" "Sophos and Sophie"
30961 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30962 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30963 for this scanner type is the path to the UNIX socket that Sophie uses for
30964 client communication. For example:
30965 .code
30966 av_scanner = sophie:/tmp/sophie
30967 .endd
30968 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30969 the option.
30970 .endlist
30971
30972 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30973 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30974 ACL.
30975
30976 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30977 makes it possible to use different scanners. See further below for an example.
30978 The &%malware%& condition caches its results, so when you use it multiple times
30979 for the same message, the actual scanning process is only carried out once.
30980 However, using expandable items in &%av_scanner%& disables this caching, in
30981 which case each use of the &%malware%& condition causes a new scan of the
30982 message.
30983
30984 The &%malware%& condition takes a right-hand argument that is expanded before
30985 use and taken as a list, slash-separated by default.
30986 The first element can then be one of
30987
30988 .ilist
30989 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30990 The condition succeeds if a virus was found, and fail otherwise. This is the
30991 recommended usage.
30992 .next
30993 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30994 the condition fails immediately.
30995 .next
30996 A regular expression, in which case the message is scanned for viruses. The
30997 condition succeeds if a virus is found and its name matches the regular
30998 expression. This allows you to take special actions on certain types of virus.
30999 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31000 unless the separator is changed (in the usual way).
31001 .endlist
31002
31003 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31004 messages even if there is a problem with the virus scanner.
31005 Otherwise, such a problem causes the ACL to defer.
31006
31007 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31008 specify a non-default timeout.  The default is two minutes.
31009 For example:
31010 .code
31011 malware = * / defer_ok / tmo=10s
31012 .endd
31013 A timeout causes the ACL to defer.
31014
31015 .vindex "&$callout_address$&"
31016 When a connection is made to the scanner the expansion variable &$callout_address$&
31017 is set to record the actual address used.
31018
31019 .vindex "&$malware_name$&"
31020 When a virus is found, the condition sets up an expansion variable called
31021 &$malware_name$& that contains the name of the virus. You can use it in a
31022 &%message%& modifier that specifies the error returned to the sender, and/or in
31023 logging data.
31024
31025 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
31026 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
31027 &%malware%& condition.
31028
31029 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31030 imposed by your anti-virus scanner.
31031
31032 Here is a very simple scanning example:
31033 .code
31034 deny message = This message contains malware ($malware_name)
31035      demime = *
31036      malware = *
31037 .endd
31038 The next example accepts messages when there is a problem with the scanner:
31039 .code
31040 deny message = This message contains malware ($malware_name)
31041      demime = *
31042      malware = */defer_ok
31043 .endd
31044 The next example shows how to use an ACL variable to scan with both sophie and
31045 aveserver. It assumes you have set:
31046 .code
31047 av_scanner = $acl_m0
31048 .endd
31049 in the main Exim configuration.
31050 .code
31051 deny message = This message contains malware ($malware_name)
31052      set acl_m0 = sophie
31053      malware = *
31054
31055 deny message = This message contains malware ($malware_name)
31056      set acl_m0 = aveserver
31057      malware = *
31058 .endd
31059
31060
31061 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31062 .cindex "content scanning" "for spam"
31063 .cindex "spam scanning"
31064 .cindex "SpamAssassin"
31065 .cindex "Rspamd"
31066 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31067 score and a report for the message.
31068 Support is also provided for Rspamd.
31069
31070 For more information about installation and configuration of SpamAssassin or
31071 Rspamd refer to their respective websites at
31072 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31073
31074 SpamAssassin can be installed with CPAN by running:
31075 .code
31076 perl -MCPAN -e 'install Mail::SpamAssassin'
31077 .endd
31078 SpamAssassin has its own set of configuration files. Please review its
31079 documentation to see how you can tweak it. The default installation should work
31080 nicely, however.
31081
31082 .oindex "&%spamd_address%&"
31083 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31084 intend to use an instance running on the local host you do not need to set
31085 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31086 you must set the &%spamd_address%& option in the global part of the Exim
31087 configuration as follows (example):
31088 .code
31089 spamd_address = 192.168.99.45 387
31090 .endd
31091
31092 To use Rspamd (which by default listens on all local addresses
31093 on TCP port 11333)
31094 you should add &%variant=rspamd%& after the address/port pair, for example:
31095 .code
31096 spamd_address = 127.0.0.1 11333 variant=rspamd
31097 .endd
31098
31099 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31100 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31101 file name instead of an address/port pair:
31102 .code
31103 spamd_address = /var/run/spamd_socket
31104 .endd
31105 You can have multiple &%spamd%& servers to improve scalability. These can
31106 reside on other hardware reachable over the network. To specify multiple
31107 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31108 option, separated with colons (the separator can be changed in the usual way):
31109 .code
31110 spamd_address = 192.168.2.10 783 : \
31111                 192.168.2.11 783 : \
31112                 192.168.2.12 783
31113 .endd
31114 Up to 32 &%spamd%& servers are supported.
31115 When a server fails to respond to the connection attempt, all other
31116 servers are tried until one succeeds. If no server responds, the &%spam%&
31117 condition defers.
31118
31119 Unix and TCP socket specifications may be mixed in any order.
31120 Each element of the list is a list itself, space-separated by default
31121 and changeable in the usual way.
31122
31123 For TCP socket specifications a host name or IP (v4 or v6, but
31124 subject to list-separator quoting rules) address can be used,
31125 and the port can be one or a dash-separated pair.
31126 In the latter case, the range is tried in strict order.
31127
31128 Elements after the first for Unix sockets, or second for TCP socket,
31129 are options.
31130 The supported options are:
31131 .code
31132 pri=<priority>      Selection priority
31133 weight=<value>      Selection bias
31134 time=<start>-<end>  Use only between these times of day
31135 retry=<timespec>    Retry on connect fail
31136 tmo=<timespec>      Connection time limit
31137 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31138 .endd
31139
31140 The &`pri`& option specifies a priority for the server within the list,
31141 higher values being tried first.
31142 The default priority is 1.
31143
31144 The &`weight`& option specifies a selection bias.
31145 Within a priority set
31146 servers are queried in a random fashion, weighted by this value.
31147 The default value for selection bias is 1.
31148
31149 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31150 in the local time zone; each element being one or more digits.
31151 Either the seconds or both minutes and seconds, plus the leading &`.`&
31152 characters, may be omitted and will be taken as zero.
31153
31154 Timeout specifications for the &`retry`& and &`tmo`& options
31155 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31156
31157 The &`tmo`& option specifies an overall timeout for communication.
31158 The default value is two minutes.
31159
31160 The &`retry`& option specifies a time after which a single retry for
31161 a failed connect is made.
31162 The default is to not retry.
31163
31164 The &%spamd_address%& variable is expanded before use if it starts with
31165 a dollar sign. In this case, the expansion may return a string that is
31166 used as the list so that multiple spamd servers can be the result of an
31167 expansion.
31168
31169 .vindex "&$callout_address$&"
31170 When a connection is made to the server the expansion variable &$callout_address$&
31171 is set to record the actual address used.
31172
31173 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31174 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31175 .code
31176 deny message = This message was classified as SPAM
31177      spam = joe
31178 .endd
31179 The right-hand side of the &%spam%& condition specifies a name. This is
31180 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31181 to scan using a specific profile, but rather use the SpamAssassin system-wide
31182 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31183 Rspamd does not use this setting. However, you must put something on the
31184 right-hand side.
31185
31186 The name allows you to use per-domain or per-user antispam profiles in
31187 principle, but this is not straightforward in practice, because a message may
31188 have multiple recipients, not necessarily all in the same domain. Because the
31189 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31190 read the contents of the message, the variables &$local_part$& and &$domain$&
31191 are not set.
31192 Careful enforcement of single-recipient messages
31193 (e.g. by responding with defer in the recipient ACL for all recipients
31194 after the first),
31195 or the use of PRDR,
31196 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31197 are needed to use this feature.
31198
31199 The right-hand side of the &%spam%& condition is expanded before being used, so
31200 you can put lookups or conditions there. When the right-hand side evaluates to
31201 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31202
31203
31204 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31205 large ones may cause significant performance degradation. As most spam messages
31206 are quite small, it is recommended that you do not scan the big ones. For
31207 example:
31208 .code
31209 deny message = This message was classified as SPAM
31210      condition = ${if < {$message_size}{10K}}
31211      spam = nobody
31212 .endd
31213
31214 The &%spam%& condition returns true if the threshold specified in the user's
31215 SpamAssassin profile has been matched or exceeded. If you want to use the
31216 &%spam%& condition for its side effects (see the variables below), you can make
31217 it always return &"true"& by appending &`:true`& to the username.
31218
31219 .cindex "spam scanning" "returned variables"
31220 When the &%spam%& condition is run, it sets up a number of expansion
31221 variables.
31222 Except for &$spam_report$&,
31223 these variables are saved with the received message so are
31224 available for use at delivery time.
31225
31226 .vlist
31227 .vitem &$spam_score$&
31228 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31229 for inclusion in log or reject messages.
31230
31231 .vitem &$spam_score_int$&
31232 The spam score of the message, multiplied by ten, as an integer value. For
31233 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31234 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31235 The integer value is useful for numeric comparisons in conditions.
31236
31237 .vitem &$spam_bar$&
31238 A string consisting of a number of &"+"& or &"-"& characters, representing the
31239 integer part of the spam score value. A spam score of 4.4 would have a
31240 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31241 headers, since MUAs can match on such strings. The maximum length of the
31242 spam bar is 50 characters.
31243
31244 .vitem &$spam_report$&
31245 A multiline text table, containing the full SpamAssassin report for the
31246 message. Useful for inclusion in headers or reject messages.
31247 This variable is only usable in a DATA-time ACL.
31248
31249 .vitem &$spam_action$&
31250 For SpamAssassin either 'reject' or 'no action' depending on the
31251 spam score versus threshold.
31252 For Rspamd, the recommended action.
31253
31254 .endlist
31255
31256 The &%spam%& condition caches its results unless expansion in
31257 spamd_address was used. If you call it again with the same user name, it
31258 does not scan again, but rather returns the same values as before.
31259
31260 The &%spam%& condition returns DEFER if there is any error while running
31261 the message through SpamAssassin or if the expansion of spamd_address
31262 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31263 statement block), append &`/defer_ok`& to the right-hand side of the
31264 spam condition, like this:
31265 .code
31266 deny message = This message was classified as SPAM
31267      spam    = joe/defer_ok
31268 .endd
31269 This causes messages to be accepted even if there is a problem with &%spamd%&.
31270
31271 Here is a longer, commented example of the use of the &%spam%&
31272 condition:
31273 .code
31274 # put headers in all messages (no matter if spam or not)
31275 warn  spam = nobody:true
31276       add_header = X-Spam-Score: $spam_score ($spam_bar)
31277       add_header = X-Spam-Report: $spam_report
31278
31279 # add second subject line with *SPAM* marker when message
31280 # is over threshold
31281 warn  spam = nobody
31282       add_header = Subject: *SPAM* $h_Subject:
31283
31284 # reject spam at high scores (> 12)
31285 deny  message = This message scored $spam_score spam points.
31286       spam = nobody:true
31287       condition = ${if >{$spam_score_int}{120}{1}{0}}
31288 .endd
31289
31290
31291
31292 .section "Scanning MIME parts" "SECTscanmimepart"
31293 .cindex "content scanning" "MIME parts"
31294 .cindex "MIME content scanning"
31295 .oindex "&%acl_smtp_mime%&"
31296 .oindex "&%acl_not_smtp_mime%&"
31297 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31298 each MIME part of an SMTP message, including multipart types, in the sequence
31299 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31300 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31301 options may both refer to the same ACL if you want the same processing in both
31302 cases.
31303
31304 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31305 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31306 the case of a non-SMTP message. However, a MIME ACL is called only if the
31307 message contains a &'Content-Type:'& header line. When a call to a MIME
31308 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31309 result code is sent to the client. In the case of an SMTP message, the
31310 &%acl_smtp_data%& ACL is not called when this happens.
31311
31312 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31313 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31314 condition to match against the raw MIME part. You can also use the
31315 &%mime_regex%& condition to match against the decoded MIME part (see section
31316 &<<SECTscanregex>>&).
31317
31318 At the start of a MIME ACL, a number of variables are set from the header
31319 information for the relevant MIME part. These are described below. The contents
31320 of the MIME part are not by default decoded into a disk file except for MIME
31321 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31322 part into a disk file, you can use the &%decode%& condition. The general
31323 syntax is:
31324 .display
31325 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31326 .endd
31327 The right hand side is expanded before use. After expansion,
31328 the value can be:
31329
31330 .olist
31331 &"0"& or &"false"&, in which case no decoding is done.
31332 .next
31333 The string &"default"&. In that case, the file is put in the temporary
31334 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31335 a sequential file name consisting of the message id and a sequence number. The
31336 full path and name is available in &$mime_decoded_filename$& after decoding.
31337 .next
31338 A full path name starting with a slash. If the full name is an existing
31339 directory, it is used as a replacement for the default directory. The filename
31340 is then sequentially assigned. If the path does not exist, it is used as
31341 the full path and file name.
31342 .next
31343 If the string does not start with a slash, it is used as the
31344 filename, and the default path is then used.
31345 .endlist
31346 The &%decode%& condition normally succeeds. It is only false for syntax
31347 errors or unusual circumstances such as memory shortages. You can easily decode
31348 a file with its original, proposed filename using
31349 .code
31350 decode = $mime_filename
31351 .endd
31352 However, you should keep in mind that &$mime_filename$& might contain
31353 anything. If you place files outside of the default path, they are not
31354 automatically unlinked.
31355
31356 For RFC822 attachments (these are messages attached to messages, with a
31357 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31358 as for the primary message, only that the &$mime_is_rfc822$& expansion
31359 variable is set (see below). Attached messages are always decoded to disk
31360 before being checked, and the files are unlinked once the check is done.
31361
31362 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31363 used to match regular expressions against raw and decoded MIME parts,
31364 respectively. They are described in section &<<SECTscanregex>>&.
31365
31366 .cindex "MIME content scanning" "returned variables"
31367 The following list describes all expansion variables that are
31368 available in the MIME ACL:
31369
31370 .vlist
31371 .vitem &$mime_boundary$&
31372 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31373 have a boundary string, which is stored in this variable. If the current part
31374 has no boundary parameter in the &'Content-Type:'& header, this variable
31375 contains the empty string.
31376
31377 .vitem &$mime_charset$&
31378 This variable contains the character set identifier, if one was found in the
31379 &'Content-Type:'& header. Examples for charset identifiers are:
31380 .code
31381 us-ascii
31382 gb2312 (Chinese)
31383 iso-8859-1
31384 .endd
31385 Please note that this value is not normalized, so you should do matches
31386 case-insensitively.
31387
31388 .vitem &$mime_content_description$&
31389 This variable contains the normalized content of the &'Content-Description:'&
31390 header. It can contain a human-readable description of the parts content. Some
31391 implementations repeat the filename for attachments here, but they are usually
31392 only used for display purposes.
31393
31394 .vitem &$mime_content_disposition$&
31395 This variable contains the normalized content of the &'Content-Disposition:'&
31396 header. You can expect strings like &"attachment"& or &"inline"& here.
31397
31398 .vitem &$mime_content_id$&
31399 This variable contains the normalized content of the &'Content-ID:'& header.
31400 This is a unique ID that can be used to reference a part from another part.
31401
31402 .vitem &$mime_content_size$&
31403 This variable is set only after the &%decode%& modifier (see above) has been
31404 successfully run. It contains the size of the decoded part in kilobytes. The
31405 size is always rounded up to full kilobytes, so only a completely empty part
31406 has a &$mime_content_size$& of zero.
31407
31408 .vitem &$mime_content_transfer_encoding$&
31409 This variable contains the normalized content of the
31410 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31411 type. Typical values are &"base64"& and &"quoted-printable"&.
31412
31413 .vitem &$mime_content_type$&
31414 If the MIME part has a &'Content-Type:'& header, this variable contains its
31415 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31416 are some examples of popular MIME types, as they may appear in this variable:
31417 .code
31418 text/plain
31419 text/html
31420 application/octet-stream
31421 image/jpeg
31422 audio/midi
31423 .endd
31424 If the MIME part has no &'Content-Type:'& header, this variable contains the
31425 empty string.
31426
31427 .vitem &$mime_decoded_filename$&
31428 This variable is set only after the &%decode%& modifier (see above) has been
31429 successfully run. It contains the full path and file name of the file
31430 containing the decoded data.
31431 .endlist
31432
31433 .cindex "RFC 2047"
31434 .vlist
31435 .vitem &$mime_filename$&
31436 This is perhaps the most important of the MIME variables. It contains a
31437 proposed filename for an attachment, if one was found in either the
31438 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31439 RFC2047
31440 or RFC2231
31441 decoded, but no additional sanity checks are done.
31442  If no filename was
31443 found, this variable contains the empty string.
31444
31445 .vitem &$mime_is_coverletter$&
31446 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31447 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31448 content in the cover letter, while not restricting attachments at all.
31449
31450 The variable contains 1 (true) for a MIME part believed to be part of the
31451 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31452 follows:
31453
31454 .olist
31455 The outermost MIME part of a message is always a cover letter.
31456
31457 .next
31458 If a multipart/alternative or multipart/related MIME part is a cover letter,
31459 so are all MIME subparts within that multipart.
31460
31461 .next
31462 If any other multipart is a cover letter, the first subpart is a cover letter,
31463 and the rest are attachments.
31464
31465 .next
31466 All parts contained within an attachment multipart are attachments.
31467 .endlist olist
31468
31469 As an example, the following will ban &"HTML mail"& (including that sent with
31470 alternative plain text), while allowing HTML files to be attached. HTML
31471 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31472 .code
31473 deny message = HTML mail is not accepted here
31474 !condition = $mime_is_rfc822
31475 condition = $mime_is_coverletter
31476 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31477 .endd
31478 .vitem &$mime_is_multipart$&
31479 This variable has the value 1 (true) when the current part has the main type
31480 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31481 Since multipart entities only serve as containers for other parts, you may not
31482 want to carry out specific actions on them.
31483
31484 .vitem &$mime_is_rfc822$&
31485 This variable has the value 1 (true) if the current part is not a part of the
31486 checked message itself, but part of an attached message. Attached message
31487 decoding is fully recursive.
31488
31489 .vitem &$mime_part_count$&
31490 This variable is a counter that is raised for each processed MIME part. It
31491 starts at zero for the very first part (which is usually a multipart). The
31492 counter is per-message, so it is reset when processing RFC822 attachments (see
31493 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31494 complete, so you can use it in the DATA ACL to determine the number of MIME
31495 parts of a message. For non-MIME messages, this variable contains the value -1.
31496 .endlist
31497
31498
31499
31500 .section "Scanning with regular expressions" "SECTscanregex"
31501 .cindex "content scanning" "with regular expressions"
31502 .cindex "regular expressions" "content scanning with"
31503 You can specify your own custom regular expression matches on the full body of
31504 the message, or on individual MIME parts.
31505
31506 The &%regex%& condition takes one or more regular expressions as arguments and
31507 matches them against the full message (when called in the DATA ACL) or a raw
31508 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31509 linewise, with a maximum line length of 32K characters. That means you cannot
31510 have multiline matches with the &%regex%& condition.
31511
31512 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31513 to 32K of decoded content (the whole content at once, not linewise). If the
31514 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31515 is decoded automatically when &%mime_regex%& is executed (using default path
31516 and filename values). If the decoded data is larger than  32K, only the first
31517 32K characters are checked.
31518
31519 The regular expressions are passed as a colon-separated list. To include a
31520 literal colon, you must double it. Since the whole right-hand side string is
31521 expanded before being used, you must also escape dollar signs and backslashes
31522 with more backslashes, or use the &`\N`& facility to disable expansion.
31523 Here is a simple example that contains two regular expressions:
31524 .code
31525 deny message = contains blacklisted regex ($regex_match_string)
31526      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31527 .endd
31528 The conditions returns true if any one of the regular expressions matches. The
31529 &$regex_match_string$& expansion variable is then set up and contains the
31530 matching regular expression.
31531 The expansion variables &$regex1$& &$regex2$& etc
31532 are set to any substrings captured by the regular expression.
31533
31534 &*Warning*&: With large messages, these conditions can be fairly
31535 CPU-intensive.
31536
31537
31538
31539
31540 .section "The demime condition" "SECTdemimecond"
31541 .cindex "content scanning" "MIME checking"
31542 .cindex "MIME content scanning"
31543 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31544 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31545 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31546 ACL functionality, but provides no additional facilities. Please note that this
31547 condition is deprecated and kept only for backward compatibility. You must set
31548 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31549 use the &%demime%& condition.
31550
31551 The &%demime%& condition unpacks MIME containers in the message. It detects
31552 errors in MIME containers and can match file extensions found in the message
31553 against a list. Using this facility produces files containing the unpacked MIME
31554 parts of the message in the temporary scan directory. If you do antivirus
31555 scanning, it is recommended that you use the &%demime%& condition before the
31556 antivirus (&%malware%&) condition.
31557
31558 On the right-hand side of the &%demime%& condition you can pass a
31559 colon-separated list of file extensions that it should match against. For
31560 example:
31561 .code
31562 deny message = Found blacklisted file attachment
31563      demime  = vbs:com:bat:pif:prf:lnk
31564 .endd
31565 If one of the file extensions is found, the condition is true, otherwise it is
31566 false. If there is a temporary error while demimeing (for example, &"disk
31567 full"&), the condition defers, and the message is temporarily rejected (unless
31568 the condition is on a &%warn%& verb).
31569
31570 The right-hand side is expanded before being treated as a list, so you can have
31571 conditions and lookups there. If it expands to an empty string, &"false"&, or
31572 zero (&"0"&), no demimeing is done and the condition is false.
31573
31574 The &%demime%& condition set the following variables:
31575
31576 .vlist
31577 .vitem &$demime_errorlevel$&
31578 .vindex "&$demime_errorlevel$&"
31579 When an error is detected in a MIME container, this variable contains the
31580 severity of the error, as an integer number. The higher the value, the more
31581 severe the error (the current maximum value is 3). If this variable is unset or
31582 zero, no error occurred.
31583
31584 .vitem &$demime_reason$&
31585 .vindex "&$demime_reason$&"
31586 When &$demime_errorlevel$& is greater than zero, this variable contains a
31587 human-readable text string describing the MIME error that occurred.
31588 .endlist
31589
31590 .vlist
31591 .vitem &$found_extension$&
31592 .vindex "&$found_extension$&"
31593 When the &%demime%& condition is true, this variable contains the file
31594 extension it found.
31595 .endlist
31596
31597 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31598 the &%demime%& condition, and are not changed on subsequent calls.
31599
31600 If you do not want to check for file extensions, but rather use the &%demime%&
31601 condition for unpacking or error checking purposes, pass &"*"& as the
31602 right-hand side value. Here is a more elaborate example of how to use this
31603 facility:
31604 .code
31605 # Reject messages with serious MIME container errors
31606 deny  message = Found MIME error ($demime_reason).
31607       demime = *
31608       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31609
31610 # Reject known virus spreading file extensions.
31611 # Accepting these is pretty much braindead.
31612 deny  message = contains $found_extension file (blacklisted).
31613       demime  = com:vbs:bat:pif:scr
31614
31615 # Freeze .exe and .doc files. Postmaster can
31616 # examine them and eventually thaw them.
31617 deny  log_message = Another $found_extension file.
31618       demime = exe:doc
31619       control = freeze
31620 .endd
31621 .ecindex IIDcosca
31622
31623
31624
31625
31626 . ////////////////////////////////////////////////////////////////////////////
31627 . ////////////////////////////////////////////////////////////////////////////
31628
31629 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31630          "Local scan function"
31631 .scindex IIDlosca "&[local_scan()]& function" "description of"
31632 .cindex "customizing" "input scan using C function"
31633 .cindex "policy control" "by local scan function"
31634 In these days of email worms, viruses, and ever-increasing spam, some sites
31635 want to apply a lot of checking to messages before accepting them.
31636
31637 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31638 passing messages to external virus and spam scanning software. You can also do
31639 a certain amount in Exim itself through string expansions and the &%condition%&
31640 condition in the ACL that runs after the SMTP DATA command or the ACL for
31641 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31642
31643 To allow for further customization to a site's own requirements, there is the
31644 possibility of linking Exim with a private message scanning function, written
31645 in C. If you want to run code that is written in something other than C, you
31646 can of course use a little C stub to call it.
31647
31648 The local scan function is run once for every incoming message, at the point
31649 when Exim is just about to accept the message.
31650 It can therefore be used to control non-SMTP messages from local processes as
31651 well as messages arriving via SMTP.
31652
31653 Exim applies a timeout to calls of the local scan function, and there is an
31654 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31655 Zero means &"no timeout"&.
31656 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31657 before calling the local scan function, so that the most common types of crash
31658 are caught. If the timeout is exceeded or one of those signals is caught, the
31659 incoming message is rejected with a temporary error if it is an SMTP message.
31660 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31661 code. The incident is logged on the main and reject logs.
31662
31663
31664
31665 .section "Building Exim to use a local scan function" "SECID207"
31666 .cindex "&[local_scan()]& function" "building Exim to use"
31667 To make use of the local scan function feature, you must tell Exim where your
31668 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31669 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31670 directory, so you might set
31671 .code
31672 LOCAL_SCAN_SOURCE=Local/local_scan.c
31673 .endd
31674 for example. The function must be called &[local_scan()]&. It is called by
31675 Exim after it has received a message, when the success return code is about to
31676 be sent. This is after all the ACLs have been run. The return code from your
31677 function controls whether the message is actually accepted or not. There is a
31678 commented template function (that just accepts the message) in the file
31679 _src/local_scan.c_.
31680
31681 If you want to make use of Exim's run time configuration file to set options
31682 for your &[local_scan()]& function, you must also set
31683 .code
31684 LOCAL_SCAN_HAS_OPTIONS=yes
31685 .endd
31686 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31687
31688
31689
31690
31691 .section "API for local_scan()" "SECTapiforloc"
31692 .cindex "&[local_scan()]& function" "API description"
31693 You must include this line near the start of your code:
31694 .code
31695 #include "local_scan.h"
31696 .endd
31697 This header file defines a number of variables and other values, and the
31698 prototype for the function itself. Exim is coded to use unsigned char values
31699 almost exclusively, and one of the things this header defines is a shorthand
31700 for &`unsigned char`& called &`uschar`&.
31701 It also contains the following macro definitions, to simplify casting character
31702 strings and pointers to character strings:
31703 .code
31704 #define CS   (char *)
31705 #define CCS  (const char *)
31706 #define CSS  (char **)
31707 #define US   (unsigned char *)
31708 #define CUS  (const unsigned char *)
31709 #define USS  (unsigned char **)
31710 .endd
31711 The function prototype for &[local_scan()]& is:
31712 .code
31713 extern int local_scan(int fd, uschar **return_text);
31714 .endd
31715 The arguments are as follows:
31716
31717 .ilist
31718 &%fd%& is a file descriptor for the file that contains the body of the message
31719 (the -D file). The file is open for reading and writing, but updating it is not
31720 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31721
31722 The descriptor is positioned at character 19 of the file, which is the first
31723 character of the body itself, because the first 19 characters are the message
31724 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31725 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31726 case this changes in some future version.
31727 .next
31728 &%return_text%& is an address which you can use to return a pointer to a text
31729 string at the end of the function. The value it points to on entry is NULL.
31730 .endlist
31731
31732 The function must return an &%int%& value which is one of the following macros:
31733
31734 .vlist
31735 .vitem &`LOCAL_SCAN_ACCEPT`&
31736 .vindex "&$local_scan_data$&"
31737 The message is accepted. If you pass back a string of text, it is saved with
31738 the message, and made available in the variable &$local_scan_data$&. No
31739 newlines are permitted (if there are any, they are turned into spaces) and the
31740 maximum length of text is 1000 characters.
31741
31742 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31743 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31744 queued without immediate delivery, and is frozen.
31745
31746 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31747 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31748 queued without immediate delivery.
31749
31750 .vitem &`LOCAL_SCAN_REJECT`&
31751 The message is rejected; the returned text is used as an error message which is
31752 passed back to the sender and which is also logged. Newlines are permitted &--
31753 they cause a multiline response for SMTP rejections, but are converted to
31754 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31755 used.
31756
31757 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31758 The message is temporarily rejected; the returned text is used as an error
31759 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31760 problem"& is used.
31761
31762 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31763 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31764 message is not written to the reject log. It has the effect of unsetting the
31765 &%rejected_header%& log selector for just this rejection. If
31766 &%rejected_header%& is already unset (see the discussion of the
31767 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31768 same as LOCAL_SCAN_REJECT.
31769
31770 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31771 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31772 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31773 .endlist
31774
31775 If the message is not being received by interactive SMTP, rejections are
31776 reported by writing to &%stderr%& or by sending an email, as configured by the
31777 &%-oe%& command line options.
31778
31779
31780
31781 .section "Configuration options for local_scan()" "SECTconoptloc"
31782 .cindex "&[local_scan()]& function" "configuration options"
31783 It is possible to have option settings in the main configuration file
31784 that set values in static variables in the &[local_scan()]& module. If you
31785 want to do this, you must have the line
31786 .code
31787 LOCAL_SCAN_HAS_OPTIONS=yes
31788 .endd
31789 in your &_Local/Makefile_& when you build Exim. (This line is in
31790 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31791 file, you must define static variables to hold the option values, and a table
31792 to define them.
31793
31794 The table must be a vector called &%local_scan_options%&, of type
31795 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31796 and a pointer to the variable that holds the value. The entries must appear in
31797 alphabetical order. Following &%local_scan_options%& you must also define a
31798 variable called &%local_scan_options_count%& that contains the number of
31799 entries in the table. Here is a short example, showing two kinds of option:
31800 .code
31801 static int my_integer_option = 42;
31802 static uschar *my_string_option = US"a default string";
31803
31804 optionlist local_scan_options[] = {
31805   { "my_integer", opt_int,       &my_integer_option },
31806   { "my_string",  opt_stringptr, &my_string_option }
31807 };
31808
31809 int local_scan_options_count =
31810   sizeof(local_scan_options)/sizeof(optionlist);
31811 .endd
31812 The values of the variables can now be changed from Exim's runtime
31813 configuration file by including a local scan section as in this example:
31814 .code
31815 begin local_scan
31816 my_integer = 99
31817 my_string = some string of text...
31818 .endd
31819 The available types of option data are as follows:
31820
31821 .vlist
31822 .vitem &*opt_bool*&
31823 This specifies a boolean (true/false) option. The address should point to a
31824 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31825 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31826 whether such a variable has been set at all, you can initialize it to
31827 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31828 values.)
31829
31830 .vitem &*opt_fixed*&
31831 This specifies a fixed point number, such as is used for load averages.
31832 The address should point to a variable of type &`int`&. The value is stored
31833 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31834
31835 .vitem &*opt_int*&
31836 This specifies an integer; the address should point to a variable of type
31837 &`int`&. The value may be specified in any of the integer formats accepted by
31838 Exim.
31839
31840 .vitem &*opt_mkint*&
31841 This is the same as &%opt_int%&, except that when such a value is output in a
31842 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31843 printed with the suffix K or M.
31844
31845 .vitem &*opt_octint*&
31846 This also specifies an integer, but the value is always interpreted as an
31847 octal integer, whether or not it starts with the digit zero, and it is
31848 always output in octal.
31849
31850 .vitem &*opt_stringptr*&
31851 This specifies a string value; the address must be a pointer to a
31852 variable that points to a string (for example, of type &`uschar *`&).
31853
31854 .vitem &*opt_time*&
31855 This specifies a time interval value. The address must point to a variable of
31856 type &`int`&. The value that is placed there is a number of seconds.
31857 .endlist
31858
31859 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31860 out the values of all the &[local_scan()]& options.
31861
31862
31863
31864 .section "Available Exim variables" "SECID208"
31865 .cindex "&[local_scan()]& function" "available Exim variables"
31866 The header &_local_scan.h_& gives you access to a number of C variables. These
31867 are the only ones that are guaranteed to be maintained from release to release.
31868 Note, however, that you can obtain the value of any Exim expansion variable,
31869 including &$recipients$&, by calling &'expand_string()'&. The exported
31870 C variables are as follows:
31871
31872 .vlist
31873 .vitem &*int&~body_linecount*&
31874 This variable contains the number of lines in the message's body.
31875
31876 .vitem &*int&~body_zerocount*&
31877 This variable contains the number of binary zero bytes in the message's body.
31878
31879 .vitem &*unsigned&~int&~debug_selector*&
31880 This variable is set to zero when no debugging is taking place. Otherwise, it
31881 is a bitmap of debugging selectors. Two bits are identified for use in
31882 &[local_scan()]&; they are defined as macros:
31883
31884 .ilist
31885 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31886 testing option that is not privileged &-- any caller may set it. All the
31887 other selector bits can be set only by admin users.
31888
31889 .next
31890 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31891 by the &`+local_scan`& debug selector. It is not included in the default set
31892 of debugging bits.
31893 .endlist ilist
31894
31895 Thus, to write to the debugging output only when &`+local_scan`& has been
31896 selected, you should use code like this:
31897 .code
31898 if ((debug_selector & D_local_scan) != 0)
31899   debug_printf("xxx", ...);
31900 .endd
31901 .vitem &*uschar&~*expand_string_message*&
31902 After a failing call to &'expand_string()'& (returned value NULL), the
31903 variable &%expand_string_message%& contains the error message, zero-terminated.
31904
31905 .vitem &*header_line&~*header_list*&
31906 A pointer to a chain of header lines. The &%header_line%& structure is
31907 discussed below.
31908
31909 .vitem &*header_line&~*header_last*&
31910 A pointer to the last of the header lines.
31911
31912 .vitem &*uschar&~*headers_charset*&
31913 The value of the &%headers_charset%& configuration option.
31914
31915 .vitem &*BOOL&~host_checking*&
31916 This variable is TRUE during a host checking session that is initiated by the
31917 &%-bh%& command line option.
31918
31919 .vitem &*uschar&~*interface_address*&
31920 The IP address of the interface that received the message, as a string. This
31921 is NULL for locally submitted messages.
31922
31923 .vitem &*int&~interface_port*&
31924 The port on which this message was received. When testing with the &%-bh%&
31925 command line option, the value of this variable is -1 unless a port has been
31926 specified via the &%-oMi%& option.
31927
31928 .vitem &*uschar&~*message_id*&
31929 This variable contains Exim's message id for the incoming message (the value of
31930 &$message_exim_id$&) as a zero-terminated string.
31931
31932 .vitem &*uschar&~*received_protocol*&
31933 The name of the protocol by which the message was received.
31934
31935 .vitem &*int&~recipients_count*&
31936 The number of accepted recipients.
31937
31938 .vitem &*recipient_item&~*recipients_list*&
31939 .cindex "recipient" "adding in local scan"
31940 .cindex "recipient" "removing in local scan"
31941 The list of accepted recipients, held in a vector of length
31942 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31943 can add additional recipients by calling &'receive_add_recipient()'& (see
31944 below). You can delete recipients by removing them from the vector and
31945 adjusting the value in &%recipients_count%&. In particular, by setting
31946 &%recipients_count%& to zero you remove all recipients. If you then return the
31947 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31948 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31949 and then call &'receive_add_recipient()'& as often as needed.
31950
31951 .vitem &*uschar&~*sender_address*&
31952 The envelope sender address. For bounce messages this is the empty string.
31953
31954 .vitem &*uschar&~*sender_host_address*&
31955 The IP address of the sending host, as a string. This is NULL for
31956 locally-submitted messages.
31957
31958 .vitem &*uschar&~*sender_host_authenticated*&
31959 The name of the authentication mechanism that was used, or NULL if the message
31960 was not received over an authenticated SMTP connection.
31961
31962 .vitem &*uschar&~*sender_host_name*&
31963 The name of the sending host, if known.
31964
31965 .vitem &*int&~sender_host_port*&
31966 The port on the sending host.
31967
31968 .vitem &*BOOL&~smtp_input*&
31969 This variable is TRUE for all SMTP input, including BSMTP.
31970
31971 .vitem &*BOOL&~smtp_batched_input*&
31972 This variable is TRUE for BSMTP input.
31973
31974 .vitem &*int&~store_pool*&
31975 The contents of this variable control which pool of memory is used for new
31976 requests. See section &<<SECTmemhanloc>>& for details.
31977 .endlist
31978
31979
31980 .section "Structure of header lines" "SECID209"
31981 The &%header_line%& structure contains the members listed below.
31982 You can add additional header lines by calling the &'header_add()'& function
31983 (see below). You can cause header lines to be ignored (deleted) by setting
31984 their type to *.
31985
31986
31987 .vlist
31988 .vitem &*struct&~header_line&~*next*&
31989 A pointer to the next header line, or NULL for the last line.
31990
31991 .vitem &*int&~type*&
31992 A code identifying certain headers that Exim recognizes. The codes are printing
31993 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31994 Notice in particular that any header line whose type is * is not transmitted
31995 with the message. This flagging is used for header lines that have been
31996 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31997 lines.) Effectively, * means &"deleted"&.
31998
31999 .vitem &*int&~slen*&
32000 The number of characters in the header line, including the terminating and any
32001 internal newlines.
32002
32003 .vitem &*uschar&~*text*&
32004 A pointer to the text of the header. It always ends with a newline, followed by
32005 a zero byte. Internal newlines are preserved.
32006 .endlist
32007
32008
32009
32010 .section "Structure of recipient items" "SECID210"
32011 The &%recipient_item%& structure contains these members:
32012
32013 .vlist
32014 .vitem &*uschar&~*address*&
32015 This is a pointer to the recipient address as it was received.
32016
32017 .vitem &*int&~pno*&
32018 This is used in later Exim processing when top level addresses are created by
32019 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32020 and must always contain -1 at this stage.
32021
32022 .vitem &*uschar&~*errors_to*&
32023 If this value is not NULL, bounce messages caused by failing to deliver to the
32024 recipient are sent to the address it contains. In other words, it overrides the
32025 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32026 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32027 an unqualified address, Exim qualifies it using the domain from
32028 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32029 is NULL for all recipients.
32030 .endlist
32031
32032
32033
32034 .section "Available Exim functions" "SECID211"
32035 .cindex "&[local_scan()]& function" "available Exim functions"
32036 The header &_local_scan.h_& gives you access to a number of Exim functions.
32037 These are the only ones that are guaranteed to be maintained from release to
32038 release:
32039
32040 .vlist
32041 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32042        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32043
32044 This function creates a child process that runs the command specified by
32045 &%argv%&. The environment for the process is specified by &%envp%&, which can
32046 be NULL if no environment variables are to be passed. A new umask is supplied
32047 for the process in &%newumask%&.
32048
32049 Pipes to the standard input and output of the new process are set up
32050 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32051 standard error is cloned to the standard output. If there are any file
32052 descriptors &"in the way"& in the new process, they are closed. If the final
32053 argument is TRUE, the new process is made into a process group leader.
32054
32055 The function returns the pid of the new process, or -1 if things go wrong.
32056
32057 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32058 This function waits for a child process to terminate, or for a timeout (in
32059 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32060 return value is as follows:
32061
32062 .ilist
32063 >= 0
32064
32065 The process terminated by a normal exit and the value is the process
32066 ending status.
32067
32068 .next
32069 < 0 and > &--256
32070
32071 The process was terminated by a signal and the value is the negation of the
32072 signal number.
32073
32074 .next
32075 &--256
32076
32077 The process timed out.
32078 .next
32079 &--257
32080
32081 The was some other error in wait(); &%errno%& is still set.
32082 .endlist
32083
32084 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32085 This function provide you with a means of submitting a new message to
32086 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32087 want, but this packages it all up for you.) The function creates a pipe,
32088 forks a subprocess that is running
32089 .code
32090 exim -t -oem -oi -f <>
32091 .endd
32092 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32093 that is connected to the standard input. The yield of the function is the PID
32094 of the subprocess. You can then write a message to the file descriptor, with
32095 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32096
32097 When you have finished, call &'child_close()'& to wait for the process to
32098 finish and to collect its ending status. A timeout value of zero is usually
32099 fine in this circumstance. Unless you have made a mistake with the recipient
32100 addresses, you should get a return code of zero.
32101
32102
32103 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32104        *sender_authentication)*&
32105 This function is a more sophisticated version of &'child_open()'&. The command
32106 that it runs is:
32107 .display
32108 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32109 .endd
32110 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32111
32112
32113 .vitem &*void&~debug_printf(char&~*,&~...)*&
32114 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32115 output is written to the standard error stream. If no debugging is selected,
32116 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32117 conditional on the &`local_scan`& debug selector by coding like this:
32118 .code
32119 if ((debug_selector & D_local_scan) != 0)
32120   debug_printf("xxx", ...);
32121 .endd
32122
32123 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32124 This is an interface to Exim's string expansion code. The return value is the
32125 expanded string, or NULL if there was an expansion failure.
32126 The C variable &%expand_string_message%& contains an error message after an
32127 expansion failure. If expansion does not change the string, the return value is
32128 the pointer to the input string. Otherwise, the return value points to a new
32129 block of memory that was obtained by a call to &'store_get()'&. See section
32130 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32131
32132 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32133 This function allows you to an add additional header line at the end of the
32134 existing ones. The first argument is the type, and should normally be a space
32135 character. The second argument is a format string and any number of
32136 substitution arguments as for &[sprintf()]&. You may include internal newlines
32137 if you want, and you must ensure that the string ends with a newline.
32138
32139 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32140         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32141 This function adds a new header line at a specified point in the header
32142 chain. The header itself is specified as for &'header_add()'&.
32143
32144 If &%name%& is NULL, the new header is added at the end of the chain if
32145 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32146 NULL, the header lines are searched for the first non-deleted header that
32147 matches the name. If one is found, the new header is added before it if
32148 &%after%& is false. If &%after%& is true, the new header is added after the
32149 found header and any adjacent subsequent ones with the same name (even if
32150 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32151 option controls where the header is added. If it is true, addition is at the
32152 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32153 headers, or at the top if there are no &'Received:'& headers, you could use
32154 .code
32155 header_add_at_position(TRUE, US"Received", TRUE,
32156   ' ', "X-xxx: ...");
32157 .endd
32158 Normally, there is always at least one non-deleted &'Received:'& header, but
32159 there may not be if &%received_header_text%& expands to an empty string.
32160
32161
32162 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32163 This function removes header lines. If &%occurrence%& is zero or negative, all
32164 occurrences of the header are removed. If occurrence is greater than zero, that
32165 particular instance of the header is removed. If no header(s) can be found that
32166 match the specification, the function does nothing.
32167
32168
32169 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32170         int&~length,&~BOOL&~notdel)*&"
32171 This function tests whether the given header has the given name. It is not just
32172 a string comparison, because white space is permitted between the name and the
32173 colon. If the &%notdel%& argument is true, a false return is forced for all
32174 &"deleted"& headers; otherwise they are not treated specially. For example:
32175 .code
32176 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32177 .endd
32178 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32179 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32180 This function base64-encodes a string, which is passed by address and length.
32181 The text may contain bytes of any value, including zero. The result is passed
32182 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32183 zero-terminated.
32184
32185 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32186 This function decodes a base64-encoded string. Its arguments are a
32187 zero-terminated base64-encoded string and the address of a variable that is set
32188 to point to the result, which is in dynamic memory. The length of the decoded
32189 string is the yield of the function. If the input is invalid base64 data, the
32190 yield is -1. A zero byte is added to the end of the output string to make it
32191 easy to interpret as a C string (assuming it contains no zeros of its own). The
32192 added zero byte is not included in the returned count.
32193
32194 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32195 This function checks for a match in a domain list. Domains are always
32196 matched caselessly. The return value is one of the following:
32197 .display
32198 &`OK     `& match succeeded
32199 &`FAIL   `& match failed
32200 &`DEFER  `& match deferred
32201 .endd
32202 DEFER is usually caused by some kind of lookup defer, such as the
32203 inability to contact a database.
32204
32205 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32206         BOOL&~caseless)*&"
32207 This function checks for a match in a local part list. The third argument
32208 controls case-sensitivity. The return values are as for
32209 &'lss_match_domain()'&.
32210
32211 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32212         BOOL&~caseless)*&"
32213 This function checks for a match in an address list. The third argument
32214 controls the case-sensitivity of the local part match. The domain is always
32215 matched caselessly. The return values are as for &'lss_match_domain()'&.
32216
32217 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32218         uschar&~*list)*&"
32219 This function checks for a match in a host list. The most common usage is
32220 expected to be
32221 .code
32222 lss_match_host(sender_host_name, sender_host_address, ...)
32223 .endd
32224 .vindex "&$sender_host_address$&"
32225 An empty address field matches an empty item in the host list. If the host name
32226 is NULL, the name corresponding to &$sender_host_address$& is automatically
32227 looked up if a host name is required to match an item in the list. The return
32228 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32229 returns ERROR in the case when it had to look up a host name, but the lookup
32230 failed.
32231
32232 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32233         *format,&~...)*&"
32234 This function writes to Exim's log files. The first argument should be zero (it
32235 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32236 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32237 them. It specifies to which log or logs the message is written. The remaining
32238 arguments are a format and relevant insertion arguments. The string should not
32239 contain any newlines, not even at the end.
32240
32241
32242 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32243 This function adds an additional recipient to the message. The first argument
32244 is the recipient address. If it is unqualified (has no domain), it is qualified
32245 with the &%qualify_recipient%& domain. The second argument must always be -1.
32246
32247 This function does not allow you to specify a private &%errors_to%& address (as
32248 described with the structure of &%recipient_item%& above), because it pre-dates
32249 the addition of that field to the structure. However, it is easy to add such a
32250 value afterwards. For example:
32251 .code
32252  receive_add_recipient(US"monitor@mydom.example", -1);
32253  recipients_list[recipients_count-1].errors_to =
32254    US"postmaster@mydom.example";
32255 .endd
32256
32257 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32258 This is a convenience function to remove a named recipient from the list of
32259 recipients. It returns true if a recipient was removed, and false if no
32260 matching recipient could be found. The argument must be a complete email
32261 address.
32262 .endlist
32263
32264
32265 .cindex "RFC 2047"
32266 .vlist
32267 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32268   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32269 This function decodes strings that are encoded according to RFC 2047. Typically
32270 these are the contents of header lines. First, each &"encoded word"& is decoded
32271 from the Q or B encoding into a byte-string. Then, if provided with the name of
32272 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32273 made  to translate the result to the named character set. If this fails, the
32274 binary string is returned with an error message.
32275
32276 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32277 maximum MIME word length is enforced. The third argument is the target
32278 encoding, or NULL if no translation is wanted.
32279
32280 .cindex "binary zero" "in RFC 2047 decoding"
32281 .cindex "RFC 2047" "binary zero in"
32282 If a binary zero is encountered in the decoded string, it is replaced by the
32283 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32284 not be 0 because header lines are handled as zero-terminated strings.
32285
32286 The function returns the result of processing the string, zero-terminated; if
32287 &%lenptr%& is not NULL, the length of the result is set in the variable to
32288 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32289
32290 If an error is encountered, the function returns NULL and uses the &%error%&
32291 argument to return an error message. The variable pointed to by &%error%& is
32292 set to NULL if there is no error; it may be set non-NULL even when the function
32293 returns a non-NULL value if decoding was successful, but there was a problem
32294 with translation.
32295
32296
32297 .vitem &*int&~smtp_fflush(void)*&
32298 This function is used in conjunction with &'smtp_printf()'&, as described
32299 below.
32300
32301 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32302 The arguments of this function are like &[printf()]&; it writes to the SMTP
32303 output stream. You should use this function only when there is an SMTP output
32304 stream, that is, when the incoming message is being received via interactive
32305 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32306 is FALSE. If you want to test for an incoming message from another host (as
32307 opposed to a local process that used the &%-bs%& command line option), you can
32308 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32309 is involved.
32310
32311 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32312 output function, so it can be used for all forms of SMTP connection.
32313
32314 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32315 must start with an appropriate response code: 550 if you are going to return
32316 LOCAL_SCAN_REJECT, 451 if you are going to return
32317 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32318 initial lines of a multi-line response, the code must be followed by a hyphen
32319 to indicate that the line is not the final response line. You must also ensure
32320 that the lines you write terminate with CRLF. For example:
32321 .code
32322 smtp_printf("550-this is some extra info\r\n");
32323 return LOCAL_SCAN_REJECT;
32324 .endd
32325 Note that you can also create multi-line responses by including newlines in
32326 the data returned via the &%return_text%& argument. The added value of using
32327 &'smtp_printf()'& is that, for instance, you could introduce delays between
32328 multiple output lines.
32329
32330 The &'smtp_printf()'& function does not return any error indication, because it
32331 does not automatically flush pending output, and therefore does not test
32332 the state of the stream. (In the main code of Exim, flushing and error
32333 detection is done when Exim is ready for the next SMTP input command.) If
32334 you want to flush the output and check for an error (for example, the
32335 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32336 arguments. It flushes the output stream, and returns a non-zero value if there
32337 is an error.
32338
32339 .vitem &*void&~*store_get(int)*&
32340 This function accesses Exim's internal store (memory) manager. It gets a new
32341 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32342 runs out of memory. See the next section for a discussion of memory handling.
32343
32344 .vitem &*void&~*store_get_perm(int)*&
32345 This function is like &'store_get()'&, but it always gets memory from the
32346 permanent pool. See the next section for a discussion of memory handling.
32347
32348 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32349 See below.
32350
32351 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32352 See below.
32353
32354 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32355 These three functions create strings using Exim's dynamic memory facilities.
32356 The first makes a copy of an entire string. The second copies up to a maximum
32357 number of characters, indicated by the second argument. The third uses a format
32358 and insertion arguments to create a new string. In each case, the result is a
32359 pointer to a new string in the current memory pool. See the next section for
32360 more discussion.
32361 .endlist
32362
32363
32364
32365 .section "More about Exim's memory handling" "SECTmemhanloc"
32366 .cindex "&[local_scan()]& function" "memory handling"
32367 No function is provided for freeing memory, because that is never needed.
32368 The dynamic memory that Exim uses when receiving a message is automatically
32369 recycled if another message is received by the same process (this applies only
32370 to incoming SMTP connections &-- other input methods can supply only one
32371 message at a time). After receiving the last message, a reception process
32372 terminates.
32373
32374 Because it is recycled, the normal dynamic memory cannot be used for holding
32375 data that must be preserved over a number of incoming messages on the same SMTP
32376 connection. However, Exim in fact uses two pools of dynamic memory; the second
32377 one is not recycled, and can be used for this purpose.
32378
32379 If you want to allocate memory that remains available for subsequent messages
32380 in the same SMTP connection, you should set
32381 .code
32382 store_pool = POOL_PERM
32383 .endd
32384 before calling the function that does the allocation. There is no need to
32385 restore the value if you do not need to; however, if you do want to revert to
32386 the normal pool, you can either restore the previous value of &%store_pool%& or
32387 set it explicitly to POOL_MAIN.
32388
32389 The pool setting applies to all functions that get dynamic memory, including
32390 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32391 There is also a convenience function called &'store_get_perm()'& that gets a
32392 block of memory from the permanent pool while preserving the value of
32393 &%store_pool%&.
32394 .ecindex IIDlosca
32395
32396
32397
32398
32399 . ////////////////////////////////////////////////////////////////////////////
32400 . ////////////////////////////////////////////////////////////////////////////
32401
32402 .chapter "System-wide message filtering" "CHAPsystemfilter"
32403 .scindex IIDsysfil1 "filter" "system filter"
32404 .scindex IIDsysfil2 "filtering all mail"
32405 .scindex IIDsysfil3 "system filter"
32406 The previous chapters (on ACLs and the local scan function) describe checks
32407 that can be applied to messages before they are accepted by a host. There is
32408 also a mechanism for checking messages once they have been received, but before
32409 they are delivered. This is called the &'system filter'&.
32410
32411 The system filter operates in a similar manner to users' filter files, but it
32412 is run just once per message (however many recipients the message has).
32413 It should not normally be used as a substitute for routing, because &%deliver%&
32414 commands in a system router provide new envelope recipient addresses.
32415 The system filter must be an Exim filter. It cannot be a Sieve filter.
32416
32417 The system filter is run at the start of a delivery attempt, before any routing
32418 is done. If a message fails to be completely delivered at the first attempt,
32419 the system filter is run again at the start of every retry.
32420 If you want your filter to do something only once per message, you can make use
32421 of the &%first_delivery%& condition in an &%if%& command in the filter to
32422 prevent it happening on retries.
32423
32424 .vindex "&$domain$&"
32425 .vindex "&$local_part$&"
32426 &*Warning*&: Because the system filter runs just once, variables that are
32427 specific to individual recipient addresses, such as &$local_part$& and
32428 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32429 you want to run a centrally-specified filter for each recipient address
32430 independently, you can do so by setting up a suitable &(redirect)& router, as
32431 described in section &<<SECTperaddfil>>& below.
32432
32433
32434 .section "Specifying a system filter" "SECID212"
32435 .cindex "uid (user id)" "system filter"
32436 .cindex "gid (group id)" "system filter"
32437 The name of the file that contains the system filter must be specified by
32438 setting &%system_filter%&. If you want the filter to run under a uid and gid
32439 other than root, you must also set &%system_filter_user%& and
32440 &%system_filter_group%& as appropriate. For example:
32441 .code
32442 system_filter = /etc/mail/exim.filter
32443 system_filter_user = exim
32444 .endd
32445 If a system filter generates any deliveries directly to files or pipes (via the
32446 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32447 specified by setting &%system_filter_file_transport%& and
32448 &%system_filter_pipe_transport%&, respectively. Similarly,
32449 &%system_filter_reply_transport%& must be set to handle any messages generated
32450 by the &%reply%& command.
32451
32452
32453 .section "Testing a system filter" "SECID213"
32454 You can run simple tests of a system filter in the same way as for a user
32455 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32456 are permitted only in system filters are recognized.
32457
32458 If you want to test the combined effect of a system filter and a user filter,
32459 you can use both &%-bF%& and &%-bf%& on the same command line.
32460
32461
32462
32463 .section "Contents of a system filter" "SECID214"
32464 The language used to specify system filters is the same as for users' filter
32465 files. It is described in the separate end-user document &'Exim's interface to
32466 mail filtering'&. However, there are some additional features that are
32467 available only in system filters; these are described in subsequent sections.
32468 If they are encountered in a user's filter file or when testing with &%-bf%&,
32469 they cause errors.
32470
32471 .cindex "frozen messages" "manual thaw; testing in filter"
32472 There are two special conditions which, though available in users' filter
32473 files, are designed for use in system filters. The condition &%first_delivery%&
32474 is true only for the first attempt at delivering a message, and
32475 &%manually_thawed%& is true only if the message has been frozen, and
32476 subsequently thawed by an admin user. An explicit forced delivery counts as a
32477 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32478
32479 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32480 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32481 succeed, it will not be tried again.
32482 If you want Exim to retry an unseen delivery until it succeeds, you should
32483 arrange to set it up every time the filter runs.
32484
32485 When a system filter finishes running, the values of the variables &$n0$& &--
32486 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32487 users' filter files. Thus a system filter can, for example, set up &"scores"&
32488 to which users' filter files can refer.
32489
32490
32491
32492 .section "Additional variable for system filters" "SECID215"
32493 .vindex "&$recipients$&"
32494 The expansion variable &$recipients$&, containing a list of all the recipients
32495 of the message (separated by commas and white space), is available in system
32496 filters. It is not available in users' filters for privacy reasons.
32497
32498
32499
32500 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32501 .cindex "freezing messages"
32502 .cindex "message" "freezing"
32503 .cindex "message" "forced failure"
32504 .cindex "&%fail%&" "in system filter"
32505 .cindex "&%freeze%& in system filter"
32506 .cindex "&%defer%& in system filter"
32507 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32508 always available in system filters, but are not normally enabled in users'
32509 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32510 for the &(redirect)& router.) These commands can optionally be followed by the
32511 word &%text%& and a string containing an error message, for example:
32512 .code
32513 fail text "this message looks like spam to me"
32514 .endd
32515 The keyword &%text%& is optional if the next character is a double quote.
32516
32517 The &%defer%& command defers delivery of the original recipients of the
32518 message. The &%fail%& command causes all the original recipients to be failed,
32519 and a bounce message to be created. The &%freeze%& command suspends all
32520 delivery attempts for the original recipients. In all cases, any new deliveries
32521 that are specified by the filter are attempted as normal after the filter has
32522 run.
32523
32524 The &%freeze%& command is ignored if the message has been manually unfrozen and
32525 not manually frozen since. This means that automatic freezing by a system
32526 filter can be used as a way of checking out suspicious messages. If a message
32527 is found to be all right, manually unfreezing it allows it to be delivered.
32528
32529 .cindex "log" "&%fail%& command log line"
32530 .cindex "&%fail%&" "log line; reducing"
32531 The text given with a fail command is used as part of the bounce message as
32532 well as being written to the log. If the message is quite long, this can fill
32533 up a lot of log space when such failures are common. To reduce the size of the
32534 log message, Exim interprets the text in a special way if it starts with the
32535 two characters &`<<`& and contains &`>>`& later. The text between these two
32536 strings is written to the log, and the rest of the text is used in the bounce
32537 message. For example:
32538 .code
32539 fail "<<filter test 1>>Your message is rejected \
32540      because it contains attachments that we are \
32541      not prepared to receive."
32542 .endd
32543
32544 .cindex "loop" "caused by &%fail%&"
32545 Take great care with the &%fail%& command when basing the decision to fail on
32546 the contents of the message, because the bounce message will of course include
32547 the contents of the original message and will therefore trigger the &%fail%&
32548 command again (causing a mail loop) unless steps are taken to prevent this.
32549 Testing the &%error_message%& condition is one way to prevent this. You could
32550 use, for example
32551 .code
32552 if $message_body contains "this is spam" and not error_message
32553 then fail text "spam is not wanted here" endif
32554 .endd
32555 though of course that might let through unwanted bounce messages. The
32556 alternative is clever checking of the body and/or headers to detect bounces
32557 generated by the filter.
32558
32559 The interpretation of a system filter file ceases after a
32560 &%defer%&,
32561 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32562 set up earlier in the filter file are honoured, so you can use a sequence such
32563 as
32564 .code
32565 mail ...
32566 freeze
32567 .endd
32568 to send a specified message when the system filter is freezing (or deferring or
32569 failing) a message. The normal deliveries for the message do not, of course,
32570 take place.
32571
32572
32573
32574 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32575 .cindex "header lines" "adding; in system filter"
32576 .cindex "header lines" "removing; in system filter"
32577 .cindex "filter" "header lines; adding/removing"
32578 Two filter commands that are available only in system filters are:
32579 .code
32580 headers add <string>
32581 headers remove <string>
32582 .endd
32583 The argument for the &%headers add%& is a string that is expanded and then
32584 added to the end of the message's headers. It is the responsibility of the
32585 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32586 space is ignored, and if the string is otherwise empty, or if the expansion is
32587 forced to fail, the command has no effect.
32588
32589 You can use &"\n"& within the string, followed by white space, to specify
32590 continued header lines. More than one header may be added in one command by
32591 including &"\n"& within the string without any following white space. For
32592 example:
32593 .code
32594 headers add "X-header-1: ....\n  \
32595              continuation of X-header-1 ...\n\
32596              X-header-2: ...."
32597 .endd
32598 Note that the header line continuation white space after the first newline must
32599 be placed before the backslash that continues the input string, because white
32600 space after input continuations is ignored.
32601
32602 The argument for &%headers remove%& is a colon-separated list of header names.
32603 This command applies only to those headers that are stored with the message;
32604 those that are added at delivery time (such as &'Envelope-To:'& and
32605 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32606 header with the same name, they are all removed.
32607
32608 The &%headers%& command in a system filter makes an immediate change to the set
32609 of header lines that was received with the message (with possible additions
32610 from ACL processing). Subsequent commands in the system filter operate on the
32611 modified set, which also forms the basis for subsequent message delivery.
32612 Unless further modified during routing or transporting, this set of headers is
32613 used for all recipients of the message.
32614
32615 During routing and transporting, the variables that refer to the contents of
32616 header lines refer only to those lines that are in this set. Thus, header lines
32617 that are added by a system filter are visible to users' filter files and to all
32618 routers and transports. This contrasts with the manipulation of header lines by
32619 routers and transports, which is not immediate, but which instead is saved up
32620 until the message is actually being written (see section
32621 &<<SECTheadersaddrem>>&).
32622
32623 If the message is not delivered at the first attempt, header lines that were
32624 added by the system filter are stored with the message, and so are still
32625 present at the next delivery attempt. Header lines that were removed are still
32626 present, but marked &"deleted"& so that they are not transported with the
32627 message. For this reason, it is usual to make the &%headers%& command
32628 conditional on &%first_delivery%& so that the set of header lines is not
32629 modified more than once.
32630
32631 Because header modification in a system filter acts immediately, you have to
32632 use an indirect approach if you want to modify the contents of a header line.
32633 For example:
32634 .code
32635 headers add "Old-Subject: $h_subject:"
32636 headers remove "Subject"
32637 headers add "Subject: new subject (was: $h_old-subject:)"
32638 headers remove "Old-Subject"
32639 .endd
32640
32641
32642
32643 .section "Setting an errors address in a system filter" "SECID217"
32644 .cindex "envelope sender"
32645 In a system filter, if a &%deliver%& command is followed by
32646 .code
32647 errors_to <some address>
32648 .endd
32649 in order to change the envelope sender (and hence the error reporting) for that
32650 delivery, any address may be specified. (In a user filter, only the current
32651 user's address can be set.) For example, if some mail is being monitored, you
32652 might use
32653 .code
32654 unseen deliver monitor@spying.example errors_to root@local.example
32655 .endd
32656 to take a copy which would not be sent back to the normal error reporting
32657 address if its delivery failed.
32658
32659
32660
32661 .section "Per-address filtering" "SECTperaddfil"
32662 .vindex "&$domain$&"
32663 .vindex "&$local_part$&"
32664 In contrast to the system filter, which is run just once per message for each
32665 delivery attempt, it is also possible to set up a system-wide filtering
32666 operation that runs once for each recipient address. In this case, variables
32667 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32668 filter file could be made dependent on them. This is an example of a router
32669 which implements such a filter:
32670 .code
32671 central_filter:
32672   check_local_user
32673   driver = redirect
32674   domains = +local_domains
32675   file = /central/filters/$local_part
32676   no_verify
32677   allow_filter
32678   allow_freeze
32679 .endd
32680 The filter is run in a separate process under its own uid. Therefore, either
32681 &%check_local_user%& must be set (as above), in which case the filter is run as
32682 the local user, or the &%user%& option must be used to specify which user to
32683 use. If both are set, &%user%& overrides.
32684
32685 Care should be taken to ensure that none of the commands in the filter file
32686 specify a significant delivery if the message is to go on to be delivered to
32687 its intended recipient. The router will not then claim to have dealt with the
32688 address, so it will be passed on to subsequent routers to be delivered in the
32689 normal way.
32690 .ecindex IIDsysfil1
32691 .ecindex IIDsysfil2
32692 .ecindex IIDsysfil3
32693
32694
32695
32696
32697
32698
32699 . ////////////////////////////////////////////////////////////////////////////
32700 . ////////////////////////////////////////////////////////////////////////////
32701
32702 .chapter "Message processing" "CHAPmsgproc"
32703 .scindex IIDmesproc "message" "general processing"
32704 Exim performs various transformations on the sender and recipient addresses of
32705 all messages that it handles, and also on the messages' header lines. Some of
32706 these are optional and configurable, while others always take place. All of
32707 this processing, except rewriting as a result of routing, and the addition or
32708 removal of header lines while delivering, happens when a message is received,
32709 before it is placed on Exim's queue.
32710
32711 Some of the automatic processing takes place by default only for
32712 &"locally-originated"& messages. This adjective is used to describe messages
32713 that are not received over TCP/IP, but instead are passed to an Exim process on
32714 its standard input. This includes the interactive &"local SMTP"& case that is
32715 set up by the &%-bs%& command line option.
32716
32717 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32718 or ::1) are not considered to be locally-originated. Exim does not treat the
32719 loopback interface specially in any way.
32720
32721 If you want the loopback interface to be treated specially, you must ensure
32722 that there are appropriate entries in your ACLs.
32723
32724
32725
32726
32727 .section "Submission mode for non-local messages" "SECTsubmodnon"
32728 .cindex "message" "submission"
32729 .cindex "submission mode"
32730 Processing that happens automatically for locally-originated messages (unless
32731 &%suppress_local_fixups%& is set) can also be requested for messages that are
32732 received over TCP/IP. The term &"submission mode"& is used to describe this
32733 state. Submission mode is set by the modifier
32734 .code
32735 control = submission
32736 .endd
32737 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32738 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32739 a local submission, and is normally used when the source of the message is
32740 known to be an MUA running on a client host (as opposed to an MTA). For
32741 example, to set submission mode for messages originating on the IPv4 loopback
32742 interface, you could include the following in the MAIL ACL:
32743 .code
32744 warn  hosts = 127.0.0.1
32745       control = submission
32746 .endd
32747 .cindex "&%sender_retain%& submission option"
32748 There are some options that can be used when setting submission mode. A slash
32749 is used to separate options. For example:
32750 .code
32751 control = submission/sender_retain
32752 .endd
32753 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32754 true and &%local_from_check%& false for the current incoming message. The first
32755 of these allows an existing &'Sender:'& header in the message to remain, and
32756 the second suppresses the check to ensure that &'From:'& matches the
32757 authenticated sender. With this setting, Exim still fixes up messages by adding
32758 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32759 attempt to check sender authenticity in header lines.
32760
32761 When &%sender_retain%& is not set, a submission mode setting may specify a
32762 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32763 example:
32764 .code
32765 control = submission/domain=some.domain
32766 .endd
32767 The domain may be empty. How this value is used is described in sections
32768 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32769 that allows you to specify the user's full name for inclusion in a created
32770 &'Sender:'& or &'From:'& header line. For example:
32771 .code
32772 accept authenticated = *
32773        control = submission/domain=wonderland.example/\
32774                             name=${lookup {$authenticated_id} \
32775                                    lsearch {/etc/exim/namelist}}
32776 .endd
32777 Because the name may contain any characters, including slashes, the &%name%&
32778 option must be given last. The remainder of the string is used as the name. For
32779 the example above, if &_/etc/exim/namelist_& contains:
32780 .code
32781 bigegg:  Humpty Dumpty
32782 .endd
32783 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32784 line would be:
32785 .code
32786 Sender: Humpty Dumpty <bigegg@wonderland.example>
32787 .endd
32788 .cindex "return path" "in submission mode"
32789 By default, submission mode forces the return path to the same address as is
32790 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32791 specified, the return path is also left unchanged.
32792
32793 &*Note*&: The changes caused by submission mode take effect after the predata
32794 ACL. This means that any sender checks performed before the fix-ups use the
32795 untrusted sender address specified by the user, not the trusted sender address
32796 specified by submission mode. Although this might be slightly unexpected, it
32797 does mean that you can configure ACL checks to spot that a user is trying to
32798 spoof another's address.
32799
32800 .section "Line endings" "SECTlineendings"
32801 .cindex "line endings"
32802 .cindex "carriage return"
32803 .cindex "linefeed"
32804 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32805 linefeed) is the line ending for messages transmitted over the Internet using
32806 SMTP over TCP/IP. However, within individual operating systems, different
32807 conventions are used. For example, Unix-like systems use just LF, but others
32808 use CRLF or just CR.
32809
32810 Exim was designed for Unix-like systems, and internally, it stores messages
32811 using the system's convention of a single LF as a line terminator. When
32812 receiving a message, all line endings are translated to this standard format.
32813 Originally, it was thought that programs that passed messages directly to an
32814 MTA within an operating system would use that system's convention. Experience
32815 has shown that this is not the case; for example, there are Unix applications
32816 that use CRLF in this circumstance. For this reason, and for compatibility with
32817 other MTAs, the way Exim handles line endings for all messages is now as
32818 follows:
32819
32820 .ilist
32821 LF not preceded by CR is treated as a line ending.
32822 .next
32823 CR is treated as a line ending; if it is immediately followed by LF, the LF
32824 is ignored.
32825 .next
32826 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32827 nor a local message in the state where a line containing only a dot is a
32828 terminator.
32829 .next
32830 If a bare CR is encountered within a header line, an extra space is added after
32831 the line terminator so as not to end the header line. The reasoning behind this
32832 is that bare CRs in header lines are most likely either to be mistakes, or
32833 people trying to play silly games.
32834 .next
32835 If the first header line received in a message ends with CRLF, a subsequent
32836 bare LF in a header line is treated in the same way as a bare CR in a header
32837 line.
32838 .endlist
32839
32840
32841
32842
32843
32844 .section "Unqualified addresses" "SECID218"
32845 .cindex "unqualified addresses"
32846 .cindex "address" "qualification"
32847 By default, Exim expects every envelope address it receives from an external
32848 host to be fully qualified. Unqualified addresses cause negative responses to
32849 SMTP commands. However, because SMTP is used as a means of transporting
32850 messages from MUAs running on personal workstations, there is sometimes a
32851 requirement to accept unqualified addresses from specific hosts or IP networks.
32852
32853 Exim has two options that separately control which hosts may send unqualified
32854 sender or recipient addresses in SMTP commands, namely
32855 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32856 cases, if an unqualified address is accepted, it is qualified by adding the
32857 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32858
32859 .oindex "&%qualify_domain%&"
32860 .oindex "&%qualify_recipient%&"
32861 Unqualified addresses in header lines are automatically qualified for messages
32862 that are locally originated, unless the &%-bnq%& option is given on the command
32863 line. For messages received over SMTP, unqualified addresses in header lines
32864 are qualified only if unqualified addresses are permitted in SMTP commands. In
32865 other words, such qualification is also controlled by
32866 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32867
32868
32869
32870
32871 .section "The UUCP From line" "SECID219"
32872 .cindex "&""From""& line"
32873 .cindex "UUCP" "&""From""& line"
32874 .cindex "sender" "address"
32875 .oindex "&%uucp_from_pattern%&"
32876 .oindex "&%uucp_from_sender%&"
32877 .cindex "envelope sender"
32878 .cindex "Sendmail compatibility" "&""From""& line"
32879 Messages that have come from UUCP (and some other applications) often begin
32880 with a line containing the envelope sender and a timestamp, following the word
32881 &"From"&. Examples of two common formats are:
32882 .code
32883 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32884 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32885 .endd
32886 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32887 Exim recognizes such lines at the start of messages that are submitted to it
32888 via the command line (that is, on the standard input). It does not recognize
32889 such lines in incoming SMTP messages, unless the sending host matches
32890 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32891 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32892 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32893 default value matches the two common cases shown above and puts the address
32894 that follows &"From"& into &$1$&.
32895
32896 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32897 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32898 a trusted user, the message's sender address is constructed by expanding the
32899 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32900 then parsed as an RFC 2822 address. If there is no domain, the local part is
32901 qualified with &%qualify_domain%& unless it is the empty string. However, if
32902 the command line &%-f%& option is used, it overrides the &"From"& line.
32903
32904 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32905 sender address is not changed. This is also the case for incoming SMTP messages
32906 that are permitted to contain &"From"& lines.
32907
32908 Only one &"From"& line is recognized. If there is more than one, the second is
32909 treated as a data line that starts the body of the message, as it is not valid
32910 as a header line. This also happens if a &"From"& line is present in an
32911 incoming SMTP message from a source that is not permitted to send them.
32912
32913
32914
32915 .section "Resent- header lines" "SECID220"
32916 .cindex "&%Resent-%& header lines"
32917 RFC 2822 makes provision for sets of header lines starting with the string
32918 &`Resent-`& to be added to a message when it is resent by the original
32919 recipient to somebody else. These headers are &'Resent-Date:'&,
32920 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32921 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32922
32923 .blockquote
32924 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32925 processing of replies or other such automatic actions on messages.'&
32926 .endblockquote
32927
32928 This leaves things a bit vague as far as other processing actions such as
32929 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32930 follows:
32931
32932 .ilist
32933 A &'Resent-From:'& line that just contains the login id of the submitting user
32934 is automatically rewritten in the same way as &'From:'& (see below).
32935 .next
32936 If there's a rewriting rule for a particular header line, it is also applied to
32937 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32938 &'From:'& also rewrites &'Resent-From:'&.
32939 .next
32940 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32941 also removed.
32942 .next
32943 For a locally-submitted message,
32944 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32945 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32946 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32947 included in log lines in this case.
32948 .next
32949 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32950 &%Resent-%& header lines are present.
32951 .endlist
32952
32953
32954
32955
32956 .section "The Auto-Submitted: header line" "SECID221"
32957 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32958 includes the header line:
32959 .code
32960 Auto-Submitted: auto-replied
32961 .endd
32962
32963 .section "The Bcc: header line" "SECID222"
32964 .cindex "&'Bcc:'& header line"
32965 If Exim is called with the &%-t%& option, to take recipient addresses from a
32966 message's header, it removes any &'Bcc:'& header line that may exist (after
32967 extracting its addresses). If &%-t%& is not present on the command line, any
32968 existing &'Bcc:'& is not removed.
32969
32970
32971 .section "The Date: header line" "SECID223"
32972 .cindex "&'Date:'& header line"
32973 If a locally-generated or submission-mode message has no &'Date:'& header line,
32974 Exim adds one, using the current date and time, unless the
32975 &%suppress_local_fixups%& control has been specified.
32976
32977 .section "The Delivery-date: header line" "SECID224"
32978 .cindex "&'Delivery-date:'& header line"
32979 .oindex "&%delivery_date_remove%&"
32980 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32981 set. Exim can be configured to add them to the final delivery of messages. (See
32982 the generic &%delivery_date_add%& transport option.) They should not be present
32983 in messages in transit. If the &%delivery_date_remove%& configuration option is
32984 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32985 messages.
32986
32987
32988 .section "The Envelope-to: header line" "SECID225"
32989 .cindex "&'Envelope-to:'& header line"
32990 .oindex "&%envelope_to_remove%&"
32991 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32992 Exim can be configured to add them to the final delivery of messages. (See the
32993 generic &%envelope_to_add%& transport option.) They should not be present in
32994 messages in transit. If the &%envelope_to_remove%& configuration option is set
32995 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32996 messages.
32997
32998
32999 .section "The From: header line" "SECTthefrohea"
33000 .cindex "&'From:'& header line"
33001 .cindex "Sendmail compatibility" "&""From""& line"
33002 .cindex "message" "submission"
33003 .cindex "submission mode"
33004 If a submission-mode message does not contain a &'From:'& header line, Exim
33005 adds one if either of the following conditions is true:
33006
33007 .ilist
33008 The envelope sender address is not empty (that is, this is not a bounce
33009 message). The added header line copies the envelope sender address.
33010 .next
33011 .vindex "&$authenticated_id$&"
33012 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33013 .olist
33014 .vindex "&$qualify_domain$&"
33015 If no domain is specified by the submission control, the local part is
33016 &$authenticated_id$& and the domain is &$qualify_domain$&.
33017 .next
33018 If a non-empty domain is specified by the submission control, the local
33019 part is &$authenticated_id$&, and the domain is the specified domain.
33020 .next
33021 If an empty domain is specified by the submission control,
33022 &$authenticated_id$& is assumed to be the complete address.
33023 .endlist
33024 .endlist
33025
33026 A non-empty envelope sender takes precedence.
33027
33028 If a locally-generated incoming message does not contain a &'From:'& header
33029 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33030 containing the sender's address. The calling user's login name and full name
33031 are used to construct the address, as described in section &<<SECTconstr>>&.
33032 They are obtained from the password data by calling &[getpwuid()]& (but see the
33033 &%unknown_login%& configuration option). The address is qualified with
33034 &%qualify_domain%&.
33035
33036 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33037 &'From:'& header line containing just the unqualified login name of the calling
33038 user, this is replaced by an address containing the user's login name and full
33039 name as described in section &<<SECTconstr>>&.
33040
33041
33042 .section "The Message-ID: header line" "SECID226"
33043 .cindex "&'Message-ID:'& header line"
33044 .cindex "message" "submission"
33045 .oindex "&%message_id_header_text%&"
33046 If a locally-generated or submission-mode incoming message does not contain a
33047 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33048 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33049 to the message. If there are any &'Resent-:'& headers in the message, it
33050 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33051 message id, preceded by the letter E to ensure it starts with a letter, and
33052 followed by @ and the primary host name. Additional information can be included
33053 in this header line by setting the &%message_id_header_text%& and/or
33054 &%message_id_header_domain%& options.
33055
33056
33057 .section "The Received: header line" "SECID227"
33058 .cindex "&'Received:'& header line"
33059 A &'Received:'& header line is added at the start of every message. The
33060 contents are defined by the &%received_header_text%& configuration option, and
33061 Exim automatically adds a semicolon and a timestamp to the configured string.
33062
33063 The &'Received:'& header is generated as soon as the message's header lines
33064 have been received. At this stage, the timestamp in the &'Received:'& header
33065 line is the time that the message started to be received. This is the value
33066 that is seen by the DATA ACL and by the &[local_scan()]& function.
33067
33068 Once a message is accepted, the timestamp in the &'Received:'& header line is
33069 changed to the time of acceptance, which is (apart from a small delay while the
33070 -H spool file is written) the earliest time at which delivery could start.
33071
33072
33073 .section "The References: header line" "SECID228"
33074 .cindex "&'References:'& header line"
33075 Messages created by the &(autoreply)& transport include a &'References:'&
33076 header line. This is constructed according to the rules that are described in
33077 section 3.64 of RFC 2822 (which states that replies should contain such a
33078 header line), and section 3.14 of RFC 3834 (which states that automatic
33079 responses are not different in this respect). However, because some mail
33080 processing software does not cope well with very long header lines, no more
33081 than 12 message IDs are copied from the &'References:'& header line in the
33082 incoming message. If there are more than 12, the first one and then the final
33083 11 are copied, before adding the message ID of the incoming message.
33084
33085
33086
33087 .section "The Return-path: header line" "SECID229"
33088 .cindex "&'Return-path:'& header line"
33089 .oindex "&%return_path_remove%&"
33090 &'Return-path:'& header lines are defined as something an MTA may insert when
33091 it does the final delivery of messages. (See the generic &%return_path_add%&
33092 transport option.) Therefore, they should not be present in messages in
33093 transit. If the &%return_path_remove%& configuration option is set (the
33094 default), Exim removes &'Return-path:'& header lines from incoming messages.
33095
33096
33097
33098 .section "The Sender: header line" "SECTthesenhea"
33099 .cindex "&'Sender:'& header line"
33100 .cindex "message" "submission"
33101 For a locally-originated message from an untrusted user, Exim may remove an
33102 existing &'Sender:'& header line, and it may add a new one. You can modify
33103 these actions by setting the &%local_sender_retain%& option true, the
33104 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33105 control setting.
33106
33107 When a local message is received from an untrusted user and
33108 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33109 control has not been set, a check is made to see if the address given in the
33110 &'From:'& header line is the correct (local) sender of the message. The address
33111 that is expected has the login name as the local part and the value of
33112 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33113 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33114 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33115 line is added to the message.
33116
33117 If you set &%local_from_check%& false, this checking does not occur. However,
33118 the removal of an existing &'Sender:'& line still happens, unless you also set
33119 &%local_sender_retain%& to be true. It is not possible to set both of these
33120 options true at the same time.
33121
33122 .cindex "submission mode"
33123 By default, no processing of &'Sender:'& header lines is done for messages
33124 received over TCP/IP or for messages submitted by trusted users. However, when
33125 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33126 not specified on the submission control, the following processing takes place:
33127
33128 .vindex "&$authenticated_id$&"
33129 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33130 authenticated, and &$authenticated_id$& is not empty, a sender address is
33131 created as follows:
33132
33133 .ilist
33134 .vindex "&$qualify_domain$&"
33135 If no domain is specified by the submission control, the local part is
33136 &$authenticated_id$& and the domain is &$qualify_domain$&.
33137 .next
33138 If a non-empty domain is specified by the submission control, the local part
33139 is &$authenticated_id$&, and the domain is the specified domain.
33140 .next
33141 If an empty domain is specified by the submission control,
33142 &$authenticated_id$& is assumed to be the complete address.
33143 .endlist
33144
33145 This address is compared with the address in the &'From:'& header line. If they
33146 are different, a &'Sender:'& header line containing the created address is
33147 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33148 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33149
33150 .cindex "return path" "created from &'Sender:'&"
33151 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33152 the message (the envelope sender address) is changed to be the same address,
33153 except in the case of submission mode when &%sender_retain%& is specified.
33154
33155
33156
33157 .section "Adding and removing header lines in routers and transports" &&&
33158          "SECTheadersaddrem"
33159 .cindex "header lines" "adding; in router or transport"
33160 .cindex "header lines" "removing; in router or transport"
33161 When a message is delivered, the addition and removal of header lines can be
33162 specified in a system filter, or on any of the routers and transports that
33163 process the message. Section &<<SECTaddremheasys>>& contains details about
33164 modifying headers in a system filter. Header lines can also be added in an ACL
33165 as a message is received (see section &<<SECTaddheadacl>>&).
33166
33167 In contrast to what happens in a system filter, header modifications that are
33168 specified on routers and transports apply only to the particular recipient
33169 addresses that are being processed by those routers and transports. These
33170 changes do not actually take place until a copy of the message is being
33171 transported. Therefore, they do not affect the basic set of header lines, and
33172 they do not affect the values of the variables that refer to header lines.
33173
33174 &*Note*&: In particular, this means that any expansions in the configuration of
33175 the transport cannot refer to the modified header lines, because such
33176 expansions all occur before the message is actually transported.
33177
33178 For both routers and transports, the argument of a &%headers_add%&
33179 option must be in the form of one or more RFC 2822 header lines, separated by
33180 newlines (coded as &"\n"&). For example:
33181 .code
33182 headers_add = X-added-header: added by $primary_hostname\n\
33183               X-added-second: another added header line
33184 .endd
33185 Exim does not check the syntax of these added header lines.
33186
33187 Multiple &%headers_add%& options for a single router or transport can be
33188 specified; the values will append to a single list of header lines.
33189 Each header-line is separately expanded.
33190
33191 The argument of a &%headers_remove%& option must consist of a colon-separated
33192 list of header names. This is confusing, because header names themselves are
33193 often terminated by colons. In this case, the colons are the list separators,
33194 not part of the names. For example:
33195 .code
33196 headers_remove = return-receipt-to:acknowledge-to
33197 .endd
33198
33199 Multiple &%headers_remove%& options for a single router or transport can be
33200 specified; the arguments will append to a single header-names list.
33201 Each item is separately expanded.
33202 Note that colons in complex expansions which are used to
33203 form all or part of a &%headers_remove%& list
33204 will act as list separators.
33205
33206 When &%headers_add%& or &%headers_remove%& is specified on a router,
33207 items are expanded at routing time,
33208 and then associated with all addresses that are
33209 accepted by that router, and also with any new addresses that it generates. If
33210 an address passes through several routers as a result of aliasing or
33211 forwarding, the changes are cumulative.
33212
33213 .oindex "&%unseen%&"
33214 However, this does not apply to multiple routers that result from the use of
33215 the &%unseen%& option. Any header modifications that were specified by the
33216 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33217
33218 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33219 settings cannot be delivered together in a batch, so a transport is always
33220 dealing with a set of addresses that have the same header-processing
33221 requirements.
33222
33223 The transport starts by writing the original set of header lines that arrived
33224 with the message, possibly modified by the system filter. As it writes out
33225 these lines, it consults the list of header names that were attached to the
33226 recipient address(es) by &%headers_remove%& options in routers, and it also
33227 consults the transport's own &%headers_remove%& option. Header lines whose
33228 names are on either of these lists are not written out. If there are multiple
33229 instances of any listed header, they are all skipped.
33230
33231 After the remaining original header lines have been written, new header
33232 lines that were specified by routers' &%headers_add%& options are written, in
33233 the order in which they were attached to the address. These are followed by any
33234 header lines specified by the transport's &%headers_add%& option.
33235
33236 This way of handling header line modifications in routers and transports has
33237 the following consequences:
33238
33239 .ilist
33240 The original set of header lines, possibly modified by the system filter,
33241 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33242 to it, at all times.
33243 .next
33244 Header lines that are added by a router's
33245 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33246 expansion syntax in subsequent routers or the transport.
33247 .next
33248 Conversely, header lines that are specified for removal by &%headers_remove%&
33249 in a router remain visible to subsequent routers and the transport.
33250 .next
33251 Headers added to an address by &%headers_add%& in a router cannot be removed by
33252 a later router or by a transport.
33253 .next
33254 An added header can refer to the contents of an original header that is to be
33255 removed, even it has the same name as the added header. For example:
33256 .code
33257 headers_remove = subject
33258 headers_add = Subject: new subject (was: $h_subject:)
33259 .endd
33260 .endlist
33261
33262 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33263 for a &(redirect)& router that has the &%one_time%& option set.
33264
33265
33266
33267
33268
33269 .section "Constructed addresses" "SECTconstr"
33270 .cindex "address" "constructed"
33271 .cindex "constructed address"
33272 When Exim constructs a sender address for a locally-generated message, it uses
33273 the form
33274 .display
33275 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33276 .endd
33277 For example:
33278 .code
33279 Zaphod Beeblebrox <zaphod@end.univ.example>
33280 .endd
33281 The user name is obtained from the &%-F%& command line option if set, or
33282 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33283 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33284 ampersand character, this is replaced by the login name with the first letter
33285 upper cased, as is conventional in a number of operating systems. See the
33286 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33287 The &%unknown_username%& option can be used to specify user names in cases when
33288 there is no password file entry.
33289
33290 .cindex "RFC 2047"
33291 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33292 parts of it if necessary. In addition, if it contains any non-printing
33293 characters, it is encoded as described in RFC 2047, which defines a way of
33294 including non-ASCII characters in header lines. The value of the
33295 &%headers_charset%& option specifies the name of the encoding that is used (the
33296 characters are assumed to be in this encoding). The setting of
33297 &%print_topbitchars%& controls whether characters with the top bit set (that
33298 is, with codes greater than 127) count as printing characters or not.
33299
33300
33301
33302 .section "Case of local parts" "SECID230"
33303 .cindex "case of local parts"
33304 .cindex "local part" "case of"
33305 RFC 2822 states that the case of letters in the local parts of addresses cannot
33306 be assumed to be non-significant. Exim preserves the case of local parts of
33307 addresses, but by default it uses a lower-cased form when it is routing,
33308 because on most Unix systems, usernames are in lower case and case-insensitive
33309 routing is required. However, any particular router can be made to use the
33310 original case for local parts by setting the &%caseful_local_part%& generic
33311 router option.
33312
33313 .cindex "mixed-case login names"
33314 If you must have mixed-case user names on your system, the best way to proceed,
33315 assuming you want case-independent handling of incoming email, is to set up
33316 your first router to convert incoming local parts in your domains to the
33317 correct case by means of a file lookup. For example:
33318 .code
33319 correct_case:
33320   driver = redirect
33321   domains = +local_domains
33322   data = ${lookup{$local_part}cdb\
33323               {/etc/usercased.cdb}{$value}fail}\
33324               @$domain
33325 .endd
33326 For this router, the local part is forced to lower case by the default action
33327 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33328 up a new local part in the correct case. If you then set &%caseful_local_part%&
33329 on any subsequent routers which process your domains, they will operate on
33330 local parts with the correct case in a case-sensitive manner.
33331
33332
33333
33334 .section "Dots in local parts" "SECID231"
33335 .cindex "dot" "in local part"
33336 .cindex "local part" "dots in"
33337 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33338 part may not begin or end with a dot, nor have two consecutive dots in the
33339 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33340 empty components for compatibility.
33341
33342
33343
33344 .section "Rewriting addresses" "SECID232"
33345 .cindex "rewriting" "addresses"
33346 Rewriting of sender and recipient addresses, and addresses in headers, can
33347 happen automatically, or as the result of configuration options, as described
33348 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33349 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33350
33351 Automatic rewriting includes qualification, as mentioned above. The other case
33352 in which it can happen is when an incomplete non-local domain is given. The
33353 routing process may cause this to be expanded into the full domain name. For
33354 example, a header such as
33355 .code
33356 To: hare@teaparty
33357 .endd
33358 might get rewritten as
33359 .code
33360 To: hare@teaparty.wonderland.fict.example
33361 .endd
33362 Rewriting as a result of routing is the one kind of message processing that
33363 does not happen at input time, as it cannot be done until the address has
33364 been routed.
33365
33366 Strictly, one should not do &'any'& deliveries of a message until all its
33367 addresses have been routed, in case any of the headers get changed as a
33368 result of routing. However, doing this in practice would hold up many
33369 deliveries for unreasonable amounts of time, just because one address could not
33370 immediately be routed. Exim therefore does not delay other deliveries when
33371 routing of one or more addresses is deferred.
33372 .ecindex IIDmesproc
33373
33374
33375
33376 . ////////////////////////////////////////////////////////////////////////////
33377 . ////////////////////////////////////////////////////////////////////////////
33378
33379 .chapter "SMTP processing" "CHAPSMTP"
33380 .scindex IIDsmtpproc1 "SMTP" "processing details"
33381 .scindex IIDsmtpproc2 "LMTP" "processing details"
33382 Exim supports a number of different ways of using the SMTP protocol, and its
33383 LMTP variant, which is an interactive protocol for transferring messages into a
33384 closed mail store application. This chapter contains details of how SMTP is
33385 processed. For incoming mail, the following are available:
33386
33387 .ilist
33388 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33389 .next
33390 SMTP over the standard input and output (the &%-bs%& option);
33391 .next
33392 Batched SMTP on the standard input (the &%-bS%& option).
33393 .endlist
33394
33395 For mail delivery, the following are available:
33396
33397 .ilist
33398 SMTP over TCP/IP (the &(smtp)& transport);
33399 .next
33400 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33401 &"lmtp"&);
33402 .next
33403 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33404 transport);
33405 .next
33406 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33407 the &%use_bsmtp%& option set).
33408 .endlist
33409
33410 &'Batched SMTP'& is the name for a process in which batches of messages are
33411 stored in or read from files (or pipes), in a format in which SMTP commands are
33412 used to contain the envelope information.
33413
33414
33415
33416 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33417 .cindex "SMTP" "outgoing over TCP/IP"
33418 .cindex "outgoing SMTP over TCP/IP"
33419 .cindex "LMTP" "over TCP/IP"
33420 .cindex "outgoing LMTP over TCP/IP"
33421 .cindex "EHLO"
33422 .cindex "HELO"
33423 .cindex "SIZE option on MAIL command"
33424 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33425 The &%protocol%& option selects which protocol is to be used, but the actual
33426 processing is the same in both cases.
33427
33428 If, in response to its EHLO command, Exim is told that the SIZE
33429 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33430 command. The value of <&'n'&> is the message size plus the value of the
33431 &%size_addition%& option (default 1024) to allow for additions to the message
33432 such as per-transport header lines, or changes made in a
33433 .cindex "transport" "filter"
33434 .cindex "filter" "transport filter"
33435 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33436 suppressed.
33437
33438 If the remote server advertises support for PIPELINING, Exim uses the
33439 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33440 required for the transaction.
33441
33442 If the remote server advertises support for the STARTTLS command, and Exim
33443 was built to support TLS encryption, it tries to start a TLS session unless the
33444 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33445 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33446 is called for verification.
33447
33448 If the remote server advertises support for the AUTH command, Exim scans
33449 the authenticators configuration for any suitable client settings, as described
33450 in chapter &<<CHAPSMTPAUTH>>&.
33451
33452 .cindex "carriage return"
33453 .cindex "linefeed"
33454 Responses from the remote host are supposed to be terminated by CR followed by
33455 LF. However, there are known to be hosts that do not send CR characters, so in
33456 order to be able to interwork with such hosts, Exim treats LF on its own as a
33457 line terminator.
33458
33459 If a message contains a number of different addresses, all those with the same
33460 characteristics (for example, the same envelope sender) that resolve to the
33461 same set of hosts, in the same order, are sent in a single SMTP transaction,
33462 even if they are for different domains, unless there are more than the setting
33463 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33464 they are split into groups containing no more than &%max_rcpt%&s addresses
33465 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33466 in parallel sessions. The order of hosts with identical MX values is not
33467 significant when checking whether addresses can be batched in this way.
33468
33469 When the &(smtp)& transport suffers a temporary failure that is not
33470 message-related, Exim updates its transport-specific database, which contains
33471 records indexed by host name that remember which messages are waiting for each
33472 particular host. It also updates the retry database with new retry times.
33473
33474 .cindex "hints database" "retry keys"
33475 Exim's retry hints are based on host name plus IP address, so if one address of
33476 a multi-homed host is broken, it will soon be skipped most of the time.
33477 See the next section for more detail about error handling.
33478
33479 .cindex "SMTP" "passed connection"
33480 .cindex "SMTP" "batching over TCP/IP"
33481 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33482 looks in the hints database for the transport to see if there are any queued
33483 messages waiting for the host to which it is connected. If it finds one, it
33484 creates a new Exim process using the &%-MC%& option (which can only be used by
33485 a process running as root or the Exim user) and passes the TCP/IP socket to it
33486 so that it can deliver another message using the same socket. The new process
33487 does only those deliveries that are routed to the connected host, and may in
33488 turn pass the socket on to a third process, and so on.
33489
33490 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33491 limit the number of messages sent down a single TCP/IP connection.
33492
33493 .cindex "asterisk" "after IP address"
33494 The second and subsequent messages delivered down an existing connection are
33495 identified in the main log by the addition of an asterisk after the closing
33496 square bracket of the IP address.
33497
33498
33499
33500
33501 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33502 .cindex "error" "in outgoing SMTP"
33503 .cindex "SMTP" "errors in outgoing"
33504 .cindex "host" "error"
33505 Three different kinds of error are recognized for outgoing SMTP: host errors,
33506 message errors, and recipient errors.
33507
33508 .vlist
33509 .vitem "&*Host errors*&"
33510 A host error is not associated with a particular message or with a
33511 particular recipient of a message. The host errors are:
33512
33513 .ilist
33514 Connection refused or timed out,
33515 .next
33516 Any error response code on connection,
33517 .next
33518 Any error response code to EHLO or HELO,
33519 .next
33520 Loss of connection at any time, except after &"."&,
33521 .next
33522 I/O errors at any time,
33523 .next
33524 Timeouts during the session, other than in response to MAIL, RCPT or
33525 the &"."& at the end of the data.
33526 .endlist ilist
33527
33528 For a host error, a permanent error response on connection, or in response to
33529 EHLO, causes all addresses routed to the host to be failed. Any other host
33530 error causes all addresses to be deferred, and retry data to be created for the
33531 host. It is not tried again, for any message, until its retry time arrives. If
33532 the current set of addresses are not all delivered in this run (to some
33533 alternative host), the message is added to the list of those waiting for this
33534 host, so if it is still undelivered when a subsequent successful delivery is
33535 made to the host, it will be sent down the same SMTP connection.
33536
33537 .vitem "&*Message errors*&"
33538 .cindex "message" "error"
33539 A message error is associated with a particular message when sent to a
33540 particular host, but not with a particular recipient of the message. The
33541 message errors are:
33542
33543 .ilist
33544 Any error response code to MAIL, DATA, or the &"."& that terminates
33545 the data,
33546 .next
33547 Timeout after MAIL,
33548 .next
33549 Timeout or loss of connection after the &"."& that terminates the data. A
33550 timeout after the DATA command itself is treated as a host error, as is loss of
33551 connection at any other time.
33552 .endlist ilist
33553
33554 For a message error, a permanent error response (5&'xx'&) causes all addresses
33555 to be failed, and a delivery error report to be returned to the sender. A
33556 temporary error response (4&'xx'&), or one of the timeouts, causes all
33557 addresses to be deferred. Retry data is not created for the host, but instead,
33558 a retry record for the combination of host plus message id is created. The
33559 message is not added to the list of those waiting for this host. This ensures
33560 that the failing message will not be sent to this host again until the retry
33561 time arrives. However, other messages that are routed to the host are not
33562 affected, so if it is some property of the message that is causing the error,
33563 it will not stop the delivery of other mail.
33564
33565 If the remote host specified support for the SIZE parameter in its response
33566 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33567 over-large message will cause a message error because the error arrives as a
33568 response to MAIL.
33569
33570 .vitem "&*Recipient errors*&"
33571 .cindex "recipient" "error"
33572 A recipient error is associated with a particular recipient of a message. The
33573 recipient errors are:
33574
33575 .ilist
33576 Any error response to RCPT,
33577 .next
33578 Timeout after RCPT.
33579 .endlist
33580
33581 For a recipient error, a permanent error response (5&'xx'&) causes the
33582 recipient address to be failed, and a bounce message to be returned to the
33583 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33584 address to be deferred, and routing retry data to be created for it. This is
33585 used to delay processing of the address in subsequent queue runs, until its
33586 routing retry time arrives. This applies to all messages, but because it
33587 operates only in queue runs, one attempt will be made to deliver a new message
33588 to the failing address before the delay starts to operate. This ensures that,
33589 if the failure is really related to the message rather than the recipient
33590 (&"message too big for this recipient"& is a possible example), other messages
33591 have a chance of getting delivered. If a delivery to the address does succeed,
33592 the retry information gets cleared, so all stuck messages get tried again, and
33593 the retry clock is reset.
33594
33595 The message is not added to the list of those waiting for this host. Use of the
33596 host for other messages is unaffected, and except in the case of a timeout,
33597 other recipients are processed independently, and may be successfully delivered
33598 in the current SMTP session. After a timeout it is of course impossible to
33599 proceed with the session, so all addresses get deferred. However, those other
33600 than the one that failed do not suffer any subsequent retry delays. Therefore,
33601 if one recipient is causing trouble, the others have a chance of getting
33602 through when a subsequent delivery attempt occurs before the failing
33603 recipient's retry time.
33604 .endlist
33605
33606 In all cases, if there are other hosts (or IP addresses) available for the
33607 current set of addresses (for example, from multiple MX records), they are
33608 tried in this run for any undelivered addresses, subject of course to their
33609 own retry data. In other words, recipient error retry data does not take effect
33610 until the next delivery attempt.
33611
33612 Some hosts have been observed to give temporary error responses to every
33613 MAIL command at certain times (&"insufficient space"& has been seen). It
33614 would be nice if such circumstances could be recognized, and defer data for the
33615 host itself created, but this is not possible within the current Exim design.
33616 What actually happens is that retry data for every (host, message) combination
33617 is created.
33618
33619 The reason that timeouts after MAIL and RCPT are treated specially is that
33620 these can sometimes arise as a result of the remote host's verification
33621 procedures. Exim makes this assumption, and treats them as if a temporary error
33622 response had been received. A timeout after &"."& is treated specially because
33623 it is known that some broken implementations fail to recognize the end of the
33624 message if the last character of the last line is a binary zero. Thus, it is
33625 helpful to treat this case as a message error.
33626
33627 Timeouts at other times are treated as host errors, assuming a problem with the
33628 host, or the connection to it. If a timeout after MAIL, RCPT,
33629 or &"."& is really a connection problem, the assumption is that at the next try
33630 the timeout is likely to occur at some other point in the dialogue, causing it
33631 then to be treated as a host error.
33632
33633 There is experimental evidence that some MTAs drop the connection after the
33634 terminating &"."& if they do not like the contents of the message for some
33635 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33636 should be given. That is why Exim treats this case as a message rather than a
33637 host error, in order not to delay other messages to the same host.
33638
33639
33640
33641
33642 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33643 .cindex "SMTP" "incoming over TCP/IP"
33644 .cindex "incoming SMTP over TCP/IP"
33645 .cindex "inetd"
33646 .cindex "daemon"
33647 Incoming SMTP messages can be accepted in one of two ways: by running a
33648 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33649 &_/etc/inetd.conf_& should be like this:
33650 .code
33651 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33652 .endd
33653 Exim distinguishes between this case and the case of a locally running user
33654 agent using the &%-bs%& option by checking whether or not the standard input is
33655 a socket. When it is, either the port must be privileged (less than 1024), or
33656 the caller must be root or the Exim user. If any other user passes a socket
33657 with an unprivileged port number, Exim prints a message on the standard error
33658 stream and exits with an error code.
33659
33660 By default, Exim does not make a log entry when a remote host connects or
33661 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33662 unexpected. It can be made to write such log entries by setting the
33663 &%smtp_connection%& log selector.
33664
33665 .cindex "carriage return"
33666 .cindex "linefeed"
33667 Commands from the remote host are supposed to be terminated by CR followed by
33668 LF. However, there are known to be hosts that do not send CR characters. In
33669 order to be able to interwork with such hosts, Exim treats LF on its own as a
33670 line terminator.
33671 Furthermore, because common code is used for receiving messages from all
33672 sources, a CR on its own is also interpreted as a line terminator. However, the
33673 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33674
33675 .cindex "EHLO" "invalid data"
33676 .cindex "HELO" "invalid data"
33677 One area that sometimes gives rise to problems concerns the EHLO or
33678 HELO commands. Some clients send syntactically invalid versions of these
33679 commands, which Exim rejects by default. (This is nothing to do with verifying
33680 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33681 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33682 match the broken hosts that send invalid commands.
33683
33684 .cindex "SIZE option on MAIL command"
33685 .cindex "MAIL" "SIZE option"
33686 The amount of disk space available is checked whenever SIZE is received on
33687 a MAIL command, independently of whether &%message_size_limit%& or
33688 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33689 false. A temporary error is given if there is not enough space. If
33690 &%check_spool_space%& is set, the check is for that amount of space plus the
33691 value given with SIZE, that is, it checks that the addition of the incoming
33692 message will not reduce the space below the threshold.
33693
33694 When a message is successfully received, Exim includes the local message id in
33695 its response to the final &"."& that terminates the data. If the remote host
33696 logs this text it can help with tracing what has happened to a message.
33697
33698 The Exim daemon can limit the number of simultaneous incoming connections it is
33699 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33700 number of simultaneous incoming connections from a single remote host (see the
33701 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33702 rejected using the SMTP temporary error code 421.
33703
33704 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33705 subprocess has finished, as this can get lost at busy times. Instead, it looks
33706 for completed subprocesses every time it wakes up. Provided there are other
33707 things happening (new incoming calls, starts of queue runs), completed
33708 processes will be noticed and tidied away. On very quiet systems you may
33709 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33710 it will be noticed when the daemon next wakes up.
33711
33712 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33713 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33714 high system load &-- for details see the &%smtp_accept_reserve%&,
33715 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33716 applies in both the daemon and &'inetd'& cases.
33717
33718 Exim normally starts a delivery process for each message received, though this
33719 can be varied by means of the &%-odq%& command line option and the
33720 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33721 number of simultaneously running delivery processes started in this way from
33722 SMTP input can be limited by the &%smtp_accept_queue%& and
33723 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33724 subsequently received messages are just put on the input queue without starting
33725 a delivery process.
33726
33727 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33728 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33729 started up from the &'inetd'& daemon, because in that case each connection is
33730 handled by an entirely independent Exim process. Control by load average is,
33731 however, available with &'inetd'&.
33732
33733 Exim can be configured to verify addresses in incoming SMTP commands as they
33734 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33735 to rewrite addresses at this time &-- before any syntax checking is done. See
33736 section &<<SECTrewriteS>>&.
33737
33738 Exim can also be configured to limit the rate at which a client host submits
33739 MAIL and RCPT commands in a single SMTP session. See the
33740 &%smtp_ratelimit_hosts%& option.
33741
33742
33743
33744 .section "Unrecognized SMTP commands" "SECID234"
33745 .cindex "SMTP" "unrecognized commands"
33746 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33747 commands during a single SMTP connection, it drops the connection after sending
33748 the error response to the last command. The default value for
33749 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33750 abuse that subvert web servers into making connections to SMTP ports; in these
33751 circumstances, a number of non-SMTP lines are sent first.
33752
33753
33754 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33755 .cindex "SMTP" "syntax errors"
33756 .cindex "SMTP" "protocol errors"
33757 A syntax error is detected if an SMTP command is recognized, but there is
33758 something syntactically wrong with its data, for example, a malformed email
33759 address in a RCPT command. Protocol errors include invalid command
33760 sequencing such as RCPT before MAIL. If Exim receives more than
33761 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33762 drops the connection after sending the error response to the last command. The
33763 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33764 broken clients that loop sending bad commands (yes, it has been seen).
33765
33766
33767
33768 .section "Use of non-mail SMTP commands" "SECID236"
33769 .cindex "SMTP" "non-mail commands"
33770 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33771 DATA. Exim counts such commands, and drops the connection if there are too
33772 many of them in a single SMTP session. This action catches some
33773 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33774 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33775 defines what &"too many"& means. Its default value is 10.
33776
33777 When a new message is expected, one occurrence of RSET is not counted. This
33778 allows a client to send one RSET between messages (this is not necessary,
33779 but some clients do it). Exim also allows one uncounted occurrence of HELO
33780 or EHLO, and one occurrence of STARTTLS between messages. After
33781 starting up a TLS session, another EHLO is expected, and so it too is not
33782 counted.
33783
33784 The first occurrence of AUTH in a connection, or immediately following
33785 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33786 RCPT, DATA, and QUIT are counted.
33787
33788 You can control which hosts are subject to the limit set by
33789 &%smtp_accept_max_nonmail%& by setting
33790 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33791 the limit apply to all hosts. This option means that you can exclude any
33792 specific badly-behaved hosts that you have to live with.
33793
33794
33795
33796
33797 .section "The VRFY and EXPN commands" "SECID237"
33798 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33799 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33800 appropriate) in order to decide whether the command should be accepted or not.
33801 If no ACL is defined, the command is rejected.
33802
33803 .cindex "VRFY" "processing"
33804 When VRFY is accepted, it runs exactly the same code as when Exim is
33805 called with the &%-bv%& option.
33806
33807 .cindex "EXPN" "processing"
33808 When EXPN is accepted, a single-level expansion of the address is done.
33809 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33810 than a verification (the &%-bv%& option). If an unqualified local part is given
33811 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33812 of VRFY and EXPN commands are logged on the main and reject logs, and
33813 VRFY verification failures are logged on the main log for consistency with
33814 RCPT failures.
33815
33816
33817
33818 .section "The ETRN command" "SECTETRN"
33819 .cindex "ETRN" "processing"
33820 RFC 1985 describes an SMTP command called ETRN that is designed to
33821 overcome the security problems of the TURN command (which has fallen into
33822 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33823 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33824 should be accepted or not. If no ACL is defined, the command is rejected.
33825
33826 The ETRN command is concerned with &"releasing"& messages that are awaiting
33827 delivery to certain hosts. As Exim does not organize its message queue by host,
33828 the only form of ETRN that is supported by default is the one where the
33829 text starts with the &"#"& prefix, in which case the remainder of the text is
33830 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33831 the &%-R%& option to happen, with the remainder of the ETRN text as its
33832 argument. For example,
33833 .code
33834 ETRN #brigadoon
33835 .endd
33836 runs the command
33837 .code
33838 exim -R brigadoon
33839 .endd
33840 which causes a delivery attempt on all messages with undelivered addresses
33841 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33842 default), Exim prevents the simultaneous execution of more than one queue run
33843 for the same argument string as a result of an ETRN command. This stops
33844 a misbehaving client from starting more than one queue runner at once.
33845
33846 .cindex "hints database" "ETRN serialization"
33847 Exim implements the serialization by means of a hints database in which a
33848 record is written whenever a process is started by ETRN, and deleted when
33849 the process completes. However, Exim does not keep the SMTP session waiting for
33850 the ETRN process to complete. Once ETRN is accepted, the client is sent
33851 a &"success"& return code. Obviously there is scope for hints records to get
33852 left lying around if there is a system or program crash. To guard against this,
33853 Exim ignores any records that are more than six hours old.
33854
33855 .oindex "&%smtp_etrn_command%&"
33856 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33857 used. This specifies a command that is run whenever ETRN is received,
33858 whatever the form of its argument. For
33859 example:
33860 .code
33861 smtp_etrn_command = /etc/etrn_command $domain \
33862                     $sender_host_address
33863 .endd
33864 .vindex "&$domain$&"
33865 The string is split up into arguments which are independently expanded. The
33866 expansion variable &$domain$& is set to the argument of the ETRN command,
33867 and no syntax checking is done on the contents of this argument. Exim does not
33868 wait for the command to complete, so its status code is not checked. Exim runs
33869 under its own uid and gid when receiving incoming SMTP, so it is not possible
33870 for it to change them before running the command.
33871
33872
33873
33874 .section "Incoming local SMTP" "SECID238"
33875 .cindex "SMTP" "local incoming"
33876 Some user agents use SMTP to pass messages to their local MTA using the
33877 standard input and output, as opposed to passing the envelope on the command
33878 line and writing the message to the standard input. This is supported by the
33879 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33880 messages over TCP/IP (including the use of ACLs), except that the envelope
33881 sender given in a MAIL command is ignored unless the caller is trusted. In
33882 an ACL you can detect this form of SMTP input by testing for an empty host
33883 identification. It is common to have this as the first line in the ACL that
33884 runs for RCPT commands:
33885 .code
33886 accept hosts = :
33887 .endd
33888 This accepts SMTP messages from local processes without doing any other tests.
33889
33890
33891
33892 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33893 .cindex "SMTP" "batched outgoing"
33894 .cindex "batched SMTP output"
33895 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33896 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33897 be output in BSMTP format. No SMTP responses are possible for this form of
33898 delivery. All it is doing is using SMTP commands as a way of transmitting the
33899 envelope along with the message.
33900
33901 The message is written to the file or pipe preceded by the SMTP commands
33902 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33903 the message that start with a dot have an extra dot added. The SMTP command
33904 HELO is not normally used. If it is required, the &%message_prefix%& option
33905 can be used to specify it.
33906
33907 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33908 one recipient address at a time by default. However, you can arrange for them
33909 to handle several addresses at once by setting the &%batch_max%& option. When
33910 this is done for BSMTP, messages may contain multiple RCPT commands. See
33911 chapter &<<CHAPbatching>>& for more details.
33912
33913 .vindex "&$host$&"
33914 When one or more addresses are routed to a BSMTP transport by a router that
33915 sets up a host list, the name of the first host on the list is available to the
33916 transport in the variable &$host$&. Here is an example of such a transport and
33917 router:
33918 .code
33919 begin routers
33920 route_append:
33921   driver = manualroute
33922   transport = smtp_appendfile
33923   route_list = domain.example  batch.host.example
33924
33925 begin transports
33926 smtp_appendfile:
33927   driver = appendfile
33928   directory = /var/bsmtp/$host
33929   batch_max = 1000
33930   use_bsmtp
33931   user = exim
33932 .endd
33933 This causes messages addressed to &'domain.example'& to be written in BSMTP
33934 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33935 message (unless there are more than 1000 recipients).
33936
33937
33938
33939 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33940 .cindex "SMTP" "batched incoming"
33941 .cindex "batched SMTP input"
33942 The &%-bS%& command line option causes Exim to accept one or more messages by
33943 reading SMTP on the standard input, but to generate no responses. If the caller
33944 is trusted, the senders in the MAIL commands are believed; otherwise the
33945 sender is always the caller of Exim. Unqualified senders and receivers are not
33946 rejected (there seems little point) but instead just get qualified. HELO
33947 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33948 as NOOP; QUIT quits.
33949
33950 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33951 ACL is run in the same way as for non-SMTP local input.
33952
33953 If an error is detected while reading a message, including a missing &"."& at
33954 the end, Exim gives up immediately. It writes details of the error to the
33955 standard output in a stylized way that the calling program should be able to
33956 make some use of automatically, for example:
33957 .code
33958 554 Unexpected end of file
33959 Transaction started in line 10
33960 Error detected in line 14
33961 .endd
33962 It writes a more verbose version, for human consumption, to the standard error
33963 file, for example:
33964 .code
33965 An error was detected while processing a file of BSMTP input.
33966 The error message was:
33967
33968 501 '>' missing at end of address
33969
33970 The SMTP transaction started in line 10.
33971 The error was detected in line 12.
33972 The SMTP command at fault was:
33973
33974 rcpt to:<malformed@in.com.plete
33975
33976 1 previous message was successfully processed.
33977 The rest of the batch was abandoned.
33978 .endd
33979 The return code from Exim is zero only if there were no errors. It is 1 if some
33980 messages were accepted before an error was detected, and 2 if no messages were
33981 accepted.
33982 .ecindex IIDsmtpproc1
33983 .ecindex IIDsmtpproc2
33984
33985
33986
33987 . ////////////////////////////////////////////////////////////////////////////
33988 . ////////////////////////////////////////////////////////////////////////////
33989
33990 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33991          "Customizing messages"
33992 When a message fails to be delivered, or remains on the queue for more than a
33993 configured amount of time, Exim sends a message to the original sender, or
33994 to an alternative configured address. The text of these messages is built into
33995 the code of Exim, but it is possible to change it, either by adding a single
33996 string, or by replacing each of the paragraphs by text supplied in a file.
33997
33998 The &'From:'& and &'To:'& header lines are automatically generated; you can
33999 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34000 option. Exim also adds the line
34001 .code
34002 Auto-Submitted: auto-generated
34003 .endd
34004 to all warning and bounce messages,
34005
34006
34007 .section "Customizing bounce messages" "SECID239"
34008 .cindex "customizing" "bounce message"
34009 .cindex "bounce message" "customizing"
34010 If &%bounce_message_text%& is set, its contents are included in the default
34011 message immediately after &"This message was created automatically by mail
34012 delivery software."& The string is not expanded. It is not used if
34013 &%bounce_message_file%& is set.
34014
34015 When &%bounce_message_file%& is set, it must point to a template file for
34016 constructing error messages. The file consists of a series of text items,
34017 separated by lines consisting of exactly four asterisks. If the file cannot be
34018 opened, default text is used and a message is written to the main and panic
34019 logs. If any text item in the file is empty, default text is used for that
34020 item.
34021
34022 .vindex "&$bounce_recipient$&"
34023 .vindex "&$bounce_return_size_limit$&"
34024 Each item of text that is read from the file is expanded, and there are two
34025 expansion variables which can be of use here: &$bounce_recipient$& is set to
34026 the recipient of an error message while it is being created, and
34027 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34028 option, rounded to a whole number.
34029
34030 The items must appear in the file in the following order:
34031
34032 .ilist
34033 The first item is included in the headers, and should include at least a
34034 &'Subject:'& header. Exim does not check the syntax of these headers.
34035 .next
34036 The second item forms the start of the error message. After it, Exim lists the
34037 failing addresses with their error messages.
34038 .next
34039 The third item is used to introduce any text from pipe transports that is to be
34040 returned to the sender. It is omitted if there is no such text.
34041 .next
34042 The fourth, fifth and sixth items will be ignored and may be empty.
34043 The fields exist for back-compatibility
34044 .endlist
34045
34046 The default state (&%bounce_message_file%& unset) is equivalent to the
34047 following file, in which the sixth item is empty. The &'Subject:'& and some
34048 other lines have been split in order to fit them on the page:
34049 .code
34050 Subject: Mail delivery failed
34051   ${if eq{$sender_address}{$bounce_recipient}
34052   {: returning message to sender}}
34053 ****
34054 This message was created automatically by mail delivery software.
34055
34056 A message ${if eq{$sender_address}{$bounce_recipient}
34057   {that you sent }{sent by
34058
34059 <$sender_address>
34060
34061 }}could not be delivered to all of its recipients.
34062 This is a permanent error. The following address(es) failed:
34063 ****
34064 The following text was generated during the delivery attempt(s):
34065 ****
34066 ------ This is a copy of the message, including all the headers.
34067   ------
34068 ****
34069 ------ The body of the message is $message_size characters long;
34070   only the first
34071 ------ $bounce_return_size_limit or so are included here.
34072 ****
34073 .endd
34074 .section "Customizing warning messages" "SECTcustwarn"
34075 .cindex "customizing" "warning message"
34076 .cindex "warning of delay" "customizing the message"
34077 The option &%warn_message_file%& can be pointed at a template file for use when
34078 warnings about message delays are created. In this case there are only three
34079 text sections:
34080
34081 .ilist
34082 The first item is included in the headers, and should include at least a
34083 &'Subject:'& header. Exim does not check the syntax of these headers.
34084 .next
34085 The second item forms the start of the warning message. After it, Exim lists
34086 the delayed addresses.
34087 .next
34088 The third item then ends the message.
34089 .endlist
34090
34091 The default state is equivalent to the following file, except that some lines
34092 have been split here, in order to fit them on the page:
34093 .code
34094 Subject: Warning: message $message_exim_id delayed
34095   $warn_message_delay
34096 ****
34097 This message was created automatically by mail delivery software.
34098
34099 A message ${if eq{$sender_address}{$warn_message_recipients}
34100 {that you sent }{sent by
34101
34102 <$sender_address>
34103
34104 }}has not been delivered to all of its recipients after
34105 more than $warn_message_delay on the queue on $primary_hostname.
34106
34107 The message identifier is:     $message_exim_id
34108 The subject of the message is: $h_subject
34109 The date of the message is:    $h_date
34110
34111 The following address(es) have not yet been delivered:
34112 ****
34113 No action is required on your part. Delivery attempts will
34114 continue for some time, and this warning may be repeated at
34115 intervals if the message remains undelivered. Eventually the
34116 mail delivery software will give up, and when that happens,
34117 the message will be returned to you.
34118 .endd
34119 .vindex "&$warn_message_delay$&"
34120 .vindex "&$warn_message_recipients$&"
34121 However, in the default state the subject and date lines are omitted if no
34122 appropriate headers exist. During the expansion of this file,
34123 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34124 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34125 of recipients for the warning message. There may be more than one if there are
34126 multiple addresses with different &%errors_to%& settings on the routers that
34127 handled them.
34128
34129
34130
34131
34132 . ////////////////////////////////////////////////////////////////////////////
34133 . ////////////////////////////////////////////////////////////////////////////
34134
34135 .chapter "Some common configuration settings" "CHAPcomconreq"
34136 This chapter discusses some configuration settings that seem to be fairly
34137 common. More examples and discussion can be found in the Exim book.
34138
34139
34140
34141 .section "Sending mail to a smart host" "SECID240"
34142 .cindex "smart host" "example router"
34143 If you want to send all mail for non-local domains to a &"smart host"&, you
34144 should replace the default &(dnslookup)& router with a router which does the
34145 routing explicitly:
34146 .code
34147 send_to_smart_host:
34148   driver = manualroute
34149   route_list = !+local_domains smart.host.name
34150   transport = remote_smtp
34151 .endd
34152 You can use the smart host's IP address instead of the name if you wish.
34153 If you are using Exim only to submit messages to a smart host, and not for
34154 receiving incoming messages, you can arrange for it to do the submission
34155 synchronously by setting the &%mua_wrapper%& option (see chapter
34156 &<<CHAPnonqueueing>>&).
34157
34158
34159
34160
34161 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34162 .cindex "mailing lists"
34163 Exim can be used to run simple mailing lists, but for large and/or complicated
34164 requirements, the use of additional specialized mailing list software such as
34165 Majordomo or Mailman is recommended.
34166
34167 The &(redirect)& router can be used to handle mailing lists where each list
34168 is maintained in a separate file, which can therefore be managed by an
34169 independent manager. The &%domains%& router option can be used to run these
34170 lists in a separate domain from normal mail. For example:
34171 .code
34172 lists:
34173   driver = redirect
34174   domains = lists.example
34175   file = /usr/lists/$local_part
34176   forbid_pipe
34177   forbid_file
34178   errors_to = $local_part-request@lists.example
34179   no_more
34180 .endd
34181 This router is skipped for domains other than &'lists.example'&. For addresses
34182 in that domain, it looks for a file that matches the local part. If there is no
34183 such file, the router declines, but because &%no_more%& is set, no subsequent
34184 routers are tried, and so the whole delivery fails.
34185
34186 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34187 expanded into a file name or a pipe delivery, which is usually inappropriate in
34188 a mailing list.
34189
34190 .oindex "&%errors_to%&"
34191 The &%errors_to%& option specifies that any delivery errors caused by addresses
34192 taken from a mailing list are to be sent to the given address rather than the
34193 original sender of the message. However, before acting on this, Exim verifies
34194 the error address, and ignores it if verification fails.
34195
34196 For example, using the configuration above, mail sent to
34197 &'dicts@lists.example'& is passed on to those addresses contained in
34198 &_/usr/lists/dicts_&, with error reports directed to
34199 &'dicts-request@lists.example'&, provided that this address can be verified.
34200 There could be a file called &_/usr/lists/dicts-request_& containing
34201 the address(es) of this particular list's manager(s), but other approaches,
34202 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34203 or &%local_part_suffix%& options) to handle addresses of the form
34204 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34205
34206
34207
34208 .section "Syntax errors in mailing lists" "SECID241"
34209 .cindex "mailing lists" "syntax errors in"
34210 If an entry in redirection data contains a syntax error, Exim normally defers
34211 delivery of the original address. That means that a syntax error in a mailing
34212 list holds up all deliveries to the list. This may not be appropriate when a
34213 list is being maintained automatically from data supplied by users, and the
34214 addresses are not rigorously checked.
34215
34216 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34217 entries that fail to parse, noting the incident in the log. If in addition
34218 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34219 whenever a broken address is skipped. It is usually appropriate to set
34220 &%syntax_errors_to%& to the same address as &%errors_to%&.
34221
34222
34223
34224 .section "Re-expansion of mailing lists" "SECID242"
34225 .cindex "mailing lists" "re-expansion of"
34226 Exim remembers every individual address to which a message has been delivered,
34227 in order to avoid duplication, but it normally stores only the original
34228 recipient addresses with a message. If all the deliveries to a mailing list
34229 cannot be done at the first attempt, the mailing list is re-expanded when the
34230 delivery is next tried. This means that alterations to the list are taken into
34231 account at each delivery attempt, so addresses that have been added to
34232 the list since the message arrived will therefore receive a copy of the
34233 message, even though it pre-dates their subscription.
34234
34235 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34236 on the &(redirect)& router. If this is done, any addresses generated by the
34237 router that fail to deliver at the first attempt are added to the message as
34238 &"top level"& addresses, and the parent address that generated them is marked
34239 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34240 subsequent delivery attempts. The disadvantage of this is that if any of the
34241 failing addresses are incorrect, correcting them in the file has no effect on
34242 pre-existing messages.
34243
34244 The original top-level address is remembered with each of the generated
34245 addresses, and is output in any log messages. However, any intermediate parent
34246 addresses are not recorded. This makes a difference to the log only if the
34247 &%all_parents%& selector is set, but for mailing lists there is normally only
34248 one level of expansion anyway.
34249
34250
34251
34252 .section "Closed mailing lists" "SECID243"
34253 .cindex "mailing lists" "closed"
34254 The examples so far have assumed open mailing lists, to which anybody may
34255 send mail. It is also possible to set up closed lists, where mail is accepted
34256 from specified senders only. This is done by making use of the generic
34257 &%senders%& option to restrict the router that handles the list.
34258
34259 The following example uses the same file as a list of recipients and as a list
34260 of permitted senders. It requires three routers:
34261 .code
34262 lists_request:
34263   driver = redirect
34264   domains = lists.example
34265   local_part_suffix = -request
34266   file = /usr/lists/$local_part$local_part_suffix
34267   no_more
34268
34269 lists_post:
34270   driver = redirect
34271   domains = lists.example
34272   senders = ${if exists {/usr/lists/$local_part}\
34273              {lsearch;/usr/lists/$local_part}{*}}
34274   file = /usr/lists/$local_part
34275   forbid_pipe
34276   forbid_file
34277   errors_to = $local_part-request@lists.example
34278   no_more
34279
34280 lists_closed:
34281   driver = redirect
34282   domains = lists.example
34283   allow_fail
34284   data = :fail: $local_part@lists.example is a closed mailing list
34285 .endd
34286 All three routers have the same &%domains%& setting, so for any other domains,
34287 they are all skipped. The first router runs only if the local part ends in
34288 &%-request%&. It handles messages to the list manager(s) by means of an open
34289 mailing list.
34290
34291 The second router runs only if the &%senders%& precondition is satisfied. It
34292 checks for the existence of a list that corresponds to the local part, and then
34293 checks that the sender is on the list by means of a linear search. It is
34294 necessary to check for the existence of the file before trying to search it,
34295 because otherwise Exim thinks there is a configuration error. If the file does
34296 not exist, the expansion of &%senders%& is *, which matches all senders. This
34297 means that the router runs, but because there is no list, declines, and
34298 &%no_more%& ensures that no further routers are run. The address fails with an
34299 &"unrouteable address"& error.
34300
34301 The third router runs only if the second router is skipped, which happens when
34302 a mailing list exists, but the sender is not on it. This router forcibly fails
34303 the address, giving a suitable error message.
34304
34305
34306
34307
34308 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34309 .cindex "VERP"
34310 .cindex "Variable Envelope Return Paths"
34311 .cindex "envelope sender"
34312 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34313 are a way of helping mailing list administrators discover which subscription
34314 address is the cause of a particular delivery failure. The idea is to encode
34315 the original recipient address in the outgoing envelope sender address, so that
34316 if the message is forwarded by another host and then subsequently bounces, the
34317 original recipient can be extracted from the recipient address of the bounce.
34318
34319 .oindex &%errors_to%&
34320 .oindex &%return_path%&
34321 Envelope sender addresses can be modified by Exim using two different
34322 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34323 list examples), or the &%return_path%& option on a transport. The second of
34324 these is effective only if the message is successfully delivered to another
34325 host; it is not used for errors detected on the local host (see the description
34326 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34327 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34328 .code
34329 verp_smtp:
34330   driver = smtp
34331   max_rcpt = 1
34332   return_path = \
34333     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34334       {$1-request+$local_part=$domain@your.dom.example}fail}
34335 .endd
34336 This has the effect of rewriting the return path (envelope sender) on outgoing
34337 SMTP messages, if the local part of the original return path ends in
34338 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34339 local part and domain of the recipient into the return path. Suppose, for
34340 example, that a message whose return path has been set to
34341 &'somelist-request@your.dom.example'& is sent to
34342 &'subscriber@other.dom.example'&. In the transport, the return path is
34343 rewritten as
34344 .code
34345 somelist-request+subscriber=other.dom.example@your.dom.example
34346 .endd
34347 .vindex "&$local_part$&"
34348 For this to work, you must tell Exim to send multiple copies of messages that
34349 have more than one recipient, so that each copy has just one recipient. This is
34350 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34351 might be sent to several different recipients in the same domain, in which case
34352 &$local_part$& is not available in the transport, because it is not unique.
34353
34354 Unless your host is doing nothing but mailing list deliveries, you should
34355 probably use a separate transport for the VERP deliveries, so as not to use
34356 extra resources in making one-per-recipient copies for other deliveries. This
34357 can easily be done by expanding the &%transport%& option in the router:
34358 .code
34359 dnslookup:
34360   driver = dnslookup
34361   domains = ! +local_domains
34362   transport = \
34363     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34364       {verp_smtp}{remote_smtp}}
34365   no_more
34366 .endd
34367 If you want to change the return path using &%errors_to%& in a router instead
34368 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34369 routers that handle mailing list addresses. This will ensure that all delivery
34370 errors, including those detected on the local host, are sent to the VERP
34371 address.
34372
34373 On a host that does no local deliveries and has no manual routing, only the
34374 &(dnslookup)& router needs to be changed. A special transport is not needed for
34375 SMTP deliveries. Every mailing list recipient has its own return path value,
34376 and so Exim must hand them to the transport one at a time. Here is an example
34377 of a &(dnslookup)& router that implements VERP:
34378 .code
34379 verp_dnslookup:
34380   driver = dnslookup
34381   domains = ! +local_domains
34382   transport = remote_smtp
34383   errors_to = \
34384     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34385      {$1-request+$local_part=$domain@your.dom.example}fail}
34386   no_more
34387 .endd
34388 Before you start sending out messages with VERPed return paths, you must also
34389 configure Exim to accept the bounce messages that come back to those paths.
34390 Typically this is done by setting a &%local_part_suffix%& option for a
34391 router, and using this to route the messages to wherever you want to handle
34392 them.
34393
34394 The overhead incurred in using VERP depends very much on the size of the
34395 message, the number of recipient addresses that resolve to the same remote
34396 host, and the speed of the connection over which the message is being sent. If
34397 a lot of addresses resolve to the same host and the connection is slow, sending
34398 a separate copy of the message for each address may take substantially longer
34399 than sending a single copy with many recipients (for which VERP cannot be
34400 used).
34401
34402
34403
34404
34405
34406
34407 .section "Virtual domains" "SECTvirtualdomains"
34408 .cindex "virtual domains"
34409 .cindex "domain" "virtual"
34410 The phrase &'virtual domain'& is unfortunately used with two rather different
34411 meanings:
34412
34413 .ilist
34414 A domain for which there are no real mailboxes; all valid local parts are
34415 aliases for other email addresses. Common examples are organizational
34416 top-level domains and &"vanity"& domains.
34417 .next
34418 One of a number of independent domains that are all handled by the same host,
34419 with mailboxes on that host, but where the mailbox owners do not necessarily
34420 have login accounts on that host.
34421 .endlist
34422
34423 The first usage is probably more common, and does seem more &"virtual"& than
34424 the second. This kind of domain can be handled in Exim with a straightforward
34425 aliasing router. One approach is to create a separate alias file for each
34426 virtual domain. Exim can test for the existence of the alias file to determine
34427 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34428 to a router of this form:
34429 .code
34430 virtual:
34431   driver = redirect
34432   domains = dsearch;/etc/mail/virtual
34433   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34434   no_more
34435 .endd
34436 The &%domains%& option specifies that the router is to be skipped, unless there
34437 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34438 domain that is being processed. When the router runs, it looks up the local
34439 part in the file to find a new address (or list of addresses). The &%no_more%&
34440 setting ensures that if the lookup fails (leading to &%data%& being an empty
34441 string), Exim gives up on the address without trying any subsequent routers.
34442
34443 This one router can handle all the virtual domains because the alias file names
34444 follow a fixed pattern. Permissions can be arranged so that appropriate people
34445 can edit the different alias files. A successful aliasing operation results in
34446 a new envelope recipient address, which is then routed from scratch.
34447
34448 The other kind of &"virtual"& domain can also be handled in a straightforward
34449 way. One approach is to create a file for each domain containing a list of
34450 valid local parts, and use it in a router like this:
34451 .code
34452 my_domains:
34453   driver = accept
34454   domains = dsearch;/etc/mail/domains
34455   local_parts = lsearch;/etc/mail/domains/$domain
34456   transport = my_mailboxes
34457 .endd
34458 The address is accepted if there is a file for the domain, and the local part
34459 can be found in the file. The &%domains%& option is used to check for the
34460 file's existence because &%domains%& is tested before the &%local_parts%&
34461 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34462 because that option is tested after &%local_parts%&. The transport is as
34463 follows:
34464 .code
34465 my_mailboxes:
34466   driver = appendfile
34467   file = /var/mail/$domain/$local_part
34468   user = mail
34469 .endd
34470 This uses a directory of mailboxes for each domain. The &%user%& setting is
34471 required, to specify which uid is to be used for writing to the mailboxes.
34472
34473 The configuration shown here is just one example of how you might support this
34474 requirement. There are many other ways this kind of configuration can be set
34475 up, for example, by using a database instead of separate files to hold all the
34476 information about the domains.
34477
34478
34479
34480 .section "Multiple user mailboxes" "SECTmulbox"
34481 .cindex "multiple mailboxes"
34482 .cindex "mailbox" "multiple"
34483 .cindex "local part" "prefix"
34484 .cindex "local part" "suffix"
34485 Heavy email users often want to operate with multiple mailboxes, into which
34486 incoming mail is automatically sorted. A popular way of handling this is to
34487 allow users to use multiple sender addresses, so that replies can easily be
34488 identified. Users are permitted to add prefixes or suffixes to their local
34489 parts for this purpose. The wildcard facility of the generic router options
34490 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34491 example, consider this router:
34492 .code
34493 userforward:
34494   driver = redirect
34495   check_local_user
34496   file = $home/.forward
34497   local_part_suffix = -*
34498   local_part_suffix_optional
34499   allow_filter
34500 .endd
34501 .vindex "&$local_part_suffix$&"
34502 It runs a user's &_.forward_& file for all local parts of the form
34503 &'username-*'&. Within the filter file the user can distinguish different
34504 cases by testing the variable &$local_part_suffix$&. For example:
34505 .code
34506 if $local_part_suffix contains -special then
34507 save /home/$local_part/Mail/special
34508 endif
34509 .endd
34510 If the filter file does not exist, or does not deal with such addresses, they
34511 fall through to subsequent routers, and, assuming no subsequent use of the
34512 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34513 control over which suffixes are valid.
34514
34515 Alternatively, a suffix can be used to trigger the use of a different
34516 &_.forward_& file &-- which is the way a similar facility is implemented in
34517 another MTA:
34518 .code
34519 userforward:
34520   driver = redirect
34521   check_local_user
34522   file = $home/.forward$local_part_suffix
34523   local_part_suffix = -*
34524   local_part_suffix_optional
34525   allow_filter
34526 .endd
34527 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34528 example, &_.forward-special_& is used. Once again, if the appropriate file
34529 does not exist, or does not deal with the address, it is passed on to
34530 subsequent routers, which could, if required, look for an unqualified
34531 &_.forward_& file to use as a default.
34532
34533
34534
34535 .section "Simplified vacation processing" "SECID244"
34536 .cindex "vacation processing"
34537 The traditional way of running the &'vacation'& program is for a user to set up
34538 a pipe command in a &_.forward_& file
34539 (see section &<<SECTspecitredli>>& for syntax details).
34540 This is prone to error by inexperienced users. There are two features of Exim
34541 that can be used to make this process simpler for users:
34542
34543 .ilist
34544 A local part prefix such as &"vacation-"& can be specified on a router which
34545 can cause the message to be delivered directly to the &'vacation'& program, or
34546 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34547 &_.forward_& file are then much simpler. For example:
34548 .code
34549 spqr, vacation-spqr
34550 .endd
34551 .next
34552 The &%require_files%& generic router option can be used to trigger a
34553 vacation delivery by checking for the existence of a certain file in the
34554 user's home directory. The &%unseen%& generic option should also be used, to
34555 ensure that the original delivery also proceeds. In this case, all the user has
34556 to do is to create a file called, say, &_.vacation_&, containing a vacation
34557 message.
34558 .endlist
34559
34560 Another advantage of both these methods is that they both work even when the
34561 use of arbitrary pipes by users is locked out.
34562
34563
34564
34565 .section "Taking copies of mail" "SECID245"
34566 .cindex "message" "copying every"
34567 Some installations have policies that require archive copies of all messages to
34568 be made. A single copy of each message can easily be taken by an appropriate
34569 command in a system filter, which could, for example, use a different file for
34570 each day's messages.
34571
34572 There is also a shadow transport mechanism that can be used to take copies of
34573 messages that are successfully delivered by local transports, one copy per
34574 delivery. This could be used, &'inter alia'&, to implement automatic
34575 notification of delivery by sites that insist on doing such things.
34576
34577
34578
34579 .section "Intermittently connected hosts" "SECID246"
34580 .cindex "intermittently connected hosts"
34581 It has become quite common (because it is cheaper) for hosts to connect to the
34582 Internet periodically rather than remain connected all the time. The normal
34583 arrangement is that mail for such hosts accumulates on a system that is
34584 permanently connected.
34585
34586 Exim was designed for use on permanently connected hosts, and so it is not
34587 particularly well-suited to use in an intermittently connected environment.
34588 Nevertheless there are some features that can be used.
34589
34590
34591 .section "Exim on the upstream server host" "SECID247"
34592 It is tempting to arrange for incoming mail for the intermittently connected
34593 host to remain on Exim's queue until the client connects. However, this
34594 approach does not scale very well. Two different kinds of waiting message are
34595 being mixed up in the same queue &-- those that cannot be delivered because of
34596 some temporary problem, and those that are waiting for their destination host
34597 to connect. This makes it hard to manage the queue, as well as wasting
34598 resources, because each queue runner scans the entire queue.
34599
34600 A better approach is to separate off those messages that are waiting for an
34601 intermittently connected host. This can be done by delivering these messages
34602 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34603 format, from where they are transmitted by other software when their
34604 destination connects. This makes it easy to collect all the mail for one host
34605 in a single directory, and to apply local timeout rules on a per-message basis
34606 if required.
34607
34608 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34609 you are doing this, you should configure Exim with a long retry period for the
34610 intermittent host. For example:
34611 .code
34612 cheshire.wonderland.fict.example    *   F,5d,24h
34613 .endd
34614 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34615 which messages it has queued up for that host. Once the intermittent host comes
34616 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34617 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34618 causes all the queued up messages to be delivered, often down a single SMTP
34619 connection. While the host remains connected, any new messages get delivered
34620 immediately.
34621
34622 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34623 issued with a different IP address each time it connects, Exim's retry
34624 mechanisms on the holding host get confused, because the IP address is normally
34625 used as part of the key string for holding retry information. This can be
34626 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34627 Since this has disadvantages for permanently connected hosts, it is best to
34628 arrange a separate transport for the intermittently connected ones.
34629
34630
34631
34632 .section "Exim on the intermittently connected client host" "SECID248"
34633 The value of &%smtp_accept_queue_per_connection%& should probably be
34634 increased, or even set to zero (that is, disabled) on the intermittently
34635 connected host, so that all incoming messages down a single connection get
34636 delivered immediately.
34637
34638 .cindex "SMTP" "passed connection"
34639 .cindex "SMTP" "multiple deliveries"
34640 .cindex "multiple SMTP deliveries"
34641 Mail waiting to be sent from an intermittently connected host will probably
34642 not have been routed, because without a connection DNS lookups are not
34643 possible. This means that if a normal queue run is done at connection time,
34644 each message is likely to be sent in a separate SMTP session. This can be
34645 avoided by starting the queue run with a command line option beginning with
34646 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34647 first pass, routing is done but no deliveries take place. The second pass is a
34648 normal queue run; since all the messages have been previously routed, those
34649 destined for the same host are likely to get sent as multiple deliveries in a
34650 single SMTP connection.
34651
34652
34653
34654 . ////////////////////////////////////////////////////////////////////////////
34655 . ////////////////////////////////////////////////////////////////////////////
34656
34657 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34658          "Exim as a non-queueing client"
34659 .cindex "client, non-queueing"
34660 .cindex "smart host" "suppressing queueing"
34661 On a personal computer, it is a common requirement for all
34662 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34663 configured to operate that way, for all the popular operating systems.
34664 However, there are some MUAs for Unix-like systems that cannot be so
34665 configured: they submit messages using the command line interface of
34666 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34667 messages this way.
34668
34669 If the personal computer runs continuously, there is no problem, because it can
34670 run a conventional MTA that handles delivery to the smart host, and deal with
34671 any delays via its queueing mechanism. However, if the computer does not run
34672 continuously or runs different operating systems at different times, queueing
34673 email is not desirable.
34674
34675 There is therefore a requirement for something that can provide the
34676 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34677 any queueing or retrying facilities. Furthermore, the delivery to the smart
34678 host should be synchronous, so that if it fails, the sending MUA is immediately
34679 informed. In other words, we want something that extends an MUA that submits
34680 to a local MTA via the command line so that it behaves like one that submits
34681 to a remote smart host using TCP/SMTP.
34682
34683 There are a number of applications (for example, there is one called &'ssmtp'&)
34684 that do this job. However, people have found them to be lacking in various
34685 ways. For instance, you might want to allow aliasing and forwarding to be done
34686 before sending a message to the smart host.
34687
34688 Exim already had the necessary infrastructure for doing this job. Just a few
34689 tweaks were needed to make it behave as required, though it is somewhat of an
34690 overkill to use a fully-featured MTA for this purpose.
34691
34692 .oindex "&%mua_wrapper%&"
34693 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34694 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34695 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34696 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34697 compatible router and transport configuration. Typically there will be just one
34698 router and one transport, sending everything to a smart host.
34699
34700 When run in MUA wrapping mode, the behaviour of Exim changes in the
34701 following ways:
34702
34703 .ilist
34704 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34705 In other words, the only way to submit messages is via the command line.
34706 .next
34707 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34708 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34709 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34710 does not finish until the delivery attempt is complete. If the delivery is
34711 successful, a zero return code is given.
34712 .next
34713 Address redirection is permitted, but the final routing for all addresses must
34714 be to the same remote transport, and to the same list of hosts. Furthermore,
34715 the return address (envelope sender) must be the same for all recipients, as
34716 must any added or deleted header lines. In other words, it must be possible to
34717 deliver the message in a single SMTP transaction, however many recipients there
34718 are.
34719 .next
34720 If these conditions are not met, or if routing any address results in a
34721 failure or defer status, or if Exim is unable to deliver all the recipients
34722 successfully to one of the smart hosts, delivery of the entire message fails.
34723 .next
34724 Because no queueing is allowed, all failures are treated as permanent; there
34725 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34726 smart host. Furthermore, because only a single yes/no response can be given to
34727 the caller, it is not possible to deliver to some recipients and not others. If
34728 there is an error (temporary or permanent) for any recipient, all are failed.
34729 .next
34730 If more than one smart host is listed, Exim will try another host after a
34731 connection failure or a timeout, in the normal way. However, if this kind of
34732 failure happens for all the hosts, the delivery fails.
34733 .next
34734 When delivery fails, an error message is written to the standard error stream
34735 (as well as to Exim's log), and Exim exits to the caller with a return code
34736 value 1. The message is expunged from Exim's spool files. No bounce messages
34737 are ever generated.
34738 .next
34739 No retry data is maintained, and any retry rules are ignored.
34740 .next
34741 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34742 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34743 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34744 .endlist
34745
34746 The overall effect is that Exim makes a single synchronous attempt to deliver
34747 the message, failing if there is any kind of problem. Because no local
34748 deliveries are done and no daemon can be run, Exim does not need root
34749 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34750 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34751 the advantages and disadvantages of running without root privilege.
34752
34753
34754
34755
34756 . ////////////////////////////////////////////////////////////////////////////
34757 . ////////////////////////////////////////////////////////////////////////////
34758
34759 .chapter "Log files" "CHAPlog"
34760 .scindex IIDloggen "log" "general description"
34761 .cindex "log" "types of"
34762 Exim writes three different logs, referred to as the main log, the reject log,
34763 and the panic log:
34764
34765 .ilist
34766 .cindex "main log"
34767 The main log records the arrival of each message and each delivery in a single
34768 line in each case. The format is as compact as possible, in an attempt to keep
34769 down the size of log files. Two-character flag sequences make it easy to pick
34770 out these lines. A number of other events are recorded in the main log. Some of
34771 them are optional, in which case the &%log_selector%& option controls whether
34772 they are included or not. A Perl script called &'eximstats'&, which does simple
34773 analysis of main log files, is provided in the Exim distribution (see section
34774 &<<SECTmailstat>>&).
34775 .next
34776 .cindex "reject log"
34777 The reject log records information from messages that are rejected as a result
34778 of a configuration option (that is, for policy reasons).
34779 The first line of each rejection is a copy of the line that is also written to
34780 the main log. Then, if the message's header has been read at the time the log
34781 is written, its contents are written to this log. Only the original header
34782 lines are available; header lines added by ACLs are not logged. You can use the
34783 reject log to check that your policy controls are working correctly; on a busy
34784 host this may be easier than scanning the main log for rejection messages. You
34785 can suppress the writing of the reject log by setting &%write_rejectlog%&
34786 false.
34787 .next
34788 .cindex "panic log"
34789 .cindex "system log"
34790 When certain serious errors occur, Exim writes entries to its panic log. If the
34791 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34792 are usually written to the main log as well, but can get lost amid the mass of
34793 other entries. The panic log should be empty under normal circumstances. It is
34794 therefore a good idea to check it (or to have a &'cron'& script check it)
34795 regularly, in order to become aware of any problems. When Exim cannot open its
34796 panic log, it tries as a last resort to write to the system log (syslog). This
34797 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34798 message itself is written at priority LOG_CRIT.
34799 .endlist
34800
34801 Every log line starts with a timestamp, in the format shown in the following
34802 example. Note that many of the examples shown in this chapter are line-wrapped.
34803 In the log file, this would be all on one line:
34804 .code
34805 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34806   by QUIT
34807 .endd
34808 By default, the timestamps are in the local timezone. There are two
34809 ways of changing this:
34810
34811 .ilist
34812 You can set the &%timezone%& option to a different time zone; in particular, if
34813 you set
34814 .code
34815 timezone = UTC
34816 .endd
34817 the timestamps will be in UTC (aka GMT).
34818 .next
34819 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34820 example:
34821 .code
34822 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34823 .endd
34824 .endlist
34825
34826 .cindex "log" "process ids in"
34827 .cindex "pid (process id)" "in log lines"
34828 Exim does not include its process id in log lines by default, but you can
34829 request that it does so by specifying the &`pid`& log selector (see section
34830 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34831 brackets, immediately after the time and date.
34832
34833
34834
34835
34836 .section "Where the logs are written" "SECTwhelogwri"
34837 .cindex "log" "destination"
34838 .cindex "log" "to file"
34839 .cindex "log" "to syslog"
34840 .cindex "syslog"
34841 The logs may be written to local files, or to syslog, or both. However, it
34842 should be noted that many syslog implementations use UDP as a transport, and
34843 are therefore unreliable in the sense that messages are not guaranteed to
34844 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34845 It has also been reported that on large log files (tens of megabytes) you may
34846 need to tweak syslog to prevent it syncing the file with each write &-- on
34847 Linux this has been seen to make syslog take 90% plus of CPU time.
34848
34849 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34850 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34851 configuration. This latter string is expanded, so it can contain, for example,
34852 references to the host name:
34853 .code
34854 log_file_path = /var/log/$primary_hostname/exim_%slog
34855 .endd
34856 It is generally advisable, however, to set the string in &_Local/Makefile_&
34857 rather than at run time, because then the setting is available right from the
34858 start of Exim's execution. Otherwise, if there's something it wants to log
34859 before it has read the configuration file (for example, an error in the
34860 configuration file) it will not use the path you want, and may not be able to
34861 log at all.
34862
34863 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34864 list, currently limited to at most two items. This is one option where the
34865 facility for changing a list separator may not be used. The list must always be
34866 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34867 otherwise the item must either be an absolute path, containing &`%s`& at the
34868 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34869 implying the use of a default path.
34870
34871 When Exim encounters an empty item in the list, it searches the list defined by
34872 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34873 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34874 mean &"use the path specified at build time"&. It no such item exists, log
34875 files are written in the &_log_& subdirectory of the spool directory. This is
34876 equivalent to the setting:
34877 .code
34878 log_file_path = $spool_directory/log/%slog
34879 .endd
34880 If you do not specify anything at build time or run time,
34881 or if you unset the option at run time (i.e. &`log_file_path = `&),
34882 that is where the logs are written.
34883
34884 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34885 are in use &-- see section &<<SECTdatlogfil>>& below.
34886
34887 Here are some examples of possible settings:
34888 .display
34889 &`LOG_FILE_PATH=syslog                    `& syslog only
34890 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34891 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34892 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34893 .endd
34894 If there are more than two paths in the list, the first is used and a panic
34895 error is logged.
34896
34897
34898
34899 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34900 .cindex "log" "cycling local files"
34901 .cindex "cycling logs"
34902 .cindex "&'exicyclog'&"
34903 .cindex "log" "local files; writing to"
34904 Some operating systems provide centralized and standardized methods for cycling
34905 log files. For those that do not, a utility script called &'exicyclog'& is
34906 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34907 main and reject logs each time it is called. The maximum number of old logs to
34908 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34909
34910 An Exim delivery process opens the main log when it first needs to write to it,
34911 and it keeps the file open in case subsequent entries are required &-- for
34912 example, if a number of different deliveries are being done for the same
34913 message. However, remote SMTP deliveries can take a long time, and this means
34914 that the file may be kept open long after it is renamed if &'exicyclog'& or
34915 something similar is being used to rename log files on a regular basis. To
34916 ensure that a switch of log files is noticed as soon as possible, Exim calls
34917 &[stat()]& on the main log's name before reusing an open file, and if the file
34918 does not exist, or its inode has changed, the old file is closed and Exim
34919 tries to open the main log from scratch. Thus, an old log file may remain open
34920 for quite some time, but no Exim processes should write to it once it has been
34921 renamed.
34922
34923
34924
34925 .section "Datestamped log files" "SECTdatlogfil"
34926 .cindex "log" "datestamped files"
34927 Instead of cycling the main and reject log files by renaming them
34928 periodically, some sites like to use files whose names contain a datestamp,
34929 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34930 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34931 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34932 point where the datestamp is required. For example:
34933 .code
34934 log_file_path = /var/spool/exim/log/%slog-%D
34935 log_file_path = /var/log/exim-%s-%D.log
34936 log_file_path = /var/spool/exim/log/%D-%slog
34937 log_file_path = /var/log/exim/%s.%M
34938 .endd
34939 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34940 examples of names generated by the above examples:
34941 .code
34942 /var/spool/exim/log/mainlog-20021225
34943 /var/log/exim-reject-20021225.log
34944 /var/spool/exim/log/20021225-mainlog
34945 /var/log/exim/main.200212
34946 .endd
34947 When this form of log file is specified, Exim automatically switches to new
34948 files at midnight. It does not make any attempt to compress old logs; you
34949 will need to write your own script if you require this. You should not
34950 run &'exicyclog'& with this form of logging.
34951
34952 The location of the panic log is also determined by &%log_file_path%&, but it
34953 is not datestamped, because rotation of the panic log does not make sense.
34954 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34955 the string. In addition, if it immediately follows a slash, a following
34956 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34957 character is removed. Thus, the four examples above would give these panic
34958 log names:
34959 .code
34960 /var/spool/exim/log/paniclog
34961 /var/log/exim-panic.log
34962 /var/spool/exim/log/paniclog
34963 /var/log/exim/panic
34964 .endd
34965
34966
34967 .section "Logging to syslog" "SECID249"
34968 .cindex "log" "syslog; writing to"
34969 The use of syslog does not change what Exim logs or the format of its messages,
34970 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34971 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34972 that, the same strings are written to syslog as to log files. The syslog
34973 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34974 by default, but you can change these by setting the &%syslog_facility%& and
34975 &%syslog_processname%& options, respectively. If Exim was compiled with
34976 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34977 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34978 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34979 the time and host name to each line.
34980 The three log streams are mapped onto syslog priorities as follows:
34981
34982 .ilist
34983 &'mainlog'& is mapped to LOG_INFO
34984 .next
34985 &'rejectlog'& is mapped to LOG_NOTICE
34986 .next
34987 &'paniclog'& is mapped to LOG_ALERT
34988 .endlist
34989
34990 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34991 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34992 these are routed by syslog to the same place. You can suppress this duplication
34993 by setting &%syslog_duplication%& false.
34994
34995 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34996 entries contain multiple lines when headers are included. To cope with both
34997 these cases, entries written to syslog are split into separate &[syslog()]&
34998 calls at each internal newline, and also after a maximum of
34999 870 data characters. (This allows for a total syslog line length of 1024, when
35000 additions such as timestamps are added.) If you are running a syslog
35001 replacement that can handle lines longer than the 1024 characters allowed by
35002 RFC 3164, you should set
35003 .code
35004 SYSLOG_LONG_LINES=yes
35005 .endd
35006 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35007 lines, but it still splits at internal newlines in &'reject'& log entries.
35008
35009 To make it easy to re-assemble split lines later, each component of a split
35010 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35011 where <&'n'&> is the component number and <&'m'&> is the total number of
35012 components in the entry. The / delimiter is used when the line was split
35013 because it was too long; if it was split because of an internal newline, the \
35014 delimiter is used. For example, supposing the length limit to be 50 instead of
35015 870, the following would be the result of a typical rejection message to
35016 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35017 name, and pid as added by syslog:
35018 .code
35019 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35020 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35021 [3/5]  when scanning for sender: missing or malformed lo
35022 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35023 [5/5] mple>)
35024 .endd
35025 The same error might cause the following lines to be written to &"rejectlog"&
35026 (LOG_NOTICE):
35027 .code
35028 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35029 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35030 [3/18] er when scanning for sender: missing or malformed
35031 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35032 [5\18] .example>)
35033 [6\18] Recipients: ph10@some.domain.cam.example
35034 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35035 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35036 [9\18]        id 16RdAL-0006pc-00
35037 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35038 [11\18] 09:43 +0100
35039 [12\18] F From: <>
35040 [13\18]   Subject: this is a test header
35041 [18\18]   X-something: this is another header
35042 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35043 [16\18] le>
35044 [17\18] B Bcc:
35045 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35046 .endd
35047 Log lines that are neither too long nor contain newlines are written to syslog
35048 without modification.
35049
35050 If only syslog is being used, the Exim monitor is unable to provide a log tail
35051 display, unless syslog is routing &'mainlog'& to a file on the local host and
35052 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35053 where it is.
35054
35055
35056
35057 .section "Log line flags" "SECID250"
35058 One line is written to the main log for each message received, and for each
35059 successful, unsuccessful, and delayed delivery. These lines can readily be
35060 picked out by the distinctive two-character flags that immediately follow the
35061 timestamp. The flags are:
35062 .display
35063 &`<=`&     message arrival
35064 &`=>`&     normal message delivery
35065 &`->`&     additional address in same delivery
35066 &`>>`&     cutthrough message delivery
35067 &`*>`&     delivery suppressed by &%-N%&
35068 &`**`&     delivery failed; address bounced
35069 &`==`&     delivery deferred; temporary problem
35070 .endd
35071
35072
35073 .section "Logging message reception" "SECID251"
35074 .cindex "log" "reception line"
35075 The format of the single-line entry in the main log that is written for every
35076 message received is shown in the basic example below, which is split over
35077 several lines in order to fit it on the page:
35078 .code
35079 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35080   H=mailer.fict.example [192.168.123.123] U=exim
35081   P=smtp S=5678 id=<incoming message id>
35082 .endd
35083 The address immediately following &"<="& is the envelope sender address. A
35084 bounce message is shown with the sender address &"<>"&, and if it is locally
35085 generated, this is followed by an item of the form
35086 .code
35087 R=<message id>
35088 .endd
35089 which is a reference to the message that caused the bounce to be sent.
35090
35091 .cindex "HELO"
35092 .cindex "EHLO"
35093 For messages from other hosts, the H and U fields identify the remote host and
35094 record the RFC 1413 identity of the user that sent the message, if one was
35095 received. The number given in square brackets is the IP address of the sending
35096 host. If there is a single, unparenthesized  host name in the H field, as
35097 above, it has been verified to correspond to the IP address (see the
35098 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35099 by the remote host in the SMTP HELO or EHLO command, and has not been
35100 verified. If verification yields a different name to that given for HELO or
35101 EHLO, the verified name appears first, followed by the HELO or EHLO
35102 name in parentheses.
35103
35104 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35105 without brackets, in the HELO or EHLO command, leading to entries in
35106 the log containing text like these examples:
35107 .code
35108 H=(10.21.32.43) [192.168.8.34]
35109 H=([10.21.32.43]) [192.168.8.34]
35110 .endd
35111 This can be confusing. Only the final address in square brackets can be relied
35112 on.
35113
35114 For locally generated messages (that is, messages not received over TCP/IP),
35115 the H field is omitted, and the U field contains the login name of the caller
35116 of Exim.
35117
35118 .cindex "authentication" "logging"
35119 .cindex "AUTH" "logging"
35120 For all messages, the P field specifies the protocol used to receive the
35121 message. This is the value that is stored in &$received_protocol$&. In the case
35122 of incoming SMTP messages, the value indicates whether or not any SMTP
35123 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35124 session was encrypted, there is an additional X field that records the cipher
35125 suite that was used.
35126
35127 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35128 hosts that have authenticated themselves using the SMTP AUTH command. The first
35129 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35130 there is an additional item A= followed by the name of the authenticator that
35131 was used. If an authenticated identification was set up by the authenticator's
35132 &%server_set_id%& option, this is logged too, separated by a colon from the
35133 authenticator name.
35134
35135 .cindex "size" "of message"
35136 The id field records the existing message id, if present. The size of the
35137 received message is given by the S field. When the message is delivered,
35138 headers may be removed or added, so that the size of delivered copies of the
35139 message may not correspond with this value (and indeed may be different to each
35140 other).
35141
35142 The &%log_selector%& option can be used to request the logging of additional
35143 data when a message is received. See section &<<SECTlogselector>>& below.
35144
35145
35146
35147 .section "Logging deliveries" "SECID252"
35148 .cindex "log" "delivery line"
35149 The format of the single-line entry in the main log that is written for every
35150 delivery is shown in one of the examples below, for local and remote
35151 deliveries, respectively. Each example has been split into two lines in order
35152 to fit it on the page:
35153 .code
35154 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35155   <marv@hitch.fict.example> R=localuser T=local_delivery
35156 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35157   monk@holistic.fict.example R=dnslookup T=remote_smtp
35158   H=holistic.fict.example [192.168.234.234]
35159 .endd
35160 For ordinary local deliveries, the original address is given in angle brackets
35161 after the final delivery address, which might be a pipe or a file. If
35162 intermediate address(es) exist between the original and the final address, the
35163 last of these is given in parentheses after the final address. The R and T
35164 fields record the router and transport that were used to process the address.
35165
35166 If SMTP AUTH was used for the delivery there is an additional item A=
35167 followed by the name of the authenticator that was used.
35168 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35169 option, this is logged too, separated by a colon from the authenticator name.
35170
35171 If a shadow transport was run after a successful local delivery, the log line
35172 for the successful delivery has an item added on the end, of the form
35173 .display
35174 &`ST=<`&&'shadow transport name'&&`>`&
35175 .endd
35176 If the shadow transport did not succeed, the error message is put in
35177 parentheses afterwards.
35178
35179 .cindex "asterisk" "after IP address"
35180 When more than one address is included in a single delivery (for example, two
35181 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35182 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35183 down a single SMTP connection, an asterisk follows the IP address in the log
35184 lines for the second and subsequent messages.
35185
35186 .cindex "delivery" "cutthrough; logging"
35187 .cindex "cutthrough" "logging"
35188 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35189 line precedes the reception line, since cutthrough waits for a possible
35190 rejection from the destination in case it can reject the sourced item.
35191
35192 The generation of a reply message by a filter file gets logged as a
35193 &"delivery"& to the addressee, preceded by &">"&.
35194
35195 The &%log_selector%& option can be used to request the logging of additional
35196 data when a message is delivered. See section &<<SECTlogselector>>& below.
35197
35198
35199 .section "Discarded deliveries" "SECID253"
35200 .cindex "discarded messages"
35201 .cindex "message" "discarded"
35202 .cindex "delivery" "discarded; logging"
35203 When a message is discarded as a result of the command &"seen finish"& being
35204 obeyed in a filter file which generates no deliveries, a log entry of the form
35205 .code
35206 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35207   <low.club@bridge.example> R=userforward
35208 .endd
35209 is written, to record why no deliveries are logged. When a message is discarded
35210 because it is aliased to &":blackhole:"& the log line is like this:
35211 .code
35212 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35213   <hole@nowhere.example> R=blackhole_router
35214 .endd
35215
35216
35217 .section "Deferred deliveries" "SECID254"
35218 When a delivery is deferred, a line of the following form is logged:
35219 .code
35220 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35221   R=dnslookup T=smtp defer (146): Connection refused
35222 .endd
35223 In the case of remote deliveries, the error is the one that was given for the
35224 last IP address that was tried. Details of individual SMTP failures are also
35225 written to the log, so the above line would be preceded by something like
35226 .code
35227 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35228   mail1.endrest.example [192.168.239.239]: Connection refused
35229 .endd
35230 When a deferred address is skipped because its retry time has not been reached,
35231 a message is written to the log, but this can be suppressed by setting an
35232 appropriate value in &%log_selector%&.
35233
35234
35235
35236 .section "Delivery failures" "SECID255"
35237 .cindex "delivery" "failure; logging"
35238 If a delivery fails because an address cannot be routed, a line of the
35239 following form is logged:
35240 .code
35241 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35242   <jim@trek99.example>: unknown mail domain
35243 .endd
35244 If a delivery fails at transport time, the router and transport are shown, and
35245 the response from the remote host is included, as in this example:
35246 .code
35247 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35248   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35249   after pipelined RCPT TO:<ace400@pb.example>: host
35250   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35251   <ace400@pb.example>...Addressee unknown
35252 .endd
35253 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35254 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35255 disabling PIPELINING. The log lines for all forms of delivery failure are
35256 flagged with &`**`&.
35257
35258
35259
35260 .section "Fake deliveries" "SECID256"
35261 .cindex "delivery" "fake; logging"
35262 If a delivery does not actually take place because the &%-N%& option has been
35263 used to suppress it, a normal delivery line is written to the log, except that
35264 &"=>"& is replaced by &"*>"&.
35265
35266
35267
35268 .section "Completion" "SECID257"
35269 A line of the form
35270 .code
35271 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35272 .endd
35273 is written to the main log when a message is about to be removed from the spool
35274 at the end of its processing.
35275
35276
35277
35278
35279 .section "Summary of Fields in Log Lines" "SECID258"
35280 .cindex "log" "summary of fields"
35281 A summary of the field identifiers that are used in log lines is shown in
35282 the following table:
35283 .display
35284 &`A   `&        authenticator name (and optional id and sender)
35285 &`C   `&        SMTP confirmation on delivery
35286 &`    `&        command list for &"no mail in SMTP session"&
35287 &`CV  `&        certificate verification status
35288 &`D   `&        duration of &"no mail in SMTP session"&
35289 &`DN  `&        distinguished name from peer certificate
35290 &`DT  `&        on &`=>`& lines: time taken for a delivery
35291 &`F   `&        sender address (on delivery lines)
35292 &`H   `&        host name and IP address
35293 &`I   `&        local interface used
35294 &`id  `&        message id for incoming message
35295 &`P   `&        on &`<=`& lines: protocol used
35296 &`    `&        on &`=>`& and &`**`& lines: return path
35297 &`QT  `&        on &`=>`& lines: time spent on queue so far
35298 &`    `&        on &"Completed"& lines: time spent on queue
35299 &`R   `&        on &`<=`& lines: reference for local bounce
35300 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35301 &`S   `&        size of message
35302 &`SNI `&        server name indication from TLS client hello
35303 &`ST  `&        shadow transport name
35304 &`T   `&        on &`<=`& lines: message subject (topic)
35305 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35306 &`U   `&        local user or RFC 1413 identity
35307 &`X   `&        TLS cipher suite
35308 .endd
35309
35310
35311 .section "Other log entries" "SECID259"
35312 Various other types of log entry are written from time to time. Most should be
35313 self-explanatory. Among the more common are:
35314
35315 .ilist
35316 .cindex "retry" "time not reached"
35317 &'retry time not reached'&&~&~An address previously suffered a temporary error
35318 during routing or local delivery, and the time to retry has not yet arrived.
35319 This message is not written to an individual message log file unless it happens
35320 during the first delivery attempt.
35321 .next
35322 &'retry time not reached for any host'&&~&~An address previously suffered
35323 temporary errors during remote delivery, and the retry time has not yet arrived
35324 for any of the hosts to which it is routed.
35325 .next
35326 .cindex "spool directory" "file locked"
35327 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35328 some other Exim process is already working on the message. This can be quite
35329 common if queue running processes are started at frequent intervals. The
35330 &'exiwhat'& utility script can be used to find out what Exim processes are
35331 doing.
35332 .next
35333 .cindex "error" "ignored"
35334 &'error ignored'&&~&~There are several circumstances that give rise to this
35335 message:
35336 .olist
35337 Exim failed to deliver a bounce message whose age was greater than
35338 &%ignore_bounce_errors_after%&. The bounce was discarded.
35339 .next
35340 A filter file set up a delivery using the &"noerror"& option, and the delivery
35341 failed. The delivery was discarded.
35342 .next
35343 A delivery set up by a router configured with
35344 . ==== As this is a nested list, any displays it contains must be indented
35345 . ==== as otherwise they are too far to the left.
35346 .code
35347     errors_to = <>
35348 .endd
35349 failed. The delivery was discarded.
35350 .endlist olist
35351 .endlist ilist
35352
35353
35354
35355
35356
35357 .section "Reducing or increasing what is logged" "SECTlogselector"
35358 .cindex "log" "selectors"
35359 By setting the &%log_selector%& global option, you can disable some of Exim's
35360 default logging, or you can request additional logging. The value of
35361 &%log_selector%& is made up of names preceded by plus or minus characters. For
35362 example:
35363 .code
35364 log_selector = +arguments -retry_defer
35365 .endd
35366 The list of optional log items is in the following table, with the default
35367 selection marked by asterisks:
35368 .display
35369 &` 8bitmime                   `&  received 8BITMIME status
35370 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35371 &` address_rewrite            `&  address rewriting
35372 &` all_parents                `&  all parents in => lines
35373 &` arguments                  `&  command line arguments
35374 &`*connection_reject          `&  connection rejections
35375 &`*delay_delivery             `&  immediate delivery delayed
35376 &` deliver_time               `&  time taken to perform delivery
35377 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35378 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35379 &`*etrn                       `&  ETRN commands
35380 &`*host_lookup_failed         `&  as it says
35381 &` ident_timeout              `&  timeout for ident connection
35382 &` incoming_interface         `&  local interface on <= and => lines
35383 &` incoming_port              `&  remote port on <= lines
35384 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35385 .new
35386 &` outgoing_interface         `&  local interface on => lines
35387 .wen
35388 &` outgoing_port              `&  add remote port to => lines
35389 &`*queue_run                  `&  start and end queue runs
35390 &` queue_time                 `&  time on queue for one recipient
35391 &` queue_time_overall         `&  time on queue for whole message
35392 &` pid                        `&  Exim process id
35393 &` received_recipients        `&  recipients on <= lines
35394 &` received_sender            `&  sender on <= lines
35395 &`*rejected_header            `&  header contents on reject log
35396 &`*retry_defer                `&  &"retry time not reached"&
35397 &` return_path_on_delivery    `&  put return path on => and ** lines
35398 &` sender_on_delivery         `&  add sender to => lines
35399 &`*sender_verify_fail         `&  sender verification failures
35400 &`*size_reject                `&  rejection because too big
35401 &`*skip_delivery              `&  delivery skipped in a queue run
35402 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35403 &` smtp_connection            `&  incoming SMTP connections
35404 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35405 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35406 &` smtp_no_mail               `&  session with no MAIL commands
35407 &` smtp_protocol_error        `&  SMTP protocol errors
35408 &` smtp_syntax_error          `&  SMTP syntax errors
35409 &` subject                    `&  contents of &'Subject:'& on <= lines
35410 &`*tls_certificate_verified   `&  certificate verification status
35411 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35412 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35413 &` tls_sni                    `&  TLS SNI on <= lines
35414 &` unknown_in_list            `&  DNS lookup failed in list match
35415
35416 &` all                        `&  all of the above
35417 .endd
35418 See also the &%slow_lookup_log%& main configuration option,
35419 section &<<SECID99>>&
35420
35421 More details on each of these items follows:
35422
35423 .ilist
35424 .cindex "8BITMIME"
35425 .cindex "log" "8BITMIME"
35426 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35427 which may help in tracking down interoperability issues with ancient MTAs
35428 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35429 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35430 &`7BIT`& and &`8BITMIME`& respectively.
35431 .next
35432 .cindex "&%warn%& ACL verb" "log when skipping"
35433 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35434 its conditions cannot be evaluated, a log line to this effect is written if
35435 this log selector is set.
35436 .next
35437 .cindex "log" "rewriting"
35438 .cindex "rewriting" "logging"
35439 &%address_rewrite%&: This applies both to global rewrites and per-transport
35440 rewrites, but not to rewrites in filters run as an unprivileged user (because
35441 such users cannot access the log).
35442 .next
35443 .cindex "log" "full parentage"
35444 &%all_parents%&: Normally only the original and final addresses are logged on
35445 delivery lines; with this selector, intermediate parents are given in
35446 parentheses between them.
35447 .next
35448 .cindex "log" "Exim arguments"
35449 .cindex "Exim arguments, logging"
35450 &%arguments%&: This causes Exim to write the arguments with which it was called
35451 to the main log, preceded by the current working directory. This is a debugging
35452 feature, added to make it easier to find out how certain MUAs call
35453 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35454 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35455 that are empty or that contain white space are quoted. Non-printing characters
35456 are shown as escape sequences. This facility cannot log unrecognized arguments,
35457 because the arguments are checked before the configuration file is read. The
35458 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35459 between the caller and Exim.
35460 .next
35461 .cindex "log" "connection rejections"
35462 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35463 connection is rejected, for whatever reason.
35464 .next
35465 .cindex "log" "delayed delivery"
35466 .cindex "delayed delivery, logging"
35467 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35468 started for an incoming message because the load is too high or too many
35469 messages were received on one connection. Logging does not occur if no delivery
35470 process is started because &%queue_only%& is set or &%-odq%& was used.
35471 .next
35472 .cindex "log" "delivery duration"
35473 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35474 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35475 .next
35476 .cindex "log" "message size on delivery"
35477 .cindex "size" "of message"
35478 &%delivery_size%&: For each delivery, the size of message delivered is added to
35479 the &"=>"& line, tagged with S=.
35480 .next
35481 .cindex "log" "dnslist defer"
35482 .cindex "DNS list" "logging defer"
35483 .cindex "black list (DNS)"
35484 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35485 DNS black list suffers a temporary error.
35486 .next
35487 .cindex "log" "ETRN commands"
35488 .cindex "ETRN" "logging"
35489 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35490 is run to determine whether or not it is actually accepted. An invalid ETRN
35491 command, or one received within a message transaction is not logged by this
35492 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35493 .next
35494 .cindex "log" "host lookup failure"
35495 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35496 any addresses, or when a lookup of an IP address fails to find a host name, a
35497 log line is written. This logging does not apply to direct DNS lookups when
35498 routing email addresses, but it does apply to &"byname"& lookups.
35499 .next
35500 .cindex "log" "ident timeout"
35501 .cindex "RFC 1413" "logging timeout"
35502 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35503 client's ident port times out.
35504 .next
35505 .cindex "log" "incoming interface"
35506 .cindex "log" "local interface"
35507 .cindex "log" "local address and port"
35508 .cindex "TCP/IP" "logging local address and port"
35509 .cindex "interface" "logging"
35510 &%incoming_interface%&: The interface on which a message was received is added
35511 to the &"<="& line as an IP address in square brackets, tagged by I= and
35512 followed by a colon and the port number. The local interface and port are also
35513 added to other SMTP log lines, for example &"SMTP connection from"&, to
35514 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
35515 .new
35516 The latter can be disabled by turning off the &%outgoing_interface%& option.
35517 .wen
35518 .next
35519 .cindex "log" "incoming remote port"
35520 .cindex "port" "logging remote"
35521 .cindex "TCP/IP" "logging incoming remote port"
35522 .vindex "&$sender_fullhost$&"
35523 .vindex "&$sender_rcvhost$&"
35524 &%incoming_port%&: The remote port number from which a message was received is
35525 added to log entries and &'Received:'& header lines, following the IP address
35526 in square brackets, and separated from it by a colon. This is implemented by
35527 changing the value that is put in the &$sender_fullhost$& and
35528 &$sender_rcvhost$& variables. Recording the remote port number has become more
35529 important with the widening use of NAT (see RFC 2505).
35530 .next
35531 .cindex "log" "dropped connection"
35532 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35533 connection is unexpectedly dropped.
35534 .next
35535 .cindex "log" "outgoing interface"
35536 .cindex "log" "local interface"
35537 .cindex "log" "local address and port"
35538 .cindex "TCP/IP" "logging local address and port"
35539 .cindex "interface" "logging"
35540 .new
35541 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
35542 interface on which a message was sent is added to delivery lines as an I= tag
35543 followed by IP address in square brackets. You can disable this by turning
35544 off the &%outgoing_interface%& option.
35545 .wen
35546 .next
35547 .cindex "log" "outgoing remote port"
35548 .cindex "port" "logging outgoint remote"
35549 .cindex "TCP/IP" "logging ougtoing remote port"
35550 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35551 containing => tags) following the IP address.
35552 .new
35553 The local port is also added if &%incoming_interface%& and
35554 &%outgoing_interface%& are both enabled.
35555 .wen
35556 This option is not included in the default setting, because for most ordinary
35557 configurations, the remote port number is always 25 (the SMTP port), and the
35558 local port is a random ephemeral port.
35559 .next
35560 .cindex "log" "process ids in"
35561 .cindex "pid (process id)" "in log lines"
35562 &%pid%&: The current process id is added to every log line, in square brackets,
35563 immediately after the time and date.
35564 .next
35565 .cindex "log" "queue run"
35566 .cindex "queue runner" "logging"
35567 &%queue_run%&: The start and end of every queue run are logged.
35568 .next
35569 .cindex "log" "queue time"
35570 &%queue_time%&: The amount of time the message has been in the queue on the
35571 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35572 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35573 includes reception time as well as the delivery time for the current address.
35574 This means that it may be longer than the difference between the arrival and
35575 delivery log line times, because the arrival log line is not written until the
35576 message has been successfully received.
35577 .next
35578 &%queue_time_overall%&: The amount of time the message has been in the queue on
35579 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35580 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35581 message, so it includes reception time as well as the total delivery time.
35582 .next
35583 .cindex "log" "recipients"
35584 &%received_recipients%&: The recipients of a message are listed in the main log
35585 as soon as the message is received. The list appears at the end of the log line
35586 that is written when a message is received, preceded by the word &"for"&. The
35587 addresses are listed after they have been qualified, but before any rewriting
35588 has taken place.
35589 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35590 in the list.
35591 .next
35592 .cindex "log" "sender reception"
35593 &%received_sender%&: The unrewritten original sender of a message is added to
35594 the end of the log line that records the message's arrival, after the word
35595 &"from"& (before the recipients if &%received_recipients%& is also set).
35596 .next
35597 .cindex "log" "header lines for rejection"
35598 &%rejected_header%&: If a message's header has been received at the time a
35599 rejection is written to the reject log, the complete header is added to the
35600 log. Header logging can be turned off individually for messages that are
35601 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35602 .next
35603 .cindex "log" "retry defer"
35604 &%retry_defer%&: A log line is written if a delivery is deferred because a
35605 retry time has not yet been reached. However, this &"retry time not reached"&
35606 message is always omitted from individual message logs after the first delivery
35607 attempt.
35608 .next
35609 .cindex "log" "return path"
35610 &%return_path_on_delivery%&: The return path that is being transmitted with
35611 the message is included in delivery and bounce lines, using the tag P=.
35612 This is omitted if no delivery actually happens, for example, if routing fails,
35613 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35614 .next
35615 .cindex "log" "sender on delivery"
35616 &%sender_on_delivery%&: The message's sender address is added to every delivery
35617 and bounce line, tagged by F= (for &"from"&).
35618 This is the original sender that was received with the message; it is not
35619 necessarily the same as the outgoing return path.
35620 .next
35621 .cindex "log" "sender verify failure"
35622 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35623 gives details of a sender verification failure is not written. Log lines for
35624 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35625 detail is lost.
35626 .next
35627 .cindex "log" "size rejection"
35628 &%size_reject%&: A log line is written whenever a message is rejected because
35629 it is too big.
35630 .next
35631 .cindex "log" "frozen messages; skipped"
35632 .cindex "frozen messages" "logging skipping"
35633 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35634 queue run because it is frozen or because another process is already delivering
35635 it.
35636 .cindex "&""spool file is locked""&"
35637 The message that is written is &"spool file is locked"&.
35638 .next
35639 .cindex "log" "smtp confirmation"
35640 .cindex "SMTP" "logging confirmation"
35641 .cindex "LMTP" "logging confirmation"
35642 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35643 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35644 A number of MTAs (including Exim) return an identifying string in this
35645 response.
35646 .next
35647 .cindex "log" "SMTP connections"
35648 .cindex "SMTP" "logging connections"
35649 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
35650 established or closed, unless the connection is from a host that matches
35651 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35652 only when the closure is unexpected.) This applies to connections from local
35653 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35654 dropped in the middle of a message, a log line is always written, whether or
35655 not this selector is set, but otherwise nothing is written at the start and end
35656 of connections unless this selector is enabled.
35657
35658 For TCP/IP connections to an Exim daemon, the current number of connections is
35659 included in the log message for each new connection, but note that the count is
35660 reset if the daemon is restarted.
35661 Also, because connections are closed (and the closure is logged) in
35662 subprocesses, the count may not include connections that have been closed but
35663 whose termination the daemon has not yet noticed. Thus, while it is possible to
35664 match up the opening and closing of connections in the log, the value of the
35665 logged counts may not be entirely accurate.
35666 .next
35667 .cindex "log" "SMTP transaction; incomplete"
35668 .cindex "SMTP" "logging incomplete transactions"
35669 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35670 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35671 and the message sender plus any accepted recipients are included in the log
35672 line. This can provide evidence of dictionary attacks.
35673 .next
35674 .cindex "log" "non-MAIL SMTP sessions"
35675 .cindex "MAIL" "logging session without"
35676 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35677 connection terminates without having issued a MAIL command. This includes both
35678 the case when the connection is dropped, and the case when QUIT is used. It
35679 does not include cases where the connection is rejected right at the start (by
35680 an ACL, or because there are too many connections, or whatever). These cases
35681 already have their own log lines.
35682
35683 The log line that is written contains the identity of the client in the usual
35684 way, followed by D= and a time, which records the duration of the connection.
35685 If the connection was authenticated, this fact is logged exactly as it is for
35686 an incoming message, with an A= item. If the connection was encrypted, CV=,
35687 DN=, and X= items may appear as they do for an incoming message, controlled by
35688 the same logging options.
35689
35690 Finally, if any SMTP commands were issued during the connection, a C= item
35691 is added to the line, listing the commands that were used. For example,
35692 .code
35693 C=EHLO,QUIT
35694 .endd
35695 shows that the client issued QUIT straight after EHLO. If there were fewer
35696 than 20 commands, they are all listed. If there were more than 20 commands,
35697 the last 20 are listed, preceded by &"..."&. However, with the default
35698 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
35699 have been aborted before 20 non-mail commands are processed.
35700 .next
35701 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35702 colon-separated, is appended to the A= item for a message arrival or delivery
35703 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35704 was accepted or used.
35705 .next
35706 .cindex "log" "SMTP protocol error"
35707 .cindex "SMTP" "logging protocol error"
35708 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35709 encountered. Exim does not have perfect detection of all protocol errors
35710 because of transmission delays and the use of pipelining. If PIPELINING has
35711 been advertised to a client, an Exim server assumes that the client will use
35712 it, and therefore it does not count &"expected"& errors (for example, RCPT
35713 received after rejecting MAIL) as protocol errors.
35714 .next
35715 .cindex "SMTP" "logging syntax errors"
35716 .cindex "SMTP" "syntax errors; logging"
35717 .cindex "SMTP" "unknown command; logging"
35718 .cindex "log" "unknown SMTP command"
35719 .cindex "log" "SMTP syntax error"
35720 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35721 encountered. An unrecognized command is treated as a syntax error. For an
35722 external connection, the host identity is given; for an internal connection
35723 using &%-bs%& the sender identification (normally the calling user) is given.
35724 .next
35725 .cindex "log" "subject"
35726 .cindex "subject, logging"
35727 &%subject%&: The subject of the message is added to the arrival log line,
35728 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35729 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35730 specifies whether characters with values greater than 127 should be logged
35731 unchanged, or whether they should be rendered as escape sequences.
35732 .next
35733 .cindex "log" "certificate verification"
35734 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35735 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35736 verified, and &`CV=no`& if not.
35737 .next
35738 .cindex "log" "TLS cipher"
35739 .cindex "TLS" "logging cipher"
35740 &%tls_cipher%&: When a message is sent or received over an encrypted
35741 connection, the cipher suite used is added to the log line, preceded by X=.
35742 .next
35743 .cindex "log" "TLS peer DN"
35744 .cindex "TLS" "logging peer DN"
35745 &%tls_peerdn%&: When a message is sent or received over an encrypted
35746 connection, and a certificate is supplied by the remote host, the peer DN is
35747 added to the log line, preceded by DN=.
35748 .next
35749 .cindex "log" "TLS SNI"
35750 .cindex "TLS" "logging SNI"
35751 &%tls_sni%&: When a message is received over an encrypted connection, and
35752 the remote host provided the Server Name Indication extension, the SNI is
35753 added to the log line, preceded by SNI=.
35754 .next
35755 .cindex "log" "DNS failure in list"
35756 &%unknown_in_list%&: This setting causes a log entry to be written when the
35757 result of a list match is failure because a DNS lookup failed.
35758 .endlist
35759
35760
35761 .section "Message log" "SECID260"
35762 .cindex "message" "log file for"
35763 .cindex "log" "message log; description of"
35764 .cindex "&_msglog_& directory"
35765 .oindex "&%preserve_message_logs%&"
35766 In addition to the general log files, Exim writes a log file for each message
35767 that it handles. The names of these per-message logs are the message ids, and
35768 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35769 message log contains copies of the log lines that apply to the message. This
35770 makes it easier to inspect the status of an individual message without having
35771 to search the main log. A message log is deleted when processing of the message
35772 is complete, unless &%preserve_message_logs%& is set, but this should be used
35773 only with great care because they can fill up your disk very quickly.
35774
35775 On a heavily loaded system, it may be desirable to disable the use of
35776 per-message logs, in order to reduce disk I/O. This can be done by setting the
35777 &%message_logs%& option false.
35778 .ecindex IIDloggen
35779
35780
35781
35782
35783 . ////////////////////////////////////////////////////////////////////////////
35784 . ////////////////////////////////////////////////////////////////////////////
35785
35786 .chapter "Exim utilities" "CHAPutils"
35787 .scindex IIDutils "utilities"
35788 A number of utility scripts and programs are supplied with Exim and are
35789 described in this chapter. There is also the Exim Monitor, which is covered in
35790 the next chapter. The utilities described here are:
35791
35792 .itable none 0 0 3  7* left  15* left  40* left
35793 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35794   "list what Exim processes are doing"
35795 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35796 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35797 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35798 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35799                                                 various criteria"
35800 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35801 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35802   "extract statistics from the log"
35803 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35804   "check address acceptance from given IP"
35805 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35806 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35807 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35808 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35809 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35810 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35811 .endtable
35812
35813 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35814 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35815 &url(http://duncanthrax.net/exilog/) for details.
35816
35817
35818
35819
35820 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35821 .cindex "&'exiwhat'&"
35822 .cindex "process, querying"
35823 .cindex "SIGUSR1"
35824 On operating systems that can restart a system call after receiving a signal
35825 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35826 a line describing what it is doing to the file &_exim-process.info_& in the
35827 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35828 processes it can find, having first emptied the file. It then waits for one
35829 second to allow the Exim processes to react before displaying the results. In
35830 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35831 send the signal to the Exim processes, so it is normally run as root.
35832
35833 &*Warning*&: This is not an efficient process. It is intended for occasional
35834 use by system administrators. It is not sensible, for example, to set up a
35835 script that sends SIGUSR1 signals to Exim processes at short intervals.
35836
35837
35838 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35839 varies in different operating systems. Not only are different options used,
35840 but the format of the output is different. For this reason, there are some
35841 system configuration options that configure exactly how &'exiwhat'& works. If
35842 it doesn't seem to be working for you, check the following compile-time
35843 options:
35844 .display
35845 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35846 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35847 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35848 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35849 .endd
35850 An example of typical output from &'exiwhat'& is
35851 .code
35852 164 daemon: -q1h, listening on port 25
35853 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35854 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35855   [10.19.42.42] (editor@ref.example)
35856 10592 handling incoming call from [192.168.243.242]
35857 10628 accepting a local non-SMTP message
35858 .endd
35859 The first number in the output line is the process number. The third line has
35860 been split here, in order to fit it on the page.
35861
35862
35863
35864 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35865 .cindex "&'exiqgrep'&"
35866 .cindex "queue" "grepping"
35867 This utility is a Perl script contributed by Matt Hubbard. It runs
35868 .code
35869 exim -bpu
35870 .endd
35871 or (in case &*-a*& switch is specified)
35872 .code
35873 exim -bp
35874 .endd
35875 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35876 contain alternate exim configuration the queue management might be using.
35877
35878 to obtain a queue listing, and then greps the output to select messages
35879 that match given criteria. The following selection options are available:
35880
35881 .vlist
35882 .vitem &*-f*&&~<&'regex'&>
35883 Match the sender address using a case-insensitive search. The field that is
35884 tested is enclosed in angle brackets, so you can test for bounce messages with
35885 .code
35886 exiqgrep -f '^<>$'
35887 .endd
35888 .vitem &*-r*&&~<&'regex'&>
35889 Match a recipient address using a case-insensitive search. The field that is
35890 tested is not enclosed in angle brackets.
35891
35892 .vitem &*-s*&&~<&'regex'&>
35893 Match against the size field.
35894
35895 .vitem &*-y*&&~<&'seconds'&>
35896 Match messages that are younger than the given time.
35897
35898 .vitem &*-o*&&~<&'seconds'&>
35899 Match messages that are older than the given time.
35900
35901 .vitem &*-z*&
35902 Match only frozen messages.
35903
35904 .vitem &*-x*&
35905 Match only non-frozen messages.
35906 .endlist
35907
35908 The following options control the format of the output:
35909
35910 .vlist
35911 .vitem &*-c*&
35912 Display only the count of matching messages.
35913
35914 .vitem &*-l*&
35915 Long format &-- display the full message information as output by Exim. This is
35916 the default.
35917
35918 .vitem &*-i*&
35919 Display message ids only.
35920
35921 .vitem &*-b*&
35922 Brief format &-- one line per message.
35923
35924 .vitem &*-R*&
35925 Display messages in reverse order.
35926
35927 .vitem &*-a*&
35928 Include delivered recipients in queue listing.
35929 .endlist
35930
35931 There is one more option, &%-h%&, which outputs a list of options.
35932
35933
35934
35935 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35936 .cindex "&'exiqsumm'&"
35937 .cindex "queue" "summary"
35938 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35939 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35940 running a command such as
35941 .code
35942 exim -bp | exiqsumm
35943 .endd
35944 The output consists of one line for each domain that has messages waiting for
35945 it, as in the following example:
35946 .code
35947 3   2322   74m   66m  msn.com.example
35948 .endd
35949 Each line lists the number of pending deliveries for a domain, their total
35950 volume, and the length of time that the oldest and the newest messages have
35951 been waiting. Note that the number of pending deliveries is greater than the
35952 number of messages when messages have more than one recipient.
35953
35954 A summary line is output at the end. By default the output is sorted on the
35955 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35956 the output to be sorted by oldest message and by count of messages,
35957 respectively. There are also three options that split the messages for each
35958 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35959 separates frozen messages, and &%-s%& separates messages according to their
35960 sender.
35961
35962 The output of &'exim -bp'& contains the original addresses in the message, so
35963 this also applies to the output from &'exiqsumm'&. No domains from addresses
35964 generated by aliasing or forwarding are included (unless the &%one_time%&
35965 option of the &(redirect)& router has been used to convert them into &"top
35966 level"& addresses).
35967
35968
35969
35970
35971 .section "Extracting specific information from the log (exigrep)" &&&
35972          "SECTextspeinf"
35973 .cindex "&'exigrep'&"
35974 .cindex "log" "extracts; grepping for"
35975 The &'exigrep'& utility is a Perl script that searches one or more main log
35976 files for entries that match a given pattern. When it finds a match, it
35977 extracts all the log entries for the relevant message, not just those that
35978 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35979 given message, or all mail for a given user, or for a given host, for example.
35980 The input files can be in Exim log format or syslog format.
35981 If a matching log line is not associated with a specific message, it is
35982 included in &'exigrep'&'s output without any additional lines. The usage is:
35983 .display
35984 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35985 .endd
35986 If no log file names are given on the command line, the standard input is read.
35987
35988 The &%-t%& argument specifies a number of seconds. It adds an additional
35989 condition for message selection. Messages that are complete are shown only if
35990 they spent more than <&'n'&> seconds on the queue.
35991
35992 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35993 makes it case-sensitive. This may give a performance improvement when searching
35994 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35995 option; with &%-I%& they do not. In both cases it is possible to change the
35996 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35997
35998 The &%-l%& option means &"literal"&, that is, treat all characters in the
35999 pattern as standing for themselves. Otherwise the pattern must be a Perl
36000 regular expression.
36001
36002 The &%-v%& option inverts the matching condition. That is, a line is selected
36003 if it does &'not'& match the pattern.
36004
36005 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36006 that are generated as a result/response to a message that &'exigrep'& matched
36007 normally.
36008
36009 Example of &%-M%&:
36010 user_a sends a message to user_b, which generates a bounce back to user_b. If
36011 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36012 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36013 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36014 when searching for &"user_a"& will show both messages since the bounce is
36015 &"related"& to or a &"result"& of the first message that was found by the
36016 search term.
36017
36018 If the location of a &'zcat'& command is known from the definition of
36019 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36020 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36021 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36022 autodetection of some well known compression extensions.
36023
36024
36025 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36026 .cindex "&'exipick'&"
36027 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36028 lists messages from the queue according to a variety of criteria. For details
36029 of &'exipick'&'s facilities, visit the web page at
36030 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
36031 the &%--help%& option.
36032
36033
36034 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36035 .cindex "log" "cycling local files"
36036 .cindex "cycling logs"
36037 .cindex "&'exicyclog'&"
36038 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36039 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36040 you are using log files with datestamps in their names (see section
36041 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36042 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36043 There are two command line options for &'exicyclog'&:
36044 .ilist
36045 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36046 default that is set when Exim is built. The default default is 10.
36047 .next
36048 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36049 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36050 overriding the script's default, which is to find the setting from Exim's
36051 configuration.
36052 .endlist
36053
36054 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36055 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36056 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36057 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36058 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36059 logs are handled similarly.
36060
36061 If the limit is greater than 99, the script uses 3-digit numbers such as
36062 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36063 to one that is greater, or &'vice versa'&, you will have to fix the names of
36064 any existing log files.
36065
36066 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36067 the end are deleted. All files with numbers greater than 01 are compressed,
36068 using a compression command which is configured by the COMPRESS_COMMAND
36069 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36070 root &%crontab%& entry of the form
36071 .code
36072 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36073 .endd
36074 assuming you have used the name &"exim"& for the Exim user. You can run
36075 &'exicyclog'& as root if you wish, but there is no need.
36076
36077
36078
36079 .section "Mail statistics (eximstats)" "SECTmailstat"
36080 .cindex "statistics"
36081 .cindex "&'eximstats'&"
36082 A Perl script called &'eximstats'& is provided for extracting statistical
36083 information from log files. The output is either plain text, or HTML.
36084 Exim log files are also supported by the &'Lire'& system produced by the
36085 LogReport Foundation &url(http://www.logreport.org).
36086
36087 The &'eximstats'& script has been hacked about quite a bit over time. The
36088 latest version is the result of some extensive revision by Steve Campbell. A
36089 lot of information is given by default, but there are options for suppressing
36090 various parts of it. Following any options, the arguments to the script are a
36091 list of files, which should be main log files. For example:
36092 .code
36093 eximstats -nr /var/spool/exim/log/mainlog.01
36094 .endd
36095 By default, &'eximstats'& extracts information about the number and volume of
36096 messages received from or delivered to various hosts. The information is sorted
36097 both by message count and by volume, and the top fifty hosts in each category
36098 are listed on the standard output. Similar information, based on email
36099 addresses or domains instead of hosts can be requested by means of various
36100 options. For messages delivered and received locally, similar statistics are
36101 also produced per user.
36102
36103 The output also includes total counts and statistics about delivery errors, and
36104 histograms showing the number of messages received and deliveries made in each
36105 hour of the day. A delivery with more than one address in its envelope (for
36106 example, an SMTP transaction with more than one RCPT command) is counted
36107 as a single delivery by &'eximstats'&.
36108
36109 Though normally more deliveries than receipts are reported (as messages may
36110 have multiple recipients), it is possible for &'eximstats'& to report more
36111 messages received than delivered, even though the queue is empty at the start
36112 and end of the period in question. If an incoming message contains no valid
36113 recipients, no deliveries are recorded for it. A bounce message is handled as
36114 an entirely separate message.
36115
36116 &'eximstats'& always outputs a grand total summary giving the volume and number
36117 of messages received and deliveries made, and the number of hosts involved in
36118 each case. It also outputs the number of messages that were delayed (that is,
36119 not completely delivered at the first attempt), and the number that had at
36120 least one address that failed.
36121
36122 The remainder of the output is in sections that can be independently disabled
36123 or modified by various options. It consists of a summary of deliveries by
36124 transport, histograms of messages received and delivered per time interval
36125 (default per hour), information about the time messages spent on the queue,
36126 a list of relayed messages, lists of the top fifty sending hosts, local
36127 senders, destination hosts, and destination local users by count and by volume,
36128 and a list of delivery errors that occurred.
36129
36130 The relay information lists messages that were actually relayed, that is, they
36131 came from a remote host and were directly delivered to some other remote host,
36132 without being processed (for example, for aliasing or forwarding) locally.
36133
36134 There are quite a few options for &'eximstats'& to control exactly what it
36135 outputs. These are documented in the Perl script itself, and can be extracted
36136 by running the command &(perldoc)& on the script. For example:
36137 .code
36138 perldoc /usr/exim/bin/eximstats
36139 .endd
36140
36141 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36142 .cindex "&'exim_checkaccess'&"
36143 .cindex "policy control" "checking access"
36144 .cindex "checking access"
36145 The &%-bh%& command line argument allows you to run a fake SMTP session with
36146 debugging output, in order to check what Exim is doing when it is applying
36147 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36148 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36149 sometimes you just want to answer the question &"Does this address have
36150 access?"& without bothering with any further details.
36151
36152 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36153 two arguments, an IP address and an email address:
36154 .code
36155 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36156 .endd
36157 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36158 given email address would be accepted in a RCPT command in a TCP/IP
36159 connection from the host with the given IP address. The output of the utility
36160 is either the word &"accepted"&, or the SMTP error response, for example:
36161 .code
36162 Rejected:
36163 550 Relay not permitted
36164 .endd
36165 When running this test, the utility uses &`<>`& as the envelope sender address
36166 for the MAIL command, but you can change this by providing additional
36167 options. These are passed directly to the Exim command. For example, to specify
36168 that the test is to be run with the sender address &'himself@there.example'&
36169 you can use:
36170 .code
36171 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36172                  -f himself@there.example
36173 .endd
36174 Note that these additional Exim command line items must be given after the two
36175 mandatory arguments.
36176
36177 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36178 while running its checks. You can run checks that include callouts by using
36179 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36180
36181
36182
36183 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36184 .cindex "DBM" "building dbm files"
36185 .cindex "building DBM files"
36186 .cindex "&'exim_dbmbuild'&"
36187 .cindex "lower casing"
36188 .cindex "binary zero" "in lookup key"
36189 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36190 the format used by the &(lsearch)& lookup (see section
36191 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36192 names as keys and the remainder of the information as data. The lower-casing
36193 can be prevented by calling the program with the &%-nolc%& option.
36194
36195 A terminating zero is included as part of the key string. This is expected by
36196 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36197 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36198 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36199 files.
36200
36201 The program requires two arguments: the name of the input file (which can be a
36202 single hyphen to indicate the standard input), and the name of the output file.
36203 It creates the output under a temporary name, and then renames it if all went
36204 well.
36205
36206 .cindex "USE_DB"
36207 If the native DB interface is in use (USE_DB is set in a compile-time
36208 configuration file &-- this is common in free versions of Unix) the two file
36209 names must be different, because in this mode the Berkeley DB functions create
36210 a single output file using exactly the name given. For example,
36211 .code
36212 exim_dbmbuild /etc/aliases /etc/aliases.db
36213 .endd
36214 reads the system alias file and creates a DBM version of it in
36215 &_/etc/aliases.db_&.
36216
36217 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36218 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36219 environment, the suffixes are added to the second argument of
36220 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36221 when the Berkeley functions are used in compatibility mode (though this is not
36222 recommended), because in that case it adds a &_.db_& suffix to the file name.
36223
36224 If a duplicate key is encountered, the program outputs a warning, and when it
36225 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36226 option is used. By default, only the first of a set of duplicates is used &--
36227 this makes it compatible with &(lsearch)& lookups. There is an option
36228 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36229 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36230 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36231 return code is 2.
36232
36233
36234
36235
36236 .section "Finding individual retry times (exinext)" "SECTfinindret"
36237 .cindex "retry" "times"
36238 .cindex "&'exinext'&"
36239 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36240 fish specific information out of the retry database. Given a mail domain (or a
36241 complete address), it looks up the hosts for that domain, and outputs any retry
36242 information for the hosts or for the domain. At present, the retry information
36243 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36244 output. For example:
36245 .code
36246 $ exinext piglet@milne.fict.example
36247 kanga.milne.example:192.168.8.1 error 146: Connection refused
36248   first failed: 21-Feb-1996 14:57:34
36249   last tried:   21-Feb-1996 14:57:34
36250   next try at:  21-Feb-1996 15:02:34
36251 roo.milne.example:192.168.8.3 error 146: Connection refused
36252   first failed: 20-Jan-1996 13:12:08
36253   last tried:   21-Feb-1996 11:42:03
36254   next try at:  21-Feb-1996 19:42:03
36255   past final cutoff time
36256 .endd
36257 You can also give &'exinext'& a local part, without a domain, and it
36258 will give any retry information for that local part in your default domain.
36259 A message id can be used to obtain retry information pertaining to a specific
36260 message. This exists only when an attempt to deliver a message to a remote host
36261 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36262 &'exinext'& is not particularly efficient, but then it is not expected to be
36263 run very often.
36264
36265 The &'exinext'& utility calls Exim to find out information such as the location
36266 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36267 passed on to the &'exim'& commands. The first specifies an alternate Exim
36268 configuration file, and the second sets macros for use within the configuration
36269 file. These features are mainly to help in testing, but might also be useful in
36270 environments where more than one configuration file is in use.
36271
36272
36273
36274 .section "Hints database maintenance" "SECThindatmai"
36275 .cindex "hints database" "maintenance"
36276 .cindex "maintaining Exim's hints database"
36277 Three utility programs are provided for maintaining the DBM files that Exim
36278 uses to contain its delivery hint information. Each program requires two
36279 arguments. The first specifies the name of Exim's spool directory, and the
36280 second is the name of the database it is to operate on. These are as follows:
36281
36282 .ilist
36283 &'retry'&: the database of retry information
36284 .next
36285 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36286 for remote hosts
36287 .next
36288 &'callout'&: the callout cache
36289 .next
36290 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36291 .next
36292 &'misc'&: other hints data
36293 .endlist
36294
36295 The &'misc'& database is used for
36296
36297 .ilist
36298 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36299 .next
36300 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36301 &(smtp)& transport)
36302 .next
36303 Limiting the concurrency of specific transports (when &%max_parallel%& is set
36304 in a transport)
36305 .endlist
36306
36307
36308
36309 .section "exim_dumpdb" "SECID261"
36310 .cindex "&'exim_dumpdb'&"
36311 The entire contents of a database are written to the standard output by the
36312 &'exim_dumpdb'& program, which has no options or arguments other than the
36313 spool and database names. For example, to dump the retry database:
36314 .code
36315 exim_dumpdb /var/spool/exim retry
36316 .endd
36317 Two lines of output are produced for each entry:
36318 .code
36319 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36320 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36321 .endd
36322 The first item on the first line is the key of the record. It starts with one
36323 of the letters R, or T, depending on whether it refers to a routing or
36324 transport retry. For a local delivery, the next part is the local address; for
36325 a remote delivery it is the name of the remote host, followed by its failing IP
36326 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36327 transport). If the remote port is not the standard one (port 25), it is added
36328 to the IP address. Then there follows an error code, an additional error code,
36329 and a textual description of the error.
36330
36331 The three times on the second line are the time of first failure, the time of
36332 the last delivery attempt, and the computed time for the next attempt. The line
36333 ends with an asterisk if the cutoff time for the last retry rule has been
36334 exceeded.
36335
36336 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36337 consists of a host name followed by a list of ids for messages that are or were
36338 waiting to be delivered to that host. If there are a very large number for any
36339 one host, continuation records, with a sequence number added to the host name,
36340 may be seen. The data in these records is often out of date, because a message
36341 may be routed to several alternative hosts, and Exim makes no effort to keep
36342 cross-references.
36343
36344
36345
36346 .section "exim_tidydb" "SECID262"
36347 .cindex "&'exim_tidydb'&"
36348 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36349 database. If run with no options, it removes all records that are more than 30
36350 days old. The age is calculated from the date and time that the record was last
36351 updated. Note that, in the case of the retry database, it is &'not'& the time
36352 since the first delivery failure. Information about a host that has been down
36353 for more than 30 days will remain in the database, provided that the record is
36354 updated sufficiently often.
36355
36356 The cutoff date can be altered by means of the &%-t%& option, which must be
36357 followed by a time. For example, to remove all records older than a week from
36358 the retry database:
36359 .code
36360 exim_tidydb -t 7d /var/spool/exim retry
36361 .endd
36362 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36363 message ids. In the former these appear as data in records keyed by host &--
36364 they were messages that were waiting for that host &-- and in the latter they
36365 are the keys for retry information for messages that have suffered certain
36366 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36367 message ids in database records are those of messages that are still on the
36368 queue. Message ids for messages that no longer exist are removed from
36369 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36370 For the &'retry'& database, records whose keys are non-existent message ids are
36371 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36372 whenever it removes information from the database.
36373
36374 Certain records are automatically removed by Exim when they are no longer
36375 needed, but others are not. For example, if all the MX hosts for a domain are
36376 down, a retry record is created for each one. If the primary MX host comes back
36377 first, its record is removed when Exim successfully delivers to it, but the
36378 records for the others remain because Exim has not tried to use those hosts.
36379
36380 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36381 hints databases. You should do this at a quiet time of day, because it requires
36382 a database to be locked (and therefore inaccessible to Exim) while it does its
36383 work. Removing records from a DBM file does not normally make the file smaller,
36384 but all the common DBM libraries are able to re-use the space that is released.
36385 After an initial phase of increasing in size, the databases normally reach a
36386 point at which they no longer get any bigger, as long as they are regularly
36387 tidied.
36388
36389 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36390 databases is likely to keep on increasing.
36391
36392
36393
36394
36395 .section "exim_fixdb" "SECID263"
36396 .cindex "&'exim_fixdb'&"
36397 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36398 Its main use is for testing Exim, but it might also be occasionally useful for
36399 getting round problems in a live system. It has no options, and its interface
36400 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36401 key of a database record can then be entered, and the data for that record is
36402 displayed.
36403
36404 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36405 except the &'retry'& database, that is the only operation that can be carried
36406 out. For the &'retry'& database, each field is output preceded by a number, and
36407 data for individual fields can be changed by typing the field number followed
36408 by new data, for example:
36409 .code
36410 > 4 951102:1000
36411 .endd
36412 resets the time of the next delivery attempt. Time values are given as a
36413 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36414 used as optional separators.
36415
36416
36417
36418
36419 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36420 .cindex "mailbox" "maintenance"
36421 .cindex "&'exim_lock'&"
36422 .cindex "locking mailboxes"
36423 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36424 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36425 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36426 a user agent while investigating a problem. The utility requires the name of
36427 the file as its first argument. If the locking is successful, the second
36428 argument is run as a command (using C's &[system()]& function); if there is no
36429 second argument, the value of the SHELL environment variable is used; if this
36430 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36431 is unlocked and the utility ends. The following options are available:
36432
36433 .vlist
36434 .vitem &%-fcntl%&
36435 Use &[fcntl()]& locking on the open mailbox.
36436
36437 .vitem &%-flock%&
36438 Use &[flock()]& locking on the open mailbox, provided the operating system
36439 supports it.
36440
36441 .vitem &%-interval%&
36442 This must be followed by a number, which is a number of seconds; it sets the
36443 interval to sleep between retries (default 3).
36444
36445 .vitem &%-lockfile%&
36446 Create a lock file before opening the mailbox.
36447
36448 .vitem &%-mbx%&
36449 Lock the mailbox using MBX rules.
36450
36451 .vitem &%-q%&
36452 Suppress verification output.
36453
36454 .vitem &%-retries%&
36455 This must be followed by a number; it sets the number of times to try to get
36456 the lock (default 10).
36457
36458 .vitem &%-restore_time%&
36459 This option causes &%exim_lock%& to restore the modified and read times to the
36460 locked file before exiting. This allows you to access a locked mailbox (for
36461 example, to take a backup copy) without disturbing the times that the user
36462 subsequently sees.
36463
36464 .vitem &%-timeout%&
36465 This must be followed by a number, which is a number of seconds; it sets a
36466 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36467 default), a non-blocking call is used.
36468
36469 .vitem &%-v%&
36470 Generate verbose output.
36471 .endlist
36472
36473 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36474 default is to create a lock file and also to use &[fcntl()]& locking on the
36475 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36476 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36477 requires that the directory containing the file be writeable. Locking by lock
36478 file does not last for ever; Exim assumes that a lock file is expired if it is
36479 more than 30 minutes old.
36480
36481 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36482 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36483 to be taken out on the open mailbox, and an exclusive lock on the file
36484 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36485 number of the mailbox file. When the locking is released, if an exclusive lock
36486 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36487
36488 The default output contains verification of the locking that takes place. The
36489 &%-v%& option causes some additional information to be given. The &%-q%& option
36490 suppresses all output except error messages.
36491
36492 A command such as
36493 .code
36494 exim_lock /var/spool/mail/spqr
36495 .endd
36496 runs an interactive shell while the file is locked, whereas
36497 .display
36498 &`exim_lock -q /var/spool/mail/spqr <<End`&
36499 <&'some commands'&>
36500 &`End`&
36501 .endd
36502 runs a specific non-interactive sequence of commands while the file is locked,
36503 suppressing all verification output. A single command can be run by a command
36504 such as
36505 .code
36506 exim_lock -q /var/spool/mail/spqr \
36507   "cp /var/spool/mail/spqr /some/where"
36508 .endd
36509 Note that if a command is supplied, it must be entirely contained within the
36510 second argument &-- hence the quotes.
36511 .ecindex IIDutils
36512
36513
36514 . ////////////////////////////////////////////////////////////////////////////
36515 . ////////////////////////////////////////////////////////////////////////////
36516
36517 .chapter "The Exim monitor" "CHAPeximon"
36518 .scindex IIDeximon "Exim monitor" "description"
36519 .cindex "X-windows"
36520 .cindex "&'eximon'&"
36521 .cindex "Local/eximon.conf"
36522 .cindex "&_exim_monitor/EDITME_&"
36523 The Exim monitor is an application which displays in an X window information
36524 about the state of Exim's queue and what Exim is doing. An admin user can
36525 perform certain operations on messages from this GUI interface; however all
36526 such facilities are also available from the command line, and indeed, the
36527 monitor itself makes use of the command line to perform any actions requested.
36528
36529
36530
36531 .section "Running the monitor" "SECID264"
36532 The monitor is started by running the script called &'eximon'&. This is a shell
36533 script that sets up a number of environment variables, and then runs the
36534 binary called &_eximon.bin_&. The default appearance of the monitor window can
36535 be changed by editing the &_Local/eximon.conf_& file created by editing
36536 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36537 parameters are for.
36538
36539 The parameters that get built into the &'eximon'& script can be overridden for
36540 a particular invocation by setting up environment variables of the same names,
36541 preceded by &`EXIMON_`&. For example, a shell command such as
36542 .code
36543 EXIMON_LOG_DEPTH=400 eximon
36544 .endd
36545 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36546 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36547 overrides the Exim log file configuration. This makes it possible to have
36548 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36549 syslog messages are routed to a file on the local host.
36550
36551 X resources can be used to change the appearance of the window in the normal
36552 way. For example, a resource setting of the form
36553 .code
36554 Eximon*background: gray94
36555 .endd
36556 changes the colour of the background to light grey rather than white. The
36557 stripcharts are drawn with both the data lines and the reference lines in
36558 black. This means that the reference lines are not visible when on top of the
36559 data. However, their colour can be changed by setting a resource called
36560 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36561 For example, if your X server is running Unix, you could set up lighter
36562 reference lines in the stripcharts by obeying
36563 .code
36564 xrdb -merge <<End
36565 Eximon*highlight: gray
36566 End
36567 .endd
36568 .cindex "admin user"
36569 In order to see the contents of messages on the queue, and to operate on them,
36570 &'eximon'& must either be run as root or by an admin user.
36571
36572 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36573 contain X11 resource parameters interpreted by the X11 library.  In addition,
36574 if the first parameter starts with the string "gdb" then it is removed and the
36575 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36576 versioned variants of gdb can be invoked).
36577
36578 The monitor's window is divided into three parts. The first contains one or
36579 more stripcharts and two action buttons, the second contains a &"tail"& of the
36580 main log file, and the third is a display of the queue of messages awaiting
36581 delivery, with two more action buttons. The following sections describe these
36582 different parts of the display.
36583
36584
36585
36586
36587 .section "The stripcharts" "SECID265"
36588 .cindex "stripchart"
36589 The first stripchart is always a count of messages on the queue. Its name can
36590 be configured by setting QUEUE_STRIPCHART_NAME in the
36591 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36592 configuration script by regular expression matches on log file entries, making
36593 it possible to display, for example, counts of messages delivered to certain
36594 hosts or using certain transports. The supplied defaults display counts of
36595 received and delivered messages, and of local and SMTP deliveries. The default
36596 period between stripchart updates is one minute; this can be adjusted by a
36597 parameter in the &_Local/eximon.conf_& file.
36598
36599 The stripchart displays rescale themselves automatically as the value they are
36600 displaying changes. There are always 10 horizontal lines in each chart; the
36601 title string indicates the value of each division when it is greater than one.
36602 For example, &"x2"& means that each division represents a value of 2.
36603
36604 It is also possible to have a stripchart which shows the percentage fullness of
36605 a particular disk partition, which is useful when local deliveries are confined
36606 to a single partition.
36607
36608 .cindex "&%statvfs%& function"
36609 This relies on the availability of the &[statvfs()]& function or equivalent in
36610 the operating system. Most, but not all versions of Unix that support Exim have
36611 this. For this particular stripchart, the top of the chart always represents
36612 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36613 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36614 &_Local/eximon.conf_& file.
36615
36616
36617
36618
36619 .section "Main action buttons" "SECID266"
36620 .cindex "size" "of monitor window"
36621 .cindex "Exim monitor" "window size"
36622 .cindex "window size"
36623 Below the stripcharts there is an action button for quitting the monitor. Next
36624 to this is another button marked &"Size"&. They are placed here so that
36625 shrinking the window to its default minimum size leaves just the queue count
36626 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36627 the window to expand to its maximum size, unless it is already at the maximum,
36628 in which case it is reduced to its minimum.
36629
36630 When expanding to the maximum, if the window cannot be fully seen where it
36631 currently is, it is moved back to where it was the last time it was at full
36632 size. When it is expanding from its minimum size, the old position is
36633 remembered, and next time it is reduced to the minimum it is moved back there.
36634
36635 The idea is that you can keep a reduced window just showing one or two
36636 stripcharts at a convenient place on your screen, easily expand it to show
36637 the full window when required, and just as easily put it back to what it was.
36638 The idea is copied from what the &'twm'& window manager does for its
36639 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36640 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36641
36642 Normally, the monitor starts up with the window at its full size, but it can be
36643 built so that it starts up with the window at its smallest size, by setting
36644 START_SMALL=yes in &_Local/eximon.conf_&.
36645
36646
36647
36648 .section "The log display" "SECID267"
36649 .cindex "log" "tail of; in monitor"
36650 The second section of the window is an area in which a display of the tail of
36651 the main log is maintained.
36652 To save space on the screen, the timestamp on each log line is shortened by
36653 removing the date and, if &%log_timezone%& is set, the timezone.
36654 The log tail is not available when the only destination for logging data is
36655 syslog, unless the syslog lines are routed to a local file whose name is passed
36656 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36657
36658 The log sub-window has a scroll bar at its lefthand side which can be used to
36659 move back to look at earlier text, and the up and down arrow keys also have a
36660 scrolling effect. The amount of log that is kept depends on the setting of
36661 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36662 to use. When this is full, the earlier 50% of data is discarded &-- this is
36663 much more efficient than throwing it away line by line. The sub-window also has
36664 a horizontal scroll bar for accessing the ends of long log lines. This is the
36665 only means of horizontal scrolling; the right and left arrow keys are not
36666 available. Text can be cut from this part of the window using the mouse in the
36667 normal way. The size of this subwindow is controlled by parameters in the
36668 configuration file &_Local/eximon.conf_&.
36669
36670 Searches of the text in the log window can be carried out by means of the ^R
36671 and ^S keystrokes, which default to a reverse and a forward search,
36672 respectively. The search covers only the text that is displayed in the window.
36673 It cannot go further back up the log.
36674
36675 The point from which the search starts is indicated by a caret marker. This is
36676 normally at the end of the text in the window, but can be positioned explicitly
36677 by pointing and clicking with the left mouse button, and is moved automatically
36678 by a successful search. If new text arrives in the window when it is scrolled
36679 back, the caret remains where it is, but if the window is not scrolled back,
36680 the caret is moved to the end of the new text.
36681
36682 Pressing ^R or ^S pops up a window into which the search text can be typed.
36683 There are buttons for selecting forward or reverse searching, for carrying out
36684 the search, and for cancelling. If the &"Search"& button is pressed, the search
36685 happens and the window remains so that further searches can be done. If the
36686 &"Return"& key is pressed, a single search is done and the window is closed. If
36687 ^C is typed the search is cancelled.
36688
36689 The searching facility is implemented using the facilities of the Athena text
36690 widget. By default this pops up a window containing both &"search"& and
36691 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36692 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36693 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36694 provided version of &%TextPop%& when the remaining parts of the text widget
36695 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36696 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36697 on these systems, at the expense of having unwanted items in the search popup
36698 window.
36699
36700
36701
36702 .section "The queue display" "SECID268"
36703 .cindex "queue" "display in monitor"
36704 The bottom section of the monitor window contains a list of all messages that
36705 are on the queue, which includes those currently being received or delivered,
36706 as well as those awaiting delivery. The size of this subwindow is controlled by
36707 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36708 at which it is updated is controlled by another parameter in the same file &--
36709 the default is 5 minutes, since queue scans can be quite expensive. However,
36710 there is an &"Update"& action button just above the display which can be used
36711 to force an update of the queue display at any time.
36712
36713 When a host is down for some time, a lot of pending mail can build up for it,
36714 and this can make it hard to deal with other messages on the queue. To help
36715 with this situation there is a button next to &"Update"& called &"Hide"&. If
36716 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36717 type anything in here and press &"Return"&, the text is added to a chain of
36718 such texts, and if every undelivered address in a message matches at least one
36719 of the texts, the message is not displayed.
36720
36721 If there is an address that does not match any of the texts, all the addresses
36722 are displayed as normal. The matching happens on the ends of addresses so, for
36723 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36724 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36725 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36726 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36727 a hide request is automatically cancelled after one hour.
36728
36729 While the dialogue box is displayed, you can't press any buttons or do anything
36730 else to the monitor window. For this reason, if you want to cut text from the
36731 queue display to use in the dialogue box, you have to do the cutting before
36732 pressing the &"Hide"& button.
36733
36734 The queue display contains, for each unhidden queued message, the length of
36735 time it has been on the queue, the size of the message, the message id, the
36736 message sender, and the first undelivered recipient, all on one line. If it is
36737 a bounce message, the sender is shown as &"<>"&. If there is more than one
36738 recipient to which the message has not yet been delivered, subsequent ones are
36739 listed on additional lines, up to a maximum configured number, following which
36740 an ellipsis is displayed. Recipients that have already received the message are
36741 not shown.
36742
36743 .cindex "frozen messages" "display"
36744 If a message is frozen, an asterisk is displayed at the left-hand side.
36745
36746 The queue display has a vertical scroll bar, and can also be scrolled by means
36747 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36748 The text searching facilities, as described above for the log window, are also
36749 available, but the caret is always moved to the end of the text when the queue
36750 display is updated.
36751
36752
36753
36754 .section "The queue menu" "SECID269"
36755 .cindex "queue" "menu in monitor"
36756 If the &%shift%& key is held down and the left button is clicked when the mouse
36757 pointer is over the text for any message, an action menu pops up, and the first
36758 line of the queue display for the message is highlighted. This does not affect
36759 any selected text.
36760
36761 If you want to use some other event for popping up the menu, you can set the
36762 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36763 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36764 value set in this parameter is a standard X event description. For example, to
36765 run eximon using &%ctrl%& rather than &%shift%& you could use
36766 .code
36767 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36768 .endd
36769 The title of the menu is the message id, and it contains entries which act as
36770 follows:
36771
36772 .ilist
36773 &'message log'&: The contents of the message log for the message are displayed
36774 in a new text window.
36775 .next
36776 &'headers'&: Information from the spool file that contains the envelope
36777 information and headers is displayed in a new text window. See chapter
36778 &<<CHAPspool>>& for a description of the format of spool files.
36779 .next
36780 &'body'&: The contents of the spool file containing the body of the message are
36781 displayed in a new text window. There is a default limit of 20,000 bytes to the
36782 amount of data displayed. This can be changed by setting the BODY_MAX
36783 option at compile time, or the EXIMON_BODY_MAX option at run time.
36784 .next
36785 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36786 delivery of the message. This causes an automatic thaw if the message is
36787 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36788 a new text window. The delivery is run in a separate process, to avoid holding
36789 up the monitor while the delivery proceeds.
36790 .next
36791 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36792 that the message be frozen.
36793 .next
36794 .cindex "thawing messages"
36795 .cindex "unfreezing messages"
36796 .cindex "frozen messages" "thawing"
36797 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36798 that the message be thawed.
36799 .next
36800 .cindex "delivery" "forcing failure"
36801 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36802 that Exim gives up trying to deliver the message. A bounce message is generated
36803 for any remaining undelivered addresses.
36804 .next
36805 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36806 that the message be deleted from the system without generating a bounce
36807 message.
36808 .next
36809 &'add recipient'&: A dialog box is displayed into which a recipient address can
36810 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36811 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36812 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36813 causes a call to Exim to be made using the &%-Mar%& option to request that an
36814 additional recipient be added to the message, unless the entry box is empty, in
36815 which case no action is taken.
36816 .next
36817 &'mark delivered'&: A dialog box is displayed into which a recipient address
36818 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36819 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36820 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36821 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36822 recipient address as already delivered, unless the entry box is empty, in which
36823 case no action is taken.
36824 .next
36825 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36826 mark all recipient addresses as already delivered.
36827 .next
36828 &'edit sender'&: A dialog box is displayed initialized with the current
36829 sender's address. Pressing RETURN causes a call to Exim to be made using the
36830 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36831 in which case no action is taken. If you want to set an empty sender (as in
36832 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36833 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36834 the address is qualified with that domain.
36835 .endlist
36836
36837 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36838 other cases when a call to Exim is made, if there is any output from Exim (in
36839 particular, if the command fails) a window containing the command and the
36840 output is displayed. Otherwise, the results of the action are normally apparent
36841 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36842 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36843 if no output is generated.
36844
36845 The queue display is automatically updated for actions such as freezing and
36846 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36847 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36848 force an update of the display after one of these actions.
36849
36850 In any text window that is displayed as result of a menu action, the normal
36851 cut-and-paste facility is available, and searching can be carried out using ^R
36852 and ^S, as described above for the log tail window.
36853 .ecindex IIDeximon
36854
36855
36856
36857
36858
36859 . ////////////////////////////////////////////////////////////////////////////
36860 . ////////////////////////////////////////////////////////////////////////////
36861
36862 .chapter "Security considerations" "CHAPsecurity"
36863 .scindex IIDsecurcon "security" "discussion of"
36864 This chapter discusses a number of issues concerned with security, some of
36865 which are also covered in other parts of this manual.
36866
36867 For reasons that this author does not understand, some people have promoted
36868 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36869 existence of this chapter in the documentation. However, the intent of the
36870 chapter is simply to describe the way Exim works in relation to certain
36871 security concerns, not to make any specific claims about the effectiveness of
36872 its security as compared with other MTAs.
36873
36874 What follows is a description of the way Exim is supposed to be. Best efforts
36875 have been made to try to ensure that the code agrees with the theory, but an
36876 absence of bugs can never be guaranteed. Any that are reported will get fixed
36877 as soon as possible.
36878
36879
36880 .section "Building a more &""hardened""& Exim" "SECID286"
36881 .cindex "security" "build-time features"
36882 There are a number of build-time options that can be set in &_Local/Makefile_&
36883 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36884 Exim administrator who does not have the root password, or by someone who has
36885 penetrated the Exim (but not the root) account. These options are as follows:
36886
36887 .ilist
36888 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36889 start of any file names used with the &%-C%& option. When it is set, these file
36890 names are also not allowed to contain the sequence &"/../"&. (However, if the
36891 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36892 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36893 default setting for &%ALT_CONFIG_PREFIX%&.
36894
36895 If the permitted configuration files are confined to a directory to
36896 which only root has access, this guards against someone who has broken
36897 into the Exim account from running a privileged Exim with an arbitrary
36898 configuration file, and using it to break into other accounts.
36899 .next
36900
36901 If a non-trusted configuration file (i.e. not the default configuration file
36902 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36903 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36904 the next item), then root privilege is retained only if the caller of Exim is
36905 root. This locks out the possibility of testing a configuration using &%-C%&
36906 right through message reception and delivery, even if the caller is root. The
36907 reception works, but by that time, Exim is running as the Exim user, so when
36908 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36909 privilege to be lost. However, root can test reception and delivery using two
36910 separate commands.
36911
36912 .next
36913 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36914 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36915 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36916 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36917 the restrictive side.  Requiring build-time selection of safe macros is onerous
36918 but this option is intended solely as a transition mechanism to permit
36919 previously-working configurations to continue to work after release 4.73.
36920 .next
36921 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36922 is disabled.
36923 .next
36924 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36925 never to be used for any deliveries. This is like the &%never_users%& runtime
36926 option, but it cannot be overridden; the runtime option adds additional users
36927 to the list. The default setting is &"root"&; this prevents a non-root user who
36928 is permitted to modify the runtime file from using Exim as a way to get root.
36929 .endlist
36930
36931
36932
36933 .section "Root privilege" "SECID270"
36934 .cindex "setuid"
36935 .cindex "root privilege"
36936 The Exim binary is normally setuid to root, which means that it gains root
36937 privilege (runs as root) when it starts execution. In some special cases (for
36938 example, when the daemon is not in use and there are no local deliveries), it
36939 may be possible to run Exim setuid to some user other than root. This is
36940 discussed in the next section. However, in most installations, root privilege
36941 is required for two things:
36942
36943 .ilist
36944 To set up a socket connected to the standard SMTP port (25) when initialising
36945 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36946 not required.
36947 .next
36948 To be able to change uid and gid in order to read users' &_.forward_& files and
36949 perform local deliveries as the receiving user or as specified in the
36950 configuration.
36951 .endlist
36952
36953 It is not necessary to be root to do any of the other things Exim does, such as
36954 receiving messages and delivering them externally over SMTP, and it is
36955 obviously more secure if Exim does not run as root except when necessary.
36956 For this reason, a user and group for Exim to use must be defined in
36957 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36958 group"&. Their values can be changed by the run time configuration, though this
36959 is not recommended. Often a user called &'exim'& is used, but some sites use
36960 &'mail'& or another user name altogether.
36961
36962 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36963 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36964 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36965
36966 After a new Exim process has interpreted its command line options, it changes
36967 uid and gid in the following cases:
36968
36969 .ilist
36970 .oindex "&%-C%&"
36971 .oindex "&%-D%&"
36972 If the &%-C%& option is used to specify an alternate configuration file, or if
36973 the &%-D%& option is used to define macro values for the configuration, and the
36974 calling process is not running as root, the uid and gid are changed to those of
36975 the calling process.
36976 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36977 option may not be used at all.
36978 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36979 can be supplied if the calling process is running as root, the Exim run-time
36980 user or CONFIGURE_OWNER, if defined.
36981 .next
36982 .oindex "&%-be%&"
36983 .oindex "&%-bf%&"
36984 .oindex "&%-bF%&"
36985 If the expansion test option (&%-be%&) or one of the filter testing options
36986 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36987 calling process.
36988 .next
36989 If the process is not a daemon process or a queue runner process or a delivery
36990 process or a process for testing address routing (started with &%-bt%&), the
36991 uid and gid are changed to the Exim user and group. This means that Exim always
36992 runs under its own uid and gid when receiving messages. This also applies when
36993 testing address verification
36994 .oindex "&%-bv%&"
36995 .oindex "&%-bh%&"
36996 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36997 option).
36998 .next
36999 For a daemon, queue runner, delivery, or address testing process, the uid
37000 remains as root at this stage, but the gid is changed to the Exim group.
37001 .endlist
37002
37003 The processes that initially retain root privilege behave as follows:
37004
37005 .ilist
37006 A daemon process changes the gid to the Exim group and the uid to the Exim
37007 user after setting up one or more listening sockets. The &[initgroups()]&
37008 function is called, so that if the Exim user is in any additional groups, they
37009 will be used during message reception.
37010 .next
37011 A queue runner process retains root privilege throughout its execution. Its
37012 job is to fork a controlled sequence of delivery processes.
37013 .next
37014 A delivery process retains root privilege throughout most of its execution,
37015 but any actual deliveries (that is, the transports themselves) are run in
37016 subprocesses which always change to a non-root uid and gid. For local
37017 deliveries this is typically the uid and gid of the owner of the mailbox; for
37018 remote deliveries, the Exim uid and gid are used. Once all the delivery
37019 subprocesses have been run, a delivery process changes to the Exim uid and gid
37020 while doing post-delivery tidying up such as updating the retry database and
37021 generating bounce and warning messages.
37022
37023 While the recipient addresses in a message are being routed, the delivery
37024 process runs as root. However, if a user's filter file has to be processed,
37025 this is done in a subprocess that runs under the individual user's uid and
37026 gid. A system filter is run as root unless &%system_filter_user%& is set.
37027 .next
37028 A process that is testing addresses (the &%-bt%& option) runs as root so that
37029 the routing is done in the same environment as a message delivery.
37030 .endlist
37031
37032
37033
37034
37035 .section "Running Exim without privilege" "SECTrunexiwitpri"
37036 .cindex "privilege, running without"
37037 .cindex "unprivileged running"
37038 .cindex "root privilege" "running without"
37039 Some installations like to run Exim in an unprivileged state for more of its
37040 operation, for added security. Support for this mode of operation is provided
37041 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37042 gid are changed to the Exim user and group at the start of a delivery process
37043 (and also queue runner and address testing processes). This means that address
37044 routing is no longer run as root, and the deliveries themselves cannot change
37045 to any other uid.
37046
37047 .cindex SIGHUP
37048 .cindex "daemon" "restarting"
37049 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37050 that the daemon can still be started in the usual way, and it can respond
37051 correctly to SIGHUP because the re-invocation regains root privilege.
37052
37053 An alternative approach is to make Exim setuid to the Exim user and also setgid
37054 to the Exim group. If you do this, the daemon must be started from a root
37055 process. (Calling Exim from a root process makes it behave in the way it does
37056 when it is setuid root.) However, the daemon cannot restart itself after a
37057 SIGHUP signal because it cannot regain privilege.
37058
37059 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37060 stops Exim from trying to re-invoke itself to do a delivery after a message has
37061 been received. Such a re-invocation is a waste of resources because it has no
37062 effect.
37063
37064 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37065 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37066 to the Exim user seems a clean approach, but there is one complication:
37067
37068 In this style of operation, Exim is running with the real uid and gid set to
37069 those of the calling process, and the effective uid/gid set to Exim's values.
37070 Ideally, any association with the calling process' uid/gid should be dropped,
37071 that is, the real uid/gid should be reset to the effective values so as to
37072 discard any privileges that the caller may have. While some operating systems
37073 have a function that permits this action for a non-root effective uid, quite a
37074 number of them do not. Because of this lack of standardization, Exim does not
37075 address this problem at this time.
37076
37077 For this reason, the recommended approach for &"mostly unprivileged"& running
37078 is to keep the Exim binary setuid to root, and to set
37079 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37080 be used in the most straightforward way.
37081
37082 If you configure Exim not to run delivery processes as root, there are a
37083 number of restrictions on what you can do:
37084
37085 .ilist
37086 You can deliver only as the Exim user/group. You should  explicitly use the
37087 &%user%& and &%group%& options to override routers or local transports that
37088 normally deliver as the recipient. This makes sure that configurations that
37089 work in this mode function the same way in normal mode. Any implicit or
37090 explicit specification of another user causes an error.
37091 .next
37092 Use of &_.forward_& files is severely restricted, such that it is usually
37093 not worthwhile to include them in the configuration.
37094 .next
37095 Users who wish to use &_.forward_& would have to make their home directory and
37096 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37097 and their equivalents in Exim filters, cannot be used. While they could be
37098 enabled in the Exim user's name, that would be insecure and not very useful.
37099 .next
37100 Unless the local user mailboxes are all owned by the Exim user (possible in
37101 some POP3 or IMAP-only environments):
37102
37103 .olist
37104 They must be owned by the Exim group and be writeable by that group. This
37105 implies you must set &%mode%& in the appendfile configuration, as well as the
37106 mode of the mailbox files themselves.
37107 .next
37108 You must set &%no_check_owner%&, since most or all of the files will not be
37109 owned by the Exim user.
37110 .next
37111 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37112 on a newly created mailbox when unprivileged. This also implies that new
37113 mailboxes need to be created manually.
37114 .endlist olist
37115 .endlist ilist
37116
37117
37118 These restrictions severely restrict what can be done in local deliveries.
37119 However, there are no restrictions on remote deliveries. If you are running a
37120 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37121 gives more security at essentially no cost.
37122
37123 If you are using the &%mua_wrapper%& facility (see chapter
37124 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37125
37126
37127
37128
37129 .section "Delivering to local files" "SECID271"
37130 Full details of the checks applied by &(appendfile)& before it writes to a file
37131 are given in chapter &<<CHAPappendfile>>&.
37132
37133
37134
37135 .section "Running local commands" "SECTsecconslocalcmds"
37136 .cindex "security" "local commands"
37137 .cindex "security" "command injection attacks"
37138 There are a number of ways in which an administrator can configure Exim to run
37139 commands based upon received, untrustworthy, data. Further, in some
37140 configurations a user who can control a &_.forward_& file can also arrange to
37141 run commands. Configuration to check includes, but is not limited to:
37142
37143 .ilist
37144 Use of &%use_shell%& in the pipe transport: various forms of shell command
37145 injection may be possible with this option present. It is dangerous and should
37146 be used only with considerable caution. Consider constraints which whitelist
37147 allowed characters in a variable which is to be used in a pipe transport that
37148 has &%use_shell%& enabled.
37149 .next
37150 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37151 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37152 &_.forward_& files in a redirect router. If Exim is running on a central mail
37153 hub to which ordinary users do not have shell access, but home directories are
37154 NFS mounted (for instance) then administrators should review the list of these
37155 forbid options available, and should bear in mind that the options that may
37156 need forbidding can change as new features are added between releases.
37157 .next
37158 The &%${run...}%& expansion item does not use a shell by default, but
37159 administrators can configure use of &_/bin/sh_& as part of the command.
37160 Such invocations should be viewed with prejudicial suspicion.
37161 .next
37162 Administrators who use embedded Perl are advised to explore how Perl's
37163 taint checking might apply to their usage.
37164 .next
37165 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37166 administrators are well advised to view its use with suspicion, in case (for
37167 instance) it allows a local-part to contain embedded Exim directives.
37168 .next
37169 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37170 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37171 each can reference arbitrary lists and files, rather than just being a list
37172 of opaque strings.
37173 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37174 real-world security vulnerabilities caused by its use with untrustworthy data
37175 injected in, for SQL injection attacks.
37176 Consider the use of the &%inlisti%& expansion condition instead.
37177 .endlist
37178
37179
37180
37181
37182 .section "Trust in configuration data" "SECTsecconfdata"
37183 .cindex "security" "data sources"
37184 .cindex "security" "regular expressions"
37185 .cindex "regular expressions" "security"
37186 .cindex "PCRE" "security"
37187 If configuration data for Exim can come from untrustworthy sources, there
37188 are some issues to be aware of:
37189
37190 .ilist
37191 Use of &%${expand...}%& may provide a path for shell injection attacks.
37192 .next
37193 Letting untrusted data provide a regular expression is unwise.
37194 .next
37195 Using &%${match...}%& to apply a fixed regular expression against untrusted
37196 data may result in pathological behaviour within PCRE.  Be aware of what
37197 "backtracking" means and consider options for being more strict with a regular
37198 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37199 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37200 possessive quantifiers or just not using regular expressions against untrusted
37201 data.
37202 .next
37203 It can be important to correctly use &%${quote:...}%&,
37204 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37205 items to ensure that data is correctly constructed.
37206 .next
37207 Some lookups might return multiple results, even though normal usage is only
37208 expected to yield one result.
37209 .endlist
37210
37211
37212
37213
37214 .section "IPv4 source routing" "SECID272"
37215 .cindex "source routing" "in IP packets"
37216 .cindex "IP source routing"
37217 Many operating systems suppress IP source-routed packets in the kernel, but
37218 some cannot be made to do this, so Exim does its own check. It logs incoming
37219 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37220 IPv6. No special checking is currently done.
37221
37222
37223
37224 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37225 Support for these SMTP commands is disabled by default. If required, they can
37226 be enabled by defining suitable ACLs.
37227
37228
37229
37230
37231 .section "Privileged users" "SECID274"
37232 .cindex "trusted users"
37233 .cindex "admin user"
37234 .cindex "privileged user"
37235 .cindex "user" "trusted"
37236 .cindex "user" "admin"
37237 Exim recognizes two sets of users with special privileges. Trusted users are
37238 able to submit new messages to Exim locally, but supply their own sender
37239 addresses and information about a sending host. For other users submitting
37240 local messages, Exim sets up the sender address from the uid, and doesn't
37241 permit a remote host to be specified.
37242
37243 .oindex "&%-f%&"
37244 However, an untrusted user is permitted to use the &%-f%& command line option
37245 in the special form &%-f <>%& to indicate that a delivery failure for the
37246 message should not cause an error report. This affects the message's envelope,
37247 but it does not affect the &'Sender:'& header. Untrusted users may also be
37248 permitted to use specific forms of address with the &%-f%& option by setting
37249 the &%untrusted_set_sender%& option.
37250
37251 Trusted users are used to run processes that receive mail messages from some
37252 other mail domain and pass them on to Exim for delivery either locally, or over
37253 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37254 as any user listed in the &%trusted_users%& configuration option, or under any
37255 group listed in the &%trusted_groups%& option.
37256
37257 Admin users are permitted to do things to the messages on Exim's queue. They
37258 can freeze or thaw messages, cause them to be returned to their senders, remove
37259 them entirely, or modify them in various ways. In addition, admin users can run
37260 the Exim monitor and see all the information it is capable of providing, which
37261 includes the contents of files on the spool.
37262
37263 .oindex "&%-M%&"
37264 .oindex "&%-q%&"
37265 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37266 delivery of messages on its queue is restricted to admin users. This
37267 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37268 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37269 queue is also restricted to admin users. This restriction can be relaxed by
37270 setting &%no_queue_list_requires_admin%&.
37271
37272 Exim recognizes an admin user if the calling process is running as root or as
37273 the Exim user or if any of the groups associated with the calling process is
37274 the Exim group. It is not necessary actually to be running under the Exim
37275 group. However, if admin users who are not root or the Exim user are to access
37276 the contents of files on the spool via the Exim monitor (which runs
37277 unprivileged), Exim must be built to allow group read access to its spool
37278 files.
37279
37280
37281
37282 .section "Spool files" "SECID275"
37283 .cindex "spool directory" "files"
37284 Exim's spool directory and everything it contains is owned by the Exim user and
37285 set to the Exim group. The mode for spool files is defined in the
37286 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37287 any user who is a member of the Exim group can access these files.
37288
37289
37290
37291 .section "Use of argv[0]" "SECID276"
37292 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37293 of specific strings, Exim assumes certain options. For example, calling Exim
37294 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37295 to calling it with the option &%-bS%&. There are no security implications in
37296 this.
37297
37298
37299
37300 .section "Use of %f formatting" "SECID277"
37301 The only use made of &"%f"& by Exim is in formatting load average values. These
37302 are actually stored in integer variables as 1000 times the load average.
37303 Consequently, their range is limited and so therefore is the length of the
37304 converted output.
37305
37306
37307
37308 .section "Embedded Exim path" "SECID278"
37309 Exim uses its own path name, which is embedded in the code, only when it needs
37310 to re-exec in order to regain root privilege. Therefore, it is not root when it
37311 does so. If some bug allowed the path to get overwritten, it would lead to an
37312 arbitrary program's being run as exim, not as root.
37313
37314
37315
37316 .section "Dynamic module directory" "SECTdynmoddir"
37317 Any dynamically loadable modules must be installed into the directory
37318 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37319 loading it.
37320
37321
37322 .section "Use of sprintf()" "SECID279"
37323 .cindex "&[sprintf()]&"
37324 A large number of occurrences of &"sprintf"& in the code are actually calls to
37325 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37326 The intermediate formatting is done into a large fixed buffer by a function
37327 that runs through the format string itself, and checks the length of each
37328 conversion before performing it, thus preventing buffer overruns.
37329
37330 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37331 the output buffer is known to be sufficiently long to contain the converted
37332 string.
37333
37334
37335
37336 .section "Use of debug_printf() and log_write()" "SECID280"
37337 Arbitrary strings are passed to both these functions, but they do their
37338 formatting by calling the function &'string_vformat()'&, which runs through
37339 the format string itself, and checks the length of each conversion.
37340
37341
37342
37343 .section "Use of strcat() and strcpy()" "SECID281"
37344 These are used only in cases where the output buffer is known to be large
37345 enough to hold the result.
37346 .ecindex IIDsecurcon
37347
37348
37349
37350
37351 . ////////////////////////////////////////////////////////////////////////////
37352 . ////////////////////////////////////////////////////////////////////////////
37353
37354 .chapter "Format of spool files" "CHAPspool"
37355 .scindex IIDforspo1 "format" "spool files"
37356 .scindex IIDforspo2 "spool directory" "format of files"
37357 .scindex IIDforspo3 "spool files" "format of"
37358 .cindex "spool files" "editing"
37359 A message on Exim's queue consists of two files, whose names are the message id
37360 followed by -D and -H, respectively. The data portion of the message is kept in
37361 the -D file on its own. The message's envelope, status, and headers are all
37362 kept in the -H file, whose format is described in this chapter. Each of these
37363 two files contains the final component of its own name as its first line. This
37364 is insurance against disk crashes where the directory is lost but the files
37365 themselves are recoverable.
37366
37367 Some people are tempted into editing -D files in order to modify messages. You
37368 need to be extremely careful if you do this; it is not recommended and you are
37369 on your own if you do it. Here are some of the pitfalls:
37370
37371 .ilist
37372 You must ensure that Exim does not try to deliver the message while you are
37373 fiddling with it. The safest way is to take out a write lock on the -D file,
37374 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37375 place, the lock will be retained. If you write a new file and rename it, the
37376 lock will be lost at the instant of rename.
37377 .next
37378 .vindex "&$body_linecount$&"
37379 If you change the number of lines in the file, the value of
37380 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37381 present, this value is not used by Exim, but there is no guarantee that this
37382 will always be the case.
37383 .next
37384 If the message is in MIME format, you must take care not to break it.
37385 .next
37386 If the message is cryptographically signed, any change will invalidate the
37387 signature.
37388 .endlist
37389 All in all, modifying -D files is fraught with danger.
37390
37391 Files whose names end with -J may also be seen in the &_input_& directory (or
37392 its subdirectories when &%split_spool_directory%& is set). These are journal
37393 files, used to record addresses to which the message has been delivered during
37394 the course of a delivery attempt. If there are still undelivered recipients at
37395 the end, the -H file is updated, and the -J file is deleted. If, however, there
37396 is some kind of crash (for example, a power outage) before this happens, the -J
37397 file remains in existence. When Exim next processes the message, it notices the
37398 -J file and uses it to update the -H file before starting the next delivery
37399 attempt.
37400
37401 .section "Format of the -H file" "SECID282"
37402 .cindex "uid (user id)" "in spool file"
37403 .cindex "gid (group id)" "in spool file"
37404 The second line of the -H file contains the login name for the uid of the
37405 process that called Exim to read the message, followed by the numerical uid and
37406 gid. For a locally generated message, this is normally the user who sent the
37407 message. For a message received over TCP/IP via the daemon, it is
37408 normally the Exim user.
37409
37410 The third line of the file contains the address of the message's sender as
37411 transmitted in the envelope, contained in angle brackets. The sender address is
37412 empty for bounce messages. For incoming SMTP mail, the sender address is given
37413 in the MAIL command. For locally generated mail, the sender address is
37414 created by Exim from the login name of the current user and the configured
37415 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37416 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37417 &"<>"& or an address that matches &%untrusted_set_senders%&.
37418
37419 The fourth line contains two numbers. The first is the time that the message
37420 was received, in the conventional Unix form &-- the number of seconds since the
37421 start of the epoch. The second number is a count of the number of messages
37422 warning of delayed delivery that have been sent to the sender.
37423
37424 There follow a number of lines starting with a hyphen. These can appear in any
37425 order, and are omitted when not relevant:
37426
37427 .vlist
37428 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37429 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37430 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37431 recognized, to provide backward compatibility. In the old format, a line of
37432 this form is present for every ACL variable that is not empty. The number
37433 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37434 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37435 the data string for the variable. The string itself starts at the beginning of
37436 the next line, and is followed by a newline character. It may contain internal
37437 newlines.
37438
37439 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37440 A line of this form is present for every ACL connection variable that is
37441 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37442 The length is the length of the data string for the variable. The string itself
37443 starts at the beginning of the next line, and is followed by a newline
37444 character. It may contain internal newlines.
37445
37446 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37447 A line of this form is present for every ACL message variable that is defined.
37448 Note that there is a space between &%-aclm%& and the rest of the name. The
37449 length is the length of the data string for the variable. The string itself
37450 starts at the beginning of the next line, and is followed by a newline
37451 character. It may contain internal newlines.
37452
37453 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37454 This is present if, when the message was received over SMTP, the value of
37455 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37456
37457 .vitem &%-allow_unqualified_recipient%&
37458 This is present if unqualified recipient addresses are permitted in header
37459 lines (to stop such addresses from being qualified if rewriting occurs at
37460 transport time). Local messages that were input using &%-bnq%& and remote
37461 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37462
37463 .vitem &%-allow_unqualified_sender%&
37464 This is present if unqualified sender addresses are permitted in header lines
37465 (to stop such addresses from being qualified if rewriting occurs at transport
37466 time). Local messages that were input using &%-bnq%& and remote messages from
37467 hosts that match &%sender_unqualified_hosts%& set this flag.
37468
37469 .vitem "&%-auth_id%&&~<&'text'&>"
37470 The id information for a message received on an authenticated SMTP connection
37471 &-- the value of the &$authenticated_id$& variable.
37472
37473 .vitem "&%-auth_sender%&&~<&'address'&>"
37474 The address of an authenticated sender &-- the value of the
37475 &$authenticated_sender$& variable.
37476
37477 .vitem "&%-body_linecount%&&~<&'number'&>"
37478 This records the number of lines in the body of the message, and is always
37479 present.
37480
37481 .vitem "&%-body_zerocount%&&~<&'number'&>"
37482 This records the number of binary zero bytes in the body of the message, and is
37483 present if the number is greater than zero.
37484
37485 .vitem &%-deliver_firsttime%&
37486 This is written when a new message is first added to the spool. When the spool
37487 file is updated after a deferral, it is omitted.
37488
37489 .vitem "&%-frozen%&&~<&'time'&>"
37490 .cindex "frozen messages" "spool data"
37491 The message is frozen, and the freezing happened at <&'time'&>.
37492
37493 .vitem "&%-helo_name%&&~<&'text'&>"
37494 This records the host name as specified by a remote host in a HELO or EHLO
37495 command.
37496
37497 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37498 This records the IP address of the host from which the message was received and
37499 the remote port number that was used. It is omitted for locally generated
37500 messages.
37501
37502 .vitem "&%-host_auth%&&~<&'text'&>"
37503 If the message was received on an authenticated SMTP connection, this records
37504 the name of the authenticator &-- the value of the
37505 &$sender_host_authenticated$& variable.
37506
37507 .vitem &%-host_lookup_failed%&
37508 This is present if an attempt to look up the sending host's name from its IP
37509 address failed. It corresponds to the &$host_lookup_failed$& variable.
37510
37511 .vitem "&%-host_name%&&~<&'text'&>"
37512 .cindex "reverse DNS lookup"
37513 .cindex "DNS" "reverse lookup"
37514 This records the name of the remote host from which the message was received,
37515 if the host name was looked up from the IP address when the message was being
37516 received. It is not present if no reverse lookup was done.
37517
37518 .vitem "&%-ident%&&~<&'text'&>"
37519 For locally submitted messages, this records the login of the originating user,
37520 unless it was a trusted user and the &%-oMt%& option was used to specify an
37521 ident value. For messages received over TCP/IP, this records the ident string
37522 supplied by the remote host, if any.
37523
37524 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37525 This records the IP address of the local interface and the port number through
37526 which a message was received from a remote host. It is omitted for locally
37527 generated messages.
37528
37529 .vitem &%-local%&
37530 The message is from a local sender.
37531
37532 .vitem &%-localerror%&
37533 The message is a locally-generated bounce message.
37534
37535 .vitem "&%-local_scan%&&~<&'string'&>"
37536 This records the data string that was returned by the &[local_scan()]& function
37537 when the message was received &-- the value of the &$local_scan_data$&
37538 variable. It is omitted if no data was returned.
37539
37540 .vitem &%-manual_thaw%&
37541 The message was frozen but has been thawed manually, that is, by an explicit
37542 Exim command rather than via the auto-thaw process.
37543
37544 .vitem &%-N%&
37545 A testing delivery process was started using the &%-N%& option to suppress any
37546 actual deliveries, but delivery was deferred. At any further delivery attempts,
37547 &%-N%& is assumed.
37548
37549 .vitem &%-received_protocol%&
37550 This records the value of the &$received_protocol$& variable, which contains
37551 the name of the protocol by which the message was received.
37552
37553 .vitem &%-sender_set_untrusted%&
37554 The envelope sender of this message was set by an untrusted local caller (used
37555 to ensure that the caller is displayed in queue listings).
37556
37557 .vitem "&%-spam_score_int%&&~<&'number'&>"
37558 If a message was scanned by SpamAssassin, this is present. It records the value
37559 of &$spam_score_int$&.
37560
37561 .vitem &%-tls_certificate_verified%&
37562 A TLS certificate was received from the client that sent this message, and the
37563 certificate was verified by the server.
37564
37565 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37566 When the message was received over an encrypted connection, this records the
37567 name of the cipher suite that was used.
37568
37569 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37570 When the message was received over an encrypted connection, and a certificate
37571 was received from the client, this records the Distinguished Name from that
37572 certificate.
37573 .endlist
37574
37575 Following the options there is a list of those addresses to which the message
37576 is not to be delivered. This set of addresses is initialized from the command
37577 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37578 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37579 the address is added to this set. The addresses are kept internally as a
37580 balanced binary tree, and it is a representation of that tree which is written
37581 to the spool file. If an address is expanded via an alias or forward file, the
37582 original address is added to the tree when deliveries to all its child
37583 addresses are complete.
37584
37585 If the tree is empty, there is a single line in the spool file containing just
37586 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37587 Y or N, followed by an address. The address is the value for the node of the
37588 tree, and the letters indicate whether the node has a left branch and/or a
37589 right branch attached to it, respectively. If branches exist, they immediately
37590 follow. Here is an example of a three-node tree:
37591 .code
37592 YY darcy@austen.fict.example
37593 NN alice@wonderland.fict.example
37594 NN editor@thesaurus.ref.example
37595 .endd
37596 After the non-recipients tree, there is a list of the message's recipients.
37597 This is a simple list, preceded by a count. It includes all the original
37598 recipients of the message, including those to whom the message has already been
37599 delivered. In the simplest case, the list contains one address per line. For
37600 example:
37601 .code
37602 4
37603 editor@thesaurus.ref.example
37604 darcy@austen.fict.example
37605 rdo@foundation
37606 alice@wonderland.fict.example
37607 .endd
37608 However, when a child address has been added to the top-level addresses as a
37609 result of the use of the &%one_time%& option on a &(redirect)& router, each
37610 line is of the following form:
37611 .display
37612 <&'top-level address'&> <&'errors_to address'&> &&&
37613   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37614 .endd
37615 The 01 flag bit indicates the presence of the three other fields that follow
37616 the top-level address. Other bits may be used in future to support additional
37617 fields. The <&'parent number'&> is the offset in the recipients list of the
37618 original parent of the &"one time"& address. The first two fields are the
37619 envelope sender that is associated with this address and its length. If the
37620 length is zero, there is no special envelope sender (there are then two space
37621 characters in the line). A non-empty field can arise from a &(redirect)& router
37622 that has an &%errors_to%& setting.
37623
37624
37625 A blank line separates the envelope and status information from the headers
37626 which follow. A header may occupy several lines of the file, and to save effort
37627 when reading it in, each header is preceded by a number and an identifying
37628 character. The number is the number of characters in the header, including any
37629 embedded newlines and the terminating newline. The character is one of the
37630 following:
37631
37632 .table2 50pt
37633 .row <&'blank'&>         "header in which Exim has no special interest"
37634 .row &`B`&               "&'Bcc:'& header"
37635 .row &`C`&               "&'Cc:'& header"
37636 .row &`F`&               "&'From:'& header"
37637 .row &`I`&               "&'Message-id:'& header"
37638 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37639 .row &`R`&               "&'Reply-To:'& header"
37640 .row &`S`&               "&'Sender:'& header"
37641 .row &`T`&               "&'To:'& header"
37642 .row &`*`&               "replaced or deleted header"
37643 .endtable
37644
37645 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37646 purposes. They are not transmitted when the message is delivered. Here is a
37647 typical set of headers:
37648 .code
37649 111P Received: by hobbit.fict.example with local (Exim 4.00)
37650 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37651 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37652 038* X-rewrote-sender: bb@hobbit.fict.example
37653 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37654 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37655 099* To: alice@wonderland.fict.example, rdo@foundation,
37656 darcy@austen.fict.example, editor@thesaurus.ref.example
37657 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37658 darcy@austen.fict.example, editor@thesaurus.ref.example
37659 038  Date: Fri, 11 May 2001 10:28:59 +0100
37660 .endd
37661 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37662 &'To:'& header have been rewritten, the last one because routing expanded the
37663 unqualified domain &'foundation'&.
37664 .ecindex IIDforspo1
37665 .ecindex IIDforspo2
37666 .ecindex IIDforspo3
37667
37668 . ////////////////////////////////////////////////////////////////////////////
37669 . ////////////////////////////////////////////////////////////////////////////
37670
37671 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37672          "DKIM Support"
37673 .cindex "DKIM"
37674
37675 DKIM is a mechanism by which messages sent by some entity can be provably
37676 linked to a domain which that entity controls.  It permits reputation to
37677 be tracked on a per-domain basis, rather than merely upon source IP address.
37678 DKIM is documented in RFC 4871.
37679
37680 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37681 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37682
37683 Exim's DKIM implementation allows to
37684 .olist
37685 Sign outgoing messages: This function is implemented in the SMTP transport.
37686 It can co-exist with all other Exim features
37687 (including transport filters)
37688 except cutthrough delivery.
37689 .next
37690 Verify signatures in incoming messages: This is implemented by an additional
37691 ACL (acl_smtp_dkim), which can be called several times per message, with
37692 different signature contexts.
37693 .endlist
37694
37695 In typical Exim style, the verification implementation does not include any
37696 default "policy". Instead it enables you to build your own policy using
37697 Exim's standard controls.
37698
37699 Please note that verification of DKIM signatures in incoming mail is turned
37700 on by default for logging purposes. For each signature in incoming email,
37701 exim will log a line displaying the most important signature details, and the
37702 signature status. Here is an example (with line-breaks added for clarity):
37703 .code
37704 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37705     d=facebookmail.com s=q1-2009b
37706     c=relaxed/relaxed a=rsa-sha1
37707     i=@facebookmail.com t=1252484542 [verification succeeded]
37708 .endd
37709 You might want to turn off DKIM verification processing entirely for internal
37710 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37711 control modifier. This should typically be done in the RCPT ACL, at points
37712 where you accept mail from relay sources (internal hosts or authenticated
37713 senders).
37714
37715
37716 .section "Signing outgoing messages" "SECID513"
37717 .cindex "DKIM" "signing"
37718
37719 Signing is implemented by setting private options on the SMTP transport.
37720 These options take (expandable) strings as arguments.
37721
37722 .option dkim_domain smtp string&!! unset
37723 MANDATORY:
37724 The domain you want to sign with. The result of this expanded
37725 option is put into the &%$dkim_domain%& expansion variable.
37726
37727 .option dkim_selector smtp string&!! unset
37728 MANDATORY:
37729 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37730 variable to look up a matching selector. The result is put in the expansion
37731 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37732 option along with &%$dkim_domain%&.
37733
37734 .option dkim_private_key smtp string&!! unset
37735 MANDATORY:
37736 This sets the private key to use. You can use the &%$dkim_domain%& and
37737 &%$dkim_selector%& expansion variables to determine the private key to use.
37738 The result can either
37739 .ilist
37740 be a valid RSA private key in ASCII armor, including line breaks.
37741 .next
37742 start with a slash, in which case it is treated as a file that contains
37743 the private key.
37744 .next
37745 be "0", "false" or the empty string, in which case the message will not
37746 be signed. This case will not result in an error, even if &%dkim_strict%&
37747 is set.
37748 .endlist
37749
37750 .option dkim_canon smtp string&!! unset
37751 OPTIONAL:
37752 This option sets the canonicalization method used when signing a message.
37753 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37754 The option defaults to "relaxed" when unset. Note: the current implementation
37755 only supports using the same canonicalization method for both headers and body.
37756
37757 .option dkim_strict smtp string&!! unset
37758 OPTIONAL:
37759 This  option  defines  how  Exim  behaves  when  signing a message that
37760 should be signed fails for some reason.  When the expansion evaluates to
37761 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37762 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37763 variables here.
37764
37765 .option dkim_sign_headers smtp string&!! unset
37766 OPTIONAL:
37767 When set, this option must expand to (or be specified as) a colon-separated
37768 list of header names. Headers with these names will be included in the message
37769 signature. When unspecified, the header names recommended in RFC4871 will be
37770 used.
37771
37772
37773 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37774 .cindex "DKIM" "verification"
37775
37776 Verification of DKIM signatures in incoming email is implemented via the
37777 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37778 syntactically(!) correct signature in the incoming message.
37779 A missing ACL definition defaults to accept.
37780 If any ACL call does not accept, the message is not accepted.
37781 If a cutthrough delivery was in progress for the message it is
37782 summarily dropped (having wasted the transmission effort).
37783
37784 To evaluate the signature in the ACL a large number of expansion variables
37785 containing the signature status and its details are set up during the
37786 runtime of the ACL.
37787
37788 Calling the ACL only for existing signatures is not sufficient to build
37789 more advanced policies. For that reason, the global option
37790 &%dkim_verify_signers%&, and a global expansion variable
37791 &%$dkim_signers%& exist.
37792
37793 The global option &%dkim_verify_signers%& can be set to a colon-separated
37794 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37795 called. It is expanded when the message has been received. At this point,
37796 the expansion variable &%$dkim_signers%& already contains a colon-separated
37797 list of signer domains and identities for the message. When
37798 &%dkim_verify_signers%& is not specified in the main configuration,
37799 it defaults as:
37800 .code
37801 dkim_verify_signers = $dkim_signers
37802 .endd
37803 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37804 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37805 call the ACL for known domains or identities. This would be achieved as follows:
37806 .code
37807 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37808 .endd
37809 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37810 and "ebay.com", plus all domains and identities that have signatures in the message.
37811 You can also be more creative in constructing your policy. For example:
37812 .code
37813 dkim_verify_signers = $sender_address_domain:$dkim_signers
37814 .endd
37815
37816 If a domain or identity is listed several times in the (expanded) value of
37817 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37818
37819
37820 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37821 available (from most to least important):
37822
37823
37824 .vlist
37825 .vitem &%$dkim_cur_signer%&
37826 The signer that is being evaluated in this ACL run. This can be a domain or
37827 an identity. This is one of the list items from the expanded main option
37828 &%dkim_verify_signers%& (see above).
37829 .vitem &%$dkim_verify_status%&
37830 A string describing the general status of the signature. One of
37831 .ilist
37832 &%none%&: There is no signature in the message for the current domain or
37833 identity (as reflected by &%$dkim_cur_signer%&).
37834 .next
37835 &%invalid%&: The signature could not be verified due to a processing error.
37836 More detail is available in &%$dkim_verify_reason%&.
37837 .next
37838 &%fail%&: Verification of the signature failed.  More detail is
37839 available in &%$dkim_verify_reason%&.
37840 .next
37841 &%pass%&: The signature passed verification. It is valid.
37842 .endlist
37843 .vitem &%$dkim_verify_reason%&
37844 A string giving a little bit more detail when &%$dkim_verify_status%& is either
37845 "fail" or "invalid". One of
37846 .ilist
37847 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37848 key for the domain could not be retrieved. This may be a temporary problem.
37849 .next
37850 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37851 record for the domain is syntactically invalid.
37852 .next
37853 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37854 body hash does not match the one specified in the signature header. This
37855 means that the message body was modified in transit.
37856 .next
37857 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37858 could not be verified. This may mean that headers were modified,
37859 re-written or otherwise changed in a way which is incompatible with
37860 DKIM verification. It may of course also mean that the signature is forged.
37861 .endlist
37862 .vitem &%$dkim_domain%&
37863 The signing domain. IMPORTANT: This variable is only populated if there is
37864 an actual signature in the message for the current domain or identity (as
37865 reflected by &%$dkim_cur_signer%&).
37866 .vitem &%$dkim_identity%&
37867 The signing identity, if present. IMPORTANT: This variable is only populated
37868 if there is an actual signature in the message for the current domain or
37869 identity (as reflected by &%$dkim_cur_signer%&).
37870 .vitem &%$dkim_selector%&
37871 The key record selector string.
37872 .vitem &%$dkim_algo%&
37873 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37874 .vitem &%$dkim_canon_body%&
37875 The body canonicalization method. One of 'relaxed' or 'simple'.
37876 .vitem &%dkim_canon_headers%&
37877 The header canonicalization method. One of 'relaxed' or 'simple'.
37878 .vitem &%$dkim_copiedheaders%&
37879 A transcript of headers and their values which are included in the signature
37880 (copied from the 'z=' tag of the signature).
37881 .vitem &%$dkim_bodylength%&
37882 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37883 limit was set by the signer, "9999999999999" is returned. This makes sure
37884 that this variable always expands to an integer value.
37885 .vitem &%$dkim_created%&
37886 UNIX timestamp reflecting the date and time when the signature was created.
37887 When this was not specified by the signer, "0" is returned.
37888 .vitem &%$dkim_expires%&
37889 UNIX timestamp reflecting the date and time when the signer wants the
37890 signature to be treated as "expired". When this was not specified by the
37891 signer, "9999999999999" is returned. This makes it possible to do useful
37892 integer size comparisons against this value.
37893 .vitem &%$dkim_headernames%&
37894 A colon-separated list of names of headers included in the signature.
37895 .vitem &%$dkim_key_testing%&
37896 "1" if the key record has the "testing" flag set, "0" if not.
37897 .vitem &%$dkim_key_nosubdomains%&
37898 "1" if the key record forbids subdomaining, "0" otherwise.
37899 .vitem &%$dkim_key_srvtype%&
37900 Service type (tag s=) from the key record. Defaults to "*" if not specified
37901 in the key record.
37902 .vitem &%$dkim_key_granularity%&
37903 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37904 in the key record.
37905 .vitem &%$dkim_key_notes%&
37906 Notes from the key record (tag n=).
37907 .endlist
37908
37909 In addition, two ACL conditions are provided:
37910
37911 .vlist
37912 .vitem &%dkim_signers%&
37913 ACL condition that checks a colon-separated list of domains or identities
37914 for a match against the domain or identity that the ACL is currently verifying
37915 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37916 verb to a group of domains or identities. For example:
37917
37918 .code
37919 # Warn when Mail purportedly from GMail has no signature at all
37920 warn log_message = GMail sender without DKIM signature
37921      sender_domains = gmail.com
37922      dkim_signers = gmail.com
37923      dkim_status = none
37924 .endd
37925
37926 .vitem &%dkim_status%&
37927 ACL condition that checks a colon-separated list of possible DKIM verification
37928 results against the actual result of verification. This is typically used
37929 to restrict an ACL verb to a list of verification outcomes, for example:
37930
37931 .code
37932 deny message = Mail from Paypal with invalid/missing signature
37933      sender_domains = paypal.com:paypal.de
37934      dkim_signers = paypal.com:paypal.de
37935      dkim_status = none:invalid:fail
37936 .endd
37937
37938 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37939 see the documentation of the &%$dkim_verify_status%& expansion variable above
37940 for more information of what they mean.
37941 .endlist
37942
37943 . ////////////////////////////////////////////////////////////////////////////
37944 . ////////////////////////////////////////////////////////////////////////////
37945
37946 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37947          "Adding drivers or lookups"
37948 .cindex "adding drivers"
37949 .cindex "new drivers, adding"
37950 .cindex "drivers" "adding new"
37951 The following actions have to be taken in order to add a new router, transport,
37952 authenticator, or lookup type to Exim:
37953
37954 .olist
37955 Choose a name for the driver or lookup type that does not conflict with any
37956 existing name; I will use &"newdriver"& in what follows.
37957 .next
37958 Add to &_src/EDITME_& the line:
37959 .display
37960 <&'type'&>&`_NEWDRIVER=yes`&
37961 .endd
37962 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37963 code is not to be included in the binary by default, comment this line out. You
37964 should also add any relevant comments about the driver or lookup type.
37965 .next
37966 Add to &_src/config.h.defaults_& the line:
37967 .code
37968 #define <type>_NEWDRIVER
37969 .endd
37970 .next
37971 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37972 and create a table entry as is done for all the other drivers and lookup types.
37973 .next
37974 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37975 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37976 Add your &`NEWDRIVER`& to that list.
37977 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37978 simple form that most lookups have.
37979 .next
37980 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37981 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37982 driver or lookup type and add it to the definition of OBJ.
37983 .next
37984 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37985 &_src_&.
37986 .next
37987 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37988 as for other drivers and lookups.
37989 .endlist
37990
37991 Then all you need to do is write the code! A good way to start is to make a
37992 proforma by copying an existing module of the same type, globally changing all
37993 occurrences of the name, and cutting out most of the code. Note that any
37994 options you create must be listed in alphabetical order, because the tables are
37995 searched using a binary chop procedure.
37996
37997 There is a &_README_& file in each of the sub-directories of &_src_& describing
37998 the interface that is expected.
37999
38000
38001
38002
38003 . ////////////////////////////////////////////////////////////////////////////
38004 . ////////////////////////////////////////////////////////////////////////////
38005
38006 . /////////////////////////////////////////////////////////////////////////////
38007 . These lines are processing instructions for the Simple DocBook Processor that
38008 . Philip Hazel has developed as a less cumbersome way of making PostScript and
38009 . PDFs than using xmlto and fop. They will be ignored by all other XML
38010 . processors.
38011 . /////////////////////////////////////////////////////////////////////////////
38012
38013 .literal xml
38014 <?sdop
38015   format="newpage"
38016   foot_right_recto="&chaptertitle;"
38017   foot_right_verso="&chaptertitle;"
38018 ?>
38019 .literal off
38020
38021 .makeindex "Options index"   "option"
38022 .makeindex "Variables index" "variable"
38023 .makeindex "Concept index"   "concept"
38024
38025
38026 . /////////////////////////////////////////////////////////////////////////////
38027 . /////////////////////////////////////////////////////////////////////////////