Doc: Add DKIM info in main sections. Bug 1607
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.85"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 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"
1579 Exim makes a note in its hints database, and whenever a successful
1580 SMTP delivery has happened, it looks to see if any other messages are waiting
1581 for the same host. If any are found, they are sent over the same SMTP
1582 connection, subject to a configuration limit as to the maximum number in any
1583 one connection.
1584
1585
1586
1587 .section "Permanent delivery failure" "SECID21"
1588 .cindex "delivery" "permanent failure"
1589 .cindex "bounce message" "when generated"
1590 When a message cannot be delivered to some or all of its intended recipients, a
1591 bounce message is generated. Temporary delivery failures turn into permanent
1592 errors when their timeout expires. All the addresses that fail in a given
1593 delivery attempt are listed in a single message. If the original message has
1594 many recipients, it is possible for some addresses to fail in one delivery
1595 attempt and others to fail subsequently, giving rise to more than one bounce
1596 message. The wording of bounce messages can be customized by the administrator.
1597 See chapter &<<CHAPemsgcust>>& for details.
1598
1599 .cindex "&'X-Failed-Recipients:'& header line"
1600 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1601 failed addresses, for the benefit of programs that try to analyse such messages
1602 automatically.
1603
1604 .cindex "bounce message" "recipient of"
1605 A bounce message is normally sent to the sender of the original message, as
1606 obtained from the message's envelope. For incoming SMTP messages, this is the
1607 address given in the MAIL command. However, when an address is expanded via a
1608 forward or alias file, an alternative address can be specified for delivery
1609 failures of the generated addresses. For a mailing list expansion (see section
1610 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1611 of the list.
1612
1613
1614
1615 .section "Failures to deliver bounce messages" "SECID22"
1616 .cindex "bounce message" "failure to deliver"
1617 If a bounce message (either locally generated or received from a remote host)
1618 itself suffers a permanent delivery failure, the message is left on the queue,
1619 but it is frozen, awaiting the attention of an administrator. There are options
1620 that can be used to make Exim discard such failed messages, or to keep them
1621 for only a short time (see &%timeout_frozen_after%& and
1622 &%ignore_bounce_errors_after%&).
1623
1624
1625
1626
1627
1628 . ////////////////////////////////////////////////////////////////////////////
1629 . ////////////////////////////////////////////////////////////////////////////
1630
1631 .chapter "Building and installing Exim" "CHID3"
1632 .scindex IIDbuex "building Exim"
1633
1634 .section "Unpacking" "SECID23"
1635 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1636 creates a directory with the name of the current release (for example,
1637 &_exim-&version()_&) into which the following files are placed:
1638
1639 .table2 140pt
1640 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1641 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1642   documented"
1643 .irow &_LICENCE_&         "the GNU General Public Licence"
1644 .irow &_Makefile_&        "top-level make file"
1645 .irow &_NOTICE_&          "conditions for the use of Exim"
1646 .irow &_README_&          "list of files, directories and simple build &&&
1647   instructions"
1648 .endtable
1649
1650 Other files whose names begin with &_README_& may also be present. The
1651 following subdirectories are created:
1652
1653 .table2 140pt
1654 .irow &_Local_&           "an empty directory for local configuration files"
1655 .irow &_OS_&              "OS-specific files"
1656 .irow &_doc_&             "documentation files"
1657 .irow &_exim_monitor_&    "source files for the Exim monitor"
1658 .irow &_scripts_&         "scripts used in the build process"
1659 .irow &_src_&             "remaining source files"
1660 .irow &_util_&            "independent utilities"
1661 .endtable
1662
1663 The main utility programs are contained in the &_src_& directory, and are built
1664 with the Exim binary. The &_util_& directory contains a few optional scripts
1665 that may be useful to some sites.
1666
1667
1668 .section "Multiple machine architectures and operating systems" "SECID24"
1669 .cindex "building Exim" "multiple OS/architectures"
1670 The building process for Exim is arranged to make it easy to build binaries for
1671 a number of different architectures and operating systems from the same set of
1672 source files. Compilation does not take place in the &_src_& directory.
1673 Instead, a &'build directory'& is created for each architecture and operating
1674 system.
1675 .cindex "symbolic link" "to build directory"
1676 Symbolic links to the sources are installed in this directory, which is where
1677 the actual building takes place. In most cases, Exim can discover the machine
1678 architecture and operating system for itself, but the defaults can be
1679 overridden if necessary.
1680
1681
1682 .section "PCRE library" "SECTpcre"
1683 .cindex "PCRE library"
1684 Exim no longer has an embedded PCRE library as the vast majority of
1685 modern systems include PCRE as a system library, although you may need
1686 to install the PCRE or PCRE development package for your operating
1687 system. If your system has a normal PCRE installation the Exim build
1688 process will need no further configuration. If the library or the
1689 headers are in an unusual location you will need to either set the PCRE_LIBS
1690 and INCLUDE directives appropriately,
1691 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1692 If your operating system has no
1693 PCRE support then you will need to obtain and build the current PCRE
1694 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1695 More information on PCRE is available at &url(http://www.pcre.org/).
1696
1697 .section "DBM libraries" "SECTdb"
1698 .cindex "DBM libraries" "discussion of"
1699 .cindex "hints database" "DBM files used for"
1700 Even if you do not use any DBM files in your configuration, Exim still needs a
1701 DBM library in order to operate, because it uses indexed files for its hints
1702 databases. Unfortunately, there are a number of DBM libraries in existence, and
1703 different operating systems often have different ones installed.
1704
1705 .cindex "Solaris" "DBM library for"
1706 .cindex "IRIX, DBM library for"
1707 .cindex "BSD, DBM library for"
1708 .cindex "Linux, DBM library for"
1709 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1710 Linux distribution, the DBM configuration should happen automatically, and you
1711 may be able to ignore this section. Otherwise, you may have to learn more than
1712 you would like about DBM libraries from what follows.
1713
1714 .cindex "&'ndbm'& DBM library"
1715 Licensed versions of Unix normally contain a library of DBM functions operating
1716 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1717 versions of Unix seem to vary in what they contain as standard. In particular,
1718 some early versions of Linux have no default DBM library, and different
1719 distributors have chosen to bundle different libraries with their packaged
1720 versions. However, the more recent releases seem to have standardized on the
1721 Berkeley DB library.
1722
1723 Different DBM libraries have different conventions for naming the files they
1724 use. When a program opens a file called &_dbmfile_&, there are several
1725 possibilities:
1726
1727 .olist
1728 A traditional &'ndbm'& implementation, such as that supplied as part of
1729 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1730 .next
1731 .cindex "&'gdbm'& DBM library"
1732 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1733 compatibility interface it makes two different hard links to it with names
1734 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1735 file name is used unmodified.
1736 .next
1737 .cindex "Berkeley DB library"
1738 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1739 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1740 programmer exactly the same as the traditional &'ndbm'& implementation.
1741 .next
1742 If the Berkeley package is used in its native mode, it operates on a single
1743 file called &_dbmfile_&; the programmer's interface is somewhat different to
1744 the traditional &'ndbm'& interface.
1745 .next
1746 To complicate things further, there are several very different versions of the
1747 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1748 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1749 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1750 versions of Berkeley DB can be obtained from
1751 &url(http://www.sleepycat.com/).
1752 .next
1753 .cindex "&'tdb'& DBM library"
1754 Yet another DBM library, called &'tdb'&, is available from
1755 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1756 operates on a single file.
1757 .endlist
1758
1759 .cindex "USE_DB"
1760 .cindex "DBM libraries" "configuration for building"
1761 Exim and its utilities can be compiled to use any of these interfaces. In order
1762 to use any version of the Berkeley DB package in native mode, you must set
1763 USE_DB in an appropriate configuration file (typically
1764 &_Local/Makefile_&). For example:
1765 .code
1766 USE_DB=yes
1767 .endd
1768 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1769 error is diagnosed if you set more than one of these.
1770
1771 At the lowest level, the build-time configuration sets none of these options,
1772 thereby assuming an interface of type (1). However, some operating system
1773 configuration files (for example, those for the BSD operating systems and
1774 Linux) assume type (4) by setting USE_DB as their default, and the
1775 configuration files for Cygwin set USE_GDBM. Anything you set in
1776 &_Local/Makefile_&, however, overrides these system defaults.
1777
1778 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1779 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1780 in one of these lines:
1781 .code
1782 DBMLIB = -ldb
1783 DBMLIB = -ltdb
1784 .endd
1785 Settings like that will work if the DBM library is installed in the standard
1786 place. Sometimes it is not, and the library's header file may also not be in
1787 the default path. You may need to set INCLUDE to specify where the header
1788 file is, and to specify the path to the library more fully in DBMLIB, as in
1789 this example:
1790 .code
1791 INCLUDE=-I/usr/local/include/db-4.1
1792 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1793 .endd
1794 There is further detailed discussion about the various DBM libraries in the
1795 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1796
1797
1798
1799 .section "Pre-building configuration" "SECID25"
1800 .cindex "building Exim" "pre-building configuration"
1801 .cindex "configuration for building Exim"
1802 .cindex "&_Local/Makefile_&"
1803 .cindex "&_src/EDITME_&"
1804 Before building Exim, a local configuration file that specifies options
1805 independent of any operating system has to be created with the name
1806 &_Local/Makefile_&. A template for this file is supplied as the file
1807 &_src/EDITME_&, and it contains full descriptions of all the option settings
1808 therein. These descriptions are therefore not repeated here. If you are
1809 building Exim for the first time, the simplest thing to do is to copy
1810 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1811
1812 There are three settings that you must supply, because Exim will not build
1813 without them. They are the location of the run time configuration file
1814 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1815 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1816 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1817 a colon-separated list of file names; Exim uses the first of them that exists.
1818
1819 There are a few other parameters that can be specified either at build time or
1820 at run time, to enable the same binary to be used on a number of different
1821 machines. However, if the locations of Exim's spool directory and log file
1822 directory (if not within the spool directory) are fixed, it is recommended that
1823 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1824 detected early in Exim's execution (such as a malformed configuration file) can
1825 be logged.
1826
1827 .cindex "content scanning" "specifying at build time"
1828 Exim's interfaces for calling virus and spam scanning software directly from
1829 access control lists are not compiled by default. If you want to include these
1830 facilities, you need to set
1831 .code
1832 WITH_CONTENT_SCAN=yes
1833 .endd
1834 in your &_Local/Makefile_&. For details of the facilities themselves, see
1835 chapter &<<CHAPexiscan>>&.
1836
1837
1838 .cindex "&_Local/eximon.conf_&"
1839 .cindex "&_exim_monitor/EDITME_&"
1840 If you are going to build the Exim monitor, a similar configuration process is
1841 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1842 your installation and saved under the name &_Local/eximon.conf_&. If you are
1843 happy with the default settings described in &_exim_monitor/EDITME_&,
1844 &_Local/eximon.conf_& can be empty, but it must exist.
1845
1846 This is all the configuration that is needed in straightforward cases for known
1847 operating systems. However, the building process is set up so that it is easy
1848 to override options that are set by default or by operating-system-specific
1849 configuration files, for example to change the name of the C compiler, which
1850 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1851 do this.
1852
1853
1854
1855 .section "Support for iconv()" "SECID26"
1856 .cindex "&[iconv()]& support"
1857 .cindex "RFC 2047"
1858 The contents of header lines in messages may be encoded according to the rules
1859 described RFC 2047. This makes it possible to transmit characters that are not
1860 in the ASCII character set, and to label them as being in a particular
1861 character set. When Exim is inspecting header lines by means of the &%$h_%&
1862 mechanism, it decodes them, and translates them into a specified character set
1863 (default ISO-8859-1). The translation is possible only if the operating system
1864 supports the &[iconv()]& function.
1865
1866 However, some of the operating systems that supply &[iconv()]& do not support
1867 very many conversions. The GNU &%libiconv%& library (available from
1868 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1869 systems to remedy this deficiency, as well as on systems that do not supply
1870 &[iconv()]& at all. After installing &%libiconv%&, you should add
1871 .code
1872 HAVE_ICONV=yes
1873 .endd
1874 to your &_Local/Makefile_& and rebuild Exim.
1875
1876
1877
1878 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1879 .cindex "TLS" "including support for TLS"
1880 .cindex "encryption" "including support for"
1881 .cindex "SUPPORT_TLS"
1882 .cindex "OpenSSL" "building Exim with"
1883 .cindex "GnuTLS" "building Exim with"
1884 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1885 command as per RFC 2487. It can also support legacy clients that expect to
1886 start a TLS session immediately on connection to a non-standard port (see the
1887 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1888 line option).
1889
1890 If you want to build Exim with TLS support, you must first install either the
1891 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1892 implementing SSL.
1893
1894 If OpenSSL is installed, you should set
1895 .code
1896 SUPPORT_TLS=yes
1897 TLS_LIBS=-lssl -lcrypto
1898 .endd
1899 in &_Local/Makefile_&. You may also need to specify the locations of the
1900 OpenSSL library and include files. For example:
1901 .code
1902 SUPPORT_TLS=yes
1903 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1904 TLS_INCLUDE=-I/usr/local/openssl/include/
1905 .endd
1906 .cindex "pkg-config" "OpenSSL"
1907 If you have &'pkg-config'& available, then instead you can just use:
1908 .code
1909 SUPPORT_TLS=yes
1910 USE_OPENSSL_PC=openssl
1911 .endd
1912 .cindex "USE_GNUTLS"
1913 If GnuTLS is installed, you should set
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1918 .endd
1919 in &_Local/Makefile_&, and again you may need to specify the locations of the
1920 library and include files. For example:
1921 .code
1922 SUPPORT_TLS=yes
1923 USE_GNUTLS=yes
1924 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1925 TLS_INCLUDE=-I/usr/gnu/include
1926 .endd
1927 .cindex "pkg-config" "GnuTLS"
1928 If you have &'pkg-config'& available, then instead you can just use:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 USE_GNUTLS_PC=gnutls
1933 .endd
1934
1935 You do not need to set TLS_INCLUDE if the relevant directory is already
1936 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1937 given in chapter &<<CHAPTLS>>&.
1938
1939
1940
1941
1942 .section "Use of tcpwrappers" "SECID27"
1943
1944 .cindex "tcpwrappers, building Exim to support"
1945 .cindex "USE_TCP_WRAPPERS"
1946 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1947 .cindex "tcp_wrappers_daemon_name"
1948 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1949 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1950 alternative to Exim's own checking facilities for installations that are
1951 already making use of &'tcpwrappers'& for other purposes. To do this, you
1952 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1953 &_tcpd.h_& to be available at compile time, and also ensure that the library
1954 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1955 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1956 you might have
1957 .code
1958 USE_TCP_WRAPPERS=yes
1959 CFLAGS=-O -I/usr/local/include
1960 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1961 .endd
1962 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1963 files is &"exim"&. For example, the line
1964 .code
1965 exim : LOCAL  192.168.1.  .friendly.domain.example
1966 .endd
1967 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1968 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1969 All other connections are denied. The daemon name used by &'tcpwrappers'&
1970 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1971 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1972 configure file. Consult the &'tcpwrappers'& documentation for
1973 further details.
1974
1975
1976 .section "Including support for IPv6" "SECID28"
1977 .cindex "IPv6" "including support for"
1978 Exim contains code for use on systems that have IPv6 support. Setting
1979 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1980 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1981 where the IPv6 support is not fully integrated into the normal include and
1982 library files.
1983
1984 Two different types of DNS record for handling IPv6 addresses have been
1985 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1986 currently seen as the mainstream. Another record type called A6 was proposed
1987 as better than AAAA because it had more flexibility. However, it was felt to be
1988 over-complex, and its status was reduced to &"experimental"&. Exim used to
1989 have a compile option for including A6 record support but this has now been
1990 withdrawn.
1991
1992
1993
1994 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1995 .cindex "lookup modules"
1996 .cindex "dynamic modules"
1997 .cindex ".so building"
1998 On some platforms, Exim supports not compiling all lookup types directly into
1999 the main binary, instead putting some into external modules which can be loaded
2000 on demand.
2001 This permits packagers to build Exim with support for lookups with extensive
2002 library dependencies without requiring all users to install all of those
2003 dependencies.
2004 Most, but not all, lookup types can be built this way.
2005
2006 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2007 installed; Exim will only load modules from that directory, as a security
2008 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2009 for your OS; see &_OS/Makefile-Linux_& for an example.
2010 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2011 see &_src/EDITME_& for details.
2012
2013 Then, for each module to be loaded dynamically, define the relevant
2014 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2015 For example, this will build in lsearch but load sqlite and mysql support
2016 on demand:
2017 .code
2018 LOOKUP_LSEARCH=yes
2019 LOOKUP_SQLITE=2
2020 LOOKUP_MYSQL=2
2021 .endd
2022
2023
2024 .section "The building process" "SECID29"
2025 .cindex "build directory"
2026 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2027 created, run &'make'& at the top level. It determines the architecture and
2028 operating system types, and creates a build directory if one does not exist.
2029 For example, on a Sun system running Solaris 8, the directory
2030 &_build-SunOS5-5.8-sparc_& is created.
2031 .cindex "symbolic link" "to source files"
2032 Symbolic links to relevant source files are installed in the build directory.
2033
2034 &*Warning*&: The &%-j%& (parallel) flag must not be used with &'make'&; the
2035 building process fails if it is set.
2036
2037 If this is the first time &'make'& has been run, it calls a script that builds
2038 a make file inside the build directory, using the configuration files from the
2039 &_Local_& directory. The new make file is then passed to another instance of
2040 &'make'&. This does the real work, building a number of utility scripts, and
2041 then compiling and linking the binaries for the Exim monitor (if configured), a
2042 number of utility programs, and finally Exim itself. The command &`make
2043 makefile`& can be used to force a rebuild of the make file in the build
2044 directory, should this ever be necessary.
2045
2046 If you have problems building Exim, check for any comments there may be in the
2047 &_README_& file concerning your operating system, and also take a look at the
2048 FAQ, where some common problems are covered.
2049
2050
2051
2052 .section 'Output from &"make"&' "SECID283"
2053 The output produced by the &'make'& process for compile lines is often very
2054 unreadable, because these lines can be very long. For this reason, the normal
2055 output is suppressed by default, and instead output similar to that which
2056 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2057 each module that is being compiled or linked. However, it is still possible to
2058 get the full output, by calling &'make'& like this:
2059 .code
2060 FULLECHO='' make -e
2061 .endd
2062 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2063 command reflection in &'make'&. When you ask for the full output, it is
2064 given in addition to the short output.
2065
2066
2067
2068 .section "Overriding build-time options for Exim" "SECToverride"
2069 .cindex "build-time options, overriding"
2070 The main make file that is created at the beginning of the building process
2071 consists of the concatenation of a number of files which set configuration
2072 values, followed by a fixed set of &'make'& instructions. If a value is set
2073 more than once, the last setting overrides any previous ones. This provides a
2074 convenient way of overriding defaults. The files that are concatenated are, in
2075 order:
2076 .display
2077 &_OS/Makefile-Default_&
2078 &_OS/Makefile-_&<&'ostype'&>
2079 &_Local/Makefile_&
2080 &_Local/Makefile-_&<&'ostype'&>
2081 &_Local/Makefile-_&<&'archtype'&>
2082 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2083 &_OS/Makefile-Base_&
2084 .endd
2085 .cindex "&_Local/Makefile_&"
2086 .cindex "building Exim" "operating system type"
2087 .cindex "building Exim" "architecture type"
2088 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2089 architecture type. &_Local/Makefile_& is required to exist, and the building
2090 process fails if it is absent. The other three &_Local_& files are optional,
2091 and are often not needed.
2092
2093 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2094 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2095 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2096 values are used, thereby providing a means of forcing particular settings.
2097 Otherwise, the scripts try to get values from the &%uname%& command. If this
2098 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2099 of &'ad hoc'& transformations are then applied, to produce the standard names
2100 that Exim expects. You can run these scripts directly from the shell in order
2101 to find out what values are being used on your system.
2102
2103
2104 &_OS/Makefile-Default_& contains comments about the variables that are set
2105 therein. Some (but not all) are mentioned below. If there is something that
2106 needs changing, review the contents of this file and the contents of the make
2107 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2108 default values are.
2109
2110
2111 .cindex "building Exim" "overriding default settings"
2112 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2113 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2114 need to change the original files. Instead, you should make the changes by
2115 putting the new values in an appropriate &_Local_& file. For example,
2116 .cindex "Tru64-Unix build-time settings"
2117 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2118 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2119 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2120 called with the option &%-std1%&, to make it recognize some of the features of
2121 Standard C that Exim uses. (Most other compilers recognize Standard C by
2122 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2123 containing the lines
2124 .code
2125 CC=cc
2126 CFLAGS=-std1
2127 .endd
2128 If you are compiling for just one operating system, it may be easier to put
2129 these lines directly into &_Local/Makefile_&.
2130
2131 Keeping all your local configuration settings separate from the distributed
2132 files makes it easy to transfer them to new versions of Exim simply by copying
2133 the contents of the &_Local_& directory.
2134
2135
2136 .cindex "NIS lookup type" "including support for"
2137 .cindex "NIS+ lookup type" "including support for"
2138 .cindex "LDAP" "including support for"
2139 .cindex "lookup" "inclusion in binary"
2140 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2141 lookup, but not all systems have these components installed, so the default is
2142 not to include the relevant code in the binary. All the different kinds of file
2143 and database lookup that Exim supports are implemented as separate code modules
2144 which are included only if the relevant compile-time options are set. In the
2145 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2146 .code
2147 LOOKUP_LDAP=yes
2148 LOOKUP_NIS=yes
2149 LOOKUP_NISPLUS=yes
2150 .endd
2151 and similar settings apply to the other lookup types. They are all listed in
2152 &_src/EDITME_&. In many cases the relevant include files and interface
2153 libraries need to be installed before compiling Exim.
2154 .cindex "cdb" "including support for"
2155 However, there are some optional lookup types (such as cdb) for which
2156 the code is entirely contained within Exim, and no external include
2157 files or libraries are required. When a lookup type is not included in the
2158 binary, attempts to configure Exim to use it cause run time configuration
2159 errors.
2160
2161 .cindex "pkg-config" "lookups"
2162 .cindex "pkg-config" "authenticators"
2163 Many systems now use a tool called &'pkg-config'& to encapsulate information
2164 about how to compile against a library; Exim has some initial support for
2165 being able to use pkg-config for lookups and authenticators.  For any given
2166 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2167 variable with the &`_PC`& suffix in the name and assign as the value the
2168 name of the package to be queried.  The results of querying via the
2169 &'pkg-config'& command will be added to the appropriate Makefile variables
2170 with &`+=`& directives, so your version of &'make'& will need to support that
2171 syntax.  For instance:
2172 .code
2173 LOOKUP_SQLITE=yes
2174 LOOKUP_SQLITE_PC=sqlite3
2175 AUTH_GSASL=yes
2176 AUTH_GSASL_PC=libgsasl
2177 AUTH_HEIMDAL_GSSAPI=yes
2178 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2179 .endd
2180
2181 .cindex "Perl" "including support for"
2182 Exim can be linked with an embedded Perl interpreter, allowing Perl
2183 subroutines to be called during string expansion. To enable this facility,
2184 .code
2185 EXIM_PERL=perl.o
2186 .endd
2187 must be defined in &_Local/Makefile_&. Details of this facility are given in
2188 chapter &<<CHAPperl>>&.
2189
2190 .cindex "X11 libraries, location of"
2191 The location of the X11 libraries is something that varies a lot between
2192 operating systems, and there may be different versions of X11 to cope
2193 with. Exim itself makes no use of X11, but if you are compiling the Exim
2194 monitor, the X11 libraries must be available.
2195 The following three variables are set in &_OS/Makefile-Default_&:
2196 .code
2197 X11=/usr/X11R6
2198 XINCLUDE=-I$(X11)/include
2199 XLFLAGS=-L$(X11)/lib
2200 .endd
2201 These are overridden in some of the operating-system configuration files. For
2202 example, in &_OS/Makefile-SunOS5_& there is
2203 .code
2204 X11=/usr/openwin
2205 XINCLUDE=-I$(X11)/include
2206 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2207 .endd
2208 If you need to override the default setting for your operating system, place a
2209 definition of all three of these variables into your
2210 &_Local/Makefile-<ostype>_& file.
2211
2212 .cindex "EXTRALIBS"
2213 If you need to add any extra libraries to the link steps, these can be put in a
2214 variable called EXTRALIBS, which appears in all the link commands, but by
2215 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2216 command for linking the main Exim binary, and not for any associated utilities.
2217
2218 .cindex "DBM libraries" "configuration for building"
2219 There is also DBMLIB, which appears in the link commands for binaries that
2220 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2221 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2222 binary, and which can be used, for example, to include additional X11
2223 libraries.
2224
2225 .cindex "configuration file" "editing"
2226 The make file copes with rebuilding Exim correctly if any of the configuration
2227 files are edited. However, if an optional configuration file is deleted, it is
2228 necessary to touch the associated non-optional file (that is,
2229 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2230
2231
2232 .section "OS-specific header files" "SECID30"
2233 .cindex "&_os.h_&"
2234 .cindex "building Exim" "OS-specific C header files"
2235 The &_OS_& directory contains a number of files with names of the form
2236 &_os.h-<ostype>_&. These are system-specific C header files that should not
2237 normally need to be changed. There is a list of macro settings that are
2238 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2239 are porting Exim to a new operating system.
2240
2241
2242
2243 .section "Overriding build-time options for the monitor" "SECID31"
2244 .cindex "building Eximon"
2245 A similar process is used for overriding things when building the Exim monitor,
2246 where the files that are involved are
2247 .display
2248 &_OS/eximon.conf-Default_&
2249 &_OS/eximon.conf-_&<&'ostype'&>
2250 &_Local/eximon.conf_&
2251 &_Local/eximon.conf-_&<&'ostype'&>
2252 &_Local/eximon.conf-_&<&'archtype'&>
2253 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2254 .endd
2255 .cindex "&_Local/eximon.conf_&"
2256 As with Exim itself, the final three files need not exist, and in this case the
2257 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2258 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2259 variables of the same name, preceded by EXIMON_. For example, setting
2260 EXIMON_LOG_DEPTH in the environment overrides the value of
2261 LOG_DEPTH at run time.
2262 .ecindex IIDbuex
2263
2264
2265 .section "Installing Exim binaries and scripts" "SECID32"
2266 .cindex "installing Exim"
2267 .cindex "BIN_DIRECTORY"
2268 The command &`make install`& runs the &(exim_install)& script with no
2269 arguments. The script copies binaries and utility scripts into the directory
2270 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2271 .cindex "setuid" "installing Exim with"
2272 The install script copies files only if they are newer than the files they are
2273 going to replace. The Exim binary is required to be owned by root and have the
2274 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2275 install`& as root so that it can set up the Exim binary in this way. However, in
2276 some special situations (for example, if a host is doing no local deliveries)
2277 it may be possible to run Exim without making the binary setuid root (see
2278 chapter &<<CHAPsecurity>>& for details).
2279
2280 .cindex "CONFIGURE_FILE"
2281 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2282 in &_Local/Makefile_&. If this names a single file, and the file does not
2283 exist, the default configuration file &_src/configure.default_& is copied there
2284 by the installation script. If a run time configuration file already exists, it
2285 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2286 alternative files, no default is installed.
2287
2288 .cindex "system aliases file"
2289 .cindex "&_/etc/aliases_&"
2290 One change is made to the default configuration file when it is installed: the
2291 default configuration contains a router that references a system aliases file.
2292 The path to this file is set to the value specified by
2293 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2294 If the system aliases file does not exist, the installation script creates it,
2295 and outputs a comment to the user.
2296
2297 The created file contains no aliases, but it does contain comments about the
2298 aliases a site should normally have. Mail aliases have traditionally been
2299 kept in &_/etc/aliases_&. However, some operating systems are now using
2300 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2301 Exim's configuration if necessary.
2302
2303 The default configuration uses the local host's name as the only local domain,
2304 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2305 running as the local user. System aliases and &_.forward_& files in users' home
2306 directories are supported, but no NIS or NIS+ support is configured. Domains
2307 other than the name of the local host are routed using the DNS, with delivery
2308 over SMTP.
2309
2310 It is possible to install Exim for special purposes (such as building a binary
2311 distribution) in a private part of the file system. You can do this by a
2312 command such as
2313 .code
2314 make DESTDIR=/some/directory/ install
2315 .endd
2316 This has the effect of pre-pending the specified directory to all the file
2317 paths, except the name of the system aliases file that appears in the default
2318 configuration. (If a default alias file is created, its name &'is'& modified.)
2319 For backwards compatibility, ROOT is used if DESTDIR is not set,
2320 but this usage is deprecated.
2321
2322 .cindex "installing Exim" "what is not installed"
2323 Running &'make install'& does not copy the Exim 4 conversion script
2324 &'convert4r4'&. You will probably run this only once if you are
2325 upgrading from Exim 3. None of the documentation files in the &_doc_&
2326 directory are copied, except for the info files when you have set
2327 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2328
2329 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2330 to their names. The Exim binary itself, however, is handled differently. It is
2331 installed under a name that includes the version number and the compile number,
2332 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2333 called &_exim_& to point to the binary. If you are updating a previous version
2334 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2335 from the directory (as seen by other processes).
2336
2337 .cindex "installing Exim" "testing the script"
2338 If you want to see what the &'make install'& will do before running it for
2339 real, you can pass the &%-n%& option to the installation script by this
2340 command:
2341 .code
2342 make INSTALL_ARG=-n install
2343 .endd
2344 The contents of the variable INSTALL_ARG are passed to the installation
2345 script. You do not need to be root to run this test. Alternatively, you can run
2346 the installation script directly, but this must be from within the build
2347 directory. For example, from the top-level Exim directory you could use this
2348 command:
2349 .code
2350 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2351 .endd
2352 .cindex "installing Exim" "install script options"
2353 There are two other options that can be supplied to the installation script.
2354
2355 .ilist
2356 &%-no_chown%& bypasses the call to change the owner of the installed binary
2357 to root, and the call to make it a setuid binary.
2358 .next
2359 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2360 installed binary.
2361 .endlist
2362
2363 INSTALL_ARG can be used to pass these options to the script. For example:
2364 .code
2365 make INSTALL_ARG=-no_symlink install
2366 .endd
2367 The installation script can also be given arguments specifying which files are
2368 to be copied. For example, to install just the Exim binary, and nothing else,
2369 without creating the symbolic link, you could use:
2370 .code
2371 make INSTALL_ARG='-no_symlink exim' install
2372 .endd
2373
2374
2375
2376 .section "Installing info documentation" "SECTinsinfdoc"
2377 .cindex "installing Exim" "&'info'& documentation"
2378 Not all systems use the GNU &'info'& system for documentation, and for this
2379 reason, the Texinfo source of Exim's documentation is not included in the main
2380 distribution. Instead it is available separately from the ftp site (see section
2381 &<<SECTavail>>&).
2382
2383 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2384 source of the documentation is found in the source tree, running &`make
2385 install`& automatically builds the info files and installs them.
2386
2387
2388
2389 .section "Setting up the spool directory" "SECID33"
2390 .cindex "spool directory" "creating"
2391 When it starts up, Exim tries to create its spool directory if it does not
2392 exist. The Exim uid and gid are used for the owner and group of the spool
2393 directory. Sub-directories are automatically created in the spool directory as
2394 necessary.
2395
2396
2397
2398
2399 .section "Testing" "SECID34"
2400 .cindex "testing" "installation"
2401 Having installed Exim, you can check that the run time configuration file is
2402 syntactically valid by running the following command, which assumes that the
2403 Exim binary directory is within your PATH environment variable:
2404 .code
2405 exim -bV
2406 .endd
2407 If there are any errors in the configuration file, Exim outputs error messages.
2408 Otherwise it outputs the version number and build date,
2409 the DBM library that is being used, and information about which drivers and
2410 other optional code modules are included in the binary.
2411 Some simple routing tests can be done by using the address testing option. For
2412 example,
2413 .display
2414 &`exim -bt`& <&'local username'&>
2415 .endd
2416 should verify that it recognizes a local mailbox, and
2417 .display
2418 &`exim -bt`& <&'remote address'&>
2419 .endd
2420 a remote one. Then try getting it to deliver mail, both locally and remotely.
2421 This can be done by passing messages directly to Exim, without going through a
2422 user agent. For example:
2423 .code
2424 exim -v postmaster@your.domain.example
2425 From: user@your.domain.example
2426 To: postmaster@your.domain.example
2427 Subject: Testing Exim
2428
2429 This is a test message.
2430 ^D
2431 .endd
2432 The &%-v%& option causes Exim to output some verification of what it is doing.
2433 In this case you should see copies of three log lines, one for the message's
2434 arrival, one for its delivery, and one containing &"Completed"&.
2435
2436 .cindex "delivery" "problems with"
2437 If you encounter problems, look at Exim's log files (&'mainlog'& and
2438 &'paniclog'&) to see if there is any relevant information there. Another source
2439 of information is running Exim with debugging turned on, by specifying the
2440 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2441 with debugging turned on by a command of the form
2442 .display
2443 &`exim -d -M`& <&'exim-message-id'&>
2444 .endd
2445 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2446 produces rather a lot of output, but you can cut this down to specific areas.
2447 For example, if you use &%-d-all+route%& only the debugging information
2448 relevant to routing is included. (See the &%-d%& option in chapter
2449 &<<CHAPcommandline>>& for more details.)
2450
2451 .cindex '&"sticky"& bit'
2452 .cindex "lock files"
2453 One specific problem that has shown up on some sites is the inability to do
2454 local deliveries into a shared mailbox directory, because it does not have the
2455 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2456 writing to a mailbox file, and if it cannot create the lock file, the delivery
2457 is deferred. You can get round this either by setting the &"sticky bit"& on the
2458 directory, or by setting a specific group for local deliveries and allowing
2459 that group to create files in the directory (see the comments above the
2460 &(local_delivery)& transport in the default configuration file). Another
2461 approach is to configure Exim not to use lock files, but just to rely on
2462 &[fcntl()]& locking instead. However, you should do this only if all user
2463 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2464 see chapter &<<CHAPappendfile>>&.
2465
2466 One thing that cannot be tested on a system that is already running an MTA is
2467 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2468 &%-oX%& option can be used to run an Exim daemon that listens on some other
2469 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2470 &'exim_checkaccess'& utility can be used to check out policy controls on
2471 incoming SMTP mail.
2472
2473 Testing a new version on a system that is already running Exim can most easily
2474 be done by building a binary with a different CONFIGURE_FILE setting. From
2475 within the run time configuration, all other file and directory names
2476 that Exim uses can be altered, in order to keep it entirely clear of the
2477 production version.
2478
2479
2480 .section "Replacing another MTA with Exim" "SECID35"
2481 .cindex "replacing another MTA"
2482 Building and installing Exim for the first time does not of itself put it in
2483 general use. The name by which the system's MTA is called by mail user agents
2484 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2485 operating system), and it is necessary to make this name point to the &'exim'&
2486 binary in order to get the user agents to pass messages to Exim. This is
2487 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2488 or &_/usr/lib/sendmail_&
2489 .cindex "symbolic link" "to &'exim'& binary"
2490 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2491 privilege and executable status from the old MTA. It is then necessary to stop
2492 and restart the mailer daemon, if one is running.
2493
2494 .cindex "FreeBSD, MTA indirection"
2495 .cindex "&_/etc/mail/mailer.conf_&"
2496 Some operating systems have introduced alternative ways of switching MTAs. For
2497 example, if you are running FreeBSD, you need to edit the file
2498 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2499 described. A typical example of the contents of this file for running Exim is
2500 as follows:
2501 .code
2502 sendmail            /usr/exim/bin/exim
2503 send-mail           /usr/exim/bin/exim
2504 mailq               /usr/exim/bin/exim -bp
2505 newaliases          /usr/bin/true
2506 .endd
2507 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2508 your Exim installation is &"live"&. Check it by sending a message from your
2509 favourite user agent.
2510
2511 You should consider what to tell your users about the change of MTA. Exim may
2512 have different capabilities to what was previously running, and there are
2513 various operational differences such as the text of messages produced by
2514 command line options and in bounce messages. If you allow your users to make
2515 use of Exim's filtering capabilities, you should make the document entitled
2516 &'Exim's interface to mail filtering'& available to them.
2517
2518
2519
2520 .section "Upgrading Exim" "SECID36"
2521 .cindex "upgrading Exim"
2522 If you are already running Exim on your host, building and installing a new
2523 version automatically makes it available to MUAs, or any other programs that
2524 call the MTA directly. However, if you are running an Exim daemon, you do need
2525 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2526 new binary. You do not need to stop processing mail in order to install a new
2527 version of Exim. The install script does not modify an existing runtime
2528 configuration file.
2529
2530
2531
2532
2533 .section "Stopping the Exim daemon on Solaris" "SECID37"
2534 .cindex "Solaris" "stopping Exim on"
2535 The standard command for stopping the mailer daemon on Solaris is
2536 .code
2537 /etc/init.d/sendmail stop
2538 .endd
2539 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2540 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2541 for the text &"sendmail"&; this is not present because the actual program name
2542 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2543 solution is to replace the line that finds the process id with something like
2544 .code
2545 pid=`cat /var/spool/exim/exim-daemon.pid`
2546 .endd
2547 to obtain the daemon's pid directly from the file that Exim saves it in.
2548
2549 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2550 still be received from local processes, and if automatic delivery is configured
2551 (the normal case), deliveries will still occur.
2552
2553
2554
2555
2556 . ////////////////////////////////////////////////////////////////////////////
2557 . ////////////////////////////////////////////////////////////////////////////
2558
2559 .chapter "The Exim command line" "CHAPcommandline"
2560 .scindex IIDclo1 "command line" "options"
2561 .scindex IIDclo2 "options" "command line"
2562 Exim's command line takes the standard Unix form of a sequence of options,
2563 each starting with a hyphen character, followed by a number of arguments. The
2564 options are compatible with the main options of Sendmail, and there are also
2565 some additional options, some of which are compatible with Smail 3. Certain
2566 combinations of options do not make sense, and provoke an error if used.
2567 The form of the arguments depends on which options are set.
2568
2569
2570 .section "Setting options by program name" "SECID38"
2571 .cindex "&'mailq'&"
2572 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2573 were present before any other options.
2574 The &%-bp%& option requests a listing of the contents of the mail queue on the
2575 standard output.
2576 This feature is for compatibility with some systems that contain a command of
2577 that name in one of the standard libraries, symbolically linked to
2578 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2579
2580 .cindex "&'rsmtp'&"
2581 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2582 were present before any other options, for compatibility with Smail. The
2583 &%-bS%& option is used for reading in a number of messages in batched SMTP
2584 format.
2585
2586 .cindex "&'rmail'&"
2587 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2588 &%-oee%& options were present before any other options, for compatibility with
2589 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2590
2591 .cindex "&'runq'&"
2592 .cindex "queue runner"
2593 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2594 were present before any other options, for compatibility with Smail. The &%-q%&
2595 option causes a single queue runner process to be started.
2596
2597 .cindex "&'newaliases'&"
2598 .cindex "alias file" "building"
2599 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2600 If Exim is called under the name &'newaliases'& it behaves as if the option
2601 &%-bi%& were present before any other options, for compatibility with Sendmail.
2602 This option is used for rebuilding Sendmail's alias file. Exim does not have
2603 the concept of a single alias file, but can be configured to run a given
2604 command if called with the &%-bi%& option.
2605
2606
2607 .section "Trusted and admin users" "SECTtrustedadmin"
2608 Some Exim options are available only to &'trusted users'& and others are
2609 available only to &'admin users'&. In the description below, the phrases &"Exim
2610 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2611 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2612 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2613
2614 .ilist
2615 .cindex "trusted users" "definition of"
2616 .cindex "user" "trusted definition of"
2617 The trusted users are root, the Exim user, any user listed in the
2618 &%trusted_users%& configuration option, and any user whose current group or any
2619 supplementary group is one of those listed in the &%trusted_groups%&
2620 configuration option. Note that the Exim group is not automatically trusted.
2621
2622 .cindex '&"From"& line'
2623 .cindex "envelope sender"
2624 Trusted users are always permitted to use the &%-f%& option or a leading
2625 &"From&~"& line to specify the envelope sender of a message that is passed to
2626 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2627 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2628 users to set envelope senders.
2629
2630 .cindex "&'From:'& header line"
2631 .cindex "&'Sender:'& header line"
2632 For a trusted user, there is never any check on the contents of the &'From:'&
2633 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2634 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2635
2636 Trusted users may also specify a host name, host address, interface address,
2637 protocol name, ident value, and authentication data when submitting a message
2638 locally. Thus, they are able to insert messages into Exim's queue locally that
2639 have the characteristics of messages received from a remote host. Untrusted
2640 users may in some circumstances use &%-f%&, but can never set the other values
2641 that are available to trusted users.
2642 .next
2643 .cindex "user" "admin definition of"
2644 .cindex "admin user" "definition of"
2645 The admin users are root, the Exim user, and any user that is a member of the
2646 Exim group or of any group listed in the &%admin_groups%& configuration option.
2647 The current group does not have to be one of these groups.
2648
2649 Admin users are permitted to list the queue, and to carry out certain
2650 operations on messages, for example, to force delivery failures. It is also
2651 necessary to be an admin user in order to see the full information provided by
2652 the Exim monitor, and full debugging output.
2653
2654 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2655 Exim to attempt delivery of messages on its queue is restricted to admin users.
2656 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2657 option false (that is, specifying &%no_prod_requires_admin%&).
2658
2659 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2660 is restricted to admin users unless &%queue_list_requires_admin%& is set
2661 false.
2662 .endlist
2663
2664
2665 &*Warning*&: If you configure your system so that admin users are able to
2666 edit Exim's configuration file, you are giving those users an easy way of
2667 getting root. There is further discussion of this issue at the start of chapter
2668 &<<CHAPconf>>&.
2669
2670
2671
2672
2673 .section "Command line options" "SECID39"
2674 Exim's command line options are described in alphabetical order below. If none
2675 of the options that specifies a specific action (such as starting the daemon or
2676 a queue runner, or testing an address, or receiving a message in a specific
2677 format, or listing the queue) are present, and there is at least one argument
2678 on the command line, &%-bm%& (accept a local message on the standard input,
2679 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2680 outputs a brief message about itself and exits.
2681
2682 . ////////////////////////////////////////////////////////////////////////////
2683 . Insert a stylized XML comment here, to identify the start of the command line
2684 . options. This is for the benefit of the Perl script that automatically
2685 . creates a man page for the options.
2686 . ////////////////////////////////////////////////////////////////////////////
2687
2688 .literal xml
2689 <!-- === Start of command line options === -->
2690 .literal off
2691
2692
2693 .vlist
2694 .vitem &%--%&
2695 .oindex "--"
2696 .cindex "options" "command line; terminating"
2697 This is a pseudo-option whose only purpose is to terminate the options and
2698 therefore to cause subsequent command line items to be treated as arguments
2699 rather than options, even if they begin with hyphens.
2700
2701 .vitem &%--help%&
2702 .oindex "&%--help%&"
2703 This option causes Exim to output a few sentences stating what it is.
2704 The same output is generated if the Exim binary is called with no options and
2705 no arguments.
2706
2707 .vitem &%--version%&
2708 .oindex "&%--version%&"
2709 This option is an alias for &%-bV%& and causes version information to be
2710 displayed.
2711
2712 .vitem &%-Ac%& &&&
2713        &%-Am%&
2714 .oindex "&%-Ac%&"
2715 .oindex "&%-Am%&"
2716 These options are used by Sendmail for selecting configuration files and are
2717 ignored by Exim.
2718
2719 .vitem &%-B%&<&'type'&>
2720 .oindex "&%-B%&"
2721 .cindex "8-bit characters"
2722 .cindex "Sendmail compatibility" "8-bit characters"
2723 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2724 clean; it ignores this option.
2725
2726 .vitem &%-bd%&
2727 .oindex "&%-bd%&"
2728 .cindex "daemon"
2729 .cindex "SMTP" "listener"
2730 .cindex "queue runner"
2731 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2732 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2733 that the daemon should also initiate periodic queue runs.
2734
2735 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2736 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2737 disconnect from the controlling terminal. When running this way, it can be
2738 stopped by pressing ctrl-C.
2739
2740 By default, Exim listens for incoming connections to the standard SMTP port on
2741 all the host's running interfaces. However, it is possible to listen on other
2742 ports, on multiple ports, and only on specific interfaces. Chapter
2743 &<<CHAPinterfaces>>& contains a description of the options that control this.
2744
2745 When a listening daemon
2746 .cindex "daemon" "process id (pid)"
2747 .cindex "pid (process id)" "of daemon"
2748 is started without the use of &%-oX%& (that is, without overriding the normal
2749 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2750 in Exim's spool directory. This location can be overridden by setting
2751 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2752 running as root.
2753
2754 When &%-oX%& is used on the command line to start a listening daemon, the
2755 process id is not written to the normal pid file path. However, &%-oP%& can be
2756 used to specify a path on the command line if a pid file is required.
2757
2758 The SIGHUP signal
2759 .cindex "SIGHUP"
2760 .cindex "daemon" "restarting"
2761 can be used to cause the daemon to re-execute itself. This should be done
2762 whenever Exim's configuration file, or any file that is incorporated into it by
2763 means of the &%.include%& facility, is changed, and also whenever a new version
2764 of Exim is installed. It is not necessary to do this when other files that are
2765 referenced from the configuration (for example, alias files) are changed,
2766 because these are reread each time they are used.
2767
2768 .vitem &%-bdf%&
2769 .oindex "&%-bdf%&"
2770 This option has the same effect as &%-bd%& except that it never disconnects
2771 from the controlling terminal, even when no debugging is specified.
2772
2773 .vitem &%-be%&
2774 .oindex "&%-be%&"
2775 .cindex "testing" "string expansion"
2776 .cindex "expansion" "testing"
2777 Run Exim in expansion testing mode. Exim discards its root privilege, to
2778 prevent ordinary users from using this mode to read otherwise inaccessible
2779 files. If no arguments are given, Exim runs interactively, prompting for lines
2780 of data. Otherwise, it processes each argument in turn.
2781
2782 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2783 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2784 used without command line arguments. If successful, it uses the &[readline()]&
2785 function, which provides extensive line-editing facilities, for reading the
2786 test data. A line history is supported.
2787
2788 Long expansion expressions can be split over several lines by using backslash
2789 continuations. As in Exim's run time configuration, white space at the start of
2790 continuation lines is ignored. Each argument or data line is passed through the
2791 string expansion mechanism, and the result is output. Variable values from the
2792 configuration file (for example, &$qualify_domain$&) are available, but no
2793 message-specific values (such as &$sender_domain$&) are set, because no message
2794 is being processed (but see &%-bem%& and &%-Mset%&).
2795
2796 &*Note*&: If you use this mechanism to test lookups, and you change the data
2797 files or databases you are using, you must exit and restart Exim before trying
2798 the same lookup again. Otherwise, because each Exim process caches the results
2799 of lookups, you will just get the same result as before.
2800
2801 .vitem &%-bem%&&~<&'filename'&>
2802 .oindex "&%-bem%&"
2803 .cindex "testing" "string expansion"
2804 .cindex "expansion" "testing"
2805 This option operates like &%-be%& except that it must be followed by the name
2806 of a file. For example:
2807 .code
2808 exim -bem /tmp/testmessage
2809 .endd
2810 The file is read as a message (as if receiving a locally-submitted non-SMTP
2811 message) before any of the test expansions are done. Thus, message-specific
2812 variables such as &$message_size$& and &$header_from:$& are available. However,
2813 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2814 recipients are read from the headers in the normal way, and are shown in the
2815 &$recipients$& variable. Note that recipients cannot be given on the command
2816 line, because further arguments are taken as strings to expand (just like
2817 &%-be%&).
2818
2819 .vitem &%-bF%&&~<&'filename'&>
2820 .oindex "&%-bF%&"
2821 .cindex "system filter" "testing"
2822 .cindex "testing" "system filter"
2823 This option is the same as &%-bf%& except that it assumes that the filter being
2824 tested is a system filter. The additional commands that are available only in
2825 system filters are recognized.
2826
2827 .vitem &%-bf%&&~<&'filename'&>
2828 .oindex "&%-bf%&"
2829 .cindex "filter" "testing"
2830 .cindex "testing" "filter file"
2831 .cindex "forward file" "testing"
2832 .cindex "testing" "forward file"
2833 .cindex "Sieve filter" "testing"
2834 This option runs Exim in user filter testing mode; the file is the filter file
2835 to be tested, and a test message must be supplied on the standard input. If
2836 there are no message-dependent tests in the filter, an empty file can be
2837 supplied.
2838
2839 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2840 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2841 filter and a user filter in the same run. For example:
2842 .code
2843 exim -bF /system/filter -bf /user/filter </test/message
2844 .endd
2845 This is helpful when the system filter adds header lines or sets filter
2846 variables that are used by the user filter.
2847
2848 If the test filter file does not begin with one of the special lines
2849 .code
2850 # Exim filter
2851 # Sieve filter
2852 .endd
2853 it is taken to be a normal &_.forward_& file, and is tested for validity under
2854 that interpretation. See sections &<<SECTitenonfilred>>& to
2855 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2856 redirection lists.
2857
2858 The result of an Exim command that uses &%-bf%&, provided no errors are
2859 detected, is a list of the actions that Exim would try to take if presented
2860 with the message for real. More details of filter testing are given in the
2861 separate document entitled &'Exim's interfaces to mail filtering'&.
2862
2863 When testing a filter file,
2864 .cindex "&""From""& line"
2865 .cindex "envelope sender"
2866 .oindex "&%-f%&" "for filter testing"
2867 the envelope sender can be set by the &%-f%& option,
2868 or by a &"From&~"& line at the start of the test message. Various parameters
2869 that would normally be taken from the envelope recipient address of the message
2870 can be set by means of additional command line options (see the next four
2871 options).
2872
2873 .vitem &%-bfd%&&~<&'domain'&>
2874 .oindex "&%-bfd%&"
2875 .vindex "&$qualify_domain$&"
2876 This sets the domain of the recipient address when a filter file is being
2877 tested by means of the &%-bf%& option. The default is the value of
2878 &$qualify_domain$&.
2879
2880 .vitem &%-bfl%&&~<&'local&~part'&>
2881 .oindex "&%-bfl%&"
2882 This sets the local part of the recipient address when a filter file is being
2883 tested by means of the &%-bf%& option. The default is the username of the
2884 process that calls Exim. A local part should be specified with any prefix or
2885 suffix stripped, because that is how it appears to the filter when a message is
2886 actually being delivered.
2887
2888 .vitem &%-bfp%&&~<&'prefix'&>
2889 .oindex "&%-bfp%&"
2890 This sets the prefix of the local part of the recipient address when a filter
2891 file is being tested by means of the &%-bf%& option. The default is an empty
2892 prefix.
2893
2894 .vitem &%-bfs%&&~<&'suffix'&>
2895 .oindex "&%-bfs%&"
2896 This sets the suffix of the local part of the recipient address when a filter
2897 file is being tested by means of the &%-bf%& option. The default is an empty
2898 suffix.
2899
2900 .vitem &%-bh%&&~<&'IP&~address'&>
2901 .oindex "&%-bh%&"
2902 .cindex "testing" "incoming SMTP"
2903 .cindex "SMTP" "testing incoming"
2904 .cindex "testing" "relay control"
2905 .cindex "relaying" "testing configuration"
2906 .cindex "policy control" "testing"
2907 .cindex "debugging" "&%-bh%& option"
2908 This option runs a fake SMTP session as if from the given IP address, using the
2909 standard input and output. The IP address may include a port number at the end,
2910 after a full stop. For example:
2911 .code
2912 exim -bh 10.9.8.7.1234
2913 exim -bh fe80::a00:20ff:fe86:a061.5678
2914 .endd
2915 When an IPv6 address is given, it is converted into canonical form. In the case
2916 of the second example above, the value of &$sender_host_address$& after
2917 conversion to the canonical form is
2918 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2919
2920 Comments as to what is going on are written to the standard error file. These
2921 include lines beginning with &"LOG"& for anything that would have been logged.
2922 This facility is provided for testing configuration options for incoming
2923 messages, to make sure they implement the required policy. For example, you can
2924 test your relay controls using &%-bh%&.
2925
2926 &*Warning 1*&:
2927 .cindex "RFC 1413"
2928 You can test features of the configuration that rely on ident (RFC 1413)
2929 information by using the &%-oMt%& option. However, Exim cannot actually perform
2930 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2931 connection.
2932
2933 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2934 are also skipped when testing using &%-bh%&. If you want these callouts to
2935 occur, use &%-bhc%& instead.
2936
2937 Messages supplied during the testing session are discarded, and nothing is
2938 written to any of the real log files. There may be pauses when DNS (and other)
2939 lookups are taking place, and of course these may time out. The &%-oMi%& option
2940 can be used to specify a specific IP interface and port if this is important,
2941 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2942 session were authenticated.
2943
2944 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2945 output just states whether a given recipient address from a given host is
2946 acceptable or not. See section &<<SECTcheckaccess>>&.
2947
2948 Features such as authentication and encryption, where the client input is not
2949 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2950 specialized SMTP test program such as
2951 &url(http://jetmore.org/john/code/#swaks,swaks).
2952
2953 .vitem &%-bhc%&&~<&'IP&~address'&>
2954 .oindex "&%-bhc%&"
2955 This option operates in the same way as &%-bh%&, except that address
2956 verification callouts are performed if required. This includes consulting and
2957 updating the callout cache database.
2958
2959 .vitem &%-bi%&
2960 .oindex "&%-bi%&"
2961 .cindex "alias file" "building"
2962 .cindex "building alias file"
2963 .cindex "Sendmail compatibility" "&%-bi%& option"
2964 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2965 Exim does not have the concept of a single alias file, and so it cannot mimic
2966 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2967 tend to appear in various scripts such as NIS make files, so the option must be
2968 recognized.
2969
2970 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2971 configuration option is run, under the uid and gid of the caller of Exim. If
2972 the &%-oA%& option is used, its value is passed to the command as an argument.
2973 The command set by &%bi_command%& may not contain arguments. The command can
2974 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2975 if this is required. If the &%bi_command%& option is not set, calling Exim with
2976 &%-bi%& is a no-op.
2977
2978 . // Keep :help first, then the rest in alphabetical order
2979 .vitem &%-bI:help%&
2980 .oindex "&%-bI:help%&"
2981 .cindex "querying exim information"
2982 We shall provide various options starting &`-bI:`& for querying Exim for
2983 information.  The output of many of these will be intended for machine
2984 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2985 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2986 options shall cause Exim to exit after producing the requested output.
2987
2988 .vitem &%-bI:dscp%&
2989 .oindex "&%-bI:dscp%&"
2990 .cindex "DSCP" "values"
2991 This option causes Exim to emit an alphabetically sorted list of all
2992 recognised DSCP names.
2993
2994 .vitem &%-bI:sieve%&
2995 .oindex "&%-bI:sieve%&"
2996 .cindex "Sieve filter" "capabilities"
2997 This option causes Exim to emit an alphabetically sorted list of all supported
2998 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2999 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3000 &`SIEVE`& capability response line.  As the precise list may depend upon
3001 compile-time build options, which this option will adapt to, this is the only
3002 way to guarantee a correct response.
3003
3004 .vitem &%-bm%&
3005 .oindex "&%-bm%&"
3006 .cindex "local message reception"
3007 This option runs an Exim receiving process that accepts an incoming,
3008 locally-generated message on the standard input. The recipients are given as the
3009 command arguments (except when &%-t%& is also present &-- see below). Each
3010 argument can be a comma-separated list of RFC 2822 addresses. This is the
3011 default option for selecting the overall action of an Exim call; it is assumed
3012 if no other conflicting option is present.
3013
3014 If any addresses in the message are unqualified (have no domain), they are
3015 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3016 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3017 suppressing this for special cases.
3018
3019 Policy checks on the contents of local messages can be enforced by means of
3020 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3021
3022 .cindex "return code" "for &%-bm%&"
3023 The return code is zero if the message is successfully accepted. Otherwise, the
3024 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3025
3026 The format
3027 .cindex "message" "format"
3028 .cindex "format" "message"
3029 .cindex "&""From""& line"
3030 .cindex "UUCP" "&""From""& line"
3031 .cindex "Sendmail compatibility" "&""From""& line"
3032 of the message must be as defined in RFC 2822, except that, for
3033 compatibility with Sendmail and Smail, a line in one of the forms
3034 .code
3035 From sender Fri Jan  5 12:55 GMT 1997
3036 From sender Fri, 5 Jan 97 12:55:01
3037 .endd
3038 (with the weekday optional, and possibly with additional text after the date)
3039 is permitted to appear at the start of the message. There appears to be no
3040 authoritative specification of the format of this line. Exim recognizes it by
3041 matching against the regular expression defined by the &%uucp_from_pattern%&
3042 option, which can be changed if necessary.
3043
3044 .oindex "&%-f%&" "overriding &""From""& line"
3045 The specified sender is treated as if it were given as the argument to the
3046 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3047 preference to the address taken from the message. The caller of Exim must be a
3048 trusted user for the sender of a message to be set in this way.
3049
3050 .vitem &%-bmalware%&&~<&'filename'&>
3051 .oindex "&%-bmalware%&"
3052 .cindex "testing", "malware"
3053 .cindex "malware scan test"
3054 This debugging option causes Exim to scan the given file,
3055 using the malware scanning framework.  The option of &%av_scanner%& influences
3056 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3057 the expansion should have defaults which apply to this invocation.  ACLs are
3058 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3059 will never be populated and &%-bmalware%& will fail.
3060
3061 Exim will have changed working directory before resolving the filename, so
3062 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3063 user when it tries to open the file, rather than as the invoking user.
3064 This option requires admin privileges.
3065
3066 The &%-bmalware%& option will not be extended to be more generally useful,
3067 there are better tools for file-scanning.  This option exists to help
3068 administrators verify their Exim and AV scanner configuration.
3069
3070 .vitem &%-bnq%&
3071 .oindex "&%-bnq%&"
3072 .cindex "address qualification, suppressing"
3073 By default, Exim automatically qualifies unqualified addresses (those
3074 without domains) that appear in messages that are submitted locally (that
3075 is, not over TCP/IP). This qualification applies both to addresses in
3076 envelopes, and addresses in header lines. Sender addresses are qualified using
3077 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3078 defaults to the value of &%qualify_domain%&).
3079
3080 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3081 being used to re-submit messages that originally came from remote hosts after
3082 content scanning, you probably do not want to qualify unqualified addresses in
3083 header lines. (Such lines will be present only if you have not enabled a header
3084 syntax check in the appropriate ACL.)
3085
3086 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3087 messages that originate on the local host. When this is used, unqualified
3088 addresses in the envelope provoke errors (causing message rejection) and
3089 unqualified addresses in header lines are left alone.
3090
3091
3092 .vitem &%-bP%&
3093 .oindex "&%-bP%&"
3094 .cindex "configuration options" "extracting"
3095 .cindex "options" "configuration &-- extracting"
3096 If this option is given with no arguments, it causes the values of all Exim's
3097 main configuration options to be written to the standard output. The values
3098 of one or more specific options can be requested by giving their names as
3099 arguments, for example:
3100 .code
3101 exim -bP qualify_domain hold_domains
3102 .endd
3103 .cindex "hiding configuration option values"
3104 .cindex "configuration options" "hiding value of"
3105 .cindex "options" "hiding value of"
3106 However, any option setting that is preceded by the word &"hide"& in the
3107 configuration file is not shown in full, except to an admin user. For other
3108 users, the output is as in this example:
3109 .code
3110 mysql_servers = <value not displayable>
3111 .endd
3112 If &%configure_file%& is given as an argument, the name of the run time
3113 configuration file is output.
3114 If a list of configuration files was supplied, the value that is output here
3115 is the name of the file that was actually used.
3116
3117 .cindex "options" "hiding name of"
3118 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3119 name will not be output.
3120
3121 .cindex "daemon" "process id (pid)"
3122 .cindex "pid (process id)" "of daemon"
3123 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3124 directories where log files and daemon pid files are written are output,
3125 respectively. If these values are unset, log files are written in a
3126 sub-directory of the spool directory called &%log%&, and the pid file is
3127 written directly into the spool directory.
3128
3129 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3130 .code
3131 exim -bP +local_domains
3132 .endd
3133 it searches for a matching named list of any type (domain, host, address, or
3134 local part) and outputs what it finds.
3135
3136 .cindex "options" "router &-- extracting"
3137 .cindex "options" "transport &-- extracting"
3138 .cindex "options" "authenticator &-- extracting"
3139 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3140 followed by the name of an appropriate driver instance, the option settings for
3141 that driver are output. For example:
3142 .code
3143 exim -bP transport local_delivery
3144 .endd
3145 The generic driver options are output first, followed by the driver's private
3146 options. A list of the names of drivers of a particular type can be obtained by
3147 using one of the words &%router_list%&, &%transport_list%&, or
3148 &%authenticator_list%&, and a complete list of all drivers with their option
3149 settings can be obtained by using &%routers%&, &%transports%&, or
3150 &%authenticators%&.
3151
3152 .cindex "options" "macro &-- extracting"
3153 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3154 are available, similarly to the drivers.  Because macros are sometimes used
3155 for storing passwords, this option is restricted.
3156 The output format is one item per line.
3157
3158 .vitem &%-bp%&
3159 .oindex "&%-bp%&"
3160 .cindex "queue" "listing messages on"
3161 .cindex "listing" "messages on the queue"
3162 This option requests a listing of the contents of the mail queue on the
3163 standard output. If the &%-bp%& option is followed by a list of message ids,
3164 just those messages are listed. By default, this option can be used only by an
3165 admin user. However, the &%queue_list_requires_admin%& option can be set false
3166 to allow any user to see the queue.
3167
3168 Each message on the queue is displayed as in the following example:
3169 .code
3170 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3171           red.king@looking-glass.fict.example
3172           <other addresses>
3173 .endd
3174 .cindex "message" "size in queue listing"
3175 .cindex "size" "of message"
3176 The first line contains the length of time the message has been on the queue
3177 (in this case 25 minutes), the size of the message (2.9K), the unique local
3178 identifier for the message, and the message sender, as contained in the
3179 envelope. For bounce messages, the sender address is empty, and appears as
3180 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3181 the default sender address, the user's login name is shown in parentheses
3182 before the sender address.
3183
3184 .cindex "frozen messages" "in queue listing"
3185 If the message is frozen (attempts to deliver it are suspended) then the text
3186 &"*** frozen ***"& is displayed at the end of this line.
3187
3188 The recipients of the message (taken from the envelope, not the headers) are
3189 displayed on subsequent lines. Those addresses to which the message has already
3190 been delivered are marked with the letter D. If an original address gets
3191 expanded into several addresses via an alias or forward file, the original is
3192 displayed with a D only when deliveries for all of its child addresses are
3193 complete.
3194
3195
3196 .vitem &%-bpa%&
3197 .oindex "&%-bpa%&"
3198 This option operates like &%-bp%&, but in addition it shows delivered addresses
3199 that were generated from the original top level address(es) in each message by
3200 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3201 of just &"D"&.
3202
3203
3204 .vitem &%-bpc%&
3205 .oindex "&%-bpc%&"
3206 .cindex "queue" "count of messages on"
3207 This option counts the number of messages on the queue, and writes the total
3208 to the standard output. It is restricted to admin users, unless
3209 &%queue_list_requires_admin%& is set false.
3210
3211
3212 .vitem &%-bpr%&
3213 .oindex "&%-bpr%&"
3214 This option operates like &%-bp%&, but the output is not sorted into
3215 chronological order of message arrival. This can speed it up when there are
3216 lots of messages on the queue, and is particularly useful if the output is
3217 going to be post-processed in a way that doesn't need the sorting.
3218
3219 .vitem &%-bpra%&
3220 .oindex "&%-bpra%&"
3221 This option is a combination of &%-bpr%& and &%-bpa%&.
3222
3223 .vitem &%-bpru%&
3224 .oindex "&%-bpru%&"
3225 This option is a combination of &%-bpr%& and &%-bpu%&.
3226
3227
3228 .vitem &%-bpu%&
3229 .oindex "&%-bpu%&"
3230 This option operates like &%-bp%& but shows only undelivered top-level
3231 addresses for each message displayed. Addresses generated by aliasing or
3232 forwarding are not shown, unless the message was deferred after processing by a
3233 router with the &%one_time%& option set.
3234
3235
3236 .vitem &%-brt%&
3237 .oindex "&%-brt%&"
3238 .cindex "testing" "retry configuration"
3239 .cindex "retry" "configuration testing"
3240 This option is for testing retry rules, and it must be followed by up to three
3241 arguments. It causes Exim to look for a retry rule that matches the values
3242 and to write it to the standard output. For example:
3243 .code
3244 exim -brt bach.comp.mus.example
3245 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3246 .endd
3247 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3248 argument, which is required, can be a complete address in the form
3249 &'local_part@domain'&, or it can be just a domain name. If the second argument
3250 contains a dot, it is interpreted as an optional second domain name; if no
3251 retry rule is found for the first argument, the second is tried. This ties in
3252 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3253 rule is found that matches the host, one that matches the mail domain is
3254 sought. Finally, an argument that is the name of a specific delivery error, as
3255 used in setting up retry rules, can be given. For example:
3256 .code
3257 exim -brt haydn.comp.mus.example quota_3d
3258 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3259 .endd
3260
3261 .vitem &%-brw%&
3262 .oindex "&%-brw%&"
3263 .cindex "testing" "rewriting"
3264 .cindex "rewriting" "testing"
3265 This option is for testing address rewriting rules, and it must be followed by
3266 a single argument, consisting of either a local part without a domain, or a
3267 complete address with a fully qualified domain. Exim outputs how this address
3268 would be rewritten for each possible place it might appear. See chapter
3269 &<<CHAPrewrite>>& for further details.
3270
3271 .vitem &%-bS%&
3272 .oindex "&%-bS%&"
3273 .cindex "SMTP" "batched incoming"
3274 .cindex "batched SMTP input"
3275 This option is used for batched SMTP input, which is an alternative interface
3276 for non-interactive local message submission. A number of messages can be
3277 submitted in a single run. However, despite its name, this is not really SMTP
3278 input. Exim reads each message's envelope from SMTP commands on the standard
3279 input, but generates no responses. If the caller is trusted, or
3280 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3281 believed; otherwise the sender is always the caller of Exim.
3282
3283 The message itself is read from the standard input, in SMTP format (leading
3284 dots doubled), terminated by a line containing just a single dot. An error is
3285 provoked if the terminating dot is missing. A further message may then follow.
3286
3287 As for other local message submissions, the contents of incoming batch SMTP
3288 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3289 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3290 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3291
3292 Some other SMTP commands are recognized in the input. HELO and EHLO act
3293 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3294 QUIT quits, ignoring the rest of the standard input.
3295
3296 .cindex "return code" "for &%-bS%&"
3297 If any error is encountered, reports are written to the standard output and
3298 error streams, and Exim gives up immediately. The return code is 0 if no error
3299 was detected; it is 1 if one or more messages were accepted before the error
3300 was detected; otherwise it is 2.
3301
3302 More details of input using batched SMTP are given in section
3303 &<<SECTincomingbatchedSMTP>>&.
3304
3305 .vitem &%-bs%&
3306 .oindex "&%-bs%&"
3307 .cindex "SMTP" "local input"
3308 .cindex "local SMTP input"
3309 This option causes Exim to accept one or more messages by reading SMTP commands
3310 on the standard input, and producing SMTP replies on the standard output. SMTP
3311 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3312 Some user agents use this interface as a way of passing locally-generated
3313 messages to the MTA.
3314
3315 In
3316 .cindex "sender" "source of"
3317 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3318 set, the senders of messages are taken from the SMTP MAIL commands.
3319 Otherwise the content of these commands is ignored and the sender is set up as
3320 the calling user. Unqualified addresses are automatically qualified using
3321 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3322 &%-bnq%& option is used.
3323
3324 .cindex "inetd"
3325 The
3326 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3327 using a listening daemon. Exim can distinguish the two cases by checking
3328 whether the standard input is a TCP/IP socket. When Exim is called from
3329 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3330 above concerning senders and qualification do not apply. In this situation,
3331 Exim behaves in exactly the same way as it does when receiving a message via
3332 the listening daemon.
3333
3334 .vitem &%-bt%&
3335 .oindex "&%-bt%&"
3336 .cindex "testing" "addresses"
3337 .cindex "address" "testing"
3338 This option runs Exim in address testing mode, in which each argument is taken
3339 as a recipient address to be tested for deliverability. The results are
3340 written to the standard output. If a test fails, and the caller is not an admin
3341 user, no details of the failure are output, because these might contain
3342 sensitive information such as usernames and passwords for database lookups.
3343
3344 If no arguments are given, Exim runs in an interactive manner, prompting with a
3345 right angle bracket for addresses to be tested.
3346
3347 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3348 &[readline()]& function, because it is running as &'root'& and there are
3349 security issues.
3350
3351 Each address is handled as if it were the recipient address of a message
3352 (compare the &%-bv%& option). It is passed to the routers and the result is
3353 written to the standard output. However, any router that has
3354 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3355 genuine routing tests if your first router passes everything to a scanner
3356 program.
3357
3358 .cindex "return code" "for &%-bt%&"
3359 The return code is 2 if any address failed outright; it is 1 if no address
3360 failed outright but at least one could not be resolved for some reason. Return
3361 code 0 is given only when all addresses succeed.
3362
3363 .cindex "duplicate addresses"
3364 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3365 addresses after routing is complete, so that only one delivery takes place.
3366 This does not happen when testing with &%-bt%&; the full results of routing are
3367 always shown.
3368
3369 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3370 routers in the configuration makes any tests on the sender address of a
3371 message,
3372 .oindex "&%-f%&" "for address testing"
3373 you can use the &%-f%& option to set an appropriate sender when running
3374 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3375 default qualifying domain. However, if you have set up (for example) routers
3376 whose behaviour depends on the contents of an incoming message, you cannot test
3377 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3378 doing such tests.
3379
3380 .vitem &%-bV%&
3381 .oindex "&%-bV%&"
3382 .cindex "version number of Exim"
3383 This option causes Exim to write the current version number, compilation
3384 number, and compilation date of the &'exim'& binary to the standard output.
3385 It also lists the DBM library that is being used, the optional modules (such as
3386 specific lookup types), the drivers that are included in the binary, and the
3387 name of the run time configuration file that is in use.
3388
3389 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3390 configuration file. However, this is a static check only. It cannot check
3391 values that are to be expanded. For example, although a misspelt ACL verb is
3392 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3393 alone to discover (for example) all the typos in the configuration; some
3394 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3395 dynamic testing facilities.
3396
3397 .vitem &%-bv%&
3398 .oindex "&%-bv%&"
3399 .cindex "verifying address" "using &%-bv%&"
3400 .cindex "address" "verification"
3401 This option runs Exim in address verification mode, in which each argument is
3402 taken as a recipient address to be verified by the routers. (This does
3403 not involve any verification callouts). During normal operation, verification
3404 happens mostly as a consequence processing a &%verify%& condition in an ACL
3405 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3406 including callouts, see the &%-bh%& and &%-bhc%& options.
3407
3408 If verification fails, and the caller is not an admin user, no details of the
3409 failure are output, because these might contain sensitive information such as
3410 usernames and passwords for database lookups.
3411
3412 If no arguments are given, Exim runs in an interactive manner, prompting with a
3413 right angle bracket for addresses to be verified.
3414
3415 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3416 &[readline()]& function, because it is running as &'exim'& and there are
3417 security issues.
3418
3419 Verification differs from address testing (the &%-bt%& option) in that routers
3420 that have &%no_verify%& set are skipped, and if the address is accepted by a
3421 router that has &%fail_verify%& set, verification fails. The address is
3422 verified as a recipient if &%-bv%& is used; to test verification for a sender
3423 address, &%-bvs%& should be used.
3424
3425 If the &%-v%& option is not set, the output consists of a single line for each
3426 address, stating whether it was verified or not, and giving a reason in the
3427 latter case. Without &%-v%&, generating more than one address by redirection
3428 causes verification to end successfully, without considering the generated
3429 addresses. However, if just one address is generated, processing continues,
3430 and the generated address must verify successfully for the overall verification
3431 to succeed.
3432
3433 When &%-v%& is set, more details are given of how the address has been handled,
3434 and in the case of address redirection, all the generated addresses are also
3435 considered. Verification may succeed for some and fail for others.
3436
3437 The
3438 .cindex "return code" "for &%-bv%&"
3439 return code is 2 if any address failed outright; it is 1 if no address
3440 failed outright but at least one could not be resolved for some reason. Return
3441 code 0 is given only when all addresses succeed.
3442
3443 If any of the routers in the configuration makes any tests on the sender
3444 address of a message, you should use the &%-f%& option to set an appropriate
3445 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3446 calling user at the default qualifying domain.
3447
3448 .vitem &%-bvs%&
3449 .oindex "&%-bvs%&"
3450 This option acts like &%-bv%&, but verifies the address as a sender rather
3451 than a recipient address. This affects any rewriting and qualification that
3452 might happen.
3453
3454 .vitem &%-bw%&
3455 .oindex "&%-bw%&"
3456 .cindex "daemon"
3457 .cindex "inetd"
3458 .cindex "inetd" "wait mode"
3459 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3460 similarly to the &%-bd%& option.  All port specifications on the command-line
3461 and in the configuration file are ignored.  Queue-running may not be specified.
3462
3463 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3464 listening for connections.  This permits the system to start up and have
3465 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3466 each port only when the first connection is received.
3467
3468 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3469 which the daemon will exit, which should cause inetd to listen once more.
3470
3471 .vitem &%-C%&&~<&'filelist'&>
3472 .oindex "&%-C%&"
3473 .cindex "configuration file" "alternate"
3474 .cindex "CONFIGURE_FILE"
3475 .cindex "alternate configuration file"
3476 This option causes Exim to find the run time configuration file from the given
3477 list instead of from the list specified by the CONFIGURE_FILE
3478 compile-time setting. Usually, the list will consist of just a single file
3479 name, but it can be a colon-separated list of names. In this case, the first
3480 file that exists is used. Failure to open an existing file stops Exim from
3481 proceeding any further along the list, and an error is generated.
3482
3483 When this option is used by a caller other than root, and the list is different
3484 from the compiled-in list, Exim gives up its root privilege immediately, and
3485 runs with the real and effective uid and gid set to those of the caller.
3486 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3487 file contains a list of full pathnames, one per line, for configuration files
3488 which are trusted. Root privilege is retained for any configuration file so
3489 listed, as long as the caller is the Exim user (or the user specified in the
3490 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3491 not writeable by inappropriate users or groups.
3492
3493 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3494 configuration using &%-C%& right through message reception and delivery,
3495 even if the caller is root. The reception works, but by that time, Exim is
3496 running as the Exim user, so when it re-executes to regain privilege for the
3497 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3498 test reception and delivery using two separate commands (one to put a message
3499 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3500
3501 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3502 prefix string with which any file named in a &%-C%& command line option
3503 must start. In addition, the file name must not contain the sequence &`/../`&.
3504 However, if the value of the &%-C%& option is identical to the value of
3505 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3506 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3507 unset, any file name can be used with &%-C%&.
3508
3509 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3510 to a directory to which only root has access. This prevents someone who has
3511 broken into the Exim account from running a privileged Exim with an arbitrary
3512 configuration file.
3513
3514 The &%-C%& facility is useful for ensuring that configuration files are
3515 syntactically correct, but cannot be used for test deliveries, unless the
3516 caller is privileged, or unless it is an exotic configuration that does not
3517 require privilege. No check is made on the owner or group of the files
3518 specified by this option.
3519
3520
3521 .vitem &%-D%&<&'macro'&>=<&'value'&>
3522 .oindex "&%-D%&"
3523 .cindex "macro" "setting on command line"
3524 This option can be used to override macro definitions in the configuration file
3525 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3526 unprivileged caller, it causes Exim to give up its root privilege.
3527 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3528 completely disabled, and its use causes an immediate error exit.
3529
3530 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3531 colon-separated list of macros which are considered safe and, if &%-D%& only
3532 supplies macros from this list, and the values are acceptable, then Exim will
3533 not give up root privilege if the caller is root, the Exim run-time user, or
3534 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3535 to be removed in the future.  Acceptable values for the macros satisfy the
3536 regexp: &`^[A-Za-z0-9_/.-]*$`&
3537
3538 The entire option (including equals sign if present) must all be within one
3539 command line item. &%-D%& can be used to set the value of a macro to the empty
3540 string, in which case the equals sign is optional. These two commands are
3541 synonymous:
3542 .code
3543 exim -DABC  ...
3544 exim -DABC= ...
3545 .endd
3546 To include spaces in a macro definition item, quotes must be used. If you use
3547 quotes, spaces are permitted around the macro name and the equals sign. For
3548 example:
3549 .code
3550 exim '-D ABC = something' ...
3551 .endd
3552 &%-D%& may be repeated up to 10 times on a command line.
3553
3554
3555 .vitem &%-d%&<&'debug&~options'&>
3556 .oindex "&%-d%&"
3557 .cindex "debugging" "list of selectors"
3558 .cindex "debugging" "&%-d%& option"
3559 This option causes debugging information to be written to the standard
3560 error stream. It is restricted to admin users because debugging output may show
3561 database queries that contain password information. Also, the details of users'
3562 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3563 writes an error message to the standard error stream and exits with a non-zero
3564 return code.
3565
3566 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3567 standard debugging data is output. This can be reduced, or increased to include
3568 some more rarely needed information, by directly following &%-d%& with a string
3569 made up of names preceded by plus or minus characters. These add or remove sets
3570 of debugging data, respectively. For example, &%-d+filter%& adds filter
3571 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3572 no spaces are allowed in the debug setting. The available debugging categories
3573 are:
3574 .display
3575 &`acl            `& ACL interpretation
3576 &`auth           `& authenticators
3577 &`deliver        `& general delivery logic
3578 &`dns            `& DNS lookups (see also resolver)
3579 &`dnsbl          `& DNS black list (aka RBL) code
3580 &`exec           `& arguments for &[execv()]& calls
3581 &`expand         `& detailed debugging for string expansions
3582 &`filter         `& filter handling
3583 &`hints_lookup   `& hints data lookups
3584 &`host_lookup    `& all types of name-to-IP address handling
3585 &`ident          `& ident lookup
3586 &`interface      `& lists of local interfaces
3587 &`lists          `& matching things in lists
3588 &`load           `& system load checks
3589 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3590                     &<<CHAPlocalscan>>&)
3591 &`lookup         `& general lookup code and all lookups
3592 &`memory         `& memory handling
3593 &`pid            `& add pid to debug output lines
3594 &`process_info   `& setting info for the process log
3595 &`queue_run      `& queue runs
3596 &`receive        `& general message reception logic
3597 &`resolver       `& turn on the DNS resolver's debugging output
3598 &`retry          `& retry handling
3599 &`rewrite        `& address rewriting
3600 &`route          `& address routing
3601 &`timestamp      `& add timestamp to debug output lines
3602 &`tls            `& TLS logic
3603 &`transport      `& transports
3604 &`uid            `& changes of uid/gid and looking up uid/gid
3605 &`verify         `& address verification logic
3606 &`all            `& almost all of the above (see below), and also &%-v%&
3607 .endd
3608 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3609 for &`-all`&. The reason for this is that &`+all`& is something that people
3610 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3611 is included, an awful lot of output that is very rarely of interest is
3612 generated, so it now has to be explicitly requested. However, &`-all`& does
3613 turn everything off.
3614
3615 .cindex "resolver, debugging output"
3616 .cindex "DNS resolver, debugging output"
3617 The &`resolver`& option produces output only if the DNS resolver was compiled
3618 with DEBUG enabled. This is not the case in some operating systems. Also,
3619 unfortunately, debugging output from the DNS resolver is written to stdout
3620 rather than stderr.
3621
3622 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3623 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3624 However, the &`pid`& selector is forced when debugging is turned on for a
3625 daemon, which then passes it on to any re-executed Exims. Exim also
3626 automatically adds the pid to debug lines when several remote deliveries are
3627 run in parallel.
3628
3629 The &`timestamp`& selector causes the current time to be inserted at the start
3630 of all debug output lines. This can be useful when trying to track down delays
3631 in processing.
3632
3633 If the &%debug_print%& option is set in any driver, it produces output whenever
3634 any debugging is selected, or if &%-v%& is used.
3635
3636 .vitem &%-dd%&<&'debug&~options'&>
3637 .oindex "&%-dd%&"
3638 This option behaves exactly like &%-d%& except when used on a command that
3639 starts a daemon process. In that case, debugging is turned off for the
3640 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3641 behaviour of the daemon without creating as much output as full debugging does.
3642
3643 .vitem &%-dropcr%&
3644 .oindex "&%-dropcr%&"
3645 This is an obsolete option that is now a no-op. It used to affect the way Exim
3646 handled CR and LF characters in incoming messages. What happens now is
3647 described in section &<<SECTlineendings>>&.
3648
3649 .vitem &%-E%&
3650 .oindex "&%-E%&"
3651 .cindex "bounce message" "generating"
3652 This option specifies that an incoming message is a locally-generated delivery
3653 failure report. It is used internally by Exim when handling delivery failures
3654 and is not intended for external use. Its only effect is to stop Exim
3655 generating certain messages to the postmaster, as otherwise message cascades
3656 could occur in some situations. As part of the same option, a message id may
3657 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3658 new message contains the id, following &"R="&, as a cross-reference.
3659
3660 .vitem &%-e%&&'x'&
3661 .oindex "&%-e%&&'x'&"
3662 There are a number of Sendmail options starting with &%-oe%& which seem to be
3663 called by various programs without the leading &%o%& in the option. For
3664 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3665 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3666
3667 .vitem &%-F%&&~<&'string'&>
3668 .oindex "&%-F%&"
3669 .cindex "sender" "name"
3670 .cindex "name" "of sender"
3671 This option sets the sender's full name for use when a locally-generated
3672 message is being accepted. In the absence of this option, the user's &'gecos'&
3673 entry from the password data is used. As users are generally permitted to alter
3674 their &'gecos'& entries, no security considerations are involved. White space
3675 between &%-F%& and the <&'string'&> is optional.
3676
3677 .vitem &%-f%&&~<&'address'&>
3678 .oindex "&%-f%&"
3679 .cindex "sender" "address"
3680 .cindex "address" "sender"
3681 .cindex "trusted users"
3682 .cindex "envelope sender"
3683 .cindex "user" "trusted"
3684 This option sets the address of the envelope sender of a locally-generated
3685 message (also known as the return path). The option can normally be used only
3686 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3687 users to use it.
3688
3689 Processes running as root or the Exim user are always trusted. Other
3690 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3691 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3692 of a local message is set to the caller's login name at the default qualify
3693 domain.
3694
3695 There is one exception to the restriction on the use of &%-f%&: an empty sender
3696 can be specified by any user, trusted or not, to create a message that can
3697 never provoke a bounce. An empty sender can be specified either as an empty
3698 string, or as a pair of angle brackets with nothing between them, as in these
3699 examples of shell commands:
3700 .code
3701 exim -f '<>' user@domain
3702 exim -f "" user@domain
3703 .endd
3704 In addition, the use of &%-f%& is not restricted when testing a filter file
3705 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3706 &%-bv%& options.
3707
3708 Allowing untrusted users to change the sender address does not of itself make
3709 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3710 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3711 though this can be overridden by setting &%no_local_from_check%&.
3712
3713 White
3714 .cindex "&""From""& line"
3715 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3716 given as two arguments or one combined argument). The sender of a
3717 locally-generated message can also be set (when permitted) by an initial
3718 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3719 if &%-f%& is also present, it overrides &"From&~"&.
3720
3721 .vitem &%-G%&
3722 .oindex "&%-G%&"
3723 .cindex "submission fixups, suppressing (command-line)"
3724 This option is equivalent to an ACL applying:
3725 .code
3726 control = suppress_local_fixups
3727 .endd
3728 for every message received.  Note that Sendmail will complain about such
3729 bad formatting, where Exim silently just does not fix it up.  This may change
3730 in future.
3731
3732 As this affects audit information, the caller must be a trusted user to use
3733 this option.
3734
3735 .vitem &%-h%&&~<&'number'&>
3736 .oindex "&%-h%&"
3737 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3738 This option is accepted for compatibility with Sendmail, but has no effect. (In
3739 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3740 headers.)
3741
3742 .vitem &%-i%&
3743 .oindex "&%-i%&"
3744 .cindex "Solaris" "&'mail'& command"
3745 .cindex "dot" "in incoming non-SMTP message"
3746 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3747 line by itself should not terminate an incoming, non-SMTP message. I can find
3748 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3749 command in Solaris 2.4 uses it. See also &%-ti%&.
3750
3751 .vitem &%-L%&&~<&'tag'&>
3752 .oindex "&%-L%&"
3753 .cindex "syslog" "process name; set with flag"
3754 This option is equivalent to setting &%syslog_processname%& in the config
3755 file and setting &%log_file_path%& to &`syslog`&.
3756 Its use is restricted to administrators.  The configuration file has to be
3757 read and parsed, to determine access rights, before this is set and takes
3758 effect, so early configuration file errors will not honour this flag.
3759
3760 The tag should not be longer than 32 characters.
3761
3762 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3763 .oindex "&%-M%&"
3764 .cindex "forcing delivery"
3765 .cindex "delivery" "forcing attempt"
3766 .cindex "frozen messages" "forcing delivery"
3767 This option requests Exim to run a delivery attempt on each message in turn. If
3768 any of the messages are frozen, they are automatically thawed before the
3769 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3770 and &%hold_domains%& are ignored.
3771
3772 Retry
3773 .cindex "hints database" "overriding retry hints"
3774 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3775 the normal retry time has not yet been reached. This option requires the caller
3776 to be an admin user. However, there is an option called &%prod_requires_admin%&
3777 which can be set false to relax this restriction (and also the same requirement
3778 for the &%-q%&, &%-R%&, and &%-S%& options).
3779
3780 The deliveries happen synchronously, that is, the original Exim process does
3781 not terminate until all the delivery attempts have finished. No output is
3782 produced unless there is a serious error. If you want to see what is happening,
3783 use the &%-v%& option as well, or inspect Exim's main log.
3784
3785 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3786 .oindex "&%-Mar%&"
3787 .cindex "message" "adding recipients"
3788 .cindex "recipient" "adding"
3789 This option requests Exim to add the addresses to the list of recipients of the
3790 message (&"ar"& for &"add recipients"&). The first argument must be a message
3791 id, and the remaining ones must be email addresses. However, if the message is
3792 active (in the middle of a delivery attempt), it is not altered. This option
3793 can be used only by an admin user.
3794
3795 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3796         &~<&'message&~id'&>"
3797 .oindex "&%-MC%&"
3798 .cindex "SMTP" "passed connection"
3799 .cindex "SMTP" "multiple deliveries"
3800 .cindex "multiple SMTP deliveries"
3801 This option is not intended for use by external callers. It is used internally
3802 by Exim to invoke another instance of itself to deliver a waiting message using
3803 an existing SMTP connection, which is passed as the standard input. Details are
3804 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3805 must be root or the Exim user in order to use it.
3806
3807 .vitem &%-MCA%&
3808 .oindex "&%-MCA%&"
3809 This option is not intended for use by external callers. It is used internally
3810 by Exim in conjunction with the &%-MC%& option. It signifies that the
3811 connection to the remote host has been authenticated.
3812
3813 .new
3814 .vitem &%-MCD%&
3815 .oindex "&%-MCD%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the
3818 remote host supports the ESMTP &_DSN_& extension.
3819 .wen
3820
3821 .vitem &%-MCP%&
3822 .oindex "&%-MCP%&"
3823 This option is not intended for use by external callers. It is used internally
3824 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3825 which Exim is connected supports pipelining.
3826
3827 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3828 .oindex "&%-MCQ%&"
3829 This option is not intended for use by external callers. It is used internally
3830 by Exim in conjunction with the &%-MC%& option when the original delivery was
3831 started by a queue runner. It passes on the process id of the queue runner,
3832 together with the file descriptor number of an open pipe. Closure of the pipe
3833 signals the final completion of the sequence of processes that are passing
3834 messages through the same SMTP connection.
3835
3836 .vitem &%-MCS%&
3837 .oindex "&%-MCS%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3840 SMTP SIZE option should be used on messages delivered down the existing
3841 connection.
3842
3843 .vitem &%-MCT%&
3844 .oindex "&%-MCT%&"
3845 This option is not intended for use by external callers. It is used internally
3846 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3847 host to which Exim is connected supports TLS encryption.
3848
3849 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3850 .oindex "&%-Mc%&"
3851 .cindex "hints database" "not overridden by &%-Mc%&"
3852 .cindex "delivery" "manually started &-- not forced"
3853 This option requests Exim to run a delivery attempt on each message in turn,
3854 but unlike the &%-M%& option, it does check for retry hints, and respects any
3855 that are found. This option is not very useful to external callers. It is
3856 provided mainly for internal use by Exim when it needs to re-invoke itself in
3857 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3858 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3859 respects retry times and other options such as &%hold_domains%& that are
3860 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3861 If you want to run a specific delivery as if in a queue run, you should use
3862 &%-q%& with a message id argument. A distinction between queue run deliveries
3863 and other deliveries is made in one or two places.
3864
3865 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3866 .oindex "&%-Mes%&"
3867 .cindex "message" "changing sender"
3868 .cindex "sender" "changing"
3869 This option requests Exim to change the sender address in the message to the
3870 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3871 &"edit sender"&). There must be exactly two arguments. The first argument must
3872 be a message id, and the second one an email address. However, if the message
3873 is active (in the middle of a delivery attempt), its status is not altered.
3874 This option can be used only by an admin user.
3875
3876 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3877 .oindex "&%-Mf%&"
3878 .cindex "freezing messages"
3879 .cindex "message" "manually freezing"
3880 This option requests Exim to mark each listed message as &"frozen"&. This
3881 prevents any delivery attempts taking place until the message is &"thawed"&,
3882 either manually or as a result of the &%auto_thaw%& configuration option.
3883 However, if any of the messages are active (in the middle of a delivery
3884 attempt), their status is not altered. This option can be used only by an admin
3885 user.
3886
3887 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3888 .oindex "&%-Mg%&"
3889 .cindex "giving up on messages"
3890 .cindex "message" "abandoning delivery attempts"
3891 .cindex "delivery" "abandoning further attempts"
3892 This option requests Exim to give up trying to deliver the listed messages,
3893 including any that are frozen. However, if any of the messages are active,
3894 their status is not altered. For non-bounce messages, a delivery error message
3895 is sent to the sender, containing the text &"cancelled by administrator"&.
3896 Bounce messages are just discarded. This option can be used only by an admin
3897 user.
3898
3899 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3900 .oindex "&%-Mmad%&"
3901 .cindex "delivery" "cancelling all"
3902 This option requests Exim to mark all the recipient addresses in the messages
3903 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3904 message is active (in the middle of a delivery attempt), its status is not
3905 altered. This option can be used only by an admin user.
3906
3907 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3908 .oindex "&%-Mmd%&"
3909 .cindex "delivery" "cancelling by address"
3910 .cindex "recipient" "removing"
3911 .cindex "removing recipients"
3912 This option requests Exim to mark the given addresses as already delivered
3913 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3914 the remaining ones must be email addresses. These are matched to recipient
3915 addresses in the message in a case-sensitive manner. If the message is active
3916 (in the middle of a delivery attempt), its status is not altered. This option
3917 can be used only by an admin user.
3918
3919 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3920 .oindex "&%-Mrm%&"
3921 .cindex "removing messages"
3922 .cindex "abandoning mail"
3923 .cindex "message" "manually discarding"
3924 This option requests Exim to remove the given messages from the queue. No
3925 bounce messages are sent; each message is simply forgotten. However, if any of
3926 the messages are active, their status is not altered. This option can be used
3927 only by an admin user or by the user who originally caused the message to be
3928 placed on the queue.
3929
3930 .vitem &%-Mset%&&~<&'message&~id'&>
3931 .oindex "&%-Mset%&
3932 .cindex "testing" "string expansion"
3933 .cindex "expansion" "testing"
3934 This option is useful only in conjunction with &%-be%& (that is, when testing
3935 string expansions). Exim loads the given message from its spool before doing
3936 the test expansions, thus setting message-specific variables such as
3937 &$message_size$& and the header variables. The &$recipients$& variable is made
3938 available. This feature is provided to make it easier to test expansions that
3939 make use of these variables. However, this option can be used only by an admin
3940 user. See also &%-bem%&.
3941
3942 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3943 .oindex "&%-Mt%&"
3944 .cindex "thawing messages"
3945 .cindex "unfreezing messages"
3946 .cindex "frozen messages" "thawing"
3947 .cindex "message" "thawing frozen"
3948 This option requests Exim to &"thaw"& any of the listed messages that are
3949 &"frozen"&, so that delivery attempts can resume. However, if any of the
3950 messages are active, their status is not altered. This option can be used only
3951 by an admin user.
3952
3953 .vitem &%-Mvb%&&~<&'message&~id'&>
3954 .oindex "&%-Mvb%&"
3955 .cindex "listing" "message body"
3956 .cindex "message" "listing body of"
3957 This option causes the contents of the message body (-D) spool file to be
3958 written to the standard output. This option can be used only by an admin user.
3959
3960 .vitem &%-Mvc%&&~<&'message&~id'&>
3961 .oindex "&%-Mvc%&"
3962 .cindex "message" "listing in RFC 2822 format"
3963 .cindex "listing" "message in RFC 2822 format"
3964 This option causes a copy of the complete message (header lines plus body) to
3965 be written to the standard output in RFC 2822 format. This option can be used
3966 only by an admin user.
3967
3968 .vitem &%-Mvh%&&~<&'message&~id'&>
3969 .oindex "&%-Mvh%&"
3970 .cindex "listing" "message headers"
3971 .cindex "header lines" "listing"
3972 .cindex "message" "listing header lines"
3973 This option causes the contents of the message headers (-H) spool file to be
3974 written to the standard output. This option can be used only by an admin user.
3975
3976 .vitem &%-Mvl%&&~<&'message&~id'&>
3977 .oindex "&%-Mvl%&"
3978 .cindex "listing" "message log"
3979 .cindex "message" "listing message log"
3980 This option causes the contents of the message log spool file to be written to
3981 the standard output. This option can be used only by an admin user.
3982
3983 .vitem &%-m%&
3984 .oindex "&%-m%&"
3985 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
3986 treats it that way too.
3987
3988 .vitem &%-N%&
3989 .oindex "&%-N%&"
3990 .cindex "debugging" "&%-N%& option"
3991 .cindex "debugging" "suppressing delivery"
3992 This is a debugging option that inhibits delivery of a message at the transport
3993 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
3994 it just doesn't actually transport the message, but instead behaves as if it
3995 had successfully done so. However, it does not make any updates to the retry
3996 database, and the log entries for deliveries are flagged with &"*>"& rather
3997 than &"=>"&.
3998
3999 Because &%-N%& discards any message to which it applies, only root or the Exim
4000 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4001 words, an ordinary user can use it only when supplying an incoming message to
4002 which it will apply. Although transportation never fails when &%-N%& is set, an
4003 address may be deferred because of a configuration problem on a transport, or a
4004 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4005 the message, and applies to any subsequent delivery attempts that may happen
4006 for that message.
4007
4008 .vitem &%-n%&
4009 .oindex "&%-n%&"
4010 This option is interpreted by Sendmail to mean &"no aliasing"&.
4011 For normal modes of operation, it is ignored by Exim.
4012 When combined with &%-bP%& it suppresses the name of an option from being output.
4013
4014 .vitem &%-O%&&~<&'data'&>
4015 .oindex "&%-O%&"
4016 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4017 Exim.
4018
4019 .vitem &%-oA%&&~<&'file&~name'&>
4020 .oindex "&%-oA%&"
4021 .cindex "Sendmail compatibility" "&%-oA%& option"
4022 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4023 alternative alias file name. Exim handles &%-bi%& differently; see the
4024 description above.
4025
4026 .vitem &%-oB%&&~<&'n'&>
4027 .oindex "&%-oB%&"
4028 .cindex "SMTP" "passed connection"
4029 .cindex "SMTP" "multiple deliveries"
4030 .cindex "multiple SMTP deliveries"
4031 This is a debugging option which limits the maximum number of messages that can
4032 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4033 transport. If <&'n'&> is omitted, the limit is set to 1.
4034
4035 .vitem &%-odb%&
4036 .oindex "&%-odb%&"
4037 .cindex "background delivery"
4038 .cindex "delivery" "in the background"
4039 This option applies to all modes in which Exim accepts incoming messages,
4040 including the listening daemon. It requests &"background"& delivery of such
4041 messages, which means that the accepting process automatically starts a
4042 delivery process for each message received, but does not wait for the delivery
4043 processes to finish.
4044
4045 When all the messages have been received, the reception process exits,
4046 leaving the delivery processes to finish in their own time. The standard output
4047 and error streams are closed at the start of each delivery process.
4048 This is the default action if none of the &%-od%& options are present.
4049
4050 If one of the queueing options in the configuration file
4051 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4052 overrides it if &%queue_only_override%& is set true, which is the default
4053 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4054
4055 .vitem &%-odf%&
4056 .oindex "&%-odf%&"
4057 .cindex "foreground delivery"
4058 .cindex "delivery" "in the foreground"
4059 This option requests &"foreground"& (synchronous) delivery when Exim has
4060 accepted a locally-generated message. (For the daemon it is exactly the same as
4061 &%-odb%&.) A delivery process is automatically started to deliver the message,
4062 and Exim waits for it to complete before proceeding.
4063
4064 The original Exim reception process does not finish until the delivery
4065 process for the final message has ended. The standard error stream is left open
4066 during deliveries.
4067
4068 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4069 false and one of the queueing options in the configuration file is in effect.
4070
4071 If there is a temporary delivery error during foreground delivery, the
4072 message is left on the queue for later delivery, and the original reception
4073 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4074 restricted configuration that never queues messages.
4075
4076
4077 .vitem &%-odi%&
4078 .oindex "&%-odi%&"
4079 This option is synonymous with &%-odf%&. It is provided for compatibility with
4080 Sendmail.
4081
4082 .vitem &%-odq%&
4083 .oindex "&%-odq%&"
4084 .cindex "non-immediate delivery"
4085 .cindex "delivery" "suppressing immediate"
4086 .cindex "queueing incoming messages"
4087 This option applies to all modes in which Exim accepts incoming messages,
4088 including the listening daemon. It specifies that the accepting process should
4089 not automatically start a delivery process for each message received. Messages
4090 are placed on the queue, and remain there until a subsequent queue runner
4091 process encounters them. There are several configuration options (such as
4092 &%queue_only%&) that can be used to queue incoming messages under certain
4093 conditions. This option overrides all of them and also &%-odqs%&. It always
4094 forces queueing.
4095
4096 .vitem &%-odqs%&
4097 .oindex "&%-odqs%&"
4098 .cindex "SMTP" "delaying delivery"
4099 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4100 However, like &%-odb%& and &%-odi%&, this option has no effect if
4101 &%queue_only_override%& is false and one of the queueing options in the
4102 configuration file is in effect.
4103
4104 When &%-odqs%& does operate, a delivery process is started for each incoming
4105 message, in the background by default, but in the foreground if &%-odi%& is
4106 also present. The recipient addresses are routed, and local deliveries are done
4107 in the normal way. However, if any SMTP deliveries are required, they are not
4108 done at this time, so the message remains on the queue until a subsequent queue
4109 runner process encounters it. Because routing was done, Exim knows which
4110 messages are waiting for which hosts, and so a number of messages for the same
4111 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4112 configuration option has the same effect for specific domains. See also the
4113 &%-qq%& option.
4114
4115 .vitem &%-oee%&
4116 .oindex "&%-oee%&"
4117 .cindex "error" "reporting"
4118 If an error is detected while a non-SMTP message is being received (for
4119 example, a malformed address), the error is reported to the sender in a mail
4120 message.
4121
4122 .cindex "return code" "for &%-oee%&"
4123 Provided
4124 this error message is successfully sent, the Exim receiving process
4125 exits with a return code of zero. If not, the return code is 2 if the problem
4126 is that the original message has no recipients, or 1 for any other error.
4127 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4128
4129 .vitem &%-oem%&
4130 .oindex "&%-oem%&"
4131 .cindex "error" "reporting"
4132 .cindex "return code" "for &%-oem%&"
4133 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4134 return code, whether or not the error message was successfully sent.
4135 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4136
4137 .vitem &%-oep%&
4138 .oindex "&%-oep%&"
4139 .cindex "error" "reporting"
4140 If an error is detected while a non-SMTP message is being received, the
4141 error is reported by writing a message to the standard error file (stderr).
4142 .cindex "return code" "for &%-oep%&"
4143 The return code is 1 for all errors.
4144
4145 .vitem &%-oeq%&
4146 .oindex "&%-oeq%&"
4147 .cindex "error" "reporting"
4148 This option is supported for compatibility with Sendmail, but has the same
4149 effect as &%-oep%&.
4150
4151 .vitem &%-oew%&
4152 .oindex "&%-oew%&"
4153 .cindex "error" "reporting"
4154 This option is supported for compatibility with Sendmail, but has the same
4155 effect as &%-oem%&.
4156
4157 .vitem &%-oi%&
4158 .oindex "&%-oi%&"
4159 .cindex "dot" "in incoming non-SMTP message"
4160 This option, which has the same effect as &%-i%&, specifies that a dot on a
4161 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4162 single dot does terminate, though Exim does no special processing for other
4163 lines that start with a dot. This option is set by default if Exim is called as
4164 &'rmail'&. See also &%-ti%&.
4165
4166 .vitem &%-oitrue%&
4167 .oindex "&%-oitrue%&"
4168 This option is treated as synonymous with &%-oi%&.
4169
4170 .vitem &%-oMa%&&~<&'host&~address'&>
4171 .oindex "&%-oMa%&"
4172 .cindex "sender" "host address, specifying for local message"
4173 A number of options starting with &%-oM%& can be used to set values associated
4174 with remote hosts on locally-submitted messages (that is, messages not received
4175 over TCP/IP). These options can be used by any caller in conjunction with the
4176 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4177 other circumstances, they are ignored unless the caller is trusted.
4178
4179 The &%-oMa%& option sets the sender host address. This may include a port
4180 number at the end, after a full stop (period). For example:
4181 .code
4182 exim -bs -oMa 10.9.8.7.1234
4183 .endd
4184 An alternative syntax is to enclose the IP address in square brackets,
4185 followed by a colon and the port number:
4186 .code
4187 exim -bs -oMa [10.9.8.7]:1234
4188 .endd
4189 The IP address is placed in the &$sender_host_address$& variable, and the
4190 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4191 are present on the command line, the sender host IP address is taken from
4192 whichever one is last.
4193
4194 .vitem &%-oMaa%&&~<&'name'&>
4195 .oindex "&%-oMaa%&"
4196 .cindex "authentication" "name, specifying for local message"
4197 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4198 option sets the value of &$sender_host_authenticated$& (the authenticator
4199 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4200 This option can be used with &%-bh%& and &%-bs%& to set up an
4201 authenticated SMTP session without actually using the SMTP AUTH command.
4202
4203 .vitem &%-oMai%&&~<&'string'&>
4204 .oindex "&%-oMai%&"
4205 .cindex "authentication" "id, specifying for local message"
4206 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4207 option sets the value of &$authenticated_id$& (the id that was authenticated).
4208 This overrides the default value (the caller's login id, except with &%-bh%&,
4209 where there is no default) for messages from local sources. See chapter
4210 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4211
4212 .vitem &%-oMas%&&~<&'address'&>
4213 .oindex "&%-oMas%&"
4214 .cindex "authentication" "sender, specifying for local message"
4215 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4216 option sets the authenticated sender value in &$authenticated_sender$&. It
4217 overrides the sender address that is created from the caller's login id for
4218 messages from local sources, except when &%-bh%& is used, when there is no
4219 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4220 specified on a MAIL command overrides this value. See chapter
4221 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4222
4223 .vitem &%-oMi%&&~<&'interface&~address'&>
4224 .oindex "&%-oMi%&"
4225 .cindex "interface" "address, specifying for local message"
4226 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4227 option sets the IP interface address value. A port number may be included,
4228 using the same syntax as for &%-oMa%&. The interface address is placed in
4229 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4230
4231 .vitem &%-oMm%&&~<&'message&~reference'&>
4232 .oindex "&%-oMm%&"
4233 .cindex "message reference" "message reference, specifying for local message"
4234 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4235 option sets the message reference, e.g. message-id, and is logged during
4236 delivery. This is useful when some kind of audit trail is required to tie
4237 messages together. The format of the message reference is checked and will
4238 abort if the format is invalid. The option will only be accepted if exim is
4239 running in trusted mode, not as any regular user.
4240
4241 The best example of a message reference is when Exim sends a bounce message.
4242 The message reference is the message-id of the original message for which Exim
4243 is sending the bounce.
4244
4245 .vitem &%-oMr%&&~<&'protocol&~name'&>
4246 .oindex "&%-oMr%&"
4247 .cindex "protocol, specifying for local message"
4248 .vindex "&$received_protocol$&"
4249 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4250 option sets the received protocol value that is stored in
4251 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4252 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4253 SMTP protocol names (see the description of &$received_protocol$& in section
4254 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4255 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4256 be set by &%-oMr%&.
4257
4258 .vitem &%-oMs%&&~<&'host&~name'&>
4259 .oindex "&%-oMs%&"
4260 .cindex "sender" "host name, specifying for local message"
4261 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4262 option sets the sender host name in &$sender_host_name$&. When this option is
4263 present, Exim does not attempt to look up a host name from an IP address; it
4264 uses the name it is given.
4265
4266 .vitem &%-oMt%&&~<&'ident&~string'&>
4267 .oindex "&%-oMt%&"
4268 .cindex "sender" "ident string, specifying for local message"
4269 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4270 option sets the sender ident value in &$sender_ident$&. The default setting for
4271 local callers is the login id of the calling process, except when &%-bh%& is
4272 used, when there is no default.
4273
4274 .vitem &%-om%&
4275 .oindex "&%-om%&"
4276 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4277 In Sendmail, this option means &"me too"&, indicating that the sender of a
4278 message should receive a copy of the message if the sender appears in an alias
4279 expansion. Exim always does this, so the option does nothing.
4280
4281 .vitem &%-oo%&
4282 .oindex "&%-oo%&"
4283 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4284 This option is ignored. In Sendmail it specifies &"old style headers"&,
4285 whatever that means.
4286
4287 .vitem &%-oP%&&~<&'path'&>
4288 .oindex "&%-oP%&"
4289 .cindex "pid (process id)" "of daemon"
4290 .cindex "daemon" "process id (pid)"
4291 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4292 value. The option specifies the file to which the process id of the daemon is
4293 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4294 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4295 because in those cases, the normal pid file is not used.
4296
4297 .vitem &%-or%&&~<&'time'&>
4298 .oindex "&%-or%&"
4299 .cindex "timeout" "for non-SMTP input"
4300 This option sets a timeout value for incoming non-SMTP messages. If it is not
4301 set, Exim will wait forever for the standard input. The value can also be set
4302 by the &%receive_timeout%& option. The format used for specifying times is
4303 described in section &<<SECTtimeformat>>&.
4304
4305 .vitem &%-os%&&~<&'time'&>
4306 .oindex "&%-os%&"
4307 .cindex "timeout" "for SMTP input"
4308 .cindex "SMTP" "input timeout"
4309 This option sets a timeout value for incoming SMTP messages. The timeout
4310 applies to each SMTP command and block of data. The value can also be set by
4311 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4312 for specifying times is described in section &<<SECTtimeformat>>&.
4313
4314 .vitem &%-ov%&
4315 .oindex "&%-ov%&"
4316 This option has exactly the same effect as &%-v%&.
4317
4318 .vitem &%-oX%&&~<&'number&~or&~string'&>
4319 .oindex "&%-oX%&"
4320 .cindex "TCP/IP" "setting listening ports"
4321 .cindex "TCP/IP" "setting listening interfaces"
4322 .cindex "port" "receiving TCP/IP"
4323 This option is relevant only when the &%-bd%& (start listening daemon) option
4324 is also given. It controls which ports and interfaces the daemon uses. Details
4325 of the syntax, and how it interacts with configuration file options, are given
4326 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4327 file is written unless &%-oP%& is also present to specify a pid file name.
4328
4329 .vitem &%-pd%&
4330 .oindex "&%-pd%&"
4331 .cindex "Perl" "starting the interpreter"
4332 This option applies when an embedded Perl interpreter is linked with Exim (see
4333 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4334 option, forcing the starting of the interpreter to be delayed until it is
4335 needed.
4336
4337 .vitem &%-ps%&
4338 .oindex "&%-ps%&"
4339 .cindex "Perl" "starting the interpreter"
4340 This option applies when an embedded Perl interpreter is linked with Exim (see
4341 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4342 option, forcing the starting of the interpreter to occur as soon as Exim is
4343 started.
4344
4345 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4346 .oindex "&%-p%&"
4347 For compatibility with Sendmail, this option is equivalent to
4348 .display
4349 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4350 .endd
4351 It sets the incoming protocol and host name (for trusted callers). The
4352 host name and its colon can be omitted when only the protocol is to be set.
4353 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4354 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4355 or &`s`& using this option (but that does not seem a real limitation).
4356
4357 .vitem &%-q%&
4358 .oindex "&%-q%&"
4359 .cindex "queue runner" "starting manually"
4360 This option is normally restricted to admin users. However, there is a
4361 configuration option called &%prod_requires_admin%& which can be set false to
4362 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4363 and &%-S%& options).
4364
4365 .cindex "queue runner" "description of operation"
4366 The &%-q%& option starts one queue runner process. This scans the queue of
4367 waiting messages, and runs a delivery process for each one in turn. It waits
4368 for each delivery process to finish before starting the next one. A delivery
4369 process may not actually do any deliveries if the retry times for the addresses
4370 have not been reached. Use &%-qf%& (see below) if you want to override this.
4371
4372 If
4373 .cindex "SMTP" "passed connection"
4374 .cindex "SMTP" "multiple deliveries"
4375 .cindex "multiple SMTP deliveries"
4376 the delivery process spawns other processes to deliver other messages down
4377 passed SMTP connections, the queue runner waits for these to finish before
4378 proceeding.
4379
4380 When all the queued messages have been considered, the original queue runner
4381 process terminates. In other words, a single pass is made over the waiting
4382 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4383 this to be repeated periodically.
4384
4385 Exim processes the waiting messages in an unpredictable order. It isn't very
4386 random, but it is likely to be different each time, which is all that matters.
4387 If one particular message screws up a remote MTA, other messages to the same
4388 MTA have a chance of getting through if they get tried first.
4389
4390 It is possible to cause the messages to be processed in lexical message id
4391 order, which is essentially the order in which they arrived, by setting the
4392 &%queue_run_in_order%& option, but this is not recommended for normal use.
4393
4394 .vitem &%-q%&<&'qflags'&>
4395 The &%-q%& option may be followed by one or more flag letters that change its
4396 behaviour. They are all optional, but if more than one is present, they must
4397 appear in the correct order. Each flag is described in a separate item below.
4398
4399 .vitem &%-qq...%&
4400 .oindex "&%-qq%&"
4401 .cindex "queue" "double scanning"
4402 .cindex "queue" "routing"
4403 .cindex "routing" "whole queue before delivery"
4404 An option starting with &%-qq%& requests a two-stage queue run. In the first
4405 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4406 every domain. Addresses are routed, local deliveries happen, but no remote
4407 transports are run.
4408
4409 .cindex "hints database" "remembering routing"
4410 The hints database that remembers which messages are waiting for specific hosts
4411 is updated, as if delivery to those hosts had been deferred. After this is
4412 complete, a second, normal queue scan happens, with routing and delivery taking
4413 place as normal. Messages that are routed to the same host should mostly be
4414 delivered down a single SMTP
4415 .cindex "SMTP" "passed connection"
4416 .cindex "SMTP" "multiple deliveries"
4417 .cindex "multiple SMTP deliveries"
4418 connection because of the hints that were set up during the first queue scan.
4419 This option may be useful for hosts that are connected to the Internet
4420 intermittently.
4421
4422 .vitem &%-q[q]i...%&
4423 .oindex "&%-qi%&"
4424 .cindex "queue" "initial delivery"
4425 If the &'i'& flag is present, the queue runner runs delivery processes only for
4426 those messages that haven't previously been tried. (&'i'& stands for &"initial
4427 delivery"&.) This can be helpful if you are putting messages on the queue using
4428 &%-odq%& and want a queue runner just to process the new messages.
4429
4430 .vitem &%-q[q][i]f...%&
4431 .oindex "&%-qf%&"
4432 .cindex "queue" "forcing delivery"
4433 .cindex "delivery" "forcing in queue run"
4434 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4435 message, whereas without &'f'& only those non-frozen addresses that have passed
4436 their retry times are tried.
4437
4438 .vitem &%-q[q][i]ff...%&
4439 .oindex "&%-qff%&"
4440 .cindex "frozen messages" "forcing delivery"
4441 If &'ff'& is present, a delivery attempt is forced for every message, whether
4442 frozen or not.
4443
4444 .vitem &%-q[q][i][f[f]]l%&
4445 .oindex "&%-ql%&"
4446 .cindex "queue" "local deliveries only"
4447 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4448 be done. If a message requires any remote deliveries, it remains on the queue
4449 for later delivery.
4450
4451 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4452 .cindex "queue" "delivering specific messages"
4453 When scanning the queue, Exim can be made to skip over messages whose ids are
4454 lexically less than a given value by following the &%-q%& option with a
4455 starting message id. For example:
4456 .code
4457 exim -q 0t5C6f-0000c8-00
4458 .endd
4459 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4460 second message id is given, messages whose ids are lexically greater than it
4461 are also skipped. If the same id is given twice, for example,
4462 .code
4463 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4464 .endd
4465 just one delivery process is started, for that message. This differs from
4466 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4467 that it counts as a delivery from a queue run. Note that the selection
4468 mechanism does not affect the order in which the messages are scanned. There
4469 are also other ways of selecting specific sets of messages for delivery in a
4470 queue run &-- see &%-R%& and &%-S%&.
4471
4472 .vitem &%-q%&<&'qflags'&><&'time'&>
4473 .cindex "queue runner" "starting periodically"
4474 .cindex "periodic queue running"
4475 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4476 starting a queue runner process at intervals specified by the given time value
4477 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4478 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4479 single daemon process handles both functions. A common way of starting up a
4480 combined daemon at system boot time is to use a command such as
4481 .code
4482 /usr/exim/bin/exim -bd -q30m
4483 .endd
4484 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4485 process every 30 minutes.
4486
4487 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4488 pid file is written unless one is explicitly requested by the &%-oP%& option.
4489
4490 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4491 .oindex "&%-qR%&"
4492 This option is synonymous with &%-R%&. It is provided for Sendmail
4493 compatibility.
4494
4495 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4496 .oindex "&%-qS%&"
4497 This option is synonymous with &%-S%&.
4498
4499 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4500 .oindex "&%-R%&"
4501 .cindex "queue runner" "for specific recipients"
4502 .cindex "delivery" "to given domain"
4503 .cindex "domain" "delivery to"
4504 The <&'rsflags'&> may be empty, in which case the white space before the string
4505 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4506 which are the possible values for <&'rsflags'&>. White space is required if
4507 <&'rsflags'&> is not empty.
4508
4509 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4510 perform a single queue run, except that, when scanning the messages on the
4511 queue, Exim processes only those that have at least one undelivered recipient
4512 address containing the given string, which is checked in a case-independent
4513 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4514 regular expression; otherwise it is a literal string.
4515
4516 If you want to do periodic queue runs for messages with specific recipients,
4517 you can combine &%-R%& with &%-q%& and a time value. For example:
4518 .code
4519 exim -q25m -R @special.domain.example
4520 .endd
4521 This example does a queue run for messages with recipients in the given domain
4522 every 25 minutes. Any additional flags that are specified with &%-q%& are
4523 applied to each queue run.
4524
4525 Once a message is selected for delivery by this mechanism, all its addresses
4526 are processed. For the first selected message, Exim overrides any retry
4527 information and forces a delivery attempt for each undelivered address. This
4528 means that if delivery of any address in the first message is successful, any
4529 existing retry information is deleted, and so delivery attempts for that
4530 address in subsequently selected messages (which are processed without forcing)
4531 will run. However, if delivery of any address does not succeed, the retry
4532 information is updated, and in subsequently selected messages, the failing
4533 address will be skipped.
4534
4535 .cindex "frozen messages" "forcing delivery"
4536 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4537 all selected messages, not just the first; frozen messages are included when
4538 &'ff'& is present.
4539
4540 The &%-R%& option makes it straightforward to initiate delivery of all messages
4541 to a given domain after a host has been down for some time. When the SMTP
4542 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4543 effect is to run Exim with the &%-R%& option, but it can be configured to run
4544 an arbitrary command instead.
4545
4546 .vitem &%-r%&
4547 .oindex "&%-r%&"
4548 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4549
4550 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4551 .oindex "&%-S%&"
4552 .cindex "delivery" "from given sender"
4553 .cindex "queue runner" "for specific senders"
4554 This option acts like &%-R%& except that it checks the string against each
4555 message's sender instead of against the recipients. If &%-R%& is also set, both
4556 conditions must be met for a message to be selected. If either of the options
4557 has &'f'& or &'ff'& in its flags, the associated action is taken.
4558
4559 .vitem &%-Tqt%&&~<&'times'&>
4560 .oindex "&%-Tqt%&"
4561 This is an option that is exclusively for use by the Exim testing suite. It is not
4562 recognized when Exim is run normally. It allows for the setting up of explicit
4563 &"queue times"& so that various warning/retry features can be tested.
4564
4565 .vitem &%-t%&
4566 .oindex "&%-t%&"
4567 .cindex "recipient" "extracting from header lines"
4568 .cindex "&'Bcc:'& header line"
4569 .cindex "&'Cc:'& header line"
4570 .cindex "&'To:'& header line"
4571 When Exim is receiving a locally-generated, non-SMTP message on its standard
4572 input, the &%-t%& option causes the recipients of the message to be obtained
4573 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4574 from the command arguments. The addresses are extracted before any rewriting
4575 takes place and the &'Bcc:'& header line, if present, is then removed.
4576
4577 .cindex "Sendmail compatibility" "&%-t%& option"
4578 If the command has any arguments, they specify addresses to which the message
4579 is &'not'& to be delivered. That is, the argument addresses are removed from
4580 the recipients list obtained from the headers. This is compatible with Smail 3
4581 and in accordance with the documented behaviour of several versions of
4582 Sendmail, as described in man pages on a number of operating systems (e.g.
4583 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4584 argument addresses to those obtained from the headers, and the O'Reilly
4585 Sendmail book documents it that way. Exim can be made to add argument addresses
4586 instead of subtracting them by setting the option
4587 &%extract_addresses_remove_arguments%& false.
4588
4589 .cindex "&%Resent-%& header lines" "with &%-t%&"
4590 If there are any &%Resent-%& header lines in the message, Exim extracts
4591 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4592 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4593 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4594 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4595
4596 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4597 message is resent several times). The RFC also specifies that they should be
4598 added at the front of the message, and separated by &'Received:'& lines. It is
4599 not at all clear how &%-t%& should operate in the present of multiple sets,
4600 nor indeed exactly what constitutes a &"set"&.
4601 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4602 are often added at the end of the header, and if a message is resent more than
4603 once, it is common for the original set of &%Resent-%& headers to be renamed as
4604 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4605
4606 .vitem &%-ti%&
4607 .oindex "&%-ti%&"
4608 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4609 compatibility with Sendmail.
4610
4611 .vitem &%-tls-on-connect%&
4612 .oindex "&%-tls-on-connect%&"
4613 .cindex "TLS" "use without STARTTLS"
4614 .cindex "TLS" "automatic start"
4615 This option is available when Exim is compiled with TLS support. It forces all
4616 incoming SMTP connections to behave as if the incoming port is listed in the
4617 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4618 &<<CHAPTLS>>& for further details.
4619
4620
4621 .vitem &%-U%&
4622 .oindex "&%-U%&"
4623 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4624 Sendmail uses this option for &"initial message submission"&, and its
4625 documentation states that in future releases, it may complain about
4626 syntactically invalid messages rather than fixing them when this flag is not
4627 set. Exim ignores this option.
4628
4629 .vitem &%-v%&
4630 .oindex "&%-v%&"
4631 This option causes Exim to write information to the standard error stream,
4632 describing what it is doing. In particular, it shows the log lines for
4633 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4634 dialogue is shown. Some of the log lines shown may not actually be written to
4635 the log if the setting of &%log_selector%& discards them. Any relevant
4636 selectors are shown with each log line. If none are shown, the logging is
4637 unconditional.
4638
4639 .vitem &%-x%&
4640 .oindex "&%-x%&"
4641 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4642 National Language Support extended characters in the body of the mail item"&).
4643 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4644 this option.
4645
4646 .vitem &%-X%&&~<&'logfile'&>
4647 .oindex "&%-X%&"
4648 This option is interpreted by Sendmail to cause debug information to be sent
4649 to the named file.  It is ignored by Exim.
4650
4651 .vitem &%-z%&&~<&'log-line'&>
4652 .oindex "&%-z%&"
4653 This option writes its argument to Exim's logfile.
4654 Use is restricted to administrators; the intent is for operational notes.
4655 Quotes should be used to maintain a multi-word item as a single argument,
4656 under most shells.
4657 .endlist
4658
4659 .ecindex IIDclo1
4660 .ecindex IIDclo2
4661
4662
4663 . ////////////////////////////////////////////////////////////////////////////
4664 . Insert a stylized DocBook comment here, to identify the end of the command
4665 . line options. This is for the benefit of the Perl script that automatically
4666 . creates a man page for the options.
4667 . ////////////////////////////////////////////////////////////////////////////
4668
4669 .literal xml
4670 <!-- === End of command line options === -->
4671 .literal off
4672
4673
4674
4675
4676
4677 . ////////////////////////////////////////////////////////////////////////////
4678 . ////////////////////////////////////////////////////////////////////////////
4679
4680
4681 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4682          "The runtime configuration file"
4683
4684 .cindex "run time configuration"
4685 .cindex "configuration file" "general description"
4686 .cindex "CONFIGURE_FILE"
4687 .cindex "configuration file" "errors in"
4688 .cindex "error" "in configuration file"
4689 .cindex "return code" "for bad configuration"
4690 Exim uses a single run time configuration file that is read whenever an Exim
4691 binary is executed. Note that in normal operation, this happens frequently,
4692 because Exim is designed to operate in a distributed manner, without central
4693 control.
4694
4695 If a syntax error is detected while reading the configuration file, Exim
4696 writes a message on the standard error, and exits with a non-zero return code.
4697 The message is also written to the panic log. &*Note*&: Only simple syntax
4698 errors can be detected at this time. The values of any expanded options are
4699 not checked until the expansion happens, even when the expansion does not
4700 actually alter the string.
4701
4702 The name of the configuration file is compiled into the binary for security
4703 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4704 most configurations, this specifies a single file. However, it is permitted to
4705 give a colon-separated list of file names, in which case Exim uses the first
4706 existing file in the list.
4707
4708 .cindex "EXIM_USER"
4709 .cindex "EXIM_GROUP"
4710 .cindex "CONFIGURE_OWNER"
4711 .cindex "CONFIGURE_GROUP"
4712 .cindex "configuration file" "ownership"
4713 .cindex "ownership" "configuration file"
4714 The run time configuration file must be owned by root or by the user that is
4715 specified at compile time by the CONFIGURE_OWNER option (if set). The
4716 configuration file must not be world-writeable, or group-writeable unless its
4717 group is the root group or the one specified at compile time by the
4718 CONFIGURE_GROUP option.
4719
4720 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4721 to root, anybody who is able to edit the run time configuration file has an
4722 easy way to run commands as root. If you specify a user or group in the
4723 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4724 who are members of that group will trivially be able to obtain root privileges.
4725
4726 Up to Exim version 4.72, the run time configuration file was also permitted to
4727 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4728 since it offered a simple privilege escalation for any attacker who managed to
4729 compromise the Exim user account.
4730
4731 A default configuration file, which will work correctly in simple situations,
4732 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4733 defines just one file name, the installation process copies the default
4734 configuration to a new file of that name if it did not previously exist. If
4735 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4736 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4737 configuration.
4738
4739
4740
4741 .section "Using a different configuration file" "SECID40"
4742 .cindex "configuration file" "alternate"
4743 A one-off alternate configuration can be specified by the &%-C%& command line
4744 option, which may specify a single file or a list of files. However, when
4745 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4746 unless the argument for &%-C%& is identical to the built-in value from
4747 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4748 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4749 is useful mainly for checking the syntax of configuration files before
4750 installing them. No owner or group checks are done on a configuration file
4751 specified by &%-C%&, if root privilege has been dropped.
4752
4753 Even the Exim user is not trusted to specify an arbitrary configuration file
4754 with the &%-C%& option to be used with root privileges, unless that file is
4755 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4756 testing a configuration using &%-C%& right through message reception and
4757 delivery, even if the caller is root. The reception works, but by that time,
4758 Exim is running as the Exim user, so when it re-execs to regain privilege for
4759 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4760 can test reception and delivery using two separate commands (one to put a
4761 message on the queue, using &%-odq%&, and another to do the delivery, using
4762 &%-M%&).
4763
4764 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4765 prefix string with which any file named in a &%-C%& command line option must
4766 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4767 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4768 name can be used with &%-C%&.
4769
4770 One-off changes to a configuration can be specified by the &%-D%& command line
4771 option, which defines and overrides values for macros used inside the
4772 configuration file. However, like &%-C%&, the use of this option by a
4773 non-privileged user causes Exim to discard its root privilege.
4774 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4775 completely disabled, and its use causes an immediate error exit.
4776
4777 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4778 to declare certain macro names trusted, such that root privilege will not
4779 necessarily be discarded.
4780 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4781 considered safe and, if &%-D%& only supplies macros from this list, and the
4782 values are acceptable, then Exim will not give up root privilege if the caller
4783 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4784 transition mechanism and is expected to be removed in the future.  Acceptable
4785 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4786
4787 Some sites may wish to use the same Exim binary on different machines that
4788 share a file system, but to use different configuration files on each machine.
4789 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4790 looks for a file whose name is the configuration file name followed by a dot
4791 and the machine's node name, as obtained from the &[uname()]& function. If this
4792 file does not exist, the standard name is tried. This processing occurs for
4793 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4794
4795 In some esoteric situations different versions of Exim may be run under
4796 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4797 help with this. See the comments in &_src/EDITME_& for details.
4798
4799
4800
4801 .section "Configuration file format" "SECTconffilfor"
4802 .cindex "configuration file" "format of"
4803 .cindex "format" "configuration file"
4804 Exim's configuration file is divided into a number of different parts. General
4805 option settings must always appear at the start of the file. The other parts
4806 are all optional, and may appear in any order. Each part other than the first
4807 is introduced by the word &"begin"& followed by the name of the part. The
4808 optional parts are:
4809
4810 .ilist
4811 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4812 &<<CHAPACL>>&).
4813 .next
4814 .cindex "AUTH" "configuration"
4815 &'authenticators'&: Configuration settings for the authenticator drivers. These
4816 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4817 .next
4818 &'routers'&: Configuration settings for the router drivers. Routers process
4819 addresses and determine how the message is to be delivered (see chapters
4820 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4821 .next
4822 &'transports'&: Configuration settings for the transport drivers. Transports
4823 define mechanisms for copying messages to destinations (see chapters
4824 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4825 .next
4826 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4827 If there is no retry section, or if it is empty (that is, no retry rules are
4828 defined), Exim will not retry deliveries. In this situation, temporary errors
4829 are treated the same as permanent errors. Retry rules are discussed in chapter
4830 &<<CHAPretry>>&.
4831 .next
4832 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4833 when new addresses are generated during delivery. Rewriting is discussed in
4834 chapter &<<CHAPrewrite>>&.
4835 .next
4836 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4837 want to use this feature, you must set
4838 .code
4839 LOCAL_SCAN_HAS_OPTIONS=yes
4840 .endd
4841 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4842 facility are given in chapter &<<CHAPlocalscan>>&.
4843 .endlist
4844
4845 .cindex "configuration file" "leading white space in"
4846 .cindex "configuration file" "trailing white space in"
4847 .cindex "white space" "in configuration file"
4848 Leading and trailing white space in configuration lines is always ignored.
4849
4850 Blank lines in the file, and lines starting with a # character (ignoring
4851 leading white space) are treated as comments and are ignored. &*Note*&: A
4852 # character other than at the beginning of a line is not treated specially,
4853 and does not introduce a comment.
4854
4855 Any non-comment line can be continued by ending it with a backslash. Note that
4856 the general rule for white space means that trailing white space after the
4857 backslash and leading white space at the start of continuation
4858 lines is ignored. Comment lines beginning with # (but not empty lines) may
4859 appear in the middle of a sequence of continuation lines.
4860
4861 A convenient way to create a configuration file is to start from the
4862 default, which is supplied in &_src/configure.default_&, and add, delete, or
4863 change settings as required.
4864
4865 The ACLs, retry rules, and rewriting rules have their own syntax which is
4866 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4867 respectively. The other parts of the configuration file have some syntactic
4868 items in common, and these are described below, from section &<<SECTcos>>&
4869 onwards. Before that, the inclusion, macro, and conditional facilities are
4870 described.
4871
4872
4873
4874 .section "File inclusions in the configuration file" "SECID41"
4875 .cindex "inclusions in configuration file"
4876 .cindex "configuration file" "including other files"
4877 .cindex "&`.include`& in configuration file"
4878 .cindex "&`.include_if_exists`& in configuration file"
4879 You can include other files inside Exim's run time configuration file by
4880 using this syntax:
4881 .display
4882 &`.include`& <&'file name'&>
4883 &`.include_if_exists`& <&'file name'&>
4884 .endd
4885 on a line by itself. Double quotes round the file name are optional. If you use
4886 the first form, a configuration error occurs if the file does not exist; the
4887 second form does nothing for non-existent files. In all cases, an absolute file
4888 name is required.
4889
4890 Includes may be nested to any depth, but remember that Exim reads its
4891 configuration file often, so it is a good idea to keep them to a minimum.
4892 If you change the contents of an included file, you must HUP the daemon,
4893 because an included file is read only when the configuration itself is read.
4894
4895 The processing of inclusions happens early, at a physical line level, so, like
4896 comment lines, an inclusion can be used in the middle of an option setting,
4897 for example:
4898 .code
4899 hosts_lookup = a.b.c \
4900                .include /some/file
4901 .endd
4902 Include processing happens after macro processing (see below). Its effect is to
4903 process the lines of the included file as if they occurred inline where the
4904 inclusion appears.
4905
4906
4907
4908 .section "Macros in the configuration file" "SECTmacrodefs"
4909 .cindex "macro" "description of"
4910 .cindex "configuration file" "macros"
4911 If a line in the main part of the configuration (that is, before the first
4912 &"begin"& line) begins with an upper case letter, it is taken as a macro
4913 definition, and must be of the form
4914 .display
4915 <&'name'&> = <&'rest of line'&>
4916 .endd
4917 The name must consist of letters, digits, and underscores, and need not all be
4918 in upper case, though that is recommended. The rest of the line, including any
4919 continuations, is the replacement text, and has leading and trailing white
4920 space removed. Quotes are not removed. The replacement text can never end with
4921 a backslash character, but this doesn't seem to be a serious limitation.
4922
4923 Macros may also be defined between router, transport, authenticator, or ACL
4924 definitions. They may not, however, be defined within an individual driver or
4925 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4926
4927 .section "Macro substitution" "SECID42"
4928 Once a macro is defined, all subsequent lines in the file (and any included
4929 files) are scanned for the macro name; if there are several macros, the line is
4930 scanned for each in turn, in the order in which the macros are defined. The
4931 replacement text is not re-scanned for the current macro, though it is scanned
4932 for subsequently defined macros. For this reason, a macro name may not contain
4933 the name of a previously defined macro as a substring. You could, for example,
4934 define
4935 .display
4936 &`ABCD_XYZ = `&<&'something'&>
4937 &`ABCD = `&<&'something else'&>
4938 .endd
4939 but putting the definitions in the opposite order would provoke a configuration
4940 error. Macro expansion is applied to individual physical lines from the file,
4941 before checking for line continuation or file inclusion (see above). If a line
4942 consists solely of a macro name, and the expansion of the macro is empty, the
4943 line is ignored. A macro at the start of a line may turn the line into a
4944 comment line or a &`.include`& line.
4945
4946
4947 .section "Redefining macros" "SECID43"
4948 Once defined, the value of a macro can be redefined later in the configuration
4949 (or in an included file). Redefinition is specified by using &'=='& instead of
4950 &'='&. For example:
4951 .code
4952 MAC =  initial value
4953 ...
4954 MAC == updated value
4955 .endd
4956 Redefinition does not alter the order in which the macros are applied to the
4957 subsequent lines of the configuration file. It is still the same order in which
4958 the macros were originally defined. All that changes is the macro's value.
4959 Redefinition makes it possible to accumulate values. For example:
4960 .code
4961 MAC =  initial value
4962 ...
4963 MAC == MAC and something added
4964 .endd
4965 This can be helpful in situations where the configuration file is built
4966 from a number of other files.
4967
4968 .section "Overriding macro values" "SECID44"
4969 The values set for macros in the configuration file can be overridden by the
4970 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
4971 used, unless called by root or the Exim user. A definition on the command line
4972 using the &%-D%& option causes all definitions and redefinitions within the
4973 file to be ignored.
4974
4975
4976
4977 .section "Example of macro usage" "SECID45"
4978 As an example of macro usage, consider a configuration where aliases are looked
4979 up in a MySQL database. It helps to keep the file less cluttered if long
4980 strings such as SQL statements are defined separately as macros, for example:
4981 .code
4982 ALIAS_QUERY = select mailbox from user where \
4983               login='${quote_mysql:$local_part}';
4984 .endd
4985 This can then be used in a &(redirect)& router setting like this:
4986 .code
4987 data = ${lookup mysql{ALIAS_QUERY}}
4988 .endd
4989 In earlier versions of Exim macros were sometimes used for domain, host, or
4990 address lists. In Exim 4 these are handled better by named lists &-- see
4991 section &<<SECTnamedlists>>&.
4992
4993
4994 .section "Conditional skips in the configuration file" "SECID46"
4995 .cindex "configuration file" "conditional skips"
4996 .cindex "&`.ifdef`&"
4997 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
4998 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
4999 portions of the configuration file. The processing happens whenever the file is
5000 read (that is, when an Exim binary starts to run).
5001
5002 The implementation is very simple. Instances of the first four directives must
5003 be followed by text that includes the names of one or macros. The condition
5004 that is tested is whether or not any macro substitution has taken place in the
5005 line. Thus:
5006 .code
5007 .ifdef AAA
5008 message_size_limit = 50M
5009 .else
5010 message_size_limit = 100M
5011 .endif
5012 .endd
5013 sets a message size limit of 50M if the macro &`AAA`& is defined, and 100M
5014 otherwise. If there is more than one macro named on the line, the condition
5015 is true if any of them are defined. That is, it is an &"or"& condition. To
5016 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5017
5018 Although you can use a macro expansion to generate one of these directives,
5019 it is not very useful, because the condition &"there was a macro substitution
5020 in this line"& will always be true.
5021
5022 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5023 to clarify complicated nestings.
5024
5025
5026
5027 .section "Common option syntax" "SECTcos"
5028 .cindex "common option syntax"
5029 .cindex "syntax of common options"
5030 .cindex "configuration file" "common option syntax"
5031 For the main set of options, driver options, and &[local_scan()]& options,
5032 each setting is on a line by itself, and starts with a name consisting of
5033 lower-case letters and underscores. Many options require a data value, and in
5034 these cases the name must be followed by an equals sign (with optional white
5035 space) and then the value. For example:
5036 .code
5037 qualify_domain = mydomain.example.com
5038 .endd
5039 .cindex "hiding configuration option values"
5040 .cindex "configuration options" "hiding value of"
5041 .cindex "options" "hiding value of"
5042 Some option settings may contain sensitive data, for example, passwords for
5043 accessing databases. To stop non-admin users from using the &%-bP%& command
5044 line option to read these values, you can precede the option settings with the
5045 word &"hide"&. For example:
5046 .code
5047 hide mysql_servers = localhost/users/admin/secret-password
5048 .endd
5049 For non-admin users, such options are displayed like this:
5050 .code
5051 mysql_servers = <value not displayable>
5052 .endd
5053 If &"hide"& is used on a driver option, it hides the value of that option on
5054 all instances of the same driver.
5055
5056 The following sections describe the syntax used for the different data types
5057 that are found in option settings.
5058
5059
5060 .section "Boolean options" "SECID47"
5061 .cindex "format" "boolean"
5062 .cindex "boolean configuration values"
5063 .oindex "&%no_%&&'xxx'&"
5064 .oindex "&%not_%&&'xxx'&"
5065 Options whose type is given as boolean are on/off switches. There are two
5066 different ways of specifying such options: with and without a data value. If
5067 the option name is specified on its own without data, the switch is turned on;
5068 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5069 boolean options may be followed by an equals sign and one of the words
5070 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5071 the following two settings have exactly the same effect:
5072 .code
5073 queue_only
5074 queue_only = true
5075 .endd
5076 The following two lines also have the same (opposite) effect:
5077 .code
5078 no_queue_only
5079 queue_only = false
5080 .endd
5081 You can use whichever syntax you prefer.
5082
5083
5084
5085
5086 .section "Integer values" "SECID48"
5087 .cindex "integer configuration values"
5088 .cindex "format" "integer"
5089 If an option's type is given as &"integer"&, the value can be given in decimal,
5090 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5091 number is assumed. Otherwise, it is treated as an octal number unless it starts
5092 with the characters &"0x"&, in which case the remainder is interpreted as a
5093 hexadecimal number.
5094
5095 If an integer value is followed by the letter K, it is multiplied by 1024; if
5096 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5097 of integer option settings are output, values which are an exact multiple of
5098 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5099 and M. The printing style is independent of the actual input format that was
5100 used.
5101
5102
5103 .section "Octal integer values" "SECID49"
5104 .cindex "integer format"
5105 .cindex "format" "octal integer"
5106 If an option's type is given as &"octal integer"&, its value is always
5107 interpreted as an octal number, whether or not it starts with the digit zero.
5108 Such options are always output in octal.
5109
5110
5111 .section "Fixed point numbers" "SECID50"
5112 .cindex "fixed point configuration values"
5113 .cindex "format" "fixed point"
5114 If an option's type is given as &"fixed-point"&, its value must be a decimal
5115 integer, optionally followed by a decimal point and up to three further digits.
5116
5117
5118
5119 .section "Time intervals" "SECTtimeformat"
5120 .cindex "time interval" "specifying in configuration"
5121 .cindex "format" "time interval"
5122 A time interval is specified as a sequence of numbers, each followed by one of
5123 the following letters, with no intervening white space:
5124
5125 .table2 30pt
5126 .irow &%s%& seconds
5127 .irow &%m%& minutes
5128 .irow &%h%& hours
5129 .irow &%d%& days
5130 .irow &%w%& weeks
5131 .endtable
5132
5133 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5134 intervals are output in the same format. Exim does not restrict the values; it
5135 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5136
5137
5138
5139 .section "String values" "SECTstrings"
5140 .cindex "string" "format of configuration values"
5141 .cindex "format" "string"
5142 If an option's type is specified as &"string"&, the value can be specified with
5143 or without double-quotes. If it does not start with a double-quote, the value
5144 consists of the remainder of the line plus any continuation lines, starting at
5145 the first character after any leading white space, with trailing white space
5146 removed, and with no interpretation of the characters in the string. Because
5147 Exim removes comment lines (those beginning with #) at an early stage, they can
5148 appear in the middle of a multi-line string. The following two settings are
5149 therefore equivalent:
5150 .code
5151 trusted_users = uucp:mail
5152 trusted_users = uucp:\
5153                 # This comment line is ignored
5154                 mail
5155 .endd
5156 .cindex "string" "quoted"
5157 .cindex "escape characters in quoted strings"
5158 If a string does start with a double-quote, it must end with a closing
5159 double-quote, and any backslash characters other than those used for line
5160 continuation are interpreted as escape characters, as follows:
5161
5162 .table2 100pt
5163 .irow &`\\`&                     "single backslash"
5164 .irow &`\n`&                     "newline"
5165 .irow &`\r`&                     "carriage return"
5166 .irow &`\t`&                     "tab"
5167 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5168 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5169                                    character"
5170 .endtable
5171
5172 If a backslash is followed by some other character, including a double-quote
5173 character, that character replaces the pair.
5174
5175 Quoting is necessary only if you want to make use of the backslash escapes to
5176 insert special characters, or if you need to specify a value with leading or
5177 trailing spaces. These cases are rare, so quoting is almost never needed in
5178 current versions of Exim. In versions of Exim before 3.14, quoting was required
5179 in order to continue lines, so you may come across older configuration files
5180 and examples that apparently quote unnecessarily.
5181
5182
5183 .section "Expanded strings" "SECID51"
5184 .cindex "expansion" "definition of"
5185 Some strings in the configuration file are subjected to &'string expansion'&,
5186 by which means various parts of the string may be changed according to the
5187 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5188 is as just described; in particular, the handling of backslashes in quoted
5189 strings is done as part of the input process, before expansion takes place.
5190 However, backslash is also an escape character for the expander, so any
5191 backslashes that are required for that reason must be doubled if they are
5192 within a quoted configuration string.
5193
5194
5195 .section "User and group names" "SECID52"
5196 .cindex "user name" "format of"
5197 .cindex "format" "user name"
5198 .cindex "groups" "name format"
5199 .cindex "format" "group name"
5200 User and group names are specified as strings, using the syntax described
5201 above, but the strings are interpreted specially. A user or group name must
5202 either consist entirely of digits, or be a name that can be looked up using the
5203 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5204
5205
5206 .section "List construction" "SECTlistconstruct"
5207 .cindex "list" "syntax of in configuration"
5208 .cindex "format" "list item in configuration"
5209 .cindex "string" "list, definition of"
5210 The data for some configuration options is a list of items, with colon as the
5211 default separator. Many of these options are shown with type &"string list"& in
5212 the descriptions later in this document. Others are listed as &"domain list"&,
5213 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5214 are all the same; however, those other than &"string list"& are subject to
5215 particular kinds of interpretation, as described in chapter
5216 &<<CHAPdomhosaddlists>>&.
5217
5218 In all these cases, the entire list is treated as a single string as far as the
5219 input syntax is concerned. The &%trusted_users%& setting in section
5220 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5221 in a list, it must be entered as two colons. Leading and trailing white space
5222 on each item in a list is ignored. This makes it possible to include items that
5223 start with a colon, and in particular, certain forms of IPv6 address. For
5224 example, the list
5225 .code
5226 local_interfaces = 127.0.0.1 : ::::1
5227 .endd
5228 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5229
5230 &*Note*&: Although leading and trailing white space is ignored in individual
5231 list items, it is not ignored when parsing the list. The space after the first
5232 colon in the example above is necessary. If it were not there, the list would
5233 be interpreted as the two items 127.0.0.1:: and 1.
5234
5235 .section "Changing list separators" "SECID53"
5236 .cindex "list separator" "changing"
5237 .cindex "IPv6" "addresses in lists"
5238 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5239 introduced to allow the separator character to be changed. If a list begins
5240 with a left angle bracket, followed by any punctuation character, that
5241 character is used instead of colon as the list separator. For example, the list
5242 above can be rewritten to use a semicolon separator like this:
5243 .code
5244 local_interfaces = <; 127.0.0.1 ; ::1
5245 .endd
5246 This facility applies to all lists, with the exception of the list in
5247 &%log_file_path%&. It is recommended that the use of non-colon separators be
5248 confined to circumstances where they really are needed.
5249
5250 .cindex "list separator" "newline as"
5251 .cindex "newline" "as list separator"
5252 It is also possible to use newline and other control characters (those with
5253 code values less than 32, plus DEL) as separators in lists. Such separators
5254 must be provided literally at the time the list is processed. For options that
5255 are string-expanded, you can write the separator using a normal escape
5256 sequence. This will be processed by the expander before the string is
5257 interpreted as a list. For example, if a newline-separated list of domains is
5258 generated by a lookup, you can process it directly by a line such as this:
5259 .code
5260 domains = <\n ${lookup mysql{.....}}
5261 .endd
5262 This avoids having to change the list separator in such data. You are unlikely
5263 to want to use a control character as a separator in an option that is not
5264 expanded, because the value is literal text. However, it can be done by giving
5265 the value in quotes. For example:
5266 .code
5267 local_interfaces = "<\n 127.0.0.1 \n ::1"
5268 .endd
5269 Unlike printing character separators, which can be included in list items by
5270 doubling, it is not possible to include a control character as data when it is
5271 set as the separator. Two such characters in succession are interpreted as
5272 enclosing an empty list item.
5273
5274
5275
5276 .section "Empty items in lists" "SECTempitelis"
5277 .cindex "list" "empty item in"
5278 An empty item at the end of a list is always ignored. In other words, trailing
5279 separator characters are ignored. Thus, the list in
5280 .code
5281 senders = user@domain :
5282 .endd
5283 contains only a single item. If you want to include an empty string as one item
5284 in a list, it must not be the last item. For example, this list contains three
5285 items, the second of which is empty:
5286 .code
5287 senders = user1@domain : : user2@domain
5288 .endd
5289 &*Note*&: There must be white space between the two colons, as otherwise they
5290 are interpreted as representing a single colon data character (and the list
5291 would then contain just one item). If you want to specify a list that contains
5292 just one, empty item, you can do it as in this example:
5293 .code
5294 senders = :
5295 .endd
5296 In this case, the first item is empty, and the second is discarded because it
5297 is at the end of the list.
5298
5299
5300
5301
5302 .section "Format of driver configurations" "SECTfordricon"
5303 .cindex "drivers" "configuration format"
5304 There are separate parts in the configuration for defining routers, transports,
5305 and authenticators. In each part, you are defining a number of driver
5306 instances, each with its own set of options. Each driver instance is defined by
5307 a sequence of lines like this:
5308 .display
5309 <&'instance name'&>:
5310   <&'option'&>
5311   ...
5312   <&'option'&>
5313 .endd
5314 In the following example, the instance name is &(localuser)&, and it is
5315 followed by three options settings:
5316 .code
5317 localuser:
5318   driver = accept
5319   check_local_user
5320   transport = local_delivery
5321 .endd
5322 For each driver instance, you specify which Exim code module it uses &-- by the
5323 setting of the &%driver%& option &-- and (optionally) some configuration
5324 settings. For example, in the case of transports, if you want a transport to
5325 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5326 a local file you would use the &(appendfile)& driver. Each of the drivers is
5327 described in detail in its own separate chapter later in this manual.
5328
5329 You can have several routers, transports, or authenticators that are based on
5330 the same underlying driver (each must have a different instance name).
5331
5332 The order in which routers are defined is important, because addresses are
5333 passed to individual routers one by one, in order. The order in which
5334 transports are defined does not matter at all. The order in which
5335 authenticators are defined is used only when Exim, as a client, is searching
5336 them to find one that matches an authentication mechanism offered by the
5337 server.
5338
5339 .cindex "generic options"
5340 .cindex "options" "generic &-- definition of"
5341 Within a driver instance definition, there are two kinds of option: &'generic'&
5342 and &'private'&. The generic options are those that apply to all drivers of the
5343 same type (that is, all routers, all transports or all authenticators). The
5344 &%driver%& option is a generic option that must appear in every definition.
5345 .cindex "private options"
5346 The private options are special for each driver, and none need appear, because
5347 they all have default values.
5348
5349 The options may appear in any order, except that the &%driver%& option must
5350 precede any private options, since these depend on the particular driver. For
5351 this reason, it is recommended that &%driver%& always be the first option.
5352
5353 Driver instance names, which are used for reference in log entries and
5354 elsewhere, can be any sequence of letters, digits, and underscores (starting
5355 with a letter) and must be unique among drivers of the same type. A router and
5356 a transport (for example) can each have the same name, but no two router
5357 instances can have the same name. The name of a driver instance should not be
5358 confused with the name of the underlying driver module. For example, the
5359 configuration lines:
5360 .code
5361 remote_smtp:
5362   driver = smtp
5363 .endd
5364 create an instance of the &(smtp)& transport driver whose name is
5365 &(remote_smtp)&. The same driver code can be used more than once, with
5366 different instance names and different option settings each time. A second
5367 instance of the &(smtp)& transport, with different options, might be defined
5368 thus:
5369 .code
5370 special_smtp:
5371   driver = smtp
5372   port = 1234
5373   command_timeout = 10s
5374 .endd
5375 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5376 these transport instances from routers, and these names would appear in log
5377 lines.
5378
5379 Comment lines may be present in the middle of driver specifications. The full
5380 list of option settings for any particular driver instance, including all the
5381 defaulted values, can be extracted by making use of the &%-bP%& command line
5382 option.
5383
5384
5385
5386
5387
5388
5389 . ////////////////////////////////////////////////////////////////////////////
5390 . ////////////////////////////////////////////////////////////////////////////
5391
5392 .chapter "The default configuration file" "CHAPdefconfil"
5393 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5394 .cindex "default" "configuration file &""walk through""&"
5395 The default configuration file supplied with Exim as &_src/configure.default_&
5396 is sufficient for a host with simple mail requirements. As an introduction to
5397 the way Exim is configured, this chapter &"walks through"& the default
5398 configuration, giving brief explanations of the settings. Detailed descriptions
5399 of the options are given in subsequent chapters. The default configuration file
5400 itself contains extensive comments about ways you might want to modify the
5401 initial settings. However, note that there are many options that are not
5402 mentioned at all in the default configuration.
5403
5404
5405
5406 .section "Main configuration settings" "SECTdefconfmain"
5407 The main (global) configuration option settings must always come first in the
5408 file. The first thing you'll see in the file, after some initial comments, is
5409 the line
5410 .code
5411 # primary_hostname =
5412 .endd
5413 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5414 to know the official, fully qualified name of your host, and this is where you
5415 can specify it. However, in most cases you do not need to set this option. When
5416 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5417
5418 The first three non-comment configuration lines are as follows:
5419 .code
5420 domainlist local_domains    = @
5421 domainlist relay_to_domains =
5422 hostlist   relay_from_hosts = 127.0.0.1
5423 .endd
5424 These are not, in fact, option settings. They are definitions of two named
5425 domain lists and one named host list. Exim allows you to give names to lists of
5426 domains, hosts, and email addresses, in order to make it easier to manage the
5427 configuration file (see section &<<SECTnamedlists>>&).
5428
5429 The first line defines a domain list called &'local_domains'&; this is used
5430 later in the configuration to identify domains that are to be delivered
5431 on the local host.
5432
5433 .cindex "@ in a domain list"
5434 There is just one item in this list, the string &"@"&. This is a special form
5435 of entry which means &"the name of the local host"&. Thus, if the local host is
5436 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5437 be delivered locally. Because the local host's name is referenced indirectly,
5438 the same configuration file can be used on different hosts.
5439
5440 The second line defines a domain list called &'relay_to_domains'&, but the
5441 list itself is empty. Later in the configuration we will come to the part that
5442 controls mail relaying through the local host; it allows relaying to any
5443 domains in this list. By default, therefore, no relaying on the basis of a mail
5444 domain is permitted.
5445
5446 The third line defines a host list called &'relay_from_hosts'&. This list is
5447 used later in the configuration to permit relaying from any host or IP address
5448 that matches the list. The default contains just the IP address of the IPv4
5449 loopback interface, which means that processes on the local host are able to
5450 submit mail for relaying by sending it over TCP/IP to that interface. No other
5451 hosts are permitted to submit messages for relaying.
5452
5453 Just to be sure there's no misunderstanding: at this point in the configuration
5454 we aren't actually setting up any controls. We are just defining some domains
5455 and hosts that will be used in the controls that are specified later.
5456
5457 The next two configuration lines are genuine option settings:
5458 .code
5459 acl_smtp_rcpt = acl_check_rcpt
5460 acl_smtp_data = acl_check_data
5461 .endd
5462 These options specify &'Access Control Lists'& (ACLs) that are to be used
5463 during an incoming SMTP session for every recipient of a message (every RCPT
5464 command), and after the contents of the message have been received,
5465 respectively. The names of the lists are &'acl_check_rcpt'& and
5466 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5467 section of the configuration. The RCPT ACL controls which recipients are
5468 accepted for an incoming message &-- if a configuration does not provide an ACL
5469 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5470 contents of a message to be checked.
5471
5472 Two commented-out option settings are next:
5473 .code
5474 # av_scanner = clamd:/tmp/clamd
5475 # spamd_address = 127.0.0.1 783
5476 .endd
5477 These are example settings that can be used when Exim is compiled with the
5478 content-scanning extension. The first specifies the interface to the virus
5479 scanner, and the second specifies the interface to SpamAssassin. Further
5480 details are given in chapter &<<CHAPexiscan>>&.
5481
5482 Three more commented-out option settings follow:
5483 .code
5484 # tls_advertise_hosts = *
5485 # tls_certificate = /etc/ssl/exim.crt
5486 # tls_privatekey = /etc/ssl/exim.pem
5487 .endd
5488 These are example settings that can be used when Exim is compiled with
5489 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5490 first one specifies the list of clients that are allowed to use TLS when
5491 connecting to this server; in this case the wildcard means all clients. The
5492 other options specify where Exim should find its TLS certificate and private
5493 key, which together prove the server's identity to any clients that connect.
5494 More details are given in chapter &<<CHAPTLS>>&.
5495
5496 Another two commented-out option settings follow:
5497 .code
5498 # daemon_smtp_ports = 25 : 465 : 587
5499 # tls_on_connect_ports = 465
5500 .endd
5501 .cindex "port" "465 and 587"
5502 .cindex "port" "for message submission"
5503 .cindex "message" "submission, ports for"
5504 .cindex "ssmtp protocol"
5505 .cindex "smtps protocol"
5506 .cindex "SMTP" "ssmtp protocol"
5507 .cindex "SMTP" "smtps protocol"
5508 These options provide better support for roaming users who wish to use this
5509 server for message submission. They are not much use unless you have turned on
5510 TLS (as described in the previous paragraph) and authentication (about which
5511 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5512 on end-user networks, so RFC 4409 specifies that message submission should use
5513 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5514 configured to use port 587 correctly, so these settings also enable the
5515 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5516 &<<SECTsupobssmt>>&).
5517
5518 Two more commented-out options settings follow:
5519 .code
5520 # qualify_domain =
5521 # qualify_recipient =
5522 .endd
5523 The first of these specifies a domain that Exim uses when it constructs a
5524 complete email address from a local login name. This is often needed when Exim
5525 receives a message from a local process. If you do not set &%qualify_domain%&,
5526 the value of &%primary_hostname%& is used. If you set both of these options,
5527 you can have different qualification domains for sender and recipient
5528 addresses. If you set only the first one, its value is used in both cases.
5529
5530 .cindex "domain literal" "recognizing format"
5531 The following line must be uncommented if you want Exim to recognize
5532 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5533 (an IP address within square brackets) instead of a named domain.
5534 .code
5535 # allow_domain_literals
5536 .endd
5537 The RFCs still require this form, but many people think that in the modern
5538 Internet it makes little sense to permit mail to be sent to specific hosts by
5539 quoting their IP addresses. This ancient format has been used by people who
5540 try to abuse hosts by using them for unwanted relaying. However, some
5541 people believe there are circumstances (for example, messages addressed to
5542 &'postmaster'&) where domain literals are still useful.
5543
5544 The next configuration line is a kind of trigger guard:
5545 .code
5546 never_users = root
5547 .endd
5548 It specifies that no delivery must ever be run as the root user. The normal
5549 convention is to set up &'root'& as an alias for the system administrator. This
5550 setting is a guard against slips in the configuration.
5551 The list of users specified by &%never_users%& is not, however, the complete
5552 list; the build-time configuration in &_Local/Makefile_& has an option called
5553 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5554 contents of &%never_users%& are added to this list. By default
5555 FIXED_NEVER_USERS also specifies root.
5556
5557 When a remote host connects to Exim in order to send mail, the only information
5558 Exim has about the host's identity is its IP address. The next configuration
5559 line,
5560 .code
5561 host_lookup = *
5562 .endd
5563 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5564 in order to get a host name. This improves the quality of the logging
5565 information, but if you feel it is too expensive, you can remove it entirely,
5566 or restrict the lookup to hosts on &"nearby"& networks.
5567 Note that it is not always possible to find a host name from an IP address,
5568 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5569 unreachable.
5570
5571 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5572 1413 (hence their names):
5573 .code
5574 rfc1413_hosts = *
5575 rfc1413_query_timeout = 0s
5576 .endd
5577 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5578 Few hosts offer RFC1413 service these days; calls have to be
5579 terminated by a timeout and this needlessly delays the startup
5580 of an incoming SMTP connection.
5581 If you have hosts for which you trust RFC1413 and need this
5582 information, you can change this.
5583
5584 This line enables an efficiency SMTP option.  It is negotiated by clients
5585 and not expected to cause problems but can be disabled if needed.
5586 .code
5587 prdr_enable = true
5588 .endd
5589
5590 When Exim receives messages over SMTP connections, it expects all addresses to
5591 be fully qualified with a domain, as required by the SMTP definition. However,
5592 if you are running a server to which simple clients submit messages, you may
5593 find that they send unqualified addresses. The two commented-out options:
5594 .code
5595 # sender_unqualified_hosts =
5596 # recipient_unqualified_hosts =
5597 .endd
5598 show how you can specify hosts that are permitted to send unqualified sender
5599 and recipient addresses, respectively.
5600
5601 The &%percent_hack_domains%& option is also commented out:
5602 .code
5603 # percent_hack_domains =
5604 .endd
5605 It provides a list of domains for which the &"percent hack"& is to operate.
5606 This is an almost obsolete form of explicit email routing. If you do not know
5607 anything about it, you can safely ignore this topic.
5608
5609 The last two settings in the main part of the default configuration are
5610 concerned with messages that have been &"frozen"& on Exim's queue. When a
5611 message is frozen, Exim no longer continues to try to deliver it. Freezing
5612 occurs when a bounce message encounters a permanent failure because the sender
5613 address of the original message that caused the bounce is invalid, so the
5614 bounce cannot be delivered. This is probably the most common case, but there
5615 are also other conditions that cause freezing, and frozen messages are not
5616 always bounce messages.
5617 .code
5618 ignore_bounce_errors_after = 2d
5619 timeout_frozen_after = 7d
5620 .endd
5621 The first of these options specifies that failing bounce messages are to be
5622 discarded after 2 days on the queue. The second specifies that any frozen
5623 message (whether a bounce message or not) is to be timed out (and discarded)
5624 after a week. In this configuration, the first setting ensures that no failing
5625 bounce message ever lasts a week.
5626
5627
5628
5629 .section "ACL configuration" "SECID54"
5630 .cindex "default" "ACLs"
5631 .cindex "&ACL;" "default configuration"
5632 In the default configuration, the ACL section follows the main configuration.
5633 It starts with the line
5634 .code
5635 begin acl
5636 .endd
5637 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5638 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5639 and &%acl_smtp_data%& above.
5640
5641 .cindex "RCPT" "ACL for"
5642 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5643 RCPT command specifies one of the message's recipients. The ACL statements
5644 are considered in order, until the recipient address is either accepted or
5645 rejected. The RCPT command is then accepted or rejected, according to the
5646 result of the ACL processing.
5647 .code
5648 acl_check_rcpt:
5649 .endd
5650 This line, consisting of a name terminated by a colon, marks the start of the
5651 ACL, and names it.
5652 .code
5653 accept  hosts = :
5654 .endd
5655 This ACL statement accepts the recipient if the sending host matches the list.
5656 But what does that strange list mean? It doesn't actually contain any host
5657 names or IP addresses. The presence of the colon puts an empty item in the
5658 list; Exim matches this only if the incoming message did not come from a remote
5659 host, because in that case, the remote hostname is empty. The colon is
5660 important. Without it, the list itself is empty, and can never match anything.
5661
5662 What this statement is doing is to accept unconditionally all recipients in
5663 messages that are submitted by SMTP from local processes using the standard
5664 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5665 manner.
5666 .code
5667 deny    message       = Restricted characters in address
5668         domains       = +local_domains
5669         local_parts   = ^[.] : ^.*[@%!/|]
5670
5671 deny    message       = Restricted characters in address
5672         domains       = !+local_domains
5673         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5674 .endd
5675 These statements are concerned with local parts that contain any of the
5676 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5677 Although these characters are entirely legal in local parts (in the case of
5678 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5679 in Internet mail addresses.
5680
5681 The first three have in the past been associated with explicitly routed
5682 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5683 option). Addresses containing these characters are regularly tried by spammers
5684 in an attempt to bypass relaying restrictions, and also by open relay testing
5685 programs. Unless you really need them it is safest to reject these characters
5686 at this early stage. This configuration is heavy-handed in rejecting these
5687 characters for all messages it accepts from remote hosts. This is a deliberate
5688 policy of being as safe as possible.
5689
5690 The first rule above is stricter, and is applied to messages that are addressed
5691 to one of the local domains handled by this host. This is implemented by the
5692 first condition, which restricts it to domains that are listed in the
5693 &'local_domains'& domain list. The &"+"& character is used to indicate a
5694 reference to a named list. In this configuration, there is just one domain in
5695 &'local_domains'&, but in general there may be many.
5696
5697 The second condition on the first statement uses two regular expressions to
5698 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5699 or &"|"&. If you have local accounts that include these characters, you will
5700 have to modify this rule.
5701
5702 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5703 allows them because they have been encountered in practice. (Consider the
5704 common convention of local parts constructed as
5705 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5706 the author of Exim, who has no second initial.) However, a local part starting
5707 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5708 file name (for example, for a mailing list). This is also true for local parts
5709 that contain slashes. A pipe symbol can also be troublesome if the local part
5710 is incorporated unthinkingly into a shell command line.
5711
5712 The second rule above applies to all other domains, and is less strict. This
5713 allows your own users to send outgoing messages to sites that use slashes
5714 and vertical bars in their local parts. It blocks local parts that begin
5715 with a dot, slash, or vertical bar, but allows these characters within the
5716 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5717 and &"!"& is blocked, as before. The motivation here is to prevent your users
5718 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5719 .code
5720 accept  local_parts   = postmaster
5721         domains       = +local_domains
5722 .endd
5723 This statement, which has two conditions, accepts an incoming address if the
5724 local part is &'postmaster'& and the domain is one of those listed in the
5725 &'local_domains'& domain list. The &"+"& character is used to indicate a
5726 reference to a named list. In this configuration, there is just one domain in
5727 &'local_domains'&, but in general there may be many.
5728
5729 The presence of this statement means that mail to postmaster is never blocked
5730 by any of the subsequent tests. This can be helpful while sorting out problems
5731 in cases where the subsequent tests are incorrectly denying access.
5732 .code
5733 require verify        = sender
5734 .endd
5735 This statement requires the sender address to be verified before any subsequent
5736 ACL statement can be used. If verification fails, the incoming recipient
5737 address is refused. Verification consists of trying to route the address, to
5738 see if a bounce message could be delivered to it. In the case of remote
5739 addresses, basic verification checks only the domain, but &'callouts'& can be
5740 used for more verification if required. Section &<<SECTaddressverification>>&
5741 discusses the details of address verification.
5742 .code
5743 accept  hosts         = +relay_from_hosts
5744         control       = submission
5745 .endd
5746 This statement accepts the address if the message is coming from one of the
5747 hosts that are defined as being allowed to relay through this host. Recipient
5748 verification is omitted here, because in many cases the clients are dumb MUAs
5749 that do not cope well with SMTP error responses. For the same reason, the
5750 second line specifies &"submission mode"& for messages that are accepted. This
5751 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5752 messages that are deficient in some way, for example, because they lack a
5753 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5754 probably add recipient verification here, and disable submission mode.
5755 .code
5756 accept  authenticated = *
5757         control       = submission
5758 .endd
5759 This statement accepts the address if the client host has authenticated itself.
5760 Submission mode is again specified, on the grounds that such messages are most
5761 likely to come from MUAs. The default configuration does not define any
5762 authenticators, though it does include some nearly complete commented-out
5763 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5764 fact authenticate until you complete the authenticator definitions.
5765 .code
5766 require message = relay not permitted
5767         domains = +local_domains : +relay_to_domains
5768 .endd
5769 This statement rejects the address if its domain is neither a local domain nor
5770 one of the domains for which this host is a relay.
5771 .code
5772 require verify = recipient
5773 .endd
5774 This statement requires the recipient address to be verified; if verification
5775 fails, the address is rejected.
5776 .code
5777 # deny    message     = rejected because $sender_host_address \
5778 #                       is in a black list at $dnslist_domain\n\
5779 #                       $dnslist_text
5780 #         dnslists    = black.list.example
5781 #
5782 # warn    dnslists    = black.list.example
5783 #         add_header  = X-Warning: $sender_host_address is in \
5784 #                       a black list at $dnslist_domain
5785 #         log_message = found in $dnslist_domain
5786 .endd
5787 These commented-out lines are examples of how you could configure Exim to check
5788 sending hosts against a DNS black list. The first statement rejects messages
5789 from blacklisted hosts, whereas the second just inserts a warning header
5790 line.
5791 .code
5792 # require verify = csa
5793 .endd
5794 This commented-out line is an example of how you could turn on client SMTP
5795 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5796 records.
5797 .code
5798 accept
5799 .endd
5800 The final statement in the first ACL unconditionally accepts any recipient
5801 address that has successfully passed all the previous tests.
5802 .code
5803 acl_check_data:
5804 .endd
5805 This line marks the start of the second ACL, and names it. Most of the contents
5806 of this ACL are commented out:
5807 .code
5808 # deny    malware   = *
5809 #         message   = This message contains a virus \
5810 #                     ($malware_name).
5811 .endd
5812 These lines are examples of how to arrange for messages to be scanned for
5813 viruses when Exim has been compiled with the content-scanning extension, and a
5814 suitable virus scanner is installed. If the message is found to contain a
5815 virus, it is rejected with the given custom error message.
5816 .code
5817 # warn    spam      = nobody
5818 #         message   = X-Spam_score: $spam_score\n\
5819 #                     X-Spam_score_int: $spam_score_int\n\
5820 #                     X-Spam_bar: $spam_bar\n\
5821 #                     X-Spam_report: $spam_report
5822 .endd
5823 These lines are an example of how to arrange for messages to be scanned by
5824 SpamAssassin when Exim has been compiled with the content-scanning extension,
5825 and SpamAssassin has been installed. The SpamAssassin check is run with
5826 &`nobody`& as its user parameter, and the results are added to the message as a
5827 series of extra header line. In this case, the message is not rejected,
5828 whatever the spam score.
5829 .code
5830 accept
5831 .endd
5832 This final line in the DATA ACL accepts the message unconditionally.
5833
5834
5835 .section "Router configuration" "SECID55"
5836 .cindex "default" "routers"
5837 .cindex "routers" "default"
5838 The router configuration comes next in the default configuration, introduced
5839 by the line
5840 .code
5841 begin routers
5842 .endd
5843 Routers are the modules in Exim that make decisions about where to send
5844 messages. An address is passed to each router in turn, until it is either
5845 accepted, or failed. This means that the order in which you define the routers
5846 matters. Each router is fully described in its own chapter later in this
5847 manual. Here we give only brief overviews.
5848 .code
5849 # domain_literal:
5850 #   driver = ipliteral
5851 #   domains = !+local_domains
5852 #   transport = remote_smtp
5853 .endd
5854 .cindex "domain literal" "default router"
5855 This router is commented out because the majority of sites do not want to
5856 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5857 you uncomment this router, you also need to uncomment the setting of
5858 &%allow_domain_literals%& in the main part of the configuration.
5859 .code
5860 dnslookup:
5861   driver = dnslookup
5862   domains = ! +local_domains
5863   transport = remote_smtp
5864   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5865   no_more
5866 .endd
5867 The first uncommented router handles addresses that do not involve any local
5868 domains. This is specified by the line
5869 .code
5870 domains = ! +local_domains
5871 .endd
5872 The &%domains%& option lists the domains to which this router applies, but the
5873 exclamation mark is a negation sign, so the router is used only for domains
5874 that are not in the domain list called &'local_domains'& (which was defined at
5875 the start of the configuration). The plus sign before &'local_domains'&
5876 indicates that it is referring to a named list. Addresses in other domains are
5877 passed on to the following routers.
5878
5879 The name of the router driver is &(dnslookup)&,
5880 and is specified by the &%driver%& option. Do not be confused by the fact that
5881 the name of this router instance is the same as the name of the driver. The
5882 instance name is arbitrary, but the name set in the &%driver%& option must be
5883 one of the driver modules that is in the Exim binary.
5884
5885 The &(dnslookup)& router routes addresses by looking up their domains in the
5886 DNS in order to obtain a list of hosts to which the address is routed. If the
5887 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5888 specified by the &%transport%& option. If the router does not find the domain
5889 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5890 the address fails and is bounced.
5891
5892 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5893 be entirely ignored. This option is present because a number of cases have been
5894 encountered where MX records in the DNS point to host names
5895 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5896 Completely ignoring these IP addresses causes Exim to fail to route the
5897 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5898 continue to try to deliver the message periodically until the address timed
5899 out.
5900 .code
5901 system_aliases:
5902   driver = redirect
5903   allow_fail
5904   allow_defer
5905   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5906 # user = exim
5907   file_transport = address_file
5908   pipe_transport = address_pipe
5909 .endd
5910 Control reaches this and subsequent routers only for addresses in the local
5911 domains. This router checks to see whether the local part is defined as an
5912 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5913 data that it looks up from that file. If no data is found for the local part,
5914 the value of the &%data%& option is empty, causing the address to be passed to
5915 the next router.
5916
5917 &_/etc/aliases_& is a conventional name for the system aliases file that is
5918 often used. That is why it is referenced by from the default configuration
5919 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5920 &_Local/Makefile_& before building Exim.
5921 .code
5922 userforward:
5923   driver = redirect
5924   check_local_user
5925 # local_part_suffix = +* : -*
5926 # local_part_suffix_optional
5927   file = $home/.forward
5928 # allow_filter
5929   no_verify
5930   no_expn
5931   check_ancestor
5932   file_transport = address_file
5933   pipe_transport = address_pipe
5934   reply_transport = address_reply
5935 .endd
5936 This is the most complicated router in the default configuration. It is another
5937 redirection router, but this time it is looking for forwarding data set up by
5938 individual users. The &%check_local_user%& setting specifies a check that the
5939 local part of the address is the login name of a local user. If it is not, the
5940 router is skipped. The two commented options that follow &%check_local_user%&,
5941 namely:
5942 .code
5943 # local_part_suffix = +* : -*
5944 # local_part_suffix_optional
5945 .endd
5946 .vindex "&$local_part_suffix$&"
5947 show how you can specify the recognition of local part suffixes. If the first
5948 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5949 by any sequence of characters, is removed from the local part and placed in the
5950 variable &$local_part_suffix$&. The second suffix option specifies that the
5951 presence of a suffix in the local part is optional. When a suffix is present,
5952 the check for a local login uses the local part with the suffix removed.
5953
5954 When a local user account is found, the file called &_.forward_& in the user's
5955 home directory is consulted. If it does not exist, or is empty, the router
5956 declines. Otherwise, the contents of &_.forward_& are interpreted as
5957 redirection data (see chapter &<<CHAPredirect>>& for more details).
5958
5959 .cindex "Sieve filter" "enabling in default router"
5960 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5961 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5962 is commented out by default), the contents of the file are interpreted as a set
5963 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5964 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5965 separate document entitled &'Exim's interfaces to mail filtering'&.
5966
5967 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5968 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5969 There are two reasons for doing this:
5970
5971 .olist
5972 Whether or not a local user has a &_.forward_& file is not really relevant when
5973 checking an address for validity; it makes sense not to waste resources doing
5974 unnecessary work.
5975 .next
5976 More importantly, when Exim is verifying addresses or handling an EXPN
5977 command during an SMTP session, it is running as the Exim user, not as root.
5978 The group is the Exim group, and no additional groups are set up.
5979 It may therefore not be possible for Exim to read users' &_.forward_& files at
5980 this time.
5981 .endlist
5982
5983 The setting of &%check_ancestor%& prevents the router from generating a new
5984 address that is the same as any previous address that was redirected. (This
5985 works round a problem concerning a bad interaction between aliasing and
5986 forwarding &-- see section &<<SECTredlocmai>>&).
5987
5988 The final three option settings specify the transports that are to be used when
5989 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5990 auto-reply, respectively. For example, if a &_.forward_& file contains
5991 .code
5992 a.nother@elsewhere.example, /home/spqr/archive
5993 .endd
5994 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
5995 transport.
5996 .code
5997 localuser:
5998   driver = accept
5999   check_local_user
6000 # local_part_suffix = +* : -*
6001 # local_part_suffix_optional
6002   transport = local_delivery
6003 .endd
6004 The final router sets up delivery into local mailboxes, provided that the local
6005 part is the name of a local login, by accepting the address and assigning it to
6006 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6007 routers, so the address is bounced. The commented suffix settings fulfil the
6008 same purpose as they do for the &(userforward)& router.
6009
6010
6011 .section "Transport configuration" "SECID56"
6012 .cindex "default" "transports"
6013 .cindex "transports" "default"
6014 Transports define mechanisms for actually delivering messages. They operate
6015 only when referenced from routers, so the order in which they are defined does
6016 not matter. The transports section of the configuration starts with
6017 .code
6018 begin transports
6019 .endd
6020 One remote transport and four local transports are defined.
6021 .code
6022 remote_smtp:
6023   driver = smtp
6024   hosts_try_prdr = *
6025 .endd
6026 This transport is used for delivering messages over SMTP connections.
6027 The list of remote hosts comes from the router.
6028 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6029 It is negotiated between client and server
6030 and not expected to cause problems but can be disabled if needed.
6031 All other options are defaulted.
6032 .code
6033 local_delivery:
6034   driver = appendfile
6035   file = /var/mail/$local_part
6036   delivery_date_add
6037   envelope_to_add
6038   return_path_add
6039 # group = mail
6040 # mode = 0660
6041 .endd
6042 This &(appendfile)& transport is used for local delivery to user mailboxes in
6043 traditional BSD mailbox format. By default it runs under the uid and gid of the
6044 local user, which requires the sticky bit to be set on the &_/var/mail_&
6045 directory. Some systems use the alternative approach of running mail deliveries
6046 under a particular group instead of using the sticky bit. The commented options
6047 show how this can be done.
6048
6049 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6050 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6051 similarly-named options above.
6052 .code
6053 address_pipe:
6054   driver = pipe
6055   return_output
6056 .endd
6057 This transport is used for handling deliveries to pipes that are generated by
6058 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6059 option specifies that any output generated by the pipe is to be returned to the
6060 sender.
6061 .code
6062 address_file:
6063   driver = appendfile
6064   delivery_date_add
6065   envelope_to_add
6066   return_path_add
6067 .endd
6068 This transport is used for handling deliveries to files that are generated by
6069 redirection. The name of the file is not specified in this instance of
6070 &(appendfile)&, because it comes from the &(redirect)& router.
6071 .code
6072 address_reply:
6073   driver = autoreply
6074 .endd
6075 This transport is used for handling automatic replies generated by users'
6076 filter files.
6077
6078
6079
6080 .section "Default retry rule" "SECID57"
6081 .cindex "retry" "default rule"
6082 .cindex "default" "retry rule"
6083 The retry section of the configuration file contains rules which affect the way
6084 Exim retries deliveries that cannot be completed at the first attempt. It is
6085 introduced by the line
6086 .code
6087 begin retry
6088 .endd
6089 In the default configuration, there is just one rule, which applies to all
6090 errors:
6091 .code
6092 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6093 .endd
6094 This causes any temporarily failing address to be retried every 15 minutes for
6095 2 hours, then at intervals starting at one hour and increasing by a factor of
6096 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6097 is not delivered after 4 days of temporary failure, it is bounced.
6098
6099 If the retry section is removed from the configuration, or is empty (that is,
6100 if no retry rules are defined), Exim will not retry deliveries. This turns
6101 temporary errors into permanent errors.
6102
6103
6104 .section "Rewriting configuration" "SECID58"
6105 The rewriting section of the configuration, introduced by
6106 .code
6107 begin rewrite
6108 .endd
6109 contains rules for rewriting addresses in messages as they arrive. There are no
6110 rewriting rules in the default configuration file.
6111
6112
6113
6114 .section "Authenticators configuration" "SECTdefconfauth"
6115 .cindex "AUTH" "configuration"
6116 The authenticators section of the configuration, introduced by
6117 .code
6118 begin authenticators
6119 .endd
6120 defines mechanisms for the use of the SMTP AUTH command. The default
6121 configuration file contains two commented-out example authenticators
6122 which support plaintext username/password authentication using the
6123 standard PLAIN mechanism and the traditional but non-standard LOGIN
6124 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6125 to support most MUA software.
6126
6127 The example PLAIN authenticator looks like this:
6128 .code
6129 #PLAIN:
6130 #  driver                  = plaintext
6131 #  server_set_id           = $auth2
6132 #  server_prompts          = :
6133 #  server_condition        = Authentication is not yet configured
6134 #  server_advertise_condition = ${if def:tls_in_cipher }
6135 .endd
6136 And the example LOGIN authenticator looks like this:
6137 .code
6138 #LOGIN:
6139 #  driver                  = plaintext
6140 #  server_set_id           = $auth1
6141 #  server_prompts          = <| Username: | Password:
6142 #  server_condition        = Authentication is not yet configured
6143 #  server_advertise_condition = ${if def:tls_in_cipher }
6144 .endd
6145
6146 The &%server_set_id%& option makes Exim remember the authenticated username
6147 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6148 &%server_prompts%& option configures the &(plaintext)& authenticator so
6149 that it implements the details of the specific authentication mechanism,
6150 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6151 when Exim offers authentication to clients; in the examples, this is only
6152 when TLS or SSL has been started, so to enable the authenticators you also
6153 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6154
6155 The &%server_condition%& setting defines how to verify that the username and
6156 password are correct. In the examples it just produces an error message.
6157 To make the authenticators work, you can use a string expansion
6158 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6159
6160 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6161 usercode and password are in different positions.
6162 Chapter &<<CHAPplaintext>>& covers both.
6163
6164 .ecindex IIDconfiwal
6165
6166
6167
6168 . ////////////////////////////////////////////////////////////////////////////
6169 . ////////////////////////////////////////////////////////////////////////////
6170
6171 .chapter "Regular expressions" "CHAPregexp"
6172
6173 .cindex "regular expressions" "library"
6174 .cindex "PCRE"
6175 Exim supports the use of regular expressions in many of its options. It
6176 uses the PCRE regular expression library; this provides regular expression
6177 matching that is compatible with Perl 5. The syntax and semantics of
6178 regular expressions is discussed in many Perl reference books, and also in
6179 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6180 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6181
6182 The documentation for the syntax and semantics of the regular expressions that
6183 are supported by PCRE is included in the PCRE distribution, and no further
6184 description is included here. The PCRE functions are called from Exim using
6185 the default option settings (that is, with no PCRE options set), except that
6186 the PCRE_CASELESS option is set when the matching is required to be
6187 case-insensitive.
6188
6189 In most cases, when a regular expression is required in an Exim configuration,
6190 it has to start with a circumflex, in order to distinguish it from plain text
6191 or an &"ends with"& wildcard. In this example of a configuration setting, the
6192 second item in the colon-separated list is a regular expression.
6193 .code
6194 domains = a.b.c : ^\\d{3} : *.y.z : ...
6195 .endd
6196 The doubling of the backslash is required because of string expansion that
6197 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6198 of this issue, and a way of avoiding the need for doubling backslashes. The
6199 regular expression that is eventually used in this example contains just one
6200 backslash. The circumflex is included in the regular expression, and has the
6201 normal effect of &"anchoring"& it to the start of the string that is being
6202 matched.
6203
6204 There are, however, two cases where a circumflex is not required for the
6205 recognition of a regular expression: these are the &%match%& condition in a
6206 string expansion, and the &%matches%& condition in an Exim filter file. In
6207 these cases, the relevant string is always treated as a regular expression; if
6208 it does not start with a circumflex, the expression is not anchored, and can
6209 match anywhere in the subject string.
6210
6211 In all cases, if you want a regular expression to match at the end of a string,
6212 you must code the $ metacharacter to indicate this. For example:
6213 .code
6214 domains = ^\\d{3}\\.example
6215 .endd
6216 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6217 You need to use:
6218 .code
6219 domains = ^\\d{3}\\.example\$
6220 .endd
6221 if you want &'example'& to be the top-level domain. The backslash before the
6222 $ is needed because string expansion also interprets dollar characters.
6223
6224
6225
6226 . ////////////////////////////////////////////////////////////////////////////
6227 . ////////////////////////////////////////////////////////////////////////////
6228
6229 .chapter "File and database lookups" "CHAPfdlookup"
6230 .scindex IIDfidalo1 "file" "lookups"
6231 .scindex IIDfidalo2 "database" "lookups"
6232 .cindex "lookup" "description of"
6233 Exim can be configured to look up data in files or databases as it processes
6234 messages. Two different kinds of syntax are used:
6235
6236 .olist
6237 A string that is to be expanded may contain explicit lookup requests. These
6238 cause parts of the string to be replaced by data that is obtained from the
6239 lookup. Lookups of this type are conditional expansion items. Different results
6240 can be defined for the cases of lookup success and failure. See chapter
6241 &<<CHAPexpand>>&, where string expansions are described in detail.
6242 .next
6243 Lists of domains, hosts, and email addresses can contain lookup requests as a
6244 way of avoiding excessively long linear lists. In this case, the data that is
6245 returned by the lookup is often (but not always) discarded; whether the lookup
6246 succeeds or fails is what really counts. These kinds of list are described in
6247 chapter &<<CHAPdomhosaddlists>>&.
6248 .endlist
6249
6250 String expansions, lists, and lookups interact with each other in such a way
6251 that there is no order in which to describe any one of them that does not
6252 involve references to the others. Each of these three chapters makes more sense
6253 if you have read the other two first. If you are reading this for the first
6254 time, be aware that some of it will make a lot more sense after you have read
6255 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6256
6257 .section "Examples of different lookup syntax" "SECID60"
6258 It is easy to confuse the two different kinds of lookup, especially as the
6259 lists that may contain the second kind are always expanded before being
6260 processed as lists. Therefore, they may also contain lookups of the first kind.
6261 Be careful to distinguish between the following two examples:
6262 .code
6263 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6264 domains = lsearch;/some/file
6265 .endd
6266 The first uses a string expansion, the result of which must be a domain list.
6267 No strings have been specified for a successful or a failing lookup; the
6268 defaults in this case are the looked-up data and an empty string, respectively.
6269 The expansion takes place before the string is processed as a list, and the
6270 file that is searched could contain lines like this:
6271 .code
6272 192.168.3.4: domain1:domain2:...
6273 192.168.1.9: domain3:domain4:...
6274 .endd
6275 When the lookup succeeds, the result of the expansion is a list of domains (and
6276 possibly other types of item that are allowed in domain lists).
6277
6278 In the second example, the lookup is a single item in a domain list. It causes
6279 Exim to use a lookup to see if the domain that is being processed can be found
6280 in the file. The file could contains lines like this:
6281 .code
6282 domain1:
6283 domain2:
6284 .endd
6285 Any data that follows the keys is not relevant when checking that the domain
6286 matches the list item.
6287
6288 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6289 Consider a file containing lines like this:
6290 .code
6291 192.168.5.6: lsearch;/another/file
6292 .endd
6293 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6294 first &%domains%& setting above generates the second setting, which therefore
6295 causes a second lookup to occur.
6296
6297 The rest of this chapter describes the different lookup types that are
6298 available. Any of them can be used in any part of the configuration where a
6299 lookup is permitted.
6300
6301
6302 .section "Lookup types" "SECID61"
6303 .cindex "lookup" "types of"
6304 .cindex "single-key lookup" "definition of"
6305 Two different types of data lookup are implemented:
6306
6307 .ilist
6308 The &'single-key'& type requires the specification of a file in which to look,
6309 and a single key to search for. The key must be a non-empty string for the
6310 lookup to succeed. The lookup type determines how the file is searched.
6311 .next
6312 .cindex "query-style lookup" "definition of"
6313 The &'query-style'& type accepts a generalized database query. No particular
6314 key value is assumed by Exim for query-style lookups. You can use whichever
6315 Exim variables you need to construct the database query.
6316 .endlist
6317
6318 The code for each lookup type is in a separate source file that is included in
6319 the binary of Exim only if the corresponding compile-time option is set. The
6320 default settings in &_src/EDITME_& are:
6321 .code
6322 LOOKUP_DBM=yes
6323 LOOKUP_LSEARCH=yes
6324 .endd
6325 which means that only linear searching and DBM lookups are included by default.
6326 For some types of lookup (e.g. SQL databases), you need to install appropriate
6327 libraries and header files before building Exim.
6328
6329
6330
6331
6332 .section "Single-key lookup types" "SECTsinglekeylookups"
6333 .cindex "lookup" "single-key types"
6334 .cindex "single-key lookup" "list of types"
6335 The following single-key lookup types are implemented:
6336
6337 .ilist
6338 .cindex "cdb" "description of"
6339 .cindex "lookup" "cdb"
6340 .cindex "binary zero" "in lookup key"
6341 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6342 string without a terminating binary zero. The cdb format is designed for
6343 indexed files that are read frequently and never updated, except by total
6344 re-creation. As such, it is particularly suitable for large files containing
6345 aliases or other indexed data referenced by an MTA. Information about cdb can
6346 be found in several places:
6347 .display
6348 &url(http://www.pobox.com/~djb/cdb.html)
6349 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6350 &url(http://packages.debian.org/stable/utils/freecdb.html)
6351 .endd
6352 A cdb distribution is not needed in order to build Exim with cdb support,
6353 because the code for reading cdb files is included directly in Exim itself.
6354 However, no means of building or testing cdb files is provided with Exim, so
6355 you need to obtain a cdb distribution in order to do this.
6356 .next
6357 .cindex "DBM" "lookup type"
6358 .cindex "lookup" "dbm"
6359 .cindex "binary zero" "in lookup key"
6360 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6361 DBM file by looking up the record with the given key. A terminating binary
6362 zero is included in the key that is passed to the DBM library. See section
6363 &<<SECTdb>>& for a discussion of DBM libraries.
6364
6365 .cindex "Berkeley DB library" "file format"
6366 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6367 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6368 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6369 the DB_UNKNOWN option. This enables it to handle any of the types of database
6370 that the library supports, and can be useful for accessing DBM files created by
6371 other applications. (For earlier DB versions, DB_HASH is always used.)
6372 .next
6373 .cindex "lookup" "dbmjz"
6374 .cindex "lookup" "dbm &-- embedded NULs"
6375 .cindex "sasldb2"
6376 .cindex "dbmjz lookup type"
6377 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6378 interpreted as an Exim list; the elements of the list are joined together with
6379 ASCII NUL characters to form the lookup key.  An example usage would be to
6380 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6381 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6382 &(cram_md5)& authenticator.
6383 .next
6384 .cindex "lookup" "dbmnz"
6385 .cindex "lookup" "dbm &-- terminating zero"
6386 .cindex "binary zero" "in lookup key"
6387 .cindex "Courier"
6388 .cindex "&_/etc/userdbshadow.dat_&"
6389 .cindex "dbmnz lookup type"
6390 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6391 is not included in the key that is passed to the DBM library. You may need this
6392 if you want to look up data in files that are created by or shared with some
6393 other application that does not use terminating zeros. For example, you need to
6394 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6395 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6396 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6397 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6398 .next
6399 .cindex "lookup" "dsearch"
6400 .cindex "dsearch lookup type"
6401 &(dsearch)&: The given file must be a directory; this is searched for an entry
6402 whose name is the key by calling the &[lstat()]& function. The key may not
6403 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6404 the lookup is the name of the entry, which may be a file, directory,
6405 symbolic link, or any other kind of directory entry. An example of how this
6406 lookup can be used to support virtual domains is given in section
6407 &<<SECTvirtualdomains>>&.
6408 .next
6409 .cindex "lookup" "iplsearch"
6410 .cindex "iplsearch lookup type"
6411 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6412 terminated by a colon or white space or the end of the line. The keys in the
6413 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6414 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6415 being interpreted as a key terminator. For example:
6416 .code
6417 1.2.3.4:           data for 1.2.3.4
6418 192.168.0.0/16:    data for 192.168.0.0/16
6419 "abcd::cdab":      data for abcd::cdab
6420 "abcd:abcd::/32"   data for abcd:abcd::/32
6421 .endd
6422 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6423 file is searched linearly, using the CIDR masks where present, until a matching
6424 key is found. The first key that matches is used; there is no attempt to find a
6425 &"best"& match. Apart from the way the keys are matched, the processing for
6426 &(iplsearch)& is the same as for &(lsearch)&.
6427
6428 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6429 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6430 lookup types support only literal keys.
6431
6432 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6433 the implicit key is the host's IP address rather than its name (see section
6434 &<<SECThoslispatsikey>>&).
6435 .next
6436 .cindex "linear search"
6437 .cindex "lookup" "lsearch"
6438 .cindex "lsearch lookup type"
6439 .cindex "case sensitivity" "in lsearch lookup"
6440 &(lsearch)&: The given file is a text file that is searched linearly for a
6441 line beginning with the search key, terminated by a colon or white space or the
6442 end of the line. The search is case-insensitive; that is, upper and lower case
6443 letters are treated as the same. The first occurrence of the key that is found
6444 in the file is used.
6445
6446 White space between the key and the colon is permitted. The remainder of the
6447 line, with leading and trailing white space removed, is the data. This can be
6448 continued onto subsequent lines by starting them with any amount of white
6449 space, but only a single space character is included in the data at such a
6450 junction. If the data begins with a colon, the key must be terminated by a
6451 colon, for example:
6452 .code
6453 baduser:  :fail:
6454 .endd
6455 Empty lines and lines beginning with # are ignored, even if they occur in the
6456 middle of an item. This is the traditional textual format of alias files. Note
6457 that the keys in an &(lsearch)& file are literal strings. There is no
6458 wildcarding of any kind.
6459
6460 .cindex "lookup" "lsearch &-- colons in keys"
6461 .cindex "white space" "in lsearch key"
6462 In most &(lsearch)& files, keys are not required to contain colons or #
6463 characters, or white space. However, if you need this feature, it is available.
6464 If a key begins with a doublequote character, it is terminated only by a
6465 matching quote (or end of line), and the normal escaping rules apply to its
6466 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6467 quoted keys (exactly as for unquoted keys). There is no special handling of
6468 quotes for the data part of an &(lsearch)& line.
6469
6470 .next
6471 .cindex "NIS lookup type"
6472 .cindex "lookup" "NIS"
6473 .cindex "binary zero" "in lookup key"
6474 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6475 the given key, without a terminating binary zero. There is a variant called
6476 &(nis0)& which does include the terminating binary zero in the key. This is
6477 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6478 aliases; the full map names must be used.
6479
6480 .next
6481 .cindex "wildlsearch lookup type"
6482 .cindex "lookup" "wildlsearch"
6483 .cindex "nwildlsearch lookup type"
6484 .cindex "lookup" "nwildlsearch"
6485 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6486 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6487 the file may be wildcarded. The difference between these two lookup types is
6488 that for &(wildlsearch)&, each key in the file is string-expanded before being
6489 used, whereas for &(nwildlsearch)&, no expansion takes place.
6490
6491 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6492 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6493 file that are regular expressions can be made case-sensitive by the use of
6494 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6495
6496 . ==== As this is a nested list, any displays it contains must be indented
6497 . ==== as otherwise they are too far to the left.
6498
6499 .olist
6500 The string may begin with an asterisk to mean &"ends with"&. For example:
6501 .code
6502     *.a.b.c       data for anything.a.b.c
6503     *fish         data for anythingfish
6504 .endd
6505 .next
6506 The string may begin with a circumflex to indicate a regular expression. For
6507 example, for &(wildlsearch)&:
6508 .code
6509     ^\N\d+\.a\.b\N    data for <digits>.a.b
6510 .endd
6511 Note the use of &`\N`& to disable expansion of the contents of the regular
6512 expression. If you are using &(nwildlsearch)&, where the keys are not
6513 string-expanded, the equivalent entry is:
6514 .code
6515     ^\d+\.a\.b        data for <digits>.a.b
6516 .endd
6517 The case-insensitive flag is set at the start of compiling the regular
6518 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6519 For example, to make the entire pattern case-sensitive:
6520 .code
6521     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6522 .endd
6523
6524 If the regular expression contains white space or colon characters, you must
6525 either quote it (see &(lsearch)& above), or represent these characters in other
6526 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6527 colon. This may be easier than quoting, because if you quote, you have to
6528 escape all the backslashes inside the quotes.
6529
6530 &*Note*&: It is not possible to capture substrings in a regular expression
6531 match for later use, because the results of all lookups are cached. If a lookup
6532 is repeated, the result is taken from the cache, and no actual pattern matching
6533 takes place. The values of all the numeric variables are unset after a
6534 &((n)wildlsearch)& match.
6535
6536 .next
6537 Although I cannot see it being of much use, the general matching function that
6538 is used to implement &((n)wildlsearch)& means that the string may begin with a
6539 lookup name terminated by a semicolon, and followed by lookup data. For
6540 example:
6541 .code
6542     cdb;/some/file  data for keys that match the file
6543 .endd
6544 The data that is obtained from the nested lookup is discarded.
6545 .endlist olist
6546
6547 Keys that do not match any of these patterns are interpreted literally. The
6548 continuation rules for the data are the same as for &(lsearch)&, and keys may
6549 be followed by optional colons.
6550
6551 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6552 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6553 lookup types support only literal keys.
6554 .endlist ilist
6555
6556
6557 .section "Query-style lookup types" "SECID62"
6558 .cindex "lookup" "query-style types"
6559 .cindex "query-style lookup" "list of types"
6560 The supported query-style lookup types are listed below. Further details about
6561 many of them are given in later sections.
6562
6563 .ilist
6564 .cindex "DNS" "as a lookup type"
6565 .cindex "lookup" "DNS"
6566 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6567 are given in the supplied query. The resulting data is the contents of the
6568 records. See section &<<SECTdnsdb>>&.
6569 .next
6570 .cindex "InterBase lookup type"
6571 .cindex "lookup" "InterBase"
6572 &(ibase)&: This does a lookup in an InterBase database.
6573 .next
6574 .cindex "LDAP" "lookup type"
6575 .cindex "lookup" "LDAP"
6576 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6577 returns attributes from a single entry. There is a variant called &(ldapm)&
6578 that permits values from multiple entries to be returned. A third variant
6579 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6580 any attribute values. See section &<<SECTldap>>&.
6581 .next
6582 .cindex "MySQL" "lookup type"
6583 .cindex "lookup" "MySQL"
6584 &(mysql)&: The format of the query is an SQL statement that is passed to a
6585 MySQL database. See section &<<SECTsql>>&.
6586 .next
6587 .cindex "NIS+ lookup type"
6588 .cindex "lookup" "NIS+"
6589 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6590 the field to be returned. See section &<<SECTnisplus>>&.
6591 .next
6592 .cindex "Oracle" "lookup type"
6593 .cindex "lookup" "Oracle"
6594 &(oracle)&: The format of the query is an SQL statement that is passed to an
6595 Oracle database. See section &<<SECTsql>>&.
6596 .next
6597 .cindex "lookup" "passwd"
6598 .cindex "passwd lookup type"
6599 .cindex "&_/etc/passwd_&"
6600 &(passwd)& is a query-style lookup with queries that are just user names. The
6601 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6602 success, the result string is the same as you would get from an &(lsearch)&
6603 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6604 password value. For example:
6605 .code
6606 *:42:42:King Rat:/home/kr:/bin/bash
6607 .endd
6608 .next
6609 .cindex "PostgreSQL lookup type"
6610 .cindex "lookup" "PostgreSQL"
6611 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6612 PostgreSQL database. See section &<<SECTsql>>&.
6613
6614 .next
6615 .cindex "sqlite lookup type"
6616 .cindex "lookup" "sqlite"
6617 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6618 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6619
6620 .next
6621 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6622 not likely to be useful in normal operation.
6623 .next
6624 .cindex "whoson lookup type"
6625 .cindex "lookup" "whoson"
6626 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6627 allows a server to check whether a particular (dynamically allocated) IP
6628 address is currently allocated to a known (trusted) user and, optionally, to
6629 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6630 at one time for &"POP before SMTP"& authentication, but that approach has been
6631 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6632 &"POP before SMTP"& checking using ACL statements such as
6633 .code
6634 require condition = \
6635   ${lookup whoson {$sender_host_address}{yes}{no}}
6636 .endd
6637 The query consists of a single IP address. The value returned is the name of
6638 the authenticated user, which is stored in the variable &$value$&. However, in
6639 this example, the data in &$value$& is not used; the result of the lookup is
6640 one of the fixed strings &"yes"& or &"no"&.
6641 .endlist
6642
6643
6644
6645 .section "Temporary errors in lookups" "SECID63"
6646 .cindex "lookup" "temporary error in"
6647 Lookup functions can return temporary error codes if the lookup cannot be
6648 completed. For example, an SQL or LDAP database might be unavailable. For this
6649 reason, it is not advisable to use a lookup that might do this for critical
6650 options such as a list of local domains.
6651
6652 When a lookup cannot be completed in a router or transport, delivery
6653 of the message (to the relevant address) is deferred, as for any other
6654 temporary error. In other circumstances Exim may assume the lookup has failed,
6655 or may give up altogether.
6656
6657
6658
6659 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6660 .cindex "wildcard lookups"
6661 .cindex "lookup" "default values"
6662 .cindex "lookup" "wildcard"
6663 .cindex "lookup" "* added to type"
6664 .cindex "default" "in single-key lookups"
6665 In this context, a &"default value"& is a value specified by the administrator
6666 that is to be used if a lookup fails.
6667
6668 &*Note:*& This section applies only to single-key lookups. For query-style
6669 lookups, the facilities of the query language must be used. An attempt to
6670 specify a default for a query-style lookup provokes an error.
6671
6672 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6673 and the initial lookup fails, the key &"*"& is looked up in the file to
6674 provide a default value. See also the section on partial matching below.
6675
6676 .cindex "*@ with single-key lookup"
6677 .cindex "lookup" "*@ added to type"
6678 .cindex "alias file" "per-domain default"
6679 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6680 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6681 character, a second lookup is done with everything before the last @ replaced
6682 by *. This makes it possible to provide per-domain defaults in alias files
6683 that include the domains in the keys. If the second lookup fails (or doesn't
6684 take place because there is no @ in the key), &"*"& is looked up.
6685 For example, a &(redirect)& router might contain:
6686 .code
6687 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6688 .endd
6689 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6690 looks up these keys, in this order:
6691 .code
6692 jane@eyre.example
6693 *@eyre.example
6694 *
6695 .endd
6696 The data is taken from whichever key it finds first. &*Note*&: In an
6697 &(lsearch)& file, this does not mean the first of these keys in the file. A
6698 complete scan is done for each key, and only if it is not found at all does
6699 Exim move on to try the next key.
6700
6701
6702
6703 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6704 .cindex "partial matching"
6705 .cindex "wildcard lookups"
6706 .cindex "lookup" "partial matching"
6707 .cindex "lookup" "wildcard"
6708 .cindex "asterisk" "in search type"
6709 The normal operation of a single-key lookup is to search the file for an exact
6710 match with the given key. However, in a number of situations where domains are
6711 being looked up, it is useful to be able to do partial matching. In this case,
6712 information in the file that has a key starting with &"*."& is matched by any
6713 domain that ends with the components that follow the full stop. For example, if
6714 a key in a DBM file is
6715 .code
6716 *.dates.fict.example
6717 .endd
6718 then when partial matching is enabled this is matched by (amongst others)
6719 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6720 by &'dates.fict.example'&, if that does not appear as a separate key in the
6721 file.
6722
6723 &*Note*&: Partial matching is not available for query-style lookups. It is
6724 also not available for any lookup items in address lists (see section
6725 &<<SECTaddresslist>>&).
6726
6727 Partial matching is implemented by doing a series of separate lookups using
6728 keys constructed by modifying the original subject key. This means that it can
6729 be used with any of the single-key lookup types, provided that
6730 partial matching keys
6731 beginning with a special prefix (default &"*."&) are included in the data file.
6732 Keys in the file that do not begin with the prefix are matched only by
6733 unmodified subject keys when partial matching is in use.
6734
6735 Partial matching is requested by adding the string &"partial-"& to the front of
6736 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6737 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6738 is added at the start of the subject key, and it is looked up again. If that
6739 fails, further lookups are tried with dot-separated components removed from the
6740 start of the subject key, one-by-one, and &"*."& added on the front of what
6741 remains.
6742
6743 A minimum number of two non-* components are required. This can be adjusted
6744 by including a number before the hyphen in the search type. For example,
6745 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6746 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6747 subject key is &'2250.dates.fict.example'& then the following keys are looked
6748 up when the minimum number of non-* components is two:
6749 .code
6750 2250.dates.fict.example
6751 *.2250.dates.fict.example
6752 *.dates.fict.example
6753 *.fict.example
6754 .endd
6755 As soon as one key in the sequence is successfully looked up, the lookup
6756 finishes.
6757
6758 .cindex "lookup" "partial matching &-- changing prefix"
6759 .cindex "prefix" "for partial matching"
6760 The use of &"*."& as the partial matching prefix is a default that can be
6761 changed. The motivation for this feature is to allow Exim to operate with file
6762 formats that are used by other MTAs. A different prefix can be supplied in
6763 parentheses instead of the hyphen after &"partial"&. For example:
6764 .code
6765 domains = partial(.)lsearch;/some/file
6766 .endd
6767 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6768 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6769 components is unchanged). The prefix may consist of any punctuation characters
6770 other than a closing parenthesis. It may be empty, for example:
6771 .code
6772 domains = partial1()cdb;/some/file
6773 .endd
6774 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6775 &`a.b.c`&, &`b.c`&, and &`c`&.
6776
6777 If &"partial0"& is specified, what happens at the end (when the lookup with
6778 just one non-wild component has failed, and the original key is shortened right
6779 down to the null string) depends on the prefix:
6780
6781 .ilist
6782 If the prefix has zero length, the whole lookup fails.
6783 .next
6784 If the prefix has length 1, a lookup for just the prefix is done. For
6785 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6786 .next
6787 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6788 remainder is looked up. With the default prefix, therefore, the final lookup is
6789 for &"*"& on its own.
6790 .next
6791 Otherwise, the whole prefix is looked up.
6792 .endlist
6793
6794
6795 If the search type ends in &"*"& or &"*@"& (see section
6796 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6797 this implies happens after all partial lookups have failed. If &"partial0"& is
6798 specified, adding &"*"& to the search type has no effect with the default
6799 prefix, because the &"*"& key is already included in the sequence of partial
6800 lookups. However, there might be a use for lookup types such as
6801 &"partial0(.)lsearch*"&.
6802
6803 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6804 in domain lists and the like. Partial matching works only in terms of
6805 dot-separated components; a key such as &`*fict.example`&
6806 in a database file is useless, because the asterisk in a partial matching
6807 subject key is always followed by a dot.
6808
6809
6810
6811
6812 .section "Lookup caching" "SECID64"
6813 .cindex "lookup" "caching"
6814 .cindex "caching" "lookup data"
6815 Exim caches all lookup results in order to avoid needless repetition of
6816 lookups. However, because (apart from the daemon) Exim operates as a collection
6817 of independent, short-lived processes, this caching applies only within a
6818 single Exim process. There is no inter-process lookup caching facility.
6819
6820 For single-key lookups, Exim keeps the relevant files open in case there is
6821 another lookup that needs them. In some types of configuration this can lead to
6822 many files being kept open for messages with many recipients. To avoid hitting
6823 the operating system limit on the number of simultaneously open files, Exim
6824 closes the least recently used file when it needs to open more files than its
6825 own internal limit, which can be changed via the &%lookup_open_max%& option.
6826
6827 The single-key lookup files are closed and the lookup caches are flushed at
6828 strategic points during delivery &-- for example, after all routing is
6829 complete.
6830
6831
6832
6833
6834 .section "Quoting lookup data" "SECID65"
6835 .cindex "lookup" "quoting"
6836 .cindex "quoting" "in lookups"
6837 When data from an incoming message is included in a query-style lookup, there
6838 is the possibility of special characters in the data messing up the syntax of
6839 the query. For example, a NIS+ query that contains
6840 .code
6841 [name=$local_part]
6842 .endd
6843 will be broken if the local part happens to contain a closing square bracket.
6844 For NIS+, data can be enclosed in double quotes like this:
6845 .code
6846 [name="$local_part"]
6847 .endd
6848 but this still leaves the problem of a double quote in the data. The rule for
6849 NIS+ is that double quotes must be doubled. Other lookup types have different
6850 rules, and to cope with the differing requirements, an expansion operator
6851 of the following form is provided:
6852 .code
6853 ${quote_<lookup-type>:<string>}
6854 .endd
6855 For example, the safest way to write the NIS+ query is
6856 .code
6857 [name="${quote_nisplus:$local_part}"]
6858 .endd
6859 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6860 operator can be used for all lookup types, but has no effect for single-key
6861 lookups, since no quoting is ever needed in their key strings.
6862
6863
6864
6865
6866 .section "More about dnsdb" "SECTdnsdb"
6867 .cindex "dnsdb lookup"
6868 .cindex "lookup" "dnsdb"
6869 .cindex "DNS" "as a lookup type"
6870 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6871 of a record type and a domain name, separated by an equals sign. For example,
6872 an expansion string could contain:
6873 .code
6874 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6875 .endd
6876 If the lookup succeeds, the result is placed in &$value$&, which in this case
6877 is used on its own as the result. If the lookup does not succeed, the
6878 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6879 &<<SECTforexpfai>>& for an explanation of what this means.
6880
6881 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6882 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6883 If no type is given, TXT is assumed.
6884
6885 For any record type, if multiple records are found, the data is returned as a
6886 concatenation, with newline as the default separator. The order, of course,
6887 depends on the DNS resolver. You can specify a different separator character
6888 between multiple records by putting a right angle-bracket followed immediately
6889 by the new separator at the start of the query. For example:
6890 .code
6891 ${lookup dnsdb{>: a=host1.example}}
6892 .endd
6893 It is permitted to specify a space as the separator character. Further
6894 white space is ignored.
6895 For lookup types that return multiple fields per record,
6896 an alternate field separator can be specified using a comma after the main
6897 separator character, followed immediately by the field separator.
6898
6899 .cindex "PTR record" "in &(dnsdb)& lookup"
6900 When the type is PTR,
6901 the data can be an IP address, written as normal; inversion and the addition of
6902 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6903 .code
6904 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6905 .endd
6906 If the data for a PTR record is not a syntactically valid IP address, it is not
6907 altered and nothing is added.
6908
6909 .cindex "MX record" "in &(dnsdb)& lookup"
6910 .cindex "SRV record" "in &(dnsdb)& lookup"
6911 For an MX lookup, both the preference value and the host name are returned for
6912 each record, separated by a space. For an SRV lookup, the priority, weight,
6913 port, and host name are returned for each record, separated by spaces.
6914 The field separator can be modified as above.
6915
6916 .cindex "TXT record" "in &(dnsdb)& lookup"
6917 .cindex "SPF record" "in &(dnsdb)& lookup"
6918 For TXT records with multiple items of data, only the first item is returned,
6919 unless a field separator is specified.
6920 To concatenate items without a separator, use a semicolon instead.
6921 For SPF records the
6922 default behaviour is to concatenate multiple items without using a separator.
6923 .code
6924 ${lookup dnsdb{>\n,: txt=a.b.example}}
6925 ${lookup dnsdb{>\n; txt=a.b.example}}
6926 ${lookup dnsdb{spf=example.org}}
6927 .endd
6928 It is permitted to specify a space as the separator character. Further
6929 white space is ignored.
6930
6931 .cindex "SOA record" "in &(dnsdb)& lookup"
6932 For an SOA lookup, while no result is obtained the lookup is redone with
6933 successively more leading components dropped from the given domain.
6934 Only the primary-nameserver field is returned unless a field separator is
6935 specified.
6936 .code
6937 ${lookup dnsdb{>:,; soa=a.b.example.com}}
6938 .endd
6939
6940 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6941 .cindex "dnsdb modifiers"
6942 .cindex "modifiers" "dnsdb"
6943 .cindex "options" "dnsdb"
6944 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6945 each followed by a comma,
6946 that may appear before the record type.
6947
6948 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6949 temporary DNS error for any of them, the behaviour is controlled by
6950 a defer-option modifier.
6951 The possible keywords are
6952 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6953 With &"strict"& behaviour, any temporary DNS error causes the
6954 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6955 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6956 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6957 error causes the whole lookup to defer only if none of the other lookups
6958 succeed. The default is &"lax"&, so the following lookups are equivalent:
6959 .code
6960 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6961 ${lookup dnsdb{a=one.host.com:two.host.com}}
6962 .endd
6963 Thus, in the default case, as long as at least one of the DNS lookups
6964 yields some data, the lookup succeeds.
6965
6966 .cindex "DNSSEC" "dns lookup"
6967 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6968 The possible keywords are
6969 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6970 With &"strict"& or &"lax"& DNSSEC information is requested
6971 with the lookup.
6972 With &"strict"& a response from the DNS resolver that
6973 is not labelled as authenticated data
6974 is treated as equivalent to a temporary DNS error.
6975 The default is &"never"&.
6976
6977 See also the &$lookup_dnssec_authenticated$& variable.
6978
6979 .cindex timeout "dns lookup"
6980 .cindex "DNS" timeout
6981 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
6982 The form is &"retrans_VAL"& where VAL is an Exim time specification
6983 (eg &"5s"&).
6984 The default value is set by the main configuration option &%dns_retrans%&.
6985
6986 Retries for the dnsdb lookup can be controlled by a retry modifier.
6987 The form if &"retry_VAL"& where VAL is an integer.
6988 The default count is set by the main configuration option &%dns_retry%&.
6989
6990
6991 .section "Pseudo dnsdb record types" "SECID66"
6992 .cindex "MX record" "in &(dnsdb)& lookup"
6993 By default, both the preference value and the host name are returned for
6994 each MX record, separated by a space. If you want only host names, you can use
6995 the pseudo-type MXH:
6996 .code
6997 ${lookup dnsdb{mxh=a.b.example}}
6998 .endd
6999 In this case, the preference values are omitted, and just the host names are
7000 returned.
7001
7002 .cindex "name server for enclosing domain"
7003 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7004 records on the given domain, but if none are found, it removes the first
7005 component of the domain name, and tries again. This process continues until NS
7006 records are found or there are no more components left (or there is a DNS
7007 error). In other words, it may return the name servers for a top-level domain,
7008 but it never returns the root name servers. If there are no NS records for the
7009 top-level domain, the lookup fails. Consider these examples:
7010 .code
7011 ${lookup dnsdb{zns=xxx.quercite.com}}
7012 ${lookup dnsdb{zns=xxx.edu}}
7013 .endd
7014 Assuming that in each case there are no NS records for the full domain name,
7015 the first returns the name servers for &%quercite.com%&, and the second returns
7016 the name servers for &%edu%&.
7017
7018 You should be careful about how you use this lookup because, unless the
7019 top-level domain does not exist, the lookup always returns some host names. The
7020 sort of use to which this might be put is for seeing if the name servers for a
7021 given domain are on a blacklist. You can probably assume that the name servers
7022 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7023 such a list.
7024
7025 .cindex "CSA" "in &(dnsdb)& lookup"
7026 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7027 records according to the CSA rules, which are described in section
7028 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7029 not sufficient because of the extra parent domain search behaviour of CSA. The
7030 result of a successful lookup such as:
7031 .code
7032 ${lookup dnsdb {csa=$sender_helo_name}}
7033 .endd
7034 has two space-separated fields: an authorization code and a target host name.
7035 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7036 authorization required but absent, or &"?"& for unknown.
7037
7038 .cindex "A+" "in &(dnsdb)& lookup"
7039 The pseudo-type A+ performs an AAAA
7040 and then an A lookup.  All results are returned; defer processing
7041 (see below) is handled separately for each lookup.  Example:
7042 .code
7043 ${lookup dnsdb {>; a+=$sender_helo_name}}
7044 .endd
7045
7046
7047 .section "Multiple dnsdb lookups" "SECID67"
7048 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7049 However, you can specify a list of domains or IP addresses in a single
7050 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7051 the default separator, but with the ability to change this. For example:
7052 .code
7053 ${lookup dnsdb{one.domain.com:two.domain.com}}
7054 ${lookup dnsdb{a=one.host.com:two.host.com}}
7055 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7056 .endd
7057 In order to retain backwards compatibility, there is one special case: if
7058 the lookup type is PTR and no change of separator is specified, Exim looks
7059 to see if the rest of the string is precisely one IPv6 address. In this
7060 case, it does not treat it as a list.
7061
7062 The data from each lookup is concatenated, with newline separators by default,
7063 in the same way that multiple DNS records for a single item are handled. A
7064 different separator can be specified, as described above.
7065
7066
7067
7068
7069 .section "More about LDAP" "SECTldap"
7070 .cindex "LDAP" "lookup, more about"
7071 .cindex "lookup" "LDAP"
7072 .cindex "Solaris" "LDAP"
7073 The original LDAP implementation came from the University of Michigan; this has
7074 become &"Open LDAP"&, and there are now two different releases. Another
7075 implementation comes from Netscape, and Solaris 7 and subsequent releases
7076 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7077 the lookup function level, their error handling is different. For this reason
7078 it is necessary to set a compile-time variable when building Exim with LDAP, to
7079 indicate which LDAP library is in use. One of the following should appear in
7080 your &_Local/Makefile_&:
7081 .code
7082 LDAP_LIB_TYPE=UMICHIGAN
7083 LDAP_LIB_TYPE=OPENLDAP1
7084 LDAP_LIB_TYPE=OPENLDAP2
7085 LDAP_LIB_TYPE=NETSCAPE
7086 LDAP_LIB_TYPE=SOLARIS
7087 .endd
7088 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7089 same interface as the University of Michigan version.
7090
7091 There are three LDAP lookup types in Exim. These behave slightly differently in
7092 the way they handle the results of a query:
7093
7094 .ilist
7095 &(ldap)& requires the result to contain just one entry; if there are more, it
7096 gives an error.
7097 .next
7098 &(ldapdn)& also requires the result to contain just one entry, but it is the
7099 Distinguished Name that is returned rather than any attribute values.
7100 .next
7101 &(ldapm)& permits the result to contain more than one entry; the attributes
7102 from all of them are returned.
7103 .endlist
7104
7105
7106 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7107 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7108 the data returned by a successful lookup is described in the next section.
7109 First we explain how LDAP queries are coded.
7110
7111
7112 .section "Format of LDAP queries" "SECTforldaque"
7113 .cindex "LDAP" "query format"
7114 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7115 the configuration of a &(redirect)& router one might have this setting:
7116 .code
7117 data = ${lookup ldap \
7118   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7119   c=UK?mailbox?base?}}
7120 .endd
7121 .cindex "LDAP" "with TLS"
7122 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7123 secure (encrypted) LDAP connections. The second of these ensures that an
7124 encrypted TLS connection is used.
7125
7126 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7127 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7128 See the &%ldap_start_tls%& option.
7129
7130 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7131 controlled. Every part of the TLS configuration can be configured by settings in
7132 &_exim.conf_&. Depending on the version of the client libraries installed on
7133 your system, some of the initialization may have required setting options in
7134 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7135 certificates. This revealed a nuance where the current UID that exim was
7136 running as could affect which config files it read. With Exim 4.83, these
7137 methods become optional, only taking effect if not specifically set in
7138 &_exim.conf_&.
7139
7140
7141 .section "LDAP quoting" "SECID68"
7142 .cindex "LDAP" "quoting"
7143 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7144 and the second because the LDAP query is represented as a URL. Furthermore,
7145 within an LDAP query, two different kinds of quoting are required. For this
7146 reason, there are two different LDAP-specific quoting operators.
7147
7148 The &%quote_ldap%& operator is designed for use on strings that are part of
7149 filter specifications. Conceptually, it first does the following conversions on
7150 the string:
7151 .code
7152 *   =>   \2A
7153 (   =>   \28
7154 )   =>   \29
7155 \   =>   \5C
7156 .endd
7157 in accordance with RFC 2254. The resulting string is then quoted according
7158 to the rules for URLs, that is, all non-alphanumeric characters except
7159 .code
7160 ! $ ' - . _ ( ) * +
7161 .endd
7162 are converted to their hex values, preceded by a percent sign. For example:
7163 .code
7164 ${quote_ldap: a(bc)*, a<yz>; }
7165 .endd
7166 yields
7167 .code
7168 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7169 .endd
7170 Removing the URL quoting, this is (with a leading and a trailing space):
7171 .code
7172 a\28bc\29\2A, a<yz>;
7173 .endd
7174 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7175 base DN specifications in queries. Conceptually, it first converts the string
7176 by inserting a backslash in front of any of the following characters:
7177 .code
7178 , + " \ < > ;
7179 .endd
7180 It also inserts a backslash before any leading spaces or # characters, and
7181 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7182 is then quoted according to the rules for URLs. For example:
7183 .code
7184 ${quote_ldap_dn: a(bc)*, a<yz>; }
7185 .endd
7186 yields
7187 .code
7188 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7189 .endd
7190 Removing the URL quoting, this is (with a trailing space):
7191 .code
7192 \ a(bc)*\, a\<yz\>\;\
7193 .endd
7194 There are some further comments about quoting in the section on LDAP
7195 authentication below.
7196
7197
7198 .section "LDAP connections" "SECID69"
7199 .cindex "LDAP" "connections"
7200 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7201 is in use, via a Unix domain socket. The example given above does not specify
7202 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7203 by starting it with
7204 .code
7205 ldap://<hostname>:<port>/...
7206 .endd
7207 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7208 used. When no server is specified in a query, a list of default servers is
7209 taken from the &%ldap_default_servers%& configuration option. This supplies a
7210 colon-separated list of servers which are tried in turn until one successfully
7211 handles a query, or there is a serious error. Successful handling either
7212 returns the requested data, or indicates that it does not exist. Serious errors
7213 are syntactical, or multiple values when only a single value is expected.
7214 Errors which cause the next server to be tried are connection failures, bind
7215 failures, and timeouts.
7216
7217 For each server name in the list, a port number can be given. The standard way
7218 of specifying a host and port is to use a colon separator (RFC 1738). Because
7219 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7220 doubled. For example
7221 .code
7222 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7223 .endd
7224 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7225 to the LDAP library with no server name, and the library's default (normally
7226 the local host) is used.
7227
7228 If you are using the OpenLDAP library, you can connect to an LDAP server using
7229 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7230 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7231 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7232 not available.
7233
7234 For this type of connection, instead of a host name for the server, a pathname
7235 for the socket is required, and the port number is not relevant. The pathname
7236 can be specified either as an item in &%ldap_default_servers%&, or inline in
7237 the query. In the former case, you can have settings such as
7238 .code
7239 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7240 .endd
7241 When the pathname is given in the query, you have to escape the slashes as
7242 &`%2F`& to fit in with the LDAP URL syntax. For example:
7243 .code
7244 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7245 .endd
7246 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7247 a pathname, it uses the Unix domain socket code, even if the query actually
7248 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7249 socket connection. This behaviour means that you can use a setting of
7250 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7251 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7252 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7253 backup host.
7254
7255 If an explicit &`ldapi`& type is given in a query when a host name is
7256 specified, an error is diagnosed. However, if there are more items in
7257 &%ldap_default_servers%&, they are tried. In other words:
7258
7259 .ilist
7260 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7261 interface.
7262 .next
7263 Using &`ldapi`& with a host name causes an error.
7264 .endlist
7265
7266
7267 Using &`ldapi`& with no host or path in the query, and no setting of
7268 &%ldap_default_servers%&, does whatever the library does by default.
7269
7270
7271
7272 .section "LDAP authentication and control information" "SECID70"
7273 .cindex "LDAP" "authentication"
7274 The LDAP URL syntax provides no way of passing authentication and other control
7275 information to the server. To make this possible, the URL in an LDAP query may
7276 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7277 spaces. If a value contains spaces it must be enclosed in double quotes, and
7278 when double quotes are used, backslash is interpreted in the usual way inside
7279 them. The following names are recognized:
7280 .display
7281 &`DEREFERENCE`&  set the dereferencing parameter
7282 &`NETTIME    `&  set a timeout for a network operation
7283 &`USER       `&  set the DN, for authenticating the LDAP bind
7284 &`PASS       `&  set the password, likewise
7285 &`REFERRALS  `&  set the referrals parameter
7286 &`SERVERS    `&  set alternate server list for this query only
7287 &`SIZE       `&  set the limit for the number of entries returned
7288 &`TIME       `&  set the maximum waiting time for a query
7289 .endd
7290 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7291 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7292 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7293 library from trying to follow referrals issued by the LDAP server.
7294
7295 The name CONNECT is an obsolete name for NETTIME, retained for
7296 backwards compatibility. This timeout (specified as a number of seconds) is
7297 enforced from the client end for operations that can be carried out over a
7298 network. Specifically, it applies to network connections and calls to the
7299 &'ldap_result()'& function. If the value is greater than zero, it is used if
7300 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7301 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7302 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7303 Netscape SDK; for OpenLDAP no action is taken.
7304
7305 The TIME parameter (also a number of seconds) is passed to the server to
7306 set a server-side limit on the time taken to complete a search.
7307
7308 The SERVERS parameter allows you to specify an alternate list of ldap servers
7309 to use for an individual lookup.  The global ldap_servers option provides a
7310 default list of ldap servers, and a single lookup can specify a single ldap
7311 server to use.  But when you need to do a lookup with a list of servers that is
7312 different than the default list (maybe different order, maybe a completely
7313 different set of servers), the SERVERS parameter allows you to specify this
7314 alternate list (colon-separated).
7315
7316 Here is an example of an LDAP query in an Exim lookup that uses some of these
7317 values. This is a single line, folded to fit on the page:
7318 .code
7319 ${lookup ldap
7320   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7321   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7322   {$value}fail}
7323 .endd
7324 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7325 any of the auxiliary data. Exim configuration settings that include lookups
7326 which contain password information should be preceded by &"hide"& to prevent
7327 non-admin users from using the &%-bP%& option to see their values.
7328
7329 The auxiliary data items may be given in any order. The default is no
7330 connection timeout (the system timeout is used), no user or password, no limit
7331 on the number of entries returned, and no time limit on queries.
7332
7333 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7334 removes any URL quoting that it may contain before passing it LDAP. Apparently
7335 some libraries do this for themselves, but some do not. Removing the URL
7336 quoting has two advantages:
7337
7338 .ilist
7339 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7340 DNs as with DNs inside actual queries.
7341 .next
7342 It permits spaces inside USER= DNs.
7343 .endlist
7344
7345 For example, a setting such as
7346 .code
7347 USER=cn=${quote_ldap_dn:$1}
7348 .endd
7349 should work even if &$1$& contains spaces.
7350
7351 Expanded data for the PASS= value should be quoted using the &%quote%&
7352 expansion operator, rather than the LDAP quote operators. The only reason this
7353 field needs quoting is to ensure that it conforms to the Exim syntax, which
7354 does not allow unquoted spaces. For example:
7355 .code
7356 PASS=${quote:$3}
7357 .endd
7358 The LDAP authentication mechanism can be used to check passwords as part of
7359 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7360 &<<CHAPexpand>>&.
7361
7362
7363
7364 .section "Format of data returned by LDAP" "SECID71"
7365 .cindex "LDAP" "returned data formats"
7366 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7367 as a sequence of values, for example
7368 .code
7369 cn=manager, o=University of Cambridge, c=UK
7370 .endd
7371 The &(ldap)& lookup type generates an error if more than one entry matches the
7372 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7373 the result between the data from different entries. It is possible for multiple
7374 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7375 you know that whatever values are returned all came from a single entry in the
7376 directory.
7377
7378 In the common case where you specify a single attribute in your LDAP query, the
7379 result is not quoted, and does not contain the attribute name. If the attribute
7380 has multiple values, they are separated by commas.
7381
7382 If you specify multiple attributes, the result contains space-separated, quoted
7383 strings, each preceded by the attribute name and an equals sign. Within the
7384 quotes, the quote character, backslash, and newline are escaped with
7385 backslashes, and commas are used to separate multiple values for the attribute.
7386 Any commas in attribute values are doubled
7387 (permitting treatment of the values as a comma-separated list).
7388 Apart from the escaping, the string within quotes takes the same form as the
7389 output when a single attribute is requested. Specifying no attributes is the
7390 same as specifying all of an entry's attributes.
7391
7392 Here are some examples of the output format. The first line of each pair is an
7393 LDAP query, and the second is the data that is returned. The attribute called
7394 &%attr1%& has two values, one of them with an embedded comma, whereas
7395 &%attr2%& has only one value:
7396 .code
7397 ldap:///o=base?attr1?sub?(uid=fred)
7398 value1.1,value1,,2
7399
7400 ldap:///o=base?attr2?sub?(uid=fred)
7401 value two
7402
7403 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7404 attr1="value1.1,value1,,2" attr2="value two"
7405
7406 ldap:///o=base??sub?(uid=fred)
7407 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7408 .endd
7409 You can
7410 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7411 results of LDAP lookups.
7412 The &%extract%& operator in string expansions can be used to pick out
7413 individual fields from data that consists of &'key'&=&'value'& pairs.
7414 The &%listextract%& operator should be used to pick out individual values
7415 of attributes, even when only a single value is expected.
7416 The doubling of embedded commas allows you to use the returned data as a
7417 comma separated list (using the "<," syntax for changing the input list separator).
7418
7419
7420
7421
7422 .section "More about NIS+" "SECTnisplus"
7423 .cindex "NIS+ lookup type"
7424 .cindex "lookup" "NIS+"
7425 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7426 and field name. If this is given, the result of a successful query is the
7427 contents of the named field; otherwise the result consists of a concatenation
7428 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7429 values containing spaces are quoted. For example, the query
7430 .code
7431 [name=mg1456],passwd.org_dir
7432 .endd
7433 might return the string
7434 .code
7435 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7436 home=/home/mg1456 shell=/bin/bash shadow=""
7437 .endd
7438 (split over two lines here to fit on the page), whereas
7439 .code
7440 [name=mg1456],passwd.org_dir:gcos
7441 .endd
7442 would just return
7443 .code
7444 Martin Guerre
7445 .endd
7446 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7447 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7448 operator is to double any quote characters within the text.
7449
7450
7451
7452 .section "SQL lookups" "SECTsql"
7453 .cindex "SQL lookup types"
7454 .cindex "MySQL" "lookup type"
7455 .cindex "PostgreSQL lookup type"
7456 .cindex "lookup" "MySQL"
7457 .cindex "lookup" "PostgreSQL"
7458 .cindex "Oracle" "lookup type"
7459 .cindex "lookup" "Oracle"
7460 .cindex "InterBase lookup type"
7461 .cindex "lookup" "InterBase"
7462 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7463 databases. Queries for these databases contain SQL statements, so an example
7464 might be
7465 .code
7466 ${lookup mysql{select mailbox from users where id='userx'}\
7467   {$value}fail}
7468 .endd
7469 If the result of the query contains more than one field, the data for each
7470 field in the row is returned, preceded by its name, so the result of
7471 .code
7472 ${lookup pgsql{select home,name from users where id='userx'}\
7473   {$value}}
7474 .endd
7475 might be
7476 .code
7477 home=/home/userx name="Mister X"
7478 .endd
7479 Empty values and values containing spaces are double quoted, with embedded
7480 quotes escaped by a backslash. If the result of the query contains just one
7481 field, the value is passed back verbatim, without a field name, for example:
7482 .code
7483 Mister X
7484 .endd
7485 If the result of the query yields more than one row, it is all concatenated,
7486 with a newline between the data for each row.
7487
7488
7489 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7490 .cindex "MySQL" "lookup type"
7491 .cindex "PostgreSQL lookup type"
7492 .cindex "lookup" "MySQL"
7493 .cindex "lookup" "PostgreSQL"
7494 .cindex "Oracle" "lookup type"
7495 .cindex "lookup" "Oracle"
7496 .cindex "InterBase lookup type"
7497 .cindex "lookup" "InterBase"
7498 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7499 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7500 option (as appropriate) must be set to a colon-separated list of server
7501 information.
7502 (For MySQL and PostgreSQL only, the global option need not be set if all
7503 queries contain their own server information &-- see section
7504 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7505 items: host name, database name, user name, and password. In the case of
7506 Oracle, the host name field is used for the &"service name"&, and the database
7507 name field is not used and should be empty. For example:
7508 .code
7509 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7510 .endd
7511 Because password data is sensitive, you should always precede the setting with
7512 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7513 option. Here is an example where two MySQL servers are listed:
7514 .code
7515 hide mysql_servers = localhost/users/root/secret:\
7516                      otherhost/users/root/othersecret
7517 .endd
7518 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7519 because this is a colon-separated list, the colon has to be doubled. For each
7520 query, these parameter groups are tried in order until a connection is made and
7521 a query is successfully processed. The result of a query may be that no data is
7522 found, but that is still a successful query. In other words, the list of
7523 servers provides a backup facility, not a list of different places to look.
7524
7525 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7526 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7527 respectively, and the characters single-quote, double-quote, and backslash
7528 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7529 addition, escapes the percent and underscore characters. This cannot be done
7530 for MySQL because these escapes are not recognized in contexts where these
7531 characters are not special.
7532
7533 .section "Specifying the server in the query" "SECTspeserque"
7534 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7535 it is possible to specify a list of servers with an individual query. This is
7536 done by starting the query with
7537 .display
7538 &`servers=`&&'server1:server2:server3:...'&&`;`&
7539 .endd
7540 Each item in the list may take one of two forms:
7541 .olist
7542 If it contains no slashes it is assumed to be just a host name. The appropriate
7543 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7544 of the same name, and the remaining parameters (database, user, password) are
7545 taken from there.
7546 .next
7547 If it contains any slashes, it is taken as a complete parameter set.
7548 .endlist
7549 The list of servers is used in exactly the same way as the global list.
7550 Once a connection to a server has happened and a query has been
7551 successfully executed, processing of the lookup ceases.
7552
7553 This feature is intended for use in master/slave situations where updates
7554 are occurring and you want to update the master rather than a slave. If the
7555 master is in the list as a backup for reading, you might have a global setting
7556 like this:
7557 .code
7558 mysql_servers = slave1/db/name/pw:\
7559                 slave2/db/name/pw:\
7560                 master/db/name/pw
7561 .endd
7562 In an updating lookup, you could then write:
7563 .code
7564 ${lookup mysql{servers=master; UPDATE ...} }
7565 .endd
7566 That query would then be sent only to the master server. If, on the other hand,
7567 the master is not to be used for reading, and so is not present in the global
7568 option, you can still update it by a query of this form:
7569 .code
7570 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7571 .endd
7572
7573
7574 .section "Special MySQL features" "SECID73"
7575 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7576 causes a connection to the server on the local host by means of a Unix domain
7577 socket. An alternate socket can be specified in parentheses. The full syntax of
7578 each item in &%mysql_servers%& is:
7579 .display
7580 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7581   <&'user'&>/<&'password'&>
7582 .endd
7583 Any of the three sub-parts of the first field can be omitted. For normal use on
7584 the local host it can be left blank or set to just &"localhost"&.
7585
7586 No database need be supplied &-- but if it is absent here, it must be given in
7587 the queries.
7588
7589 If a MySQL query is issued that does not request any data (an insert, update,
7590 or delete command), the result of the lookup is the number of rows affected.
7591
7592 &*Warning*&: This can be misleading. If an update does not actually change
7593 anything (for example, setting a field to the value it already has), the result
7594 is zero because no rows are affected.
7595
7596
7597 .section "Special PostgreSQL features" "SECID74"
7598 PostgreSQL lookups can also use Unix domain socket connections to the database.
7599 This is usually faster and costs less CPU time than a TCP/IP connection.
7600 However it can be used only if the mail server runs on the same machine as the
7601 database server. A configuration line for PostgreSQL via Unix domain sockets
7602 looks like this:
7603 .code
7604 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7605 .endd
7606 In other words, instead of supplying a host name, a path to the socket is
7607 given. The path name is enclosed in parentheses so that its slashes aren't
7608 visually confused with the delimiters for the other server parameters.
7609
7610 If a PostgreSQL query is issued that does not request any data (an insert,
7611 update, or delete command), the result of the lookup is the number of rows
7612 affected.
7613
7614 .section "More about SQLite" "SECTsqlite"
7615 .cindex "lookup" "SQLite"
7616 .cindex "sqlite lookup type"
7617 SQLite is different to the other SQL lookups because a file name is required in
7618 addition to the SQL query. An SQLite database is a single file, and there is no
7619 daemon as in the other SQL databases. The interface to Exim requires the name
7620 of the file, as an absolute path, to be given at the start of the query. It is
7621 separated from the query by white space. This means that the path name cannot
7622 contain white space. Here is a lookup expansion example:
7623 .code
7624 ${lookup sqlite {/some/thing/sqlitedb \
7625   select name from aliases where id='userx';}}
7626 .endd
7627 In a list, the syntax is similar. For example:
7628 .code
7629 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7630    select * from relays where ip='$sender_host_address';
7631 .endd
7632 The only character affected by the &%quote_sqlite%& operator is a single
7633 quote, which it doubles.
7634
7635 The SQLite library handles multiple simultaneous accesses to the database
7636 internally. Multiple readers are permitted, but only one process can
7637 update at once. Attempts to access the database while it is being updated
7638 are rejected after a timeout period, during which the SQLite library
7639 waits for the lock to be released. In Exim, the default timeout is set
7640 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7641 option.
7642 .ecindex IIDfidalo1
7643 .ecindex IIDfidalo2
7644
7645
7646 . ////////////////////////////////////////////////////////////////////////////
7647 . ////////////////////////////////////////////////////////////////////////////
7648
7649 .chapter "Domain, host, address, and local part lists" &&&
7650          "CHAPdomhosaddlists" &&&
7651          "Domain, host, and address lists"
7652 .scindex IIDdohoadli "lists of domains; hosts; etc."
7653 A number of Exim configuration options contain lists of domains, hosts,
7654 email addresses, or local parts. For example, the &%hold_domains%& option
7655 contains a list of domains whose delivery is currently suspended. These lists
7656 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7657 arguments to expansion conditions such as &%match_domain%&.
7658
7659 Each item in one of these lists is a pattern to be matched against a domain,
7660 host, email address, or local part, respectively. In the sections below, the
7661 different types of pattern for each case are described, but first we cover some
7662 general facilities that apply to all four kinds of list.
7663
7664
7665
7666 .section "Expansion of lists" "SECID75"
7667 .cindex "expansion" "of lists"
7668 Each list is expanded as a single string before it is used. The result of
7669 expansion must be a list, possibly containing empty items, which is split up
7670 into separate items for matching. By default, colon is the separator character,
7671 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7672 &<<SECTempitelis>>& for details of the list syntax; the second of these
7673 discusses the way to specify empty list items.
7674
7675
7676 If the string expansion is forced to fail, Exim behaves as if the item it is
7677 testing (domain, host, address, or local part) is not in the list. Other
7678 expansion failures cause temporary errors.
7679
7680 If an item in a list is a regular expression, backslashes, dollars and possibly
7681 other special characters in the expression must be protected against
7682 misinterpretation by the string expander. The easiest way to do this is to use
7683 the &`\N`& expansion feature to indicate that the contents of the regular
7684 expression should not be expanded. For example, in an ACL you might have:
7685 .code
7686 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7687                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7688 .endd
7689 The first item is a regular expression that is protected from expansion by
7690 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7691 senders based on the receiving domain.
7692
7693
7694
7695
7696 .section "Negated items in lists" "SECID76"
7697 .cindex "list" "negation"
7698 .cindex "negation" "in lists"
7699 Items in a list may be positive or negative. Negative items are indicated by a
7700 leading exclamation mark, which may be followed by optional white space. A list
7701 defines a set of items (domains, etc). When Exim processes one of these lists,
7702 it is trying to find out whether a domain, host, address, or local part
7703 (respectively) is in the set that is defined by the list. It works like this:
7704
7705 The list is scanned from left to right. If a positive item is matched, the
7706 subject that is being checked is in the set; if a negative item is matched, the
7707 subject is not in the set. If the end of the list is reached without the
7708 subject having matched any of the patterns, it is in the set if the last item
7709 was a negative one, but not if it was a positive one. For example, the list in
7710 .code
7711 domainlist relay_to_domains = !a.b.c : *.b.c
7712 .endd
7713 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7714 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7715 list is positive. However, if the setting were
7716 .code
7717 domainlist relay_to_domains = !a.b.c
7718 .endd
7719 then all domains other than &'a.b.c'& would match because the last item in the
7720 list is negative. In other words, a list that ends with a negative item behaves
7721 as if it had an extra item &`:*`& on the end.
7722
7723 Another way of thinking about positive and negative items in lists is to read
7724 the connector as &"or"& after a positive item and as &"and"& after a negative
7725 item.
7726
7727
7728
7729 .section "File names in lists" "SECTfilnamlis"
7730 .cindex "list" "file name in"
7731 If an item in a domain, host, address, or local part list is an absolute file
7732 name (beginning with a slash character), each line of the file is read and
7733 processed as if it were an independent item in the list, except that further
7734 file names are not allowed,
7735 and no expansion of the data from the file takes place.
7736 Empty lines in the file are ignored, and the file may also contain comment
7737 lines:
7738
7739 .ilist
7740 For domain and host lists, if a # character appears anywhere in a line of the
7741 file, it and all following characters are ignored.
7742 .next
7743 Because local parts may legitimately contain # characters, a comment in an
7744 address list or local part list file is recognized only if # is preceded by
7745 white space or the start of the line. For example:
7746 .code
7747 not#comment@x.y.z   # but this is a comment
7748 .endd
7749 .endlist
7750
7751 Putting a file name in a list has the same effect as inserting each line of the
7752 file as an item in the list (blank lines and comments excepted). However, there
7753 is one important difference: the file is read each time the list is processed,
7754 so if its contents vary over time, Exim's behaviour changes.
7755
7756 If a file name is preceded by an exclamation mark, the sense of any match
7757 within the file is inverted. For example, if
7758 .code
7759 hold_domains = !/etc/nohold-domains
7760 .endd
7761 and the file contains the lines
7762 .code
7763 !a.b.c
7764 *.b.c
7765 .endd
7766 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7767 any domain matching &`*.b.c`& is not.
7768
7769
7770
7771 .section "An lsearch file is not an out-of-line list" "SECID77"
7772 As will be described in the sections that follow, lookups can be used in lists
7773 to provide indexed methods of checking list membership. There has been some
7774 confusion about the way &(lsearch)& lookups work in lists. Because
7775 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7776 sometimes thought that it is allowed to contain wild cards and other kinds of
7777 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7778 always fixed strings, just as for any other single-key lookup type.
7779
7780 If you want to use a file to contain wild-card patterns that form part of a
7781 list, just give the file name on its own, without a search type, as described
7782 in the previous section. You could also use the &(wildlsearch)& or
7783 &(nwildlsearch)&, but there is no advantage in doing this.
7784
7785
7786
7787
7788 .section "Named lists" "SECTnamedlists"
7789 .cindex "named lists"
7790 .cindex "list" "named"
7791 A list of domains, hosts, email addresses, or local parts can be given a name
7792 which is then used to refer to the list elsewhere in the configuration. This is
7793 particularly convenient if the same list is required in several different
7794 places. It also allows lists to be given meaningful names, which can improve
7795 the readability of the configuration. For example, it is conventional to define
7796 a domain list called &'local_domains'& for all the domains that are handled
7797 locally on a host, using a configuration line such as
7798 .code
7799 domainlist local_domains = localhost:my.dom.example
7800 .endd
7801 Named lists are referenced by giving their name preceded by a plus sign, so,
7802 for example, a router that is intended to handle local domains would be
7803 configured with the line
7804 .code
7805 domains = +local_domains
7806 .endd
7807 The first router in a configuration is often one that handles all domains
7808 except the local ones, using a configuration with a negated item like this:
7809 .code
7810 dnslookup:
7811   driver = dnslookup
7812   domains = ! +local_domains
7813   transport = remote_smtp
7814   no_more
7815 .endd
7816 The four kinds of named list are created by configuration lines starting with
7817 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7818 respectively. Then there follows the name that you are defining, followed by an
7819 equals sign and the list itself. For example:
7820 .code
7821 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7822 addresslist bad_senders = cdb;/etc/badsenders
7823 .endd
7824 A named list may refer to other named lists:
7825 .code
7826 domainlist  dom1 = first.example : second.example
7827 domainlist  dom2 = +dom1 : third.example
7828 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7829 .endd
7830 &*Warning*&: If the last item in a referenced list is a negative one, the
7831 effect may not be what you intended, because the negation does not propagate
7832 out to the higher level. For example, consider:
7833 .code
7834 domainlist  dom1 = !a.b
7835 domainlist  dom2 = +dom1 : *.b
7836 .endd
7837 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7838 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7839 means it matches the second list as well. The effect is not the same as
7840 .code
7841 domainlist  dom2 = !a.b : *.b
7842 .endd
7843 where &'x.y'& does not match. It's best to avoid negation altogether in
7844 referenced lists if you can.
7845
7846 Named lists may have a performance advantage. When Exim is routing an
7847 address or checking an incoming message, it caches the result of tests on named
7848 lists. So, if you have a setting such as
7849 .code
7850 domains = +local_domains
7851 .endd
7852 on several of your routers
7853 or in several ACL statements,
7854 the actual test is done only for the first one. However, the caching works only
7855 if there are no expansions within the list itself or any sublists that it
7856 references. In other words, caching happens only for lists that are known to be
7857 the same each time they are referenced.
7858
7859 By default, there may be up to 16 named lists of each type. This limit can be
7860 extended by changing a compile-time variable. The use of domain and host lists
7861 is recommended for concepts such as local domains, relay domains, and relay
7862 hosts. The default configuration is set up like this.
7863
7864
7865
7866 .section "Named lists compared with macros" "SECID78"
7867 .cindex "list" "named compared with macro"
7868 .cindex "macro" "compared with named list"
7869 At first sight, named lists might seem to be no different from macros in the
7870 configuration file. However, macros are just textual substitutions. If you
7871 write
7872 .code
7873 ALIST = host1 : host2
7874 auth_advertise_hosts = !ALIST
7875 .endd
7876 it probably won't do what you want, because that is exactly the same as
7877 .code
7878 auth_advertise_hosts = !host1 : host2
7879 .endd
7880 Notice that the second host name is not negated. However, if you use a host
7881 list, and write
7882 .code
7883 hostlist alist = host1 : host2
7884 auth_advertise_hosts = ! +alist
7885 .endd
7886 the negation applies to the whole list, and so that is equivalent to
7887 .code
7888 auth_advertise_hosts = !host1 : !host2
7889 .endd
7890
7891
7892 .section "Named list caching" "SECID79"
7893 .cindex "list" "caching of named"
7894 .cindex "caching" "named lists"
7895 While processing a message, Exim caches the result of checking a named list if
7896 it is sure that the list is the same each time. In practice, this means that
7897 the cache operates only if the list contains no $ characters, which guarantees
7898 that it will not change when it is expanded. Sometimes, however, you may have
7899 an expanded list that you know will be the same each time within a given
7900 message. For example:
7901 .code
7902 domainlist special_domains = \
7903            ${lookup{$sender_host_address}cdb{/some/file}}
7904 .endd
7905 This provides a list of domains that depends only on the sending host's IP
7906 address. If this domain list is referenced a number of times (for example,
7907 in several ACL lines, or in several routers) the result of the check is not
7908 cached by default, because Exim does not know that it is going to be the
7909 same list each time.
7910
7911 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7912 cache the result anyway. For example:
7913 .code
7914 domainlist_cache special_domains = ${lookup{...
7915 .endd
7916 If you do this, you should be absolutely sure that caching is going to do
7917 the right thing in all cases. When in doubt, leave it out.
7918
7919
7920
7921 .section "Domain lists" "SECTdomainlist"
7922 .cindex "domain list" "patterns for"
7923 .cindex "list" "domain list"
7924 Domain lists contain patterns that are to be matched against a mail domain.
7925 The following types of item may appear in domain lists:
7926
7927 .ilist
7928 .cindex "primary host name"
7929 .cindex "host name" "matched in domain list"
7930 .oindex "&%primary_hostname%&"
7931 .cindex "domain list" "matching primary host name"
7932 .cindex "@ in a domain list"
7933 If a pattern consists of a single @ character, it matches the local host name,
7934 as set by the &%primary_hostname%& option (or defaulted). This makes it
7935 possible to use the same configuration file on several different hosts that
7936 differ only in their names.
7937 .next
7938 .cindex "@[] in a domain list"
7939 .cindex "domain list" "matching local IP interfaces"
7940 .cindex "domain literal"
7941 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7942 in square brackets (as in an email address that contains a domain literal), but
7943 only if that IP address is recognized as local for email routing purposes. The
7944 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7945 control which of a host's several IP addresses are treated as local.
7946 In today's Internet, the use of domain literals is controversial.
7947 .next
7948 .cindex "@mx_any"
7949 .cindex "@mx_primary"
7950 .cindex "@mx_secondary"
7951 .cindex "domain list" "matching MX pointers to local host"
7952 If a pattern consists of the string &`@mx_any`& it matches any domain that
7953 has an MX record pointing to the local host or to any host that is listed in
7954 .oindex "&%hosts_treat_as_local%&"
7955 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7956 are similar, except that the first matches only when a primary MX target is the
7957 local host, and the second only when no primary MX target is the local host,
7958 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7959 preference value &-- there may of course be more than one of them.
7960
7961 The MX lookup that takes place when matching a pattern of this type is
7962 performed with the resolver options for widening names turned off. Thus, for
7963 example, a single-component domain will &'not'& be expanded by adding the
7964 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7965 options of the &(dnslookup)& router for a discussion of domain widening.
7966
7967 Sometimes you may want to ignore certain IP addresses when using one of these
7968 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7969 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7970 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7971 on a router). For example:
7972 .code
7973 domains = @mx_any/ignore=127.0.0.1
7974 .endd
7975 This example matches any domain that has an MX record pointing to one of
7976 the local host's IP addresses other than 127.0.0.1.
7977
7978 The list of IP addresses is in fact processed by the same code that processes
7979 host lists, so it may contain CIDR-coded network specifications and it may also
7980 contain negative items.
7981
7982 Because the list of IP addresses is a sublist within a domain list, you have to
7983 be careful about delimiters if there is more than one address. Like any other
7984 list, the default delimiter can be changed. Thus, you might have:
7985 .code
7986 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7987           an.other.domain : ...
7988 .endd
7989 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7990 involved, it is easiest to change the delimiter for the main list as well:
7991 .code
7992 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
7993           an.other.domain ? ...
7994 .endd
7995 .next
7996 .cindex "asterisk" "in domain list"
7997 .cindex "domain list" "asterisk in"
7998 .cindex "domain list" "matching &""ends with""&"
7999 If a pattern starts with an asterisk, the remaining characters of the pattern
8000 are compared with the terminating characters of the domain. The use of &"*"& in
8001 domain lists differs from its use in partial matching lookups. In a domain
8002 list, the character following the asterisk need not be a dot, whereas partial
8003 matching works only in terms of dot-separated components. For example, a domain
8004 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8005 &'cipher.key.ex'&.
8006
8007 .next
8008 .cindex "regular expressions" "in domain list"
8009 .cindex "domain list" "matching regular expression"
8010 If a pattern starts with a circumflex character, it is treated as a regular
8011 expression, and matched against the domain using a regular expression matching
8012 function. The circumflex is treated as part of the regular expression.
8013 Email domains are case-independent, so this regular expression match is by
8014 default case-independent, but you can make it case-dependent by starting it
8015 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8016 are given in chapter &<<CHAPregexp>>&.
8017
8018 &*Warning*&: Because domain lists are expanded before being processed, you
8019 must escape any backslash and dollar characters in the regular expression, or
8020 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8021 it is not to be expanded (unless you really do want to build a regular
8022 expression by expansion, of course).
8023 .next
8024 .cindex "lookup" "in domain list"
8025 .cindex "domain list" "matching by lookup"
8026 If a pattern starts with the name of a single-key lookup type followed by a
8027 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8028 must be a file name in a suitable format for the lookup type. For example, for
8029 &"cdb;"& it must be an absolute path:
8030 .code
8031 domains = cdb;/etc/mail/local_domains.cdb
8032 .endd
8033 The appropriate type of lookup is done on the file using the domain name as the
8034 key. In most cases, the data that is looked up is not used; Exim is interested
8035 only in whether or not the key is present in the file. However, when a lookup
8036 is used for the &%domains%& option on a router
8037 or a &%domains%& condition in an ACL statement, the data is preserved in the
8038 &$domain_data$& variable and can be referred to in other router options or
8039 other statements in the same ACL.
8040
8041 .next
8042 Any of the single-key lookup type names may be preceded by
8043 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8044 .code
8045 domains = partial-dbm;/partial/domains
8046 .endd
8047 This causes partial matching logic to be invoked; a description of how this
8048 works is given in section &<<SECTpartiallookup>>&.
8049
8050 .next
8051 .cindex "asterisk" "in lookup type"
8052 Any of the single-key lookup types may be followed by an asterisk. This causes
8053 a default lookup for a key consisting of a single asterisk to be done if the
8054 original lookup fails. This is not a useful feature when using a domain list to
8055 select particular domains (because any domain would match), but it might have
8056 value if the result of the lookup is being used via the &$domain_data$&
8057 expansion variable.
8058 .next
8059 If the pattern starts with the name of a query-style lookup type followed by a
8060 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8061 pattern must be an appropriate query for the lookup type, as described in
8062 chapter &<<CHAPfdlookup>>&. For example:
8063 .code
8064 hold_domains = mysql;select domain from holdlist \
8065   where domain = '${quote_mysql:$domain}';
8066 .endd
8067 In most cases, the data that is looked up is not used (so for an SQL query, for
8068 example, it doesn't matter what field you select). Exim is interested only in
8069 whether or not the query succeeds. However, when a lookup is used for the
8070 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8071 variable and can be referred to in other options.
8072 .next
8073 .cindex "domain list" "matching literal domain name"
8074 If none of the above cases apply, a caseless textual comparison is made
8075 between the pattern and the domain.
8076 .endlist
8077
8078 Here is an example that uses several different kinds of pattern:
8079 .code
8080 domainlist funny_domains = \
8081   @ : \
8082   lib.unseen.edu : \
8083   *.foundation.fict.example : \
8084   \N^[1-2]\d{3}\.fict\.example$\N : \
8085   partial-dbm;/opt/data/penguin/book : \
8086   nis;domains.byname : \
8087   nisplus;[name=$domain,status=local],domains.org_dir
8088 .endd
8089 There are obvious processing trade-offs among the various matching modes. Using
8090 an asterisk is faster than a regular expression, and listing a few names
8091 explicitly probably is too. The use of a file or database lookup is expensive,
8092 but may be the only option if hundreds of names are required. Because the
8093 patterns are tested in order, it makes sense to put the most commonly matched
8094 patterns earlier.
8095
8096
8097
8098 .section "Host lists" "SECThostlist"
8099 .cindex "host list" "patterns in"
8100 .cindex "list" "host list"
8101 Host lists are used to control what remote hosts are allowed to do. For
8102 example, some hosts may be allowed to use the local host as a relay, and some
8103 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8104 two different ways, by name or by IP address. In a host list, some types of
8105 pattern are matched to a host name, and some are matched to an IP address.
8106 You need to be particularly careful with this when single-key lookups are
8107 involved, to ensure that the right value is being used as the key.
8108
8109
8110 .section "Special host list patterns" "SECID80"
8111 .cindex "empty item in hosts list"
8112 .cindex "host list" "empty string in"
8113 If a host list item is the empty string, it matches only when no remote host is
8114 involved. This is the case when a message is being received from a local
8115 process using SMTP on the standard input, that is, when a TCP/IP connection is
8116 not used.
8117
8118 .cindex "asterisk" "in host list"
8119 The special pattern &"*"& in a host list matches any host or no host. Neither
8120 the IP address nor the name is actually inspected.
8121
8122
8123
8124 .section "Host list patterns that match by IP address" "SECThoslispatip"
8125 .cindex "host list" "matching IP addresses"
8126 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8127 the incoming address actually appears in the IPv6 host as
8128 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8129 list, it is converted into a traditional IPv4 address first. (Not all operating
8130 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8131 concerns.)
8132
8133 The following types of pattern in a host list check the remote host by
8134 inspecting its IP address:
8135
8136 .ilist
8137 If the pattern is a plain domain name (not a regular expression, not starting
8138 with *, not a lookup of any kind), Exim calls the operating system function
8139 to find the associated IP address(es). Exim uses the newer
8140 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8141 This typically causes a forward DNS lookup of the name. The result is compared
8142 with the IP address of the subject host.
8143
8144 If there is a temporary problem (such as a DNS timeout) with the host name
8145 lookup, a temporary error occurs. For example, if the list is being used in an
8146 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8147 temporary SMTP error code. If no IP address can be found for the host name,
8148 what happens is described in section &<<SECTbehipnot>>& below.
8149
8150 .next
8151 .cindex "@ in a host list"
8152 If the pattern is &"@"&, the primary host name is substituted and used as a
8153 domain name, as just described.
8154
8155 .next
8156 If the pattern is an IP address, it is matched against the IP address of the
8157 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8158 IPv6 addresses can be given in colon-separated format, but the colons have to
8159 be doubled so as not to be taken as item separators when the default list
8160 separator is used. IPv6 addresses are recognized even when Exim is compiled
8161 without IPv6 support. This means that if they appear in a host list on an
8162 IPv4-only host, Exim will not treat them as host names. They are just addresses
8163 that can never match a client host.
8164
8165 .next
8166 .cindex "@[] in a host list"
8167 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8168 the local host. For example, if the local host is an IPv4 host with one
8169 interface address 10.45.23.56, these two ACL statements have the same effect:
8170 .code
8171 accept hosts = 127.0.0.1 : 10.45.23.56
8172 accept hosts = @[]
8173 .endd
8174 .next
8175 .cindex "CIDR notation"
8176 If the pattern is an IP address followed by a slash and a mask length (for
8177 example 10.11.42.0/24), it is matched against the IP address of the subject
8178 host under the given mask. This allows, an entire network of hosts to be
8179 included (or excluded) by a single item. The mask uses CIDR notation; it
8180 specifies the number of address bits that must match, starting from the most
8181 significant end of the address.
8182
8183 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8184 of a range of addresses. It is the number of bits in the network portion of the
8185 address. The above example specifies a 24-bit netmask, so it matches all 256
8186 addresses in the 10.11.42.0 network. An item such as
8187 .code
8188 192.168.23.236/31
8189 .endd
8190 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8191 32 for an IPv4 address is the same as no mask at all; just a single address
8192 matches.
8193
8194 Here is another example which shows an IPv4 and an IPv6 network:
8195 .code
8196 recipient_unqualified_hosts = 192.168.0.0/16: \
8197                               3ffe::ffff::836f::::/48
8198 .endd
8199 The doubling of list separator characters applies only when these items
8200 appear inline in a host list. It is not required when indirecting via a file.
8201 For example:
8202 .code
8203 recipient_unqualified_hosts = /opt/exim/unqualnets
8204 .endd
8205 could make use of a file containing
8206 .code
8207 172.16.0.0/12
8208 3ffe:ffff:836f::/48
8209 .endd
8210 to have exactly the same effect as the previous example. When listing IPv6
8211 addresses inline, it is usually more convenient to use the facility for
8212 changing separator characters. This list contains the same two networks:
8213 .code
8214 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8215                                  3ffe:ffff:836f::/48
8216 .endd
8217 The separator is changed to semicolon by the leading &"<;"& at the start of the
8218 list.
8219 .endlist
8220
8221
8222
8223 .section "Host list patterns for single-key lookups by host address" &&&
8224          "SECThoslispatsikey"
8225 .cindex "host list" "lookup of IP address"
8226 When a host is to be identified by a single-key lookup of its complete IP
8227 address, the pattern takes this form:
8228 .display
8229 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8230 .endd
8231 For example:
8232 .code
8233 hosts_lookup = net-cdb;/hosts-by-ip.db
8234 .endd
8235 The text form of the IP address of the subject host is used as the lookup key.
8236 IPv6 addresses are converted to an unabbreviated form, using lower case
8237 letters, with dots as separators because colon is the key terminator in
8238 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8239 quoting the keys, but this is a facility that was added later.] The data
8240 returned by the lookup is not used.
8241
8242 .cindex "IP address" "masking"
8243 .cindex "host list" "masked IP address"
8244 Single-key lookups can also be performed using masked IP addresses, using
8245 patterns of this form:
8246 .display
8247 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8248 .endd
8249 For example:
8250 .code
8251 net24-dbm;/networks.db
8252 .endd
8253 The IP address of the subject host is masked using <&'number'&> as the mask
8254 length. A textual string is constructed from the masked value, followed by the
8255 mask, and this is used as the lookup key. For example, if the host's IP address
8256 is 192.168.34.6, the key that is looked up for the above example is
8257 &"192.168.34.0/24"&.
8258
8259 When an IPv6 address is converted to a string, dots are normally used instead
8260 of colons, so that keys in &(lsearch)& files need not contain colons (which
8261 terminate &(lsearch)& keys). This was implemented some time before the ability
8262 to quote keys was made available in &(lsearch)& files. However, the more
8263 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8264 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8265 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8266 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8267 addresses are always used.
8268
8269 Ideally, it would be nice to tidy up this anomalous situation by changing to
8270 colons in all cases, given that quoting is now available for &(lsearch)&.
8271 However, this would be an incompatible change that might break some existing
8272 configurations.
8273
8274 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8275 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8276 the former case the key strings include the mask value, whereas in the latter
8277 case the IP address is used on its own.
8278
8279
8280
8281 .section "Host list patterns that match by host name" "SECThoslispatnam"
8282 .cindex "host" "lookup failures"
8283 .cindex "unknown host name"
8284 .cindex "host list" "matching host name"
8285 There are several types of pattern that require Exim to know the name of the
8286 remote host. These are either wildcard patterns or lookups by name. (If a
8287 complete hostname is given without any wildcarding, it is used to find an IP
8288 address to match against, as described in section &<<SECThoslispatip>>&
8289 above.)
8290
8291 If the remote host name is not already known when Exim encounters one of these
8292 patterns, it has to be found from the IP address.
8293 Although many sites on the Internet are conscientious about maintaining reverse
8294 DNS data for their hosts, there are also many that do not do this.
8295 Consequently, a name cannot always be found, and this may lead to unwanted
8296 effects. Take care when configuring host lists with wildcarded name patterns.
8297 Consider what will happen if a name cannot be found.
8298
8299 Because of the problems of determining host names from IP addresses, matching
8300 against host names is not as common as matching against IP addresses.
8301
8302 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8303 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8304 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8305 are done can be changed by setting the &%host_lookup_order%& option. For
8306 security, once Exim has found one or more names, it looks up the IP addresses
8307 for these names and compares them with the IP address that it started with.
8308 Only those names whose IP addresses match are accepted. Any other names are
8309 discarded. If no names are left, Exim behaves as if the host name cannot be
8310 found. In the most common case there is only one name and one IP address.
8311
8312 There are some options that control what happens if a host name cannot be
8313 found. These are described in section &<<SECTbehipnot>>& below.
8314
8315 .cindex "host" "alias for"
8316 .cindex "alias for host"
8317 As a result of aliasing, hosts may have more than one name. When processing any
8318 of the following types of pattern, all the host's names are checked:
8319
8320 .ilist
8321 .cindex "asterisk" "in host list"
8322 If a pattern starts with &"*"& the remainder of the item must match the end of
8323 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8324 &'.b.c'&. This special simple form is provided because this is a very common
8325 requirement. Other kinds of wildcarding require the use of a regular
8326 expression.
8327 .next
8328 .cindex "regular expressions" "in host list"
8329 .cindex "host list" "regular expression in"
8330 If the item starts with &"^"& it is taken to be a regular expression which is
8331 matched against the host name. Host names are case-independent, so this regular
8332 expression match is by default case-independent, but you can make it
8333 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8334 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8335 example,
8336 .code
8337 ^(a|b)\.c\.d$
8338 .endd
8339 is a regular expression that matches either of the two hosts &'a.c.d'& or
8340 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8341 that backslash and dollar characters are not misinterpreted as part of the
8342 string expansion. The simplest way to do this is to use &`\N`& to mark that
8343 part of the string as non-expandable. For example:
8344 .code
8345 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8346 .endd
8347 &*Warning*&: If you want to match a complete host name, you must include the
8348 &`$`& terminating metacharacter in the regular expression, as in the above
8349 example. Without it, a match at the start of the host name is all that is
8350 required.
8351 .endlist
8352
8353
8354
8355
8356 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8357 .cindex "host" "lookup failures, permanent"
8358 While processing a host list, Exim may need to look up an IP address from a
8359 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8360 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8361 behaviour when it fails to find the information it is seeking is the same.
8362
8363 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8364 apply to temporary DNS errors, whose handling is described in the next section.
8365
8366 .cindex "&`+include_unknown`&"
8367 .cindex "&`+ignore_unknown`&"
8368 Exim parses a host list from left to right. If it encounters a permanent
8369 lookup failure in any item in the host list before it has found a match,
8370 Exim treats it as a failure and the default behavior is as if the host
8371 does not match the list. This may not always be what you want to happen.
8372 To change Exim's behaviour, the special items &`+include_unknown`& or
8373 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8374 not recognized in an indirected file).
8375
8376 .ilist
8377 If any item that follows &`+include_unknown`& requires information that
8378 cannot found, Exim behaves as if the host does match the list. For example,
8379 .code
8380 host_reject_connection = +include_unknown:*.enemy.ex
8381 .endd
8382 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8383 any hosts whose name it cannot find.
8384
8385 .next
8386 If any item that follows &`+ignore_unknown`& requires information that cannot
8387 be found, Exim ignores that item and proceeds to the rest of the list. For
8388 example:
8389 .code
8390 accept hosts = +ignore_unknown : friend.example : \
8391                192.168.4.5
8392 .endd
8393 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8394 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8395 name can be found for 192.168.4.5, it is rejected.
8396 .endlist
8397
8398 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8399 list. The effect of each one lasts until the next, or until the end of the
8400 list.
8401
8402 .section "Mixing wildcarded host names and addresses in host lists" &&&
8403          "SECTmixwilhos"
8404 .cindex "host list" "mixing names and addresses in"
8405
8406 This section explains the host/ip processing logic with the same concepts
8407 as the previous section, but specifically addresses what happens when a
8408 wildcarded hostname is one of the items in the hostlist.
8409
8410 .ilist
8411 If you have name lookups or wildcarded host names and
8412 IP addresses in the same host list, you should normally put the IP
8413 addresses first. For example, in an ACL you could have:
8414 .code
8415 accept hosts = 10.9.8.7 : *.friend.example
8416 .endd
8417 The reason you normally would order it this way lies in the
8418 left-to-right way that Exim processes lists.  It can test IP addresses
8419 without doing any DNS lookups, but when it reaches an item that requires
8420 a host name, it fails if it cannot find a host name to compare with the
8421 pattern. If the above list is given in the opposite order, the
8422 &%accept%& statement fails for a host whose name cannot be found, even
8423 if its IP address is 10.9.8.7.
8424
8425 .next
8426 If you really do want to do the name check first, and still recognize the IP
8427 address, you can rewrite the ACL like this:
8428 .code
8429 accept hosts = *.friend.example
8430 accept hosts = 10.9.8.7
8431 .endd
8432 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8433 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8434 &`+ignore_unknown`&, which was discussed in depth in the first example in
8435 this section.
8436 .endlist
8437
8438
8439 .section "Temporary DNS errors when looking up host information" &&&
8440          "SECTtemdnserr"
8441 .cindex "host" "lookup failures, temporary"
8442 .cindex "&`+include_defer`&"
8443 .cindex "&`+ignore_defer`&"
8444 A temporary DNS lookup failure normally causes a defer action (except when
8445 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8446 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8447 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8448 section. These options should be used with care, probably only in non-critical
8449 host lists such as whitelists.
8450
8451
8452
8453 .section "Host list patterns for single-key lookups by host name" &&&
8454          "SECThoslispatnamsk"
8455 .cindex "unknown host name"
8456 .cindex "host list" "matching host name"
8457 If a pattern is of the form
8458 .display
8459 <&'single-key-search-type'&>;<&'search-data'&>
8460 .endd
8461 for example
8462 .code
8463 dbm;/host/accept/list
8464 .endd
8465 a single-key lookup is performed, using the host name as its key. If the
8466 lookup succeeds, the host matches the item. The actual data that is looked up
8467 is not used.
8468
8469 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8470 keys in the file, not IP addresses. If you want to do lookups based on IP
8471 addresses, you must precede the search type with &"net-"& (see section
8472 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8473 two items in the same list, one doing an address lookup and one doing a name
8474 lookup, both using the same file.
8475
8476
8477
8478 .section "Host list patterns for query-style lookups" "SECID81"
8479 If a pattern is of the form
8480 .display
8481 <&'query-style-search-type'&>;<&'query'&>
8482 .endd
8483 the query is obeyed, and if it succeeds, the host matches the item. The actual
8484 data that is looked up is not used. The variables &$sender_host_address$& and
8485 &$sender_host_name$& can be used in the query. For example:
8486 .code
8487 hosts_lookup = pgsql;\
8488   select ip from hostlist where ip='$sender_host_address'
8489 .endd
8490 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8491 can use the &%sg%& expansion item to change this if you need to. If you want to
8492 use masked IP addresses in database queries, you can use the &%mask%& expansion
8493 operator.
8494
8495 If the query contains a reference to &$sender_host_name$&, Exim automatically
8496 looks up the host name if it has not already done so. (See section
8497 &<<SECThoslispatnam>>& for comments on finding host names.)
8498
8499 Historical note: prior to release 4.30, Exim would always attempt to find a
8500 host name before running the query, unless the search type was preceded by
8501 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8502 still recognized for query-style lookups, but its presence or absence has no
8503 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8504 See section &<<SECThoslispatsikey>>&.)
8505
8506
8507
8508
8509
8510 .section "Address lists" "SECTaddresslist"
8511 .cindex "list" "address list"
8512 .cindex "address list" "empty item"
8513 .cindex "address list" "patterns"
8514 Address lists contain patterns that are matched against mail addresses. There
8515 is one special case to be considered: the sender address of a bounce message is
8516 always empty. You can test for this by providing an empty item in an address
8517 list. For example, you can set up a router to process bounce messages by
8518 using this option setting:
8519 .code
8520 senders = :
8521 .endd
8522 The presence of the colon creates an empty item. If you do not provide any
8523 data, the list is empty and matches nothing. The empty sender can also be
8524 detected by a regular expression that matches an empty string,
8525 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8526
8527 Non-empty items in an address list can be straightforward email addresses. For
8528 example:
8529 .code
8530 senders = jbc@askone.example : hs@anacreon.example
8531 .endd
8532 A certain amount of wildcarding is permitted. If a pattern contains an @
8533 character, but is not a regular expression and does not begin with a
8534 semicolon-terminated lookup type (described below), the local part of the
8535 subject address is compared with the local part of the pattern, which may start
8536 with an asterisk. If the local parts match, the domain is checked in exactly
8537 the same way as for a pattern in a domain list. For example, the domain can be
8538 wildcarded, refer to a named list, or be a lookup:
8539 .code
8540 deny senders = *@*.spamming.site:\
8541                *@+hostile_domains:\
8542                bozo@partial-lsearch;/list/of/dodgy/sites:\
8543                *@dbm;/bad/domains.db
8544 .endd
8545 .cindex "local part" "starting with !"
8546 .cindex "address list" "local part starting with !"
8547 If a local part that begins with an exclamation mark is required, it has to be
8548 specified using a regular expression, because otherwise the exclamation mark is
8549 treated as a sign of negation, as is standard in lists.
8550
8551 If a non-empty pattern that is not a regular expression or a lookup does not
8552 contain an @ character, it is matched against the domain part of the subject
8553 address. The only two formats that are recognized this way are a literal
8554 domain, or a domain pattern that starts with *. In both these cases, the effect
8555 is the same as if &`*@`& preceded the pattern. For example:
8556 .code
8557 deny senders = enemy.domain : *.enemy.domain
8558 .endd
8559
8560 The following kinds of more complicated address list pattern can match any
8561 address, including the empty address that is characteristic of bounce message
8562 senders:
8563
8564 .ilist
8565 .cindex "regular expressions" "in address list"
8566 .cindex "address list" "regular expression in"
8567 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8568 done against the complete address, with the pattern as the regular expression.
8569 You must take care that backslash and dollar characters are not misinterpreted
8570 as part of the string expansion. The simplest way to do this is to use &`\N`&
8571 to mark that part of the string as non-expandable. For example:
8572 .code
8573 deny senders = \N^.*this.*@example\.com$\N : \
8574                \N^\d{8}.+@spamhaus.example$\N : ...
8575 .endd
8576 The &`\N`& sequences are removed by the expansion, so these items do indeed
8577 start with &"^"& by the time they are being interpreted as address patterns.
8578
8579 .next
8580 .cindex "address list" "lookup for complete address"
8581 Complete addresses can be looked up by using a pattern that starts with a
8582 lookup type terminated by a semicolon, followed by the data for the lookup. For
8583 example:
8584 .code
8585 deny senders = cdb;/etc/blocked.senders : \
8586   mysql;select address from blocked where \
8587   address='${quote_mysql:$sender_address}'
8588 .endd
8589 Both query-style and single-key lookup types can be used. For a single-key
8590 lookup type, Exim uses the complete address as the key. However, empty keys are
8591 not supported for single-key lookups, so a match against the empty address
8592 always fails. This restriction does not apply to query-style lookups.
8593
8594 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8595 cannot be used, and is ignored if specified, with an entry being written to the
8596 panic log.
8597 .cindex "*@ with single-key lookup"
8598 However, you can configure lookup defaults, as described in section
8599 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8600 default. For example, with this lookup:
8601 .code
8602 accept senders = lsearch*@;/some/file
8603 .endd
8604 the file could contains lines like this:
8605 .code
8606 user1@domain1.example
8607 *@domain2.example
8608 .endd
8609 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8610 that are tried is:
8611 .code
8612 nimrod@jaeger.example
8613 *@jaeger.example
8614 *
8615 .endd
8616 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8617 would mean that every address matches, thus rendering the test useless.
8618
8619 &*Warning 2*&: Do not confuse these two kinds of item:
8620 .code
8621 deny recipients = dbm*@;/some/file
8622 deny recipients = *@dbm;/some/file
8623 .endd
8624 The first does a whole address lookup, with defaulting, as just described,
8625 because it starts with a lookup type. The second matches the local part and
8626 domain independently, as described in a bullet point below.
8627 .endlist
8628
8629
8630 The following kinds of address list pattern can match only non-empty addresses.
8631 If the subject address is empty, a match against any of these pattern types
8632 always fails.
8633
8634
8635 .ilist
8636 .cindex "@@ with single-key lookup"
8637 .cindex "address list" "@@ lookup type"
8638 .cindex "address list" "split local part and domain"
8639 If a pattern starts with &"@@"& followed by a single-key lookup item
8640 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8641 split into a local part and a domain. The domain is looked up in the file. If
8642 it is not found, there is no match. If it is found, the data that is looked up
8643 from the file is treated as a colon-separated list of local part patterns, each
8644 of which is matched against the subject local part in turn.
8645
8646 .cindex "asterisk" "in address list"
8647 The lookup may be a partial one, and/or one involving a search for a default
8648 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8649 patterns that are looked up can be regular expressions or begin with &"*"&, or
8650 even be further lookups. They may also be independently negated. For example,
8651 with
8652 .code
8653 deny senders = @@dbm;/etc/reject-by-domain
8654 .endd
8655 the data from which the DBM file is built could contain lines like
8656 .code
8657 baddomain.com:  !postmaster : *
8658 .endd
8659 to reject all senders except &%postmaster%& from that domain.
8660
8661 .cindex "local part" "starting with !"
8662 If a local part that actually begins with an exclamation mark is required, it
8663 has to be specified using a regular expression. In &(lsearch)& files, an entry
8664 may be split over several lines by indenting the second and subsequent lines,
8665 but the separating colon must still be included at line breaks. White space
8666 surrounding the colons is ignored. For example:
8667 .code
8668 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8669   spammer3 : spammer4
8670 .endd
8671 As in all colon-separated lists in Exim, a colon can be included in an item by
8672 doubling.
8673
8674 If the last item in the list starts with a right angle-bracket, the remainder
8675 of the item is taken as a new key to look up in order to obtain a continuation
8676 list of local parts. The new key can be any sequence of characters. Thus one
8677 might have entries like
8678 .code
8679 aol.com: spammer1 : spammer 2 : >*
8680 xyz.com: spammer3 : >*
8681 *:       ^\d{8}$
8682 .endd
8683 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8684 local parts for all domains, in addition to the specific local parts listed for
8685 each domain. Of course, using this feature costs another lookup each time a
8686 chain is followed, but the effort needed to maintain the data is reduced.
8687
8688 .cindex "loop" "in lookups"
8689 It is possible to construct loops using this facility, and in order to catch
8690 them, the chains may be no more than fifty items long.
8691
8692 .next
8693 The @@<&'lookup'&> style of item can also be used with a query-style
8694 lookup, but in this case, the chaining facility is not available. The lookup
8695 can only return a single list of local parts.
8696 .endlist
8697
8698 &*Warning*&: There is an important difference between the address list items
8699 in these two examples:
8700 .code
8701 senders = +my_list
8702 senders = *@+my_list
8703 .endd
8704 In the first one, &`my_list`& is a named address list, whereas in the second
8705 example it is a named domain list.
8706
8707
8708
8709
8710 .section "Case of letters in address lists" "SECTcasletadd"
8711 .cindex "case of local parts"
8712 .cindex "address list" "case forcing"
8713 .cindex "case forcing in address lists"
8714 Domains in email addresses are always handled caselessly, but for local parts
8715 case may be significant on some systems (see &%caseful_local_part%& for how
8716 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8717 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8718 blocking lists should be done in a case-independent manner. Since most address
8719 lists in Exim are used for this kind of control, Exim attempts to do this by
8720 default.
8721
8722 The domain portion of an address is always lowercased before matching it to an
8723 address list. The local part is lowercased by default, and any string
8724 comparisons that take place are done caselessly. This means that the data in
8725 the address list itself, in files included as plain file names, and in any file
8726 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8727 keys in files that are looked up by a search type other than &(lsearch)& (which
8728 works caselessly) must be in lower case, because these lookups are not
8729 case-independent.
8730
8731 .cindex "&`+caseful`&"
8732 To allow for the possibility of caseful address list matching, if an item in
8733 an address list is the string &"+caseful"&, the original case of the local
8734 part is restored for any comparisons that follow, and string comparisons are no
8735 longer case-independent. This does not affect the domain, which remains in
8736 lower case. However, although independent matches on the domain alone are still
8737 performed caselessly, regular expressions that match against an entire address
8738 become case-sensitive after &"+caseful"& has been seen.
8739
8740
8741
8742 .section "Local part lists" "SECTlocparlis"
8743 .cindex "list" "local part list"
8744 .cindex "local part" "list"
8745 Case-sensitivity in local part lists is handled in the same way as for address
8746 lists, as just described. The &"+caseful"& item can be used if required. In a
8747 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8748 set false, the subject is lowercased and the matching is initially
8749 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8750 matching in the local part list, but not elsewhere in the router. If
8751 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8752 option is case-sensitive from the start.
8753
8754 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8755 comments are handled in the same way as address lists &-- they are recognized
8756 only if the # is preceded by white space or the start of the line.
8757 Otherwise, local part lists are matched in the same way as domain lists, except
8758 that the special items that refer to the local host (&`@`&, &`@[]`&,
8759 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8760 Refer to section &<<SECTdomainlist>>& for details of the other available item
8761 types.
8762 .ecindex IIDdohoadli
8763
8764
8765
8766
8767 . ////////////////////////////////////////////////////////////////////////////
8768 . ////////////////////////////////////////////////////////////////////////////
8769
8770 .chapter "String expansions" "CHAPexpand"
8771 .scindex IIDstrexp "expansion" "of strings"
8772 Many strings in Exim's run time configuration are expanded before use. Some of
8773 them are expanded every time they are used; others are expanded only once.
8774
8775 When a string is being expanded it is copied verbatim from left to right except
8776 when a dollar or backslash character is encountered. A dollar specifies the
8777 start of a portion of the string that is interpreted and replaced as described
8778 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8779 escape character, as described in the following section.
8780
8781 Whether a string is expanded depends upon the context.  Usually this is solely
8782 dependent upon the option for which a value is sought; in this documentation,
8783 options for which string expansion is performed are marked with &dagger; after
8784 the data type.  ACL rules always expand strings.  A couple of expansion
8785 conditions do not expand some of the brace-delimited branches, for security
8786 reasons.
8787
8788
8789
8790 .section "Literal text in expanded strings" "SECTlittext"
8791 .cindex "expansion" "including literal text"
8792 An uninterpreted dollar can be included in an expanded string by putting a
8793 backslash in front of it. A backslash can be used to prevent any special
8794 character being treated specially in an expansion, including backslash itself.
8795 If the string appears in quotes in the configuration file, two backslashes are
8796 required because the quotes themselves cause interpretation of backslashes when
8797 the string is read in (see section &<<SECTstrings>>&).
8798
8799 .cindex "expansion" "non-expandable substrings"
8800 A portion of the string can specified as non-expandable by placing it between
8801 two occurrences of &`\N`&. This is particularly useful for protecting regular
8802 expressions, which often contain backslashes and dollar signs. For example:
8803 .code
8804 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8805 .endd
8806 On encountering the first &`\N`&, the expander copies subsequent characters
8807 without interpretation until it reaches the next &`\N`& or the end of the
8808 string.
8809
8810
8811
8812 .section "Character escape sequences in expanded strings" "SECID82"
8813 .cindex "expansion" "escape sequences"
8814 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8815 expanded string is recognized as an escape sequence for the character newline,
8816 carriage return, or tab, respectively. A backslash followed by up to three
8817 octal digits is recognized as an octal encoding for a single character, and a
8818 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8819 encoding.
8820
8821 These escape sequences are also recognized in quoted strings when they are read
8822 in. Their interpretation in expansions as well is useful for unquoted strings,
8823 and for other cases such as looked-up strings that are then expanded.
8824
8825
8826 .section "Testing string expansions" "SECID83"
8827 .cindex "expansion" "testing"
8828 .cindex "testing" "string expansion"
8829 .oindex "&%-be%&"
8830 Many expansions can be tested by calling Exim with the &%-be%& option. This
8831 takes the command arguments, or lines from the standard input if there are no
8832 arguments, runs them through the string expansion code, and writes the results
8833 to the standard output. Variables based on configuration values are set up, but
8834 since no message is being processed, variables such as &$local_part$& have no
8835 value. Nevertheless the &%-be%& option can be useful for checking out file and
8836 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8837 and &%nhash%&.
8838
8839 Exim gives up its root privilege when it is called with the &%-be%& option, and
8840 instead runs under the uid and gid it was called with, to prevent users from
8841 using &%-be%& for reading files to which they do not have access.
8842
8843 .oindex "&%-bem%&"
8844 If you want to test expansions that include variables whose values are taken
8845 from a message, there are two other options that can be used. The &%-bem%&
8846 option is like &%-be%& except that it is followed by a file name. The file is
8847 read as a message before doing the test expansions. For example:
8848 .code
8849 exim -bem /tmp/test.message '$h_subject:'
8850 .endd
8851 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8852 Exim message identifier. For example:
8853 .code
8854 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8855 .endd
8856 This loads the message from Exim's spool before doing the test expansions, and
8857 is therefore restricted to admin users.
8858
8859
8860 .section "Forced expansion failure" "SECTforexpfai"
8861 .cindex "expansion" "forced failure"
8862 A number of expansions that are described in the following section have
8863 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8864 (which are sometimes called &"curly brackets"&). Which of the two strings is
8865 used depends on some condition that is evaluated as part of the expansion. If,
8866 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8867 the entire string expansion fails in a way that can be detected by the code
8868 that requested the expansion. This is called &"forced expansion failure"&, and
8869 its consequences depend on the circumstances. In some cases it is no different
8870 from any other expansion failure, but in others a different action may be
8871 taken. Such variations are mentioned in the documentation of the option that is
8872 being expanded.
8873
8874
8875
8876
8877 .section "Expansion items" "SECTexpansionitems"
8878 The following items are recognized in expanded strings. White space may be used
8879 between sub-items that are keywords or substrings enclosed in braces inside an
8880 outer set of braces, to improve readability. &*Warning*&: Within braces,
8881 white space is significant.
8882
8883 .vlist
8884 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8885 .cindex "expansion" "variables"
8886 Substitute the contents of the named variable, for example:
8887 .code
8888 $local_part
8889 ${domain}
8890 .endd
8891 The second form can be used to separate the name from subsequent alphanumeric
8892 characters. This form (using braces) is available only for variables; it does
8893 &'not'& apply to message headers. The names of the variables are given in
8894 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8895 given, the expansion fails.
8896
8897 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8898 .cindex "expansion" "operators"
8899 The string is first itself expanded, and then the operation specified by
8900 <&'op'&> is applied to it. For example:
8901 .code
8902 ${lc:$local_part}
8903 .endd
8904 The string starts with the first character after the colon, which may be
8905 leading white space. A list of operators is given in section &<<SECTexpop>>&
8906 below. The operator notation is used for simple expansion items that have just
8907 one argument, because it reduces the number of braces and therefore makes the
8908 string easier to understand.
8909
8910 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8911 This item inserts &"basic"& header lines. It is described with the &%header%&
8912 expansion item below.
8913
8914
8915 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8916 .cindex "expansion" "calling an acl"
8917 .cindex "&%acl%&" "call from expansion"
8918 The name and zero to nine argument strings are first expanded separately.  The expanded
8919 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8920 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8921 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8922 and may use the variables; if another acl expansion is used the values
8923 are restored after it returns.  If the ACL sets
8924 a value using a "message =" modifier and returns accept or deny, the value becomes
8925 the result of the expansion.
8926 If no message is set and the ACL returns accept or deny
8927 the expansion result is an empty string.
8928 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8929
8930
8931 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8932        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8933 .cindex "expansion" "extracting cerificate fields"
8934 .cindex "&%certextract%&" "certificate fields"
8935 .cindex "certificate" "extracting fields"
8936 The <&'certificate'&> must be a variable of type certificate.
8937 The field name is expanded and used to retrive the relevant field from
8938 the certificate.  Supported fields are:
8939 .display
8940 &`version        `&
8941 &`serial_number  `&
8942 &`subject        `& RFC4514 DN
8943 &`issuer         `& RFC4514 DN
8944 &`notbefore      `& time
8945 &`notafter       `& time
8946 &`sig_algorithm  `&
8947 &`signature      `&
8948 &`subj_altname   `& tagged list
8949 &`ocsp_uri       `& list
8950 &`crl_uri        `& list
8951 .endd
8952 If the field is found,
8953 <&'string2'&> is expanded, and replaces the whole item;
8954 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8955 variable &$value$& contains the value that has been extracted. Afterwards, it
8956 is restored to any previous value it might have had.
8957
8958 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8959 key is not found. If {<&'string2'&>} is also omitted, the value that was
8960 extracted is used.
8961
8962 Some field names take optional modifiers, appended and separated by commas.
8963
8964 The field selectors marked as "RFC4514" above
8965 output a Distinguished Name string which is
8966 not quite
8967 parseable by Exim as a comma-separated tagged list
8968 (the exceptions being elements containing commas).
8969 RDN elements of a single type may be selected by
8970 a modifier of the type label; if so the expansion
8971 result is a list (newline-separated by default).
8972 The separator may be changed by another modifer of
8973 a right angle-bracket followed immediately by the new separator.
8974 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8975
8976 The field selectors marked as "time" above
8977 take an optional modifier of "int"
8978 for which the result is the number of seconds since epoch.
8979 Otherwise the result is a human-readable string
8980 in the timezone selected by the main "timezone" option.
8981
8982 The field selectors marked as "list" above return a list,
8983 newline-separated by default,
8984 (embedded separator characters in elements are doubled).
8985 The separator may be changed by a modifier of
8986 a right angle-bracket followed immediately by the new separator.
8987
8988 The field selectors marked as "tagged" above
8989 prefix each list element with a type string and an equals sign.
8990 Elements of only one type may be selected by a modifier
8991 which is one of "dns", "uri" or "mail";
8992 if so the elenment tags are omitted.
8993
8994 If not otherwise noted field values are presented in human-readable form.
8995
8996 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
8997        {*&<&'arg'&>&*}...}*&"
8998 .cindex &%dlfunc%&
8999 This expansion dynamically loads and then calls a locally-written C function.
9000 This functionality is available only if Exim is compiled with
9001 .code
9002 EXPAND_DLFUNC=yes
9003 .endd
9004 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9005 object so that it doesn't reload the same object file in the same Exim process
9006 (but of course Exim does start new processes frequently).
9007
9008 There may be from zero to eight arguments to the function. When compiling
9009 a local function that is to be called in this way, &_local_scan.h_& should be
9010 included. The Exim variables and functions that are defined by that API
9011 are also available for dynamically loaded functions. The function itself
9012 must have the following type:
9013 .code
9014 int dlfunction(uschar **yield, int argc, uschar *argv[])
9015 .endd
9016 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9017 function should return one of the following values:
9018
9019 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9020 into the expanded string that is being built.
9021
9022 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9023 from &'yield'&, if it is set.
9024
9025 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9026 taken from &'yield'& if it is set.
9027
9028 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9029
9030 When compiling a function that is to be used in this way with gcc,
9031 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9032 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9033
9034
9035 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9036 .cindex "expansion" "extracting value from environment"
9037 .cindex "environment" "value from"
9038 The key is first expanded separately, and leading and trailing white space
9039 removed.
9040 This is then searched for as a name in the environment.
9041 If a variable is found then its value is placed in &$value$&
9042 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9043
9044 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9045 appear, for example:
9046 .code
9047 ${env{USER}{$value} fail }
9048 .endd
9049 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9050 {<&'string1'&>} must be present for &"fail"& to be recognized.
9051
9052 If {<&'string2'&>} is omitted an empty string is substituted on 
9053 search failure.
9054 If {<&'string1'&>} is omitted the search result is substituted on
9055 search success.
9056
9057
9058 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9059        {*&<&'string3'&>&*}}*&"
9060 .cindex "expansion" "extracting substrings by key"
9061 .cindex "&%extract%&" "substrings by key"
9062 The key and <&'string1'&> are first expanded separately. Leading and trailing
9063 white space is removed from the key (but not from any of the strings). The key
9064 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9065 form:
9066 .display
9067 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9068 .endd
9069 .vindex "&$value$&"
9070 where the equals signs and spaces (but not both) are optional. If any of the
9071 values contain white space, they must be enclosed in double quotes, and any
9072 values that are enclosed in double quotes are subject to escape processing as
9073 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9074 for the value that corresponds to the key. The search is case-insensitive. If
9075 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9076 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9077 variable &$value$& contains the value that has been extracted. Afterwards, it
9078 is restored to any previous value it might have had.
9079
9080 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9081 key is not found. If {<&'string2'&>} is also omitted, the value that was
9082 extracted is used. Thus, for example, these two expansions are identical, and
9083 yield &"2001"&:
9084 .code
9085 ${extract{gid}{uid=1984 gid=2001}}
9086 ${extract{gid}{uid=1984 gid=2001}{$value}}
9087 .endd
9088 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9089 appear, for example:
9090 .code
9091 ${extract{Z}{A=... B=...}{$value} fail }
9092 .endd
9093 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9094 {<&'string2'&>} must be present for &"fail"& to be recognized.
9095
9096
9097 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9098         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9099 .cindex "expansion" "extracting substrings by number"
9100 .cindex "&%extract%&" "substrings by number"
9101 The <&'number'&> argument must consist entirely of decimal digits,
9102 apart from leading and trailing white space, which is ignored.
9103 This is what distinguishes this form of &%extract%& from the previous kind. It
9104 behaves in the same way, except that, instead of extracting a named field, it
9105 extracts from <&'string1'&> the field whose number is given as the first
9106 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9107 <&'string3'&> as before.
9108
9109 The fields in the string are separated by any one of the characters in the
9110 separator string. These may include space or tab characters.
9111 The first field is numbered one. If the number is negative, the fields are
9112 counted from the end of the string, with the rightmost one numbered -1. If the
9113 number given is zero, the entire string is returned. If the modulus of the
9114 number is greater than the number of fields in the string, the result is the
9115 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9116 provided. For example:
9117 .code
9118 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9119 .endd
9120 yields &"42"&, and
9121 .code
9122 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9123 .endd
9124 yields &"99"&. Two successive separators mean that the field between them is
9125 empty (for example, the fifth field above).
9126
9127
9128 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9129 .cindex "list" "selecting by condition"
9130 .cindex "expansion" "selecting from list by condition"
9131 .vindex "&$item$&"
9132 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9133 default, but the separator can be changed in the usual way. For each item
9134 in this list, its value is place in &$item$&, and then the condition is
9135 evaluated. If the condition is true, &$item$& is added to the output as an
9136 item in a new list; if the condition is false, the item is discarded. The
9137 separator used for the output list is the same as the one used for the
9138 input, but a separator setting is not included in the output. For example:
9139 .code
9140 ${filter{a:b:c}{!eq{$item}{b}}
9141 .endd
9142 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9143 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9144
9145
9146 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9147 .cindex "hash function" "textual"
9148 .cindex "expansion" "textual hash"
9149 This is a textual hashing function, and was the first to be implemented in
9150 early versions of Exim. In current releases, there are other hashing functions
9151 (numeric, MD5, and SHA-1), which are described below.
9152
9153 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9154 <&'n'&>. If you are using fixed values for these numbers, that is, if
9155 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9156 use the simpler operator notation that avoids some of the braces:
9157 .code
9158 ${hash_<n>_<m>:<string>}
9159 .endd
9160 The second number is optional (in both notations). If <&'n'&> is greater than
9161 or equal to the length of the string, the expansion item returns the string.
9162 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9163 function to the string. The new string consists of characters taken from the
9164 first <&'m'&> characters of the string
9165 .code
9166 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9167 .endd
9168 If <&'m'&> is not present the value 26 is used, so that only lower case
9169 letters appear. For example:
9170 .display
9171 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9172 &`$hash{5}{monty}}           `&   yields  &`monty`&
9173 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9174 .endd
9175
9176 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9177         &*$h_*&<&'header&~name'&>&*:*&" &&&
9178        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9179         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9180        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9181         &*$rh_*&<&'header&~name'&>&*:*&"
9182 .cindex "expansion" "header insertion"
9183 .vindex "&$header_$&"
9184 .vindex "&$bheader_$&"
9185 .vindex "&$rheader_$&"
9186 .cindex "header lines" "in expansion strings"
9187 .cindex "header lines" "character sets"
9188 .cindex "header lines" "decoding"
9189 Substitute the contents of the named message header line, for example
9190 .code
9191 $header_reply-to:
9192 .endd
9193 The newline that terminates a header line is not included in the expansion, but
9194 internal newlines (caused by splitting the header line over several physical
9195 lines) may be present.
9196
9197 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9198 the data in the header line is interpreted.
9199
9200 .ilist
9201 .cindex "white space" "in header lines"
9202 &%rheader%& gives the original &"raw"& content of the header line, with no
9203 processing at all, and without the removal of leading and trailing white space.
9204
9205 .next
9206 .cindex "base64 encoding" "in header lines"
9207 &%bheader%& removes leading and trailing white space, and then decodes base64
9208 or quoted-printable MIME &"words"& within the header text, but does no
9209 character set translation. If decoding of what looks superficially like a MIME
9210 &"word"& fails, the raw string is returned. If decoding
9211 .cindex "binary zero" "in header line"
9212 produces a binary zero character, it is replaced by a question mark &-- this is
9213 what Exim does for binary zeros that are actually received in header lines.
9214
9215 .next
9216 &%header%& tries to translate the string as decoded by &%bheader%& to a
9217 standard character set. This is an attempt to produce the same string as would
9218 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9219 returned. Translation is attempted only on operating systems that support the
9220 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9221 a system Makefile or in &_Local/Makefile_&.
9222 .endlist ilist
9223
9224 In a filter file, the target character set for &%header%& can be specified by a
9225 command of the following form:
9226 .code
9227 headers charset "UTF-8"
9228 .endd
9229 This command affects all references to &$h_$& (or &$header_$&) expansions in
9230 subsequently obeyed filter commands. In the absence of this command, the target
9231 character set in a filter is taken from the setting of the &%headers_charset%&
9232 option in the runtime configuration. The value of this option defaults to the
9233 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9234 ISO-8859-1.
9235
9236 Header names follow the syntax of RFC 2822, which states that they may contain
9237 any printing characters except space and colon. Consequently, curly brackets
9238 &'do not'& terminate header names, and should not be used to enclose them as
9239 if they were variables. Attempting to do so causes a syntax error.
9240
9241 Only header lines that are common to all copies of a message are visible to
9242 this mechanism. These are the original header lines that are received with the
9243 message, and any that are added by an ACL statement or by a system
9244 filter. Header lines that are added to a particular copy of a message by a
9245 router or transport are not accessible.
9246
9247 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9248 before the DATA ACL, because the header structure is not set up until the
9249 message is received. Header lines that are added in a RCPT ACL (for example)
9250 are saved until the message's incoming header lines are available, at which
9251 point they are added. When a DATA ACL is running, however, header lines added
9252 by earlier ACLs are visible.
9253
9254 Upper case and lower case letters are synonymous in header names. If the
9255 following character is white space, the terminating colon may be omitted, but
9256 this is not recommended, because you may then forget it when it is needed. When
9257 white space terminates the header name, it is included in the expanded string.
9258 If the message does not contain the given header, the expansion item is
9259 replaced by an empty string. (See the &%def%& condition in section
9260 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9261
9262 If there is more than one header with the same name, they are all concatenated
9263 to form the substitution string, up to a maximum length of 64K. Unless
9264 &%rheader%& is being used, leading and trailing white space is removed from
9265 each header before concatenation, and a completely empty header is ignored. A
9266 newline character is then inserted between non-empty headers, but there is no
9267 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9268 those headers that contain lists of addresses, a comma is also inserted at the
9269 junctions between headers. This does not happen for the &%rheader%& expansion.
9270
9271
9272 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9273 .cindex "expansion" "hmac hashing"
9274 .cindex &%hmac%&
9275 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9276 shared secret and some text into a message authentication code, as specified in
9277 RFC 2104. This differs from &`${md5:secret_text...}`& or
9278 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9279 cryptographic hash, allowing for authentication that is not possible with MD5
9280 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9281 present. For example:
9282 .code
9283 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9284 .endd
9285 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9286 produces:
9287 .code
9288 dd97e3ba5d1a61b5006108f8c8252953
9289 .endd
9290 As an example of how this might be used, you might put in the main part of
9291 an Exim configuration:
9292 .code
9293 SPAMSCAN_SECRET=cohgheeLei2thahw
9294 .endd
9295 In a router or a transport you could then have:
9296 .code
9297 headers_add = \
9298   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9299   ${hmac{md5}{SPAMSCAN_SECRET}\
9300   {${primary_hostname},${message_exim_id},$h_message-id:}}
9301 .endd
9302 Then given a message, you can check where it was scanned by looking at the
9303 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9304 this header line is authentic by recomputing the authentication code from the
9305 host name, message ID and the &'Message-id:'& header line. This can be done
9306 using Exim's &%-be%& option, or by other means, for example by using the
9307 &'hmac_md5_hex()'& function in Perl.
9308
9309
9310 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9311 .cindex "expansion" "conditional"
9312 .cindex "&%if%&, expansion item"
9313 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9314 item; otherwise <&'string2'&> is used. The available conditions are described
9315 in section &<<SECTexpcond>>& below. For example:
9316 .code
9317 ${if eq {$local_part}{postmaster} {yes}{no} }
9318 .endd
9319 The second string need not be present; if it is not and the condition is not
9320 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9321 be present instead of the second string (without any curly brackets). In this
9322 case, the expansion is forced to fail if the condition is not true (see section
9323 &<<SECTforexpfai>>&).
9324
9325 If both strings are omitted, the result is the string &`true`& if the condition
9326 is true, and the empty string if the condition is false. This makes it less
9327 cumbersome to write custom ACL and router conditions. For example, instead of
9328 .code
9329 condition = ${if >{$acl_m4}{3}{true}{false}}
9330 .endd
9331 you can use
9332 .code
9333 condition = ${if >{$acl_m4}{3}}
9334 .endd
9335
9336 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9337 .cindex "expansion" "string truncation"
9338 .cindex "&%length%& expansion item"
9339 The &%length%& item is used to extract the initial portion of a string. Both
9340 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9341 you are using a fixed value for the number, that is, if <&'string1'&> does not
9342 change when expanded, you can use the simpler operator notation that avoids
9343 some of the braces:
9344 .code
9345 ${length_<n>:<string>}
9346 .endd
9347 The result of this item is either the first <&'n'&> characters or the whole
9348 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9349 &%strlen%&, which gives the length of a string.
9350
9351
9352 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9353         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9354 .cindex "expansion" "extracting list elements by number"
9355 .cindex "&%listextract%&" "extract list elements by number"
9356 .cindex "list" "extracting elements by number"
9357 The <&'number'&> argument must consist entirely of decimal digits,
9358 apart from an optional leading minus,
9359 and leading and trailing white space (which is ignored).
9360
9361 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9362 default, but the separator can be changed in the usual way.
9363
9364 The first field of the list is numbered one.
9365 If the number is negative, the fields are
9366 counted from the end of the list, with the rightmost one numbered -1.
9367 The numbered element of the list is extracted and placed in &$value$&,
9368 then <&'string2'&> is expanded as the result.
9369
9370 If the modulus of the
9371 number is zero or greater than the number of fields in the string,
9372 the result is the expansion of <&'string3'&>.
9373
9374 For example:
9375 .code
9376 ${listextract{2}{x:42:99}}
9377 .endd
9378 yields &"42"&, and
9379 .code
9380 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9381 .endd
9382 yields &"result: 99"&.
9383
9384 If {<&'string3'&>} is omitted, an empty string is used for string3.
9385 If {<&'string2'&>} is also omitted, the value that was
9386 extracted is used.
9387 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9388
9389
9390 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9391         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9392 This is the first of one of two different types of lookup item, which are both
9393 described in the next item.
9394
9395 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9396         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9397 .cindex "expansion" "lookup in"
9398 .cindex "file" "lookups"
9399 .cindex "lookup" "in expanded string"
9400 The two forms of lookup item specify data lookups in files and databases, as
9401 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9402 lookups, and the second is used for query-style lookups. The <&'key'&>,
9403 <&'file'&>, and <&'query'&> strings are expanded before use.
9404
9405 If there is any white space in a lookup item which is part of a filter command,
9406 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9407 other place where white space is significant, the lookup item must be enclosed
9408 in double quotes. The use of data lookups in users' filter files may be locked
9409 out by the system administrator.
9410
9411 .vindex "&$value$&"
9412 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9413 During its expansion, the variable &$value$& contains the data returned by the
9414 lookup. Afterwards it reverts to the value it had previously (at the outer
9415 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9416 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9417 string on failure. If <&'string2'&> is provided, it can itself be a nested
9418 lookup, thus providing a mechanism for looking up a default value when the
9419 original lookup fails.
9420
9421 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9422 data for the outer lookup while the parameters of the second lookup are
9423 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9424 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9425 appear, and in this case, if the lookup fails, the entire expansion is forced
9426 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9427 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9428 successful lookup, and nothing in the case of failure.
9429
9430 For single-key lookups, the string &"partial"& is permitted to precede the
9431 search type in order to do partial matching, and * or *@ may follow a search
9432 type to request default lookups if the key does not match (see sections
9433 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9434
9435 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9436 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9437 and non-wild parts of the key during the expansion of the replacement text.
9438 They return to their previous values at the end of the lookup item.
9439
9440 This example looks up the postmaster alias in the conventional alias file:
9441 .code
9442 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9443 .endd
9444 This example uses NIS+ to look up the full name of the user corresponding to
9445 the local part of an address, forcing the expansion to fail if it is not found:
9446 .code
9447 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9448   {$value}fail}
9449 .endd
9450
9451
9452 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9453 .cindex "expansion" "list creation"
9454 .vindex "&$item$&"
9455 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9456 default, but the separator can be changed in the usual way. For each item
9457 in this list, its value is place in &$item$&, and then <&'string2'&> is
9458 expanded and added to the output as an item in a new list. The separator used
9459 for the output list is the same as the one used for the input, but a separator
9460 setting is not included in the output. For example:
9461 .code
9462 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9463 .endd
9464 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9465 value of &$item$& is restored to what it was before. See also the &*filter*&
9466 and &*reduce*& expansion items.
9467
9468 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9469 .cindex "expansion" "numeric hash"
9470 .cindex "hash function" "numeric"
9471 The three strings are expanded; the first two must yield numbers. Call them
9472 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9473 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9474 can use the simpler operator notation that avoids some of the braces:
9475 .code
9476 ${nhash_<n>_<m>:<string>}
9477 .endd
9478 The second number is optional (in both notations). If there is only one number,
9479 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9480 processed by a div/mod hash function that returns two numbers, separated by a
9481 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9482 example,
9483 .code
9484 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9485 .endd
9486 returns the string &"6/33"&.
9487
9488
9489
9490 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9491 .cindex "Perl" "use in expanded string"
9492 .cindex "expansion" "calling Perl from"
9493 This item is available only if Exim has been built to include an embedded Perl
9494 interpreter. The subroutine name and the arguments are first separately
9495 expanded, and then the Perl subroutine is called with those arguments. No
9496 additional arguments need be given; the maximum number permitted, including the
9497 name of the subroutine, is nine.
9498
9499 The return value of the subroutine is inserted into the expanded string, unless
9500 the return value is &%undef%&. In that case, the expansion fails in the same
9501 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9502 Whatever you return is evaluated in a scalar context. For example, if you
9503 return the name of a Perl vector, the return value is the size of the vector,
9504 not its contents.
9505
9506 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9507 with the error message that was passed to &%die%&. More details of the embedded
9508 Perl facility are given in chapter &<<CHAPperl>>&.
9509
9510 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9511 out the use of this expansion item in filter files.
9512
9513
9514 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9515 .cindex "&%prvs%& expansion item"
9516 The first argument is a complete email address and the second is secret
9517 keystring. The third argument, specifying a key number, is optional. If absent,
9518 it defaults to 0. The result of the expansion is a prvs-signed email address,
9519 to be typically used with the &%return_path%& option on an &(smtp)& transport
9520 as part of a bounce address tag validation (BATV) scheme. For more discussion
9521 and an example, see section &<<SECTverifyPRVS>>&.
9522
9523 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9524         {*&<&'string'&>&*}}*&"
9525 .cindex "&%prvscheck%& expansion item"
9526 This expansion item is the complement of the &%prvs%& item. It is used for
9527 checking prvs-signed addresses. If the expansion of the first argument does not
9528 yield a syntactically valid prvs-signed address, the whole item expands to the
9529 empty string. When the first argument does expand to a syntactically valid
9530 prvs-signed address, the second argument is expanded, with the prvs-decoded
9531 version of the address and the key number extracted from the address in the
9532 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9533
9534 These two variables can be used in the expansion of the second argument to
9535 retrieve the secret. The validity of the prvs-signed address is then checked
9536 against the secret. The result is stored in the variable &$prvscheck_result$&,
9537 which is empty for failure or &"1"& for success.
9538
9539 The third argument is optional; if it is missing, it defaults to an empty
9540 string. This argument is now expanded. If the result is an empty string, the
9541 result of the expansion is the decoded version of the address. This is the case
9542 whether or not the signature was valid. Otherwise, the result of the expansion
9543 is the expansion of the third argument.
9544
9545 All three variables can be used in the expansion of the third argument.
9546 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9547 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9548
9549 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9550 .cindex "expansion" "inserting an entire file"
9551 .cindex "file" "inserting into expansion"
9552 .cindex "&%readfile%& expansion item"
9553 The file name and end-of-line string are first expanded separately. The file is
9554 then read, and its contents replace the entire item. All newline characters in
9555 the file are replaced by the end-of-line string if it is present. Otherwise,
9556 newlines are left in the string.
9557 String expansion is not applied to the contents of the file. If you want this,
9558 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9559 the string expansion fails.
9560
9561 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9562 locks out the use of this expansion item in filter files.
9563
9564
9565
9566 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9567         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9568 .cindex "expansion" "inserting from a socket"
9569 .cindex "socket, use of in expansion"
9570 .cindex "&%readsocket%& expansion item"
9571 This item inserts data from a Unix domain or TCP socket into the expanded
9572 string. The minimal way of using it uses just two arguments, as in these
9573 examples:
9574 .code
9575 ${readsocket{/socket/name}{request string}}
9576 ${readsocket{inet:some.host:1234}{request string}}
9577 .endd
9578 For a Unix domain socket, the first substring must be the path to the socket.
9579 For an Internet socket, the first substring must contain &`inet:`& followed by
9580 a host name or IP address, followed by a colon and a port, which can be a
9581 number or the name of a TCP port in &_/etc/services_&. An IP address may
9582 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9583 example:
9584 .code
9585 ${readsocket{inet:[::1]:1234}{request string}}
9586 .endd
9587 Only a single host name may be given, but if looking it up yields more than
9588 one IP address, they are each tried in turn until a connection is made. For
9589 both kinds of socket, Exim makes a connection, writes the request string
9590 (unless it is an empty string) and reads from the socket until an end-of-file
9591 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9592 extend what can be done. Firstly, you can vary the timeout. For example:
9593 .code
9594 ${readsocket{/socket/name}{request string}{3s}}
9595 .endd
9596 A fourth argument allows you to change any newlines that are in the data
9597 that is read, in the same way as for &%readfile%& (see above). This example
9598 turns them into spaces:
9599 .code
9600 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9601 .endd
9602 As with all expansions, the substrings are expanded before the processing
9603 happens. Errors in these sub-expansions cause the expansion to fail. In
9604 addition, the following errors can occur:
9605
9606 .ilist
9607 Failure to create a socket file descriptor;
9608 .next
9609 Failure to connect the socket;
9610 .next
9611 Failure to write the request string;
9612 .next
9613 Timeout on reading from the socket.
9614 .endlist
9615
9616 By default, any of these errors causes the expansion to fail. However, if
9617 you supply a fifth substring, it is expanded and used when any of the above
9618 errors occurs. For example:
9619 .code
9620 ${readsocket{/socket/name}{request string}{3s}{\n}\
9621   {socket failure}}
9622 .endd
9623 You can test for the existence of a Unix domain socket by wrapping this
9624 expansion in &`${if exists`&, but there is a race condition between that test
9625 and the actual opening of the socket, so it is safer to use the fifth argument
9626 if you want to be absolutely sure of avoiding an expansion error for a
9627 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9628
9629 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9630 locks out the use of this expansion item in filter files.
9631
9632
9633 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9634 .cindex "expansion" "reducing a list to a scalar"
9635 .cindex "list" "reducing to a scalar"
9636 .vindex "&$value$&"
9637 .vindex "&$item$&"
9638 This operation reduces a list to a single, scalar string. After expansion,
9639 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9640 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9641 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9642 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9643 them. The result of that expansion is assigned to &$value$& before the next
9644 iteration. When the end of the list is reached, the final value of &$value$& is
9645 added to the expansion output. The &*reduce*& expansion item can be used in a
9646 number of ways. For example, to add up a list of numbers:
9647 .code
9648 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9649 .endd
9650 The result of that expansion would be &`6`&. The maximum of a list of numbers
9651 can be found:
9652 .code
9653 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9654 .endd
9655 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9656 restored to what they were before. See also the &*filter*& and &*map*&
9657 expansion items.
9658
9659 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9660 This item inserts &"raw"& header lines. It is described with the &%header%&
9661 expansion item above.
9662
9663 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9664         {*&<&'string2'&>&*}}*&"
9665 .cindex "expansion" "running a command"
9666 .cindex "&%run%& expansion item"
9667 The command and its arguments are first expanded as one string. The string is
9668 split apart into individual arguments by spaces, and then the command is run
9669 in a separate process, but under the same uid and gid.  As in other command
9670 executions from Exim, a shell is not used by default. If the command requires
9671 a shell, you must explicitly code it.
9672
9673 Since the arguments are split by spaces, when there is a variable expansion
9674 which has an empty result, it will cause the situation that the argument will
9675 simply be omitted when the program is actually executed by Exim. If the
9676 script/program requires a specific number of arguments and the expanded
9677 variable could possibly result in this empty expansion, the variable must be
9678 quoted. This is more difficult if the expanded variable itself could result
9679 in a string containing quotes, because it would interfere with the quotes
9680 around the command arguments. A possible guard against this is to wrap the
9681 variable in the &%sg%& operator to change any quote marks to some other
9682 character.
9683
9684 The standard input for the command exists, but is empty. The standard output
9685 and standard error are set to the same file descriptor.
9686 .cindex "return code" "from &%run%& expansion"
9687 .vindex "&$value$&"
9688 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9689 and replaces the entire item; during this expansion, the standard output/error
9690 from the command is in the variable &$value$&. If the command fails,
9691 <&'string2'&>, if present, is expanded and used. Once again, during the
9692 expansion, the standard output/error from the command is in the variable
9693 &$value$&.
9694
9695 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9696 can be the word &"fail"& (not in braces) to force expansion failure if the
9697 command does not succeed. If both strings are omitted, the result is contents
9698 of the standard output/error on success, and nothing on failure.
9699
9700 .vindex "&$run_in_acl$&"
9701 The standard output/error of the command is put in the variable &$value$&.
9702 In this ACL example, the output of a command is logged for the admin to
9703 troubleshoot:
9704 .code
9705 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9706       log_message  = Output of id: $value
9707 .endd
9708 If the command requires shell idioms, such as the > redirect operator, the
9709 shell must be invoked directly, such as with:
9710 .code
9711 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9712 .endd
9713
9714 .vindex "&$runrc$&"
9715 The return code from the command is put in the variable &$runrc$&, and this
9716 remains set afterwards, so in a filter file you can do things like this:
9717 .code
9718 if "${run{x y z}{}}$runrc" is 1 then ...
9719   elif $runrc is 2 then ...
9720   ...
9721 endif
9722 .endd
9723 If execution of the command fails (for example, the command does not exist),
9724 the return code is 127 &-- the same code that shells use for non-existent
9725 commands.
9726
9727 &*Warning*&: In a router or transport, you cannot assume the order in which
9728 option values are expanded, except for those preconditions whose order of
9729 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9730 by the expansion of one option, and use it in another.
9731
9732 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9733 out the use of this expansion item in filter files.
9734
9735
9736 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9737 .cindex "expansion" "string substitution"
9738 .cindex "&%sg%& expansion item"
9739 This item works like Perl's substitution operator (s) with the global (/g)
9740 option; hence its name. However, unlike the Perl equivalent, Exim does not
9741 modify the subject string; instead it returns the modified string for insertion
9742 into the overall expansion. The item takes three arguments: the subject string,
9743 a regular expression, and a substitution string. For example:
9744 .code
9745 ${sg{abcdefabcdef}{abc}{xyz}}
9746 .endd
9747 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9748 if any $ or \ characters are required in the regular expression or in the
9749 substitution string, they have to be escaped. For example:
9750 .code
9751 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9752 .endd
9753 yields &"defabc"&, and
9754 .code
9755 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9756 .endd
9757 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9758 the regular expression from string expansion.
9759
9760
9761
9762 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9763 .cindex sorting "a list"
9764 .cindex list sorting
9765 .cindex expansion "list sorting"
9766 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9767 default, but the separator can be changed in the usual way.
9768 The <&'comparator'&> argument is interpreted as the operator
9769 of a two-argument expansion condition.
9770 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9771 The comparison should return true when applied to two values
9772 if the first value should sort before the second value.
9773 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9774 the element being placed in &$item$&,
9775 to give values for comparison.
9776
9777 The item result is a sorted list,
9778 with the original list separator,
9779 of the list elements (in full) of the original.
9780
9781 Examples:
9782 .code
9783 ${sort{3:2:1:4}{<}{$item}}
9784 .endd
9785 sorts a list of numbers, and
9786 .code
9787 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9788 .endd
9789 will sort an MX lookup into priority order.
9790
9791
9792 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9793 .cindex "&%substr%& expansion item"
9794 .cindex "substring extraction"
9795 .cindex "expansion" "substring extraction"
9796 The three strings are expanded; the first two must yield numbers. Call them
9797 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9798 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9799 can use the simpler operator notation that avoids some of the braces:
9800 .code
9801 ${substr_<n>_<m>:<string>}
9802 .endd
9803 The second number is optional (in both notations).
9804 If it is absent in the simpler format, the preceding underscore must also be
9805 omitted.
9806
9807 The &%substr%& item can be used to extract more general substrings than
9808 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9809 length required. For example
9810 .code
9811 ${substr{3}{2}{$local_part}}
9812 .endd
9813 If the starting offset is greater than the string length the result is the
9814 null string; if the length plus starting offset is greater than the string
9815 length, the result is the right-hand part of the string, starting from the
9816 given offset. The first character in the string has offset zero.
9817
9818 The &%substr%& expansion item can take negative offset values to count
9819 from the right-hand end of its operand. The last character is offset -1, the
9820 second-last is offset -2, and so on. Thus, for example,
9821 .code
9822 ${substr{-5}{2}{1234567}}
9823 .endd
9824 yields &"34"&. If the absolute value of a negative offset is greater than the
9825 length of the string, the substring starts at the beginning of the string, and
9826 the length is reduced by the amount of overshoot. Thus, for example,
9827 .code
9828 ${substr{-5}{2}{12}}
9829 .endd
9830 yields an empty string, but
9831 .code
9832 ${substr{-3}{2}{12}}
9833 .endd
9834 yields &"1"&.
9835
9836 When the second number is omitted from &%substr%&, the remainder of the string
9837 is taken if the offset is positive. If it is negative, all characters in the
9838 string preceding the offset point are taken. For example, an offset of -1 and
9839 no length, as in these semantically identical examples:
9840 .code
9841 ${substr_-1:abcde}
9842 ${substr{-1}{abcde}}
9843 .endd
9844 yields all but the last character of the string, that is, &"abcd"&.
9845
9846
9847
9848 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9849         {*&<&'replacements'&>&*}}*&"
9850 .cindex "expansion" "character translation"
9851 .cindex "&%tr%& expansion item"
9852 This item does single-character translation on its subject string. The second
9853 argument is a list of characters to be translated in the subject string. Each
9854 matching character is replaced by the corresponding character from the
9855 replacement list. For example
9856 .code
9857 ${tr{abcdea}{ac}{13}}
9858 .endd
9859 yields &`1b3de1`&. If there are duplicates in the second character string, the
9860 last occurrence is used. If the third string is shorter than the second, its
9861 last character is replicated. However, if it is empty, no translation takes
9862 place.
9863 .endlist
9864
9865
9866
9867 .section "Expansion operators" "SECTexpop"
9868 .cindex "expansion" "operators"
9869 For expansion items that perform transformations on a single argument string,
9870 the &"operator"& notation is used because it is simpler and uses fewer braces.
9871 The substring is first expanded before the operation is applied to it. The
9872 following operations can be performed:
9873
9874 .vlist
9875 .vitem &*${address:*&<&'string'&>&*}*&
9876 .cindex "expansion" "RFC 2822 address handling"
9877 .cindex "&%address%& expansion item"
9878 The string is interpreted as an RFC 2822 address, as it might appear in a
9879 header line, and the effective address is extracted from it. If the string does
9880 not parse successfully, the result is empty.
9881
9882
9883 .vitem &*${addresses:*&<&'string'&>&*}*&
9884 .cindex "expansion" "RFC 2822 address handling"
9885 .cindex "&%addresses%& expansion item"
9886 The string (after expansion) is interpreted as a list of addresses in RFC
9887 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9888 operative address (&'local-part@domain'&) is extracted from each item, and the
9889 result of the expansion is a colon-separated list, with appropriate
9890 doubling of colons should any happen to be present in the email addresses.
9891 Syntactically invalid RFC2822 address items are omitted from the output.
9892
9893 It is possible to specify a character other than colon for the output
9894 separator by starting the string with > followed by the new separator
9895 character. For example:
9896 .code
9897 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9898 .endd
9899 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9900 expansion item, which extracts the working address from a single RFC2822
9901 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9902 processing lists.
9903
9904 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9905 a strict interpretation of header line formatting.  Exim parses the bare,
9906 unquoted portion of an email address and if it finds a comma, treats it as an
9907 email address seperator. For the example header line:
9908 .code
9909 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9910 .endd
9911 The first example below demonstrates that Q-encoded email addresses are parsed
9912 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9913 It does not see the comma because it's still encoded as "=2C".  The second
9914 example below is passed the contents of &`$header_from:`&, meaning it gets
9915 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9916 The third example shows that the presence of a comma is skipped when it is
9917 quoted.
9918 .code
9919 # exim -be '${addresses:From: \
9920 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9921 user@example.com
9922 # exim -be '${addresses:From: Last, First <user@example.com>}'
9923 Last:user@example.com
9924 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9925 user@example.com
9926 .endd
9927
9928 .vitem &*${base62:*&<&'digits'&>&*}*&
9929 .cindex "&%base62%& expansion item"
9930 .cindex "expansion" "conversion to base 62"
9931 The string must consist entirely of decimal digits. The number is converted to
9932 base 62 and output as a string of six characters, including leading zeros. In
9933 the few operating environments where Exim uses base 36 instead of base 62 for
9934 its message identifiers (because those systems do not have case-sensitive file
9935 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9936 be absolutely clear: this is &'not'& base64 encoding.
9937
9938 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9939 .cindex "&%base62d%& expansion item"
9940 .cindex "expansion" "conversion to base 62"
9941 The string must consist entirely of base-62 digits, or, in operating
9942 environments where Exim uses base 36 instead of base 62 for its message
9943 identifiers, base-36 digits. The number is converted to decimal and output as a
9944 string.
9945
9946
9947 .vitem &*${domain:*&<&'string'&>&*}*&
9948 .cindex "domain" "extraction"
9949 .cindex "expansion" "domain extraction"
9950 The string is interpreted as an RFC 2822 address and the domain is extracted
9951 from it. If the string does not parse successfully, the result is empty.
9952
9953
9954 .vitem &*${escape:*&<&'string'&>&*}*&
9955 .cindex "expansion" "escaping non-printing characters"
9956 .cindex "&%escape%& expansion item"
9957 If the string contains any non-printing characters, they are converted to
9958 escape sequences starting with a backslash. Whether characters with the most
9959 significant bit set (so-called &"8-bit characters"&) count as printing or not
9960 is controlled by the &%print_topbitchars%& option.
9961
9962
9963 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9964 .cindex "expansion" "expression evaluation"
9965 .cindex "expansion" "arithmetic expression"
9966 .cindex "&%eval%& expansion item"
9967 These items supports simple arithmetic and bitwise logical operations in
9968 expansion strings. The string (after expansion) must be a conventional
9969 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9970 logical operators, and parentheses. All operations are carried out using
9971 integer arithmetic. The operator priorities are as follows (the same as in the
9972 C programming language):
9973 .table2 70pt 300pt
9974 .irow &'highest:'& "not (~), negate (-)"
9975 .irow ""   "multiply (*), divide (/), remainder (%)"
9976 .irow ""   "plus (+), minus (-)"
9977 .irow ""   "shift-left (<<), shift-right (>>)"
9978 .irow ""   "and (&&)"
9979 .irow ""   "xor (^)"
9980 .irow &'lowest:'&  "or (|)"
9981 .endtable
9982 Binary operators with the same priority are evaluated from left to right. White
9983 space is permitted before or after operators.
9984
9985 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9986 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9987 decimal, even if they start with a leading zero; hexadecimal numbers are not
9988 permitted. This can be useful when processing numbers extracted from dates or
9989 times, which often do have leading zeros.
9990
9991 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
9992 or 1024*1024*1024,
9993 respectively. Negative numbers are supported. The result of the computation is
9994 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
9995
9996 .display
9997 &`${eval:1+1}            `&  yields 2
9998 &`${eval:1+2*3}          `&  yields 7
9999 &`${eval:(1+2)*3}        `&  yields 9
10000 &`${eval:2+42%5}         `&  yields 4
10001 &`${eval:0xc&amp;5}          `&  yields 4
10002 &`${eval:0xc|5}          `&  yields 13
10003 &`${eval:0xc^5}          `&  yields 9
10004 &`${eval:0xc>>1}         `&  yields 6
10005 &`${eval:0xc<<1}         `&  yields 24
10006 &`${eval:~255&amp;0x1234}    `&  yields 4608
10007 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10008 .endd
10009
10010 As a more realistic example, in an ACL you might have
10011 .code
10012 deny   message = Too many bad recipients
10013        condition =                    \
10014          ${if and {                   \
10015            {>{$rcpt_count}{10}}       \
10016            {                          \
10017            <                          \
10018              {$recipients_count}      \
10019              {${eval:$rcpt_count/2}}  \
10020            }                          \
10021          }{yes}{no}}
10022 .endd
10023 The condition is true if there have been more than 10 RCPT commands and
10024 fewer than half of them have resulted in a valid recipient.
10025
10026
10027 .vitem &*${expand:*&<&'string'&>&*}*&
10028 .cindex "expansion" "re-expansion of substring"
10029 The &%expand%& operator causes a string to be expanded for a second time. For
10030 example,
10031 .code
10032 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10033 .endd
10034 first looks up a string in a file while expanding the operand for &%expand%&,
10035 and then re-expands what it has found.
10036
10037
10038 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10039 .cindex "Unicode"
10040 .cindex "UTF-8" "conversion from"
10041 .cindex "expansion" "UTF-8 conversion"
10042 .cindex "&%from_utf8%& expansion item"
10043 The world is slowly moving towards Unicode, although there are no standards for
10044 email yet. However, other applications (including some databases) are starting
10045 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10046 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10047 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10048 the result is an undefined sequence of bytes.
10049
10050 Unicode code points with values less than 256 are compatible with ASCII and
10051 ISO-8859-1 (also known as Latin-1).
10052 For example, character 169 is the copyright symbol in both cases, though the
10053 way it is encoded is different. In UTF-8, more than one byte is needed for
10054 characters with code values greater than 127, whereas ISO-8859-1 is a
10055 single-byte encoding (but thereby limited to 256 characters). This makes
10056 translation from UTF-8 to ISO-8859-1 straightforward.
10057
10058
10059 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10060 .cindex "hash function" "textual"
10061 .cindex "expansion" "textual hash"
10062 The &%hash%& operator is a simpler interface to the hashing function that can
10063 be used when the two parameters are fixed numbers (as opposed to strings that
10064 change when expanded). The effect is the same as
10065 .code
10066 ${hash{<n>}{<m>}{<string>}}
10067 .endd
10068 See the description of the general &%hash%& item above for details. The
10069 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10070
10071
10072
10073 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10074 .cindex "base64 encoding" "conversion from hex"
10075 .cindex "expansion" "hex to base64"
10076 .cindex "&%hex2b64%& expansion item"
10077 This operator converts a hex string into one that is base64 encoded. This can
10078 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10079
10080
10081
10082 .vitem &*${hexquote:*&<&'string'&>&*}*&
10083 .cindex "quoting" "hex-encoded unprintable characters"
10084 .cindex "&%hexquote%& expansion item"
10085 This operator converts non-printable characters in a string into a hex
10086 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10087 as is, and other byte values are converted to &`\xNN`&, for example a
10088 byte value 127 is converted to &`\x7f`&.
10089
10090
10091 .vitem &*${lc:*&<&'string'&>&*}*&
10092 .cindex "case forcing in strings"
10093 .cindex "string" "case forcing"
10094 .cindex "lower casing"
10095 .cindex "expansion" "case forcing"
10096 .cindex "&%lc%& expansion item"
10097 This forces the letters in the string into lower-case, for example:
10098 .code
10099 ${lc:$local_part}
10100 .endd
10101
10102 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10103 .cindex "expansion" "string truncation"
10104 .cindex "&%length%& expansion item"
10105 The &%length%& operator is a simpler interface to the &%length%& function that
10106 can be used when the parameter is a fixed number (as opposed to a string that
10107 changes when expanded). The effect is the same as
10108 .code
10109 ${length{<number>}{<string>}}
10110 .endd
10111 See the description of the general &%length%& item above for details. Note that
10112 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10113 when &%length%& is used as an operator.
10114
10115
10116 .vitem &*${listcount:*&<&'string'&>&*}*&
10117 .cindex "expansion" "list item count"
10118 .cindex "list" "item count"
10119 .cindex "list" "count of items"
10120 .cindex "&%listcount%& expansion item"
10121 The string is interpreted as a list and the number of items is returned.
10122
10123
10124 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10125 .cindex "expansion" "named list"
10126 .cindex "&%listnamed%& expansion item"
10127 The name is interpreted as a named list and the content of the list is returned,
10128 expanding any referenced lists, re-quoting as needed for colon-separation.
10129 If the optional type is given it must be one of "a", "d", "h" or "l"
10130 and selects address-, domain-, host- or localpart- lists to search among respectively.
10131 Otherwise all types are searched in an undefined order and the first
10132 matching list is returned.
10133
10134
10135 .vitem &*${local_part:*&<&'string'&>&*}*&
10136 .cindex "expansion" "local part extraction"
10137 .cindex "&%local_part%& expansion item"
10138 The string is interpreted as an RFC 2822 address and the local part is
10139 extracted from it. If the string does not parse successfully, the result is
10140 empty.
10141
10142
10143 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10144 .cindex "masked IP address"
10145 .cindex "IP address" "masking"
10146 .cindex "CIDR notation"
10147 .cindex "expansion" "IP address masking"
10148 .cindex "&%mask%& expansion item"
10149 If the form of the string to be operated on is not an IP address followed by a
10150 slash and an integer (that is, a network address in CIDR notation), the
10151 expansion fails. Otherwise, this operator converts the IP address to binary,
10152 masks off the least significant bits according to the bit count, and converts
10153 the result back to text, with mask appended. For example,
10154 .code
10155 ${mask:10.111.131.206/28}
10156 .endd
10157 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10158 be mostly used for looking up masked addresses in files, the result for an IPv6
10159 address uses dots to separate components instead of colons, because colon
10160 terminates a key string in lsearch files. So, for example,
10161 .code
10162 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10163 .endd
10164 returns the string
10165 .code
10166 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10167 .endd
10168 Letters in IPv6 addresses are always output in lower case.
10169
10170
10171 .vitem &*${md5:*&<&'string'&>&*}*&
10172 .cindex "MD5 hash"
10173 .cindex "expansion" "MD5 hash"
10174 .cindex "certificate fingerprint"
10175 .cindex "&%md5%& expansion item"
10176 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10177 as a 32-digit hexadecimal number, in which any letters are in lower case.
10178
10179
10180 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10181 .cindex "expansion" "numeric hash"
10182 .cindex "hash function" "numeric"
10183 The &%nhash%& operator is a simpler interface to the numeric hashing function
10184 that can be used when the two parameters are fixed numbers (as opposed to
10185 strings that change when expanded). The effect is the same as
10186 .code
10187 ${nhash{<n>}{<m>}{<string>}}
10188 .endd
10189 See the description of the general &%nhash%& item above for details.
10190
10191
10192 .vitem &*${quote:*&<&'string'&>&*}*&
10193 .cindex "quoting" "in string expansions"
10194 .cindex "expansion" "quoting"
10195 .cindex "&%quote%& expansion item"
10196 The &%quote%& operator puts its argument into double quotes if it
10197 is an empty string or
10198 contains anything other than letters, digits, underscores, dots, and hyphens.
10199 Any occurrences of double quotes and backslashes are escaped with a backslash.
10200 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10201 respectively For example,
10202 .code
10203 ${quote:ab"*"cd}
10204 .endd
10205 becomes
10206 .code
10207 "ab\"*\"cd"
10208 .endd
10209 The place where this is useful is when the argument is a substitution from a
10210 variable or a message header.
10211
10212 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10213 .cindex "&%quote_local_part%& expansion item"
10214 This operator is like &%quote%&, except that it quotes the string only if
10215 required to do so by the rules of RFC 2822 for quoting local parts. For
10216 example, a plus sign would not cause quoting (but it would for &%quote%&).
10217 If you are creating a new email address from the contents of &$local_part$&
10218 (or any other unknown data), you should always use this operator.
10219
10220
10221 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10222 .cindex "quoting" "lookup-specific"
10223 This operator applies lookup-specific quoting rules to the string. Each
10224 query-style lookup type has its own quoting rules which are described with
10225 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10226 .code
10227 ${quote_ldap:two * two}
10228 .endd
10229 returns
10230 .code
10231 two%20%5C2A%20two
10232 .endd
10233 For single-key lookup types, no quoting is ever necessary and this operator
10234 yields an unchanged string.
10235
10236
10237 .vitem &*${randint:*&<&'n'&>&*}*&
10238 .cindex "random number"
10239 This operator returns a somewhat random number which is less than the
10240 supplied number and is at least 0.  The quality of this randomness depends
10241 on how Exim was built; the values are not suitable for keying material.
10242 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10243 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10244 for versions of GnuTLS with that function.
10245 Otherwise, the implementation may be arc4random(), random() seeded by
10246 srandomdev() or srandom(), or a custom implementation even weaker than
10247 random().
10248
10249
10250 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10251 .cindex "expansion" "IP address"
10252 This operator reverses an IP address; for IPv4 addresses, the result is in
10253 dotted-quad decimal form, while for IPv6 addreses the result is in
10254 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10255 for DNS.  For example,
10256 .code
10257 ${reverse_ip:192.0.2.4}
10258 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10259 .endd
10260 returns
10261 .code
10262 4.2.0.192
10263 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
10264 .endd
10265
10266
10267 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10268 .cindex "expansion" "RFC 2047"
10269 .cindex "RFC 2047" "expansion operator"
10270 .cindex "&%rfc2047%& expansion item"
10271 This operator encodes text according to the rules of RFC 2047. This is an
10272 encoding that is used in header lines to encode non-ASCII characters. It is
10273 assumed that the input string is in the encoding specified by the
10274 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10275 contains only characters in the range 33&--126, and no instances of the
10276 characters
10277 .code
10278 ? = ( ) < > @ , ; : \ " . [ ] _
10279 .endd
10280 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10281 string, using as many &"encoded words"& as necessary to encode all the
10282 characters.
10283
10284
10285 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10286 .cindex "expansion" "RFC 2047"
10287 .cindex "RFC 2047" "decoding"
10288 .cindex "&%rfc2047d%& expansion item"
10289 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10290 bytes are replaced by question marks. Characters are converted into the
10291 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10292 not recognized unless &%check_rfc2047_length%& is set false.
10293
10294 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10295 access a header line, RFC 2047 decoding is done automatically. You do not need
10296 to use this operator as well.
10297
10298
10299
10300 .vitem &*${rxquote:*&<&'string'&>&*}*&
10301 .cindex "quoting" "in regular expressions"
10302 .cindex "regular expressions" "quoting"
10303 .cindex "&%rxquote%& expansion item"
10304 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10305 characters in its argument. This is useful when substituting the values of
10306 variables or headers inside regular expressions.
10307
10308
10309 .vitem &*${sha1:*&<&'string'&>&*}*&
10310 .cindex "SHA-1 hash"
10311 .cindex "expansion" "SHA-1 hashing"
10312 .cindex "certificate fingerprint"
10313 .cindex "&%sha2%& expansion item"
10314 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10315 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10316
10317
10318 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10319 .cindex "SHA-256 hash"
10320 .cindex "certificate fingerprint"
10321 .cindex "expansion" "SHA-256 hashing"
10322 .cindex "&%sha256%& expansion item"
10323 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10324 certificate,
10325 and returns
10326 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10327 Only arguments which are a single variable of certificate type are supported.
10328
10329
10330 .vitem &*${stat:*&<&'string'&>&*}*&
10331 .cindex "expansion" "statting a file"
10332 .cindex "file" "extracting characteristics"
10333 .cindex "&%stat%& expansion item"
10334 The string, after expansion, must be a file path. A call to the &[stat()]&
10335 function is made for this path. If &[stat()]& fails, an error occurs and the
10336 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10337 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10338 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10339 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10340 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10341 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10342 can extract individual fields using the &%extract%& expansion item.
10343
10344 The use of the &%stat%& expansion in users' filter files can be locked out by
10345 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10346 systems for files larger than 2GB.
10347
10348 .vitem &*${str2b64:*&<&'string'&>&*}*&
10349 .cindex "expansion" "base64 encoding"
10350 .cindex "base64 encoding" "in string expansion"
10351 .cindex "&%str2b64%& expansion item"
10352 This operator converts a string into one that is base64 encoded.
10353
10354
10355
10356 .vitem &*${strlen:*&<&'string'&>&*}*&
10357 .cindex "expansion" "string length"
10358 .cindex "string" "length in expansion"
10359 .cindex "&%strlen%& expansion item"
10360 The item is replace by the length of the expanded string, expressed as a
10361 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10362
10363
10364 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10365 .cindex "&%substr%& expansion item"
10366 .cindex "substring extraction"
10367 .cindex "expansion" "substring expansion"
10368 The &%substr%& operator is a simpler interface to the &%substr%& function that
10369 can be used when the two parameters are fixed numbers (as opposed to strings
10370 that change when expanded). The effect is the same as
10371 .code
10372 ${substr{<start>}{<length>}{<string>}}
10373 .endd
10374 See the description of the general &%substr%& item above for details. The
10375 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10376
10377 .vitem &*${time_eval:*&<&'string'&>&*}*&
10378 .cindex "&%time_eval%& expansion item"
10379 .cindex "time interval" "decoding"
10380 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10381 seconds.
10382
10383 .vitem &*${time_interval:*&<&'string'&>&*}*&
10384 .cindex "&%time_interval%& expansion item"
10385 .cindex "time interval" "formatting"
10386 The argument (after sub-expansion) must be a sequence of decimal digits that
10387 represents an interval of time as a number of seconds. It is converted into a
10388 number of larger units and output in Exim's normal time format, for example,
10389 &`1w3d4h2m6s`&.
10390
10391 .vitem &*${uc:*&<&'string'&>&*}*&
10392 .cindex "case forcing in strings"
10393 .cindex "string" "case forcing"
10394 .cindex "upper casing"
10395 .cindex "expansion" "case forcing"
10396 .cindex "&%uc%& expansion item"
10397 This forces the letters in the string into upper-case.
10398
10399 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10400 .cindex "correction of invalid utf-8 sequences in strings"
10401 .cindex "utf-8" "utf-8 sequences"
10402 .cindex "incorrect utf-8"
10403 .cindex "expansion" "utf-8 forcing"
10404 .cindex "&%utf8clean%& expansion item"
10405 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10406 .endlist
10407
10408
10409
10410
10411
10412
10413 .section "Expansion conditions" "SECTexpcond"
10414 .scindex IIDexpcond "expansion" "conditions"
10415 The following conditions are available for testing by the &%${if%& construct
10416 while expanding strings:
10417
10418 .vlist
10419 .vitem &*!*&<&'condition'&>
10420 .cindex "expansion" "negating a condition"
10421 .cindex "negation" "in expansion condition"
10422 Preceding any condition with an exclamation mark negates the result of the
10423 condition.
10424
10425 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10426 .cindex "numeric comparison"
10427 .cindex "expansion" "numeric comparison"
10428 There are a number of symbolic operators for doing numeric comparisons. They
10429 are:
10430 .display
10431 &`=   `&   equal
10432 &`==  `&   equal
10433 &`>   `&   greater
10434 &`>=  `&   greater or equal
10435 &`<   `&   less
10436 &`<=  `&   less or equal
10437 .endd
10438 For example:
10439 .code
10440 ${if >{$message_size}{10M} ...
10441 .endd
10442 Note that the general negation operator provides for inequality testing. The
10443 two strings must take the form of optionally signed decimal integers,
10444 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10445 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10446 As a special case, the numerical value of an empty string is taken as
10447 zero.
10448
10449 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10450 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10451 10M, not if 10M is larger than &$message_size$&.
10452
10453
10454 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10455         {*&<&'arg2'&>&*}...}*&
10456 .cindex "expansion" "calling an acl"
10457 .cindex "&%acl%&" "expansion condition"
10458 The name and zero to nine argument strings are first expanded separately.  The expanded
10459 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10460 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10461 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10462 and may use the variables; if another acl expansion is used the values
10463 are restored after it returns.  If the ACL sets
10464 a value using a "message =" modifier the variable $value becomes
10465 the result of the expansion, otherwise it is empty.
10466 If the ACL returns accept the condition is true; if deny, false.
10467 If the ACL returns defer the result is a forced-fail.
10468
10469 .vitem &*bool&~{*&<&'string'&>&*}*&
10470 .cindex "expansion" "boolean parsing"
10471 .cindex "&%bool%& expansion condition"
10472 This condition turns a string holding a true or false representation into
10473 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10474 (case-insensitively); also integer numbers map to true if non-zero,
10475 false if zero.
10476 An empty string is treated as false.
10477 Leading and trailing whitespace is ignored;
10478 thus a string consisting only of whitespace is false.
10479 All other string values will result in expansion failure.
10480
10481 When combined with ACL variables, this expansion condition will let you
10482 make decisions in one place and act on those decisions in another place.
10483 For example:
10484 .code
10485 ${if bool{$acl_m_privileged_sender} ...
10486 .endd
10487
10488
10489 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10490 .cindex "expansion" "boolean parsing"
10491 .cindex "&%bool_lax%& expansion condition"
10492 Like &%bool%&, this condition turns a string into a boolean state.  But
10493 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10494 loose definition that the Router &%condition%& option uses.  The empty string
10495 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10496 true.  Leading and trailing whitespace is ignored.
10497
10498 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10499
10500 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10501 .cindex "expansion" "encrypted comparison"
10502 .cindex "encrypted strings, comparing"
10503 .cindex "&%crypteq%& expansion condition"
10504 This condition is included in the Exim binary if it is built to support any
10505 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10506 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10507 included in the binary.
10508
10509 The &%crypteq%& condition has two arguments. The first is encrypted and
10510 compared against the second, which is already encrypted. The second string may
10511 be in the LDAP form for storing encrypted strings, which starts with the
10512 encryption type in curly brackets, followed by the data. If the second string
10513 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10514 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10515 Typically this will be a field from a password file. An example of an encrypted
10516 string in LDAP form is:
10517 .code
10518 {md5}CY9rzUYh03PK3k6DJie09g==
10519 .endd
10520 If such a string appears directly in an expansion, the curly brackets have to
10521 be quoted, because they are part of the expansion syntax. For example:
10522 .code
10523 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10524 .endd
10525 The following encryption types (whose names are matched case-independently) are
10526 supported:
10527
10528 .ilist
10529 .cindex "MD5 hash"
10530 .cindex "base64 encoding" "in encrypted password"
10531 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10532 printable characters to compare with the remainder of the second string. If the
10533 length of the comparison string is 24, Exim assumes that it is base64 encoded
10534 (as in the above example). If the length is 32, Exim assumes that it is a
10535 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10536 comparison fails.
10537
10538 .next
10539 .cindex "SHA-1 hash"
10540 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10541 printable characters to compare with the remainder of the second string. If the
10542 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10543 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10544 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10545
10546 .next
10547 .cindex "&[crypt()]&"
10548 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10549 only the first eight characters of the password. However, in modern operating
10550 systems this is no longer true, and in many cases the entire password is used,
10551 whatever its length.
10552
10553 .next
10554 .cindex "&[crypt16()]&"
10555 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10556 use up to 16 characters of the password in some operating systems. Again, in
10557 modern operating systems, more characters may be used.
10558 .endlist
10559 Exim has its own version of &[crypt16()]&, which is just a double call to
10560 &[crypt()]&. For operating systems that have their own version, setting
10561 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10562 operating system version instead of its own. This option is set by default in
10563 the OS-dependent &_Makefile_& for those operating systems that are known to
10564 support &[crypt16()]&.
10565
10566 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10567 it was not using the same algorithm as some operating systems' versions. It
10568 turns out that as well as &[crypt16()]& there is a function called
10569 &[bigcrypt()]& in some operating systems. This may or may not use the same
10570 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10571
10572 However, since there is now a move away from the traditional &[crypt()]&
10573 functions towards using SHA1 and other algorithms, tidying up this area of
10574 Exim is seen as very low priority.
10575
10576 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10577 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10578 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10579 default is &`{crypt}`&. Whatever the default, you can always use either
10580 function by specifying it explicitly in curly brackets.
10581
10582 .vitem &*def:*&<&'variable&~name'&>
10583 .cindex "expansion" "checking for empty variable"
10584 .cindex "&%def%& expansion condition"
10585 The &%def%& condition must be followed by the name of one of the expansion
10586 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10587 variable does not contain the empty string. For example:
10588 .code
10589 ${if def:sender_ident {from $sender_ident}}
10590 .endd
10591 Note that the variable name is given without a leading &%$%& character. If the
10592 variable does not exist, the expansion fails.
10593
10594 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10595         &~&*def:h_*&<&'header&~name'&>&*:*&"
10596 .cindex "expansion" "checking header line existence"
10597 This condition is true if a message is being processed and the named header
10598 exists in the message. For example,
10599 .code
10600 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10601 .endd
10602 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10603 the header name must be terminated by a colon if white space does not follow.
10604
10605 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10606        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10607 .cindex "string" "comparison"
10608 .cindex "expansion" "string comparison"
10609 .cindex "&%eq%& expansion condition"
10610 .cindex "&%eqi%& expansion condition"
10611 The two substrings are first expanded. The condition is true if the two
10612 resulting strings are identical. For &%eq%& the comparison includes the case of
10613 letters, whereas for &%eqi%& the comparison is case-independent.
10614
10615 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10616 .cindex "expansion" "file existence test"
10617 .cindex "file" "existence test"
10618 .cindex "&%exists%&, expansion condition"
10619 The substring is first expanded and then interpreted as an absolute path. The
10620 condition is true if the named file (or directory) exists. The existence test
10621 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10622 users' filter files may be locked out by the system administrator.
10623
10624 .vitem &*first_delivery*&
10625 .cindex "delivery" "first"
10626 .cindex "first delivery"
10627 .cindex "expansion" "first delivery test"
10628 .cindex "&%first_delivery%& expansion condition"
10629 This condition, which has no data, is true during a message's first delivery
10630 attempt. It is false during any subsequent delivery attempts.
10631
10632
10633 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10634        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10635 .cindex "list" "iterative conditions"
10636 .cindex "expansion" "&*forall*& condition"
10637 .cindex "expansion" "&*forany*& condition"
10638 .vindex "&$item$&"
10639 These conditions iterate over a list. The first argument is expanded to form
10640 the list. By default, the list separator is a colon, but it can be changed by
10641 the normal method. The second argument is interpreted as a condition that is to
10642 be applied to each item in the list in turn. During the interpretation of the
10643 condition, the current list item is placed in a variable called &$item$&.
10644 .ilist
10645 For &*forany*&, interpretation stops if the condition is true for any item, and
10646 the result of the whole condition is true. If the condition is false for all
10647 items in the list, the overall condition is false.
10648 .next
10649 For &*forall*&, interpretation stops if the condition is false for any item,
10650 and the result of the whole condition is false. If the condition is true for
10651 all items in the list, the overall condition is true.
10652 .endlist
10653 Note that negation of &*forany*& means that the condition must be false for all
10654 items for the overall condition to succeed, and negation of &*forall*& means
10655 that the condition must be false for at least one item. In this example, the
10656 list separator is changed to a comma:
10657 .code
10658 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10659 .endd
10660 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10661 being processed, to enable these expansion items to be nested.
10662
10663 To scan a named list, expand it with the &*listnamed*& operator.
10664
10665
10666 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10667        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10668 .cindex "string" "comparison"
10669 .cindex "expansion" "string comparison"
10670 .cindex "&%ge%& expansion condition"
10671 .cindex "&%gei%& expansion condition"
10672 The two substrings are first expanded. The condition is true if the first
10673 string is lexically greater than or equal to the second string. For &%ge%& the
10674 comparison includes the case of letters, whereas for &%gei%& the comparison is
10675 case-independent.
10676
10677 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10678        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10679 .cindex "string" "comparison"
10680 .cindex "expansion" "string comparison"
10681 .cindex "&%gt%& expansion condition"
10682 .cindex "&%gti%& expansion condition"
10683 The two substrings are first expanded. The condition is true if the first
10684 string is lexically greater than the second string. For &%gt%& the comparison
10685 includes the case of letters, whereas for &%gti%& the comparison is
10686 case-independent.
10687
10688 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10689        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10690 .cindex "string" "comparison"
10691 .cindex "list" "iterative conditions"
10692 Both strings are expanded; the second string is treated as a list of simple
10693 strings; if the first string is a member of the second, then the condition
10694 is true.
10695
10696 These are simpler to use versions of the more powerful &*forany*& condition.
10697 Examples, and the &*forany*& equivalents:
10698 .code
10699 ${if inlist{needle}{foo:needle:bar}}
10700   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10701 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10702   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10703 .endd
10704
10705 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10706        &*isip4&~{*&<&'string'&>&*}*& &&&
10707        &*isip6&~{*&<&'string'&>&*}*&
10708 .cindex "IP address" "testing string format"
10709 .cindex "string" "testing for IP address"
10710 .cindex "&%isip%& expansion condition"
10711 .cindex "&%isip4%& expansion condition"
10712 .cindex "&%isip6%& expansion condition"
10713 The substring is first expanded, and then tested to see if it has the form of
10714 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10715 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10716
10717 For an IPv4 address, the test is for four dot-separated components, each of
10718 which consists of from one to three digits. For an IPv6 address, up to eight
10719 colon-separated components are permitted, each containing from one to four
10720 hexadecimal digits. There may be fewer than eight components if an empty
10721 component (adjacent colons) is present. Only one empty component is permitted.
10722
10723 &*Note*&: The checks are just on the form of the address; actual numerical
10724 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10725 check. The main use of these tests is to distinguish between IP addresses and
10726 host names, or between IPv4 and IPv6 addresses. For example, you could use
10727 .code
10728 ${if isip4{$sender_host_address}...
10729 .endd
10730 to test which IP version an incoming SMTP connection is using.
10731
10732 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10733 .cindex "LDAP" "use for authentication"
10734 .cindex "expansion" "LDAP authentication test"
10735 .cindex "&%ldapauth%& expansion condition"
10736 This condition supports user authentication using LDAP. See section
10737 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10738 queries. For this use, the query must contain a user name and password. The
10739 query itself is not used, and can be empty. The condition is true if the
10740 password is not empty, and the user name and password are accepted by the LDAP
10741 server. An empty password is rejected without calling LDAP because LDAP binds
10742 with an empty password are considered anonymous regardless of the username, and
10743 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10744 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10745 this can be used.
10746
10747
10748 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10749        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10750 .cindex "string" "comparison"
10751 .cindex "expansion" "string comparison"
10752 .cindex "&%le%& expansion condition"
10753 .cindex "&%lei%& expansion condition"
10754 The two substrings are first expanded. The condition is true if the first
10755 string is lexically less than or equal to the second string. For &%le%& the
10756 comparison includes the case of letters, whereas for &%lei%& the comparison is
10757 case-independent.
10758
10759 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10760        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10761 .cindex "string" "comparison"
10762 .cindex "expansion" "string comparison"
10763 .cindex "&%lt%& expansion condition"
10764 .cindex "&%lti%& expansion condition"
10765 The two substrings are first expanded. The condition is true if the first
10766 string is lexically less than the second string. For &%lt%& the comparison
10767 includes the case of letters, whereas for &%lti%& the comparison is
10768 case-independent.
10769
10770
10771 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10772 .cindex "expansion" "regular expression comparison"
10773 .cindex "regular expressions" "match in expanded string"
10774 .cindex "&%match%& expansion condition"
10775 The two substrings are first expanded. The second is then treated as a regular
10776 expression and applied to the first. Because of the pre-expansion, if the
10777 regular expression contains dollar, or backslash characters, they must be
10778 escaped. Care must also be taken if the regular expression contains braces
10779 (curly brackets). A closing brace must be escaped so that it is not taken as a
10780 premature termination of <&'string2'&>. The easiest approach is to use the
10781 &`\N`& feature to disable expansion of the regular expression.
10782 For example,
10783 .code
10784 ${if match {$local_part}{\N^\d{3}\N} ...
10785 .endd
10786 If the whole expansion string is in double quotes, further escaping of
10787 backslashes is also required.
10788
10789 The condition is true if the regular expression match succeeds.
10790 The regular expression is not required to begin with a circumflex
10791 metacharacter, but if there is no circumflex, the expression is not anchored,
10792 and it may match anywhere in the subject, not just at the start. If you want
10793 the pattern to match at the end of the subject, you must include the &`$`&
10794 metacharacter at an appropriate point.
10795
10796 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10797 At the start of an &%if%& expansion the values of the numeric variable
10798 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10799 succeeds causes them to be reset to the substrings of that condition and they
10800 will have these values during the expansion of the success string. At the end
10801 of the &%if%& expansion, the previous values are restored. After testing a
10802 combination of conditions using &%or%&, the subsequent values of the numeric
10803 variables are those of the condition that succeeded.
10804
10805 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10806 .cindex "&%match_address%& expansion condition"
10807 See &*match_local_part*&.
10808
10809 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10810 .cindex "&%match_domain%& expansion condition"
10811 See &*match_local_part*&.
10812
10813 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10814 .cindex "&%match_ip%& expansion condition"
10815 This condition matches an IP address to a list of IP address patterns. It must
10816 be followed by two argument strings. The first (after expansion) must be an IP
10817 address or an empty string. The second (not expanded) is a restricted host
10818 list that can match only an IP address, not a host name. For example:
10819 .code
10820 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10821 .endd
10822 The specific types of host list item that are permitted in the list are:
10823
10824 .ilist
10825 An IP address, optionally with a CIDR mask.
10826 .next
10827 A single asterisk, which matches any IP address.
10828 .next
10829 An empty item, which matches only if the IP address is empty. This could be
10830 useful for testing for a locally submitted message or one from specific hosts
10831 in a single test such as
10832 . ==== As this is a nested list, any displays it contains must be indented
10833 . ==== as otherwise they are too far to the left. This comment applies to
10834 . ==== the use of xmlto plus fop. There's no problem when formatting with
10835 . ==== sdop, with or without the extra indent.
10836 .code
10837   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10838 .endd
10839 where the first item in the list is the empty string.
10840 .next
10841 The item @[] matches any of the local host's interface addresses.
10842 .next
10843 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10844 even if &`net-`& is not specified. There is never any attempt to turn the IP
10845 address into a host name. The most common type of linear search for
10846 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10847 masks. For example:
10848 .code
10849   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10850 .endd
10851 It is of course possible to use other kinds of lookup, and in such a case, you
10852 do need to specify the &`net-`& prefix if you want to specify a specific
10853 address mask, for example:
10854 .code
10855   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10856 .endd
10857 However, unless you are combining a &%match_ip%& condition with others, it is
10858 just as easy to use the fact that a lookup is itself a condition, and write:
10859 .code
10860   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10861 .endd
10862 .endlist ilist
10863
10864 Note that <&'string2'&> is not itself subject to string expansion, unless
10865 Exim was built with the EXPAND_LISTMATCH_RHS option.
10866
10867 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10868
10869 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10870 .cindex "domain list" "in expansion condition"
10871 .cindex "address list" "in expansion condition"
10872 .cindex "local part" "list, in expansion condition"
10873 .cindex "&%match_local_part%& expansion condition"
10874 This condition, together with &%match_address%& and &%match_domain%&, make it
10875 possible to test domain, address, and local part lists within expansions. Each
10876 condition requires two arguments: an item and a list to match. A trivial
10877 example is:
10878 .code
10879 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10880 .endd
10881 In each case, the second argument may contain any of the allowable items for a
10882 list of the appropriate type. Also, because the second argument (after
10883 expansion) is a standard form of list, it is possible to refer to a named list.
10884 Thus, you can use conditions like this:
10885 .code
10886 ${if match_domain{$domain}{+local_domains}{...
10887 .endd
10888 .cindex "&`+caseful`&"
10889 For address lists, the matching starts off caselessly, but the &`+caseful`&
10890 item can be used, as in all address lists, to cause subsequent items to
10891 have their local parts matched casefully. Domains are always matched
10892 caselessly.
10893
10894 Note that <&'string2'&> is not itself subject to string expansion, unless
10895 Exim was built with the EXPAND_LISTMATCH_RHS option.
10896
10897 &*Note*&: Host lists are &'not'& supported in this way. This is because
10898 hosts have two identities: a name and an IP address, and it is not clear
10899 how to specify cleanly how such a test would work. However, IP addresses can be
10900 matched using &%match_ip%&.
10901
10902 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10903 .cindex "PAM authentication"
10904 .cindex "AUTH" "with PAM"
10905 .cindex "Solaris" "PAM support"
10906 .cindex "expansion" "PAM authentication test"
10907 .cindex "&%pam%& expansion condition"
10908 &'Pluggable Authentication Modules'&
10909 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10910 available in the latest releases of Solaris and in some GNU/Linux
10911 distributions. The Exim support, which is intended for use in conjunction with
10912 the SMTP AUTH command, is available only if Exim is compiled with
10913 .code
10914 SUPPORT_PAM=yes
10915 .endd
10916 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10917 in some releases of GNU/Linux &%-ldl%& is also needed.
10918
10919 The argument string is first expanded, and the result must be a
10920 colon-separated list of strings. Leading and trailing white space is ignored.
10921 The PAM module is initialized with the service name &"exim"& and the user name
10922 taken from the first item in the colon-separated data string (<&'string1'&>).
10923 The remaining items in the data string are passed over in response to requests
10924 from the authentication function. In the simple case there will only be one
10925 request, for a password, so the data consists of just two strings.
10926
10927 There can be problems if any of the strings are permitted to contain colon
10928 characters. In the usual way, these have to be doubled to avoid being taken as
10929 separators. If the data is being inserted from a variable, the &%sg%& expansion
10930 item can be used to double any existing colons. For example, the configuration
10931 of a LOGIN authenticator might contain this setting:
10932 .code
10933 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10934 .endd
10935 For a PLAIN authenticator you could use:
10936 .code
10937 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10938 .endd
10939 In some operating systems, PAM authentication can be done only from a process
10940 running as root. Since Exim is running as the Exim user when receiving
10941 messages, this means that PAM cannot be used directly in those systems.
10942 A patched version of the &'pam_unix'& module that comes with the
10943 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10944 The patched module allows one special uid/gid combination, in addition to root,
10945 to authenticate. If you build the patched module to allow the Exim user and
10946 group, PAM can then be used from an Exim authenticator.
10947
10948
10949 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10950 .cindex "&'pwcheck'& daemon"
10951 .cindex "Cyrus"
10952 .cindex "expansion" "&'pwcheck'& authentication test"
10953 .cindex "&%pwcheck%& expansion condition"
10954 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10955 This is one way of making it possible for passwords to be checked by a process
10956 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10957 deprecated. Its replacement is &'saslauthd'& (see below).
10958
10959 The pwcheck support is not included in Exim by default. You need to specify
10960 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10961 building Exim. For example:
10962 .code
10963 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10964 .endd
10965 You do not need to install the full Cyrus software suite in order to use
10966 the pwcheck daemon. You can compile and install just the daemon alone
10967 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10968 access to the &_/var/pwcheck_& directory.
10969
10970 The &%pwcheck%& condition takes one argument, which must be the user name and
10971 password, separated by a colon. For example, in a LOGIN authenticator
10972 configuration, you might have this:
10973 .code
10974 server_condition = ${if pwcheck{$auth1:$auth2}}
10975 .endd
10976 Again, for a PLAIN authenticator configuration, this would be:
10977 .code
10978 server_condition = ${if pwcheck{$auth2:$auth3}}
10979 .endd
10980 .vitem &*queue_running*&
10981 .cindex "queue runner" "detecting when delivering from"
10982 .cindex "expansion" "queue runner test"
10983 .cindex "&%queue_running%& expansion condition"
10984 This condition, which has no data, is true during delivery attempts that are
10985 initiated by queue runner processes, and false otherwise.
10986
10987
10988 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10989 .cindex "Radius"
10990 .cindex "expansion" "Radius authentication"
10991 .cindex "&%radius%& expansion condition"
10992 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
10993 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
10994 the Radius client configuration file in order to build Exim with Radius
10995 support.
10996
10997 With just that one setting, Exim expects to be linked with the &%radiusclient%&
10998 library, using the original API. If you are using release 0.4.0 or later of
10999 this library, you need to set
11000 .code
11001 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11002 .endd
11003 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11004 &%libradius%& library that comes with FreeBSD. To do this, set
11005 .code
11006 RADIUS_LIB_TYPE=RADLIB
11007 .endd
11008 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11009 You may also have to supply a suitable setting in EXTRALIBS so that the
11010 Radius library can be found when Exim is linked.
11011
11012 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11013 Radius client library, which calls the Radius server. The condition is true if
11014 the authentication is successful. For example:
11015 .code
11016 server_condition = ${if radius{<arguments>}}
11017 .endd
11018
11019
11020 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11021         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11022 .cindex "&'saslauthd'& daemon"
11023 .cindex "Cyrus"
11024 .cindex "expansion" "&'saslauthd'& authentication test"
11025 .cindex "&%saslauthd%& expansion condition"
11026 This condition supports user authentication using the Cyrus &'saslauthd'&
11027 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11028 Using this daemon is one way of making it possible for passwords to be checked
11029 by a process that is not running as root.
11030
11031 The saslauthd support is not included in Exim by default. You need to specify
11032 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11033 building Exim. For example:
11034 .code
11035 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11036 .endd
11037 You do not need to install the full Cyrus software suite in order to use
11038 the saslauthd daemon. You can compile and install just the daemon alone
11039 from the Cyrus SASL library.
11040
11041 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11042 two are mandatory. For example:
11043 .code
11044 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11045 .endd
11046 The service and the realm are optional (which is why the arguments are enclosed
11047 in their own set of braces). For details of the meaning of the service and
11048 realm, and how to run the daemon, consult the Cyrus documentation.
11049 .endlist vlist
11050
11051
11052
11053 .section "Combining expansion conditions" "SECID84"
11054 .cindex "expansion" "combining conditions"
11055 Several conditions can be tested at once by combining them using the &%and%&
11056 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11057 conditions on their own, and precede their lists of sub-conditions. Each
11058 sub-condition must be enclosed in braces within the overall braces that contain
11059 the list. No repetition of &%if%& is used.
11060
11061
11062 .vlist
11063 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11064 .cindex "&""or""& expansion condition"
11065 .cindex "expansion" "&""or""& of conditions"
11066 The sub-conditions are evaluated from left to right. The condition is true if
11067 any one of the sub-conditions is true.
11068 For example,
11069 .code
11070 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11071 .endd
11072 When a true sub-condition is found, the following ones are parsed but not
11073 evaluated. If there are several &"match"& sub-conditions the values of the
11074 numeric variables afterwards are taken from the first one that succeeds.
11075
11076 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11077 .cindex "&""and""& expansion condition"
11078 .cindex "expansion" "&""and""& of conditions"
11079 The sub-conditions are evaluated from left to right. The condition is true if
11080 all of the sub-conditions are true. If there are several &"match"&
11081 sub-conditions, the values of the numeric variables afterwards are taken from
11082 the last one. When a false sub-condition is found, the following ones are
11083 parsed but not evaluated.
11084 .endlist
11085 .ecindex IIDexpcond
11086
11087
11088
11089
11090 .section "Expansion variables" "SECTexpvar"
11091 .cindex "expansion" "variables, list of"
11092 This section contains an alphabetical list of all the expansion variables. Some
11093 of them are available only when Exim is compiled with specific options such as
11094 support for TLS or the content scanning extension.
11095
11096 .vlist
11097 .vitem "&$0$&, &$1$&, etc"
11098 .cindex "numerical variables (&$1$& &$2$& etc)"
11099 When a &%match%& expansion condition succeeds, these variables contain the
11100 captured substrings identified by the regular expression during subsequent
11101 processing of the success string of the containing &%if%& expansion item.
11102 However, they do not retain their values afterwards; in fact, their previous
11103 values are restored at the end of processing an &%if%& item. The numerical
11104 variables may also be set externally by some other matching process which
11105 precedes the expansion of the string. For example, the commands available in
11106 Exim filter files include an &%if%& command with its own regular expression
11107 matching condition.
11108
11109 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11110 Within an acl condition, expansion condition or expansion item
11111 any arguments are copied to these variables,
11112 any unused variables being made empty.
11113
11114 .vitem "&$acl_c...$&"
11115 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11116 can be given any name that starts with &$acl_c$& and is at least six characters
11117 long, but the sixth character must be either a digit or an underscore. For
11118 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11119 variables persist throughout the lifetime of an SMTP connection. They can be
11120 used to pass information between ACLs and between different invocations of the
11121 same ACL. When a message is received, the values of these variables are saved
11122 with the message, and can be accessed by filters, routers, and transports
11123 during subsequent delivery.
11124
11125 .vitem "&$acl_m...$&"
11126 These variables are like the &$acl_c...$& variables, except that their values
11127 are reset after a message has been received. Thus, if several messages are
11128 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11129 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11130 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11131 message is received, the values of these variables are saved with the message,
11132 and can be accessed by filters, routers, and transports during subsequent
11133 delivery.
11134
11135 .vitem &$acl_narg$&
11136 Within an acl condition, expansion condition or expansion item
11137 this variable has the number of arguments.
11138
11139 .vitem &$acl_verify_message$&
11140 .vindex "&$acl_verify_message$&"
11141 After an address verification has failed, this variable contains the failure
11142 message. It retains its value for use in subsequent modifiers. The message can
11143 be preserved by coding like this:
11144 .code
11145 warn !verify = sender
11146      set acl_m0 = $acl_verify_message
11147 .endd
11148 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11149 &%log_message%& modifiers, to include information about the verification
11150 failure.
11151
11152 .vitem &$address_data$&
11153 .vindex "&$address_data$&"
11154 This variable is set by means of the &%address_data%& option in routers. The
11155 value then remains with the address while it is processed by subsequent routers
11156 and eventually a transport. If the transport is handling multiple addresses,
11157 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11158 for more details. &*Note*&: The contents of &$address_data$& are visible in
11159 user filter files.
11160
11161 If &$address_data$& is set when the routers are called from an ACL to verify
11162 a recipient address, the final value is still in the variable for subsequent
11163 conditions and modifiers of the ACL statement. If routing the address caused it
11164 to be redirected to just one address, the child address is also routed as part
11165 of the verification, and in this case the final value of &$address_data$& is
11166 from the child's routing.
11167
11168 If &$address_data$& is set when the routers are called from an ACL to verify a
11169 sender address, the final value is also preserved, but this time in
11170 &$sender_address_data$&, to distinguish it from data from a recipient
11171 address.
11172
11173 In both cases (recipient and sender verification), the value does not persist
11174 after the end of the current ACL statement. If you want to preserve
11175 these values for longer, you can save them in ACL variables.
11176
11177 .vitem &$address_file$&
11178 .vindex "&$address_file$&"
11179 When, as a result of aliasing, forwarding, or filtering, a message is directed
11180 to a specific file, this variable holds the name of the file when the transport
11181 is running. At other times, the variable is empty. For example, using the
11182 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11183 .code
11184 /home/r2d2/savemail
11185 .endd
11186 then when the &(address_file)& transport is running, &$address_file$&
11187 contains the text string &`/home/r2d2/savemail`&.
11188 .cindex "Sieve filter" "value of &$address_file$&"
11189 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11190 then up to the transport configuration to generate an appropriate absolute path
11191 to the relevant file.
11192
11193 .vitem &$address_pipe$&
11194 .vindex "&$address_pipe$&"
11195 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11196 this variable holds the pipe command when the transport is running.
11197
11198 .vitem "&$auth1$& &-- &$auth3$&"
11199 .vindex "&$auth1$&, &$auth2$&, etc"
11200 These variables are used in SMTP authenticators (see chapters
11201 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11202
11203 .vitem &$authenticated_id$&
11204 .cindex "authentication" "id"
11205 .vindex "&$authenticated_id$&"
11206 When a server successfully authenticates a client it may be configured to
11207 preserve some of the authentication information in the variable
11208 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11209 user/password authenticator configuration might preserve the user name for use
11210 in the routers. Note that this is not the same information that is saved in
11211 &$sender_host_authenticated$&.
11212 When a message is submitted locally (that is, not over a TCP connection)
11213 the value of &$authenticated_id$& is normally the login name of the calling
11214 process. However, a trusted user can override this by means of the &%-oMai%&
11215 command line option.
11216
11217 .vitem &$authenticated_fail_id$&
11218 .cindex "authentication" "fail" "id"
11219 .vindex "&$authenticated_fail_id$&"
11220 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11221 will contain the failed authentication id. If more than one authentication
11222 id is attempted, it will contain only the last one. The variable is
11223 available for processing in the ACL's, generally the quit or notquit ACL.
11224 A message to a local recipient could still be accepted without requiring
11225 authentication, which means this variable could also be visible in all of
11226 the ACL's as well.
11227
11228
11229 .vitem &$authenticated_sender$&
11230 .cindex "sender" "authenticated"
11231 .cindex "authentication" "sender"
11232 .cindex "AUTH" "on MAIL command"
11233 .vindex "&$authenticated_sender$&"
11234 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11235 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11236 described in section &<<SECTauthparamail>>&. Unless the data is the string
11237 &"<>"&, it is set as the authenticated sender of the message, and the value is
11238 available during delivery in the &$authenticated_sender$& variable. If the
11239 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11240
11241 .vindex "&$qualify_domain$&"
11242 When a message is submitted locally (that is, not over a TCP connection), the
11243 value of &$authenticated_sender$& is an address constructed from the login
11244 name of the calling process and &$qualify_domain$&, except that a trusted user
11245 can override this by means of the &%-oMas%& command line option.
11246
11247
11248 .vitem &$authentication_failed$&
11249 .cindex "authentication" "failure"
11250 .vindex "&$authentication_failed$&"
11251 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11252 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11253 possible to distinguish between &"did not try to authenticate"&
11254 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11255 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11256 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11257 negative response to an AUTH command, including (for example) an attempt to use
11258 an undefined mechanism.
11259
11260 .vitem &$av_failed$&
11261 .cindex "content scanning" "AV scanner failure"
11262 This variable is available when Exim is compiled with the content-scanning
11263 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11264 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11265 the ACL malware condition.
11266
11267 .vitem &$body_linecount$&
11268 .cindex "message body" "line count"
11269 .cindex "body of message" "line count"
11270 .vindex "&$body_linecount$&"
11271 When a message is being received or delivered, this variable contains the
11272 number of lines in the message's body. See also &$message_linecount$&.
11273
11274 .vitem &$body_zerocount$&
11275 .cindex "message body" "binary zero count"
11276 .cindex "body of message" "binary zero count"
11277 .cindex "binary zero" "in message body"
11278 .vindex "&$body_zerocount$&"
11279 When a message is being received or delivered, this variable contains the
11280 number of binary zero bytes (ASCII NULs) in the message's body.
11281
11282 .vitem &$bounce_recipient$&
11283 .vindex "&$bounce_recipient$&"
11284 This is set to the recipient address of a bounce message while Exim is creating
11285 it. It is useful if a customized bounce message text file is in use (see
11286 chapter &<<CHAPemsgcust>>&).
11287
11288 .vitem &$bounce_return_size_limit$&
11289 .vindex "&$bounce_return_size_limit$&"
11290 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11291 up to a multiple of 1000. It is useful when a customized error message text
11292 file is in use (see chapter &<<CHAPemsgcust>>&).
11293
11294 .vitem &$caller_gid$&
11295 .cindex "gid (group id)" "caller"
11296 .vindex "&$caller_gid$&"
11297 The real group id under which the process that called Exim was running. This is
11298 not the same as the group id of the originator of a message (see
11299 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11300 incarnation normally contains the Exim gid.
11301
11302 .vitem &$caller_uid$&
11303 .cindex "uid (user id)" "caller"
11304 .vindex "&$caller_uid$&"
11305 The real user id under which the process that called Exim was running. This is
11306 not the same as the user id of the originator of a message (see
11307 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11308 incarnation normally contains the Exim uid.
11309
11310 .vitem &$compile_date$&
11311 .vindex "&$compile_date$&"
11312 The date on which the Exim binary was compiled.
11313
11314 .vitem &$compile_number$&
11315 .vindex "&$compile_number$&"
11316 The building process for Exim keeps a count of the number
11317 of times it has been compiled. This serves to distinguish different
11318 compilations of the same version of the program.
11319
11320 .new
11321 .vitem &$config_dir$&
11322 .vindex "&$config_dir$&"
11323 The directory name of the main configuration file. That is, the content of
11324 &$config_file$& with the last component stripped. The value does not
11325 contain the trailing slash. If &$config_file$& does not contain a slash,
11326 &$config_dir$& is ".".
11327
11328 .vitem &$config_file$&
11329 .vindex "&$config_file$&"
11330 The name of the main configuration file Exim is using.
11331 .wen
11332
11333 .vitem &$demime_errorlevel$&
11334 .vindex "&$demime_errorlevel$&"
11335 This variable is available when Exim is compiled with
11336 the content-scanning extension and the obsolete &%demime%& condition. For
11337 details, see section &<<SECTdemimecond>>&.
11338
11339 .vitem &$demime_reason$&
11340 .vindex "&$demime_reason$&"
11341 This variable is available when Exim is compiled with the
11342 content-scanning extension and the obsolete &%demime%& condition. For details,
11343 see section &<<SECTdemimecond>>&.
11344
11345 .vitem &$dkim_cur_signer$& &&&
11346        &$dkim_verify_status$& &&&
11347        &$dkim_verify_reason$& &&&
11348        &$dkim_domain$& &&&
11349        &$dkim_identity$& &&&
11350        &$dkim_selector$& &&&
11351        &$dkim_algo$& &&&
11352        &$dkim_canon_body$& &&&
11353        &$dkim_canon_headers$& &&&
11354        &$dkim_copiedheaders$& &&&
11355        &$dkim_bodylength$& &&&
11356        &$dkim_created$& &&&
11357        &$dkim_expires$& &&&
11358        &$dkim_headernames$& &&&
11359        &$dkim_key_testing$& &&&
11360        &$dkim_key_nosubdomains$& &&&
11361        &$dkim_key_srvtype$& &&&
11362        &$dkim_key_granularity$& &&&
11363        &$dkim_key_notes$&
11364 These variables are only available within the DKIM ACL.
11365 For details see chapter &<<CHAPdkim>>&.
11366
11367 .vitem &$dkim_signers$&
11368 .vindex &$dkim_signers$&
11369 When a message has been received this variable contains
11370 a colon-separated list of signer domains and identities for the message.
11371 For details see chapter &<<CHAPdkim>>&.
11372
11373 .vitem &$dnslist_domain$& &&&
11374        &$dnslist_matched$& &&&
11375        &$dnslist_text$& &&&
11376        &$dnslist_value$&
11377 .vindex "&$dnslist_domain$&"
11378 .vindex "&$dnslist_matched$&"
11379 .vindex "&$dnslist_text$&"
11380 .vindex "&$dnslist_value$&"
11381 .cindex "black list (DNS)"
11382 When a DNS (black) list lookup succeeds, these variables are set to contain
11383 the following data from the lookup: the list's domain name, the key that was
11384 looked up, the contents of any associated TXT record, and the value from the
11385 main A record. See section &<<SECID204>>& for more details.
11386
11387 .vitem &$domain$&
11388 .vindex "&$domain$&"
11389 When an address is being routed, or delivered on its own, this variable
11390 contains the domain. Uppercase letters in the domain are converted into lower
11391 case for &$domain$&.
11392
11393 Global address rewriting happens when a message is received, so the value of
11394 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11395 is set during user filtering, but not during system filtering, because a
11396 message may have many recipients and the system filter is called just once.
11397
11398 When more than one address is being delivered at once (for example, several
11399 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11400 have the same domain. Transports can be restricted to handling only one domain
11401 at a time if the value of &$domain$& is required at transport time &-- this is
11402 the default for local transports. For further details of the environment in
11403 which local transports are run, see chapter &<<CHAPenvironment>>&.
11404
11405 .oindex "&%delay_warning_condition%&"
11406 At the end of a delivery, if all deferred addresses have the same domain, it is
11407 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11408
11409 The &$domain$& variable is also used in some other circumstances:
11410
11411 .ilist
11412 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11413 the recipient address. The domain of the &'sender'& address is in
11414 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11415 normally set during the running of the MAIL ACL. However, if the sender address
11416 is verified with a callout during the MAIL ACL, the sender domain is placed in
11417 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11418 the &(smtp)& transport.
11419
11420 .next
11421 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11422 &$domain$& contains the domain portion of the address that is being rewritten;
11423 it can be used in the expansion of the replacement address, for example, to
11424 rewrite domains by file lookup.
11425
11426 .next
11427 With one important exception, whenever a domain list is being scanned,
11428 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11429 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11430 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11431 that, in a RCPT ACL, the sender domain list can be dependent on the
11432 recipient domain (which is what is in &$domain$& at this time).
11433
11434 .next
11435 .cindex "ETRN" "value of &$domain$&"
11436 .oindex "&%smtp_etrn_command%&"
11437 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11438 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11439 .endlist
11440
11441
11442 .vitem &$domain_data$&
11443 .vindex "&$domain_data$&"
11444 When the &%domains%& option on a router matches a domain by
11445 means of a lookup, the data read by the lookup is available during the running
11446 of the router as &$domain_data$&. In addition, if the driver routes the
11447 address to a transport, the value is available in that transport. If the
11448 transport is handling multiple addresses, the value from the first address is
11449 used.
11450
11451 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11452 domain by means of a lookup. The data read by the lookup is available during
11453 the rest of the ACL statement. In all other situations, this variable expands
11454 to nothing.
11455
11456 .vitem &$exim_gid$&
11457 .vindex "&$exim_gid$&"
11458 This variable contains the numerical value of the Exim group id.
11459
11460 .vitem &$exim_path$&
11461 .vindex "&$exim_path$&"
11462 This variable contains the path to the Exim binary.
11463
11464 .vitem &$exim_uid$&
11465 .vindex "&$exim_uid$&"
11466 This variable contains the numerical value of the Exim user id.
11467
11468 .new
11469 .vitem &$exim_version$&
11470 .vindex "&$exim_version$&"
11471 This variable contains the version string of the Exim build.
11472 The first character is a major version number, currently 4.
11473 Then after a dot, the next group of digits is a minor version number.
11474 There may be other characters following the minor version.
11475 .wen
11476
11477 .vitem &$found_extension$&
11478 .vindex "&$found_extension$&"
11479 This variable is available when Exim is compiled with the
11480 content-scanning extension and the obsolete &%demime%& condition. For details,
11481 see section &<<SECTdemimecond>>&.
11482
11483 .vitem &$header_$&<&'name'&>
11484 This is not strictly an expansion variable. It is expansion syntax for
11485 inserting the message header line with the given name. Note that the name must
11486 be terminated by colon or white space, because it may contain a wide variety of
11487 characters. Note also that braces must &'not'& be used.
11488
11489 .vitem &$headers_added$&
11490 .vindex "&$headers_added$&"
11491 Within an ACL this variable contains the headers added so far by
11492 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11493 The headers are a newline-separated list.
11494
11495 .vitem &$home$&
11496 .vindex "&$home$&"
11497 When the &%check_local_user%& option is set for a router, the user's home
11498 directory is placed in &$home$& when the check succeeds. In particular, this
11499 means it is set during the running of users' filter files. A router may also
11500 explicitly set a home directory for use by a transport; this can be overridden
11501 by a setting on the transport itself.
11502
11503 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11504 of the environment variable HOME.
11505
11506 .vitem &$host$&
11507 .vindex "&$host$&"
11508 If a router assigns an address to a transport (any transport), and passes a
11509 list of hosts with the address, the value of &$host$& when the transport starts
11510 to run is the name of the first host on the list. Note that this applies both
11511 to local and remote transports.
11512
11513 .cindex "transport" "filter"
11514 .cindex "filter" "transport filter"
11515 For the &(smtp)& transport, if there is more than one host, the value of
11516 &$host$& changes as the transport works its way through the list. In
11517 particular, when the &(smtp)& transport is expanding its options for encryption
11518 using TLS, or for specifying a transport filter (see chapter
11519 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11520 is connected.
11521
11522 When used in the client part of an authenticator configuration (see chapter
11523 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11524 client is connected.
11525
11526
11527 .vitem &$host_address$&
11528 .vindex "&$host_address$&"
11529 This variable is set to the remote host's IP address whenever &$host$& is set
11530 for a remote connection. It is also set to the IP address that is being checked
11531 when the &%ignore_target_hosts%& option is being processed.
11532
11533 .vitem &$host_data$&
11534 .vindex "&$host_data$&"
11535 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11536 result of the lookup is made available in the &$host_data$& variable. This
11537 allows you, for example, to do things like this:
11538 .code
11539 deny  hosts = net-lsearch;/some/file
11540 message = $host_data
11541 .endd
11542 .vitem &$host_lookup_deferred$&
11543 .cindex "host name" "lookup, failure of"
11544 .vindex "&$host_lookup_deferred$&"
11545 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11546 message comes from a remote host and there is an attempt to look up the host's
11547 name from its IP address, and the attempt is not successful, one of these
11548 variables is set to &"1"&.
11549
11550 .ilist
11551 If the lookup receives a definite negative response (for example, a DNS lookup
11552 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11553
11554 .next
11555 If there is any kind of problem during the lookup, such that Exim cannot
11556 tell whether or not the host name is defined (for example, a timeout for a DNS
11557 lookup), &$host_lookup_deferred$& is set to &"1"&.
11558 .endlist ilist
11559
11560 Looking up a host's name from its IP address consists of more than just a
11561 single reverse lookup. Exim checks that a forward lookup of at least one of the
11562 names it receives from a reverse lookup yields the original IP address. If this
11563 is not the case, Exim does not accept the looked up name(s), and
11564 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11565 IP address (for example, the existence of a PTR record in the DNS) is not
11566 sufficient on its own for the success of a host name lookup. If the reverse
11567 lookup succeeds, but there is a lookup problem such as a timeout when checking
11568 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11569 &"1"&. See also &$sender_host_name$&.
11570
11571 .vitem &$host_lookup_failed$&
11572 .vindex "&$host_lookup_failed$&"
11573 See &$host_lookup_deferred$&.
11574
11575 .vitem &$host_port$&
11576 .vindex "&$host_port$&"
11577 This variable is set to the remote host's TCP port whenever &$host$& is set
11578 for an outbound connection.
11579
11580
11581 .vitem &$inode$&
11582 .vindex "&$inode$&"
11583 The only time this variable is set is while expanding the &%directory_file%&
11584 option in the &(appendfile)& transport. The variable contains the inode number
11585 of the temporary file which is about to be renamed. It can be used to construct
11586 a unique name for the file.
11587
11588 .vitem &$interface_address$&
11589 .vindex "&$interface_address$&"
11590 This is an obsolete name for &$received_ip_address$&.
11591
11592 .vitem &$interface_port$&
11593 .vindex "&$interface_port$&"
11594 This is an obsolete name for &$received_port$&.
11595
11596 .vitem &$item$&
11597 .vindex "&$item$&"
11598 This variable is used during the expansion of &*forall*& and &*forany*&
11599 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11600 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11601 empty.
11602
11603 .vitem &$ldap_dn$&
11604 .vindex "&$ldap_dn$&"
11605 This variable, which is available only when Exim is compiled with LDAP support,
11606 contains the DN from the last entry in the most recently successful LDAP
11607 lookup.
11608
11609 .vitem &$load_average$&
11610 .vindex "&$load_average$&"
11611 This variable contains the system load average, multiplied by 1000 so that it
11612 is an integer. For example, if the load average is 0.21, the value of the
11613 variable is 210. The value is recomputed every time the variable is referenced.
11614
11615 .vitem &$local_part$&
11616 .vindex "&$local_part$&"
11617 When an address is being routed, or delivered on its own, this
11618 variable contains the local part. When a number of addresses are being
11619 delivered together (for example, multiple RCPT commands in an SMTP
11620 session), &$local_part$& is not set.
11621
11622 Global address rewriting happens when a message is received, so the value of
11623 &$local_part$& during routing and delivery is the value after rewriting.
11624 &$local_part$& is set during user filtering, but not during system filtering,
11625 because a message may have many recipients and the system filter is called just
11626 once.
11627
11628 .vindex "&$local_part_prefix$&"
11629 .vindex "&$local_part_suffix$&"
11630 If a local part prefix or suffix has been recognized, it is not included in the
11631 value of &$local_part$& during routing and subsequent delivery. The values of
11632 any prefix or suffix are in &$local_part_prefix$& and
11633 &$local_part_suffix$&, respectively.
11634
11635 When a message is being delivered to a file, pipe, or autoreply transport as a
11636 result of aliasing or forwarding, &$local_part$& is set to the local part of
11637 the parent address, not to the file name or command (see &$address_file$& and
11638 &$address_pipe$&).
11639
11640 When an ACL is running for a RCPT command, &$local_part$& contains the
11641 local part of the recipient address.
11642
11643 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11644 &$local_part$& contains the local part of the address that is being rewritten;
11645 it can be used in the expansion of the replacement address, for example.
11646
11647 In all cases, all quoting is removed from the local part. For example, for both
11648 the addresses
11649 .code
11650 "abc:xyz"@test.example
11651 abc\:xyz@test.example
11652 .endd
11653 the value of &$local_part$& is
11654 .code
11655 abc:xyz
11656 .endd
11657 If you use &$local_part$& to create another address, you should always wrap it
11658 inside a quoting operator. For example, in a &(redirect)& router you could
11659 have:
11660 .code
11661 data = ${quote_local_part:$local_part}@new.domain.example
11662 .endd
11663 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11664 to process local parts in a case-dependent manner in a router, you can set the
11665 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11666
11667 .vitem &$local_part_data$&
11668 .vindex "&$local_part_data$&"
11669 When the &%local_parts%& option on a router matches a local part by means of a
11670 lookup, the data read by the lookup is available during the running of the
11671 router as &$local_part_data$&. In addition, if the driver routes the address
11672 to a transport, the value is available in that transport. If the transport is
11673 handling multiple addresses, the value from the first address is used.
11674
11675 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11676 matches a local part by means of a lookup. The data read by the lookup is
11677 available during the rest of the ACL statement. In all other situations, this
11678 variable expands to nothing.
11679
11680 .vitem &$local_part_prefix$&
11681 .vindex "&$local_part_prefix$&"
11682 When an address is being routed or delivered, and a
11683 specific prefix for the local part was recognized, it is available in this
11684 variable, having been removed from &$local_part$&.
11685
11686 .vitem &$local_part_suffix$&
11687 .vindex "&$local_part_suffix$&"
11688 When an address is being routed or delivered, and a
11689 specific suffix for the local part was recognized, it is available in this
11690 variable, having been removed from &$local_part$&.
11691
11692 .vitem &$local_scan_data$&
11693 .vindex "&$local_scan_data$&"
11694 This variable contains the text returned by the &[local_scan()]& function when
11695 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11696
11697 .vitem &$local_user_gid$&
11698 .vindex "&$local_user_gid$&"
11699 See &$local_user_uid$&.
11700
11701 .vitem &$local_user_uid$&
11702 .vindex "&$local_user_uid$&"
11703 This variable and &$local_user_gid$& are set to the uid and gid after the
11704 &%check_local_user%& router precondition succeeds. This means that their values
11705 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11706 and &%condition%&), for the &%address_data%& expansion, and for any
11707 router-specific expansions. At all other times, the values in these variables
11708 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11709
11710 .vitem &$localhost_number$&
11711 .vindex "&$localhost_number$&"
11712 This contains the expanded value of the
11713 &%localhost_number%& option. The expansion happens after the main options have
11714 been read.
11715
11716 .vitem &$log_inodes$&
11717 .vindex "&$log_inodes$&"
11718 The number of free inodes in the disk partition where Exim's
11719 log files are being written. The value is recalculated whenever the variable is
11720 referenced. If the relevant file system does not have the concept of inodes,
11721 the value of is -1. See also the &%check_log_inodes%& option.
11722
11723 .vitem &$log_space$&
11724 .vindex "&$log_space$&"
11725 The amount of free space (as a number of kilobytes) in the disk
11726 partition where Exim's log files are being written. The value is recalculated
11727 whenever the variable is referenced. If the operating system does not have the
11728 ability to find the amount of free space (only true for experimental systems),
11729 the space value is -1. See also the &%check_log_space%& option.
11730
11731
11732 .vitem &$lookup_dnssec_authenticated$&
11733 .vindex "&$lookup_dnssec_authenticated$&"
11734 This variable is set after a DNS lookup done by
11735 a dnsdb lookup expansion, dnslookup router or smtp transport.
11736 .cindex "DNS" "DNSSEC"
11737 It will be empty if &(DNSSEC)& was not requested,
11738 &"no"& if the result was not labelled as authenticated data
11739 and &"yes"& if it was.
11740
11741 .vitem &$mailstore_basename$&
11742 .vindex "&$mailstore_basename$&"
11743 This variable is set only when doing deliveries in &"mailstore"& format in the
11744 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11745 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11746 contains the basename of the files that are being written, that is, the name
11747 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11748 variable is empty.
11749
11750 .vitem &$malware_name$&
11751 .vindex "&$malware_name$&"
11752 This variable is available when Exim is compiled with the
11753 content-scanning extension. It is set to the name of the virus that was found
11754 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11755
11756 .vitem &$max_received_linelength$&
11757 .vindex "&$max_received_linelength$&"
11758 .cindex "maximum" "line length"
11759 .cindex "line length" "maximum"
11760 This variable contains the number of bytes in the longest line that was
11761 received as part of the message, not counting the line termination
11762 character(s).
11763
11764 .vitem &$message_age$&
11765 .cindex "message" "age of"
11766 .vindex "&$message_age$&"
11767 This variable is set at the start of a delivery attempt to contain the number
11768 of seconds since the message was received. It does not change during a single
11769 delivery attempt.
11770
11771 .vitem &$message_body$&
11772 .cindex "body of message" "expansion variable"
11773 .cindex "message body" "in expansion"
11774 .cindex "binary zero" "in message body"
11775 .vindex "&$message_body$&"
11776 .oindex "&%message_body_visible%&"
11777 This variable contains the initial portion of a message's body while it is
11778 being delivered, and is intended mainly for use in filter files. The maximum
11779 number of characters of the body that are put into the variable is set by the
11780 &%message_body_visible%& configuration option; the default is 500.
11781
11782 .oindex "&%message_body_newlines%&"
11783 By default, newlines are converted into spaces in &$message_body$&, to make it
11784 easier to search for phrases that might be split over a line break. However,
11785 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11786 zeros are always converted into spaces.
11787
11788 .vitem &$message_body_end$&
11789 .cindex "body of message" "expansion variable"
11790 .cindex "message body" "in expansion"
11791 .vindex "&$message_body_end$&"
11792 This variable contains the final portion of a message's
11793 body while it is being delivered. The format and maximum size are as for
11794 &$message_body$&.
11795
11796 .vitem &$message_body_size$&
11797 .cindex "body of message" "size"
11798 .cindex "message body" "size"
11799 .vindex "&$message_body_size$&"
11800 When a message is being delivered, this variable contains the size of the body
11801 in bytes. The count starts from the character after the blank line that
11802 separates the body from the header. Newlines are included in the count. See
11803 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11804
11805 .vitem &$message_exim_id$&
11806 .vindex "&$message_exim_id$&"
11807 When a message is being received or delivered, this variable contains the
11808 unique message id that is generated and used by Exim to identify the message.
11809 An id is not created for a message until after its header has been successfully
11810 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11811 line; it is the local id that Exim assigns to the message, for example:
11812 &`1BXTIK-0001yO-VA`&.
11813
11814 .vitem &$message_headers$&
11815 .vindex &$message_headers$&
11816 This variable contains a concatenation of all the header lines when a message
11817 is being processed, except for lines added by routers or transports. The header
11818 lines are separated by newline characters. Their contents are decoded in the
11819 same way as a header line that is inserted by &%bheader%&.
11820
11821 .vitem &$message_headers_raw$&
11822 .vindex &$message_headers_raw$&
11823 This variable is like &$message_headers$& except that no processing of the
11824 contents of header lines is done.
11825
11826 .vitem &$message_id$&
11827 This is an old name for &$message_exim_id$&. It is now deprecated.
11828
11829 .vitem &$message_linecount$&
11830 .vindex "&$message_linecount$&"
11831 This variable contains the total number of lines in the header and body of the
11832 message. Compare &$body_linecount$&, which is the count for the body only.
11833 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11834 number of lines received. Before delivery happens (that is, before filters,
11835 routers, and transports run) the count is increased to include the
11836 &'Received:'& header line that Exim standardly adds, and also any other header
11837 lines that are added by ACLs. The blank line that separates the message header
11838 from the body is not counted.
11839
11840 As with the special case of &$message_size$&, during the expansion of the
11841 appendfile transport's maildir_tag option in maildir format, the value of
11842 &$message_linecount$& is the precise size of the number of newlines in the
11843 file that has been written (minus one for the blank line between the
11844 header and the body).
11845
11846 Here is an example of the use of this variable in a DATA ACL:
11847 .code
11848 deny message   = Too many lines in message header
11849      condition = \
11850       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11851 .endd
11852 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11853 message has not yet been received.
11854
11855 .vitem &$message_size$&
11856 .cindex "size" "of message"
11857 .cindex "message" "size"
11858 .vindex "&$message_size$&"
11859 When a message is being processed, this variable contains its size in bytes. In
11860 most cases, the size includes those headers that were received with the
11861 message, but not those (such as &'Envelope-to:'&) that are added to individual
11862 deliveries as they are written. However, there is one special case: during the
11863 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11864 doing a delivery in maildir format, the value of &$message_size$& is the
11865 precise size of the file that has been written. See also
11866 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11867
11868 .cindex "RCPT" "value of &$message_size$&"
11869 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11870 contains the size supplied on the MAIL command, or -1 if no size was given. The
11871 value may not, of course, be truthful.
11872
11873 .vitem &$mime_$&&'xxx'&
11874 A number of variables whose names start with &$mime$& are
11875 available when Exim is compiled with the content-scanning extension. For
11876 details, see section &<<SECTscanmimepart>>&.
11877
11878 .vitem "&$n0$& &-- &$n9$&"
11879 These variables are counters that can be incremented by means
11880 of the &%add%& command in filter files.
11881
11882 .vitem &$original_domain$&
11883 .vindex "&$domain$&"
11884 .vindex "&$original_domain$&"
11885 When a top-level address is being processed for delivery, this contains the
11886 same value as &$domain$&. However, if a &"child"& address (for example,
11887 generated by an alias, forward, or filter file) is being processed, this
11888 variable contains the domain of the original address (lower cased). This
11889 differs from &$parent_domain$& only when there is more than one level of
11890 aliasing or forwarding. When more than one address is being delivered in a
11891 single transport run, &$original_domain$& is not set.
11892
11893 If a new address is created by means of a &%deliver%& command in a system
11894 filter, it is set up with an artificial &"parent"& address. This has the local
11895 part &'system-filter'& and the default qualify domain.
11896
11897 .vitem &$original_local_part$&
11898 .vindex "&$local_part$&"
11899 .vindex "&$original_local_part$&"
11900 When a top-level address is being processed for delivery, this contains the
11901 same value as &$local_part$&, unless a prefix or suffix was removed from the
11902 local part, because &$original_local_part$& always contains the full local
11903 part. When a &"child"& address (for example, generated by an alias, forward, or
11904 filter file) is being processed, this variable contains the full local part of
11905 the original address.
11906
11907 If the router that did the redirection processed the local part
11908 case-insensitively, the value in &$original_local_part$& is in lower case.
11909 This variable differs from &$parent_local_part$& only when there is more than
11910 one level of aliasing or forwarding. When more than one address is being
11911 delivered in a single transport run, &$original_local_part$& is not set.
11912
11913 If a new address is created by means of a &%deliver%& command in a system
11914 filter, it is set up with an artificial &"parent"& address. This has the local
11915 part &'system-filter'& and the default qualify domain.
11916
11917 .vitem &$originator_gid$&
11918 .cindex "gid (group id)" "of originating user"
11919 .cindex "sender" "gid"
11920 .vindex "&$caller_gid$&"
11921 .vindex "&$originator_gid$&"
11922 This variable contains the value of &$caller_gid$& that was set when the
11923 message was received. For messages received via the command line, this is the
11924 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11925 normally the gid of the Exim user.
11926
11927 .vitem &$originator_uid$&
11928 .cindex "uid (user id)" "of originating user"
11929 .cindex "sender" "uid"
11930 .vindex "&$caller_uid$&"
11931 .vindex "&$originaltor_uid$&"
11932 The value of &$caller_uid$& that was set when the message was received. For
11933 messages received via the command line, this is the uid of the sending user.
11934 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11935 user.
11936
11937 .vitem &$parent_domain$&
11938 .vindex "&$parent_domain$&"
11939 This variable is similar to &$original_domain$& (see
11940 above), except that it refers to the immediately preceding parent address.
11941
11942 .vitem &$parent_local_part$&
11943 .vindex "&$parent_local_part$&"
11944 This variable is similar to &$original_local_part$&
11945 (see above), except that it refers to the immediately preceding parent address.
11946
11947 .vitem &$pid$&
11948 .cindex "pid (process id)" "of current process"
11949 .vindex "&$pid$&"
11950 This variable contains the current process id.
11951
11952 .vitem &$pipe_addresses$&
11953 .cindex "filter" "transport filter"
11954 .cindex "transport" "filter"
11955 .vindex "&$pipe_addresses$&"
11956 This is not an expansion variable, but is mentioned here because the string
11957 &`$pipe_addresses`& is handled specially in the command specification for the
11958 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11959 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11960 It cannot be used in general expansion strings, and provokes an &"unknown
11961 variable"& error if encountered.
11962
11963 .vitem &$primary_hostname$&
11964 .vindex "&$primary_hostname$&"
11965 This variable contains the value set by &%primary_hostname%& in the
11966 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11967 a single-component name, Exim calls &[gethostbyname()]& (or
11968 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11969 qualified host name. See also &$smtp_active_hostname$&.
11970
11971
11972 .vitem &$prvscheck_address$&
11973 This variable is used in conjunction with the &%prvscheck%& expansion item,
11974 which is described in sections &<<SECTexpansionitems>>& and
11975 &<<SECTverifyPRVS>>&.
11976
11977 .vitem &$prvscheck_keynum$&
11978 This variable is used in conjunction with the &%prvscheck%& expansion item,
11979 which is described in sections &<<SECTexpansionitems>>& and
11980 &<<SECTverifyPRVS>>&.
11981
11982 .vitem &$prvscheck_result$&
11983 This variable is used in conjunction with the &%prvscheck%& expansion item,
11984 which is described in sections &<<SECTexpansionitems>>& and
11985 &<<SECTverifyPRVS>>&.
11986
11987 .vitem &$qualify_domain$&
11988 .vindex "&$qualify_domain$&"
11989 The value set for the &%qualify_domain%& option in the configuration file.
11990
11991 .vitem &$qualify_recipient$&
11992 .vindex "&$qualify_recipient$&"
11993 The value set for the &%qualify_recipient%& option in the configuration file,
11994 or if not set, the value of &$qualify_domain$&.
11995
11996 .vitem &$rcpt_count$&
11997 .vindex "&$rcpt_count$&"
11998 When a message is being received by SMTP, this variable contains the number of
11999 RCPT commands received for the current message. If this variable is used in a
12000 RCPT ACL, its value includes the current command.
12001
12002 .vitem &$rcpt_defer_count$&
12003 .vindex "&$rcpt_defer_count$&"
12004 .cindex "4&'xx'& responses" "count of"
12005 When a message is being received by SMTP, this variable contains the number of
12006 RCPT commands in the current message that have previously been rejected with a
12007 temporary (4&'xx'&) response.
12008
12009 .vitem &$rcpt_fail_count$&
12010 .vindex "&$rcpt_fail_count$&"
12011 When a message is being received by SMTP, this variable contains the number of
12012 RCPT commands in the current message that have previously been rejected with a
12013 permanent (5&'xx'&) response.
12014
12015 .vitem &$received_count$&
12016 .vindex "&$received_count$&"
12017 This variable contains the number of &'Received:'& header lines in the message,
12018 including the one added by Exim (so its value is always greater than zero). It
12019 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12020 delivering.
12021
12022 .vitem &$received_for$&
12023 .vindex "&$received_for$&"
12024 If there is only a single recipient address in an incoming message, this
12025 variable contains that address when the &'Received:'& header line is being
12026 built. The value is copied after recipient rewriting has happened, but before
12027 the &[local_scan()]& function is run.
12028
12029 .vitem &$received_ip_address$&
12030 .vindex "&$received_ip_address$&"
12031 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12032 variable is set to the address of the local IP interface, and &$received_port$&
12033 is set to the local port number. (The remote IP address and port are in
12034 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12035 the port value is -1 unless it has been set using the &%-oMi%& command line
12036 option.
12037
12038 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12039 could be used, for example, to make the file name for a TLS certificate depend
12040 on which interface and/or port is being used for the incoming connection. The
12041 values of &$received_ip_address$& and &$received_port$& are saved with any
12042 messages that are received, thus making these variables available at delivery
12043 time.
12044 For outbound connections see &$sending_ip_address$&.
12045
12046 .vitem &$received_port$&
12047 .vindex "&$received_port$&"
12048 See &$received_ip_address$&.
12049
12050 .vitem &$received_protocol$&
12051 .vindex "&$received_protocol$&"
12052 When a message is being processed, this variable contains the name of the
12053 protocol by which it was received. Most of the names used by Exim are defined
12054 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12055 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12056 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12057 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12058 connection and the client was successfully authenticated.
12059
12060 Exim uses the protocol name &"smtps"& for the case when encryption is
12061 automatically set up on connection without the use of STARTTLS (see
12062 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12063 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12064 where the client initially uses EHLO, sets up an encrypted connection using
12065 STARTTLS, and then uses HELO afterwards.
12066
12067 The &%-oMr%& option provides a way of specifying a custom protocol name for
12068 messages that are injected locally by trusted callers. This is commonly used to
12069 identify messages that are being re-injected after some kind of scanning.
12070
12071 .vitem &$received_time$&
12072 .vindex "&$received_time$&"
12073 This variable contains the date and time when the current message was received,
12074 as a number of seconds since the start of the Unix epoch.
12075
12076 .vitem &$recipient_data$&
12077 .vindex "&$recipient_data$&"
12078 This variable is set after an indexing lookup success in an ACL &%recipients%&
12079 condition. It contains the data from the lookup, and the value remains set
12080 until the next &%recipients%& test. Thus, you can do things like this:
12081 .display
12082 &`require recipients  = cdb*@;/some/file`&
12083 &`deny    `&&'some further test involving'& &`$recipient_data`&
12084 .endd
12085 &*Warning*&: This variable is set only when a lookup is used as an indexing
12086 method in the address list, using the semicolon syntax as in the example above.
12087 The variable is not set for a lookup that is used as part of the string
12088 expansion that all such lists undergo before being interpreted.
12089
12090 .vitem &$recipient_verify_failure$&
12091 .vindex "&$recipient_verify_failure$&"
12092 In an ACL, when a recipient verification fails, this variable contains
12093 information about the failure. It is set to one of the following words:
12094
12095 .ilist
12096 &"qualify"&: The address was unqualified (no domain), and the message
12097 was neither local nor came from an exempted host.
12098
12099 .next
12100 &"route"&: Routing failed.
12101
12102 .next
12103 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12104 or before the MAIL command (that is, on initial connection, HELO, or
12105 MAIL).
12106
12107 .next
12108 &"recipient"&: The RCPT command in a callout was rejected.
12109 .next
12110
12111 &"postmaster"&: The postmaster check in a callout was rejected.
12112 .endlist
12113
12114 The main use of this variable is expected to be to distinguish between
12115 rejections of MAIL and rejections of RCPT.
12116
12117 .vitem &$recipients$&
12118 .vindex "&$recipients$&"
12119 This variable contains a list of envelope recipients for a message. A comma and
12120 a space separate the addresses in the replacement text. However, the variable
12121 is not generally available, to prevent exposure of Bcc recipients in
12122 unprivileged users' filter files. You can use &$recipients$& only in these
12123 cases:
12124
12125 .olist
12126 In a system filter file.
12127 .next
12128 In the ACLs associated with the DATA command and with non-SMTP messages, that
12129 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12130 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12131 &%acl_not_smtp_mime%&.
12132 .next
12133 From within a &[local_scan()]& function.
12134 .endlist
12135
12136
12137 .vitem &$recipients_count$&
12138 .vindex "&$recipients_count$&"
12139 When a message is being processed, this variable contains the number of
12140 envelope recipients that came with the message. Duplicates are not excluded
12141 from the count. While a message is being received over SMTP, the number
12142 increases for each accepted recipient. It can be referenced in an ACL.
12143
12144
12145 .vitem &$regex_match_string$&
12146 .vindex "&$regex_match_string$&"
12147 This variable is set to contain the matching regular expression after a
12148 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12149
12150
12151 .vitem &$reply_address$&
12152 .vindex "&$reply_address$&"
12153 When a message is being processed, this variable contains the contents of the
12154 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12155 contents of the &'From:'& header line. Apart from the removal of leading
12156 white space, the value is not processed in any way. In particular, no RFC 2047
12157 decoding or character code translation takes place.
12158
12159 .vitem &$return_path$&
12160 .vindex "&$return_path$&"
12161 When a message is being delivered, this variable contains the return path &--
12162 the sender field that will be sent as part of the envelope. It is not enclosed
12163 in <> characters. At the start of routing an address, &$return_path$& has the
12164 same value as &$sender_address$&, but if, for example, an incoming message to a
12165 mailing list has been expanded by a router which specifies a different address
12166 for bounce messages, &$return_path$& subsequently contains the new bounce
12167 address, whereas &$sender_address$& always contains the original sender address
12168 that was received with the message. In other words, &$sender_address$& contains
12169 the incoming envelope sender, and &$return_path$& contains the outgoing
12170 envelope sender.
12171
12172 .vitem &$return_size_limit$&
12173 .vindex "&$return_size_limit$&"
12174 This is an obsolete name for &$bounce_return_size_limit$&.
12175
12176 .vitem &$router_name$&
12177 .cindex "router" "name"
12178 .cindex "name" "of router"
12179 .vindex "&$router_name$&"
12180 During the running of a router this variable contains its name.
12181
12182 .vitem &$runrc$&
12183 .cindex "return code" "from &%run%& expansion"
12184 .vindex "&$runrc$&"
12185 This variable contains the return code from a command that is run by the
12186 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12187 assume the order in which option values are expanded, except for those
12188 preconditions whose order of testing is documented. Therefore, you cannot
12189 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12190 another.
12191
12192 .vitem &$self_hostname$&
12193 .oindex "&%self%&" "value of host name"
12194 .vindex "&$self_hostname$&"
12195 When an address is routed to a supposedly remote host that turns out to be the
12196 local host, what happens is controlled by the &%self%& generic router option.
12197 One of its values causes the address to be passed to another router. When this
12198 happens, &$self_hostname$& is set to the name of the local host that the
12199 original router encountered. In other circumstances its contents are null.
12200
12201 .vitem &$sender_address$&
12202 .vindex "&$sender_address$&"
12203 When a message is being processed, this variable contains the sender's address
12204 that was received in the message's envelope. The case of letters in the address
12205 is retained, in both the local part and the domain. For bounce messages, the
12206 value of this variable is the empty string. See also &$return_path$&.
12207
12208 .vitem &$sender_address_data$&
12209 .vindex "&$address_data$&"
12210 .vindex "&$sender_address_data$&"
12211 If &$address_data$& is set when the routers are called from an ACL to verify a
12212 sender address, the final value is preserved in &$sender_address_data$&, to
12213 distinguish it from data from a recipient address. The value does not persist
12214 after the end of the current ACL statement. If you want to preserve it for
12215 longer, you can save it in an ACL variable.
12216
12217 .vitem &$sender_address_domain$&
12218 .vindex "&$sender_address_domain$&"
12219 The domain portion of &$sender_address$&.
12220
12221 .vitem &$sender_address_local_part$&
12222 .vindex "&$sender_address_local_part$&"
12223 The local part portion of &$sender_address$&.
12224
12225 .vitem &$sender_data$&
12226 .vindex "&$sender_data$&"
12227 This variable is set after a lookup success in an ACL &%senders%& condition or
12228 in a router &%senders%& option. It contains the data from the lookup, and the
12229 value remains set until the next &%senders%& test. Thus, you can do things like
12230 this:
12231 .display
12232 &`require senders      = cdb*@;/some/file`&
12233 &`deny    `&&'some further test involving'& &`$sender_data`&
12234 .endd
12235 &*Warning*&: This variable is set only when a lookup is used as an indexing
12236 method in the address list, using the semicolon syntax as in the example above.
12237 The variable is not set for a lookup that is used as part of the string
12238 expansion that all such lists undergo before being interpreted.
12239
12240 .vitem &$sender_fullhost$&
12241 .vindex "&$sender_fullhost$&"
12242 When a message is received from a remote host, this variable contains the host
12243 name and IP address in a single string. It ends with the IP address in square
12244 brackets, followed by a colon and a port number if the logging of ports is
12245 enabled. The format of the rest of the string depends on whether the host
12246 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12247 looking up its IP address. (Looking up the IP address can be forced by the
12248 &%host_lookup%& option, independent of verification.) A plain host name at the
12249 start of the string is a verified host name; if this is not present,
12250 verification either failed or was not requested. A host name in parentheses is
12251 the argument of a HELO or EHLO command. This is omitted if it is identical to
12252 the verified host name or to the host's IP address in square brackets.
12253
12254 .new
12255 .vitem &$sender_helo_dnssec$&
12256 .vindex "&$sender_helo_dnssec$&"
12257 This boolean variable is true if a successful HELO verification was
12258 .cindex "DNS" "DNSSEC"
12259 done using DNS information the resolver library stated was authenticatied data.
12260 .wen
12261
12262 .vitem &$sender_helo_name$&
12263 .vindex "&$sender_helo_name$&"
12264 When a message is received from a remote host that has issued a HELO or EHLO
12265 command, the argument of that command is placed in this variable. It is also
12266 set if HELO or EHLO is used when a message is received using SMTP locally via
12267 the &%-bs%& or &%-bS%& options.
12268
12269 .vitem &$sender_host_address$&
12270 .vindex "&$sender_host_address$&"
12271 When a message is received from a remote host using SMTP,
12272 this variable contains that
12273 host's IP address. For locally non-SMTP submitted messages, it is empty.
12274
12275 .vitem &$sender_host_authenticated$&
12276 .vindex "&$sender_host_authenticated$&"
12277 This variable contains the name (not the public name) of the authenticator
12278 driver that successfully authenticated the client from which the message was
12279 received. It is empty if there was no successful authentication. See also
12280 &$authenticated_id$&.
12281
12282 .vitem &$sender_host_dnssec$&
12283 .vindex "&$sender_host_dnssec$&"
12284 If an attempt to populate &$sender_host_name$& has been made
12285 (by reference, &%hosts_lookup%& or
12286 otherwise) then this boolean will have been set true if, and only if, the
12287 resolver library states that both
12288 the reverse and forward DNS were authenticated data.  At all
12289 other times, this variable is false.
12290
12291 .cindex "DNS" "DNSSEC"
12292 It is likely that you will need to coerce DNSSEC support on in the resolver
12293 library, by setting:
12294 .code
12295 dns_dnssec_ok = 1
12296 .endd
12297
12298 Exim does not perform DNSSEC validation itself, instead leaving that to a
12299 validating resolver (eg, unbound, or bind with suitable configuration).
12300
12301 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12302 mechanism in the list, then this variable will be false.
12303
12304
12305 .vitem &$sender_host_name$&
12306 .vindex "&$sender_host_name$&"
12307 When a message is received from a remote host, this variable contains the
12308 host's name as obtained by looking up its IP address. For messages received by
12309 other means, this variable is empty.
12310
12311 .vindex "&$host_lookup_failed$&"
12312 If the host name has not previously been looked up, a reference to
12313 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12314 A looked up name is accepted only if it leads back to the original IP address
12315 via a forward lookup. If either the reverse or the forward lookup fails to find
12316 any data, or if the forward lookup does not yield the original IP address,
12317 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12318
12319 .vindex "&$host_lookup_deferred$&"
12320 However, if either of the lookups cannot be completed (for example, there is a
12321 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12322 &$host_lookup_failed$& remains set to &"0"&.
12323
12324 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12325 host name again if there is a subsequent reference to &$sender_host_name$&
12326 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12327 is set to &"1"&.
12328
12329 Exim does not automatically look up every calling host's name. If you want
12330 maximum efficiency, you should arrange your configuration so that it avoids
12331 these lookups altogether. The lookup happens only if one or more of the
12332 following are true:
12333
12334 .ilist
12335 A string containing &$sender_host_name$& is expanded.
12336 .next
12337 The calling host matches the list in &%host_lookup%&. In the default
12338 configuration, this option is set to *, so it must be changed if lookups are
12339 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12340 .next
12341 Exim needs the host name in order to test an item in a host list. The items
12342 that require this are described in sections &<<SECThoslispatnam>>& and
12343 &<<SECThoslispatnamsk>>&.
12344 .next
12345 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12346 In this case, the host name is required to compare with the name quoted in any
12347 EHLO or HELO commands that the client issues.
12348 .next
12349 The remote host issues a EHLO or HELO command that quotes one of the
12350 domains in &%helo_lookup_domains%&. The default value of this option is
12351 . ==== As this is a nested list, any displays it contains must be indented
12352 . ==== as otherwise they are too far to the left.
12353 .code
12354   helo_lookup_domains = @ : @[]
12355 .endd
12356 which causes a lookup if a remote host (incorrectly) gives the server's name or
12357 IP address in an EHLO or HELO command.
12358 .endlist
12359
12360
12361 .vitem &$sender_host_port$&
12362 .vindex "&$sender_host_port$&"
12363 When a message is received from a remote host, this variable contains the port
12364 number that was used on the remote host.
12365
12366 .vitem &$sender_ident$&
12367 .vindex "&$sender_ident$&"
12368 When a message is received from a remote host, this variable contains the
12369 identification received in response to an RFC 1413 request. When a message has
12370 been received locally, this variable contains the login name of the user that
12371 called Exim.
12372
12373 .vitem &$sender_rate_$&&'xxx'&
12374 A number of variables whose names begin &$sender_rate_$& are set as part of the
12375 &%ratelimit%& ACL condition. Details are given in section
12376 &<<SECTratelimiting>>&.
12377
12378 .vitem &$sender_rcvhost$&
12379 .cindex "DNS" "reverse lookup"
12380 .cindex "reverse DNS lookup"
12381 .vindex "&$sender_rcvhost$&"
12382 This is provided specifically for use in &'Received:'& headers. It starts with
12383 either the verified host name (as obtained from a reverse DNS lookup) or, if
12384 there is no verified host name, the IP address in square brackets. After that
12385 there may be text in parentheses. When the first item is a verified host name,
12386 the first thing in the parentheses is the IP address in square brackets,
12387 followed by a colon and a port number if port logging is enabled. When the
12388 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12389 the parentheses.
12390
12391 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12392 was used and its argument was not identical to the real host name or IP
12393 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12394 all three items are present in the parentheses, a newline and tab are inserted
12395 into the string, to improve the formatting of the &'Received:'& header.
12396
12397 .vitem &$sender_verify_failure$&
12398 .vindex "&$sender_verify_failure$&"
12399 In an ACL, when a sender verification fails, this variable contains information
12400 about the failure. The details are the same as for
12401 &$recipient_verify_failure$&.
12402
12403 .vitem &$sending_ip_address$&
12404 .vindex "&$sending_ip_address$&"
12405 This variable is set whenever an outgoing SMTP connection to another host has
12406 been set up. It contains the IP address of the local interface that is being
12407 used. This is useful if a host that has more than one IP address wants to take
12408 on different personalities depending on which one is being used. For incoming
12409 connections, see &$received_ip_address$&.
12410
12411 .vitem &$sending_port$&
12412 .vindex "&$sending_port$&"
12413 This variable is set whenever an outgoing SMTP connection to another host has
12414 been set up. It contains the local port that is being used. For incoming
12415 connections, see &$received_port$&.
12416
12417 .vitem &$smtp_active_hostname$&
12418 .vindex "&$smtp_active_hostname$&"
12419 During an incoming SMTP session, this variable contains the value of the active
12420 host name, as specified by the &%smtp_active_hostname%& option. The value of
12421 &$smtp_active_hostname$& is saved with any message that is received, so its
12422 value can be consulted during routing and delivery.
12423
12424 .vitem &$smtp_command$&
12425 .vindex "&$smtp_command$&"
12426 During the processing of an incoming SMTP command, this variable contains the
12427 entire command. This makes it possible to distinguish between HELO and EHLO in
12428 the HELO ACL, and also to distinguish between commands such as these:
12429 .code
12430 MAIL FROM:<>
12431 MAIL FROM: <>
12432 .endd
12433 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12434 command, the address in &$smtp_command$& is the original address before any
12435 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12436 the address after SMTP-time rewriting.
12437
12438 .vitem &$smtp_command_argument$&
12439 .cindex "SMTP" "command, argument for"
12440 .vindex "&$smtp_command_argument$&"
12441 While an ACL is running to check an SMTP command, this variable contains the
12442 argument, that is, the text that follows the command name, with leading white
12443 space removed. Following the introduction of &$smtp_command$&, this variable is
12444 somewhat redundant, but is retained for backwards compatibility.
12445
12446 .vitem &$smtp_count_at_connection_start$&
12447 .vindex "&$smtp_count_at_connection_start$&"
12448 This variable is set greater than zero only in processes spawned by the Exim
12449 daemon for handling incoming SMTP connections. The name is deliberately long,
12450 in order to emphasize what the contents are. When the daemon accepts a new
12451 connection, it increments this variable. A copy of the variable is passed to
12452 the child process that handles the connection, but its value is fixed, and
12453 never changes. It is only an approximation of how many incoming connections
12454 there actually are, because many other connections may come and go while a
12455 single connection is being processed. When a child process terminates, the
12456 daemon decrements its copy of the variable.
12457
12458 .vitem "&$sn0$& &-- &$sn9$&"
12459 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12460 that were current at the end of the system filter file. This allows a system
12461 filter file to set values that can be tested in users' filter files. For
12462 example, a system filter could set a value indicating how likely it is that a
12463 message is junk mail.
12464
12465 .vitem &$spam_$&&'xxx'&
12466 A number of variables whose names start with &$spam$& are available when Exim
12467 is compiled with the content-scanning extension. For details, see section
12468 &<<SECTscanspamass>>&.
12469
12470
12471 .vitem &$spool_directory$&
12472 .vindex "&$spool_directory$&"
12473 The name of Exim's spool directory.
12474
12475 .vitem &$spool_inodes$&
12476 .vindex "&$spool_inodes$&"
12477 The number of free inodes in the disk partition where Exim's spool files are
12478 being written. The value is recalculated whenever the variable is referenced.
12479 If the relevant file system does not have the concept of inodes, the value of
12480 is -1. See also the &%check_spool_inodes%& option.
12481
12482 .vitem &$spool_space$&
12483 .vindex "&$spool_space$&"
12484 The amount of free space (as a number of kilobytes) in the disk partition where
12485 Exim's spool files are being written. The value is recalculated whenever the
12486 variable is referenced. If the operating system does not have the ability to
12487 find the amount of free space (only true for experimental systems), the space
12488 value is -1. For example, to check in an ACL that there is at least 50
12489 megabytes free on the spool, you could write:
12490 .code
12491 condition = ${if > {$spool_space}{50000}}
12492 .endd
12493 See also the &%check_spool_space%& option.
12494
12495
12496 .vitem &$thisaddress$&
12497 .vindex "&$thisaddress$&"
12498 This variable is set only during the processing of the &%foranyaddress%&
12499 command in a filter file. Its use is explained in the description of that
12500 command, which can be found in the separate document entitled &'Exim's
12501 interfaces to mail filtering'&.
12502
12503 .vitem &$tls_in_bits$&
12504 .vindex "&$tls_in_bits$&"
12505 Contains an approximation of the TLS cipher's bit-strength
12506 on the inbound connection; the meaning of
12507 this depends upon the TLS implementation used.
12508 If TLS has not been negotiated, the value will be 0.
12509 The value of this is automatically fed into the Cyrus SASL authenticator
12510 when acting as a server, to specify the "external SSF" (a SASL term).
12511
12512 The deprecated &$tls_bits$& variable refers to the inbound side
12513 except when used in the context of an outbound SMTP delivery, when it refers to
12514 the outbound.
12515
12516 .vitem &$tls_out_bits$&
12517 .vindex "&$tls_out_bits$&"
12518 Contains an approximation of the TLS cipher's bit-strength
12519 on an outbound SMTP connection; the meaning of
12520 this depends upon the TLS implementation used.
12521 If TLS has not been negotiated, the value will be 0.
12522
12523 .vitem &$tls_in_ourcert$&
12524 .vindex "&$tls_in_ourcert$&"
12525 This variable refers to the certificate presented to the peer of an
12526 inbound connection when the message was received.
12527 It is only useful as the argument of a
12528 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12529 or a &%def%& condition.
12530
12531 .vitem &$tls_in_peercert$&
12532 .vindex "&$tls_in_peercert$&"
12533 This variable refers to the certificate presented by the peer of an
12534 inbound connection when the message was received.
12535 It is only useful as the argument of a
12536 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12537 or a &%def%& condition.
12538 If certificate verification fails it may refer to a failing chain element
12539 which is not the leaf.
12540
12541 .vitem &$tls_out_ourcert$&
12542 .vindex "&$tls_out_ourcert$&"
12543 This variable refers to the certificate presented to the peer of an
12544 outbound connection.  It is only useful as the argument of a
12545 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12546 or a &%def%& condition.
12547
12548 .vitem &$tls_out_peercert$&
12549 .vindex "&$tls_out_peercert$&"
12550 This variable refers to the certificate presented by the peer of an
12551 outbound connection.  It is only useful as the argument of a
12552 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12553 or a &%def%& condition.
12554 If certificate verification fails it may refer to a failing chain element
12555 which is not the leaf.
12556
12557 .vitem &$tls_in_certificate_verified$&
12558 .vindex "&$tls_in_certificate_verified$&"
12559 This variable is set to &"1"& if a TLS certificate was verified when the
12560 message was received, and &"0"& otherwise.
12561
12562 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12563 except when used in the context of an outbound SMTP delivery, when it refers to
12564 the outbound.
12565
12566 .vitem &$tls_out_certificate_verified$&
12567 .vindex "&$tls_out_certificate_verified$&"
12568 This variable is set to &"1"& if a TLS certificate was verified when an
12569 outbound SMTP connection was made,
12570 and &"0"& otherwise.
12571
12572 .vitem &$tls_in_cipher$&
12573 .vindex "&$tls_in_cipher$&"
12574 .vindex "&$tls_cipher$&"
12575 When a message is received from a remote host over an encrypted SMTP
12576 connection, this variable is set to the cipher suite that was negotiated, for
12577 example DES-CBC3-SHA. In other circumstances, in particular, for message
12578 received over unencrypted connections, the variable is empty. Testing
12579 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12580 non-encrypted connections during ACL processing.
12581
12582 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12583 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12584 becomes the same as &$tls_out_cipher$&.
12585
12586 .vitem &$tls_out_cipher$&
12587 .vindex "&$tls_out_cipher$&"
12588 This variable is
12589 cleared before any outgoing SMTP connection is made,
12590 and then set to the outgoing cipher suite if one is negotiated. See chapter
12591 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12592 details of the &(smtp)& transport.
12593
12594 .vitem &$tls_in_ocsp$&
12595 .vindex "&$tls_in_ocsp$&"
12596 When a message is received from a remote client connection
12597 the result of any OCSP request from the client is encoded in this variable:
12598 .code
12599 0 OCSP proof was not requested (default value)
12600 1 No response to request
12601 2 Response not verified
12602 3 Verification failed
12603 4 Verification succeeded
12604 .endd
12605
12606 .vitem &$tls_out_ocsp$&
12607 .vindex "&$tls_out_ocsp$&"
12608 When a message is sent to a remote host connection
12609 the result of any OCSP request made is encoded in this variable.
12610 See &$tls_in_ocsp$& for values.
12611
12612 .vitem &$tls_in_peerdn$&
12613 .vindex "&$tls_in_peerdn$&"
12614 .vindex "&$tls_peerdn$&"
12615 When a message is received from a remote host over an encrypted SMTP
12616 connection, and Exim is configured to request a certificate from the client,
12617 the value of the Distinguished Name of the certificate is made available in the
12618 &$tls_in_peerdn$& during subsequent processing.
12619 If certificate verification fails it may refer to a failing chain element
12620 which is not the leaf.
12621
12622 The deprecated &$tls_peerdn$& variable refers to the inbound side
12623 except when used in the context of an outbound SMTP delivery, when it refers to
12624 the outbound.
12625
12626 .vitem &$tls_out_peerdn$&
12627 .vindex "&$tls_out_peerdn$&"
12628 When a message is being delivered to a remote host over an encrypted SMTP
12629 connection, and Exim is configured to request a certificate from the server,
12630 the value of the Distinguished Name of the certificate is made available in the
12631 &$tls_out_peerdn$& during subsequent processing.
12632 If certificate verification fails it may refer to a failing chain element
12633 which is not the leaf.
12634
12635 .vitem &$tls_in_sni$&
12636 .vindex "&$tls_in_sni$&"
12637 .vindex "&$tls_sni$&"
12638 .cindex "TLS" "Server Name Indication"
12639 When a TLS session is being established, if the client sends the Server
12640 Name Indication extension, the value will be placed in this variable.
12641 If the variable appears in &%tls_certificate%& then this option and
12642 some others, described in &<<SECTtlssni>>&,
12643 will be re-expanded early in the TLS session, to permit
12644 a different certificate to be presented (and optionally a different key to be
12645 used) to the client, based upon the value of the SNI extension.
12646
12647 The deprecated &$tls_sni$& 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_sni$&
12652 .vindex "&$tls_out_sni$&"
12653 .cindex "TLS" "Server Name Indication"
12654 During outbound
12655 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12656 the transport.
12657
12658 .vitem &$tod_bsdinbox$&
12659 .vindex "&$tod_bsdinbox$&"
12660 The time of day and the date, in the format required for BSD-style mailbox
12661 files, for example: Thu Oct 17 17:14:09 1995.
12662
12663 .vitem &$tod_epoch$&
12664 .vindex "&$tod_epoch$&"
12665 The time and date as a number of seconds since the start of the Unix epoch.
12666
12667 .vitem &$tod_epoch_l$&
12668 .vindex "&$tod_epoch_l$&"
12669 The time and date as a number of microseconds since the start of the Unix epoch.
12670
12671 .vitem &$tod_full$&
12672 .vindex "&$tod_full$&"
12673 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12674 +0100. The timezone is always given as a numerical offset from UTC, with
12675 positive values used for timezones that are ahead (east) of UTC, and negative
12676 values for those that are behind (west).
12677
12678 .vitem &$tod_log$&
12679 .vindex "&$tod_log$&"
12680 The time and date in the format used for writing Exim's log files, for example:
12681 1995-10-12 15:32:29, but without a timezone.
12682
12683 .vitem &$tod_logfile$&
12684 .vindex "&$tod_logfile$&"
12685 This variable contains the date in the format yyyymmdd. This is the format that
12686 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12687 flag.
12688
12689 .vitem &$tod_zone$&
12690 .vindex "&$tod_zone$&"
12691 This variable contains the numerical value of the local timezone, for example:
12692 -0500.
12693
12694 .vitem &$tod_zulu$&
12695 .vindex "&$tod_zulu$&"
12696 This variable contains the UTC date and time in &"Zulu"& format, as specified
12697 by ISO 8601, for example: 20030221154023Z.
12698
12699 .vitem &$transport_name$&
12700 .cindex "transport" "name"
12701 .cindex "name" "of transport"
12702 .vindex "&$transport_name$&"
12703 During the running of a transport, this variable contains its name.
12704
12705 .vitem &$value$&
12706 .vindex "&$value$&"
12707 This variable contains the result of an expansion lookup, extraction operation,
12708 or external command, as described above. It is also used during a
12709 &*reduce*& expansion.
12710
12711 .vitem &$verify_mode$&
12712 .vindex "&$verify_mode$&"
12713 While a router or transport is being run in verify mode
12714 or for cutthrough delivery,
12715 contains "S" for sender-verification or "R" for recipient-verification.
12716 Otherwise, empty.
12717
12718 .vitem &$version_number$&
12719 .vindex "&$version_number$&"
12720 The version number of Exim.
12721
12722 .vitem &$warn_message_delay$&
12723 .vindex "&$warn_message_delay$&"
12724 This variable is set only during the creation of a message warning about a
12725 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12726
12727 .vitem &$warn_message_recipients$&
12728 .vindex "&$warn_message_recipients$&"
12729 This variable is set only during the creation of a message warning about a
12730 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12731 .endlist
12732 .ecindex IIDstrexp
12733
12734
12735
12736 . ////////////////////////////////////////////////////////////////////////////
12737 . ////////////////////////////////////////////////////////////////////////////
12738
12739 .chapter "Embedded Perl" "CHAPperl"
12740 .scindex IIDperl "Perl" "calling from Exim"
12741 Exim can be built to include an embedded Perl interpreter. When this is done,
12742 Perl subroutines can be called as part of the string expansion process. To make
12743 use of the Perl support, you need version 5.004 or later of Perl installed on
12744 your system. To include the embedded interpreter in the Exim binary, include
12745 the line
12746 .code
12747 EXIM_PERL = perl.o
12748 .endd
12749 in your &_Local/Makefile_& and then build Exim in the normal way.
12750
12751
12752 .section "Setting up so Perl can be used" "SECID85"
12753 .oindex "&%perl_startup%&"
12754 Access to Perl subroutines is via a global configuration option called
12755 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12756 no &%perl_startup%& option in the Exim configuration file then no Perl
12757 interpreter is started and there is almost no overhead for Exim (since none of
12758 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12759 option then the associated value is taken to be Perl code which is executed in
12760 a newly created Perl interpreter.
12761
12762 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12763 need backslashes before any characters to escape special meanings. The option
12764 should usually be something like
12765 .code
12766 perl_startup = do '/etc/exim.pl'
12767 .endd
12768 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12769 use from Exim. Exim can be configured either to start up a Perl interpreter as
12770 soon as it is entered, or to wait until the first time it is needed. Starting
12771 the interpreter at the beginning ensures that it is done while Exim still has
12772 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12773 fact used in a particular run. Also, note that this does not mean that Exim is
12774 necessarily running as root when Perl is called at a later time. By default,
12775 the interpreter is started only when it is needed, but this can be changed in
12776 two ways:
12777
12778 .ilist
12779 .oindex "&%perl_at_start%&"
12780 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12781 a startup when Exim is entered.
12782 .next
12783 The command line option &%-ps%& also requests a startup when Exim is entered,
12784 overriding the setting of &%perl_at_start%&.
12785 .endlist
12786
12787 There is also a command line option &%-pd%& (for delay) which suppresses the
12788 initial startup, even if &%perl_at_start%& is set.
12789
12790
12791 .section "Calling Perl subroutines" "SECID86"
12792 When the configuration file includes a &%perl_startup%& option you can make use
12793 of the string expansion item to call the Perl subroutines that are defined
12794 by the &%perl_startup%& code. The operator is used in any of the following
12795 forms:
12796 .code
12797 ${perl{foo}}
12798 ${perl{foo}{argument}}
12799 ${perl{foo}{argument1}{argument2} ... }
12800 .endd
12801 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12802 arguments may be passed. Passing more than this results in an expansion failure
12803 with an error message of the form
12804 .code
12805 Too many arguments passed to Perl subroutine "foo" (max is 8)
12806 .endd
12807 The return value of the Perl subroutine is evaluated in a scalar context before
12808 it is passed back to Exim to be inserted into the expanded string. If the
12809 return value is &'undef'&, the expansion is forced to fail in the same way as
12810 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12811 by obeying Perl's &%die%& function, the expansion fails with the error message
12812 that was passed to &%die%&.
12813
12814
12815 .section "Calling Exim functions from Perl" "SECID87"
12816 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12817 is available to call back into Exim's string expansion function. For example,
12818 the Perl code
12819 .code
12820 my $lp = Exim::expand_string('$local_part');
12821 .endd
12822 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12823 Note those are single quotes and not double quotes to protect against
12824 &$local_part$& being interpolated as a Perl variable.
12825
12826 If the string expansion is forced to fail by a &"fail"& item, the result of
12827 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12828 expansion string, the Perl call from the original expansion string fails with
12829 an appropriate error message, in the same way as if &%die%& were used.
12830
12831 .cindex "debugging" "from embedded Perl"
12832 .cindex "log" "writing from embedded Perl"
12833 Two other Exim functions are available for use from within Perl code.
12834 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12835 debugging is enabled. If you want a newline at the end, you must supply it.
12836 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12837 timestamp. In this case, you should not supply a terminating newline.
12838
12839
12840 .section "Use of standard output and error by Perl" "SECID88"
12841 .cindex "Perl" "standard output and error"
12842 You should not write to the standard error or output streams from within your
12843 Perl code, as it is not defined how these are set up. In versions of Exim
12844 before 4.50, it is possible for the standard output or error to refer to the
12845 SMTP connection during message reception via the daemon. Writing to this stream
12846 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12847 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12848 avoided, but the output is lost.
12849
12850 .cindex "Perl" "use of &%warn%&"
12851 The Perl &%warn%& statement writes to the standard error stream by default.
12852 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12853 you have no control. When Exim starts up the Perl interpreter, it arranges for
12854 output from the &%warn%& statement to be written to the Exim main log. You can
12855 change this by including appropriate Perl magic somewhere in your Perl code.
12856 For example, to discard &%warn%& output completely, you need this:
12857 .code
12858 $SIG{__WARN__} = sub { };
12859 .endd
12860 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12861 example, the code for the subroutine is empty, so it does nothing, but you can
12862 include any Perl code that you like. The text of the &%warn%& message is passed
12863 as the first subroutine argument.
12864 .ecindex IIDperl
12865
12866
12867 . ////////////////////////////////////////////////////////////////////////////
12868 . ////////////////////////////////////////////////////////////////////////////
12869
12870 .chapter "Starting the daemon and the use of network interfaces" &&&
12871          "CHAPinterfaces" &&&
12872          "Starting the daemon"
12873 .cindex "daemon" "starting"
12874 .cindex "interface" "listening"
12875 .cindex "network interface"
12876 .cindex "interface" "network"
12877 .cindex "IP address" "for listening"
12878 .cindex "daemon" "listening IP addresses"
12879 .cindex "TCP/IP" "setting listening interfaces"
12880 .cindex "TCP/IP" "setting listening ports"
12881 A host that is connected to a TCP/IP network may have one or more physical
12882 hardware network interfaces. Each of these interfaces may be configured as one
12883 or more &"logical"& interfaces, which are the entities that a program actually
12884 works with. Each of these logical interfaces is associated with an IP address.
12885 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12886 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12887 knowledge about the host's interfaces for use in three different circumstances:
12888
12889 .olist
12890 When a listening daemon is started, Exim needs to know which interfaces
12891 and ports to listen on.
12892 .next
12893 When Exim is routing an address, it needs to know which IP addresses
12894 are associated with local interfaces. This is required for the correct
12895 processing of MX lists by removing the local host and others with the
12896 same or higher priority values. Also, Exim needs to detect cases
12897 when an address is routed to an IP address that in fact belongs to the
12898 local host. Unless the &%self%& router option or the &%allow_localhost%&
12899 option of the smtp transport is set (as appropriate), this is treated
12900 as an error situation.
12901 .next
12902 When Exim connects to a remote host, it may need to know which interface to use
12903 for the outgoing connection.
12904 .endlist
12905
12906
12907 Exim's default behaviour is likely to be appropriate in the vast majority
12908 of cases. If your host has only one interface, and you want all its IP
12909 addresses to be treated in the same way, and you are using only the
12910 standard SMTP port, you should not need to take any special action. The
12911 rest of this chapter does not apply to you.
12912
12913 In a more complicated situation you may want to listen only on certain
12914 interfaces, or on different ports, and for this reason there are a number of
12915 options that can be used to influence Exim's behaviour. The rest of this
12916 chapter describes how they operate.
12917
12918 When a message is received over TCP/IP, the interface and port that were
12919 actually used are set in &$received_ip_address$& and &$received_port$&.
12920
12921
12922
12923 .section "Starting a listening daemon" "SECID89"
12924 When a listening daemon is started (by means of the &%-bd%& command line
12925 option), the interfaces and ports on which it listens are controlled by the
12926 following options:
12927
12928 .ilist
12929 &%daemon_smtp_ports%& contains a list of default ports
12930 or service names.
12931 (For backward compatibility, this option can also be specified in the singular.)
12932 .next
12933 &%local_interfaces%& contains list of interface IP addresses on which to
12934 listen. Each item may optionally also specify a port.
12935 .endlist
12936
12937 The default list separator in both cases is a colon, but this can be changed as
12938 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12939 it is usually best to change the separator to avoid having to double all the
12940 colons. For example:
12941 .code
12942 local_interfaces = <; 127.0.0.1 ; \
12943                       192.168.23.65 ; \
12944                       ::1 ; \
12945                       3ffe:ffff:836f::fe86:a061
12946 .endd
12947 There are two different formats for specifying a port along with an IP address
12948 in &%local_interfaces%&:
12949
12950 .olist
12951 The port is added onto the address with a dot separator. For example, to listen
12952 on port 1234 on two different IP addresses:
12953 .code
12954 local_interfaces = <; 192.168.23.65.1234 ; \
12955                       3ffe:ffff:836f::fe86:a061.1234
12956 .endd
12957 .next
12958 The IP address is enclosed in square brackets, and the port is added
12959 with a colon separator, for example:
12960 .code
12961 local_interfaces = <; [192.168.23.65]:1234 ; \
12962                       [3ffe:ffff:836f::fe86:a061]:1234
12963 .endd
12964 .endlist
12965
12966 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12967 default setting contains just one port:
12968 .code
12969 daemon_smtp_ports = smtp
12970 .endd
12971 If more than one port is listed, each interface that does not have its own port
12972 specified listens on all of them. Ports that are listed in
12973 &%daemon_smtp_ports%& can be identified either by name (defined in
12974 &_/etc/services_&) or by number. However, when ports are given with individual
12975 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12976
12977
12978
12979 .section "Special IP listening addresses" "SECID90"
12980 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12981 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12982 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12983 instead of setting up separate listening sockets for each interface. The
12984 default value of &%local_interfaces%& is
12985 .code
12986 local_interfaces = 0.0.0.0
12987 .endd
12988 when Exim is built without IPv6 support; otherwise it is:
12989 .code
12990 local_interfaces = <; ::0 ; 0.0.0.0
12991 .endd
12992 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
12993
12994
12995
12996 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
12997 The &%-oX%& command line option can be used to override the values of
12998 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
12999 instance. Another way of doing this would be to use macros and the &%-D%&
13000 option. However, &%-oX%& can be used by any admin user, whereas modification of
13001 the runtime configuration by &%-D%& is allowed only when the caller is root or
13002 exim.
13003
13004 The value of &%-oX%& is a list of items. The default colon separator can be
13005 changed in the usual way if required. If there are any items that do not
13006 contain dots or colons (that is, are not IP addresses), the value of
13007 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13008 items that do contain dots or colons, the value of &%local_interfaces%& is
13009 replaced by those items. Thus, for example,
13010 .code
13011 -oX 1225
13012 .endd
13013 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13014 whereas
13015 .code
13016 -oX 192.168.34.5.1125
13017 .endd
13018 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13019 (However, since &%local_interfaces%& now contains no items without ports, the
13020 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13021
13022
13023
13024 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13025 .cindex "ssmtp protocol"
13026 .cindex "smtps protocol"
13027 .cindex "SMTP" "ssmtp protocol"
13028 .cindex "SMTP" "smtps protocol"
13029 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13030 before the STARTTLS command was standardized for SMTP. Some legacy clients
13031 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13032 list of port numbers or service names,
13033 connections to those ports must use SSMTP. The most
13034 common use of this option is expected to be
13035 .code
13036 tls_on_connect_ports = 465
13037 .endd
13038 because 465 is the usual port number used by the legacy clients. There is also
13039 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13040 this way when a daemon is started.
13041
13042 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13043 daemon to listen on those ports. You must still specify them in
13044 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13045 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13046 connections via the daemon.)
13047
13048
13049
13050
13051 .section "IPv6 address scopes" "SECID92"
13052 .cindex "IPv6" "address scopes"
13053 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13054 can, in principle, have the same link-local IPv6 address on different
13055 interfaces. Thus, additional information is needed, over and above the IP
13056 address, to distinguish individual interfaces. A convention of using a
13057 percent sign followed by something (often the interface name) has been
13058 adopted in some cases, leading to addresses like this:
13059 .code
13060 fe80::202:b3ff:fe03:45c1%eth0
13061 .endd
13062 To accommodate this usage, a percent sign followed by an arbitrary string is
13063 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13064 to convert a textual IPv6 address for actual use. This function recognizes the
13065 percent convention in operating systems that support it, and it processes the
13066 address appropriately. Unfortunately, some older libraries have problems with
13067 &[getaddrinfo()]&. If
13068 .code
13069 IPV6_USE_INET_PTON=yes
13070 .endd
13071 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13072 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13073 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13074 function.) Of course, this means that the additional functionality of
13075 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13076
13077 .section "Disabling IPv6" "SECID93"
13078 .cindex "IPv6" "disabling"
13079 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13080 run on a host whose kernel does not support IPv6. The binary will fall back to
13081 using IPv4, but it may waste resources looking up AAAA records, and trying to
13082 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13083 .oindex "&%disable_ipv6%&"
13084 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13085 activities take place. AAAA records are never looked up, and any IPv6 addresses
13086 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13087 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13088 to handle IPv6 literal addresses.
13089
13090 On the other hand, when IPv6 is in use, there may be times when you want to
13091 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13092 option to globally suppress the lookup of AAAA records for specified domains,
13093 and you can use the &%ignore_target_hosts%& generic router option to ignore
13094 IPv6 addresses in an individual router.
13095
13096
13097
13098 .section "Examples of starting a listening daemon" "SECID94"
13099 The default case in an IPv6 environment is
13100 .code
13101 daemon_smtp_ports = smtp
13102 local_interfaces = <; ::0 ; 0.0.0.0
13103 .endd
13104 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13105 Either one or two sockets may be used, depending on the characteristics of
13106 the TCP/IP stack. (This is complicated and messy; for more information,
13107 read the comments in the &_daemon.c_& source file.)
13108
13109 To specify listening on ports 25 and 26 on all interfaces:
13110 .code
13111 daemon_smtp_ports = 25 : 26
13112 .endd
13113 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13114 .code
13115 local_interfaces = <; ::0.25     ; ::0.26 \
13116                       0.0.0.0.25 ; 0.0.0.0.26
13117 .endd
13118 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13119 IPv4 loopback address only:
13120 .code
13121 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13122 .endd
13123 To specify listening on the default port on specific interfaces only:
13124 .code
13125 local_interfaces = 10.0.0.67 : 192.168.34.67
13126 .endd
13127 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13128
13129
13130
13131 .section "Recognizing the local host" "SECTreclocipadd"
13132 The &%local_interfaces%& option is also used when Exim needs to determine
13133 whether or not an IP address refers to the local host. That is, the IP
13134 addresses of all the interfaces on which a daemon is listening are always
13135 treated as local.
13136
13137 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13138 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13139 available interfaces from the operating system, and extracts the relevant
13140 (that is, IPv4 or IPv6) addresses to use for checking.
13141
13142 Some systems set up large numbers of virtual interfaces in order to provide
13143 many virtual web servers. In this situation, you may want to listen for
13144 email on only a few of the available interfaces, but nevertheless treat all
13145 interfaces as local when routing. You can do this by setting
13146 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13147 &"all"& wildcard values. These addresses are recognized as local, but are not
13148 used for listening. Consider this example:
13149 .code
13150 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13151                       192.168.53.235 ; \
13152                       3ffe:2101:12:1:a00:20ff:fe86:a061
13153
13154 extra_local_interfaces = <; ::0 ; 0.0.0.0
13155 .endd
13156 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13157 address, but all available interface addresses are treated as local when
13158 Exim is routing.
13159
13160 In some environments the local host name may be in an MX list, but with an IP
13161 address that is not assigned to any local interface. In other cases it may be
13162 desirable to treat other host names as if they referred to the local host. Both
13163 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13164 This contains host names rather than IP addresses. When a host is referenced
13165 during routing, either via an MX record or directly, it is treated as the local
13166 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13167 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13168
13169
13170
13171 .section "Delivering to a remote host" "SECID95"
13172 Delivery to a remote host is handled by the smtp transport. By default, it
13173 allows the system's TCP/IP functions to choose which interface to use (if
13174 there is more than one) when connecting to a remote host. However, the
13175 &%interface%& option can be set to specify which interface is used. See the
13176 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13177 details.
13178
13179
13180
13181
13182 . ////////////////////////////////////////////////////////////////////////////
13183 . ////////////////////////////////////////////////////////////////////////////
13184
13185 .chapter "Main configuration" "CHAPmainconfig"
13186 .scindex IIDconfima "configuration file" "main section"
13187 .scindex IIDmaiconf "main configuration"
13188 The first part of the run time configuration file contains three types of item:
13189
13190 .ilist
13191 Macro definitions: These lines start with an upper case letter. See section
13192 &<<SECTmacrodefs>>& for details of macro processing.
13193 .next
13194 Named list definitions: These lines start with one of the words &"domainlist"&,
13195 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13196 section &<<SECTnamedlists>>&.
13197 .next
13198 Main configuration settings: Each setting occupies one line of the file
13199 (with possible continuations). If any setting is preceded by the word
13200 &"hide"&, the &%-bP%& command line option displays its value to admin users
13201 only. See section &<<SECTcos>>& for a description of the syntax of these option
13202 settings.
13203 .endlist
13204
13205 This chapter specifies all the main configuration options, along with their
13206 types and default values. For ease of finding a particular option, they appear
13207 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13208 are now so many options, they are first listed briefly in functional groups, as
13209 an aid to finding the name of the option you are looking for. Some options are
13210 listed in more than one group.
13211
13212 .section "Miscellaneous" "SECID96"
13213 .table2
13214 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13215 .row &%disable_ipv6%&                "do no IPv6 processing"
13216 .row &%keep_malformed%&              "for broken files &-- should not happen"
13217 .row &%localhost_number%&            "for unique message ids in clusters"
13218 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13219 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13220 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13221 .row &%print_topbitchars%&           "top-bit characters are printing"
13222 .row &%timezone%&                    "force time zone"
13223 .endtable
13224
13225
13226 .section "Exim parameters" "SECID97"
13227 .table2
13228 .row &%exim_group%&                  "override compiled-in value"
13229 .row &%exim_path%&                   "override compiled-in value"
13230 .row &%exim_user%&                   "override compiled-in value"
13231 .row &%primary_hostname%&            "default from &[uname()]&"
13232 .row &%split_spool_directory%&       "use multiple directories"
13233 .row &%spool_directory%&             "override compiled-in value"
13234 .endtable
13235
13236
13237
13238 .section "Privilege controls" "SECID98"
13239 .table2
13240 .row &%admin_groups%&                "groups that are Exim admin users"
13241 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13242 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13243 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13244 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13245 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13246 .row &%never_users%&                 "do not run deliveries as these"
13247 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13248 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13249 .row &%trusted_groups%&              "groups that are trusted"
13250 .row &%trusted_users%&               "users that are trusted"
13251 .endtable
13252
13253
13254
13255 .section "Logging" "SECID99"
13256 .table2
13257 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13258 .row &%log_file_path%&               "override compiled-in value"
13259 .row &%log_selector%&                "set/unset optional logging"
13260 .row &%log_timezone%&                "add timezone to log lines"
13261 .row &%message_logs%&                "create per-message logs"
13262 .row &%preserve_message_logs%&       "after message completion"
13263 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13264 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13265 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13266 .row &%syslog_facility%&             "set syslog &""facility""& field"
13267 .row &%syslog_processname%&          "set syslog &""ident""& field"
13268 .row &%syslog_timestamp%&            "timestamp syslog lines"
13269 .row &%write_rejectlog%&             "control use of message log"
13270 .endtable
13271
13272
13273
13274 .section "Frozen messages" "SECID100"
13275 .table2
13276 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13277 .row &%freeze_tell%&                 "send message when freezing"
13278 .row &%move_frozen_messages%&        "to another directory"
13279 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13280 .endtable
13281
13282
13283
13284 .section "Data lookups" "SECID101"
13285 .table2
13286 .row &%ibase_servers%&               "InterBase servers"
13287 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13288 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13289 .row &%ldap_cert_file%&              "client cert file for LDAP"
13290 .row &%ldap_cert_key%&               "client key file for LDAP"
13291 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13292 .row &%ldap_default_servers%&        "used if no server in query"
13293 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13294 .row &%ldap_start_tls%&              "require TLS within LDAP"
13295 .row &%ldap_version%&                "set protocol version"
13296 .row &%lookup_open_max%&             "lookup files held open"
13297 .row &%mysql_servers%&               "default MySQL servers"
13298 .row &%oracle_servers%&              "Oracle servers"
13299 .row &%pgsql_servers%&               "default PostgreSQL servers"
13300 .row &%sqlite_lock_timeout%&         "as it says"
13301 .endtable
13302
13303
13304
13305 .section "Message ids" "SECID102"
13306 .table2
13307 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13308 .row &%message_id_header_text%&      "ditto"
13309 .endtable
13310
13311
13312
13313 .section "Embedded Perl Startup" "SECID103"
13314 .table2
13315 .row &%perl_at_start%&               "always start the interpreter"
13316 .row &%perl_startup%&                "code to obey when starting Perl"
13317 .endtable
13318
13319
13320
13321 .section "Daemon" "SECID104"
13322 .table2
13323 .row &%daemon_smtp_ports%&           "default ports"
13324 .row &%daemon_startup_retries%&      "number of times to retry"
13325 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13326 .row &%extra_local_interfaces%&      "not necessarily listened on"
13327 .row &%local_interfaces%&            "on which to listen, with optional ports"
13328 .row &%pid_file_path%&               "override compiled-in value"
13329 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13330 .endtable
13331
13332
13333
13334 .section "Resource control" "SECID105"
13335 .table2
13336 .row &%check_log_inodes%&            "before accepting a message"
13337 .row &%check_log_space%&             "before accepting a message"
13338 .row &%check_spool_inodes%&          "before accepting a message"
13339 .row &%check_spool_space%&           "before accepting a message"
13340 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13341 .row &%queue_only_load%&             "queue incoming if load high"
13342 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13343 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13344 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13345 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13346 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13347 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13348 .row &%smtp_accept_max_per_connection%& "messages per connection"
13349 .row &%smtp_accept_max_per_host%&    "connections from one host"
13350 .row &%smtp_accept_queue%&           "queue mail if more connections"
13351 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13352                                            connection"
13353 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13354 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13355 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13356 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13357 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13358 .endtable
13359
13360
13361
13362 .section "Policy controls" "SECID106"
13363 .table2
13364 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13365 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13366 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13367 .row &%acl_smtp_auth%&               "ACL for AUTH"
13368 .row &%acl_smtp_connect%&            "ACL for connection"
13369 .row &%acl_smtp_data%&               "ACL for DATA"
13370 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13371 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13372 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13373 .row &%acl_smtp_expn%&               "ACL for EXPN"
13374 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13375 .row &%acl_smtp_mail%&               "ACL for MAIL"
13376 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13377 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13378 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13379 .row &%acl_smtp_predata%&            "ACL for start of data"
13380 .row &%acl_smtp_quit%&               "ACL for QUIT"
13381 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13382 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13383 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13384 .row &%av_scanner%&                  "specify virus scanner"
13385 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13386                                       words""&"
13387 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13388 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13389 .row &%header_maxsize%&              "total size of message header"
13390 .row &%header_line_maxsize%&         "individual header line limit"
13391 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13392 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13393 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13394 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13395 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13396 .row &%host_lookup%&                 "host name looked up for these hosts"
13397 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13398 .row &%host_reject_connection%&      "reject connection from these hosts"
13399 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13400 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13401 .row &%message_size_limit%&          "for all messages"
13402 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13403 .row &%spamd_address%&               "set interface to SpamAssassin"
13404 .row &%strict_acl_vars%&             "object to unset ACL variables"
13405 .endtable
13406
13407
13408
13409 .section "Callout cache" "SECID107"
13410 .table2
13411 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13412                                          item"
13413 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13414                                          item"
13415 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13416 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13417 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13418 .endtable
13419
13420
13421
13422 .section "TLS" "SECID108"
13423 .table2
13424 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13425 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13426 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13427 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13428 .row &%tls_certificate%&             "location of server certificate"
13429 .row &%tls_crl%&                     "certificate revocation list"
13430 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13431 .row &%tls_dhparam%&                 "DH parameters for server"
13432 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13433 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13434 .row &%tls_privatekey%&              "location of server private key"
13435 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13436 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13437 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13438 .row &%tls_verify_certificates%&     "expected client certificates"
13439 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13440 .endtable
13441
13442
13443
13444 .section "Local user handling" "SECID109"
13445 .table2
13446 .row &%finduser_retries%&            "useful in NIS environments"
13447 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13448 .row &%gecos_pattern%&               "ditto"
13449 .row &%max_username_length%&         "for systems that truncate"
13450 .row &%unknown_login%&               "used when no login name found"
13451 .row &%unknown_username%&            "ditto"
13452 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13453 .row &%uucp_from_sender%&            "ditto"
13454 .endtable
13455
13456
13457
13458 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13459 .table2
13460 .row &%header_maxsize%&              "total size of message header"
13461 .row &%header_line_maxsize%&         "individual header line limit"
13462 .row &%message_size_limit%&          "applies to all messages"
13463 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13464 .row &%received_header_text%&        "expanded to make &'Received:'&"
13465 .row &%received_headers_max%&        "for mail loop detection"
13466 .row &%recipients_max%&              "limit per message"
13467 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13468 .endtable
13469
13470
13471
13472
13473 .section "Non-SMTP incoming messages" "SECID111"
13474 .table2
13475 .row &%receive_timeout%&             "for non-SMTP messages"
13476 .endtable
13477
13478
13479
13480
13481
13482 .section "Incoming SMTP messages" "SECID112"
13483 See also the &'Policy controls'& section above.
13484
13485 .table2
13486 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13487 .row &%host_lookup%&                 "host name looked up for these hosts"
13488 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13489 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13490 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13491 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13492 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13493 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13494 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13495 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13496 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13497 .row &%smtp_accept_max_per_connection%& "messages per connection"
13498 .row &%smtp_accept_max_per_host%&    "connections from one host"
13499 .row &%smtp_accept_queue%&           "queue mail if more connections"
13500 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13501                                            connection"
13502 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13503 .row &%smtp_active_hostname%&        "host name to use in messages"
13504 .row &%smtp_banner%&                 "text for welcome banner"
13505 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13506 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13507 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13508 .row &%smtp_etrn_command%&           "what to run for ETRN"
13509 .row &%smtp_etrn_serialize%&         "only one at once"
13510 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13511 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13512 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13513 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13514 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13515 .row &%smtp_receive_timeout%&        "per command or data line"
13516 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13517 .row &%smtp_return_error_details%&   "give detail on rejections"
13518 .endtable
13519
13520
13521
13522 .section "SMTP extensions" "SECID113"
13523 .table2
13524 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13525 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13526 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13527 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13528 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13529 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13530 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13531 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13532 .endtable
13533
13534
13535
13536 .section "Processing messages" "SECID114"
13537 .table2
13538 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13539 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13540 .row &%allow_utf8_domains%&          "in addresses"
13541 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13542                                       words""&"
13543 .row &%delivery_date_remove%&        "from incoming messages"
13544 .row &%envelope_to_remove%&          "from incoming messages"
13545 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13546 .row &%headers_charset%&             "default for translations"
13547 .row &%qualify_domain%&              "default for senders"
13548 .row &%qualify_recipient%&           "default for recipients"
13549 .row &%return_path_remove%&          "from incoming messages"
13550 .row &%strip_excess_angle_brackets%& "in addresses"
13551 .row &%strip_trailing_dot%&          "at end of addresses"
13552 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13553 .endtable
13554
13555
13556
13557 .section "System filter" "SECID115"
13558 .table2
13559 .row &%system_filter%&               "locate system filter"
13560 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13561                                             directory"
13562 .row &%system_filter_file_transport%& "transport for delivery to a file"
13563 .row &%system_filter_group%&         "group for filter running"
13564 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13565 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13566 .row &%system_filter_user%&          "user for filter running"
13567 .endtable
13568
13569
13570
13571 .section "Routing and delivery" "SECID116"
13572 .table2
13573 .row &%disable_ipv6%&                "do no IPv6 processing"
13574 .row &%dns_again_means_nonexist%&    "for broken domains"
13575 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13576 .row &%dns_dnssec_ok%&               "parameter for resolver"
13577 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13578 .row &%dns_retrans%&                 "parameter for resolver"
13579 .row &%dns_retry%&                   "parameter for resolver"
13580 .row &%dns_use_edns0%&               "parameter for resolver"
13581 .row &%hold_domains%&                "hold delivery for these domains"
13582 .row &%local_interfaces%&            "for routing checks"
13583 .row &%queue_domains%&               "no immediate delivery for these"
13584 .row &%queue_only%&                  "no immediate delivery at all"
13585 .row &%queue_only_file%&             "no immediate delivery if file exists"
13586 .row &%queue_only_load%&             "no immediate delivery if load is high"
13587 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13588 .row &%queue_only_override%&         "allow command line to override"
13589 .row &%queue_run_in_order%&          "order of arrival"
13590 .row &%queue_run_max%&               "of simultaneous queue runners"
13591 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13592 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13593 .row &%remote_sort_domains%&         "order of remote deliveries"
13594 .row &%retry_data_expire%&           "timeout for retry data"
13595 .row &%retry_interval_max%&          "safety net for retry rules"
13596 .endtable
13597
13598
13599
13600 .section "Bounce and warning messages" "SECID117"
13601 .table2
13602 .row &%bounce_message_file%&         "content of bounce"
13603 .row &%bounce_message_text%&         "content of bounce"
13604 .row &%bounce_return_body%&          "include body if returning message"
13605 .row &%bounce_return_message%&       "include original message in bounce"
13606 .row &%bounce_return_size_limit%&    "limit on returned message"
13607 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13608 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13609 .row &%errors_copy%&                 "copy bounce messages"
13610 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13611 .row &%delay_warning%&               "time schedule"
13612 .row &%delay_warning_condition%&     "condition for warning messages"
13613 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13614 .row &%smtp_return_error_details%&   "give detail on rejections"
13615 .row &%warn_message_file%&           "content of warning message"
13616 .endtable
13617
13618
13619
13620 .section "Alphabetical list of main options" "SECTalomo"
13621 Those options that undergo string expansion before use are marked with
13622 &dagger;.
13623
13624 .option accept_8bitmime main boolean true
13625 .cindex "8BITMIME"
13626 .cindex "8-bit characters"
13627 .cindex "log" "selectors"
13628 .cindex "log" "8BITMIME"
13629 This option causes Exim to send 8BITMIME in its response to an SMTP
13630 EHLO command, and to accept the BODY= parameter on MAIL commands.
13631 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13632 takes no steps to do anything special with messages received by this route.
13633
13634 Historically Exim kept this option off by default, but the maintainers
13635 feel that in today's Internet, this causes more problems than it solves.
13636 It now defaults to true.
13637 A more detailed analysis of the issues is provided by Dan Bernstein:
13638 .display
13639 &url(http://cr.yp.to/smtp/8bitmime.html)
13640 .endd
13641
13642 To log received 8BITMIME status use
13643 .code
13644 log_selector = +8bitmime
13645 .endd
13646
13647 .option acl_not_smtp main string&!! unset
13648 .cindex "&ACL;" "for non-SMTP messages"
13649 .cindex "non-SMTP messages" "ACLs for"
13650 This option defines the ACL that is run when a non-SMTP message has been
13651 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13652 further details.
13653
13654 .option acl_not_smtp_mime main string&!! unset
13655 This option defines the ACL that is run for individual MIME parts of non-SMTP
13656 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13657 SMTP messages.
13658
13659 .option acl_not_smtp_start main string&!! unset
13660 .cindex "&ACL;" "at start of non-SMTP message"
13661 .cindex "non-SMTP messages" "ACLs for"
13662 This option defines the ACL that is run before Exim starts reading a
13663 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13664
13665 .option acl_smtp_auth main string&!! unset
13666 .cindex "&ACL;" "setting up for SMTP commands"
13667 .cindex "AUTH" "ACL for"
13668 This option defines the ACL that is run when an SMTP AUTH command is
13669 received. See chapter &<<CHAPACL>>& for further details.
13670
13671 .option acl_smtp_connect main string&!! unset
13672 .cindex "&ACL;" "on SMTP connection"
13673 This option defines the ACL that is run when an SMTP connection is received.
13674 See chapter &<<CHAPACL>>& for further details.
13675
13676 .option acl_smtp_data main string&!! unset
13677 .cindex "DATA" "ACL for"
13678 This option defines the ACL that is run after an SMTP DATA command has been
13679 processed and the message itself has been received, but before the final
13680 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13681
13682 .new
13683 .option acl_smtp_data_prdr main string&!! accept
13684 .cindex "PRDR" "ACL for"
13685 .cindex "DATA" "PRDR ACL for"
13686 .cindex "&ACL;" "PRDR-related"
13687 .cindex "&ACL;" "per-user data processing"
13688 .wen
13689 This option defines the ACL that,
13690 if the PRDR feature has been negotiated,
13691 is run for each recipient after an SMTP DATA command has been
13692 processed and the message itself has been received, but before the
13693 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13694
13695 .option acl_smtp_dkim main string&!! unset
13696 .cindex DKIM "ACL for"
13697 This option defines the ACL that is run for each DKIM signature
13698 of a received message.
13699 See chapter &<<CHAPdkim>>& for further details.
13700
13701 .option acl_smtp_etrn main string&!! unset
13702 .cindex "ETRN" "ACL for"
13703 This option defines the ACL that is run when an SMTP ETRN command is
13704 received. See chapter &<<CHAPACL>>& for further details.
13705
13706 .option acl_smtp_expn main string&!! unset
13707 .cindex "EXPN" "ACL for"
13708 This option defines the ACL that is run when an SMTP EXPN command is
13709 received. See chapter &<<CHAPACL>>& for further details.
13710
13711 .option acl_smtp_helo main string&!! unset
13712 .cindex "EHLO" "ACL for"
13713 .cindex "HELO" "ACL for"
13714 This option defines the ACL that is run when an SMTP EHLO or HELO
13715 command is received. See chapter &<<CHAPACL>>& for further details.
13716
13717
13718 .option acl_smtp_mail main string&!! unset
13719 .cindex "MAIL" "ACL for"
13720 This option defines the ACL that is run when an SMTP MAIL command is
13721 received. See chapter &<<CHAPACL>>& for further details.
13722
13723 .option acl_smtp_mailauth main string&!! unset
13724 .cindex "AUTH" "on MAIL command"
13725 This option defines the ACL that is run when there is an AUTH parameter on
13726 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13727 &<<CHAPSMTPAUTH>>& for details of authentication.
13728
13729 .option acl_smtp_mime main string&!! unset
13730 .cindex "MIME content scanning" "ACL for"
13731 This option is available when Exim is built with the content-scanning
13732 extension. It defines the ACL that is run for each MIME part in a message. See
13733 section &<<SECTscanmimepart>>& for details.
13734
13735 .option acl_smtp_notquit main string&!! unset
13736 .cindex "not-QUIT, ACL for"
13737 This option defines the ACL that is run when an SMTP session
13738 ends without a QUIT command being received.
13739 See chapter &<<CHAPACL>>& for further details.
13740
13741 .option acl_smtp_predata main string&!! unset
13742 This option defines the ACL that is run when an SMTP DATA command is
13743 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13744 further details.
13745
13746 .option acl_smtp_quit main string&!! unset
13747 .cindex "QUIT, ACL for"
13748 This option defines the ACL that is run when an SMTP QUIT command is
13749 received. See chapter &<<CHAPACL>>& for further details.
13750
13751 .option acl_smtp_rcpt main string&!! unset
13752 .cindex "RCPT" "ACL for"
13753 This option defines the ACL that is run when an SMTP RCPT command is
13754 received. See chapter &<<CHAPACL>>& for further details.
13755
13756 .option acl_smtp_starttls main string&!! unset
13757 .cindex "STARTTLS, ACL for"
13758 This option defines the ACL that is run when an SMTP STARTTLS command is
13759 received. See chapter &<<CHAPACL>>& for further details.
13760
13761 .option acl_smtp_vrfy main string&!! unset
13762 .cindex "VRFY" "ACL for"
13763 This option defines the ACL that is run when an SMTP VRFY command is
13764 received. See chapter &<<CHAPACL>>& for further details.
13765
13766 .option admin_groups main "string list&!!" unset
13767 .cindex "admin user"
13768 This option is expanded just once, at the start of Exim's processing. If the
13769 current group or any of the supplementary groups of an Exim caller is in this
13770 colon-separated list, the caller has admin privileges. If all your system
13771 programmers are in a specific group, for example, you can give them all Exim
13772 admin privileges by putting that group in &%admin_groups%&. However, this does
13773 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13774 To permit this, you have to add individuals to the Exim group.
13775
13776 .option allow_domain_literals main boolean false
13777 .cindex "domain literal"
13778 If this option is set, the RFC 2822 domain literal format is permitted in
13779 email addresses. The option is not set by default, because the domain literal
13780 format is not normally required these days, and few people know about it. It
13781 has, however, been exploited by mail abusers.
13782
13783 Unfortunately, it seems that some DNS black list maintainers are using this
13784 format to report black listing to postmasters. If you want to accept messages
13785 addressed to your hosts by IP address, you need to set
13786 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13787 domains (defined in the named domain list &%local_domains%& in the default
13788 configuration). This &"magic string"& matches the domain literal form of all
13789 the local host's IP addresses.
13790
13791
13792 .option allow_mx_to_ip main boolean false
13793 .cindex "MX record" "pointing to IP address"
13794 It appears that more and more DNS zone administrators are breaking the rules
13795 and putting domain names that look like IP addresses on the right hand side of
13796 MX records. Exim follows the rules and rejects this, giving an error message
13797 that explains the mis-configuration. However, some other MTAs support this
13798 practice, so to avoid &"Why can't Exim do this?"& complaints,
13799 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13800 recommended, except when you have no other choice.
13801
13802 .option allow_utf8_domains main boolean false
13803 .cindex "domain" "UTF-8 characters in"
13804 .cindex "UTF-8" "in domain name"
13805 Lots of discussion is going on about internationalized domain names. One
13806 camp is strongly in favour of just using UTF-8 characters, and it seems
13807 that at least two other MTAs permit this. This option allows Exim users to
13808 experiment if they wish.
13809
13810 If it is set true, Exim's domain parsing function allows valid
13811 UTF-8 multicharacters to appear in domain name components, in addition to
13812 letters, digits, and hyphens. However, just setting this option is not
13813 enough; if you want to look up these domain names in the DNS, you must also
13814 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13815 suitable setting is:
13816 .code
13817 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13818   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13819 .endd
13820 Alternatively, you can just disable this feature by setting
13821 .code
13822 dns_check_names_pattern =
13823 .endd
13824 That is, set the option to an empty string so that no check is done.
13825
13826
13827 .option auth_advertise_hosts main "host list&!!" *
13828 .cindex "authentication" "advertising"
13829 .cindex "AUTH" "advertising"
13830 If any server authentication mechanisms are configured, Exim advertises them in
13831 response to an EHLO command only if the calling host matches this list.
13832 Otherwise, Exim does not advertise AUTH.
13833 Exim does not accept AUTH commands from clients to which it has not
13834 advertised the availability of AUTH. The advertising of individual
13835 authentication mechanisms can be controlled by the use of the
13836 &%server_advertise_condition%& generic authenticator option on the individual
13837 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13838
13839 Certain mail clients (for example, Netscape) require the user to provide a name
13840 and password for authentication if AUTH is advertised, even though it may
13841 not be needed (the host may accept messages from hosts on its local LAN without
13842 authentication, for example). The &%auth_advertise_hosts%& option can be used
13843 to make these clients more friendly by excluding them from the set of hosts to
13844 which Exim advertises AUTH.
13845
13846 .cindex "AUTH" "advertising when encrypted"
13847 If you want to advertise the availability of AUTH only when the connection
13848 is encrypted using TLS, you can make use of the fact that the value of this
13849 option is expanded, with a setting like this:
13850 .code
13851 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13852 .endd
13853 .vindex "&$tls_in_cipher$&"
13854 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13855 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13856 expansion is *, which matches all hosts.
13857
13858
13859 .option auto_thaw main time 0s
13860 .cindex "thawing messages"
13861 .cindex "unfreezing messages"
13862 If this option is set to a time greater than zero, a queue runner will try a
13863 new delivery attempt on any frozen message, other than a bounce message, if
13864 this much time has passed since it was frozen. This may result in the message
13865 being re-frozen if nothing has changed since the last attempt. It is a way of
13866 saying &"keep on trying, even though there are big problems"&.
13867
13868 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13869 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13870 thought to be very useful any more, and its use should probably be avoided.
13871
13872
13873 .option av_scanner main string "see below"
13874 This option is available if Exim is built with the content-scanning extension.
13875 It specifies which anti-virus scanner to use. The default value is:
13876 .code
13877 sophie:/var/run/sophie
13878 .endd
13879 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13880 before use. See section &<<SECTscanvirus>>& for further details.
13881
13882
13883 .option bi_command main string unset
13884 .oindex "&%-bi%&"
13885 This option supplies the name of a command that is run when Exim is called with
13886 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13887 just the command name, it is not a complete command line. If an argument is
13888 required, it must come from the &%-oA%& command line option.
13889
13890
13891 .option bounce_message_file main string unset
13892 .cindex "bounce message" "customizing"
13893 .cindex "customizing" "bounce message"
13894 This option defines a template file containing paragraphs of text to be used
13895 for constructing bounce messages.  Details of the file's contents are given in
13896 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13897
13898
13899 .option bounce_message_text main string unset
13900 When this option is set, its contents are included in the default bounce
13901 message immediately after &"This message was created automatically by mail
13902 delivery software."& It is not used if &%bounce_message_file%& is set.
13903
13904 .option bounce_return_body main boolean true
13905 .cindex "bounce message" "including body"
13906 This option controls whether the body of an incoming message is included in a
13907 bounce message when &%bounce_return_message%& is true. The default setting
13908 causes the entire message, both header and body, to be returned (subject to the
13909 value of &%bounce_return_size_limit%&). If this option is false, only the
13910 message header is included. In the case of a non-SMTP message containing an
13911 error that is detected during reception, only those header lines preceding the
13912 point at which the error was detected are returned.
13913 .cindex "bounce message" "including original"
13914
13915 .option bounce_return_message main boolean true
13916 If this option is set false, none of the original message is included in
13917 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13918 &%bounce_return_body%&.
13919
13920
13921 .option bounce_return_size_limit main integer 100K
13922 .cindex "size" "of bounce, limit"
13923 .cindex "bounce message" "size limit"
13924 .cindex "limit" "bounce message size"
13925 This option sets a limit in bytes on the size of messages that are returned to
13926 senders as part of bounce messages when &%bounce_return_message%& is true. The
13927 limit should be less than the value of the global &%message_size_limit%& and of
13928 any &%message_size_limit%& settings on transports, to allow for the bounce text
13929 that Exim generates. If this option is set to zero there is no limit.
13930
13931 When the body of any message that is to be included in a bounce message is
13932 greater than the limit, it is truncated, and a comment pointing this out is
13933 added at the top. The actual cutoff may be greater than the value given, owing
13934 to the use of buffering for transferring the message in chunks (typically 8K in
13935 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13936 messages.
13937
13938 .option bounce_sender_authentication main string unset
13939 .cindex "bounce message" "sender authentication"
13940 .cindex "authentication" "bounce message"
13941 .cindex "AUTH" "on bounce message"
13942 This option provides an authenticated sender address that is sent with any
13943 bounce messages generated by Exim that are sent over an authenticated SMTP
13944 connection. A typical setting might be:
13945 .code
13946 bounce_sender_authentication = mailer-daemon@my.domain.example
13947 .endd
13948 which would cause bounce messages to be sent using the SMTP command:
13949 .code
13950 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13951 .endd
13952 The value of &%bounce_sender_authentication%& must always be a complete email
13953 address.
13954
13955 .option callout_domain_negative_expire main time 3h
13956 .cindex "caching" "callout timeouts"
13957 .cindex "callout" "caching timeouts"
13958 This option specifies the expiry time for negative callout cache data for a
13959 domain. See section &<<SECTcallver>>& for details of callout verification, and
13960 section &<<SECTcallvercache>>& for details of the caching.
13961
13962
13963 .option callout_domain_positive_expire main time 7d
13964 This option specifies the expiry time for positive callout cache data for a
13965 domain. See section &<<SECTcallver>>& for details of callout verification, and
13966 section &<<SECTcallvercache>>& for details of the caching.
13967
13968
13969 .option callout_negative_expire main time 2h
13970 This option specifies the expiry time for negative callout cache data for an
13971 address. See section &<<SECTcallver>>& for details of callout verification, and
13972 section &<<SECTcallvercache>>& for details of the caching.
13973
13974
13975 .option callout_positive_expire main time 24h
13976 This option specifies the expiry time for positive callout cache data for an
13977 address. See section &<<SECTcallver>>& for details of callout verification, and
13978 section &<<SECTcallvercache>>& for details of the caching.
13979
13980
13981 .option callout_random_local_part main string&!! "see below"
13982 This option defines the &"random"& local part that can be used as part of
13983 callout verification. The default value is
13984 .code
13985 $primary_hostname-$tod_epoch-testing
13986 .endd
13987 See section &<<CALLaddparcall>>& for details of how this value is used.
13988
13989
13990 .option check_log_inodes main integer 0
13991 See &%check_spool_space%& below.
13992
13993
13994 .option check_log_space main integer 0
13995 See &%check_spool_space%& below.
13996
13997 .oindex "&%check_rfc2047_length%&"
13998 .cindex "RFC 2047" "disabling length check"
13999 .option check_rfc2047_length main boolean true
14000 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14001 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14002 word; strings to be encoded that exceed this length are supposed to use
14003 multiple encoded words. By default, Exim does not recognize encoded words that
14004 exceed the maximum length. However, it seems that some software, in violation
14005 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14006 set false, Exim recognizes encoded words of any length.
14007
14008
14009 .option check_spool_inodes main integer 0
14010 See &%check_spool_space%& below.
14011
14012
14013 .option check_spool_space main integer 0
14014 .cindex "checking disk space"
14015 .cindex "disk space, checking"
14016 .cindex "spool directory" "checking space"
14017 The four &%check_...%& options allow for checking of disk resources before a
14018 message is accepted.
14019
14020 .vindex "&$log_inodes$&"
14021 .vindex "&$log_space$&"
14022 .vindex "&$spool_inodes$&"
14023 .vindex "&$spool_space$&"
14024 When any of these options are set, they apply to all incoming messages. If you
14025 want to apply different checks to different kinds of message, you can do so by
14026 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14027 &$spool_space$& in an ACL with appropriate additional conditions.
14028
14029
14030 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14031 either value is greater than zero, for example:
14032 .code
14033 check_spool_space = 10M
14034 check_spool_inodes = 100
14035 .endd
14036 The spool partition is the one that contains the directory defined by
14037 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14038 transit.
14039
14040 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14041 files are written if either is greater than zero. These should be set only if
14042 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14043
14044 If there is less space or fewer inodes than requested, Exim refuses to accept
14045 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14046 error response to the MAIL command. If ESMTP is in use and there was a
14047 SIZE parameter on the MAIL command, its value is added to the
14048 &%check_spool_space%& value, and the check is performed even if
14049 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14050
14051 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14052 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14053
14054 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14055 failure a message is written to stderr and Exim exits with a non-zero code, as
14056 it obviously cannot send an error message of any kind.
14057
14058 .option daemon_smtp_ports main string &`smtp`&
14059 .cindex "port" "for daemon"
14060 .cindex "TCP/IP" "setting listening ports"
14061 This option specifies one or more default SMTP ports on which the Exim daemon
14062 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14063 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14064
14065 .option daemon_startup_retries main integer 9
14066 .cindex "daemon startup, retrying"
14067 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14068 the daemon at startup when it cannot immediately bind a listening socket
14069 (typically because the socket is already in use): &%daemon_startup_retries%&
14070 defines the number of retries after the first failure, and
14071 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14072
14073 .option daemon_startup_sleep main time 30s
14074 See &%daemon_startup_retries%&.
14075
14076 .option delay_warning main "time list" 24h
14077 .cindex "warning of delay"
14078 .cindex "delay warning, specifying"
14079 When a message is delayed, Exim sends a warning message to the sender at
14080 intervals specified by this option. The data is a colon-separated list of times
14081 after which to send warning messages. If the value of the option is an empty
14082 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14083 message has been on the queue for longer than the last time, the last interval
14084 between the times is used to compute subsequent warning times. For example,
14085 with
14086 .code
14087 delay_warning = 4h:8h:24h
14088 .endd
14089 the first message is sent after 4 hours, the second after 8 hours, and
14090 the third one after 24 hours. After that, messages are sent every 16 hours,
14091 because that is the interval between the last two times on the list. If you set
14092 just one time, it specifies the repeat interval. For example, with:
14093 .code
14094 delay_warning = 6h
14095 .endd
14096 messages are repeated every six hours. To stop warnings after a given time, set
14097 a very large time at the end of the list. For example:
14098 .code
14099 delay_warning = 2h:12h:99d
14100 .endd
14101 Note that the option is only evaluated at the time a delivery attempt fails,
14102 which depends on retry and queue-runner configuration.
14103 Typically retries will be configured more frequently than warning messages.
14104
14105 .option delay_warning_condition main string&!! "see below"
14106 .vindex "&$domain$&"
14107 The string is expanded at the time a warning message might be sent. If all the
14108 deferred addresses have the same domain, it is set in &$domain$& during the
14109 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14110 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14111 &"false"& (the comparison being done caselessly) then the warning message is
14112 not sent. The default is:
14113 .code
14114 delay_warning_condition = ${if or {\
14115   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14116   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14117   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14118   } {no}{yes}}
14119 .endd
14120 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14121 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14122 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14123 &"auto-replied"& in an &'Auto-Submitted:'& header.
14124
14125 .option deliver_drop_privilege main boolean false
14126 .cindex "unprivileged delivery"
14127 .cindex "delivery" "unprivileged"
14128 If this option is set true, Exim drops its root privilege at the start of a
14129 delivery process, and runs as the Exim user throughout. This severely restricts
14130 the kinds of local delivery that are possible, but is viable in certain types
14131 of configuration. There is a discussion about the use of root privilege in
14132 chapter &<<CHAPsecurity>>&.
14133
14134 .option deliver_queue_load_max main fixed-point unset
14135 .cindex "load average"
14136 .cindex "queue runner" "abandoning"
14137 When this option is set, a queue run is abandoned if the system load average
14138 becomes greater than the value of the option. The option has no effect on
14139 ancient operating systems on which Exim cannot determine the load average.
14140 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14141
14142
14143 .option delivery_date_remove main boolean true
14144 .cindex "&'Delivery-date:'& header line"
14145 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14146 message when it is delivered, in exactly the same way as &'Return-path:'& is
14147 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14148 should not be present in incoming messages, and this option causes them to be
14149 removed at the time the message is received, to avoid any problems that might
14150 occur when a delivered message is subsequently sent on to some other recipient.
14151
14152 .option disable_fsync main boolean false
14153 .cindex "&[fsync()]&, disabling"
14154 This option is available only if Exim was built with the compile-time option
14155 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14156 a runtime configuration generates an &"unknown option"& error. You should not
14157 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14158 really, really, really understand what you are doing. &'No pre-compiled
14159 distributions of Exim should ever make this option available.'&
14160
14161 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14162 updated files' data to be written to disc before continuing. Unexpected events
14163 such as crashes and power outages may cause data to be lost or scrambled.
14164 Here be Dragons. &*Beware.*&
14165
14166
14167 .option disable_ipv6 main boolean false
14168 .cindex "IPv6" "disabling"
14169 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14170 activities take place. AAAA records are never looked up, and any IPv6 addresses
14171 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14172 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14173 to handle IPv6 literal addresses.
14174
14175
14176 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14177 .cindex DKIM "controlling calls to the ACL"
14178 This option gives a list of DKIM domains for which the DKIM ACL is run.
14179 It is expanded after the message is received; by default it runs
14180 the ACL once for each signature in the message.
14181 See chapter &<<CHAPdkim>>&.
14182
14183
14184 .option dns_again_means_nonexist main "domain list&!!" unset
14185 .cindex "DNS" "&""try again""& response; overriding"
14186 DNS lookups give a &"try again"& response for the DNS errors
14187 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14188 keep trying to deliver a message, or to give repeated temporary errors to
14189 incoming mail. Sometimes the effect is caused by a badly set up name server and
14190 may persist for a long time. If a domain which exhibits this problem matches
14191 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14192 This option should be used with care. You can make it apply to reverse lookups
14193 by a setting such as this:
14194 .code
14195 dns_again_means_nonexist = *.in-addr.arpa
14196 .endd
14197 This option applies to all DNS lookups that Exim does. It also applies when the
14198 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14199 since these are most likely to be caused by DNS lookup problems. The
14200 &(dnslookup)& router has some options of its own for controlling what happens
14201 when lookups for MX or SRV records give temporary errors. These more specific
14202 options are applied after this global option.
14203
14204 .option dns_check_names_pattern main string "see below"
14205 .cindex "DNS" "pre-check of name syntax"
14206 When this option is set to a non-empty string, it causes Exim to check domain
14207 names for characters that are not allowed in host names before handing them to
14208 the DNS resolver, because some resolvers give temporary errors for names that
14209 contain unusual characters. If a domain name contains any unwanted characters,
14210 a &"not found"& result is forced, and the resolver is not called. The check is
14211 done by matching the domain name against a regular expression, which is the
14212 value of this option. The default pattern is
14213 .code
14214 dns_check_names_pattern = \
14215   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14216 .endd
14217 which permits only letters, digits, slashes, and hyphens in components, but
14218 they must start and end with a letter or digit. Slashes are not, in fact,
14219 permitted in host names, but they are found in certain NS records (which can be
14220 accessed in Exim by using a &%dnsdb%& lookup). If you set
14221 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14222 empty string.
14223
14224 .option dns_csa_search_limit main integer 5
14225 This option controls the depth of parental searching for CSA SRV records in the
14226 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14227
14228 .option dns_csa_use_reverse main boolean true
14229 This option controls whether or not an IP address, given as a CSA domain, is
14230 reversed and looked up in the reverse DNS, as described in more detail in
14231 section &<<SECTverifyCSA>>&.
14232
14233
14234 .option dns_dnssec_ok main integer -1
14235 .cindex "DNS" "resolver options"
14236 .cindex "DNS" "DNSSEC"
14237 If this option is set to a non-negative number then Exim will initialise the
14238 DNS resolver library to either use or not use DNSSEC, overriding the system
14239 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14240
14241 If the resolver library does not support DNSSEC then this option has no effect.
14242
14243
14244 .option dns_ipv4_lookup main "domain list&!!" unset
14245 .cindex "IPv6" "DNS lookup for AAAA records"
14246 .cindex "DNS" "IPv6 lookup for AAAA records"
14247 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14248 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14249 (A records) when trying to find IP addresses for hosts, unless the host's
14250 domain matches this list.
14251
14252 This is a fudge to help with name servers that give big delays or otherwise do
14253 not work for the AAAA record type. In due course, when the world's name
14254 servers have all been upgraded, there should be no need for this option.
14255
14256
14257 .option dns_retrans main time 0s
14258 .cindex "DNS" "resolver options"
14259 .cindex timeout "dns lookup"
14260 .cindex "DNS" timeout
14261 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14262 retransmission and retry parameters for DNS lookups. Values of zero (the
14263 defaults) leave the system default settings unchanged. The first value is the
14264 time between retries, and the second is the number of retries. It isn't
14265 totally clear exactly how these settings affect the total time a DNS lookup may
14266 take. I haven't found any documentation about timeouts on DNS lookups; these
14267 parameter values are available in the external resolver interface structure,
14268 but nowhere does it seem to describe how they are used or what you might want
14269 to set in them.
14270 See also the &%slow_lookup_log%& option.
14271
14272
14273 .option dns_retry main integer 0
14274 See &%dns_retrans%& above.
14275
14276
14277 .option dns_use_edns0 main integer -1
14278 .cindex "DNS" "resolver options"
14279 .cindex "DNS" "EDNS0"
14280 If this option is set to a non-negative number then Exim will initialise the
14281 DNS resolver library to either use or not use EDNS0 extensions, overriding
14282 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14283 on.
14284
14285 If the resolver library does not support EDNS0 then this option has no effect.
14286
14287
14288 .option drop_cr main boolean false
14289 This is an obsolete option that is now a no-op. It used to affect the way Exim
14290 handled CR and LF characters in incoming messages. What happens now is
14291 described in section &<<SECTlineendings>>&.
14292
14293 .new
14294 .option dsn_advertise_hosts main "host list&!!" unset
14295 .cindex "bounce messages" "success"
14296 .cindex "DSN" "success"
14297 .cindex "Delivery Status Notification" "success"
14298 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14299 and accepted from, these hosts.
14300 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14301 and RET and ORCPT options on MAIL FROM commands.
14302 A NOTIFY=SUCCESS option requests success-DSN messages.
14303 A NOTIFY= option with no argument requests that no delay or failure DSNs
14304 are sent.
14305 .wen
14306
14307 .option dsn_from main "string&!!" "see below"
14308 .cindex "&'From:'& header line" "in bounces"
14309 .cindex "bounce messages" "&'From:'& line, specifying"
14310 This option can be used to vary the contents of &'From:'& header lines in
14311 bounces and other automatically generated messages (&"Delivery Status
14312 Notifications"& &-- hence the name of the option). The default setting is:
14313 .code
14314 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14315 .endd
14316 The value is expanded every time it is needed. If the expansion fails, a
14317 panic is logged, and the default value is used.
14318
14319 .option envelope_to_remove main boolean true
14320 .cindex "&'Envelope-to:'& header line"
14321 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14322 message when it is delivered, in exactly the same way as &'Return-path:'& is
14323 handled. &'Envelope-to:'& records the original recipient address from the
14324 messages's envelope that caused the delivery to happen. Such headers should not
14325 be present in incoming messages, and this option causes them to be removed at
14326 the time the message is received, to avoid any problems that might occur when a
14327 delivered message is subsequently sent on to some other recipient.
14328
14329
14330 .option errors_copy main "string list&!!" unset
14331 .cindex "bounce message" "copy to other address"
14332 .cindex "copy of bounce message"
14333 Setting this option causes Exim to send bcc copies of bounce messages that it
14334 generates to other addresses. &*Note*&: This does not apply to bounce messages
14335 coming from elsewhere. The value of the option is a colon-separated list of
14336 items. Each item consists of a pattern, terminated by white space, followed by
14337 a comma-separated list of email addresses. If a pattern contains spaces, it
14338 must be enclosed in double quotes.
14339
14340 Each pattern is processed in the same way as a single item in an address list
14341 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14342 the bounce message, the message is copied to the addresses on the list. The
14343 items are scanned in order, and once a matching one is found, no further items
14344 are examined. For example:
14345 .code
14346 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14347               rqps@mydomain   hostmaster@mydomain.example,\
14348                               postmaster@mydomain.example
14349 .endd
14350 .vindex "&$domain$&"
14351 .vindex "&$local_part$&"
14352 The address list is expanded before use. The expansion variables &$local_part$&
14353 and &$domain$& are set from the original recipient of the error message, and if
14354 there was any wildcard matching in the pattern, the expansion
14355 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14356 variables &$0$&, &$1$&, etc. are set in the normal way.
14357
14358
14359 .option errors_reply_to main string unset
14360 .cindex "bounce message" "&'Reply-to:'& in"
14361 By default, Exim's bounce and delivery warning messages contain the header line
14362 .display
14363 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14364 .endd
14365 .oindex &%quota_warn_message%&
14366 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14367 A warning message that is generated by the &%quota_warn_message%& option in an
14368 &(appendfile)& transport may contain its own &'From:'& header line that
14369 overrides the default.
14370
14371 Experience shows that people reply to bounce messages. If the
14372 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14373 and warning messages. For example:
14374 .code
14375 errors_reply_to = postmaster@my.domain.example
14376 .endd
14377 The value of the option is not expanded. It must specify a valid RFC 2822
14378 address. However, if a warning message that is generated by the
14379 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14380 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14381 not used.
14382
14383
14384 .option exim_group main string "compile-time configured"
14385 .cindex "gid (group id)" "Exim's own"
14386 .cindex "Exim group"
14387 This option changes the gid under which Exim runs when it gives up root
14388 privilege. The default value is compiled into the binary. The value of this
14389 option is used only when &%exim_user%& is also set. Unless it consists entirely
14390 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14391 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14392 security issues.
14393
14394
14395 .option exim_path main string "see below"
14396 .cindex "Exim binary, path name"
14397 This option specifies the path name of the Exim binary, which is used when Exim
14398 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14399 the directory configured at compile time by the BIN_DIRECTORY setting. It
14400 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14401 other place.
14402 &*Warning*&: Do not use a macro to define the value of this option, because
14403 you will break those Exim utilities that scan the configuration file to find
14404 where the binary is. (They then use the &%-bP%& option to extract option
14405 settings such as the value of &%spool_directory%&.)
14406
14407
14408 .option exim_user main string "compile-time configured"
14409 .cindex "uid (user id)" "Exim's own"
14410 .cindex "Exim user"
14411 This option changes the uid under which Exim runs when it gives up root
14412 privilege. The default value is compiled into the binary. Ownership of the run
14413 time configuration file and the use of the &%-C%& and &%-D%& command line
14414 options is checked against the values in the binary, not what is set here.
14415
14416 Unless it consists entirely of digits, the string is looked up using
14417 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14418 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14419 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14420
14421
14422 .option extra_local_interfaces main "string list" unset
14423 This option defines network interfaces that are to be considered local when
14424 routing, but which are not used for listening by the daemon. See section
14425 &<<SECTreclocipadd>>& for details.
14426
14427
14428 . Allow this long option name to split; give it unsplit as a fifth argument
14429 . for the automatic .oindex that is generated by .option.
14430
14431 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14432          extract_addresses_remove_arguments
14433 .oindex "&%-t%&"
14434 .cindex "command line" "addresses with &%-t%&"
14435 .cindex "Sendmail compatibility" "&%-t%& option"
14436 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14437 are present on the command line when the &%-t%& option is used to build an
14438 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14439 line addresses are removed from the recipients list. This is also how Smail
14440 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14441 command line addresses are added to those obtained from the header lines. When
14442 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14443 argument headers. If it is set false, Exim adds rather than removes argument
14444 addresses.
14445
14446
14447 .option finduser_retries main integer 0
14448 .cindex "NIS, retrying user lookups"
14449 On systems running NIS or other schemes in which user and group information is
14450 distributed from a remote system, there can be times when &[getpwnam()]& and
14451 related functions fail, even when given valid data, because things time out.
14452 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14453 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14454 many extra times to find a user or a group, waiting for one second between
14455 retries.
14456
14457 .cindex "&_/etc/passwd_&" "multiple reading of"
14458 You should not set this option greater than zero if your user information is in
14459 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14460 search the file multiple times for non-existent users, and also cause delay.
14461
14462
14463
14464 .option freeze_tell main "string list, comma separated" unset
14465 .cindex "freezing messages" "sending a message when freezing"
14466 On encountering certain errors, or when configured to do so in a system filter,
14467 ACL, or special router, Exim freezes a message. This means that no further
14468 delivery attempts take place until an administrator thaws the message, or the
14469 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14470 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14471 warning message whenever it freezes something, unless the message it is
14472 freezing is a locally-generated bounce message. (Without this exception there
14473 is the possibility of looping.) The warning message is sent to the addresses
14474 supplied as the comma-separated value of this option. If several of the
14475 message's addresses cause freezing, only a single message is sent. If the
14476 freezing was automatic, the reason(s) for freezing can be found in the message
14477 log. If you configure freezing in a filter or ACL, you must arrange for any
14478 logging that you require.
14479
14480
14481 .option gecos_name main string&!! unset
14482 .cindex "HP-UX"
14483 .cindex "&""gecos""& field, parsing"
14484 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14485 password file to hold other information in addition to users' real names. Exim
14486 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14487 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14488 of the field are used unchanged, except that, if an ampersand is encountered,
14489 it is replaced by the user's login name with the first character forced to
14490 upper case, since this is a convention that is observed on many systems.
14491
14492 When these options are set, &%gecos_pattern%& is treated as a regular
14493 expression that is to be applied to the field (again with && replaced by the
14494 login name), and if it matches, &%gecos_name%& is expanded and used as the
14495 user's name.
14496
14497 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14498 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14499 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14500 name terminates at the first comma, the following can be used:
14501 .code
14502 gecos_pattern = ([^,]*)
14503 gecos_name = $1
14504 .endd
14505
14506 .option gecos_pattern main string unset
14507 See &%gecos_name%& above.
14508
14509
14510 .option gnutls_compat_mode main boolean unset
14511 This option controls whether GnuTLS is used in compatibility mode in an Exim
14512 server. This reduces security slightly, but improves interworking with older
14513 implementations of TLS.
14514
14515
14516 option gnutls_allow_auto_pkcs11 main boolean unset
14517 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14518 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14519
14520 See
14521 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14522 for documentation.
14523
14524
14525
14526 .option headers_charset main string "see below"
14527 This option sets a default character set for translating from encoded MIME
14528 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14529 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14530 ultimate default is ISO-8859-1. For more details see the description of header
14531 insertions in section &<<SECTexpansionitems>>&.
14532
14533
14534
14535 .option header_maxsize main integer "see below"
14536 .cindex "header section" "maximum size of"
14537 .cindex "limit" "size of message header section"
14538 This option controls the overall maximum size of a message's header
14539 section. The default is the value of HEADER_MAXSIZE in
14540 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14541 sections are rejected.
14542
14543
14544 .option header_line_maxsize main integer 0
14545 .cindex "header lines" "maximum size of"
14546 .cindex "limit" "size of one header line"
14547 This option limits the length of any individual header line in a message, after
14548 all the continuations have been joined together. Messages with individual
14549 header lines that are longer than the limit are rejected. The default value of
14550 zero means &"no limit"&.
14551
14552
14553
14554
14555 .option helo_accept_junk_hosts main "host list&!!" unset
14556 .cindex "HELO" "accepting junk data"
14557 .cindex "EHLO" "accepting junk data"
14558 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14559 mail, and gives an error response for invalid data. Unfortunately, there are
14560 some SMTP clients that send syntactic junk. They can be accommodated by setting
14561 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14562 if you want to do semantic checking.
14563 See also &%helo_allow_chars%& for a way of extending the permitted character
14564 set.
14565
14566
14567 .option helo_allow_chars main string unset
14568 .cindex "HELO" "underscores in"
14569 .cindex "EHLO" "underscores in"
14570 .cindex "underscore in EHLO/HELO"
14571 This option can be set to a string of rogue characters that are permitted in
14572 all EHLO and HELO names in addition to the standard letters, digits,
14573 hyphens, and dots. If you really must allow underscores, you can set
14574 .code
14575 helo_allow_chars = _
14576 .endd
14577 Note that the value is one string, not a list.
14578
14579
14580 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14581 .cindex "HELO" "forcing reverse lookup"
14582 .cindex "EHLO" "forcing reverse lookup"
14583 If the domain given by a client in a HELO or EHLO command matches this
14584 list, a reverse lookup is done in order to establish the host's true name. The
14585 default forces a lookup if the client host gives the server's name or any of
14586 its IP addresses (in brackets), something that broken clients have been seen to
14587 do.
14588
14589
14590 .option helo_try_verify_hosts main "host list&!!" unset
14591 .cindex "HELO verifying" "optional"
14592 .cindex "EHLO" "verifying, optional"
14593 By default, Exim just checks the syntax of HELO and EHLO commands (see
14594 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14595 to do more extensive checking of the data supplied by these commands. The ACL
14596 condition &`verify = helo`& is provided to make this possible.
14597 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14598 to force the check to occur. From release 4.53 onwards, this is no longer
14599 necessary. If the check has not been done before &`verify = helo`& is
14600 encountered, it is done at that time. Consequently, this option is obsolete.
14601 Its specification is retained here for backwards compatibility.
14602
14603 When an EHLO or HELO command is received, if the calling host matches
14604 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14605 EHLO command either:
14606
14607 .ilist
14608 is an IP literal matching the calling address of the host, or
14609 .next
14610 .cindex "DNS" "reverse lookup"
14611 .cindex "reverse DNS lookup"
14612 matches the host name that Exim obtains by doing a reverse lookup of the
14613 calling host address, or
14614 .next
14615 when looked up in DNS yields the calling host address.
14616 .endlist
14617
14618 However, the EHLO or HELO command is not rejected if any of the checks
14619 fail. Processing continues, but the result of the check is remembered, and can
14620 be detected later in an ACL by the &`verify = helo`& condition.
14621
14622 If DNS was used for successful verification, the variable
14623 .cindex "DNS" "DNSSEC"
14624 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14625
14626 .option helo_verify_hosts main "host list&!!" unset
14627 .cindex "HELO verifying" "mandatory"
14628 .cindex "EHLO" "verifying, mandatory"
14629 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14630 backwards compatibility. For hosts that match this option, Exim checks the host
14631 name given in the HELO or EHLO in the same way as for
14632 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14633 rejected with a 550 error, and entries are written to the main and reject logs.
14634 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14635 error.
14636
14637 .option hold_domains main "domain list&!!" unset
14638 .cindex "domain" "delaying delivery"
14639 .cindex "delivery" "delaying certain domains"
14640 This option allows mail for particular domains to be held on the queue
14641 manually. The option is overridden if a message delivery is forced with the
14642 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14643 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14644 item in &%hold_domains%&, no routing or delivery for that address is done, and
14645 it is deferred every time the message is looked at.
14646
14647 This option is intended as a temporary operational measure for delaying the
14648 delivery of mail while some problem is being sorted out, or some new
14649 configuration tested. If you just want to delay the processing of some
14650 domains until a queue run occurs, you should use &%queue_domains%& or
14651 &%queue_smtp_domains%&, not &%hold_domains%&.
14652
14653 A setting of &%hold_domains%& does not override Exim's code for removing
14654 messages from the queue if they have been there longer than the longest retry
14655 time in any retry rule. If you want to hold messages for longer than the normal
14656 retry times, insert a dummy retry rule with a long retry time.
14657
14658
14659 .option host_lookup main "host list&!!" unset
14660 .cindex "host name" "lookup, forcing"
14661 Exim does not look up the name of a calling host from its IP address unless it
14662 is required to compare against some host list, or the host matches
14663 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14664 option (which normally contains IP addresses rather than host names). The
14665 default configuration file contains
14666 .code
14667 host_lookup = *
14668 .endd
14669 which causes a lookup to happen for all hosts. If the expense of these lookups
14670 is felt to be too great, the setting can be changed or removed.
14671
14672 After a successful reverse lookup, Exim does a forward lookup on the name it
14673 has obtained, to verify that it yields the IP address that it started with. If
14674 this check fails, Exim behaves as if the name lookup failed.
14675
14676 .vindex "&$host_lookup_failed$&"
14677 .vindex "&$sender_host_name$&"
14678 After any kind of failure, the host name (in &$sender_host_name$&) remains
14679 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14680 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14681 &`verify = reverse_host_lookup`& in ACLs.
14682
14683
14684 .option host_lookup_order main "string list" &`bydns:byaddr`&
14685 This option specifies the order of different lookup methods when Exim is trying
14686 to find a host name from an IP address. The default is to do a DNS lookup
14687 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14688 if that fails. You can change the order of these lookups, or omit one entirely,
14689 if you want.
14690
14691 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14692 multiple PTR records in the DNS and the IP address is not listed in
14693 &_/etc/hosts_&. Different operating systems give different results in this
14694 case. That is why the default tries a DNS lookup first.
14695
14696
14697
14698 .option host_reject_connection main "host list&!!" unset
14699 .cindex "host" "rejecting connections from"
14700 If this option is set, incoming SMTP calls from the hosts listed are rejected
14701 as soon as the connection is made.
14702 This option is obsolete, and retained only for backward compatibility, because
14703 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14704 connections immediately.
14705
14706 The ability to give an immediate rejection (either by this option or using an
14707 ACL) is provided for use in unusual cases. Many hosts will just try again,
14708 sometimes without much delay. Normally, it is better to use an ACL to reject
14709 incoming messages at a later stage, such as after RCPT commands. See
14710 chapter &<<CHAPACL>>&.
14711
14712
14713 .option hosts_connection_nolog main "host list&!!" unset
14714 .cindex "host" "not logging connections from"
14715 This option defines a list of hosts for which connection logging does not
14716 happen, even though the &%smtp_connection%& log selector is set. For example,
14717 you might want not to log SMTP connections from local processes, or from
14718 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14719 the daemon; you should therefore strive to restrict its value to a short inline
14720 list of IP addresses and networks. To disable logging SMTP connections from
14721 local processes, you must create a host list with an empty item. For example:
14722 .code
14723 hosts_connection_nolog = :
14724 .endd
14725 If the &%smtp_connection%& log selector is not set, this option has no effect.
14726
14727
14728
14729 .option hosts_treat_as_local main "domain list&!!" unset
14730 .cindex "local host" "domains treated as"
14731 .cindex "host" "treated as local"
14732 If this option is set, any host names that match the domain list are treated as
14733 if they were the local host when Exim is scanning host lists obtained from MX
14734 records
14735 or other sources. Note that the value of this option is a domain list, not a
14736 host list, because it is always used to check host names, not IP addresses.
14737
14738 This option also applies when Exim is matching the special items
14739 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14740 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14741 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14742 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14743 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14744 interfaces and recognizing the local host.
14745
14746
14747 .option ibase_servers main "string list" unset
14748 .cindex "InterBase" "server list"
14749 This option provides a list of InterBase servers and associated connection data,
14750 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14751 The option is available only if Exim has been built with InterBase support.
14752
14753
14754
14755 .option ignore_bounce_errors_after main time 10w
14756 .cindex "bounce message" "discarding"
14757 .cindex "discarding bounce message"
14758 This option affects the processing of bounce messages that cannot be delivered,
14759 that is, those that suffer a permanent delivery failure. (Bounce messages that
14760 suffer temporary delivery failures are of course retried in the usual way.)
14761
14762 After a permanent delivery failure, bounce messages are frozen,
14763 because there is no sender to whom they can be returned. When a frozen bounce
14764 message has been on the queue for more than the given time, it is unfrozen at
14765 the next queue run, and a further delivery is attempted. If delivery fails
14766 again, the bounce message is discarded. This makes it possible to keep failed
14767 bounce messages around for a shorter time than the normal maximum retry time
14768 for frozen messages. For example,
14769 .code
14770 ignore_bounce_errors_after = 12h
14771 .endd
14772 retries failed bounce message deliveries after 12 hours, discarding any further
14773 failures. If the value of this option is set to a zero time period, bounce
14774 failures are discarded immediately. Setting a very long time (as in the default
14775 value) has the effect of disabling this option. For ways of automatically
14776 dealing with other kinds of frozen message, see &%auto_thaw%& and
14777 &%timeout_frozen_after%&.
14778
14779
14780 .option ignore_fromline_hosts main "host list&!!" unset
14781 .cindex "&""From""& line"
14782 .cindex "UUCP" "&""From""& line"
14783 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14784 the headers of a message. By default this is treated as the start of the
14785 message's body, which means that any following headers are not recognized as
14786 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14787 match those hosts that insist on sending it. If the sender is actually a local
14788 process rather than a remote host, and is using &%-bs%& to inject the messages,
14789 &%ignore_fromline_local%& must be set to achieve this effect.
14790
14791
14792 .option ignore_fromline_local main boolean false
14793 See &%ignore_fromline_hosts%& above.
14794
14795
14796 .option keep_malformed main time 4d
14797 This option specifies the length of time to keep messages whose spool files
14798 have been corrupted in some way. This should, of course, never happen. At the
14799 next attempt to deliver such a message, it gets removed. The incident is
14800 logged.
14801
14802
14803 .option ldap_ca_cert_dir main string unset
14804 .cindex "LDAP", "TLS CA certificate directory"
14805 This option indicates which directory contains CA certificates for verifying
14806 a TLS certificate presented by an LDAP server.
14807 While Exim does not provide a default value, your SSL library may.
14808 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14809 and constrained to be a directory.
14810
14811
14812 .option ldap_ca_cert_file main string unset
14813 .cindex "LDAP", "TLS CA certificate file"
14814 This option indicates which file contains CA certificates for verifying
14815 a TLS certificate presented by an LDAP server.
14816 While Exim does not provide a default value, your SSL library may.
14817 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14818 and constrained to be a file.
14819
14820
14821 .option ldap_cert_file main string unset
14822 .cindex "LDAP" "TLS client certificate file"
14823 This option indicates which file contains an TLS client certificate which
14824 Exim should present to the LDAP server during TLS negotiation.
14825 Should be used together with &%ldap_cert_key%&.
14826
14827
14828 .option ldap_cert_key main string unset
14829 .cindex "LDAP" "TLS client key file"
14830 This option indicates which file contains the secret/private key to use
14831 to prove identity to the LDAP server during TLS negotiation.
14832 Should be used together with &%ldap_cert_file%&, which contains the
14833 identity to be proven.
14834
14835
14836 .option ldap_cipher_suite main string unset
14837 .cindex "LDAP" "TLS cipher suite"
14838 This controls the TLS cipher-suite negotiation during TLS negotiation with
14839 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14840 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14841
14842
14843 .option ldap_default_servers main "string list" unset
14844 .cindex "LDAP" "default servers"
14845 This option provides a list of LDAP servers which are tried in turn when an
14846 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14847 details of LDAP queries. This option is available only when Exim has been built
14848 with LDAP support.
14849
14850
14851 .option ldap_require_cert main string unset.
14852 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14853 This should be one of the values "hard", "demand", "allow", "try" or "never".
14854 A value other than one of these is interpreted as "never".
14855 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14856 Although Exim does not set a default, the LDAP library probably defaults
14857 to hard/demand.
14858
14859
14860 .option ldap_start_tls main boolean false
14861 .cindex "LDAP" "whether or not to negotiate TLS"
14862 If set, Exim will attempt to negotiate TLS with the LDAP server when
14863 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14864 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14865 of SSL-on-connect.
14866 In the event of failure to negotiate TLS, the action taken is controlled
14867 by &%ldap_require_cert%&.
14868
14869
14870 .option ldap_version main integer unset
14871 .cindex "LDAP" "protocol version, forcing"
14872 This option can be used to force Exim to set a specific protocol version for
14873 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14874 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14875 the LDAP headers; otherwise it is 2. This option is available only when Exim
14876 has been built with LDAP support.
14877
14878
14879
14880 .option local_from_check main boolean true
14881 .cindex "&'Sender:'& header line" "disabling addition of"
14882 .cindex "&'From:'& header line" "disabling checking of"
14883 When a message is submitted locally (that is, not over a TCP/IP connection) by
14884 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14885 checks that the &'From:'& header line matches the login of the calling user and
14886 the domain specified by &%qualify_domain%&.
14887
14888 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14889 locally submitted message is automatically qualified by Exim, unless the
14890 &%-bnq%& command line option is used.
14891
14892 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14893 on the local part. If the &'From:'& header line does not match, Exim adds a
14894 &'Sender:'& header with an address constructed from the calling user's login
14895 and the default qualify domain.
14896
14897 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14898 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14899 &'Sender:'& header lines supplied by untrusted users, you must also set
14900 &%local_sender_retain%& to be true.
14901
14902 .cindex "envelope sender"
14903 These options affect only the header lines in the message. The envelope sender
14904 is still forced to be the login id at the qualify domain unless
14905 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14906
14907 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14908 request similar header line checking. See section &<<SECTthesenhea>>&, which
14909 has more details about &'Sender:'& processing.
14910
14911
14912
14913
14914 .option local_from_prefix main string unset
14915 When Exim checks the &'From:'& header line of locally submitted messages for
14916 matching the login id (see &%local_from_check%& above), it can be configured to
14917 ignore certain prefixes and suffixes in the local part of the address. This is
14918 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14919 appropriate lists, in the same form as the &%local_part_prefix%& and
14920 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14921 example, if
14922 .code
14923 local_from_prefix = *-
14924 .endd
14925 is set, a &'From:'& line containing
14926 .code
14927 From: anything-user@your.domain.example
14928 .endd
14929 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14930 matches the actual sender address that is constructed from the login name and
14931 qualify domain.
14932
14933
14934 .option local_from_suffix main string unset
14935 See &%local_from_prefix%& above.
14936
14937
14938 .option local_interfaces main "string list" "see below"
14939 This option controls which network interfaces are used by the daemon for
14940 listening; they are also used to identify the local host when routing. Chapter
14941 &<<CHAPinterfaces>>& contains a full description of this option and the related
14942 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14943 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14944 &%local_interfaces%& is
14945 .code
14946 local_interfaces = 0.0.0.0
14947 .endd
14948 when Exim is built without IPv6 support; otherwise it is
14949 .code
14950 local_interfaces = <; ::0 ; 0.0.0.0
14951 .endd
14952
14953 .option local_scan_timeout main time 5m
14954 .cindex "timeout" "for &[local_scan()]& function"
14955 .cindex "&[local_scan()]& function" "timeout"
14956 This timeout applies to the &[local_scan()]& function (see chapter
14957 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14958 the incoming message is rejected with a temporary error if it is an SMTP
14959 message. For a non-SMTP message, the message is dropped and Exim ends with a
14960 non-zero code. The incident is logged on the main and reject logs.
14961
14962
14963
14964 .option local_sender_retain main boolean false
14965 .cindex "&'Sender:'& header line" "retaining from local submission"
14966 When a message is submitted locally (that is, not over a TCP/IP connection) by
14967 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14968 do not want this to happen, you must set &%local_sender_retain%&, and you must
14969 also set &%local_from_check%& to be false (Exim will complain if you do not).
14970 See also the ACL modifier &`control = suppress_local_fixups`&. Section
14971 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
14972
14973
14974
14975
14976 .option localhost_number main string&!! unset
14977 .cindex "host" "locally unique number for"
14978 .cindex "message ids" "with multiple hosts"
14979 .vindex "&$localhost_number$&"
14980 Exim's message ids are normally unique only within the local host. If
14981 uniqueness among a set of hosts is required, each host must set a different
14982 value for the &%localhost_number%& option. The string is expanded immediately
14983 after reading the configuration file (so that a number can be computed from the
14984 host name, for example) and the result of the expansion must be a number in the
14985 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
14986 systems). This is available in subsequent string expansions via the variable
14987 &$localhost_number$&. When &%localhost_number is set%&, the final two
14988 characters of the message id, instead of just being a fractional part of the
14989 time, are computed from the time and the local host number as described in
14990 section &<<SECTmessiden>>&.
14991
14992
14993
14994 .option log_file_path main "string list&!!" "set at compile time"
14995 .cindex "log" "file path for"
14996 This option sets the path which is used to determine the names of Exim's log
14997 files, or indicates that logging is to be to syslog, or both. It is expanded
14998 when Exim is entered, so it can, for example, contain a reference to the host
14999 name. If no specific path is set for the log files at compile or run time,
15000 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15001 they are written in a sub-directory called &_log_& in Exim's spool directory.
15002 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15003 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15004 used. If this string is fixed at your installation (contains no expansion
15005 variables) it is recommended that you do not set this option in the
15006 configuration file, but instead supply the path using LOG_FILE_PATH in
15007 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15008 early on &-- in particular, failure to read the configuration file.
15009
15010
15011 .option log_selector main string unset
15012 .cindex "log" "selectors"
15013 This option can be used to reduce or increase the number of things that Exim
15014 writes to its log files. Its argument is made up of names preceded by plus or
15015 minus characters. For example:
15016 .code
15017 log_selector = +arguments -retry_defer
15018 .endd
15019 A list of possible names and what they control is given in the chapter on
15020 logging, in section &<<SECTlogselector>>&.
15021
15022
15023 .option log_timezone main boolean false
15024 .cindex "log" "timezone for entries"
15025 .vindex "&$tod_log$&"
15026 .vindex "&$tod_zone$&"
15027 By default, the timestamps on log lines are in local time without the
15028 timezone. This means that if your timezone changes twice a year, the timestamps
15029 in log lines are ambiguous for an hour when the clocks go back. One way of
15030 avoiding this problem is to set the timezone to UTC. An alternative is to set
15031 &%log_timezone%& true. This turns on the addition of the timezone offset to
15032 timestamps in log lines. Turning on this option can add quite a lot to the size
15033 of log files because each line is extended by 6 characters. Note that the
15034 &$tod_log$& variable contains the log timestamp without the zone, but there is
15035 another variable called &$tod_zone$& that contains just the timezone offset.
15036
15037
15038 .option lookup_open_max main integer 25
15039 .cindex "too many open files"
15040 .cindex "open files, too many"
15041 .cindex "file" "too many open"
15042 .cindex "lookup" "maximum open files"
15043 .cindex "limit" "open files for lookups"
15044 This option limits the number of simultaneously open files for single-key
15045 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15046 Exim normally keeps these files open during routing, because often the same
15047 file is required several times. If the limit is reached, Exim closes the least
15048 recently used file. Note that if you are using the &'ndbm'& library, it
15049 actually opens two files for each logical DBM database, though it still counts
15050 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15051 open files"& errors with NDBM, you need to reduce the value of
15052 &%lookup_open_max%&.
15053
15054
15055 .option max_username_length main integer 0
15056 .cindex "length of login name"
15057 .cindex "user name" "maximum length"
15058 .cindex "limit" "user name length"
15059 Some operating systems are broken in that they truncate long arguments to
15060 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15061 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15062 an argument that is longer behaves as if &[getpwnam()]& failed.
15063
15064
15065 .option message_body_newlines main bool false
15066 .cindex "message body" "newlines in variables"
15067 .cindex "newline" "in message body variables"
15068 .vindex "&$message_body$&"
15069 .vindex "&$message_body_end$&"
15070 By default, newlines in the message body are replaced by spaces when setting
15071 the &$message_body$& and &$message_body_end$& expansion variables. If this
15072 option is set true, this no longer happens.
15073
15074
15075 .option message_body_visible main integer 500
15076 .cindex "body of message" "visible size"
15077 .cindex "message body" "visible size"
15078 .vindex "&$message_body$&"
15079 .vindex "&$message_body_end$&"
15080 This option specifies how much of a message's body is to be included in the
15081 &$message_body$& and &$message_body_end$& expansion variables.
15082
15083
15084 .option message_id_header_domain main string&!! unset
15085 .cindex "&'Message-ID:'& header line"
15086 If this option is set, the string is expanded and used as the right hand side
15087 (domain) of the &'Message-ID:'& header that Exim creates if a
15088 locally-originated incoming message does not have one. &"Locally-originated"&
15089 means &"not received over TCP/IP."&
15090 Otherwise, the primary host name is used.
15091 Only letters, digits, dot and hyphen are accepted; any other characters are
15092 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15093 empty string, the option is ignored.
15094
15095
15096 .option message_id_header_text main string&!! unset
15097 If this variable is set, the string is expanded and used to augment the text of
15098 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15099 message does not have one. The text of this header is required by RFC 2822 to
15100 take the form of an address. By default, Exim uses its internal message id as
15101 the local part, and the primary host name as the domain. If this option is set,
15102 it is expanded, and provided the expansion is not forced to fail, and does not
15103 yield an empty string, the result is inserted into the header immediately
15104 before the @, separated from the internal message id by a dot. Any characters
15105 that are illegal in an address are automatically converted into hyphens. This
15106 means that variables such as &$tod_log$& can be used, because the spaces and
15107 colons will become hyphens.
15108
15109
15110 .option message_logs main boolean true
15111 .cindex "message logs" "disabling"
15112 .cindex "log" "message log; disabling"
15113 If this option is turned off, per-message log files are not created in the
15114 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15115 Exim, by reducing the number of files involved in handling a message from a
15116 minimum of four (header spool file, body spool file, delivery journal, and
15117 per-message log) to three. The other major I/O activity is Exim's main log,
15118 which is not affected by this option.
15119
15120
15121 .option message_size_limit main string&!! 50M
15122 .cindex "message" "size limit"
15123 .cindex "limit" "message size"
15124 .cindex "size" "of message, limit"
15125 This option limits the maximum size of message that Exim will process. The
15126 value is expanded for each incoming connection so, for example, it can be made
15127 to depend on the IP address of the remote host for messages arriving via
15128 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15129 optionally followed by K or M.
15130
15131 &*Note*&: This limit cannot be made to depend on a message's sender or any
15132 other properties of an individual message, because it has to be advertised in
15133 the server's response to EHLO. String expansion failure causes a temporary
15134 error. A value of zero means no limit, but its use is not recommended. See also
15135 &%bounce_return_size_limit%&.
15136
15137 Incoming SMTP messages are failed with a 552 error if the limit is
15138 exceeded; locally-generated messages either get a stderr message or a delivery
15139 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15140 an oversized message is logged in both the main and the reject logs. See also
15141 the generic transport option &%message_size_limit%&, which limits the size of
15142 message that an individual transport can process.
15143
15144 If you use a virus-scanner and set this option to to a value larger than the
15145 maximum size that your virus-scanner is configured to support, you may get
15146 failures triggered by large mails.  The right size to configure for the
15147 virus-scanner depends upon what data is passed and the options in use but it's
15148 probably safest to just set it to a little larger than this value.  Eg, with a
15149 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15150 some problems may result.
15151
15152 A value of 0 will disable size limit checking; Exim will still advertise the
15153 SIZE extension in an EHLO response, but without a limit, so as to permit
15154 SMTP clients to still indicate the message size along with the MAIL verb.
15155
15156
15157 .option move_frozen_messages main boolean false
15158 .cindex "frozen messages" "moving"
15159 This option, which is available only if Exim has been built with the setting
15160 .code
15161 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15162 .endd
15163 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15164 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15165 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15166 standard utilities for handling such moved messages, and they do not show up in
15167 lists generated by &%-bp%& or by the Exim monitor.
15168
15169
15170 .option mua_wrapper main boolean false
15171 Setting this option true causes Exim to run in a very restrictive mode in which
15172 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15173 contains a full description of this facility.
15174
15175
15176
15177 .option mysql_servers main "string list" unset
15178 .cindex "MySQL" "server list"
15179 This option provides a list of MySQL servers and associated connection data, to
15180 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15181 option is available only if Exim has been built with MySQL support.
15182
15183
15184 .option never_users main "string list&!!" unset
15185 This option is expanded just once, at the start of Exim's processing. Local
15186 message deliveries are normally run in processes that are setuid to the
15187 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15188 It is usually desirable to prevent any deliveries from running as root, as a
15189 safety precaution.
15190
15191 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15192 list of users that must not be used for local deliveries. This list is fixed in
15193 the binary and cannot be overridden by the configuration file. By default, it
15194 contains just the single user name &"root"&. The &%never_users%& runtime option
15195 can be used to add more users to the fixed list.
15196
15197 If a message is to be delivered as one of the users on the fixed list or the
15198 &%never_users%& list, an error occurs, and delivery is deferred. A common
15199 example is
15200 .code
15201 never_users = root:daemon:bin
15202 .endd
15203 Including root is redundant if it is also on the fixed list, but it does no
15204 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15205 transport driver.
15206
15207
15208 .option openssl_options main "string list" "+no_sslv2"
15209 .cindex "OpenSSL "compatibility options"
15210 This option allows an administrator to adjust the SSL options applied
15211 by OpenSSL to connections.  It is given as a space-separated list of items,
15212 each one to be +added or -subtracted from the current value.
15213
15214 This option is only available if Exim is built against OpenSSL.  The values
15215 available for this option vary according to the age of your OpenSSL install.
15216 The &"all"& value controls a subset of flags which are available, typically
15217 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15218 list the values known on your system and Exim should support all the
15219 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15220 names lose the leading &"SSL_OP_"& and are lower-cased.
15221
15222 Note that adjusting the options can have severe impact upon the security of
15223 SSL as used by Exim.  It is possible to disable safety checks and shoot
15224 yourself in the foot in various unpleasant ways.  This option should not be
15225 adjusted lightly.  An unrecognised item will be detected at startup, by
15226 invoking Exim with the &%-bV%& flag.
15227
15228 The option affects Exim operating both as a server and as a client.
15229
15230 Historical note: prior to release 4.80, Exim defaulted this value to
15231 "+dont_insert_empty_fragments", which may still be needed for compatibility
15232 with some clients, but which lowers security by increasing exposure to
15233 some now infamous attacks.
15234
15235 Examples:
15236 .code
15237 # Make both old MS and old Eudora happy:
15238 openssl_options = -all +microsoft_big_sslv3_buffer \
15239                        +dont_insert_empty_fragments
15240
15241 # Disable older protocol versions:
15242 openssl_options = +no_sslv2 +no_sslv3
15243 .endd
15244
15245 Possible options may include:
15246 .ilist
15247 &`all`&
15248 .next
15249 &`allow_unsafe_legacy_renegotiation`&
15250 .next
15251 &`cipher_server_preference`&
15252 .next
15253 &`dont_insert_empty_fragments`&
15254 .next
15255 &`ephemeral_rsa`&
15256 .next
15257 &`legacy_server_connect`&
15258 .next
15259 &`microsoft_big_sslv3_buffer`&
15260 .next
15261 &`microsoft_sess_id_bug`&
15262 .next
15263 &`msie_sslv2_rsa_padding`&
15264 .next
15265 &`netscape_challenge_bug`&
15266 .next
15267 &`netscape_reuse_cipher_change_bug`&
15268 .next
15269 &`no_compression`&
15270 .next
15271 &`no_session_resumption_on_renegotiation`&
15272 .next
15273 &`no_sslv2`&
15274 .next
15275 &`no_sslv3`&
15276 .next
15277 &`no_ticket`&
15278 .next
15279 &`no_tlsv1`&
15280 .next
15281 &`no_tlsv1_1`&
15282 .next
15283 &`no_tlsv1_2`&
15284 .next
15285 &`safari_ecdhe_ecdsa_bug`&
15286 .next
15287 &`single_dh_use`&
15288 .next
15289 &`single_ecdh_use`&
15290 .next
15291 &`ssleay_080_client_dh_bug`&
15292 .next
15293 &`sslref2_reuse_cert_type_bug`&
15294 .next
15295 &`tls_block_padding_bug`&
15296 .next
15297 &`tls_d5_bug`&
15298 .next
15299 &`tls_rollback_bug`&
15300 .endlist
15301
15302 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15303 all clients connecting using the MacOS SecureTransport TLS facility prior
15304 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15305 to negotiate TLS then this option value might help, provided that your OpenSSL
15306 release is new enough to contain this work-around.  This may be a situation
15307 where you have to upgrade OpenSSL to get buggy clients working.
15308
15309
15310 .option oracle_servers main "string list" unset
15311 .cindex "Oracle" "server list"
15312 This option provides a list of Oracle servers and associated connection data,
15313 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15314 The option is available only if Exim has been built with Oracle support.
15315
15316
15317 .option percent_hack_domains main "domain list&!!" unset
15318 .cindex "&""percent hack""&"
15319 .cindex "source routing" "in email address"
15320 .cindex "address" "source-routed"
15321 The &"percent hack"& is the convention whereby a local part containing a
15322 percent sign is re-interpreted as a new email address, with the percent
15323 replaced by @. This is sometimes called &"source routing"&, though that term is
15324 also applied to RFC 2822 addresses that begin with an @ character. If this
15325 option is set, Exim implements the percent facility for those domains listed,
15326 but no others. This happens before an incoming SMTP address is tested against
15327 an ACL.
15328
15329 &*Warning*&: The &"percent hack"& has often been abused by people who are
15330 trying to get round relaying restrictions. For this reason, it is best avoided
15331 if at all possible. Unfortunately, a number of less security-conscious MTAs
15332 implement it unconditionally. If you are running Exim on a gateway host, and
15333 routing mail through to internal MTAs without processing the local parts, it is
15334 a good idea to reject recipient addresses with percent characters in their
15335 local parts. Exim's default configuration does this.
15336
15337
15338 .option perl_at_start main boolean false
15339 This option is available only when Exim is built with an embedded Perl
15340 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15341
15342
15343 .option perl_startup main string unset
15344 This option is available only when Exim is built with an embedded Perl
15345 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15346
15347
15348 .option pgsql_servers main "string list" unset
15349 .cindex "PostgreSQL lookup type" "server list"
15350 This option provides a list of PostgreSQL servers and associated connection
15351 data, to be used in conjunction with &(pgsql)& lookups (see section
15352 &<<SECID72>>&). The option is available only if Exim has been built with
15353 PostgreSQL support.
15354
15355
15356 .option pid_file_path main string&!! "set at compile time"
15357 .cindex "daemon" "pid file path"
15358 .cindex "pid file, path for"
15359 This option sets the name of the file to which the Exim daemon writes its
15360 process id. The string is expanded, so it can contain, for example, references
15361 to the host name:
15362 .code
15363 pid_file_path = /var/log/$primary_hostname/exim.pid
15364 .endd
15365 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15366 spool directory.
15367 The value set by the option can be overridden by the &%-oP%& command line
15368 option. A pid file is not written if a &"non-standard"& daemon is run by means
15369 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15370
15371
15372 .option pipelining_advertise_hosts main "host list&!!" *
15373 .cindex "PIPELINING" "suppressing advertising"
15374 This option can be used to suppress the advertisement of the SMTP
15375 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15376 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15377 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15378 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15379 that clients will use it; &"out of order"& commands that are &"expected"& do
15380 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15381
15382
15383 .option prdr_enable main boolean false
15384 .cindex "PRDR" "enabling on server"
15385 This option can be used to enable the Per-Recipient Data Response extension
15386 to SMTP, defined by Eric Hall.
15387 If the option is set, PRDR is advertised by Exim when operating as a server.
15388 If the client requests PRDR, and more than one recipient, for a message 
15389 an additional ACL is called for each recipient after the message content
15390 is recieved.  See section &<<SECTPRDRACL>>&.
15391
15392 .option preserve_message_logs main boolean false
15393 .cindex "message logs" "preserving"
15394 If this option is set, message log files are not deleted when messages are
15395 completed. Instead, they are moved to a sub-directory of the spool directory
15396 called &_msglog.OLD_&, where they remain available for statistical or debugging
15397 purposes. This is a dangerous option to set on systems with any appreciable
15398 volume of mail. Use with care!
15399
15400
15401 .option primary_hostname main string "see below"
15402 .cindex "name" "of local host"
15403 .cindex "host" "name of local"
15404 .cindex "local host" "name of"
15405 .vindex "&$primary_hostname$&"
15406 This specifies the name of the current host. It is used in the default EHLO or
15407 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15408 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15409 The value is also used by default in some SMTP response messages from an Exim
15410 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15411
15412 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15413 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15414 contains only one component, Exim passes it to &[gethostbyname()]& (or
15415 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15416 version. The variable &$primary_hostname$& contains the host name, whether set
15417 explicitly by this option, or defaulted.
15418
15419
15420 .option print_topbitchars main boolean false
15421 .cindex "printing characters"
15422 .cindex "8-bit characters"
15423 By default, Exim considers only those characters whose codes lie in the range
15424 32&--126 to be printing characters. In a number of circumstances (for example,
15425 when writing log entries) non-printing characters are converted into escape
15426 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15427 is set, code values of 128 and above are also considered to be printing
15428 characters.
15429
15430 This option also affects the header syntax checks performed by the
15431 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15432 the user's full name when constructing From: and Sender: addresses (as
15433 described in section &<<SECTconstr>>&). Setting this option can cause
15434 Exim to generate eight bit message headers that do not conform to the
15435 standards.
15436
15437
15438 .option process_log_path main string unset
15439 .cindex "process log path"
15440 .cindex "log" "process log"
15441 .cindex "&'exiwhat'&"
15442 This option sets the name of the file to which an Exim process writes its
15443 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15444 utility script. If this option is unset, the file called &_exim-process.info_&
15445 in Exim's spool directory is used. The ability to specify the name explicitly
15446 can be useful in environments where two different Exims are running, using
15447 different spool directories.
15448
15449
15450 .option prod_requires_admin main boolean true
15451 .oindex "&%-M%&"
15452 .oindex "&%-R%&"
15453 .oindex "&%-q%&"
15454 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15455 admin user unless &%prod_requires_admin%& is set false. See also
15456 &%queue_list_requires_admin%&.
15457
15458
15459 .option qualify_domain main string "see below"
15460 .cindex "domain" "for qualifying addresses"
15461 .cindex "address" "qualification"
15462 This option specifies the domain name that is added to any envelope sender
15463 addresses that do not have a domain qualification. It also applies to
15464 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15465 are accepted by default only for locally-generated messages. Qualification is
15466 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15467 locally-generated messages, unless the &%-bnq%& command line option is used.
15468
15469 Messages from external sources must always contain fully qualified addresses,
15470 unless the sending host matches &%sender_unqualified_hosts%& or
15471 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15472 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15473 necessary. Internally, Exim always works with fully qualified envelope
15474 addresses. If &%qualify_domain%& is not set, it defaults to the
15475 &%primary_hostname%& value.
15476
15477
15478 .option qualify_recipient main string "see below"
15479 This option allows you to specify a different domain for qualifying recipient
15480 addresses to the one that is used for senders. See &%qualify_domain%& above.
15481
15482
15483
15484 .option queue_domains main "domain list&!!" unset
15485 .cindex "domain" "specifying non-immediate delivery"
15486 .cindex "queueing incoming messages"
15487 .cindex "message" "queueing certain domains"
15488 This option lists domains for which immediate delivery is not required.
15489 A delivery process is started whenever a message is received, but only those
15490 domains that do not match are processed. All other deliveries wait until the
15491 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15492
15493
15494 .option queue_list_requires_admin main boolean true
15495 .oindex "&%-bp%&"
15496 The &%-bp%& command-line option, which lists the messages that are on the
15497 queue, requires the caller to be an admin user unless
15498 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15499
15500
15501 .option queue_only main boolean false
15502 .cindex "queueing incoming messages"
15503 .cindex "message" "queueing unconditionally"
15504 If &%queue_only%& is set, a delivery process is not automatically started
15505 whenever a message is received. Instead, the message waits on the queue for the
15506 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15507 delivered immediately when certain conditions (such as heavy load) occur.
15508
15509 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15510 and &%-odi%& command line options override &%queue_only%& unless
15511 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15512 &%queue_only_load%&, and &%smtp_accept_queue%&.
15513
15514
15515 .option queue_only_file main string unset
15516 .cindex "queueing incoming messages"
15517 .cindex "message" "queueing by file existence"
15518 This option can be set to a colon-separated list of absolute path names, each
15519 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15520 it tests for the existence of each listed path using a call to &[stat()]&. For
15521 each path that exists, the corresponding queueing option is set.
15522 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15523 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15524 .code
15525 queue_only_file = smtp/some/file
15526 .endd
15527 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15528 &_/some/file_& exists.
15529
15530
15531 .option queue_only_load main fixed-point unset
15532 .cindex "load average"
15533 .cindex "queueing incoming messages"
15534 .cindex "message" "queueing by load"
15535 If the system load average is higher than this value, incoming messages from
15536 all sources are queued, and no automatic deliveries are started. If this
15537 happens during local or remote SMTP input, all subsequent messages received on
15538 the same SMTP connection are queued by default, whatever happens to the load in
15539 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15540 false.
15541
15542 Deliveries will subsequently be performed by queue runner processes. This
15543 option has no effect on ancient operating systems on which Exim cannot
15544 determine the load average. See also &%deliver_queue_load_max%& and
15545 &%smtp_load_reserve%&.
15546
15547
15548 .option queue_only_load_latch main boolean true
15549 .cindex "load average" "re-evaluating per message"
15550 When this option is true (the default), once one message has been queued
15551 because the load average is higher than the value set by &%queue_only_load%&,
15552 all subsequent messages received on the same SMTP connection are also queued.
15553 This is a deliberate choice; even though the load average may fall below the
15554 threshold, it doesn't seem right to deliver later messages on the same
15555 connection when not delivering earlier ones. However, there are special
15556 circumstances such as very long-lived connections from scanning appliances
15557 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15558 should be set false. This causes the value of the load average to be
15559 re-evaluated for each message.
15560
15561
15562 .option queue_only_override main boolean true
15563 .cindex "queueing incoming messages"
15564 When this option is true, the &%-od%&&'x'& command line options override the
15565 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15566 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15567 to override; they are accepted, but ignored.
15568
15569
15570 .option queue_run_in_order main boolean false
15571 .cindex "queue runner" "processing messages in order"
15572 If this option is set, queue runs happen in order of message arrival instead of
15573 in an arbitrary order. For this to happen, a complete list of the entire queue
15574 must be set up before the deliveries start. When the queue is all held in a
15575 single directory (the default), a single list is created for both the ordered
15576 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15577 single list is not created when &%queue_run_in_order%& is false. In this case,
15578 the sub-directories are processed one at a time (in a random order), and this
15579 avoids setting up one huge list for the whole queue. Thus, setting
15580 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15581 when the queue is large, because of the extra work in setting up the single,
15582 large list. In most situations, &%queue_run_in_order%& should not be set.
15583
15584
15585
15586 .option queue_run_max main integer 5
15587 .cindex "queue runner" "maximum number of"
15588 This controls the maximum number of queue runner processes that an Exim daemon
15589 can run simultaneously. This does not mean that it starts them all at once,
15590 but rather that if the maximum number are still running when the time comes to
15591 start another one, it refrains from starting another one. This can happen with
15592 very large queues and/or very sluggish deliveries. This option does not,
15593 however, interlock with other processes, so additional queue runners can be
15594 started by other means, or by killing and restarting the daemon.
15595
15596 Setting this option to zero does not suppress queue runs; rather, it disables
15597 the limit, allowing any number of simultaneous queue runner processes to be
15598 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15599 the daemon's command line.
15600
15601 .option queue_smtp_domains main "domain list&!!" unset
15602 .cindex "queueing incoming messages"
15603 .cindex "message" "queueing remote deliveries"
15604 When this option is set, a delivery process is started whenever a message is
15605 received, routing is performed, and local deliveries take place.
15606 However, if any SMTP deliveries are required for domains that match
15607 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15608 message waits on the queue for the next queue run. Since routing of the message
15609 has taken place, Exim knows to which remote hosts it must be delivered, and so
15610 when the queue run happens, multiple messages for the same host are delivered
15611 over a single SMTP connection. The &%-odqs%& command line option causes all
15612 SMTP deliveries to be queued in this way, and is equivalent to setting
15613 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15614 &%queue_domains%&.
15615
15616
15617 .option receive_timeout main time 0s
15618 .cindex "timeout" "for non-SMTP input"
15619 This option sets the timeout for accepting a non-SMTP message, that is, the
15620 maximum time that Exim waits when reading a message on the standard input. If
15621 the value is zero, it will wait for ever. This setting is overridden by the
15622 &%-or%& command line option. The timeout for incoming SMTP messages is
15623 controlled by &%smtp_receive_timeout%&.
15624
15625 .option received_header_text main string&!! "see below"
15626 .cindex "customizing" "&'Received:'& header"
15627 .cindex "&'Received:'& header line" "customizing"
15628 This string defines the contents of the &'Received:'& message header that is
15629 added to each message, except for the timestamp, which is automatically added
15630 on at the end (preceded by a semicolon). The string is expanded each time it is
15631 used. If the expansion yields an empty string, no &'Received:'& header line is
15632 added to the message. Otherwise, the string should start with the text
15633 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15634 header lines. The default setting is:
15635
15636 .code
15637 received_header_text = Received: \
15638   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15639   {${if def:sender_ident \
15640   {from ${quote_local_part:$sender_ident} }}\
15641   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15642   by $primary_hostname \
15643   ${if def:received_protocol {with $received_protocol}} \
15644   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15645   (Exim $version_number)\n\t\
15646   ${if def:sender_address \
15647   {(envelope-from <$sender_address>)\n\t}}\
15648   id $message_exim_id\
15649   ${if def:received_for {\n\tfor $received_for}}
15650 .endd
15651
15652 The reference to the TLS cipher is omitted when Exim is built without TLS
15653 support. The use of conditional expansions ensures that this works for both
15654 locally generated messages and messages received from remote hosts, giving
15655 header lines such as the following:
15656 .code
15657 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15658 by marley.carol.example with esmtp (Exim 4.00)
15659 (envelope-from <bob@carol.example>)
15660 id 16IOWa-00019l-00
15661 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15662 Received: by scrooge.carol.example with local (Exim 4.00)
15663 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15664 .endd
15665 Until the body of the message has been received, the timestamp is the time when
15666 the message started to be received. Once the body has arrived, and all policy
15667 checks have taken place, the timestamp is updated to the time at which the
15668 message was accepted.
15669
15670
15671 .option received_headers_max main integer 30
15672 .cindex "loop" "prevention"
15673 .cindex "mail loop prevention"
15674 .cindex "&'Received:'& header line" "counting"
15675 When a message is to be delivered, the number of &'Received:'& headers is
15676 counted, and if it is greater than this parameter, a mail loop is assumed to
15677 have occurred, the delivery is abandoned, and an error message is generated.
15678 This applies to both local and remote deliveries.
15679
15680
15681 .option recipient_unqualified_hosts main "host list&!!" unset
15682 .cindex "unqualified addresses"
15683 .cindex "host" "unqualified addresses from"
15684 This option lists those hosts from which Exim is prepared to accept unqualified
15685 recipient addresses in message envelopes. The addresses are made fully
15686 qualified by the addition of the &%qualify_recipient%& value. This option also
15687 affects message header lines. Exim does not reject unqualified recipient
15688 addresses in headers, but it qualifies them only if the message came from a
15689 host that matches &%recipient_unqualified_hosts%&,
15690 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15691 option was not set.
15692
15693
15694 .option recipients_max main integer 0
15695 .cindex "limit" "number of recipients"
15696 .cindex "recipient" "maximum number"
15697 If this option is set greater than zero, it specifies the maximum number of
15698 original recipients for any message. Additional recipients that are generated
15699 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15700 all recipients over the limit; earlier recipients are delivered as normal.
15701 Non-SMTP messages with too many recipients are failed, and no deliveries are
15702 done.
15703
15704 .cindex "RCPT" "maximum number of incoming"
15705 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15706 RCPT commands in a single message.
15707
15708
15709 .option recipients_max_reject main boolean false
15710 If this option is set true, Exim rejects SMTP messages containing too many
15711 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15712 error to the eventual DATA command. Otherwise (the default) it gives a 452
15713 error to the surplus RCPT commands and accepts the message on behalf of the
15714 initial set of recipients. The remote server should then re-send the message
15715 for the remaining recipients at a later time.
15716
15717
15718 .option remote_max_parallel main integer 2
15719 .cindex "delivery" "parallelism for remote"
15720 This option controls parallel delivery of one message to a number of remote
15721 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15722 does all the remote deliveries for a message one by one. Otherwise, if a single
15723 message has to be delivered to more than one remote host, or if several copies
15724 have to be sent to the same remote host, up to &%remote_max_parallel%&
15725 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15726 deliveries are required, the maximum number of processes are started, and as
15727 each one finishes, another is begun. The order of starting processes is the
15728 same as if sequential delivery were being done, and can be controlled by the
15729 &%remote_sort_domains%& option. If parallel delivery takes place while running
15730 with debugging turned on, the debugging output from each delivery process is
15731 tagged with its process id.
15732
15733 This option controls only the maximum number of parallel deliveries for one
15734 message in one Exim delivery process. Because Exim has no central queue
15735 manager, there is no way of controlling the total number of simultaneous
15736 deliveries if the configuration allows a delivery attempt as soon as a message
15737 is received.
15738
15739 .cindex "number of deliveries"
15740 .cindex "delivery" "maximum number of"
15741 If you want to control the total number of deliveries on the system, you
15742 need to set the &%queue_only%& option. This ensures that all incoming messages
15743 are added to the queue without starting a delivery process. Then set up an Exim
15744 daemon to start queue runner processes at appropriate intervals (probably
15745 fairly often, for example, every minute), and limit the total number of queue
15746 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15747 delivers only one message at a time, the maximum number of deliveries that can
15748 then take place at once is &%queue_run_max%& multiplied by
15749 &%remote_max_parallel%&.
15750
15751 If it is purely remote deliveries you want to control, use
15752 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15753 doing the SMTP routing before queueing, so that several messages for the same
15754 host will eventually get delivered down the same connection.
15755
15756
15757 .option remote_sort_domains main "domain list&!!" unset
15758 .cindex "sorting remote deliveries"
15759 .cindex "delivery" "sorting remote"
15760 When there are a number of remote deliveries for a message, they are sorted by
15761 domain into the order given by this list. For example,
15762 .code
15763 remote_sort_domains = *.cam.ac.uk:*.uk
15764 .endd
15765 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15766 then to those in the &%uk%& domain, then to any others.
15767
15768
15769 .option retry_data_expire main time 7d
15770 .cindex "hints database" "data expiry"
15771 This option sets a &"use before"& time on retry information in Exim's hints
15772 database. Any older retry data is ignored. This means that, for example, once a
15773 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15774 past failures.
15775
15776
15777 .option retry_interval_max main time 24h
15778 .cindex "retry" "limit on interval"
15779 .cindex "limit" "on retry interval"
15780 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15781 intervals between delivery attempts for messages that cannot be delivered
15782 straight away. This option sets an overall limit to the length of time between
15783 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15784 the default value.
15785
15786
15787 .option return_path_remove main boolean true
15788 .cindex "&'Return-path:'& header line" "removing"
15789 RFC 2821, section 4.4, states that an SMTP server must insert a
15790 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15791 The &'Return-path:'& header preserves the sender address as received in the
15792 MAIL command. This description implies that this header should not be present
15793 in an incoming message. If &%return_path_remove%& is true, any existing
15794 &'Return-path:'& headers are removed from messages at the time they are
15795 received. Exim's transports have options for adding &'Return-path:'& headers at
15796 the time of delivery. They are normally used only for final local deliveries.
15797
15798
15799 .option return_size_limit main integer 100K
15800 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15801
15802
15803 .new
15804 .option rfc1413_hosts main "host list&!!" @[]
15805 .cindex "RFC 1413"
15806 .cindex "host" "for RFC 1413 calls"
15807 RFC 1413 identification calls are made to any client host which matches
15808 an item in the list.
15809 The default value specifies just this host, being any local interface
15810 for the system.
15811 .wen
15812
15813 .new
15814 .option rfc1413_query_timeout main time 0s
15815 .wen
15816 .cindex "RFC 1413" "query timeout"
15817 .cindex "timeout" "for RFC 1413 call"
15818 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15819 no RFC 1413 calls are ever made.
15820
15821
15822 .option sender_unqualified_hosts main "host list&!!" unset
15823 .cindex "unqualified addresses"
15824 .cindex "host" "unqualified addresses from"
15825 This option lists those hosts from which Exim is prepared to accept unqualified
15826 sender addresses. The addresses are made fully qualified by the addition of
15827 &%qualify_domain%&. This option also affects message header lines. Exim does
15828 not reject unqualified addresses in headers that contain sender addresses, but
15829 it qualifies them only if the message came from a host that matches
15830 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15831 using TCP/IP), and the &%-bnq%& option was not set.
15832
15833
15834 .option slow_lookup_log main integer 0
15835 .cindex "logging" "slow lookups"
15836 .cindex "dns" "logging slow lookups"
15837 This option controls logging of slow lookups.
15838 If the value is nonzero it is taken as a number of milliseconds
15839 and lookups taking longer than this are logged.
15840 Currently this applies only to DNS lookups.
15841
15842
15843
15844 .option smtp_accept_keepalive main boolean true
15845 .cindex "keepalive" "on incoming connection"
15846 This option controls the setting of the SO_KEEPALIVE option on incoming
15847 TCP/IP socket connections. When set, it causes the kernel to probe idle
15848 connections periodically, by sending packets with &"old"& sequence numbers. The
15849 other end of the connection should send an acknowledgment if the connection is
15850 still okay or a reset if the connection has been aborted. The reason for doing
15851 this is that it has the beneficial effect of freeing up certain types of
15852 connection that can get stuck when the remote host is disconnected without
15853 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15854 hours to detect unreachable hosts.
15855
15856
15857
15858 .option smtp_accept_max main integer 20
15859 .cindex "limit" "incoming SMTP connections"
15860 .cindex "SMTP" "incoming connection count"
15861 .cindex "inetd"
15862 This option specifies the maximum number of simultaneous incoming SMTP calls
15863 that Exim will accept. It applies only to the listening daemon; there is no
15864 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15865 value is set to zero, no limit is applied. However, it is required to be
15866 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15867 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15868
15869 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15870 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15871 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15872 and &%smtp_load_reserve%& are then checked before accepting the connection.
15873
15874
15875 .option smtp_accept_max_nonmail main integer 10
15876 .cindex "limit" "non-mail SMTP commands"
15877 .cindex "SMTP" "limiting non-mail commands"
15878 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15879 the connection if there are too many. This option defines &"too many"&. The
15880 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15881 client looping sending EHLO, for example. The check is applied only if the
15882 client host matches &%smtp_accept_max_nonmail_hosts%&.
15883
15884 When a new message is expected, one occurrence of RSET is not counted. This
15885 allows a client to send one RSET between messages (this is not necessary,
15886 but some clients do it). Exim also allows one uncounted occurrence of HELO
15887 or EHLO, and one occurrence of STARTTLS between messages. After
15888 starting up a TLS session, another EHLO is expected, and so it too is not
15889 counted. The first occurrence of AUTH in a connection, or immediately
15890 following STARTTLS is not counted. Otherwise, all commands other than
15891 MAIL, RCPT, DATA, and QUIT are counted.
15892
15893
15894 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15895 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15896 check by setting this option. The default value makes it apply to all hosts. By
15897 changing the value, you can exclude any badly-behaved hosts that you have to
15898 live with.
15899
15900
15901 . Allow this long option name to split; give it unsplit as a fifth argument
15902 . for the automatic .oindex that is generated by .option.
15903 . We insert " &~&~" which is both pretty nasty visually and results in
15904 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15905 . zero-width-space, which would be nicer visually and results in (at least)
15906 . html that Firefox will split on when it's forced to reflow (rather than
15907 . inserting a horizontal scrollbar).  However, the text is still not
15908 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15909 . the option name to split.
15910
15911 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15912          smtp_accept_max_per_connection
15913 .cindex "SMTP" "limiting incoming message count"
15914 .cindex "limit" "messages per SMTP connection"
15915 The value of this option limits the number of MAIL commands that Exim is
15916 prepared to accept over a single SMTP connection, whether or not each command
15917 results in the transfer of a message. After the limit is reached, a 421
15918 response is given to subsequent MAIL commands. This limit is a safety
15919 precaution against a client that goes mad (incidents of this type have been
15920 seen).
15921
15922
15923 .option smtp_accept_max_per_host main string&!! unset
15924 .cindex "limit" "SMTP connections from one host"
15925 .cindex "host" "limiting SMTP connections from"
15926 This option restricts the number of simultaneous IP connections from a single
15927 host (strictly, from a single IP address) to the Exim daemon. The option is
15928 expanded, to enable different limits to be applied to different hosts by
15929 reference to &$sender_host_address$&. Once the limit is reached, additional
15930 connection attempts from the same host are rejected with error code 421. This
15931 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15932 of zero imposes no limit. If this option is set greater than zero, it is
15933 required that &%smtp_accept_max%& be non-zero.
15934
15935 &*Warning*&: When setting this option you should not use any expansion
15936 constructions that take an appreciable amount of time. The expansion and test
15937 happen in the main daemon loop, in order to reject additional connections
15938 without forking additional processes (otherwise a denial-of-service attack
15939 could cause a vast number or processes to be created). While the daemon is
15940 doing this processing, it cannot accept any other incoming connections.
15941
15942
15943
15944 .option smtp_accept_queue main integer 0
15945 .cindex "SMTP" "incoming connection count"
15946 .cindex "queueing incoming messages"
15947 .cindex "message" "queueing by SMTP connection count"
15948 If the number of simultaneous incoming SMTP connections being handled via the
15949 listening daemon exceeds this value, messages received by SMTP are just placed
15950 on the queue; no delivery processes are started automatically. The count is
15951 fixed at the start of an SMTP connection. It cannot be updated in the
15952 subprocess that receives messages, and so the queueing or not queueing applies
15953 to all messages received in the same connection.
15954
15955 A value of zero implies no limit, and clearly any non-zero value is useful only
15956 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15957 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15958 various &%-od%&&'x'& command line options.
15959
15960
15961 . See the comment on smtp_accept_max_per_connection
15962
15963 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15964          smtp_accept_queue_per_connection
15965 .cindex "queueing incoming messages"
15966 .cindex "message" "queueing by message count"
15967 This option limits the number of delivery processes that Exim starts
15968 automatically when receiving messages via SMTP, whether via the daemon or by
15969 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
15970 and the number of messages received in a single SMTP session exceeds this
15971 number, subsequent messages are placed on the queue, but no delivery processes
15972 are started. This helps to limit the number of Exim processes when a server
15973 restarts after downtime and there is a lot of mail waiting for it on other
15974 systems. On large systems, the default should probably be increased, and on
15975 dial-in client systems it should probably be set to zero (that is, disabled).
15976
15977
15978 .option smtp_accept_reserve main integer 0
15979 .cindex "SMTP" "incoming call count"
15980 .cindex "host" "reserved"
15981 When &%smtp_accept_max%& is set greater than zero, this option specifies a
15982 number of SMTP connections that are reserved for connections from the hosts
15983 that are specified in &%smtp_reserve_hosts%&. The value set in
15984 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
15985 restricted to this number of connections; the option specifies a minimum number
15986 of connection slots for them, not a maximum. It is a guarantee that this group
15987 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
15988 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
15989 individual host.
15990
15991 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
15992 set to 5, once there are 45 active connections (from any hosts), new
15993 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
15994 provided the other criteria for acceptance are met.
15995
15996
15997 .option smtp_active_hostname main string&!! unset
15998 .cindex "host" "name in SMTP responses"
15999 .cindex "SMTP" "host name in responses"
16000 .vindex "&$primary_hostname$&"
16001 This option is provided for multi-homed servers that want to masquerade as
16002 several different hosts. At the start of an incoming SMTP connection, its value
16003 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16004 responses. For example, it is used as domain name in the response to an
16005 incoming HELO or EHLO command.
16006
16007 .vindex "&$smtp_active_hostname$&"
16008 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16009 is saved with any messages that are received. It is therefore available for use
16010 in routers and transports when the message is later delivered.
16011
16012 If this option is unset, or if its expansion is forced to fail, or if the
16013 expansion results in an empty string, the value of &$primary_hostname$& is
16014 used. Other expansion failures cause a message to be written to the main and
16015 panic logs, and the SMTP command receives a temporary error. Typically, the
16016 value of &%smtp_active_hostname%& depends on the incoming interface address.
16017 For example:
16018 .code
16019 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16020   {cox.mydomain}{box.mydomain}}
16021 .endd
16022
16023 Although &$smtp_active_hostname$& is primarily concerned with incoming
16024 messages, it is also used as the default for HELO commands in callout
16025 verification if there is no remote transport from which to obtain a
16026 &%helo_data%& value.
16027
16028 .option smtp_banner main string&!! "see below"
16029 .cindex "SMTP" "welcome banner"
16030 .cindex "banner for SMTP"
16031 .cindex "welcome banner for SMTP"
16032 .cindex "customizing" "SMTP banner"
16033 This string, which is expanded every time it is used, is output as the initial
16034 positive response to an SMTP connection. The default setting is:
16035 .code
16036 smtp_banner = $smtp_active_hostname ESMTP Exim \
16037   $version_number $tod_full
16038 .endd
16039 Failure to expand the string causes a panic error. If you want to create a
16040 multiline response to the initial SMTP connection, use &"\n"& in the string at
16041 appropriate points, but not at the end. Note that the 220 code is not included
16042 in this string. Exim adds it automatically (several times in the case of a
16043 multiline response).
16044
16045
16046 .option smtp_check_spool_space main boolean true
16047 .cindex "checking disk space"
16048 .cindex "disk space, checking"
16049 .cindex "spool directory" "checking space"
16050 When this option is set, if an incoming SMTP session encounters the SIZE
16051 option on a MAIL command, it checks that there is enough space in the
16052 spool directory's partition to accept a message of that size, while still
16053 leaving free the amount specified by &%check_spool_space%& (even if that value
16054 is zero). If there isn't enough space, a temporary error code is returned.
16055
16056
16057 .option smtp_connect_backlog main integer 20
16058 .cindex "connection backlog"
16059 .cindex "SMTP" "connection backlog"
16060 .cindex "backlog of connections"
16061 This option specifies a maximum number of waiting SMTP connections. Exim passes
16062 this value to the TCP/IP system when it sets up its listener. Once this number
16063 of connections are waiting for the daemon's attention, subsequent connection
16064 attempts are refused at the TCP/IP level. At least, that is what the manuals
16065 say; in some circumstances such connection attempts have been observed to time
16066 out instead. For large systems it is probably a good idea to increase the
16067 value (to 50, say). It also gives some protection against denial-of-service
16068 attacks by SYN flooding.
16069
16070
16071 .option smtp_enforce_sync main boolean true
16072 .cindex "SMTP" "synchronization checking"
16073 .cindex "synchronization checking in SMTP"
16074 The SMTP protocol specification requires the client to wait for a response from
16075 the server at certain points in the dialogue. Without PIPELINING these
16076 synchronization points are after every command; with PIPELINING they are
16077 fewer, but they still exist.
16078
16079 Some spamming sites send out a complete set of SMTP commands without waiting
16080 for any response. Exim protects against this by rejecting a message if the
16081 client has sent further input when it should not have. The error response &"554
16082 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16083 for this error cannot be perfect because of transmission delays (unexpected
16084 input may be on its way but not yet received when Exim checks). However, it
16085 does detect many instances.
16086
16087 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16088 If you want to disable the check selectively (for example, only for certain
16089 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16090 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16091
16092
16093
16094 .option smtp_etrn_command main string&!! unset
16095 .cindex "ETRN" "command to be run"
16096 .vindex "&$domain$&"
16097 If this option is set, the given command is run whenever an SMTP ETRN
16098 command is received from a host that is permitted to issue such commands (see
16099 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16100 are independently expanded. The expansion variable &$domain$& is set to the
16101 argument of the ETRN command, and no syntax checking is done on it. For
16102 example:
16103 .code
16104 smtp_etrn_command = /etc/etrn_command $domain \
16105                     $sender_host_address
16106 .endd
16107 A new process is created to run the command, but Exim does not wait for it to
16108 complete. Consequently, its status cannot be checked. If the command cannot be
16109 run, a line is written to the panic log, but the ETRN caller still receives
16110 a 250 success response. Exim is normally running under its own uid when
16111 receiving SMTP, so it is not possible for it to change the uid before running
16112 the command.
16113
16114
16115 .option smtp_etrn_serialize main boolean true
16116 .cindex "ETRN" "serializing"
16117 When this option is set, it prevents the simultaneous execution of more than
16118 one identical command as a result of ETRN in an SMTP connection. See
16119 section &<<SECTETRN>>& for details.
16120
16121
16122 .option smtp_load_reserve main fixed-point unset
16123 .cindex "load average"
16124 If the system load average ever gets higher than this, incoming SMTP calls are
16125 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16126 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16127 the load is over the limit. The option has no effect on ancient operating
16128 systems on which Exim cannot determine the load average. See also
16129 &%deliver_queue_load_max%& and &%queue_only_load%&.
16130
16131
16132
16133 .option smtp_max_synprot_errors main integer 3
16134 .cindex "SMTP" "limiting syntax and protocol errors"
16135 .cindex "limit" "SMTP syntax and protocol errors"
16136 Exim rejects SMTP commands that contain syntax or protocol errors. In
16137 particular, a syntactically invalid email address, as in this command:
16138 .code
16139 RCPT TO:<abc xyz@a.b.c>
16140 .endd
16141 causes immediate rejection of the command, before any other tests are done.
16142 (The ACL cannot be run if there is no valid address to set up for it.) An
16143 example of a protocol error is receiving RCPT before MAIL. If there are
16144 too many syntax or protocol errors in one SMTP session, the connection is
16145 dropped. The limit is set by this option.
16146
16147 .cindex "PIPELINING" "expected errors"
16148 When the PIPELINING extension to SMTP is in use, some protocol errors are
16149 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16150 Exim assumes that PIPELINING will be used if it advertises it (see
16151 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16152 not count towards the limit.
16153
16154
16155
16156 .option smtp_max_unknown_commands main integer 3
16157 .cindex "SMTP" "limiting unknown commands"
16158 .cindex "limit" "unknown SMTP commands"
16159 If there are too many unrecognized commands in an incoming SMTP session, an
16160 Exim server drops the connection. This is a defence against some kinds of abuse
16161 that subvert web
16162 clients
16163 into making connections to SMTP ports; in these circumstances, a number of
16164 non-SMTP command lines are sent first.
16165
16166
16167
16168 .option smtp_ratelimit_hosts main "host list&!!" unset
16169 .cindex "SMTP" "rate limiting"
16170 .cindex "limit" "rate of message arrival"
16171 .cindex "RCPT" "rate limiting"
16172 Some sites find it helpful to be able to limit the rate at which certain hosts
16173 can send them messages, and the rate at which an individual message can specify
16174 recipients.
16175
16176 Exim has two rate-limiting facilities. This section describes the older
16177 facility, which can limit rates within a single connection. The newer
16178 &%ratelimit%& ACL condition can limit rates across all connections. See section
16179 &<<SECTratelimiting>>& for details of the newer facility.
16180
16181 When a host matches &%smtp_ratelimit_hosts%&, the values of
16182 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16183 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16184 respectively. Each option, if set, must contain a set of four comma-separated
16185 values:
16186
16187 .ilist
16188 A threshold, before which there is no rate limiting.
16189 .next
16190 An initial time delay. Unlike other times in Exim, numbers with decimal
16191 fractional parts are allowed here.
16192 .next
16193 A factor by which to increase the delay each time.
16194 .next
16195 A maximum value for the delay. This should normally be less than 5 minutes,
16196 because after that time, the client is liable to timeout the SMTP command.
16197 .endlist
16198
16199 For example, these settings have been used successfully at the site which
16200 first suggested this feature, for controlling mail from their customers:
16201 .code
16202 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16203 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16204 .endd
16205 The first setting specifies delays that are applied to MAIL commands after
16206 two have been received over a single connection. The initial delay is 0.5
16207 seconds, increasing by a factor of 1.05 each time. The second setting applies
16208 delays to RCPT commands when more than four occur in a single message.
16209
16210
16211 .option smtp_ratelimit_mail main string unset
16212 See &%smtp_ratelimit_hosts%& above.
16213
16214
16215 .option smtp_ratelimit_rcpt main string unset
16216 See &%smtp_ratelimit_hosts%& above.
16217
16218
16219 .option smtp_receive_timeout main time&!! 5m
16220 .cindex "timeout" "for SMTP input"
16221 .cindex "SMTP" "input timeout"
16222 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16223 input, including batch SMTP. If a line of input (either an SMTP command or a
16224 data line) is not received within this time, the SMTP connection is dropped and
16225 the message is abandoned.
16226 A line is written to the log containing one of the following messages:
16227 .code
16228 SMTP command timeout on connection from...
16229 SMTP data timeout on connection from...
16230 .endd
16231 The former means that Exim was expecting to read an SMTP command; the latter
16232 means that it was in the DATA phase, reading the contents of a message.
16233
16234 If the first character of the option is a &"$"& the option is
16235 expanded before use and may depend on
16236 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16237
16238
16239 .oindex "&%-os%&"
16240 The value set by this option can be overridden by the
16241 &%-os%& command-line option. A setting of zero time disables the timeout, but
16242 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16243 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16244 timeout is controlled by &%receive_timeout%& and &%-or%&.
16245
16246
16247 .option smtp_reserve_hosts main "host list&!!" unset
16248 This option defines hosts for which SMTP connections are reserved; see
16249 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16250
16251
16252 .option smtp_return_error_details main boolean false
16253 .cindex "SMTP" "details policy failures"
16254 .cindex "policy control" "rejection, returning details"
16255 In the default state, Exim uses bland messages such as
16256 &"Administrative prohibition"& when it rejects SMTP commands for policy
16257 reasons. Many sysadmins like this because it gives away little information
16258 to spammers. However, some other sysadmins who are applying strict checking
16259 policies want to give out much fuller information about failures. Setting
16260 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16261 example, instead of &"Administrative prohibition"&, it might give:
16262 .code
16263 550-Rejected after DATA: '>' missing at end of address:
16264 550 failing address in "From" header is: <user@dom.ain
16265 .endd
16266
16267 .option spamd_address main string "see below"
16268 This option is available when Exim is compiled with the content-scanning
16269 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16270 The default value is
16271 .code
16272 127.0.0.1 783
16273 .endd
16274 See section &<<SECTscanspamass>>& for more details.
16275
16276
16277
16278 .option split_spool_directory main boolean false
16279 .cindex "multiple spool directories"
16280 .cindex "spool directory" "split"
16281 .cindex "directories, multiple"
16282 If this option is set, it causes Exim to split its input directory into 62
16283 subdirectories, each with a single alphanumeric character as its name. The
16284 sixth character of the message id is used to allocate messages to
16285 subdirectories; this is the least significant base-62 digit of the time of
16286 arrival of the message.
16287
16288 Splitting up the spool in this way may provide better performance on systems
16289 where there are long mail queues, by reducing the number of files in any one
16290 directory. The msglog directory is also split up in a similar way to the input
16291 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16292 are still placed in the single directory &_msglog.OLD_&.
16293
16294 It is not necessary to take any special action for existing messages when
16295 changing &%split_spool_directory%&. Exim notices messages that are in the
16296 &"wrong"& place, and continues to process them. If the option is turned off
16297 after a period of being on, the subdirectories will eventually empty and be
16298 automatically deleted.
16299
16300 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16301 changes. Instead of creating a list of all messages in the queue, and then
16302 trying to deliver each one in turn, it constructs a list of those in one
16303 sub-directory and tries to deliver them, before moving on to the next
16304 sub-directory. The sub-directories are processed in a random order. This
16305 spreads out the scanning of the input directories, and uses less memory. It is
16306 particularly beneficial when there are lots of messages on the queue. However,
16307 if &%queue_run_in_order%& is set, none of this new processing happens. The
16308 entire queue has to be scanned and sorted before any deliveries can start.
16309
16310
16311 .option spool_directory main string&!! "set at compile time"
16312 .cindex "spool directory" "path to"
16313 This defines the directory in which Exim keeps its spool, that is, the messages
16314 it is waiting to deliver. The default value is taken from the compile-time
16315 configuration setting, if there is one. If not, this option must be set. The
16316 string is expanded, so it can contain, for example, a reference to
16317 &$primary_hostname$&.
16318
16319 If the spool directory name is fixed on your installation, it is recommended
16320 that you set it at build time rather than from this option, particularly if the
16321 log files are being written to the spool directory (see &%log_file_path%&).
16322 Otherwise log files cannot be used for errors that are detected early on, such
16323 as failures in the configuration file.
16324
16325 By using this option to override the compiled-in path, it is possible to run
16326 tests of Exim without using the standard spool.
16327
16328 .option sqlite_lock_timeout main time 5s
16329 .cindex "sqlite lookup type" "lock timeout"
16330 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16331 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16332
16333 .option strict_acl_vars main boolean false
16334 .cindex "&ACL;" "variables, handling unset"
16335 This option controls what happens if a syntactically valid but undefined ACL
16336 variable is referenced. If it is false (the default), an empty string
16337 is substituted; if it is true, an error is generated. See section
16338 &<<SECTaclvariables>>& for details of ACL variables.
16339
16340 .option strip_excess_angle_brackets main boolean false
16341 .cindex "angle brackets, excess"
16342 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16343 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16344 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16345 passed on to another MTA, the excess angle brackets are not passed on. If this
16346 option is not set, multiple pairs of angle brackets cause a syntax error.
16347
16348
16349 .option strip_trailing_dot main boolean false
16350 .cindex "trailing dot on domain"
16351 .cindex "dot" "trailing on domain"
16352 If this option is set, a trailing dot at the end of a domain in an address is
16353 ignored. If this is in the envelope and the message is passed on to another
16354 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16355 domain causes a syntax error.
16356 However, addresses in header lines are checked only when an ACL requests header
16357 syntax checking.
16358
16359
16360 .option syslog_duplication main boolean true
16361 .cindex "syslog" "duplicate log lines; suppressing"
16362 When Exim is logging to syslog, it writes the log lines for its three
16363 separate logs at different syslog priorities so that they can in principle
16364 be separated on the logging hosts. Some installations do not require this
16365 separation, and in those cases, the duplication of certain log lines is a
16366 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16367 particular log line is written to syslog. For lines that normally go to
16368 both the main log and the reject log, the reject log version (possibly
16369 containing message header lines) is written, at LOG_NOTICE priority.
16370 Lines that normally go to both the main and the panic log are written at
16371 the LOG_ALERT priority.
16372
16373
16374 .option syslog_facility main string unset
16375 .cindex "syslog" "facility; setting"
16376 This option sets the syslog &"facility"& name, used when Exim is logging to
16377 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16378 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16379 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16380 details of Exim's logging.
16381
16382
16383
16384 .option syslog_processname main string &`exim`&
16385 .cindex "syslog" "process name; setting"
16386 This option sets the syslog &"ident"& name, used when Exim is logging to
16387 syslog. The value must be no longer than 32 characters. See chapter
16388 &<<CHAPlog>>& for details of Exim's logging.
16389
16390
16391
16392 .option syslog_timestamp main boolean true
16393 .cindex "syslog" "timestamps"
16394 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16395 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16396 details of Exim's logging.
16397
16398
16399 .option system_filter main string&!! unset
16400 .cindex "filter" "system filter"
16401 .cindex "system filter" "specifying"
16402 .cindex "Sieve filter" "not available for system filter"
16403 This option specifies an Exim filter file that is applied to all messages at
16404 the start of each delivery attempt, before any routing is done. System filters
16405 must be Exim filters; they cannot be Sieve filters. If the system filter
16406 generates any deliveries to files or pipes, or any new mail messages, the
16407 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16408 which transports are to be used. Details of this facility are given in chapter
16409 &<<CHAPsystemfilter>>&.
16410
16411
16412 .option system_filter_directory_transport main string&!! unset
16413 .vindex "&$address_file$&"
16414 This sets the name of the transport driver that is to be used when the
16415 &%save%& command in a system message filter specifies a path ending in &"/"&,
16416 implying delivery of each message into a separate file in some directory.
16417 During the delivery, the variable &$address_file$& contains the path name.
16418
16419
16420 .option system_filter_file_transport main string&!! unset
16421 .cindex "file" "transport for system filter"
16422 This sets the name of the transport driver that is to be used when the &%save%&
16423 command in a system message filter specifies a path not ending in &"/"&. During
16424 the delivery, the variable &$address_file$& contains the path name.
16425
16426 .option system_filter_group main string unset
16427 .cindex "gid (group id)" "system filter"
16428 This option is used only when &%system_filter_user%& is also set. It sets the
16429 gid under which the system filter is run, overriding any gid that is associated
16430 with the user. The value may be numerical or symbolic.
16431
16432 .option system_filter_pipe_transport main string&!! unset
16433 .cindex "&(pipe)& transport" "for system filter"
16434 .vindex "&$address_pipe$&"
16435 This specifies the transport driver that is to be used when a &%pipe%& command
16436 is used in a system filter. During the delivery, the variable &$address_pipe$&
16437 contains the pipe command.
16438
16439
16440 .option system_filter_reply_transport main string&!! unset
16441 .cindex "&(autoreply)& transport" "for system filter"
16442 This specifies the transport driver that is to be used when a &%mail%& command
16443 is used in a system filter.
16444
16445
16446 .option system_filter_user main string unset
16447 .cindex "uid (user id)" "system filter"
16448 If this option is set to root, the system filter is run in the main Exim
16449 delivery process, as root.  Otherwise, the system filter runs in a separate
16450 process, as the given user, defaulting to the Exim run-time user.
16451 Unless the string consists entirely of digits, it
16452 is looked up in the password data. Failure to find the named user causes a
16453 configuration error. The gid is either taken from the password data, or
16454 specified by &%system_filter_group%&. When the uid is specified numerically,
16455 &%system_filter_group%& is required to be set.
16456
16457 If the system filter generates any pipe, file, or reply deliveries, the uid
16458 under which the filter is run is used when transporting them, unless a
16459 transport option overrides.
16460
16461
16462 .option tcp_nodelay main boolean true
16463 .cindex "daemon" "TCP_NODELAY on sockets"
16464 .cindex "Nagle algorithm"
16465 .cindex "TCP_NODELAY on listening sockets"
16466 If this option is set false, it stops the Exim daemon setting the
16467 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16468 turns off the &"Nagle algorithm"&, which is a way of improving network
16469 performance in interactive (character-by-character) situations. Turning it off
16470 should improve Exim's performance a bit, so that is what happens by default.
16471 However, it appears that some broken clients cannot cope, and time out. Hence
16472 this option. It affects only those sockets that are set up for listening by the
16473 daemon. Sockets created by the smtp transport for delivering mail always set
16474 TCP_NODELAY.
16475
16476
16477 .option timeout_frozen_after main time 0s
16478 .cindex "frozen messages" "timing out"
16479 .cindex "timeout" "frozen messages"
16480 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16481 message of any kind that has been on the queue for longer than the given time
16482 is automatically cancelled at the next queue run. If the frozen message is a
16483 bounce message, it is just discarded; otherwise, a bounce is sent to the
16484 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16485 If you want to timeout frozen bounce messages earlier than other kinds of
16486 frozen message, see &%ignore_bounce_errors_after%&.
16487
16488 &*Note:*& the default value of zero means no timeouts; with this setting,
16489 frozen messages remain on the queue forever (except for any frozen bounce
16490 messages that are released by &%ignore_bounce_errors_after%&).
16491
16492
16493 .option timezone main string unset
16494 .cindex "timezone, setting"
16495 The value of &%timezone%& is used to set the environment variable TZ while
16496 running Exim (if it is different on entry). This ensures that all timestamps
16497 created by Exim are in the required timezone. If you want all your timestamps
16498 to be in UTC (aka GMT) you should set
16499 .code
16500 timezone = UTC
16501 .endd
16502 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16503 or, if that is not set, from the value of the TZ environment variable when Exim
16504 is built. If &%timezone%& is set to the empty string, either at build or run
16505 time, any existing TZ variable is removed from the environment when Exim
16506 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16507 unfortunately not all, operating systems.
16508
16509
16510 .option tls_advertise_hosts main "host list&!!" unset
16511 .cindex "TLS" "advertising"
16512 .cindex "encryption" "on SMTP connection"
16513 .cindex "SMTP" "encrypted connection"
16514 When Exim is built with support for TLS encrypted connections, the availability
16515 of the STARTTLS command to set up an encrypted session is advertised in
16516 response to EHLO only to those client hosts that match this option. See
16517 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16518
16519
16520 .option tls_certificate main string&!! unset
16521 .cindex "TLS" "server certificate; location of"
16522 .cindex "certificate" "server, location of"
16523 The value of this option is expanded, and must then be the absolute path to a
16524 file which contains the server's certificates. The server's private key is also
16525 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16526 &<<CHAPTLS>>& for further details.
16527
16528 &*Note*&: The certificates defined by this option are used only when Exim is
16529 receiving incoming messages as a server. If you want to supply certificates for
16530 use when sending messages as a client, you must set the &%tls_certificate%&
16531 option in the relevant &(smtp)& transport.
16532
16533 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16534 if the OpenSSL build supports TLS extensions and the TLS client sends the
16535 Server Name Indication extension, then this option and others documented in
16536 &<<SECTtlssni>>& will be re-expanded.
16537
16538 .option tls_crl main string&!! unset
16539 .cindex "TLS" "server certificate revocation list"
16540 .cindex "certificate" "revocation list for server"
16541 This option specifies a certificate revocation list. The expanded value must
16542 be the name of a file that contains a CRL in PEM format.
16543
16544 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16545
16546
16547 .option tls_dh_max_bits main integer 2236
16548 .cindex "TLS" "D-H bit count"
16549 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16550 the chosen TLS library.  That value might prove to be too high for
16551 interoperability.  This option provides a maximum clamp on the value
16552 suggested, trading off security for interoperability.
16553
16554 The value must be at least 1024.
16555
16556 The value 2236 was chosen because, at time of adding the option, it was the
16557 hard-coded maximum value supported by the NSS cryptographic library, as used
16558 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16559
16560 If you prefer more security and are willing to break some clients, raise this
16561 number.
16562
16563 Note that the value passed to GnuTLS for *generating* a new prime may be a
16564 little less than this figure, because GnuTLS is inexact and may produce a
16565 larger prime than requested.
16566
16567
16568 .option tls_dhparam main string&!! unset
16569 .cindex "TLS" "D-H parameters for server"
16570 The value of this option is expanded and indicates the source of DH parameters
16571 to be used by Exim.
16572
16573 If it is a filename starting with a &`/`&, then it names a file from which DH
16574 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16575 PKCS#3 representation of the DH prime.  If the file does not exist, for
16576 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16577 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16578 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16579 and treated as though the &%tls_dhparam%& were set to "none".
16580
16581 If this option expands to the string "none", then no DH parameters will be
16582 loaded by Exim.
16583
16584 If this option expands to the string "historic" and Exim is using GnuTLS, then
16585 Exim will attempt to load a file from inside the spool directory.  If the file
16586 does not exist, Exim will attempt to create it.
16587 See section &<<SECTgnutlsparam>>& for further details.
16588
16589 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16590 a default DH prime; the default is the 2048 bit prime described in section
16591 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16592 in IKE is assigned number 23.
16593
16594 Otherwise, the option must expand to the name used by Exim for any of a number
16595 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16596 "ike" followed by the number used by IKE, of "default" which corresponds to
16597 "ike23".
16598
16599 The available primes are:
16600 &`ike1`&, &`ike2`&, &`ike5`&,
16601 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16602 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16603
16604 Some of these will be too small to be accepted by clients.
16605 Some may be too large to be accepted by clients.
16606
16607 The TLS protocol does not negotiate an acceptable size for this; clients tend
16608 to hard-drop connections if what is offered by the server is unacceptable,
16609 whether too large or too small, and there's no provision for the client to
16610 tell the server what these constraints are.  Thus, as a server operator, you
16611 need to make an educated guess as to what is most likely to work for your
16612 userbase.
16613
16614 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16615 is most likely to maximise interoperability.  The upper bound comes from
16616 applications using the Mozilla Network Security Services (NSS) library, which
16617 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16618 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16619 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16620 acceptable bound from 1024 to 2048.
16621
16622
16623 .option tls_ocsp_file main string&!! unset
16624 This option
16625 must if set expand to the absolute path to a file which contains a current
16626 status proof for the server's certificate, as obtained from the
16627 Certificate Authority.
16628
16629
16630 .option tls_on_connect_ports main "string list" unset
16631 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16632 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16633 set up without waiting for the client to issue a STARTTLS command. For
16634 further details, see section &<<SECTsupobssmt>>&.
16635
16636
16637
16638 .option tls_privatekey main string&!! unset
16639 .cindex "TLS" "server private key; location of"
16640 The value of this option is expanded, and must then be the absolute path to a
16641 file which contains the server's private key. If this option is unset, or if
16642 the expansion is forced to fail, or the result is an empty string, the private
16643 key is assumed to be in the same file as the server's certificates. See chapter
16644 &<<CHAPTLS>>& for further details.
16645
16646 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16647
16648
16649 .option tls_remember_esmtp main boolean false
16650 .cindex "TLS" "esmtp state; remembering"
16651 .cindex "TLS" "broken clients"
16652 If this option is set true, Exim violates the RFCs by remembering that it is in
16653 &"esmtp"& state after successfully negotiating a TLS session. This provides
16654 support for broken clients that fail to send a new EHLO after starting a
16655 TLS session.
16656
16657
16658 .option tls_require_ciphers main string&!! unset
16659 .cindex "TLS" "requiring specific ciphers"
16660 .cindex "cipher" "requiring specific"
16661 This option controls which ciphers can be used for incoming TLS connections.
16662 The &(smtp)& transport has an option of the same name for controlling outgoing
16663 connections. This option is expanded for each connection, so can be varied for
16664 different clients if required. The value of this option must be a list of
16665 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16666 in somewhat different ways. If GnuTLS is being used, the client controls the
16667 preference order of the available ciphers. Details are given in sections
16668 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16669
16670
16671 .option tls_try_verify_hosts main "host list&!!" unset
16672 .cindex "TLS" "client certificate verification"
16673 .cindex "certificate" "verification of client"
16674 See &%tls_verify_hosts%& below.
16675
16676
16677 .new
16678 .option tls_verify_certificates main string&!! system
16679 .cindex "TLS" "client certificate verification"
16680 .cindex "certificate" "verification of client"
16681 The value of this option is expanded, and must then be either the
16682 word "system"
16683 or the absolute path to
16684 a file or directory containing permitted certificates for clients that
16685 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16686
16687 The "system" value for the option will use a
16688 system default location compiled into the SSL library.
16689 This is not available for GnuTLS versions preceding 3.0.20,
16690 and will be taken as empty; an explicit location
16691 must be specified.
16692
16693 The use of a directory for the option value is not avilable for GnuTLS versions
16694 preceding 3.3.6 and a single file must be used.
16695
16696 With OpenSSL the certificates specified
16697 explicitly
16698 either by file or directory
16699 are added to those given by the system default location.
16700 .wen
16701
16702 These certificates should be for the certificate authorities trusted, rather
16703 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16704 the value is a file then the certificates are sent by Exim as a server to
16705 connecting clients, defining the list of accepted certificate authorities.
16706 Thus the values defined should be considered public data.  To avoid this,
16707 use the explicit directory version.
16708
16709 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16710
16711 A forced expansion failure or setting to an empty string is equivalent to
16712 being unset.
16713
16714
16715 .option tls_verify_hosts main "host list&!!" unset
16716 .cindex "TLS" "client certificate verification"
16717 .cindex "certificate" "verification of client"
16718 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16719 certificates from clients. The expected certificates are defined by
16720 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16721 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16722 &%tls_verify_certificates%& is not set.
16723
16724 Any client that matches &%tls_verify_hosts%& is constrained by
16725 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16726 present one of the listed certificates. If it does not, the connection is
16727 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16728 the host to use TLS. It can still send SMTP commands through unencrypted
16729 connections. Forcing a client to use TLS has to be done separately using an
16730 ACL to reject inappropriate commands when the connection is not encrypted.
16731
16732 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16733 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16734 certificate and checks it against &%tls_verify_certificates%&, but does not
16735 abort the connection if there is no certificate or if it does not match. This
16736 state can be detected in an ACL, which makes it possible to implement policies
16737 such as &"accept for relay only if a verified certificate has been received,
16738 but accept for local delivery if encrypted, even without a verified
16739 certificate"&.
16740
16741 Client hosts that match neither of these lists are not asked to present
16742 certificates.
16743
16744
16745 .option trusted_groups main "string list&!!" unset
16746 .cindex "trusted groups"
16747 .cindex "groups" "trusted"
16748 This option is expanded just once, at the start of Exim's processing. If this
16749 option is set, any process that is running in one of the listed groups, or
16750 which has one of them as a supplementary group, is trusted. The groups can be
16751 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16752 details of what trusted callers are permitted to do. If neither
16753 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16754 are trusted.
16755
16756 .option trusted_users main "string list&!!" unset
16757 .cindex "trusted users"
16758 .cindex "user" "trusted"
16759 This option is expanded just once, at the start of Exim's processing. If this
16760 option is set, any process that is running as one of the listed users is
16761 trusted. The users can be specified numerically or by name. See section
16762 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16763 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16764 Exim user are trusted.
16765
16766 .option unknown_login main string&!! unset
16767 .cindex "uid (user id)" "unknown caller"
16768 .vindex "&$caller_uid$&"
16769 This is a specialized feature for use in unusual configurations. By default, if
16770 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16771 gives up. The &%unknown_login%& option can be used to set a login name to be
16772 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16773 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16774 is used for the user's real name (gecos field), unless this has been set by the
16775 &%-F%& option.
16776
16777 .option unknown_username main string unset
16778 See &%unknown_login%&.
16779
16780 .option untrusted_set_sender main "address list&!!" unset
16781 .cindex "trusted users"
16782 .cindex "sender" "setting by untrusted user"
16783 .cindex "untrusted user setting sender"
16784 .cindex "user" "untrusted setting sender"
16785 .cindex "envelope sender"
16786 When an untrusted user submits a message to Exim using the standard input, Exim
16787 normally creates an envelope sender address from the user's login and the
16788 default qualification domain. Data from the &%-f%& option (for setting envelope
16789 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16790 is used) is ignored.
16791
16792 However, untrusted users are permitted to set an empty envelope sender address,
16793 to declare that a message should never generate any bounces. For example:
16794 .code
16795 exim -f '<>' user@domain.example
16796 .endd
16797 .vindex "&$sender_ident$&"
16798 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16799 other envelope sender addresses in a controlled way. When it is set, untrusted
16800 users are allowed to set envelope sender addresses that match any of the
16801 patterns in the list. Like all address lists, the string is expanded. The
16802 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16803 users to setting senders that start with their login ids
16804 followed by a hyphen
16805 by a setting like this:
16806 .code
16807 untrusted_set_sender = ^$sender_ident-
16808 .endd
16809 If you want to allow untrusted users to set envelope sender addresses without
16810 restriction, you can use
16811 .code
16812 untrusted_set_sender = *
16813 .endd
16814 The &%untrusted_set_sender%& option applies to all forms of local input, but
16815 only to the setting of the envelope sender. It does not permit untrusted users
16816 to use the other options which trusted user can use to override message
16817 parameters. Furthermore, it does not stop Exim from removing an existing
16818 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16819 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16820 overriding these actions. The handling of the &'Sender:'& header is also
16821 described in section &<<SECTthesenhea>>&.
16822
16823 The log line for a message's arrival shows the envelope sender following
16824 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16825 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16826 envelope sender address, the user's login is shown in parentheses after the
16827 sender address.
16828
16829
16830 .option uucp_from_pattern main string "see below"
16831 .cindex "&""From""& line"
16832 .cindex "UUCP" "&""From""& line"
16833 Some applications that pass messages to an MTA via a command line interface use
16834 an initial line starting with &"From&~"& to pass the envelope sender. In
16835 particular, this is used by UUCP software. Exim recognizes such a line by means
16836 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16837 matches, the sender address is constructed by expanding the contents of
16838 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16839 default pattern recognizes lines in the following two forms:
16840 .code
16841 From ph10 Fri Jan  5 12:35 GMT 1996
16842 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16843 .endd
16844 The pattern can be seen by running
16845 .code
16846 exim -bP uucp_from_pattern
16847 .endd
16848 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16849 year in the second case. The first word after &"From&~"& is matched in the
16850 regular expression by a parenthesized subpattern. The default value for
16851 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16852 (&"ph10"& in the example above) as the message's sender. See also
16853 &%ignore_fromline_hosts%&.
16854
16855
16856 .option uucp_from_sender main string&!! &`$1`&
16857 See &%uucp_from_pattern%& above.
16858
16859
16860 .option warn_message_file main string unset
16861 .cindex "warning of delay" "customizing the message"
16862 .cindex "customizing" "warning message"
16863 This option defines a template file containing paragraphs of text to be used
16864 for constructing the warning message which is sent by Exim when a message has
16865 been on the queue for a specified amount of time, as specified by
16866 &%delay_warning%&. Details of the file's contents are given in chapter
16867 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16868
16869
16870 .option write_rejectlog main boolean true
16871 .cindex "reject log" "disabling"
16872 If this option is set false, Exim no longer writes anything to the reject log.
16873 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16874 .ecindex IIDconfima
16875 .ecindex IIDmaiconf
16876
16877
16878
16879
16880 . ////////////////////////////////////////////////////////////////////////////
16881 . ////////////////////////////////////////////////////////////////////////////
16882
16883 .chapter "Generic options for routers" "CHAProutergeneric"
16884 .scindex IIDgenoprou1 "options" "generic; for routers"
16885 .scindex IIDgenoprou2 "generic options" "router"
16886 This chapter describes the generic options that apply to all routers.
16887 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16888
16889 For a general description of how a router operates, see sections
16890 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16891 which the preconditions are tested. The order of expansion of the options that
16892 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16893 &%headers_remove%&, &%transport%&.
16894
16895
16896
16897 .option address_data routers string&!! unset
16898 .cindex "router" "data attached to address"
16899 The string is expanded just before the router is run, that is, after all the
16900 precondition tests have succeeded. If the expansion is forced to fail, the
16901 router declines, the value of &%address_data%& remains unchanged, and the
16902 &%more%& option controls what happens next. Other expansion failures cause
16903 delivery of the address to be deferred.
16904
16905 .vindex "&$address_data$&"
16906 When the expansion succeeds, the value is retained with the address, and can be
16907 accessed using the variable &$address_data$& in the current router, subsequent
16908 routers, and the eventual transport.
16909
16910 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16911 that runs a user's filter file, the contents of &$address_data$& are accessible
16912 in the filter. This is not normally a problem, because such data is usually
16913 either not confidential or it &"belongs"& to the current user, but if you do
16914 put confidential data into &$address_data$& you need to remember this point.
16915
16916 Even if the router declines or passes, the value of &$address_data$& remains
16917 with the address, though it can be changed by another &%address_data%& setting
16918 on a subsequent router. If a router generates child addresses, the value of
16919 &$address_data$& propagates to them. This also applies to the special kind of
16920 &"child"& that is generated by a router with the &%unseen%& option.
16921
16922 The idea of &%address_data%& is that you can use it to look up a lot of data
16923 for the address once, and then pick out parts of the data later. For example,
16924 you could use a single LDAP lookup to return a string of the form
16925 .code
16926 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16927 .endd
16928 In the transport you could pick out the mailbox by a setting such as
16929 .code
16930 file = ${extract{mailbox}{$address_data}}
16931 .endd
16932 This makes the configuration file less messy, and also reduces the number of
16933 lookups (though Exim does cache lookups).
16934
16935 .vindex "&$sender_address_data$&"
16936 .vindex "&$address_data$&"
16937 The &%address_data%& facility is also useful as a means of passing information
16938 from one router to another, and from a router to a transport. In addition, if
16939 &$address_data$& is set by a router when verifying a recipient address from an
16940 ACL, it remains available for use in the rest of the ACL statement. After
16941 verifying a sender, the value is transferred to &$sender_address_data$&.
16942
16943
16944
16945 .option address_test routers&!? boolean true
16946 .oindex "&%-bt%&"
16947 .cindex "router" "skipping when address testing"
16948 If this option is set false, the router is skipped when routing is being tested
16949 by means of the &%-bt%& command line option. This can be a convenience when
16950 your first router sends messages to an external scanner, because it saves you
16951 having to set the &"already scanned"& indicator when testing real address
16952 routing.
16953
16954
16955
16956 .option cannot_route_message routers string&!! unset
16957 .cindex "router" "customizing &""cannot route""& message"
16958 .cindex "customizing" "&""cannot route""& message"
16959 This option specifies a text message that is used when an address cannot be
16960 routed because Exim has run out of routers. The default message is
16961 &"Unrouteable address"&. This option is useful only on routers that have
16962 &%more%& set false, or on the very last router in a configuration, because the
16963 value that is used is taken from the last router that is considered. This
16964 includes a router that is skipped because its preconditions are not met, as
16965 well as a router that declines. For example, using the default configuration,
16966 you could put:
16967 .code
16968 cannot_route_message = Remote domain not found in DNS
16969 .endd
16970 on the first router, which is a &(dnslookup)& router with &%more%& set false,
16971 and
16972 .code
16973 cannot_route_message = Unknown local user
16974 .endd
16975 on the final router that checks for local users. If string expansion fails for
16976 this option, the default message is used. Unless the expansion failure was
16977 explicitly forced, a message about the failure is written to the main and panic
16978 logs, in addition to the normal message about the routing failure.
16979
16980
16981 .option caseful_local_part routers boolean false
16982 .cindex "case of local parts"
16983 .cindex "router" "case of local parts"
16984 By default, routers handle the local parts of addresses in a case-insensitive
16985 manner, though the actual case is preserved for transmission with the message.
16986 If you want the case of letters to be significant in a router, you must set
16987 this option true. For individual router options that contain address or local
16988 part lists (for example, &%local_parts%&), case-sensitive matching can be
16989 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
16990 more details.
16991
16992 .vindex "&$local_part$&"
16993 .vindex "&$original_local_part$&"
16994 .vindex "&$parent_local_part$&"
16995 The value of the &$local_part$& variable is forced to lower case while a
16996 router is running unless &%caseful_local_part%& is set. When a router assigns
16997 an address to a transport, the value of &$local_part$& when the transport runs
16998 is the same as it was in the router. Similarly, when a router generates child
16999 addresses by aliasing or forwarding, the values of &$original_local_part$&
17000 and &$parent_local_part$& are those that were used by the redirecting router.
17001
17002 This option applies to the processing of an address by a router. When a
17003 recipient address is being processed in an ACL, there is a separate &%control%&
17004 modifier that can be used to specify case-sensitive processing within the ACL
17005 (see section &<<SECTcontrols>>&).
17006
17007
17008
17009 .option check_local_user routers&!? boolean false
17010 .cindex "local user, checking in router"
17011 .cindex "router" "checking for local user"
17012 .cindex "&_/etc/passwd_&"
17013 .vindex "&$home$&"
17014 When this option is true, Exim checks that the local part of the recipient
17015 address (with affixes removed if relevant) is the name of an account on the
17016 local system. The check is done by calling the &[getpwnam()]& function rather
17017 than trying to read &_/etc/passwd_& directly. This means that other methods of
17018 holding password data (such as NIS) are supported. If the local part is a local
17019 user, &$home$& is set from the password data, and can be tested in other
17020 preconditions that are evaluated after this one (the order of evaluation is
17021 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17022 overridden by &%router_home_directory%&. If the local part is not a local user,
17023 the router is skipped.
17024
17025 If you want to check that the local part is either the name of a local user
17026 or matches something else, you cannot combine &%check_local_user%& with a
17027 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17028 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17029 setting to achieve this. For example:
17030 .code
17031 local_parts = passwd;$local_part : lsearch;/etc/other/users
17032 .endd
17033 Note, however, that the side effects of &%check_local_user%& (such as setting
17034 up a home directory) do not occur when a &(passwd)& lookup is used in a
17035 &%local_parts%& (or any other) precondition.
17036
17037
17038
17039 .option condition routers&!? string&!! unset
17040 .cindex "router" "customized precondition"
17041 This option specifies a general precondition test that has to succeed for the
17042 router to be called. The &%condition%& option is the last precondition to be
17043 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17044 result is a forced failure, or an empty string, or one of the strings &"0"& or
17045 &"no"& or &"false"& (checked without regard to the case of the letters), the
17046 router is skipped, and the address is offered to the next one.
17047
17048 If the result is any other value, the router is run (as this is the last
17049 precondition to be evaluated, all the other preconditions must be true).
17050
17051 This option is unusual in that multiple &%condition%& options may be present.
17052 All &%condition%& options must succeed.
17053
17054 The &%condition%& option provides a means of applying custom conditions to the
17055 running of routers. Note that in the case of a simple conditional expansion,
17056 the default expansion values are exactly what is wanted. For example:
17057 .code
17058 condition = ${if >{$message_age}{600}}
17059 .endd
17060 Because of the default behaviour of the string expansion, this is equivalent to
17061 .code
17062 condition = ${if >{$message_age}{600}{true}{}}
17063 .endd
17064
17065 A multiple condition example, which succeeds:
17066 .code
17067 condition = ${if >{$message_age}{600}}
17068 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17069 condition = foobar
17070 .endd
17071
17072 If the expansion fails (other than forced failure) delivery is deferred. Some
17073 of the other precondition options are common special cases that could in fact
17074 be specified using &%condition%&.
17075
17076 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17077 are far older, and use one set of semantics.  ACLs are newer and when
17078 they were created, the ACL &%condition%& process was given far stricter
17079 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17080 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17081 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17082 Router rules processing behavior.
17083
17084 This is best illustrated in an example:
17085 .code
17086 # If used in an ACL condition will fail with a syntax error, but
17087 # in a router condition any extra characters are treated as a string
17088
17089 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17090 true {yes} {no}}
17091
17092 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17093  {yes} {no}}
17094 .endd
17095 In each example above, the &%if%& statement actually ends after
17096 &"{google.com}}"&.  Since no true or false braces were defined, the
17097 default &%if%& behavior is to return a boolean true or a null answer
17098 (which evaluates to false). The rest of the line is then treated as a
17099 string. So the first example resulted in the boolean answer &"true"&
17100 with the string &" {yes} {no}}"& appended to it. The second example
17101 resulted in the null output (indicating false) with the string
17102 &" {yes} {no}}"& appended to it.
17103
17104 In fact you can put excess forward braces in too.  In the router
17105 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17106 mean something, like after a &"$"& or when required as part of a
17107 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17108 string characters.
17109
17110 Thus, in a Router, the above expansion strings will both always evaluate
17111 true, as the result of expansion is a non-empty string which doesn't
17112 match an explicit false value.  This can be tricky to debug.  By
17113 contrast, in an ACL either of those strings will always result in an
17114 expansion error because the result doesn't look sufficiently boolean.
17115
17116
17117 .option debug_print routers string&!! unset
17118 .cindex "testing" "variables in drivers"
17119 If this option is set and debugging is enabled (see the &%-d%& command line
17120 option) or in address-testing mode (see the &%-bt%& command line option),
17121 the string is expanded and included in the debugging output.
17122 If expansion of the string fails, the error message is written to the debugging
17123 output, and Exim carries on processing.
17124 This option is provided to help with checking out the values of variables and
17125 so on when debugging router configurations. For example, if a &%condition%&
17126 option appears not to be working, &%debug_print%& can be used to output the
17127 variables it references. The output happens after checks for &%domains%&,
17128 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17129 are tested. A newline is added to the text if it does not end with one.
17130 The variable &$router_name$& contains the name of the router.
17131
17132
17133
17134 .option disable_logging routers boolean false
17135 If this option is set true, nothing is logged for any routing errors
17136 or for any deliveries caused by this router. You should not set this option
17137 unless you really, really know what you are doing. See also the generic
17138 transport option of the same name.
17139
17140 .option dnssec_request_domains routers "domain list&!!" unset
17141 .cindex "MX record" "security"
17142 .cindex "DNSSEC" "MX lookup"
17143 .cindex "security" "MX lookup"
17144 .cindex "DNS" "DNSSEC"
17145 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17146 the dnssec request bit set.
17147 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17148
17149 .option dnssec_require_domains routers "domain list&!!" unset
17150 .cindex "MX record" "security"
17151 .cindex "DNSSEC" "MX lookup"
17152 .cindex "security" "MX lookup"
17153 .cindex "DNS" "DNSSEC"
17154 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17155 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17156 (AD bit) set will be ignored and logged as a host-lookup failure.
17157 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17158
17159
17160 .option domains routers&!? "domain list&!!" unset
17161 .cindex "router" "restricting to specific domains"
17162 .vindex "&$domain_data$&"
17163 If this option is set, the router is skipped unless the current domain matches
17164 the list. If the match is achieved by means of a file lookup, the data that the
17165 lookup returned for the domain is placed in &$domain_data$& for use in string
17166 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17167 a list of the order in which preconditions are evaluated.
17168
17169
17170
17171 .option driver routers string unset
17172 This option must always be set. It specifies which of the available routers is
17173 to be used.
17174
17175
17176 .new
17177 .option dsn_lasthop routers boolean false
17178 .cindex "DSN" "success"
17179 .cindex "Delivery Status Notification" "success"
17180 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17181 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17182 instead send a success DSN as if the next hop does not support DSN.
17183 Not effective on redirect routers.
17184 .wen
17185
17186
17187
17188 .option errors_to routers string&!! unset
17189 .cindex "envelope sender"
17190 .cindex "router" "changing address for errors"
17191 If a router successfully handles an address, it may assign the address to a
17192 transport for delivery or it may generate child addresses. In both cases, if
17193 there is a delivery problem during later processing, the resulting bounce
17194 message is sent to the address that results from expanding this string,
17195 provided that the address verifies successfully. The &%errors_to%& option is
17196 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17197
17198 The &%errors_to%& setting associated with an address can be overridden if it
17199 subsequently passes through other routers that have their own &%errors_to%&
17200 settings, or if the message is delivered by a transport with a &%return_path%&
17201 setting.
17202
17203 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17204 the expansion fails to verify, the errors address associated with the incoming
17205 address is used. At top level, this is the envelope sender. A non-forced
17206 expansion failure causes delivery to be deferred.
17207
17208 If an address for which &%errors_to%& has been set ends up being delivered over
17209 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17210 any bounces that are generated by other MTAs on the delivery route are also
17211 sent there. You can set &%errors_to%& to the empty string by either of these
17212 settings:
17213 .code
17214 errors_to =
17215 errors_to = ""
17216 .endd
17217 An expansion item that yields an empty string has the same effect. If you do
17218 this, a locally detected delivery error for addresses processed by this router
17219 no longer gives rise to a bounce message; the error is discarded. If the
17220 address is delivered to a remote host, the return path is set to &`<>`&, unless
17221 overridden by the &%return_path%& option on the transport.
17222
17223 .vindex "&$address_data$&"
17224 If for some reason you want to discard local errors, but use a non-empty
17225 MAIL command for remote delivery, you can preserve the original return
17226 path in &$address_data$& in the router, and reinstate it in the transport by
17227 setting &%return_path%&.
17228
17229 The most common use of &%errors_to%& is to direct mailing list bounces to the
17230 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17231 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17232
17233
17234
17235 .option expn routers&!? boolean true
17236 .cindex "address" "testing"
17237 .cindex "testing" "addresses"
17238 .cindex "EXPN" "router skipping"
17239 .cindex "router" "skipping for EXPN"
17240 If this option is turned off, the router is skipped when testing an address
17241 as a result of processing an SMTP EXPN command. You might, for example,
17242 want to turn it off on a router for users' &_.forward_& files, while leaving it
17243 on for the system alias file.
17244 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17245 are evaluated.
17246
17247 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17248 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17249 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17250
17251
17252
17253 .option fail_verify routers boolean false
17254 .cindex "router" "forcing verification failure"
17255 Setting this option has the effect of setting both &%fail_verify_sender%& and
17256 &%fail_verify_recipient%& to the same value.
17257
17258
17259
17260 .option fail_verify_recipient routers boolean false
17261 If this option is true and an address is accepted by this router when
17262 verifying a recipient, verification fails.
17263
17264
17265
17266 .option fail_verify_sender routers boolean false
17267 If this option is true and an address is accepted by this router when
17268 verifying a sender, verification fails.
17269
17270
17271
17272 .option fallback_hosts routers "string list" unset
17273 .cindex "router" "fallback hosts"
17274 .cindex "fallback" "hosts specified on router"
17275 String expansion is not applied to this option. The argument must be a
17276 colon-separated list of host names or IP addresses. The list separator can be
17277 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17278 each name or address. In fact, the format of each item is exactly the same as
17279 defined for the list of hosts in a &(manualroute)& router (see section
17280 &<<SECTformatonehostitem>>&).
17281
17282 If a router queues an address for a remote transport, this host list is
17283 associated with the address, and used instead of the transport's fallback host
17284 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17285 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17286 transport for further details.
17287
17288
17289 .option group routers string&!! "see below"
17290 .cindex "gid (group id)" "local delivery"
17291 .cindex "local transports" "uid and gid"
17292 .cindex "transport" "local"
17293 .cindex "router" "setting group"
17294 When a router queues an address for a transport, and the transport does not
17295 specify a group, the group given here is used when running the delivery
17296 process.
17297 The group may be specified numerically or by name. If expansion fails, the
17298 error is logged and delivery is deferred.
17299 The default is unset, unless &%check_local_user%& is set, when the default
17300 is taken from the password information. See also &%initgroups%& and &%user%&
17301 and the discussion in chapter &<<CHAPenvironment>>&.
17302
17303
17304
17305 .option headers_add routers list&!! unset
17306 .cindex "header lines" "adding"
17307 .cindex "router" "adding header lines"
17308 This option specifies a list of text headers,
17309 .new
17310 newline-separated (by default, changeable in the usual way),
17311 .wen
17312 that is associated with any addresses that are accepted by the router.
17313 Each item is separately expanded, at routing time.  However, this
17314 option has no effect when an address is just being verified. The way in which
17315 the text is used to add header lines at transport time is described in section
17316 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17317 message is in the process of being transported. This means that references to
17318 header lines in string expansions in the transport's configuration do not
17319 &"see"& the added header lines.
17320
17321 The &%headers_add%& option is expanded after &%errors_to%&, but before
17322 &%headers_remove%& and &%transport%&. If an item is empty, or if
17323 an item expansion is forced to fail, the item has no effect. Other expansion
17324 failures are treated as configuration errors.
17325
17326 Unlike most options, &%headers_add%& can be specified multiple times
17327 for a router; all listed headers are added.
17328
17329 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17330 router that has the &%one_time%& option set.
17331
17332 .cindex "duplicate addresses"
17333 .oindex "&%unseen%&"
17334 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17335 additions are deleted when the address is passed on to subsequent routers.
17336 For a &%redirect%& router, if a generated address is the same as the incoming
17337 address, this can lead to duplicate addresses with different header
17338 modifications. Exim does not do duplicate deliveries (except, in certain
17339 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17340 which of the duplicates is discarded, so this ambiguous situation should be
17341 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17342
17343
17344
17345 .option headers_remove routers list&!! unset
17346 .cindex "header lines" "removing"
17347 .cindex "router" "removing header lines"
17348 This option specifies a list of text headers,
17349 .new
17350 colon-separated (by default, changeable in the usual way),
17351 .wen
17352 that is associated with any addresses that are accepted by the router.
17353 Each item is separately expanded, at routing time.  However, this
17354 option has no effect when an address is just being verified. The way in which
17355 the text is used to remove header lines at transport time is described in
17356 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17357 the message is in the process of being transported. This means that references
17358 to header lines in string expansions in the transport's configuration still
17359 &"see"& the original header lines.
17360
17361 The &%headers_remove%& option is expanded after &%errors_to%& and
17362 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17363 the item has no effect. Other expansion failures are treated as configuration
17364 errors.
17365
17366 Unlike most options, &%headers_remove%& can be specified multiple times
17367 for a router; all listed headers are removed.
17368
17369 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17370 router that has the &%one_time%& option set.
17371
17372 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17373 removal requests are deleted when the address is passed on to subsequent
17374 routers, and this can lead to problems with duplicates -- see the similar
17375 warning for &%headers_add%& above.
17376
17377
17378 .option ignore_target_hosts routers "host list&!!" unset
17379 .cindex "IP address" "discarding"
17380 .cindex "router" "discarding IP addresses"
17381 Although this option is a host list, it should normally contain IP address
17382 entries rather than names. If any host that is looked up by the router has an
17383 IP address that matches an item in this list, Exim behaves as if that IP
17384 address did not exist. This option allows you to cope with rogue DNS entries
17385 like
17386 .code
17387 remote.domain.example.  A  127.0.0.1
17388 .endd
17389 by setting
17390 .code
17391 ignore_target_hosts = 127.0.0.1
17392 .endd
17393 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17394 discarded in this way, the router declines. In a conventional configuration, an
17395 attempt to mail to such a domain would normally provoke the &"unrouteable
17396 domain"& error, and an attempt to verify an address in the domain would fail.
17397 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17398 router declines if presented with one of the listed addresses.
17399
17400 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17401 means of the first or the second of the following settings, respectively:
17402 .code
17403 ignore_target_hosts = 0.0.0.0/0
17404 ignore_target_hosts = <; 0::0/0
17405 .endd
17406 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17407 in the second line matches all IPv6 addresses.
17408
17409 This option may also be useful for ignoring link-local and site-local IPv6
17410 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17411 is expanded before use as a list, it is possible to make it dependent on the
17412 domain that is being routed.
17413
17414 .vindex "&$host_address$&"
17415 During its expansion, &$host_address$& is set to the IP address that is being
17416 checked.
17417
17418 .option initgroups routers boolean false
17419 .cindex "additional groups"
17420 .cindex "groups" "additional"
17421 .cindex "local transports" "uid and gid"
17422 .cindex "transport" "local"
17423 If the router queues an address for a transport, and this option is true, and
17424 the uid supplied by the router is not overridden by the transport, the
17425 &[initgroups()]& function is called when running the transport to ensure that
17426 any additional groups associated with the uid are set up. See also &%group%&
17427 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17428
17429
17430
17431 .option local_part_prefix routers&!? "string list" unset
17432 .cindex "router" "prefix for local part"
17433 .cindex "prefix" "for local part, used in router"
17434 If this option is set, the router is skipped unless the local part starts with
17435 one of the given strings, or &%local_part_prefix_optional%& is true. See
17436 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17437 evaluated.
17438
17439 The list is scanned from left to right, and the first prefix that matches is
17440 used. A limited form of wildcard is available; if the prefix begins with an
17441 asterisk, it matches the longest possible sequence of arbitrary characters at
17442 the start of the local part. An asterisk should therefore always be followed by
17443 some character that does not occur in normal local parts.
17444 .cindex "multiple mailboxes"
17445 .cindex "mailbox" "multiple"
17446 Wildcarding can be used to set up multiple user mailboxes, as described in
17447 section &<<SECTmulbox>>&.
17448
17449 .vindex "&$local_part$&"
17450 .vindex "&$local_part_prefix$&"
17451 During the testing of the &%local_parts%& option, and while the router is
17452 running, the prefix is removed from the local part, and is available in the
17453 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17454 the router accepts the address, this remains true during subsequent delivery by
17455 a transport. In particular, the local part that is transmitted in the RCPT
17456 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17457 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17458 the relevant transport.
17459
17460 When an address is being verified, &%local_part_prefix%& affects only the
17461 behaviour of the router. If the callout feature of verification is in use, this
17462 means that the full address, including the prefix, will be used during the
17463 callout.
17464
17465 The prefix facility is commonly used to handle local parts of the form
17466 &%owner-something%&. Another common use is to support local parts of the form
17467 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17468 to tell a user their forwarding is broken &-- by placing a router like this one
17469 immediately before the router that handles &_.forward_& files:
17470 .code
17471 real_localuser:
17472   driver = accept
17473   local_part_prefix = real-
17474   check_local_user
17475   transport = local_delivery
17476 .endd
17477 For security, it would probably be a good idea to restrict the use of this
17478 router to locally-generated messages, using a condition such as this:
17479 .code
17480   condition = ${if match {$sender_host_address}\
17481                          {\N^(|127\.0\.0\.1)$\N}}
17482 .endd
17483
17484 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17485 both conditions must be met if not optional. Care must be taken if wildcards
17486 are used in both a prefix and a suffix on the same router. Different
17487 separator characters must be used to avoid ambiguity.
17488
17489
17490 .option local_part_prefix_optional routers boolean false
17491 See &%local_part_prefix%& above.
17492
17493
17494
17495 .option local_part_suffix routers&!? "string list" unset
17496 .cindex "router" "suffix for local part"
17497 .cindex "suffix for local part" "used in router"
17498 This option operates in the same way as &%local_part_prefix%&, except that the
17499 local part must end (rather than start) with the given string, the
17500 &%local_part_suffix_optional%& option determines whether the suffix is
17501 mandatory, and the wildcard * character, if present, must be the last
17502 character of the suffix. This option facility is commonly used to handle local
17503 parts of the form &%something-request%& and multiple user mailboxes of the form
17504 &%username-foo%&.
17505
17506
17507 .option local_part_suffix_optional routers boolean false
17508 See &%local_part_suffix%& above.
17509
17510
17511
17512 .option local_parts routers&!? "local part list&!!" unset
17513 .cindex "router" "restricting to specific local parts"
17514 .cindex "local part" "checking in router"
17515 The router is run only if the local part of the address matches the list.
17516 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17517 are evaluated, and
17518 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17519 string is expanded, it is possible to make it depend on the domain, for
17520 example:
17521 .code
17522 local_parts = dbm;/usr/local/specials/$domain
17523 .endd
17524 .vindex "&$local_part_data$&"
17525 If the match is achieved by a lookup, the data that the lookup returned
17526 for the local part is placed in the variable &$local_part_data$& for use in
17527 expansions of the router's private options. You might use this option, for
17528 example, if you have a large number of local virtual domains, and you want to
17529 send all postmaster mail to the same place without having to set up an alias in
17530 each virtual domain:
17531 .code
17532 postmaster:
17533   driver = redirect
17534   local_parts = postmaster
17535   data = postmaster@real.domain.example
17536 .endd
17537
17538
17539 .option log_as_local routers boolean "see below"
17540 .cindex "log" "delivery line"
17541 .cindex "delivery" "log line format"
17542 Exim has two logging styles for delivery, the idea being to make local
17543 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17544 recipient address is given just as the local part, without a domain. The use of
17545 this style is controlled by this option. It defaults to true for the &(accept)&
17546 router, and false for all the others. This option applies only when a
17547 router assigns an address to a transport. It has no effect on routers that
17548 redirect addresses.
17549
17550
17551
17552 .option more routers boolean&!! true
17553 The result of string expansion for this option must be a valid boolean value,
17554 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17555 result causes an error, and delivery is deferred. If the expansion is forced to
17556 fail, the default value for the option (true) is used. Other failures cause
17557 delivery to be deferred.
17558
17559 If this option is set false, and the router declines to handle the address, no
17560 further routers are tried, routing fails, and the address is bounced.
17561 .oindex "&%self%&"
17562 However, if the router explicitly passes an address to the following router by
17563 means of the setting
17564 .code
17565 self = pass
17566 .endd
17567 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17568 does not affect the behaviour if one of the precondition tests fails. In that
17569 case, the address is always passed to the next router.
17570
17571 Note that &%address_data%& is not considered to be a precondition. If its
17572 expansion is forced to fail, the router declines, and the value of &%more%&
17573 controls what happens next.
17574
17575
17576 .option pass_on_timeout routers boolean false
17577 .cindex "timeout" "of router"
17578 .cindex "router" "timeout"
17579 If a router times out during a host lookup, it normally causes deferral of the
17580 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17581 router, overriding &%no_more%&. This may be helpful for systems that are
17582 intermittently connected to the Internet, or those that want to pass to a smart
17583 host any messages that cannot immediately be delivered.
17584
17585 There are occasional other temporary errors that can occur while doing DNS
17586 lookups. They are treated in the same way as a timeout, and this option
17587 applies to all of them.
17588
17589
17590
17591 .option pass_router routers string unset
17592 .cindex "router" "go to after &""pass""&"
17593 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17594 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17595 routing to continue, and overriding a false setting of &%more%&. When one of
17596 these routers returns &"pass"&, the address is normally handed on to the next
17597 router in sequence. This can be changed by setting &%pass_router%& to the name
17598 of another router. However (unlike &%redirect_router%&) the named router must
17599 be below the current router, to avoid loops. Note that this option applies only
17600 to the special case of &"pass"&. It does not apply when a router returns
17601 &"decline"& because it cannot handle an address.
17602
17603
17604
17605 .option redirect_router routers string unset
17606 .cindex "router" "start at after redirection"
17607 Sometimes an administrator knows that it is pointless to reprocess addresses
17608 generated from alias or forward files with the same router again. For
17609 example, if an alias file translates real names into login ids there is no
17610 point searching the alias file a second time, especially if it is a large file.
17611
17612 The &%redirect_router%& option can be set to the name of any router instance.
17613 It causes the routing of any generated addresses to start at the named router
17614 instead of at the first router. This option has no effect if the router in
17615 which it is set does not generate new addresses.
17616
17617
17618
17619 .option require_files routers&!? "string list&!!" unset
17620 .cindex "file" "requiring for router"
17621 .cindex "router" "requiring file existence"
17622 This option provides a general mechanism for predicating the running of a
17623 router on the existence or non-existence of certain files or directories.
17624 Before running a router, as one of its precondition tests, Exim works its way
17625 through the &%require_files%& list, expanding each item separately.
17626
17627 Because the list is split before expansion, any colons in expansion items must
17628 be doubled, or the facility for using a different list separator must be used.
17629 If any expansion is forced to fail, the item is ignored. Other expansion
17630 failures cause routing of the address to be deferred.
17631
17632 If any expanded string is empty, it is ignored. Otherwise, except as described
17633 below, each string must be a fully qualified file path, optionally preceded by
17634 &"!"&. The paths are passed to the &[stat()]& function to test for the
17635 existence of the files or directories. The router is skipped if any paths not
17636 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17637
17638 .cindex "NFS"
17639 If &[stat()]& cannot determine whether a file exists or not, delivery of
17640 the message is deferred. This can happen when NFS-mounted filesystems are
17641 unavailable.
17642
17643 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17644 options, so you cannot use it to check for the existence of a file in which to
17645 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17646 full list of the order in which preconditions are evaluated.) However, as
17647 these options are all expanded, you can use the &%exists%& expansion condition
17648 to make such tests. The &%require_files%& option is intended for checking files
17649 that the router may be going to use internally, or which are needed by a
17650 transport (for example &_.procmailrc_&).
17651
17652 During delivery, the &[stat()]& function is run as root, but there is a
17653 facility for some checking of the accessibility of a file by another user.
17654 This is not a proper permissions check, but just a &"rough"& check that
17655 operates as follows:
17656
17657 If an item in a &%require_files%& list does not contain any forward slash
17658 characters, it is taken to be the user (and optional group, separated by a
17659 comma) to be checked for subsequent files in the list. If no group is specified
17660 but the user is specified symbolically, the gid associated with the uid is
17661 used. For example:
17662 .code
17663 require_files = mail:/some/file
17664 require_files = $local_part:$home/.procmailrc
17665 .endd
17666 If a user or group name in a &%require_files%& list does not exist, the
17667 &%require_files%& condition fails.
17668
17669 Exim performs the check by scanning along the components of the file path, and
17670 checking the access for the given uid and gid. It checks for &"x"& access on
17671 directories, and &"r"& access on the final file. Note that this means that file
17672 access control lists, if the operating system has them, are ignored.
17673
17674 &*Warning 1*&: When the router is being run to verify addresses for an
17675 incoming SMTP message, Exim is not running as root, but under its own uid. This
17676 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17677 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17678 user is not permitted to read one of the directories on the file's path.
17679
17680 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17681 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17682 without root access. In this case, if a check for access by a particular user
17683 is requested, Exim creates a subprocess that runs as that user, and tries the
17684 check again in that process.
17685
17686 The default action for handling an unresolved EACCES is to consider it to
17687 be caused by a configuration error, and routing is deferred because the
17688 existence or non-existence of the file cannot be determined. However, in some
17689 circumstances it may be desirable to treat this condition as if the file did
17690 not exist. If the file name (or the exclamation mark that precedes the file
17691 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17692 as if the file did not exist. For example:
17693 .code
17694 require_files = +/some/file
17695 .endd
17696 If the router is not an essential part of verification (for example, it
17697 handles users' &_.forward_& files), another solution is to set the &%verify%&
17698 option false so that the router is skipped when verifying.
17699
17700
17701
17702 .option retry_use_local_part routers boolean "see below"
17703 .cindex "hints database" "retry keys"
17704 .cindex "local part" "in retry keys"
17705 When a delivery suffers a temporary routing failure, a retry record is created
17706 in Exim's hints database. For addresses whose routing depends only on the
17707 domain, the key for the retry record should not involve the local part, but for
17708 other addresses, both the domain and the local part should be included.
17709 Usually, remote routing is of the former kind, and local routing is of the
17710 latter kind.
17711
17712 This option controls whether the local part is used to form the key for retry
17713 hints for addresses that suffer temporary errors while being handled by this
17714 router. The default value is true for any router that has &%check_local_user%&
17715 set, and false otherwise. Note that this option does not apply to hints keys
17716 for transport delays; they are controlled by a generic transport option of the
17717 same name.
17718
17719 The setting of &%retry_use_local_part%& applies only to the router on which it
17720 appears. If the router generates child addresses, they are routed
17721 independently; this setting does not become attached to them.
17722
17723
17724
17725 .option router_home_directory routers string&!! unset
17726 .cindex "router" "home directory for"
17727 .cindex "home directory" "for router"
17728 .vindex "&$home$&"
17729 This option sets a home directory for use while the router is running. (Compare
17730 &%transport_home_directory%&, which sets a home directory for later
17731 transporting.) In particular, if used on a &(redirect)& router, this option
17732 sets a value for &$home$& while a filter is running. The value is expanded;
17733 forced expansion failure causes the option to be ignored &-- other failures
17734 cause the router to defer.
17735
17736 Expansion of &%router_home_directory%& happens immediately after the
17737 &%check_local_user%& test (if configured), before any further expansions take
17738 place.
17739 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17740 are evaluated.)
17741 While the router is running, &%router_home_directory%& overrides the value of
17742 &$home$& that came from &%check_local_user%&.
17743
17744 When a router accepts an address and assigns it to a local transport (including
17745 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17746 delivery), the home directory setting for the transport is taken from the first
17747 of these values that is set:
17748
17749 .ilist
17750 The &%home_directory%& option on the transport;
17751 .next
17752 The &%transport_home_directory%& option on the router;
17753 .next
17754 The password data if &%check_local_user%& is set on the router;
17755 .next
17756 The &%router_home_directory%& option on the router.
17757 .endlist
17758
17759 In other words, &%router_home_directory%& overrides the password data for the
17760 router, but not for the transport.
17761
17762
17763
17764 .option self routers string freeze
17765 .cindex "MX record" "pointing to local host"
17766 .cindex "local host" "MX pointing to"
17767 This option applies to those routers that use a recipient address to find a
17768 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17769 and &(manualroute)& routers.
17770 Certain configurations of the &(queryprogram)& router can also specify a list
17771 of remote hosts.
17772 Usually such routers are configured to send the message to a remote host via an
17773 &(smtp)& transport. The &%self%& option specifies what happens when the first
17774 host on the list turns out to be the local host.
17775 The way in which Exim checks for the local host is described in section
17776 &<<SECTreclocipadd>>&.
17777
17778 Normally this situation indicates either an error in Exim's configuration (for
17779 example, the router should be configured not to process this domain), or an
17780 error in the DNS (for example, the MX should not point to this host). For this
17781 reason, the default action is to log the incident, defer the address, and
17782 freeze the message. The following alternatives are provided for use in special
17783 cases:
17784
17785 .vlist
17786 .vitem &%defer%&
17787 Delivery of the message is tried again later, but the message is not frozen.
17788
17789 .vitem "&%reroute%&: <&'domain'&>"
17790 The domain is changed to the given domain, and the address is passed back to
17791 be reprocessed by the routers. No rewriting of headers takes place. This
17792 behaviour is essentially a redirection.
17793
17794 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17795 The domain is changed to the given domain, and the address is passed back to be
17796 reprocessed by the routers. Any headers that contain the original domain are
17797 rewritten.
17798
17799 .vitem &%pass%&
17800 .oindex "&%more%&"
17801 .vindex "&$self_hostname$&"
17802 The router passes the address to the next router, or to the router named in the
17803 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17804 subsequent routing and delivery, the variable &$self_hostname$& contains the
17805 name of the local host that the router encountered. This can be used to
17806 distinguish between different cases for hosts with multiple names. The
17807 combination
17808 .code
17809 self = pass
17810 no_more
17811 .endd
17812 ensures that only those addresses that routed to the local host are passed on.
17813 Without &%no_more%&, addresses that were declined for other reasons would also
17814 be passed to the next router.
17815
17816 .vitem &%fail%&
17817 Delivery fails and an error report is generated.
17818
17819 .vitem &%send%&
17820 .cindex "local host" "sending to"
17821 The anomaly is ignored and the address is queued for the transport. This
17822 setting should be used with extreme caution. For an &(smtp)& transport, it
17823 makes sense only in cases where the program that is listening on the SMTP port
17824 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17825 different configuration file that handles the domain in another way.
17826 .endlist
17827
17828
17829
17830 .option senders routers&!? "address list&!!" unset
17831 .cindex "router" "checking senders"
17832 If this option is set, the router is skipped unless the message's sender
17833 address matches something on the list.
17834 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17835 are evaluated.
17836
17837 There are issues concerning verification when the running of routers is
17838 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17839 setting, it sets the sender to the null string. When using the &%-bt%& option
17840 to check a configuration file, it is necessary also to use the &%-f%& option to
17841 set an appropriate sender. For incoming mail, the sender is unset when
17842 verifying the sender, but is available when verifying any recipients. If the
17843 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17844 matters.
17845
17846
17847 .option translate_ip_address routers string&!! unset
17848 .cindex "IP address" "translating"
17849 .cindex "packet radio"
17850 .cindex "router" "IP address translation"
17851 There exist some rare networking situations (for example, packet radio) where
17852 it is helpful to be able to translate IP addresses generated by normal routing
17853 mechanisms into other IP addresses, thus performing a kind of manual IP
17854 routing. This should be done only if the normal IP routing of the TCP/IP stack
17855 is inadequate or broken. Because this is an extremely uncommon requirement, the
17856 code to support this option is not included in the Exim binary unless
17857 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17858
17859 .vindex "&$host_address$&"
17860 The &%translate_ip_address%& string is expanded for every IP address generated
17861 by the router, with the generated address set in &$host_address$&. If the
17862 expansion is forced to fail, no action is taken.
17863 For any other expansion error, delivery of the message is deferred.
17864 If the result of the expansion is an IP address, that replaces the original
17865 address; otherwise the result is assumed to be a host name &-- this is looked
17866 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17867 produce one or more replacement IP addresses. For example, to subvert all IP
17868 addresses in some specific networks, this could be added to a router:
17869 .code
17870 translate_ip_address = \
17871   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17872     {$value}fail}}
17873 .endd
17874 The file would contain lines like
17875 .code
17876 10.2.3.128/26    some.host
17877 10.8.4.34/26     10.44.8.15
17878 .endd
17879 You should not make use of this facility unless you really understand what you
17880 are doing.
17881
17882
17883
17884 .option transport routers string&!! unset
17885 This option specifies the transport to be used when a router accepts an address
17886 and sets it up for delivery. A transport is never needed if a router is used
17887 only for verification. The value of the option is expanded at routing time,
17888 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17889 and result must be the name of one of the configured transports. If it is not,
17890 delivery is deferred.
17891
17892 The &%transport%& option is not used by the &(redirect)& router, but it does
17893 have some private options that set up transports for pipe and file deliveries
17894 (see chapter &<<CHAPredirect>>&).
17895
17896
17897
17898 .option transport_current_directory routers string&!! unset
17899 .cindex "current directory for local transport"
17900 This option associates a current directory with any address that is routed
17901 to a local transport. This can happen either because a transport is
17902 explicitly configured for the router, or because it generates a delivery to a
17903 file or a pipe. During the delivery process (that is, at transport time), this
17904 option string is expanded and is set as the current directory, unless
17905 overridden by a setting on the transport.
17906 If the expansion fails for any reason, including forced failure, an error is
17907 logged, and delivery is deferred.
17908 See chapter &<<CHAPenvironment>>& for details of the local delivery
17909 environment.
17910
17911
17912
17913
17914 .option transport_home_directory routers string&!! "see below"
17915 .cindex "home directory" "for local transport"
17916 This option associates a home directory with any address that is routed to a
17917 local transport. This can happen either because a transport is explicitly
17918 configured for the router, or because it generates a delivery to a file or a
17919 pipe. During the delivery process (that is, at transport time), the option
17920 string is expanded and is set as the home directory, unless overridden by a
17921 setting of &%home_directory%& on the transport.
17922 If the expansion fails for any reason, including forced failure, an error is
17923 logged, and delivery is deferred.
17924
17925 If the transport does not specify a home directory, and
17926 &%transport_home_directory%& is not set for the router, the home directory for
17927 the transport is taken from the password data if &%check_local_user%& is set for
17928 the router. Otherwise it is taken from &%router_home_directory%& if that option
17929 is set; if not, no home directory is set for the transport.
17930
17931 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17932 environment.
17933
17934
17935
17936
17937 .option unseen routers boolean&!! false
17938 .cindex "router" "carrying on after success"
17939 The result of string expansion for this option must be a valid boolean value,
17940 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17941 result causes an error, and delivery is deferred. If the expansion is forced to
17942 fail, the default value for the option (false) is used. Other failures cause
17943 delivery to be deferred.
17944
17945 When this option is set true, routing does not cease if the router accepts the
17946 address. Instead, a copy of the incoming address is passed to the next router,
17947 overriding a false setting of &%more%&. There is little point in setting
17948 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
17949 the value of &%unseen%& contains expansion items (and therefore, presumably, is
17950 sometimes true and sometimes false).
17951
17952 .cindex "copy of message (&%unseen%& option)"
17953 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
17954 qualifier in filter files. It can be used to cause copies of messages to be
17955 delivered to some other destination, while also carrying out a normal delivery.
17956 In effect, the current address is made into a &"parent"& that has two children
17957 &-- one that is delivered as specified by this router, and a clone that goes on
17958 to be routed further. For this reason, &%unseen%& may not be combined with the
17959 &%one_time%& option in a &(redirect)& router.
17960
17961 &*Warning*&: Header lines added to the address (or specified for removal) by
17962 this router or by previous routers affect the &"unseen"& copy of the message
17963 only. The clone that continues to be processed by further routers starts with
17964 no added headers and none specified for removal. For a &%redirect%& router, if
17965 a generated address is the same as the incoming address, this can lead to
17966 duplicate addresses with different header modifications. Exim does not do
17967 duplicate deliveries (except, in certain circumstances, to pipes -- see section
17968 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
17969 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
17970 &%redirect%& router may be of help.
17971
17972 Unlike the handling of header modifications, any data that was set by the
17973 &%address_data%& option in the current or previous routers &'is'& passed on to
17974 subsequent routers.
17975
17976
17977 .option user routers string&!! "see below"
17978 .cindex "uid (user id)" "local delivery"
17979 .cindex "local transports" "uid and gid"
17980 .cindex "transport" "local"
17981 .cindex "router" "user for filter processing"
17982 .cindex "filter" "user for processing"
17983 When a router queues an address for a transport, and the transport does not
17984 specify a user, the user given here is used when running the delivery process.
17985 The user may be specified numerically or by name. If expansion fails, the
17986 error is logged and delivery is deferred.
17987 This user is also used by the &(redirect)& router when running a filter file.
17988 The default is unset, except when &%check_local_user%& is set. In this case,
17989 the default is taken from the password information. If the user is specified as
17990 a name, and &%group%& is not set, the group associated with the user is used.
17991 See also &%initgroups%& and &%group%& and the discussion in chapter
17992 &<<CHAPenvironment>>&.
17993
17994
17995
17996 .option verify routers&!? boolean true
17997 Setting this option has the effect of setting &%verify_sender%& and
17998 &%verify_recipient%& to the same value.
17999
18000
18001 .option verify_only routers&!? boolean false
18002 .cindex "EXPN" "with &%verify_only%&"
18003 .oindex "&%-bv%&"
18004 .cindex "router" "used only when verifying"
18005 If this option is set, the router is used only when verifying an address,
18006 delivering in cutthrough mode or
18007 testing with the &%-bv%& option, not when actually doing a delivery, testing
18008 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18009 restricted to verifying only senders or recipients by means of
18010 &%verify_sender%& and &%verify_recipient%&.
18011
18012 &*Warning*&: When the router is being run to verify addresses for an incoming
18013 SMTP message, Exim is not running as root, but under its own uid. If the router
18014 accesses any files, you need to make sure that they are accessible to the Exim
18015 user or group.
18016
18017
18018 .option verify_recipient routers&!? boolean true
18019 If this option is false, the router is skipped when verifying recipient
18020 addresses,
18021 delivering in cutthrough mode
18022 or testing recipient verification using &%-bv%&.
18023 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18024 are evaluated.
18025 See also the &$verify_mode$& variable.
18026
18027
18028 .option verify_sender routers&!? boolean true
18029 If this option is false, the router is skipped when verifying sender addresses
18030 or testing sender verification using &%-bvs%&.
18031 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18032 are evaluated.
18033 See also the &$verify_mode$& variable.
18034 .ecindex IIDgenoprou1
18035 .ecindex IIDgenoprou2
18036
18037
18038
18039
18040
18041
18042 . ////////////////////////////////////////////////////////////////////////////
18043 . ////////////////////////////////////////////////////////////////////////////
18044
18045 .chapter "The accept router" "CHID4"
18046 .cindex "&(accept)& router"
18047 .cindex "routers" "&(accept)&"
18048 The &(accept)& router has no private options of its own. Unless it is being
18049 used purely for verification (see &%verify_only%&) a transport is required to
18050 be defined by the generic &%transport%& option. If the preconditions that are
18051 specified by generic options are met, the router accepts the address and queues
18052 it for the given transport. The most common use of this router is for setting
18053 up deliveries to local mailboxes. For example:
18054 .code
18055 localusers:
18056   driver = accept
18057   domains = mydomain.example
18058   check_local_user
18059   transport = local_delivery
18060 .endd
18061 The &%domains%& condition in this example checks the domain of the address, and
18062 &%check_local_user%& checks that the local part is the login of a local user.
18063 When both preconditions are met, the &(accept)& router runs, and queues the
18064 address for the &(local_delivery)& transport.
18065
18066
18067
18068
18069
18070
18071 . ////////////////////////////////////////////////////////////////////////////
18072 . ////////////////////////////////////////////////////////////////////////////
18073
18074 .chapter "The dnslookup router" "CHAPdnslookup"
18075 .scindex IIDdnsrou1 "&(dnslookup)& router"
18076 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18077 The &(dnslookup)& router looks up the hosts that handle mail for the
18078 recipient's domain in the DNS. A transport must always be set for this router,
18079 unless &%verify_only%& is set.
18080
18081 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18082 SRV records. If none are found, or if SRV support is not configured,
18083 MX records are looked up. If no MX records exist, address records are sought.
18084 However, &%mx_domains%& can be set to disable the direct use of address
18085 records.
18086
18087 MX records of equal priority are sorted by Exim into a random order. Exim then
18088 looks for address records for the host names obtained from MX or SRV records.
18089 When a host has more than one IP address, they are sorted into a random order,
18090 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18091 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18092 generic option, the router declines.
18093
18094 Unless they have the highest priority (lowest MX value), MX records that point
18095 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18096 are discarded, together with any other MX records of equal or lower priority.
18097
18098 .cindex "MX record" "pointing to local host"
18099 .cindex "local host" "MX pointing to"
18100 .oindex "&%self%&" "in &(dnslookup)& router"
18101 If the host pointed to by the highest priority MX record, or looked up as an
18102 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18103 happens is controlled by the generic &%self%& option.
18104
18105
18106 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18107 There have been problems with DNS servers when SRV records are looked up.
18108 Some mis-behaving servers return a DNS error or timeout when a non-existent
18109 SRV record is sought. Similar problems have in the past been reported for
18110 MX records. The global &%dns_again_means_nonexist%& option can help with this
18111 problem, but it is heavy-handed because it is a global option.
18112
18113 For this reason, there are two options, &%srv_fail_domains%& and
18114 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18115 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18116 an attempt to look up an SRV or MX record causes one of these results, and the
18117 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18118 such record"&. In the case of an SRV lookup, this means that the router
18119 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18120 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18121 case routing fails.
18122
18123
18124 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18125 .cindex "&(dnslookup)& router" "declines"
18126 There are a few cases where a &(dnslookup)& router will decline to accept
18127 an address; if such a router is expected to handle "all remaining non-local
18128 domains", then it is important to set &%no_more%&.
18129
18130 The router will defer rather than decline if the domain
18131 is found in the &%fail_defer_domains%& router option.
18132
18133 Reasons for a &(dnslookup)& router to decline currently include:
18134 .ilist
18135 The domain does not exist in DNS
18136 .next
18137 The domain exists but the MX record's host part is just "."; this is a common
18138 convention (borrowed from SRV) used to indicate that there is no such service
18139 for this domain and to not fall back to trying A/AAAA records.
18140 .next
18141 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18142 .next
18143 MX record points to a non-existent host.
18144 .next
18145 MX record points to an IP address and the main section option
18146 &%allow_mx_to_ip%& is not set.
18147 .next
18148 MX records exist and point to valid hosts, but all hosts resolve only to
18149 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18150 .next
18151 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18152 &%dns_check_names_pattern%& for handling one variant of this)
18153 .next
18154 &%check_secondary_mx%& is set on this router but the local host can
18155 not be found in the MX records (see below)
18156 .endlist
18157
18158
18159
18160
18161 .section "Private options for dnslookup" "SECID118"
18162 .cindex "options" "&(dnslookup)& router"
18163 The private options for the &(dnslookup)& router are as follows:
18164
18165 .option check_secondary_mx dnslookup boolean false
18166 .cindex "MX record" "checking for secondary"
18167 If this option is set, the router declines unless the local host is found in
18168 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18169 process domains for which the local host is a secondary mail exchanger
18170 differently to other domains. The way in which Exim decides whether a host is
18171 the local host is described in section &<<SECTreclocipadd>>&.
18172
18173
18174 .option check_srv dnslookup string&!! unset
18175 .cindex "SRV record" "enabling use of"
18176 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18177 addition to MX and address records. The support is disabled by default. To
18178 enable SRV support, set the &%check_srv%& option to the name of the service
18179 required. For example,
18180 .code
18181 check_srv = smtp
18182 .endd
18183 looks for SRV records that refer to the normal smtp service. The option is
18184 expanded, so the service name can vary from message to message or address
18185 to address. This might be helpful if SRV records are being used for a
18186 submission service. If the expansion is forced to fail, the &%check_srv%&
18187 option is ignored, and the router proceeds to look for MX records in the
18188 normal way.
18189
18190 When the expansion succeeds, the router searches first for SRV records for
18191 the given service (it assumes TCP protocol). A single SRV record with a
18192 host name that consists of just a single dot indicates &"no such service for
18193 this domain"&; if this is encountered, the router declines. If other kinds of
18194 SRV record are found, they are used to construct a host list for delivery
18195 according to the rules of RFC 2782. MX records are not sought in this case.
18196
18197 When no SRV records are found, MX records (and address records) are sought in
18198 the traditional way. In other words, SRV records take precedence over MX
18199 records, just as MX records take precedence over address records. Note that
18200 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18201 defined it. It is apparently believed that MX records are sufficient for email
18202 and that SRV records should not be used for this purpose. However, SRV records
18203 have an additional &"weight"& feature which some people might find useful when
18204 trying to split an SMTP load between hosts of different power.
18205
18206 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18207 when there is a DNS lookup error.
18208
18209
18210
18211
18212 .option fail_defer_domains dnslookup "domain list&!!" unset
18213 .cindex "MX record" "not found"
18214 DNS lookups for domains matching &%fail_defer_domains%&
18215 which find no matching record will cause the router to defer
18216 rather than the default behaviour of decline.
18217 This maybe be useful for queueing messages for a newly created
18218 domain while the DNS configuration is not ready.
18219 However, it will result in any message with mistyped domains
18220 also being queued.
18221
18222
18223 .option mx_domains dnslookup "domain list&!!" unset
18224 .cindex "MX record" "required to exist"
18225 .cindex "SRV record" "required to exist"
18226 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18227 record in order to be recognized. (The name of this option could be improved.)
18228 For example, if all the mail hosts in &'fict.example'& are known to have MX
18229 records, except for those in &'discworld.fict.example'&, you could use this
18230 setting:
18231 .code
18232 mx_domains = ! *.discworld.fict.example : *.fict.example
18233 .endd
18234 This specifies that messages addressed to a domain that matches the list but
18235 has no MX record should be bounced immediately instead of being routed using
18236 the address record.
18237
18238
18239 .option mx_fail_domains dnslookup "domain list&!!" unset
18240 If the DNS lookup for MX records for one of the domains in this list causes a
18241 DNS lookup error, Exim behaves as if no MX records were found. See section
18242 &<<SECTprowitdnsloo>>& for more discussion.
18243
18244
18245
18246
18247 .option qualify_single dnslookup boolean true
18248 .cindex "DNS" "resolver options"
18249 .cindex "DNS" "qualifying single-component names"
18250 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18251 lookups. Typically, but not standardly, this causes the resolver to qualify
18252 single-component names with the default domain. For example, on a machine
18253 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18254 &'thesaurus.ref.example'& inside the resolver. For details of what your
18255 resolver actually does, consult your man pages for &'resolver'& and
18256 &'resolv.conf'&.
18257
18258
18259
18260 .option rewrite_headers dnslookup boolean true
18261 .cindex "rewriting" "header lines"
18262 .cindex "header lines" "rewriting"
18263 If the domain name in the address that is being processed is not fully
18264 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18265 an address is specified as &'dormouse@teaparty'&, the domain might be
18266 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18267 occur as a result of setting the &%widen_domains%& option. If
18268 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18269 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18270 header lines of the message are rewritten with the full domain name.
18271
18272 This option should be turned off only when it is known that no message is
18273 ever going to be sent outside an environment where the abbreviation makes
18274 sense.
18275
18276 When an MX record is looked up in the DNS and matches a wildcard record, name
18277 servers normally return a record containing the name that has been looked up,
18278 making it impossible to detect whether a wildcard was present or not. However,
18279 some name servers have recently been seen to return the wildcard entry. If the
18280 name returned by a DNS lookup begins with an asterisk, it is not used for
18281 header rewriting.
18282
18283
18284 .option same_domain_copy_routing dnslookup boolean false
18285 .cindex "address" "copying routing"
18286 Addresses with the same domain are normally routed by the &(dnslookup)& router
18287 to the same list of hosts. However, this cannot be presumed, because the router
18288 options and preconditions may refer to the local part of the address. By
18289 default, therefore, Exim routes each address in a message independently. DNS
18290 servers run caches, so repeated DNS lookups are not normally expensive, and in
18291 any case, personal messages rarely have more than a few recipients.
18292
18293 If you are running mailing lists with large numbers of subscribers at the same
18294 domain, and you are using a &(dnslookup)& router which is independent of the
18295 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18296 lookups for identical domains in one message. In this case, when &(dnslookup)&
18297 routes an address to a remote transport, any other unrouted addresses in the
18298 message that have the same domain are automatically given the same routing
18299 without processing them independently,
18300 provided the following conditions are met:
18301
18302 .ilist
18303 No router that processed the address specified &%headers_add%& or
18304 &%headers_remove%&.
18305 .next
18306 The router did not change the address in any way, for example, by &"widening"&
18307 the domain.
18308 .endlist
18309
18310
18311
18312
18313 .option search_parents dnslookup boolean false
18314 .cindex "DNS" "resolver options"
18315 When this option is true, the resolver option RES_DNSRCH is set for DNS
18316 lookups. This is different from the &%qualify_single%& option in that it
18317 applies to domains containing dots. Typically, but not standardly, it causes
18318 the resolver to search for the name in the current domain and in parent
18319 domains. For example, on a machine in the &'fict.example'& domain, if looking
18320 up &'teaparty.wonderland'& failed, the resolver would try
18321 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18322 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18323
18324 Setting this option true can cause problems in domains that have a wildcard MX
18325 record, because any domain that does not have its own MX record matches the
18326 local wildcard.
18327
18328
18329
18330 .option srv_fail_domains dnslookup "domain list&!!" unset
18331 If the DNS lookup for SRV records for one of the domains in this list causes a
18332 DNS lookup error, Exim behaves as if no SRV records were found. See section
18333 &<<SECTprowitdnsloo>>& for more discussion.
18334
18335
18336
18337
18338 .option widen_domains dnslookup "string list" unset
18339 .cindex "domain" "partial; widening"
18340 If a DNS lookup fails and this option is set, each of its strings in turn is
18341 added onto the end of the domain, and the lookup is tried again. For example,
18342 if
18343 .code
18344 widen_domains = fict.example:ref.example
18345 .endd
18346 is set and a lookup of &'klingon.dictionary'& fails,
18347 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18348 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18349 and &%search_parents%& options can cause some widening to be undertaken inside
18350 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18351 when verifying, unless &%rewrite_headers%& is false (not the default).
18352
18353
18354 .section "Effect of qualify_single and search_parents" "SECID119"
18355 When a domain from an envelope recipient is changed by the resolver as a result
18356 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18357 corresponding address in the message's header lines unless &%rewrite_headers%&
18358 is set false. Exim then re-routes the address, using the full domain.
18359
18360 These two options affect only the DNS lookup that takes place inside the router
18361 for the domain of the address that is being routed. They do not affect lookups
18362 such as that implied by
18363 .code
18364 domains = @mx_any
18365 .endd
18366 that may happen while processing a router precondition before the router is
18367 entered. No widening ever takes place for these lookups.
18368 .ecindex IIDdnsrou1
18369 .ecindex IIDdnsrou2
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379 . ////////////////////////////////////////////////////////////////////////////
18380 . ////////////////////////////////////////////////////////////////////////////
18381
18382 .chapter "The ipliteral router" "CHID5"
18383 .cindex "&(ipliteral)& router"
18384 .cindex "domain literal" "routing"
18385 .cindex "routers" "&(ipliteral)&"
18386 This router has no private options. Unless it is being used purely for
18387 verification (see &%verify_only%&) a transport is required to be defined by the
18388 generic &%transport%& option. The router accepts the address if its domain part
18389 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18390 router handles the address
18391 .code
18392 root@[192.168.1.1]
18393 .endd
18394 by setting up delivery to the host with that IP address. IPv4 domain literals
18395 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18396 are similar, but the address is preceded by &`ipv6:`&. For example:
18397 .code
18398 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18399 .endd
18400 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18401 grounds that sooner or later somebody will try it.
18402
18403 .oindex "&%self%&" "in &(ipliteral)& router"
18404 If the IP address matches something in &%ignore_target_hosts%&, the router
18405 declines. If an IP literal turns out to refer to the local host, the generic
18406 &%self%& option determines what happens.
18407
18408 The RFCs require support for domain literals; however, their use is
18409 controversial in today's Internet. If you want to use this router, you must
18410 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18411 Exim will not recognize the domain literal syntax in addresses.
18412
18413
18414
18415 . ////////////////////////////////////////////////////////////////////////////
18416 . ////////////////////////////////////////////////////////////////////////////
18417
18418 .chapter "The iplookup router" "CHID6"
18419 .cindex "&(iplookup)& router"
18420 .cindex "routers" "&(iplookup)&"
18421 The &(iplookup)& router was written to fulfil a specific requirement in
18422 Cambridge University (which in fact no longer exists). For this reason, it is
18423 not included in the binary of Exim by default. If you want to include it, you
18424 must set
18425 .code
18426 ROUTER_IPLOOKUP=yes
18427 .endd
18428 in your &_Local/Makefile_& configuration file.
18429
18430 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18431 connection to one or more specific hosts. The host can then return the same or
18432 a different address &-- in effect rewriting the recipient address in the
18433 message's envelope. The new address is then passed on to subsequent routers. If
18434 this process fails, the address can be passed on to other routers, or delivery
18435 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18436 must not be specified for it.
18437
18438 .cindex "options" "&(iplookup)& router"
18439 .option hosts iplookup string unset
18440 This option must be supplied. Its value is a colon-separated list of host
18441 names. The hosts are looked up using &[gethostbyname()]&
18442 (or &[getipnodebyname()]& when available)
18443 and are tried in order until one responds to the query. If none respond, what
18444 happens is controlled by &%optional%&.
18445
18446
18447 .option optional iplookup boolean false
18448 If &%optional%& is true, if no response is obtained from any host, the address
18449 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18450 delivery to the address is deferred.
18451
18452
18453 .option port iplookup integer 0
18454 .cindex "port" "&(iplookup)& router"
18455 This option must be supplied. It specifies the port number for the TCP or UDP
18456 call.
18457
18458
18459 .option protocol iplookup string udp
18460 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18461 protocols is to be used.
18462
18463
18464 .option query iplookup string&!! "see below"
18465 This defines the content of the query that is sent to the remote hosts. The
18466 default value is:
18467 .code
18468 $local_part@$domain $local_part@$domain
18469 .endd
18470 The repetition serves as a way of checking that a response is to the correct
18471 query in the default case (see &%response_pattern%& below).
18472
18473
18474 .option reroute iplookup string&!! unset
18475 If this option is not set, the rerouted address is precisely the byte string
18476 returned by the remote host, up to the first white space, if any. If set, the
18477 string is expanded to form the rerouted address. It can include parts matched
18478 in the response by &%response_pattern%& by means of numeric variables such as
18479 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18480 whether or not a pattern is in use. In all cases, the rerouted address must end
18481 up in the form &'local_part@domain'&.
18482
18483
18484 .option response_pattern iplookup string unset
18485 This option can be set to a regular expression that is applied to the string
18486 returned from the remote host. If the pattern does not match the response, the
18487 router declines. If &%response_pattern%& is not set, no checking of the
18488 response is done, unless the query was defaulted, in which case there is a
18489 check that the text returned after the first white space is the original
18490 address. This checks that the answer that has been received is in response to
18491 the correct question. For example, if the response is just a new domain, the
18492 following could be used:
18493 .code
18494 response_pattern = ^([^@]+)$
18495 reroute = $local_part@$1
18496 .endd
18497
18498 .option timeout iplookup time 5s
18499 This specifies the amount of time to wait for a response from the remote
18500 machine. The same timeout is used for the &[connect()]& function for a TCP
18501 call. It does not apply to UDP.
18502
18503
18504
18505
18506 . ////////////////////////////////////////////////////////////////////////////
18507 . ////////////////////////////////////////////////////////////////////////////
18508
18509 .chapter "The manualroute router" "CHID7"
18510 .scindex IIDmanrou1 "&(manualroute)& router"
18511 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18512 .cindex "domain" "manually routing"
18513 The &(manualroute)& router is so-called because it provides a way of manually
18514 routing an address according to its domain. It is mainly used when you want to
18515 route addresses to remote hosts according to your own rules, bypassing the
18516 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18517 route to local transports, a facility that may be useful if you want to save
18518 messages for dial-in hosts in local files.
18519
18520 The &(manualroute)& router compares a list of domain patterns with the domain
18521 it is trying to route. If there is no match, the router declines. Each pattern
18522 has associated with it a list of hosts and some other optional data, which may
18523 include a transport. The combination of a pattern and its data is called a
18524 &"routing rule"&. For patterns that do not have an associated transport, the
18525 generic &%transport%& option must specify a transport, unless the router is
18526 being used purely for verification (see &%verify_only%&).
18527
18528 .vindex "&$host$&"
18529 In the case of verification, matching the domain pattern is sufficient for the
18530 router to accept the address. When actually routing an address for delivery,
18531 an address that matches a domain pattern is queued for the associated
18532 transport. If the transport is not a local one, a host list must be associated
18533 with the pattern; IP addresses are looked up for the hosts, and these are
18534 passed to the transport along with the mail address. For local transports, a
18535 host list is optional. If it is present, it is passed in &$host$& as a single
18536 text string.
18537
18538 The list of routing rules can be provided as an inline string in
18539 &%route_list%&, or the data can be obtained by looking up the domain in a file
18540 or database by setting &%route_data%&. Only one of these settings may appear in
18541 any one instance of &(manualroute)&. The format of routing rules is described
18542 below, following the list of private options.
18543
18544
18545 .section "Private options for manualroute" "SECTprioptman"
18546
18547 .cindex "options" "&(manualroute)& router"
18548 The private options for the &(manualroute)& router are as follows:
18549
18550 .option host_all_ignored manualroute string defer
18551 See &%host_find_failed%&.
18552
18553 .option host_find_failed manualroute string freeze
18554 This option controls what happens when &(manualroute)& tries to find an IP
18555 address for a host, and the host does not exist. The option can be set to one
18556 of the following values:
18557 .code
18558 decline
18559 defer
18560 fail
18561 freeze
18562 ignore
18563 pass
18564 .endd
18565 The default (&"freeze"&) assumes that this state is a serious configuration
18566 error. The difference between &"pass"& and &"decline"& is that the former
18567 forces the address to be passed to the next router (or the router defined by
18568 &%pass_router%&),
18569 .oindex "&%more%&"
18570 overriding &%no_more%&, whereas the latter passes the address to the next
18571 router only if &%more%& is true.
18572
18573 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18574 cannot be found. If all the hosts in the list are ignored, the behaviour is
18575 controlled by the &%host_all_ignored%& option. This takes the same values
18576 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18577
18578 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18579 state; if a host lookup gets a temporary error, delivery is deferred unless the
18580 generic &%pass_on_timeout%& option is set.
18581
18582
18583 .option hosts_randomize manualroute boolean false
18584 .cindex "randomized host list"
18585 .cindex "host" "list of; randomized"
18586 If this option is set, the order of the items in a host list in a routing rule
18587 is randomized each time the list is used, unless an option in the routing rule
18588 overrides (see below). Randomizing the order of a host list can be used to do
18589 crude load sharing. However, if more than one mail address is routed by the
18590 same router to the same host list, the host lists are considered to be the same
18591 (even though they may be randomized into different orders) for the purpose of
18592 deciding whether to batch the deliveries into a single SMTP transaction.
18593
18594 When &%hosts_randomize%& is true, a host list may be split
18595 into groups whose order is separately randomized. This makes it possible to
18596 set up MX-like behaviour. The boundaries between groups are indicated by an
18597 item that is just &`+`& in the host list. For example:
18598 .code
18599 route_list = * host1:host2:host3:+:host4:host5
18600 .endd
18601 The order of the first three hosts and the order of the last two hosts is
18602 randomized for each use, but the first three always end up before the last two.
18603 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18604 randomized host list is passed to an &(smtp)& transport that also has
18605 &%hosts_randomize set%&, the list is not re-randomized.
18606
18607
18608 .option route_data manualroute string&!! unset
18609 If this option is set, it must expand to yield the data part of a routing rule.
18610 Typically, the expansion string includes a lookup based on the domain. For
18611 example:
18612 .code
18613 route_data = ${lookup{$domain}dbm{/etc/routes}}
18614 .endd
18615 If the expansion is forced to fail, or the result is an empty string, the
18616 router declines. Other kinds of expansion failure cause delivery to be
18617 deferred.
18618
18619
18620 .option route_list manualroute "string list" unset
18621 This string is a list of routing rules, in the form defined below. Note that,
18622 unlike most string lists, the items are separated by semicolons. This is so
18623 that they may contain colon-separated host lists.
18624
18625
18626 .option same_domain_copy_routing manualroute boolean false
18627 .cindex "address" "copying routing"
18628 Addresses with the same domain are normally routed by the &(manualroute)&
18629 router to the same list of hosts. However, this cannot be presumed, because the
18630 router options and preconditions may refer to the local part of the address. By
18631 default, therefore, Exim routes each address in a message independently. DNS
18632 servers run caches, so repeated DNS lookups are not normally expensive, and in
18633 any case, personal messages rarely have more than a few recipients.
18634
18635 If you are running mailing lists with large numbers of subscribers at the same
18636 domain, and you are using a &(manualroute)& router which is independent of the
18637 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18638 lookups for identical domains in one message. In this case, when
18639 &(manualroute)& routes an address to a remote transport, any other unrouted
18640 addresses in the message that have the same domain are automatically given the
18641 same routing without processing them independently. However, this is only done
18642 if &%headers_add%& and &%headers_remove%& are unset.
18643
18644
18645
18646
18647 .section "Routing rules in route_list" "SECID120"
18648 The value of &%route_list%& is a string consisting of a sequence of routing
18649 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18650 entered as two semicolons. Alternatively, the list separator can be changed as
18651 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18652 Empty rules are ignored. The format of each rule is
18653 .display
18654 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18655 .endd
18656 The following example contains two rules, each with a simple domain pattern and
18657 no options:
18658 .code
18659 route_list = \
18660   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18661   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18662 .endd
18663 The three parts of a rule are separated by white space. The pattern and the
18664 list of hosts can be enclosed in quotes if necessary, and if they are, the
18665 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18666 single domain pattern, which is the only mandatory item in the rule. The
18667 pattern is in the same format as one item in a domain list (see section
18668 &<<SECTdomainlist>>&),
18669 except that it may not be the name of an interpolated file.
18670 That is, it may be wildcarded, or a regular expression, or a file or database
18671 lookup (with semicolons doubled, because of the use of semicolon as a separator
18672 in a &%route_list%&).
18673
18674 The rules in &%route_list%& are searched in order until one of the patterns
18675 matches the domain that is being routed. The list of hosts and then options are
18676 then used as described below. If there is no match, the router declines. When
18677 &%route_list%& is set, &%route_data%& must not be set.
18678
18679
18680
18681 .section "Routing rules in route_data" "SECID121"
18682 The use of &%route_list%& is convenient when there are only a small number of
18683 routing rules. For larger numbers, it is easier to use a file or database to
18684 hold the routing information, and use the &%route_data%& option instead.
18685 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18686 Most commonly, &%route_data%& is set as a string that contains an
18687 expansion lookup. For example, suppose we place two routing rules in a file
18688 like this:
18689 .code
18690 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18691 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18692 .endd
18693 This data can be accessed by setting
18694 .code
18695 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18696 .endd
18697 Failure of the lookup results in an empty string, causing the router to
18698 decline. However, you do not have to use a lookup in &%route_data%&. The only
18699 requirement is that the result of expanding the string is a list of hosts,
18700 possibly followed by options, separated by white space. The list of hosts must
18701 be enclosed in quotes if it contains white space.
18702
18703
18704
18705
18706 .section "Format of the list of hosts" "SECID122"
18707 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18708 always separately expanded before use. If the expansion fails, the router
18709 declines. The result of the expansion must be a colon-separated list of names
18710 and/or IP addresses, optionally also including ports. The format of each item
18711 in the list is described in the next section. The list separator can be changed
18712 as described in section &<<SECTlistconstruct>>&.
18713
18714 If the list of hosts was obtained from a &%route_list%& item, the following
18715 variables are set during its expansion:
18716
18717 .ilist
18718 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18719 If the domain was matched against a regular expression, the numeric variables
18720 &$1$&, &$2$&, etc. may be set. For example:
18721 .code
18722 route_list = ^domain(\d+)   host-$1.text.example
18723 .endd
18724 .next
18725 &$0$& is always set to the entire domain.
18726 .next
18727 &$1$& is also set when partial matching is done in a file lookup.
18728
18729 .next
18730 .vindex "&$value$&"
18731 If the pattern that matched the domain was a lookup item, the data that was
18732 looked up is available in the expansion variable &$value$&. For example:
18733 .code
18734 route_list = lsearch;;/some/file.routes  $value
18735 .endd
18736 .endlist
18737
18738 Note the doubling of the semicolon in the pattern that is necessary because
18739 semicolon is the default route list separator.
18740
18741
18742
18743 .section "Format of one host item" "SECTformatonehostitem"
18744 Each item in the list of hosts is either a host name or an IP address,
18745 optionally with an attached port number. When no port is given, an IP address
18746 is not enclosed in brackets. When a port is specified, it overrides the port
18747 specification on the transport. The port is separated from the name or address
18748 by a colon. This leads to some complications:
18749
18750 .ilist
18751 Because colon is the default separator for the list of hosts, either
18752 the colon that specifies a port must be doubled, or the list separator must
18753 be changed. The following two examples have the same effect:
18754 .code
18755 route_list = * "host1.tld::1225 : host2.tld::1226"
18756 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18757 .endd
18758 .next
18759 When IPv6 addresses are involved, it gets worse, because they contain
18760 colons of their own. To make this case easier, it is permitted to
18761 enclose an IP address (either v4 or v6) in square brackets if a port
18762 number follows. For example:
18763 .code
18764 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18765 .endd
18766 .endlist
18767
18768 .section "How the list of hosts is used" "SECThostshowused"
18769 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18770 the hosts is tried, in the order specified, when carrying out the SMTP
18771 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18772 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18773 transport.
18774
18775 Hosts may be listed by name or by IP address. An unadorned name in the list of
18776 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18777 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18778 records in the DNS. For example:
18779 .code
18780 route_list = *  x.y.z:p.q.r/MX:e.f.g
18781 .endd
18782 If this feature is used with a port specifier, the port must come last. For
18783 example:
18784 .code
18785 route_list = *  dom1.tld/mx::1225
18786 .endd
18787 If the &%hosts_randomize%& option is set, the order of the items in the list is
18788 randomized before any lookups are done. Exim then scans the list; for any name
18789 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18790 be an interface on the local host and the item is not the first in the list,
18791 Exim discards it and any subsequent items. If it is the first item, what
18792 happens is controlled by the
18793 .oindex "&%self%&" "in &(manualroute)& router"
18794 &%self%& option of the router.
18795
18796 A name on the list that is followed by &`/MX`& is replaced with the list of
18797 hosts obtained by looking up MX records for the name. This is always a DNS
18798 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18799 below) are not relevant here. The order of these hosts is determined by the
18800 preference values in the MX records, according to the usual rules. Because
18801 randomizing happens before the MX lookup, it does not affect the order that is
18802 defined by MX preferences.
18803
18804 If the local host is present in the sublist obtained from MX records, but is
18805 not the most preferred host in that list, it and any equally or less
18806 preferred hosts are removed before the sublist is inserted into the main list.
18807
18808 If the local host is the most preferred host in the MX list, what happens
18809 depends on where in the original list of hosts the &`/MX`& item appears. If it
18810 is not the first item (that is, there are previous hosts in the main list),
18811 Exim discards this name and any subsequent items in the main list.
18812
18813 If the MX item is first in the list of hosts, and the local host is the
18814 most preferred host, what happens is controlled by the &%self%& option of the
18815 router.
18816
18817 DNS failures when lookup up the MX records are treated in the same way as DNS
18818 failures when looking up IP addresses: &%pass_on_timeout%& and
18819 &%host_find_failed%& are used when relevant.
18820
18821 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18822 whether obtained from an MX lookup or not.
18823
18824
18825
18826 .section "How the options are used" "SECThowoptused"
18827 The options are a sequence of words; in practice no more than three are ever
18828 present. One of the words can be the name of a transport; this overrides the
18829 &%transport%& option on the router for this particular routing rule only. The
18830 other words (if present) control randomization of the list of hosts on a
18831 per-rule basis, and how the IP addresses of the hosts are to be found when
18832 routing to a remote transport. These options are as follows:
18833
18834 .ilist
18835 &%randomize%&: randomize the order of the hosts in this list, overriding the
18836 setting of &%hosts_randomize%& for this routing rule only.
18837 .next
18838 &%no_randomize%&: do not randomize the order of the hosts in this list,
18839 overriding the setting of &%hosts_randomize%& for this routing rule only.
18840 .next
18841 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18842 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18843 also look in &_/etc/hosts_& or other sources of information.
18844 .next
18845 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18846 no address records are found. If there is a temporary DNS error (such as a
18847 timeout), delivery is deferred.
18848 .endlist
18849
18850 For example:
18851 .code
18852 route_list = domain1  host1:host2:host3  randomize bydns;\
18853              domain2  host4:host5
18854 .endd
18855 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18856 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18857 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18858 or &[gethostbyname()]&, and the result of the lookup is the result of that
18859 call.
18860
18861 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18862 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18863 instead of TRY_AGAIN. That is why the default action is to try a DNS
18864 lookup first. Only if that gives a definite &"no such host"& is the local
18865 function called.
18866
18867
18868
18869 If no IP address for a host can be found, what happens is controlled by the
18870 &%host_find_failed%& option.
18871
18872 .vindex "&$host$&"
18873 When an address is routed to a local transport, IP addresses are not looked up.
18874 The host list is passed to the transport in the &$host$& variable.
18875
18876
18877
18878 .section "Manualroute examples" "SECID123"
18879 In some of the examples that follow, the presence of the &%remote_smtp%&
18880 transport, as defined in the default configuration file, is assumed:
18881
18882 .ilist
18883 .cindex "smart host" "example router"
18884 The &(manualroute)& router can be used to forward all external mail to a
18885 &'smart host'&. If you have set up, in the main part of the configuration, a
18886 named domain list that contains your local domains, for example:
18887 .code
18888 domainlist local_domains = my.domain.example
18889 .endd
18890 You can arrange for all other domains to be routed to a smart host by making
18891 your first router something like this:
18892 .code
18893 smart_route:
18894   driver = manualroute
18895   domains = !+local_domains
18896   transport = remote_smtp
18897   route_list = * smarthost.ref.example
18898 .endd
18899 This causes all non-local addresses to be sent to the single host
18900 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18901 they are tried in order
18902 (but you can use &%hosts_randomize%& to vary the order each time).
18903 Another way of configuring the same thing is this:
18904 .code
18905 smart_route:
18906   driver = manualroute
18907   transport = remote_smtp
18908   route_list = !+local_domains  smarthost.ref.example
18909 .endd
18910 There is no difference in behaviour between these two routers as they stand.
18911 However, they behave differently if &%no_more%& is added to them. In the first
18912 example, the router is skipped if the domain does not match the &%domains%&
18913 precondition; the following router is always tried. If the router runs, it
18914 always matches the domain and so can never decline. Therefore, &%no_more%&
18915 would have no effect. In the second case, the router is never skipped; it
18916 always runs. However, if it doesn't match the domain, it declines. In this case
18917 &%no_more%& would prevent subsequent routers from running.
18918
18919 .next
18920 .cindex "mail hub example"
18921 A &'mail hub'& is a host which receives mail for a number of domains via MX
18922 records in the DNS and delivers it via its own private routing mechanism. Often
18923 the final destinations are behind a firewall, with the mail hub being the one
18924 machine that can connect to machines both inside and outside the firewall. The
18925 &(manualroute)& router is usually used on a mail hub to route incoming messages
18926 to the correct hosts. For a small number of domains, the routing can be inline,
18927 using the &%route_list%& option, but for a larger number a file or database
18928 lookup is easier to manage.
18929
18930 If the domain names are in fact the names of the machines to which the mail is
18931 to be sent by the mail hub, the configuration can be quite simple. For
18932 example:
18933 .code
18934 hub_route:
18935   driver = manualroute
18936   transport = remote_smtp
18937   route_list = *.rhodes.tvs.example  $domain
18938 .endd
18939 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18940 whose names are the same as the mail domains. A similar approach can be taken
18941 if the host name can be obtained from the domain name by a string manipulation
18942 that the expansion facilities can handle. Otherwise, a lookup based on the
18943 domain can be used to find the host:
18944 .code
18945 through_firewall:
18946   driver = manualroute
18947   transport = remote_smtp
18948   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
18949 .endd
18950 The result of the lookup must be the name or IP address of the host (or
18951 hosts) to which the address is to be routed. If the lookup fails, the route
18952 data is empty, causing the router to decline. The address then passes to the
18953 next router.
18954
18955 .next
18956 .cindex "batched SMTP output example"
18957 .cindex "SMTP" "batched outgoing; example"
18958 You can use &(manualroute)& to deliver messages to pipes or files in batched
18959 SMTP format for onward transportation by some other means. This is one way of
18960 storing mail for a dial-up host when it is not connected. The route list entry
18961 can be as simple as a single domain name in a configuration like this:
18962 .code
18963 save_in_file:
18964   driver = manualroute
18965   transport = batchsmtp_appendfile
18966   route_list = saved.domain.example
18967 .endd
18968 though often a pattern is used to pick up more than one domain. If there are
18969 several domains or groups of domains with different transport requirements,
18970 different transports can be listed in the routing information:
18971 .code
18972 save_in_file:
18973   driver = manualroute
18974   route_list = \
18975     *.saved.domain1.example  $domain  batch_appendfile; \
18976     *.saved.domain2.example  \
18977       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
18978       batch_pipe
18979 .endd
18980 .vindex "&$domain$&"
18981 .vindex "&$host$&"
18982 The first of these just passes the domain in the &$host$& variable, which
18983 doesn't achieve much (since it is also in &$domain$&), but the second does a
18984 file lookup to find a value to pass, causing the router to decline to handle
18985 the address if the lookup fails.
18986
18987 .next
18988 .cindex "UUCP" "example of router for"
18989 Routing mail directly to UUCP software is a specific case of the use of
18990 &(manualroute)& in a gateway to another mail environment. This is an example of
18991 one way it can be done:
18992 .code
18993 # Transport
18994 uucp:
18995   driver = pipe
18996   user = nobody
18997   command = /usr/local/bin/uux -r - \
18998     ${substr_-5:$host}!rmail ${local_part}
18999   return_fail_output = true
19000
19001 # Router
19002 uucphost:
19003   transport = uucp
19004   driver = manualroute
19005   route_data = \
19006     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19007 .endd
19008 The file &_/usr/local/exim/uucphosts_& contains entries like
19009 .code
19010 darksite.ethereal.example:           darksite.UUCP
19011 .endd
19012 It can be set up more simply without adding and removing &".UUCP"& but this way
19013 makes clear the distinction between the domain name
19014 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19015 .endlist
19016 .ecindex IIDmanrou1
19017 .ecindex IIDmanrou2
19018
19019
19020
19021
19022
19023
19024
19025
19026 . ////////////////////////////////////////////////////////////////////////////
19027 . ////////////////////////////////////////////////////////////////////////////
19028
19029 .chapter "The queryprogram router" "CHAPdriverlast"
19030 .scindex IIDquerou1 "&(queryprogram)& router"
19031 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19032 .cindex "routing" "by external program"
19033 The &(queryprogram)& router routes an address by running an external command
19034 and acting on its output. This is an expensive way to route, and is intended
19035 mainly for use in lightly-loaded systems, or for performing experiments.
19036 However, if it is possible to use the precondition options (&%domains%&,
19037 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19038 be used in special cases, even on a busy host. There are the following private
19039 options:
19040 .cindex "options" "&(queryprogram)& router"
19041
19042 .option command queryprogram string&!! unset
19043 This option must be set. It specifies the command that is to be run. The
19044 command is split up into a command name and arguments, and then each is
19045 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19046 &<<CHAPpipetransport>>&).
19047
19048
19049 .option command_group queryprogram string unset
19050 .cindex "gid (group id)" "in &(queryprogram)& router"
19051 This option specifies a gid to be set when running the command while routing an
19052 address for deliver. It must be set if &%command_user%& specifies a numerical
19053 uid. If it begins with a digit, it is interpreted as the numerical value of the
19054 gid. Otherwise it is looked up using &[getgrnam()]&.
19055
19056
19057 .option command_user queryprogram string unset
19058 .cindex "uid (user id)" "for &(queryprogram)&"
19059 This option must be set. It specifies the uid which is set when running the
19060 command while routing an address for delivery. If the value begins with a digit,
19061 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19062 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19063 not set, a value for the gid also.
19064
19065 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19066 root, which it does during a normal delivery in a conventional configuration.
19067 However, when an address is being verified during message reception, Exim is
19068 usually running as the Exim user, not as root. If the &(queryprogram)& router
19069 is called from a non-root process, Exim cannot change uid or gid before running
19070 the command. In this circumstance the command runs under the current uid and
19071 gid.
19072
19073
19074 .option current_directory queryprogram string /
19075 This option specifies an absolute path which is made the current directory
19076 before running the command.
19077
19078
19079 .option timeout queryprogram time 1h
19080 If the command does not complete within the timeout period, its process group
19081 is killed and the message is frozen. A value of zero time specifies no
19082 timeout.
19083
19084
19085 The standard output of the command is connected to a pipe, which is read when
19086 the command terminates. It should consist of a single line of output,
19087 containing up to five fields, separated by white space. The maximum length of
19088 the line is 1023 characters. Longer lines are silently truncated. The first
19089 field is one of the following words (case-insensitive):
19090
19091 .ilist
19092 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19093 below).
19094 .next
19095 &'Decline'&: the router declines; pass the address to the next router, unless
19096 &%no_more%& is set.
19097 .next
19098 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19099 subsequent text on the line is an error message. If the router is run as part
19100 of address verification during an incoming SMTP message, the message is
19101 included in the SMTP response.
19102 .next
19103 &'Defer'&: routing could not be completed at this time; try again later. Any
19104 subsequent text on the line is an error message which is logged. It is not
19105 included in any SMTP response.
19106 .next
19107 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19108 .next
19109 &'Pass'&: pass the address to the next router (or the router specified by
19110 &%pass_router%&), overriding &%no_more%&.
19111 .next
19112 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19113 new addresses, which are routed independently, starting with the first router,
19114 or the router specified by &%redirect_router%&, if set.
19115 .endlist
19116
19117 When the first word is &'accept'&, the remainder of the line consists of a
19118 number of keyed data values, as follows (split into two lines here, to fit on
19119 the page):
19120 .code
19121 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19122 LOOKUP=byname|bydns DATA=<text>
19123 .endd
19124 The data items can be given in any order, and all are optional. If no transport
19125 is included, the transport specified by the generic &%transport%& option is
19126 used. The list of hosts and the lookup type are needed only if the transport is
19127 an &(smtp)& transport that does not itself supply a list of hosts.
19128
19129 The format of the list of hosts is the same as for the &(manualroute)& router.
19130 As well as host names and IP addresses with optional port numbers, as described
19131 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19132 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19133 (see section &<<SECThostshowused>>&).
19134
19135 If the lookup type is not specified, Exim behaves as follows when trying to
19136 find an IP address for each host: First, a DNS lookup is done. If this yields
19137 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19138 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19139 result of the lookup is the result of that call.
19140
19141 .vindex "&$address_data$&"
19142 If the DATA field is set, its value is placed in the &$address_data$&
19143 variable. For example, this return line
19144 .code
19145 accept hosts=x1.y.example:x2.y.example data="rule1"
19146 .endd
19147 routes the address to the default transport, passing a list of two hosts. When
19148 the transport runs, the string &"rule1"& is in &$address_data$&.
19149 .ecindex IIDquerou1
19150 .ecindex IIDquerou2
19151
19152
19153
19154
19155 . ////////////////////////////////////////////////////////////////////////////
19156 . ////////////////////////////////////////////////////////////////////////////
19157
19158 .chapter "The redirect router" "CHAPredirect"
19159 .scindex IIDredrou1 "&(redirect)& router"
19160 .scindex IIDredrou2 "routers" "&(redirect)&"
19161 .cindex "alias file" "in a &(redirect)& router"
19162 .cindex "address redirection" "&(redirect)& router"
19163 The &(redirect)& router handles several kinds of address redirection. Its most
19164 common uses are for resolving local part aliases from a central alias file
19165 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19166 files, but it has many other potential uses. The incoming address can be
19167 redirected in several different ways:
19168
19169 .ilist
19170 It can be replaced by one or more new addresses which are themselves routed
19171 independently.
19172 .next
19173 It can be routed to be delivered to a given file or directory.
19174 .next
19175 It can be routed to be delivered to a specified pipe command.
19176 .next
19177 It can cause an automatic reply to be generated.
19178 .next
19179 It can be forced to fail, optionally with a custom error message.
19180 .next
19181 It can be temporarily deferred, optionally with a custom message.
19182 .next
19183 It can be discarded.
19184 .endlist
19185
19186 The generic &%transport%& option must not be set for &(redirect)& routers.
19187 However, there are some private options which define transports for delivery to
19188 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19189 &%pipe_transport%& and &%reply_transport%& descriptions below.
19190
19191 .new
19192 If success DSNs have been requested
19193 .cindex "DSN" "success"
19194 .cindex "Delivery Status Notification" "success"
19195 redirection triggers one and the DSN options are not passed any further.
19196 .wen
19197
19198
19199
19200 .section "Redirection data" "SECID124"
19201 The router operates by interpreting a text string which it obtains either by
19202 expanding the contents of the &%data%& option, or by reading the entire
19203 contents of a file whose name is given in the &%file%& option. These two
19204 options are mutually exclusive. The first is commonly used for handling system
19205 aliases, in a configuration like this:
19206 .code
19207 system_aliases:
19208   driver = redirect
19209   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19210 .endd
19211 If the lookup fails, the expanded string in this example is empty. When the
19212 expansion of &%data%& results in an empty string, the router declines. A forced
19213 expansion failure also causes the router to decline; other expansion failures
19214 cause delivery to be deferred.
19215
19216 A configuration using &%file%& is commonly used for handling users'
19217 &_.forward_& files, like this:
19218 .code
19219 userforward:
19220   driver = redirect
19221   check_local_user
19222   file = $home/.forward
19223   no_verify
19224 .endd
19225 If the file does not exist, or causes no action to be taken (for example, it is
19226 empty or consists only of comments), the router declines. &*Warning*&: This
19227 is not the case when the file contains syntactically valid items that happen to
19228 yield empty addresses, for example, items containing only RFC 2822 address
19229 comments.
19230
19231
19232
19233 .section "Forward files and address verification" "SECID125"
19234 .cindex "address redirection" "while verifying"
19235 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19236 &_.forward_& files, as in the example above. There are two reasons for this:
19237
19238 .ilist
19239 When Exim is receiving an incoming SMTP message from a remote host, it is
19240 running under the Exim uid, not as root. Exim is unable to change uid to read
19241 the file as the user, and it may not be able to read it as the Exim user. So in
19242 practice the router may not be able to operate.
19243 .next
19244 However, even when the router can operate, the existence of a &_.forward_& file
19245 is unimportant when verifying an address. What should be checked is whether the
19246 local part is a valid user name or not. Cutting out the redirection processing
19247 saves some resources.
19248 .endlist
19249
19250
19251
19252
19253
19254
19255 .section "Interpreting redirection data" "SECID126"
19256 .cindex "Sieve filter" "specifying in redirection data"
19257 .cindex "filter" "specifying in redirection data"
19258 The contents of the data string, whether obtained from &%data%& or &%file%&,
19259 can be interpreted in two different ways:
19260
19261 .ilist
19262 If the &%allow_filter%& option is set true, and the data begins with the text
19263 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19264 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19265 respectively. Details of the syntax and semantics of filter files are described
19266 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19267 document is intended for use by end users.
19268 .next
19269 Otherwise, the data must be a comma-separated list of redirection items, as
19270 described in the next section.
19271 .endlist
19272
19273 When a message is redirected to a file (a &"mail folder"&), the file name given
19274 in a non-filter redirection list must always be an absolute path. A filter may
19275 generate a relative path &-- how this is handled depends on the transport's
19276 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19277 for the &(appendfile)& transport.
19278
19279
19280
19281 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19282 .cindex "address redirection" "non-filter list items"
19283 When the redirection data is not an Exim or Sieve filter, for example, if it
19284 comes from a conventional alias or forward file, it consists of a list of
19285 addresses, file names, pipe commands, or certain special items (see section
19286 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19287 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19288 depending on their default values. The items in the list are separated by
19289 commas or newlines.
19290 If a comma is required in an item, the entire item must be enclosed in double
19291 quotes.
19292
19293 Lines starting with a # character are comments, and are ignored, and # may
19294 also appear following a comma, in which case everything between the # and the
19295 next newline character is ignored.
19296
19297 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19298 double quotes are retained because some forms of mail address require their use
19299 (but never to enclose the entire address). In the following description,
19300 &"item"& refers to what remains after any surrounding double quotes have been
19301 removed.
19302
19303 .vindex "&$local_part$&"
19304 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19305 and the expansion contains a reference to &$local_part$&, you should make use
19306 of the &%quote_local_part%& expansion operator, in case the local part contains
19307 special characters. For example, to redirect all mail for the domain
19308 &'obsolete.example'&, retaining the existing local part, you could use this
19309 setting:
19310 .code
19311 data = ${quote_local_part:$local_part}@newdomain.example
19312 .endd
19313
19314
19315 .section "Redirecting to a local mailbox" "SECTredlocmai"
19316 .cindex "routing" "loops in"
19317 .cindex "loop" "while routing, avoidance of"
19318 .cindex "address redirection" "to local mailbox"
19319 A redirection item may safely be the same as the address currently under
19320 consideration. This does not cause a routing loop, because a router is
19321 automatically skipped if any ancestor of the address that is being processed
19322 is the same as the current address and was processed by the current router.
19323 Such an address is therefore passed to the following routers, so it is handled
19324 as if there were no redirection. When making this loop-avoidance test, the
19325 complete local part, including any prefix or suffix, is used.
19326
19327 .cindex "address redirection" "local part without domain"
19328 Specifying the same local part without a domain is a common usage in personal
19329 filter files when the user wants to have messages delivered to the local
19330 mailbox and also forwarded elsewhere. For example, the user whose login is
19331 &'cleo'& might have a &_.forward_& file containing this:
19332 .code
19333 cleo, cleopatra@egypt.example
19334 .endd
19335 .cindex "backslash in alias file"
19336 .cindex "alias file" "backslash in"
19337 For compatibility with other MTAs, such unqualified local parts may be
19338 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19339 it does make a difference if more than one domain is being handled
19340 synonymously.
19341
19342 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19343 2822 address that does not include a domain, the item is qualified using the
19344 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19345 addresses are qualified using the value in &%qualify_recipient%&, but you can
19346 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19347
19348 Care must be taken if there are alias names for local users.
19349 Consider an MTA handling a single local domain where the system alias file
19350 contains:
19351 .code
19352 Sam.Reman: spqr
19353 .endd
19354 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19355 messages in the local mailbox, and also forward copies elsewhere. He creates
19356 this forward file:
19357 .code
19358 Sam.Reman, spqr@reme.elsewhere.example
19359 .endd
19360 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19361 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19362 second time round, because it has previously routed it,
19363 and the following routers presumably cannot handle the alias. The forward file
19364 should really contain
19365 .code
19366 spqr, spqr@reme.elsewhere.example
19367 .endd
19368 but because this is such a common error, the &%check_ancestor%& option (see
19369 below) exists to provide a way to get round it. This is normally set on a
19370 &(redirect)& router that is handling users' &_.forward_& files.
19371
19372
19373
19374 .section "Special items in redirection lists" "SECTspecitredli"
19375 In addition to addresses, the following types of item may appear in redirection
19376 lists (that is, in non-filter redirection data):
19377
19378 .ilist
19379 .cindex "pipe" "in redirection list"
19380 .cindex "address redirection" "to pipe"
19381 An item is treated as a pipe command if it begins with &"|"& and does not parse
19382 as a valid RFC 2822 address that includes a domain. A transport for running the
19383 command must be specified by the &%pipe_transport%& option.
19384 Normally, either the router or the transport specifies a user and a group under
19385 which to run the delivery. The default is to use the Exim user and group.
19386
19387 Single or double quotes can be used for enclosing the individual arguments of
19388 the pipe command; no interpretation of escapes is done for single quotes. If
19389 the command contains a comma character, it is necessary to put the whole item
19390 in double quotes, for example:
19391 .code
19392 "|/some/command ready,steady,go"
19393 .endd
19394 since items in redirection lists are terminated by commas. Do not, however,
19395 quote just the command. An item such as
19396 .code
19397 |"/some/command ready,steady,go"
19398 .endd
19399 is interpreted as a pipe with a rather strange command name, and no arguments.
19400
19401 Note that the above example assumes that the text comes from a lookup source
19402 of some sort, so that the quotes are part of the data.  If composing a
19403 redirect router with a &%data%& option directly specifying this command, the
19404 quotes will be used by the configuration parser to define the extent of one
19405 string, but will not be passed down into the redirect router itself.  There
19406 are two main approaches to get around this: escape quotes to be part of the
19407 data itself, or avoid using this mechanism and instead create a custom
19408 transport with the &%command%& option set and reference that transport from
19409 an &%accept%& router.
19410
19411 .next
19412 .cindex "file" "in redirection list"
19413 .cindex "address redirection" "to file"
19414 An item is interpreted as a path name if it begins with &"/"& and does not
19415 parse as a valid RFC 2822 address that includes a domain. For example,
19416 .code
19417 /home/world/minbari
19418 .endd
19419 is treated as a file name, but
19420 .code
19421 /s=molari/o=babylon/@x400gate.way
19422 .endd
19423 is treated as an address. For a file name, a transport must be specified using
19424 the &%file_transport%& option. However, if the generated path name ends with a
19425 forward slash character, it is interpreted as a directory name rather than a
19426 file name, and &%directory_transport%& is used instead.
19427
19428 Normally, either the router or the transport specifies a user and a group under
19429 which to run the delivery. The default is to use the Exim user and group.
19430
19431 .cindex "&_/dev/null_&"
19432 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19433 bypassed at a high level, and the log entry shows &"**bypassed**"&
19434 instead of a transport name. In this case the user and group are not used.
19435
19436 .next
19437 .cindex "included address list"
19438 .cindex "address redirection" "included external list"
19439 If an item is of the form
19440 .code
19441 :include:<path name>
19442 .endd
19443 a list of further items is taken from the given file and included at that
19444 point. &*Note*&: Such a file can not be a filter file; it is just an
19445 out-of-line addition to the list. The items in the included list are separated
19446 by commas or newlines and are not subject to expansion. If this is the first
19447 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19448 the alias name. This example is incorrect:
19449 .code
19450 list1    :include:/opt/lists/list1
19451 .endd
19452 It must be given as
19453 .code
19454 list1:   :include:/opt/lists/list1
19455 .endd
19456 .next
19457 .cindex "address redirection" "to black hole"
19458 Sometimes you want to throw away mail to a particular local part. Making the
19459 &%data%& option expand to an empty string does not work, because that causes
19460 the router to decline. Instead, the alias item
19461 .cindex "black hole"
19462 .cindex "abandoning mail"
19463 &':blackhole:'& can be used. It does what its name implies. No delivery is
19464 done, and no error message is generated. This has the same effect as specifing
19465 &_/dev/null_& as a destination, but it can be independently disabled.
19466
19467 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19468 delivery is done for the original local part, even if other redirection items
19469 are present. If you are generating a multi-item list (for example, by reading a
19470 database) and need the ability to provide a no-op item, you must use
19471 &_/dev/null_&.
19472
19473 .next
19474 .cindex "delivery" "forcing failure"
19475 .cindex "delivery" "forcing deferral"
19476 .cindex "failing delivery" "forcing"
19477 .cindex "deferred delivery, forcing"
19478 .cindex "customizing" "failure message"
19479 An attempt to deliver a particular address can be deferred or forced to fail by
19480 redirection items of the form
19481 .code
19482 :defer:
19483 :fail:
19484 .endd
19485 respectively. When a redirection list contains such an item, it applies
19486 to the entire redirection; any other items in the list are ignored. Any
19487 text following &':fail:'& or &':defer:'& is placed in the error text
19488 associated with the failure. For example, an alias file might contain:
19489 .code
19490 X.Employee:  :fail: Gone away, no forwarding address
19491 .endd
19492 In the case of an address that is being verified from an ACL or as the subject
19493 of a
19494 .cindex "VRFY" "error text, display of"
19495 VRFY command, the text is included in the SMTP error response by
19496 default.
19497 .cindex "EXPN" "error text, display of"
19498 The text is not included in the response to an EXPN command. In non-SMTP cases
19499 the text is included in the error message that Exim generates.
19500
19501 .cindex "SMTP" "error codes"
19502 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19503 &':fail:'&. However, if the message starts with three digits followed by a
19504 space, optionally followed by an extended code of the form &'n.n.n'&, also
19505 followed by a space, and the very first digit is the same as the default error
19506 code, the code from the message is used instead. If the very first digit is
19507 incorrect, a panic error is logged, and the default code is used. You can
19508 suppress the use of the supplied code in a redirect router by setting the
19509 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19510 ignored.
19511
19512 .vindex "&$acl_verify_message$&"
19513 In an ACL, an explicitly provided message overrides the default, but the
19514 default message is available in the variable &$acl_verify_message$& and can
19515 therefore be included in a custom message if this is desired.
19516
19517 Normally the error text is the rest of the redirection list &-- a comma does
19518 not terminate it &-- but a newline does act as a terminator. Newlines are not
19519 normally present in alias expansions. In &(lsearch)& lookups they are removed
19520 as part of the continuation process, but they may exist in other kinds of
19521 lookup and in &':include:'& files.
19522
19523 During routing for message delivery (as opposed to verification), a redirection
19524 containing &':fail:'& causes an immediate failure of the incoming address,
19525 whereas &':defer:'& causes the message to remain on the queue so that a
19526 subsequent delivery attempt can happen at a later time. If an address is
19527 deferred for too long, it will ultimately fail, because the normal retry
19528 rules still apply.
19529
19530 .next
19531 .cindex "alias file" "exception to default"
19532 Sometimes it is useful to use a single-key search type with a default (see
19533 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19534 for exceptions to the default. These can be handled by aliasing them to
19535 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19536 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19537 results in an empty redirection list has the same effect.
19538 .endlist
19539
19540
19541 .section "Duplicate addresses" "SECTdupaddr"
19542 .cindex "duplicate addresses"
19543 .cindex "address duplicate, discarding"
19544 .cindex "pipe" "duplicated"
19545 Exim removes duplicate addresses from the list to which it is delivering, so as
19546 to deliver just one copy to each address. This does not apply to deliveries
19547 routed to pipes by different immediate parent addresses, but an indirect
19548 aliasing scheme of the type
19549 .code
19550 pipe:       |/some/command $local_part
19551 localpart1: pipe
19552 localpart2: pipe
19553 .endd
19554 does not work with a message that is addressed to both local parts, because
19555 when the second is aliased to the intermediate local part &"pipe"& it gets
19556 discarded as being the same as a previously handled address. However, a scheme
19557 such as
19558 .code
19559 localpart1: |/some/command $local_part
19560 localpart2: |/some/command $local_part
19561 .endd
19562 does result in two different pipe deliveries, because the immediate parents of
19563 the pipes are distinct.
19564
19565
19566
19567 .section "Repeated redirection expansion" "SECID128"
19568 .cindex "repeated redirection expansion"
19569 .cindex "address redirection" "repeated for each delivery attempt"
19570 When a message cannot be delivered to all of its recipients immediately,
19571 leading to two or more delivery attempts, redirection expansion is carried out
19572 afresh each time for those addresses whose children were not all previously
19573 delivered. If redirection is being used as a mailing list, this can lead to new
19574 members of the list receiving copies of old messages. The &%one_time%& option
19575 can be used to avoid this.
19576
19577
19578 .section "Errors in redirection lists" "SECID129"
19579 .cindex "address redirection" "errors"
19580 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19581 error is skipped, and an entry is written to the main log. This may be useful
19582 for mailing lists that are automatically managed. Otherwise, if an error is
19583 detected while generating the list of new addresses, the original address is
19584 deferred. See also &%syntax_errors_to%&.
19585
19586
19587
19588 .section "Private options for the redirect router" "SECID130"
19589
19590 .cindex "options" "&(redirect)& router"
19591 The private options for the &(redirect)& router are as follows:
19592
19593
19594 .option allow_defer redirect boolean false
19595 Setting this option allows the use of &':defer:'& in non-filter redirection
19596 data, or the &%defer%& command in an Exim filter file.
19597
19598
19599 .option allow_fail redirect boolean false
19600 .cindex "failing delivery" "from filter"
19601 If this option is true, the &':fail:'& item can be used in a redirection list,
19602 and the &%fail%& command may be used in an Exim filter file.
19603
19604
19605 .option allow_filter redirect boolean false
19606 .cindex "filter" "enabling use of"
19607 .cindex "Sieve filter" "enabling use of"
19608 Setting this option allows Exim to interpret redirection data that starts with
19609 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19610 are some features of Exim filter files that some administrators may wish to
19611 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19612
19613 It is also possible to lock out Exim filters or Sieve filters while allowing
19614 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19615
19616
19617 The filter is run using the uid and gid set by the generic &%user%& and
19618 &%group%& options. These take their defaults from the password data if
19619 &%check_local_user%& is set, so in the normal case of users' personal filter
19620 files, the filter is run as the relevant user. When &%allow_filter%& is set
19621 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19622
19623
19624
19625 .option allow_freeze redirect boolean false
19626 .cindex "freezing messages" "allowing in filter"
19627 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19628 This command is more normally encountered in system filters, and is disabled by
19629 default for redirection filters because it isn't something you usually want to
19630 let ordinary users do.
19631
19632
19633
19634 .option check_ancestor redirect boolean false
19635 This option is concerned with handling generated addresses that are the same
19636 as some address in the list of redirection ancestors of the current address.
19637 Although it is turned off by default in the code, it is set in the default
19638 configuration file for handling users' &_.forward_& files. It is recommended
19639 for this use of the &(redirect)& router.
19640
19641 When &%check_ancestor%& is set, if a generated address (including the domain)
19642 is the same as any ancestor of the current address, it is replaced by a copy of
19643 the current address. This helps in the case where local part A is aliased to B,
19644 and B has a &_.forward_& file pointing back to A. For example, within a single
19645 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19646 &_&~jb/.forward_& contains:
19647 .code
19648 \Joe.Bloggs, <other item(s)>
19649 .endd
19650 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19651 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19652 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19653 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19654 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19655 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19656 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19657 original address. See also the &%repeat_use%& option below.
19658
19659
19660 .option check_group redirect boolean "see below"
19661 When the &%file%& option is used, the group owner of the file is checked only
19662 when this option is set. The permitted groups are those listed in the
19663 &%owngroups%& option, together with the user's default group if
19664 &%check_local_user%& is set. If the file has the wrong group, routing is
19665 deferred. The default setting for this option is true if &%check_local_user%&
19666 is set and the &%modemask%& option permits the group write bit, or if the
19667 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19668
19669
19670
19671 .option check_owner redirect boolean "see below"
19672 When the &%file%& option is used, the owner of the file is checked only when
19673 this option is set. If &%check_local_user%& is set, the local user is
19674 permitted; otherwise the owner must be one of those listed in the &%owners%&
19675 option. The default value for this option is true if &%check_local_user%& or
19676 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19677
19678
19679 .option data redirect string&!! unset
19680 This option is mutually exclusive with &%file%&. One or other of them must be
19681 set, but not both. The contents of &%data%& are expanded, and then used as the
19682 list of forwarding items, or as a set of filtering instructions. If the
19683 expansion is forced to fail, or the result is an empty string or a string that
19684 has no effect (consists entirely of comments), the router declines.
19685
19686 When filtering instructions are used, the string must begin with &"#Exim
19687 filter"&, and all comments in the string, including this initial one, must be
19688 terminated with newline characters. For example:
19689 .code
19690 data = #Exim filter\n\
19691        if $h_to: contains Exim then save $home/mail/exim endif
19692 .endd
19693 If you are reading the data from a database where newlines cannot be included,
19694 you can use the &${sg}$& expansion item to turn the escape string of your
19695 choice into a newline.
19696
19697
19698 .option directory_transport redirect string&!! unset
19699 A &(redirect)& router sets up a direct delivery to a directory when a path name
19700 ending with a slash is specified as a new &"address"&. The transport used is
19701 specified by this option, which, after expansion, must be the name of a
19702 configured transport. This should normally be an &(appendfile)& transport.
19703
19704
19705 .option file redirect string&!! unset
19706 This option specifies the name of a file that contains the redirection data. It
19707 is mutually exclusive with the &%data%& option. The string is expanded before
19708 use; if the expansion is forced to fail, the router declines. Other expansion
19709 failures cause delivery to be deferred. The result of a successful expansion
19710 must be an absolute path. The entire file is read and used as the redirection
19711 data. If the data is an empty string or a string that has no effect (consists
19712 entirely of comments), the router declines.
19713
19714 .cindex "NFS" "checking for file existence"
19715 If the attempt to open the file fails with a &"does not exist"& error, Exim
19716 runs a check on the containing directory,
19717 unless &%ignore_enotdir%& is true (see below).
19718 If the directory does not appear to exist, delivery is deferred. This can
19719 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19720 is a mount problem. If the containing directory does exist, but the file does
19721 not, the router declines.
19722
19723
19724 .option file_transport redirect string&!! unset
19725 .vindex "&$address_file$&"
19726 A &(redirect)& router sets up a direct delivery to a file when a path name not
19727 ending in a slash is specified as a new &"address"&. The transport used is
19728 specified by this option, which, after expansion, must be the name of a
19729 configured transport. This should normally be an &(appendfile)& transport. When
19730 it is running, the file name is in &$address_file$&.
19731
19732
19733 .option filter_prepend_home redirect boolean true
19734 When this option is true, if a &(save)& command in an Exim filter specifies a
19735 relative path, and &$home$& is defined, it is automatically prepended to the
19736 relative path. If this option is set false, this action does not happen. The
19737 relative path is then passed to the transport unmodified.
19738
19739
19740 .option forbid_blackhole redirect boolean false
19741 If this option is true, the &':blackhole:'& item may not appear in a
19742 redirection list.
19743
19744
19745 .option forbid_exim_filter redirect boolean false
19746 If this option is set true, only Sieve filters are permitted when
19747 &%allow_filter%& is true.
19748
19749
19750
19751
19752 .option forbid_file redirect boolean false
19753 .cindex "delivery" "to file; forbidding"
19754 .cindex "Sieve filter" "forbidding delivery to a file"
19755 .cindex "Sieve filter" "&""keep""& facility; disabling"
19756 If this option is true, this router may not generate a new address that
19757 specifies delivery to a local file or directory, either from a filter or from a
19758 conventional forward file. This option is forced to be true if &%one_time%& is
19759 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19760 locks out the Sieve's &"keep"& facility.
19761
19762
19763 .option forbid_filter_dlfunc redirect boolean false
19764 .cindex "filter" "locking out certain features"
19765 If this option is true, string expansions in Exim filters are not allowed to
19766 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19767 functions.
19768
19769 .option forbid_filter_existstest redirect boolean false
19770 .cindex "expansion" "statting a file"
19771 If this option is true, string expansions in Exim filters are not allowed to
19772 make use of the &%exists%& condition or the &%stat%& expansion item.
19773
19774 .option forbid_filter_logwrite redirect boolean false
19775 If this option is true, use of the logging facility in Exim filters is not
19776 permitted. Logging is in any case available only if the filter is being run
19777 under some unprivileged uid (which is normally the case for ordinary users'
19778 &_.forward_& files).
19779
19780
19781 .option forbid_filter_lookup redirect boolean false
19782 If this option is true, string expansions in Exim filter files are not allowed
19783 to make use of &%lookup%& items.
19784
19785
19786 .option forbid_filter_perl redirect boolean false
19787 This option has an effect only if Exim is built with embedded Perl support. If
19788 it is true, string expansions in Exim filter files are not allowed to make use
19789 of the embedded Perl support.
19790
19791
19792 .option forbid_filter_readfile redirect boolean false
19793 If this option is true, string expansions in Exim filter files are not allowed
19794 to make use of &%readfile%& items.
19795
19796
19797 .option forbid_filter_readsocket redirect boolean false
19798 If this option is true, string expansions in Exim filter files are not allowed
19799 to make use of &%readsocket%& items.
19800
19801
19802 .option forbid_filter_reply redirect boolean false
19803 If this option is true, this router may not generate an automatic reply
19804 message. Automatic replies can be generated only from Exim or Sieve filter
19805 files, not from traditional forward files. This option is forced to be true if
19806 &%one_time%& is set.
19807
19808
19809 .option forbid_filter_run redirect boolean false
19810 If this option is true, string expansions in Exim filter files are not allowed
19811 to make use of &%run%& items.
19812
19813
19814 .option forbid_include redirect boolean false
19815 If this option is true, items of the form
19816 .code
19817 :include:<path name>
19818 .endd
19819 are not permitted in non-filter redirection lists.
19820
19821
19822 .option forbid_pipe redirect boolean false
19823 .cindex "delivery" "to pipe; forbidding"
19824 If this option is true, this router may not generate a new address which
19825 specifies delivery to a pipe, either from an Exim filter or from a conventional
19826 forward file. This option is forced to be true if &%one_time%& is set.
19827
19828
19829 .option forbid_sieve_filter redirect boolean false
19830 If this option is set true, only Exim filters are permitted when
19831 &%allow_filter%& is true.
19832
19833
19834 .cindex "SMTP" "error codes"
19835 .option forbid_smtp_code redirect boolean false
19836 If this option is set true, any SMTP error codes that are present at the start
19837 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19838 the default codes (451 and 550, respectively) are always used.
19839
19840
19841
19842
19843 .option hide_child_in_errmsg redirect boolean false
19844 .cindex "bounce message" "redirection details; suppressing"
19845 If this option is true, it prevents Exim from quoting a child address if it
19846 generates a bounce or delay message for it. Instead it says &"an address
19847 generated from <&'the top level address'&>"&. Of course, this applies only to
19848 bounces generated locally. If a message is forwarded to another host, &'its'&
19849 bounce may well quote the generated address.
19850
19851
19852 .option ignore_eacces redirect boolean false
19853 .cindex "EACCES"
19854 If this option is set and an attempt to open a redirection file yields the
19855 EACCES error (permission denied), the &(redirect)& router behaves as if the
19856 file did not exist.
19857
19858
19859 .option ignore_enotdir redirect boolean false
19860 .cindex "ENOTDIR"
19861 If this option is set and an attempt to open a redirection file yields the
19862 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19863 router behaves as if the file did not exist.
19864
19865 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19866 router that has the &%file%& option set discovers that the file does not exist
19867 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19868 against unmounted NFS directories. If the parent can not be statted, delivery
19869 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19870 is set, because that option tells Exim to ignore &"something on the path is not
19871 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19872 that some operating systems give ENOENT where others give ENOTDIR.
19873
19874
19875
19876 .option include_directory redirect string unset
19877 If this option is set, the path names of any &':include:'& items in a
19878 redirection list must start with this directory.
19879
19880
19881 .option modemask redirect "octal integer" 022
19882 This specifies mode bits which must not be set for a file specified by the
19883 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19884
19885
19886 .option one_time redirect boolean false
19887 .cindex "one-time aliasing/forwarding expansion"
19888 .cindex "alias file" "one-time expansion"
19889 .cindex "forward file" "one-time expansion"
19890 .cindex "mailing lists" "one-time expansion"
19891 .cindex "address redirection" "one-time expansion"
19892 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19893 files each time it tries to deliver a message causes a problem when one or more
19894 of the generated addresses fails be delivered at the first attempt. The problem
19895 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19896 but of what happens when the redirection list changes during the time that the
19897 message is on Exim's queue. This is particularly true in the case of mailing
19898 lists, where new subscribers might receive copies of messages that were posted
19899 before they subscribed.
19900
19901 If &%one_time%& is set and any addresses generated by the router fail to
19902 deliver at the first attempt, the failing addresses are added to the message as
19903 &"top level"& addresses, and the parent address that generated them is marked
19904 &"delivered"&. Thus, redirection does not happen again at the next delivery
19905 attempt.
19906
19907 &*Warning 1*&: Any header line addition or removal that is specified by this
19908 router would be lost if delivery did not succeed at the first attempt. For this
19909 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19910 permitted when &%one_time%& is set.
19911
19912 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19913 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19914 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19915
19916 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19917 &%one_time%&.
19918
19919 The original top-level address is remembered with each of the generated
19920 addresses, and is output in any log messages. However, any intermediate parent
19921 addresses are not recorded. This makes a difference to the log only if
19922 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19923 typically be used for mailing lists, where there is normally just one level of
19924 expansion.
19925
19926
19927 .option owners redirect "string list" unset
19928 .cindex "ownership" "alias file"
19929 .cindex "ownership" "forward file"
19930 .cindex "alias file" "ownership"
19931 .cindex "forward file" "ownership"
19932 This specifies a list of permitted owners for the file specified by &%file%&.
19933 This list is in addition to the local user when &%check_local_user%& is set.
19934 See &%check_owner%& above.
19935
19936
19937 .option owngroups redirect "string list" unset
19938 This specifies a list of permitted groups for the file specified by &%file%&.
19939 The list is in addition to the local user's primary group when
19940 &%check_local_user%& is set. See &%check_group%& above.
19941
19942
19943 .option pipe_transport redirect string&!! unset
19944 .vindex "&$address_pipe$&"
19945 A &(redirect)& router sets up a direct delivery to a pipe when a string
19946 starting with a vertical bar character is specified as a new &"address"&. The
19947 transport used is specified by this option, which, after expansion, must be the
19948 name of a configured transport. This should normally be a &(pipe)& transport.
19949 When the transport is run, the pipe command is in &$address_pipe$&.
19950
19951
19952 .option qualify_domain redirect string&!! unset
19953 .vindex "&$qualify_recipient$&"
19954 If this option is set, and an unqualified address (one without a domain) is
19955 generated, and that address would normally be qualified by the global setting
19956 in &%qualify_recipient%&, it is instead qualified with the domain specified by
19957 expanding this string. If the expansion fails, the router declines. If you want
19958 to revert to the default, you can have the expansion generate
19959 &$qualify_recipient$&.
19960
19961 This option applies to all unqualified addresses generated by Exim filters,
19962 but for traditional &_.forward_& files, it applies only to addresses that are
19963 not preceded by a backslash. Sieve filters cannot generate unqualified
19964 addresses.
19965
19966 .option qualify_preserve_domain redirect boolean false
19967 .cindex "domain" "in redirection; preserving"
19968 .cindex "preserving domain in redirection"
19969 .cindex "address redirection" "domain; preserving"
19970 If this option is set, the router's local &%qualify_domain%& option must not be
19971 set (a configuration error occurs if it is). If an unqualified address (one
19972 without a domain) is generated, it is qualified with the domain of the parent
19973 address (the immediately preceding ancestor) instead of the global
19974 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
19975 this applies whether or not the address is preceded by a backslash.
19976
19977
19978 .option repeat_use redirect boolean true
19979 If this option is set false, the router is skipped for a child address that has
19980 any ancestor that was routed by this router. This test happens before any of
19981 the other preconditions are tested. Exim's default anti-looping rules skip
19982 only when the ancestor is the same as the current address. See also
19983 &%check_ancestor%& above and the generic &%redirect_router%& option.
19984
19985
19986 .option reply_transport redirect string&!! unset
19987 A &(redirect)& router sets up an automatic reply when a &%mail%& or
19988 &%vacation%& command is used in a filter file. The transport used is specified
19989 by this option, which, after expansion, must be the name of a configured
19990 transport. This should normally be an &(autoreply)& transport. Other transports
19991 are unlikely to do anything sensible or useful.
19992
19993
19994 .option rewrite redirect boolean true
19995 .cindex "address redirection" "disabling rewriting"
19996 If this option is set false, addresses generated by the router are not
19997 subject to address rewriting. Otherwise, they are treated like new addresses
19998 and are rewritten according to the global rewriting rules.
19999
20000
20001 .option sieve_subaddress redirect string&!! unset
20002 The value of this option is passed to a Sieve filter to specify the
20003 :subaddress part of an address.
20004
20005 .option sieve_useraddress redirect string&!! unset
20006 The value of this option is passed to a Sieve filter to specify the :user part
20007 of an address. However, if it is unset, the entire original local part
20008 (including any prefix or suffix) is used for :user.
20009
20010
20011 .option sieve_vacation_directory redirect string&!! unset
20012 .cindex "Sieve filter" "vacation directory"
20013 To enable the &"vacation"& extension for Sieve filters, you must set
20014 &%sieve_vacation_directory%& to the directory where vacation databases are held
20015 (do not put anything else in that directory), and ensure that the
20016 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20017 needs their own directory; Exim will create it if necessary.
20018
20019
20020
20021 .option skip_syntax_errors redirect boolean false
20022 .cindex "forward file" "broken"
20023 .cindex "address redirection" "broken files"
20024 .cindex "alias file" "broken"
20025 .cindex "broken alias or forward files"
20026 .cindex "ignoring faulty addresses"
20027 .cindex "skipping faulty addresses"
20028 .cindex "error" "skipping bad syntax"
20029 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20030 non-filter redirection data are skipped, and each failing address is logged. If
20031 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20032 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20033 are expanded and placed at the head of the error message generated by
20034 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20035 be the same address as the generic &%errors_to%& option. The
20036 &%skip_syntax_errors%& option is often used when handling mailing lists.
20037
20038 If all the addresses in a redirection list are skipped because of syntax
20039 errors, the router declines to handle the original address, and it is passed to
20040 the following routers.
20041
20042 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20043 error in the filter causes filtering to be abandoned without any action being
20044 taken. The incident is logged, and the router declines to handle the address,
20045 so it is passed to the following routers.
20046
20047 .cindex "Sieve filter" "syntax errors in"
20048 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20049 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20050 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20051
20052 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20053 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20054 option, used with an address that does not get redirected, can be used to
20055 notify users of these errors, by means of a router like this:
20056 .code
20057 userforward:
20058   driver = redirect
20059   allow_filter
20060   check_local_user
20061   file = $home/.forward
20062   file_transport = address_file
20063   pipe_transport = address_pipe
20064   reply_transport = address_reply
20065   no_verify
20066   skip_syntax_errors
20067   syntax_errors_to = real-$local_part@$domain
20068   syntax_errors_text = \
20069    This is an automatically generated message. An error has\n\
20070    been found in your .forward file. Details of the error are\n\
20071    reported below. While this error persists, you will receive\n\
20072    a copy of this message for every message that is addressed\n\
20073    to you. If your .forward file is a filter file, or if it is\n\
20074    a non-filter file containing no valid forwarding addresses,\n\
20075    a copy of each incoming message will be put in your normal\n\
20076    mailbox. If a non-filter file contains at least one valid\n\
20077    forwarding address, forwarding to the valid addresses will\n\
20078    happen, and those will be the only deliveries that occur.
20079 .endd
20080 You also need a router to ensure that local addresses that are prefixed by
20081 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20082 put this immediately before the &(userforward)& router:
20083 .code
20084 real_localuser:
20085   driver = accept
20086   check_local_user
20087   local_part_prefix = real-
20088   transport = local_delivery
20089 .endd
20090 For security, it would probably be a good idea to restrict the use of this
20091 router to locally-generated messages, using a condition such as this:
20092 .code
20093   condition = ${if match {$sender_host_address}\
20094                          {\N^(|127\.0\.0\.1)$\N}}
20095 .endd
20096
20097
20098 .option syntax_errors_text redirect string&!! unset
20099 See &%skip_syntax_errors%& above.
20100
20101
20102 .option syntax_errors_to redirect string unset
20103 See &%skip_syntax_errors%& above.
20104 .ecindex IIDredrou1
20105 .ecindex IIDredrou2
20106
20107
20108
20109
20110
20111
20112 . ////////////////////////////////////////////////////////////////////////////
20113 . ////////////////////////////////////////////////////////////////////////////
20114
20115 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20116          "Environment for local transports"
20117 .scindex IIDenvlotra1 "local transports" "environment for"
20118 .scindex IIDenvlotra2 "environment for local transports"
20119 .scindex IIDenvlotra3 "transport" "local; environment for"
20120 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20121 transport can be thought of as similar to a pipe.) Exim always runs transports
20122 in subprocesses, under specified uids and gids. Typical deliveries to local
20123 mailboxes run under the uid and gid of the local user.
20124
20125 Exim also sets a specific current directory while running the transport; for
20126 some transports a home directory setting is also relevant. The &(pipe)&
20127 transport is the only one that sets up environment variables; see section
20128 &<<SECTpipeenv>>& for details.
20129
20130 The values used for the uid, gid, and the directories may come from several
20131 different places. In many cases, the router that handles the address associates
20132 settings with that address as a result of its &%check_local_user%&, &%group%&,
20133 or &%user%& options. However, values may also be given in the transport's own
20134 configuration, and these override anything that comes from the router.
20135
20136
20137
20138 .section "Concurrent deliveries" "SECID131"
20139 .cindex "concurrent deliveries"
20140 .cindex "simultaneous deliveries"
20141 If two different messages for the same local recipient arrive more or less
20142 simultaneously, the two delivery processes are likely to run concurrently. When
20143 the &(appendfile)& transport is used to write to a file, Exim applies locking
20144 rules to stop concurrent processes from writing to the same file at the same
20145 time.
20146
20147 However, when you use a &(pipe)& transport, it is up to you to arrange any
20148 locking that is needed. Here is a silly example:
20149 .code
20150 my_transport:
20151   driver = pipe
20152   command = /bin/sh -c 'cat >>/some/file'
20153 .endd
20154 This is supposed to write the message at the end of the file. However, if two
20155 messages arrive at the same time, the file will be scrambled. You can use the
20156 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20157 file using the same algorithm that Exim itself uses.
20158
20159
20160
20161
20162 .section "Uids and gids" "SECTenvuidgid"
20163 .cindex "local transports" "uid and gid"
20164 .cindex "transport" "local; uid and gid"
20165 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20166 overrides any group that the router set in the address, even if &%user%& is not
20167 set for the transport. This makes it possible, for example, to run local mail
20168 delivery under the uid of the recipient (set by the router), but in a special
20169 group (set by the transport). For example:
20170 .code
20171 # Routers ...
20172 # User/group are set by check_local_user in this router
20173 local_users:
20174   driver = accept
20175   check_local_user
20176   transport = group_delivery
20177
20178 # Transports ...
20179 # This transport overrides the group
20180 group_delivery:
20181   driver = appendfile
20182   file = /var/spool/mail/$local_part
20183   group = mail
20184 .endd
20185 If &%user%& is set for a transport, its value overrides what is set in the
20186 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20187 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20188 set.
20189
20190 .oindex "&%initgroups%&"
20191 When the uid is taken from the transport's configuration, the &[initgroups()]&
20192 function is called for the groups associated with that uid if the
20193 &%initgroups%& option is set for the transport. When the uid is not specified
20194 by the transport, but is associated with the address by a router, the option
20195 for calling &[initgroups()]& is taken from the router configuration.
20196
20197 .cindex "&(pipe)& transport" "uid for"
20198 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20199 is set and &%user%& is not set, the uid of the process that called Exim to
20200 receive the message is used, and if &%group%& is not set, the corresponding
20201 original gid is also used.
20202
20203 This is the detailed preference order for obtaining a gid; the first of the
20204 following that is set is used:
20205
20206 .ilist
20207 A &%group%& setting of the transport;
20208 .next
20209 A &%group%& setting of the router;
20210 .next
20211 A gid associated with a user setting of the router, either as a result of
20212 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20213 .next
20214 The group associated with a non-numeric &%user%& setting of the transport;
20215 .next
20216 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20217 the uid is the creator's uid;
20218 .next
20219 The Exim gid if the Exim uid is being used as a default.
20220 .endlist
20221
20222 If, for example, the user is specified numerically on the router and there are
20223 no group settings, no gid is available. In this situation, an error occurs.
20224 This is different for the uid, for which there always is an ultimate default.
20225 The first of the following that is set is used:
20226
20227 .ilist
20228 A &%user%& setting of the transport;
20229 .next
20230 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20231 .next
20232 A &%user%& setting of the router;
20233 .next
20234 A &%check_local_user%& setting of the router;
20235 .next
20236 The Exim uid.
20237 .endlist
20238
20239 Of course, an error will still occur if the uid that is chosen is on the
20240 &%never_users%& list.
20241
20242
20243
20244
20245
20246 .section "Current and home directories" "SECID132"
20247 .cindex "current directory for local transport"
20248 .cindex "home directory" "for local transport"
20249 .cindex "transport" "local; home directory for"
20250 .cindex "transport" "local; current directory for"
20251 Routers may set current and home directories for local transports by means of
20252 the &%transport_current_directory%& and &%transport_home_directory%& options.
20253 However, if the transport's &%current_directory%& or &%home_directory%& options
20254 are set, they override the router's values. In detail, the home directory
20255 for a local transport is taken from the first of these values that is set:
20256
20257 .ilist
20258 The &%home_directory%& option on the transport;
20259 .next
20260 The &%transport_home_directory%& option on the router;
20261 .next
20262 The password data if &%check_local_user%& is set on the router;
20263 .next
20264 The &%router_home_directory%& option on the router.
20265 .endlist
20266
20267 The current directory is taken from the first of these values that is set:
20268
20269 .ilist
20270 The &%current_directory%& option on the transport;
20271 .next
20272 The &%transport_current_directory%& option on the router.
20273 .endlist
20274
20275
20276 If neither the router nor the transport sets a current directory, Exim uses the
20277 value of the home directory, if it is set. Otherwise it sets the current
20278 directory to &_/_& before running a local transport.
20279
20280
20281
20282 .section "Expansion variables derived from the address" "SECID133"
20283 .vindex "&$domain$&"
20284 .vindex "&$local_part$&"
20285 .vindex "&$original_domain$&"
20286 Normally a local delivery is handling a single address, and in that case the
20287 variables such as &$domain$& and &$local_part$& are set during local
20288 deliveries. However, in some circumstances more than one address may be handled
20289 at once (for example, while writing batch SMTP for onward transmission by some
20290 other means). In this case, the variables associated with the local part are
20291 never set, &$domain$& is set only if all the addresses have the same domain,
20292 and &$original_domain$& is never set.
20293 .ecindex IIDenvlotra1
20294 .ecindex IIDenvlotra2
20295 .ecindex IIDenvlotra3
20296
20297
20298
20299
20300
20301
20302
20303 . ////////////////////////////////////////////////////////////////////////////
20304 . ////////////////////////////////////////////////////////////////////////////
20305
20306 .chapter "Generic options for transports" "CHAPtransportgeneric"
20307 .scindex IIDgenoptra1 "generic options" "transport"
20308 .scindex IIDgenoptra2 "options" "generic; for transports"
20309 .scindex IIDgenoptra3 "transport" "generic options for"
20310 The following generic options apply to all transports:
20311
20312
20313 .option body_only transports boolean false
20314 .cindex "transport" "body only"
20315 .cindex "message" "transporting body only"
20316 .cindex "body of message" "transporting"
20317 If this option is set, the message's headers are not transported. It is
20318 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20319 or &(pipe)& transports, the settings of &%message_prefix%& and
20320 &%message_suffix%& should be checked, because this option does not
20321 automatically suppress them.
20322
20323
20324 .option current_directory transports string&!! unset
20325 .cindex "transport" "current directory for"
20326 This specifies the current directory that is to be set while running the
20327 transport, overriding any value that may have been set by the router.
20328 If the expansion fails for any reason, including forced failure, an error is
20329 logged, and delivery is deferred.
20330
20331
20332 .option disable_logging transports boolean false
20333 If this option is set true, nothing is logged for any
20334 deliveries by the transport or for any
20335 transport errors. You should not set this option unless you really, really know
20336 what you are doing.
20337
20338
20339 .option debug_print transports string&!! unset
20340 .cindex "testing" "variables in drivers"
20341 If this option is set and debugging is enabled (see the &%-d%& command line
20342 option), the string is expanded and included in the debugging output when the
20343 transport is run.
20344 If expansion of the string fails, the error message is written to the debugging
20345 output, and Exim carries on processing.
20346 This facility is provided to help with checking out the values of variables and
20347 so on when debugging driver configurations. For example, if a &%headers_add%&
20348 option is not working properly, &%debug_print%& could be used to output the
20349 variables it references. A newline is added to the text if it does not end with
20350 one.
20351 The variables &$transport_name$& and &$router_name$& contain the name of the
20352 transport and the router that called it.
20353
20354 .option delivery_date_add transports boolean false
20355 .cindex "&'Delivery-date:'& header line"
20356 If this option is true, a &'Delivery-date:'& header is added to the message.
20357 This gives the actual time the delivery was made. As this is not a standard
20358 header, Exim has a configuration option (&%delivery_date_remove%&) which
20359 requests its removal from incoming messages, so that delivered messages can
20360 safely be resent to other recipients.
20361
20362
20363 .option driver transports string unset
20364 This specifies which of the available transport drivers is to be used.
20365 There is no default, and this option must be set for every transport.
20366
20367
20368 .option envelope_to_add transports boolean false
20369 .cindex "&'Envelope-to:'& header line"
20370 If this option is true, an &'Envelope-to:'& header is added to the message.
20371 This gives the original address(es) in the incoming envelope that caused this
20372 delivery to happen. More than one address may be present if the transport is
20373 configured to handle several addresses at once, or if more than one original
20374 address was redirected to the same final address. As this is not a standard
20375 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20376 its removal from incoming messages, so that delivered messages can safely be
20377 resent to other recipients.
20378
20379
20380 .option group transports string&!! "Exim group"
20381 .cindex "transport" "group; specifying"
20382 This option specifies a gid for running the transport process, overriding any
20383 value that the router supplies, and also overriding any value associated with
20384 &%user%& (see below).
20385
20386
20387 .option headers_add transports list&!! unset
20388 .cindex "header lines" "adding in transport"
20389 .cindex "transport" "header lines; adding"
20390 This option specifies a list of text headers,
20391 .new
20392 newline-separated (by default, changeable in the usual way),
20393 .wen
20394 which are (separately) expanded and added to the header
20395 portion of a message as it is transported, as described in section
20396 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20397 routers. If the result of the expansion is an empty string, or if the expansion
20398 is forced to fail, no action is taken. Other expansion failures are treated as
20399 errors and cause the delivery to be deferred.
20400
20401 Unlike most options, &%headers_add%& can be specified multiple times
20402 for a transport; all listed headers are added.
20403
20404
20405 .option headers_only transports boolean false
20406 .cindex "transport" "header lines only"
20407 .cindex "message" "transporting headers only"
20408 .cindex "header lines" "transporting"
20409 If this option is set, the message's body is not transported. It is mutually
20410 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20411 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20412 checked, since this option does not automatically suppress them.
20413
20414
20415 .option headers_remove transports list&!! unset
20416 .cindex "header lines" "removing"
20417 .cindex "transport" "header lines; removing"
20418 This option specifies a list of header names,
20419 .new
20420 colon-separated (by default, changeable in the usual way);
20421 .wen
20422 these headers are omitted from the message as it is transported, as described
20423 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20424 routers.
20425 Each list item is separately expanded.
20426 If the result of the expansion is an empty string, or if the expansion
20427 is forced to fail, no action is taken. Other expansion failures are treated as
20428 errors and cause the delivery to be deferred.
20429
20430 Unlike most options, &%headers_remove%& can be specified multiple times
20431 for a router; all listed headers are removed.
20432
20433
20434
20435 .option headers_rewrite transports string unset
20436 .cindex "transport" "header lines; rewriting"
20437 .cindex "rewriting" "at transport time"
20438 This option allows addresses in header lines to be rewritten at transport time,
20439 that is, as the message is being copied to its destination. The contents of the
20440 option are a colon-separated list of rewriting rules. Each rule is in exactly
20441 the same form as one of the general rewriting rules that are applied when a
20442 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20443 example,
20444 .code
20445 headers_rewrite = a@b c@d f : \
20446                   x@y w@z
20447 .endd
20448 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20449 &'w@z'& in all address-bearing header lines. The rules are applied to the
20450 header lines just before they are written out at transport time, so they affect
20451 only those copies of the message that pass through the transport. However, only
20452 the message's original header lines, and any that were added by a system
20453 filter, are rewritten. If a router or transport adds header lines, they are not
20454 affected by this option. These rewriting rules are &'not'& applied to the
20455 envelope. You can change the return path using &%return_path%&, but you cannot
20456 change envelope recipients at this time.
20457
20458
20459 .option home_directory transports string&!! unset
20460 .cindex "transport" "home directory for"
20461 .vindex "&$home$&"
20462 This option specifies a home directory setting for a local transport,
20463 overriding any value that may be set by the router. The home directory is
20464 placed in &$home$& while expanding the transport's private options. It is also
20465 used as the current directory if no current directory is set by the
20466 &%current_directory%& option on the transport or the
20467 &%transport_current_directory%& option on the router. If the expansion fails
20468 for any reason, including forced failure, an error is logged, and delivery is
20469 deferred.
20470
20471
20472 .option initgroups transports boolean false
20473 .cindex "additional groups"
20474 .cindex "groups" "additional"
20475 .cindex "transport" "group; additional"
20476 If this option is true and the uid for the delivery process is provided by the
20477 transport, the &[initgroups()]& function is called when running the transport
20478 to ensure that any additional groups associated with the uid are set up.
20479
20480
20481 .option message_size_limit transports string&!! 0
20482 .cindex "limit" "message size per transport"
20483 .cindex "size" "of message, limit"
20484 .cindex "transport" "message size; limiting"
20485 This option controls the size of messages passed through the transport. It is
20486 expanded before use; the result of the expansion must be a sequence of decimal
20487 digits, optionally followed by K or M. If the expansion fails for any reason,
20488 including forced failure, or if the result is not of the required form,
20489 delivery is deferred. If the value is greater than zero and the size of a
20490 message exceeds this limit, the address is failed. If there is any chance that
20491 the resulting bounce message could be routed to the same transport, you should
20492 ensure that &%return_size_limit%& is less than the transport's
20493 &%message_size_limit%&, as otherwise the bounce message will fail to get
20494 delivered.
20495
20496
20497
20498 .option rcpt_include_affixes transports boolean false
20499 .cindex "prefix" "for local part, including in envelope"
20500 .cindex "suffix for local part" "including in envelope"
20501 .cindex "local part" "prefix"
20502 .cindex "local part" "suffix"
20503 When this option is false (the default), and an address that has had any
20504 affixes (prefixes or suffixes) removed from the local part is delivered by any
20505 form of SMTP or LMTP, the affixes are not included. For example, if a router
20506 that contains
20507 .code
20508 local_part_prefix = *-
20509 .endd
20510 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20511 is delivered with
20512 .code
20513 RCPT TO:<xyz@some.domain>
20514 .endd
20515 This is also the case when an ACL-time callout is being used to verify a
20516 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20517 whole local part is included in the RCPT command. This option applies to BSMTP
20518 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20519 &(lmtp)& and &(smtp)& transports.
20520
20521
20522 .option retry_use_local_part transports boolean "see below"
20523 .cindex "hints database" "retry keys"
20524 When a delivery suffers a temporary failure, a retry record is created
20525 in Exim's hints database. For remote deliveries, the key for the retry record
20526 is based on the name and/or IP address of the failing remote host. For local
20527 deliveries, the key is normally the entire address, including both the local
20528 part and the domain. This is suitable for most common cases of local delivery
20529 temporary failure &-- for example, exceeding a mailbox quota should delay only
20530 deliveries to that mailbox, not to the whole domain.
20531
20532 However, in some special cases you may want to treat a temporary local delivery
20533 as a failure associated with the domain, and not with a particular local part.
20534 (For example, if you are storing all mail for some domain in files.) You can do
20535 this by setting &%retry_use_local_part%& false.
20536
20537 For all the local transports, its default value is true. For remote transports,
20538 the default value is false for tidiness, but changing the value has no effect
20539 on a remote transport in the current implementation.
20540
20541
20542 .option return_path transports string&!! unset
20543 .cindex "envelope sender"
20544 .cindex "transport" "return path; changing"
20545 .cindex "return path" "changing in transport"
20546 If this option is set, the string is expanded at transport time and replaces
20547 the existing return path (envelope sender) value in the copy of the message
20548 that is being delivered. An empty return path is permitted. This feature is
20549 designed for remote deliveries, where the value of this option is used in the
20550 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20551 only effect is to change the address that is placed in the &'Return-path:'&
20552 header line, if one is added to the message (see the next option).
20553
20554 &*Note:*& A changed return path is not logged unless you add
20555 &%return_path_on_delivery%& to the log selector.
20556
20557 .vindex "&$return_path$&"
20558 The expansion can refer to the existing value via &$return_path$&. This is
20559 either the message's envelope sender, or an address set by the
20560 &%errors_to%& option on a router. If the expansion is forced to fail, no
20561 replacement occurs; if it fails for another reason, delivery is deferred. This
20562 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20563 section &<<SECTverp>>&.
20564
20565 &*Note*&: If a delivery error is detected locally, including the case when a
20566 remote server rejects a message at SMTP time, the bounce message is not sent to
20567 the value of this option. It is sent to the previously set errors address.
20568 This defaults to the incoming sender address, but can be changed by setting
20569 &%errors_to%& in a router.
20570
20571
20572
20573 .option return_path_add transports boolean false
20574 .cindex "&'Return-path:'& header line"
20575 If this option is true, a &'Return-path:'& header is added to the message.
20576 Although the return path is normally available in the prefix line of BSD
20577 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20578 have easy access to it.
20579
20580 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20581 the delivery SMTP server makes the final delivery"&. This implies that this
20582 header should not be present in incoming messages. Exim has a configuration
20583 option, &%return_path_remove%&, which requests removal of this header from
20584 incoming messages, so that delivered messages can safely be resent to other
20585 recipients.
20586
20587
20588 .option shadow_condition transports string&!! unset
20589 See &%shadow_transport%& below.
20590
20591
20592 .option shadow_transport transports string unset
20593 .cindex "shadow transport"
20594 .cindex "transport" "shadow"
20595 A local transport may set the &%shadow_transport%& option to the name of
20596 another local transport. Shadow remote transports are not supported.
20597
20598 Whenever a delivery to the main transport succeeds, and either
20599 &%shadow_condition%& is unset, or its expansion does not result in the empty
20600 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20601 passed to the shadow transport, with the same delivery address or addresses. If
20602 expansion fails, no action is taken except that non-forced expansion failures
20603 cause a log line to be written.
20604
20605 The result of the shadow transport is discarded and does not affect the
20606 subsequent processing of the message. Only a single level of shadowing is
20607 provided; the &%shadow_transport%& option is ignored on any transport when it
20608 is running as a shadow. Options concerned with output from pipes are also
20609 ignored. The log line for the successful delivery has an item added on the end,
20610 of the form
20611 .code
20612 ST=<shadow transport name>
20613 .endd
20614 If the shadow transport did not succeed, the error message is put in
20615 parentheses afterwards. Shadow transports can be used for a number of different
20616 purposes, including keeping more detailed log information than Exim normally
20617 provides, and implementing automatic acknowledgment policies based on message
20618 headers that some sites insist on.
20619
20620
20621 .option transport_filter transports string&!! unset
20622 .cindex "transport" "filter"
20623 .cindex "filter" "transport filter"
20624 This option sets up a filtering (in the Unix shell sense) process for messages
20625 at transport time. It should not be confused with mail filtering as set up by
20626 individual users or via a system filter.
20627
20628 When the message is about to be written out, the command specified by
20629 &%transport_filter%& is started up in a separate, parallel process, and
20630 the entire message, including the header lines, is passed to it on its standard
20631 input (this in fact is done from a third process, to avoid deadlock). The
20632 command must be specified as an absolute path.
20633
20634 The lines of the message that are written to the transport filter are
20635 terminated by newline (&"\n"&). The message is passed to the filter before any
20636 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20637 lines beginning with a dot, and also before any processing implied by the
20638 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20639 &(pipe)& transports.
20640
20641 The standard error for the filter process is set to the same destination as its
20642 standard output; this is read and written to the message's ultimate
20643 destination. The process that writes the message to the filter, the
20644 filter itself, and the original process that reads the result and delivers it
20645 are all run in parallel, like a shell pipeline.
20646
20647 The filter can perform any transformations it likes, but of course should take
20648 care not to break RFC 2822 syntax. Exim does not check the result, except to
20649 test for a final newline when SMTP is in use. All messages transmitted over
20650 SMTP must end with a newline, so Exim supplies one if it is missing.
20651
20652 .cindex "content scanning" "per user"
20653 A transport filter can be used to provide content-scanning on a per-user basis
20654 at delivery time if the only required effect of the scan is to modify the
20655 message. For example, a content scan could insert a new header line containing
20656 a spam score. This could be interpreted by a filter in the user's MUA. It is
20657 not possible to discard a message at this stage.
20658
20659 .cindex "SMTP" "SIZE"
20660 A problem might arise if the filter increases the size of a message that is
20661 being sent down an SMTP connection. If the receiving SMTP server has indicated
20662 support for the SIZE parameter, Exim will have sent the size of the message
20663 at the start of the SMTP session. If what is actually sent is substantially
20664 more, the server might reject the message. This can be worked round by setting
20665 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20666 additions to the message, or to disable the use of SIZE altogether.
20667
20668 .vindex "&$pipe_addresses$&"
20669 The value of the &%transport_filter%& option is the command string for starting
20670 the filter, which is run directly from Exim, not under a shell. The string is
20671 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20672 Exim breaks it up into arguments and then expands each argument separately (see
20673 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20674 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20675 of arguments, one for each address that applies to this delivery. (This isn't
20676 an ideal name for this feature here, but as it was already implemented for the
20677 &(pipe)& transport, it seemed sensible not to change it.)
20678
20679 .vindex "&$host$&"
20680 .vindex "&$host_address$&"
20681 The expansion variables &$host$& and &$host_address$& are available when the
20682 transport is a remote one. They contain the name and IP address of the host to
20683 which the message is being sent. For example:
20684 .code
20685 transport_filter = /some/directory/transport-filter.pl \
20686   $host $host_address $sender_address $pipe_addresses
20687 .endd
20688
20689 Two problems arise if you want to use more complicated expansion items to
20690 generate transport filter commands, both of which due to the fact that the
20691 command is split up &'before'& expansion.
20692 .ilist
20693 If an expansion item contains white space, you must quote it, so that it is all
20694 part of the same command item. If the entire option setting is one such
20695 expansion item, you have to take care what kind of quoting you use. For
20696 example:
20697 .code
20698 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20699 .endd
20700 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20701 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20702 stripped by Exim when it read the option's value. When the value is used, if
20703 the single quotes were missing, the line would be split into two items,
20704 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20705 Exim tried to expand the first one.
20706 .next
20707 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20708 expansion cannot generate multiple arguments, or a command name followed by
20709 arguments. Consider this example:
20710 .code
20711 transport_filter = ${lookup{$host}lsearch{/a/file}\
20712                     {$value}{/bin/cat}}
20713 .endd
20714 The result of the lookup is interpreted as the name of the command, even
20715 if it contains white space. The simplest way round this is to use a shell:
20716 .code
20717 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20718                                {$value}{/bin/cat}}
20719 .endd
20720 .endlist
20721
20722 The filter process is run under the same uid and gid as the normal delivery.
20723 For remote deliveries this is the Exim uid/gid by default. The command should
20724 normally yield a zero return code. Transport filters are not supposed to fail.
20725 A non-zero code is taken to mean that the transport filter encountered some
20726 serious problem. Delivery of the message is deferred; the message remains on
20727 the queue and is tried again later. It is not possible to cause a message to be
20728 bounced from a transport filter.
20729
20730 If a transport filter is set on an autoreply transport, the original message is
20731 passed through the filter as it is being copied into the newly generated
20732 message, which happens if the &%return_message%& option is set.
20733
20734
20735 .option transport_filter_timeout transports time 5m
20736 .cindex "transport" "filter, timeout"
20737 When Exim is reading the output of a transport filter, it applies a timeout
20738 that can be set by this option. Exceeding the timeout is normally treated as a
20739 temporary delivery failure. However, if a transport filter is used with a
20740 &(pipe)& transport, a timeout in the transport filter is treated in the same
20741 way as a timeout in the pipe command itself. By default, a timeout is a hard
20742 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20743 becomes a temporary error.
20744
20745
20746 .option user transports string&!! "Exim user"
20747 .cindex "uid (user id)" "local delivery"
20748 .cindex "transport" "user, specifying"
20749 This option specifies the user under whose uid the delivery process is to be
20750 run, overriding any uid that may have been set by the router. If the user is
20751 given as a name, the uid is looked up from the password data, and the
20752 associated group is taken as the value of the gid to be used if the &%group%&
20753 option is not set.
20754
20755 For deliveries that use local transports, a user and group are normally
20756 specified explicitly or implicitly (for example, as a result of
20757 &%check_local_user%&) by the router or transport.
20758
20759 .cindex "hints database" "access by remote transport"
20760 For remote transports, you should leave this option unset unless you really are
20761 sure you know what you are doing. When a remote transport is running, it needs
20762 to be able to access Exim's hints databases, because each host may have its own
20763 retry data.
20764 .ecindex IIDgenoptra1
20765 .ecindex IIDgenoptra2
20766 .ecindex IIDgenoptra3
20767
20768
20769
20770
20771
20772
20773 . ////////////////////////////////////////////////////////////////////////////
20774 . ////////////////////////////////////////////////////////////////////////////
20775
20776 .chapter "Address batching in local transports" "CHAPbatching" &&&
20777          "Address batching"
20778 .cindex "transport" "local; address batching in"
20779 The only remote transport (&(smtp)&) is normally configured to handle more than
20780 one address at a time, so that when several addresses are routed to the same
20781 remote host, just one copy of the message is sent. Local transports, however,
20782 normally handle one address at a time. That is, a separate instance of the
20783 transport is run for each address that is routed to the transport. A separate
20784 copy of the message is delivered each time.
20785
20786 .cindex "batched local delivery"
20787 .oindex "&%batch_max%&"
20788 .oindex "&%batch_id%&"
20789 In special cases, it may be desirable to handle several addresses at once in a
20790 local transport, for example:
20791
20792 .ilist
20793 In an &(appendfile)& transport, when storing messages in files for later
20794 delivery by some other means, a single copy of the message with multiple
20795 recipients saves space.
20796 .next
20797 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20798 a single copy saves time, and is the normal way LMTP is expected to work.
20799 .next
20800 In a &(pipe)& transport, when passing the message
20801 to a scanner program or
20802 to some other delivery mechanism such as UUCP, multiple recipients may be
20803 acceptable.
20804 .endlist
20805
20806 These three local transports all have the same options for controlling multiple
20807 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20808 repeating the information for each transport, these options are described here.
20809
20810 The &%batch_max%& option specifies the maximum number of addresses that can be
20811 delivered together in a single run of the transport. Its default value is one
20812 (no batching). When more than one address is routed to a transport that has a
20813 &%batch_max%& value greater than one, the addresses are delivered in a batch
20814 (that is, in a single run of the transport with multiple recipients), subject
20815 to certain conditions:
20816
20817 .ilist
20818 .vindex "&$local_part$&"
20819 If any of the transport's options contain a reference to &$local_part$&, no
20820 batching is possible.
20821 .next
20822 .vindex "&$domain$&"
20823 If any of the transport's options contain a reference to &$domain$&, only
20824 addresses with the same domain are batched.
20825 .next
20826 .cindex "customizing" "batching condition"
20827 If &%batch_id%& is set, it is expanded for each address, and only those
20828 addresses with the same expanded value are batched. This allows you to specify
20829 customized batching conditions. Failure of the expansion for any reason,
20830 including forced failure, disables batching, but it does not stop the delivery
20831 from taking place.
20832 .next
20833 Batched addresses must also have the same errors address (where to send
20834 delivery errors), the same header additions and removals, the same user and
20835 group for the transport, and if a host list is present, the first host must
20836 be the same.
20837 .endlist
20838
20839 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20840 both when the file or pipe command is specified in the transport, and when it
20841 is specified by a &(redirect)& router, but all the batched addresses must of
20842 course be routed to the same file or pipe command. These two transports have an
20843 option called &%use_bsmtp%&, which causes them to deliver the message in
20844 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20845 &%check_string%& and &%escape_string%& options are forced to the values
20846 .code
20847 check_string = "."
20848 escape_string = ".."
20849 .endd
20850 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20851 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20852 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20853
20854 .cindex "&'Envelope-to:'& header line"
20855 If the generic &%envelope_to_add%& option is set for a batching transport, the
20856 &'Envelope-to:'& header that is added to the message contains all the addresses
20857 that are being processed together. If you are using a batching &(appendfile)&
20858 transport without &%use_bsmtp%&, the only way to preserve the recipient
20859 addresses is to set the &%envelope_to_add%& option.
20860
20861 .cindex "&(pipe)& transport" "with multiple addresses"
20862 .vindex "&$pipe_addresses$&"
20863 If you are using a &(pipe)& transport without BSMTP, and setting the
20864 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20865 the command. This is not a true variable; it is a bit of magic that causes each
20866 of the recipient addresses to be inserted into the command as a separate
20867 argument. This provides a way of accessing all the addresses that are being
20868 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20869 are specified by a &(redirect)& router.
20870
20871
20872
20873
20874 . ////////////////////////////////////////////////////////////////////////////
20875 . ////////////////////////////////////////////////////////////////////////////
20876
20877 .chapter "The appendfile transport" "CHAPappendfile"
20878 .scindex IIDapptra1 "&(appendfile)& transport"
20879 .scindex IIDapptra2 "transports" "&(appendfile)&"
20880 .cindex "directory creation"
20881 .cindex "creating directories"
20882 The &(appendfile)& transport delivers a message by appending it to an existing
20883 file, or by creating an entirely new file in a specified directory. Single
20884 files to which messages are appended can be in the traditional Unix mailbox
20885 format, or optionally in the MBX format supported by the Pine MUA and
20886 University of Washington IMAP daemon, &'inter alia'&. When each message is
20887 being delivered as a separate file, &"maildir"& format can optionally be used
20888 to give added protection against failures that happen part-way through the
20889 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20890 supported. For all file formats, Exim attempts to create as many levels of
20891 directory as necessary, provided that &%create_directory%& is set.
20892
20893 The code for the optional formats is not included in the Exim binary by
20894 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20895 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20896 included.
20897
20898 .cindex "quota" "system"
20899 Exim recognizes system quota errors, and generates an appropriate message. Exim
20900 also supports its own quota control within the transport, for use when the
20901 system facility is unavailable or cannot be used for some reason.
20902
20903 If there is an error while appending to a file (for example, quota exceeded or
20904 partition filled), Exim attempts to reset the file's length and last
20905 modification time back to what they were before. If there is an error while
20906 creating an entirely new file, the new file is removed.
20907
20908 Before appending to a file, a number of security checks are made, and the
20909 file is locked. A detailed description is given below, after the list of
20910 private options.
20911
20912 The &(appendfile)& transport is most commonly used for local deliveries to
20913 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20914 putting messages into files for remote delivery by some means other than Exim.
20915 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20916 option).
20917
20918
20919
20920 .section "The file and directory options" "SECTfildiropt"
20921 The &%file%& option specifies a single file, to which the message is appended;
20922 the &%directory%& option specifies a directory, in which a new file containing
20923 the message is created. Only one of these two options can be set, and for
20924 normal deliveries to mailboxes, one of them &'must'& be set.
20925
20926 .vindex "&$address_file$&"
20927 .vindex "&$local_part$&"
20928 However, &(appendfile)& is also used for delivering messages to files or
20929 directories whose names (or parts of names) are obtained from alias,
20930 forwarding, or filtering operations (for example, a &%save%& command in a
20931 user's Exim filter). When such a transport is running, &$local_part$& contains
20932 the local part that was aliased or forwarded, and &$address_file$& contains the
20933 name (or partial name) of the file or directory generated by the redirection
20934 operation. There are two cases:
20935
20936 .ilist
20937 If neither &%file%& nor &%directory%& is set, the redirection operation
20938 must specify an absolute path (one that begins with &`/`&). This is the most
20939 common case when users with local accounts use filtering to sort mail into
20940 different folders. See for example, the &(address_file)& transport in the
20941 default configuration. If the path ends with a slash, it is assumed to be the
20942 name of a directory. A delivery to a directory can also be forced by setting
20943 &%maildir_format%& or &%mailstore_format%&.
20944 .next
20945 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
20946 used to determine the file or directory name for the delivery. Normally, the
20947 contents of &$address_file$& are used in some way in the string expansion.
20948 .endlist
20949
20950
20951 .cindex "Sieve filter" "configuring &(appendfile)&"
20952 .cindex "Sieve filter" "relative mailbox path handling"
20953 As an example of the second case, consider an environment where users do not
20954 have home directories. They may be permitted to use Exim filter commands of the
20955 form:
20956 .code
20957 save folder23
20958 .endd
20959 or Sieve filter commands of the form:
20960 .code
20961 require "fileinto";
20962 fileinto "folder23";
20963 .endd
20964 In this situation, the expansion of &%file%& or &%directory%& in the transport
20965 must transform the relative path into an appropriate absolute file name. In the
20966 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
20967 is used as a result of a &"keep"& action in the filter. This example shows one
20968 way of handling this requirement:
20969 .code
20970 file = ${if eq{$address_file}{inbox} \
20971             {/var/mail/$local_part} \
20972             {${if eq{${substr_0_1:$address_file}}{/} \
20973                   {$address_file} \
20974                   {$home/mail/$address_file} \
20975             }} \
20976        }
20977 .endd
20978 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
20979 location, absolute paths are used without change, and other folders are in the
20980 &_mail_& directory within the home directory.
20981
20982 &*Note 1*&: While processing an Exim filter, a relative path such as
20983 &_folder23_& is turned into an absolute path if a home directory is known to
20984 the router. In particular, this is the case if &%check_local_user%& is set. If
20985 you want to prevent this happening at routing time, you can set
20986 &%router_home_directory%& empty. This forces the router to pass the relative
20987 path to the transport.
20988
20989 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
20990 the &%file%& or &%directory%& option is still used if it is set.
20991
20992
20993
20994
20995 .section "Private options for appendfile" "SECID134"
20996 .cindex "options" "&(appendfile)& transport"
20997
20998
20999
21000 .option allow_fifo appendfile boolean false
21001 .cindex "fifo (named pipe)"
21002 .cindex "named pipe (fifo)"
21003 .cindex "pipe" "named (fifo)"
21004 Setting this option permits delivery to named pipes (FIFOs) as well as to
21005 regular files. If no process is reading the named pipe at delivery time, the
21006 delivery is deferred.
21007
21008
21009 .option allow_symlink appendfile boolean false
21010 .cindex "symbolic link" "to mailbox"
21011 .cindex "mailbox" "symbolic link"
21012 By default, &(appendfile)& will not deliver if the path name for the file is
21013 that of a symbolic link. Setting this option relaxes that constraint, but there
21014 are security issues involved in the use of symbolic links. Be sure you know
21015 what you are doing if you set this. Details of exactly what this option affects
21016 are included in the discussion which follows this list of options.
21017
21018
21019 .option batch_id appendfile string&!! unset
21020 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21021 However, batching is automatically disabled for &(appendfile)& deliveries that
21022 happen as a result of forwarding or aliasing or other redirection directly to a
21023 file.
21024
21025
21026 .option batch_max appendfile integer 1
21027 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21028
21029
21030 .option check_group appendfile boolean false
21031 When this option is set, the group owner of the file defined by the &%file%&
21032 option is checked to see that it is the same as the group under which the
21033 delivery process is running. The default setting is false because the default
21034 file mode is 0600, which means that the group is irrelevant.
21035
21036
21037 .option check_owner appendfile boolean true
21038 When this option is set, the owner of the file defined by the &%file%& option
21039 is checked to ensure that it is the same as the user under which the delivery
21040 process is running.
21041
21042
21043 .option check_string appendfile string "see below"
21044 .cindex "&""From""& line"
21045 As &(appendfile)& writes the message, the start of each line is tested for
21046 matching &%check_string%&, and if it does, the initial matching characters are
21047 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21048 a literal string, not a regular expression, and the case of any letters it
21049 contains is significant.
21050
21051 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21052 are forced to &"."& and &".."& respectively, and any settings in the
21053 configuration are ignored. Otherwise, they default to &"From&~"& and
21054 &">From&~"& when the &%file%& option is set, and unset when any of the
21055 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21056
21057 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21058 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21059 &"From&~"& indicates the start of a new message. All four options need changing
21060 if another format is used. For example, to deliver to mailboxes in MMDF format:
21061 .cindex "MMDF format mailbox"
21062 .cindex "mailbox" "MMDF format"
21063 .code
21064 check_string = "\1\1\1\1\n"
21065 escape_string = "\1\1\1\1 \n"
21066 message_prefix = "\1\1\1\1\n"
21067 message_suffix = "\1\1\1\1\n"
21068 .endd
21069 .option create_directory appendfile boolean true
21070 .cindex "directory creation"
21071 When this option is true, Exim attempts to create any missing superior
21072 directories for the file that it is about to write. A created directory's mode
21073 is given by the &%directory_mode%& option.
21074
21075 The group ownership of a newly created directory is highly dependent on the
21076 operating system (and possibly the file system) that is being used. For
21077 example, in Solaris, if the parent directory has the setgid bit set, its group
21078 is propagated to the child; if not, the currently set group is used. However,
21079 in FreeBSD, the parent's group is always used.
21080
21081
21082
21083 .option create_file appendfile string anywhere
21084 This option constrains the location of files and directories that are created
21085 by this transport. It applies to files defined by the &%file%& option and
21086 directories defined by the &%directory%& option. In the case of maildir
21087 delivery, it applies to the top level directory, not the maildir directories
21088 beneath.
21089
21090 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21091 &"belowhome"&. In the second and third cases, a home directory must have been
21092 set for the transport. This option is not useful when an explicit file name is
21093 given for normal mailbox deliveries. It is intended for the case when file
21094 names are generated from users' &_.forward_& files. These are usually handled
21095 by an &(appendfile)& transport called &%address_file%&. See also
21096 &%file_must_exist%&.
21097
21098
21099 .option directory appendfile string&!! unset
21100 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21101 or &%directory%& must be set, unless the delivery is the direct result of a
21102 redirection (see section &<<SECTfildiropt>>&).
21103
21104 When &%directory%& is set, the string is expanded, and the message is delivered
21105 into a new file or files in or below the given directory, instead of being
21106 appended to a single mailbox file. A number of different formats are provided
21107 (see &%maildir_format%& and &%mailstore_format%&), and see section
21108 &<<SECTopdir>>& for further details of this form of delivery.
21109
21110
21111 .option directory_file appendfile string&!! "see below"
21112 .cindex "base62"
21113 .vindex "&$inode$&"
21114 When &%directory%& is set, but neither &%maildir_format%& nor
21115 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21116 whose name is obtained by expanding this string. The default value is:
21117 .code
21118 q${base62:$tod_epoch}-$inode
21119 .endd
21120 This generates a unique name from the current time, in base 62 form, and the
21121 inode of the file. The variable &$inode$& is available only when expanding this
21122 option.
21123
21124
21125 .option directory_mode appendfile "octal integer" 0700
21126 If &(appendfile)& creates any directories as a result of the
21127 &%create_directory%& option, their mode is specified by this option.
21128
21129
21130 .option escape_string appendfile string "see description"
21131 See &%check_string%& above.
21132
21133
21134 .option file appendfile string&!! unset
21135 This option is mutually exclusive with the &%directory%& option, but one of
21136 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21137 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21138 specifies a single file, to which the message is appended. One or more of
21139 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21140 &%file%&.
21141
21142 .cindex "NFS" "lock file"
21143 .cindex "locking files"
21144 .cindex "lock files"
21145 If you are using more than one host to deliver over NFS into the same
21146 mailboxes, you should always use lock files.
21147
21148 The string value is expanded for each delivery, and must yield an absolute
21149 path. The most common settings of this option are variations on one of these
21150 examples:
21151 .code
21152 file = /var/spool/mail/$local_part
21153 file = /home/$local_part/inbox
21154 file = $home/inbox
21155 .endd
21156 .cindex "&""sticky""& bit"
21157 In the first example, all deliveries are done into the same directory. If Exim
21158 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21159 create a file in the directory, so the &"sticky"& bit must be turned on for
21160 deliveries to be possible, or alternatively the &%group%& option can be used to
21161 run the delivery under a group id which has write access to the directory.
21162
21163
21164
21165 .option file_format appendfile string unset
21166 .cindex "file" "mailbox; checking existing format"
21167 This option requests the transport to check the format of an existing file
21168 before adding to it. The check consists of matching a specific string at the
21169 start of the file. The value of the option consists of an even number of
21170 colon-separated strings. The first of each pair is the test string, and the
21171 second is the name of a transport. If the transport associated with a matched
21172 string is not the current transport, control is passed over to the other
21173 transport. For example, suppose the standard &(local_delivery)& transport has
21174 this added to it:
21175 .code
21176 file_format = "From       : local_delivery :\
21177                \1\1\1\1\n : local_mmdf_delivery"
21178 .endd
21179 Mailboxes that begin with &"From"& are still handled by this transport, but if
21180 a mailbox begins with four binary ones followed by a newline, control is passed
21181 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21182 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21183 is assumed to match the current transport. If the start of a mailbox doesn't
21184 match any string, or if the transport named for a given string is not defined,
21185 delivery is deferred.
21186
21187
21188 .option file_must_exist appendfile boolean false
21189 If this option is true, the file specified by the &%file%& option must exist.
21190 A temporary error occurs if it does not, causing delivery to be deferred.
21191 If this option is false, the file is created if it does not exist.
21192
21193
21194 .option lock_fcntl_timeout appendfile time 0s
21195 .cindex "timeout" "mailbox locking"
21196 .cindex "mailbox" "locking, blocking and non-blocking"
21197 .cindex "locking files"
21198 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21199 when locking an open mailbox file. If the call fails, the delivery process
21200 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21201 Non-blocking calls are used so that the file is not kept open during the wait
21202 for the lock; the reason for this is to make it as safe as possible for
21203 deliveries over NFS in the case when processes might be accessing an NFS
21204 mailbox without using a lock file. This should not be done, but
21205 misunderstandings and hence misconfigurations are not unknown.
21206
21207 On a busy system, however, the performance of a non-blocking lock approach is
21208 not as good as using a blocking lock with a timeout. In this case, the waiting
21209 is done inside the system call, and Exim's delivery process acquires the lock
21210 and can proceed as soon as the previous lock holder releases it.
21211
21212 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21213 timeout, are used. There may still be some retrying: the maximum number of
21214 retries is
21215 .code
21216 (lock_retries * lock_interval) / lock_fcntl_timeout
21217 .endd
21218 rounded up to the next whole number. In other words, the total time during
21219 which &(appendfile)& is trying to get a lock is roughly the same, unless
21220 &%lock_fcntl_timeout%& is set very large.
21221
21222 You should consider setting this option if you are getting a lot of delayed
21223 local deliveries because of errors of the form
21224 .code
21225 failed to lock mailbox /some/file (fcntl)
21226 .endd
21227
21228 .option lock_flock_timeout appendfile time 0s
21229 This timeout applies to file locking when using &[flock()]& (see
21230 &%use_flock%&); the timeout operates in a similar manner to
21231 &%lock_fcntl_timeout%&.
21232
21233
21234 .option lock_interval appendfile time 3s
21235 This specifies the time to wait between attempts to lock the file. See below
21236 for details of locking.
21237
21238
21239 .option lock_retries appendfile integer 10
21240 This specifies the maximum number of attempts to lock the file. A value of zero
21241 is treated as 1. See below for details of locking.
21242
21243
21244 .option lockfile_mode appendfile "octal integer" 0600
21245 This specifies the mode of the created lock file, when a lock file is being
21246 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21247
21248
21249 .option lockfile_timeout appendfile time 30m
21250 .cindex "timeout" "mailbox locking"
21251 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21252 exists and is older than this value, it is assumed to have been left behind by
21253 accident, and Exim attempts to remove it.
21254
21255
21256 .option mailbox_filecount appendfile string&!! unset
21257 .cindex "mailbox" "specifying size of"
21258 .cindex "size" "of mailbox"
21259 If this option is set, it is expanded, and the result is taken as the current
21260 number of files in the mailbox. It must be a decimal number, optionally
21261 followed by K or M. This provides a way of obtaining this information from an
21262 external source that maintains the data.
21263
21264
21265 .option mailbox_size appendfile string&!! unset
21266 .cindex "mailbox" "specifying size of"
21267 .cindex "size" "of mailbox"
21268 If this option is set, it is expanded, and the result is taken as the current
21269 size the mailbox. It must be a decimal number, optionally followed by K or M.
21270 This provides a way of obtaining this information from an external source that
21271 maintains the data. This is likely to be helpful for maildir deliveries where
21272 it is computationally expensive to compute the size of a mailbox.
21273
21274
21275
21276 .option maildir_format appendfile boolean false
21277 .cindex "maildir format" "specifying"
21278 If this option is set with the &%directory%& option, the delivery is into a new
21279 file, in the &"maildir"& format that is used by other mail software. When the
21280 transport is activated directly from a &(redirect)& router (for example, the
21281 &(address_file)& transport in the default configuration), setting
21282 &%maildir_format%& causes the path received from the router to be treated as a
21283 directory, whether or not it ends with &`/`&. This option is available only if
21284 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21285 &<<SECTmaildirdelivery>>& below for further details.
21286
21287
21288 .option maildir_quota_directory_regex appendfile string "See below"
21289 .cindex "maildir format" "quota; directories included in"
21290 .cindex "quota" "maildir; directories included in"
21291 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21292 a regular expression for specifying directories, relative to the quota
21293 directory (see &%quota_directory%&), that should be included in the quota
21294 calculation. The default value is:
21295 .code
21296 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21297 .endd
21298 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21299 (directories whose names begin with a dot). If you want to exclude the
21300 &_Trash_&
21301 folder from the count (as some sites do), you need to change this setting to
21302 .code
21303 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21304 .endd
21305 This uses a negative lookahead in the regular expression to exclude the
21306 directory whose name is &_.Trash_&. When a directory is excluded from quota
21307 calculations, quota processing is bypassed for any messages that are delivered
21308 directly into that directory.
21309
21310
21311 .option maildir_retries appendfile integer 10
21312 This option specifies the number of times to retry when writing a file in
21313 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21314
21315
21316 .option maildir_tag appendfile string&!! unset
21317 This option applies only to deliveries in maildir format, and is described in
21318 section &<<SECTmaildirdelivery>>& below.
21319
21320
21321 .option maildir_use_size_file appendfile&!! boolean false
21322 .cindex "maildir format" "&_maildirsize_& file"
21323 The result of string expansion for this option must be a valid boolean value.
21324 If it is true, it enables support for &_maildirsize_& files. Exim
21325 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21326 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21327 value is zero. See &%maildir_quota_directory_regex%& above and section
21328 &<<SECTmaildirdelivery>>& below for further details.
21329
21330 .option maildirfolder_create_regex appendfile string unset
21331 .cindex "maildir format" "&_maildirfolder_& file"
21332 .cindex "&_maildirfolder_&, creating"
21333 The value of this option is a regular expression. If it is unset, it has no
21334 effect. Otherwise, before a maildir delivery takes place, the pattern is
21335 matched against the name of the maildir directory, that is, the directory
21336 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21337 delivery. If there is a match, Exim checks for the existence of a file called
21338 &_maildirfolder_& in the directory, and creates it if it does not exist.
21339 See section &<<SECTmaildirdelivery>>& for more details.
21340
21341
21342 .option mailstore_format appendfile boolean false
21343 .cindex "mailstore format" "specifying"
21344 If this option is set with the &%directory%& option, the delivery is into two
21345 new files in  &"mailstore"& format. The option is available only if
21346 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21347 below for further details.
21348
21349
21350 .option mailstore_prefix appendfile string&!! unset
21351 This option applies only to deliveries in mailstore format, and is described in
21352 section &<<SECTopdir>>& below.
21353
21354
21355 .option mailstore_suffix appendfile string&!! unset
21356 This option applies only to deliveries in mailstore format, and is described in
21357 section &<<SECTopdir>>& below.
21358
21359
21360 .option mbx_format appendfile boolean false
21361 .cindex "locking files"
21362 .cindex "file" "locking"
21363 .cindex "file" "MBX format"
21364 .cindex "MBX format, specifying"
21365 This option is available only if Exim has been compiled with SUPPORT_MBX
21366 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21367 the message is appended to the mailbox file in MBX format instead of
21368 traditional Unix format. This format is supported by Pine4 and its associated
21369 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21370
21371 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21372 automatically changed by the use of &%mbx_format%&. They should normally be set
21373 empty when using MBX format, so this option almost always appears in this
21374 combination:
21375 .code
21376 mbx_format = true
21377 message_prefix =
21378 message_suffix =
21379 .endd
21380 If none of the locking options are mentioned in the configuration,
21381 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21382 is possible to specify the other kinds of locking with &%mbx_format%&, but
21383 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21384 interworks with &'c-client'&, providing for shared access to the mailbox. It
21385 should not be used if any program that does not use this form of locking is
21386 going to access the mailbox, nor should it be used if the mailbox file is NFS
21387 mounted, because it works only when the mailbox is accessed from a single host.
21388
21389 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21390 the standard version of &'c-client'&, because as long as it has a mailbox open
21391 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21392 append messages to it.
21393
21394
21395 .option message_prefix appendfile string&!! "see below"
21396 .cindex "&""From""& line"
21397 The string specified here is expanded and output at the start of every message.
21398 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21399 in which case it is:
21400 .code
21401 message_prefix = "From ${if def:return_path{$return_path}\
21402   {MAILER-DAEMON}} $tod_bsdinbox\n"
21403 .endd
21404 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21405 &`\n`& to &`\r\n`& in &%message_prefix%&.
21406
21407 .option message_suffix appendfile string&!! "see below"
21408 The string specified here is expanded and output at the end of every message.
21409 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21410 in which case it is a single newline character. The suffix can be suppressed by
21411 setting
21412 .code
21413 message_suffix =
21414 .endd
21415 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21416 &`\n`& to &`\r\n`& in &%message_suffix%&.
21417
21418 .option mode appendfile "octal integer" 0600
21419 If the output file is created, it is given this mode. If it already exists and
21420 has wider permissions, they are reduced to this mode. If it has narrower
21421 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21422 if the delivery is the result of a &%save%& command in a filter file specifying
21423 a particular mode, the mode of the output file is always forced to take that
21424 value, and this option is ignored.
21425
21426
21427 .option mode_fail_narrower appendfile boolean true
21428 This option applies in the case when an existing mailbox file has a narrower
21429 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21430 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21431 continues with the delivery attempt, using the existing mode of the file.
21432
21433
21434 .option notify_comsat appendfile boolean false
21435 If this option is true, the &'comsat'& daemon is notified after every
21436 successful delivery to a user mailbox. This is the daemon that notifies logged
21437 on users about incoming mail.
21438
21439
21440 .option quota appendfile string&!! unset
21441 .cindex "quota" "imposed by Exim"
21442 This option imposes a limit on the size of the file to which Exim is appending,
21443 or to the total space used in the directory tree when the &%directory%& option
21444 is set. In the latter case, computation of the space used is expensive, because
21445 all the files in the directory (and any sub-directories) have to be
21446 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21447 &%maildir_use_size_file%& for ways to avoid this in environments where users
21448 have no shell access to their mailboxes).
21449
21450 As there is no interlock against two simultaneous deliveries into a
21451 multi-file mailbox, it is possible for the quota to be overrun in this case.
21452 For single-file mailboxes, of course, an interlock is a necessity.
21453
21454 A file's size is taken as its &'used'& value. Because of blocking effects, this
21455 may be a lot less than the actual amount of disk space allocated to the file.
21456 If the sizes of a number of files are being added up, the rounding effect can
21457 become quite noticeable, especially on systems that have large block sizes.
21458 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21459 the obvious value which users understand most easily.
21460
21461 The value of the option is expanded, and must then be a numerical value
21462 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21463 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21464 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21465 be handled.
21466
21467 &*Note*&: A value of zero is interpreted as &"no quota"&.
21468
21469 The expansion happens while Exim is running as root, before it changes uid for
21470 the delivery. This means that files that are inaccessible to the end user can
21471 be used to hold quota values that are looked up in the expansion. When delivery
21472 fails because this quota is exceeded, the handling of the error is as for
21473 system quota failures.
21474
21475 By default, Exim's quota checking mimics system quotas, and restricts the
21476 mailbox to the specified maximum size, though the value is not accurate to the
21477 last byte, owing to separator lines and additional headers that may get added
21478 during message delivery. When a mailbox is nearly full, large messages may get
21479 refused even though small ones are accepted, because the size of the current
21480 message is added to the quota when the check is made. This behaviour can be
21481 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21482 for exceeding the quota does not include the current message. Thus, deliveries
21483 continue until the quota has been exceeded; thereafter, no further messages are
21484 delivered. See also &%quota_warn_threshold%&.
21485
21486
21487 .option quota_directory appendfile string&!! unset
21488 This option defines the directory to check for quota purposes when delivering
21489 into individual files. The default is the delivery directory, or, if a file
21490 called &_maildirfolder_& exists in a maildir directory, the parent of the
21491 delivery directory.
21492
21493
21494 .option quota_filecount appendfile string&!! 0
21495 This option applies when the &%directory%& option is set. It limits the total
21496 number of files in the directory (compare the inode limit in system quotas). It
21497 can only be used if &%quota%& is also set. The value is expanded; an expansion
21498 failure causes delivery to be deferred. A value of zero is interpreted as
21499 &"no quota"&.
21500
21501
21502 .option quota_is_inclusive appendfile boolean true
21503 See &%quota%& above.
21504
21505
21506 .option quota_size_regex appendfile string unset
21507 This option applies when one of the delivery modes that writes a separate file
21508 for each message is being used. When Exim wants to find the size of one of
21509 these files in order to test the quota, it first checks &%quota_size_regex%&.
21510 If this is set to a regular expression that matches the file name, and it
21511 captures one string, that string is interpreted as a representation of the
21512 file's size. The value of &%quota_size_regex%& is not expanded.
21513
21514 This feature is useful only when users have no shell access to their mailboxes
21515 &-- otherwise they could defeat the quota simply by renaming the files. This
21516 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21517 the file length to the file name. For example:
21518 .code
21519 maildir_tag = ,S=$message_size
21520 quota_size_regex = ,S=(\d+)
21521 .endd
21522 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21523 number of lines in the message.
21524
21525 The regular expression should not assume that the length is at the end of the
21526 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21527 sometimes add other information onto the ends of message file names.
21528
21529 Section &<<SECID136>>& contains further information.
21530
21531
21532 .option quota_warn_message appendfile string&!! "see below"
21533 See below for the use of this option. If it is not set when
21534 &%quota_warn_threshold%& is set, it defaults to
21535 .code
21536 quota_warn_message = "\
21537   To: $local_part@$domain\n\
21538   Subject: Your mailbox\n\n\
21539   This message is automatically created \
21540   by mail delivery software.\n\n\
21541   The size of your mailbox has exceeded \
21542   a warning threshold that is\n\
21543   set by the system administrator.\n"
21544 .endd
21545
21546
21547 .option quota_warn_threshold appendfile string&!! 0
21548 .cindex "quota" "warning threshold"
21549 .cindex "mailbox" "size warning"
21550 .cindex "size" "of mailbox"
21551 This option is expanded in the same way as &%quota%& (see above). If the
21552 resulting value is greater than zero, and delivery of the message causes the
21553 size of the file or total space in the directory tree to cross the given
21554 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21555 may be specified as a percentage of it by following the value with a percent
21556 sign. For example:
21557 .code
21558 quota = 10M
21559 quota_warn_threshold = 75%
21560 .endd
21561 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21562 percent sign is ignored.
21563
21564 The warning message itself is specified by the &%quota_warn_message%& option,
21565 and it must start with a &'To:'& header line containing the recipient(s) of the
21566 warning message. These do not necessarily have to include the recipient(s) of
21567 the original message. A &'Subject:'& line should also normally be supplied. You
21568 can include any other header lines that you want. If you do not include a
21569 &'From:'& line, the default is:
21570 .code
21571 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21572 .endd
21573 .oindex &%errors_reply_to%&
21574 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21575 option.
21576
21577 The &%quota%& option does not have to be set in order to use this option; they
21578 are independent of one another except when the threshold is specified as a
21579 percentage.
21580
21581
21582 .option use_bsmtp appendfile boolean false
21583 .cindex "envelope sender"
21584 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21585 format, with the envelope sender and recipient(s) included as SMTP commands. If
21586 you want to include a leading HELO command with such messages, you can do
21587 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21588 for details of batch SMTP.
21589
21590
21591 .option use_crlf appendfile boolean false
21592 .cindex "carriage return"
21593 .cindex "linefeed"
21594 This option causes lines to be terminated with the two-character CRLF sequence
21595 (carriage return, linefeed) instead of just a linefeed character. In the case
21596 of batched SMTP, the byte sequence written to the file is then an exact image
21597 of what would be sent down a real SMTP connection.
21598
21599 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21600 (which are used to supply the traditional &"From&~"& and blank line separators
21601 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21602 carriage return characters if these are needed. In cases where these options
21603 have non-empty defaults, the values end with a single linefeed, so they must be
21604 changed to end with &`\r\n`& if &%use_crlf%& is set.
21605
21606
21607 .option use_fcntl_lock appendfile boolean "see below"
21608 This option controls the use of the &[fcntl()]& function to lock a file for
21609 exclusive use when a message is being appended. It is set by default unless
21610 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21611 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21612 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21613
21614
21615 .option use_flock_lock appendfile boolean false
21616 This option is provided to support the use of &[flock()]& for file locking, for
21617 the few situations where it is needed. Most modern operating systems support
21618 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21619 each other. Exim uses &[fcntl()]& locking by default.
21620
21621 This option is required only if you are using an operating system where
21622 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21623 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21624 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21625
21626 .cindex "Solaris" "&[flock()]& support"
21627 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21628 have it (and some, I think, provide a not quite right version built on top of
21629 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21630 the ability to use it, and any attempt to do so will cause a configuration
21631 error.
21632
21633 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21634 is just being mapped onto &[fcntl()]& by the OS).
21635
21636
21637 .option use_lockfile appendfile boolean "see below"
21638 If this option is turned off, Exim does not attempt to create a lock file when
21639 appending to a mailbox file. In this situation, the only locking is by
21640 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21641 sure that every MUA that is ever going to look at your users' mailboxes uses
21642 &[fcntl()]& rather than a lock file, and even then only when you are not
21643 delivering over NFS from more than one host.
21644
21645 .cindex "NFS" "lock file"
21646 In order to append to an NFS file safely from more than one host, it is
21647 necessary to take out a lock &'before'& opening the file, and the lock file
21648 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21649 file corruption.
21650
21651 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21652 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21653 except when &%mbx_format%& is set.
21654
21655
21656 .option use_mbx_lock appendfile boolean "see below"
21657 This option is available only if Exim has been compiled with SUPPORT_MBX
21658 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21659 locking rules be used. It is set by default if &%mbx_format%& is set and none
21660 of the locking options are mentioned in the configuration. The locking rules
21661 are the same as are used by the &'c-client'& library that underlies Pine and
21662 the IMAP4 and POP daemons that come with it (see the discussion below). The
21663 rules allow for shared access to the mailbox. However, this kind of locking
21664 does not work when the mailbox is NFS mounted.
21665
21666 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21667 &%use_flock_lock%& to control what kind of locking is used in implementing the
21668 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21669 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21670
21671
21672
21673
21674 .section "Operational details for appending" "SECTopappend"
21675 .cindex "appending to a file"
21676 .cindex "file" "appending"
21677 Before appending to a file, the following preparations are made:
21678
21679 .ilist
21680 If the name of the file is &_/dev/null_&, no action is taken, and a success
21681 return is given.
21682
21683 .next
21684 .cindex "directory creation"
21685 If any directories on the file's path are missing, Exim creates them if the
21686 &%create_directory%& option is set. A created directory's mode is given by the
21687 &%directory_mode%& option.
21688
21689 .next
21690 If &%file_format%& is set, the format of an existing file is checked. If this
21691 indicates that a different transport should be used, control is passed to that
21692 transport.
21693
21694 .next
21695 .cindex "file" "locking"
21696 .cindex "locking files"
21697 .cindex "NFS" "lock file"
21698 If &%use_lockfile%& is set, a lock file is built in a way that will work
21699 reliably over NFS, as follows:
21700
21701 .olist
21702 Create a &"hitching post"& file whose name is that of the lock file with the
21703 current time, primary host name, and process id added, by opening for writing
21704 as a new file. If this fails with an access error, delivery is deferred.
21705 .next
21706 Close the hitching post file, and hard link it to the lock file name.
21707 .next
21708 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21709 Unlink the hitching post name.
21710 .next
21711 Otherwise, use &[stat()]& to get information about the hitching post file, and
21712 then unlink hitching post name. If the number of links is exactly two, creation
21713 of the lock file succeeded but something (for example, an NFS server crash and
21714 restart) caused this fact not to be communicated to the &[link()]& call.
21715 .next
21716 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21717 up to &%lock_retries%& times. However, since any program that writes to a
21718 mailbox should complete its task very quickly, it is reasonable to time out old
21719 lock files that are normally the result of user agent and system crashes. If an
21720 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21721 it before trying again.
21722 .endlist olist
21723
21724 .next
21725 A call is made to &[lstat()]& to discover whether the main file exists, and if
21726 so, what its characteristics are. If &[lstat()]& fails for any reason other
21727 than non-existence, delivery is deferred.
21728
21729 .next
21730 .cindex "symbolic link" "to mailbox"
21731 .cindex "mailbox" "symbolic link"
21732 If the file does exist and is a symbolic link, delivery is deferred, unless the
21733 &%allow_symlink%& option is set, in which case the ownership of the link is
21734 checked, and then &[stat()]& is called to find out about the real file, which
21735 is then subjected to the checks below. The check on the top-level link
21736 ownership prevents one user creating a link for another's mailbox in a sticky
21737 directory, though allowing symbolic links in this case is definitely not a good
21738 idea. If there is a chain of symbolic links, the intermediate ones are not
21739 checked.
21740
21741 .next
21742 If the file already exists but is not a regular file, or if the file's owner
21743 and group (if the group is being checked &-- see &%check_group%& above) are
21744 different from the user and group under which the delivery is running,
21745 delivery is deferred.
21746
21747 .next
21748 If the file's permissions are more generous than specified, they are reduced.
21749 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21750 is set false, in which case the delivery is tried using the existing
21751 permissions.
21752
21753 .next
21754 The file's inode number is saved, and the file is then opened for appending.
21755 If this fails because the file has vanished, &(appendfile)& behaves as if it
21756 hadn't existed (see below). For any other failures, delivery is deferred.
21757
21758 .next
21759 If the file is opened successfully, check that the inode number hasn't
21760 changed, that it is still a regular file, and that the owner and permissions
21761 have not changed. If anything is wrong, defer delivery and freeze the message.
21762
21763 .next
21764 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21765 option is set. Otherwise, check that the file is being created in a permitted
21766 directory if the &%create_file%& option is set (deferring on failure), and then
21767 open for writing as a new file, with the O_EXCL and O_CREAT options,
21768 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21769 set). In this case, which can happen if the link points to a non-existent file,
21770 the file is opened for writing using O_CREAT but not O_EXCL, because
21771 that prevents link following.
21772
21773 .next
21774 .cindex "loop" "while file testing"
21775 If opening fails because the file exists, obey the tests given above for
21776 existing files. However, to avoid looping in a situation where the file is
21777 being continuously created and destroyed, the exists/not-exists loop is broken
21778 after 10 repetitions, and the message is then frozen.
21779
21780 .next
21781 If opening fails with any other error, defer delivery.
21782
21783 .next
21784 .cindex "file" "locking"
21785 .cindex "locking files"
21786 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21787 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21788 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21789 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21790 file, and an exclusive lock on the file whose name is
21791 .code
21792 /tmp/.<device-number>.<inode-number>
21793 .endd
21794 using the device and inode numbers of the open mailbox file, in accordance with
21795 the MBX locking rules. This file is created with a mode that is specified by
21796 the &%lockfile_mode%& option.
21797
21798 If Exim fails to lock the file, there are two possible courses of action,
21799 depending on the value of the locking timeout. This is obtained from
21800 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21801
21802 If the timeout value is zero, the file is closed, Exim waits for
21803 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21804 to lock it again. This happens up to &%lock_retries%& times, after which the
21805 delivery is deferred.
21806
21807 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21808 &[flock()]& are used (with the given timeout), so there has already been some
21809 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21810 immediately. It retries up to
21811 .code
21812 (lock_retries * lock_interval) / <timeout>
21813 .endd
21814 times (rounded up).
21815 .endlist
21816
21817 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21818 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21819
21820
21821 .section "Operational details for delivery to a new file" "SECTopdir"
21822 .cindex "delivery" "to single file"
21823 .cindex "&""From""& line"
21824 When the &%directory%& option is set instead of &%file%&, each message is
21825 delivered into a newly-created file or set of files. When &(appendfile)& is
21826 activated directly from a &(redirect)& router, neither &%file%& nor
21827 &%directory%& is normally set, because the path for delivery is supplied by the
21828 router. (See for example, the &(address_file)& transport in the default
21829 configuration.) In this case, delivery is to a new file if either the path name
21830 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21831
21832 No locking is required while writing the message to a new file, so the various
21833 locking options of the transport are ignored. The &"From"& line that by default
21834 separates messages in a single file is not normally needed, nor is the escaping
21835 of message lines that start with &"From"&, and there is no need to ensure a
21836 newline at the end of each message. Consequently, the default values for
21837 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21838 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21839
21840 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21841 the files in the delivery directory by default. However, you can specify a
21842 different directory by setting &%quota_directory%&. Also, for maildir
21843 deliveries (see below) the &_maildirfolder_& convention is honoured.
21844
21845
21846 .cindex "maildir format"
21847 .cindex "mailstore format"
21848 There are three different ways in which delivery to individual files can be
21849 done, controlled by the settings of the &%maildir_format%& and
21850 &%mailstore_format%& options. Note that code to support maildir or mailstore
21851 formats is not included in the binary unless SUPPORT_MAILDIR or
21852 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21853
21854 .cindex "directory creation"
21855 In all three cases an attempt is made to create the directory and any necessary
21856 sub-directories if they do not exist, provided that the &%create_directory%&
21857 option is set (the default). The location of a created directory can be
21858 constrained by setting &%create_file%&. A created directory's mode is given by
21859 the &%directory_mode%& option. If creation fails, or if the
21860 &%create_directory%& option is not set when creation is required, delivery is
21861 deferred.
21862
21863
21864
21865 .section "Maildir delivery" "SECTmaildirdelivery"
21866 .cindex "maildir format" "description of"
21867 If the &%maildir_format%& option is true, Exim delivers each message by writing
21868 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21869 directory that is defined by the &%directory%& option (the &"delivery
21870 directory"&). If the delivery is successful, the file is renamed into the
21871 &_new_& subdirectory.
21872
21873 In the file name, <&'stime'&> is the current time of day in seconds, and
21874 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21875 Exim checks that the time-of-day clock has moved on by at least one microsecond
21876 before terminating the delivery process. This guarantees uniqueness for the
21877 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21878 opening it. If any response other than ENOENT (does not exist) is given,
21879 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21880
21881 Before Exim carries out a maildir delivery, it ensures that subdirectories
21882 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21883 do not exist, Exim tries to create them and any superior directories in their
21884 path, subject to the &%create_directory%& and &%create_file%& options. If the
21885 &%maildirfolder_create_regex%& option is set, and the regular expression it
21886 contains matches the delivery directory, Exim also ensures that a file called
21887 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21888 &_maildirfolder_& file cannot be created, delivery is deferred.
21889
21890 These features make it possible to use Exim to create all the necessary files
21891 and directories in a maildir mailbox, including subdirectories for maildir++
21892 folders. Consider this example:
21893 .code
21894 maildir_format = true
21895 directory = /var/mail/$local_part\
21896            ${if eq{$local_part_suffix}{}{}\
21897            {/.${substr_1:$local_part_suffix}}}
21898 maildirfolder_create_regex = /\.[^/]+$
21899 .endd
21900 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21901 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21902 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21903 not match this name, so Exim will not look for or create the file
21904 &_/var/mail/pimbo/maildirfolder_&, though it will create
21905 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21906
21907 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21908 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21909 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21910 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21911 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21912
21913 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21914 not inadvertently match the toplevel maildir directory, because a
21915 &_maildirfolder_& file at top level would completely break quota calculations.
21916
21917 .cindex "quota" "in maildir delivery"
21918 .cindex "maildir++"
21919 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21920 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21921 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21922 Exim assumes the directory is a maildir++ folder directory, which is one level
21923 down from the user's top level mailbox directory. This causes it to start at
21924 the parent directory instead of the current directory when calculating the
21925 amount of space used.
21926
21927 One problem with delivering into a multi-file mailbox is that it is
21928 computationally expensive to compute the size of the mailbox for quota
21929 checking. Various approaches have been taken to reduce the amount of work
21930 needed. The next two sections describe two of them. A third alternative is to
21931 use some external process for maintaining the size data, and use the expansion
21932 of the &%mailbox_size%& option as a way of importing it into Exim.
21933
21934
21935
21936
21937 .section "Using tags to record message sizes" "SECID135"
21938 If &%maildir_tag%& is set, the string is expanded for each delivery.
21939 When the maildir file is renamed into the &_new_& sub-directory, the
21940 tag is added to its name. However, if adding the tag takes the length of the
21941 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21942 the tag is dropped and the maildir file is created with no tag.
21943
21944
21945 .vindex "&$message_size$&"
21946 Tags can be used to encode the size of files in their names; see
21947 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
21948 happens after the message has been written. The value of the &$message_size$&
21949 variable is set to the number of bytes actually written. If the expansion is
21950 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
21951 be deferred. The expanded tag may contain any printing characters except &"/"&.
21952 Non-printing characters in the string are ignored; if the resulting string is
21953 empty, it is ignored. If it starts with an alphanumeric character, a leading
21954 colon is inserted; this default has not proven to be the path that popular
21955 maildir implementations have chosen (but changing it in Exim would break
21956 backwards compatibility).
21957
21958 For one common implementation, you might set:
21959 .code
21960 maildir_tag = ,S=${message_size}
21961 .endd
21962 but you should check the documentation of the other software to be sure.
21963
21964 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
21965 as this allows Exim to extract the size from your tag, instead of having to
21966 &[stat()]& each message file.
21967
21968
21969 .section "Using a maildirsize file" "SECID136"
21970 .cindex "quota" "in maildir delivery"
21971 .cindex "maildir format" "&_maildirsize_& file"
21972 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
21973 storing quota and message size information in a file called &_maildirsize_&
21974 within the toplevel maildir directory. If this file does not exist, Exim
21975 creates it, setting the quota from the &%quota%& option of the transport. If
21976 the maildir directory itself does not exist, it is created before any attempt
21977 to write a &_maildirsize_& file.
21978
21979 The &_maildirsize_& file is used to hold information about the sizes of
21980 messages in the maildir, thus speeding up quota calculations. The quota value
21981 in the file is just a cache; if the quota is changed in the transport, the new
21982 value overrides the cached value when the next message is delivered. The cache
21983 is maintained for the benefit of other programs that access the maildir and
21984 need to know the quota.
21985
21986 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
21987 file is maintained (with a zero quota setting), but no quota is imposed.
21988
21989 A regular expression is available for controlling which directories in the
21990 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
21991 See the description of the &%maildir_quota_directory_regex%& option above for
21992 details.
21993
21994
21995 .section "Mailstore delivery" "SECID137"
21996 .cindex "mailstore format" "description of"
21997 If the &%mailstore_format%& option is true, each message is written as two
21998 files in the given directory. A unique base name is constructed from the
21999 message id and the current delivery process, and the files that are written use
22000 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22001 contains the message's envelope, and the &_.msg_& file contains the message
22002 itself. The base name is placed in the variable &$mailstore_basename$&.
22003
22004 During delivery, the envelope is first written to a file with the suffix
22005 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22006 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22007 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22008 file before accessing either of them. An alternative approach is to wait for
22009 the absence of a &_.tmp_& file.
22010
22011 The envelope file starts with any text defined by the &%mailstore_prefix%&
22012 option, expanded and terminated by a newline if there isn't one. Then follows
22013 the sender address on one line, then all the recipient addresses, one per line.
22014 There can be more than one recipient only if the &%batch_max%& option is set
22015 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22016 appended to the file, followed by a newline if it does not end with one.
22017
22018 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22019 failure, it is ignored. Other expansion errors are treated as serious
22020 configuration errors, and delivery is deferred. The variable
22021 &$mailstore_basename$& is available for use during these expansions.
22022
22023
22024 .section "Non-special new file delivery" "SECID138"
22025 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22026 file is created directly in the named directory. For example, when delivering
22027 messages into files in batched SMTP format for later delivery to some host (see
22028 section &<<SECTbatchSMTP>>&), a setting such as
22029 .code
22030 directory = /var/bsmtp/$host
22031 .endd
22032 might be used. A message is written to a file with a temporary name, which is
22033 then renamed when the delivery is complete. The final name is obtained by
22034 expanding the contents of the &%directory_file%& option.
22035 .ecindex IIDapptra1
22036 .ecindex IIDapptra2
22037
22038
22039
22040
22041
22042
22043 . ////////////////////////////////////////////////////////////////////////////
22044 . ////////////////////////////////////////////////////////////////////////////
22045
22046 .chapter "The autoreply transport" "CHID8"
22047 .scindex IIDauttra1 "transports" "&(autoreply)&"
22048 .scindex IIDauttra2 "&(autoreply)& transport"
22049 The &(autoreply)& transport is not a true transport in that it does not cause
22050 the message to be transmitted. Instead, it generates a new mail message as an
22051 automatic reply to the incoming message. &'References:'& and
22052 &'Auto-Submitted:'& header lines are included. These are constructed according
22053 to the rules in RFCs 2822 and 3834, respectively.
22054
22055 If the router that passes the message to this transport does not have the
22056 &%unseen%& option set, the original message (for the current recipient) is not
22057 delivered anywhere. However, when the &%unseen%& option is set on the router
22058 that passes the message to this transport, routing of the address continues, so
22059 another router can set up a normal message delivery.
22060
22061
22062 The &(autoreply)& transport is usually run as the result of mail filtering, a
22063 &"vacation"& message being the standard example. However, it can also be run
22064 directly from a router like any other transport. To reduce the possibility of
22065 message cascades, messages created by the &(autoreply)& transport always have
22066 empty envelope sender addresses, like bounce messages.
22067
22068 The parameters of the message to be sent can be specified in the configuration
22069 by options described below. However, these are used only when the address
22070 passed to the transport does not contain its own reply information. When the
22071 transport is run as a consequence of a
22072 &%mail%&
22073 or &%vacation%& command in a filter file, the parameters of the message are
22074 supplied by the filter, and passed with the address. The transport's options
22075 that define the message are then ignored (so they are not usually set in this
22076 case). The message is specified entirely by the filter or by the transport; it
22077 is never built from a mixture of options. However, the &%file_optional%&,
22078 &%mode%&, and &%return_message%& options apply in all cases.
22079
22080 &(Autoreply)& is implemented as a local transport. When used as a result of a
22081 command in a user's filter file, &(autoreply)& normally runs under the uid and
22082 gid of the user, and with appropriate current and home directories (see chapter
22083 &<<CHAPenvironment>>&).
22084
22085 There is a subtle difference between routing a message to a &(pipe)& transport
22086 that generates some text to be returned to the sender, and routing it to an
22087 &(autoreply)& transport. This difference is noticeable only if more than one
22088 address from the same message is so handled. In the case of a pipe, the
22089 separate outputs from the different addresses are gathered up and returned to
22090 the sender in a single message, whereas if &(autoreply)& is used, a separate
22091 message is generated for each address that is passed to it.
22092
22093 Non-printing characters are not permitted in the header lines generated for the
22094 message that &(autoreply)& creates, with the exception of newlines that are
22095 immediately followed by white space. If any non-printing characters are found,
22096 the transport defers.
22097 Whether characters with the top bit set count as printing characters or not is
22098 controlled by the &%print_topbitchars%& global option.
22099
22100 If any of the generic options for manipulating headers (for example,
22101 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22102 of the original message that is included in the generated message when
22103 &%return_message%& is set. They do not apply to the generated message itself.
22104
22105 .vindex "&$sender_address$&"
22106 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22107 the message, indicating that there were no recipients, it does not treat this
22108 as an error. This means that autoreplies sent to &$sender_address$& when this
22109 is empty (because the incoming message is a bounce message) do not cause
22110 problems. They are just discarded.
22111
22112
22113
22114 .section "Private options for autoreply" "SECID139"
22115 .cindex "options" "&(autoreply)& transport"
22116
22117 .option bcc autoreply string&!! unset
22118 This specifies the addresses that are to receive &"blind carbon copies"& of the
22119 message when the message is specified by the transport.
22120
22121
22122 .option cc autoreply string&!! unset
22123 This specifies recipients of the message and the contents of the &'Cc:'& header
22124 when the message is specified by the transport.
22125
22126
22127 .option file autoreply string&!! unset
22128 The contents of the file are sent as the body of the message when the message
22129 is specified by the transport. If both &%file%& and &%text%& are set, the text
22130 string comes first.
22131
22132
22133 .option file_expand autoreply boolean false
22134 If this is set, the contents of the file named by the &%file%& option are
22135 subjected to string expansion as they are added to the message.
22136
22137
22138 .option file_optional autoreply boolean false
22139 If this option is true, no error is generated if the file named by the &%file%&
22140 option or passed with the address does not exist or cannot be read.
22141
22142
22143 .option from autoreply string&!! unset
22144 This specifies the contents of the &'From:'& header when the message is
22145 specified by the transport.
22146
22147
22148 .option headers autoreply string&!! unset
22149 This specifies additional RFC 2822 headers that are to be added to the message
22150 when the message is specified by the transport. Several can be given by using
22151 &"\n"& to separate them. There is no check on the format.
22152
22153
22154 .option log autoreply string&!! unset
22155 This option names a file in which a record of every message sent is logged when
22156 the message is specified by the transport.
22157
22158
22159 .option mode autoreply "octal integer" 0600
22160 If either the log file or the &"once"& file has to be created, this mode is
22161 used.
22162
22163
22164 .option never_mail autoreply "address list&!!" unset
22165 If any run of the transport creates a message with a recipient that matches any
22166 item in the list, that recipient is quietly discarded. If all recipients are
22167 discarded, no message is created. This applies both when the recipients are
22168 generated by a filter and when they are specified in the transport.
22169
22170
22171
22172 .option once autoreply string&!! unset
22173 This option names a file or DBM database in which a record of each &'To:'&
22174 recipient is kept when the message is specified by the transport. &*Note*&:
22175 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22176
22177 If &%once%& is unset, or is set to an empty string, the message is always sent.
22178 By default, if &%once%& is set to a non-empty file name, the message
22179 is not sent if a potential recipient is already listed in the database.
22180 However, if the &%once_repeat%& option specifies a time greater than zero, the
22181 message is sent if that much time has elapsed since a message was last sent to
22182 this recipient. A setting of zero time for &%once_repeat%& (the default)
22183 prevents a message from being sent a second time &-- in this case, zero means
22184 infinity.
22185
22186 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22187 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22188 greater than zero, it changes the way Exim implements the &%once%& option.
22189 Instead of using a DBM file to record every recipient it sends to, it uses a
22190 regular file, whose size will never get larger than the given value.
22191
22192 In the file, Exim keeps a linear list of recipient addresses and the times at
22193 which they were sent messages. If the file is full when a new address needs to
22194 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22195 means that a given recipient may receive multiple messages, but at
22196 unpredictable intervals that depend on the rate of turnover of addresses in the
22197 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22198
22199
22200 .option once_file_size autoreply integer 0
22201 See &%once%& above.
22202
22203
22204 .option once_repeat autoreply time&!! 0s
22205 See &%once%& above.
22206 After expansion, the value of this option must be a valid time value.
22207
22208
22209 .option reply_to autoreply string&!! unset
22210 This specifies the contents of the &'Reply-To:'& header when the message is
22211 specified by the transport.
22212
22213
22214 .option return_message autoreply boolean false
22215 If this is set, a copy of the original message is returned with the new
22216 message, subject to the maximum size set in the &%return_size_limit%& global
22217 configuration option.
22218
22219
22220 .option subject autoreply string&!! unset
22221 This specifies the contents of the &'Subject:'& header when the message is
22222 specified by the transport. It is tempting to quote the original subject in
22223 automatic responses. For example:
22224 .code
22225 subject = Re: $h_subject:
22226 .endd
22227 There is a danger in doing this, however. It may allow a third party to
22228 subscribe your users to an opt-in mailing list, provided that the list accepts
22229 bounce messages as subscription confirmations. Well-managed lists require a
22230 non-bounce message to confirm a subscription, so the danger is relatively
22231 small.
22232
22233
22234
22235 .option text autoreply string&!! unset
22236 This specifies a single string to be used as the body of the message when the
22237 message is specified by the transport. If both &%text%& and &%file%& are set,
22238 the text comes first.
22239
22240
22241 .option to autoreply string&!! unset
22242 This specifies recipients of the message and the contents of the &'To:'& header
22243 when the message is specified by the transport.
22244 .ecindex IIDauttra1
22245 .ecindex IIDauttra2
22246
22247
22248
22249
22250 . ////////////////////////////////////////////////////////////////////////////
22251 . ////////////////////////////////////////////////////////////////////////////
22252
22253 .chapter "The lmtp transport" "CHAPLMTP"
22254 .cindex "transports" "&(lmtp)&"
22255 .cindex "&(lmtp)& transport"
22256 .cindex "LMTP" "over a pipe"
22257 .cindex "LMTP" "over a socket"
22258 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22259 specified command
22260 or by interacting with a Unix domain socket.
22261 This transport is something of a cross between the &(pipe)& and &(smtp)&
22262 transports. Exim also has support for using LMTP over TCP/IP; this is
22263 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22264 to be of minority interest, the default build-time configure in &_src/EDITME_&
22265 has it commented out. You need to ensure that
22266 .code
22267 TRANSPORT_LMTP=yes
22268 .endd
22269 .cindex "options" "&(lmtp)& transport"
22270 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22271 included in the Exim binary. The private options of the &(lmtp)& transport are
22272 as follows:
22273
22274 .option batch_id lmtp string&!! unset
22275 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22276
22277
22278 .option batch_max lmtp integer 1
22279 This limits the number of addresses that can be handled in a single delivery.
22280 Most LMTP servers can handle several addresses at once, so it is normally a
22281 good idea to increase this value. See the description of local delivery
22282 batching in chapter &<<CHAPbatching>>&.
22283
22284
22285 .option command lmtp string&!! unset
22286 This option must be set if &%socket%& is not set. The string is a command which
22287 is run in a separate process. It is split up into a command name and list of
22288 arguments, each of which is separately expanded (so expansion cannot change the
22289 number of arguments). The command is run directly, not via a shell. The message
22290 is passed to the new process using the standard input and output to operate the
22291 LMTP protocol.
22292
22293 .option ignore_quota lmtp boolean false
22294 .cindex "LMTP" "ignoring quota errors"
22295 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22296 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22297 in its response to the LHLO command.
22298
22299 .option socket lmtp string&!! unset
22300 This option must be set if &%command%& is not set. The result of expansion must
22301 be the name of a Unix domain socket. The transport connects to the socket and
22302 delivers the message to it using the LMTP protocol.
22303
22304
22305 .option timeout lmtp time 5m
22306 The transport is aborted if the created process or Unix domain socket does not
22307 respond to LMTP commands or message input within this timeout. Delivery
22308 is deferred, and will be tried again later. Here is an example of a typical
22309 LMTP transport:
22310 .code
22311 lmtp:
22312   driver = lmtp
22313   command = /some/local/lmtp/delivery/program
22314   batch_max = 20
22315   user = exim
22316 .endd
22317 This delivers up to 20 addresses at a time, in a mixture of domains if
22318 necessary, running as the user &'exim'&.
22319
22320
22321
22322 . ////////////////////////////////////////////////////////////////////////////
22323 . ////////////////////////////////////////////////////////////////////////////
22324
22325 .chapter "The pipe transport" "CHAPpipetransport"
22326 .scindex IIDpiptra1 "transports" "&(pipe)&"
22327 .scindex IIDpiptra2 "&(pipe)& transport"
22328 The &(pipe)& transport is used to deliver messages via a pipe to a command
22329 running in another process. One example is the use of &(pipe)& as a
22330 pseudo-remote transport for passing messages to some other delivery mechanism
22331 (such as UUCP). Another is the use by individual users to automatically process
22332 their incoming messages. The &(pipe)& transport can be used in one of the
22333 following ways:
22334
22335 .ilist
22336 .vindex "&$local_part$&"
22337 A router routes one address to a transport in the normal way, and the
22338 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22339 contains the local part of the address (as usual), and the command that is run
22340 is specified by the &%command%& option on the transport.
22341 .next
22342 .vindex "&$pipe_addresses$&"
22343 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22344 transport can handle more than one address in a single run. In this case, when
22345 more than one address is routed to the transport, &$local_part$& is not set
22346 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22347 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22348 that are routed to the transport.
22349 .next
22350 .vindex "&$address_pipe$&"
22351 A router redirects an address directly to a pipe command (for example, from an
22352 alias or forward file). In this case, &$address_pipe$& contains the text of the
22353 pipe command, and the &%command%& option on the transport is ignored unless
22354 &%force_command%& is set. If only one address is being transported
22355 (&%batch_max%& is not greater than one, or only one address was redirected to
22356 this pipe command), &$local_part$& contains the local part that was redirected.
22357 .endlist
22358
22359
22360 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22361 deliver messages over pipes using the LMTP interactive protocol. This is
22362 implemented by the &(lmtp)& transport.
22363
22364 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22365 &_.forward_& file, the command runs under the uid and gid of that user. In
22366 other cases, the uid and gid have to be specified explicitly, either on the
22367 transport or on the router that handles the address. Current and &"home"&
22368 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22369 details of the local delivery environment and chapter &<<CHAPbatching>>&
22370 for a discussion of local delivery batching.
22371
22372
22373 .section "Concurrent delivery" "SECID140"
22374 If two messages arrive at almost the same time, and both are routed to a pipe
22375 delivery, the two pipe transports may be run concurrently. You must ensure that
22376 any pipe commands you set up are robust against this happening. If the commands
22377 write to a file, the &%exim_lock%& utility might be of use.
22378
22379
22380
22381
22382 .section "Returned status and data" "SECID141"
22383 .cindex "&(pipe)& transport" "returned data"
22384 If the command exits with a non-zero return code, the delivery is deemed to
22385 have failed, unless either the &%ignore_status%& option is set (in which case
22386 the return code is treated as zero), or the return code is one of those listed
22387 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22388 later"&. In this case, delivery is deferred. Details of a permanent failure are
22389 logged, but are not included in the bounce message, which merely contains
22390 &"local delivery failed"&.
22391
22392 If the command exits on a signal and the &%freeze_signal%& option is set then
22393 the message will be frozen in the queue. If that option is not set, a bounce
22394 will be sent as normal.
22395
22396 If the return code is greater than 128 and the command being run is a shell
22397 script, it normally means that the script was terminated by a signal whose
22398 value is the return code minus 128. The &%freeze_signal%& option does not
22399 apply in this case.
22400
22401 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22402 return code is set to 127. This is the value that a shell returns if it is
22403 asked to run a non-existent command. The wording for the log line suggests that
22404 a non-existent command may be the problem.
22405
22406 The &%return_output%& option can affect the result of a pipe delivery. If it is
22407 set and the command produces any output on its standard output or standard
22408 error streams, the command is considered to have failed, even if it gave a zero
22409 return code or if &%ignore_status%& is set. The output from the command is
22410 included as part of the bounce message. The &%return_fail_output%& option is
22411 similar, except that output is returned only when the command exits with a
22412 failure return code, that is, a value other than zero or a code that matches
22413 &%temp_errors%&.
22414
22415
22416
22417 .section "How the command is run" "SECThowcommandrun"
22418 .cindex "&(pipe)& transport" "path for command"
22419 The command line is (by default) broken down into a command name and arguments
22420 by the &(pipe)& transport itself. The &%allow_commands%& and
22421 &%restrict_to_path%& options can be used to restrict the commands that may be
22422 run.
22423
22424 .cindex "quoting" "in pipe command"
22425 Unquoted arguments are delimited by white space. If an argument appears in
22426 double quotes, backslash is interpreted as an escape character in the usual
22427 way. If an argument appears in single quotes, no escaping is done.
22428
22429 String expansion is applied to the command line except when it comes from a
22430 traditional &_.forward_& file (commands from a filter file are expanded). The
22431 expansion is applied to each argument in turn rather than to the whole line.
22432 For this reason, any string expansion item that contains white space must be
22433 quoted so as to be contained within a single argument. A setting such as
22434 .code
22435 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22436 .endd
22437 will not work, because the expansion item gets split between several
22438 arguments. You have to write
22439 .code
22440 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22441 .endd
22442 to ensure that it is all in one argument. The expansion is done in this way,
22443 argument by argument, so that the number of arguments cannot be changed as a
22444 result of expansion, and quotes or backslashes in inserted variables do not
22445 interact with external quoting. However, this leads to problems if you want to
22446 generate multiple arguments (or the command name plus arguments) from a single
22447 expansion. In this situation, the simplest solution is to use a shell. For
22448 example:
22449 .code
22450 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22451 .endd
22452
22453 .cindex "transport" "filter"
22454 .cindex "filter" "transport filter"
22455 .vindex "&$pipe_addresses$&"
22456 Special handling takes place when an argument consists of precisely the text
22457 &`$pipe_addresses`&. This is not a general expansion variable; the only
22458 place this string is recognized is when it appears as an argument for a pipe or
22459 transport filter command. It causes each address that is being handled to be
22460 inserted in the argument list at that point &'as a separate argument'&. This
22461 avoids any problems with spaces or shell metacharacters, and is of use when a
22462 &(pipe)& transport is handling groups of addresses in a batch.
22463
22464 If &%force_command%& is enabled on the transport, Special handling takes place
22465 for an argument that consists of precisely the text &`$address_pipe`&.  It
22466 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22467 argument is inserted in the argument list at that point
22468 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22469 the only item in the argument; in fact, if it were then &%force_command%&
22470 should behave as a no-op.  Rather, it should be used to adjust the command
22471 run while preserving the argument vector separation.
22472
22473 After splitting up into arguments and expansion, the resulting command is run
22474 in a subprocess directly from the transport, &'not'& under a shell. The
22475 message that is being delivered is supplied on the standard input, and the
22476 standard output and standard error are both connected to a single pipe that is
22477 read by Exim. The &%max_output%& option controls how much output the command
22478 may produce, and the &%return_output%& and &%return_fail_output%& options
22479 control what is done with it.
22480
22481 Not running the command under a shell (by default) lessens the security risks
22482 in cases when a command from a user's filter file is built out of data that was
22483 taken from an incoming message. If a shell is required, it can of course be
22484 explicitly specified as the command to be run. However, there are circumstances
22485 where existing commands (for example, in &_.forward_& files) expect to be run
22486 under a shell and cannot easily be modified. To allow for these cases, there is
22487 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22488 works. Instead of breaking up the command line as just described, it expands it
22489 as a single string and passes the result to &_/bin/sh_&. The
22490 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22491 with &%use_shell%&, and the whole mechanism is inherently less secure.
22492
22493
22494
22495 .section "Environment variables" "SECTpipeenv"
22496 .cindex "&(pipe)& transport" "environment for command"
22497 .cindex "environment for pipe transport"
22498 The environment variables listed below are set up when the command is invoked.
22499 This list is a compromise for maximum compatibility with other MTAs. Note that
22500 the &%environment%& option can be used to add additional variables to this
22501 environment.
22502 .display
22503 &`DOMAIN            `&   the domain of the address
22504 &`HOME              `&   the home directory, if set
22505 &`HOST              `&   the host name when called from a router (see below)
22506 &`LOCAL_PART        `&   see below
22507 &`LOCAL_PART_PREFIX `&   see below
22508 &`LOCAL_PART_SUFFIX `&   see below
22509 &`LOGNAME           `&   see below
22510 &`MESSAGE_ID        `&   Exim's local ID for the message
22511 &`PATH              `&   as specified by the &%path%& option below
22512 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22513 &`RECIPIENT         `&   the complete recipient address
22514 &`SENDER            `&   the sender of the message (empty if a bounce)
22515 &`SHELL             `&   &`/bin/sh`&
22516 &`TZ                `&   the value of the &%timezone%& option, if set
22517 &`USER              `&   see below
22518 .endd
22519 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22520 router, LOCAL_PART is set to the local part of the address. When it is
22521 called as a result of a forward or alias expansion, LOCAL_PART is set to
22522 the local part of the address that was expanded. In both cases, any affixes are
22523 removed from the local part, and made available in LOCAL_PART_PREFIX and
22524 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22525 same value as LOCAL_PART for compatibility with other MTAs.
22526
22527 .cindex "HOST"
22528 HOST is set only when a &(pipe)& transport is called from a router that
22529 associates hosts with an address, typically when using &(pipe)& as a
22530 pseudo-remote transport. HOST is set to the first host name specified by
22531 the router.
22532
22533 .cindex "HOME"
22534 If the transport's generic &%home_directory%& option is set, its value is used
22535 for the HOME environment variable. Otherwise, a home directory may be set
22536 by the router's &%transport_home_directory%& option, which defaults to the
22537 user's home directory if &%check_local_user%& is set.
22538
22539
22540 .section "Private options for pipe" "SECID142"
22541 .cindex "options" "&(pipe)& transport"
22542
22543
22544
22545 .option allow_commands pipe "string list&!!" unset
22546 .cindex "&(pipe)& transport" "permitted commands"
22547 The string is expanded, and is then interpreted as a colon-separated list of
22548 permitted commands. If &%restrict_to_path%& is not set, the only commands
22549 permitted are those in the &%allow_commands%& list. They need not be absolute
22550 paths; the &%path%& option is still used for relative paths. If
22551 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22552 in the &%allow_commands%& list, or a name without any slashes that is found on
22553 the path. In other words, if neither &%allow_commands%& nor
22554 &%restrict_to_path%& is set, there is no restriction on the command, but
22555 otherwise only commands that are permitted by one or the other are allowed. For
22556 example, if
22557 .code
22558 allow_commands = /usr/bin/vacation
22559 .endd
22560 and &%restrict_to_path%& is not set, the only permitted command is
22561 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22562 &%use_shell%& is set.
22563
22564
22565 .option batch_id pipe string&!! unset
22566 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22567
22568
22569 .option batch_max pipe integer 1
22570 This limits the number of addresses that can be handled in a single delivery.
22571 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22572
22573
22574 .option check_string pipe string unset
22575 As &(pipe)& writes the message, the start of each line is tested for matching
22576 &%check_string%&, and if it does, the initial matching characters are replaced
22577 by the contents of &%escape_string%&, provided both are set. The value of
22578 &%check_string%& is a literal string, not a regular expression, and the case of
22579 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22580 of &%check_string%& and &%escape_string%& are forced to values that implement
22581 the SMTP escaping protocol. Any settings made in the configuration file are
22582 ignored.
22583
22584
22585 .option command pipe string&!! unset
22586 This option need not be set when &(pipe)& is being used to deliver to pipes
22587 obtained directly from address redirections. In other cases, the option must be
22588 set, to provide a command to be run. It need not yield an absolute path (see
22589 the &%path%& option below). The command is split up into separate arguments by
22590 Exim, and each argument is separately expanded, as described in section
22591 &<<SECThowcommandrun>>& above.
22592
22593
22594 .option environment pipe string&!! unset
22595 .cindex "&(pipe)& transport" "environment for command"
22596 .cindex "environment for &(pipe)& transport"
22597 This option is used to add additional variables to the environment in which the
22598 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22599 a string which is expanded, and then interpreted as a colon-separated list of
22600 environment settings of the form <&'name'&>=<&'value'&>.
22601
22602
22603 .option escape_string pipe string unset
22604 See &%check_string%& above.
22605
22606
22607 .option freeze_exec_fail pipe boolean false
22608 .cindex "exec failure"
22609 .cindex "failure of exec"
22610 .cindex "&(pipe)& transport" "failure of exec"
22611 Failure to exec the command in a pipe transport is by default treated like
22612 any other failure while running the command. However, if &%freeze_exec_fail%&
22613 is set, failure to exec is treated specially, and causes the message to be
22614 frozen, whatever the setting of &%ignore_status%&.
22615
22616
22617 .option freeze_signal pipe boolean false
22618 .cindex "signal exit"
22619 .cindex "&(pipe)& transport", "signal exit"
22620 Normally if the process run by a command in a pipe transport exits on a signal,
22621 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22622 frozen in Exim's queue instead.
22623
22624
22625 .option force_command pipe boolean false
22626 .cindex "force command"
22627 .cindex "&(pipe)& transport", "force command"
22628 Normally when a router redirects an address directly to a pipe command
22629 the &%command%& option on the transport is ignored.  If &%force_command%&
22630 is set, the &%command%& option will used. This is especially
22631 useful for forcing a wrapper or additional argument to be added to the
22632 command. For example:
22633 .code
22634 command = /usr/bin/remote_exec myhost -- $address_pipe
22635 force_command
22636 .endd
22637
22638 Note that &$address_pipe$& is handled specially in &%command%& when
22639 &%force_command%& is set, expanding out to the original argument vector as
22640 separate items, similarly to a Unix shell &`"$@"`& construct.
22641
22642 .option ignore_status pipe boolean false
22643 If this option is true, the status returned by the subprocess that is set up to
22644 run the command is ignored, and Exim behaves as if zero had been returned.
22645 Otherwise, a non-zero status or termination by signal causes an error return
22646 from the transport unless the status value is one of those listed in
22647 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22648
22649 &*Note*&: This option does not apply to timeouts, which do not return a status.
22650 See the &%timeout_defer%& option for how timeouts are handled.
22651
22652 .option log_defer_output pipe boolean false
22653 .cindex "&(pipe)& transport" "logging output"
22654 If this option is set, and the status returned by the command is
22655 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22656 and any output was produced, the first line of it is written to the main log.
22657
22658
22659 .option log_fail_output pipe boolean false
22660 If this option is set, and the command returns any output, and also ends with a
22661 return code that is neither zero nor one of the return codes listed in
22662 &%temp_errors%& (that is, the delivery failed), the first line of output is
22663 written to the main log. This option and &%log_output%& are mutually exclusive.
22664 Only one of them may be set.
22665
22666
22667
22668 .option log_output pipe boolean false
22669 If this option is set and the command returns any output, the first line of
22670 output is written to the main log, whatever the return code. This option and
22671 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22672
22673
22674
22675 .option max_output pipe integer 20K
22676 This specifies the maximum amount of output that the command may produce on its
22677 standard output and standard error file combined. If the limit is exceeded, the
22678 process running the command is killed. This is intended as a safety measure to
22679 catch runaway processes. The limit is applied independently of the settings of
22680 the options that control what is done with such output (for example,
22681 &%return_output%&). Because of buffering effects, the amount of output may
22682 exceed the limit by a small amount before Exim notices.
22683
22684
22685 .option message_prefix pipe string&!! "see below"
22686 The string specified here is expanded and output at the start of every message.
22687 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22688 .code
22689 message_prefix = \
22690   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22691   ${tod_bsdinbox}\n
22692 .endd
22693 .cindex "Cyrus"
22694 .cindex "&%tmail%&"
22695 .cindex "&""From""& line"
22696 This is required by the commonly used &_/usr/bin/vacation_& program.
22697 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22698 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22699 setting
22700 .code
22701 message_prefix =
22702 .endd
22703 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22704 &`\n`& to &`\r\n`& in &%message_prefix%&.
22705
22706
22707 .option message_suffix pipe string&!! "see below"
22708 The string specified here is expanded and output at the end of every message.
22709 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22710 The suffix can be suppressed by setting
22711 .code
22712 message_suffix =
22713 .endd
22714 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22715 &`\n`& to &`\r\n`& in &%message_suffix%&.
22716
22717
22718 .option path pipe string "see below"
22719 This option specifies the string that is set up in the PATH environment
22720 variable of the subprocess. The default is:
22721 .code
22722 /bin:/usr/bin
22723 .endd
22724 If the &%command%& option does not yield an absolute path name, the command is
22725 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22726 apply to a command specified as a transport filter.
22727
22728
22729 .option permit_coredump pipe boolean false
22730 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22731 a core-dump of a pipe command, enable this command.  This enables core-dumps
22732 during delivery and affects both the Exim binary and the pipe command run.
22733 It is recommended that this option remain off unless and until you have a need
22734 for it and that this only be enabled when needed, as the risk of excessive
22735 resource consumption can be quite high.  Note also that Exim is typically
22736 installed as a setuid binary and most operating systems will inhibit coredumps
22737 of these by default, so further OS-specific action may be required.
22738
22739
22740 .option pipe_as_creator pipe boolean false
22741 .cindex "uid (user id)" "local delivery"
22742 If the generic &%user%& option is not set and this option is true, the delivery
22743 process is run under the uid that was in force when Exim was originally called
22744 to accept the message. If the group id is not otherwise set (via the generic
22745 &%group%& option), the gid that was in force when Exim was originally called to
22746 accept the message is used.
22747
22748
22749 .option restrict_to_path pipe boolean false
22750 When this option is set, any command name not listed in &%allow_commands%& must
22751 contain no slashes. The command is searched for only in the directories listed
22752 in the &%path%& option. This option is intended for use in the case when a pipe
22753 command has been generated from a user's &_.forward_& file. This is usually
22754 handled by a &(pipe)& transport called &%address_pipe%&.
22755
22756
22757 .option return_fail_output pipe boolean false
22758 If this option is true, and the command produced any output and ended with a
22759 return code other than zero or one of the codes listed in &%temp_errors%& (that
22760 is, the delivery failed), the output is returned in the bounce message.
22761 However, if the message has a null sender (that is, it is itself a bounce
22762 message), output from the command is discarded. This option and
22763 &%return_output%& are mutually exclusive. Only one of them may be set.
22764
22765
22766
22767 .option return_output pipe boolean false
22768 If this option is true, and the command produced any output, the delivery is
22769 deemed to have failed whatever the return code from the command, and the output
22770 is returned in the bounce message. Otherwise, the output is just discarded.
22771 However, if the message has a null sender (that is, it is a bounce message),
22772 output from the command is always discarded, whatever the setting of this
22773 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22774 of them may be set.
22775
22776
22777
22778 .option temp_errors pipe "string list" "see below"
22779 .cindex "&(pipe)& transport" "temporary failure"
22780 This option contains either a colon-separated list of numbers, or a single
22781 asterisk. If &%ignore_status%& is false
22782 and &%return_output%& is not set,
22783 and the command exits with a non-zero return code, the failure is treated as
22784 temporary and the delivery is deferred if the return code matches one of the
22785 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22786 codes are treated as permanent errors. The default setting contains the codes
22787 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22788 compiled on a system that does not define these macros, it assumes values of 75
22789 and 73, respectively.
22790
22791
22792 .option timeout pipe time 1h
22793 If the command fails to complete within this time, it is killed. This normally
22794 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22795 specifies no timeout. In order to ensure that any subprocesses created by the
22796 command are also killed, Exim makes the initial process a process group leader,
22797 and kills the whole process group on a timeout. However, this can be defeated
22798 if one of the processes starts a new process group.
22799
22800 .option timeout_defer pipe boolean false
22801 A timeout in a &(pipe)& transport, either in the command that the transport
22802 runs, or in a transport filter that is associated with it, is by default
22803 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22804 is set true, both kinds of timeout become temporary errors, causing the
22805 delivery to be deferred.
22806
22807 .option umask pipe "octal integer" 022
22808 This specifies the umask setting for the subprocess that runs the command.
22809
22810
22811 .option use_bsmtp pipe boolean false
22812 .cindex "envelope sender"
22813 If this option is set true, the &(pipe)& transport writes messages in &"batch
22814 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22815 commands. If you want to include a leading HELO command with such messages,
22816 you can do so by setting the &%message_prefix%& option. See section
22817 &<<SECTbatchSMTP>>& for details of batch SMTP.
22818
22819 .option use_classresources pipe boolean false
22820 .cindex "class resources (BSD)"
22821 This option is available only when Exim is running on FreeBSD, NetBSD, or
22822 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22823 resource limits when a &(pipe)& transport is run to perform a delivery. The
22824 limits for the uid under which the pipe is to run are obtained from the login
22825 class database.
22826
22827
22828 .option use_crlf pipe boolean false
22829 .cindex "carriage return"
22830 .cindex "linefeed"
22831 This option causes lines to be terminated with the two-character CRLF sequence
22832 (carriage return, linefeed) instead of just a linefeed character. In the case
22833 of batched SMTP, the byte sequence written to the pipe is then an exact image
22834 of what would be sent down a real SMTP connection.
22835
22836 The contents of the &%message_prefix%& and &%message_suffix%& options are
22837 written verbatim, so must contain their own carriage return characters if these
22838 are needed. When &%use_bsmtp%& is not set, the default values for both
22839 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22840 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22841
22842
22843 .option use_shell pipe boolean false
22844 .vindex "&$pipe_addresses$&"
22845 If this option is set, it causes the command to be passed to &_/bin/sh_&
22846 instead of being run directly from the transport, as described in section
22847 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22848 where the command is expected to be run under a shell and cannot easily be
22849 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22850 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22851 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22852 its &%-c%& option.
22853
22854
22855
22856 .section "Using an external local delivery agent" "SECID143"
22857 .cindex "local delivery" "using an external agent"
22858 .cindex "&'procmail'&"
22859 .cindex "external local delivery"
22860 .cindex "delivery" "&'procmail'&"
22861 .cindex "delivery" "by external agent"
22862 The &(pipe)& transport can be used to pass all messages that require local
22863 delivery to a separate local delivery agent such as &%procmail%&. When doing
22864 this, care must be taken to ensure that the pipe is run under an appropriate
22865 uid and gid. In some configurations one wants this to be a uid that is trusted
22866 by the delivery agent to supply the correct sender of the message. It may be
22867 necessary to recompile or reconfigure the delivery agent so that it trusts an
22868 appropriate user. The following is an example transport and router
22869 configuration for &%procmail%&:
22870 .code
22871 # transport
22872 procmail_pipe:
22873   driver = pipe
22874   command = /usr/local/bin/procmail -d $local_part
22875   return_path_add
22876   delivery_date_add
22877   envelope_to_add
22878   check_string = "From "
22879   escape_string = ">From "
22880   umask = 077
22881   user = $local_part
22882   group = mail
22883
22884 # router
22885 procmail:
22886   driver = accept
22887   check_local_user
22888   transport = procmail_pipe
22889 .endd
22890 In this example, the pipe is run as the local user, but with the group set to
22891 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22892 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22893 user to supply a correct sender address. If you do not specify either a
22894 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22895 home directory is the user's home directory by default.
22896
22897 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22898 .code
22899 IFS=" "
22900 .endd
22901 as shown in some &%procmail%& documentation, because Exim does not by default
22902 use a shell to run pipe commands.
22903
22904 .cindex "Cyrus"
22905 The next example shows a transport and a router for a system where local
22906 deliveries are handled by the Cyrus IMAP server.
22907 .code
22908 # transport
22909 local_delivery_cyrus:
22910   driver = pipe
22911   command = /usr/cyrus/bin/deliver \
22912             -m ${substr_1:$local_part_suffix} -- $local_part
22913   user = cyrus
22914   group = mail
22915   return_output
22916   log_output
22917   message_prefix =
22918   message_suffix =
22919
22920 # router
22921 local_user_cyrus:
22922   driver = accept
22923   check_local_user
22924   local_part_suffix = .*
22925   transport = local_delivery_cyrus
22926 .endd
22927 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22928 &%return_output%& to cause any text written by Cyrus to be returned to the
22929 sender.
22930 .ecindex IIDpiptra1
22931 .ecindex IIDpiptra2
22932
22933
22934 . ////////////////////////////////////////////////////////////////////////////
22935 . ////////////////////////////////////////////////////////////////////////////
22936
22937 .chapter "The smtp transport" "CHAPsmtptrans"
22938 .scindex IIDsmttra1 "transports" "&(smtp)&"
22939 .scindex IIDsmttra2 "&(smtp)& transport"
22940 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22941 or LMTP protocol. The list of hosts to try can either be taken from the address
22942 that is being processed (having been set up by the router), or specified
22943 explicitly for the transport. Timeout and retry processing (see chapter
22944 &<<CHAPretry>>&) is applied to each IP address independently.
22945
22946
22947 .section "Multiple messages on a single connection" "SECID144"
22948 The sending of multiple messages over a single TCP/IP connection can arise in
22949 two ways:
22950
22951 .ilist
22952 If a message contains more than &%max_rcpt%& (see below) addresses that are
22953 routed to the same host, more than one copy of the message has to be sent to
22954 that host. In this situation, multiple copies may be sent in a single run of
22955 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
22956 does when it has too many addresses to send in one message also depends on the
22957 value of the global &%remote_max_parallel%& option. Details are given in
22958 section &<<SECToutSMTPTCP>>&.)
22959 .next
22960 .cindex "hints database" "remembering routing"
22961 When a message has been successfully delivered over a TCP/IP connection, Exim
22962 looks in its hints database to see if there are any other messages awaiting a
22963 connection to the same host. If there are, a new delivery process is started
22964 for one of them, and the current TCP/IP connection is passed on to it. The new
22965 process may in turn send multiple copies and possibly create yet another
22966 process.
22967 .endlist
22968
22969
22970 For each copy sent over the same TCP/IP connection, a sequence counter is
22971 incremented, and if it ever gets to the value of &%connection_max_messages%&,
22972 no further messages are sent over that connection.
22973
22974
22975
22976 .section "Use of the $host and $host_address variables" "SECID145"
22977 .vindex "&$host$&"
22978 .vindex "&$host_address$&"
22979 At the start of a run of the &(smtp)& transport, the values of &$host$& and
22980 &$host_address$& are the name and IP address of the first host on the host list
22981 passed by the router. However, when the transport is about to connect to a
22982 specific host, and while it is connected to that host, &$host$& and
22983 &$host_address$& are set to the values for that host. These are the values
22984 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
22985 &%serialize_hosts%&, and the various TLS options are expanded.
22986
22987
22988 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
22989 .vindex &$tls_bits$&
22990 .vindex &$tls_cipher$&
22991 .vindex &$tls_peerdn$&
22992 .vindex &$tls_sni$&
22993 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
22994 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
22995 are the values that were set when the message was received.
22996 These are the values that are used for options that are expanded before any
22997 SMTP connections are made. Just before each connection is made, these four
22998 variables are emptied. If TLS is subsequently started, they are set to the
22999 appropriate values for the outgoing connection, and these are the values that
23000 are in force when any authenticators are run and when the
23001 &%authenticated_sender%& option is expanded.
23002
23003 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23004 and will be removed in a future release.
23005
23006
23007 .section "Private options for smtp" "SECID146"
23008 .cindex "options" "&(smtp)& transport"
23009 The private options of the &(smtp)& transport are as follows:
23010
23011
23012 .option address_retry_include_sender smtp boolean true
23013 .cindex "4&'xx'& responses" "retrying after"
23014 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23015 is the combination of sender and recipient that is delayed in subsequent queue
23016 runs until the retry time is reached. You can delay the recipient without
23017 reference to the sender (which is what earlier versions of Exim did), by
23018 setting &%address_retry_include_sender%& false. However, this can lead to
23019 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23020
23021 .option allow_localhost smtp boolean false
23022 .cindex "local host" "sending to"
23023 .cindex "fallback" "hosts specified on transport"
23024 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23025 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23026 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23027 the delivery anyway. This should be used only in special cases when the
23028 configuration ensures that no looping will result (for example, a differently
23029 configured Exim is listening on the port to which the message is sent).
23030
23031
23032 .option authenticated_sender smtp string&!! unset
23033 .cindex "Cyrus"
23034 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23035 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23036 overriding any existing authenticated sender value. If the string expansion is
23037 forced to fail, the option is ignored. Other expansion failures cause delivery
23038 to be deferred. If the result of expansion is an empty string, that is also
23039 ignored.
23040
23041 The expansion happens after the outgoing connection has been made and TLS
23042 started, if required. This means that the &$host$&, &$host_address$&,
23043 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23044 particular connection.
23045
23046 If the SMTP session is not authenticated, the expansion of
23047 &%authenticated_sender%& still happens (and can cause the delivery to be
23048 deferred if it fails), but no AUTH= item is added to MAIL commands
23049 unless &%authenticated_sender_force%& is true.
23050
23051 This option allows you to use the &(smtp)& transport in LMTP mode to
23052 deliver mail to Cyrus IMAP and provide the proper local part as the
23053 &"authenticated sender"&, via a setting such as:
23054 .code
23055 authenticated_sender = $local_part
23056 .endd
23057 This removes the need for IMAP subfolders to be assigned special ACLs to
23058 allow direct delivery to those subfolders.
23059
23060 Because of expected uses such as that just described for Cyrus (when no
23061 domain is involved), there is no checking on the syntax of the provided
23062 value.
23063
23064
23065 .option authenticated_sender_force smtp boolean false
23066 If this option is set true, the &%authenticated_sender%& option's value
23067 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23068 authenticated as a client.
23069
23070
23071 .option command_timeout smtp time 5m
23072 This sets a timeout for receiving a response to an SMTP command that has been
23073 sent out. It is also used when waiting for the initial banner line from the
23074 remote host. Its value must not be zero.
23075
23076
23077 .option connect_timeout smtp time 5m
23078 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23079 to a remote host. A setting of zero allows the system timeout (typically
23080 several minutes) to act. To have any effect, the value of this option must be
23081 less than the system timeout. However, it has been observed that on some
23082 systems there is no system timeout, which is why the default value for this
23083 option is 5 minutes, a value recommended by RFC 1123.
23084
23085
23086 .option connection_max_messages smtp integer 500
23087 .cindex "SMTP" "passed connection"
23088 .cindex "SMTP" "multiple deliveries"
23089 .cindex "multiple SMTP deliveries"
23090 This controls the maximum number of separate message deliveries that are sent
23091 over a single TCP/IP connection. If the value is zero, there is no limit.
23092 For testing purposes, this value can be overridden by the &%-oB%& command line
23093 option.
23094
23095
23096 .option data_timeout smtp time 5m
23097 This sets a timeout for the transmission of each block in the data portion of
23098 the message. As a result, the overall timeout for a message depends on the size
23099 of the message. Its value must not be zero. See also &%final_timeout%&.
23100
23101
23102 .option delay_after_cutoff smtp boolean true
23103 This option controls what happens when all remote IP addresses for a given
23104 domain have been inaccessible for so long that they have passed their retry
23105 cutoff times.
23106
23107 In the default state, if the next retry time has not been reached for any of
23108 them, the address is bounced without trying any deliveries. In other words,
23109 Exim delays retrying an IP address after the final cutoff time until a new
23110 retry time is reached, and can therefore bounce an address without ever trying
23111 a delivery, when machines have been down for a long time. Some people are
23112 unhappy at this prospect, so...
23113
23114 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23115 addresses are past their final cutoff time, Exim tries to deliver to those
23116 IP addresses that have not been tried since the message arrived. If there are
23117 none, of if they all fail, the address is bounced. In other words, it does not
23118 delay when a new message arrives, but immediately tries those expired IP
23119 addresses that haven't been tried since the message arrived. If there is a
23120 continuous stream of messages for the dead hosts, unsetting
23121 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23122 to them.
23123
23124
23125 .option dns_qualify_single smtp boolean true
23126 If the &%hosts%& or &%fallback_hosts%& option is being used,
23127 and the &%gethostbyname%& option is false,
23128 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23129 in chapter &<<CHAPdnslookup>>& for more details.
23130
23131
23132 .option dns_search_parents smtp boolean false
23133 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23134 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23135 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23136 details.
23137
23138
23139 .option dnssec_request_domains smtp "domain list&!!" unset
23140 .cindex "MX record" "security"
23141 .cindex "DNSSEC" "MX lookup"
23142 .cindex "security" "MX lookup"
23143 .cindex "DNS" "DNSSEC"
23144 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23145 the dnssec request bit set.
23146 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23147
23148
23149
23150 .option dnssec_require_domains smtp "domain list&!!" unset
23151 .cindex "MX record" "security"
23152 .cindex "DNSSEC" "MX lookup"
23153 .cindex "security" "MX lookup"
23154 .cindex "DNS" "DNSSEC"
23155 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23156 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23157 (AD bit) set wil be ignored and logged as a host-lookup failure.
23158 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23159
23160
23161
23162 .option dscp smtp string&!! unset
23163 .cindex "DCSP" "outbound"
23164 This option causes the DSCP value associated with a socket to be set to one
23165 of a number of fixed strings or to numeric value.
23166 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23167 Common values include &`throughput`&, &`mincost`&, and on newer systems
23168 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23169
23170 The outbound packets from Exim will be marked with this value in the header
23171 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23172 that these values will have any effect, not be stripped by networking
23173 equipment, or do much of anything without cooperation with your Network
23174 Engineer and those of all network operators between the source and destination.
23175
23176
23177 .option fallback_hosts smtp "string list" unset
23178 .cindex "fallback" "hosts specified on transport"
23179 String expansion is not applied to this option. The argument must be a
23180 colon-separated list of host names or IP addresses, optionally also including
23181 port numbers, though the separator can be changed, as described in section
23182 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23183 item in a &%route_list%& setting for the &(manualroute)& router, as described
23184 in section &<<SECTformatonehostitem>>&.
23185
23186 Fallback hosts can also be specified on routers, which associate them with the
23187 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23188 &%fallback_hosts%& specified on the transport is used only if the address does
23189 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23190 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23191 However, &%hosts_randomize%& does apply to fallback host lists.
23192
23193 If Exim is unable to deliver to any of the hosts for a particular address, and
23194 the errors are not permanent rejections, the address is put on a separate
23195 transport queue with its host list replaced by the fallback hosts, unless the
23196 address was routed via MX records and the current host was in the original MX
23197 list. In that situation, the fallback host list is not used.
23198
23199 Once normal deliveries are complete, the fallback queue is delivered by
23200 re-running the same transports with the new host lists. If several failing
23201 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23202 copy of the message is sent.
23203
23204 The resolution of the host names on the fallback list is controlled by the
23205 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23206 both to cases when the host list comes with the address and when it is taken
23207 from &%hosts%&. This option provides a &"use a smart host only if delivery
23208 fails"& facility.
23209
23210
23211 .option final_timeout smtp time 10m
23212 This is the timeout that applies while waiting for the response to the final
23213 line containing just &"."& that terminates a message. Its value must not be
23214 zero.
23215
23216 .option gethostbyname smtp boolean false
23217 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23218 being used, names are looked up using &[gethostbyname()]&
23219 (or &[getipnodebyname()]& when available)
23220 instead of using the DNS. Of course, that function may in fact use the DNS, but
23221 it may also consult other sources of information such as &_/etc/hosts_&.
23222
23223 .option gnutls_compat_mode smtp boolean unset
23224 This option controls whether GnuTLS is used in compatibility mode in an Exim
23225 server. This reduces security slightly, but improves interworking with older
23226 implementations of TLS.
23227
23228 .option helo_data smtp string&!! "see below"
23229 .cindex "HELO" "argument, setting"
23230 .cindex "EHLO" "argument, setting"
23231 .cindex "LHLO argument setting"
23232 The value of this option is expanded after a connection to a another host has
23233 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23234 command that starts the outgoing SMTP or LMTP session. The default value of the
23235 option is:
23236 .code
23237 $primary_hostname
23238 .endd
23239 During the expansion, the variables &$host$& and &$host_address$& are set to
23240 the identity of the remote host, and the variables &$sending_ip_address$& and
23241 &$sending_port$& are set to the local IP address and port number that are being
23242 used. These variables can be used to generate different values for different
23243 servers or different local IP addresses. For example, if you want the string
23244 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23245 interface address, you could use this:
23246 .code
23247 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23248   {$primary_hostname}}
23249 .endd
23250 The use of &%helo_data%& applies both to sending messages and when doing
23251 callouts.
23252
23253 .option hosts smtp "string list&!!" unset
23254 Hosts are associated with an address by a router such as &(dnslookup)&, which
23255 finds the hosts by looking up the address domain in the DNS, or by
23256 &(manualroute)&, which has lists of hosts in its configuration. However,
23257 email addresses can be passed to the &(smtp)& transport by any router, and not
23258 all of them can provide an associated list of hosts.
23259
23260 The &%hosts%& option specifies a list of hosts to be used if the address being
23261 processed does not have any hosts associated with it. The hosts specified by
23262 &%hosts%& are also used, whether or not the address has its own hosts, if
23263 &%hosts_override%& is set.
23264
23265 The string is first expanded, before being interpreted as a colon-separated
23266 list of host names or IP addresses, possibly including port numbers. The
23267 separator may be changed to something other than colon, as described in section
23268 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23269 item in a &%route_list%& setting for the &(manualroute)& router, as described
23270 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23271 of the &(manualroute)& router is not available here.
23272
23273 If the expansion fails, delivery is deferred. Unless the failure was caused by
23274 the inability to complete a lookup, the error is logged to the panic log as
23275 well as the main log. Host names are looked up either by searching directly for
23276 address records in the DNS or by calling &[gethostbyname()]& (or
23277 &[getipnodebyname()]& when available), depending on the setting of the
23278 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23279 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23280 address are used.
23281
23282 During delivery, the hosts are tried in order, subject to their retry status,
23283 unless &%hosts_randomize%& is set.
23284
23285
23286 .option hosts_avoid_esmtp smtp "host list&!!" unset
23287 .cindex "ESMTP, avoiding use of"
23288 .cindex "HELO" "forcing use of"
23289 .cindex "EHLO" "avoiding use of"
23290 .cindex "PIPELINING" "avoiding the use of"
23291 This option is for use with broken hosts that announce ESMTP facilities (for
23292 example, PIPELINING) and then fail to implement them properly. When a host
23293 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23294 start of the SMTP session. This means that it cannot use any of the ESMTP
23295 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23296
23297
23298 .option hosts_avoid_pipelining smtp "host list&!!" unset
23299 .cindex "PIPELINING" "avoiding the use of"
23300 Exim will not use the SMTP PIPELINING extension when delivering to any host
23301 that matches this list, even if the server host advertises PIPELINING support.
23302
23303
23304 .option hosts_avoid_tls smtp "host list&!!" unset
23305 .cindex "TLS" "avoiding for certain hosts"
23306 Exim will not try to start a TLS session when delivering to any host that
23307 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23308
23309 .new
23310 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23311 .cindex "TLS" "avoiding for certain hosts"
23312 Exim will not try to start a TLS session for a verify callout,
23313 or when delivering in cutthrough mode,
23314 to any host that matches this list.
23315 .wen
23316
23317
23318 .option hosts_max_try smtp integer 5
23319 .cindex "host" "maximum number to try"
23320 .cindex "limit" "number of hosts tried"
23321 .cindex "limit" "number of MX tried"
23322 .cindex "MX record" "maximum tried"
23323 This option limits the number of IP addresses that are tried for any one
23324 delivery in cases where there are temporary delivery errors. Section
23325 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23326
23327
23328 .option hosts_max_try_hardlimit smtp integer 50
23329 This is an additional check on the maximum number of IP addresses that Exim
23330 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23331 why it exists.
23332
23333
23334
23335 .option hosts_nopass_tls smtp "host list&!!" unset
23336 .cindex "TLS" "passing connection"
23337 .cindex "multiple SMTP deliveries"
23338 .cindex "TLS" "multiple message deliveries"
23339 For any host that matches this list, a connection on which a TLS session has
23340 been started will not be passed to a new delivery process for sending another
23341 message on the same connection. See section &<<SECTmulmessam>>& for an
23342 explanation of when this might be needed.
23343
23344
23345 .option hosts_override smtp boolean false
23346 If this option is set and the &%hosts%& option is also set, any hosts that are
23347 attached to the address are ignored, and instead the hosts specified by the
23348 &%hosts%& option are always used. This option does not apply to
23349 &%fallback_hosts%&.
23350
23351
23352 .option hosts_randomize smtp boolean false
23353 .cindex "randomized host list"
23354 .cindex "host" "list of; randomized"
23355 .cindex "fallback" "randomized hosts"
23356 If this option is set, and either the list of hosts is taken from the
23357 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23358 were not obtained from MX records (this includes fallback hosts from the
23359 router), and were not randomized by the router, the order of trying the hosts
23360 is randomized each time the transport runs. Randomizing the order of a host
23361 list can be used to do crude load sharing.
23362
23363 When &%hosts_randomize%& is true, a host list may be split into groups whose
23364 order is separately randomized. This makes it possible to set up MX-like
23365 behaviour. The boundaries between groups are indicated by an item that is just
23366 &`+`& in the host list. For example:
23367 .code
23368 hosts = host1:host2:host3:+:host4:host5
23369 .endd
23370 The order of the first three hosts and the order of the last two hosts is
23371 randomized for each use, but the first three always end up before the last two.
23372 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23373
23374 .option hosts_require_auth smtp "host list&!!" unset
23375 .cindex "authentication" "required by client"
23376 This option provides a list of servers for which authentication must succeed
23377 before Exim will try to transfer a message. If authentication fails for
23378 servers which are not in this list, Exim tries to send unauthenticated. If
23379 authentication fails for one of these servers, delivery is deferred. This
23380 temporary error is detectable in the retry rules, so it can be turned into a
23381 hard failure if required. See also &%hosts_try_auth%&, and chapter
23382 &<<CHAPSMTPAUTH>>& for details of authentication.
23383
23384
23385 .option hosts_request_ocsp smtp "host list&!!" *
23386 .cindex "TLS" "requiring for certain servers"
23387 Exim will request a Certificate Status on a
23388 TLS session for any host that matches this list.
23389 &%tls_verify_certificates%& should also be set for the transport.
23390
23391 .option hosts_require_ocsp smtp "host list&!!" unset
23392 .cindex "TLS" "requiring for certain servers"
23393 Exim will request, and check for a valid Certificate Status being given, on a
23394 TLS session for any host that matches this list.
23395 &%tls_verify_certificates%& should also be set for the transport.
23396
23397 .option hosts_require_tls smtp "host list&!!" unset
23398 .cindex "TLS" "requiring for certain servers"
23399 Exim will insist on using a TLS session when delivering to any host that
23400 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23401 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23402 incoming messages, use an appropriate ACL.
23403
23404 .option hosts_try_auth smtp "host list&!!" unset
23405 .cindex "authentication" "optional in client"
23406 This option provides a list of servers to which, provided they announce
23407 authentication support, Exim will attempt to authenticate as a client when it
23408 connects. If authentication fails, Exim will try to transfer the message
23409 unauthenticated. See also &%hosts_require_auth%&, and chapter
23410 &<<CHAPSMTPAUTH>>& for details of authentication.
23411
23412 .new
23413 .option hosts_try_prdr smtp "host list&!!" *
23414 .cindex "PRDR" "enabling, optional in client"
23415 This option provides a list of servers to which, provided they announce
23416 PRDR support, Exim will attempt to negotiate PRDR
23417 for multi-recipient messages.
23418 The option can usually be left as default.
23419 .wen
23420
23421 .option interface smtp "string list&!!" unset
23422 .cindex "bind IP address"
23423 .cindex "IP address" "binding"
23424 .vindex "&$host$&"
23425 .vindex "&$host_address$&"
23426 This option specifies which interface to bind to when making an outgoing SMTP
23427 call. The value is an IP address, not an interface name such as
23428 &`eth0`&. Do not confuse this with the interface address that was used when a
23429 message was received, which is in &$received_ip_address$&, formerly known as
23430 &$interface_address$&. The name was changed to minimize confusion with the
23431 outgoing interface address. There is no variable that contains an outgoing
23432 interface address because, unless it is set by this option, its value is
23433 unknown.
23434
23435 During the expansion of the &%interface%& option the variables &$host$& and
23436 &$host_address$& refer to the host to which a connection is about to be made
23437 during the expansion of the string. Forced expansion failure, or an empty
23438 string result causes the option to be ignored. Otherwise, after expansion, the
23439 string must be a list of IP addresses, colon-separated by default, but the
23440 separator can be changed in the usual way. For example:
23441 .code
23442 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23443 .endd
23444 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23445 connection. If none of them are the correct type, the option is ignored. If
23446 &%interface%& is not set, or is ignored, the system's IP functions choose which
23447 interface to use if the host has more than one.
23448
23449
23450 .option keepalive smtp boolean true
23451 .cindex "keepalive" "on outgoing connection"
23452 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23453 connections. When set, it causes the kernel to probe idle connections
23454 periodically, by sending packets with &"old"& sequence numbers. The other end
23455 of the connection should send a acknowledgment if the connection is still okay
23456 or a reset if the connection has been aborted. The reason for doing this is
23457 that it has the beneficial effect of freeing up certain types of connection
23458 that can get stuck when the remote host is disconnected without tidying up the
23459 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23460 unreachable hosts.
23461
23462
23463 .option lmtp_ignore_quota smtp boolean false
23464 .cindex "LMTP" "ignoring quota errors"
23465 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23466 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23467 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23468
23469 .option max_rcpt smtp integer 100
23470 .cindex "RCPT" "maximum number of outgoing"
23471 This option limits the number of RCPT commands that are sent in a single
23472 SMTP message transaction. Each set of addresses is treated independently, and
23473 so can cause parallel connections to the same host if &%remote_max_parallel%&
23474 permits this.
23475
23476
23477 .option multi_domain smtp boolean&!! true
23478 .vindex "&$domain$&"
23479 When this option is set, the &(smtp)& transport can handle a number of
23480 addresses containing a mixture of different domains provided they all resolve
23481 to the same list of hosts. Turning the option off restricts the transport to
23482 handling only one domain at a time. This is useful if you want to use
23483 &$domain$& in an expansion for the transport, because it is set only when there
23484 is a single domain involved in a remote delivery.
23485
23486 .new
23487 It is expanded per-address and can depend on any of
23488 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23489 &$host$&, &$host_address$& and &$host_port$&.
23490 .wen
23491
23492 .option port smtp string&!! "see below"
23493 .cindex "port" "sending TCP/IP"
23494 .cindex "TCP/IP" "setting outgoing port"
23495 This option specifies the TCP/IP port on the server to which Exim connects.
23496 &*Note:*& Do not confuse this with the port that was used when a message was
23497 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23498 The name was changed to minimize confusion with the outgoing port. There is no
23499 variable that contains an outgoing port.
23500
23501 If the value of this option begins with a digit it is taken as a port number;
23502 otherwise it is looked up using &[getservbyname()]&. The default value is
23503 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23504 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23505 is deferred.
23506
23507
23508
23509 .option protocol smtp string smtp
23510 .cindex "LMTP" "over TCP/IP"
23511 .cindex "ssmtp protocol" "outbound"
23512 .cindex "TLS" "SSL-on-connect outbound"
23513 .vindex "&$port$&"
23514 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23515 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23516 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23517 deliveries into closed message stores. Exim also has support for running LMTP
23518 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23519
23520 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23521 changes to &"smtps"&, and the transport initiates TLS immediately after
23522 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23523 The Internet standards bodies strongly discourage use of this mode.
23524
23525
23526 .option retry_include_ip_address smtp boolean&!! true
23527 Exim normally includes both the host name and the IP address in the key it
23528 constructs for indexing retry data after a temporary delivery failure. This
23529 means that when one of several IP addresses for a host is failing, it gets
23530 tried periodically (controlled by the retry rules), but use of the other IP
23531 addresses is not affected.
23532
23533 However, in some dialup environments hosts are assigned a different IP address
23534 each time they connect. In this situation the use of the IP address as part of
23535 the retry key leads to undesirable behaviour. Setting this option false causes
23536 Exim to use only the host name.
23537 .new
23538 Since it is expanded it can be made to depend on the host or domain.
23539 .wen
23540
23541
23542 .option serialize_hosts smtp "host list&!!" unset
23543 .cindex "serializing connections"
23544 .cindex "host" "serializing connections"
23545 Because Exim operates in a distributed manner, if several messages for the same
23546 host arrive at around the same time, more than one simultaneous connection to
23547 the remote host can occur. This is not usually a problem except when there is a
23548 slow link between the hosts. In that situation it may be helpful to restrict
23549 Exim to one connection at a time. This can be done by setting
23550 &%serialize_hosts%& to match the relevant hosts.
23551
23552 .cindex "hints database" "serializing deliveries to a host"
23553 Exim implements serialization by means of a hints database in which a record is
23554 written whenever a process connects to one of the restricted hosts. The record
23555 is deleted when the connection is completed. Obviously there is scope for
23556 records to get left lying around if there is a system or program crash. To
23557 guard against this, Exim ignores any records that are more than six hours old.
23558
23559 If you set up this kind of serialization, you should also arrange to delete the
23560 relevant hints database whenever your system reboots. The names of the files
23561 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23562 may be one or two files, depending on the type of DBM in use. The same files
23563 are used for ETRN serialization.
23564
23565
23566 .option size_addition smtp integer 1024
23567 .cindex "SMTP" "SIZE"
23568 .cindex "message" "size issue for transport filter"
23569 .cindex "size" "of message"
23570 .cindex "transport" "filter"
23571 .cindex "filter" "transport filter"
23572 If a remote SMTP server indicates that it supports the SIZE option of the
23573 MAIL command, Exim uses this to pass over the message size at the start of
23574 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23575 sends, to allow for headers and other text that may be added during delivery by
23576 configuration options or in a transport filter. It may be necessary to increase
23577 this if a lot of text is added to messages.
23578
23579 Alternatively, if the value of &%size_addition%& is set negative, it disables
23580 the use of the SIZE option altogether.
23581
23582
23583 .option tls_certificate smtp string&!! unset
23584 .cindex "TLS" "client certificate, location of"
23585 .cindex "certificate" "client, location of"
23586 .vindex "&$host$&"
23587 .vindex "&$host_address$&"
23588 The value of this option must be the absolute path to a file which contains the
23589 client's certificate, for possible use when sending a message over an encrypted
23590 connection. The values of &$host$& and &$host_address$& are set to the name and
23591 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23592 details of TLS.
23593
23594 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23595 certificate when sending messages as a client. The global option of the same
23596 name specifies the certificate for Exim as a server; it is not automatically
23597 assumed that the same certificate should be used when Exim is operating as a
23598 client.
23599
23600
23601 .option tls_crl smtp string&!! unset
23602 .cindex "TLS" "client certificate revocation list"
23603 .cindex "certificate" "revocation list for client"
23604 This option specifies a certificate revocation list. The expanded value must
23605 be the name of a file that contains a CRL in PEM format.
23606
23607
23608 .option tls_dh_min_bits smtp integer 1024
23609 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23610 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23611 key agreement is negotiated, the server will provide a large prime number
23612 for use.  This option establishes the minimum acceptable size of that number.
23613 If the parameter offered by the server is too small, then the TLS handshake
23614 will fail.
23615
23616 Only supported when using GnuTLS.
23617
23618
23619 .option tls_privatekey smtp string&!! unset
23620 .cindex "TLS" "client private key, location of"
23621 .vindex "&$host$&"
23622 .vindex "&$host_address$&"
23623 The value of this option must be the absolute path to a file which contains the
23624 client's private key. This is used when sending a message over an encrypted
23625 connection using a client certificate. The values of &$host$& and
23626 &$host_address$& are set to the name and address of the server during the
23627 expansion. If this option is unset, or the expansion is forced to fail, or the
23628 result is an empty string, the private key is assumed to be in the same file as
23629 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23630
23631
23632 .option tls_require_ciphers smtp string&!! unset
23633 .cindex "TLS" "requiring specific ciphers"
23634 .cindex "cipher" "requiring specific"
23635 .vindex "&$host$&"
23636 .vindex "&$host_address$&"
23637 The value of this option must be a list of permitted cipher suites, for use
23638 when setting up an outgoing encrypted connection. (There is a global option of
23639 the same name for controlling incoming connections.) The values of &$host$& and
23640 &$host_address$& are set to the name and address of the server during the
23641 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23642 is used in different ways by OpenSSL and GnuTLS (see sections
23643 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23644 ciphers is a preference order.
23645
23646
23647
23648 .option tls_sni smtp string&!! unset
23649 .cindex "TLS" "Server Name Indication"
23650 .vindex "&$tls_sni$&"
23651 If this option is set then it sets the $tls_out_sni variable and causes any
23652 TLS session to pass this value as the Server Name Indication extension to
23653 the remote side, which can be used by the remote side to select an appropriate
23654 certificate and private key for the session.
23655
23656 See &<<SECTtlssni>>& for more information.
23657
23658 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23659 TLS extensions.
23660
23661
23662
23663
23664 .option tls_tempfail_tryclear smtp boolean true
23665 .cindex "4&'xx'& responses" "to STARTTLS"
23666 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23667 setting up a TLS session, this option determines whether or not Exim should try
23668 to deliver the message unencrypted. If it is set false, delivery to the
23669 current host is deferred; if there are other hosts, they are tried. If this
23670 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23671 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23672 TLS negotiation fails, Exim closes the current connection (because it is in an
23673 unknown state), opens a new one to the same host, and then tries the delivery
23674 in clear.
23675
23676
23677 .new
23678 .option tls_try_verify_hosts smtp "host list&!!" *
23679 .wen
23680 .cindex "TLS" "server certificate verification"
23681 .cindex "certificate" "verification of server"
23682 This option gives a list of hosts for which, on encrypted connections,
23683 certificate verification will be tried but need not succeed.
23684 The &%tls_verify_certificates%& option must also be set.
23685 Note that unless the host is in this list
23686 TLS connections will be denied to hosts using self-signed certificates
23687 when &%tls_verify_certificates%& is matched.
23688 The &$tls_out_certificate_verified$& variable is set when
23689 certificate verification succeeds.
23690
23691
23692 .new
23693 .option tls_verify_cert_hostnames smtp "host list&!!" *
23694 .cindex "TLS" "server certificate hostname verification"
23695 .cindex "certificate" "verification of server"
23696 This option give a list of hosts for which,
23697 while verifying the server certificate,
23698 checks will be included on the host name
23699 (note that this will generally be the result of a DNS MX lookup)
23700 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23701 limited to being the initial component of a 3-or-more component FQDN.
23702
23703 There is no equivalent checking on client certificates.
23704 .wen
23705
23706
23707 .new
23708 .option tls_verify_certificates smtp string&!! system
23709 .cindex "TLS" "server certificate verification"
23710 .cindex "certificate" "verification of server"
23711 .vindex "&$host$&"
23712 .vindex "&$host_address$&"
23713 The value of this option must be either the
23714 word "system"
23715 or the absolute path to
23716 a file or directory containing permitted certificates for servers,
23717 for use when setting up an encrypted connection.
23718
23719 The "system" value for the option will use a location compiled into the SSL library.
23720 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23721 is taken as empty and an explicit location
23722 must be specified.
23723
23724 The use of a directory for the option value is not avilable for GnuTLS versions
23725 preceding 3.3.6 and a single file must be used.
23726 .wen
23727
23728 With OpenSSL the certificates specified
23729 explicitly
23730 either by file or directory
23731 are added to those given by the system default location.
23732
23733 The values of &$host$& and
23734 &$host_address$& are set to the name and address of the server during the
23735 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23736
23737 For back-compatability,
23738 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23739 (a single-colon empty list counts as being set)
23740 and certificate verification fails the TLS connection is closed.
23741
23742
23743 .option tls_verify_hosts smtp "host list&!!" unset
23744 .cindex "TLS" "server certificate verification"
23745 .cindex "certificate" "verification of server"
23746 This option gives a list of hosts for which. on encrypted connections,
23747 certificate verification must succeed.
23748 The &%tls_verify_certificates%& option must also be set.
23749 If both this option and &%tls_try_verify_hosts%& are unset
23750 operation is as if this option selected all hosts.
23751
23752
23753
23754
23755 .section "How the limits for the number of hosts to try are used" &&&
23756          "SECTvalhosmax"
23757 .cindex "host" "maximum number to try"
23758 .cindex "limit" "hosts; maximum number tried"
23759 There are two options that are concerned with the number of hosts that are
23760 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23761 &%hosts_max_try_hardlimit%&.
23762
23763
23764 The &%hosts_max_try%& option limits the number of hosts that are tried
23765 for a single delivery. However, despite the term &"host"& in its name, the
23766 option actually applies to each IP address independently. In other words, a
23767 multihomed host is treated as several independent hosts, just as it is for
23768 retrying.
23769
23770 Many of the larger ISPs have multiple MX records which often point to
23771 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23772 created as a result of routing one of these domains.
23773
23774 Trying every single IP address on such a long list does not seem sensible; if
23775 several at the top of the list fail, it is reasonable to assume there is some
23776 problem that is likely to affect all of them. Roughly speaking, the value of
23777 &%hosts_max_try%& is the maximum number that are tried before deferring the
23778 delivery. However, the logic cannot be quite that simple.
23779
23780 Firstly, IP addresses that are skipped because their retry times have not
23781 arrived do not count, and in addition, addresses that are past their retry
23782 limits are also not counted, even when they are tried. This means that when
23783 some IP addresses are past their retry limits, more than the value of
23784 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23785 that all IP addresses are considered before timing out an email address (but
23786 see below for an exception).
23787
23788 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23789 list to see if there is a subsequent host with a different (higher valued) MX.
23790 If there is, that host is considered next, and the current IP address is used
23791 but not counted. This behaviour helps in the case of a domain with a retry rule
23792 that hardly ever delays any hosts, as is now explained:
23793
23794 Consider the case of a long list of hosts with one MX value, and a few with a
23795 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23796 hosts at the top of the list are tried at first. With the default retry rule,
23797 which specifies increasing retry times, the higher MX hosts are eventually
23798 tried when those at the top of the list are skipped because they have not
23799 reached their retry times.
23800
23801 However, it is common practice to put a fixed short retry time on domains for
23802 large ISPs, on the grounds that their servers are rarely down for very long.
23803 Unfortunately, these are exactly the domains that tend to resolve to long lists
23804 of hosts. The short retry time means that the lowest MX hosts are tried every
23805 time. The attempts may be in a different order because of random sorting, but
23806 without the special MX check, the higher MX hosts would never be tried until
23807 all the lower MX hosts had timed out (which might be several days), because
23808 there are always some lower MX hosts that have reached their retry times. With
23809 the special check, Exim considers at least one IP address from each MX value at
23810 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23811 reached.
23812
23813 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23814 particular, Exim normally eventually tries all the IP addresses before timing
23815 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23816 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23817 been set up with hundreds of IP addresses for some domains. It can
23818 take a very long time indeed for an address to time out in these cases.
23819
23820 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23821 Exim never tries more than this number of IP addresses; if it hits this limit
23822 and they are all timed out, the email address is bounced, even though not all
23823 possible IP addresses have been tried.
23824 .ecindex IIDsmttra1
23825 .ecindex IIDsmttra2
23826
23827
23828
23829
23830
23831 . ////////////////////////////////////////////////////////////////////////////
23832 . ////////////////////////////////////////////////////////////////////////////
23833
23834 .chapter "Address rewriting" "CHAPrewrite"
23835 .scindex IIDaddrew "rewriting" "addresses"
23836 There are some circumstances in which Exim automatically rewrites domains in
23837 addresses. The two most common are when an address is given without a domain
23838 (referred to as an &"unqualified address"&) or when an address contains an
23839 abbreviated domain that is expanded by DNS lookup.
23840
23841 Unqualified envelope addresses are accepted only for locally submitted
23842 messages, or for messages that are received from hosts matching
23843 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23844 appropriate. Unqualified addresses in header lines are qualified if they are in
23845 locally submitted messages, or messages from hosts that are permitted to send
23846 unqualified envelope addresses. Otherwise, unqualified addresses in header
23847 lines are neither qualified nor rewritten.
23848
23849 One situation in which Exim does &'not'& automatically rewrite a domain is
23850 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23851 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23852 do this. The new RFCs do not contain this suggestion.
23853
23854
23855 .section "Explicitly configured address rewriting" "SECID147"
23856 This chapter describes the rewriting rules that can be used in the
23857 main rewrite section of the configuration file, and also in the generic
23858 &%headers_rewrite%& option that can be set on any transport.
23859
23860 Some people believe that configured address rewriting is a Mortal Sin.
23861 Others believe that life is not possible without it. Exim provides the
23862 facility; you do not have to use it.
23863
23864 The main rewriting rules that appear in the &"rewrite"& section of the
23865 configuration file are applied to addresses in incoming messages, both envelope
23866 addresses and addresses in header lines. Each rule specifies the types of
23867 address to which it applies.
23868
23869 Whether or not addresses in header lines are rewritten depends on the origin of
23870 the headers and the type of rewriting. Global rewriting, that is, rewriting
23871 rules from the rewrite section of the configuration file, is applied only to
23872 those headers that were received with the message. Header lines that are added
23873 by ACLs or by a system filter or by individual routers or transports (which
23874 are specific to individual recipient addresses) are not rewritten by the global
23875 rules.
23876
23877 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23878 applies all headers except those added by routers and transports. That is, as
23879 well as the headers that were received with the message, it also applies to
23880 headers that were added by an ACL or a system filter.
23881
23882
23883 In general, rewriting addresses from your own system or domain has some
23884 legitimacy. Rewriting other addresses should be done only with great care and
23885 in special circumstances. The author of Exim believes that rewriting should be
23886 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23887 Although it can sometimes be used as a routing tool, this is very strongly
23888 discouraged.
23889
23890 There are two commonly encountered circumstances where rewriting is used, as
23891 illustrated by these examples:
23892
23893 .ilist
23894 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23895 exchange mail with each other behind a firewall, but there is only a single
23896 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23897 &'hitch.fict.example'& when sending mail off-site.
23898 .next
23899 A host rewrites the local parts of its own users so that, for example,
23900 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23901 .endlist
23902
23903
23904
23905 .section "When does rewriting happen?" "SECID148"
23906 .cindex "rewriting" "timing of"
23907 .cindex "&ACL;" "rewriting addresses in"
23908 Configured address rewriting can take place at several different stages of a
23909 message's processing.
23910
23911 .vindex "&$sender_address$&"
23912 At the start of an ACL for MAIL, the sender address may have been rewritten
23913 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23914 ordinary rewrite rules have yet been applied. If, however, the sender address
23915 is verified in the ACL, it is rewritten before verification, and remains
23916 rewritten thereafter. The subsequent value of &$sender_address$& is the
23917 rewritten address. This also applies if sender verification happens in a
23918 RCPT ACL. Otherwise, when the sender address is not verified, it is
23919 rewritten as soon as a message's header lines have been received.
23920
23921 .vindex "&$domain$&"
23922 .vindex "&$local_part$&"
23923 Similarly, at the start of an ACL for RCPT, the current recipient's address
23924 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23925 rewrite rules have yet been applied to it. However, the behaviour is different
23926 from the sender address when a recipient is verified. The address is rewritten
23927 for the verification, but the rewriting is not remembered at this stage. The
23928 value of &$local_part$& and &$domain$& after verification are always the same
23929 as they were before (that is, they contain the unrewritten &-- except for
23930 SMTP-time rewriting &-- address).
23931
23932 As soon as a message's header lines have been received, all the envelope
23933 recipient addresses are permanently rewritten, and rewriting is also applied to
23934 the addresses in the header lines (if configured). This happens before adding
23935 any header lines that were specified in MAIL or RCPT ACLs, and
23936 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23937 before the DATA ACL and &[local_scan()]& functions are run.
23938
23939 When an address is being routed, either for delivery or for verification,
23940 rewriting is applied immediately to child addresses that are generated by
23941 redirection, unless &%no_rewrite%& is set on the router.
23942
23943 .cindex "envelope sender" "rewriting at transport time"
23944 .cindex "rewriting" "at transport time"
23945 .cindex "header lines" "rewriting at transport time"
23946 At transport time, additional rewriting of addresses in header lines can be
23947 specified by setting the generic &%headers_rewrite%& option on a transport.
23948 This option contains rules that are identical in form to those in the rewrite
23949 section of the configuration file. They are applied to the original message
23950 header lines and any that were added by ACLs or a system filter. They are not
23951 applied to header lines that are added by routers or the transport.
23952
23953 The outgoing envelope sender can be rewritten by means of the &%return_path%&
23954 transport option. However, it is not possible to rewrite envelope recipients at
23955 transport time.
23956
23957
23958
23959
23960 .section "Testing the rewriting rules that apply on input" "SECID149"
23961 .cindex "rewriting" "testing"
23962 .cindex "testing" "rewriting"
23963 Exim's input rewriting configuration appears in a part of the run time
23964 configuration file headed by &"begin rewrite"&. It can be tested by the
23965 &%-brw%& command line option. This takes an address (which can be a full RFC
23966 2822 address) as its argument. The output is a list of how the address would be
23967 transformed by the rewriting rules for each of the different places it might
23968 appear in an incoming message, that is, for each different header and for the
23969 envelope sender and recipient fields. For example,
23970 .code
23971 exim -brw ph10@exim.workshop.example
23972 .endd
23973 might produce the output
23974 .code
23975 sender: Philip.Hazel@exim.workshop.example
23976 from: Philip.Hazel@exim.workshop.example
23977 to: ph10@exim.workshop.example
23978 cc: ph10@exim.workshop.example
23979 bcc: ph10@exim.workshop.example
23980 reply-to: Philip.Hazel@exim.workshop.example
23981 env-from: Philip.Hazel@exim.workshop.example
23982 env-to: ph10@exim.workshop.example
23983 .endd
23984 which shows that rewriting has been set up for that address when used in any of
23985 the source fields, but not when it appears as a recipient address. At the
23986 present time, there is no equivalent way of testing rewriting rules that are
23987 set for a particular transport.
23988
23989
23990 .section "Rewriting rules" "SECID150"
23991 .cindex "rewriting" "rules"
23992 The rewrite section of the configuration file consists of lines of rewriting
23993 rules in the form
23994 .display
23995 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
23996 .endd
23997 Rewriting rules that are specified for the &%headers_rewrite%& generic
23998 transport option are given as a colon-separated list. Each item in the list
23999 takes the same form as a line in the main rewriting configuration (except that
24000 any colons must be doubled, of course).
24001
24002 The formats of source patterns and replacement strings are described below.
24003 Each is terminated by white space, unless enclosed in double quotes, in which
24004 case normal quoting conventions apply inside the quotes. The flags are single
24005 characters which may appear in any order. Spaces and tabs between them are
24006 ignored.
24007
24008 For each address that could potentially be rewritten, the rules are scanned in
24009 order, and replacements for the address from earlier rules can themselves be
24010 replaced by later rules (but see the &"q"& and &"R"& flags).
24011
24012 The order in which addresses are rewritten is undefined, may change between
24013 releases, and must not be relied on, with one exception: when a message is
24014 received, the envelope sender is always rewritten first, before any header
24015 lines are rewritten. For example, the replacement string for a rewrite of an
24016 address in &'To:'& must not assume that the message's address in &'From:'& has
24017 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24018 that the envelope sender has already been rewritten.
24019
24020 .vindex "&$domain$&"
24021 .vindex "&$local_part$&"
24022 The variables &$local_part$& and &$domain$& can be used in the replacement
24023 string to refer to the address that is being rewritten. Note that lookup-driven
24024 rewriting can be done by a rule of the form
24025 .code
24026 *@*   ${lookup ...
24027 .endd
24028 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24029 refer to the address that is being rewritten.
24030
24031
24032 .section "Rewriting patterns" "SECID151"
24033 .cindex "rewriting" "patterns"
24034 .cindex "address list" "in a rewriting pattern"
24035 The source pattern in a rewriting rule is any item which may appear in an
24036 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24037 single-item address list, which means that it is expanded before being tested
24038 against the address. As always, if you use a regular expression as a pattern,
24039 you must take care to escape dollar and backslash characters, or use the &`\N`&
24040 facility to suppress string expansion within the regular expression.
24041
24042 Domains in patterns should be given in lower case. Local parts in patterns are
24043 case-sensitive. If you want to do case-insensitive matching of local parts, you
24044 can use a regular expression that starts with &`^(?i)`&.
24045
24046 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24047 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24048 depending on the type of match which occurred. These can be used in the
24049 replacement string to insert portions of the incoming address. &$0$& always
24050 refers to the complete incoming address. When a regular expression is used, the
24051 numerical variables are set from its capturing subexpressions. For other types
24052 of pattern they are set as follows:
24053
24054 .ilist
24055 If a local part or domain starts with an asterisk, the numerical variables
24056 refer to the character strings matched by asterisks, with &$1$& associated with
24057 the first asterisk, and &$2$& with the second, if present. For example, if the
24058 pattern
24059 .code
24060 *queen@*.fict.example
24061 .endd
24062 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24063 .code
24064 $0 = hearts-queen@wonderland.fict.example
24065 $1 = hearts-
24066 $2 = wonderland
24067 .endd
24068 Note that if the local part does not start with an asterisk, but the domain
24069 does, it is &$1$& that contains the wild part of the domain.
24070
24071 .next
24072 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24073 of the domain are placed in the next available numerical variables. Suppose,
24074 for example, that the address &'foo@bar.baz.example'& is processed by a
24075 rewriting rule of the form
24076 .display
24077 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24078 .endd
24079 and the key in the file that matches the domain is &`*.baz.example`&. Then
24080 .code
24081 $1 = foo
24082 $2 = bar
24083 $3 = baz.example
24084 .endd
24085 If the address &'foo@baz.example'& is looked up, this matches the same
24086 wildcard file entry, and in this case &$2$& is set to the empty string, but
24087 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24088 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24089 whole domain. For non-partial domain lookups, no numerical variables are set.
24090 .endlist
24091
24092
24093 .section "Rewriting replacements" "SECID152"
24094 .cindex "rewriting" "replacements"
24095 If the replacement string for a rule is a single asterisk, addresses that
24096 match the pattern and the flags are &'not'& rewritten, and no subsequent
24097 rewriting rules are scanned. For example,
24098 .code
24099 hatta@lookingglass.fict.example  *  f
24100 .endd
24101 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24102 &'From:'& headers.
24103
24104 .vindex "&$domain$&"
24105 .vindex "&$local_part$&"
24106 If the replacement string is not a single asterisk, it is expanded, and must
24107 yield a fully qualified address. Within the expansion, the variables
24108 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24109 Any letters they contain retain their original case &-- they are not lower
24110 cased. The numerical variables are set up according to the type of pattern that
24111 matched the address, as described above. If the expansion is forced to fail by
24112 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24113 current rule is abandoned, but subsequent rules may take effect. Any other
24114 expansion failure causes the entire rewriting operation to be abandoned, and an
24115 entry written to the panic log.
24116
24117
24118
24119 .section "Rewriting flags" "SECID153"
24120 There are three different kinds of flag that may appear on rewriting rules:
24121
24122 .ilist
24123 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24124 c, f, h, r, s, t.
24125 .next
24126 A flag that specifies rewriting at SMTP time: S.
24127 .next
24128 Flags that control the rewriting process: Q, q, R, w.
24129 .endlist
24130
24131 For rules that are part of the &%headers_rewrite%& generic transport option,
24132 E, F, T, and S are not permitted.
24133
24134
24135
24136 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24137          "SECID154"
24138 .cindex "rewriting" "flags"
24139 If none of the following flag letters, nor the &"S"& flag (see section
24140 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24141 and to both the sender and recipient fields of the envelope, whereas a
24142 transport-time rewriting rule just applies to all headers. Otherwise, the
24143 rewriting rule is skipped unless the relevant addresses are being processed.
24144 .display
24145 &`E`&       rewrite all envelope fields
24146 &`F`&       rewrite the envelope From field
24147 &`T`&       rewrite the envelope To field
24148 &`b`&       rewrite the &'Bcc:'& header
24149 &`c`&       rewrite the &'Cc:'& header
24150 &`f`&       rewrite the &'From:'& header
24151 &`h`&       rewrite all headers
24152 &`r`&       rewrite the &'Reply-To:'& header
24153 &`s`&       rewrite the &'Sender:'& header
24154 &`t`&       rewrite the &'To:'& header
24155 .endd
24156 "All headers" means all of the headers listed above that can be selected
24157 individually, plus their &'Resent-'& versions. It does not include
24158 other headers such as &'Subject:'& etc.
24159
24160 You should be particularly careful about rewriting &'Sender:'& headers, and
24161 restrict this to special known cases in your own domains.
24162
24163
24164 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24165 .cindex "SMTP" "rewriting malformed addresses"
24166 .cindex "RCPT" "rewriting argument of"
24167 .cindex "MAIL" "rewriting argument of"
24168 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24169 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24170 before any other processing; even before syntax checking. The pattern is
24171 required to be a regular expression, and it is matched against the whole of the
24172 data for the command, including any surrounding angle brackets.
24173
24174 .vindex "&$domain$&"
24175 .vindex "&$local_part$&"
24176 This form of rewrite rule allows for the handling of addresses that are not
24177 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24178 input). Because the input is not required to be a syntactically valid address,
24179 the variables &$local_part$& and &$domain$& are not available during the
24180 expansion of the replacement string. The result of rewriting replaces the
24181 original address in the MAIL or RCPT command.
24182
24183
24184 .section "Flags controlling the rewriting process" "SECID155"
24185 There are four flags which control the way the rewriting process works. These
24186 take effect only when a rule is invoked, that is, when the address is of the
24187 correct type (matches the flags) and matches the pattern:
24188
24189 .ilist
24190 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24191 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24192 absence of &"Q"& the rewritten address must always include a domain.
24193 .next
24194 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24195 even if no rewriting actually takes place because of a &"fail"& in the
24196 expansion. The &"q"& flag is not effective if the address is of the wrong type
24197 (does not match the flags) or does not match the pattern.
24198 .next
24199 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24200 address, up to ten times. It can be combined with the &"q"& flag, to stop
24201 rewriting once it fails to match (after at least one successful rewrite).
24202 .next
24203 .cindex "rewriting" "whole addresses"
24204 When an address in a header is rewritten, the rewriting normally applies only
24205 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24206 left unchanged. For example, rewriting might change
24207 .code
24208 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24209 .endd
24210 into
24211 .code
24212 From: Ford Prefect <prefectf@hitch.fict.example>
24213 .endd
24214 .cindex "RFC 2047"
24215 Sometimes there is a need to replace the whole address item, and this can be
24216 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24217 causes an address in a header line to be rewritten, the entire address is
24218 replaced, not just the working part. The replacement must be a complete RFC
24219 2822 address, including the angle brackets if necessary. If text outside angle
24220 brackets contains a character whose value is greater than 126 or less than 32
24221 (except for tab), the text is encoded according to RFC 2047. The character set
24222 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24223
24224 When the &"w"& flag is set on a rule that causes an envelope address to be
24225 rewritten, all but the working part of the replacement address is discarded.
24226 .endlist
24227
24228
24229 .section "Rewriting examples" "SECID156"
24230 Here is an example of the two common rewriting paradigms:
24231 .code
24232 *@*.hitch.fict.example  $1@hitch.fict.example
24233 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24234                      {$value}fail}@hitch.fict.example bctfrF
24235 .endd
24236 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24237 the string expansion to fail if the lookup does not succeed. In this context it
24238 has the effect of leaving the original address unchanged, but Exim goes on to
24239 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24240 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24241 explicitly, which would cause the rewritten address to be the same as before,
24242 at the cost of a small bit of processing. Not supplying either of these is an
24243 error, since the rewritten address would then contain no local part.
24244
24245 The first example above replaces the domain with a superior, more general
24246 domain. This may not be desirable for certain local parts. If the rule
24247 .code
24248 root@*.hitch.fict.example  *
24249 .endd
24250 were inserted before the first rule, rewriting would be suppressed for the
24251 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24252
24253 Rewriting can be made conditional on a number of tests, by making use of
24254 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24255 messages that originate outside the local host:
24256 .code
24257 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24258                          {$1@hitch.fict.example}fail}"
24259 .endd
24260 The replacement string is quoted in this example because it contains white
24261 space.
24262
24263 .cindex "rewriting" "bang paths"
24264 .cindex "bang paths" "rewriting"
24265 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24266 an address it treats it as an unqualified local part which it qualifies with
24267 the local qualification domain (if the source of the message is local or if the
24268 remote host is permitted to send unqualified addresses). Rewriting can
24269 sometimes be used to handle simple bang paths with a fixed number of
24270 components. For example, the rule
24271 .code
24272 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24273 .endd
24274 rewrites a two-component bang path &'host.name!user'& as the domain address
24275 &'user@host.name'&. However, there is a security implication in using this as
24276 a global rewriting rule for envelope addresses. It can provide a backdoor
24277 method for using your system as a relay, because the incoming addresses appear
24278 to be local. If the bang path addresses are received via SMTP, it is safer to
24279 use the &"S"& flag to rewrite them as they are received, so that relay checking
24280 can be done on the rewritten addresses.
24281 .ecindex IIDaddrew
24282
24283
24284
24285
24286
24287 . ////////////////////////////////////////////////////////////////////////////
24288 . ////////////////////////////////////////////////////////////////////////////
24289
24290 .chapter "Retry configuration" "CHAPretry"
24291 .scindex IIDretconf1 "retry" "configuration, description of"
24292 .scindex IIDregconf2 "configuration file" "retry section"
24293 The &"retry"& section of the runtime configuration file contains a list of
24294 retry rules that control how often Exim tries to deliver messages that cannot
24295 be delivered at the first attempt. If there are no retry rules (the section is
24296 empty or not present), there are no retries. In this situation, temporary
24297 errors are treated as permanent. The default configuration contains a single,
24298 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24299 line option can be used to test which retry rule will be used for a given
24300 address, domain and error.
24301
24302 The most common cause of retries is temporary failure to deliver to a remote
24303 host because the host is down, or inaccessible because of a network problem.
24304 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24305 address) basis, not on a per-message basis. Thus, if one message has recently
24306 been delayed, delivery of a new message to the same host is not immediately
24307 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24308 log selector is set, the message
24309 .cindex "retry" "time not reached"
24310 &"retry time not reached"& is written to the main log whenever a delivery is
24311 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24312 the handling of errors during remote deliveries.
24313
24314 Retry processing applies to routing as well as to delivering, except as covered
24315 in the next paragraph. The retry rules do not distinguish between these
24316 actions. It is not possible, for example, to specify different behaviour for
24317 failures to route the domain &'snark.fict.example'& and failures to deliver to
24318 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24319 added complication, so did not implement it. However, although they share the
24320 same retry rule, the actual retry times for routing and transporting a given
24321 domain are maintained independently.
24322
24323 When a delivery is not part of a queue run (typically an immediate delivery on
24324 receipt of a message), the routers are always run, and local deliveries are
24325 always attempted, even if retry times are set for them. This makes for better
24326 behaviour if one particular message is causing problems (for example, causing
24327 quota overflow, or provoking an error in a filter file). If such a delivery
24328 suffers a temporary failure, the retry data is updated as normal, and
24329 subsequent delivery attempts from queue runs occur only when the retry time for
24330 the local address is reached.
24331
24332 .section "Changing retry rules" "SECID157"
24333 If you change the retry rules in your configuration, you should consider
24334 whether or not to delete the retry data that is stored in Exim's spool area in
24335 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24336 always safe; that is why they are called &"hints"&.
24337
24338 The hints retry data contains suggested retry times based on the previous
24339 rules. In the case of a long-running problem with a remote host, it might
24340 record the fact that the host has timed out. If your new rules increase the
24341 timeout time for such a host, you should definitely remove the old retry data
24342 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24343 messages that it should now be retaining.
24344
24345
24346
24347 .section "Format of retry rules" "SECID158"
24348 .cindex "retry" "rules"
24349 Each retry rule occupies one line and consists of three or four parts,
24350 separated by white space: a pattern, an error name, an optional list of sender
24351 addresses, and a list of retry parameters. The pattern and sender lists must be
24352 enclosed in double quotes if they contain white space. The rules are searched
24353 in order until one is found where the pattern, error name, and sender list (if
24354 present) match the failing host or address, the error that occurred, and the
24355 message's sender, respectively.
24356
24357
24358 The pattern is any single item that may appear in an address list (see section
24359 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24360 which means that it is expanded before being tested against the address that
24361 has been delayed. A negated address list item is permitted. Address
24362 list processing treats a plain domain name as if it were preceded by &"*@"&,
24363 which makes it possible for many retry rules to start with just a domain. For
24364 example,
24365 .code
24366 lookingglass.fict.example        *  F,24h,30m;
24367 .endd
24368 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24369 whereas
24370 .code
24371 alice@lookingglass.fict.example  *  F,24h,30m;
24372 .endd
24373 applies only to temporary failures involving the local part &%alice%&.
24374 In practice, almost all rules start with a domain name pattern without a local
24375 part.
24376
24377 .cindex "regular expressions" "in retry rules"
24378 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24379 must match a complete address, not just a domain, because that is how regular
24380 expressions work in address lists.
24381 .display
24382 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24383 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24384 .endd
24385
24386
24387 .section "Choosing which retry rule to use for address errors" "SECID159"
24388 When Exim is looking for a retry rule after a routing attempt has failed (for
24389 example, after a DNS timeout), each line in the retry configuration is tested
24390 against the complete address only if &%retry_use_local_part%& is set for the
24391 router. Otherwise, only the domain is used, except when matching against a
24392 regular expression, when the local part of the address is replaced with &"*"&.
24393 A domain on its own can match a domain pattern, or a pattern that starts with
24394 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24395 &%check_local_user%& is true, and false for other routers.
24396
24397 Similarly, when Exim is looking for a retry rule after a local delivery has
24398 failed (for example, after a mailbox full error), each line in the retry
24399 configuration is tested against the complete address only if
24400 &%retry_use_local_part%& is set for the transport (it defaults true for all
24401 local transports).
24402
24403 .cindex "4&'xx'& responses" "retry rules for"
24404 However, when Exim is looking for a retry rule after a remote delivery attempt
24405 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24406 whole address is always used as the key when searching the retry rules. The
24407 rule that is found is used to create a retry time for the combination of the
24408 failing address and the message's sender. It is the combination of sender and
24409 recipient that is delayed in subsequent queue runs until its retry time is
24410 reached. You can delay the recipient without regard to the sender by setting
24411 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24412 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24413 commands.
24414
24415
24416
24417 .section "Choosing which retry rule to use for host and message errors" &&&
24418          "SECID160"
24419 For a temporary error that is not related to an individual address (for
24420 example, a connection timeout), each line in the retry configuration is checked
24421 twice. First, the name of the remote host is used as a domain name (preceded by
24422 &"*@"& when matching a regular expression). If this does not match the line,
24423 the domain from the email address is tried in a similar fashion. For example,
24424 suppose the MX records for &'a.b.c.example'& are
24425 .code
24426 a.b.c.example  MX  5  x.y.z.example
24427                MX  6  p.q.r.example
24428                MX  7  m.n.o.example
24429 .endd
24430 and the retry rules are
24431 .code
24432 p.q.r.example    *      F,24h,30m;
24433 a.b.c.example    *      F,4d,45m;
24434 .endd
24435 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24436 first rule matches neither the host nor the domain, so Exim looks at the second
24437 rule. This does not match the host, but it does match the domain, so it is used
24438 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24439 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24440 first retry rule is used, because it matches the host.
24441
24442 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24443 first rule to determine retry times, but for all the other hosts for the domain
24444 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24445 routing to &'a.b.c.example'& suffers a temporary failure.
24446
24447 &*Note*&: The host name is used when matching the patterns, not its IP address.
24448 However, if a message is routed directly to an IP address without the use of a
24449 host name, for example, if a &(manualroute)& router contains a setting such as:
24450 .code
24451 route_list = *.a.example  192.168.34.23
24452 .endd
24453 then the &"host name"& that is used when searching for a retry rule is the
24454 textual form of the IP address.
24455
24456 .section "Retry rules for specific errors" "SECID161"
24457 .cindex "retry" "specific errors; specifying"
24458 The second field in a retry rule is the name of a particular error, or an
24459 asterisk, which matches any error. The errors that can be tested for are:
24460
24461 .vlist
24462 .vitem &%auth_failed%&
24463 Authentication failed when trying to send to a host in the
24464 &%hosts_require_auth%& list in an &(smtp)& transport.
24465
24466 .vitem &%data_4xx%&
24467 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24468 after the command, or after sending the message's data.
24469
24470 .vitem &%mail_4xx%&
24471 A 4&'xx'& error was received for an outgoing MAIL command.
24472
24473 .vitem &%rcpt_4xx%&
24474 A 4&'xx'& error was received for an outgoing RCPT command.
24475 .endlist
24476
24477 For the three 4&'xx'& errors, either the first or both of the x's can be given
24478 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24479 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24480 and have retries every ten minutes with a one-hour timeout, you could set up a
24481 retry rule of this form:
24482 .code
24483 the.domain.name  rcpt_452   F,1h,10m
24484 .endd
24485 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24486 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24487
24488 .vlist
24489 .vitem &%lost_connection%&
24490 A server unexpectedly closed the SMTP connection. There may, of course,
24491 legitimate reasons for this (host died, network died), but if it repeats a lot
24492 for the same host, it indicates something odd.
24493
24494 .vitem &%lookup%&
24495 A DNS lookup for a host failed.
24496 Note that a &%dnslookup%& router will need to have matched
24497 its &%fail_defer_domains%& option for this retry type to be usable.
24498 Also note that a &%manualroute%& router will probably need
24499 its &%host_find_failed%& option set to &%defer%&.
24500
24501 .vitem &%refused_MX%&
24502 A connection to a host obtained from an MX record was refused.
24503
24504 .vitem &%refused_A%&
24505 A connection to a host not obtained from an MX record was refused.
24506
24507 .vitem &%refused%&
24508 A connection was refused.
24509
24510 .vitem &%timeout_connect_MX%&
24511 A connection attempt to a host obtained from an MX record timed out.
24512
24513 .vitem &%timeout_connect_A%&
24514 A connection attempt to a host not obtained from an MX record timed out.
24515
24516 .vitem &%timeout_connect%&
24517 A connection attempt timed out.
24518
24519 .vitem &%timeout_MX%&
24520 There was a timeout while connecting or during an SMTP session with a host
24521 obtained from an MX record.
24522
24523 .vitem &%timeout_A%&
24524 There was a timeout while connecting or during an SMTP session with a host not
24525 obtained from an MX record.
24526
24527 .vitem &%timeout%&
24528 There was a timeout while connecting or during an SMTP session.
24529
24530 .vitem &%tls_required%&
24531 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24532 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24533 to STARTTLS, or there was a problem setting up the TLS connection.
24534
24535 .vitem &%quota%&
24536 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24537 transport.
24538
24539 .vitem &%quota_%&<&'time'&>
24540 .cindex "quota" "error testing in retry rule"
24541 .cindex "retry" "quota error testing"
24542 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24543 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24544 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24545 for four days.
24546 .endlist
24547
24548 .cindex "mailbox" "time of last read"
24549 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24550 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24551 it should be based on the last time that the user accessed the mailbox.
24552 However, it is not always possible to determine this. Exim uses the following
24553 heuristic rules:
24554
24555 .ilist
24556 If the mailbox is a single file, the time of last access (the &"atime"&) is
24557 used. As no new messages are being delivered (because the mailbox is over
24558 quota), Exim does not access the file, so this is the time of last user access.
24559 .next
24560 .cindex "maildir format" "time of last read"
24561 For a maildir delivery, the time of last modification of the &_new_&
24562 subdirectory is used. As the mailbox is over quota, no new files are created in
24563 the &_new_& subdirectory, because no new messages are being delivered. Any
24564 change to the &_new_& subdirectory is therefore assumed to be the result of an
24565 MUA moving a new message to the &_cur_& directory when it is first read. The
24566 time that is used is therefore the last time that the user read a new message.
24567 .next
24568 For other kinds of multi-file mailbox, the time of last access cannot be
24569 obtained, so a retry rule that uses this type of error field is never matched.
24570 .endlist
24571
24572 The quota errors apply both to system-enforced quotas and to Exim's own quota
24573 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24574 when a local delivery is deferred because a partition is full (the ENOSPC
24575 error).
24576
24577
24578
24579 .section "Retry rules for specified senders" "SECID162"
24580 .cindex "retry" "rules; sender-specific"
24581 You can specify retry rules that apply only when the failing message has a
24582 specific sender. In particular, this can be used to define retry rules that
24583 apply only to bounce messages. The third item in a retry rule can be of this
24584 form:
24585 .display
24586 &`senders=`&<&'address list'&>
24587 .endd
24588 The retry timings themselves are then the fourth item. For example:
24589 .code
24590 *   rcpt_4xx   senders=:   F,1h,30m
24591 .endd
24592 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24593 host. If the address list contains white space, it must be enclosed in quotes.
24594 For example:
24595 .code
24596 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24597 .endd
24598 &*Warning*&: This facility can be unhelpful if it is used for host errors
24599 (which do not depend on the recipient). The reason is that the sender is used
24600 only to match the retry rule. Once the rule has been found for a host error,
24601 its contents are used to set a retry time for the host, and this will apply to
24602 all messages, not just those with specific senders.
24603
24604 When testing retry rules using &%-brt%&, you can supply a sender using the
24605 &%-f%& command line option, like this:
24606 .code
24607 exim -f "" -brt user@dom.ain
24608 .endd
24609 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24610 list is never matched.
24611
24612
24613
24614
24615
24616 .section "Retry parameters" "SECID163"
24617 .cindex "retry" "parameters in rules"
24618 The third (or fourth, if a senders list is present) field in a retry rule is a
24619 sequence of retry parameter sets, separated by semicolons. Each set consists of
24620 .display
24621 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24622 .endd
24623 The letter identifies the algorithm for computing a new retry time; the cutoff
24624 time is the time beyond which this algorithm no longer applies, and the
24625 arguments vary the algorithm's action. The cutoff time is measured from the
24626 time that the first failure for the domain (combined with the local part if
24627 relevant) was detected, not from the time the message was received.
24628
24629 .cindex "retry" "algorithms"
24630 .cindex "retry" "fixed intervals"
24631 .cindex "retry" "increasing intervals"
24632 .cindex "retry" "random intervals"
24633 The available algorithms are:
24634
24635 .ilist
24636 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24637 the interval.
24638 .next
24639 &'G'&: retry at geometrically increasing intervals. The first argument
24640 specifies a starting value for the interval, and the second a multiplier, which
24641 is used to increase the size of the interval at each retry.
24642 .next
24643 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24644 retry, the previous interval is multiplied by the factor in order to get a
24645 maximum for the next interval. The minimum interval is the first argument of
24646 the parameter, and an actual interval is chosen randomly between them. Such a
24647 rule has been found to be helpful in cluster configurations when all the
24648 members of the cluster restart at once, and may therefore synchronize their
24649 queue processing times.
24650 .endlist
24651
24652 When computing the next retry time, the algorithm definitions are scanned in
24653 order until one whose cutoff time has not yet passed is reached. This is then
24654 used to compute a new retry time that is later than the current time. In the
24655 case of fixed interval retries, this simply means adding the interval to the
24656 current time. For geometrically increasing intervals, retry intervals are
24657 computed from the rule's parameters until one that is greater than the previous
24658 interval is found. The main configuration variable
24659 .cindex "limit" "retry interval"
24660 .cindex "retry" "interval, maximum"
24661 .oindex "&%retry_interval_max%&"
24662 &%retry_interval_max%& limits the maximum interval between retries. It
24663 cannot be set greater than &`24h`&, which is its default value.
24664
24665 A single remote domain may have a number of hosts associated with it, and each
24666 host may have more than one IP address. Retry algorithms are selected on the
24667 basis of the domain name, but are applied to each IP address independently. If,
24668 for example, a host has two IP addresses and one is unusable, Exim will
24669 generate retry times for it and will not try to use it until its next retry
24670 time comes. Thus the good IP address is likely to be tried first most of the
24671 time.
24672
24673 .cindex "hints database" "use for retrying"
24674 Retry times are hints rather than promises. Exim does not make any attempt to
24675 run deliveries exactly at the computed times. Instead, a queue runner process
24676 starts delivery processes for delayed messages periodically, and these attempt
24677 new deliveries only for those addresses that have passed their next retry time.
24678 If a new message arrives for a deferred address, an immediate delivery attempt
24679 occurs only if the address has passed its retry time. In the absence of new
24680 messages, the minimum time between retries is the interval between queue runner
24681 processes. There is not much point in setting retry times of five minutes if
24682 your queue runners happen only once an hour, unless there are a significant
24683 number of incoming messages (which might be the case on a system that is
24684 sending everything to a smart host, for example).
24685
24686 The data in the retry hints database can be inspected by using the
24687 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24688 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24689 &'exinext'& utility script can be used to find out what the next retry times
24690 are for the hosts associated with a particular mail domain, and also for local
24691 deliveries that have been deferred.
24692
24693
24694 .section "Retry rule examples" "SECID164"
24695 Here are some example retry rules:
24696 .code
24697 alice@wonderland.fict.example quota_5d  F,7d,3h
24698 wonderland.fict.example       quota_5d
24699 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24700 lookingglass.fict.example     *         F,24h,30m;
24701 *                 refused_A   F,2h,20m;
24702 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24703 .endd
24704 The first rule sets up special handling for mail to
24705 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24706 mailbox has not been read for at least 5 days. Retries continue every three
24707 hours for 7 days. The second rule handles over-quota errors for all other local
24708 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24709 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24710 fail are bounced immediately if the mailbox has not been read for at least 5
24711 days.
24712
24713 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24714 happen every 15 minutes for an hour, then with geometrically increasing
24715 intervals until two days have passed since a delivery first failed. After the
24716 first hour there is a delay of one hour, then two hours, then four hours, and
24717 so on (this is a rather extreme example).
24718
24719 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24720 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24721 all other domains, with special action for connection refusal from hosts that
24722 were not obtained from an MX record.
24723
24724 The final rule in a retry configuration should always have asterisks in the
24725 first two fields so as to provide a general catch-all for any addresses that do
24726 not have their own special handling. This example tries every 15 minutes for 2
24727 hours, then with intervals starting at one hour and increasing by a factor of
24728 1.5 up to 16 hours, then every 8 hours up to 5 days.
24729
24730
24731
24732 .section "Timeout of retry data" "SECID165"
24733 .cindex "timeout" "of retry data"
24734 .oindex "&%retry_data_expire%&"
24735 .cindex "hints database" "data expiry"
24736 .cindex "retry" "timeout of data"
24737 Exim timestamps the data that it writes to its retry hints database. When it
24738 consults the data during a delivery it ignores any that is older than the value
24739 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24740 been tried for 7 days, Exim will try to deliver to it immediately a message
24741 arrives, and if that fails, it will calculate a retry time as if it were
24742 failing for the first time.
24743
24744 This improves the behaviour for messages routed to rarely-used hosts such as MX
24745 backups. If such a host was down at one time, and happens to be down again when
24746 Exim tries a month later, using the old retry data would imply that it had been
24747 down all the time, which is not a justified assumption.
24748
24749 If a host really is permanently dead, this behaviour causes a burst of retries
24750 every now and again, but only if messages routed to it are rare. If there is a
24751 message at least once every 7 days the retry data never expires.
24752
24753
24754
24755
24756 .section "Long-term failures" "SECID166"
24757 .cindex "delivery failure, long-term"
24758 .cindex "retry" "after long-term failure"
24759 Special processing happens when an email address has been failing for so long
24760 that the cutoff time for the last algorithm is reached. For example, using the
24761 default retry rule:
24762 .code
24763 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24764 .endd
24765 the cutoff time is four days. Reaching the retry cutoff is independent of how
24766 long any specific message has been failing; it is the length of continuous
24767 failure for the recipient address that counts.
24768
24769 When the cutoff time is reached for a local delivery, or for all the IP
24770 addresses associated with a remote delivery, a subsequent delivery failure
24771 causes Exim to give up on the address, and a bounce message is generated.
24772 In order to cater for new messages that use the failing address, a next retry
24773 time is still computed from the final algorithm, and is used as follows:
24774
24775 For local deliveries, one delivery attempt is always made for any subsequent
24776 messages. If this delivery fails, the address fails immediately. The
24777 post-cutoff retry time is not used.
24778
24779 If the delivery is remote, there are two possibilities, controlled by the
24780 .oindex "&%delay_after_cutoff%&"
24781 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24782 default. Until the post-cutoff retry time for one of the IP addresses is
24783 reached, the failing email address is bounced immediately, without a delivery
24784 attempt taking place. After that time, one new delivery attempt is made to
24785 those IP addresses that are past their retry times, and if that still fails,
24786 the address is bounced and new retry times are computed.
24787
24788 In other words, when all the hosts for a given email address have been failing
24789 for a long time, Exim bounces rather then defers until one of the hosts' retry
24790 times is reached. Then it tries once, and bounces if that attempt fails. This
24791 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24792 to a broken destination, but if the host does recover, Exim will eventually
24793 notice.
24794
24795 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24796 addresses are past their final cutoff time, Exim tries to deliver to those IP
24797 addresses that have not been tried since the message arrived. If there are
24798 no suitable IP addresses, or if they all fail, the address is bounced. In other
24799 words, it does not delay when a new message arrives, but tries the expired
24800 addresses immediately, unless they have been tried since the message arrived.
24801 If there is a continuous stream of messages for the failing domains, setting
24802 &%delay_after_cutoff%& false means that there will be many more attempts to
24803 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24804 true.
24805
24806 .section "Deliveries that work intermittently" "SECID167"
24807 .cindex "retry" "intermittently working deliveries"
24808 Some additional logic is needed to cope with cases where a host is
24809 intermittently available, or when a message has some attribute that prevents
24810 its delivery when others to the same address get through. In this situation,
24811 because some messages are successfully delivered, the &"retry clock"& for the
24812 host or address keeps getting reset by the successful deliveries, and so
24813 failing messages remain on the queue for ever because the cutoff time is never
24814 reached.
24815
24816 Two exceptional actions are applied to prevent this happening. The first
24817 applies to errors that are related to a message rather than a remote host.
24818 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24819 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24820 commands, and quota failures. For this type of error, if a message's arrival
24821 time is earlier than the &"first failed"& time for the error, the earlier time
24822 is used when scanning the retry rules to decide when to try next and when to
24823 time out the address.
24824
24825 The exceptional second action applies in all cases. If a message has been on
24826 the queue for longer than the cutoff time of any applicable retry rule for a
24827 given address, a delivery is attempted for that address, even if it is not yet
24828 time, and if this delivery fails, the address is timed out. A new retry time is
24829 not computed in this case, so that other messages for the same address are
24830 considered immediately.
24831 .ecindex IIDretconf1
24832 .ecindex IIDregconf2
24833
24834
24835
24836
24837
24838
24839 . ////////////////////////////////////////////////////////////////////////////
24840 . ////////////////////////////////////////////////////////////////////////////
24841
24842 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24843 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24844 .scindex IIDauthconf2 "authentication"
24845 The &"authenticators"& section of Exim's run time configuration is concerned
24846 with SMTP authentication. This facility is an extension to the SMTP protocol,
24847 described in RFC 2554, which allows a client SMTP host to authenticate itself
24848 to a server. This is a common way for a server to recognize clients that are
24849 permitted to use it as a relay. SMTP authentication is not of relevance to the
24850 transfer of mail between servers that have no managerial connection with each
24851 other.
24852
24853 .cindex "AUTH" "description of"
24854 Very briefly, the way SMTP authentication works is as follows:
24855
24856 .ilist
24857 The server advertises a number of authentication &'mechanisms'& in response to
24858 the client's EHLO command.
24859 .next
24860 The client issues an AUTH command, naming a specific mechanism. The command
24861 may, optionally, contain some authentication data.
24862 .next
24863 The server may issue one or more &'challenges'&, to which the client must send
24864 appropriate responses. In simple authentication mechanisms, the challenges are
24865 just prompts for user names and passwords. The server does not have to issue
24866 any challenges &-- in some mechanisms the relevant data may all be transmitted
24867 with the AUTH command.
24868 .next
24869 The server either accepts or denies authentication.
24870 .next
24871 If authentication succeeds, the client may optionally make use of the AUTH
24872 option on the MAIL command to pass an authenticated sender in subsequent
24873 mail transactions. Authentication lasts for the remainder of the SMTP
24874 connection.
24875 .next
24876 If authentication fails, the client may give up, or it may try a different
24877 authentication mechanism, or it may try transferring mail over the
24878 unauthenticated connection.
24879 .endlist
24880
24881 If you are setting up a client, and want to know which authentication
24882 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24883 SMTP port) on the server, and issue an EHLO command. The response to this
24884 includes the list of supported mechanisms. For example:
24885 .display
24886 &`$ `&&*&`telnet server.example 25`&*&
24887 &`Trying 192.168.34.25...`&
24888 &`Connected to server.example.`&
24889 &`Escape character is &#x0027;^]&#x0027;.`&
24890 &`220 server.example ESMTP Exim 4.20 ...`&
24891 &*&`ehlo client.example`&*&
24892 &`250-server.example Hello client.example [10.8.4.5]`&
24893 &`250-SIZE 52428800`&
24894 &`250-PIPELINING`&
24895 &`250-AUTH PLAIN`&
24896 &`250 HELP`&
24897 .endd
24898 The second-last line of this example output shows that the server supports
24899 authentication using the PLAIN mechanism. In Exim, the different authentication
24900 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24901 routers and transports, which authenticators are included in the binary is
24902 controlled by build-time definitions. The following are currently available,
24903 included by setting
24904 .code
24905 AUTH_CRAM_MD5=yes
24906 AUTH_CYRUS_SASL=yes
24907 AUTH_DOVECOT=yes
24908 AUTH_GSASL=yes
24909 AUTH_HEIMDAL_GSSAPI=yes
24910 AUTH_PLAINTEXT=yes
24911 AUTH_SPA=yes
24912 AUTH_TLS=yes
24913 .endd
24914 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24915 authentication mechanism (RFC 2195), and the second provides an interface to
24916 the Cyrus SASL authentication library.
24917 The third is an interface to Dovecot's authentication system, delegating the
24918 work via a socket interface.
24919 The fourth provides an interface to the GNU SASL authentication library, which
24920 provides mechanisms but typically not data sources.
24921 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24922 supporting setting a server keytab.
24923 The sixth can be configured to support
24924 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24925 not formally documented, but used by several MUAs. The seventh authenticator
24926 supports Microsoft's &'Secure Password Authentication'& mechanism.
24927 The eighth is an Exim authenticator but not an SMTP one;
24928 instead it can use information from a TLS negotiation.
24929
24930 The authenticators are configured using the same syntax as other drivers (see
24931 section &<<SECTfordricon>>&). If no authenticators are required, no
24932 authentication section need be present in the configuration file. Each
24933 authenticator can in principle have both server and client functions. When Exim
24934 is receiving SMTP mail, it is acting as a server; when it is sending out
24935 messages over SMTP, it is acting as a client. Authenticator configuration
24936 options are provided for use in both these circumstances.
24937
24938 To make it clear which options apply to which situation, the prefixes
24939 &%server_%& and &%client_%& are used on option names that are specific to
24940 either the server or the client function, respectively. Server and client
24941 functions are disabled if none of their options are set. If an authenticator is
24942 to be used for both server and client functions, a single definition, using
24943 both sets of options, is required. For example:
24944 .code
24945 cram:
24946   driver = cram_md5
24947   public_name = CRAM-MD5
24948   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
24949   client_name = ph10
24950   client_secret = secret2
24951 .endd
24952 The &%server_%& option is used when Exim is acting as a server, and the
24953 &%client_%& options when it is acting as a client.
24954
24955 Descriptions of the individual authenticators are given in subsequent chapters.
24956 The remainder of this chapter covers the generic options for the
24957 authenticators, followed by general discussion of the way authentication works
24958 in Exim.
24959
24960 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
24961 per-mechanism basis.  Please read carefully to determine which variables hold
24962 account labels such as usercodes and which hold passwords or other
24963 authenticating data.
24964
24965 Note that some mechanisms support two different identifiers for accounts: the
24966 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
24967 and &'authz'& are commonly encountered.  The American spelling is standard here.
24968 Conceptually, authentication data such as passwords are tied to the identifier
24969 used to authenticate; servers may have rules to permit one user to act as a
24970 second user, so that after login the session is treated as though that second
24971 user had logged in.  That second user is the &'authorization id'&.  A robust
24972 configuration might confirm that the &'authz'& field is empty or matches the
24973 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
24974 as verified data, the &'authz'& as an unverified request which the server might
24975 choose to honour.
24976
24977 A &'realm'& is a text string, typically a domain name, presented by a server
24978 to a client to help it select an account and credentials to use.  In some
24979 mechanisms, the client and server provably agree on the realm, but clients
24980 typically can not treat the realm as secure data to be blindly trusted.
24981
24982
24983
24984 .section "Generic options for authenticators" "SECID168"
24985 .cindex "authentication" "generic options"
24986 .cindex "options" "generic; for authenticators"
24987
24988 .option client_condition authenticators string&!! unset
24989 When Exim is authenticating as a client, it skips any authenticator whose
24990 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
24991 used, for example, to skip plain text authenticators when the connection is not
24992 encrypted by a setting such as:
24993 .code
24994 client_condition = ${if !eq{$tls_out_cipher}{}}
24995 .endd
24996
24997
24998 .option client_set_id authenticators string&!! unset
24999 When client authentication succeeds, this condition is expanded; the
25000 result is used in the log lines for outbound messasges.
25001 Typically it will be the user name used for authentication.
25002
25003
25004 .option driver authenticators string unset
25005 This option must always be set. It specifies which of the available
25006 authenticators is to be used.
25007
25008
25009 .option public_name authenticators string unset
25010 This option specifies the name of the authentication mechanism that the driver
25011 implements, and by which it is known to the outside world. These names should
25012 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25013 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25014 defaults to the driver's instance name.
25015
25016
25017 .option server_advertise_condition authenticators string&!! unset
25018 When a server is about to advertise an authentication mechanism, the condition
25019 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25020 mechanism is not advertised.
25021 If the expansion fails, the mechanism is not advertised. If the failure was not
25022 forced, and was not caused by a lookup defer, the incident is logged.
25023 See section &<<SECTauthexiser>>& below for further discussion.
25024
25025
25026 .option server_condition authenticators string&!! unset
25027 This option must be set for a &%plaintext%& server authenticator, where it
25028 is used directly to control authentication. See section &<<SECTplainserver>>&
25029 for details.
25030
25031 For the &(gsasl)& authenticator, this option is required for various
25032 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25033
25034 For the other authenticators, &%server_condition%& can be used as an additional
25035 authentication or authorization mechanism that is applied after the other
25036 authenticator conditions succeed. If it is set, it is expanded when the
25037 authenticator would otherwise return a success code. If the expansion is forced
25038 to fail, authentication fails. Any other expansion failure causes a temporary
25039 error code to be returned. If the result of a successful expansion is an empty
25040 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25041 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25042 other result, a temporary error code is returned, with the expanded string as
25043 the error text.
25044
25045
25046 .option server_debug_print authenticators string&!! unset
25047 If this option is set and authentication debugging is enabled (see the &%-d%&
25048 command line option), the string is expanded and included in the debugging
25049 output when the authenticator is run as a server. This can help with checking
25050 out the values of variables.
25051 If expansion of the string fails, the error message is written to the debugging
25052 output, and Exim carries on processing.
25053
25054
25055 .option server_set_id authenticators string&!! unset
25056 .vindex "&$authenticated_id$&"
25057 When an Exim server successfully authenticates a client, this string is
25058 expanded using data from the authentication, and preserved for any incoming
25059 messages in the variable &$authenticated_id$&. It is also included in the log
25060 lines for incoming messages. For example, a user/password authenticator
25061 configuration might preserve the user name that was used to authenticate, and
25062 refer to it subsequently during delivery of the message.
25063 If expansion fails, the option is ignored.
25064
25065
25066 .option server_mail_auth_condition authenticators string&!! unset
25067 This option allows a server to discard authenticated sender addresses supplied
25068 as part of MAIL commands in SMTP connections that are authenticated by the
25069 driver on which &%server_mail_auth_condition%& is set. The option is not used
25070 as part of the authentication process; instead its (unexpanded) value is
25071 remembered for later use.
25072 How it is used is described in the following section.
25073
25074
25075
25076
25077
25078 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25079 .cindex "authentication" "sender; authenticated"
25080 .cindex "AUTH" "on MAIL command"
25081 When a client supplied an AUTH= item on a MAIL command, Exim applies
25082 the following checks before accepting it as the authenticated sender of the
25083 message:
25084
25085 .ilist
25086 If the connection is not using extended SMTP (that is, HELO was used rather
25087 than EHLO), the use of AUTH= is a syntax error.
25088 .next
25089 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25090 .next
25091 .vindex "&$authenticated_sender$&"
25092 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25093 running, the value of &$authenticated_sender$& is set to the value obtained
25094 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25095 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25096 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25097 given for the MAIL command.
25098 .next
25099 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25100 is accepted and placed in &$authenticated_sender$& only if the client has
25101 authenticated.
25102 .next
25103 If the AUTH= value was accepted by either of the two previous rules, and
25104 the client has authenticated, and the authenticator has a setting for the
25105 &%server_mail_auth_condition%&, the condition is checked at this point. The
25106 valued that was saved from the authenticator is expanded. If the expansion
25107 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25108 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25109 the value of &$authenticated_sender$& is retained and passed on with the
25110 message.
25111 .endlist
25112
25113
25114 When &$authenticated_sender$& is set for a message, it is passed on to other
25115 hosts to which Exim authenticates as a client. Do not confuse this value with
25116 &$authenticated_id$&, which is a string obtained from the authentication
25117 process, and which is not usually a complete email address.
25118
25119 .vindex "&$sender_address$&"
25120 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25121 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25122 therefore make use of &$authenticated_sender$&. The converse is not true: the
25123 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25124 ACL is run.
25125
25126
25127
25128 .section "Authentication on an Exim server" "SECTauthexiser"
25129 .cindex "authentication" "on an Exim server"
25130 When Exim receives an EHLO command, it advertises the public names of those
25131 authenticators that are configured as servers, subject to the following
25132 conditions:
25133
25134 .ilist
25135 The client host must match &%auth_advertise_hosts%& (default *).
25136 .next
25137 It the &%server_advertise_condition%& option is set, its expansion must not
25138 yield the empty string, &"0"&, &"no"&, or &"false"&.
25139 .endlist
25140
25141 The order in which the authenticators are defined controls the order in which
25142 the mechanisms are advertised.
25143
25144 Some mail clients (for example, some versions of Netscape) require the user to
25145 provide a name and password for authentication whenever AUTH is advertised,
25146 even though authentication may not in fact be needed (for example, Exim may be
25147 set up to allow unconditional relaying from the client by an IP address check).
25148 You can make such clients more friendly by not advertising AUTH to them.
25149 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25150 that runs for RCPT) to relay without authentication, you should set
25151 .code
25152 auth_advertise_hosts = ! 10.9.8.0/24
25153 .endd
25154 so that no authentication mechanisms are advertised to them.
25155
25156 The &%server_advertise_condition%& controls the advertisement of individual
25157 authentication mechanisms. For example, it can be used to restrict the
25158 advertisement of a particular mechanism to encrypted connections, by a setting
25159 such as:
25160 .code
25161 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25162 .endd
25163 .vindex "&$tls_in_cipher$&"
25164 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25165 yields &"yes"&, which allows the advertisement to happen.
25166
25167 When an Exim server receives an AUTH command from a client, it rejects it
25168 immediately if AUTH was not advertised in response to an earlier EHLO
25169 command. This is the case if
25170
25171 .ilist
25172 The client host does not match &%auth_advertise_hosts%&; or
25173 .next
25174 No authenticators are configured with server options; or
25175 .next
25176 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25177 server authenticators.
25178 .endlist
25179
25180
25181 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25182 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25183 AUTH is accepted from any client host.
25184
25185 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25186 server authentication mechanism that was advertised in response to EHLO and
25187 that matches the one named in the AUTH command. If it finds one, it runs
25188 the appropriate authentication protocol, and authentication either succeeds or
25189 fails. If there is no matching advertised mechanism, the AUTH command is
25190 rejected with a 504 error.
25191
25192 .vindex "&$received_protocol$&"
25193 .vindex "&$sender_host_authenticated$&"
25194 When a message is received from an authenticated host, the value of
25195 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25196 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25197 public name) of the authenticator driver that successfully authenticated the
25198 client from which the message was received. This variable is empty if there was
25199 no successful authentication.
25200
25201
25202
25203
25204 .section "Testing server authentication" "SECID169"
25205 .cindex "authentication" "testing a server"
25206 .cindex "AUTH" "testing a server"
25207 .cindex "base64 encoding" "creating authentication test data"
25208 Exim's &%-bh%& option can be useful for testing server authentication
25209 configurations. The data for the AUTH command has to be sent using base64
25210 encoding. A quick way to produce such data for testing is the following Perl
25211 script:
25212 .code
25213 use MIME::Base64;
25214 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25215 .endd
25216 .cindex "binary zero" "in authentication data"
25217 This interprets its argument as a Perl string, and then encodes it. The
25218 interpretation as a Perl string allows binary zeros, which are required for
25219 some kinds of authentication, to be included in the data. For example, a
25220 command line to run this script on such data might be
25221 .code
25222 encode '\0user\0password'
25223 .endd
25224 Note the use of single quotes to prevent the shell interpreting the
25225 backslashes, so that they can be interpreted by Perl to specify characters
25226 whose code value is zero.
25227
25228 &*Warning 1*&: If either of the user or password strings starts with an octal
25229 digit, you must use three zeros instead of one after the leading backslash. If
25230 you do not, the octal digit that starts your string will be incorrectly
25231 interpreted as part of the code for the first character.
25232
25233 &*Warning 2*&: If there are characters in the strings that Perl interprets
25234 specially, you must use a Perl escape to prevent them being misinterpreted. For
25235 example, a command such as
25236 .code
25237 encode '\0user@domain.com\0pas$$word'
25238 .endd
25239 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25240
25241 If you have the &%mimencode%& command installed, another way to do produce
25242 base64-encoded strings is to run the command
25243 .code
25244 echo -e -n `\0user\0password' | mimencode
25245 .endd
25246 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25247 in the argument, and the &%-n%& option specifies no newline at the end of its
25248 output. However, not all versions of &%echo%& recognize these options, so you
25249 should check your version before relying on this suggestion.
25250
25251
25252
25253 .section "Authentication by an Exim client" "SECID170"
25254 .cindex "authentication" "on an Exim client"
25255 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25256 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25257 announces support for authentication, and the host matches an entry in either
25258 of these options, Exim (as a client) tries to authenticate as follows:
25259
25260 .ilist
25261 For each authenticator that is configured as a client, in the order in which
25262 they are defined in the configuration, it searches the authentication
25263 mechanisms announced by the server for one whose name matches the public name
25264 of the authenticator.
25265 .next
25266 .vindex "&$host$&"
25267 .vindex "&$host_address$&"
25268 When it finds one that matches, it runs the authenticator's client code. The
25269 variables &$host$& and &$host_address$& are available for any string expansions
25270 that the client might do. They are set to the server's name and IP address. If
25271 any expansion is forced to fail, the authentication attempt is abandoned, and
25272 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25273 delivery to be deferred.
25274 .next
25275 If the result of the authentication attempt is a temporary error or a timeout,
25276 Exim abandons trying to send the message to the host for the moment. It will
25277 try again later. If there are any backup hosts available, they are tried in the
25278 usual way.
25279 .next
25280 If the response to authentication is a permanent error (5&'xx'& code), Exim
25281 carries on searching the list of authenticators and tries another one if
25282 possible. If all authentication attempts give permanent errors, or if there are
25283 no attempts because no mechanisms match (or option expansions force failure),
25284 what happens depends on whether the host matches &%hosts_require_auth%& or
25285 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25286 delivery is deferred. The error can be detected in the retry rules, and thereby
25287 turned into a permanent error if you wish. In the second case, Exim tries to
25288 deliver the message unauthenticated.
25289 .endlist
25290
25291 .cindex "AUTH" "on MAIL command"
25292 When Exim has authenticated itself to a remote server, it adds the AUTH
25293 parameter to the MAIL commands it sends, if it has an authenticated sender for
25294 the message. If the message came from a remote host, the authenticated sender
25295 is the one that was receiving on an incoming MAIL command, provided that the
25296 incoming connection was authenticated and the &%server_mail_auth%& condition
25297 allowed the authenticated sender to be retained. If a local process calls Exim
25298 to send a message, the sender address that is built from the login name and
25299 &%qualify_domain%& is treated as authenticated. However, if the
25300 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25301 the authenticated sender that was received with the message.
25302 .ecindex IIDauthconf1
25303 .ecindex IIDauthconf2
25304
25305
25306
25307
25308
25309
25310 . ////////////////////////////////////////////////////////////////////////////
25311 . ////////////////////////////////////////////////////////////////////////////
25312
25313 .chapter "The plaintext authenticator" "CHAPplaintext"
25314 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25315 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25316 The &(plaintext)& authenticator can be configured to support the PLAIN and
25317 LOGIN authentication mechanisms, both of which transfer authentication data as
25318 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25319 security risk; you are strongly advised to insist on the use of SMTP encryption
25320 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25321 use unencrypted plain text, you should not use the same passwords for SMTP
25322 connections as you do for login accounts.
25323
25324 .section "Plaintext options" "SECID171"
25325 .cindex "options" "&(plaintext)& authenticator (server)"
25326 When configured as a server, &(plaintext)& uses the following options:
25327
25328 .option server_condition authenticators string&!! unset
25329 This is actually a global authentication option, but it must be set in order to
25330 configure the &(plaintext)& driver as a server. Its use is described below.
25331
25332 .option server_prompts plaintext string&!! unset
25333 The contents of this option, after expansion, must be a colon-separated list of
25334 prompt strings. If expansion fails, a temporary authentication rejection is
25335 given.
25336
25337 .section "Using plaintext in a server" "SECTplainserver"
25338 .cindex "AUTH" "in &(plaintext)& authenticator"
25339 .cindex "binary zero" "in &(plaintext)& authenticator"
25340 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25341         "in &(plaintext)& authenticator"
25342 .vindex "&$auth1$&, &$auth2$&, etc"
25343 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25344
25345 When running as a server, &(plaintext)& performs the authentication test by
25346 expanding a string. The data sent by the client with the AUTH command, or in
25347 response to subsequent prompts, is base64 encoded, and so may contain any byte
25348 values when decoded. If any data is supplied with the command, it is treated as
25349 a list of strings, separated by NULs (binary zeros), the first three of which
25350 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25351 (neither LOGIN nor PLAIN uses more than three strings).
25352
25353 For compatibility with previous releases of Exim, the values are also placed in
25354 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25355 variables for this purpose is now deprecated, as it can lead to confusion in
25356 string expansions that also use them for other things.
25357
25358 If there are more strings in &%server_prompts%& than the number of strings
25359 supplied with the AUTH command, the remaining prompts are used to obtain more
25360 data. Each response from the client may be a list of NUL-separated strings.
25361
25362 .vindex "&$authenticated_id$&"
25363 Once a sufficient number of data strings have been received,
25364 &%server_condition%& is expanded. If the expansion is forced to fail,
25365 authentication fails. Any other expansion failure causes a temporary error code
25366 to be returned. If the result of a successful expansion is an empty string,
25367 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25368 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25369 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25370 For any other result, a temporary error code is returned, with the expanded
25371 string as the error text
25372
25373 &*Warning*&: If you use a lookup in the expansion to find the user's
25374 password, be sure to make the authentication fail if the user is unknown.
25375 There are good and bad examples at the end of the next section.
25376
25377
25378
25379 .section "The PLAIN authentication mechanism" "SECID172"
25380 .cindex "PLAIN authentication mechanism"
25381 .cindex "authentication" "PLAIN mechanism"
25382 .cindex "binary zero" "in &(plaintext)& authenticator"
25383 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25384 sent as one item of data (that is, one combined string containing two NUL
25385 separators). The data is sent either as part of the AUTH command, or
25386 subsequently in response to an empty prompt from the server.
25387
25388 The second and third strings are a user name and a corresponding password.
25389 Using a single fixed user name and password as an example, this could be
25390 configured as follows:
25391 .code
25392 fixed_plain:
25393   driver = plaintext
25394   public_name = PLAIN
25395   server_prompts = :
25396   server_condition = \
25397     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25398   server_set_id = $auth2
25399 .endd
25400 Note that the default result strings from &%if%& (&"true"& or an empty string)
25401 are exactly what we want here, so they need not be specified. Obviously, if the
25402 password contains expansion-significant characters such as dollar, backslash,
25403 or closing brace, they have to be escaped.
25404
25405 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25406 the end of a string list are ignored). If all the data comes as part of the
25407 AUTH command, as is commonly the case, the prompt is not used. This
25408 authenticator is advertised in the response to EHLO as
25409 .code
25410 250-AUTH PLAIN
25411 .endd
25412 and a client host can authenticate itself by sending the command
25413 .code
25414 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25415 .endd
25416 As this contains three strings (more than the number of prompts), no further
25417 data is required from the client. Alternatively, the client may just send
25418 .code
25419 AUTH PLAIN
25420 .endd
25421 to initiate authentication, in which case the server replies with an empty
25422 prompt. The client must respond with the combined data string.
25423
25424 The data string is base64 encoded, as required by the RFC. This example,
25425 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25426 represents a zero byte. This is split up into three strings, the first of which
25427 is empty. The &%server_condition%& option in the authenticator checks that the
25428 second two are &`username`& and &`mysecret`& respectively.
25429
25430 Having just one fixed user name and password, as in this example, is not very
25431 realistic, though for a small organization with only a handful of
25432 authenticating clients it could make sense.
25433
25434 A more sophisticated instance of this authenticator could use the user name in
25435 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25436 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25437 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25438 This is an incorrect example:
25439 .code
25440 server_condition = \
25441   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25442 .endd
25443 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25444 which it then compares to the supplied password (&$auth3$&). Why is this example
25445 incorrect? It works fine for existing users, but consider what happens if a
25446 non-existent user name is given. The lookup fails, but as no success/failure
25447 strings are given for the lookup, it yields an empty string. Thus, to defeat
25448 the authentication, all a client has to do is to supply a non-existent user
25449 name and an empty password. The correct way of writing this test is:
25450 .code
25451 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25452   {${if eq{$value}{$auth3}}} {false}}
25453 .endd
25454 In this case, if the lookup succeeds, the result is checked; if the lookup
25455 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25456 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25457 always fails if its second argument is empty. However, the second way of
25458 writing the test makes the logic clearer.
25459
25460
25461 .section "The LOGIN authentication mechanism" "SECID173"
25462 .cindex "LOGIN authentication mechanism"
25463 .cindex "authentication" "LOGIN mechanism"
25464 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25465 in a number of programs. No data is sent with the AUTH command. Instead, a
25466 user name and password are supplied separately, in response to prompts. The
25467 plaintext authenticator can be configured to support this as in this example:
25468 .code
25469 fixed_login:
25470   driver = plaintext
25471   public_name = LOGIN
25472   server_prompts = User Name : Password
25473   server_condition = \
25474     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25475   server_set_id = $auth1
25476 .endd
25477 Because of the way plaintext operates, this authenticator accepts data supplied
25478 with the AUTH command (in contravention of the specification of LOGIN), but
25479 if the client does not supply it (as is the case for LOGIN clients), the prompt
25480 strings are used to obtain two data items.
25481
25482 Some clients are very particular about the precise text of the prompts. For
25483 example, Outlook Express is reported to recognize only &"Username:"& and
25484 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25485 strings. It uses the &%ldapauth%& expansion condition to check the user
25486 name and password by binding to an LDAP server:
25487 .code
25488 login:
25489   driver = plaintext
25490   public_name = LOGIN
25491   server_prompts = Username:: : Password::
25492   server_condition = ${if and{{ \
25493     !eq{}{$auth1} }{ \
25494     ldapauth{\
25495       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25496       pass=${quote:$auth2} \
25497       ldap://ldap.example.org/} }} }
25498   server_set_id = uid=$auth1,ou=people,o=example.org
25499 .endd
25500 We have to check that the username is not empty before using it, because LDAP
25501 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25502 operator to correctly quote the DN for authentication. However, the basic
25503 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25504 correct one to use for the password, because quoting is needed only to make
25505 the password conform to the Exim syntax. At the LDAP level, the password is an
25506 uninterpreted string.
25507
25508
25509 .section "Support for different kinds of authentication" "SECID174"
25510 A number of string expansion features are provided for the purpose of
25511 interfacing to different ways of user authentication. These include checking
25512 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25513 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25514 &<<SECTexpcond>>&.
25515
25516
25517
25518
25519 .section "Using plaintext in a client" "SECID175"
25520 .cindex "options" "&(plaintext)& authenticator (client)"
25521 The &(plaintext)& authenticator has two client options:
25522
25523 .option client_ignore_invalid_base64 plaintext boolean false
25524 If the client receives a server prompt that is not a valid base64 string,
25525 authentication is abandoned by default. However, if this option is set true,
25526 the error in the challenge is ignored and the client sends the response as
25527 usual.
25528
25529 .option client_send plaintext string&!! unset
25530 The string is a colon-separated list of authentication data strings. Each
25531 string is independently expanded before being sent to the server. The first
25532 string is sent with the AUTH command; any more strings are sent in response
25533 to prompts from the server. Before each string is expanded, the value of the
25534 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25535 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25536 way. Thus, the prompt that is received in response to sending the first string
25537 (with the AUTH command) can be used in the expansion of the second string, and
25538 so on. If an invalid base64 string is received when
25539 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25540 &$auth$&<&'n'&> variable.
25541
25542 &*Note*&: You cannot use expansion to create multiple strings, because
25543 splitting takes priority and happens first.
25544
25545 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25546 the data, further processing is applied to each string before it is sent. If
25547 there are any single circumflex characters in the string, they are converted to
25548 NULs. Should an actual circumflex be required as data, it must be doubled in
25549 the string.
25550
25551 This is an example of a client configuration that implements the PLAIN
25552 authentication mechanism with a fixed user name and password:
25553 .code
25554 fixed_plain:
25555   driver = plaintext
25556   public_name = PLAIN
25557   client_send = ^username^mysecret
25558 .endd
25559 The lack of colons means that the entire text is sent with the AUTH
25560 command, with the circumflex characters converted to NULs. A similar example
25561 that uses the LOGIN mechanism is:
25562 .code
25563 fixed_login:
25564   driver = plaintext
25565   public_name = LOGIN
25566   client_send = : username : mysecret
25567 .endd
25568 The initial colon means that the first string is empty, so no data is sent with
25569 the AUTH command itself. The remaining strings are sent in response to
25570 prompts.
25571 .ecindex IIDplaiauth1
25572 .ecindex IIDplaiauth2
25573
25574
25575
25576
25577 . ////////////////////////////////////////////////////////////////////////////
25578 . ////////////////////////////////////////////////////////////////////////////
25579
25580 .chapter "The cram_md5 authenticator" "CHID9"
25581 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25582 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25583 .cindex "CRAM-MD5 authentication mechanism"
25584 .cindex "authentication" "CRAM-MD5 mechanism"
25585 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25586 sends a challenge string to the client, and the response consists of a user
25587 name and the CRAM-MD5 digest of the challenge string combined with a secret
25588 string (password) which is known to both server and client. Thus, the secret
25589 is not sent over the network as plain text, which makes this authenticator more
25590 secure than &(plaintext)&. However, the downside is that the secret has to be
25591 available in plain text at either end.
25592
25593
25594 .section "Using cram_md5 as a server" "SECID176"
25595 .cindex "options" "&(cram_md5)& authenticator (server)"
25596 This authenticator has one server option, which must be set to configure the
25597 authenticator as a server:
25598
25599 .option server_secret cram_md5 string&!! unset
25600 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25601 When the server receives the client's response, the user name is placed in
25602 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25603 obtain the password for that user. The server then computes the CRAM-MD5 digest
25604 that the client should have sent, and checks that it received the correct
25605 string. If the expansion of &%server_secret%& is forced to fail, authentication
25606 fails. If the expansion fails for some other reason, a temporary error code is
25607 returned to the client.
25608
25609 For compatibility with previous releases of Exim, the user name is also placed
25610 in &$1$&. However, the use of this variables for this purpose is now
25611 deprecated, as it can lead to confusion in string expansions that also use
25612 numeric variables for other things.
25613
25614 For example, the following authenticator checks that the user name given by the
25615 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25616 user name, authentication fails.
25617 .code
25618 fixed_cram:
25619   driver = cram_md5
25620   public_name = CRAM-MD5
25621   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25622   server_set_id = $auth1
25623 .endd
25624 .vindex "&$authenticated_id$&"
25625 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25626 name in &$authenticated_id$&. A more typical configuration might look up the
25627 secret string in a file, using the user name as the key. For example:
25628 .code
25629 lookup_cram:
25630   driver = cram_md5
25631   public_name = CRAM-MD5
25632   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25633                   {$value}fail}
25634   server_set_id = $auth1
25635 .endd
25636 Note that this expansion explicitly forces failure if the lookup fails
25637 because &$auth1$& contains an unknown user name.
25638
25639 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25640 using the relevant libraries, you need to know the realm to specify in the
25641 lookup and then ask for the &"userPassword"& attribute for that user in that
25642 realm, with:
25643 .code
25644 cyrusless_crammd5:
25645   driver = cram_md5
25646   public_name = CRAM-MD5
25647   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25648                   dbmjz{/etc/sasldb2}}
25649   server_set_id = $auth1
25650 .endd
25651
25652 .section "Using cram_md5 as a client" "SECID177"
25653 .cindex "options" "&(cram_md5)& authenticator (client)"
25654 When used as a client, the &(cram_md5)& authenticator has two options:
25655
25656
25657
25658 .option client_name cram_md5 string&!! "the primary host name"
25659 This string is expanded, and the result used as the user name data when
25660 computing the response to the server's challenge.
25661
25662
25663 .option client_secret cram_md5 string&!! unset
25664 This option must be set for the authenticator to work as a client. Its value is
25665 expanded and the result used as the secret string when computing the response.
25666
25667
25668 .vindex "&$host$&"
25669 .vindex "&$host_address$&"
25670 Different user names and secrets can be used for different servers by referring
25671 to &$host$& or &$host_address$& in the options. Forced failure of either
25672 expansion string is treated as an indication that this authenticator is not
25673 prepared to handle this case. Exim moves on to the next configured client
25674 authenticator. Any other expansion failure causes Exim to give up trying to
25675 send the message to the current server.
25676
25677 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25678 strings, is:
25679 .code
25680 fixed_cram:
25681   driver = cram_md5
25682   public_name = CRAM-MD5
25683   client_name = ph10
25684   client_secret = secret
25685 .endd
25686 .ecindex IIDcramauth1
25687 .ecindex IIDcramauth2
25688
25689
25690
25691 . ////////////////////////////////////////////////////////////////////////////
25692 . ////////////////////////////////////////////////////////////////////////////
25693
25694 .chapter "The cyrus_sasl authenticator" "CHID10"
25695 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25696 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25697 .cindex "Cyrus" "SASL library"
25698 .cindex "Kerberos"
25699 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25700 Digital Ltd (&url(http://www.aldigital.co.uk)).
25701
25702 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25703 library implementation of the RFC 2222 (&"Simple Authentication and Security
25704 Layer"&). This library supports a number of authentication mechanisms,
25705 including PLAIN and LOGIN, but also several others that Exim does not support
25706 directly. In particular, there is support for Kerberos authentication.
25707
25708 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25709 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25710 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25711 name of the driver to determine which mechanism to support.
25712
25713 Where access to some kind of secret file is required, for example in GSSAPI
25714 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25715 user, and that the Cyrus SASL library has no way of escalating privileges
25716 by default. You may also find you need to set environment variables,
25717 depending on the driver you are using.
25718
25719 The application name provided by Exim is &"exim"&, so various SASL options may
25720 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25721 Kerberos, note that because of limitations in the GSSAPI interface,
25722 changing the server keytab might need to be communicated down to the Kerberos
25723 layer independently. The mechanism for doing so is dependent upon the Kerberos
25724 implementation.
25725
25726 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25727 may be set to point to an alternative keytab file. Exim will pass this
25728 variable through from its own inherited environment when started as root or the
25729 Exim user. The keytab file needs to be readable by the Exim user.
25730 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25731 environment variable.  In practice, for those releases, the Cyrus authenticator
25732 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25733 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25734
25735
25736 .section "Using cyrus_sasl as a server" "SECID178"
25737 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25738 (on a successful authentication) into &$auth1$&. For compatibility with
25739 previous releases of Exim, the username is also placed in &$1$&. However, the
25740 use of this variable for this purpose is now deprecated, as it can lead to
25741 confusion in string expansions that also use numeric variables for other
25742 things.
25743
25744
25745 .option server_hostname cyrus_sasl string&!! "see below"
25746 This option selects the hostname that is used when communicating with the
25747 library. The default value is &`$primary_hostname`&. It is up to the underlying
25748 SASL plug-in what it does with this data.
25749
25750
25751 .option server_mech cyrus_sasl string "see below"
25752 This option selects the authentication mechanism this driver should use. The
25753 default is the value of the generic &%public_name%& option. This option allows
25754 you to use a different underlying mechanism from the advertised name. For
25755 example:
25756 .code
25757 sasl:
25758   driver = cyrus_sasl
25759   public_name = X-ANYTHING
25760   server_mech = CRAM-MD5
25761   server_set_id = $auth1
25762 .endd
25763
25764 .option server_realm cyrus_sasl string&!! unset
25765 This specifies the SASL realm that the server claims to be in.
25766
25767
25768 .option server_service cyrus_sasl string &`smtp`&
25769 This is the SASL service that the server claims to implement.
25770
25771
25772 For straightforward cases, you do not need to set any of the authenticator's
25773 private options. All you need to do is to specify an appropriate mechanism as
25774 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25775 PLAIN, you could have two authenticators as follows:
25776 .code
25777 sasl_cram_md5:
25778   driver = cyrus_sasl
25779   public_name = CRAM-MD5
25780   server_set_id = $auth1
25781
25782 sasl_plain:
25783   driver = cyrus_sasl
25784   public_name = PLAIN
25785   server_set_id = $auth2
25786 .endd
25787 Cyrus SASL does implement the LOGIN authentication method, even though it is
25788 not a standard method. It is disabled by default in the source distribution,
25789 but it is present in many binary distributions.
25790 .ecindex IIDcyrauth1
25791 .ecindex IIDcyrauth2
25792
25793
25794
25795
25796 . ////////////////////////////////////////////////////////////////////////////
25797 . ////////////////////////////////////////////////////////////////////////////
25798 .chapter "The dovecot authenticator" "CHAPdovecot"
25799 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25800 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25801 This authenticator is an interface to the authentication facility of the
25802 Dovecot POP/IMAP server, which can support a number of authentication methods.
25803 Note that Dovecot must be configured to use auth-client not auth-userdb.
25804 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25805 to use the same mechanisms for SMTP authentication. This is a server
25806 authenticator only. There is only one option:
25807
25808 .option server_socket dovecot string unset
25809
25810 This option must specify the socket that is the interface to Dovecot
25811 authentication. The &%public_name%& option must specify an authentication
25812 mechanism that Dovecot is configured to support. You can have several
25813 authenticators for different mechanisms. For example:
25814 .code
25815 dovecot_plain:
25816   driver = dovecot
25817   public_name = PLAIN
25818   server_socket = /var/run/dovecot/auth-client
25819   server_set_id = $auth1
25820
25821 dovecot_ntlm:
25822   driver = dovecot
25823   public_name = NTLM
25824   server_socket = /var/run/dovecot/auth-client
25825   server_set_id = $auth1
25826 .endd
25827 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25828 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25829 option is passed in the Dovecot authentication command. If, for a TLS
25830 connection, a client certificate has been verified, the &"valid-client-cert"&
25831 option is passed. When authentication succeeds, the identity of the user
25832 who authenticated is placed in &$auth1$&.
25833 .ecindex IIDdcotauth1
25834 .ecindex IIDdcotauth2
25835
25836
25837 . ////////////////////////////////////////////////////////////////////////////
25838 . ////////////////////////////////////////////////////////////////////////////
25839 .chapter "The gsasl authenticator" "CHAPgsasl"
25840 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25841 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25842 .cindex "authentication" "GNU SASL"
25843 .cindex "authentication" "SASL"
25844 .cindex "authentication" "EXTERNAL"
25845 .cindex "authentication" "ANONYMOUS"
25846 .cindex "authentication" "PLAIN"
25847 .cindex "authentication" "LOGIN"
25848 .cindex "authentication" "DIGEST-MD5"
25849 .cindex "authentication" "CRAM-MD5"
25850 .cindex "authentication" "SCRAM-SHA-1"
25851 The &(gsasl)& authenticator provides server integration for the GNU SASL
25852 library and the mechanisms it provides.  This is new as of the 4.80 release
25853 and there are a few areas where the library does not let Exim smoothly
25854 scale to handle future authentication mechanisms, so no guarantee can be
25855 made that any particular new authentication mechanism will be supported
25856 without code changes in Exim.
25857
25858
25859 .option server_channelbinding gsasl boolean false
25860 Some authentication mechanisms are able to use external context at both ends
25861 of the session to bind the authentication to that context, and fail the
25862 authentication process if that context differs.  Specifically, some TLS
25863 ciphersuites can provide identifying information about the cryptographic
25864 context.
25865
25866 This means that certificate identity and verification becomes a non-issue,
25867 as a man-in-the-middle attack will cause the correct client and server to
25868 see different identifiers and authentication will fail.
25869
25870 This is currently only supported when using the GnuTLS library.  This is
25871 only usable by mechanisms which support "channel binding"; at time of
25872 writing, that's the SCRAM family.
25873
25874 This defaults off to ensure smooth upgrade across Exim releases, in case
25875 this option causes some clients to start failing.  Some future release
25876 of Exim may switch the default to be true.
25877
25878
25879 .option server_hostname gsasl string&!! "see below"
25880 This option selects the hostname that is used when communicating with the
25881 library. The default value is &`$primary_hostname`&.
25882 Some mechanisms will use this data.
25883
25884
25885 .option server_mech gsasl string "see below"
25886 This option selects the authentication mechanism this driver should use. The
25887 default is the value of the generic &%public_name%& option. This option allows
25888 you to use a different underlying mechanism from the advertised name. For
25889 example:
25890 .code
25891 sasl:
25892   driver = gsasl
25893   public_name = X-ANYTHING
25894   server_mech = CRAM-MD5
25895   server_set_id = $auth1
25896 .endd
25897
25898
25899 .option server_password gsasl string&!! unset
25900 Various mechanisms need access to the cleartext password on the server, so
25901 that proof-of-possession can be demonstrated on the wire, without sending
25902 the password itself.
25903
25904 The data available for lookup varies per mechanism.
25905 In all cases, &$auth1$& is set to the &'authentication id'&.
25906 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25907 if available, else the empty string.
25908 The &$auth3$& variable will always be the &'realm'& if available,
25909 else the empty string.
25910
25911 A forced failure will cause authentication to defer.
25912
25913 If using this option, it may make sense to set the &%server_condition%&
25914 option to be simply "true".
25915
25916
25917 .option server_realm gsasl string&!! unset
25918 This specifies the SASL realm that the server claims to be in.
25919 Some mechanisms will use this data.
25920
25921
25922 .option server_scram_iter gsasl string&!! unset
25923 This option provides data for the SCRAM family of mechanisms.
25924 &$auth1$& is not available at evaluation time.
25925 (This may change, as we receive feedback on use)
25926
25927
25928 .option server_scram_salt gsasl string&!! unset
25929 This option provides data for the SCRAM family of mechanisms.
25930 &$auth1$& is not available at evaluation time.
25931 (This may change, as we receive feedback on use)
25932
25933
25934 .option server_service gsasl string &`smtp`&
25935 This is the SASL service that the server claims to implement.
25936 Some mechanisms will use this data.
25937
25938
25939 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25940 .vindex "&$auth1$&, &$auth2$&, etc"
25941 These may be set when evaluating specific options, as detailed above.
25942 They will also be set when evaluating &%server_condition%&.
25943
25944 Unless otherwise stated below, the &(gsasl)& integration will use the following
25945 meanings for these variables:
25946
25947 .ilist
25948 .vindex "&$auth1$&"
25949 &$auth1$&: the &'authentication id'&
25950 .next
25951 .vindex "&$auth2$&"
25952 &$auth2$&: the &'authorization id'&
25953 .next
25954 .vindex "&$auth3$&"
25955 &$auth3$&: the &'realm'&
25956 .endlist
25957
25958 On a per-mechanism basis:
25959
25960 .ilist
25961 .cindex "authentication" "EXTERNAL"
25962 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
25963 the &%server_condition%& option must be present.
25964 .next
25965 .cindex "authentication" "ANONYMOUS"
25966 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
25967 the &%server_condition%& option must be present.
25968 .next
25969 .cindex "authentication" "GSSAPI"
25970 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
25971 &$auth2$& will be set to the &'authorization id'&,
25972 the &%server_condition%& option must be present.
25973 .endlist
25974
25975 An &'anonymous token'& is something passed along as an unauthenticated
25976 identifier; this is analogous to FTP anonymous authentication passing an
25977 email address, or software-identifier@, as the "password".
25978
25979
25980 An example showing the password having the realm specified in the callback
25981 and demonstrating a Cyrus SASL to GSASL migration approach is:
25982 .code
25983 gsasl_cyrusless_crammd5:
25984   driver = gsasl
25985   public_name = CRAM-MD5
25986   server_realm = imap.example.org
25987   server_password = ${lookup{$auth1:$auth3:userPassword}\
25988                     dbmjz{/etc/sasldb2}{$value}fail}
25989   server_set_id = ${quote:$auth1}
25990   server_condition = yes
25991 .endd
25992
25993
25994 . ////////////////////////////////////////////////////////////////////////////
25995 . ////////////////////////////////////////////////////////////////////////////
25996
25997 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
25998 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
25999 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26000 .cindex "authentication" "GSSAPI"
26001 .cindex "authentication" "Kerberos"
26002 The &(heimdal_gssapi)& authenticator provides server integration for the
26003 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26004 reliably.
26005
26006 .option server_hostname heimdal_gssapi string&!! "see below"
26007 This option selects the hostname that is used, with &%server_service%&,
26008 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26009 identifier.  The default value is &`$primary_hostname`&.
26010
26011 .option server_keytab heimdal_gssapi string&!! unset
26012 If set, then Heimdal will not use the system default keytab (typically
26013 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26014 The value should be a pathname, with no &"file:"& prefix.
26015
26016 .option server_service heimdal_gssapi string&!! "smtp"
26017 This option specifies the service identifier used, in conjunction with
26018 &%server_hostname%&, for building the identifer for finding credentials
26019 from the keytab.
26020
26021
26022 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26023 Beware that these variables will typically include a realm, thus will appear
26024 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26025 not verified, so a malicious client can set it to anything.
26026
26027 The &$auth1$& field should be safely trustable as a value from the Key
26028 Distribution Center.  Note that these are not quite email addresses.
26029 Each identifier is for a role, and so the left-hand-side may include a
26030 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26031
26032 .vindex "&$auth1$&, &$auth2$&, etc"
26033 .ilist
26034 .vindex "&$auth1$&"
26035 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26036 .next
26037 .vindex "&$auth2$&"
26038 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26039 authentication.  If that was empty, this will also be set to the
26040 GSS Display Name.
26041 .endlist
26042
26043
26044 . ////////////////////////////////////////////////////////////////////////////
26045 . ////////////////////////////////////////////////////////////////////////////
26046
26047 .chapter "The spa authenticator" "CHAPspa"
26048 .scindex IIDspaauth1 "&(spa)& authenticator"
26049 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26050 .cindex "authentication" "Microsoft Secure Password"
26051 .cindex "authentication" "NTLM"
26052 .cindex "Microsoft Secure Password Authentication"
26053 .cindex "NTLM authentication"
26054 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26055 Password Authentication'& mechanism,
26056 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26057 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26058 taken from the Samba project (&url(http://www.samba.org)). The code for the
26059 server side was subsequently contributed by Tom Kistner. The mechanism works as
26060 follows:
26061
26062 .ilist
26063 After the AUTH command has been accepted, the client sends an SPA
26064 authentication request based on the user name and optional domain.
26065 .next
26066 The server sends back a challenge.
26067 .next
26068 The client builds a challenge response which makes use of the user's password
26069 and sends it to the server, which then accepts or rejects it.
26070 .endlist
26071
26072 Encryption is used to protect the password in transit.
26073
26074
26075
26076 .section "Using spa as a server" "SECID179"
26077 .cindex "options" "&(spa)& authenticator (server)"
26078 The &(spa)& authenticator has just one server option:
26079
26080 .option server_password spa string&!! unset
26081 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26082 This option is expanded, and the result must be the cleartext password for the
26083 authenticating user, whose name is at this point in &$auth1$&. For
26084 compatibility with previous releases of Exim, the user name is also placed in
26085 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26086 it can lead to confusion in string expansions that also use numeric variables
26087 for other things. For example:
26088 .code
26089 spa:
26090   driver = spa
26091   public_name = NTLM
26092   server_password = \
26093     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26094 .endd
26095 If the expansion is forced to fail, authentication fails. Any other expansion
26096 failure causes a temporary error code to be returned.
26097
26098
26099
26100
26101
26102 .section "Using spa as a client" "SECID180"
26103 .cindex "options" "&(spa)& authenticator (client)"
26104 The &(spa)& authenticator has the following client options:
26105
26106
26107
26108 .option client_domain spa string&!! unset
26109 This option specifies an optional domain for the authentication.
26110
26111
26112 .option client_password spa string&!! unset
26113 This option specifies the user's password, and must be set.
26114
26115
26116 .option client_username spa string&!! unset
26117 This option specifies the user name, and must be set. Here is an example of a
26118 configuration of this authenticator for use with the mail servers at
26119 &'msn.com'&:
26120 .code
26121 msn:
26122   driver = spa
26123   public_name = MSN
26124   client_username = msn/msn_username
26125   client_password = msn_plaintext_password
26126   client_domain = DOMAIN_OR_UNSET
26127 .endd
26128 .ecindex IIDspaauth1
26129 .ecindex IIDspaauth2
26130
26131
26132
26133
26134
26135 . ////////////////////////////////////////////////////////////////////////////
26136 . ////////////////////////////////////////////////////////////////////////////
26137
26138 .new
26139 .chapter "The tls authenticator" "CHAPtlsauth"
26140 .scindex IIDtlsauth1 "&(tls)& authenticator"
26141 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26142 .cindex "authentication" "Client Certificate"
26143 .cindex "authentication" "X509"
26144 .cindex "Certificate-based authentication"
26145 The &(tls)& authenticator provides server support for
26146 authentication based on client certificates.
26147
26148 It is not an SMTP authentication mechanism and is not
26149 advertised by the server as part of the SMTP EHLO response.
26150 It is an Exim authenticator in the sense that it affects
26151 the protocol element of the log line, can be tested for
26152 by the &%authenticated%& ACL condition, and can set
26153 the &$authenticated_id$& variable.
26154
26155 The client must present a verifiable certificate,
26156 for which it must have been requested via the
26157 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26158 (see &<<CHAPTLS>>&).
26159
26160 If an authenticator of this type is configured it is
26161 run before any SMTP-level communication is done,
26162 and can authenticate the connection.
26163 If it does, SMTP suthentication is not offered.
26164
26165 A maximum of one authenticator of this type may be present.
26166
26167
26168 .cindex "options" "&(tls)& authenticator (server)"
26169 The &(tls)& authenticator has three server options:
26170
26171 .option server_param1 tls string&!! unset
26172 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26173 This option is expanded after the TLS negotiation and
26174 the result is placed in &$auth1$&.
26175 If the expansion is forced to fail, authentication fails. Any other expansion
26176 failure causes a temporary error code to be returned.
26177
26178 .option server_param2 tls string&!! unset
26179 .option server_param3 tls string&!! unset
26180 As above, for &$auth2$& and &$auth3$&.
26181
26182 &%server_param1%& may also be spelled &%server_param%&.
26183
26184
26185 Example:
26186 .code
26187 tls:
26188   driver = tls
26189   server_param1 =     ${certextract {subj_altname,mail,>:} \
26190                                     {$tls_in_peercert}}
26191   server_condition =  ${if forany {$auth1} \
26192                             {!= {0} \
26193                                 {${lookup ldap{ldap:///\
26194                          mailname=${quote_ldap_dn:${lc:$item}},\
26195                          ou=users,LDAP_DC?mailid} {$value}{0} \
26196                        }    }   } }
26197   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26198 .endd
26199 .ecindex IIDtlsauth1
26200 .ecindex IIDtlsauth2
26201 .wen
26202
26203
26204 Note that because authentication is traditionally an SMTP operation,
26205 the &%authenticated%& ACL condition cannot be used in
26206 a connect- or helo-ACL.
26207
26208
26209
26210 . ////////////////////////////////////////////////////////////////////////////
26211 . ////////////////////////////////////////////////////////////////////////////
26212
26213 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26214          "Encrypted SMTP connections"
26215 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26216 .scindex IIDencsmtp2 "SMTP" "encryption"
26217 .cindex "TLS" "on SMTP connection"
26218 .cindex "OpenSSL"
26219 .cindex "GnuTLS"
26220 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26221 Sockets Layer), is implemented by making use of the OpenSSL library or the
26222 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26223 cryptographic code in the Exim distribution itself for implementing TLS. In
26224 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26225 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26226 You also need to understand the basic concepts of encryption at a managerial
26227 level, and in particular, the way that public keys, private keys, and
26228 certificates are used.
26229
26230 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26231 connection is established, the client issues a STARTTLS command. If the
26232 server accepts this, the client and the server negotiate an encryption
26233 mechanism. If the negotiation succeeds, the data that subsequently passes
26234 between them is encrypted.
26235
26236 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26237 and if so, what cipher suite is in use, whether the client supplied a
26238 certificate, and whether or not that certificate was verified. This makes it
26239 possible for an Exim server to deny or accept certain commands based on the
26240 encryption state.
26241
26242 &*Warning*&: Certain types of firewall and certain anti-virus products can
26243 disrupt TLS connections. You need to turn off SMTP scanning for these products
26244 in order to get TLS to work.
26245
26246
26247
26248 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26249          "SECID284"
26250 .cindex "ssmtp protocol"
26251 .cindex "smtps protocol"
26252 .cindex "SMTP" "ssmtp protocol"
26253 .cindex "SMTP" "smtps protocol"
26254 Early implementations of encrypted SMTP used a different TCP port from normal
26255 SMTP, and expected an encryption negotiation to start immediately, instead of
26256 waiting for a STARTTLS command from the client using the standard SMTP
26257 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26258 allocated for this purpose.
26259
26260 This approach was abandoned when encrypted SMTP was standardized, but there are
26261 still some legacy clients that use it. Exim supports these clients by means of
26262 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26263 numbers; the most common use is expected to be:
26264 .code
26265 tls_on_connect_ports = 465
26266 .endd
26267 The port numbers specified by this option apply to all SMTP connections, both
26268 via the daemon and via &'inetd'&. You still need to specify all the ports that
26269 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26270 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26271 an extra port &-- rather, it specifies different behaviour on a port that is
26272 defined elsewhere.
26273
26274 There is also a &%-tls-on-connect%& command line option. This overrides
26275 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26276
26277
26278
26279
26280
26281
26282 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26283 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26284 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26285 followed later, when the first versions of GnuTLS were released. To build Exim
26286 to use GnuTLS, you need to set
26287 .code
26288 USE_GNUTLS=yes
26289 .endd
26290 in Local/Makefile, in addition to
26291 .code
26292 SUPPORT_TLS=yes
26293 .endd
26294 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26295 include files and libraries for GnuTLS can be found.
26296
26297 There are some differences in usage when using GnuTLS instead of OpenSSL:
26298
26299 .ilist
26300 The &%tls_verify_certificates%& option
26301 cannot be the path of a directory
26302 for GnuTLS versions before 3.3.6
26303 (for later versions, or OpenSSL, it can be either).
26304 .next
26305 The default value for &%tls_dhparam%& differs for historical reasons.
26306 .next
26307 .vindex "&$tls_in_peerdn$&"
26308 .vindex "&$tls_out_peerdn$&"
26309 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26310 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26311 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26312 .next
26313 OpenSSL identifies cipher suites using hyphens as separators, for example:
26314 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26315 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26316 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26317 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26318 to handle its own older variants) when processing lists of cipher suites in the
26319 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26320 option).
26321 .next
26322 The &%tls_require_ciphers%& options operate differently, as described in the
26323 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26324 .next
26325 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26326 When using OpenSSL, this option is ignored.
26327 (If an API is found to let OpenSSL be configured in this way,
26328 let the Exim Maintainers know and we'll likely use it).
26329 .next
26330 Some other recently added features may only be available in one or the other.
26331 This should be documented with the feature.  If the documentation does not
26332 explicitly state that the feature is infeasible in the other TLS
26333 implementation, then patches are welcome.
26334 .endlist
26335
26336
26337 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26338 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26339 an explicit path; if the latter, then the text about generation still applies,
26340 but not the chosen filename.
26341 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26342 See the documentation of &%tls_dhparam%& for more information.
26343
26344 GnuTLS uses D-H parameters that may take a substantial amount of time
26345 to compute. It is unreasonable to re-compute them for every TLS session.
26346 Therefore, Exim keeps this data in a file in its spool directory, called
26347 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26348 of bits requested.
26349 The file is owned by the Exim user and is readable only by
26350 its owner. Every Exim process that start up GnuTLS reads the D-H
26351 parameters from this file. If the file does not exist, the first Exim process
26352 that needs it computes the data and writes it to a temporary file which is
26353 renamed once it is complete. It does not matter if several Exim processes do
26354 this simultaneously (apart from wasting a few resources). Once a file is in
26355 place, new Exim processes immediately start using it.
26356
26357 For maximum security, the parameters that are stored in this file should be
26358 recalculated periodically, the frequency depending on your paranoia level.
26359 If you are avoiding using the fixed D-H primes published in RFCs, then you
26360 are concerned about some advanced attacks and will wish to do this; if you do
26361 not regenerate then you might as well stick to the standard primes.
26362
26363 Arranging this is easy in principle; just delete the file when you want new
26364 values to be computed. However, there may be a problem. The calculation of new
26365 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26366 If the system is not very active, &_/dev/random_& may delay returning data
26367 until enough randomness (entropy) is available. This may cause Exim to hang for
26368 a substantial amount of time, causing timeouts on incoming connections.
26369
26370 The solution is to generate the parameters externally to Exim. They are stored
26371 in &_gnutls-params-N_& in PEM format, which means that they can be
26372 generated externally using the &(certtool)& command that is part of GnuTLS.
26373
26374 To replace the parameters with new ones, instead of deleting the file
26375 and letting Exim re-create it, you can generate new parameters using
26376 &(certtool)& and, when this has been done, replace Exim's cache file by
26377 renaming. The relevant commands are something like this:
26378 .code
26379 # ls
26380 [ look for file; assume gnutls-params-2236 is the most recent ]
26381 # rm -f new-params
26382 # touch new-params
26383 # chown exim:exim new-params
26384 # chmod 0600 new-params
26385 # certtool --generate-dh-params --bits 2236 >>new-params
26386 # openssl dhparam -noout -text -in new-params | head
26387 [ check the first line, make sure it's not more than 2236;
26388   if it is, then go back to the start ("rm") and repeat
26389   until the size generated is at most the size requested ]
26390 # chmod 0400 new-params
26391 # mv new-params gnutls-params-2236
26392 .endd
26393 If Exim never has to generate the parameters itself, the possibility of
26394 stalling is removed.
26395
26396 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26397 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26398 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26399 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26400 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26401 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26402 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26403 which applies to all D-H usage, client or server.  If the value returned by
26404 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26405 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26406 limit, which is still much higher than Exim historically used.
26407
26408 The filename and bits used will change as the GnuTLS maintainers change the
26409 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26410 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26411 2432 bits, while NSS is limited to 2236 bits.
26412
26413 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26414 increase the chance of the generated prime actually being within acceptable
26415 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26416 procedure above.  There is no sane procedure available to Exim to double-check
26417 the size of the generated prime, so it might still be too large.
26418
26419
26420 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26421 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26422 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26423 There is a function in the OpenSSL library that can be passed a list of cipher
26424 suites before the cipher negotiation takes place. This specifies which ciphers
26425 are acceptable. The list is colon separated and may contain names like
26426 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26427 directly to this function call.
26428 Many systems will install the OpenSSL manual-pages, so you may have
26429 &'ciphers(1)'& available to you.
26430 The following quotation from the OpenSSL
26431 documentation specifies what forms of item are allowed in the cipher string:
26432
26433 .ilist
26434 It can consist of a single cipher suite such as RC4-SHA.
26435 .next
26436 It can represent a list of cipher suites containing a certain algorithm,
26437 or cipher suites of a certain type. For example SHA1 represents all
26438 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26439 SSL v3 algorithms.
26440 .next
26441 Lists of cipher suites can be combined in a single cipher string using
26442 the + character. This is used as a logical and operation. For example
26443 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26444 algorithms.
26445 .endlist
26446
26447 Each cipher string can be optionally preceded by one of the characters &`!`&,
26448 &`-`& or &`+`&.
26449 .ilist
26450 If &`!`& is used, the ciphers are permanently deleted from the list. The
26451 ciphers deleted can never reappear in the list even if they are explicitly
26452 stated.
26453 .next
26454 If &`-`& is used, the ciphers are deleted from the list, but some or all
26455 of the ciphers can be added again by later options.
26456 .next
26457 If &`+`& is used, the ciphers are moved to the end of the list. This
26458 option does not add any new ciphers; it just moves matching existing ones.
26459 .endlist
26460
26461 If none of these characters is present, the string is interpreted as
26462 a list of ciphers to be appended to the current preference list. If the list
26463 includes any ciphers already present they will be ignored: that is, they will
26464 not be moved to the end of the list.
26465 .endlist
26466
26467 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26468 string:
26469 .code
26470 # note single-quotes to get ! past any shell history expansion
26471 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26472 .endd
26473
26474 This example will let the library defaults be permitted on the MX port, where
26475 there's probably no identity verification anyway, but ups the ante on the
26476 submission ports where the administrator might have some influence on the
26477 choice of clients used:
26478 .code
26479 # OpenSSL variant; see man ciphers(1)
26480 tls_require_ciphers = ${if =={$received_port}{25}\
26481                            {DEFAULT}\
26482                            {HIGH:!MD5:!SHA1}}
26483 .endd
26484
26485
26486
26487 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26488          "SECTreqciphgnu"
26489 .cindex "GnuTLS" "specifying parameters for"
26490 .cindex "TLS" "specifying ciphers (GnuTLS)"
26491 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26492 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26493 .cindex "TLS" "specifying protocols (GnuTLS)"
26494 .cindex "TLS" "specifying priority string (GnuTLS)"
26495 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26496 The GnuTLS library allows the caller to provide a "priority string", documented
26497 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26498 ciphersuite specification in OpenSSL.
26499
26500 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26501 and controls both protocols and ciphers.
26502
26503 The &%tls_require_ciphers%& option is available both as an global option,
26504 controlling how Exim behaves as a server, and also as an option of the
26505 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26506 the value is string expanded.  The resulting string is not an Exim list and
26507 the string is given to the GnuTLS library, so that Exim does not need to be
26508 aware of future feature enhancements of GnuTLS.
26509
26510 Documentation of the strings accepted may be found in the GnuTLS manual, under
26511 "Priority strings".  This is online as
26512 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26513 but beware that this relates to GnuTLS 3, which may be newer than the version
26514 installed on your system.  If you are using GnuTLS 3,
26515 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26516 on that site can be used to test a given string.
26517
26518 For example:
26519 .code
26520 # Disable older versions of protocols
26521 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26522 .endd
26523
26524 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26525 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26526 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26527
26528 This example will let the library defaults be permitted on the MX port, where
26529 there's probably no identity verification anyway, and lowers security further
26530 by increasing compatibility; but this ups the ante on the submission ports
26531 where the administrator might have some influence on the choice of clients
26532 used:
26533 .code
26534 # GnuTLS variant
26535 tls_require_ciphers = ${if =={$received_port}{25}\
26536                            {NORMAL:%COMPAT}\
26537                            {SECURE128}}
26538 .endd
26539
26540
26541 .section "Configuring an Exim server to use TLS" "SECID182"
26542 .cindex "TLS" "configuring an Exim server"
26543 When Exim has been built with TLS support, it advertises the availability of
26544 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26545 but not to any others. The default value of this option is unset, which means
26546 that STARTTLS is not advertised at all. This default is chosen because you
26547 need to set some other options in order to make TLS available, and also it is
26548 sensible for systems that want to use TLS only as a client.
26549
26550 If a client issues a STARTTLS command and there is some configuration
26551 problem in the server, the command is rejected with a 454 error. If the client
26552 persists in trying to issue SMTP commands, all except QUIT are rejected
26553 with the error
26554 .code
26555 554 Security failure
26556 .endd
26557 If a STARTTLS command is issued within an existing TLS session, it is
26558 rejected with a 554 error code.
26559
26560 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26561 match some hosts. You can, of course, set it to * to match all hosts.
26562 However, this is not all you need to do. TLS sessions to a server won't work
26563 without some further configuration at the server end.
26564
26565 It is rumoured that all existing clients that support TLS/SSL use RSA
26566 encryption. To make this work you need to set, in the server,
26567 .code
26568 tls_certificate = /some/file/name
26569 tls_privatekey = /some/file/name
26570 .endd
26571 These options are, in fact, expanded strings, so you can make them depend on
26572 the identity of the client that is connected if you wish. The first file
26573 contains the server's X509 certificate, and the second contains the private key
26574 that goes with it. These files need to be
26575 PEM format and readable by the Exim user, and must
26576 always be given as full path names.
26577 The key must not be password-protected.
26578 They can be the same file if both the
26579 certificate and the key are contained within it. If &%tls_privatekey%& is not
26580 set, or if its expansion is forced to fail or results in an empty string, this
26581 is assumed to be the case. The certificate file may also contain intermediate
26582 certificates that need to be sent to the client to enable it to authenticate
26583 the server's certificate.
26584
26585 If you do not understand about certificates and keys, please try to find a
26586 source of this background information, which is not Exim-specific. (There are a
26587 few comments below in section &<<SECTcerandall>>&.)
26588
26589 &*Note*&: These options do not apply when Exim is operating as a client &--
26590 they apply only in the case of a server. If you need to use a certificate in an
26591 Exim client, you must set the options of the same names in an &(smtp)&
26592 transport.
26593
26594 With just these options, an Exim server will be able to use TLS. It does not
26595 require the client to have a certificate (but see below for how to insist on
26596 this). There is one other option that may be needed in other situations. If
26597 .code
26598 tls_dhparam = /some/file/name
26599 .endd
26600 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26601 with the parameters contained in the file.
26602 Set this to &`none`& to disable use of DH entirely, by making no prime
26603 available:
26604 .code
26605 tls_dhparam = none
26606 .endd
26607 This may also be set to a string identifying a standard prime to be used for
26608 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26609 used is &`ike23`&.  There are a few standard primes available, see the
26610 documentation for &%tls_dhparam%& for the complete list.
26611
26612 See the command
26613 .code
26614 openssl dhparam
26615 .endd
26616 for a way of generating file data.
26617
26618 The strings supplied for these three options are expanded every time a client
26619 host connects. It is therefore possible to use different certificates and keys
26620 for different hosts, if you so wish, by making use of the client's IP address
26621 in &$sender_host_address$& to control the expansion. If a string expansion is
26622 forced to fail, Exim behaves as if the option is not set.
26623
26624 .cindex "cipher" "logging"
26625 .cindex "log" "TLS cipher"
26626 .vindex "&$tls_in_cipher$&"
26627 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26628 an incoming TLS connection. It is included in the &'Received:'& header of an
26629 incoming message (by default &-- you can, of course, change this), and it is
26630 also included in the log line that records a message's arrival, keyed by
26631 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26632 condition can be used to test for specific cipher suites in ACLs.
26633
26634 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26635 can check the name of the cipher suite and vary their actions accordingly. The
26636 cipher suite names vary, depending on which TLS library is being used. For
26637 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26638 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26639 documentation for more details.
26640
26641 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26642 (again depending on the &%tls_cipher%& log selector).
26643
26644
26645 .section "Requesting and verifying client certificates" "SECID183"
26646 .cindex "certificate" "verification of client"
26647 .cindex "TLS" "client certificate verification"
26648 If you want an Exim server to request a certificate when negotiating a TLS
26649 session with a client, you must set either &%tls_verify_hosts%& or
26650 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26651 apply to all TLS connections. For any host that matches one of these options,
26652 Exim requests a certificate as part of the setup of the TLS session. The
26653 contents of the certificate are verified by comparing it with a list of
26654 expected certificates.
26655 .new
26656 These may be the system default set (depending on library version),
26657 .wen
26658 an explicit file or,
26659 depending on library version, a directory, identified by
26660 &%tls_verify_certificates%&.
26661
26662 A file can contain multiple certificates, concatenated end to end. If a
26663 directory is used
26664 (OpenSSL only),
26665 each certificate must be in a separate file, with a name (or a symbolic link)
26666 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26667 certificate. You can compute the relevant hash by running the command
26668 .code
26669 openssl x509 -hash -noout -in /cert/file
26670 .endd
26671 where &_/cert/file_& contains a single certificate.
26672
26673 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26674 what happens if the client does not supply a certificate, or if the certificate
26675 does not match any of the certificates in the collection named by
26676 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26677 attempt to set up a TLS session is aborted, and the incoming connection is
26678 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26679 session continues. ACLs that run for subsequent SMTP commands can detect the
26680 fact that no certificate was verified, and vary their actions accordingly. For
26681 example, you can insist on a certificate before accepting a message for
26682 relaying, but not when the message is destined for local delivery.
26683
26684 .vindex "&$tls_in_peerdn$&"
26685 When a client supplies a certificate (whether it verifies or not), the value of
26686 the Distinguished Name of the certificate is made available in the variable
26687 &$tls_in_peerdn$& during subsequent processing of the message.
26688
26689 .cindex "log" "distinguished name"
26690 Because it is often a long text string, it is not included in the log line or
26691 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26692 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26693 &%received_header_text%& to change the &'Received:'& header. When no
26694 certificate is supplied, &$tls_in_peerdn$& is empty.
26695
26696
26697 .section "Revoked certificates" "SECID184"
26698 .cindex "TLS" "revoked certificates"
26699 .cindex "revocation list"
26700 .cindex "certificate" "revocation list"
26701 .cindex "OCSP" "stapling"
26702 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26703 certificates are revoked. If you have such a list, you can pass it to an Exim
26704 server using the global option called &%tls_crl%& and to an Exim client using
26705 an identically named option for the &(smtp)& transport. In each case, the value
26706 of the option is expanded and must then be the name of a file that contains a
26707 CRL in PEM format.
26708 The downside is that clients have to periodically re-download a potentially huge
26709 file from every certificate authority they know of.
26710
26711 The way with most moving parts at query time is Online Certificate
26712 Status Protocol (OCSP), where the client verifies the certificate
26713 against an OCSP server run by the CA.  This lets the CA track all
26714 usage of the certs.  It requires running software with access to the
26715 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26716 is based on HTTP and can be proxied accordingly.
26717
26718 The only widespread OCSP server implementation (known to this writer)
26719 comes as part of OpenSSL and aborts on an invalid request, such as
26720 connecting to the port and then disconnecting.  This requires
26721 re-entering the passphrase each time some random client does this.
26722
26723 The third way is OCSP Stapling; in this, the server using a certificate
26724 issued by the CA periodically requests an OCSP proof of validity from
26725 the OCSP server, then serves it up inline as part of the TLS
26726 negotiation.   This approach adds no extra round trips, does not let the
26727 CA track users, scales well with number of certs issued by the CA and is
26728 resilient to temporary OCSP server failures, as long as the server
26729 starts retrying to fetch an OCSP proof some time before its current
26730 proof expires.  The downside is that it requires server support.
26731
26732 Unless Exim is built with the support disabled,
26733 or with GnuTLS earlier than version 3.1.3,
26734 support for OCSP stapling is included.
26735
26736 There is a global option called &%tls_ocsp_file%&.
26737 The file specified therein is expected to be in DER format, and contain
26738 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26739 option will be re-expanded for SNI, if the &%tls_certificate%& option
26740 contains &`tls_in_sni`&, as per other TLS options.
26741
26742 Exim does not at this time implement any support for fetching a new OCSP
26743 proof.  The burden is on the administrator to handle this, outside of
26744 Exim.  The file specified should be replaced atomically, so that the
26745 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26746 on each connection, so a new file will be handled transparently on the
26747 next connection.
26748
26749 When built with OpenSSL Exim will check for a valid next update timestamp
26750 in the OCSP proof; if not present, or if the proof has expired, it will be
26751 ignored.
26752
26753 For the client to be able to verify the stapled OCSP the server must
26754 also supply, in its stapled information, any intermediate
26755 certificates for the chain leading to the OCSP proof from the signer
26756 of the server certificate.  There may be zero or one such. These
26757 intermediate certificates should be added to the server OCSP stapling
26758 file named by &%tls_ocsp_file%&.
26759
26760 Note that the proof only covers the terminal server certificate,
26761 not any of the chain from CA to it.
26762
26763 There is no current way to staple a proof for a client certificate.
26764
26765 .code
26766   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26767   OCSP server is supplied.  The server URL may be included in the
26768   server certificate, if the CA is helpful.
26769
26770   One failure mode seen was the OCSP Signer cert expiring before the end
26771   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26772   noted this as invalid overall, but the re-fetch script did not.
26773 .endd
26774
26775
26776
26777
26778 .section "Configuring an Exim client to use TLS" "SECID185"
26779 .cindex "cipher" "logging"
26780 .cindex "log" "TLS cipher"
26781 .cindex "log" "distinguished name"
26782 .cindex "TLS" "configuring an Exim client"
26783 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26784 deliveries as well as to incoming, the latter one causing logging of the
26785 server certificate's DN. The remaining client configuration for TLS is all
26786 within the &(smtp)& transport.
26787
26788 It is not necessary to set any options to have TLS work in the &(smtp)&
26789 transport. If Exim is built with TLS support, and TLS is advertised by a
26790 server, the &(smtp)& transport always tries to start a TLS session. However,
26791 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26792 transport) to a list of server hosts for which TLS should not be used.
26793
26794 If you do not want Exim to attempt to send messages unencrypted when an attempt
26795 to set up an encrypted connection fails in any way, you can set
26796 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26797 those hosts, delivery is always deferred if an encrypted connection cannot be
26798 set up. If there are any other hosts for the address, they are tried in the
26799 usual way.
26800
26801 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26802 the message unencrypted. It always does this if the response to STARTTLS is
26803 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26804 session after a success response code, what happens is controlled by the
26805 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26806 delivery to this host is deferred, and other hosts (if available) are tried. If
26807 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26808 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26809 negotiation fails, Exim closes the current connection (because it is in an
26810 unknown state), opens a new one to the same host, and then tries the delivery
26811 unencrypted.
26812
26813 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26814 transport provide the client with a certificate, which is passed to the server
26815 if it requests it. If the server is Exim, it will request a certificate only if
26816 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26817
26818 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26819 specifies a collection of expected server certificates.
26820 .new
26821 These may be the system default set (depending on library version),
26822 .wen
26823 a file or,
26824 depnding on liibrary version, a directory,
26825 must name a file or,
26826 for OpenSSL only (not GnuTLS), a directory.
26827 The client verifies the server's certificate
26828 against this collection, taking into account any revoked certificates that are
26829 in the list defined by &%tls_crl%&.
26830 Failure to verify fails the TLS connection unless either of the
26831 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26832
26833 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26834 certificate verification to the listed servers.  Verification either must
26835 or need not succeed respectively.
26836
26837 The &(smtp)& transport has two OCSP-related options:
26838 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26839 is requested and required for the connection to proceed.  The default
26840 value is empty.
26841 &%hosts_request_ocsp%&; a host-list for which (additionally)
26842 a Certificate Status is requested (but not necessarily verified).  The default
26843 value is "*" meaning that requests are made unless configured
26844 otherwise.
26845
26846 The host(s) should also be in &%hosts_require_tls%&, and
26847 &%tls_verify_certificates%& configured for the transport,
26848 for OCSP to be relevant.
26849
26850 If
26851 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26852 list of permitted cipher suites. If either of these checks fails, delivery to
26853 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26854 alternative hosts, if any.
26855
26856  &*Note*&:
26857 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26858 is operating as a client. Exim does not assume that a server certificate (set
26859 by the global options of the same name) should also be used when operating as a
26860 client.
26861
26862 .vindex "&$host$&"
26863 .vindex "&$host_address$&"
26864 All the TLS options in the &(smtp)& transport are expanded before use, with
26865 &$host$& and &$host_address$& containing the name and address of the server to
26866 which the client is connected. Forced failure of an expansion causes Exim to
26867 behave as if the relevant option were unset.
26868
26869 .vindex &$tls_out_bits$&
26870 .vindex &$tls_out_cipher$&
26871 .vindex &$tls_out_peerdn$&
26872 .vindex &$tls_out_sni$&
26873 Before an SMTP connection is established, the
26874 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26875 variables are emptied. (Until the first connection, they contain the values
26876 that were set when the message was received.) If STARTTLS is subsequently
26877 successfully obeyed, these variables are set to the relevant values for the
26878 outgoing connection.
26879
26880
26881
26882 .section "Use of TLS Server Name Indication" "SECTtlssni"
26883 .cindex "TLS" "Server Name Indication"
26884 .vindex "&$tls_in_sni$&"
26885 .oindex "&%tls_in_sni%&"
26886 With TLS1.0 or above, there is an extension mechanism by which extra
26887 information can be included at various points in the protocol.  One of these
26888 extensions, documented in RFC 6066 (and before that RFC 4366) is
26889 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26890 client in the initial handshake, so that the server can examine the servername
26891 within and possibly choose to use different certificates and keys (and more)
26892 for this session.
26893
26894 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26895 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26896 address.
26897
26898 With SMTP to MX, there are the same problems here as in choosing the identity
26899 against which to validate a certificate: you can't rely on insecure DNS to
26900 provide the identity which you then cryptographically verify.  So this will
26901 be of limited use in that environment.
26902
26903 With SMTP to Submission, there is a well-defined hostname which clients are
26904 connecting to and can validate certificates against.  Thus clients &*can*&
26905 choose to include this information in the TLS negotiation.  If this becomes
26906 wide-spread, then hosters can choose to present different certificates to
26907 different clients.  Or even negotiate different cipher suites.
26908
26909 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26910 if not empty, will be sent on a TLS session as part of the handshake.  There's
26911 nothing more to it.  Choosing a sensible value not derived insecurely is the
26912 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26913 for the lifetime of the client connection (including during authentication).
26914
26915 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26916 received from a client.
26917 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26918
26919 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26920 option (prior to expansion) then the following options will be re-expanded
26921 during TLS session handshake, to permit alternative values to be chosen:
26922
26923 .ilist
26924 .vindex "&%tls_certificate%&"
26925 &%tls_certificate%&
26926 .next
26927 .vindex "&%tls_crl%&"
26928 &%tls_crl%&
26929 .next
26930 .vindex "&%tls_privatekey%&"
26931 &%tls_privatekey%&
26932 .next
26933 .vindex "&%tls_verify_certificates%&"
26934 &%tls_verify_certificates%&
26935 .next
26936 .vindex "&%tls_ocsp_file%&"
26937 &%tls_ocsp_file%&
26938 .endlist
26939
26940 Great care should be taken to deal with matters of case, various injection
26941 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26942 can always be referenced; it is important to remember that &$tls_sni$& is
26943 arbitrary unverified data provided prior to authentication.
26944
26945 The Exim developers are proceeding cautiously and so far no other TLS options
26946 are re-expanded.
26947
26948 When Exim is built againt OpenSSL, OpenSSL must have been built with support
26949 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
26950 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
26951 see &`-servername`& in the output, then OpenSSL has support.
26952
26953 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
26954 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
26955 built, then you have SNI support).
26956
26957
26958
26959 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
26960          "SECTmulmessam"
26961 .cindex "multiple SMTP deliveries with TLS"
26962 .cindex "TLS" "multiple message deliveries"
26963 Exim sends multiple messages down the same TCP/IP connection by starting up
26964 an entirely new delivery process for each message, passing the socket from
26965 one process to the next. This implementation does not fit well with the use
26966 of TLS, because there is quite a lot of state information associated with a TLS
26967 connection, not just a socket identification. Passing all the state information
26968 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
26969 session before passing the socket to a new process. The new process may then
26970 try to start a new TLS session, and if successful, may try to re-authenticate
26971 if AUTH is in use, before sending the next message.
26972
26973 The RFC is not clear as to whether or not an SMTP session continues in clear
26974 after TLS has been shut down, or whether TLS may be restarted again later, as
26975 just described. However, if the server is Exim, this shutdown and
26976 reinitialization works. It is not known which (if any) other servers operate
26977 successfully if the client closes a TLS session and continues with unencrypted
26978 SMTP, but there are certainly some that do not work. For such servers, Exim
26979 should not pass the socket to another process, because the failure of the
26980 subsequent attempt to use it would cause Exim to record a temporary host error,
26981 and delay other deliveries to that host.
26982
26983 To test for this case, Exim sends an EHLO command to the server after
26984 closing down the TLS session. If this fails in any way, the connection is
26985 closed instead of being passed to a new delivery process, but no retry
26986 information is recorded.
26987
26988 There is also a manual override; you can set &%hosts_nopass_tls%& on the
26989 &(smtp)& transport to match those hosts for which Exim should not pass
26990 connections to new processes if TLS has been used.
26991
26992
26993
26994
26995 .section "Certificates and all that" "SECTcerandall"
26996 .cindex "certificate" "references to discussion"
26997 In order to understand fully how TLS works, you need to know about
26998 certificates, certificate signing, and certificate authorities. This is not the
26999 place to give a tutorial, especially as I do not know very much about it
27000 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27001 to Apache, currently at
27002 .display
27003 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27004 .endd
27005 Other parts of the &'modssl'& documentation are also helpful, and have
27006 links to further files.
27007 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27008 0-201-61598-3), contains both introductory and more in-depth descriptions.
27009 Some sample programs taken from the book are available from
27010 .display
27011 &url(http://www.rtfm.com/openssl-examples/)
27012 .endd
27013
27014
27015 .section "Certificate chains" "SECID186"
27016 The file named by &%tls_certificate%& may contain more than one
27017 certificate. This is useful in the case where the certificate that is being
27018 sent is validated by an intermediate certificate which the other end does
27019 not have. Multiple certificates must be in the correct order in the file.
27020 First the host's certificate itself, then the first intermediate
27021 certificate to validate the issuer of the host certificate, then the next
27022 intermediate certificate to validate the issuer of the first intermediate
27023 certificate, and so on, until finally (optionally) the root certificate.
27024 The root certificate must already be trusted by the recipient for
27025 validation to succeed, of course, but if it's not preinstalled, sending the
27026 root certificate along with the rest makes it available for the user to
27027 install if the receiving end is a client MUA that can interact with a user.
27028
27029 Note that certificates using MD5 are unlikely to work on today's Internet;
27030 even if your libraries allow loading them for use in Exim when acting as a
27031 server, increasingly clients will not accept such certificates.  The error
27032 diagnostics in such a case can be frustratingly vague.
27033
27034
27035
27036 .section "Self-signed certificates" "SECID187"
27037 .cindex "certificate" "self-signed"
27038 You can create a self-signed certificate using the &'req'& command provided
27039 with OpenSSL, like this:
27040 . ==== Do not shorten the duration here without reading and considering
27041 . ==== the text below.  Please leave it at 9999 days.
27042 .code
27043 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27044             -days 9999 -nodes
27045 .endd
27046 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27047 delimited and so can be identified independently. The &%-days%& option
27048 specifies a period for which the certificate is valid. The &%-nodes%& option is
27049 important: if you do not set it, the key is encrypted with a passphrase
27050 that you are prompted for, and any use that is made of the key causes more
27051 prompting for the passphrase. This is not helpful if you are going to use
27052 this certificate and key in an MTA, where prompting is not possible.
27053
27054 . ==== I expect to still be working 26 years from now.  The less technical
27055 . ==== debt I create, in terms of storing up trouble for my later years, the
27056 . ==== happier I will be then.  We really have reached the point where we
27057 . ==== should start, at the very least, provoking thought and making folks
27058 . ==== pause before proceeding, instead of leaving all the fixes until two
27059 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27060 . ==== -pdp, 2012
27061 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27062 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27063 the above command might produce a date in the past.  Think carefully about
27064 the lifetime of the systems you're deploying, and either reduce the duration
27065 of the certificate or reconsider your platform deployment.  (At time of
27066 writing, reducing the duration is the most likely choice, but the inexorable
27067 progression of time takes us steadily towards an era where this will not
27068 be a sensible resolution).
27069
27070 A self-signed certificate made in this way is sufficient for testing, and
27071 may be adequate for all your requirements if you are mainly interested in
27072 encrypting transfers, and not in secure identification.
27073
27074 However, many clients require that the certificate presented by the server be a
27075 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27076 certificate. In this situation, the self-signed certificate described above
27077 must be installed on the client host as a trusted root &'certification
27078 authority'& (CA), and the certificate used by Exim must be a user certificate
27079 signed with that self-signed certificate.
27080
27081 For information on creating self-signed CA certificates and using them to sign
27082 user certificates, see the &'General implementation overview'& chapter of the
27083 Open-source PKI book, available online at
27084 &url(http://ospkibook.sourceforge.net/).
27085 .ecindex IIDencsmtp1
27086 .ecindex IIDencsmtp2
27087
27088
27089
27090 . ////////////////////////////////////////////////////////////////////////////
27091 . ////////////////////////////////////////////////////////////////////////////
27092
27093 .chapter "Access control lists" "CHAPACL"
27094 .scindex IIDacl "&ACL;" "description"
27095 .cindex "control of incoming mail"
27096 .cindex "message" "controlling incoming"
27097 .cindex "policy control" "access control lists"
27098 Access Control Lists (ACLs) are defined in a separate section of the run time
27099 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27100 name, terminated by a colon. Here is a complete ACL section that contains just
27101 one very small ACL:
27102 .code
27103 begin acl
27104 small_acl:
27105   accept   hosts = one.host.only
27106 .endd
27107 You can have as many lists as you like in the ACL section, and the order in
27108 which they appear does not matter. The lists are self-terminating.
27109
27110 The majority of ACLs are used to control Exim's behaviour when it receives
27111 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27112 when a local process submits a message using SMTP by specifying the &%-bs%&
27113 option. The most common use is for controlling which recipients are accepted
27114 in incoming messages. In addition, you can define an ACL that is used to check
27115 local non-SMTP messages. The default configuration file contains an example of
27116 a realistic ACL for checking RCPT commands. This is discussed in chapter
27117 &<<CHAPdefconfil>>&.
27118
27119
27120 .section "Testing ACLs" "SECID188"
27121 The &%-bh%& command line option provides a way of testing your ACL
27122 configuration locally by running a fake SMTP session with which you interact.
27123 The host &'relay-test.mail-abuse.org'& provides a service for checking your
27124 relaying configuration (see section &<<SECTcheralcon>>& for more details).
27125
27126
27127
27128 .section "Specifying when ACLs are used" "SECID189"
27129 .cindex "&ACL;" "options for specifying"
27130 In order to cause an ACL to be used, you have to name it in one of the relevant
27131 options in the main part of the configuration. These options are:
27132 .cindex "AUTH" "ACL for"
27133 .cindex "DATA" "ACLs for"
27134 .cindex "ETRN" "ACL for"
27135 .cindex "EXPN" "ACL for"
27136 .cindex "HELO" "ACL for"
27137 .cindex "EHLO" "ACL for"
27138 .cindex "DKIM" "ACL for"
27139 .cindex "MAIL" "ACL for"
27140 .cindex "QUIT, ACL for"
27141 .cindex "RCPT" "ACL for"
27142 .cindex "STARTTLS, ACL for"
27143 .cindex "VRFY" "ACL for"
27144 .cindex "SMTP" "connection, ACL for"
27145 .cindex "non-SMTP messages" "ACLs for"
27146 .cindex "MIME content scanning" "ACL for"
27147 .cindex "PRDR" "ACL for"
27148
27149 .table2 140pt
27150 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27151 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27152 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27153 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27154 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27155 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27156 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27157 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27158 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27159 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27160 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27161 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27162 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27163 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27164 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27165 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27166 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27167 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27168 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27169 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27170 .endtable
27171
27172 For example, if you set
27173 .code
27174 acl_smtp_rcpt = small_acl
27175 .endd
27176 the little ACL defined above is used whenever Exim receives a RCPT command
27177 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27178 done when RCPT commands arrive. A rejection of RCPT should cause the
27179 sending MTA to give up on the recipient address contained in the RCPT
27180 command, whereas rejection at other times may cause the client MTA to keep on
27181 trying to deliver the message. It is therefore recommended that you do as much
27182 testing as possible at RCPT time.
27183
27184
27185 .section "The non-SMTP ACLs" "SECID190"
27186 .cindex "non-SMTP messages" "ACLs for"
27187 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27188 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27189 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27190 the state of the SMTP connection such as encryption and authentication) are not
27191 relevant and are forbidden in these ACLs. However, the sender and recipients
27192 are known, so the &%senders%& and &%sender_domains%& conditions and the
27193 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27194 &$authenticated_sender$& are also available. You can specify added header lines
27195 in any of these ACLs.
27196
27197 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27198 non-SMTP message, before any of the message has been read. (This is the
27199 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27200 batched SMTP input, it runs after the DATA command has been reached. The
27201 result of this ACL is ignored; it cannot be used to reject a message. If you
27202 really need to, you could set a value in an ACL variable here and reject based
27203 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27204 controls, and in particular, it can be used to set
27205 .code
27206 control = suppress_local_fixups
27207 .endd
27208 This cannot be used in the other non-SMTP ACLs because by the time they are
27209 run, it is too late.
27210
27211 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27212 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27213
27214 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27215 kind of rejection is treated as permanent, because there is no way of sending a
27216 temporary error for these kinds of message.
27217
27218
27219 .section "The SMTP connect ACL" "SECID191"
27220 .cindex "SMTP" "connection, ACL for"
27221 .oindex &%smtp_banner%&
27222 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27223 session, after the test specified by &%host_reject_connection%& (which is now
27224 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27225 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27226 the message override the banner message that is otherwise specified by the
27227 &%smtp_banner%& option.
27228
27229
27230 .section "The EHLO/HELO ACL" "SECID192"
27231 .cindex "EHLO" "ACL for"
27232 .cindex "HELO" "ACL for"
27233 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27234 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27235 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27236 Note that a client may issue more than one EHLO or HELO command in an SMTP
27237 session, and indeed is required to issue a new EHLO or HELO after successfully
27238 setting up encryption following a STARTTLS command.
27239
27240 If the command is accepted by an &%accept%& verb that has a &%message%&
27241 modifier, the message may not contain more than one line (it will be truncated
27242 at the first newline and a panic logged if it does). Such a message cannot
27243 affect the EHLO options that are listed on the second and subsequent lines of
27244 an EHLO response.
27245
27246
27247 .section "The DATA ACLs" "SECID193"
27248 .cindex "DATA" "ACLs for"
27249 Two ACLs are associated with the DATA command, because it is two-stage
27250 command, with two responses being sent to the client.
27251 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27252 is obeyed. This gives you control after all the RCPT commands, but before
27253 the message itself is received. It offers the opportunity to give a negative
27254 response to the DATA command before the data is transmitted. Header lines
27255 added by MAIL or RCPT ACLs are not visible at this time, but any that
27256 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27257
27258 You cannot test the contents of the message, for example, to verify addresses
27259 in the headers, at RCPT time or when the DATA command is received. Such
27260 tests have to appear in the ACL that is run after the message itself has been
27261 received, before the final response to the DATA command is sent. This is
27262 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27263 associated with the DATA command.
27264
27265 For both of these ACLs, it is not possible to reject individual recipients. An
27266 error response rejects the entire message. Unfortunately, it is known that some
27267 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27268 before or after the data) correctly &-- they keep the message on their queues
27269 and try again later, but that is their problem, though it does waste some of
27270 your resources.
27271
27272 The &%acl_smtp_data%& ACL is run after
27273 the &%acl_smtp_data_prdr%&,
27274 the &%acl_smtp_dkim%&
27275 and the &%acl_smtp_mime%& ACLs.
27276
27277 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27278 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27279 enabled (which is the default).
27280
27281 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27282 received, and is executed for each DKIM signature found in a message.  If not
27283 otherwise specified, the default action is to accept.
27284
27285 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27286
27287 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27288
27289
27290 .section "The SMTP MIME ACL" "SECID194"
27291 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27292 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27293
27294 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27295
27296
27297 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27298 .cindex "PRDR" "ACL for"
27299 .oindex "&%prdr_enable%&"
27300 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27301 with PRDR support enabled (which is the default).
27302 It becomes active only when the PRDR feature is negotiated between
27303 client and server for a message, and more than one recipient
27304 has been accepted.
27305
27306 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27307 has been recieved, and is executed once for each recipient of the message
27308 with &$local_part$& and &$domain$& valid.
27309 The test may accept, defer or deny for inividual recipients.
27310 The &%acl_smtp_data%& will still be called after this ACL and
27311 can reject the message overall, even if this ACL has accepted it
27312 for some or all recipients.
27313
27314 PRDR may be used to support per-user content filtering.  Without it
27315 one must defer any recipient after the first that has a different
27316 content-filter configuration.  With PRDR, the RCPT-time check
27317 for this can be disabled when the MAIL-time $smtp_command included
27318 "PRDR".  Any required difference in behaviour of the main DATA-time
27319 ACL should however depend on the PRDR-time ACL having run, as Exim
27320 will avoid doing so in some situations (eg.  single-recipient mails).
27321
27322 See also the &%prdr_enable%& global option
27323 and the &%hosts_try_prdr%& smtp transport option.
27324
27325 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27326 If the ACL is not defined, processing completes as if
27327 the feature was not requested by the client.
27328
27329 .section "The QUIT ACL" "SECTQUITACL"
27330 .cindex "QUIT, ACL for"
27331 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27332 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27333 does not in fact control any access. For this reason, it may only accept
27334 or warn as its final result.
27335
27336 This ACL can be used for tasks such as custom logging at the end of an SMTP
27337 session. For example, you can use ACL variables in other ACLs to count
27338 messages, recipients, etc., and log the totals at QUIT time using one or
27339 more &%logwrite%& modifiers on a &%warn%& verb.
27340
27341 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27342 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27343
27344 You do not need to have a final &%accept%&, but if you do, you can use a
27345 &%message%& modifier to specify custom text that is sent as part of the 221
27346 response to QUIT.
27347
27348 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27349 failure (for example, failure to open a log file, or when Exim is bombing out
27350 because it has detected an unrecoverable error), all SMTP commands from the
27351 client are given temporary error responses until QUIT is received or the
27352 connection is closed. In these special cases, the QUIT ACL does not run.
27353
27354
27355 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27356 .vindex &$acl_smtp_notquit$&
27357 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27358 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27359 trouble, such as being unable to write to its log files, this ACL is not run,
27360 because it might try to do things (such as write to log files) that make the
27361 situation even worse.
27362
27363 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27364 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27365 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27366 and &%warn%&.
27367
27368 .vindex &$smtp_notquit_reason$&
27369 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27370 to a string that indicates the reason for the termination of the SMTP
27371 connection. The possible values are:
27372 .table2
27373 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27374 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27375 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27376 .irow &`connection-lost`&          "The SMTP connection has been lost"
27377 .irow &`data-timeout`&             "Timeout while reading message data"
27378 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27379 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27380 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27381 .irow &`synchronization-error`&    "SMTP synchronization error"
27382 .irow &`tls-failed`&               "TLS failed to start"
27383 .endtable
27384 In most cases when an SMTP connection is closed without having received QUIT,
27385 Exim sends an SMTP response message before actually closing the connection.
27386 With the exception of the &`acl-drop`& case, the default message can be
27387 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27388 &%drop%& verb in another ACL, it is the message from the other ACL that is
27389 used.
27390
27391
27392 .section "Finding an ACL to use" "SECID195"
27393 .cindex "&ACL;" "finding which to use"
27394 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27395 you can use different ACLs in different circumstances. For example,
27396 .code
27397 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27398                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27399 .endd
27400 In the default configuration file there are some example settings for
27401 providing an RFC 4409 message submission service on port 587 and a
27402 non-standard &"smtps"& service on port 465. You can use a string
27403 expansion like this to choose an ACL for MUAs on these ports which is
27404 more appropriate for this purpose than the default ACL on port 25.
27405
27406 The expanded string does not have to be the name of an ACL in the
27407 configuration file; there are other possibilities. Having expanded the
27408 string, Exim searches for an ACL as follows:
27409
27410 .ilist
27411 If the string begins with a slash, Exim uses it as a file name, and reads its
27412 contents as an ACL. The lines are processed in the same way as lines in the
27413 Exim configuration file. In particular, continuation lines are supported, blank
27414 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27415 If the file does not exist or cannot be read, an error occurs (typically
27416 causing a temporary failure of whatever caused the ACL to be run). For example:
27417 .code
27418 acl_smtp_data = /etc/acls/\
27419   ${lookup{$sender_host_address}lsearch\
27420   {/etc/acllist}{$value}{default}}
27421 .endd
27422 This looks up an ACL file to use on the basis of the host's IP address, falling
27423 back to a default if the lookup fails. If an ACL is successfully read from a
27424 file, it is retained in memory for the duration of the Exim process, so that it
27425 can be re-used without having to re-read the file.
27426 .next
27427 If the string does not start with a slash, and does not contain any spaces,
27428 Exim searches the ACL section of the configuration for an ACL whose name
27429 matches the string.
27430 .next
27431 If no named ACL is found, or if the string contains spaces, Exim parses
27432 the string as an inline ACL. This can save typing in cases where you just
27433 want to have something like
27434 .code
27435 acl_smtp_vrfy = accept
27436 .endd
27437 in order to allow free use of the VRFY command. Such a string may contain
27438 newlines; it is processed in the same way as an ACL that is read from a file.
27439 .endlist
27440
27441
27442
27443
27444 .section "ACL return codes" "SECID196"
27445 .cindex "&ACL;" "return codes"
27446 Except for the QUIT ACL, which does not affect the SMTP return code (see
27447 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27448 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27449 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27450 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27451 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27452 This also causes a 4&'xx'& return code.
27453
27454 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27455 &"deny"&, because there is no mechanism for passing temporary errors to the
27456 submitters of non-SMTP messages.
27457
27458
27459 ACLs that are relevant to message reception may also return &"discard"&. This
27460 has the effect of &"accept"&, but causes either the entire message or an
27461 individual recipient address to be discarded. In other words, it is a
27462 blackholing facility. Use it with care.
27463
27464 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27465 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27466 RCPT ACL is to discard just the one recipient address. If there are no
27467 recipients left when the message's data is received, the DATA ACL is not
27468 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27469 remaining recipients. The &"discard"& return is not permitted for the
27470 &%acl_smtp_predata%& ACL.
27471
27472
27473 .cindex "&[local_scan()]& function" "when all recipients discarded"
27474 The &[local_scan()]& function is always run, even if there are no remaining
27475 recipients; it may create new recipients.
27476
27477
27478
27479 .section "Unset ACL options" "SECID197"
27480 .cindex "&ACL;" "unset options"
27481 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27482 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27483 not defined at all. For any defined ACL, the default action when control
27484 reaches the end of the ACL statements is &"deny"&.
27485
27486 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27487 these two are ACLs that are used only for their side effects. They cannot be
27488 used to accept or reject anything.
27489
27490 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27491 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27492 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27493 when the ACL is not defined is &"accept"&.
27494
27495 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27496 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27497 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27498 messages over an SMTP connection. For an example, see the ACL in the default
27499 configuration file.
27500
27501
27502
27503
27504 .section "Data for message ACLs" "SECID198"
27505 .cindex "&ACL;" "data for message ACL"
27506 .vindex &$domain$&
27507 .vindex &$local_part$&
27508 .vindex &$sender_address$&
27509 .vindex &$sender_host_address$&
27510 .vindex &$smtp_command$&
27511 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27512 that contain information about the host and the message's sender (for example,
27513 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27514 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27515 &$local_part$& are set from the argument address. The entire SMTP command
27516 is available in &$smtp_command$&.
27517
27518 When an ACL for the AUTH parameter of MAIL is running, the variables that
27519 contain information about the host are set, but &$sender_address$& is not yet
27520 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27521 how it is used.
27522
27523 .vindex "&$message_size$&"
27524 The &$message_size$& variable is set to the value of the SIZE parameter on
27525 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27526 that parameter is not given. The value is updated to the true message size by
27527 the time the final DATA ACL is run (after the message data has been
27528 received).
27529
27530 .vindex "&$rcpt_count$&"
27531 .vindex "&$recipients_count$&"
27532 The &$rcpt_count$& variable increases by one for each RCPT command received.
27533 The &$recipients_count$& variable increases by one each time a RCPT command is
27534 accepted, so while an ACL for RCPT is being processed, it contains the number
27535 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27536 &$rcpt_count$& contains the total number of RCPT commands, and
27537 &$recipients_count$& contains the total number of accepted recipients.
27538
27539
27540
27541
27542
27543 .section "Data for non-message ACLs" "SECTdatfornon"
27544 .cindex "&ACL;" "data for non-message ACL"
27545 .vindex &$smtp_command_argument$&
27546 .vindex &$smtp_command$&
27547 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27548 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27549 and the entire SMTP command is available in &$smtp_command$&.
27550 These variables can be tested using a &%condition%& condition. For example,
27551 here is an ACL for use with AUTH, which insists that either the session is
27552 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27553 does not permit authentication methods that use cleartext passwords on
27554 unencrypted connections.
27555 .code
27556 acl_check_auth:
27557   accept encrypted = *
27558   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27559                      {CRAM-MD5}}
27560   deny   message   = TLS encryption or CRAM-MD5 required
27561 .endd
27562 (Another way of applying this restriction is to arrange for the authenticators
27563 that use cleartext passwords not to be advertised when the connection is not
27564 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27565 option to do this.)
27566
27567
27568
27569 .section "Format of an ACL" "SECID199"
27570 .cindex "&ACL;" "format of"
27571 .cindex "&ACL;" "verbs, definition of"
27572 An individual ACL consists of a number of statements. Each statement starts
27573 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27574 Modifiers can change the way the verb operates, define error and log messages,
27575 set variables, insert delays, and vary the processing of accepted messages.
27576
27577 If all the conditions are met, the verb is obeyed. The same condition may be
27578 used (with different arguments) more than once in the same statement. This
27579 provides a means of specifying an &"and"& conjunction between conditions. For
27580 example:
27581 .code
27582 deny  dnslists = list1.example
27583 dnslists = list2.example
27584 .endd
27585 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27586 the conditions and modifiers when it reaches a condition that fails. What
27587 happens then depends on the verb (and in one case, on a special modifier). Not
27588 all the conditions make sense at every testing point. For example, you cannot
27589 test a sender address in the ACL that is run for a VRFY command.
27590
27591
27592 .section "ACL verbs" "SECID200"
27593 The ACL verbs are as follows:
27594
27595 .ilist
27596 .cindex "&%accept%& ACL verb"
27597 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27598 of the conditions are not met, what happens depends on whether &%endpass%&
27599 appears among the conditions (for syntax see below). If the failing condition
27600 is before &%endpass%&, control is passed to the next ACL statement; if it is
27601 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27602 check a RCPT command:
27603 .code
27604 accept domains = +local_domains
27605 endpass
27606 verify = recipient
27607 .endd
27608 If the recipient domain does not match the &%domains%& condition, control
27609 passes to the next statement. If it does match, the recipient is verified, and
27610 the command is accepted if verification succeeds. However, if verification
27611 fails, the ACL yields &"deny"&, because the failing condition is after
27612 &%endpass%&.
27613
27614 The &%endpass%& feature has turned out to be confusing to many people, so its
27615 use is not recommended nowadays. It is always possible to rewrite an ACL so
27616 that &%endpass%& is not needed, and it is no longer used in the default
27617 configuration.
27618
27619 .cindex "&%message%& ACL modifier" "with &%accept%&"
27620 If a &%message%& modifier appears on an &%accept%& statement, its action
27621 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27622 (when an &%accept%& verb either accepts or passes control to the next
27623 statement), &%message%& can be used to vary the message that is sent when an
27624 SMTP command is accepted. For example, in a RCPT ACL you could have:
27625 .display
27626 &`accept  `&<&'some conditions'&>
27627 &`        message = OK, I will allow you through today`&
27628 .endd
27629 You can specify an SMTP response code, optionally followed by an &"extended
27630 response code"& at the start of the message, but the first digit must be the
27631 same as would be sent by default, which is 2 for an &%accept%& verb.
27632
27633 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27634 an error message that is used when access is denied. This behaviour is retained
27635 for backward compatibility, but current &"best practice"& is to avoid the use
27636 of &%endpass%&.
27637
27638
27639 .next
27640 .cindex "&%defer%& ACL verb"
27641 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27642 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27643 &%defer%& is the same as &%deny%&, because there is no way of sending a
27644 temporary error. For a RCPT command, &%defer%& is much the same as using a
27645 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27646 be used in any ACL, and even for a recipient it might be a simpler approach.
27647
27648
27649 .next
27650 .cindex "&%deny%& ACL verb"
27651 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27652 the conditions are not met, control is passed to the next ACL statement. For
27653 example,
27654 .code
27655 deny dnslists = blackholes.mail-abuse.org
27656 .endd
27657 rejects commands from hosts that are on a DNS black list.
27658
27659
27660 .next
27661 .cindex "&%discard%& ACL verb"
27662 &%discard%&: This verb behaves like &%accept%&, except that it returns
27663 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27664 that are concerned with receiving messages. When all the conditions are true,
27665 the sending entity receives a &"success"& response. However, &%discard%& causes
27666 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27667 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27668 message's recipients are discarded. Recipients that are discarded before DATA
27669 do not appear in the log line when the &%received_recipients%& log selector is set.
27670
27671 If the &%log_message%& modifier is set when &%discard%& operates,
27672 its contents are added to the line that is automatically written to the log.
27673 The &%message%& modifier operates exactly as it does for &%accept%&.
27674
27675
27676 .next
27677 .cindex "&%drop%& ACL verb"
27678 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27679 forcibly closed after the 5&'xx'& error message has been sent. For example:
27680 .code
27681 drop   message   = I don't take more than 20 RCPTs
27682        condition = ${if > {$rcpt_count}{20}}
27683 .endd
27684 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27685 The connection is always dropped after sending a 550 response.
27686
27687 .next
27688 .cindex "&%require%& ACL verb"
27689 &%require%&: If all the conditions are met, control is passed to the next ACL
27690 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27691 example, when checking a RCPT command,
27692 .code
27693 require message = Sender did not verify
27694         verify  = sender
27695 .endd
27696 passes control to subsequent statements only if the message's sender can be
27697 verified. Otherwise, it rejects the command. Note the positioning of the
27698 &%message%& modifier, before the &%verify%& condition. The reason for this is
27699 discussed in section &<<SECTcondmodproc>>&.
27700
27701 .next
27702 .cindex "&%warn%& ACL verb"
27703 &%warn%&: If all the conditions are true, a line specified by the
27704 &%log_message%& modifier is written to Exim's main log. Control always passes
27705 to the next ACL statement. If any condition is false, the log line is not
27706 written. If an identical log line is requested several times in the same
27707 message, only one copy is actually written to the log. If you want to force
27708 duplicates to be written, use the &%logwrite%& modifier instead.
27709
27710 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27711 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27712 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27713 first failing condition. There is more about adding header lines in section
27714 &<<SECTaddheadacl>>&.
27715
27716 If any condition on a &%warn%& statement cannot be completed (that is, there is
27717 some sort of defer), the log line specified by &%log_message%& is not written.
27718 This does not include the case of a forced failure from a lookup, which
27719 is considered to be a successful completion. After a defer, no further
27720 conditions or modifiers in the &%warn%& statement are processed. The incident
27721 is logged, and the ACL continues to be processed, from the next statement
27722 onwards.
27723
27724
27725 .vindex "&$acl_verify_message$&"
27726 When one of the &%warn%& conditions is an address verification that fails, the
27727 text of the verification failure message is in &$acl_verify_message$&. If you
27728 want this logged, you must set it up explicitly. For example:
27729 .code
27730 warn   !verify = sender
27731        log_message = sender verify failed: $acl_verify_message
27732 .endd
27733 .endlist
27734
27735 At the end of each ACL there is an implicit unconditional &%deny%&.
27736
27737 As you can see from the examples above, the conditions and modifiers are
27738 written one to a line, with the first one on the same line as the verb, and
27739 subsequent ones on following lines. If you have a very long condition, you can
27740 continue it onto several physical lines by the usual backslash continuation
27741 mechanism. It is conventional to align the conditions vertically.
27742
27743
27744
27745 .section "ACL variables" "SECTaclvariables"
27746 .cindex "&ACL;" "variables"
27747 There are some special variables that can be set during ACL processing. They
27748 can be used to pass information between different ACLs, different invocations
27749 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27750 transports, and filters that are used to deliver a message. The names of these
27751 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27752 an underscore, but the remainder of the name can be any sequence of
27753 alphanumeric characters and underscores that you choose. There is no limit on
27754 the number of ACL variables. The two sets act as follows:
27755 .ilist
27756 The values of those variables whose names begin with &$acl_c$& persist
27757 throughout an SMTP connection. They are never reset. Thus, a value that is set
27758 while receiving one message is still available when receiving the next message
27759 on the same SMTP connection.
27760 .next
27761 The values of those variables whose names begin with &$acl_m$& persist only
27762 while a message is being received. They are reset afterwards. They are also
27763 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27764 .endlist
27765
27766 When a message is accepted, the current values of all the ACL variables are
27767 preserved with the message and are subsequently made available at delivery
27768 time. The ACL variables are set by a modifier called &%set%&. For example:
27769 .code
27770 accept hosts = whatever
27771        set acl_m4 = some value
27772 accept authenticated = *
27773        set acl_c_auth = yes
27774 .endd
27775 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27776 be set. If you want to set a variable without taking any action, you can use a
27777 &%warn%& verb without any other modifiers or conditions.
27778
27779 .oindex &%strict_acl_vars%&
27780 What happens if a syntactically valid but undefined ACL variable is
27781 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27782 false (the default), an empty string is substituted; if it is true, an
27783 error is generated.
27784
27785 Versions of Exim before 4.64 have a limited set of numbered variables, but
27786 their names are compatible, so there is no problem with upgrading.
27787
27788
27789 .section "Condition and modifier processing" "SECTcondmodproc"
27790 .cindex "&ACL;" "conditions; processing"
27791 .cindex "&ACL;" "modifiers; processing"
27792 An exclamation mark preceding a condition negates its result. For example:
27793 .code
27794 deny   domains = *.dom.example
27795       !verify  = recipient
27796 .endd
27797 causes the ACL to return &"deny"& if the recipient domain ends in
27798 &'dom.example'& and the recipient address cannot be verified. Sometimes
27799 negation can be used on the right-hand side of a condition. For example, these
27800 two statements are equivalent:
27801 .code
27802 deny  hosts = !192.168.3.4
27803 deny !hosts =  192.168.3.4
27804 .endd
27805 However, for many conditions (&%verify%& being a good example), only left-hand
27806 side negation of the whole condition is possible.
27807
27808 The arguments of conditions and modifiers are expanded. A forced failure
27809 of an expansion causes a condition to be ignored, that is, it behaves as if the
27810 condition is true. Consider these two statements:
27811 .code
27812 accept  senders = ${lookup{$host_name}lsearch\
27813                   {/some/file}{$value}fail}
27814 accept  senders = ${lookup{$host_name}lsearch\
27815                   {/some/file}{$value}{}}
27816 .endd
27817 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27818 the returned list is searched, but if the lookup fails the behaviour is
27819 different in the two cases. The &%fail%& in the first statement causes the
27820 condition to be ignored, leaving no further conditions. The &%accept%& verb
27821 therefore succeeds. The second statement, however, generates an empty list when
27822 the lookup fails. No sender can match an empty list, so the condition fails,
27823 and therefore the &%accept%& also fails.
27824
27825 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27826 specify actions that are taken as the conditions for a statement are checked;
27827 others specify text for messages that are used when access is denied or a
27828 warning is generated. The &%control%& modifier affects the way an incoming
27829 message is handled.
27830
27831 The positioning of the modifiers in an ACL statement is important, because the
27832 processing of a verb ceases as soon as its outcome is known. Only those
27833 modifiers that have already been encountered will take effect. For example,
27834 consider this use of the &%message%& modifier:
27835 .code
27836 require message = Can't verify sender
27837         verify  = sender
27838         message = Can't verify recipient
27839         verify  = recipient
27840         message = This message cannot be used
27841 .endd
27842 If sender verification fails, Exim knows that the result of the statement is
27843 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27844 so its text is used as the error message. If sender verification succeeds, but
27845 recipient verification fails, the second message is used. If recipient
27846 verification succeeds, the third message becomes &"current"&, but is never used
27847 because there are no more conditions to cause failure.
27848
27849 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27850 modifier that is used, because all the conditions must be true for rejection to
27851 happen. Specifying more than one &%message%& modifier does not make sense, and
27852 the message can even be specified after all the conditions. For example:
27853 .code
27854 deny   hosts = ...
27855       !senders = *@my.domain.example
27856        message = Invalid sender from client host
27857 .endd
27858 The &"deny"& result does not happen until the end of the statement is reached,
27859 by which time Exim has set up the message.
27860
27861
27862
27863 .section "ACL modifiers" "SECTACLmodi"
27864 .cindex "&ACL;" "modifiers; list of"
27865 The ACL modifiers are as follows:
27866
27867 .vlist
27868 .vitem &*add_header*&&~=&~<&'text'&>
27869 This modifier specifies one or more header lines that are to be added to an
27870 incoming message, assuming, of course, that the message is ultimately
27871 accepted. For details, see section &<<SECTaddheadacl>>&.
27872
27873 .vitem &*continue*&&~=&~<&'text'&>
27874 .cindex "&%continue%& ACL modifier"
27875 .cindex "database" "updating in ACL"
27876 This modifier does nothing of itself, and processing of the ACL always
27877 continues with the next condition or modifier. The value of &%continue%& is in
27878 the side effects of expanding its argument. Typically this could be used to
27879 update a database. It is really just a syntactic tidiness, to avoid having to
27880 write rather ugly lines like this:
27881 .display
27882 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27883 .endd
27884 Instead, all you need is
27885 .display
27886 &`continue = `&<&'some expansion'&>
27887 .endd
27888
27889 .vitem &*control*&&~=&~<&'text'&>
27890 .cindex "&%control%& ACL modifier"
27891 This modifier affects the subsequent processing of the SMTP connection or of an
27892 incoming message that is accepted. The effect of the first type of control
27893 lasts for the duration of the connection, whereas the effect of the second type
27894 lasts only until the current message has been received. The message-specific
27895 controls always apply to the whole message, not to individual recipients,
27896 even if the &%control%& modifier appears in a RCPT ACL.
27897
27898 As there are now quite a few controls that can be applied, they are described
27899 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27900 in several different ways. For example:
27901
27902 . ==== As this is a nested list, any displays it contains must be indented
27903 . ==== as otherwise they are too far to the left. That comment applies only
27904 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27905 . ==== way.
27906
27907 .ilist
27908 It can be at the end of an &%accept%& statement:
27909 .code
27910     accept  ...some conditions
27911             control = queue_only
27912 .endd
27913 In this case, the control is applied when this statement yields &"accept"&, in
27914 other words, when the conditions are all true.
27915
27916 .next
27917 It can be in the middle of an &%accept%& statement:
27918 .code
27919     accept  ...some conditions...
27920             control = queue_only
27921             ...some more conditions...
27922 .endd
27923 If the first set of conditions are true, the control is applied, even if the
27924 statement does not accept because one of the second set of conditions is false.
27925 In this case, some subsequent statement must yield &"accept"& for the control
27926 to be relevant.
27927
27928 .next
27929 It can be used with &%warn%& to apply the control, leaving the
27930 decision about accepting or denying to a subsequent verb. For
27931 example:
27932 .code
27933     warn    ...some conditions...
27934             control = freeze
27935     accept  ...
27936 .endd
27937 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27938 &%logwrite%&, so it does not add anything to the message and does not write a
27939 log entry.
27940
27941 .next
27942 If you want to apply a control unconditionally, you can use it with a
27943 &%require%& verb. For example:
27944 .code
27945     require  control = no_multiline_responses
27946 .endd
27947 .endlist
27948
27949 .vitem &*delay*&&~=&~<&'time'&>
27950 .cindex "&%delay%& ACL modifier"
27951 .oindex "&%-bh%&"
27952 This modifier may appear in any ACL except notquit. It causes Exim to wait for
27953 the time interval before proceeding. However, when testing Exim using the
27954 &%-bh%& option, the delay is not actually imposed (an appropriate message is
27955 output instead). The time is given in the usual Exim notation, and the delay
27956 happens as soon as the modifier is processed. In an SMTP session, pending
27957 output is flushed before the delay is imposed.
27958
27959 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
27960 example:
27961 .code
27962 deny    ...some conditions...
27963         delay = 30s
27964 .endd
27965 The delay happens if all the conditions are true, before the statement returns
27966 &"deny"&. Compare this with:
27967 .code
27968 deny    delay = 30s
27969         ...some conditions...
27970 .endd
27971 which waits for 30s before processing the conditions. The &%delay%& modifier
27972 can also be used with &%warn%& and together with &%control%&:
27973 .code
27974 warn    ...some conditions...
27975         delay = 2m
27976         control = freeze
27977 accept  ...
27978 .endd
27979
27980 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
27981 responses to several commands are no longer buffered and sent in one packet (as
27982 they would normally be) because all output is flushed before imposing the
27983 delay. This optimization is disabled so that a number of small delays do not
27984 appear to the client as one large aggregated delay that might provoke an
27985 unwanted timeout. You can, however, disable output flushing for &%delay%& by
27986 using a &%control%& modifier to set &%no_delay_flush%&.
27987
27988
27989 .vitem &*endpass*&
27990 .cindex "&%endpass%& ACL modifier"
27991 This modifier, which has no argument, is recognized only in &%accept%& and
27992 &%discard%& statements. It marks the boundary between the conditions whose
27993 failure causes control to pass to the next statement, and the conditions whose
27994 failure causes the ACL to return &"deny"&. This concept has proved to be
27995 confusing to some people, so the use of &%endpass%& is no longer recommended as
27996 &"best practice"&. See the description of &%accept%& above for more details.
27997
27998
27999 .vitem &*log_message*&&~=&~<&'text'&>
28000 .cindex "&%log_message%& ACL modifier"
28001 This modifier sets up a message that is used as part of the log message if the
28002 ACL denies access or a &%warn%& statement's conditions are true. For example:
28003 .code
28004 require log_message = wrong cipher suite $tls_in_cipher
28005         encrypted   = DES-CBC3-SHA
28006 .endd
28007 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28008 example:
28009 .display
28010 &`discard `&<&'some conditions'&>
28011 &`        log_message = Discarded $local_part@$domain because...`&
28012 .endd
28013 When access is denied, &%log_message%& adds to any underlying error message
28014 that may exist because of a condition failure. For example, while verifying a
28015 recipient address, a &':fail:'& redirection might have already set up a
28016 message.
28017
28018 The message may be defined before the conditions to which it applies, because
28019 the string expansion does not happen until Exim decides that access is to be
28020 denied. This means that any variables that are set by the condition are
28021 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28022 variables are set after a DNS black list lookup succeeds. If the expansion of
28023 &%log_message%& fails, or if the result is an empty string, the modifier is
28024 ignored.
28025
28026 .vindex "&$acl_verify_message$&"
28027 If you want to use a &%warn%& statement to log the result of an address
28028 verification, you can use &$acl_verify_message$& to include the verification
28029 error message.
28030
28031 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28032 the start of the logged message. If the same warning log message is requested
28033 more than once while receiving  a single email message, only one copy is
28034 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28035 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28036 is logged for a successful &%warn%& statement.
28037
28038 If &%log_message%& is not present and there is no underlying error message (for
28039 example, from the failure of address verification), but &%message%& is present,
28040 the &%message%& text is used for logging rejections. However, if any text for
28041 logging contains newlines, only the first line is logged. In the absence of
28042 both &%log_message%& and &%message%&, a default built-in message is used for
28043 logging rejections.
28044
28045
28046 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28047 .cindex "&%log_reject_target%& ACL modifier"
28048 .cindex "logging in ACL" "specifying which log"
28049 This modifier makes it possible to specify which logs are used for messages
28050 about ACL rejections. Its argument is a colon-separated list of words that can
28051 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28052 may be empty, in which case a rejection is not logged at all. For example, this
28053 ACL fragment writes no logging information when access is denied:
28054 .display
28055 &`deny `&<&'some conditions'&>
28056 &`     log_reject_target =`&
28057 .endd
28058 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28059 permanent and temporary rejections. Its effect lasts for the rest of the
28060 current ACL.
28061
28062
28063 .vitem &*logwrite*&&~=&~<&'text'&>
28064 .cindex "&%logwrite%& ACL modifier"
28065 .cindex "logging in ACL" "immediate"
28066 This modifier writes a message to a log file as soon as it is encountered when
28067 processing an ACL. (Compare &%log_message%&, which, except in the case of
28068 &%warn%& and &%discard%&, is used only if the ACL statement denies
28069 access.) The &%logwrite%& modifier can be used to log special incidents in
28070 ACLs. For example:
28071 .display
28072 &`accept `&<&'some special conditions'&>
28073 &`       control  = freeze`&
28074 &`       logwrite = froze message because ...`&
28075 .endd
28076 By default, the message is written to the main log. However, it may begin
28077 with a colon, followed by a comma-separated list of log names, and then
28078 another colon, to specify exactly which logs are to be written. For
28079 example:
28080 .code
28081 logwrite = :main,reject: text for main and reject logs
28082 logwrite = :panic: text for panic log only
28083 .endd
28084
28085
28086 .vitem &*message*&&~=&~<&'text'&>
28087 .cindex "&%message%& ACL modifier"
28088 This modifier sets up a text string that is expanded and used as a response
28089 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28090 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28091 there is some complication if &%endpass%& is involved; see the description of
28092 &%accept%& for details.)
28093
28094 The expansion of the message happens at the time Exim decides that the ACL is
28095 to end, not at the time it processes &%message%&. If the expansion fails, or
28096 generates an empty string, the modifier is ignored. Here is an example where
28097 &%message%& must be specified first, because the ACL ends with a rejection if
28098 the &%hosts%& condition fails:
28099 .code
28100 require  message = Host not recognized
28101          hosts = 10.0.0.0/8
28102 .endd
28103 (Once a condition has failed, no further conditions or modifiers are
28104 processed.)
28105
28106 .cindex "SMTP" "error codes"
28107 .oindex "&%smtp_banner%&
28108 For ACLs that are triggered by SMTP commands, the message is returned as part
28109 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28110 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28111 is accepted. In the case of the connect ACL, accepting with a message modifier
28112 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28113 accept message may not contain more than one line (otherwise it will be
28114 truncated at the first newline and a panic logged), and it cannot affect the
28115 EHLO options.
28116
28117 When SMTP is involved, the message may begin with an overriding response code,
28118 consisting of three digits optionally followed by an &"extended response code"&
28119 of the form &'n.n.n'&, each code being followed by a space. For example:
28120 .code
28121 deny  message = 599 1.2.3 Host not welcome
28122       hosts = 192.168.34.0/24
28123 .endd
28124 The first digit of the supplied response code must be the same as would be sent
28125 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28126 access, but for the predata ACL, note that the default success code is 354, not
28127 2&'xx'&.
28128
28129 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28130 the message modifier cannot override the 221 response code.
28131
28132 The text in a &%message%& modifier is literal; any quotes are taken as
28133 literals, but because the string is expanded, backslash escapes are processed
28134 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28135 response.
28136
28137 .vindex "&$acl_verify_message$&"
28138 For ACLs that are called by an &%acl =%& ACL condition, the message is
28139 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28140
28141 If &%message%& is used on a statement that verifies an address, the message
28142 specified overrides any message that is generated by the verification process.
28143 However, the original message is available in the variable
28144 &$acl_verify_message$&, so you can incorporate it into your message if you
28145 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28146 routers to be passed back as part of the SMTP response, you should either not
28147 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28148
28149 For compatibility with previous releases of Exim, a &%message%& modifier that
28150 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28151 modifier, but this usage is now deprecated. However, &%message%& acts only when
28152 all the conditions are true, wherever it appears in an ACL command, whereas
28153 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28154 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28155 effect.
28156
28157
28158 .vitem &*remove_header*&&~=&~<&'text'&>
28159 This modifier specifies one or more header names in a colon-separated list
28160  that are to be removed from an incoming message, assuming, of course, that
28161 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28162
28163
28164 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28165 .cindex "&%set%& ACL modifier"
28166 This modifier puts a value into one of the ACL variables (see section
28167 &<<SECTaclvariables>>&).
28168
28169
28170 .vitem &*udpsend*&&~=&~<&'parameters'&>
28171 This modifier sends a UDP packet, for purposes such as statistics
28172 collection or behaviour monitoring. The parameters are expanded, and
28173 the result of the expansion must be a colon-separated list consisting
28174 of a destination server, port number, and the packet contents. The
28175 server can be specified as a host name or IPv4 or IPv6 address. The
28176 separator can be changed with the usual angle bracket syntax. For
28177 example, you might want to collect information on which hosts connect
28178 when:
28179 .code
28180 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28181              $tod_zulu $sender_host_address
28182 .endd
28183 .endlist
28184
28185
28186
28187
28188 .section "Use of the control modifier" "SECTcontrols"
28189 .cindex "&%control%& ACL modifier"
28190 The &%control%& modifier supports the following settings:
28191
28192 .vlist
28193 .vitem &*control&~=&~allow_auth_unadvertised*&
28194 This modifier allows a client host to use the SMTP AUTH command even when it
28195 has not been advertised in response to EHLO. Furthermore, because there are
28196 apparently some really broken clients that do this, Exim will accept AUTH after
28197 HELO (rather than EHLO) when this control is set. It should be used only if you
28198 really need it, and you should limit its use to those broken clients that do
28199 not work without it. For example:
28200 .code
28201 warn hosts   = 192.168.34.25
28202      control = allow_auth_unadvertised
28203 .endd
28204 Normally, when an Exim server receives an AUTH command, it checks the name of
28205 the authentication mechanism that is given in the command to ensure that it
28206 matches an advertised mechanism. When this control is set, the check that a
28207 mechanism has been advertised is bypassed. Any configured mechanism can be used
28208 by the client. This control is permitted only in the connection and HELO ACLs.
28209
28210
28211 .vitem &*control&~=&~caseful_local_part*& &&&
28212        &*control&~=&~caselower_local_part*&
28213 .cindex "&ACL;" "case of local part in"
28214 .cindex "case of local parts"
28215 .vindex "&$local_part$&"
28216 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28217 (that is, during RCPT processing). By default, the contents of &$local_part$&
28218 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28219 any uppercase letters in the original local part are restored in &$local_part$&
28220 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28221 is encountered.
28222
28223 These controls affect only the current recipient. Moreover, they apply only to
28224 local part handling that takes place directly in the ACL (for example, as a key
28225 in lookups). If a test to verify the recipient is obeyed, the case-related
28226 handling of the local part during the verification is controlled by the router
28227 configuration (see the &%caseful_local_part%& generic router option).
28228
28229 This facility could be used, for example, to add a spam score to local parts
28230 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28231 spam score:
28232 .code
28233 warn  control = caseful_local_part
28234       set acl_m4 = ${eval:\
28235                      $acl_m4 + \
28236                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28237                     }
28238       control = caselower_local_part
28239 .endd
28240 Notice that we put back the lower cased version afterwards, assuming that
28241 is what is wanted for subsequent tests.
28242
28243
28244 .vitem &*control&~=&~cutthrough_delivery*&
28245 .cindex "&ACL;" "cutthrough routing"
28246 .cindex "cutthrough" "requesting"
28247 This option requests delivery be attempted while the item is being received.
28248
28249 The option is usable in the RCPT ACL.
28250 If enabled for a message recieved via smtp and routed to an smtp transport,
28251 and only one transport, interface, destination host and port combination
28252 is used for all recipients of the message,
28253 then the delivery connection is made while the receiving connection is open
28254 and data is copied from one to the other.
28255
28256 An attempt to set this option for any recipient but the first
28257 for a mail will be quietly ignored.
28258 If a recipient-verify callout connection is subsequently
28259 requested in the same ACL it is held open and used for
28260 any subsequent receipients and the data,
28261 otherwise one is made after the initial RCPT ACL completes.
28262
28263 Note that routers are used in verify mode,
28264 and cannot depend on content of received headers.
28265 Note also that headers cannot be
28266 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28267 Headers may be modified by routers (subject to the above) and transports.
28268
28269 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28270 of outgoing messages is done, because it sends data to the ultimate destination
28271 before the entire message has been received from the source.
28272 It is not supported for messages recieved with the SMTP PRDR option in use.
28273
28274 Should the ultimate destination system positively accept or reject the mail,
28275 a corresponding indication is given to the source system and nothing is queued.
28276 If there is a temporary error the item is queued for later delivery in the
28277 usual fashion. If the item is successfully delivered in cutthrough mode
28278 the delivery log lines are tagged with ">>" rather than "=>" and appear
28279 before the acceptance "<=" line.
28280
28281 Delivery in this mode avoids the generation of a bounce mail to a
28282 (possibly faked)
28283 sender when the destination system is doing content-scan based rejection.
28284
28285
28286 .vitem &*control&~=&~debug/*&<&'options'&>
28287 .cindex "&ACL;" "enabling debug logging"
28288 .cindex "debugging" "enabling from an ACL"
28289 This control turns on debug logging, almost as though Exim had been invoked
28290 with &`-d`&, with the output going to a new logfile, by default called
28291 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28292 may access any variables already defined.  The logging may be adjusted with
28293 the &'opts'& option, which takes the same values as the &`-d`& command-line
28294 option.  Some examples (which depend on variables that don't exist in all
28295 contexts):
28296 .code
28297       control = debug
28298       control = debug/tag=.$sender_host_address
28299       control = debug/opts=+expand+acl
28300       control = debug/tag=.$message_exim_id/opts=+expand
28301 .endd
28302
28303
28304 .vitem &*control&~=&~dkim_disable_verify*&
28305 .cindex "disable DKIM verify"
28306 .cindex "DKIM" "disable verify"
28307 This control turns off DKIM verification processing entirely.  For details on
28308 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28309
28310
28311 .vitem &*control&~=&~dscp/*&<&'value'&>
28312 .cindex "&ACL;" "setting DSCP value"
28313 .cindex "DSCP" "inbound"
28314 This option causes the DSCP value associated with the socket for the inbound
28315 connection to be adjusted to a given value, given as one of a number of fixed
28316 strings or to numeric value.
28317 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28318 Common values include &`throughput`&, &`mincost`&, and on newer systems
28319 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28320
28321 The outbound packets from Exim will be marked with this value in the header
28322 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28323 that these values will have any effect, not be stripped by networking
28324 equipment, or do much of anything without cooperation with your Network
28325 Engineer and those of all network operators between the source and destination.
28326
28327
28328 .vitem &*control&~=&~enforce_sync*& &&&
28329        &*control&~=&~no_enforce_sync*&
28330 .cindex "SMTP" "synchronization checking"
28331 .cindex "synchronization checking in SMTP"
28332 These controls make it possible to be selective about when SMTP synchronization
28333 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28334 state of the switch (it is true by default). See the description of this option
28335 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28336
28337 The effect of these two controls lasts for the remainder of the SMTP
28338 connection. They can appear in any ACL except the one for the non-SMTP
28339 messages. The most straightforward place to put them is in the ACL defined by
28340 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28341 before the first synchronization check. The expected use is to turn off the
28342 synchronization checks for badly-behaved hosts that you nevertheless need to
28343 work with.
28344
28345
28346 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28347 .cindex "fake defer"
28348 .cindex "defer, fake"
28349 This control works in exactly the same way as &%fakereject%& (described below)
28350 except that it causes an SMTP 450 response after the message data instead of a
28351 550 response. You must take care when using &%fakedefer%& because it causes the
28352 messages to be duplicated when the sender retries. Therefore, you should not
28353 use &%fakedefer%& if the message is to be delivered normally.
28354
28355 .vitem &*control&~=&~fakereject/*&<&'message'&>
28356 .cindex "fake rejection"
28357 .cindex "rejection, fake"
28358 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28359 words, only when an SMTP message is being received. If Exim accepts the
28360 message, instead the final 250 response, a 550 rejection message is sent.
28361 However, Exim proceeds to deliver the message as normal. The control applies
28362 only to the current message, not to any subsequent ones that may be received in
28363 the same SMTP connection.
28364
28365 The text for the 550 response is taken from the &%control%& modifier. If no
28366 message is supplied, the following is used:
28367 .code
28368 550-Your message has been rejected but is being
28369 550-kept for evaluation.
28370 550-If it was a legitimate message, it may still be
28371 550 delivered to the target recipient(s).
28372 .endd
28373 This facility should be used with extreme caution.
28374
28375 .vitem &*control&~=&~freeze*&
28376 .cindex "frozen messages" "forcing in ACL"
28377 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28378 other words, only when a message is being received. If the message is accepted,
28379 it is placed on Exim's queue and frozen. The control applies only to the
28380 current message, not to any subsequent ones that may be received in the same
28381 SMTP connection.
28382
28383 This modifier can optionally be followed by &`/no_tell`&. If the global option
28384 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28385 is told about the freezing), provided all the &*control=freeze*& modifiers that
28386 are obeyed for the current message have the &`/no_tell`& option.
28387
28388 .vitem &*control&~=&~no_delay_flush*&
28389 .cindex "SMTP" "output flushing, disabling for delay"
28390 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28391 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28392 use. This control, as long as it is encountered before the &%delay%& modifier,
28393 disables such output flushing.
28394
28395 .vitem &*control&~=&~no_callout_flush*&
28396 .cindex "SMTP" "output flushing, disabling for callout"
28397 Exim normally flushes SMTP output before performing a callout in an ACL, to
28398 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28399 use. This control, as long as it is encountered before the &%verify%& condition
28400 that causes the callout, disables such output flushing.
28401
28402 .vitem &*control&~=&~no_mbox_unspool*&
28403 This control is available when Exim is compiled with the content scanning
28404 extension. Content scanning may require a copy of the current message, or parts
28405 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28406 or spam scanner. Normally, such copies are deleted when they are no longer
28407 needed. If this control is set, the copies are not deleted. The control applies
28408 only to the current message, not to any subsequent ones that may be received in
28409 the same SMTP connection. It is provided for debugging purposes and is unlikely
28410 to be useful in production.
28411
28412 .vitem &*control&~=&~no_multiline_responses*&
28413 .cindex "multiline responses, suppressing"
28414 This control is permitted for any ACL except the one for non-SMTP messages.
28415 It seems that there are broken clients in use that cannot handle multiline
28416 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28417
28418 If this control is set, multiline SMTP responses from ACL rejections are
28419 suppressed. One way of doing this would have been to put out these responses as
28420 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28421 (&"use multiline responses for more"& it says &-- ha!), and some of the
28422 responses might get close to that. So this facility, which is after all only a
28423 sop to broken clients, is implemented by doing two very easy things:
28424
28425 .ilist
28426 Extra information that is normally output as part of a rejection caused by
28427 sender verification failure is omitted. Only the final line (typically &"sender
28428 verification failed"&) is sent.
28429 .next
28430 If a &%message%& modifier supplies a multiline response, only the first
28431 line is output.
28432 .endlist
28433
28434 The setting of the switch can, of course, be made conditional on the
28435 calling host. Its effect lasts until the end of the SMTP connection.
28436
28437 .vitem &*control&~=&~no_pipelining*&
28438 .cindex "PIPELINING" "suppressing advertising"
28439 This control turns off the advertising of the PIPELINING extension to SMTP in
28440 the current session. To be useful, it must be obeyed before Exim sends its
28441 response to an EHLO command. Therefore, it should normally appear in an ACL
28442 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28443 &%pipelining_advertise_hosts%&.
28444
28445 .vitem &*control&~=&~queue_only*&
28446 .oindex "&%queue_only%&"
28447 .cindex "queueing incoming messages"
28448 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28449 other words, only when a message is being received. If the message is accepted,
28450 it is placed on Exim's queue and left there for delivery by a subsequent queue
28451 runner. No immediate delivery process is started. In other words, it has the
28452 effect as the &%queue_only%& global option. However, the control applies only
28453 to the current message, not to any subsequent ones that may be received in the
28454 same SMTP connection.
28455
28456 .vitem &*control&~=&~submission/*&<&'options'&>
28457 .cindex "message" "submission"
28458 .cindex "submission mode"
28459 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28460 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28461 the current message is a submission from a local MUA. In this case, Exim
28462 operates in &"submission mode"&, and applies certain fixups to the message if
28463 necessary. For example, it adds a &'Date:'& header line if one is not present.
28464 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28465 late (the message has already been created).
28466
28467 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28468 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28469 submission mode; the available options for this control are described there.
28470 The control applies only to the current message, not to any subsequent ones
28471 that may be received in the same SMTP connection.
28472
28473 .vitem &*control&~=&~suppress_local_fixups*&
28474 .cindex "submission fixups, suppressing"
28475 This control applies to locally submitted (non TCP/IP) messages, and is the
28476 complement of &`control = submission`&. It disables the fixups that are
28477 normally applied to locally-submitted messages. Specifically:
28478
28479 .ilist
28480 Any &'Sender:'& header line is left alone (in this respect, it is a
28481 dynamic version of &%local_sender_retain%&).
28482 .next
28483 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28484 .next
28485 There is no check that &'From:'& corresponds to the actual sender.
28486 .endlist ilist
28487
28488 This control may be useful when a remotely-originated message is accepted,
28489 passed to some scanning program, and then re-submitted for delivery. It can be
28490 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28491 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28492 data is read.
28493
28494 &*Note:*& This control applies only to the current message, not to any others
28495 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28496 .endlist vlist
28497
28498
28499 .section "Summary of message fixup control" "SECTsummesfix"
28500 All four possibilities for message fixups can be specified:
28501
28502 .ilist
28503 Locally submitted, fixups applied: the default.
28504 .next
28505 Locally submitted, no fixups applied: use
28506 &`control = suppress_local_fixups`&.
28507 .next
28508 Remotely submitted, no fixups applied: the default.
28509 .next
28510 Remotely submitted, fixups applied: use &`control = submission`&.
28511 .endlist
28512
28513
28514
28515 .section "Adding header lines in ACLs" "SECTaddheadacl"
28516 .cindex "header lines" "adding in an ACL"
28517 .cindex "header lines" "position of added lines"
28518 .cindex "&%add_header%& ACL modifier"
28519 The &%add_header%& modifier can be used to add one or more extra header lines
28520 to an incoming message, as in this example:
28521 .code
28522 warn dnslists = sbl.spamhaus.org : \
28523                 dialup.mail-abuse.org
28524      add_header = X-blacklisted-at: $dnslist_domain
28525 .endd
28526 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28527 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28528 receiving a message). The message must ultimately be accepted for
28529 &%add_header%& to have any significant effect. You can use &%add_header%& with
28530 any ACL verb, including &%deny%& (though this is potentially useful only in a
28531 RCPT ACL).
28532
28533 Headers will not be added to the message if the modifier is used in
28534 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28535
28536 Leading and trailing newlines are removed from
28537 the data for the &%add_header%& modifier; if it then
28538 contains one or more newlines that
28539 are not followed by a space or a tab, it is assumed to contain multiple header
28540 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28541 front of any line that is not a valid header line.
28542
28543 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28544 They are added to the message before processing the DATA and MIME ACLs.
28545 However, if an identical header line is requested more than once, only one copy
28546 is actually added to the message. Further header lines may be accumulated
28547 during the DATA and MIME ACLs, after which they are added to the message, again
28548 with duplicates suppressed. Thus, it is possible to add two identical header
28549 lines to an SMTP message, but only if one is added before DATA and one after.
28550 In the case of non-SMTP messages, new headers are accumulated during the
28551 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28552 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28553 are included in the entry that is written to the reject log.
28554
28555 .cindex "header lines" "added; visibility of"
28556 Header lines are not visible in string expansions
28557 of message headers
28558 until they are added to the
28559 message. It follows that header lines defined in the MAIL, RCPT, and predata
28560 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28561 header lines that are added by the DATA or MIME ACLs are not visible in those
28562 ACLs. Because of this restriction, you cannot use header lines as a way of
28563 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28564 this, you can use ACL variables, as described in section
28565 &<<SECTaclvariables>>&.
28566
28567 The list of headers yet to be added is given by the &%$headers_added%& variable.
28568
28569 The &%add_header%& modifier acts immediately as it is encountered during the
28570 processing of an ACL. Notice the difference between these two cases:
28571 .display
28572 &`accept add_header = ADDED: some text`&
28573 &`       `&<&'some condition'&>
28574
28575 &`accept `&<&'some condition'&>
28576 &`       add_header = ADDED: some text`&
28577 .endd
28578 In the first case, the header line is always added, whether or not the
28579 condition is true. In the second case, the header line is added only if the
28580 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28581 ACL statement. All those that are encountered before a condition fails are
28582 honoured.
28583
28584 .cindex "&%warn%& ACL verb"
28585 For compatibility with previous versions of Exim, a &%message%& modifier for a
28586 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28587 effect only if all the conditions are true, even if it appears before some of
28588 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28589 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28590 are present on a &%warn%& verb, both are processed according to their
28591 specifications.
28592
28593 By default, new header lines are added to a message at the end of the existing
28594 header lines. However, you can specify that any particular header line should
28595 be added right at the start (before all the &'Received:'& lines), immediately
28596 after the first block of &'Received:'& lines, or immediately before any line
28597 that is not a &'Received:'& or &'Resent-something:'& header.
28598
28599 This is done by specifying &":at_start:"&, &":after_received:"&, or
28600 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28601 header line, respectively. (Header text cannot start with a colon, as there has
28602 to be a header name first.) For example:
28603 .code
28604 warn add_header = \
28605        :after_received:X-My-Header: something or other...
28606 .endd
28607 If more than one header line is supplied in a single &%add_header%& modifier,
28608 each one is treated independently and can therefore be placed differently. If
28609 you add more than one line at the start, or after the Received: block, they end
28610 up in reverse order.
28611
28612 &*Warning*&: This facility currently applies only to header lines that are
28613 added in an ACL. It does NOT work for header lines that are added in a
28614 system filter or in a router or transport.
28615
28616
28617
28618 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28619 .cindex "header lines" "removing in an ACL"
28620 .cindex "header lines" "position of removed lines"
28621 .cindex "&%remove_header%& ACL modifier"
28622 The &%remove_header%& modifier can be used to remove one or more header lines
28623 from an incoming message, as in this example:
28624 .code
28625 warn   message        = Remove internal headers
28626        remove_header  = x-route-mail1 : x-route-mail2
28627 .endd
28628 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28629 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28630 receiving a message). The message must ultimately be accepted for
28631 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28632 with any ACL verb, including &%deny%&, though this is really not useful for
28633 any verb that doesn't result in a delivered message.
28634
28635 Headers will not be removed to the message if the modifier is used in
28636 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28637
28638 More than one header can be removed at the same time by using a colon separated
28639 list of header names. The header matching is case insensitive. Wildcards are
28640 not permitted, nor is list expansion performed, so you cannot use hostlists to
28641 create a list of headers, however both connection and message variable expansion
28642 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28643 .code
28644 warn   hosts           = +internal_hosts
28645        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28646 warn   message         = Remove internal headers
28647        remove_header   = $acl_c_ihdrs
28648 .endd
28649 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28650 They are removed from the message before processing the DATA and MIME ACLs.
28651 There is no harm in attempting to remove the same header twice nor is removing
28652 a non-existent header. Further header lines to be removed may be accumulated
28653 during the DATA and MIME ACLs, after which they are removed from the message,
28654 if present. In the case of non-SMTP messages, headers to be removed are
28655 accumulated during the non-SMTP ACLs, and are removed from the message after
28656 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28657 ACL, there really is no effect because there is no logging of what headers
28658 would have been removed.
28659
28660 .cindex "header lines" "removed; visibility of"
28661 Header lines are not visible in string expansions until the DATA phase when it
28662 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28663 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28664 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28665 this restriction, you cannot use header lines as a way of controlling data
28666 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28667 you should instead use ACL variables, as described in section
28668 &<<SECTaclvariables>>&.
28669
28670 The &%remove_header%& modifier acts immediately as it is encountered during the
28671 processing of an ACL. Notice the difference between these two cases:
28672 .display
28673 &`accept remove_header = X-Internal`&
28674 &`       `&<&'some condition'&>
28675
28676 &`accept `&<&'some condition'&>
28677 &`       remove_header = X-Internal`&
28678 .endd
28679 In the first case, the header line is always removed, whether or not the
28680 condition is true. In the second case, the header line is removed only if the
28681 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28682 same ACL statement. All those that are encountered before a condition fails
28683 are honoured.
28684
28685 &*Warning*&: This facility currently applies only to header lines that are
28686 present during ACL processing. It does NOT remove header lines that are added
28687 in a system filter or in a router or transport.
28688
28689
28690
28691
28692 .section "ACL conditions" "SECTaclconditions"
28693 .cindex "&ACL;" "conditions; list of"
28694 Some of the conditions listed in this section are available only when Exim is
28695 compiled with the content-scanning extension. They are included here briefly
28696 for completeness. More detailed descriptions can be found in the discussion on
28697 content scanning in chapter &<<CHAPexiscan>>&.
28698
28699 Not all conditions are relevant in all circumstances. For example, testing
28700 senders and recipients does not make sense in an ACL that is being run as the
28701 result of the arrival of an ETRN command, and checks on message headers can be
28702 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28703 can use the same condition (with different parameters) more than once in the
28704 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28705 The conditions are as follows:
28706
28707
28708 .vlist
28709 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28710 .cindex "&ACL;" "nested"
28711 .cindex "&ACL;" "indirect"
28712 .cindex "&ACL;" "arguments"
28713 .cindex "&%acl%& ACL condition"
28714 The possible values of the argument are the same as for the
28715 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28716 &"accept"& the condition is true; if it returns &"deny"& the condition is
28717 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28718 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28719 condition false. This means that further processing of the &%warn%& verb
28720 ceases, but processing of the ACL continues.
28721
28722 If the argument is a named ACL, up to nine space-separated optional values
28723 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28724 and $acl_narg is set to the count of values.
28725 Previous values of these variables are restored after the call returns.
28726 The name and values are expanded separately.
28727 Note that spaces in complex expansions which are used as arguments
28728 will act as argument separators.
28729
28730 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28731 the connection is dropped. If it returns &"discard"&, the verb must be
28732 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28733 conditions are tested.
28734
28735 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28736 loops. This condition allows you to use different ACLs in different
28737 circumstances. For example, different ACLs can be used to handle RCPT commands
28738 for different local users or different local domains.
28739
28740 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28741 .cindex "&%authenticated%& ACL condition"
28742 .cindex "authentication" "ACL checking"
28743 .cindex "&ACL;" "testing for authentication"
28744 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28745 the name of the authenticator is tested against the list. To test for
28746 authentication by any authenticator, you can set
28747 .code
28748 authenticated = *
28749 .endd
28750
28751 .vitem &*condition&~=&~*&<&'string'&>
28752 .cindex "&%condition%& ACL condition"
28753 .cindex "customizing" "ACL condition"
28754 .cindex "&ACL;" "customized test"
28755 .cindex "&ACL;" "testing, customized"
28756 This feature allows you to make up custom conditions. If the result of
28757 expanding the string is an empty string, the number zero, or one of the strings
28758 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28759 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28760 any other value, some error is assumed to have occurred, and the ACL returns
28761 &"defer"&. However, if the expansion is forced to fail, the condition is
28762 ignored. The effect is to treat it as true, whether it is positive or
28763 negative.
28764
28765 .vitem &*decode&~=&~*&<&'location'&>
28766 .cindex "&%decode%& ACL condition"
28767 This condition is available only when Exim is compiled with the
28768 content-scanning extension, and it is allowed only in the ACL defined by
28769 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28770 If all goes well, the condition is true. It is false only if there are
28771 problems such as a syntax error or a memory shortage. For more details, see
28772 chapter &<<CHAPexiscan>>&.
28773
28774 .vitem &*demime&~=&~*&<&'extension&~list'&>
28775 .cindex "&%demime%& ACL condition"
28776 This condition is available only when Exim is compiled with the
28777 content-scanning extension. Its use is described in section
28778 &<<SECTdemimecond>>&.
28779
28780 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28781 .cindex "&%dnslists%& ACL condition"
28782 .cindex "DNS list" "in ACL"
28783 .cindex "black list (DNS)"
28784 .cindex "&ACL;" "testing a DNS list"
28785 This condition checks for entries in DNS black lists. These are also known as
28786 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28787 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28788 different variants of this condition to describe briefly here. See sections
28789 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28790
28791 .vitem &*domains&~=&~*&<&'domain&~list'&>
28792 .cindex "&%domains%& ACL condition"
28793 .cindex "domain" "ACL checking"
28794 .cindex "&ACL;" "testing a recipient domain"
28795 .vindex "&$domain_data$&"
28796 This condition is relevant only after a RCPT command. It checks that the domain
28797 of the recipient address is in the domain list. If percent-hack processing is
28798 enabled, it is done before this test is done. If the check succeeds with a
28799 lookup, the result of the lookup is placed in &$domain_data$& until the next
28800 &%domains%& test.
28801
28802 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28803 use &%domains%& in a DATA ACL.
28804
28805
28806 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28807 .cindex "&%encrypted%& ACL condition"
28808 .cindex "encryption" "checking in an ACL"
28809 .cindex "&ACL;" "testing for encryption"
28810 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28811 name of the cipher suite in use is tested against the list. To test for
28812 encryption without testing for any specific cipher suite(s), set
28813 .code
28814 encrypted = *
28815 .endd
28816
28817
28818 .vitem &*hosts&~=&~*&<&'host&~list'&>
28819 .cindex "&%hosts%& ACL condition"
28820 .cindex "host" "ACL checking"
28821 .cindex "&ACL;" "testing the client host"
28822 This condition tests that the calling host matches the host list. If you have
28823 name lookups or wildcarded host names and IP addresses in the same host list,
28824 you should normally put the IP addresses first. For example, you could have:
28825 .code
28826 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28827 .endd
28828 The lookup in this example uses the host name for its key. This is implied by
28829 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28830 and it wouldn't matter which way round you had these two items.)
28831
28832 The reason for the problem with host names lies in the left-to-right way that
28833 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28834 but when it reaches an item that requires a host name, it fails if it cannot
28835 find a host name to compare with the pattern. If the above list is given in the
28836 opposite order, the &%accept%& statement fails for a host whose name cannot be
28837 found, even if its IP address is 10.9.8.7.
28838
28839 If you really do want to do the name check first, and still recognize the IP
28840 address even if the name lookup fails, you can rewrite the ACL like this:
28841 .code
28842 accept hosts = dbm;/etc/friendly/hosts
28843 accept hosts = 10.9.8.7
28844 .endd
28845 The default action on failing to find the host name is to assume that the host
28846 is not in the list, so the first &%accept%& statement fails. The second
28847 statement can then check the IP address.
28848
28849 .vindex "&$host_data$&"
28850 If a &%hosts%& condition is satisfied by means of a lookup, the result
28851 of the lookup is made available in the &$host_data$& variable. This
28852 allows you, for example, to set up a statement like this:
28853 .code
28854 deny  hosts = net-lsearch;/some/file
28855 message = $host_data
28856 .endd
28857 which gives a custom error message for each denied host.
28858
28859 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28860 .cindex "&%local_parts%& ACL condition"
28861 .cindex "local part" "ACL checking"
28862 .cindex "&ACL;" "testing a local part"
28863 .vindex "&$local_part_data$&"
28864 This condition is relevant only after a RCPT command. It checks that the local
28865 part of the recipient address is in the list. If percent-hack processing is
28866 enabled, it is done before this test. If the check succeeds with a lookup, the
28867 result of the lookup is placed in &$local_part_data$&, which remains set until
28868 the next &%local_parts%& test.
28869
28870 .vitem &*malware&~=&~*&<&'option'&>
28871 .cindex "&%malware%& ACL condition"
28872 .cindex "&ACL;" "virus scanning"
28873 .cindex "&ACL;" "scanning for viruses"
28874 This condition is available only when Exim is compiled with the
28875 content-scanning extension. It causes the incoming message to be scanned for
28876 viruses. For details, see chapter &<<CHAPexiscan>>&.
28877
28878 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28879 .cindex "&%mime_regex%& ACL condition"
28880 .cindex "&ACL;" "testing by regex matching"
28881 This condition is available only when Exim is compiled with the
28882 content-scanning extension, and it is allowed only in the ACL defined by
28883 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28884 with any of the regular expressions. For details, see chapter
28885 &<<CHAPexiscan>>&.
28886
28887 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28888 .cindex "rate limiting"
28889 This condition can be used to limit the rate at which a user or host submits
28890 messages. Details are given in section &<<SECTratelimiting>>&.
28891
28892 .vitem &*recipients&~=&~*&<&'address&~list'&>
28893 .cindex "&%recipients%& ACL condition"
28894 .cindex "recipient" "ACL checking"
28895 .cindex "&ACL;" "testing a recipient"
28896 This condition is relevant only after a RCPT command. It checks the entire
28897 recipient address against a list of recipients.
28898
28899 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28900 .cindex "&%regex%& ACL condition"
28901 .cindex "&ACL;" "testing by regex matching"
28902 This condition is available only when Exim is compiled with the
28903 content-scanning extension, and is available only in the DATA, MIME, and
28904 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28905 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28906
28907 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28908 .cindex "&%sender_domains%& ACL condition"
28909 .cindex "sender" "ACL checking"
28910 .cindex "&ACL;" "testing a sender domain"
28911 .vindex "&$domain$&"
28912 .vindex "&$sender_address_domain$&"
28913 This condition tests the domain of the sender of the message against the given
28914 domain list. &*Note*&: The domain of the sender address is in
28915 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28916 of this condition. This is an exception to the general rule for testing domain
28917 lists. It is done this way so that, if this condition is used in an ACL for a
28918 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28919 influence the sender checking.
28920
28921 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28922 relaying, because sender addresses are easily, and commonly, forged.
28923
28924 .vitem &*senders&~=&~*&<&'address&~list'&>
28925 .cindex "&%senders%& ACL condition"
28926 .cindex "sender" "ACL checking"
28927 .cindex "&ACL;" "testing a sender"
28928 This condition tests the sender of the message against the given list. To test
28929 for a bounce message, which has an empty sender, set
28930 .code
28931 senders = :
28932 .endd
28933 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28934 relaying, because sender addresses are easily, and commonly, forged.
28935
28936 .vitem &*spam&~=&~*&<&'username'&>
28937 .cindex "&%spam%& ACL condition"
28938 .cindex "&ACL;" "scanning for spam"
28939 This condition is available only when Exim is compiled with the
28940 content-scanning extension. It causes the incoming message to be scanned by
28941 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28942
28943 .vitem &*verify&~=&~certificate*&
28944 .cindex "&%verify%& ACL condition"
28945 .cindex "TLS" "client certificate verification"
28946 .cindex "certificate" "verification of client"
28947 .cindex "&ACL;" "certificate verification"
28948 .cindex "&ACL;" "testing a TLS certificate"
28949 This condition is true in an SMTP session if the session is encrypted, and a
28950 certificate was received from the client, and the certificate was verified. The
28951 server requests a certificate only if the client matches &%tls_verify_hosts%&
28952 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
28953
28954 .vitem &*verify&~=&~csa*&
28955 .cindex "CSA verification"
28956 This condition checks whether the sending host (the client) is authorized to
28957 send email. Details of how this works are given in section
28958 &<<SECTverifyCSA>>&.
28959
28960 .vitem &*verify&~=&~header_names_ascii*&
28961 .cindex "&%verify%& ACL condition"
28962 .cindex "&ACL;" "verifying header names only ASCII"
28963 .cindex "header lines" "verifying header names only ASCII"
28964 .cindex "verifying" "header names only ASCII"
28965 This condition is relevant only in an ACL that is run after a message has been
28966 received, that is, in an ACL specified by &%acl_smtp_data%& or
28967 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
28968 there are no non-ASCII characters, also excluding control characters.  The
28969 allowable characters are decimal ASCII values 33 through 126.
28970
28971 Exim itself will handle headers with non-ASCII characters, but it can cause
28972 problems for downstream applications, so this option will allow their
28973 detection and rejection in the DATA ACL's.
28974
28975 .vitem &*verify&~=&~header_sender/*&<&'options'&>
28976 .cindex "&%verify%& ACL condition"
28977 .cindex "&ACL;" "verifying sender in the header"
28978 .cindex "header lines" "verifying the sender in"
28979 .cindex "sender" "verifying in header"
28980 .cindex "verifying" "sender in header"
28981 This condition is relevant only in an ACL that is run after a message has been
28982 received, that is, in an ACL specified by &%acl_smtp_data%& or
28983 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
28984 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
28985 is loosely thought of as a &"sender"& address (hence the name of the test).
28986 However, an address that appears in one of these headers need not be an address
28987 that accepts bounce messages; only sender addresses in envelopes are required
28988 to accept bounces. Therefore, if you use the callout option on this check, you
28989 might want to arrange for a non-empty address in the MAIL command.
28990
28991 Details of address verification and the options are given later, starting at
28992 section &<<SECTaddressverification>>& (callouts are described in section
28993 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
28994 condition to restrict it to bounce messages only:
28995 .code
28996 deny    senders = :
28997         message = A valid sender header is required for bounces
28998        !verify  = header_sender
28999 .endd
29000
29001 .vitem &*verify&~=&~header_syntax*&
29002 .cindex "&%verify%& ACL condition"
29003 .cindex "&ACL;" "verifying header syntax"
29004 .cindex "header lines" "verifying syntax"
29005 .cindex "verifying" "header syntax"
29006 This condition is relevant only in an ACL that is run after a message has been
29007 received, that is, in an ACL specified by &%acl_smtp_data%& or
29008 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29009 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29010 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
29011 permitted only in locally generated messages and from hosts that match
29012 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29013 appropriate.
29014
29015 Note that this condition is a syntax check only. However, a common spamming
29016 ploy used to be to send syntactically invalid headers such as
29017 .code
29018 To: @
29019 .endd
29020 and this condition can be used to reject such messages, though they are not as
29021 common as they used to be.
29022
29023 .vitem &*verify&~=&~helo*&
29024 .cindex "&%verify%& ACL condition"
29025 .cindex "&ACL;" "verifying HELO/EHLO"
29026 .cindex "HELO" "verifying"
29027 .cindex "EHLO" "verifying"
29028 .cindex "verifying" "EHLO"
29029 .cindex "verifying" "HELO"
29030 This condition is true if a HELO or EHLO command has been received from the
29031 client host, and its contents have been verified. If there has been no previous
29032 attempt to verify the HELO/EHLO contents, it is carried out when this
29033 condition is encountered. See the description of the &%helo_verify_hosts%& and
29034 &%helo_try_verify_hosts%& options for details of how to request verification
29035 independently of this condition.
29036
29037 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29038 option), this condition is always true.
29039
29040
29041 .vitem &*verify&~=&~not_blind*&
29042 .cindex "verifying" "not blind"
29043 .cindex "bcc recipients, verifying none"
29044 This condition checks that there are no blind (bcc) recipients in the message.
29045 Every envelope recipient must appear either in a &'To:'& header line or in a
29046 &'Cc:'& header line for this condition to be true. Local parts are checked
29047 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29048 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29049 used only in a DATA or non-SMTP ACL.
29050
29051 There are, of course, many legitimate messages that make use of blind (bcc)
29052 recipients. This check should not be used on its own for blocking messages.
29053
29054
29055 .vitem &*verify&~=&~recipient/*&<&'options'&>
29056 .cindex "&%verify%& ACL condition"
29057 .cindex "&ACL;" "verifying recipient"
29058 .cindex "recipient" "verifying"
29059 .cindex "verifying" "recipient"
29060 .vindex "&$address_data$&"
29061 This condition is relevant only after a RCPT command. It verifies the current
29062 recipient. Details of address verification are given later, starting at section
29063 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29064 of &$address_data$& is the last value that was set while routing the address.
29065 This applies even if the verification fails. When an address that is being
29066 verified is redirected to a single address, verification continues with the new
29067 address, and in that case, the subsequent value of &$address_data$& is the
29068 value for the child address.
29069
29070 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29071 .cindex "&%verify%& ACL condition"
29072 .cindex "&ACL;" "verifying host reverse lookup"
29073 .cindex "host" "verifying reverse lookup"
29074 This condition ensures that a verified host name has been looked up from the IP
29075 address of the client host. (This may have happened already if the host name
29076 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29077 Verification ensures that the host name obtained from a reverse DNS lookup, or
29078 one of its aliases, does, when it is itself looked up in the DNS, yield the
29079 original IP address.
29080
29081 There is one possible option, &`defer_ok`&.  If this is present and a
29082 DNS operation returns a temporary error, the verify condition succeeds.
29083
29084 If this condition is used for a locally generated message (that is, when there
29085 is no client host involved), it always succeeds.
29086
29087 .vitem &*verify&~=&~sender/*&<&'options'&>
29088 .cindex "&%verify%& ACL condition"
29089 .cindex "&ACL;" "verifying sender"
29090 .cindex "sender" "verifying"
29091 .cindex "verifying" "sender"
29092 This condition is relevant only after a MAIL or RCPT command, or after a
29093 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29094 the message's sender is empty (that is, this is a bounce message), the
29095 condition is true. Otherwise, the sender address is verified.
29096
29097 .vindex "&$address_data$&"
29098 .vindex "&$sender_address_data$&"
29099 If there is data in the &$address_data$& variable at the end of routing, its
29100 value is placed in &$sender_address_data$& at the end of verification. This
29101 value can be used in subsequent conditions and modifiers in the same ACL
29102 statement. It does not persist after the end of the current statement. If you
29103 want to preserve the value for longer, you can save it in an ACL variable.
29104
29105 Details of verification are given later, starting at section
29106 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29107 to avoid doing it more than once per message.
29108
29109 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29110 .cindex "&%verify%& ACL condition"
29111 This is a variation of the previous option, in which a modified address is
29112 verified as a sender.
29113 .endlist
29114
29115
29116
29117 .section "Using DNS lists" "SECTmorednslists"
29118 .cindex "DNS list" "in ACL"
29119 .cindex "black list (DNS)"
29120 .cindex "&ACL;" "testing a DNS list"
29121 In its simplest form, the &%dnslists%& condition tests whether the calling host
29122 is on at least one of a number of DNS lists by looking up the inverted IP
29123 address in one or more DNS domains. (Note that DNS list domains are not mail
29124 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29125 special options instead.) For example, if the calling host's IP
29126 address is 192.168.62.43, and the ACL statement is
29127 .code
29128 deny dnslists = blackholes.mail-abuse.org : \
29129                 dialups.mail-abuse.org
29130 .endd
29131 the following records are looked up:
29132 .code
29133 43.62.168.192.blackholes.mail-abuse.org
29134 43.62.168.192.dialups.mail-abuse.org
29135 .endd
29136 As soon as Exim finds an existing DNS record, processing of the list stops.
29137 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29138 to test that a host is on more than one list (an &"and"& conjunction), you can
29139 use two separate conditions:
29140 .code
29141 deny dnslists = blackholes.mail-abuse.org
29142      dnslists = dialups.mail-abuse.org
29143 .endd
29144 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29145 behaves as if the host does not match the list item, that is, as if the DNS
29146 record does not exist. If there are further items in the DNS list, they are
29147 processed.
29148
29149 This is usually the required action when &%dnslists%& is used with &%deny%&
29150 (which is the most common usage), because it prevents a DNS failure from
29151 blocking mail. However, you can change this behaviour by putting one of the
29152 following special items in the list:
29153 .display
29154 &`+include_unknown `&   behave as if the item is on the list
29155 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29156 &`+defer_unknown   `&   give a temporary error
29157 .endd
29158 .cindex "&`+include_unknown`&"
29159 .cindex "&`+exclude_unknown`&"
29160 .cindex "&`+defer_unknown`&"
29161 Each of these applies to any subsequent items on the list. For example:
29162 .code
29163 deny dnslists = +defer_unknown : foo.bar.example
29164 .endd
29165 Testing the list of domains stops as soon as a match is found. If you want to
29166 warn for one list and block for another, you can use two different statements:
29167 .code
29168 deny  dnslists = blackholes.mail-abuse.org
29169 warn  message  = X-Warn: sending host is on dialups list
29170       dnslists = dialups.mail-abuse.org
29171 .endd
29172 DNS list lookups are cached by Exim for the duration of the SMTP session,
29173 so a lookup based on the IP address is done at most once for any incoming
29174 connection. Exim does not share information between multiple incoming
29175 connections (but your local name server cache should be active).
29176
29177
29178
29179 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29180 .cindex "DNS list" "keyed by explicit IP address"
29181 By default, the IP address that is used in a DNS list lookup is the IP address
29182 of the calling host. However, you can specify another IP address by listing it
29183 after the domain name, introduced by a slash. For example:
29184 .code
29185 deny dnslists = black.list.tld/192.168.1.2
29186 .endd
29187 This feature is not very helpful with explicit IP addresses; it is intended for
29188 use with IP addresses that are looked up, for example, the IP addresses of the
29189 MX hosts or nameservers of an email sender address. For an example, see section
29190 &<<SECTmulkeyfor>>& below.
29191
29192
29193
29194
29195 .section "DNS lists keyed on domain names" "SECID202"
29196 .cindex "DNS list" "keyed by domain name"
29197 There are some lists that are keyed on domain names rather than inverted IP
29198 addresses (see for example the &'domain based zones'& link at
29199 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29200 with these lists. You can change the name that is looked up in a DNS list by
29201 listing it after the domain name, introduced by a slash. For example,
29202 .code
29203 deny  message  = Sender's domain is listed at $dnslist_domain
29204       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29205 .endd
29206 This particular example is useful only in ACLs that are obeyed after the
29207 RCPT or DATA commands, when a sender address is available. If (for
29208 example) the message's sender is &'user@tld.example'& the name that is looked
29209 up by this example is
29210 .code
29211 tld.example.dsn.rfc-ignorant.org
29212 .endd
29213 A single &%dnslists%& condition can contain entries for both names and IP
29214 addresses. For example:
29215 .code
29216 deny dnslists = sbl.spamhaus.org : \
29217                 dsn.rfc-ignorant.org/$sender_address_domain
29218 .endd
29219 The first item checks the sending host's IP address; the second checks a domain
29220 name. The whole condition is true if either of the DNS lookups succeeds.
29221
29222
29223
29224
29225 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29226 .cindex "DNS list" "multiple keys for"
29227 The syntax described above for looking up explicitly-defined values (either
29228 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29229 name for the DNS list, what follows the slash can in fact be a list of items.
29230 As with all lists in Exim, the default separator is a colon. However, because
29231 this is a sublist within the list of DNS blacklist domains, it is necessary
29232 either to double the separators like this:
29233 .code
29234 dnslists = black.list.tld/name.1::name.2
29235 .endd
29236 or to change the separator character, like this:
29237 .code
29238 dnslists = black.list.tld/<;name.1;name.2
29239 .endd
29240 If an item in the list is an IP address, it is inverted before the DNS
29241 blacklist domain is appended. If it is not an IP address, no inversion
29242 occurs. Consider this condition:
29243 .code
29244 dnslists = black.list.tld/<;192.168.1.2;a.domain
29245 .endd
29246 The DNS lookups that occur are:
29247 .code
29248 2.1.168.192.black.list.tld
29249 a.domain.black.list.tld
29250 .endd
29251 Once a DNS record has been found (that matches a specific IP return
29252 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29253 are done. If there is a temporary DNS error, the rest of the sublist of domains
29254 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29255 only if no other DNS lookup in this sublist succeeds. In other words, a
29256 successful lookup for any of the items in the sublist overrides a temporary
29257 error for a previous item.
29258
29259 The ability to supply a list of items after the slash is in some sense just a
29260 syntactic convenience. These two examples have the same effect:
29261 .code
29262 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29263 dnslists = black.list.tld/a.domain::b.domain
29264 .endd
29265 However, when the data for the list is obtained from a lookup, the second form
29266 is usually much more convenient. Consider this example:
29267 .code
29268 deny message  = The mail servers for the domain \
29269                 $sender_address_domain \
29270                 are listed at $dnslist_domain ($dnslist_value); \
29271                 see $dnslist_text.
29272      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29273                                    ${lookup dnsdb {>|mxh=\
29274                                    $sender_address_domain} }} }
29275 .endd
29276 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29277 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29278 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29279 of expanding the condition might be something like this:
29280 .code
29281 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29282 .endd
29283 Thus, this example checks whether or not the IP addresses of the sender
29284 domain's mail servers are on the Spamhaus black list.
29285
29286 The key that was used for a successful DNS list lookup is put into the variable
29287 &$dnslist_matched$& (see section &<<SECID204>>&).
29288
29289
29290
29291
29292 .section "Data returned by DNS lists" "SECID203"
29293 .cindex "DNS list" "data returned from"
29294 DNS lists are constructed using address records in the DNS. The original RBL
29295 just used the address 127.0.0.1 on the right hand side of each record, but the
29296 RBL+ list and some other lists use a number of values with different meanings.
29297 The values used on the RBL+ list are:
29298 .display
29299 127.1.0.1  RBL
29300 127.1.0.2  DUL
29301 127.1.0.3  DUL and RBL
29302 127.1.0.4  RSS
29303 127.1.0.5  RSS and RBL
29304 127.1.0.6  RSS and DUL
29305 127.1.0.7  RSS and DUL and RBL
29306 .endd
29307 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29308 different values. Some DNS lists may return more than one address record;
29309 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29310
29311
29312 .section "Variables set from DNS lists" "SECID204"
29313 .cindex "expansion" "variables, set from DNS list"
29314 .cindex "DNS list" "variables set from"
29315 .vindex "&$dnslist_domain$&"
29316 .vindex "&$dnslist_matched$&"
29317 .vindex "&$dnslist_text$&"
29318 .vindex "&$dnslist_value$&"
29319 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29320 the name of the overall domain that matched (for example,
29321 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29322 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29323 the DNS record. When the key is an IP address, it is not reversed in
29324 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29325 cases, for example:
29326 .code
29327 deny dnslists = spamhaus.example
29328 .endd
29329 the key is also available in another variable (in this case,
29330 &$sender_host_address$&). In more complicated cases, however, this is not true.
29331 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29332 might generate a dnslists lookup like this:
29333 .code
29334 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29335 .endd
29336 If this condition succeeds, the value in &$dnslist_matched$& might be
29337 &`192.168.6.7`& (for example).
29338
29339 If more than one address record is returned by the DNS lookup, all the IP
29340 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29341 The variable &$dnslist_text$& contains the contents of any associated TXT
29342 record. For lists such as RBL+ the TXT record for a merged entry is often not
29343 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29344 information.
29345
29346 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29347 &-- although these appear before the condition in the ACL, they are not
29348 expanded until after it has failed. For example:
29349 .code
29350 deny    hosts = !+local_networks
29351         message = $sender_host_address is listed \
29352                   at $dnslist_domain
29353         dnslists = rbl-plus.mail-abuse.example
29354 .endd
29355
29356
29357
29358 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29359 .cindex "DNS list" "matching specific returned data"
29360 You can add an equals sign and an IP address after a &%dnslists%& domain name
29361 in order to restrict its action to DNS records with a matching right hand side.
29362 For example,
29363 .code
29364 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29365 .endd
29366 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29367 any address record is considered to be a match. For the moment, we assume
29368 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29369 describes how multiple records are handled.
29370
29371 More than one IP address may be given for checking, using a comma as a
29372 separator. These are alternatives &-- if any one of them matches, the
29373 &%dnslists%& condition is true. For example:
29374 .code
29375 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29376 .endd
29377 If you want to specify a constraining address list and also specify names or IP
29378 addresses to be looked up, the constraining address list must be specified
29379 first. For example:
29380 .code
29381 deny dnslists = dsn.rfc-ignorant.org\
29382                 =127.0.0.2/$sender_address_domain
29383 .endd
29384
29385 If the character &`&&`& is used instead of &`=`&, the comparison for each
29386 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29387 In other words, the listed addresses are used as bit masks. The comparison is
29388 true if all the bits in the mask are present in the address that is being
29389 tested. For example:
29390 .code
29391 dnslists = a.b.c&0.0.0.3
29392 .endd
29393 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29394 want to test whether one bit or another bit is present (as opposed to both
29395 being present), you must use multiple values. For example:
29396 .code
29397 dnslists = a.b.c&0.0.0.1,0.0.0.2
29398 .endd
29399 matches if the final component of the address is an odd number or two times
29400 an odd number.
29401
29402
29403
29404 .section "Negated DNS matching conditions" "SECID205"
29405 You can supply a negative list of IP addresses as part of a &%dnslists%&
29406 condition. Whereas
29407 .code
29408 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29409 .endd
29410 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29411 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29412 .code
29413 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29414 .endd
29415 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29416 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29417 words, the result of the test is inverted if an exclamation mark appears before
29418 the &`=`& (or the &`&&`&) sign.
29419
29420 &*Note*&: This kind of negation is not the same as negation in a domain,
29421 host, or address list (which is why the syntax is different).
29422
29423 If you are using just one list, the negation syntax does not gain you much. The
29424 previous example is precisely equivalent to
29425 .code
29426 deny  dnslists = a.b.c
29427      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29428 .endd
29429 However, if you are using multiple lists, the negation syntax is clearer.
29430 Consider this example:
29431 .code
29432 deny  dnslists = sbl.spamhaus.org : \
29433                  list.dsbl.org : \
29434                  dnsbl.njabl.org!=127.0.0.3 : \
29435                  relays.ordb.org
29436 .endd
29437 Using only positive lists, this would have to be:
29438 .code
29439 deny  dnslists = sbl.spamhaus.org : \
29440                  list.dsbl.org
29441 deny  dnslists = dnsbl.njabl.org
29442      !dnslists = dnsbl.njabl.org=127.0.0.3
29443 deny  dnslists = relays.ordb.org
29444 .endd
29445 which is less clear, and harder to maintain.
29446
29447
29448
29449
29450 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29451 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29452 thereby providing more than one IP address. When an item in a &%dnslists%& list
29453 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29454 the match to specific results from the DNS lookup, there are two ways in which
29455 the checking can be handled. For example, consider the condition:
29456 .code
29457 dnslists = a.b.c=127.0.0.1
29458 .endd
29459 What happens if the DNS lookup for the incoming IP address yields both
29460 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29461 condition true because at least one given value was found, or is it false
29462 because at least one of the found values was not listed? And how does this
29463 affect negated conditions? Both possibilities are provided for with the help of
29464 additional separators &`==`& and &`=&&`&.
29465
29466 .ilist
29467 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29468 IP addresses matches one of the listed addresses. For the example above, the
29469 condition is true because 127.0.0.1 matches.
29470 .next
29471 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29472 looked up IP addresses matches one of the listed addresses. If the condition is
29473 changed to:
29474 .code
29475 dnslists = a.b.c==127.0.0.1
29476 .endd
29477 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29478 false because 127.0.0.2 is not listed. You would need to have:
29479 .code
29480 dnslists = a.b.c==127.0.0.1,127.0.0.2
29481 .endd
29482 for the condition to be true.
29483 .endlist
29484
29485 When &`!`& is used to negate IP address matching, it inverts the result, giving
29486 the precise opposite of the behaviour above. Thus:
29487 .ilist
29488 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29489 addresses matches one of the listed addresses. Consider:
29490 .code
29491 dnslists = a.b.c!&0.0.0.1
29492 .endd
29493 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29494 false because 127.0.0.1 matches.
29495 .next
29496 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29497 looked up IP address that does not match. Consider:
29498 .code
29499 dnslists = a.b.c!=&0.0.0.1
29500 .endd
29501 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29502 true, because 127.0.0.2 does not match. You would need to have:
29503 .code
29504 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29505 .endd
29506 for the condition to be false.
29507 .endlist
29508 When the DNS lookup yields only a single IP address, there is no difference
29509 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29510
29511
29512
29513
29514 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29515 .cindex "DNS list" "information from merged"
29516 When the facility for restricting the matching IP values in a DNS list is used,
29517 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29518 the true reason for rejection. This happens when lists are merged and the IP
29519 address in the A record is used to distinguish them; unfortunately there is
29520 only one TXT record. One way round this is not to use merged lists, but that
29521 can be inefficient because it requires multiple DNS lookups where one would do
29522 in the vast majority of cases when the host of interest is not on any of the
29523 lists.
29524
29525 A less inefficient way of solving this problem is available. If
29526 two domain names, comma-separated, are given, the second is used first to
29527 do an initial check, making use of any IP value restrictions that are set.
29528 If there is a match, the first domain is used, without any IP value
29529 restrictions, to get the TXT record. As a byproduct of this, there is also
29530 a check that the IP being tested is indeed on the first list. The first
29531 domain is the one that is put in &$dnslist_domain$&. For example:
29532 .code
29533 reject message  = \
29534          rejected because $sender_host_address is blacklisted \
29535          at $dnslist_domain\n$dnslist_text
29536        dnslists = \
29537          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29538          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29539 .endd
29540 For the first blacklist item, this starts by doing a lookup in
29541 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29542 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29543 value, and as long as something is found, it looks for the corresponding TXT
29544 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29545 The second blacklist item is processed similarly.
29546
29547 If you are interested in more than one merged list, the same list must be
29548 given several times, but because the results of the DNS lookups are cached,
29549 the DNS calls themselves are not repeated. For example:
29550 .code
29551 reject dnslists = \
29552          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29553          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29554          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29555          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29556 .endd
29557 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29558 values matches (or if no record is found), this is the only lookup that is
29559 done. Only if there is a match is one of the more specific lists consulted.
29560
29561
29562
29563 .section "DNS lists and IPv6" "SECTmorednslistslast"
29564 .cindex "IPv6" "DNS black lists"
29565 .cindex "DNS list" "IPv6 usage"
29566 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29567 nibble by nibble. For example, if the calling host's IP address is
29568 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29569 .code
29570 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29571   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29572 .endd
29573 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29574 lists contain wildcard records, intended for IPv4, that interact badly with
29575 IPv6. For example, the DNS entry
29576 .code
29577 *.3.some.list.example.    A    127.0.0.1
29578 .endd
29579 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29580 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29581
29582 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29583 &%condition%& condition, as in this example:
29584 .code
29585 deny   condition = ${if isip4{$sender_host_address}}
29586        dnslists  = some.list.example
29587 .endd
29588
29589 If an explicit key is being used for a DNS lookup and it may be an IPv6
29590 address you should specify alternate list separators for both the outer
29591 (DNS list name) list and inner (lookup keys) list:
29592 .code
29593        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29594 .endd
29595
29596 .section "Rate limiting incoming messages" "SECTratelimiting"
29597 .cindex "rate limiting" "client sending"
29598 .cindex "limiting client sending rates"
29599 .oindex "&%smtp_ratelimit_*%&"
29600 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29601 which clients can send email. This is more powerful than the
29602 &%smtp_ratelimit_*%& options, because those options control the rate of
29603 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29604 works across all connections (concurrent and sequential) from the same client
29605 host. The syntax of the &%ratelimit%& condition is:
29606 .display
29607 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29608 .endd
29609 If the average client sending rate is less than &'m'& messages per time
29610 period &'p'& then the condition is false; otherwise it is true.
29611
29612 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29613 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29614 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29615 of &'p'&.
29616
29617 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29618 time interval, for example, &`8h`& for eight hours. A larger time constant
29619 means that it takes Exim longer to forget a client's past behaviour. The
29620 parameter &'m'& is the maximum number of messages that a client is permitted to
29621 send in each time interval. It also specifies the number of messages permitted
29622 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29623 constant, you can allow a client to send more messages in a burst without
29624 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29625 both small, messages must be sent at an even rate.
29626
29627 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29628 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29629 when deploying the &%ratelimit%& ACL condition. The script prints usage
29630 instructions when it is run with no arguments.
29631
29632 The key is used to look up the data for calculating the client's average
29633 sending rate. This data is stored in Exim's spool directory, alongside the
29634 retry and other hints databases. The default key is &$sender_host_address$&,
29635 which means Exim computes the sending rate of each client host IP address.
29636 By changing the key you can change how Exim identifies clients for the purpose
29637 of ratelimiting. For example, to limit the sending rate of each authenticated
29638 user, independent of the computer they are sending from, set the key to
29639 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29640 example, &$authenticated_id$& is only meaningful if the client has
29641 authenticated (which you can check with the &%authenticated%& ACL condition).
29642
29643 The lookup key does not have to identify clients: If you want to limit the
29644 rate at which a recipient receives messages, you can use the key
29645 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29646 ACL.
29647
29648 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29649 specifies what Exim measures the rate of, for example messages or recipients
29650 or bytes. You can adjust the measurement using the &%unique=%& and/or
29651 &%count=%& options. You can also control when Exim updates the recorded rate
29652 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29653 separated by a slash, like the other parameters. They may appear in any order.
29654
29655 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29656 any options that alter the meaning of the stored data. The limit &'m'& is not
29657 stored, so you can alter the configured maximum rate and Exim will still
29658 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29659 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29660 behaviour. The lookup key is not affected by changes to the update mode and
29661 the &%count=%& option.
29662
29663
29664 .section "Ratelimit options for what is being measured" "ratoptmea"
29665 .cindex "rate limiting" "per_* options"
29666 The &%per_conn%& option limits the client's connection rate. It is not
29667 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29668 &%acl_not_smtp_start%& ACLs.
29669
29670 The &%per_mail%& option limits the client's rate of sending messages. This is
29671 the default if none of the &%per_*%& options is specified. It can be used in
29672 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29673 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29674
29675 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29676 the same ACLs as the &%per_mail%& option, though it is best to use this option
29677 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29678 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29679 in its MAIL command, which may be inaccurate or completely missing. You can
29680 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29681 in kilobytes, megabytes, or gigabytes, respectively.
29682
29683 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29684 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29685 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29686 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29687 ACLs the rate is updated with the total recipient count in one go. Note that
29688 in either case the rate limiting engine will see a message with many
29689 recipients as a large high-speed burst.
29690
29691 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29692 number of different recipients that the client has sent messages to in the
29693 last time period. That is, if the client repeatedly sends messages to the same
29694 recipient, its measured rate is not increased. This option can only be used in
29695 &%acl_smtp_rcpt%&.
29696
29697 The &%per_cmd%& option causes Exim to recompute the rate every time the
29698 condition is processed. This can be used to limit the rate of any SMTP
29699 command. If it is used in multiple ACLs it can limit the aggregate rate of
29700 multiple different commands.
29701
29702 The &%count=%& option can be used to alter how much Exim adds to the client's
29703 measured rate. For example, the &%per_byte%& option is equivalent to
29704 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29705 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29706 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29707
29708 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29709
29710
29711 .section "Ratelimit update modes" "ratoptupd"
29712 .cindex "rate limiting" "reading data without updating"
29713 You can specify one of three options with the &%ratelimit%& condition to
29714 control when its database is updated. This section describes the &%readonly%&
29715 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29716
29717 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29718 previously-computed rate to check against the limit.
29719
29720 For example, you can test the client's sending rate and deny it access (when
29721 it is too fast) in the connect ACL. If the client passes this check then it
29722 can go on to send a message, in which case its recorded rate will be updated
29723 in the MAIL ACL. Subsequent connections from the same client will check this
29724 new rate.
29725 .code
29726 acl_check_connect:
29727  deny ratelimit = 100 / 5m / readonly
29728     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29729                   (max $sender_rate_limit)
29730 # ...
29731 acl_check_mail:
29732  warn ratelimit = 100 / 5m / strict
29733     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29734                   (max $sender_rate_limit)
29735 .endd
29736
29737 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29738 processing a message then it may increase the client's measured rate more than
29739 it should. For example, this will happen if you check the &%per_rcpt%& option
29740 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29741 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29742 multiple update problems by using the &%readonly%& option on later ratelimit
29743 checks.
29744
29745 The &%per_*%& options described above do not make sense in some ACLs. If you
29746 use a &%per_*%& option in an ACL where it is not normally permitted then the
29747 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29748 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29749 next section) so you must specify the &%readonly%& option explicitly.
29750
29751
29752 .section "Ratelimit options for handling fast clients" "ratoptfast"
29753 .cindex "rate limiting" "strict and leaky modes"
29754 If a client's average rate is greater than the maximum, the rate limiting
29755 engine can react in two possible ways, depending on the presence of the
29756 &%strict%& or &%leaky%& update modes. This is independent of the other
29757 counter-measures (such as rejecting the message) that may be specified by the
29758 rest of the ACL.
29759
29760 The &%leaky%& (default) option means that the client's recorded rate is not
29761 updated if it is above the limit. The effect of this is that Exim measures the
29762 client's average rate of successfully sent email, which cannot be greater than
29763 the maximum allowed. If the client is over the limit it may suffer some
29764 counter-measures (as specified in the ACL), but it will still be able to send
29765 email at the configured maximum rate, whatever the rate of its attempts. This
29766 is generally the better choice if you have clients that retry automatically.
29767 For example, it does not prevent a sender with an over-aggressive retry rate
29768 from getting any email through.
29769
29770 The &%strict%& option means that the client's recorded rate is always
29771 updated. The effect of this is that Exim measures the client's average rate
29772 of attempts to send email, which can be much higher than the maximum it is
29773 actually allowed. If the client is over the limit it may be subjected to
29774 counter-measures by the ACL. It must slow down and allow sufficient time to
29775 pass that its computed rate falls below the maximum before it can send email
29776 again. The time (the number of smoothing periods) it must wait and not
29777 attempt to send mail can be calculated with this formula:
29778 .code
29779         ln(peakrate/maxrate)
29780 .endd
29781
29782
29783 .section "Limiting the rate of different events" "ratoptuniq"
29784 .cindex "rate limiting" "counting unique events"
29785 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29786 rate of different events. For example, the &%per_addr%& option uses this
29787 mechanism to count the number of different recipients that the client has
29788 sent messages to in the last time period; it is equivalent to
29789 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29790 measure the rate that a client uses different sender addresses with the
29791 options &`per_mail/unique=$sender_address`&.
29792
29793 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29794 has seen for that key. The whole set is thrown away when it is older than the
29795 rate smoothing period &'p'&, so each different event is counted at most once
29796 per period. In the &%leaky%& update mode, an event that causes the client to
29797 go over the limit is not added to the set, in the same way that the client's
29798 recorded rate is not updated in the same situation.
29799
29800 When you combine the &%unique=%& and &%readonly%& options, the specific
29801 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29802 rate.
29803
29804 The &%unique=%& mechanism needs more space in the ratelimit database than the
29805 other &%ratelimit%& options in order to store the event set. The number of
29806 unique values is potentially as large as the rate limit, so the extra space
29807 required increases with larger limits.
29808
29809 The uniqueification is not perfect: there is a small probability that Exim
29810 will think a new event has happened before. If the sender's rate is less than
29811 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29812 the measured rate can go above the limit, in which case Exim may under-count
29813 events by a significant margin. Fortunately, if the rate is high enough (2.7
29814 times the limit) that the false positive rate goes above 9%, then Exim will
29815 throw away the over-full event set before the measured rate falls below the
29816 limit. Therefore the only harm should be that exceptionally high sending rates
29817 are logged incorrectly; any countermeasures you configure will be as effective
29818 as intended.
29819
29820
29821 .section "Using rate limiting" "useratlim"
29822 Exim's other ACL facilities are used to define what counter-measures are taken
29823 when the rate limit is exceeded. This might be anything from logging a warning
29824 (for example, while measuring existing sending rates in order to define
29825 policy), through time delays to slow down fast senders, up to rejecting the
29826 message. For example:
29827 .code
29828 # Log all senders' rates
29829 warn ratelimit = 0 / 1h / strict
29830      log_message = Sender rate $sender_rate / $sender_rate_period
29831
29832 # Slow down fast senders; note the need to truncate $sender_rate
29833 # at the decimal point.
29834 warn ratelimit = 100 / 1h / per_rcpt / strict
29835      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29836                    $sender_rate_limit }s
29837
29838 # Keep authenticated users under control
29839 deny authenticated = *
29840      ratelimit = 100 / 1d / strict / $authenticated_id
29841
29842 # System-wide rate limit
29843 defer message = Sorry, too busy. Try again later.
29844      ratelimit = 10 / 1s / $primary_hostname
29845
29846 # Restrict incoming rate from each host, with a default
29847 # set using a macro and special cases looked up in a table.
29848 defer message = Sender rate exceeds $sender_rate_limit \
29849                messages per $sender_rate_period
29850      ratelimit = ${lookup {$sender_host_address} \
29851                    cdb {DB/ratelimits.cdb} \
29852                    {$value} {RATELIMIT} }
29853 .endd
29854 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29855 especially with the &%per_rcpt%& option, you may suffer from a performance
29856 bottleneck caused by locking on the ratelimit hints database. Apart from
29857 making your ACLs less complicated, you can reduce the problem by using a
29858 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29859 this means that Exim will lose its hints data after a reboot (including retry
29860 hints, the callout cache, and ratelimit data).
29861
29862
29863
29864 .section "Address verification" "SECTaddressverification"
29865 .cindex "verifying address" "options for"
29866 .cindex "policy control" "address verification"
29867 Several of the &%verify%& conditions described in section
29868 &<<SECTaclconditions>>& cause addresses to be verified. Section
29869 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29870 The verification conditions can be followed by options that modify the
29871 verification process. The options are separated from the keyword and from each
29872 other by slashes, and some of them contain parameters. For example:
29873 .code
29874 verify = sender/callout
29875 verify = recipient/defer_ok/callout=10s,defer_ok
29876 .endd
29877 The first stage of address verification, which always happens, is to run the
29878 address through the routers, in &"verify mode"&. Routers can detect the
29879 difference between verification and routing for delivery, and their actions can
29880 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29881 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29882 The available options are as follows:
29883
29884 .ilist
29885 If the &%callout%& option is specified, successful routing to one or more
29886 remote hosts is followed by a &"callout"& to those hosts as an additional
29887 check. Callouts and their sub-options are discussed in the next section.
29888 .next
29889 If there is a defer error while doing verification routing, the ACL
29890 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29891 options, the condition is forced to be true instead. Note that this is a main
29892 verification option as well as a suboption for callouts.
29893 .next
29894 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29895 discusses the reporting of sender address verification failures.
29896 .next
29897 The &%success_on_redirect%& option causes verification always to succeed
29898 immediately after a successful redirection. By default, if a redirection
29899 generates just one address, that address is also verified. See further
29900 discussion in section &<<SECTredirwhilveri>>&.
29901 .endlist
29902
29903 .cindex "verifying address" "differentiating failures"
29904 .vindex "&$recipient_verify_failure$&"
29905 .vindex "&$sender_verify_failure$&"
29906 .vindex "&$acl_verify_message$&"
29907 After an address verification failure, &$acl_verify_message$& contains the
29908 error message that is associated with the failure. It can be preserved by
29909 coding like this:
29910 .code
29911 warn  !verify = sender
29912        set acl_m0 = $acl_verify_message
29913 .endd
29914 If you are writing your own custom rejection message or log message when
29915 denying access, you can use this variable to include information about the
29916 verification failure.
29917
29918 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29919 appropriate) contains one of the following words:
29920
29921 .ilist
29922 &%qualify%&: The address was unqualified (no domain), and the message
29923 was neither local nor came from an exempted host.
29924 .next
29925 &%route%&: Routing failed.
29926 .next
29927 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29928 occurred at or before the MAIL command (that is, on initial
29929 connection, HELO, or MAIL).
29930 .next
29931 &%recipient%&: The RCPT command in a callout was rejected.
29932 .next
29933 &%postmaster%&: The postmaster check in a callout was rejected.
29934 .endlist
29935
29936 The main use of these variables is expected to be to distinguish between
29937 rejections of MAIL and rejections of RCPT in callouts.
29938
29939
29940
29941
29942 .section "Callout verification" "SECTcallver"
29943 .cindex "verifying address" "by callout"
29944 .cindex "callout" "verification"
29945 .cindex "SMTP" "callout verification"
29946 For non-local addresses, routing verifies the domain, but is unable to do any
29947 checking of the local part. There are situations where some means of verifying
29948 the local part is desirable. One way this can be done is to make an SMTP
29949 &'callback'& to a delivery host for the sender address or a &'callforward'& to
29950 a subsequent host for a recipient address, to see if the host accepts the
29951 address. We use the term &'callout'& to cover both cases. Note that for a
29952 sender address, the callback is not to the client host that is trying to
29953 deliver the message, but to one of the hosts that accepts incoming mail for the
29954 sender's domain.
29955
29956 Exim does not do callouts by default. If you want them to happen, you must
29957 request them by setting appropriate options on the &%verify%& condition, as
29958 described below. This facility should be used with care, because it can add a
29959 lot of resource usage to the cost of verifying an address. However, Exim does
29960 cache the results of callouts, which helps to reduce the cost. Details of
29961 caching are in section &<<SECTcallvercache>>&.
29962
29963 Recipient callouts are usually used only between hosts that are controlled by
29964 the same administration. For example, a corporate gateway host could use
29965 callouts to check for valid recipients on an internal mailserver. A successful
29966 callout does not guarantee that a real delivery to the address would succeed;
29967 on the other hand, a failing callout does guarantee that a delivery would fail.
29968
29969 If the &%callout%& option is present on a condition that verifies an address, a
29970 second stage of verification occurs if the address is successfully routed to
29971 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
29972 &(manualroute)& router, where the router specifies the hosts. However, if a
29973 router that does not set up hosts routes to an &(smtp)& transport with a
29974 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
29975 &%hosts_override%& set, its hosts are always used, whether or not the router
29976 supplies a host list.
29977 Callouts are only supported on &(smtp)& transports.
29978
29979 The port that is used is taken from the transport, if it is specified and is a
29980 remote transport. (For routers that do verification only, no transport need be
29981 specified.) Otherwise, the default SMTP port is used. If a remote transport
29982 specifies an outgoing interface, this is used; otherwise the interface is not
29983 specified. Likewise, the text that is used for the HELO command is taken from
29984 the transport's &%helo_data%& option; if there is no transport, the value of
29985 &$smtp_active_hostname$& is used.
29986
29987 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
29988 test whether a bounce message could be delivered to the sender address. The
29989 following SMTP commands are sent:
29990 .display
29991 &`HELO `&<&'local host name'&>
29992 &`MAIL FROM:<>`&
29993 &`RCPT TO:`&<&'the address to be tested'&>
29994 &`QUIT`&
29995 .endd
29996 LHLO is used instead of HELO if the transport's &%protocol%& option is
29997 set to &"lmtp"&.
29998
29999 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30000 settings.
30001
30002 A recipient callout check is similar. By default, it also uses an empty address
30003 for the sender. This default is chosen because most hosts do not make use of
30004 the sender address when verifying a recipient. Using the same address means
30005 that a single cache entry can be used for each recipient. Some sites, however,
30006 do make use of the sender address when verifying. These are catered for by the
30007 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30008
30009 If the response to the RCPT command is a 2&'xx'& code, the verification
30010 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30011 Exim tries the next host, if any. If there is a problem with all the remote
30012 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30013 &%callout%& option is given, in which case the condition is forced to succeed.
30014
30015 .cindex "SMTP" "output flushing, disabling for callout"
30016 A callout may take a little time. For this reason, Exim normally flushes SMTP
30017 output before performing a callout in an ACL, to avoid unexpected timeouts in
30018 clients when the SMTP PIPELINING extension is in use. The flushing can be
30019 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30020
30021
30022
30023
30024 .section "Additional parameters for callouts" "CALLaddparcall"
30025 .cindex "callout" "additional parameters for"
30026 The &%callout%& option can be followed by an equals sign and a number of
30027 optional parameters, separated by commas. For example:
30028 .code
30029 verify = recipient/callout=10s,defer_ok
30030 .endd
30031 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30032 separate verify options, is retained for backwards compatibility, but is now
30033 deprecated. The additional parameters for &%callout%& are as follows:
30034
30035
30036 .vlist
30037 .vitem <&'a&~time&~interval'&>
30038 .cindex "callout" "timeout, specifying"
30039 This specifies the timeout that applies for the callout attempt to each host.
30040 For example:
30041 .code
30042 verify = sender/callout=5s
30043 .endd
30044 The default is 30 seconds. The timeout is used for each response from the
30045 remote host. It is also used for the initial connection, unless overridden by
30046 the &%connect%& parameter.
30047
30048
30049 .vitem &*connect&~=&~*&<&'time&~interval'&>
30050 .cindex "callout" "connection timeout, specifying"
30051 This parameter makes it possible to set a different (usually smaller) timeout
30052 for making the SMTP connection. For example:
30053 .code
30054 verify = sender/callout=5s,connect=1s
30055 .endd
30056 If not specified, this timeout defaults to the general timeout value.
30057
30058 .vitem &*defer_ok*&
30059 .cindex "callout" "defer, action on"
30060 When this parameter is present, failure to contact any host, or any other kind
30061 of temporary error, is treated as success by the ACL. However, the cache is not
30062 updated in this circumstance.
30063
30064 .vitem &*fullpostmaster*&
30065 .cindex "callout" "full postmaster check"
30066 This operates like the &%postmaster%& option (see below), but if the check for
30067 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30068 accordance with the specification in RFC 2821. The RFC states that the
30069 unqualified address &'postmaster'& should be accepted.
30070
30071
30072 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30073 .cindex "callout" "sender when verifying header"
30074 When verifying addresses in header lines using the &%header_sender%&
30075 verification option, Exim behaves by default as if the addresses are envelope
30076 sender addresses from a message. Callout verification therefore tests to see
30077 whether a bounce message could be delivered, by using an empty address in the
30078 MAIL command. However, it is arguable that these addresses might never be used
30079 as envelope senders, and could therefore justifiably reject bounce messages
30080 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30081 address to use in the MAIL command. For example:
30082 .code
30083 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30084 .endd
30085 This parameter is available only for the &%header_sender%& verification option.
30086
30087
30088 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30089 .cindex "callout" "overall timeout, specifying"
30090 This parameter sets an overall timeout for performing a callout verification.
30091 For example:
30092 .code
30093 verify = sender/callout=5s,maxwait=30s
30094 .endd
30095 This timeout defaults to four times the callout timeout for individual SMTP
30096 commands. The overall timeout applies when there is more than one host that can
30097 be tried. The timeout is checked before trying the next host. This prevents
30098 very long delays if there are a large number of hosts and all are timing out
30099 (for example, when network connections are timing out).
30100
30101
30102 .vitem &*no_cache*&
30103 .cindex "callout" "cache, suppressing"
30104 .cindex "caching callout, suppressing"
30105 When this parameter is given, the callout cache is neither read nor updated.
30106
30107 .vitem &*postmaster*&
30108 .cindex "callout" "postmaster; checking"
30109 When this parameter is set, a successful callout check is followed by a similar
30110 check for the local part &'postmaster'& at the same domain. If this address is
30111 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30112 the postmaster check is recorded in a cache record; if it is a failure, this is
30113 used to fail subsequent callouts for the domain without a connection being
30114 made, until the cache record expires.
30115
30116 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30117 The postmaster check uses an empty sender in the MAIL command by default.
30118 You can use this parameter to do a postmaster check using a different address.
30119 For example:
30120 .code
30121 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30122 .endd
30123 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30124 one overrides. The &%postmaster%& parameter is equivalent to this example:
30125 .code
30126 require  verify = sender/callout=postmaster_mailfrom=
30127 .endd
30128 &*Warning*&: The caching arrangements for postmaster checking do not take
30129 account of the sender address. It is assumed that either the empty address or
30130 a fixed non-empty address will be used. All that Exim remembers is that the
30131 postmaster check for the domain succeeded or failed.
30132
30133
30134 .vitem &*random*&
30135 .cindex "callout" "&""random""& check"
30136 When this parameter is set, before doing the normal callout check, Exim does a
30137 check for a &"random"& local part at the same domain. The local part is not
30138 really random &-- it is defined by the expansion of the option
30139 &%callout_random_local_part%&, which defaults to
30140 .code
30141 $primary_hostname-$tod_epoch-testing
30142 .endd
30143 The idea here is to try to determine whether the remote host accepts all local
30144 parts without checking. If it does, there is no point in doing callouts for
30145 specific local parts. If the &"random"& check succeeds, the result is saved in
30146 a cache record, and used to force the current and subsequent callout checks to
30147 succeed without a connection being made, until the cache record expires.
30148
30149 .vitem &*use_postmaster*&
30150 .cindex "callout" "sender for recipient check"
30151 This parameter applies to recipient callouts only. For example:
30152 .code
30153 deny  !verify = recipient/callout=use_postmaster
30154 .endd
30155 .vindex "&$qualify_domain$&"
30156 It causes a non-empty postmaster address to be used in the MAIL command when
30157 performing the callout for the recipient, and also for a &"random"& check if
30158 that is configured. The local part of the address is &`postmaster`& and the
30159 domain is the contents of &$qualify_domain$&.
30160
30161 .vitem &*use_sender*&
30162 This option applies to recipient callouts only. For example:
30163 .code
30164 require  verify = recipient/callout=use_sender
30165 .endd
30166 It causes the message's actual sender address to be used in the MAIL
30167 command when performing the callout, instead of an empty address. There is no
30168 need to use this option unless you know that the called hosts make use of the
30169 sender when checking recipients. If used indiscriminately, it reduces the
30170 usefulness of callout caching.
30171 .endlist
30172
30173 If you use any of the parameters that set a non-empty sender for the MAIL
30174 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30175 &%use_sender%&), you should think about possible loops. Recipient checking is
30176 usually done between two hosts that are under the same management, and the host
30177 that receives the callouts is not normally configured to do callouts itself.
30178 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30179 these circumstances.
30180
30181 However, if you use a non-empty sender address for a callout to an arbitrary
30182 host, there is the likelihood that the remote host will itself initiate a
30183 callout check back to your host. As it is checking what appears to be a message
30184 sender, it is likely to use an empty address in MAIL, thus avoiding a
30185 callout loop. However, to be on the safe side it would be best to set up your
30186 own ACLs so that they do not do sender verification checks when the recipient
30187 is the address you use for header sender or postmaster callout checking.
30188
30189 Another issue to think about when using non-empty senders for callouts is
30190 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30191 by the sender/recipient combination; thus, for any given recipient, many more
30192 actual callouts are performed than when an empty sender or postmaster is used.
30193
30194
30195
30196
30197 .section "Callout caching" "SECTcallvercache"
30198 .cindex "hints database" "callout cache"
30199 .cindex "callout" "cache, description of"
30200 .cindex "caching" "callout"
30201 Exim caches the results of callouts in order to reduce the amount of resources
30202 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30203 option. A hints database called &"callout"& is used for the cache. Two
30204 different record types are used: one records the result of a callout check for
30205 a specific address, and the other records information that applies to the
30206 entire domain (for example, that it accepts the local part &'postmaster'&).
30207
30208 When an original callout fails, a detailed SMTP error message is given about
30209 the failure. However, for subsequent failures use the cache data, this message
30210 is not available.
30211
30212 The expiry times for negative and positive address cache records are
30213 independent, and can be set by the global options &%callout_negative_expire%&
30214 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30215
30216 If a host gives a negative response to an SMTP connection, or rejects any
30217 commands up to and including
30218 .code
30219 MAIL FROM:<>
30220 .endd
30221 (but not including the MAIL command with a non-empty address),
30222 any callout attempt is bound to fail. Exim remembers such failures in a
30223 domain cache record, which it uses to fail callouts for the domain without
30224 making new connections, until the domain record times out. There are two
30225 separate expiry times for domain cache records:
30226 &%callout_domain_negative_expire%& (default 3h) and
30227 &%callout_domain_positive_expire%& (default 7d).
30228
30229 Domain records expire when the negative expiry time is reached if callouts
30230 cannot be made for the domain, or if the postmaster check failed.
30231 Otherwise, they expire when the positive expiry time is reached. This
30232 ensures that, for example, a host that stops accepting &"random"& local parts
30233 will eventually be noticed.
30234
30235 The callout caching mechanism is based on the domain of the address that is
30236 being tested. If the domain routes to several hosts, it is assumed that their
30237 behaviour will be the same.
30238
30239
30240
30241 .section "Sender address verification reporting" "SECTsenaddver"
30242 .cindex "verifying" "suppressing error details"
30243 See section &<<SECTaddressverification>>& for a general discussion of
30244 verification. When sender verification fails in an ACL, the details of the
30245 failure are given as additional output lines before the 550 response to the
30246 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30247 you might see:
30248 .code
30249 MAIL FROM:<xyz@abc.example>
30250 250 OK
30251 RCPT TO:<pqr@def.example>
30252 550-Verification failed for <xyz@abc.example>
30253 550-Called:   192.168.34.43
30254 550-Sent:     RCPT TO:<xyz@abc.example>
30255 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30256 550 Sender verification failed
30257 .endd
30258 If more than one RCPT command fails in the same way, the details are given
30259 only for the first of them. However, some administrators do not want to send
30260 out this much information. You can suppress the details by adding
30261 &`/no_details`& to the ACL statement that requests sender verification. For
30262 example:
30263 .code
30264 verify = sender/no_details
30265 .endd
30266
30267 .section "Redirection while verifying" "SECTredirwhilveri"
30268 .cindex "verifying" "redirection while"
30269 .cindex "address redirection" "while verifying"
30270 A dilemma arises when a local address is redirected by aliasing or forwarding
30271 during verification: should the generated addresses themselves be verified,
30272 or should the successful expansion of the original address be enough to verify
30273 it? By default, Exim takes the following pragmatic approach:
30274
30275 .ilist
30276 When an incoming address is redirected to just one child address, verification
30277 continues with the child address, and if that fails to verify, the original
30278 verification also fails.
30279 .next
30280 When an incoming address is redirected to more than one child address,
30281 verification does not continue. A success result is returned.
30282 .endlist
30283
30284 This seems the most reasonable behaviour for the common use of aliasing as a
30285 way of redirecting different local parts to the same mailbox. It means, for
30286 example, that a pair of alias entries of the form
30287 .code
30288 A.Wol:   aw123
30289 aw123:   :fail: Gone away, no forwarding address
30290 .endd
30291 work as expected, with both local parts causing verification failure. When a
30292 redirection generates more than one address, the behaviour is more like a
30293 mailing list, where the existence of the alias itself is sufficient for
30294 verification to succeed.
30295
30296 It is possible, however, to change the default behaviour so that all successful
30297 redirections count as successful verifications, however many new addresses are
30298 generated. This is specified by the &%success_on_redirect%& verification
30299 option. For example:
30300 .code
30301 require verify = recipient/success_on_redirect/callout=10s
30302 .endd
30303 In this example, verification succeeds if a router generates a new address, and
30304 the callout does not occur, because no address was routed to a remote host.
30305
30306 When verification is being tested via the &%-bv%& option, the treatment of
30307 redirections is as just described, unless the &%-v%& or any debugging option is
30308 also specified. In that case, full verification is done for every generated
30309 address and a report is output for each of them.
30310
30311
30312
30313 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30314 .cindex "CSA" "verifying"
30315 Client SMTP Authorization is a system that allows a site to advertise
30316 which machines are and are not permitted to send email. This is done by placing
30317 special SRV records in the DNS; these are looked up using the client's HELO
30318 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30319 Authorization checks in Exim are performed by the ACL condition:
30320 .code
30321 verify = csa
30322 .endd
30323 This fails if the client is not authorized. If there is a DNS problem, or if no
30324 valid CSA SRV record is found, or if the client is authorized, the condition
30325 succeeds. These three cases can be distinguished using the expansion variable
30326 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30327 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30328 be likely to cause problems for legitimate email.
30329
30330 The error messages produced by the CSA code include slightly more
30331 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30332 looking up the CSA SRV record, or problems looking up the CSA target
30333 address record. There are four reasons for &$csa_status$& being &"fail"&:
30334
30335 .ilist
30336 The client's host name is explicitly not authorized.
30337 .next
30338 The client's IP address does not match any of the CSA target IP addresses.
30339 .next
30340 The client's host name is authorized but it has no valid target IP addresses
30341 (for example, the target's addresses are IPv6 and the client is using IPv4).
30342 .next
30343 The client's host name has no CSA SRV record but a parent domain has asserted
30344 that all subdomains must be explicitly authorized.
30345 .endlist
30346
30347 The &%csa%& verification condition can take an argument which is the domain to
30348 use for the DNS query. The default is:
30349 .code
30350 verify = csa/$sender_helo_name
30351 .endd
30352 This implementation includes an extension to CSA. If the query domain
30353 is an address literal such as [192.0.2.95], or if it is a bare IP
30354 address, Exim searches for CSA SRV records in the reverse DNS as if
30355 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30356 meaningful to say:
30357 .code
30358 verify = csa/$sender_host_address
30359 .endd
30360 In fact, this is the check that Exim performs if the client does not say HELO.
30361 This extension can be turned off by setting the main configuration option
30362 &%dns_csa_use_reverse%& to be false.
30363
30364 If a CSA SRV record is not found for the domain itself, a search
30365 is performed through its parent domains for a record which might be
30366 making assertions about subdomains. The maximum depth of this search is limited
30367 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30368 default. Exim does not look for CSA SRV records in a top level domain, so the
30369 default settings handle HELO domains as long as seven
30370 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30371 of legitimate HELO domains.
30372
30373 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30374 direct SRV lookups, this is not sufficient because of the extra parent domain
30375 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30376 addresses into lookups in the reverse DNS space. The result of a successful
30377 lookup such as:
30378 .code
30379 ${lookup dnsdb {csa=$sender_helo_name}}
30380 .endd
30381 has two space-separated fields: an authorization code and a target host name.
30382 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30383 authorization required but absent, or &"?"& for unknown.
30384
30385
30386
30387
30388 .section "Bounce address tag validation" "SECTverifyPRVS"
30389 .cindex "BATV, verifying"
30390 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30391 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30392 Genuine incoming bounce messages should therefore always be addressed to
30393 recipients that have a valid tag. This scheme is a way of detecting unwanted
30394 bounce messages caused by sender address forgeries (often called &"collateral
30395 spam"&), because the recipients of such messages do not include valid tags.
30396
30397 There are two expansion items to help with the implementation of the BATV
30398 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30399 the original envelope sender address by using a simple key to add a hash of the
30400 address and some time-based randomizing information. The &%prvs%& expansion
30401 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30402 The syntax of these expansion items is described in section
30403 &<<SECTexpansionitems>>&.
30404
30405 As an example, suppose the secret per-address keys are stored in an MySQL
30406 database. A query to look up the key for an address could be defined as a macro
30407 like this:
30408 .code
30409 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30410                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30411                 }{$value}}
30412 .endd
30413 Suppose also that the senders who make use of BATV are defined by an address
30414 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30415 use this:
30416 .code
30417 # Bounces: drop unsigned addresses for BATV senders
30418 deny message = This address does not send an unsigned reverse path
30419      senders = :
30420      recipients = +batv_senders
30421
30422 # Bounces: In case of prvs-signed address, check signature.
30423 deny message = Invalid reverse path signature.
30424      senders = :
30425      condition  = ${prvscheck {$local_part@$domain}\
30426                   {PRVSCHECK_SQL}{1}}
30427      !condition = $prvscheck_result
30428 .endd
30429 The first statement rejects recipients for bounce messages that are addressed
30430 to plain BATV sender addresses, because it is known that BATV senders do not
30431 send out messages with plain sender addresses. The second statement rejects
30432 recipients that are prvs-signed, but with invalid signatures (either because
30433 the key is wrong, or the signature has timed out).
30434
30435 A non-prvs-signed address is not rejected by the second statement, because the
30436 &%prvscheck%& expansion yields an empty string if its first argument is not a
30437 prvs-signed address, thus causing the &%condition%& condition to be false. If
30438 the first argument is a syntactically valid prvs-signed address, the yield is
30439 the third string (in this case &"1"&), whether or not the cryptographic and
30440 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30441 of the checks (empty for failure, &"1"& for success).
30442
30443 There is one more issue you must consider when implementing prvs-signing:
30444 you have to ensure that the routers accept prvs-signed addresses and
30445 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30446 router to remove the signature with a configuration along these lines:
30447 .code
30448 batv_redirect:
30449   driver = redirect
30450   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30451 .endd
30452 This works because, if the third argument of &%prvscheck%& is empty, the result
30453 of the expansion of a prvs-signed address is the decoded value of the original
30454 address. This router should probably be the first of your routers that handles
30455 local addresses.
30456
30457 To create BATV-signed addresses in the first place, a transport of this form
30458 can be used:
30459 .code
30460 external_smtp_batv:
30461   driver = smtp
30462   return_path = ${prvs {$return_path} \
30463                        {${lookup mysql{SELECT \
30464                        secret FROM batv_prvs WHERE \
30465                        sender='${quote_mysql:$sender_address}'} \
30466                        {$value}fail}}}
30467 .endd
30468 If no key can be found for the existing return path, no signing takes place.
30469
30470
30471
30472 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30473 .cindex "&ACL;" "relay control"
30474 .cindex "relaying" "control by ACL"
30475 .cindex "policy control" "relay control"
30476 An MTA is said to &'relay'& a message if it receives it from some host and
30477 delivers it directly to another host as a result of a remote address contained
30478 within it. Redirecting a local address via an alias or forward file and then
30479 passing the message on to another host is not relaying,
30480 .cindex "&""percent hack""&"
30481 but a redirection as a result of the &"percent hack"& is.
30482
30483 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30484 A host which is acting as a gateway or an MX backup is concerned with incoming
30485 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30486 a host which is acting as a smart host for a number of clients is concerned
30487 with outgoing relaying from those clients to the Internet at large. Often the
30488 same host is fulfilling both functions,
30489 . ///
30490 . as illustrated in the diagram below,
30491 . ///
30492 but in principle these two kinds of relaying are entirely independent. What is
30493 not wanted is the transmission of mail from arbitrary remote hosts through your
30494 system to arbitrary domains.
30495
30496
30497 You can implement relay control by means of suitable statements in the ACL that
30498 runs for each RCPT command. For convenience, it is often easiest to use
30499 Exim's named list facility to define the domains and hosts involved. For
30500 example, suppose you want to do the following:
30501
30502 .ilist
30503 Deliver a number of domains to mailboxes on the local host (or process them
30504 locally in some other way). Let's say these are &'my.dom1.example'& and
30505 &'my.dom2.example'&.
30506 .next
30507 Relay mail for a number of other domains for which you are the secondary MX.
30508 These might be &'friend1.example'& and &'friend2.example'&.
30509 .next
30510 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30511 Suppose your LAN is 192.168.45.0/24.
30512 .endlist
30513
30514
30515 In the main part of the configuration, you put the following definitions:
30516 .code
30517 domainlist local_domains    = my.dom1.example : my.dom2.example
30518 domainlist relay_to_domains = friend1.example : friend2.example
30519 hostlist   relay_from_hosts = 192.168.45.0/24
30520 .endd
30521 Now you can use these definitions in the ACL that is run for every RCPT
30522 command:
30523 .code
30524 acl_check_rcpt:
30525   accept domains = +local_domains : +relay_to_domains
30526   accept hosts   = +relay_from_hosts
30527 .endd
30528 The first statement accepts any RCPT command that contains an address in
30529 the local or relay domains. For any other domain, control passes to the second
30530 statement, which accepts the command only if it comes from one of the relay
30531 hosts. In practice, you will probably want to make your ACL more sophisticated
30532 than this, for example, by including sender and recipient verification. The
30533 default configuration includes a more comprehensive example, which is described
30534 in chapter &<<CHAPdefconfil>>&.
30535
30536
30537
30538 .section "Checking a relay configuration" "SECTcheralcon"
30539 .cindex "relaying" "checking control of"
30540 You can check the relay characteristics of your configuration in the same way
30541 that you can test any ACL behaviour for an incoming SMTP connection, by using
30542 the &%-bh%& option to run a fake SMTP session with which you interact.
30543
30544 For specifically testing for unwanted relaying, the host
30545 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30546 host from the host on which Exim is running, using the normal telnet port, you
30547 will see a normal telnet connection message and then quite a long delay. Be
30548 patient. The remote host is making an SMTP connection back to your host, and
30549 trying a number of common probes to test for open relay vulnerability. The
30550 results of the tests will eventually appear on your terminal.
30551 .ecindex IIDacl
30552
30553
30554
30555 . ////////////////////////////////////////////////////////////////////////////
30556 . ////////////////////////////////////////////////////////////////////////////
30557
30558 .chapter "Content scanning at ACL time" "CHAPexiscan"
30559 .scindex IIDcosca "content scanning" "at ACL time"
30560 The extension of Exim to include content scanning at ACL time, formerly known
30561 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30562 was integrated into the main source for Exim release 4.50, and Tom continues to
30563 maintain it. Most of the wording of this chapter is taken from Tom's
30564 specification.
30565
30566 It is also possible to scan the content of messages at other times. The
30567 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30568 scanning after all the ACLs have run. A transport filter can be used to scan
30569 messages at delivery time (see the &%transport_filter%& option, described in
30570 chapter &<<CHAPtransportgeneric>>&).
30571
30572 If you want to include the ACL-time content-scanning features when you compile
30573 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30574 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30575
30576 .ilist
30577 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30578 for all MIME parts for SMTP and non-SMTP messages, respectively.
30579 .next
30580 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30581 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30582 run at the end of message reception (the &%acl_smtp_data%& ACL).
30583 .next
30584 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30585 of messages, or parts of messages, for debugging purposes.
30586 .next
30587 Additional expansion variables that are set in the new ACL and by the new
30588 conditions.
30589 .next
30590 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30591 .endlist
30592
30593 There is another content-scanning configuration option for &_Local/Makefile_&,
30594 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30595 condition is compiled, in addition to all the other content-scanning features.
30596
30597 Content-scanning is continually evolving, and new features are still being
30598 added. While such features are still unstable and liable to incompatible
30599 changes, they are made available in Exim by setting options whose names begin
30600 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30601 this manual. You can find out about them by reading the file called
30602 &_doc/experimental.txt_&.
30603
30604 All the content-scanning facilities work on a MBOX copy of the message that is
30605 temporarily created in a file called:
30606 .display
30607 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30608 .endd
30609 The &_.eml_& extension is a friendly hint to virus scanners that they can
30610 expect an MBOX-like structure inside that file. The file is created when the
30611 first content scanning facility is called. Subsequent calls to content
30612 scanning conditions open the same file again. The directory is recursively
30613 removed when the &%acl_smtp_data%& ACL has finished running, unless
30614 .code
30615 control = no_mbox_unspool
30616 .endd
30617 has been encountered. When the MIME ACL decodes files, they are put into the
30618 same directory by default.
30619
30620
30621
30622 .section "Scanning for viruses" "SECTscanvirus"
30623 .cindex "virus scanning"
30624 .cindex "content scanning" "for viruses"
30625 .cindex "content scanning" "the &%malware%& condition"
30626 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30627 It supports a &"generic"& interface to scanners called via the shell, and
30628 specialized interfaces for &"daemon"& type virus scanners, which are resident
30629 in memory and thus are much faster.
30630
30631 .new
30632 A timeout of 2 minutes is applied to a scanner call (by default);
30633 if it expires then a defer action is taken.
30634 .wen
30635
30636 .oindex "&%av_scanner%&"
30637 You can set the &%av_scanner%& option in the main part of the configuration
30638 to specify which scanner to use, together with any additional options that
30639 are needed. The basic syntax is as follows:
30640 .display
30641 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30642 .endd
30643 If you do not set &%av_scanner%&, it defaults to
30644 .code
30645 av_scanner = sophie:/var/run/sophie
30646 .endd
30647 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30648 before use.
30649 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30650 The following scanner types are supported in this release:
30651
30652 .vlist
30653 .new
30654 .vitem &%avast%&
30655 .cindex "virus scanners" "avast"
30656 This is the scanner daemon of Avast. It has been tested with Avast Core
30657 Security (currenty at version 1.1.7).
30658 You can get a trial version at &url(http://www.avast.com) or for Linux
30659 at &url(http://www.avast.com/linux-server-antivirus).
30660 This scanner type takes one option,
30661 which can be either a full path to a UNIX socket,
30662 or host and port specifiers separated by white space.
30663 The host may be a name or an IP address; the port is either a
30664 single number or a pair of numbers with a dash between.
30665 Any further options are given, on separate lines,
30666 to the daemon as options before the main scan command.
30667 For example:
30668 .code
30669 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30670 av_scanner = avast:192.168.2.22 5036
30671 .endd
30672 If you omit the argument, the default path
30673 &_/var/run/avast/scan.sock_&
30674 is used.
30675 If you use a remote host,
30676 you need to make Exim's spool directory available to it,
30677 as the scanner is passed a file path, not file contents.
30678 For information about available commands and their options you may use 
30679 .code
30680 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30681     FLAGS
30682     SENSITIVITY
30683     PACK
30684 .endd
30685 .wen
30686
30687
30688 .vitem &%aveserver%&
30689 .cindex "virus scanners" "Kaspersky"
30690 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30691 at &url(http://www.kaspersky.com). This scanner type takes one option,
30692 which is the path to the daemon's UNIX socket. The default is shown in this
30693 example:
30694 .code
30695 av_scanner = aveserver:/var/run/aveserver
30696 .endd
30697
30698
30699 .vitem &%clamd%&
30700 .cindex "virus scanners" "clamd"
30701 This daemon-type scanner is GPL and free. You can get it at
30702 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30703 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30704 in the MIME ACL. This is no longer believed to be necessary.
30705
30706 The options are a list of server specifiers, which may be
30707 a UNIX socket specification,
30708 a TCP socket specification,
30709 or a (global) option.
30710
30711 A socket specification consists of a space-separated list.
30712 For a Unix socket the first element is a full path for the socket,
30713 for a TCP socket the first element is the IP address
30714 and the second a port number,
30715 Any further elements are per-server (non-global) options.
30716 These per-server options are supported:
30717 .code
30718 retry=<timespec>        Retry on connect fail
30719 .endd
30720
30721 The &`retry`& option specifies a time after which a single retry for
30722 a failed connect is made.  The default is to not retry.
30723
30724 If a Unix socket file is specified, only one server is supported.
30725
30726 Examples:
30727 .code
30728 av_scanner = clamd:/opt/clamd/socket
30729 av_scanner = clamd:192.0.2.3 1234
30730 av_scanner = clamd:192.0.2.3 1234:local
30731 av_scanner = clamd:192.0.2.3 1234 retry=10s
30732 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30733 .endd
30734 If the value of av_scanner points to a UNIX socket file or contains the
30735 &`local`&
30736 option, then the ClamAV interface will pass a filename containing the data
30737 to be scanned, which will should normally result in less I/O happening and be
30738 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30739 Exim does not assume that there is a common filesystem with the remote host.
30740 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30741 you be running a version of ClamAV prior to 0.95.
30742
30743 The final example shows that multiple TCP targets can be specified.  Exim will
30744 randomly use one for each incoming email (i.e. it load balances them).  Note
30745 that only TCP targets may be used if specifying a list of scanners; a UNIX
30746 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30747 unavailable, Exim will try the remaining one(s) until it finds one that works.
30748 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30749 not keep track of scanner state between multiple messages, and the scanner
30750 selection is random, so the message will get logged in the mainlog for each
30751 email that the down scanner gets chosen first (message wrapped to be readable):
30752 .code
30753 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30754    clamd: connection to localhost, port 3310 failed
30755    (Connection refused)
30756 .endd
30757
30758 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30759 contributing the code for this scanner.
30760
30761 .vitem &%cmdline%&
30762 .cindex "virus scanners" "command line interface"
30763 This is the keyword for the generic command line scanner interface. It can be
30764 used to attach virus scanners that are invoked from the shell. This scanner
30765 type takes 3 mandatory options:
30766
30767 .olist
30768 The full path and name of the scanner binary, with all command line options,
30769 and a placeholder (&`%s`&) for the directory to scan.
30770
30771 .next
30772 A regular expression to match against the STDOUT and STDERR output of the
30773 virus scanner. If the expression matches, a virus was found. You must make
30774 absolutely sure that this expression matches on &"virus found"&. This is called
30775 the &"trigger"& expression.
30776
30777 .next
30778 Another regular expression, containing exactly one pair of parentheses, to
30779 match the name of the virus found in the scanners output. This is called the
30780 &"name"& expression.
30781 .endlist olist
30782
30783 For example, Sophos Sweep reports a virus on a line like this:
30784 .code
30785 Virus 'W32/Magistr-B' found in file ./those.bat
30786 .endd
30787 For the trigger expression, we can match the phrase &"found in file"&. For the
30788 name expression, we want to extract the W32/Magistr-B string, so we can match
30789 for the single quotes left and right of it. Altogether, this makes the
30790 configuration setting:
30791 .code
30792 av_scanner = cmdline:\
30793              /path/to/sweep -ss -all -rec -archive %s:\
30794              found in file:'(.+)'
30795 .endd
30796 .vitem &%drweb%&
30797 .cindex "virus scanners" "DrWeb"
30798 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30799 takes one option,
30800 either a full path to a UNIX socket,
30801 or host and port specifiers separated by white space.
30802 The host may be a name or an IP address; the port is either a
30803 single number or a pair of numbers with a dash between.
30804 For example:
30805 .code
30806 av_scanner = drweb:/var/run/drwebd.sock
30807 av_scanner = drweb:192.168.2.20 31337
30808 .endd
30809 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30810 is used. Thanks to Alex Miller for contributing the code for this scanner.
30811
30812 .vitem &%f-protd%&
30813 .cindex "virus scanners" "f-protd"
30814 The f-protd scanner is accessed via HTTP over TCP.
30815 One argument is taken, being a space-separated hostname and port number
30816 (or port-range).
30817 For example:
30818 .code
30819 av_scanner = f-protd:localhost 10200-10204
30820 .endd
30821 If you omit the argument, the default values show above are used.
30822
30823 .vitem &%fsecure%&
30824 .cindex "virus scanners" "F-Secure"
30825 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30826 argument which is the path to a UNIX socket. For example:
30827 .code
30828 av_scanner = fsecure:/path/to/.fsav
30829 .endd
30830 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30831 Thelmen for contributing the code for this scanner.
30832
30833 .vitem &%kavdaemon%&
30834 .cindex "virus scanners" "Kaspersky"
30835 This is the scanner daemon of Kaspersky Version 4. This version of the
30836 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30837 scanner type takes one option, which is the path to the daemon's UNIX socket.
30838 For example:
30839 .code
30840 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30841 .endd
30842 The default path is &_/var/run/AvpCtl_&.
30843
30844 .vitem &%mksd%&
30845 .cindex "virus scanners" "mksd"
30846 This is a daemon type scanner that is aimed mainly at Polish users, though some
30847 parts of documentation are now available in English. You can get it at
30848 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30849 the maximum number of processes used simultaneously to scan the attachments,
30850 provided that the demime facility is employed and also provided that mksd has
30851 been run with at least the same number of child processes. For example:
30852 .code
30853 av_scanner = mksd:2
30854 .endd
30855 You can safely omit this option (the default value is 1).
30856
30857 .vitem &%sock%&
30858 .cindex "virus scanners" "simple socket-connected"
30859 This is a general-purpose way of talking to simple scanner daemons
30860 running on the local machine.
30861 There are four options:
30862 an address (which may be an IP addres and port, or the path of a Unix socket),
30863 a commandline to send (may include a single %s which will be replaced with
30864 the path to the mail file to be scanned),
30865 an RE to trigger on from the returned data,
30866 an RE to extract malware_name from the returned data.
30867 For example:
30868 .code
30869 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30870 .endd
30871 Default for the socket specifier is &_/tmp/malware.sock_&.
30872 Default for the commandline is &_%s\n_&.
30873 Both regular-expressions are required.
30874
30875 .vitem &%sophie%&
30876 .cindex "virus scanners" "Sophos and Sophie"
30877 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30878 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30879 for this scanner type is the path to the UNIX socket that Sophie uses for
30880 client communication. For example:
30881 .code
30882 av_scanner = sophie:/tmp/sophie
30883 .endd
30884 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30885 the option.
30886 .endlist
30887
30888 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30889 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30890 ACL.
30891
30892 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30893 makes it possible to use different scanners. See further below for an example.
30894 The &%malware%& condition caches its results, so when you use it multiple times
30895 for the same message, the actual scanning process is only carried out once.
30896 However, using expandable items in &%av_scanner%& disables this caching, in
30897 which case each use of the &%malware%& condition causes a new scan of the
30898 message.
30899
30900 The &%malware%& condition takes a right-hand argument that is expanded before
30901 .new
30902 use and taken as a list, slash-separated by default.
30903 .wen
30904 The first element can then be one of
30905
30906 .ilist
30907 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30908 The condition succeeds if a virus was found, and fail otherwise. This is the
30909 recommended usage.
30910 .next
30911 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30912 the condition fails immediately.
30913 .next
30914 A regular expression, in which case the message is scanned for viruses. The
30915 condition succeeds if a virus is found and its name matches the regular
30916 expression. This allows you to take special actions on certain types of virus.
30917 .new
30918 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30919 unless the separator is changed (in the usual way).
30920 .wen
30921 .endlist
30922
30923 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30924 messages even if there is a problem with the virus scanner.
30925 Otherwise, such a problem causes the ACL to defer.
30926
30927 .new
30928 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30929 specify a non-default timeout.  The default is two minutes.
30930 For example:
30931 .code
30932 malware = * / defer_ok / tmo=10s
30933 .endd
30934 A timeout causes the ACL to defer.
30935 .wen
30936
30937 .vindex "&$malware_name$&"
30938 When a virus is found, the condition sets up an expansion variable called
30939 &$malware_name$& that contains the name of the virus. You can use it in a
30940 &%message%& modifier that specifies the error returned to the sender, and/or in
30941 logging data.
30942
30943 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
30944 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
30945 &%malware%& condition.
30946
30947 Beware the interaction of Exim's &%message_size_limit%& with any size limits
30948 imposed by your anti-virus scanner.
30949
30950 Here is a very simple scanning example:
30951 .code
30952 deny message = This message contains malware ($malware_name)
30953      demime = *
30954      malware = *
30955 .endd
30956 The next example accepts messages when there is a problem with the scanner:
30957 .code
30958 deny message = This message contains malware ($malware_name)
30959      demime = *
30960      malware = */defer_ok
30961 .endd
30962 The next example shows how to use an ACL variable to scan with both sophie and
30963 aveserver. It assumes you have set:
30964 .code
30965 av_scanner = $acl_m0
30966 .endd
30967 in the main Exim configuration.
30968 .code
30969 deny message = This message contains malware ($malware_name)
30970      set acl_m0 = sophie
30971      malware = *
30972
30973 deny message = This message contains malware ($malware_name)
30974      set acl_m0 = aveserver
30975      malware = *
30976 .endd
30977
30978
30979 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
30980 .cindex "content scanning" "for spam"
30981 .cindex "spam scanning"
30982 .cindex "SpamAssassin"
30983 .cindex "Rspamd"
30984 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
30985 score and a report for the message.
30986 .new
30987 Support is also provided for Rspamd.
30988
30989 For more information about installation and configuration of SpamAssassin or 
30990 Rspamd refer to their respective websites at
30991 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
30992 .wen
30993
30994 SpamAssassin can be installed with CPAN by running:
30995 .code
30996 perl -MCPAN -e 'install Mail::SpamAssassin'
30997 .endd
30998 SpamAssassin has its own set of configuration files. Please review its
30999 documentation to see how you can tweak it. The default installation should work
31000 nicely, however.
31001
31002 .oindex "&%spamd_address%&"
31003 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you 
31004 intend to use an instance running on the local host you do not need to set
31005 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31006 you must set the &%spamd_address%& option in the global part of the Exim
31007 configuration as follows (example):
31008 .code
31009 spamd_address = 192.168.99.45 387
31010 .endd
31011
31012 .new
31013 To use Rspamd (which by default listens on all local addresses
31014 on TCP port 11333)
31015 you should add &%variant=rspamd%& after the address/port pair, for example:
31016 .code
31017 spamd_address = 127.0.0.1 11333 variant=rspamd
31018 .endd
31019 .wen
31020
31021 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31022 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31023 file name instead of an address/port pair:
31024 .code
31025 spamd_address = /var/run/spamd_socket
31026 .endd
31027 You can have multiple &%spamd%& servers to improve scalability. These can
31028 reside on other hardware reachable over the network. To specify multiple
31029 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31030 option, separated with colons (the separator can be changed in the usual way):
31031 .code
31032 spamd_address = 192.168.2.10 783 : \
31033                 192.168.2.11 783 : \
31034                 192.168.2.12 783
31035 .endd
31036 Up to 32 &%spamd%& servers are supported.
31037 When a server fails to respond to the connection attempt, all other
31038 servers are tried until one succeeds. If no server responds, the &%spam%&
31039 condition defers.
31040
31041 .new
31042 Unix and TCP socket specifications may be mixed in any order.
31043 Each element of the list is a list itself, space-separated by default
31044 and changeable in the usual way.
31045
31046 For TCP socket specifications a host name or IP (v4 or v6, but
31047 subject to list-separator quoting rules) address can be used,
31048 and the port can be one or a dash-separated pair.
31049 In the latter case, the range is tried in strict order.
31050
31051 Elements after the first for Unix sockets, or second for TCP socket,
31052 are options.
31053 The supported option are:
31054 .code
31055 pri=<priority>      Selection priority
31056 weight=<value>      Selection bias
31057 time=<start>-<end>  Use only between these times of day
31058 retry=<timespec>    Retry on connect fail
31059 tmo=<timespec>      Connection time limit
31060 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31061 .endd
31062
31063 The &`pri`& option specifies a priority for the server within the list,
31064 higher values being tried first.
31065 The deafult priority is 1.
31066
31067 The &`weight`& option specifies a selection bias.
31068 Within a priority set
31069 servers are queried in a random fashion, weighted by this value.
31070 The default value for selection bias is 1.
31071
31072 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31073 in the local time zone; each element being one or more digits.
31074 Either the seconds or both minutes and seconds, plus the leading &`.`&
31075 characters, may be omitted and will be taken as zero.
31076
31077 Timeout specifications for the &`retry`& and &`tmo`& options
31078 are the usual Exim time interval standard, eg. &`20s`& or &`1m`&.
31079
31080 The &`tmo`& option specifies an overall timeout for communication.
31081 The default value is two minutes.
31082
31083 The &`retry`& option specifies a time after which a single retry for
31084 a failed connect is made.
31085 The default is to not retry.
31086 .wen
31087
31088 The &%spamd_address%& variable is expanded before use if it starts with
31089 a dollar sign. In this case, the expansion may return a string that is
31090 used as the list so that multiple spamd servers can be the result of an
31091 expansion.
31092
31093 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31094 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31095 .code
31096 deny message = This message was classified as SPAM
31097      spam = joe
31098 .endd
31099 The right-hand side of the &%spam%& condition specifies a name. This is
31100 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31101 to scan using a specific profile, but rather use the SpamAssassin system-wide
31102 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31103 .new
31104 Rspamd does not use this setting. However, you must put something on the
31105 right-hand side.
31106 .wen
31107
31108 The name allows you to use per-domain or per-user antispam profiles in
31109 principle, but this is not straightforward in practice, because a message may
31110 have multiple recipients, not necessarily all in the same domain. Because the
31111 &%spam%& condition has to be called from a DATA ACL in order to be able to
31112 read the contents of the message, the variables &$local_part$& and &$domain$&
31113 are not set.
31114 Careful enforcement of single-recipient messages
31115 (eg. by responding with defer in the recipient ACL for all recipients
31116 after the first),
31117 or the use of PRDR,
31118 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31119 are needed to use this feature.
31120
31121 The right-hand side of the &%spam%& condition is expanded before being used, so
31122 you can put lookups or conditions there. When the right-hand side evaluates to
31123 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31124
31125
31126 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31127 large ones may cause significant performance degradation. As most spam messages
31128 are quite small, it is recommended that you do not scan the big ones. For
31129 example:
31130 .code
31131 deny message = This message was classified as SPAM
31132      condition = ${if < {$message_size}{10K}}
31133      spam = nobody
31134 .endd
31135
31136 The &%spam%& condition returns true if the threshold specified in the user's
31137 SpamAssassin profile has been matched or exceeded. If you want to use the
31138 &%spam%& condition for its side effects (see the variables below), you can make
31139 it always return &"true"& by appending &`:true`& to the username.
31140
31141 .cindex "spam scanning" "returned variables"
31142 When the &%spam%& condition is run, it sets up a number of expansion
31143 variables. These variables are saved with the received message, thus they are
31144 available for use at delivery time.
31145
31146 .vlist
31147 .vitem &$spam_score$&
31148 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31149 for inclusion in log or reject messages.
31150
31151 .vitem &$spam_score_int$&
31152 The spam score of the message, multiplied by ten, as an integer value. For
31153 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31154 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31155 The integer value is useful for numeric comparisons in conditions.
31156
31157 .vitem &$spam_bar$&
31158 A string consisting of a number of &"+"& or &"-"& characters, representing the
31159 integer part of the spam score value. A spam score of 4.4 would have a
31160 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31161 headers, since MUAs can match on such strings.
31162
31163 .vitem &$spam_report$&
31164 A multiline text table, containing the full SpamAssassin report for the
31165 message. Useful for inclusion in headers or reject messages.
31166
31167 .new
31168 .vitem &$spam_action$&
31169 For SpamAssassin either 'reject' or 'no action' depending on the
31170 spam score versus threshold.
31171 For Rspamd, the recommended action.
31172 .wen
31173
31174 .endlist
31175
31176 The &%spam%& condition caches its results unless expansion in
31177 spamd_address was used. If you call it again with the same user name, it
31178 does not scan again, but rather returns the same values as before.
31179
31180 The &%spam%& condition returns DEFER if there is any error while running
31181 the message through SpamAssassin or if the expansion of spamd_address
31182 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31183 statement block), append &`/defer_ok`& to the right-hand side of the
31184 spam condition, like this:
31185 .code
31186 deny message = This message was classified as SPAM
31187      spam    = joe/defer_ok
31188 .endd
31189 This causes messages to be accepted even if there is a problem with &%spamd%&.
31190
31191 Here is a longer, commented example of the use of the &%spam%&
31192 condition:
31193 .code
31194 # put headers in all messages (no matter if spam or not)
31195 warn  spam = nobody:true
31196       add_header = X-Spam-Score: $spam_score ($spam_bar)
31197       add_header = X-Spam-Report: $spam_report
31198
31199 # add second subject line with *SPAM* marker when message
31200 # is over threshold
31201 warn  spam = nobody
31202       add_header = Subject: *SPAM* $h_Subject:
31203
31204 # reject spam at high scores (> 12)
31205 deny  message = This message scored $spam_score spam points.
31206       spam = nobody:true
31207       condition = ${if >{$spam_score_int}{120}{1}{0}}
31208 .endd
31209
31210
31211
31212 .section "Scanning MIME parts" "SECTscanmimepart"
31213 .cindex "content scanning" "MIME parts"
31214 .cindex "MIME content scanning"
31215 .oindex "&%acl_smtp_mime%&"
31216 .oindex "&%acl_not_smtp_mime%&"
31217 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31218 each MIME part of an SMTP message, including multipart types, in the sequence
31219 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31220 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31221 options may both refer to the same ACL if you want the same processing in both
31222 cases.
31223
31224 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31225 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31226 the case of a non-SMTP message. However, a MIME ACL is called only if the
31227 message contains a &'Content-Type:'& header line. When a call to a MIME
31228 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31229 result code is sent to the client. In the case of an SMTP message, the
31230 &%acl_smtp_data%& ACL is not called when this happens.
31231
31232 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31233 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31234 condition to match against the raw MIME part. You can also use the
31235 &%mime_regex%& condition to match against the decoded MIME part (see section
31236 &<<SECTscanregex>>&).
31237
31238 At the start of a MIME ACL, a number of variables are set from the header
31239 information for the relevant MIME part. These are described below. The contents
31240 of the MIME part are not by default decoded into a disk file except for MIME
31241 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31242 part into a disk file, you can use the &%decode%& condition. The general
31243 syntax is:
31244 .display
31245 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31246 .endd
31247 The right hand side is expanded before use. After expansion,
31248 the value can be:
31249
31250 .olist
31251 &"0"& or &"false"&, in which case no decoding is done.
31252 .next
31253 The string &"default"&. In that case, the file is put in the temporary
31254 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31255 a sequential file name consisting of the message id and a sequence number. The
31256 full path and name is available in &$mime_decoded_filename$& after decoding.
31257 .next
31258 A full path name starting with a slash. If the full name is an existing
31259 directory, it is used as a replacement for the default directory. The filename
31260 is then sequentially assigned. If the path does not exist, it is used as
31261 the full path and file name.
31262 .next
31263 If the string does not start with a slash, it is used as the
31264 filename, and the default path is then used.
31265 .endlist
31266 The &%decode%& condition normally succeeds. It is only false for syntax
31267 errors or unusual circumstances such as memory shortages. You can easily decode
31268 a file with its original, proposed filename using
31269 .code
31270 decode = $mime_filename
31271 .endd
31272 However, you should keep in mind that &$mime_filename$& might contain
31273 anything. If you place files outside of the default path, they are not
31274 automatically unlinked.
31275
31276 For RFC822 attachments (these are messages attached to messages, with a
31277 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31278 as for the primary message, only that the &$mime_is_rfc822$& expansion
31279 variable is set (see below). Attached messages are always decoded to disk
31280 before being checked, and the files are unlinked once the check is done.
31281
31282 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31283 used to match regular expressions against raw and decoded MIME parts,
31284 respectively. They are described in section &<<SECTscanregex>>&.
31285
31286 .cindex "MIME content scanning" "returned variables"
31287 The following list describes all expansion variables that are
31288 available in the MIME ACL:
31289
31290 .vlist
31291 .vitem &$mime_boundary$&
31292 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31293 have a boundary string, which is stored in this variable. If the current part
31294 has no boundary parameter in the &'Content-Type:'& header, this variable
31295 contains the empty string.
31296
31297 .vitem &$mime_charset$&
31298 This variable contains the character set identifier, if one was found in the
31299 &'Content-Type:'& header. Examples for charset identifiers are:
31300 .code
31301 us-ascii
31302 gb2312 (Chinese)
31303 iso-8859-1
31304 .endd
31305 Please note that this value is not normalized, so you should do matches
31306 case-insensitively.
31307
31308 .vitem &$mime_content_description$&
31309 This variable contains the normalized content of the &'Content-Description:'&
31310 header. It can contain a human-readable description of the parts content. Some
31311 implementations repeat the filename for attachments here, but they are usually
31312 only used for display purposes.
31313
31314 .vitem &$mime_content_disposition$&
31315 This variable contains the normalized content of the &'Content-Disposition:'&
31316 header. You can expect strings like &"attachment"& or &"inline"& here.
31317
31318 .vitem &$mime_content_id$&
31319 This variable contains the normalized content of the &'Content-ID:'& header.
31320 This is a unique ID that can be used to reference a part from another part.
31321
31322 .vitem &$mime_content_size$&
31323 This variable is set only after the &%decode%& modifier (see above) has been
31324 successfully run. It contains the size of the decoded part in kilobytes. The
31325 size is always rounded up to full kilobytes, so only a completely empty part
31326 has a &$mime_content_size$& of zero.
31327
31328 .vitem &$mime_content_transfer_encoding$&
31329 This variable contains the normalized content of the
31330 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31331 type. Typical values are &"base64"& and &"quoted-printable"&.
31332
31333 .vitem &$mime_content_type$&
31334 If the MIME part has a &'Content-Type:'& header, this variable contains its
31335 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31336 are some examples of popular MIME types, as they may appear in this variable:
31337 .code
31338 text/plain
31339 text/html
31340 application/octet-stream
31341 image/jpeg
31342 audio/midi
31343 .endd
31344 If the MIME part has no &'Content-Type:'& header, this variable contains the
31345 empty string.
31346
31347 .vitem &$mime_decoded_filename$&
31348 This variable is set only after the &%decode%& modifier (see above) has been
31349 successfully run. It contains the full path and file name of the file
31350 containing the decoded data.
31351 .endlist
31352
31353 .cindex "RFC 2047"
31354 .vlist
31355 .vitem &$mime_filename$&
31356 This is perhaps the most important of the MIME variables. It contains a
31357 proposed filename for an attachment, if one was found in either the
31358 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31359 RFC2047 or RFC2231 decoded, but no additional sanity checks are done.
31360  If no filename was
31361 found, this variable contains the empty string.
31362
31363 .vitem &$mime_is_coverletter$&
31364 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31365 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31366 content in the cover letter, while not restricting attachments at all.
31367
31368 The variable contains 1 (true) for a MIME part believed to be part of the
31369 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31370 follows:
31371
31372 .olist
31373 The outermost MIME part of a message is always a cover letter.
31374
31375 .next
31376 If a multipart/alternative or multipart/related MIME part is a cover letter,
31377 so are all MIME subparts within that multipart.
31378
31379 .next
31380 If any other multipart is a cover letter, the first subpart is a cover letter,
31381 and the rest are attachments.
31382
31383 .next
31384 All parts contained within an attachment multipart are attachments.
31385 .endlist olist
31386
31387 As an example, the following will ban &"HTML mail"& (including that sent with
31388 alternative plain text), while allowing HTML files to be attached. HTML
31389 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31390 .code
31391 deny message = HTML mail is not accepted here
31392 !condition = $mime_is_rfc822
31393 condition = $mime_is_coverletter
31394 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31395 .endd
31396 .vitem &$mime_is_multipart$&
31397 This variable has the value 1 (true) when the current part has the main type
31398 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31399 Since multipart entities only serve as containers for other parts, you may not
31400 want to carry out specific actions on them.
31401
31402 .vitem &$mime_is_rfc822$&
31403 This variable has the value 1 (true) if the current part is not a part of the
31404 checked message itself, but part of an attached message. Attached message
31405 decoding is fully recursive.
31406
31407 .vitem &$mime_part_count$&
31408 This variable is a counter that is raised for each processed MIME part. It
31409 starts at zero for the very first part (which is usually a multipart). The
31410 counter is per-message, so it is reset when processing RFC822 attachments (see
31411 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31412 complete, so you can use it in the DATA ACL to determine the number of MIME
31413 parts of a message. For non-MIME messages, this variable contains the value -1.
31414 .endlist
31415
31416
31417
31418 .section "Scanning with regular expressions" "SECTscanregex"
31419 .cindex "content scanning" "with regular expressions"
31420 .cindex "regular expressions" "content scanning with"
31421 You can specify your own custom regular expression matches on the full body of
31422 the message, or on individual MIME parts.
31423
31424 The &%regex%& condition takes one or more regular expressions as arguments and
31425 matches them against the full message (when called in the DATA ACL) or a raw
31426 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31427 linewise, with a maximum line length of 32K characters. That means you cannot
31428 have multiline matches with the &%regex%& condition.
31429
31430 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31431 to 32K of decoded content (the whole content at once, not linewise). If the
31432 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31433 is decoded automatically when &%mime_regex%& is executed (using default path
31434 and filename values). If the decoded data is larger than  32K, only the first
31435 32K characters are checked.
31436
31437 The regular expressions are passed as a colon-separated list. To include a
31438 literal colon, you must double it. Since the whole right-hand side string is
31439 expanded before being used, you must also escape dollar signs and backslashes
31440 with more backslashes, or use the &`\N`& facility to disable expansion.
31441 Here is a simple example that contains two regular expressions:
31442 .code
31443 deny message = contains blacklisted regex ($regex_match_string)
31444      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31445 .endd
31446 The conditions returns true if any one of the regular expressions matches. The
31447 &$regex_match_string$& expansion variable is then set up and contains the
31448 matching regular expression.
31449
31450 &*Warning*&: With large messages, these conditions can be fairly
31451 CPU-intensive.
31452
31453
31454
31455
31456 .section "The demime condition" "SECTdemimecond"
31457 .cindex "content scanning" "MIME checking"
31458 .cindex "MIME content scanning"
31459 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31460 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31461 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31462 ACL functionality, but provides no additional facilities. Please note that this
31463 condition is deprecated and kept only for backward compatibility. You must set
31464 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31465 use the &%demime%& condition.
31466
31467 The &%demime%& condition unpacks MIME containers in the message. It detects
31468 errors in MIME containers and can match file extensions found in the message
31469 against a list. Using this facility produces files containing the unpacked MIME
31470 parts of the message in the temporary scan directory. If you do antivirus
31471 scanning, it is recommended that you use the &%demime%& condition before the
31472 antivirus (&%malware%&) condition.
31473
31474 On the right-hand side of the &%demime%& condition you can pass a
31475 colon-separated list of file extensions that it should match against. For
31476 example:
31477 .code
31478 deny message = Found blacklisted file attachment
31479      demime  = vbs:com:bat:pif:prf:lnk
31480 .endd
31481 If one of the file extensions is found, the condition is true, otherwise it is
31482 false. If there is a temporary error while demimeing (for example, &"disk
31483 full"&), the condition defers, and the message is temporarily rejected (unless
31484 the condition is on a &%warn%& verb).
31485
31486 The right-hand side is expanded before being treated as a list, so you can have
31487 conditions and lookups there. If it expands to an empty string, &"false"&, or
31488 zero (&"0"&), no demimeing is done and the condition is false.
31489
31490 The &%demime%& condition set the following variables:
31491
31492 .vlist
31493 .vitem &$demime_errorlevel$&
31494 .vindex "&$demime_errorlevel$&"
31495 When an error is detected in a MIME container, this variable contains the
31496 severity of the error, as an integer number. The higher the value, the more
31497 severe the error (the current maximum value is 3). If this variable is unset or
31498 zero, no error occurred.
31499
31500 .vitem &$demime_reason$&
31501 .vindex "&$demime_reason$&"
31502 When &$demime_errorlevel$& is greater than zero, this variable contains a
31503 human-readable text string describing the MIME error that occurred.
31504 .endlist
31505
31506 .vlist
31507 .vitem &$found_extension$&
31508 .vindex "&$found_extension$&"
31509 When the &%demime%& condition is true, this variable contains the file
31510 extension it found.
31511 .endlist
31512
31513 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31514 the &%demime%& condition, and are not changed on subsequent calls.
31515
31516 If you do not want to check for file extensions, but rather use the &%demime%&
31517 condition for unpacking or error checking purposes, pass &"*"& as the
31518 right-hand side value. Here is a more elaborate example of how to use this
31519 facility:
31520 .code
31521 # Reject messages with serious MIME container errors
31522 deny  message = Found MIME error ($demime_reason).
31523       demime = *
31524       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31525
31526 # Reject known virus spreading file extensions.
31527 # Accepting these is pretty much braindead.
31528 deny  message = contains $found_extension file (blacklisted).
31529       demime  = com:vbs:bat:pif:scr
31530
31531 # Freeze .exe and .doc files. Postmaster can
31532 # examine them and eventually thaw them.
31533 deny  log_message = Another $found_extension file.
31534       demime = exe:doc
31535       control = freeze
31536 .endd
31537 .ecindex IIDcosca
31538
31539
31540
31541
31542 . ////////////////////////////////////////////////////////////////////////////
31543 . ////////////////////////////////////////////////////////////////////////////
31544
31545 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31546          "Local scan function"
31547 .scindex IIDlosca "&[local_scan()]& function" "description of"
31548 .cindex "customizing" "input scan using C function"
31549 .cindex "policy control" "by local scan function"
31550 In these days of email worms, viruses, and ever-increasing spam, some sites
31551 want to apply a lot of checking to messages before accepting them.
31552
31553 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31554 passing messages to external virus and spam scanning software. You can also do
31555 a certain amount in Exim itself through string expansions and the &%condition%&
31556 condition in the ACL that runs after the SMTP DATA command or the ACL for
31557 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31558
31559 To allow for further customization to a site's own requirements, there is the
31560 possibility of linking Exim with a private message scanning function, written
31561 in C. If you want to run code that is written in something other than C, you
31562 can of course use a little C stub to call it.
31563
31564 The local scan function is run once for every incoming message, at the point
31565 when Exim is just about to accept the message.
31566 It can therefore be used to control non-SMTP messages from local processes as
31567 well as messages arriving via SMTP.
31568
31569 Exim applies a timeout to calls of the local scan function, and there is an
31570 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31571 Zero means &"no timeout"&.
31572 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31573 before calling the local scan function, so that the most common types of crash
31574 are caught. If the timeout is exceeded or one of those signals is caught, the
31575 incoming message is rejected with a temporary error if it is an SMTP message.
31576 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31577 code. The incident is logged on the main and reject logs.
31578
31579
31580
31581 .section "Building Exim to use a local scan function" "SECID207"
31582 .cindex "&[local_scan()]& function" "building Exim to use"
31583 To make use of the local scan function feature, you must tell Exim where your
31584 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31585 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31586 directory, so you might set
31587 .code
31588 LOCAL_SCAN_SOURCE=Local/local_scan.c
31589 .endd
31590 for example. The function must be called &[local_scan()]&. It is called by
31591 Exim after it has received a message, when the success return code is about to
31592 be sent. This is after all the ACLs have been run. The return code from your
31593 function controls whether the message is actually accepted or not. There is a
31594 commented template function (that just accepts the message) in the file
31595 _src/local_scan.c_.
31596
31597 If you want to make use of Exim's run time configuration file to set options
31598 for your &[local_scan()]& function, you must also set
31599 .code
31600 LOCAL_SCAN_HAS_OPTIONS=yes
31601 .endd
31602 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31603
31604
31605
31606
31607 .section "API for local_scan()" "SECTapiforloc"
31608 .cindex "&[local_scan()]& function" "API description"
31609 You must include this line near the start of your code:
31610 .code
31611 #include "local_scan.h"
31612 .endd
31613 This header file defines a number of variables and other values, and the
31614 prototype for the function itself. Exim is coded to use unsigned char values
31615 almost exclusively, and one of the things this header defines is a shorthand
31616 for &`unsigned char`& called &`uschar`&.
31617 It also contains the following macro definitions, to simplify casting character
31618 strings and pointers to character strings:
31619 .code
31620 #define CS   (char *)
31621 #define CCS  (const char *)
31622 #define CSS  (char **)
31623 #define US   (unsigned char *)
31624 #define CUS  (const unsigned char *)
31625 #define USS  (unsigned char **)
31626 .endd
31627 The function prototype for &[local_scan()]& is:
31628 .code
31629 extern int local_scan(int fd, uschar **return_text);
31630 .endd
31631 The arguments are as follows:
31632
31633 .ilist
31634 &%fd%& is a file descriptor for the file that contains the body of the message
31635 (the -D file). The file is open for reading and writing, but updating it is not
31636 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31637
31638 The descriptor is positioned at character 19 of the file, which is the first
31639 character of the body itself, because the first 19 characters are the message
31640 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31641 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31642 case this changes in some future version.
31643 .next
31644 &%return_text%& is an address which you can use to return a pointer to a text
31645 string at the end of the function. The value it points to on entry is NULL.
31646 .endlist
31647
31648 The function must return an &%int%& value which is one of the following macros:
31649
31650 .vlist
31651 .vitem &`LOCAL_SCAN_ACCEPT`&
31652 .vindex "&$local_scan_data$&"
31653 The message is accepted. If you pass back a string of text, it is saved with
31654 the message, and made available in the variable &$local_scan_data$&. No
31655 newlines are permitted (if there are any, they are turned into spaces) and the
31656 maximum length of text is 1000 characters.
31657
31658 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31659 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31660 queued without immediate delivery, and is frozen.
31661
31662 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31663 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31664 queued without immediate delivery.
31665
31666 .vitem &`LOCAL_SCAN_REJECT`&
31667 The message is rejected; the returned text is used as an error message which is
31668 passed back to the sender and which is also logged. Newlines are permitted &--
31669 they cause a multiline response for SMTP rejections, but are converted to
31670 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31671 used.
31672
31673 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31674 The message is temporarily rejected; the returned text is used as an error
31675 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31676 problem"& is used.
31677
31678 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31679 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31680 message is not written to the reject log. It has the effect of unsetting the
31681 &%rejected_header%& log selector for just this rejection. If
31682 &%rejected_header%& is already unset (see the discussion of the
31683 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31684 same as LOCAL_SCAN_REJECT.
31685
31686 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31687 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31688 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31689 .endlist
31690
31691 If the message is not being received by interactive SMTP, rejections are
31692 reported by writing to &%stderr%& or by sending an email, as configured by the
31693 &%-oe%& command line options.
31694
31695
31696
31697 .section "Configuration options for local_scan()" "SECTconoptloc"
31698 .cindex "&[local_scan()]& function" "configuration options"
31699 It is possible to have option settings in the main configuration file
31700 that set values in static variables in the &[local_scan()]& module. If you
31701 want to do this, you must have the line
31702 .code
31703 LOCAL_SCAN_HAS_OPTIONS=yes
31704 .endd
31705 in your &_Local/Makefile_& when you build Exim. (This line is in
31706 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31707 file, you must define static variables to hold the option values, and a table
31708 to define them.
31709
31710 The table must be a vector called &%local_scan_options%&, of type
31711 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31712 and a pointer to the variable that holds the value. The entries must appear in
31713 alphabetical order. Following &%local_scan_options%& you must also define a
31714 variable called &%local_scan_options_count%& that contains the number of
31715 entries in the table. Here is a short example, showing two kinds of option:
31716 .code
31717 static int my_integer_option = 42;
31718 static uschar *my_string_option = US"a default string";
31719
31720 optionlist local_scan_options[] = {
31721   { "my_integer", opt_int,       &my_integer_option },
31722   { "my_string",  opt_stringptr, &my_string_option }
31723 };
31724
31725 int local_scan_options_count =
31726   sizeof(local_scan_options)/sizeof(optionlist);
31727 .endd
31728 The values of the variables can now be changed from Exim's runtime
31729 configuration file by including a local scan section as in this example:
31730 .code
31731 begin local_scan
31732 my_integer = 99
31733 my_string = some string of text...
31734 .endd
31735 The available types of option data are as follows:
31736
31737 .vlist
31738 .vitem &*opt_bool*&
31739 This specifies a boolean (true/false) option. The address should point to a
31740 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31741 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31742 whether such a variable has been set at all, you can initialize it to
31743 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31744 values.)
31745
31746 .vitem &*opt_fixed*&
31747 This specifies a fixed point number, such as is used for load averages.
31748 The address should point to a variable of type &`int`&. The value is stored
31749 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31750
31751 .vitem &*opt_int*&
31752 This specifies an integer; the address should point to a variable of type
31753 &`int`&. The value may be specified in any of the integer formats accepted by
31754 Exim.
31755
31756 .vitem &*opt_mkint*&
31757 This is the same as &%opt_int%&, except that when such a value is output in a
31758 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31759 printed with the suffix K or M.
31760
31761 .vitem &*opt_octint*&
31762 This also specifies an integer, but the value is always interpreted as an
31763 octal integer, whether or not it starts with the digit zero, and it is
31764 always output in octal.
31765
31766 .vitem &*opt_stringptr*&
31767 This specifies a string value; the address must be a pointer to a
31768 variable that points to a string (for example, of type &`uschar *`&).
31769
31770 .vitem &*opt_time*&
31771 This specifies a time interval value. The address must point to a variable of
31772 type &`int`&. The value that is placed there is a number of seconds.
31773 .endlist
31774
31775 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31776 out the values of all the &[local_scan()]& options.
31777
31778
31779
31780 .section "Available Exim variables" "SECID208"
31781 .cindex "&[local_scan()]& function" "available Exim variables"
31782 The header &_local_scan.h_& gives you access to a number of C variables. These
31783 are the only ones that are guaranteed to be maintained from release to release.
31784 Note, however, that you can obtain the value of any Exim expansion variable,
31785 including &$recipients$&, by calling &'expand_string()'&. The exported
31786 C variables are as follows:
31787
31788 .vlist
31789 .vitem &*int&~body_linecount*&
31790 This variable contains the number of lines in the message's body.
31791
31792 .vitem &*int&~body_zerocount*&
31793 This variable contains the number of binary zero bytes in the message's body.
31794
31795 .vitem &*unsigned&~int&~debug_selector*&
31796 This variable is set to zero when no debugging is taking place. Otherwise, it
31797 is a bitmap of debugging selectors. Two bits are identified for use in
31798 &[local_scan()]&; they are defined as macros:
31799
31800 .ilist
31801 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31802 testing option that is not privileged &-- any caller may set it. All the
31803 other selector bits can be set only by admin users.
31804
31805 .next
31806 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31807 by the &`+local_scan`& debug selector. It is not included in the default set
31808 of debugging bits.
31809 .endlist ilist
31810
31811 Thus, to write to the debugging output only when &`+local_scan`& has been
31812 selected, you should use code like this:
31813 .code
31814 if ((debug_selector & D_local_scan) != 0)
31815   debug_printf("xxx", ...);
31816 .endd
31817 .vitem &*uschar&~*expand_string_message*&
31818 After a failing call to &'expand_string()'& (returned value NULL), the
31819 variable &%expand_string_message%& contains the error message, zero-terminated.
31820
31821 .vitem &*header_line&~*header_list*&
31822 A pointer to a chain of header lines. The &%header_line%& structure is
31823 discussed below.
31824
31825 .vitem &*header_line&~*header_last*&
31826 A pointer to the last of the header lines.
31827
31828 .vitem &*uschar&~*headers_charset*&
31829 The value of the &%headers_charset%& configuration option.
31830
31831 .vitem &*BOOL&~host_checking*&
31832 This variable is TRUE during a host checking session that is initiated by the
31833 &%-bh%& command line option.
31834
31835 .vitem &*uschar&~*interface_address*&
31836 The IP address of the interface that received the message, as a string. This
31837 is NULL for locally submitted messages.
31838
31839 .vitem &*int&~interface_port*&
31840 The port on which this message was received. When testing with the &%-bh%&
31841 command line option, the value of this variable is -1 unless a port has been
31842 specified via the &%-oMi%& option.
31843
31844 .vitem &*uschar&~*message_id*&
31845 This variable contains Exim's message id for the incoming message (the value of
31846 &$message_exim_id$&) as a zero-terminated string.
31847
31848 .vitem &*uschar&~*received_protocol*&
31849 The name of the protocol by which the message was received.
31850
31851 .vitem &*int&~recipients_count*&
31852 The number of accepted recipients.
31853
31854 .vitem &*recipient_item&~*recipients_list*&
31855 .cindex "recipient" "adding in local scan"
31856 .cindex "recipient" "removing in local scan"
31857 The list of accepted recipients, held in a vector of length
31858 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31859 can add additional recipients by calling &'receive_add_recipient()'& (see
31860 below). You can delete recipients by removing them from the vector and
31861 adjusting the value in &%recipients_count%&. In particular, by setting
31862 &%recipients_count%& to zero you remove all recipients. If you then return the
31863 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31864 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31865 and then call &'receive_add_recipient()'& as often as needed.
31866
31867 .vitem &*uschar&~*sender_address*&
31868 The envelope sender address. For bounce messages this is the empty string.
31869
31870 .vitem &*uschar&~*sender_host_address*&
31871 The IP address of the sending host, as a string. This is NULL for
31872 locally-submitted messages.
31873
31874 .vitem &*uschar&~*sender_host_authenticated*&
31875 The name of the authentication mechanism that was used, or NULL if the message
31876 was not received over an authenticated SMTP connection.
31877
31878 .vitem &*uschar&~*sender_host_name*&
31879 The name of the sending host, if known.
31880
31881 .vitem &*int&~sender_host_port*&
31882 The port on the sending host.
31883
31884 .vitem &*BOOL&~smtp_input*&
31885 This variable is TRUE for all SMTP input, including BSMTP.
31886
31887 .vitem &*BOOL&~smtp_batched_input*&
31888 This variable is TRUE for BSMTP input.
31889
31890 .vitem &*int&~store_pool*&
31891 The contents of this variable control which pool of memory is used for new
31892 requests. See section &<<SECTmemhanloc>>& for details.
31893 .endlist
31894
31895
31896 .section "Structure of header lines" "SECID209"
31897 The &%header_line%& structure contains the members listed below.
31898 You can add additional header lines by calling the &'header_add()'& function
31899 (see below). You can cause header lines to be ignored (deleted) by setting
31900 their type to *.
31901
31902
31903 .vlist
31904 .vitem &*struct&~header_line&~*next*&
31905 A pointer to the next header line, or NULL for the last line.
31906
31907 .vitem &*int&~type*&
31908 A code identifying certain headers that Exim recognizes. The codes are printing
31909 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31910 Notice in particular that any header line whose type is * is not transmitted
31911 with the message. This flagging is used for header lines that have been
31912 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31913 lines.) Effectively, * means &"deleted"&.
31914
31915 .vitem &*int&~slen*&
31916 The number of characters in the header line, including the terminating and any
31917 internal newlines.
31918
31919 .vitem &*uschar&~*text*&
31920 A pointer to the text of the header. It always ends with a newline, followed by
31921 a zero byte. Internal newlines are preserved.
31922 .endlist
31923
31924
31925
31926 .section "Structure of recipient items" "SECID210"
31927 The &%recipient_item%& structure contains these members:
31928
31929 .vlist
31930 .vitem &*uschar&~*address*&
31931 This is a pointer to the recipient address as it was received.
31932
31933 .vitem &*int&~pno*&
31934 This is used in later Exim processing when top level addresses are created by
31935 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31936 and must always contain -1 at this stage.
31937
31938 .vitem &*uschar&~*errors_to*&
31939 If this value is not NULL, bounce messages caused by failing to deliver to the
31940 recipient are sent to the address it contains. In other words, it overrides the
31941 envelope sender for this one recipient. (Compare the &%errors_to%& generic
31942 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
31943 an unqualified address, Exim qualifies it using the domain from
31944 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
31945 is NULL for all recipients.
31946 .endlist
31947
31948
31949
31950 .section "Available Exim functions" "SECID211"
31951 .cindex "&[local_scan()]& function" "available Exim functions"
31952 The header &_local_scan.h_& gives you access to a number of Exim functions.
31953 These are the only ones that are guaranteed to be maintained from release to
31954 release:
31955
31956 .vlist
31957 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
31958        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
31959
31960 This function creates a child process that runs the command specified by
31961 &%argv%&. The environment for the process is specified by &%envp%&, which can
31962 be NULL if no environment variables are to be passed. A new umask is supplied
31963 for the process in &%newumask%&.
31964
31965 Pipes to the standard input and output of the new process are set up
31966 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
31967 standard error is cloned to the standard output. If there are any file
31968 descriptors &"in the way"& in the new process, they are closed. If the final
31969 argument is TRUE, the new process is made into a process group leader.
31970
31971 The function returns the pid of the new process, or -1 if things go wrong.
31972
31973 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
31974 This function waits for a child process to terminate, or for a timeout (in
31975 seconds) to expire. A timeout value of zero means wait as long as it takes. The
31976 return value is as follows:
31977
31978 .ilist
31979 >= 0
31980
31981 The process terminated by a normal exit and the value is the process
31982 ending status.
31983
31984 .next
31985 < 0 and > &--256
31986
31987 The process was terminated by a signal and the value is the negation of the
31988 signal number.
31989
31990 .next
31991 &--256
31992
31993 The process timed out.
31994 .next
31995 &--257
31996
31997 The was some other error in wait(); &%errno%& is still set.
31998 .endlist
31999
32000 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32001 This function provide you with a means of submitting a new message to
32002 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32003 want, but this packages it all up for you.) The function creates a pipe,
32004 forks a subprocess that is running
32005 .code
32006 exim -t -oem -oi -f <>
32007 .endd
32008 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32009 that is connected to the standard input. The yield of the function is the PID
32010 of the subprocess. You can then write a message to the file descriptor, with
32011 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32012
32013 When you have finished, call &'child_close()'& to wait for the process to
32014 finish and to collect its ending status. A timeout value of zero is usually
32015 fine in this circumstance. Unless you have made a mistake with the recipient
32016 addresses, you should get a return code of zero.
32017
32018
32019 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32020        *sender_authentication)*&
32021 This function is a more sophisticated version of &'child_open()'&. The command
32022 that it runs is:
32023 .display
32024 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32025 .endd
32026 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32027
32028
32029 .vitem &*void&~debug_printf(char&~*,&~...)*&
32030 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32031 output is written to the standard error stream. If no debugging is selected,
32032 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32033 conditional on the &`local_scan`& debug selector by coding like this:
32034 .code
32035 if ((debug_selector & D_local_scan) != 0)
32036   debug_printf("xxx", ...);
32037 .endd
32038
32039 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32040 This is an interface to Exim's string expansion code. The return value is the
32041 expanded string, or NULL if there was an expansion failure.
32042 The C variable &%expand_string_message%& contains an error message after an
32043 expansion failure. If expansion does not change the string, the return value is
32044 the pointer to the input string. Otherwise, the return value points to a new
32045 block of memory that was obtained by a call to &'store_get()'&. See section
32046 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32047
32048 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32049 This function allows you to an add additional header line at the end of the
32050 existing ones. The first argument is the type, and should normally be a space
32051 character. The second argument is a format string and any number of
32052 substitution arguments as for &[sprintf()]&. You may include internal newlines
32053 if you want, and you must ensure that the string ends with a newline.
32054
32055 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32056         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32057 This function adds a new header line at a specified point in the header
32058 chain. The header itself is specified as for &'header_add()'&.
32059
32060 If &%name%& is NULL, the new header is added at the end of the chain if
32061 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32062 NULL, the header lines are searched for the first non-deleted header that
32063 matches the name. If one is found, the new header is added before it if
32064 &%after%& is false. If &%after%& is true, the new header is added after the
32065 found header and any adjacent subsequent ones with the same name (even if
32066 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32067 option controls where the header is added. If it is true, addition is at the
32068 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32069 headers, or at the top if there are no &'Received:'& headers, you could use
32070 .code
32071 header_add_at_position(TRUE, US"Received", TRUE,
32072   ' ', "X-xxx: ...");
32073 .endd
32074 Normally, there is always at least one non-deleted &'Received:'& header, but
32075 there may not be if &%received_header_text%& expands to an empty string.
32076
32077
32078 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32079 This function removes header lines. If &%occurrence%& is zero or negative, all
32080 occurrences of the header are removed. If occurrence is greater than zero, that
32081 particular instance of the header is removed. If no header(s) can be found that
32082 match the specification, the function does nothing.
32083
32084
32085 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32086         int&~length,&~BOOL&~notdel)*&"
32087 This function tests whether the given header has the given name. It is not just
32088 a string comparison, because white space is permitted between the name and the
32089 colon. If the &%notdel%& argument is true, a false return is forced for all
32090 &"deleted"& headers; otherwise they are not treated specially. For example:
32091 .code
32092 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32093 .endd
32094 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32095 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32096 This function base64-encodes a string, which is passed by address and length.
32097 The text may contain bytes of any value, including zero. The result is passed
32098 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32099 zero-terminated.
32100
32101 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32102 This function decodes a base64-encoded string. Its arguments are a
32103 zero-terminated base64-encoded string and the address of a variable that is set
32104 to point to the result, which is in dynamic memory. The length of the decoded
32105 string is the yield of the function. If the input is invalid base64 data, the
32106 yield is -1. A zero byte is added to the end of the output string to make it
32107 easy to interpret as a C string (assuming it contains no zeros of its own). The
32108 added zero byte is not included in the returned count.
32109
32110 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32111 This function checks for a match in a domain list. Domains are always
32112 matched caselessly. The return value is one of the following:
32113 .display
32114 &`OK     `& match succeeded
32115 &`FAIL   `& match failed
32116 &`DEFER  `& match deferred
32117 .endd
32118 DEFER is usually caused by some kind of lookup defer, such as the
32119 inability to contact a database.
32120
32121 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32122         BOOL&~caseless)*&"
32123 This function checks for a match in a local part list. The third argument
32124 controls case-sensitivity. The return values are as for
32125 &'lss_match_domain()'&.
32126
32127 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32128         BOOL&~caseless)*&"
32129 This function checks for a match in an address list. The third argument
32130 controls the case-sensitivity of the local part match. The domain is always
32131 matched caselessly. The return values are as for &'lss_match_domain()'&.
32132
32133 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32134         uschar&~*list)*&"
32135 This function checks for a match in a host list. The most common usage is
32136 expected to be
32137 .code
32138 lss_match_host(sender_host_name, sender_host_address, ...)
32139 .endd
32140 .vindex "&$sender_host_address$&"
32141 An empty address field matches an empty item in the host list. If the host name
32142 is NULL, the name corresponding to &$sender_host_address$& is automatically
32143 looked up if a host name is required to match an item in the list. The return
32144 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32145 returns ERROR in the case when it had to look up a host name, but the lookup
32146 failed.
32147
32148 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32149         *format,&~...)*&"
32150 This function writes to Exim's log files. The first argument should be zero (it
32151 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32152 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32153 them. It specifies to which log or logs the message is written. The remaining
32154 arguments are a format and relevant insertion arguments. The string should not
32155 contain any newlines, not even at the end.
32156
32157
32158 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32159 This function adds an additional recipient to the message. The first argument
32160 is the recipient address. If it is unqualified (has no domain), it is qualified
32161 with the &%qualify_recipient%& domain. The second argument must always be -1.
32162
32163 This function does not allow you to specify a private &%errors_to%& address (as
32164 described with the structure of &%recipient_item%& above), because it pre-dates
32165 the addition of that field to the structure. However, it is easy to add such a
32166 value afterwards. For example:
32167 .code
32168  receive_add_recipient(US"monitor@mydom.example", -1);
32169  recipients_list[recipients_count-1].errors_to =
32170    US"postmaster@mydom.example";
32171 .endd
32172
32173 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32174 This is a convenience function to remove a named recipient from the list of
32175 recipients. It returns true if a recipient was removed, and false if no
32176 matching recipient could be found. The argument must be a complete email
32177 address.
32178 .endlist
32179
32180
32181 .cindex "RFC 2047"
32182 .vlist
32183 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32184   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32185 This function decodes strings that are encoded according to RFC 2047. Typically
32186 these are the contents of header lines. First, each &"encoded word"& is decoded
32187 from the Q or B encoding into a byte-string. Then, if provided with the name of
32188 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32189 made  to translate the result to the named character set. If this fails, the
32190 binary string is returned with an error message.
32191
32192 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32193 maximum MIME word length is enforced. The third argument is the target
32194 encoding, or NULL if no translation is wanted.
32195
32196 .cindex "binary zero" "in RFC 2047 decoding"
32197 .cindex "RFC 2047" "binary zero in"
32198 If a binary zero is encountered in the decoded string, it is replaced by the
32199 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32200 not be 0 because header lines are handled as zero-terminated strings.
32201
32202 The function returns the result of processing the string, zero-terminated; if
32203 &%lenptr%& is not NULL, the length of the result is set in the variable to
32204 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32205
32206 If an error is encountered, the function returns NULL and uses the &%error%&
32207 argument to return an error message. The variable pointed to by &%error%& is
32208 set to NULL if there is no error; it may be set non-NULL even when the function
32209 returns a non-NULL value if decoding was successful, but there was a problem
32210 with translation.
32211
32212
32213 .vitem &*int&~smtp_fflush(void)*&
32214 This function is used in conjunction with &'smtp_printf()'&, as described
32215 below.
32216
32217 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32218 The arguments of this function are like &[printf()]&; it writes to the SMTP
32219 output stream. You should use this function only when there is an SMTP output
32220 stream, that is, when the incoming message is being received via interactive
32221 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32222 is FALSE. If you want to test for an incoming message from another host (as
32223 opposed to a local process that used the &%-bs%& command line option), you can
32224 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32225 is involved.
32226
32227 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32228 output function, so it can be used for all forms of SMTP connection.
32229
32230 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32231 must start with an appropriate response code: 550 if you are going to return
32232 LOCAL_SCAN_REJECT, 451 if you are going to return
32233 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32234 initial lines of a multi-line response, the code must be followed by a hyphen
32235 to indicate that the line is not the final response line. You must also ensure
32236 that the lines you write terminate with CRLF. For example:
32237 .code
32238 smtp_printf("550-this is some extra info\r\n");
32239 return LOCAL_SCAN_REJECT;
32240 .endd
32241 Note that you can also create multi-line responses by including newlines in
32242 the data returned via the &%return_text%& argument. The added value of using
32243 &'smtp_printf()'& is that, for instance, you could introduce delays between
32244 multiple output lines.
32245
32246 The &'smtp_printf()'& function does not return any error indication, because it
32247 does not automatically flush pending output, and therefore does not test
32248 the state of the stream. (In the main code of Exim, flushing and error
32249 detection is done when Exim is ready for the next SMTP input command.) If
32250 you want to flush the output and check for an error (for example, the
32251 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32252 arguments. It flushes the output stream, and returns a non-zero value if there
32253 is an error.
32254
32255 .vitem &*void&~*store_get(int)*&
32256 This function accesses Exim's internal store (memory) manager. It gets a new
32257 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32258 runs out of memory. See the next section for a discussion of memory handling.
32259
32260 .vitem &*void&~*store_get_perm(int)*&
32261 This function is like &'store_get()'&, but it always gets memory from the
32262 permanent pool. See the next section for a discussion of memory handling.
32263
32264 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32265 See below.
32266
32267 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32268 See below.
32269
32270 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32271 These three functions create strings using Exim's dynamic memory facilities.
32272 The first makes a copy of an entire string. The second copies up to a maximum
32273 number of characters, indicated by the second argument. The third uses a format
32274 and insertion arguments to create a new string. In each case, the result is a
32275 pointer to a new string in the current memory pool. See the next section for
32276 more discussion.
32277 .endlist
32278
32279
32280
32281 .section "More about Exim's memory handling" "SECTmemhanloc"
32282 .cindex "&[local_scan()]& function" "memory handling"
32283 No function is provided for freeing memory, because that is never needed.
32284 The dynamic memory that Exim uses when receiving a message is automatically
32285 recycled if another message is received by the same process (this applies only
32286 to incoming SMTP connections &-- other input methods can supply only one
32287 message at a time). After receiving the last message, a reception process
32288 terminates.
32289
32290 Because it is recycled, the normal dynamic memory cannot be used for holding
32291 data that must be preserved over a number of incoming messages on the same SMTP
32292 connection. However, Exim in fact uses two pools of dynamic memory; the second
32293 one is not recycled, and can be used for this purpose.
32294
32295 If you want to allocate memory that remains available for subsequent messages
32296 in the same SMTP connection, you should set
32297 .code
32298 store_pool = POOL_PERM
32299 .endd
32300 before calling the function that does the allocation. There is no need to
32301 restore the value if you do not need to; however, if you do want to revert to
32302 the normal pool, you can either restore the previous value of &%store_pool%& or
32303 set it explicitly to POOL_MAIN.
32304
32305 The pool setting applies to all functions that get dynamic memory, including
32306 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32307 There is also a convenience function called &'store_get_perm()'& that gets a
32308 block of memory from the permanent pool while preserving the value of
32309 &%store_pool%&.
32310 .ecindex IIDlosca
32311
32312
32313
32314
32315 . ////////////////////////////////////////////////////////////////////////////
32316 . ////////////////////////////////////////////////////////////////////////////
32317
32318 .chapter "System-wide message filtering" "CHAPsystemfilter"
32319 .scindex IIDsysfil1 "filter" "system filter"
32320 .scindex IIDsysfil2 "filtering all mail"
32321 .scindex IIDsysfil3 "system filter"
32322 The previous chapters (on ACLs and the local scan function) describe checks
32323 that can be applied to messages before they are accepted by a host. There is
32324 also a mechanism for checking messages once they have been received, but before
32325 they are delivered. This is called the &'system filter'&.
32326
32327 The system filter operates in a similar manner to users' filter files, but it
32328 is run just once per message (however many recipients the message has).
32329 It should not normally be used as a substitute for routing, because &%deliver%&
32330 commands in a system router provide new envelope recipient addresses.
32331 The system filter must be an Exim filter. It cannot be a Sieve filter.
32332
32333 The system filter is run at the start of a delivery attempt, before any routing
32334 is done. If a message fails to be completely delivered at the first attempt,
32335 the system filter is run again at the start of every retry.
32336 If you want your filter to do something only once per message, you can make use
32337 of the &%first_delivery%& condition in an &%if%& command in the filter to
32338 prevent it happening on retries.
32339
32340 .vindex "&$domain$&"
32341 .vindex "&$local_part$&"
32342 &*Warning*&: Because the system filter runs just once, variables that are
32343 specific to individual recipient addresses, such as &$local_part$& and
32344 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32345 you want to run a centrally-specified filter for each recipient address
32346 independently, you can do so by setting up a suitable &(redirect)& router, as
32347 described in section &<<SECTperaddfil>>& below.
32348
32349
32350 .section "Specifying a system filter" "SECID212"
32351 .cindex "uid (user id)" "system filter"
32352 .cindex "gid (group id)" "system filter"
32353 The name of the file that contains the system filter must be specified by
32354 setting &%system_filter%&. If you want the filter to run under a uid and gid
32355 other than root, you must also set &%system_filter_user%& and
32356 &%system_filter_group%& as appropriate. For example:
32357 .code
32358 system_filter = /etc/mail/exim.filter
32359 system_filter_user = exim
32360 .endd
32361 If a system filter generates any deliveries directly to files or pipes (via the
32362 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32363 specified by setting &%system_filter_file_transport%& and
32364 &%system_filter_pipe_transport%&, respectively. Similarly,
32365 &%system_filter_reply_transport%& must be set to handle any messages generated
32366 by the &%reply%& command.
32367
32368
32369 .section "Testing a system filter" "SECID213"
32370 You can run simple tests of a system filter in the same way as for a user
32371 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32372 are permitted only in system filters are recognized.
32373
32374 If you want to test the combined effect of a system filter and a user filter,
32375 you can use both &%-bF%& and &%-bf%& on the same command line.
32376
32377
32378
32379 .section "Contents of a system filter" "SECID214"
32380 The language used to specify system filters is the same as for users' filter
32381 files. It is described in the separate end-user document &'Exim's interface to
32382 mail filtering'&. However, there are some additional features that are
32383 available only in system filters; these are described in subsequent sections.
32384 If they are encountered in a user's filter file or when testing with &%-bf%&,
32385 they cause errors.
32386
32387 .cindex "frozen messages" "manual thaw; testing in filter"
32388 There are two special conditions which, though available in users' filter
32389 files, are designed for use in system filters. The condition &%first_delivery%&
32390 is true only for the first attempt at delivering a message, and
32391 &%manually_thawed%& is true only if the message has been frozen, and
32392 subsequently thawed by an admin user. An explicit forced delivery counts as a
32393 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32394
32395 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32396 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32397 succeed, it will not be tried again.
32398 If you want Exim to retry an unseen delivery until it succeeds, you should
32399 arrange to set it up every time the filter runs.
32400
32401 When a system filter finishes running, the values of the variables &$n0$& &--
32402 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32403 users' filter files. Thus a system filter can, for example, set up &"scores"&
32404 to which users' filter files can refer.
32405
32406
32407
32408 .section "Additional variable for system filters" "SECID215"
32409 .vindex "&$recipients$&"
32410 The expansion variable &$recipients$&, containing a list of all the recipients
32411 of the message (separated by commas and white space), is available in system
32412 filters. It is not available in users' filters for privacy reasons.
32413
32414
32415
32416 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32417 .cindex "freezing messages"
32418 .cindex "message" "freezing"
32419 .cindex "message" "forced failure"
32420 .cindex "&%fail%&" "in system filter"
32421 .cindex "&%freeze%& in system filter"
32422 .cindex "&%defer%& in system filter"
32423 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32424 always available in system filters, but are not normally enabled in users'
32425 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32426 for the &(redirect)& router.) These commands can optionally be followed by the
32427 word &%text%& and a string containing an error message, for example:
32428 .code
32429 fail text "this message looks like spam to me"
32430 .endd
32431 The keyword &%text%& is optional if the next character is a double quote.
32432
32433 The &%defer%& command defers delivery of the original recipients of the
32434 message. The &%fail%& command causes all the original recipients to be failed,
32435 and a bounce message to be created. The &%freeze%& command suspends all
32436 delivery attempts for the original recipients. In all cases, any new deliveries
32437 that are specified by the filter are attempted as normal after the filter has
32438 run.
32439
32440 The &%freeze%& command is ignored if the message has been manually unfrozen and
32441 not manually frozen since. This means that automatic freezing by a system
32442 filter can be used as a way of checking out suspicious messages. If a message
32443 is found to be all right, manually unfreezing it allows it to be delivered.
32444
32445 .cindex "log" "&%fail%& command log line"
32446 .cindex "&%fail%&" "log line; reducing"
32447 The text given with a fail command is used as part of the bounce message as
32448 well as being written to the log. If the message is quite long, this can fill
32449 up a lot of log space when such failures are common. To reduce the size of the
32450 log message, Exim interprets the text in a special way if it starts with the
32451 two characters &`<<`& and contains &`>>`& later. The text between these two
32452 strings is written to the log, and the rest of the text is used in the bounce
32453 message. For example:
32454 .code
32455 fail "<<filter test 1>>Your message is rejected \
32456      because it contains attachments that we are \
32457      not prepared to receive."
32458 .endd
32459
32460 .cindex "loop" "caused by &%fail%&"
32461 Take great care with the &%fail%& command when basing the decision to fail on
32462 the contents of the message, because the bounce message will of course include
32463 the contents of the original message and will therefore trigger the &%fail%&
32464 command again (causing a mail loop) unless steps are taken to prevent this.
32465 Testing the &%error_message%& condition is one way to prevent this. You could
32466 use, for example
32467 .code
32468 if $message_body contains "this is spam" and not error_message
32469 then fail text "spam is not wanted here" endif
32470 .endd
32471 though of course that might let through unwanted bounce messages. The
32472 alternative is clever checking of the body and/or headers to detect bounces
32473 generated by the filter.
32474
32475 The interpretation of a system filter file ceases after a
32476 &%defer%&,
32477 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32478 set up earlier in the filter file are honoured, so you can use a sequence such
32479 as
32480 .code
32481 mail ...
32482 freeze
32483 .endd
32484 to send a specified message when the system filter is freezing (or deferring or
32485 failing) a message. The normal deliveries for the message do not, of course,
32486 take place.
32487
32488
32489
32490 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32491 .cindex "header lines" "adding; in system filter"
32492 .cindex "header lines" "removing; in system filter"
32493 .cindex "filter" "header lines; adding/removing"
32494 Two filter commands that are available only in system filters are:
32495 .code
32496 headers add <string>
32497 headers remove <string>
32498 .endd
32499 The argument for the &%headers add%& is a string that is expanded and then
32500 added to the end of the message's headers. It is the responsibility of the
32501 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32502 space is ignored, and if the string is otherwise empty, or if the expansion is
32503 forced to fail, the command has no effect.
32504
32505 You can use &"\n"& within the string, followed by white space, to specify
32506 continued header lines. More than one header may be added in one command by
32507 including &"\n"& within the string without any following white space. For
32508 example:
32509 .code
32510 headers add "X-header-1: ....\n  \
32511              continuation of X-header-1 ...\n\
32512              X-header-2: ...."
32513 .endd
32514 Note that the header line continuation white space after the first newline must
32515 be placed before the backslash that continues the input string, because white
32516 space after input continuations is ignored.
32517
32518 The argument for &%headers remove%& is a colon-separated list of header names.
32519 This command applies only to those headers that are stored with the message;
32520 those that are added at delivery time (such as &'Envelope-To:'& and
32521 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32522 header with the same name, they are all removed.
32523
32524 The &%headers%& command in a system filter makes an immediate change to the set
32525 of header lines that was received with the message (with possible additions
32526 from ACL processing). Subsequent commands in the system filter operate on the
32527 modified set, which also forms the basis for subsequent message delivery.
32528 Unless further modified during routing or transporting, this set of headers is
32529 used for all recipients of the message.
32530
32531 During routing and transporting, the variables that refer to the contents of
32532 header lines refer only to those lines that are in this set. Thus, header lines
32533 that are added by a system filter are visible to users' filter files and to all
32534 routers and transports. This contrasts with the manipulation of header lines by
32535 routers and transports, which is not immediate, but which instead is saved up
32536 until the message is actually being written (see section
32537 &<<SECTheadersaddrem>>&).
32538
32539 If the message is not delivered at the first attempt, header lines that were
32540 added by the system filter are stored with the message, and so are still
32541 present at the next delivery attempt. Header lines that were removed are still
32542 present, but marked &"deleted"& so that they are not transported with the
32543 message. For this reason, it is usual to make the &%headers%& command
32544 conditional on &%first_delivery%& so that the set of header lines is not
32545 modified more than once.
32546
32547 Because header modification in a system filter acts immediately, you have to
32548 use an indirect approach if you want to modify the contents of a header line.
32549 For example:
32550 .code
32551 headers add "Old-Subject: $h_subject:"
32552 headers remove "Subject"
32553 headers add "Subject: new subject (was: $h_old-subject:)"
32554 headers remove "Old-Subject"
32555 .endd
32556
32557
32558
32559 .section "Setting an errors address in a system filter" "SECID217"
32560 .cindex "envelope sender"
32561 In a system filter, if a &%deliver%& command is followed by
32562 .code
32563 errors_to <some address>
32564 .endd
32565 in order to change the envelope sender (and hence the error reporting) for that
32566 delivery, any address may be specified. (In a user filter, only the current
32567 user's address can be set.) For example, if some mail is being monitored, you
32568 might use
32569 .code
32570 unseen deliver monitor@spying.example errors_to root@local.example
32571 .endd
32572 to take a copy which would not be sent back to the normal error reporting
32573 address if its delivery failed.
32574
32575
32576
32577 .section "Per-address filtering" "SECTperaddfil"
32578 .vindex "&$domain$&"
32579 .vindex "&$local_part$&"
32580 In contrast to the system filter, which is run just once per message for each
32581 delivery attempt, it is also possible to set up a system-wide filtering
32582 operation that runs once for each recipient address. In this case, variables
32583 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32584 filter file could be made dependent on them. This is an example of a router
32585 which implements such a filter:
32586 .code
32587 central_filter:
32588   check_local_user
32589   driver = redirect
32590   domains = +local_domains
32591   file = /central/filters/$local_part
32592   no_verify
32593   allow_filter
32594   allow_freeze
32595 .endd
32596 The filter is run in a separate process under its own uid. Therefore, either
32597 &%check_local_user%& must be set (as above), in which case the filter is run as
32598 the local user, or the &%user%& option must be used to specify which user to
32599 use. If both are set, &%user%& overrides.
32600
32601 Care should be taken to ensure that none of the commands in the filter file
32602 specify a significant delivery if the message is to go on to be delivered to
32603 its intended recipient. The router will not then claim to have dealt with the
32604 address, so it will be passed on to subsequent routers to be delivered in the
32605 normal way.
32606 .ecindex IIDsysfil1
32607 .ecindex IIDsysfil2
32608 .ecindex IIDsysfil3
32609
32610
32611
32612
32613
32614
32615 . ////////////////////////////////////////////////////////////////////////////
32616 . ////////////////////////////////////////////////////////////////////////////
32617
32618 .chapter "Message processing" "CHAPmsgproc"
32619 .scindex IIDmesproc "message" "general processing"
32620 Exim performs various transformations on the sender and recipient addresses of
32621 all messages that it handles, and also on the messages' header lines. Some of
32622 these are optional and configurable, while others always take place. All of
32623 this processing, except rewriting as a result of routing, and the addition or
32624 removal of header lines while delivering, happens when a message is received,
32625 before it is placed on Exim's queue.
32626
32627 Some of the automatic processing takes place by default only for
32628 &"locally-originated"& messages. This adjective is used to describe messages
32629 that are not received over TCP/IP, but instead are passed to an Exim process on
32630 its standard input. This includes the interactive &"local SMTP"& case that is
32631 set up by the &%-bs%& command line option.
32632
32633 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32634 or ::1) are not considered to be locally-originated. Exim does not treat the
32635 loopback interface specially in any way.
32636
32637 If you want the loopback interface to be treated specially, you must ensure
32638 that there are appropriate entries in your ACLs.
32639
32640
32641
32642
32643 .section "Submission mode for non-local messages" "SECTsubmodnon"
32644 .cindex "message" "submission"
32645 .cindex "submission mode"
32646 Processing that happens automatically for locally-originated messages (unless
32647 &%suppress_local_fixups%& is set) can also be requested for messages that are
32648 received over TCP/IP. The term &"submission mode"& is used to describe this
32649 state. Submission mode is set by the modifier
32650 .code
32651 control = submission
32652 .endd
32653 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32654 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32655 a local submission, and is normally used when the source of the message is
32656 known to be an MUA running on a client host (as opposed to an MTA). For
32657 example, to set submission mode for messages originating on the IPv4 loopback
32658 interface, you could include the following in the MAIL ACL:
32659 .code
32660 warn  hosts = 127.0.0.1
32661       control = submission
32662 .endd
32663 .cindex "&%sender_retain%& submission option"
32664 There are some options that can be used when setting submission mode. A slash
32665 is used to separate options. For example:
32666 .code
32667 control = submission/sender_retain
32668 .endd
32669 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32670 true and &%local_from_check%& false for the current incoming message. The first
32671 of these allows an existing &'Sender:'& header in the message to remain, and
32672 the second suppresses the check to ensure that &'From:'& matches the
32673 authenticated sender. With this setting, Exim still fixes up messages by adding
32674 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32675 attempt to check sender authenticity in header lines.
32676
32677 When &%sender_retain%& is not set, a submission mode setting may specify a
32678 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32679 example:
32680 .code
32681 control = submission/domain=some.domain
32682 .endd
32683 The domain may be empty. How this value is used is described in sections
32684 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32685 that allows you to specify the user's full name for inclusion in a created
32686 &'Sender:'& or &'From:'& header line. For example:
32687 .code
32688 accept authenticated = *
32689        control = submission/domain=wonderland.example/\
32690                             name=${lookup {$authenticated_id} \
32691                                    lsearch {/etc/exim/namelist}}
32692 .endd
32693 Because the name may contain any characters, including slashes, the &%name%&
32694 option must be given last. The remainder of the string is used as the name. For
32695 the example above, if &_/etc/exim/namelist_& contains:
32696 .code
32697 bigegg:  Humpty Dumpty
32698 .endd
32699 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32700 line would be:
32701 .code
32702 Sender: Humpty Dumpty <bigegg@wonderland.example>
32703 .endd
32704 .cindex "return path" "in submission mode"
32705 By default, submission mode forces the return path to the same address as is
32706 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32707 specified, the return path is also left unchanged.
32708
32709 &*Note*&: The changes caused by submission mode take effect after the predata
32710 ACL. This means that any sender checks performed before the fix-ups use the
32711 untrusted sender address specified by the user, not the trusted sender address
32712 specified by submission mode. Although this might be slightly unexpected, it
32713 does mean that you can configure ACL checks to spot that a user is trying to
32714 spoof another's address.
32715
32716 .section "Line endings" "SECTlineendings"
32717 .cindex "line endings"
32718 .cindex "carriage return"
32719 .cindex "linefeed"
32720 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32721 linefeed) is the line ending for messages transmitted over the Internet using
32722 SMTP over TCP/IP. However, within individual operating systems, different
32723 conventions are used. For example, Unix-like systems use just LF, but others
32724 use CRLF or just CR.
32725
32726 Exim was designed for Unix-like systems, and internally, it stores messages
32727 using the system's convention of a single LF as a line terminator. When
32728 receiving a message, all line endings are translated to this standard format.
32729 Originally, it was thought that programs that passed messages directly to an
32730 MTA within an operating system would use that system's convention. Experience
32731 has shown that this is not the case; for example, there are Unix applications
32732 that use CRLF in this circumstance. For this reason, and for compatibility with
32733 other MTAs, the way Exim handles line endings for all messages is now as
32734 follows:
32735
32736 .ilist
32737 LF not preceded by CR is treated as a line ending.
32738 .next
32739 CR is treated as a line ending; if it is immediately followed by LF, the LF
32740 is ignored.
32741 .next
32742 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32743 nor a local message in the state where a line containing only a dot is a
32744 terminator.
32745 .next
32746 If a bare CR is encountered within a header line, an extra space is added after
32747 the line terminator so as not to end the header line. The reasoning behind this
32748 is that bare CRs in header lines are most likely either to be mistakes, or
32749 people trying to play silly games.
32750 .next
32751 If the first header line received in a message ends with CRLF, a subsequent
32752 bare LF in a header line is treated in the same way as a bare CR in a header
32753 line.
32754 .endlist
32755
32756
32757
32758
32759
32760 .section "Unqualified addresses" "SECID218"
32761 .cindex "unqualified addresses"
32762 .cindex "address" "qualification"
32763 By default, Exim expects every envelope address it receives from an external
32764 host to be fully qualified. Unqualified addresses cause negative responses to
32765 SMTP commands. However, because SMTP is used as a means of transporting
32766 messages from MUAs running on personal workstations, there is sometimes a
32767 requirement to accept unqualified addresses from specific hosts or IP networks.
32768
32769 Exim has two options that separately control which hosts may send unqualified
32770 sender or recipient addresses in SMTP commands, namely
32771 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32772 cases, if an unqualified address is accepted, it is qualified by adding the
32773 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32774
32775 .oindex "&%qualify_domain%&"
32776 .oindex "&%qualify_recipient%&"
32777 Unqualified addresses in header lines are automatically qualified for messages
32778 that are locally originated, unless the &%-bnq%& option is given on the command
32779 line. For messages received over SMTP, unqualified addresses in header lines
32780 are qualified only if unqualified addresses are permitted in SMTP commands. In
32781 other words, such qualification is also controlled by
32782 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32783
32784
32785
32786
32787 .section "The UUCP From line" "SECID219"
32788 .cindex "&""From""& line"
32789 .cindex "UUCP" "&""From""& line"
32790 .cindex "sender" "address"
32791 .oindex "&%uucp_from_pattern%&"
32792 .oindex "&%uucp_from_sender%&"
32793 .cindex "envelope sender"
32794 .cindex "Sendmail compatibility" "&""From""& line"
32795 Messages that have come from UUCP (and some other applications) often begin
32796 with a line containing the envelope sender and a timestamp, following the word
32797 &"From"&. Examples of two common formats are:
32798 .code
32799 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32800 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32801 .endd
32802 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32803 Exim recognizes such lines at the start of messages that are submitted to it
32804 via the command line (that is, on the standard input). It does not recognize
32805 such lines in incoming SMTP messages, unless the sending host matches
32806 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32807 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32808 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32809 default value matches the two common cases shown above and puts the address
32810 that follows &"From"& into &$1$&.
32811
32812 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32813 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32814 a trusted user, the message's sender address is constructed by expanding the
32815 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32816 then parsed as an RFC 2822 address. If there is no domain, the local part is
32817 qualified with &%qualify_domain%& unless it is the empty string. However, if
32818 the command line &%-f%& option is used, it overrides the &"From"& line.
32819
32820 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32821 sender address is not changed. This is also the case for incoming SMTP messages
32822 that are permitted to contain &"From"& lines.
32823
32824 Only one &"From"& line is recognized. If there is more than one, the second is
32825 treated as a data line that starts the body of the message, as it is not valid
32826 as a header line. This also happens if a &"From"& line is present in an
32827 incoming SMTP message from a source that is not permitted to send them.
32828
32829
32830
32831 .section "Resent- header lines" "SECID220"
32832 .cindex "&%Resent-%& header lines"
32833 RFC 2822 makes provision for sets of header lines starting with the string
32834 &`Resent-`& to be added to a message when it is resent by the original
32835 recipient to somebody else. These headers are &'Resent-Date:'&,
32836 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32837 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32838
32839 .blockquote
32840 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32841 processing of replies or other such automatic actions on messages.'&
32842 .endblockquote
32843
32844 This leaves things a bit vague as far as other processing actions such as
32845 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32846 follows:
32847
32848 .ilist
32849 A &'Resent-From:'& line that just contains the login id of the submitting user
32850 is automatically rewritten in the same way as &'From:'& (see below).
32851 .next
32852 If there's a rewriting rule for a particular header line, it is also applied to
32853 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32854 &'From:'& also rewrites &'Resent-From:'&.
32855 .next
32856 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32857 also removed.
32858 .next
32859 For a locally-submitted message,
32860 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32861 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32862 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32863 included in log lines in this case.
32864 .next
32865 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32866 &%Resent-%& header lines are present.
32867 .endlist
32868
32869
32870
32871
32872 .section "The Auto-Submitted: header line" "SECID221"
32873 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32874 includes the header line:
32875 .code
32876 Auto-Submitted: auto-replied
32877 .endd
32878
32879 .section "The Bcc: header line" "SECID222"
32880 .cindex "&'Bcc:'& header line"
32881 If Exim is called with the &%-t%& option, to take recipient addresses from a
32882 message's header, it removes any &'Bcc:'& header line that may exist (after
32883 extracting its addresses). If &%-t%& is not present on the command line, any
32884 existing &'Bcc:'& is not removed.
32885
32886
32887 .section "The Date: header line" "SECID223"
32888 .cindex "&'Date:'& header line"
32889 If a locally-generated or submission-mode message has no &'Date:'& header line,
32890 Exim adds one, using the current date and time, unless the
32891 &%suppress_local_fixups%& control has been specified.
32892
32893 .section "The Delivery-date: header line" "SECID224"
32894 .cindex "&'Delivery-date:'& header line"
32895 .oindex "&%delivery_date_remove%&"
32896 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32897 set. Exim can be configured to add them to the final delivery of messages. (See
32898 the generic &%delivery_date_add%& transport option.) They should not be present
32899 in messages in transit. If the &%delivery_date_remove%& configuration option is
32900 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32901 messages.
32902
32903
32904 .section "The Envelope-to: header line" "SECID225"
32905 .cindex "&'Envelope-to:'& header line"
32906 .oindex "&%envelope_to_remove%&"
32907 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32908 Exim can be configured to add them to the final delivery of messages. (See the
32909 generic &%envelope_to_add%& transport option.) They should not be present in
32910 messages in transit. If the &%envelope_to_remove%& configuration option is set
32911 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32912 messages.
32913
32914
32915 .section "The From: header line" "SECTthefrohea"
32916 .cindex "&'From:'& header line"
32917 .cindex "Sendmail compatibility" "&""From""& line"
32918 .cindex "message" "submission"
32919 .cindex "submission mode"
32920 If a submission-mode message does not contain a &'From:'& header line, Exim
32921 adds one if either of the following conditions is true:
32922
32923 .ilist
32924 The envelope sender address is not empty (that is, this is not a bounce
32925 message). The added header line copies the envelope sender address.
32926 .next
32927 .vindex "&$authenticated_id$&"
32928 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32929 .olist
32930 .vindex "&$qualify_domain$&"
32931 If no domain is specified by the submission control, the local part is
32932 &$authenticated_id$& and the domain is &$qualify_domain$&.
32933 .next
32934 If a non-empty domain is specified by the submission control, the local
32935 part is &$authenticated_id$&, and the domain is the specified domain.
32936 .next
32937 If an empty domain is specified by the submission control,
32938 &$authenticated_id$& is assumed to be the complete address.
32939 .endlist
32940 .endlist
32941
32942 A non-empty envelope sender takes precedence.
32943
32944 If a locally-generated incoming message does not contain a &'From:'& header
32945 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
32946 containing the sender's address. The calling user's login name and full name
32947 are used to construct the address, as described in section &<<SECTconstr>>&.
32948 They are obtained from the password data by calling &[getpwuid()]& (but see the
32949 &%unknown_login%& configuration option). The address is qualified with
32950 &%qualify_domain%&.
32951
32952 For compatibility with Sendmail, if an incoming, non-SMTP message has a
32953 &'From:'& header line containing just the unqualified login name of the calling
32954 user, this is replaced by an address containing the user's login name and full
32955 name as described in section &<<SECTconstr>>&.
32956
32957
32958 .section "The Message-ID: header line" "SECID226"
32959 .cindex "&'Message-ID:'& header line"
32960 .cindex "message" "submission"
32961 .oindex "&%message_id_header_text%&"
32962 If a locally-generated or submission-mode incoming message does not contain a
32963 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
32964 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
32965 to the message. If there are any &'Resent-:'& headers in the message, it
32966 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
32967 message id, preceded by the letter E to ensure it starts with a letter, and
32968 followed by @ and the primary host name. Additional information can be included
32969 in this header line by setting the &%message_id_header_text%& and/or
32970 &%message_id_header_domain%& options.
32971
32972
32973 .section "The Received: header line" "SECID227"
32974 .cindex "&'Received:'& header line"
32975 A &'Received:'& header line is added at the start of every message. The
32976 contents are defined by the &%received_header_text%& configuration option, and
32977 Exim automatically adds a semicolon and a timestamp to the configured string.
32978
32979 The &'Received:'& header is generated as soon as the message's header lines
32980 have been received. At this stage, the timestamp in the &'Received:'& header
32981 line is the time that the message started to be received. This is the value
32982 that is seen by the DATA ACL and by the &[local_scan()]& function.
32983
32984 Once a message is accepted, the timestamp in the &'Received:'& header line is
32985 changed to the time of acceptance, which is (apart from a small delay while the
32986 -H spool file is written) the earliest time at which delivery could start.
32987
32988
32989 .section "The References: header line" "SECID228"
32990 .cindex "&'References:'& header line"
32991 Messages created by the &(autoreply)& transport include a &'References:'&
32992 header line. This is constructed according to the rules that are described in
32993 section 3.64 of RFC 2822 (which states that replies should contain such a
32994 header line), and section 3.14 of RFC 3834 (which states that automatic
32995 responses are not different in this respect). However, because some mail
32996 processing software does not cope well with very long header lines, no more
32997 than 12 message IDs are copied from the &'References:'& header line in the
32998 incoming message. If there are more than 12, the first one and then the final
32999 11 are copied, before adding the message ID of the incoming message.
33000
33001
33002
33003 .section "The Return-path: header line" "SECID229"
33004 .cindex "&'Return-path:'& header line"
33005 .oindex "&%return_path_remove%&"
33006 &'Return-path:'& header lines are defined as something an MTA may insert when
33007 it does the final delivery of messages. (See the generic &%return_path_add%&
33008 transport option.) Therefore, they should not be present in messages in
33009 transit. If the &%return_path_remove%& configuration option is set (the
33010 default), Exim removes &'Return-path:'& header lines from incoming messages.
33011
33012
33013
33014 .section "The Sender: header line" "SECTthesenhea"
33015 .cindex "&'Sender:'& header line"
33016 .cindex "message" "submission"
33017 For a locally-originated message from an untrusted user, Exim may remove an
33018 existing &'Sender:'& header line, and it may add a new one. You can modify
33019 these actions by setting the &%local_sender_retain%& option true, the
33020 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33021 control setting.
33022
33023 When a local message is received from an untrusted user and
33024 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33025 control has not been set, a check is made to see if the address given in the
33026 &'From:'& header line is the correct (local) sender of the message. The address
33027 that is expected has the login name as the local part and the value of
33028 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33029 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33030 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33031 line is added to the message.
33032
33033 If you set &%local_from_check%& false, this checking does not occur. However,
33034 the removal of an existing &'Sender:'& line still happens, unless you also set
33035 &%local_sender_retain%& to be true. It is not possible to set both of these
33036 options true at the same time.
33037
33038 .cindex "submission mode"
33039 By default, no processing of &'Sender:'& header lines is done for messages
33040 received over TCP/IP or for messages submitted by trusted users. However, when
33041 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33042 not specified on the submission control, the following processing takes place:
33043
33044 .vindex "&$authenticated_id$&"
33045 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33046 authenticated, and &$authenticated_id$& is not empty, a sender address is
33047 created as follows:
33048
33049 .ilist
33050 .vindex "&$qualify_domain$&"
33051 If no domain is specified by the submission control, the local part is
33052 &$authenticated_id$& and the domain is &$qualify_domain$&.
33053 .next
33054 If a non-empty domain is specified by the submission control, the local part
33055 is &$authenticated_id$&, and the domain is the specified domain.
33056 .next
33057 If an empty domain is specified by the submission control,
33058 &$authenticated_id$& is assumed to be the complete address.
33059 .endlist
33060
33061 This address is compared with the address in the &'From:'& header line. If they
33062 are different, a &'Sender:'& header line containing the created address is
33063 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33064 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33065
33066 .cindex "return path" "created from &'Sender:'&"
33067 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33068 the message (the envelope sender address) is changed to be the same address,
33069 except in the case of submission mode when &%sender_retain%& is specified.
33070
33071
33072
33073 .section "Adding and removing header lines in routers and transports" &&&
33074          "SECTheadersaddrem"
33075 .cindex "header lines" "adding; in router or transport"
33076 .cindex "header lines" "removing; in router or transport"
33077 When a message is delivered, the addition and removal of header lines can be
33078 specified in a system filter, or on any of the routers and transports that
33079 process the message. Section &<<SECTaddremheasys>>& contains details about
33080 modifying headers in a system filter. Header lines can also be added in an ACL
33081 as a message is received (see section &<<SECTaddheadacl>>&).
33082
33083 In contrast to what happens in a system filter, header modifications that are
33084 specified on routers and transports apply only to the particular recipient
33085 addresses that are being processed by those routers and transports. These
33086 changes do not actually take place until a copy of the message is being
33087 transported. Therefore, they do not affect the basic set of header lines, and
33088 they do not affect the values of the variables that refer to header lines.
33089
33090 &*Note*&: In particular, this means that any expansions in the configuration of
33091 the transport cannot refer to the modified header lines, because such
33092 expansions all occur before the message is actually transported.
33093
33094 For both routers and transports, the argument of a &%headers_add%&
33095 option must be in the form of one or more RFC 2822 header lines, separated by
33096 newlines (coded as &"\n"&). For example:
33097 .code
33098 headers_add = X-added-header: added by $primary_hostname\n\
33099               X-added-second: another added header line
33100 .endd
33101 Exim does not check the syntax of these added header lines.
33102
33103 Multiple &%headers_add%& options for a single router or transport can be
33104 specified; the values will append to a single list of header lines.
33105 Each header-line is separately expanded.
33106
33107 The argument of a &%headers_remove%& option must consist of a colon-separated
33108 list of header names. This is confusing, because header names themselves are
33109 often terminated by colons. In this case, the colons are the list separators,
33110 not part of the names. For example:
33111 .code
33112 headers_remove = return-receipt-to:acknowledge-to
33113 .endd
33114
33115 Multiple &%headers_remove%& options for a single router or transport can be
33116 specified; the arguments will append to a single header-names list.
33117 Each item is separately expanded.
33118 Note that colons in complex expansions which are used to
33119 form all or part of a &%headers_remove%& list
33120 will act as list separators.
33121
33122 When &%headers_add%& or &%headers_remove%& is specified on a router,
33123 items are expanded at routing time,
33124 and then associated with all addresses that are
33125 accepted by that router, and also with any new addresses that it generates. If
33126 an address passes through several routers as a result of aliasing or
33127 forwarding, the changes are cumulative.
33128
33129 .oindex "&%unseen%&"
33130 However, this does not apply to multiple routers that result from the use of
33131 the &%unseen%& option. Any header modifications that were specified by the
33132 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33133
33134 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33135 settings cannot be delivered together in a batch, so a transport is always
33136 dealing with a set of addresses that have the same header-processing
33137 requirements.
33138
33139 The transport starts by writing the original set of header lines that arrived
33140 with the message, possibly modified by the system filter. As it writes out
33141 these lines, it consults the list of header names that were attached to the
33142 recipient address(es) by &%headers_remove%& options in routers, and it also
33143 consults the transport's own &%headers_remove%& option. Header lines whose
33144 names are on either of these lists are not written out. If there are multiple
33145 instances of any listed header, they are all skipped.
33146
33147 After the remaining original header lines have been written, new header
33148 lines that were specified by routers' &%headers_add%& options are written, in
33149 the order in which they were attached to the address. These are followed by any
33150 header lines specified by the transport's &%headers_add%& option.
33151
33152 This way of handling header line modifications in routers and transports has
33153 the following consequences:
33154
33155 .ilist
33156 The original set of header lines, possibly modified by the system filter,
33157 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33158 to it, at all times.
33159 .next
33160 Header lines that are added by a router's
33161 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33162 expansion syntax in subsequent routers or the transport.
33163 .next
33164 Conversely, header lines that are specified for removal by &%headers_remove%&
33165 in a router remain visible to subsequent routers and the transport.
33166 .next
33167 Headers added to an address by &%headers_add%& in a router cannot be removed by
33168 a later router or by a transport.
33169 .next
33170 An added header can refer to the contents of an original header that is to be
33171 removed, even it has the same name as the added header. For example:
33172 .code
33173 headers_remove = subject
33174 headers_add = Subject: new subject (was: $h_subject:)
33175 .endd
33176 .endlist
33177
33178 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33179 for a &(redirect)& router that has the &%one_time%& option set.
33180
33181
33182
33183
33184
33185 .section "Constructed addresses" "SECTconstr"
33186 .cindex "address" "constructed"
33187 .cindex "constructed address"
33188 When Exim constructs a sender address for a locally-generated message, it uses
33189 the form
33190 .display
33191 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33192 .endd
33193 For example:
33194 .code
33195 Zaphod Beeblebrox <zaphod@end.univ.example>
33196 .endd
33197 The user name is obtained from the &%-F%& command line option if set, or
33198 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33199 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33200 ampersand character, this is replaced by the login name with the first letter
33201 upper cased, as is conventional in a number of operating systems. See the
33202 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33203 The &%unknown_username%& option can be used to specify user names in cases when
33204 there is no password file entry.
33205
33206 .cindex "RFC 2047"
33207 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33208 parts of it if necessary. In addition, if it contains any non-printing
33209 characters, it is encoded as described in RFC 2047, which defines a way of
33210 including non-ASCII characters in header lines. The value of the
33211 &%headers_charset%& option specifies the name of the encoding that is used (the
33212 characters are assumed to be in this encoding). The setting of
33213 &%print_topbitchars%& controls whether characters with the top bit set (that
33214 is, with codes greater than 127) count as printing characters or not.
33215
33216
33217
33218 .section "Case of local parts" "SECID230"
33219 .cindex "case of local parts"
33220 .cindex "local part" "case of"
33221 RFC 2822 states that the case of letters in the local parts of addresses cannot
33222 be assumed to be non-significant. Exim preserves the case of local parts of
33223 addresses, but by default it uses a lower-cased form when it is routing,
33224 because on most Unix systems, usernames are in lower case and case-insensitive
33225 routing is required. However, any particular router can be made to use the
33226 original case for local parts by setting the &%caseful_local_part%& generic
33227 router option.
33228
33229 .cindex "mixed-case login names"
33230 If you must have mixed-case user names on your system, the best way to proceed,
33231 assuming you want case-independent handling of incoming email, is to set up
33232 your first router to convert incoming local parts in your domains to the
33233 correct case by means of a file lookup. For example:
33234 .code
33235 correct_case:
33236   driver = redirect
33237   domains = +local_domains
33238   data = ${lookup{$local_part}cdb\
33239               {/etc/usercased.cdb}{$value}fail}\
33240               @$domain
33241 .endd
33242 For this router, the local part is forced to lower case by the default action
33243 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33244 up a new local part in the correct case. If you then set &%caseful_local_part%&
33245 on any subsequent routers which process your domains, they will operate on
33246 local parts with the correct case in a case-sensitive manner.
33247
33248
33249
33250 .section "Dots in local parts" "SECID231"
33251 .cindex "dot" "in local part"
33252 .cindex "local part" "dots in"
33253 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33254 part may not begin or end with a dot, nor have two consecutive dots in the
33255 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33256 empty components for compatibility.
33257
33258
33259
33260 .section "Rewriting addresses" "SECID232"
33261 .cindex "rewriting" "addresses"
33262 Rewriting of sender and recipient addresses, and addresses in headers, can
33263 happen automatically, or as the result of configuration options, as described
33264 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33265 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33266
33267 Automatic rewriting includes qualification, as mentioned above. The other case
33268 in which it can happen is when an incomplete non-local domain is given. The
33269 routing process may cause this to be expanded into the full domain name. For
33270 example, a header such as
33271 .code
33272 To: hare@teaparty
33273 .endd
33274 might get rewritten as
33275 .code
33276 To: hare@teaparty.wonderland.fict.example
33277 .endd
33278 Rewriting as a result of routing is the one kind of message processing that
33279 does not happen at input time, as it cannot be done until the address has
33280 been routed.
33281
33282 Strictly, one should not do &'any'& deliveries of a message until all its
33283 addresses have been routed, in case any of the headers get changed as a
33284 result of routing. However, doing this in practice would hold up many
33285 deliveries for unreasonable amounts of time, just because one address could not
33286 immediately be routed. Exim therefore does not delay other deliveries when
33287 routing of one or more addresses is deferred.
33288 .ecindex IIDmesproc
33289
33290
33291
33292 . ////////////////////////////////////////////////////////////////////////////
33293 . ////////////////////////////////////////////////////////////////////////////
33294
33295 .chapter "SMTP processing" "CHAPSMTP"
33296 .scindex IIDsmtpproc1 "SMTP" "processing details"
33297 .scindex IIDsmtpproc2 "LMTP" "processing details"
33298 Exim supports a number of different ways of using the SMTP protocol, and its
33299 LMTP variant, which is an interactive protocol for transferring messages into a
33300 closed mail store application. This chapter contains details of how SMTP is
33301 processed. For incoming mail, the following are available:
33302
33303 .ilist
33304 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33305 .next
33306 SMTP over the standard input and output (the &%-bs%& option);
33307 .next
33308 Batched SMTP on the standard input (the &%-bS%& option).
33309 .endlist
33310
33311 For mail delivery, the following are available:
33312
33313 .ilist
33314 SMTP over TCP/IP (the &(smtp)& transport);
33315 .next
33316 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33317 &"lmtp"&);
33318 .next
33319 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33320 transport);
33321 .next
33322 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33323 the &%use_bsmtp%& option set).
33324 .endlist
33325
33326 &'Batched SMTP'& is the name for a process in which batches of messages are
33327 stored in or read from files (or pipes), in a format in which SMTP commands are
33328 used to contain the envelope information.
33329
33330
33331
33332 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33333 .cindex "SMTP" "outgoing over TCP/IP"
33334 .cindex "outgoing SMTP over TCP/IP"
33335 .cindex "LMTP" "over TCP/IP"
33336 .cindex "outgoing LMTP over TCP/IP"
33337 .cindex "EHLO"
33338 .cindex "HELO"
33339 .cindex "SIZE option on MAIL command"
33340 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33341 The &%protocol%& option selects which protocol is to be used, but the actual
33342 processing is the same in both cases.
33343
33344 If, in response to its EHLO command, Exim is told that the SIZE
33345 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33346 command. The value of <&'n'&> is the message size plus the value of the
33347 &%size_addition%& option (default 1024) to allow for additions to the message
33348 such as per-transport header lines, or changes made in a
33349 .cindex "transport" "filter"
33350 .cindex "filter" "transport filter"
33351 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33352 suppressed.
33353
33354 If the remote server advertises support for PIPELINING, Exim uses the
33355 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33356 required for the transaction.
33357
33358 If the remote server advertises support for the STARTTLS command, and Exim
33359 was built to support TLS encryption, it tries to start a TLS session unless the
33360 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33361 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33362 is called for verification.
33363
33364 If the remote server advertises support for the AUTH command, Exim scans
33365 the authenticators configuration for any suitable client settings, as described
33366 in chapter &<<CHAPSMTPAUTH>>&.
33367
33368 .cindex "carriage return"
33369 .cindex "linefeed"
33370 Responses from the remote host are supposed to be terminated by CR followed by
33371 LF. However, there are known to be hosts that do not send CR characters, so in
33372 order to be able to interwork with such hosts, Exim treats LF on its own as a
33373 line terminator.
33374
33375 If a message contains a number of different addresses, all those with the same
33376 characteristics (for example, the same envelope sender) that resolve to the
33377 same set of hosts, in the same order, are sent in a single SMTP transaction,
33378 even if they are for different domains, unless there are more than the setting
33379 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33380 they are split into groups containing no more than &%max_rcpt%&s addresses
33381 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33382 in parallel sessions. The order of hosts with identical MX values is not
33383 significant when checking whether addresses can be batched in this way.
33384
33385 When the &(smtp)& transport suffers a temporary failure that is not
33386 message-related, Exim updates its transport-specific database, which contains
33387 records indexed by host name that remember which messages are waiting for each
33388 particular host. It also updates the retry database with new retry times.
33389
33390 .cindex "hints database" "retry keys"
33391 Exim's retry hints are based on host name plus IP address, so if one address of
33392 a multi-homed host is broken, it will soon be skipped most of the time.
33393 See the next section for more detail about error handling.
33394
33395 .cindex "SMTP" "passed connection"
33396 .cindex "SMTP" "batching over TCP/IP"
33397 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33398 looks in the hints database for the transport to see if there are any queued
33399 messages waiting for the host to which it is connected. If it finds one, it
33400 creates a new Exim process using the &%-MC%& option (which can only be used by
33401 a process running as root or the Exim user) and passes the TCP/IP socket to it
33402 so that it can deliver another message using the same socket. The new process
33403 does only those deliveries that are routed to the connected host, and may in
33404 turn pass the socket on to a third process, and so on.
33405
33406 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33407 limit the number of messages sent down a single TCP/IP connection.
33408
33409 .cindex "asterisk" "after IP address"
33410 The second and subsequent messages delivered down an existing connection are
33411 identified in the main log by the addition of an asterisk after the closing
33412 square bracket of the IP address.
33413
33414
33415
33416
33417 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33418 .cindex "error" "in outgoing SMTP"
33419 .cindex "SMTP" "errors in outgoing"
33420 .cindex "host" "error"
33421 Three different kinds of error are recognized for outgoing SMTP: host errors,
33422 message errors, and recipient errors.
33423
33424 .vlist
33425 .vitem "&*Host errors*&"
33426 A host error is not associated with a particular message or with a
33427 particular recipient of a message. The host errors are:
33428
33429 .ilist
33430 Connection refused or timed out,
33431 .next
33432 Any error response code on connection,
33433 .next
33434 Any error response code to EHLO or HELO,
33435 .next
33436 Loss of connection at any time, except after &"."&,
33437 .next
33438 I/O errors at any time,
33439 .next
33440 Timeouts during the session, other than in response to MAIL, RCPT or
33441 the &"."& at the end of the data.
33442 .endlist ilist
33443
33444 For a host error, a permanent error response on connection, or in response to
33445 EHLO, causes all addresses routed to the host to be failed. Any other host
33446 error causes all addresses to be deferred, and retry data to be created for the
33447 host. It is not tried again, for any message, until its retry time arrives. If
33448 the current set of addresses are not all delivered in this run (to some
33449 alternative host), the message is added to the list of those waiting for this
33450 host, so if it is still undelivered when a subsequent successful delivery is
33451 made to the host, it will be sent down the same SMTP connection.
33452
33453 .vitem "&*Message errors*&"
33454 .cindex "message" "error"
33455 A message error is associated with a particular message when sent to a
33456 particular host, but not with a particular recipient of the message. The
33457 message errors are:
33458
33459 .ilist
33460 Any error response code to MAIL, DATA, or the &"."& that terminates
33461 the data,
33462 .next
33463 Timeout after MAIL,
33464 .next
33465 Timeout or loss of connection after the &"."& that terminates the data. A
33466 timeout after the DATA command itself is treated as a host error, as is loss of
33467 connection at any other time.
33468 .endlist ilist
33469
33470 For a message error, a permanent error response (5&'xx'&) causes all addresses
33471 to be failed, and a delivery error report to be returned to the sender. A
33472 temporary error response (4&'xx'&), or one of the timeouts, causes all
33473 addresses to be deferred. Retry data is not created for the host, but instead,
33474 a retry record for the combination of host plus message id is created. The
33475 message is not added to the list of those waiting for this host. This ensures
33476 that the failing message will not be sent to this host again until the retry
33477 time arrives. However, other messages that are routed to the host are not
33478 affected, so if it is some property of the message that is causing the error,
33479 it will not stop the delivery of other mail.
33480
33481 If the remote host specified support for the SIZE parameter in its response
33482 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33483 over-large message will cause a message error because the error arrives as a
33484 response to MAIL.
33485
33486 .vitem "&*Recipient errors*&"
33487 .cindex "recipient" "error"
33488 A recipient error is associated with a particular recipient of a message. The
33489 recipient errors are:
33490
33491 .ilist
33492 Any error response to RCPT,
33493 .next
33494 Timeout after RCPT.
33495 .endlist
33496
33497 For a recipient error, a permanent error response (5&'xx'&) causes the
33498 recipient address to be failed, and a bounce message to be returned to the
33499 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33500 address to be deferred, and routing retry data to be created for it. This is
33501 used to delay processing of the address in subsequent queue runs, until its
33502 routing retry time arrives. This applies to all messages, but because it
33503 operates only in queue runs, one attempt will be made to deliver a new message
33504 to the failing address before the delay starts to operate. This ensures that,
33505 if the failure is really related to the message rather than the recipient
33506 (&"message too big for this recipient"& is a possible example), other messages
33507 have a chance of getting delivered. If a delivery to the address does succeed,
33508 the retry information gets cleared, so all stuck messages get tried again, and
33509 the retry clock is reset.
33510
33511 The message is not added to the list of those waiting for this host. Use of the
33512 host for other messages is unaffected, and except in the case of a timeout,
33513 other recipients are processed independently, and may be successfully delivered
33514 in the current SMTP session. After a timeout it is of course impossible to
33515 proceed with the session, so all addresses get deferred. However, those other
33516 than the one that failed do not suffer any subsequent retry delays. Therefore,
33517 if one recipient is causing trouble, the others have a chance of getting
33518 through when a subsequent delivery attempt occurs before the failing
33519 recipient's retry time.
33520 .endlist
33521
33522 In all cases, if there are other hosts (or IP addresses) available for the
33523 current set of addresses (for example, from multiple MX records), they are
33524 tried in this run for any undelivered addresses, subject of course to their
33525 own retry data. In other words, recipient error retry data does not take effect
33526 until the next delivery attempt.
33527
33528 Some hosts have been observed to give temporary error responses to every
33529 MAIL command at certain times (&"insufficient space"& has been seen). It
33530 would be nice if such circumstances could be recognized, and defer data for the
33531 host itself created, but this is not possible within the current Exim design.
33532 What actually happens is that retry data for every (host, message) combination
33533 is created.
33534
33535 The reason that timeouts after MAIL and RCPT are treated specially is that
33536 these can sometimes arise as a result of the remote host's verification
33537 procedures. Exim makes this assumption, and treats them as if a temporary error
33538 response had been received. A timeout after &"."& is treated specially because
33539 it is known that some broken implementations fail to recognize the end of the
33540 message if the last character of the last line is a binary zero. Thus, it is
33541 helpful to treat this case as a message error.
33542
33543 Timeouts at other times are treated as host errors, assuming a problem with the
33544 host, or the connection to it. If a timeout after MAIL, RCPT,
33545 or &"."& is really a connection problem, the assumption is that at the next try
33546 the timeout is likely to occur at some other point in the dialogue, causing it
33547 then to be treated as a host error.
33548
33549 There is experimental evidence that some MTAs drop the connection after the
33550 terminating &"."& if they do not like the contents of the message for some
33551 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33552 should be given. That is why Exim treats this case as a message rather than a
33553 host error, in order not to delay other messages to the same host.
33554
33555
33556
33557
33558 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33559 .cindex "SMTP" "incoming over TCP/IP"
33560 .cindex "incoming SMTP over TCP/IP"
33561 .cindex "inetd"
33562 .cindex "daemon"
33563 Incoming SMTP messages can be accepted in one of two ways: by running a
33564 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33565 &_/etc/inetd.conf_& should be like this:
33566 .code
33567 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33568 .endd
33569 Exim distinguishes between this case and the case of a locally running user
33570 agent using the &%-bs%& option by checking whether or not the standard input is
33571 a socket. When it is, either the port must be privileged (less than 1024), or
33572 the caller must be root or the Exim user. If any other user passes a socket
33573 with an unprivileged port number, Exim prints a message on the standard error
33574 stream and exits with an error code.
33575
33576 By default, Exim does not make a log entry when a remote host connects or
33577 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33578 unexpected. It can be made to write such log entries by setting the
33579 &%smtp_connection%& log selector.
33580
33581 .cindex "carriage return"
33582 .cindex "linefeed"
33583 Commands from the remote host are supposed to be terminated by CR followed by
33584 LF. However, there are known to be hosts that do not send CR characters. In
33585 order to be able to interwork with such hosts, Exim treats LF on its own as a
33586 line terminator.
33587 Furthermore, because common code is used for receiving messages from all
33588 sources, a CR on its own is also interpreted as a line terminator. However, the
33589 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33590
33591 .cindex "EHLO" "invalid data"
33592 .cindex "HELO" "invalid data"
33593 One area that sometimes gives rise to problems concerns the EHLO or
33594 HELO commands. Some clients send syntactically invalid versions of these
33595 commands, which Exim rejects by default. (This is nothing to do with verifying
33596 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33597 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33598 match the broken hosts that send invalid commands.
33599
33600 .cindex "SIZE option on MAIL command"
33601 .cindex "MAIL" "SIZE option"
33602 The amount of disk space available is checked whenever SIZE is received on
33603 a MAIL command, independently of whether &%message_size_limit%& or
33604 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33605 false. A temporary error is given if there is not enough space. If
33606 &%check_spool_space%& is set, the check is for that amount of space plus the
33607 value given with SIZE, that is, it checks that the addition of the incoming
33608 message will not reduce the space below the threshold.
33609
33610 When a message is successfully received, Exim includes the local message id in
33611 its response to the final &"."& that terminates the data. If the remote host
33612 logs this text it can help with tracing what has happened to a message.
33613
33614 The Exim daemon can limit the number of simultaneous incoming connections it is
33615 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33616 number of simultaneous incoming connections from a single remote host (see the
33617 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33618 rejected using the SMTP temporary error code 421.
33619
33620 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33621 subprocess has finished, as this can get lost at busy times. Instead, it looks
33622 for completed subprocesses every time it wakes up. Provided there are other
33623 things happening (new incoming calls, starts of queue runs), completed
33624 processes will be noticed and tidied away. On very quiet systems you may
33625 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33626 it will be noticed when the daemon next wakes up.
33627
33628 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33629 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33630 high system load &-- for details see the &%smtp_accept_reserve%&,
33631 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33632 applies in both the daemon and &'inetd'& cases.
33633
33634 Exim normally starts a delivery process for each message received, though this
33635 can be varied by means of the &%-odq%& command line option and the
33636 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33637 number of simultaneously running delivery processes started in this way from
33638 SMTP input can be limited by the &%smtp_accept_queue%& and
33639 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33640 subsequently received messages are just put on the input queue without starting
33641 a delivery process.
33642
33643 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33644 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33645 started up from the &'inetd'& daemon, because in that case each connection is
33646 handled by an entirely independent Exim process. Control by load average is,
33647 however, available with &'inetd'&.
33648
33649 Exim can be configured to verify addresses in incoming SMTP commands as they
33650 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33651 to rewrite addresses at this time &-- before any syntax checking is done. See
33652 section &<<SECTrewriteS>>&.
33653
33654 Exim can also be configured to limit the rate at which a client host submits
33655 MAIL and RCPT commands in a single SMTP session. See the
33656 &%smtp_ratelimit_hosts%& option.
33657
33658
33659
33660 .section "Unrecognized SMTP commands" "SECID234"
33661 .cindex "SMTP" "unrecognized commands"
33662 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33663 commands during a single SMTP connection, it drops the connection after sending
33664 the error response to the last command. The default value for
33665 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33666 abuse that subvert web servers into making connections to SMTP ports; in these
33667 circumstances, a number of non-SMTP lines are sent first.
33668
33669
33670 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33671 .cindex "SMTP" "syntax errors"
33672 .cindex "SMTP" "protocol errors"
33673 A syntax error is detected if an SMTP command is recognized, but there is
33674 something syntactically wrong with its data, for example, a malformed email
33675 address in a RCPT command. Protocol errors include invalid command
33676 sequencing such as RCPT before MAIL. If Exim receives more than
33677 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33678 drops the connection after sending the error response to the last command. The
33679 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33680 broken clients that loop sending bad commands (yes, it has been seen).
33681
33682
33683
33684 .section "Use of non-mail SMTP commands" "SECID236"
33685 .cindex "SMTP" "non-mail commands"
33686 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33687 DATA. Exim counts such commands, and drops the connection if there are too
33688 many of them in a single SMTP session. This action catches some
33689 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33690 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33691 defines what &"too many"& means. Its default value is 10.
33692
33693 When a new message is expected, one occurrence of RSET is not counted. This
33694 allows a client to send one RSET between messages (this is not necessary,
33695 but some clients do it). Exim also allows one uncounted occurrence of HELO
33696 or EHLO, and one occurrence of STARTTLS between messages. After
33697 starting up a TLS session, another EHLO is expected, and so it too is not
33698 counted.
33699
33700 The first occurrence of AUTH in a connection, or immediately following
33701 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33702 RCPT, DATA, and QUIT are counted.
33703
33704 You can control which hosts are subject to the limit set by
33705 &%smtp_accept_max_nonmail%& by setting
33706 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33707 the limit apply to all hosts. This option means that you can exclude any
33708 specific badly-behaved hosts that you have to live with.
33709
33710
33711
33712
33713 .section "The VRFY and EXPN commands" "SECID237"
33714 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33715 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33716 appropriate) in order to decide whether the command should be accepted or not.
33717 If no ACL is defined, the command is rejected.
33718
33719 .cindex "VRFY" "processing"
33720 When VRFY is accepted, it runs exactly the same code as when Exim is
33721 called with the &%-bv%& option.
33722
33723 .cindex "EXPN" "processing"
33724 When EXPN is accepted, a single-level expansion of the address is done.
33725 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33726 than a verification (the &%-bv%& option). If an unqualified local part is given
33727 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33728 of VRFY and EXPN commands are logged on the main and reject logs, and
33729 VRFY verification failures are logged on the main log for consistency with
33730 RCPT failures.
33731
33732
33733
33734 .section "The ETRN command" "SECTETRN"
33735 .cindex "ETRN" "processing"
33736 RFC 1985 describes an SMTP command called ETRN that is designed to
33737 overcome the security problems of the TURN command (which has fallen into
33738 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33739 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33740 should be accepted or not. If no ACL is defined, the command is rejected.
33741
33742 The ETRN command is concerned with &"releasing"& messages that are awaiting
33743 delivery to certain hosts. As Exim does not organize its message queue by host,
33744 the only form of ETRN that is supported by default is the one where the
33745 text starts with the &"#"& prefix, in which case the remainder of the text is
33746 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33747 the &%-R%& option to happen, with the remainder of the ETRN text as its
33748 argument. For example,
33749 .code
33750 ETRN #brigadoon
33751 .endd
33752 runs the command
33753 .code
33754 exim -R brigadoon
33755 .endd
33756 which causes a delivery attempt on all messages with undelivered addresses
33757 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33758 default), Exim prevents the simultaneous execution of more than one queue run
33759 for the same argument string as a result of an ETRN command. This stops
33760 a misbehaving client from starting more than one queue runner at once.
33761
33762 .cindex "hints database" "ETRN serialization"
33763 Exim implements the serialization by means of a hints database in which a
33764 record is written whenever a process is started by ETRN, and deleted when
33765 the process completes. However, Exim does not keep the SMTP session waiting for
33766 the ETRN process to complete. Once ETRN is accepted, the client is sent
33767 a &"success"& return code. Obviously there is scope for hints records to get
33768 left lying around if there is a system or program crash. To guard against this,
33769 Exim ignores any records that are more than six hours old.
33770
33771 .oindex "&%smtp_etrn_command%&"
33772 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33773 used. This specifies a command that is run whenever ETRN is received,
33774 whatever the form of its argument. For
33775 example:
33776 .code
33777 smtp_etrn_command = /etc/etrn_command $domain \
33778                     $sender_host_address
33779 .endd
33780 .vindex "&$domain$&"
33781 The string is split up into arguments which are independently expanded. The
33782 expansion variable &$domain$& is set to the argument of the ETRN command,
33783 and no syntax checking is done on the contents of this argument. Exim does not
33784 wait for the command to complete, so its status code is not checked. Exim runs
33785 under its own uid and gid when receiving incoming SMTP, so it is not possible
33786 for it to change them before running the command.
33787
33788
33789
33790 .section "Incoming local SMTP" "SECID238"
33791 .cindex "SMTP" "local incoming"
33792 Some user agents use SMTP to pass messages to their local MTA using the
33793 standard input and output, as opposed to passing the envelope on the command
33794 line and writing the message to the standard input. This is supported by the
33795 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33796 messages over TCP/IP (including the use of ACLs), except that the envelope
33797 sender given in a MAIL command is ignored unless the caller is trusted. In
33798 an ACL you can detect this form of SMTP input by testing for an empty host
33799 identification. It is common to have this as the first line in the ACL that
33800 runs for RCPT commands:
33801 .code
33802 accept hosts = :
33803 .endd
33804 This accepts SMTP messages from local processes without doing any other tests.
33805
33806
33807
33808 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33809 .cindex "SMTP" "batched outgoing"
33810 .cindex "batched SMTP output"
33811 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33812 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33813 be output in BSMTP format. No SMTP responses are possible for this form of
33814 delivery. All it is doing is using SMTP commands as a way of transmitting the
33815 envelope along with the message.
33816
33817 The message is written to the file or pipe preceded by the SMTP commands
33818 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33819 the message that start with a dot have an extra dot added. The SMTP command
33820 HELO is not normally used. If it is required, the &%message_prefix%& option
33821 can be used to specify it.
33822
33823 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33824 one recipient address at a time by default. However, you can arrange for them
33825 to handle several addresses at once by setting the &%batch_max%& option. When
33826 this is done for BSMTP, messages may contain multiple RCPT commands. See
33827 chapter &<<CHAPbatching>>& for more details.
33828
33829 .vindex "&$host$&"
33830 When one or more addresses are routed to a BSMTP transport by a router that
33831 sets up a host list, the name of the first host on the list is available to the
33832 transport in the variable &$host$&. Here is an example of such a transport and
33833 router:
33834 .code
33835 begin routers
33836 route_append:
33837   driver = manualroute
33838   transport = smtp_appendfile
33839   route_list = domain.example  batch.host.example
33840
33841 begin transports
33842 smtp_appendfile:
33843   driver = appendfile
33844   directory = /var/bsmtp/$host
33845   batch_max = 1000
33846   use_bsmtp
33847   user = exim
33848 .endd
33849 This causes messages addressed to &'domain.example'& to be written in BSMTP
33850 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33851 message (unless there are more than 1000 recipients).
33852
33853
33854
33855 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33856 .cindex "SMTP" "batched incoming"
33857 .cindex "batched SMTP input"
33858 The &%-bS%& command line option causes Exim to accept one or more messages by
33859 reading SMTP on the standard input, but to generate no responses. If the caller
33860 is trusted, the senders in the MAIL commands are believed; otherwise the
33861 sender is always the caller of Exim. Unqualified senders and receivers are not
33862 rejected (there seems little point) but instead just get qualified. HELO
33863 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33864 as NOOP; QUIT quits.
33865
33866 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33867 ACL is run in the same way as for non-SMTP local input.
33868
33869 If an error is detected while reading a message, including a missing &"."& at
33870 the end, Exim gives up immediately. It writes details of the error to the
33871 standard output in a stylized way that the calling program should be able to
33872 make some use of automatically, for example:
33873 .code
33874 554 Unexpected end of file
33875 Transaction started in line 10
33876 Error detected in line 14
33877 .endd
33878 It writes a more verbose version, for human consumption, to the standard error
33879 file, for example:
33880 .code
33881 An error was detected while processing a file of BSMTP input.
33882 The error message was:
33883
33884 501 '>' missing at end of address
33885
33886 The SMTP transaction started in line 10.
33887 The error was detected in line 12.
33888 The SMTP command at fault was:
33889
33890 rcpt to:<malformed@in.com.plete
33891
33892 1 previous message was successfully processed.
33893 The rest of the batch was abandoned.
33894 .endd
33895 The return code from Exim is zero only if there were no errors. It is 1 if some
33896 messages were accepted before an error was detected, and 2 if no messages were
33897 accepted.
33898 .ecindex IIDsmtpproc1
33899 .ecindex IIDsmtpproc2
33900
33901
33902
33903 . ////////////////////////////////////////////////////////////////////////////
33904 . ////////////////////////////////////////////////////////////////////////////
33905
33906 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33907          "Customizing messages"
33908 When a message fails to be delivered, or remains on the queue for more than a
33909 configured amount of time, Exim sends a message to the original sender, or
33910 to an alternative configured address. The text of these messages is built into
33911 the code of Exim, but it is possible to change it, either by adding a single
33912 string, or by replacing each of the paragraphs by text supplied in a file.
33913
33914 The &'From:'& and &'To:'& header lines are automatically generated; you can
33915 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33916 option. Exim also adds the line
33917 .code
33918 Auto-Submitted: auto-generated
33919 .endd
33920 to all warning and bounce messages,
33921
33922
33923 .section "Customizing bounce messages" "SECID239"
33924 .cindex "customizing" "bounce message"
33925 .cindex "bounce message" "customizing"
33926 If &%bounce_message_text%& is set, its contents are included in the default
33927 message immediately after &"This message was created automatically by mail
33928 delivery software."& The string is not expanded. It is not used if
33929 &%bounce_message_file%& is set.
33930
33931 When &%bounce_message_file%& is set, it must point to a template file for
33932 constructing error messages. The file consists of a series of text items,
33933 separated by lines consisting of exactly four asterisks. If the file cannot be
33934 opened, default text is used and a message is written to the main and panic
33935 logs. If any text item in the file is empty, default text is used for that
33936 item.
33937
33938 .vindex "&$bounce_recipient$&"
33939 .vindex "&$bounce_return_size_limit$&"
33940 Each item of text that is read from the file is expanded, and there are two
33941 expansion variables which can be of use here: &$bounce_recipient$& is set to
33942 the recipient of an error message while it is being created, and
33943 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
33944 option, rounded to a whole number.
33945
33946 The items must appear in the file in the following order:
33947
33948 .ilist
33949 The first item is included in the headers, and should include at least a
33950 &'Subject:'& header. Exim does not check the syntax of these headers.
33951 .next
33952 The second item forms the start of the error message. After it, Exim lists the
33953 failing addresses with their error messages.
33954 .next
33955 The third item is used to introduce any text from pipe transports that is to be
33956 returned to the sender. It is omitted if there is no such text.
33957 .next
33958 .new
33959 The fourth, fifth and sixth items will be ignored and may be empty.
33960 The fields exist for back-compatibility
33961 .wen
33962 .endlist
33963
33964 The default state (&%bounce_message_file%& unset) is equivalent to the
33965 following file, in which the sixth item is empty. The &'Subject:'& and some
33966 other lines have been split in order to fit them on the page:
33967 .code
33968 Subject: Mail delivery failed
33969   ${if eq{$sender_address}{$bounce_recipient}
33970   {: returning message to sender}}
33971 ****
33972 This message was created automatically by mail delivery software.
33973
33974 A message ${if eq{$sender_address}{$bounce_recipient}
33975   {that you sent }{sent by
33976
33977 <$sender_address>
33978
33979 }}could not be delivered to all of its recipients.
33980 This is a permanent error. The following address(es) failed:
33981 ****
33982 The following text was generated during the delivery attempt(s):
33983 ****
33984 ------ This is a copy of the message, including all the headers.
33985   ------
33986 ****
33987 ------ The body of the message is $message_size characters long;
33988   only the first
33989 ------ $bounce_return_size_limit or so are included here.
33990 ****
33991 .endd
33992 .section "Customizing warning messages" "SECTcustwarn"
33993 .cindex "customizing" "warning message"
33994 .cindex "warning of delay" "customizing the message"
33995 The option &%warn_message_file%& can be pointed at a template file for use when
33996 warnings about message delays are created. In this case there are only three
33997 text sections:
33998
33999 .ilist
34000 The first item is included in the headers, and should include at least a
34001 &'Subject:'& header. Exim does not check the syntax of these headers.
34002 .next
34003 The second item forms the start of the warning message. After it, Exim lists
34004 the delayed addresses.
34005 .next
34006 The third item then ends the message.
34007 .endlist
34008
34009 The default state is equivalent to the following file, except that some lines
34010 have been split here, in order to fit them on the page:
34011 .code
34012 Subject: Warning: message $message_exim_id delayed
34013   $warn_message_delay
34014 ****
34015 This message was created automatically by mail delivery software.
34016
34017 A message ${if eq{$sender_address}{$warn_message_recipients}
34018 {that you sent }{sent by
34019
34020 <$sender_address>
34021
34022 }}has not been delivered to all of its recipients after
34023 more than $warn_message_delay on the queue on $primary_hostname.
34024
34025 The message identifier is:     $message_exim_id
34026 The subject of the message is: $h_subject
34027 The date of the message is:    $h_date
34028
34029 The following address(es) have not yet been delivered:
34030 ****
34031 No action is required on your part. Delivery attempts will
34032 continue for some time, and this warning may be repeated at
34033 intervals if the message remains undelivered. Eventually the
34034 mail delivery software will give up, and when that happens,
34035 the message will be returned to you.
34036 .endd
34037 .vindex "&$warn_message_delay$&"
34038 .vindex "&$warn_message_recipients$&"
34039 However, in the default state the subject and date lines are omitted if no
34040 appropriate headers exist. During the expansion of this file,
34041 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34042 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34043 of recipients for the warning message. There may be more than one if there are
34044 multiple addresses with different &%errors_to%& settings on the routers that
34045 handled them.
34046
34047
34048
34049
34050 . ////////////////////////////////////////////////////////////////////////////
34051 . ////////////////////////////////////////////////////////////////////////////
34052
34053 .chapter "Some common configuration settings" "CHAPcomconreq"
34054 This chapter discusses some configuration settings that seem to be fairly
34055 common. More examples and discussion can be found in the Exim book.
34056
34057
34058
34059 .section "Sending mail to a smart host" "SECID240"
34060 .cindex "smart host" "example router"
34061 If you want to send all mail for non-local domains to a &"smart host"&, you
34062 should replace the default &(dnslookup)& router with a router which does the
34063 routing explicitly:
34064 .code
34065 send_to_smart_host:
34066   driver = manualroute
34067   route_list = !+local_domains smart.host.name
34068   transport = remote_smtp
34069 .endd
34070 You can use the smart host's IP address instead of the name if you wish.
34071 If you are using Exim only to submit messages to a smart host, and not for
34072 receiving incoming messages, you can arrange for it to do the submission
34073 synchronously by setting the &%mua_wrapper%& option (see chapter
34074 &<<CHAPnonqueueing>>&).
34075
34076
34077
34078
34079 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34080 .cindex "mailing lists"
34081 Exim can be used to run simple mailing lists, but for large and/or complicated
34082 requirements, the use of additional specialized mailing list software such as
34083 Majordomo or Mailman is recommended.
34084
34085 The &(redirect)& router can be used to handle mailing lists where each list
34086 is maintained in a separate file, which can therefore be managed by an
34087 independent manager. The &%domains%& router option can be used to run these
34088 lists in a separate domain from normal mail. For example:
34089 .code
34090 lists:
34091   driver = redirect
34092   domains = lists.example
34093   file = /usr/lists/$local_part
34094   forbid_pipe
34095   forbid_file
34096   errors_to = $local_part-request@lists.example
34097   no_more
34098 .endd
34099 This router is skipped for domains other than &'lists.example'&. For addresses
34100 in that domain, it looks for a file that matches the local part. If there is no
34101 such file, the router declines, but because &%no_more%& is set, no subsequent
34102 routers are tried, and so the whole delivery fails.
34103
34104 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34105 expanded into a file name or a pipe delivery, which is usually inappropriate in
34106 a mailing list.
34107
34108 .oindex "&%errors_to%&"
34109 The &%errors_to%& option specifies that any delivery errors caused by addresses
34110 taken from a mailing list are to be sent to the given address rather than the
34111 original sender of the message. However, before acting on this, Exim verifies
34112 the error address, and ignores it if verification fails.
34113
34114 For example, using the configuration above, mail sent to
34115 &'dicts@lists.example'& is passed on to those addresses contained in
34116 &_/usr/lists/dicts_&, with error reports directed to
34117 &'dicts-request@lists.example'&, provided that this address can be verified.
34118 There could be a file called &_/usr/lists/dicts-request_& containing
34119 the address(es) of this particular list's manager(s), but other approaches,
34120 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34121 or &%local_part_suffix%& options) to handle addresses of the form
34122 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34123
34124
34125
34126 .section "Syntax errors in mailing lists" "SECID241"
34127 .cindex "mailing lists" "syntax errors in"
34128 If an entry in redirection data contains a syntax error, Exim normally defers
34129 delivery of the original address. That means that a syntax error in a mailing
34130 list holds up all deliveries to the list. This may not be appropriate when a
34131 list is being maintained automatically from data supplied by users, and the
34132 addresses are not rigorously checked.
34133
34134 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34135 entries that fail to parse, noting the incident in the log. If in addition
34136 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34137 whenever a broken address is skipped. It is usually appropriate to set
34138 &%syntax_errors_to%& to the same address as &%errors_to%&.
34139
34140
34141
34142 .section "Re-expansion of mailing lists" "SECID242"
34143 .cindex "mailing lists" "re-expansion of"
34144 Exim remembers every individual address to which a message has been delivered,
34145 in order to avoid duplication, but it normally stores only the original
34146 recipient addresses with a message. If all the deliveries to a mailing list
34147 cannot be done at the first attempt, the mailing list is re-expanded when the
34148 delivery is next tried. This means that alterations to the list are taken into
34149 account at each delivery attempt, so addresses that have been added to
34150 the list since the message arrived will therefore receive a copy of the
34151 message, even though it pre-dates their subscription.
34152
34153 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34154 on the &(redirect)& router. If this is done, any addresses generated by the
34155 router that fail to deliver at the first attempt are added to the message as
34156 &"top level"& addresses, and the parent address that generated them is marked
34157 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34158 subsequent delivery attempts. The disadvantage of this is that if any of the
34159 failing addresses are incorrect, correcting them in the file has no effect on
34160 pre-existing messages.
34161
34162 The original top-level address is remembered with each of the generated
34163 addresses, and is output in any log messages. However, any intermediate parent
34164 addresses are not recorded. This makes a difference to the log only if the
34165 &%all_parents%& selector is set, but for mailing lists there is normally only
34166 one level of expansion anyway.
34167
34168
34169
34170 .section "Closed mailing lists" "SECID243"
34171 .cindex "mailing lists" "closed"
34172 The examples so far have assumed open mailing lists, to which anybody may
34173 send mail. It is also possible to set up closed lists, where mail is accepted
34174 from specified senders only. This is done by making use of the generic
34175 &%senders%& option to restrict the router that handles the list.
34176
34177 The following example uses the same file as a list of recipients and as a list
34178 of permitted senders. It requires three routers:
34179 .code
34180 lists_request:
34181   driver = redirect
34182   domains = lists.example
34183   local_part_suffix = -request
34184   file = /usr/lists/$local_part$local_part_suffix
34185   no_more
34186
34187 lists_post:
34188   driver = redirect
34189   domains = lists.example
34190   senders = ${if exists {/usr/lists/$local_part}\
34191              {lsearch;/usr/lists/$local_part}{*}}
34192   file = /usr/lists/$local_part
34193   forbid_pipe
34194   forbid_file
34195   errors_to = $local_part-request@lists.example
34196   no_more
34197
34198 lists_closed:
34199   driver = redirect
34200   domains = lists.example
34201   allow_fail
34202   data = :fail: $local_part@lists.example is a closed mailing list
34203 .endd
34204 All three routers have the same &%domains%& setting, so for any other domains,
34205 they are all skipped. The first router runs only if the local part ends in
34206 &%-request%&. It handles messages to the list manager(s) by means of an open
34207 mailing list.
34208
34209 The second router runs only if the &%senders%& precondition is satisfied. It
34210 checks for the existence of a list that corresponds to the local part, and then
34211 checks that the sender is on the list by means of a linear search. It is
34212 necessary to check for the existence of the file before trying to search it,
34213 because otherwise Exim thinks there is a configuration error. If the file does
34214 not exist, the expansion of &%senders%& is *, which matches all senders. This
34215 means that the router runs, but because there is no list, declines, and
34216 &%no_more%& ensures that no further routers are run. The address fails with an
34217 &"unrouteable address"& error.
34218
34219 The third router runs only if the second router is skipped, which happens when
34220 a mailing list exists, but the sender is not on it. This router forcibly fails
34221 the address, giving a suitable error message.
34222
34223
34224
34225
34226 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34227 .cindex "VERP"
34228 .cindex "Variable Envelope Return Paths"
34229 .cindex "envelope sender"
34230 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34231 are a way of helping mailing list administrators discover which subscription
34232 address is the cause of a particular delivery failure. The idea is to encode
34233 the original recipient address in the outgoing envelope sender address, so that
34234 if the message is forwarded by another host and then subsequently bounces, the
34235 original recipient can be extracted from the recipient address of the bounce.
34236
34237 .oindex &%errors_to%&
34238 .oindex &%return_path%&
34239 Envelope sender addresses can be modified by Exim using two different
34240 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34241 list examples), or the &%return_path%& option on a transport. The second of
34242 these is effective only if the message is successfully delivered to another
34243 host; it is not used for errors detected on the local host (see the description
34244 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34245 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34246 .code
34247 verp_smtp:
34248   driver = smtp
34249   max_rcpt = 1
34250   return_path = \
34251     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34252       {$1-request+$local_part=$domain@your.dom.example}fail}
34253 .endd
34254 This has the effect of rewriting the return path (envelope sender) on outgoing
34255 SMTP messages, if the local part of the original return path ends in
34256 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34257 local part and domain of the recipient into the return path. Suppose, for
34258 example, that a message whose return path has been set to
34259 &'somelist-request@your.dom.example'& is sent to
34260 &'subscriber@other.dom.example'&. In the transport, the return path is
34261 rewritten as
34262 .code
34263 somelist-request+subscriber=other.dom.example@your.dom.example
34264 .endd
34265 .vindex "&$local_part$&"
34266 For this to work, you must tell Exim to send multiple copies of messages that
34267 have more than one recipient, so that each copy has just one recipient. This is
34268 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34269 might be sent to several different recipients in the same domain, in which case
34270 &$local_part$& is not available in the transport, because it is not unique.
34271
34272 Unless your host is doing nothing but mailing list deliveries, you should
34273 probably use a separate transport for the VERP deliveries, so as not to use
34274 extra resources in making one-per-recipient copies for other deliveries. This
34275 can easily be done by expanding the &%transport%& option in the router:
34276 .code
34277 dnslookup:
34278   driver = dnslookup
34279   domains = ! +local_domains
34280   transport = \
34281     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34282       {verp_smtp}{remote_smtp}}
34283   no_more
34284 .endd
34285 If you want to change the return path using &%errors_to%& in a router instead
34286 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34287 routers that handle mailing list addresses. This will ensure that all delivery
34288 errors, including those detected on the local host, are sent to the VERP
34289 address.
34290
34291 On a host that does no local deliveries and has no manual routing, only the
34292 &(dnslookup)& router needs to be changed. A special transport is not needed for
34293 SMTP deliveries. Every mailing list recipient has its own return path value,
34294 and so Exim must hand them to the transport one at a time. Here is an example
34295 of a &(dnslookup)& router that implements VERP:
34296 .code
34297 verp_dnslookup:
34298   driver = dnslookup
34299   domains = ! +local_domains
34300   transport = remote_smtp
34301   errors_to = \
34302     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34303      {$1-request+$local_part=$domain@your.dom.example}fail}
34304   no_more
34305 .endd
34306 Before you start sending out messages with VERPed return paths, you must also
34307 configure Exim to accept the bounce messages that come back to those paths.
34308 Typically this is done by setting a &%local_part_suffix%& option for a
34309 router, and using this to route the messages to wherever you want to handle
34310 them.
34311
34312 The overhead incurred in using VERP depends very much on the size of the
34313 message, the number of recipient addresses that resolve to the same remote
34314 host, and the speed of the connection over which the message is being sent. If
34315 a lot of addresses resolve to the same host and the connection is slow, sending
34316 a separate copy of the message for each address may take substantially longer
34317 than sending a single copy with many recipients (for which VERP cannot be
34318 used).
34319
34320
34321
34322
34323
34324
34325 .section "Virtual domains" "SECTvirtualdomains"
34326 .cindex "virtual domains"
34327 .cindex "domain" "virtual"
34328 The phrase &'virtual domain'& is unfortunately used with two rather different
34329 meanings:
34330
34331 .ilist
34332 A domain for which there are no real mailboxes; all valid local parts are
34333 aliases for other email addresses. Common examples are organizational
34334 top-level domains and &"vanity"& domains.
34335 .next
34336 One of a number of independent domains that are all handled by the same host,
34337 with mailboxes on that host, but where the mailbox owners do not necessarily
34338 have login accounts on that host.
34339 .endlist
34340
34341 The first usage is probably more common, and does seem more &"virtual"& than
34342 the second. This kind of domain can be handled in Exim with a straightforward
34343 aliasing router. One approach is to create a separate alias file for each
34344 virtual domain. Exim can test for the existence of the alias file to determine
34345 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34346 to a router of this form:
34347 .code
34348 virtual:
34349   driver = redirect
34350   domains = dsearch;/etc/mail/virtual
34351   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34352   no_more
34353 .endd
34354 The &%domains%& option specifies that the router is to be skipped, unless there
34355 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34356 domain that is being processed. When the router runs, it looks up the local
34357 part in the file to find a new address (or list of addresses). The &%no_more%&
34358 setting ensures that if the lookup fails (leading to &%data%& being an empty
34359 string), Exim gives up on the address without trying any subsequent routers.
34360
34361 This one router can handle all the virtual domains because the alias file names
34362 follow a fixed pattern. Permissions can be arranged so that appropriate people
34363 can edit the different alias files. A successful aliasing operation results in
34364 a new envelope recipient address, which is then routed from scratch.
34365
34366 The other kind of &"virtual"& domain can also be handled in a straightforward
34367 way. One approach is to create a file for each domain containing a list of
34368 valid local parts, and use it in a router like this:
34369 .code
34370 my_domains:
34371   driver = accept
34372   domains = dsearch;/etc/mail/domains
34373   local_parts = lsearch;/etc/mail/domains/$domain
34374   transport = my_mailboxes
34375 .endd
34376 The address is accepted if there is a file for the domain, and the local part
34377 can be found in the file. The &%domains%& option is used to check for the
34378 file's existence because &%domains%& is tested before the &%local_parts%&
34379 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34380 because that option is tested after &%local_parts%&. The transport is as
34381 follows:
34382 .code
34383 my_mailboxes:
34384   driver = appendfile
34385   file = /var/mail/$domain/$local_part
34386   user = mail
34387 .endd
34388 This uses a directory of mailboxes for each domain. The &%user%& setting is
34389 required, to specify which uid is to be used for writing to the mailboxes.
34390
34391 The configuration shown here is just one example of how you might support this
34392 requirement. There are many other ways this kind of configuration can be set
34393 up, for example, by using a database instead of separate files to hold all the
34394 information about the domains.
34395
34396
34397
34398 .section "Multiple user mailboxes" "SECTmulbox"
34399 .cindex "multiple mailboxes"
34400 .cindex "mailbox" "multiple"
34401 .cindex "local part" "prefix"
34402 .cindex "local part" "suffix"
34403 Heavy email users often want to operate with multiple mailboxes, into which
34404 incoming mail is automatically sorted. A popular way of handling this is to
34405 allow users to use multiple sender addresses, so that replies can easily be
34406 identified. Users are permitted to add prefixes or suffixes to their local
34407 parts for this purpose. The wildcard facility of the generic router options
34408 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34409 example, consider this router:
34410 .code
34411 userforward:
34412   driver = redirect
34413   check_local_user
34414   file = $home/.forward
34415   local_part_suffix = -*
34416   local_part_suffix_optional
34417   allow_filter
34418 .endd
34419 .vindex "&$local_part_suffix$&"
34420 It runs a user's &_.forward_& file for all local parts of the form
34421 &'username-*'&. Within the filter file the user can distinguish different
34422 cases by testing the variable &$local_part_suffix$&. For example:
34423 .code
34424 if $local_part_suffix contains -special then
34425 save /home/$local_part/Mail/special
34426 endif
34427 .endd
34428 If the filter file does not exist, or does not deal with such addresses, they
34429 fall through to subsequent routers, and, assuming no subsequent use of the
34430 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34431 control over which suffixes are valid.
34432
34433 Alternatively, a suffix can be used to trigger the use of a different
34434 &_.forward_& file &-- which is the way a similar facility is implemented in
34435 another MTA:
34436 .code
34437 userforward:
34438   driver = redirect
34439   check_local_user
34440   file = $home/.forward$local_part_suffix
34441   local_part_suffix = -*
34442   local_part_suffix_optional
34443   allow_filter
34444 .endd
34445 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34446 example, &_.forward-special_& is used. Once again, if the appropriate file
34447 does not exist, or does not deal with the address, it is passed on to
34448 subsequent routers, which could, if required, look for an unqualified
34449 &_.forward_& file to use as a default.
34450
34451
34452
34453 .section "Simplified vacation processing" "SECID244"
34454 .cindex "vacation processing"
34455 The traditional way of running the &'vacation'& program is for a user to set up
34456 a pipe command in a &_.forward_& file
34457 (see section &<<SECTspecitredli>>& for syntax details).
34458 This is prone to error by inexperienced users. There are two features of Exim
34459 that can be used to make this process simpler for users:
34460
34461 .ilist
34462 A local part prefix such as &"vacation-"& can be specified on a router which
34463 can cause the message to be delivered directly to the &'vacation'& program, or
34464 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34465 &_.forward_& file are then much simpler. For example:
34466 .code
34467 spqr, vacation-spqr
34468 .endd
34469 .next
34470 The &%require_files%& generic router option can be used to trigger a
34471 vacation delivery by checking for the existence of a certain file in the
34472 user's home directory. The &%unseen%& generic option should also be used, to
34473 ensure that the original delivery also proceeds. In this case, all the user has
34474 to do is to create a file called, say, &_.vacation_&, containing a vacation
34475 message.
34476 .endlist
34477
34478 Another advantage of both these methods is that they both work even when the
34479 use of arbitrary pipes by users is locked out.
34480
34481
34482
34483 .section "Taking copies of mail" "SECID245"
34484 .cindex "message" "copying every"
34485 Some installations have policies that require archive copies of all messages to
34486 be made. A single copy of each message can easily be taken by an appropriate
34487 command in a system filter, which could, for example, use a different file for
34488 each day's messages.
34489
34490 There is also a shadow transport mechanism that can be used to take copies of
34491 messages that are successfully delivered by local transports, one copy per
34492 delivery. This could be used, &'inter alia'&, to implement automatic
34493 notification of delivery by sites that insist on doing such things.
34494
34495
34496
34497 .section "Intermittently connected hosts" "SECID246"
34498 .cindex "intermittently connected hosts"
34499 It has become quite common (because it is cheaper) for hosts to connect to the
34500 Internet periodically rather than remain connected all the time. The normal
34501 arrangement is that mail for such hosts accumulates on a system that is
34502 permanently connected.
34503
34504 Exim was designed for use on permanently connected hosts, and so it is not
34505 particularly well-suited to use in an intermittently connected environment.
34506 Nevertheless there are some features that can be used.
34507
34508
34509 .section "Exim on the upstream server host" "SECID247"
34510 It is tempting to arrange for incoming mail for the intermittently connected
34511 host to remain on Exim's queue until the client connects. However, this
34512 approach does not scale very well. Two different kinds of waiting message are
34513 being mixed up in the same queue &-- those that cannot be delivered because of
34514 some temporary problem, and those that are waiting for their destination host
34515 to connect. This makes it hard to manage the queue, as well as wasting
34516 resources, because each queue runner scans the entire queue.
34517
34518 A better approach is to separate off those messages that are waiting for an
34519 intermittently connected host. This can be done by delivering these messages
34520 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34521 format, from where they are transmitted by other software when their
34522 destination connects. This makes it easy to collect all the mail for one host
34523 in a single directory, and to apply local timeout rules on a per-message basis
34524 if required.
34525
34526 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34527 you are doing this, you should configure Exim with a long retry period for the
34528 intermittent host. For example:
34529 .code
34530 cheshire.wonderland.fict.example    *   F,5d,24h
34531 .endd
34532 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34533 which messages it has queued up for that host. Once the intermittent host comes
34534 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34535 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34536 causes all the queued up messages to be delivered, often down a single SMTP
34537 connection. While the host remains connected, any new messages get delivered
34538 immediately.
34539
34540 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34541 issued with a different IP address each time it connects, Exim's retry
34542 mechanisms on the holding host get confused, because the IP address is normally
34543 used as part of the key string for holding retry information. This can be
34544 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34545 Since this has disadvantages for permanently connected hosts, it is best to
34546 arrange a separate transport for the intermittently connected ones.
34547
34548
34549
34550 .section "Exim on the intermittently connected client host" "SECID248"
34551 The value of &%smtp_accept_queue_per_connection%& should probably be
34552 increased, or even set to zero (that is, disabled) on the intermittently
34553 connected host, so that all incoming messages down a single connection get
34554 delivered immediately.
34555
34556 .cindex "SMTP" "passed connection"
34557 .cindex "SMTP" "multiple deliveries"
34558 .cindex "multiple SMTP deliveries"
34559 Mail waiting to be sent from an intermittently connected host will probably
34560 not have been routed, because without a connection DNS lookups are not
34561 possible. This means that if a normal queue run is done at connection time,
34562 each message is likely to be sent in a separate SMTP session. This can be
34563 avoided by starting the queue run with a command line option beginning with
34564 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34565 first pass, routing is done but no deliveries take place. The second pass is a
34566 normal queue run; since all the messages have been previously routed, those
34567 destined for the same host are likely to get sent as multiple deliveries in a
34568 single SMTP connection.
34569
34570
34571
34572 . ////////////////////////////////////////////////////////////////////////////
34573 . ////////////////////////////////////////////////////////////////////////////
34574
34575 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34576          "Exim as a non-queueing client"
34577 .cindex "client, non-queueing"
34578 .cindex "smart host" "suppressing queueing"
34579 On a personal computer, it is a common requirement for all
34580 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34581 configured to operate that way, for all the popular operating systems.
34582 However, there are some MUAs for Unix-like systems that cannot be so
34583 configured: they submit messages using the command line interface of
34584 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34585 messages this way.
34586
34587 If the personal computer runs continuously, there is no problem, because it can
34588 run a conventional MTA that handles delivery to the smart host, and deal with
34589 any delays via its queueing mechanism. However, if the computer does not run
34590 continuously or runs different operating systems at different times, queueing
34591 email is not desirable.
34592
34593 There is therefore a requirement for something that can provide the
34594 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34595 any queueing or retrying facilities. Furthermore, the delivery to the smart
34596 host should be synchronous, so that if it fails, the sending MUA is immediately
34597 informed. In other words, we want something that extends an MUA that submits
34598 to a local MTA via the command line so that it behaves like one that submits
34599 to a remote smart host using TCP/SMTP.
34600
34601 There are a number of applications (for example, there is one called &'ssmtp'&)
34602 that do this job. However, people have found them to be lacking in various
34603 ways. For instance, you might want to allow aliasing and forwarding to be done
34604 before sending a message to the smart host.
34605
34606 Exim already had the necessary infrastructure for doing this job. Just a few
34607 tweaks were needed to make it behave as required, though it is somewhat of an
34608 overkill to use a fully-featured MTA for this purpose.
34609
34610 .oindex "&%mua_wrapper%&"
34611 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34612 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34613 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34614 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34615 compatible router and transport configuration. Typically there will be just one
34616 router and one transport, sending everything to a smart host.
34617
34618 When run in MUA wrapping mode, the behaviour of Exim changes in the
34619 following ways:
34620
34621 .ilist
34622 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34623 In other words, the only way to submit messages is via the command line.
34624 .next
34625 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34626 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34627 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34628 does not finish until the delivery attempt is complete. If the delivery is
34629 successful, a zero return code is given.
34630 .next
34631 Address redirection is permitted, but the final routing for all addresses must
34632 be to the same remote transport, and to the same list of hosts. Furthermore,
34633 the return address (envelope sender) must be the same for all recipients, as
34634 must any added or deleted header lines. In other words, it must be possible to
34635 deliver the message in a single SMTP transaction, however many recipients there
34636 are.
34637 .next
34638 If these conditions are not met, or if routing any address results in a
34639 failure or defer status, or if Exim is unable to deliver all the recipients
34640 successfully to one of the smart hosts, delivery of the entire message fails.
34641 .next
34642 Because no queueing is allowed, all failures are treated as permanent; there
34643 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34644 smart host. Furthermore, because only a single yes/no response can be given to
34645 the caller, it is not possible to deliver to some recipients and not others. If
34646 there is an error (temporary or permanent) for any recipient, all are failed.
34647 .next
34648 If more than one smart host is listed, Exim will try another host after a
34649 connection failure or a timeout, in the normal way. However, if this kind of
34650 failure happens for all the hosts, the delivery fails.
34651 .next
34652 When delivery fails, an error message is written to the standard error stream
34653 (as well as to Exim's log), and Exim exits to the caller with a return code
34654 value 1. The message is expunged from Exim's spool files. No bounce messages
34655 are ever generated.
34656 .next
34657 No retry data is maintained, and any retry rules are ignored.
34658 .next
34659 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34660 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34661 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34662 .endlist
34663
34664 The overall effect is that Exim makes a single synchronous attempt to deliver
34665 the message, failing if there is any kind of problem. Because no local
34666 deliveries are done and no daemon can be run, Exim does not need root
34667 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34668 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34669 the advantages and disadvantages of running without root privilege.
34670
34671
34672
34673
34674 . ////////////////////////////////////////////////////////////////////////////
34675 . ////////////////////////////////////////////////////////////////////////////
34676
34677 .chapter "Log files" "CHAPlog"
34678 .scindex IIDloggen "log" "general description"
34679 .cindex "log" "types of"
34680 Exim writes three different logs, referred to as the main log, the reject log,
34681 and the panic log:
34682
34683 .ilist
34684 .cindex "main log"
34685 The main log records the arrival of each message and each delivery in a single
34686 line in each case. The format is as compact as possible, in an attempt to keep
34687 down the size of log files. Two-character flag sequences make it easy to pick
34688 out these lines. A number of other events are recorded in the main log. Some of
34689 them are optional, in which case the &%log_selector%& option controls whether
34690 they are included or not. A Perl script called &'eximstats'&, which does simple
34691 analysis of main log files, is provided in the Exim distribution (see section
34692 &<<SECTmailstat>>&).
34693 .next
34694 .cindex "reject log"
34695 The reject log records information from messages that are rejected as a result
34696 of a configuration option (that is, for policy reasons).
34697 The first line of each rejection is a copy of the line that is also written to
34698 the main log. Then, if the message's header has been read at the time the log
34699 is written, its contents are written to this log. Only the original header
34700 lines are available; header lines added by ACLs are not logged. You can use the
34701 reject log to check that your policy controls are working correctly; on a busy
34702 host this may be easier than scanning the main log for rejection messages. You
34703 can suppress the writing of the reject log by setting &%write_rejectlog%&
34704 false.
34705 .next
34706 .cindex "panic log"
34707 .cindex "system log"
34708 When certain serious errors occur, Exim writes entries to its panic log. If the
34709 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34710 are usually written to the main log as well, but can get lost amid the mass of
34711 other entries. The panic log should be empty under normal circumstances. It is
34712 therefore a good idea to check it (or to have a &'cron'& script check it)
34713 regularly, in order to become aware of any problems. When Exim cannot open its
34714 panic log, it tries as a last resort to write to the system log (syslog). This
34715 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34716 message itself is written at priority LOG_CRIT.
34717 .endlist
34718
34719 Every log line starts with a timestamp, in the format shown in the following
34720 example. Note that many of the examples shown in this chapter are line-wrapped.
34721 In the log file, this would be all on one line:
34722 .code
34723 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34724   by QUIT
34725 .endd
34726 By default, the timestamps are in the local timezone. There are two
34727 ways of changing this:
34728
34729 .ilist
34730 You can set the &%timezone%& option to a different time zone; in particular, if
34731 you set
34732 .code
34733 timezone = UTC
34734 .endd
34735 the timestamps will be in UTC (aka GMT).
34736 .next
34737 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34738 example:
34739 .code
34740 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34741 .endd
34742 .endlist
34743
34744 .cindex "log" "process ids in"
34745 .cindex "pid (process id)" "in log lines"
34746 Exim does not include its process id in log lines by default, but you can
34747 request that it does so by specifying the &`pid`& log selector (see section
34748 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34749 brackets, immediately after the time and date.
34750
34751
34752
34753
34754 .section "Where the logs are written" "SECTwhelogwri"
34755 .cindex "log" "destination"
34756 .cindex "log" "to file"
34757 .cindex "log" "to syslog"
34758 .cindex "syslog"
34759 The logs may be written to local files, or to syslog, or both. However, it
34760 should be noted that many syslog implementations use UDP as a transport, and
34761 are therefore unreliable in the sense that messages are not guaranteed to
34762 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34763 It has also been reported that on large log files (tens of megabytes) you may
34764 need to tweak syslog to prevent it syncing the file with each write &-- on
34765 Linux this has been seen to make syslog take 90% plus of CPU time.
34766
34767 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34768 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34769 configuration. This latter string is expanded, so it can contain, for example,
34770 references to the host name:
34771 .code
34772 log_file_path = /var/log/$primary_hostname/exim_%slog
34773 .endd
34774 It is generally advisable, however, to set the string in &_Local/Makefile_&
34775 rather than at run time, because then the setting is available right from the
34776 start of Exim's execution. Otherwise, if there's something it wants to log
34777 before it has read the configuration file (for example, an error in the
34778 configuration file) it will not use the path you want, and may not be able to
34779 log at all.
34780
34781 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34782 list, currently limited to at most two items. This is one option where the
34783 facility for changing a list separator may not be used. The list must always be
34784 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34785 otherwise the item must either be an absolute path, containing &`%s`& at the
34786 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34787 implying the use of a default path.
34788
34789 When Exim encounters an empty item in the list, it searches the list defined by
34790 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34791 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34792 mean &"use the path specified at build time"&. It no such item exists, log
34793 files are written in the &_log_& subdirectory of the spool directory. This is
34794 equivalent to the setting:
34795 .code
34796 log_file_path = $spool_directory/log/%slog
34797 .endd
34798 If you do not specify anything at build time or run time,
34799 or if you unset the option at run time (i.e. &`log_file_path = `&),
34800 that is where the logs are written.
34801
34802 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34803 are in use &-- see section &<<SECTdatlogfil>>& below.
34804
34805 Here are some examples of possible settings:
34806 .display
34807 &`LOG_FILE_PATH=syslog                    `& syslog only
34808 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34809 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34810 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34811 .endd
34812 If there are more than two paths in the list, the first is used and a panic
34813 error is logged.
34814
34815
34816
34817 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34818 .cindex "log" "cycling local files"
34819 .cindex "cycling logs"
34820 .cindex "&'exicyclog'&"
34821 .cindex "log" "local files; writing to"
34822 Some operating systems provide centralized and standardized methods for cycling
34823 log files. For those that do not, a utility script called &'exicyclog'& is
34824 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34825 main and reject logs each time it is called. The maximum number of old logs to
34826 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34827
34828 An Exim delivery process opens the main log when it first needs to write to it,
34829 and it keeps the file open in case subsequent entries are required &-- for
34830 example, if a number of different deliveries are being done for the same
34831 message. However, remote SMTP deliveries can take a long time, and this means
34832 that the file may be kept open long after it is renamed if &'exicyclog'& or
34833 something similar is being used to rename log files on a regular basis. To
34834 ensure that a switch of log files is noticed as soon as possible, Exim calls
34835 &[stat()]& on the main log's name before reusing an open file, and if the file
34836 does not exist, or its inode has changed, the old file is closed and Exim
34837 tries to open the main log from scratch. Thus, an old log file may remain open
34838 for quite some time, but no Exim processes should write to it once it has been
34839 renamed.
34840
34841
34842
34843 .section "Datestamped log files" "SECTdatlogfil"
34844 .cindex "log" "datestamped files"
34845 Instead of cycling the main and reject log files by renaming them
34846 periodically, some sites like to use files whose names contain a datestamp,
34847 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34848 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34849 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34850 point where the datestamp is required. For example:
34851 .code
34852 log_file_path = /var/spool/exim/log/%slog-%D
34853 log_file_path = /var/log/exim-%s-%D.log
34854 log_file_path = /var/spool/exim/log/%D-%slog
34855 log_file_path = /var/log/exim/%s.%M
34856 .endd
34857 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34858 examples of names generated by the above examples:
34859 .code
34860 /var/spool/exim/log/mainlog-20021225
34861 /var/log/exim-reject-20021225.log
34862 /var/spool/exim/log/20021225-mainlog
34863 /var/log/exim/main.200212
34864 .endd
34865 When this form of log file is specified, Exim automatically switches to new
34866 files at midnight. It does not make any attempt to compress old logs; you
34867 will need to write your own script if you require this. You should not
34868 run &'exicyclog'& with this form of logging.
34869
34870 The location of the panic log is also determined by &%log_file_path%&, but it
34871 is not datestamped, because rotation of the panic log does not make sense.
34872 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34873 the string. In addition, if it immediately follows a slash, a following
34874 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34875 character is removed. Thus, the four examples above would give these panic
34876 log names:
34877 .code
34878 /var/spool/exim/log/paniclog
34879 /var/log/exim-panic.log
34880 /var/spool/exim/log/paniclog
34881 /var/log/exim/panic
34882 .endd
34883
34884
34885 .section "Logging to syslog" "SECID249"
34886 .cindex "log" "syslog; writing to"
34887 The use of syslog does not change what Exim logs or the format of its messages,
34888 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34889 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34890 that, the same strings are written to syslog as to log files. The syslog
34891 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34892 by default, but you can change these by setting the &%syslog_facility%& and
34893 &%syslog_processname%& options, respectively. If Exim was compiled with
34894 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34895 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34896 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34897 the time and host name to each line.
34898 The three log streams are mapped onto syslog priorities as follows:
34899
34900 .ilist
34901 &'mainlog'& is mapped to LOG_INFO
34902 .next
34903 &'rejectlog'& is mapped to LOG_NOTICE
34904 .next
34905 &'paniclog'& is mapped to LOG_ALERT
34906 .endlist
34907
34908 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34909 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34910 these are routed by syslog to the same place. You can suppress this duplication
34911 by setting &%syslog_duplication%& false.
34912
34913 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34914 entries contain multiple lines when headers are included. To cope with both
34915 these cases, entries written to syslog are split into separate &[syslog()]&
34916 calls at each internal newline, and also after a maximum of
34917 870 data characters. (This allows for a total syslog line length of 1024, when
34918 additions such as timestamps are added.) If you are running a syslog
34919 replacement that can handle lines longer than the 1024 characters allowed by
34920 RFC 3164, you should set
34921 .code
34922 SYSLOG_LONG_LINES=yes
34923 .endd
34924 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34925 lines, but it still splits at internal newlines in &'reject'& log entries.
34926
34927 To make it easy to re-assemble split lines later, each component of a split
34928 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34929 where <&'n'&> is the component number and <&'m'&> is the total number of
34930 components in the entry. The / delimiter is used when the line was split
34931 because it was too long; if it was split because of an internal newline, the \
34932 delimiter is used. For example, supposing the length limit to be 50 instead of
34933 870, the following would be the result of a typical rejection message to
34934 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34935 name, and pid as added by syslog:
34936 .code
34937 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
34938 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
34939 [3/5]  when scanning for sender: missing or malformed lo
34940 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
34941 [5/5] mple>)
34942 .endd
34943 The same error might cause the following lines to be written to &"rejectlog"&
34944 (LOG_NOTICE):
34945 .code
34946 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
34947 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
34948 [3/18] er when scanning for sender: missing or malformed
34949 [4/18]  local part in "<>" (envelope sender is <ph10@cam
34950 [5\18] .example>)
34951 [6\18] Recipients: ph10@some.domain.cam.example
34952 [7\18] P Received: from [127.0.0.1] (ident=ph10)
34953 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
34954 [9\18]        id 16RdAL-0006pc-00
34955 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
34956 [11\18] 09:43 +0100
34957 [12\18] F From: <>
34958 [13\18]   Subject: this is a test header
34959 [18\18]   X-something: this is another header
34960 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
34961 [16\18] le>
34962 [17\18] B Bcc:
34963 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
34964 .endd
34965 Log lines that are neither too long nor contain newlines are written to syslog
34966 without modification.
34967
34968 If only syslog is being used, the Exim monitor is unable to provide a log tail
34969 display, unless syslog is routing &'mainlog'& to a file on the local host and
34970 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
34971 where it is.
34972
34973
34974
34975 .section "Log line flags" "SECID250"
34976 One line is written to the main log for each message received, and for each
34977 successful, unsuccessful, and delayed delivery. These lines can readily be
34978 picked out by the distinctive two-character flags that immediately follow the
34979 timestamp. The flags are:
34980 .display
34981 &`<=`&     message arrival
34982 &`=>`&     normal message delivery
34983 &`->`&     additional address in same delivery
34984 &`>>`&     cutthrough message delivery
34985 &`*>`&     delivery suppressed by &%-N%&
34986 &`**`&     delivery failed; address bounced
34987 &`==`&     delivery deferred; temporary problem
34988 .endd
34989
34990
34991 .section "Logging message reception" "SECID251"
34992 .cindex "log" "reception line"
34993 The format of the single-line entry in the main log that is written for every
34994 message received is shown in the basic example below, which is split over
34995 several lines in order to fit it on the page:
34996 .code
34997 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
34998   H=mailer.fict.example [192.168.123.123] U=exim
34999   P=smtp S=5678 id=<incoming message id>
35000 .endd
35001 The address immediately following &"<="& is the envelope sender address. A
35002 bounce message is shown with the sender address &"<>"&, and if it is locally
35003 generated, this is followed by an item of the form
35004 .code
35005 R=<message id>
35006 .endd
35007 which is a reference to the message that caused the bounce to be sent.
35008
35009 .cindex "HELO"
35010 .cindex "EHLO"
35011 For messages from other hosts, the H and U fields identify the remote host and
35012 record the RFC 1413 identity of the user that sent the message, if one was
35013 received. The number given in square brackets is the IP address of the sending
35014 host. If there is a single, unparenthesized  host name in the H field, as
35015 above, it has been verified to correspond to the IP address (see the
35016 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35017 by the remote host in the SMTP HELO or EHLO command, and has not been
35018 verified. If verification yields a different name to that given for HELO or
35019 EHLO, the verified name appears first, followed by the HELO or EHLO
35020 name in parentheses.
35021
35022 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35023 without brackets, in the HELO or EHLO command, leading to entries in
35024 the log containing text like these examples:
35025 .code
35026 H=(10.21.32.43) [192.168.8.34]
35027 H=([10.21.32.43]) [192.168.8.34]
35028 .endd
35029 This can be confusing. Only the final address in square brackets can be relied
35030 on.
35031
35032 For locally generated messages (that is, messages not received over TCP/IP),
35033 the H field is omitted, and the U field contains the login name of the caller
35034 of Exim.
35035
35036 .cindex "authentication" "logging"
35037 .cindex "AUTH" "logging"
35038 For all messages, the P field specifies the protocol used to receive the
35039 message. This is the value that is stored in &$received_protocol$&. In the case
35040 of incoming SMTP messages, the value indicates whether or not any SMTP
35041 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35042 session was encrypted, there is an additional X field that records the cipher
35043 suite that was used.
35044
35045 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35046 hosts that have authenticated themselves using the SMTP AUTH command. The first
35047 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35048 there is an additional item A= followed by the name of the authenticator that
35049 was used. If an authenticated identification was set up by the authenticator's
35050 &%server_set_id%& option, this is logged too, separated by a colon from the
35051 authenticator name.
35052
35053 .cindex "size" "of message"
35054 The id field records the existing message id, if present. The size of the
35055 received message is given by the S field. When the message is delivered,
35056 headers may be removed or added, so that the size of delivered copies of the
35057 message may not correspond with this value (and indeed may be different to each
35058 other).
35059
35060 The &%log_selector%& option can be used to request the logging of additional
35061 data when a message is received. See section &<<SECTlogselector>>& below.
35062
35063
35064
35065 .section "Logging deliveries" "SECID252"
35066 .cindex "log" "delivery line"
35067 The format of the single-line entry in the main log that is written for every
35068 delivery is shown in one of the examples below, for local and remote
35069 deliveries, respectively. Each example has been split into two lines in order
35070 to fit it on the page:
35071 .code
35072 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35073   <marv@hitch.fict.example> R=localuser T=local_delivery
35074 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35075   monk@holistic.fict.example R=dnslookup T=remote_smtp
35076   H=holistic.fict.example [192.168.234.234]
35077 .endd
35078 For ordinary local deliveries, the original address is given in angle brackets
35079 after the final delivery address, which might be a pipe or a file. If
35080 intermediate address(es) exist between the original and the final address, the
35081 last of these is given in parentheses after the final address. The R and T
35082 fields record the router and transport that were used to process the address.
35083
35084 If SMTP AUTH was used for the delivery there is an additional item A=
35085 followed by the name of the authenticator that was used.
35086 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35087 option, this is logged too, separated by a colon from the authenticator name.
35088
35089 If a shadow transport was run after a successful local delivery, the log line
35090 for the successful delivery has an item added on the end, of the form
35091 .display
35092 &`ST=<`&&'shadow transport name'&&`>`&
35093 .endd
35094 If the shadow transport did not succeed, the error message is put in
35095 parentheses afterwards.
35096
35097 .cindex "asterisk" "after IP address"
35098 When more than one address is included in a single delivery (for example, two
35099 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35100 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35101 down a single SMTP connection, an asterisk follows the IP address in the log
35102 lines for the second and subsequent messages.
35103
35104 .cindex "delivery" "cutthrough; logging"
35105 .cindex "cutthrough" "logging"
35106 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35107 line precedes the reception line, since cutthrough waits for a possible
35108 rejection from the destination in case it can reject the sourced item.
35109
35110 The generation of a reply message by a filter file gets logged as a
35111 &"delivery"& to the addressee, preceded by &">"&.
35112
35113 The &%log_selector%& option can be used to request the logging of additional
35114 data when a message is delivered. See section &<<SECTlogselector>>& below.
35115
35116
35117 .section "Discarded deliveries" "SECID253"
35118 .cindex "discarded messages"
35119 .cindex "message" "discarded"
35120 .cindex "delivery" "discarded; logging"
35121 When a message is discarded as a result of the command &"seen finish"& being
35122 obeyed in a filter file which generates no deliveries, a log entry of the form
35123 .code
35124 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35125   <low.club@bridge.example> R=userforward
35126 .endd
35127 is written, to record why no deliveries are logged. When a message is discarded
35128 because it is aliased to &":blackhole:"& the log line is like this:
35129 .code
35130 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35131   <hole@nowhere.example> R=blackhole_router
35132 .endd
35133
35134
35135 .section "Deferred deliveries" "SECID254"
35136 When a delivery is deferred, a line of the following form is logged:
35137 .code
35138 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35139   R=dnslookup T=smtp defer (146): Connection refused
35140 .endd
35141 In the case of remote deliveries, the error is the one that was given for the
35142 last IP address that was tried. Details of individual SMTP failures are also
35143 written to the log, so the above line would be preceded by something like
35144 .code
35145 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35146   mail1.endrest.example [192.168.239.239]: Connection refused
35147 .endd
35148 When a deferred address is skipped because its retry time has not been reached,
35149 a message is written to the log, but this can be suppressed by setting an
35150 appropriate value in &%log_selector%&.
35151
35152
35153
35154 .section "Delivery failures" "SECID255"
35155 .cindex "delivery" "failure; logging"
35156 If a delivery fails because an address cannot be routed, a line of the
35157 following form is logged:
35158 .code
35159 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35160   <jim@trek99.example>: unknown mail domain
35161 .endd
35162 If a delivery fails at transport time, the router and transport are shown, and
35163 the response from the remote host is included, as in this example:
35164 .code
35165 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35166   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35167   after pipelined RCPT TO:<ace400@pb.example>: host
35168   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35169   <ace400@pb.example>...Addressee unknown
35170 .endd
35171 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35172 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35173 disabling PIPELINING. The log lines for all forms of delivery failure are
35174 flagged with &`**`&.
35175
35176
35177
35178 .section "Fake deliveries" "SECID256"
35179 .cindex "delivery" "fake; logging"
35180 If a delivery does not actually take place because the &%-N%& option has been
35181 used to suppress it, a normal delivery line is written to the log, except that
35182 &"=>"& is replaced by &"*>"&.
35183
35184
35185
35186 .section "Completion" "SECID257"
35187 A line of the form
35188 .code
35189 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35190 .endd
35191 is written to the main log when a message is about to be removed from the spool
35192 at the end of its processing.
35193
35194
35195
35196
35197 .section "Summary of Fields in Log Lines" "SECID258"
35198 .cindex "log" "summary of fields"
35199 A summary of the field identifiers that are used in log lines is shown in
35200 the following table:
35201 .display
35202 &`A   `&        authenticator name (and optional id and sender)
35203 &`C   `&        SMTP confirmation on delivery
35204 &`    `&        command list for &"no mail in SMTP session"&
35205 &`CV  `&        certificate verification status
35206 &`D   `&        duration of &"no mail in SMTP session"&
35207 &`DN  `&        distinguished name from peer certificate
35208 &`DT  `&        on &`=>`& lines: time taken for a delivery
35209 &`F   `&        sender address (on delivery lines)
35210 &`H   `&        host name and IP address
35211 &`I   `&        local interface used
35212 &`id  `&        message id for incoming message
35213 &`P   `&        on &`<=`& lines: protocol used
35214 &`    `&        on &`=>`& and &`**`& lines: return path
35215 &`QT  `&        on &`=>`& lines: time spent on queue so far
35216 &`    `&        on &"Completed"& lines: time spent on queue
35217 &`R   `&        on &`<=`& lines: reference for local bounce
35218 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35219 &`S   `&        size of message
35220 &`SNI `&        server name indication from TLS client hello
35221 &`ST  `&        shadow transport name
35222 &`T   `&        on &`<=`& lines: message subject (topic)
35223 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35224 &`U   `&        local user or RFC 1413 identity
35225 &`X   `&        TLS cipher suite
35226 .endd
35227
35228
35229 .section "Other log entries" "SECID259"
35230 Various other types of log entry are written from time to time. Most should be
35231 self-explanatory. Among the more common are:
35232
35233 .ilist
35234 .cindex "retry" "time not reached"
35235 &'retry time not reached'&&~&~An address previously suffered a temporary error
35236 during routing or local delivery, and the time to retry has not yet arrived.
35237 This message is not written to an individual message log file unless it happens
35238 during the first delivery attempt.
35239 .next
35240 &'retry time not reached for any host'&&~&~An address previously suffered
35241 temporary errors during remote delivery, and the retry time has not yet arrived
35242 for any of the hosts to which it is routed.
35243 .next
35244 .cindex "spool directory" "file locked"
35245 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35246 some other Exim process is already working on the message. This can be quite
35247 common if queue running processes are started at frequent intervals. The
35248 &'exiwhat'& utility script can be used to find out what Exim processes are
35249 doing.
35250 .next
35251 .cindex "error" "ignored"
35252 &'error ignored'&&~&~There are several circumstances that give rise to this
35253 message:
35254 .olist
35255 Exim failed to deliver a bounce message whose age was greater than
35256 &%ignore_bounce_errors_after%&. The bounce was discarded.
35257 .next
35258 A filter file set up a delivery using the &"noerror"& option, and the delivery
35259 failed. The delivery was discarded.
35260 .next
35261 A delivery set up by a router configured with
35262 . ==== As this is a nested list, any displays it contains must be indented
35263 . ==== as otherwise they are too far to the left.
35264 .code
35265     errors_to = <>
35266 .endd
35267 failed. The delivery was discarded.
35268 .endlist olist
35269 .endlist ilist
35270
35271
35272
35273
35274
35275 .section "Reducing or increasing what is logged" "SECTlogselector"
35276 .cindex "log" "selectors"
35277 By setting the &%log_selector%& global option, you can disable some of Exim's
35278 default logging, or you can request additional logging. The value of
35279 &%log_selector%& is made up of names preceded by plus or minus characters. For
35280 example:
35281 .code
35282 log_selector = +arguments -retry_defer
35283 .endd
35284 The list of optional log items is in the following table, with the default
35285 selection marked by asterisks:
35286 .display
35287 &` 8bitmime                   `&  received 8BITMIME status
35288 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35289 &` address_rewrite            `&  address rewriting
35290 &` all_parents                `&  all parents in => lines
35291 &` arguments                  `&  command line arguments
35292 &`*connection_reject          `&  connection rejections
35293 &`*delay_delivery             `&  immediate delivery delayed
35294 &` deliver_time               `&  time taken to perform delivery
35295 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35296 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35297 &`*etrn                       `&  ETRN commands
35298 &`*host_lookup_failed         `&  as it says
35299 &` ident_timeout              `&  timeout for ident connection
35300 &` incoming_interface         `&  local interface on <= and => lines
35301 &` incoming_port              `&  remote port on <= lines
35302 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35303 &` outgoing_port              `&  add remote port to => lines
35304 &`*queue_run                  `&  start and end queue runs
35305 &` queue_time                 `&  time on queue for one recipient
35306 &` queue_time_overall         `&  time on queue for whole message
35307 &` pid                        `&  Exim process id
35308 &` received_recipients        `&  recipients on <= lines
35309 &` received_sender            `&  sender on <= lines
35310 &`*rejected_header            `&  header contents on reject log
35311 &`*retry_defer                `&  &"retry time not reached"&
35312 &` return_path_on_delivery    `&  put return path on => and ** lines
35313 &` sender_on_delivery         `&  add sender to => lines
35314 &`*sender_verify_fail         `&  sender verification failures
35315 &`*size_reject                `&  rejection because too big
35316 &`*skip_delivery              `&  delivery skipped in a queue run
35317 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35318 &` smtp_connection            `&  SMTP connections
35319 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35320 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35321 &` smtp_no_mail               `&  session with no MAIL commands
35322 &` smtp_protocol_error        `&  SMTP protocol errors
35323 &` smtp_syntax_error          `&  SMTP syntax errors
35324 &` subject                    `&  contents of &'Subject:'& on <= lines
35325 .new
35326 &`*tls_certificate_verified   `&  certificate verification status
35327 .wen
35328 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35329 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35330 &` tls_sni                    `&  TLS SNI on <= lines
35331 &` unknown_in_list            `&  DNS lookup failed in list match
35332
35333 &` all                        `&  all of the above
35334 .endd
35335 More details on each of these items follows:
35336
35337 .ilist
35338 .cindex "8BITMIME"
35339 .cindex "log" "8BITMIME"
35340 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35341 which may help in tracking down interoperability issues with ancient MTAs
35342 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35343 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35344 &`7BIT`& and &`8BITMIME`& respectively.
35345 .next
35346 .cindex "&%warn%& ACL verb" "log when skipping"
35347 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35348 its conditions cannot be evaluated, a log line to this effect is written if
35349 this log selector is set.
35350 .next
35351 .cindex "log" "rewriting"
35352 .cindex "rewriting" "logging"
35353 &%address_rewrite%&: This applies both to global rewrites and per-transport
35354 rewrites, but not to rewrites in filters run as an unprivileged user (because
35355 such users cannot access the log).
35356 .next
35357 .cindex "log" "full parentage"
35358 &%all_parents%&: Normally only the original and final addresses are logged on
35359 delivery lines; with this selector, intermediate parents are given in
35360 parentheses between them.
35361 .next
35362 .cindex "log" "Exim arguments"
35363 .cindex "Exim arguments, logging"
35364 &%arguments%&: This causes Exim to write the arguments with which it was called
35365 to the main log, preceded by the current working directory. This is a debugging
35366 feature, added to make it easier to find out how certain MUAs call
35367 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35368 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35369 that are empty or that contain white space are quoted. Non-printing characters
35370 are shown as escape sequences. This facility cannot log unrecognized arguments,
35371 because the arguments are checked before the configuration file is read. The
35372 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35373 between the caller and Exim.
35374 .next
35375 .cindex "log" "connection rejections"
35376 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35377 connection is rejected, for whatever reason.
35378 .next
35379 .cindex "log" "delayed delivery"
35380 .cindex "delayed delivery, logging"
35381 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35382 started for an incoming message because the load is too high or too many
35383 messages were received on one connection. Logging does not occur if no delivery
35384 process is started because &%queue_only%& is set or &%-odq%& was used.
35385 .next
35386 .cindex "log" "delivery duration"
35387 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35388 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35389 .next
35390 .cindex "log" "message size on delivery"
35391 .cindex "size" "of message"
35392 &%delivery_size%&: For each delivery, the size of message delivered is added to
35393 the &"=>"& line, tagged with S=.
35394 .next
35395 .cindex "log" "dnslist defer"
35396 .cindex "DNS list" "logging defer"
35397 .cindex "black list (DNS)"
35398 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35399 DNS black list suffers a temporary error.
35400 .next
35401 .cindex "log" "ETRN commands"
35402 .cindex "ETRN" "logging"
35403 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35404 is run to determine whether or not it is actually accepted. An invalid ETRN
35405 command, or one received within a message transaction is not logged by this
35406 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35407 .next
35408 .cindex "log" "host lookup failure"
35409 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35410 any addresses, or when a lookup of an IP address fails to find a host name, a
35411 log line is written. This logging does not apply to direct DNS lookups when
35412 routing email addresses, but it does apply to &"byname"& lookups.
35413 .next
35414 .cindex "log" "ident timeout"
35415 .cindex "RFC 1413" "logging timeout"
35416 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35417 client's ident port times out.
35418 .next
35419 .cindex "log" "incoming interface"
35420 .cindex "log" "local interface"
35421 .cindex "log" "local address and port"
35422 .cindex "TCP/IP" "logging local address and port"
35423 .cindex "interface" "logging"
35424 &%incoming_interface%&: The interface on which a message was received is added
35425 to the &"<="& line as an IP address in square brackets, tagged by I= and
35426 followed by a colon and the port number. The local interface and port are also
35427 added to other SMTP log lines, for example &"SMTP connection from"& and to
35428 rejection lines
35429 and (despite the name) the local interface is added to &"=>"& lines..
35430 .next
35431 .cindex "log" "incoming remote port"
35432 .cindex "port" "logging remote"
35433 .cindex "TCP/IP" "logging incoming remote port"
35434 .vindex "&$sender_fullhost$&"
35435 .vindex "&$sender_rcvhost$&"
35436 &%incoming_port%&: The remote port number from which a message was received is
35437 added to log entries and &'Received:'& header lines, following the IP address
35438 in square brackets, and separated from it by a colon. This is implemented by
35439 changing the value that is put in the &$sender_fullhost$& and
35440 &$sender_rcvhost$& variables. Recording the remote port number has become more
35441 important with the widening use of NAT (see RFC 2505).
35442 .next
35443 .cindex "log" "dropped connection"
35444 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35445 connection is unexpectedly dropped.
35446 .next
35447 .cindex "log" "outgoing remote port"
35448 .cindex "port" "logging outgoint remote"
35449 .cindex "TCP/IP" "logging ougtoing remote port"
35450 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35451 containing => tags) following the IP address. This option is not included in
35452 the default setting, because for most ordinary configurations, the remote port
35453 number is always 25 (the SMTP port).
35454 .next
35455 .cindex "log" "process ids in"
35456 .cindex "pid (process id)" "in log lines"
35457 &%pid%&: The current process id is added to every log line, in square brackets,
35458 immediately after the time and date.
35459 .next
35460 .cindex "log" "queue run"
35461 .cindex "queue runner" "logging"
35462 &%queue_run%&: The start and end of every queue run are logged.
35463 .next
35464 .cindex "log" "queue time"
35465 &%queue_time%&: The amount of time the message has been in the queue on the
35466 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35467 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35468 includes reception time as well as the delivery time for the current address.
35469 This means that it may be longer than the difference between the arrival and
35470 delivery log line times, because the arrival log line is not written until the
35471 message has been successfully received.
35472 .next
35473 &%queue_time_overall%&: The amount of time the message has been in the queue on
35474 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35475 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35476 message, so it includes reception time as well as the total delivery time.
35477 .next
35478 .cindex "log" "recipients"
35479 &%received_recipients%&: The recipients of a message are listed in the main log
35480 as soon as the message is received. The list appears at the end of the log line
35481 that is written when a message is received, preceded by the word &"for"&. The
35482 addresses are listed after they have been qualified, but before any rewriting
35483 has taken place.
35484 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35485 in the list.
35486 .next
35487 .cindex "log" "sender reception"
35488 &%received_sender%&: The unrewritten original sender of a message is added to
35489 the end of the log line that records the message's arrival, after the word
35490 &"from"& (before the recipients if &%received_recipients%& is also set).
35491 .next
35492 .cindex "log" "header lines for rejection"
35493 &%rejected_header%&: If a message's header has been received at the time a
35494 rejection is written to the reject log, the complete header is added to the
35495 log. Header logging can be turned off individually for messages that are
35496 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35497 .next
35498 .cindex "log" "retry defer"
35499 &%retry_defer%&: A log line is written if a delivery is deferred because a
35500 retry time has not yet been reached. However, this &"retry time not reached"&
35501 message is always omitted from individual message logs after the first delivery
35502 attempt.
35503 .next
35504 .cindex "log" "return path"
35505 &%return_path_on_delivery%&: The return path that is being transmitted with
35506 the message is included in delivery and bounce lines, using the tag P=.
35507 This is omitted if no delivery actually happens, for example, if routing fails,
35508 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35509 .next
35510 .cindex "log" "sender on delivery"
35511 &%sender_on_delivery%&: The message's sender address is added to every delivery
35512 and bounce line, tagged by F= (for &"from"&).
35513 This is the original sender that was received with the message; it is not
35514 necessarily the same as the outgoing return path.
35515 .next
35516 .cindex "log" "sender verify failure"
35517 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35518 gives details of a sender verification failure is not written. Log lines for
35519 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35520 detail is lost.
35521 .next
35522 .cindex "log" "size rejection"
35523 &%size_reject%&: A log line is written whenever a message is rejected because
35524 it is too big.
35525 .next
35526 .cindex "log" "frozen messages; skipped"
35527 .cindex "frozen messages" "logging skipping"
35528 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35529 queue run because it is frozen or because another process is already delivering
35530 it.
35531 .cindex "&""spool file is locked""&"
35532 The message that is written is &"spool file is locked"&.
35533 .next
35534 .cindex "log" "smtp confirmation"
35535 .cindex "SMTP" "logging confirmation"
35536 .cindex "LMTP" "logging confirmation"
35537 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35538 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35539 A number of MTAs (including Exim) return an identifying string in this
35540 response.
35541 .next
35542 .cindex "log" "SMTP connections"
35543 .cindex "SMTP" "logging connections"
35544 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35545 established or closed, unless the connection is from a host that matches
35546 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35547 only when the closure is unexpected.) This applies to connections from local
35548 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35549 dropped in the middle of a message, a log line is always written, whether or
35550 not this selector is set, but otherwise nothing is written at the start and end
35551 of connections unless this selector is enabled.
35552
35553 For TCP/IP connections to an Exim daemon, the current number of connections is
35554 included in the log message for each new connection, but note that the count is
35555 reset if the daemon is restarted.
35556 Also, because connections are closed (and the closure is logged) in
35557 subprocesses, the count may not include connections that have been closed but
35558 whose termination the daemon has not yet noticed. Thus, while it is possible to
35559 match up the opening and closing of connections in the log, the value of the
35560 logged counts may not be entirely accurate.
35561 .next
35562 .cindex "log" "SMTP transaction; incomplete"
35563 .cindex "SMTP" "logging incomplete transactions"
35564 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35565 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35566 and the message sender plus any accepted recipients are included in the log
35567 line. This can provide evidence of dictionary attacks.
35568 .next
35569 .cindex "log" "non-MAIL SMTP sessions"
35570 .cindex "MAIL" "logging session without"
35571 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35572 connection terminates without having issued a MAIL command. This includes both
35573 the case when the connection is dropped, and the case when QUIT is used. It
35574 does not include cases where the connection is rejected right at the start (by
35575 an ACL, or because there are too many connections, or whatever). These cases
35576 already have their own log lines.
35577
35578 The log line that is written contains the identity of the client in the usual
35579 way, followed by D= and a time, which records the duration of the connection.
35580 If the connection was authenticated, this fact is logged exactly as it is for
35581 an incoming message, with an A= item. If the connection was encrypted, CV=,
35582 DN=, and X= items may appear as they do for an incoming message, controlled by
35583 the same logging options.
35584
35585 Finally, if any SMTP commands were issued during the connection, a C= item
35586 is added to the line, listing the commands that were used. For example,
35587 .code
35588 C=EHLO,QUIT
35589 .endd
35590 shows that the client issued QUIT straight after EHLO. If there were fewer
35591 than 20 commands, they are all listed. If there were more than 20 commands,
35592 the last 20 are listed, preceded by &"..."&. However, with the default
35593 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35594 have been aborted before 20 non-mail commands are processed.
35595 .next
35596 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35597 colon-separated, is appended to the A= item for a message arrival or delivery
35598 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35599 was accepted or used.
35600 .next
35601 .cindex "log" "SMTP protocol error"
35602 .cindex "SMTP" "logging protocol error"
35603 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35604 encountered. Exim does not have perfect detection of all protocol errors
35605 because of transmission delays and the use of pipelining. If PIPELINING has
35606 been advertised to a client, an Exim server assumes that the client will use
35607 it, and therefore it does not count &"expected"& errors (for example, RCPT
35608 received after rejecting MAIL) as protocol errors.
35609 .next
35610 .cindex "SMTP" "logging syntax errors"
35611 .cindex "SMTP" "syntax errors; logging"
35612 .cindex "SMTP" "unknown command; logging"
35613 .cindex "log" "unknown SMTP command"
35614 .cindex "log" "SMTP syntax error"
35615 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35616 encountered. An unrecognized command is treated as a syntax error. For an
35617 external connection, the host identity is given; for an internal connection
35618 using &%-bs%& the sender identification (normally the calling user) is given.
35619 .next
35620 .cindex "log" "subject"
35621 .cindex "subject, logging"
35622 &%subject%&: The subject of the message is added to the arrival log line,
35623 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35624 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35625 specifies whether characters with values greater than 127 should be logged
35626 unchanged, or whether they should be rendered as escape sequences.
35627 .next
35628 .cindex "log" "certificate verification"
35629 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35630 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35631 verified, and &`CV=no`& if not.
35632 .next
35633 .cindex "log" "TLS cipher"
35634 .cindex "TLS" "logging cipher"
35635 &%tls_cipher%&: When a message is sent or received over an encrypted
35636 connection, the cipher suite used is added to the log line, preceded by X=.
35637 .next
35638 .cindex "log" "TLS peer DN"
35639 .cindex "TLS" "logging peer DN"
35640 &%tls_peerdn%&: When a message is sent or received over an encrypted
35641 connection, and a certificate is supplied by the remote host, the peer DN is
35642 added to the log line, preceded by DN=.
35643 .next
35644 .cindex "log" "TLS SNI"
35645 .cindex "TLS" "logging SNI"
35646 &%tls_sni%&: When a message is received over an encrypted connection, and
35647 the remote host provided the Server Name Indication extension, the SNI is
35648 added to the log line, preceded by SNI=.
35649 .next
35650 .cindex "log" "DNS failure in list"
35651 &%unknown_in_list%&: This setting causes a log entry to be written when the
35652 result of a list match is failure because a DNS lookup failed.
35653 .endlist
35654
35655
35656 .section "Message log" "SECID260"
35657 .cindex "message" "log file for"
35658 .cindex "log" "message log; description of"
35659 .cindex "&_msglog_& directory"
35660 .oindex "&%preserve_message_logs%&"
35661 In addition to the general log files, Exim writes a log file for each message
35662 that it handles. The names of these per-message logs are the message ids, and
35663 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35664 message log contains copies of the log lines that apply to the message. This
35665 makes it easier to inspect the status of an individual message without having
35666 to search the main log. A message log is deleted when processing of the message
35667 is complete, unless &%preserve_message_logs%& is set, but this should be used
35668 only with great care because they can fill up your disk very quickly.
35669
35670 On a heavily loaded system, it may be desirable to disable the use of
35671 per-message logs, in order to reduce disk I/O. This can be done by setting the
35672 &%message_logs%& option false.
35673 .ecindex IIDloggen
35674
35675
35676
35677
35678 . ////////////////////////////////////////////////////////////////////////////
35679 . ////////////////////////////////////////////////////////////////////////////
35680
35681 .chapter "Exim utilities" "CHAPutils"
35682 .scindex IIDutils "utilities"
35683 A number of utility scripts and programs are supplied with Exim and are
35684 described in this chapter. There is also the Exim Monitor, which is covered in
35685 the next chapter. The utilities described here are:
35686
35687 .itable none 0 0 3  7* left  15* left  40* left
35688 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35689   "list what Exim processes are doing"
35690 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35691 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35692 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35693 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35694                                                 various criteria"
35695 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35696 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35697   "extract statistics from the log"
35698 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35699   "check address acceptance from given IP"
35700 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35701 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35702 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35703 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35704 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35705 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35706 .endtable
35707
35708 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35709 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35710 &url(http://duncanthrax.net/exilog/) for details.
35711
35712
35713
35714
35715 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35716 .cindex "&'exiwhat'&"
35717 .cindex "process, querying"
35718 .cindex "SIGUSR1"
35719 On operating systems that can restart a system call after receiving a signal
35720 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35721 a line describing what it is doing to the file &_exim-process.info_& in the
35722 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35723 processes it can find, having first emptied the file. It then waits for one
35724 second to allow the Exim processes to react before displaying the results. In
35725 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35726 send the signal to the Exim processes, so it is normally run as root.
35727
35728 &*Warning*&: This is not an efficient process. It is intended for occasional
35729 use by system administrators. It is not sensible, for example, to set up a
35730 script that sends SIGUSR1 signals to Exim processes at short intervals.
35731
35732
35733 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35734 varies in different operating systems. Not only are different options used,
35735 but the format of the output is different. For this reason, there are some
35736 system configuration options that configure exactly how &'exiwhat'& works. If
35737 it doesn't seem to be working for you, check the following compile-time
35738 options:
35739 .display
35740 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35741 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35742 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35743 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35744 .endd
35745 An example of typical output from &'exiwhat'& is
35746 .code
35747 164 daemon: -q1h, listening on port 25
35748 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35749 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35750   [10.19.42.42] (editor@ref.example)
35751 10592 handling incoming call from [192.168.243.242]
35752 10628 accepting a local non-SMTP message
35753 .endd
35754 The first number in the output line is the process number. The third line has
35755 been split here, in order to fit it on the page.
35756
35757
35758
35759 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35760 .cindex "&'exiqgrep'&"
35761 .cindex "queue" "grepping"
35762 This utility is a Perl script contributed by Matt Hubbard. It runs
35763 .code
35764 exim -bpu
35765 .endd
35766 or (in case &*-a*& switch is specified)
35767 .code
35768 exim -bp
35769 .endd
35770 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35771 contain alternate exim configuration the queue management might be using.
35772
35773 to obtain a queue listing, and then greps the output to select messages 
35774 that match given criteria. The following selection options are available:
35775
35776 .vlist
35777 .vitem &*-f*&&~<&'regex'&>
35778 Match the sender address using a case-insensitive search. The field that is
35779 tested is enclosed in angle brackets, so you can test for bounce messages with
35780 .code
35781 exiqgrep -f '^<>$'
35782 .endd
35783 .vitem &*-r*&&~<&'regex'&>
35784 Match a recipient address using a case-insensitve search. The field that is
35785 tested is not enclosed in angle brackets.
35786
35787 .vitem &*-s*&&~<&'regex'&>
35788 Match against the size field.
35789
35790 .vitem &*-y*&&~<&'seconds'&>
35791 Match messages that are younger than the given time.
35792
35793 .vitem &*-o*&&~<&'seconds'&>
35794 Match messages that are older than the given time.
35795
35796 .vitem &*-z*&
35797 Match only frozen messages.
35798
35799 .vitem &*-x*&
35800 Match only non-frozen messages.
35801 .endlist
35802
35803 The following options control the format of the output:
35804
35805 .vlist
35806 .vitem &*-c*&
35807 Display only the count of matching messages.
35808
35809 .vitem &*-l*&
35810 Long format &-- display the full message information as output by Exim. This is
35811 the default.
35812
35813 .vitem &*-i*&
35814 Display message ids only.
35815
35816 .vitem &*-b*&
35817 Brief format &-- one line per message.
35818
35819 .vitem &*-R*&
35820 Display messages in reverse order.
35821
35822 .vitem &*-a*&
35823 Include delivered recipients in queue listing.
35824 .endlist
35825
35826 There is one more option, &%-h%&, which outputs a list of options.
35827
35828
35829
35830 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35831 .cindex "&'exiqsumm'&"
35832 .cindex "queue" "summary"
35833 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35834 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35835 running a command such as
35836 .code
35837 exim -bp | exiqsumm
35838 .endd
35839 The output consists of one line for each domain that has messages waiting for
35840 it, as in the following example:
35841 .code
35842 3   2322   74m   66m  msn.com.example
35843 .endd
35844 Each line lists the number of pending deliveries for a domain, their total
35845 volume, and the length of time that the oldest and the newest messages have
35846 been waiting. Note that the number of pending deliveries is greater than the
35847 number of messages when messages have more than one recipient.
35848
35849 A summary line is output at the end. By default the output is sorted on the
35850 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35851 the output to be sorted by oldest message and by count of messages,
35852 respectively. There are also three options that split the messages for each
35853 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35854 separates frozen messages, and &%-s%& separates messages according to their
35855 sender.
35856
35857 The output of &'exim -bp'& contains the original addresses in the message, so
35858 this also applies to the output from &'exiqsumm'&. No domains from addresses
35859 generated by aliasing or forwarding are included (unless the &%one_time%&
35860 option of the &(redirect)& router has been used to convert them into &"top
35861 level"& addresses).
35862
35863
35864
35865
35866 .section "Extracting specific information from the log (exigrep)" &&&
35867          "SECTextspeinf"
35868 .cindex "&'exigrep'&"
35869 .cindex "log" "extracts; grepping for"
35870 The &'exigrep'& utility is a Perl script that searches one or more main log
35871 files for entries that match a given pattern. When it finds a match, it
35872 extracts all the log entries for the relevant message, not just those that
35873 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35874 given message, or all mail for a given user, or for a given host, for example.
35875 The input files can be in Exim log format or syslog format.
35876 If a matching log line is not associated with a specific message, it is
35877 included in &'exigrep'&'s output without any additional lines. The usage is:
35878 .display
35879 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35880 .endd
35881 If no log file names are given on the command line, the standard input is read.
35882
35883 The &%-t%& argument specifies a number of seconds. It adds an additional
35884 condition for message selection. Messages that are complete are shown only if
35885 they spent more than <&'n'&> seconds on the queue.
35886
35887 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35888 makes it case-sensitive. This may give a performance improvement when searching
35889 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35890 option; with &%-I%& they do not. In both cases it is possible to change the
35891 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35892
35893 The &%-l%& option means &"literal"&, that is, treat all characters in the
35894 pattern as standing for themselves. Otherwise the pattern must be a Perl
35895 regular expression.
35896
35897 The &%-v%& option inverts the matching condition. That is, a line is selected
35898 if it does &'not'& match the pattern.
35899
35900 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35901 that are generated as a result/response to a message that &'exigrep'& matched
35902 normally.
35903
35904 Example of &%-M%&:
35905 user_a sends a message to user_b, which generates a bounce back to user_b. If
35906 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35907 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35908 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35909 when searching for &"user_a"& will show both messages since the bounce is
35910 &"related"& to or a &"result"& of the first message that was found by the
35911 search term.
35912
35913 If the location of a &'zcat'& command is known from the definition of
35914 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35915 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35916 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
35917 autodetection of some well known compression extensions.
35918
35919
35920 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35921 .cindex "&'exipick'&"
35922 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35923 lists messages from the queue according to a variety of criteria. For details
35924 of &'exipick'&'s facilities, visit the web page at
35925 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35926 the &%--help%& option.
35927
35928
35929 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35930 .cindex "log" "cycling local files"
35931 .cindex "cycling logs"
35932 .cindex "&'exicyclog'&"
35933 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35934 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35935 you are using log files with datestamps in their names (see section
35936 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
35937 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
35938 There are two command line options for &'exicyclog'&:
35939 .ilist
35940 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
35941 default that is set when Exim is built. The default default is 10.
35942 .next
35943 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
35944 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
35945 overriding the script's default, which is to find the setting from Exim's
35946 configuration.
35947 .endlist
35948
35949 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
35950 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
35951 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
35952 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
35953 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
35954 logs are handled similarly.
35955
35956 If the limit is greater than 99, the script uses 3-digit numbers such as
35957 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
35958 to one that is greater, or &'vice versa'&, you will have to fix the names of
35959 any existing log files.
35960
35961 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
35962 the end are deleted. All files with numbers greater than 01 are compressed,
35963 using a compression command which is configured by the COMPRESS_COMMAND
35964 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
35965 root &%crontab%& entry of the form
35966 .code
35967 1 0 * * * su exim -c /usr/exim/bin/exicyclog
35968 .endd
35969 assuming you have used the name &"exim"& for the Exim user. You can run
35970 &'exicyclog'& as root if you wish, but there is no need.
35971
35972
35973
35974 .section "Mail statistics (eximstats)" "SECTmailstat"
35975 .cindex "statistics"
35976 .cindex "&'eximstats'&"
35977 A Perl script called &'eximstats'& is provided for extracting statistical
35978 information from log files. The output is either plain text, or HTML.
35979 Exim log files are also supported by the &'Lire'& system produced by the
35980 LogReport Foundation &url(http://www.logreport.org).
35981
35982 The &'eximstats'& script has been hacked about quite a bit over time. The
35983 latest version is the result of some extensive revision by Steve Campbell. A
35984 lot of information is given by default, but there are options for suppressing
35985 various parts of it. Following any options, the arguments to the script are a
35986 list of files, which should be main log files. For example:
35987 .code
35988 eximstats -nr /var/spool/exim/log/mainlog.01
35989 .endd
35990 By default, &'eximstats'& extracts information about the number and volume of
35991 messages received from or delivered to various hosts. The information is sorted
35992 both by message count and by volume, and the top fifty hosts in each category
35993 are listed on the standard output. Similar information, based on email
35994 addresses or domains instead of hosts can be requested by means of various
35995 options. For messages delivered and received locally, similar statistics are
35996 also produced per user.
35997
35998 The output also includes total counts and statistics about delivery errors, and
35999 histograms showing the number of messages received and deliveries made in each
36000 hour of the day. A delivery with more than one address in its envelope (for
36001 example, an SMTP transaction with more than one RCPT command) is counted
36002 as a single delivery by &'eximstats'&.
36003
36004 Though normally more deliveries than receipts are reported (as messages may
36005 have multiple recipients), it is possible for &'eximstats'& to report more
36006 messages received than delivered, even though the queue is empty at the start
36007 and end of the period in question. If an incoming message contains no valid
36008 recipients, no deliveries are recorded for it. A bounce message is handled as
36009 an entirely separate message.
36010
36011 &'eximstats'& always outputs a grand total summary giving the volume and number
36012 of messages received and deliveries made, and the number of hosts involved in
36013 each case. It also outputs the number of messages that were delayed (that is,
36014 not completely delivered at the first attempt), and the number that had at
36015 least one address that failed.
36016
36017 The remainder of the output is in sections that can be independently disabled
36018 or modified by various options. It consists of a summary of deliveries by
36019 transport, histograms of messages received and delivered per time interval
36020 (default per hour), information about the time messages spent on the queue,
36021 a list of relayed messages, lists of the top fifty sending hosts, local
36022 senders, destination hosts, and destination local users by count and by volume,
36023 and a list of delivery errors that occurred.
36024
36025 The relay information lists messages that were actually relayed, that is, they
36026 came from a remote host and were directly delivered to some other remote host,
36027 without being processed (for example, for aliasing or forwarding) locally.
36028
36029 There are quite a few options for &'eximstats'& to control exactly what it
36030 outputs. These are documented in the Perl script itself, and can be extracted
36031 by running the command &(perldoc)& on the script. For example:
36032 .code
36033 perldoc /usr/exim/bin/eximstats
36034 .endd
36035
36036 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36037 .cindex "&'exim_checkaccess'&"
36038 .cindex "policy control" "checking access"
36039 .cindex "checking access"
36040 The &%-bh%& command line argument allows you to run a fake SMTP session with
36041 debugging output, in order to check what Exim is doing when it is applying
36042 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36043 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36044 sometimes you just want to answer the question &"Does this address have
36045 access?"& without bothering with any further details.
36046
36047 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36048 two arguments, an IP address and an email address:
36049 .code
36050 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36051 .endd
36052 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36053 given email address would be accepted in a RCPT command in a TCP/IP
36054 connection from the host with the given IP address. The output of the utility
36055 is either the word &"accepted"&, or the SMTP error response, for example:
36056 .code
36057 Rejected:
36058 550 Relay not permitted
36059 .endd
36060 When running this test, the utility uses &`<>`& as the envelope sender address
36061 for the MAIL command, but you can change this by providing additional
36062 options. These are passed directly to the Exim command. For example, to specify
36063 that the test is to be run with the sender address &'himself@there.example'&
36064 you can use:
36065 .code
36066 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36067                  -f himself@there.example
36068 .endd
36069 Note that these additional Exim command line items must be given after the two
36070 mandatory arguments.
36071
36072 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36073 while running its checks. You can run checks that include callouts by using
36074 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36075
36076
36077
36078 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36079 .cindex "DBM" "building dbm files"
36080 .cindex "building DBM files"
36081 .cindex "&'exim_dbmbuild'&"
36082 .cindex "lower casing"
36083 .cindex "binary zero" "in lookup key"
36084 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36085 the format used by the &(lsearch)& lookup (see section
36086 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36087 names as keys and the remainder of the information as data. The lower-casing
36088 can be prevented by calling the program with the &%-nolc%& option.
36089
36090 A terminating zero is included as part of the key string. This is expected by
36091 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36092 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36093 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36094 files.
36095
36096 The program requires two arguments: the name of the input file (which can be a
36097 single hyphen to indicate the standard input), and the name of the output file.
36098 It creates the output under a temporary name, and then renames it if all went
36099 well.
36100
36101 .cindex "USE_DB"
36102 If the native DB interface is in use (USE_DB is set in a compile-time
36103 configuration file &-- this is common in free versions of Unix) the two file
36104 names must be different, because in this mode the Berkeley DB functions create
36105 a single output file using exactly the name given. For example,
36106 .code
36107 exim_dbmbuild /etc/aliases /etc/aliases.db
36108 .endd
36109 reads the system alias file and creates a DBM version of it in
36110 &_/etc/aliases.db_&.
36111
36112 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36113 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36114 environment, the suffixes are added to the second argument of
36115 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36116 when the Berkeley functions are used in compatibility mode (though this is not
36117 recommended), because in that case it adds a &_.db_& suffix to the file name.
36118
36119 If a duplicate key is encountered, the program outputs a warning, and when it
36120 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36121 option is used. By default, only the first of a set of duplicates is used &--
36122 this makes it compatible with &(lsearch)& lookups. There is an option
36123 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36124 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36125 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36126 return code is 2.
36127
36128
36129
36130
36131 .section "Finding individual retry times (exinext)" "SECTfinindret"
36132 .cindex "retry" "times"
36133 .cindex "&'exinext'&"
36134 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36135 fish specific information out of the retry database. Given a mail domain (or a
36136 complete address), it looks up the hosts for that domain, and outputs any retry
36137 information for the hosts or for the domain. At present, the retry information
36138 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36139 output. For example:
36140 .code
36141 $ exinext piglet@milne.fict.example
36142 kanga.milne.example:192.168.8.1 error 146: Connection refused
36143   first failed: 21-Feb-1996 14:57:34
36144   last tried:   21-Feb-1996 14:57:34
36145   next try at:  21-Feb-1996 15:02:34
36146 roo.milne.example:192.168.8.3 error 146: Connection refused
36147   first failed: 20-Jan-1996 13:12:08
36148   last tried:   21-Feb-1996 11:42:03
36149   next try at:  21-Feb-1996 19:42:03
36150   past final cutoff time
36151 .endd
36152 You can also give &'exinext'& a local part, without a domain, and it
36153 will give any retry information for that local part in your default domain.
36154 A message id can be used to obtain retry information pertaining to a specific
36155 message. This exists only when an attempt to deliver a message to a remote host
36156 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36157 &'exinext'& is not particularly efficient, but then it is not expected to be
36158 run very often.
36159
36160 The &'exinext'& utility calls Exim to find out information such as the location
36161 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36162 passed on to the &'exim'& commands. The first specifies an alternate Exim
36163 configuration file, and the second sets macros for use within the configuration
36164 file. These features are mainly to help in testing, but might also be useful in
36165 environments where more than one configuration file is in use.
36166
36167
36168
36169 .section "Hints database maintenance" "SECThindatmai"
36170 .cindex "hints database" "maintenance"
36171 .cindex "maintaining Exim's hints database"
36172 Three utility programs are provided for maintaining the DBM files that Exim
36173 uses to contain its delivery hint information. Each program requires two
36174 arguments. The first specifies the name of Exim's spool directory, and the
36175 second is the name of the database it is to operate on. These are as follows:
36176
36177 .ilist
36178 &'retry'&: the database of retry information
36179 .next
36180 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36181 for remote hosts
36182 .next
36183 &'callout'&: the callout cache
36184 .next
36185 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36186 .next
36187 &'misc'&: other hints data
36188 .endlist
36189
36190 The &'misc'& database is used for
36191
36192 .ilist
36193 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36194 .next
36195 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36196 &(smtp)& transport)
36197 .endlist
36198
36199
36200
36201 .section "exim_dumpdb" "SECID261"
36202 .cindex "&'exim_dumpdb'&"
36203 The entire contents of a database are written to the standard output by the
36204 &'exim_dumpdb'& program, which has no options or arguments other than the
36205 spool and database names. For example, to dump the retry database:
36206 .code
36207 exim_dumpdb /var/spool/exim retry
36208 .endd
36209 Two lines of output are produced for each entry:
36210 .code
36211 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36212 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36213 .endd
36214 The first item on the first line is the key of the record. It starts with one
36215 of the letters R, or T, depending on whether it refers to a routing or
36216 transport retry. For a local delivery, the next part is the local address; for
36217 a remote delivery it is the name of the remote host, followed by its failing IP
36218 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36219 transport). If the remote port is not the standard one (port 25), it is added
36220 to the IP address. Then there follows an error code, an additional error code,
36221 and a textual description of the error.
36222
36223 The three times on the second line are the time of first failure, the time of
36224 the last delivery attempt, and the computed time for the next attempt. The line
36225 ends with an asterisk if the cutoff time for the last retry rule has been
36226 exceeded.
36227
36228 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36229 consists of a host name followed by a list of ids for messages that are or were
36230 waiting to be delivered to that host. If there are a very large number for any
36231 one host, continuation records, with a sequence number added to the host name,
36232 may be seen. The data in these records is often out of date, because a message
36233 may be routed to several alternative hosts, and Exim makes no effort to keep
36234 cross-references.
36235
36236
36237
36238 .section "exim_tidydb" "SECID262"
36239 .cindex "&'exim_tidydb'&"
36240 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36241 database. If run with no options, it removes all records that are more than 30
36242 days old. The age is calculated from the date and time that the record was last
36243 updated. Note that, in the case of the retry database, it is &'not'& the time
36244 since the first delivery failure. Information about a host that has been down
36245 for more than 30 days will remain in the database, provided that the record is
36246 updated sufficiently often.
36247
36248 The cutoff date can be altered by means of the &%-t%& option, which must be
36249 followed by a time. For example, to remove all records older than a week from
36250 the retry database:
36251 .code
36252 exim_tidydb -t 7d /var/spool/exim retry
36253 .endd
36254 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36255 message ids. In the former these appear as data in records keyed by host &--
36256 they were messages that were waiting for that host &-- and in the latter they
36257 are the keys for retry information for messages that have suffered certain
36258 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36259 message ids in database records are those of messages that are still on the
36260 queue. Message ids for messages that no longer exist are removed from
36261 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36262 For the &'retry'& database, records whose keys are non-existent message ids are
36263 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36264 whenever it removes information from the database.
36265
36266 Certain records are automatically removed by Exim when they are no longer
36267 needed, but others are not. For example, if all the MX hosts for a domain are
36268 down, a retry record is created for each one. If the primary MX host comes back
36269 first, its record is removed when Exim successfully delivers to it, but the
36270 records for the others remain because Exim has not tried to use those hosts.
36271
36272 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36273 hints databases. You should do this at a quiet time of day, because it requires
36274 a database to be locked (and therefore inaccessible to Exim) while it does its
36275 work. Removing records from a DBM file does not normally make the file smaller,
36276 but all the common DBM libraries are able to re-use the space that is released.
36277 After an initial phase of increasing in size, the databases normally reach a
36278 point at which they no longer get any bigger, as long as they are regularly
36279 tidied.
36280
36281 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36282 databases is likely to keep on increasing.
36283
36284
36285
36286
36287 .section "exim_fixdb" "SECID263"
36288 .cindex "&'exim_fixdb'&"
36289 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36290 Its main use is for testing Exim, but it might also be occasionally useful for
36291 getting round problems in a live system. It has no options, and its interface
36292 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36293 key of a database record can then be entered, and the data for that record is
36294 displayed.
36295
36296 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36297 except the &'retry'& database, that is the only operation that can be carried
36298 out. For the &'retry'& database, each field is output preceded by a number, and
36299 data for individual fields can be changed by typing the field number followed
36300 by new data, for example:
36301 .code
36302 > 4 951102:1000
36303 .endd
36304 resets the time of the next delivery attempt. Time values are given as a
36305 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36306 used as optional separators.
36307
36308
36309
36310
36311 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36312 .cindex "mailbox" "maintenance"
36313 .cindex "&'exim_lock'&"
36314 .cindex "locking mailboxes"
36315 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36316 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36317 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36318 a user agent while investigating a problem. The utility requires the name of
36319 the file as its first argument. If the locking is successful, the second
36320 argument is run as a command (using C's &[system()]& function); if there is no
36321 second argument, the value of the SHELL environment variable is used; if this
36322 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36323 is unlocked and the utility ends. The following options are available:
36324
36325 .vlist
36326 .vitem &%-fcntl%&
36327 Use &[fcntl()]& locking on the open mailbox.
36328
36329 .vitem &%-flock%&
36330 Use &[flock()]& locking on the open mailbox, provided the operating system
36331 supports it.
36332
36333 .vitem &%-interval%&
36334 This must be followed by a number, which is a number of seconds; it sets the
36335 interval to sleep between retries (default 3).
36336
36337 .vitem &%-lockfile%&
36338 Create a lock file before opening the mailbox.
36339
36340 .vitem &%-mbx%&
36341 Lock the mailbox using MBX rules.
36342
36343 .vitem &%-q%&
36344 Suppress verification output.
36345
36346 .vitem &%-retries%&
36347 This must be followed by a number; it sets the number of times to try to get
36348 the lock (default 10).
36349
36350 .vitem &%-restore_time%&
36351 This option causes &%exim_lock%& to restore the modified and read times to the
36352 locked file before exiting. This allows you to access a locked mailbox (for
36353 example, to take a backup copy) without disturbing the times that the user
36354 subsequently sees.
36355
36356 .vitem &%-timeout%&
36357 This must be followed by a number, which is a number of seconds; it sets a
36358 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36359 default), a non-blocking call is used.
36360
36361 .vitem &%-v%&
36362 Generate verbose output.
36363 .endlist
36364
36365 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36366 default is to create a lock file and also to use &[fcntl()]& locking on the
36367 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36368 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36369 requires that the directory containing the file be writeable. Locking by lock
36370 file does not last for ever; Exim assumes that a lock file is expired if it is
36371 more than 30 minutes old.
36372
36373 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36374 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36375 to be taken out on the open mailbox, and an exclusive lock on the file
36376 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36377 number of the mailbox file. When the locking is released, if an exclusive lock
36378 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36379
36380 The default output contains verification of the locking that takes place. The
36381 &%-v%& option causes some additional information to be given. The &%-q%& option
36382 suppresses all output except error messages.
36383
36384 A command such as
36385 .code
36386 exim_lock /var/spool/mail/spqr
36387 .endd
36388 runs an interactive shell while the file is locked, whereas
36389 .display
36390 &`exim_lock -q /var/spool/mail/spqr <<End`&
36391 <&'some commands'&>
36392 &`End`&
36393 .endd
36394 runs a specific non-interactive sequence of commands while the file is locked,
36395 suppressing all verification output. A single command can be run by a command
36396 such as
36397 .code
36398 exim_lock -q /var/spool/mail/spqr \
36399   "cp /var/spool/mail/spqr /some/where"
36400 .endd
36401 Note that if a command is supplied, it must be entirely contained within the
36402 second argument &-- hence the quotes.
36403 .ecindex IIDutils
36404
36405
36406 . ////////////////////////////////////////////////////////////////////////////
36407 . ////////////////////////////////////////////////////////////////////////////
36408
36409 .chapter "The Exim monitor" "CHAPeximon"
36410 .scindex IIDeximon "Exim monitor" "description"
36411 .cindex "X-windows"
36412 .cindex "&'eximon'&"
36413 .cindex "Local/eximon.conf"
36414 .cindex "&_exim_monitor/EDITME_&"
36415 The Exim monitor is an application which displays in an X window information
36416 about the state of Exim's queue and what Exim is doing. An admin user can
36417 perform certain operations on messages from this GUI interface; however all
36418 such facilities are also available from the command line, and indeed, the
36419 monitor itself makes use of the command line to perform any actions requested.
36420
36421
36422
36423 .section "Running the monitor" "SECID264"
36424 The monitor is started by running the script called &'eximon'&. This is a shell
36425 script that sets up a number of environment variables, and then runs the
36426 binary called &_eximon.bin_&. The default appearance of the monitor window can
36427 be changed by editing the &_Local/eximon.conf_& file created by editing
36428 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36429 parameters are for.
36430
36431 The parameters that get built into the &'eximon'& script can be overridden for
36432 a particular invocation by setting up environment variables of the same names,
36433 preceded by &`EXIMON_`&. For example, a shell command such as
36434 .code
36435 EXIMON_LOG_DEPTH=400 eximon
36436 .endd
36437 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36438 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36439 overrides the Exim log file configuration. This makes it possible to have
36440 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36441 syslog messages are routed to a file on the local host.
36442
36443 X resources can be used to change the appearance of the window in the normal
36444 way. For example, a resource setting of the form
36445 .code
36446 Eximon*background: gray94
36447 .endd
36448 changes the colour of the background to light grey rather than white. The
36449 stripcharts are drawn with both the data lines and the reference lines in
36450 black. This means that the reference lines are not visible when on top of the
36451 data. However, their colour can be changed by setting a resource called
36452 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36453 For example, if your X server is running Unix, you could set up lighter
36454 reference lines in the stripcharts by obeying
36455 .code
36456 xrdb -merge <<End
36457 Eximon*highlight: gray
36458 End
36459 .endd
36460 .cindex "admin user"
36461 In order to see the contents of messages on the queue, and to operate on them,
36462 &'eximon'& must either be run as root or by an admin user.
36463
36464 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36465 contain X11 resource parameters interpreted by the X11 library.  In addition,
36466 if the first parameter starts with the string "gdb" then it is removed and the
36467 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36468 versioned variants of gdb can be invoked).
36469
36470 The monitor's window is divided into three parts. The first contains one or
36471 more stripcharts and two action buttons, the second contains a &"tail"& of the
36472 main log file, and the third is a display of the queue of messages awaiting
36473 delivery, with two more action buttons. The following sections describe these
36474 different parts of the display.
36475
36476
36477
36478
36479 .section "The stripcharts" "SECID265"
36480 .cindex "stripchart"
36481 The first stripchart is always a count of messages on the queue. Its name can
36482 be configured by setting QUEUE_STRIPCHART_NAME in the
36483 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36484 configuration script by regular expression matches on log file entries, making
36485 it possible to display, for example, counts of messages delivered to certain
36486 hosts or using certain transports. The supplied defaults display counts of
36487 received and delivered messages, and of local and SMTP deliveries. The default
36488 period between stripchart updates is one minute; this can be adjusted by a
36489 parameter in the &_Local/eximon.conf_& file.
36490
36491 The stripchart displays rescale themselves automatically as the value they are
36492 displaying changes. There are always 10 horizontal lines in each chart; the
36493 title string indicates the value of each division when it is greater than one.
36494 For example, &"x2"& means that each division represents a value of 2.
36495
36496 It is also possible to have a stripchart which shows the percentage fullness of
36497 a particular disk partition, which is useful when local deliveries are confined
36498 to a single partition.
36499
36500 .cindex "&%statvfs%& function"
36501 This relies on the availability of the &[statvfs()]& function or equivalent in
36502 the operating system. Most, but not all versions of Unix that support Exim have
36503 this. For this particular stripchart, the top of the chart always represents
36504 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36505 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36506 &_Local/eximon.conf_& file.
36507
36508
36509
36510
36511 .section "Main action buttons" "SECID266"
36512 .cindex "size" "of monitor window"
36513 .cindex "Exim monitor" "window size"
36514 .cindex "window size"
36515 Below the stripcharts there is an action button for quitting the monitor. Next
36516 to this is another button marked &"Size"&. They are placed here so that
36517 shrinking the window to its default minimum size leaves just the queue count
36518 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36519 the window to expand to its maximum size, unless it is already at the maximum,
36520 in which case it is reduced to its minimum.
36521
36522 When expanding to the maximum, if the window cannot be fully seen where it
36523 currently is, it is moved back to where it was the last time it was at full
36524 size. When it is expanding from its minimum size, the old position is
36525 remembered, and next time it is reduced to the minimum it is moved back there.
36526
36527 The idea is that you can keep a reduced window just showing one or two
36528 stripcharts at a convenient place on your screen, easily expand it to show
36529 the full window when required, and just as easily put it back to what it was.
36530 The idea is copied from what the &'twm'& window manager does for its
36531 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36532 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36533
36534 Normally, the monitor starts up with the window at its full size, but it can be
36535 built so that it starts up with the window at its smallest size, by setting
36536 START_SMALL=yes in &_Local/eximon.conf_&.
36537
36538
36539
36540 .section "The log display" "SECID267"
36541 .cindex "log" "tail of; in monitor"
36542 The second section of the window is an area in which a display of the tail of
36543 the main log is maintained.
36544 To save space on the screen, the timestamp on each log line is shortened by
36545 removing the date and, if &%log_timezone%& is set, the timezone.
36546 The log tail is not available when the only destination for logging data is
36547 syslog, unless the syslog lines are routed to a local file whose name is passed
36548 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36549
36550 The log sub-window has a scroll bar at its lefthand side which can be used to
36551 move back to look at earlier text, and the up and down arrow keys also have a
36552 scrolling effect. The amount of log that is kept depends on the setting of
36553 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36554 to use. When this is full, the earlier 50% of data is discarded &-- this is
36555 much more efficient than throwing it away line by line. The sub-window also has
36556 a horizontal scroll bar for accessing the ends of long log lines. This is the
36557 only means of horizontal scrolling; the right and left arrow keys are not
36558 available. Text can be cut from this part of the window using the mouse in the
36559 normal way. The size of this subwindow is controlled by parameters in the
36560 configuration file &_Local/eximon.conf_&.
36561
36562 Searches of the text in the log window can be carried out by means of the ^R
36563 and ^S keystrokes, which default to a reverse and a forward search,
36564 respectively. The search covers only the text that is displayed in the window.
36565 It cannot go further back up the log.
36566
36567 The point from which the search starts is indicated by a caret marker. This is
36568 normally at the end of the text in the window, but can be positioned explicitly
36569 by pointing and clicking with the left mouse button, and is moved automatically
36570 by a successful search. If new text arrives in the window when it is scrolled
36571 back, the caret remains where it is, but if the window is not scrolled back,
36572 the caret is moved to the end of the new text.
36573
36574 Pressing ^R or ^S pops up a window into which the search text can be typed.
36575 There are buttons for selecting forward or reverse searching, for carrying out
36576 the search, and for cancelling. If the &"Search"& button is pressed, the search
36577 happens and the window remains so that further searches can be done. If the
36578 &"Return"& key is pressed, a single search is done and the window is closed. If
36579 ^C is typed the search is cancelled.
36580
36581 The searching facility is implemented using the facilities of the Athena text
36582 widget. By default this pops up a window containing both &"search"& and
36583 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36584 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36585 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36586 provided version of &%TextPop%& when the remaining parts of the text widget
36587 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36588 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36589 on these systems, at the expense of having unwanted items in the search popup
36590 window.
36591
36592
36593
36594 .section "The queue display" "SECID268"
36595 .cindex "queue" "display in monitor"
36596 The bottom section of the monitor window contains a list of all messages that
36597 are on the queue, which includes those currently being received or delivered,
36598 as well as those awaiting delivery. The size of this subwindow is controlled by
36599 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36600 at which it is updated is controlled by another parameter in the same file &--
36601 the default is 5 minutes, since queue scans can be quite expensive. However,
36602 there is an &"Update"& action button just above the display which can be used
36603 to force an update of the queue display at any time.
36604
36605 When a host is down for some time, a lot of pending mail can build up for it,
36606 and this can make it hard to deal with other messages on the queue. To help
36607 with this situation there is a button next to &"Update"& called &"Hide"&. If
36608 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36609 type anything in here and press &"Return"&, the text is added to a chain of
36610 such texts, and if every undelivered address in a message matches at least one
36611 of the texts, the message is not displayed.
36612
36613 If there is an address that does not match any of the texts, all the addresses
36614 are displayed as normal. The matching happens on the ends of addresses so, for
36615 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36616 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36617 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36618 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36619 a hide request is automatically cancelled after one hour.
36620
36621 While the dialogue box is displayed, you can't press any buttons or do anything
36622 else to the monitor window. For this reason, if you want to cut text from the
36623 queue display to use in the dialogue box, you have to do the cutting before
36624 pressing the &"Hide"& button.
36625
36626 The queue display contains, for each unhidden queued message, the length of
36627 time it has been on the queue, the size of the message, the message id, the
36628 message sender, and the first undelivered recipient, all on one line. If it is
36629 a bounce message, the sender is shown as &"<>"&. If there is more than one
36630 recipient to which the message has not yet been delivered, subsequent ones are
36631 listed on additional lines, up to a maximum configured number, following which
36632 an ellipsis is displayed. Recipients that have already received the message are
36633 not shown.
36634
36635 .cindex "frozen messages" "display"
36636 If a message is frozen, an asterisk is displayed at the left-hand side.
36637
36638 The queue display has a vertical scroll bar, and can also be scrolled by means
36639 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36640 The text searching facilities, as described above for the log window, are also
36641 available, but the caret is always moved to the end of the text when the queue
36642 display is updated.
36643
36644
36645
36646 .section "The queue menu" "SECID269"
36647 .cindex "queue" "menu in monitor"
36648 If the &%shift%& key is held down and the left button is clicked when the mouse
36649 pointer is over the text for any message, an action menu pops up, and the first
36650 line of the queue display for the message is highlighted. This does not affect
36651 any selected text.
36652
36653 If you want to use some other event for popping up the menu, you can set the
36654 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36655 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36656 value set in this parameter is a standard X event description. For example, to
36657 run eximon using &%ctrl%& rather than &%shift%& you could use
36658 .code
36659 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36660 .endd
36661 The title of the menu is the message id, and it contains entries which act as
36662 follows:
36663
36664 .ilist
36665 &'message log'&: The contents of the message log for the message are displayed
36666 in a new text window.
36667 .next
36668 &'headers'&: Information from the spool file that contains the envelope
36669 information and headers is displayed in a new text window. See chapter
36670 &<<CHAPspool>>& for a description of the format of spool files.
36671 .next
36672 &'body'&: The contents of the spool file containing the body of the message are
36673 displayed in a new text window. There is a default limit of 20,000 bytes to the
36674 amount of data displayed. This can be changed by setting the BODY_MAX
36675 option at compile time, or the EXIMON_BODY_MAX option at run time.
36676 .next
36677 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36678 delivery of the message. This causes an automatic thaw if the message is
36679 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36680 a new text window. The delivery is run in a separate process, to avoid holding
36681 up the monitor while the delivery proceeds.
36682 .next
36683 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36684 that the message be frozen.
36685 .next
36686 .cindex "thawing messages"
36687 .cindex "unfreezing messages"
36688 .cindex "frozen messages" "thawing"
36689 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36690 that the message be thawed.
36691 .next
36692 .cindex "delivery" "forcing failure"
36693 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36694 that Exim gives up trying to deliver the message. A bounce message is generated
36695 for any remaining undelivered addresses.
36696 .next
36697 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36698 that the message be deleted from the system without generating a bounce
36699 message.
36700 .next
36701 &'add recipient'&: A dialog box is displayed into which a recipient address can
36702 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36703 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36704 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36705 causes a call to Exim to be made using the &%-Mar%& option to request that an
36706 additional recipient be added to the message, unless the entry box is empty, in
36707 which case no action is taken.
36708 .next
36709 &'mark delivered'&: A dialog box is displayed into which a recipient address
36710 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36711 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36712 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36713 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36714 recipient address as already delivered, unless the entry box is empty, in which
36715 case no action is taken.
36716 .next
36717 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36718 mark all recipient addresses as already delivered.
36719 .next
36720 &'edit sender'&: A dialog box is displayed initialized with the current
36721 sender's address. Pressing RETURN causes a call to Exim to be made using the
36722 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36723 in which case no action is taken. If you want to set an empty sender (as in
36724 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36725 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36726 the address is qualified with that domain.
36727 .endlist
36728
36729 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36730 other cases when a call to Exim is made, if there is any output from Exim (in
36731 particular, if the command fails) a window containing the command and the
36732 output is displayed. Otherwise, the results of the action are normally apparent
36733 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36734 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36735 if no output is generated.
36736
36737 The queue display is automatically updated for actions such as freezing and
36738 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36739 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36740 force an update of the display after one of these actions.
36741
36742 In any text window that is displayed as result of a menu action, the normal
36743 cut-and-paste facility is available, and searching can be carried out using ^R
36744 and ^S, as described above for the log tail window.
36745 .ecindex IIDeximon
36746
36747
36748
36749
36750
36751 . ////////////////////////////////////////////////////////////////////////////
36752 . ////////////////////////////////////////////////////////////////////////////
36753
36754 .chapter "Security considerations" "CHAPsecurity"
36755 .scindex IIDsecurcon "security" "discussion of"
36756 This chapter discusses a number of issues concerned with security, some of
36757 which are also covered in other parts of this manual.
36758
36759 For reasons that this author does not understand, some people have promoted
36760 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36761 existence of this chapter in the documentation. However, the intent of the
36762 chapter is simply to describe the way Exim works in relation to certain
36763 security concerns, not to make any specific claims about the effectiveness of
36764 its security as compared with other MTAs.
36765
36766 What follows is a description of the way Exim is supposed to be. Best efforts
36767 have been made to try to ensure that the code agrees with the theory, but an
36768 absence of bugs can never be guaranteed. Any that are reported will get fixed
36769 as soon as possible.
36770
36771
36772 .section "Building a more &""hardened""& Exim" "SECID286"
36773 .cindex "security" "build-time features"
36774 There are a number of build-time options that can be set in &_Local/Makefile_&
36775 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36776 Exim administrator who does not have the root password, or by someone who has
36777 penetrated the Exim (but not the root) account. These options are as follows:
36778
36779 .ilist
36780 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36781 start of any file names used with the &%-C%& option. When it is set, these file
36782 names are also not allowed to contain the sequence &"/../"&. (However, if the
36783 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36784 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36785 default setting for &%ALT_CONFIG_PREFIX%&.
36786
36787 If the permitted configuration files are confined to a directory to
36788 which only root has access, this guards against someone who has broken
36789 into the Exim account from running a privileged Exim with an arbitrary
36790 configuration file, and using it to break into other accounts.
36791 .next
36792
36793 If a non-trusted configuration file (i.e. not the default configuration file
36794 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36795 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36796 the next item), then root privilege is retained only if the caller of Exim is
36797 root. This locks out the possibility of testing a configuration using &%-C%&
36798 right through message reception and delivery, even if the caller is root. The
36799 reception works, but by that time, Exim is running as the Exim user, so when
36800 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36801 privilege to be lost. However, root can test reception and delivery using two
36802 separate commands.
36803
36804 .next
36805 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36806 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36807 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36808 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36809 the restrictive side.  Requiring build-time selection of safe macros is onerous
36810 but this option is intended solely as a transition mechanism to permit
36811 previously-working configurations to continue to work after release 4.73.
36812 .next
36813 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36814 is disabled.
36815 .next
36816 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36817 never to be used for any deliveries. This is like the &%never_users%& runtime
36818 option, but it cannot be overridden; the runtime option adds additional users
36819 to the list. The default setting is &"root"&; this prevents a non-root user who
36820 is permitted to modify the runtime file from using Exim as a way to get root.
36821 .endlist
36822
36823
36824
36825 .section "Root privilege" "SECID270"
36826 .cindex "setuid"
36827 .cindex "root privilege"
36828 The Exim binary is normally setuid to root, which means that it gains root
36829 privilege (runs as root) when it starts execution. In some special cases (for
36830 example, when the daemon is not in use and there are no local deliveries), it
36831 may be possible to run Exim setuid to some user other than root. This is
36832 discussed in the next section. However, in most installations, root privilege
36833 is required for two things:
36834
36835 .ilist
36836 To set up a socket connected to the standard SMTP port (25) when initialising
36837 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36838 not required.
36839 .next
36840 To be able to change uid and gid in order to read users' &_.forward_& files and
36841 perform local deliveries as the receiving user or as specified in the
36842 configuration.
36843 .endlist
36844
36845 It is not necessary to be root to do any of the other things Exim does, such as
36846 receiving messages and delivering them externally over SMTP, and it is
36847 obviously more secure if Exim does not run as root except when necessary.
36848 For this reason, a user and group for Exim to use must be defined in
36849 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36850 group"&. Their values can be changed by the run time configuration, though this
36851 is not recommended. Often a user called &'exim'& is used, but some sites use
36852 &'mail'& or another user name altogether.
36853
36854 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36855 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36856 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36857
36858 After a new Exim process has interpreted its command line options, it changes
36859 uid and gid in the following cases:
36860
36861 .ilist
36862 .oindex "&%-C%&"
36863 .oindex "&%-D%&"
36864 If the &%-C%& option is used to specify an alternate configuration file, or if
36865 the &%-D%& option is used to define macro values for the configuration, and the
36866 calling process is not running as root, the uid and gid are changed to those of
36867 the calling process.
36868 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36869 option may not be used at all.
36870 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36871 can be supplied if the calling process is running as root, the Exim run-time
36872 user or CONFIGURE_OWNER, if defined.
36873 .next
36874 .oindex "&%-be%&"
36875 .oindex "&%-bf%&"
36876 .oindex "&%-bF%&"
36877 If the expansion test option (&%-be%&) or one of the filter testing options
36878 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36879 calling process.
36880 .next
36881 If the process is not a daemon process or a queue runner process or a delivery
36882 process or a process for testing address routing (started with &%-bt%&), the
36883 uid and gid are changed to the Exim user and group. This means that Exim always
36884 runs under its own uid and gid when receiving messages. This also applies when
36885 testing address verification
36886 .oindex "&%-bv%&"
36887 .oindex "&%-bh%&"
36888 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36889 option).
36890 .next
36891 For a daemon, queue runner, delivery, or address testing process, the uid
36892 remains as root at this stage, but the gid is changed to the Exim group.
36893 .endlist
36894
36895 The processes that initially retain root privilege behave as follows:
36896
36897 .ilist
36898 A daemon process changes the gid to the Exim group and the uid to the Exim
36899 user after setting up one or more listening sockets. The &[initgroups()]&
36900 function is called, so that if the Exim user is in any additional groups, they
36901 will be used during message reception.
36902 .next
36903 A queue runner process retains root privilege throughout its execution. Its
36904 job is to fork a controlled sequence of delivery processes.
36905 .next
36906 A delivery process retains root privilege throughout most of its execution,
36907 but any actual deliveries (that is, the transports themselves) are run in
36908 subprocesses which always change to a non-root uid and gid. For local
36909 deliveries this is typically the uid and gid of the owner of the mailbox; for
36910 remote deliveries, the Exim uid and gid are used. Once all the delivery
36911 subprocesses have been run, a delivery process changes to the Exim uid and gid
36912 while doing post-delivery tidying up such as updating the retry database and
36913 generating bounce and warning messages.
36914
36915 While the recipient addresses in a message are being routed, the delivery
36916 process runs as root. However, if a user's filter file has to be processed,
36917 this is done in a subprocess that runs under the individual user's uid and
36918 gid. A system filter is run as root unless &%system_filter_user%& is set.
36919 .next
36920 A process that is testing addresses (the &%-bt%& option) runs as root so that
36921 the routing is done in the same environment as a message delivery.
36922 .endlist
36923
36924
36925
36926
36927 .section "Running Exim without privilege" "SECTrunexiwitpri"
36928 .cindex "privilege, running without"
36929 .cindex "unprivileged running"
36930 .cindex "root privilege" "running without"
36931 Some installations like to run Exim in an unprivileged state for more of its
36932 operation, for added security. Support for this mode of operation is provided
36933 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36934 gid are changed to the Exim user and group at the start of a delivery process
36935 (and also queue runner and address testing processes). This means that address
36936 routing is no longer run as root, and the deliveries themselves cannot change
36937 to any other uid.
36938
36939 .cindex SIGHUP
36940 .cindex "daemon" "restarting"
36941 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
36942 that the daemon can still be started in the usual way, and it can respond
36943 correctly to SIGHUP because the re-invocation regains root privilege.
36944
36945 An alternative approach is to make Exim setuid to the Exim user and also setgid
36946 to the Exim group. If you do this, the daemon must be started from a root
36947 process. (Calling Exim from a root process makes it behave in the way it does
36948 when it is setuid root.) However, the daemon cannot restart itself after a
36949 SIGHUP signal because it cannot regain privilege.
36950
36951 It is still useful to set &%deliver_drop_privilege%& in this case, because it
36952 stops Exim from trying to re-invoke itself to do a delivery after a message has
36953 been received. Such a re-invocation is a waste of resources because it has no
36954 effect.
36955
36956 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
36957 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
36958 to the Exim user seems a clean approach, but there is one complication:
36959
36960 In this style of operation, Exim is running with the real uid and gid set to
36961 those of the calling process, and the effective uid/gid set to Exim's values.
36962 Ideally, any association with the calling process' uid/gid should be dropped,
36963 that is, the real uid/gid should be reset to the effective values so as to
36964 discard any privileges that the caller may have. While some operating systems
36965 have a function that permits this action for a non-root effective uid, quite a
36966 number of them do not. Because of this lack of standardization, Exim does not
36967 address this problem at this time.
36968
36969 For this reason, the recommended approach for &"mostly unprivileged"& running
36970 is to keep the Exim binary setuid to root, and to set
36971 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
36972 be used in the most straightforward way.
36973
36974 If you configure Exim not to run delivery processes as root, there are a
36975 number of restrictions on what you can do:
36976
36977 .ilist
36978 You can deliver only as the Exim user/group. You should  explicitly use the
36979 &%user%& and &%group%& options to override routers or local transports that
36980 normally deliver as the recipient. This makes sure that configurations that
36981 work in this mode function the same way in normal mode. Any implicit or
36982 explicit specification of another user causes an error.
36983 .next
36984 Use of &_.forward_& files is severely restricted, such that it is usually
36985 not worthwhile to include them in the configuration.
36986 .next
36987 Users who wish to use &_.forward_& would have to make their home directory and
36988 the file itself accessible to the Exim user. Pipe and append-to-file entries,
36989 and their equivalents in Exim filters, cannot be used. While they could be
36990 enabled in the Exim user's name, that would be insecure and not very useful.
36991 .next
36992 Unless the local user mailboxes are all owned by the Exim user (possible in
36993 some POP3 or IMAP-only environments):
36994
36995 .olist
36996 They must be owned by the Exim group and be writeable by that group. This
36997 implies you must set &%mode%& in the appendfile configuration, as well as the
36998 mode of the mailbox files themselves.
36999 .next
37000 You must set &%no_check_owner%&, since most or all of the files will not be
37001 owned by the Exim user.
37002 .next
37003 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37004 on a newly created mailbox when unprivileged. This also implies that new
37005 mailboxes need to be created manually.
37006 .endlist olist
37007 .endlist ilist
37008
37009
37010 These restrictions severely restrict what can be done in local deliveries.
37011 However, there are no restrictions on remote deliveries. If you are running a
37012 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37013 gives more security at essentially no cost.
37014
37015 If you are using the &%mua_wrapper%& facility (see chapter
37016 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37017
37018
37019
37020
37021 .section "Delivering to local files" "SECID271"
37022 Full details of the checks applied by &(appendfile)& before it writes to a file
37023 are given in chapter &<<CHAPappendfile>>&.
37024
37025
37026
37027 .section "Running local commands" "SECTsecconslocalcmds"
37028 .cindex "security" "local commands"
37029 .cindex "security" "command injection attacks"
37030 There are a number of ways in which an administrator can configure Exim to run
37031 commands based upon received, untrustworthy, data. Further, in some
37032 configurations a user who can control a &_.forward_& file can also arrange to
37033 run commands. Configuration to check includes, but is not limited to:
37034
37035 .ilist
37036 Use of &%use_shell%& in the pipe transport: various forms of shell command
37037 injection may be possible with this option present. It is dangerous and should
37038 be used only with considerable caution. Consider constraints which whitelist
37039 allowed characters in a variable which is to be used in a pipe transport that
37040 has &%use_shell%& enabled.
37041 .next
37042 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37043 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37044 &_.forward_& files in a redirect router. If Exim is running on a central mail
37045 hub to which ordinary users do not have shell access, but home directories are
37046 NFS mounted (for instance) then administrators should review the list of these
37047 forbid options available, and should bear in mind that the options that may
37048 need forbidding can change as new features are added between releases.
37049 .next
37050 The &%${run...}%& expansion item does not use a shell by default, but
37051 administrators can configure use of &_/bin/sh_& as part of the command.
37052 Such invocations should be viewed with prejudicial suspicion.
37053 .next
37054 Administrators who use embedded Perl are advised to explore how Perl's
37055 taint checking might apply to their usage.
37056 .next
37057 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
37058 administrators are well advised to view its use with suspicion, in case (for
37059 instance) it allows a local-part to contain embedded Exim directives.
37060 .next
37061 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37062 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37063 each can reference arbitrary lists and files, rather than just being a list
37064 of opaque strings.
37065 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37066 real-world security vulnerabilities caused by its use with untrustworthy data
37067 injected in, for SQL injection attacks.
37068 Consider the use of the &%inlisti%& expansion condition instead.
37069 .endlist
37070
37071
37072
37073
37074 .section "Trust in configuration data" "SECTsecconfdata"
37075 .cindex "security" "data sources"
37076 .cindex "security" "regular expressions"
37077 .cindex "regular expressions" "security"
37078 .cindex "PCRE" "security"
37079 If configuration data for Exim can come from untrustworthy sources, there
37080 are some issues to be aware of:
37081
37082 .ilist
37083 Use of &%${expand...}%& may provide a path for shell injection attacks.
37084 .next
37085 Letting untrusted data provide a regular expression is unwise.
37086 .next
37087 Using &%${match...}%& to apply a fixed regular expression against untrusted
37088 data may result in pathological behaviour within PCRE.  Be aware of what
37089 "backtracking" means and consider options for being more strict with a regular
37090 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37091 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37092 possessive quantifiers or just not using regular expressions against untrusted
37093 data.
37094 .next
37095 It can be important to correctly use &%${quote:...}%&,
37096 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37097 items to ensure that data is correctly constructed.
37098 .next
37099 Some lookups might return multiple results, even though normal usage is only
37100 expected to yield one result.
37101 .endlist
37102
37103
37104
37105
37106 .section "IPv4 source routing" "SECID272"
37107 .cindex "source routing" "in IP packets"
37108 .cindex "IP source routing"
37109 Many operating systems suppress IP source-routed packets in the kernel, but
37110 some cannot be made to do this, so Exim does its own check. It logs incoming
37111 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37112 IPv6. No special checking is currently done.
37113
37114
37115
37116 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37117 Support for these SMTP commands is disabled by default. If required, they can
37118 be enabled by defining suitable ACLs.
37119
37120
37121
37122
37123 .section "Privileged users" "SECID274"
37124 .cindex "trusted users"
37125 .cindex "admin user"
37126 .cindex "privileged user"
37127 .cindex "user" "trusted"
37128 .cindex "user" "admin"
37129 Exim recognizes two sets of users with special privileges. Trusted users are
37130 able to submit new messages to Exim locally, but supply their own sender
37131 addresses and information about a sending host. For other users submitting
37132 local messages, Exim sets up the sender address from the uid, and doesn't
37133 permit a remote host to be specified.
37134
37135 .oindex "&%-f%&"
37136 However, an untrusted user is permitted to use the &%-f%& command line option
37137 in the special form &%-f <>%& to indicate that a delivery failure for the
37138 message should not cause an error report. This affects the message's envelope,
37139 but it does not affect the &'Sender:'& header. Untrusted users may also be
37140 permitted to use specific forms of address with the &%-f%& option by setting
37141 the &%untrusted_set_sender%& option.
37142
37143 Trusted users are used to run processes that receive mail messages from some
37144 other mail domain and pass them on to Exim for delivery either locally, or over
37145 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37146 as any user listed in the &%trusted_users%& configuration option, or under any
37147 group listed in the &%trusted_groups%& option.
37148
37149 Admin users are permitted to do things to the messages on Exim's queue. They
37150 can freeze or thaw messages, cause them to be returned to their senders, remove
37151 them entirely, or modify them in various ways. In addition, admin users can run
37152 the Exim monitor and see all the information it is capable of providing, which
37153 includes the contents of files on the spool.
37154
37155 .oindex "&%-M%&"
37156 .oindex "&%-q%&"
37157 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37158 delivery of messages on its queue is restricted to admin users. This
37159 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37160 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37161 queue is also restricted to admin users. This restriction can be relaxed by
37162 setting &%no_queue_list_requires_admin%&.
37163
37164 Exim recognizes an admin user if the calling process is running as root or as
37165 the Exim user or if any of the groups associated with the calling process is
37166 the Exim group. It is not necessary actually to be running under the Exim
37167 group. However, if admin users who are not root or the Exim user are to access
37168 the contents of files on the spool via the Exim monitor (which runs
37169 unprivileged), Exim must be built to allow group read access to its spool
37170 files.
37171
37172
37173
37174 .section "Spool files" "SECID275"
37175 .cindex "spool directory" "files"
37176 Exim's spool directory and everything it contains is owned by the Exim user and
37177 set to the Exim group. The mode for spool files is defined in the
37178 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37179 any user who is a member of the Exim group can access these files.
37180
37181
37182
37183 .section "Use of argv[0]" "SECID276"
37184 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37185 of specific strings, Exim assumes certain options. For example, calling Exim
37186 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37187 to calling it with the option &%-bS%&. There are no security implications in
37188 this.
37189
37190
37191
37192 .section "Use of %f formatting" "SECID277"
37193 The only use made of &"%f"& by Exim is in formatting load average values. These
37194 are actually stored in integer variables as 1000 times the load average.
37195 Consequently, their range is limited and so therefore is the length of the
37196 converted output.
37197
37198
37199
37200 .section "Embedded Exim path" "SECID278"
37201 Exim uses its own path name, which is embedded in the code, only when it needs
37202 to re-exec in order to regain root privilege. Therefore, it is not root when it
37203 does so. If some bug allowed the path to get overwritten, it would lead to an
37204 arbitrary program's being run as exim, not as root.
37205
37206
37207
37208 .section "Dynamic module directory" "SECTdynmoddir"
37209 Any dynamically loadable modules must be installed into the directory
37210 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37211 loading it.
37212
37213
37214 .section "Use of sprintf()" "SECID279"
37215 .cindex "&[sprintf()]&"
37216 A large number of occurrences of &"sprintf"& in the code are actually calls to
37217 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37218 The intermediate formatting is done into a large fixed buffer by a function
37219 that runs through the format string itself, and checks the length of each
37220 conversion before performing it, thus preventing buffer overruns.
37221
37222 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37223 the output buffer is known to be sufficiently long to contain the converted
37224 string.
37225
37226
37227
37228 .section "Use of debug_printf() and log_write()" "SECID280"
37229 Arbitrary strings are passed to both these functions, but they do their
37230 formatting by calling the function &'string_vformat()'&, which runs through
37231 the format string itself, and checks the length of each conversion.
37232
37233
37234
37235 .section "Use of strcat() and strcpy()" "SECID281"
37236 These are used only in cases where the output buffer is known to be large
37237 enough to hold the result.
37238 .ecindex IIDsecurcon
37239
37240
37241
37242
37243 . ////////////////////////////////////////////////////////////////////////////
37244 . ////////////////////////////////////////////////////////////////////////////
37245
37246 .chapter "Format of spool files" "CHAPspool"
37247 .scindex IIDforspo1 "format" "spool files"
37248 .scindex IIDforspo2 "spool directory" "format of files"
37249 .scindex IIDforspo3 "spool files" "format of"
37250 .cindex "spool files" "editing"
37251 A message on Exim's queue consists of two files, whose names are the message id
37252 followed by -D and -H, respectively. The data portion of the message is kept in
37253 the -D file on its own. The message's envelope, status, and headers are all
37254 kept in the -H file, whose format is described in this chapter. Each of these
37255 two files contains the final component of its own name as its first line. This
37256 is insurance against disk crashes where the directory is lost but the files
37257 themselves are recoverable.
37258
37259 Some people are tempted into editing -D files in order to modify messages. You
37260 need to be extremely careful if you do this; it is not recommended and you are
37261 on your own if you do it. Here are some of the pitfalls:
37262
37263 .ilist
37264 You must ensure that Exim does not try to deliver the message while you are
37265 fiddling with it. The safest way is to take out a write lock on the -D file,
37266 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37267 place, the lock will be retained. If you write a new file and rename it, the
37268 lock will be lost at the instant of rename.
37269 .next
37270 .vindex "&$body_linecount$&"
37271 If you change the number of lines in the file, the value of
37272 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37273 present, this value is not used by Exim, but there is no guarantee that this
37274 will always be the case.
37275 .next
37276 If the message is in MIME format, you must take care not to break it.
37277 .next
37278 If the message is cryptographically signed, any change will invalidate the
37279 signature.
37280 .endlist
37281 All in all, modifying -D files is fraught with danger.
37282
37283 Files whose names end with -J may also be seen in the &_input_& directory (or
37284 its subdirectories when &%split_spool_directory%& is set). These are journal
37285 files, used to record addresses to which the message has been delivered during
37286 the course of a delivery attempt. If there are still undelivered recipients at
37287 the end, the -H file is updated, and the -J file is deleted. If, however, there
37288 is some kind of crash (for example, a power outage) before this happens, the -J
37289 file remains in existence. When Exim next processes the message, it notices the
37290 -J file and uses it to update the -H file before starting the next delivery
37291 attempt.
37292
37293 .section "Format of the -H file" "SECID282"
37294 .cindex "uid (user id)" "in spool file"
37295 .cindex "gid (group id)" "in spool file"
37296 The second line of the -H file contains the login name for the uid of the
37297 process that called Exim to read the message, followed by the numerical uid and
37298 gid. For a locally generated message, this is normally the user who sent the
37299 message. For a message received over TCP/IP via the daemon, it is
37300 normally the Exim user.
37301
37302 The third line of the file contains the address of the message's sender as
37303 transmitted in the envelope, contained in angle brackets. The sender address is
37304 empty for bounce messages. For incoming SMTP mail, the sender address is given
37305 in the MAIL command. For locally generated mail, the sender address is
37306 created by Exim from the login name of the current user and the configured
37307 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37308 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37309 &"<>"& or an address that matches &%untrusted_set_senders%&.
37310
37311 The fourth line contains two numbers. The first is the time that the message
37312 was received, in the conventional Unix form &-- the number of seconds since the
37313 start of the epoch. The second number is a count of the number of messages
37314 warning of delayed delivery that have been sent to the sender.
37315
37316 There follow a number of lines starting with a hyphen. These can appear in any
37317 order, and are omitted when not relevant:
37318
37319 .vlist
37320 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37321 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37322 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37323 recognized, to provide backward compatibility. In the old format, a line of
37324 this form is present for every ACL variable that is not empty. The number
37325 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37326 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37327 the data string for the variable. The string itself starts at the beginning of
37328 the next line, and is followed by a newline character. It may contain internal
37329 newlines.
37330
37331 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37332 A line of this form is present for every ACL connection variable that is
37333 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37334 The length is the length of the data string for the variable. The string itself
37335 starts at the beginning of the next line, and is followed by a newline
37336 character. It may contain internal newlines.
37337
37338 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37339 A line of this form is present for every ACL message variable that is defined.
37340 Note that there is a space between &%-aclm%& and the rest of the name. The
37341 length is the length of the data string for the variable. The string itself
37342 starts at the beginning of the next line, and is followed by a newline
37343 character. It may contain internal newlines.
37344
37345 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37346 This is present if, when the message was received over SMTP, the value of
37347 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37348
37349 .vitem &%-allow_unqualified_recipient%&
37350 This is present if unqualified recipient addresses are permitted in header
37351 lines (to stop such addresses from being qualified if rewriting occurs at
37352 transport time). Local messages that were input using &%-bnq%& and remote
37353 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37354
37355 .vitem &%-allow_unqualified_sender%&
37356 This is present if unqualified sender addresses are permitted in header lines
37357 (to stop such addresses from being qualified if rewriting occurs at transport
37358 time). Local messages that were input using &%-bnq%& and remote messages from
37359 hosts that match &%sender_unqualified_hosts%& set this flag.
37360
37361 .vitem "&%-auth_id%&&~<&'text'&>"
37362 The id information for a message received on an authenticated SMTP connection
37363 &-- the value of the &$authenticated_id$& variable.
37364
37365 .vitem "&%-auth_sender%&&~<&'address'&>"
37366 The address of an authenticated sender &-- the value of the
37367 &$authenticated_sender$& variable.
37368
37369 .vitem "&%-body_linecount%&&~<&'number'&>"
37370 This records the number of lines in the body of the message, and is always
37371 present.
37372
37373 .vitem "&%-body_zerocount%&&~<&'number'&>"
37374 This records the number of binary zero bytes in the body of the message, and is
37375 present if the number is greater than zero.
37376
37377 .vitem &%-deliver_firsttime%&
37378 This is written when a new message is first added to the spool. When the spool
37379 file is updated after a deferral, it is omitted.
37380
37381 .vitem "&%-frozen%&&~<&'time'&>"
37382 .cindex "frozen messages" "spool data"
37383 The message is frozen, and the freezing happened at <&'time'&>.
37384
37385 .vitem "&%-helo_name%&&~<&'text'&>"
37386 This records the host name as specified by a remote host in a HELO or EHLO
37387 command.
37388
37389 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37390 This records the IP address of the host from which the message was received and
37391 the remote port number that was used. It is omitted for locally generated
37392 messages.
37393
37394 .vitem "&%-host_auth%&&~<&'text'&>"
37395 If the message was received on an authenticated SMTP connection, this records
37396 the name of the authenticator &-- the value of the
37397 &$sender_host_authenticated$& variable.
37398
37399 .vitem &%-host_lookup_failed%&
37400 This is present if an attempt to look up the sending host's name from its IP
37401 address failed. It corresponds to the &$host_lookup_failed$& variable.
37402
37403 .vitem "&%-host_name%&&~<&'text'&>"
37404 .cindex "reverse DNS lookup"
37405 .cindex "DNS" "reverse lookup"
37406 This records the name of the remote host from which the message was received,
37407 if the host name was looked up from the IP address when the message was being
37408 received. It is not present if no reverse lookup was done.
37409
37410 .vitem "&%-ident%&&~<&'text'&>"
37411 For locally submitted messages, this records the login of the originating user,
37412 unless it was a trusted user and the &%-oMt%& option was used to specify an
37413 ident value. For messages received over TCP/IP, this records the ident string
37414 supplied by the remote host, if any.
37415
37416 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37417 This records the IP address of the local interface and the port number through
37418 which a message was received from a remote host. It is omitted for locally
37419 generated messages.
37420
37421 .vitem &%-local%&
37422 The message is from a local sender.
37423
37424 .vitem &%-localerror%&
37425 The message is a locally-generated bounce message.
37426
37427 .vitem "&%-local_scan%&&~<&'string'&>"
37428 This records the data string that was returned by the &[local_scan()]& function
37429 when the message was received &-- the value of the &$local_scan_data$&
37430 variable. It is omitted if no data was returned.
37431
37432 .vitem &%-manual_thaw%&
37433 The message was frozen but has been thawed manually, that is, by an explicit
37434 Exim command rather than via the auto-thaw process.
37435
37436 .vitem &%-N%&
37437 A testing delivery process was started using the &%-N%& option to suppress any
37438 actual deliveries, but delivery was deferred. At any further delivery attempts,
37439 &%-N%& is assumed.
37440
37441 .vitem &%-received_protocol%&
37442 This records the value of the &$received_protocol$& variable, which contains
37443 the name of the protocol by which the message was received.
37444
37445 .vitem &%-sender_set_untrusted%&
37446 The envelope sender of this message was set by an untrusted local caller (used
37447 to ensure that the caller is displayed in queue listings).
37448
37449 .vitem "&%-spam_score_int%&&~<&'number'&>"
37450 If a message was scanned by SpamAssassin, this is present. It records the value
37451 of &$spam_score_int$&.
37452
37453 .vitem &%-tls_certificate_verified%&
37454 A TLS certificate was received from the client that sent this message, and the
37455 certificate was verified by the server.
37456
37457 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37458 When the message was received over an encrypted connection, this records the
37459 name of the cipher suite that was used.
37460
37461 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37462 When the message was received over an encrypted connection, and a certificate
37463 was received from the client, this records the Distinguished Name from that
37464 certificate.
37465 .endlist
37466
37467 Following the options there is a list of those addresses to which the message
37468 is not to be delivered. This set of addresses is initialized from the command
37469 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37470 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37471 the address is added to this set. The addresses are kept internally as a
37472 balanced binary tree, and it is a representation of that tree which is written
37473 to the spool file. If an address is expanded via an alias or forward file, the
37474 original address is added to the tree when deliveries to all its child
37475 addresses are complete.
37476
37477 If the tree is empty, there is a single line in the spool file containing just
37478 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37479 Y or N, followed by an address. The address is the value for the node of the
37480 tree, and the letters indicate whether the node has a left branch and/or a
37481 right branch attached to it, respectively. If branches exist, they immediately
37482 follow. Here is an example of a three-node tree:
37483 .code
37484 YY darcy@austen.fict.example
37485 NN alice@wonderland.fict.example
37486 NN editor@thesaurus.ref.example
37487 .endd
37488 After the non-recipients tree, there is a list of the message's recipients.
37489 This is a simple list, preceded by a count. It includes all the original
37490 recipients of the message, including those to whom the message has already been
37491 delivered. In the simplest case, the list contains one address per line. For
37492 example:
37493 .code
37494 4
37495 editor@thesaurus.ref.example
37496 darcy@austen.fict.example
37497 rdo@foundation
37498 alice@wonderland.fict.example
37499 .endd
37500 However, when a child address has been added to the top-level addresses as a
37501 result of the use of the &%one_time%& option on a &(redirect)& router, each
37502 line is of the following form:
37503 .display
37504 <&'top-level address'&> <&'errors_to address'&> &&&
37505   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37506 .endd
37507 The 01 flag bit indicates the presence of the three other fields that follow
37508 the top-level address. Other bits may be used in future to support additional
37509 fields. The <&'parent number'&> is the offset in the recipients list of the
37510 original parent of the &"one time"& address. The first two fields are the
37511 envelope sender that is associated with this address and its length. If the
37512 length is zero, there is no special envelope sender (there are then two space
37513 characters in the line). A non-empty field can arise from a &(redirect)& router
37514 that has an &%errors_to%& setting.
37515
37516
37517 A blank line separates the envelope and status information from the headers
37518 which follow. A header may occupy several lines of the file, and to save effort
37519 when reading it in, each header is preceded by a number and an identifying
37520 character. The number is the number of characters in the header, including any
37521 embedded newlines and the terminating newline. The character is one of the
37522 following:
37523
37524 .table2 50pt
37525 .row <&'blank'&>         "header in which Exim has no special interest"
37526 .row &`B`&               "&'Bcc:'& header"
37527 .row &`C`&               "&'Cc:'& header"
37528 .row &`F`&               "&'From:'& header"
37529 .row &`I`&               "&'Message-id:'& header"
37530 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37531 .row &`R`&               "&'Reply-To:'& header"
37532 .row &`S`&               "&'Sender:'& header"
37533 .row &`T`&               "&'To:'& header"
37534 .row &`*`&               "replaced or deleted header"
37535 .endtable
37536
37537 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37538 purposes. They are not transmitted when the message is delivered. Here is a
37539 typical set of headers:
37540 .code
37541 111P Received: by hobbit.fict.example with local (Exim 4.00)
37542 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37543 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37544 038* X-rewrote-sender: bb@hobbit.fict.example
37545 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37546 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37547 099* To: alice@wonderland.fict.example, rdo@foundation,
37548 darcy@austen.fict.example, editor@thesaurus.ref.example
37549 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37550 darcy@austen.fict.example, editor@thesaurus.ref.example
37551 038  Date: Fri, 11 May 2001 10:28:59 +0100
37552 .endd
37553 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37554 &'To:'& header have been rewritten, the last one because routing expanded the
37555 unqualified domain &'foundation'&.
37556 .ecindex IIDforspo1
37557 .ecindex IIDforspo2
37558 .ecindex IIDforspo3
37559
37560 . ////////////////////////////////////////////////////////////////////////////
37561 . ////////////////////////////////////////////////////////////////////////////
37562
37563 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37564          "DKIM Support"
37565 .cindex "DKIM"
37566
37567 DKIM is a mechanism by which messages sent by some entity can be provably
37568 linked to a domain which that entity controls.  It permits reputation to
37569 be tracked on a per-domain basis, rather than merely upon source IP address.
37570 DKIM is documented in RFC 4871.
37571
37572 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37573 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37574
37575 Exim's DKIM implementation allows to
37576 .olist
37577 Sign outgoing messages: This function is implemented in the SMTP transport.
37578 It can co-exist with all other Exim features
37579 (including transport filters)
37580 except cutthrough delivery.
37581 .next
37582 Verify signatures in incoming messages: This is implemented by an additional
37583 ACL (acl_smtp_dkim), which can be called several times per message, with
37584 different signature contexts.
37585 .endlist
37586
37587 In typical Exim style, the verification implementation does not include any
37588 default "policy". Instead it enables you to build your own policy using
37589 Exim's standard controls.
37590
37591 Please note that verification of DKIM signatures in incoming mail is turned
37592 on by default for logging purposes. For each signature in incoming email,
37593 exim will log a line displaying the most important signature details, and the
37594 signature status. Here is an example (with line-breaks added for clarity):
37595 .code
37596 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37597     d=facebookmail.com s=q1-2009b
37598     c=relaxed/relaxed a=rsa-sha1
37599     i=@facebookmail.com t=1252484542 [verification succeeded]
37600 .endd
37601 You might want to turn off DKIM verification processing entirely for internal
37602 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37603 control modifier. This should typically be done in the RCPT ACL, at points
37604 where you accept mail from relay sources (internal hosts or authenticated
37605 senders).
37606
37607
37608 .section "Signing outgoing messages" "SECID513"
37609 .cindex "DKIM" "signing"
37610
37611 Signing is implemented by setting private options on the SMTP transport.
37612 These options take (expandable) strings as arguments.
37613
37614 .option dkim_domain smtp string&!! unset
37615 MANDATORY:
37616 The domain you want to sign with. The result of this expanded
37617 option is put into the &%$dkim_domain%& expansion variable.
37618
37619 .option dkim_selector smtp string&!! unset
37620 MANDATORY:
37621 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37622 variable to look up a matching selector. The result is put in the expansion
37623 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37624 option along with &%$dkim_domain%&.
37625
37626 .option dkim_private_key smtp string&!! unset
37627 MANDATORY:
37628 This sets the private key to use. You can use the &%$dkim_domain%& and
37629 &%$dkim_selector%& expansion variables to determine the private key to use.
37630 The result can either
37631 .ilist
37632 be a valid RSA private key in ASCII armor, including line breaks.
37633 .next
37634 start with a slash, in which case it is treated as a file that contains
37635 the private key.
37636 .next
37637 be "0", "false" or the empty string, in which case the message will not
37638 be signed. This case will not result in an error, even if &%dkim_strict%&
37639 is set.
37640 .endlist
37641
37642 .option dkim_canon smtp string&!! unset
37643 OPTIONAL:
37644 This option sets the canonicalization method used when signing a message.
37645 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37646 The option defaults to "relaxed" when unset. Note: the current implementation
37647 only supports using the same canonicalization method for both headers and body.
37648
37649 .option dkim_strict smtp string&!! unset
37650 OPTIONAL:
37651 This  option  defines  how  Exim  behaves  when  signing a message that
37652 should be signed fails for some reason.  When the expansion evaluates to
37653 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37654 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37655 variables here.
37656
37657 .option dkim_sign_headers smtp string&!! unset
37658 OPTIONAL:
37659 When set, this option must expand to (or be specified as) a colon-separated
37660 list of header names. Headers with these names will be included in the message
37661 signature. When unspecified, the header names recommended in RFC4871 will be
37662 used.
37663
37664
37665 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37666 .cindex "DKIM" "verification"
37667
37668 Verification of DKIM signatures in incoming email is implemented via the
37669 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37670 syntactically(!) correct signature in the incoming message.
37671 A missing ACL definition defaults to accept.
37672 If any ACL call does not acccept, the message is not accepted.
37673 If a cutthrough delivery was in progress for the message it is
37674 summarily dropped (having wasted the transmission effort).
37675
37676 To evaluate the signature in the ACL a large number of expansion variables
37677 containing the signature status and its details are set up during the
37678 runtime of the ACL.
37679
37680 Calling the ACL only for existing signatures is not sufficient to build
37681 more advanced policies. For that reason, the global option
37682 &%dkim_verify_signers%&, and a global expansion variable
37683 &%$dkim_signers%& exist.
37684
37685 The global option &%dkim_verify_signers%& can be set to a colon-separated
37686 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37687 called. It is expanded when the message has been received. At this point,
37688 the expansion variable &%$dkim_signers%& already contains a colon-separated
37689 list of signer domains and identities for the message. When
37690 &%dkim_verify_signers%& is not specified in the main configuration,
37691 it defaults as:
37692 .code
37693 dkim_verify_signers = $dkim_signers
37694 .endd
37695 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37696 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37697 call the ACL for known domains or identities. This would be achieved as follows:
37698 .code
37699 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37700 .endd
37701 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37702 and "ebay.com", plus all domains and identities that have signatures in the message.
37703 You can also be more creative in constructing your policy. For example:
37704 .code
37705 dkim_verify_signers = $sender_address_domain:$dkim_signers
37706 .endd
37707
37708 If a domain or identity is listed several times in the (expanded) value of
37709 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37710
37711
37712 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37713 available (from most to least important):
37714
37715
37716 .vlist
37717 .vitem &%$dkim_cur_signer%&
37718 The signer that is being evaluated in this ACL run. This can be a domain or
37719 an identity. This is one of the list items from the expanded main option
37720 &%dkim_verify_signers%& (see above).
37721 .vitem &%$dkim_verify_status%&
37722 A string describing the general status of the signature. One of
37723 .ilist
37724 &%none%&: There is no signature in the message for the current domain or
37725 identity (as reflected by &%$dkim_cur_signer%&).
37726 .next
37727 &%invalid%&: The signature could not be verified due to a processing error.
37728 More detail is available in &%$dkim_verify_reason%&.
37729 .next
37730 &%fail%&: Verification of the signature failed.  More detail is
37731 available in &%$dkim_verify_reason%&.
37732 .next
37733 &%pass%&: The signature passed verification. It is valid.
37734 .endlist
37735 .vitem &%$dkim_verify_reason%&
37736 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37737 "fail" or "invalid". One of
37738 .ilist
37739 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37740 key for the domain could not be retrieved. This may be a temporary problem.
37741 .next
37742 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37743 record for the domain is syntactically invalid.
37744 .next
37745 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37746 body hash does not match the one specified in the signature header. This
37747 means that the message body was modified in transit.
37748 .next
37749 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37750 could not be verified. This may mean that headers were modified,
37751 re-written or otherwise changed in a way which is incompatible with
37752 DKIM verification. It may of course also mean that the signature is forged.
37753 .endlist
37754 .vitem &%$dkim_domain%&
37755 The signing domain. IMPORTANT: This variable is only populated if there is
37756 an actual signature in the message for the current domain or identity (as
37757 reflected by &%$dkim_cur_signer%&).
37758 .vitem &%$dkim_identity%&
37759 The signing identity, if present. IMPORTANT: This variable is only populated
37760 if there is an actual signature in the message for the current domain or
37761 identity (as reflected by &%$dkim_cur_signer%&).
37762 .vitem &%$dkim_selector%&
37763 The key record selector string.
37764 .vitem &%$dkim_algo%&
37765 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37766 .vitem &%$dkim_canon_body%&
37767 The body canonicalization method. One of 'relaxed' or 'simple'.
37768 .vitem &%dkim_canon_headers%&
37769 The header canonicalization method. One of 'relaxed' or 'simple'.
37770 .vitem &%$dkim_copiedheaders%&
37771 A transcript of headers and their values which are included in the signature
37772 (copied from the 'z=' tag of the signature).
37773 .vitem &%$dkim_bodylength%&
37774 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37775 limit was set by the signer, "9999999999999" is returned. This makes sure
37776 that this variable always expands to an integer value.
37777 .vitem &%$dkim_created%&
37778 UNIX timestamp reflecting the date and time when the signature was created.
37779 When this was not specified by the signer, "0" is returned.
37780 .vitem &%$dkim_expires%&
37781 UNIX timestamp reflecting the date and time when the signer wants the
37782 signature to be treated as "expired". When this was not specified by the
37783 signer, "9999999999999" is returned. This makes it possible to do useful
37784 integer size comparisons against this value.
37785 .vitem &%$dkim_headernames%&
37786 A colon-separated list of names of headers included in the signature.
37787 .vitem &%$dkim_key_testing%&
37788 "1" if the key record has the "testing" flag set, "0" if not.
37789 .vitem &%$dkim_key_nosubdomains%&
37790 "1" if the key record forbids subdomaining, "0" otherwise.
37791 .vitem &%$dkim_key_srvtype%&
37792 Service type (tag s=) from the key record. Defaults to "*" if not specified
37793 in the key record.
37794 .vitem &%$dkim_key_granularity%&
37795 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37796 in the key record.
37797 .vitem &%$dkim_key_notes%&
37798 Notes from the key record (tag n=).
37799 .endlist
37800
37801 In addition, two ACL conditions are provided:
37802
37803 .vlist
37804 .vitem &%dkim_signers%&
37805 ACL condition that checks a colon-separated list of domains or identities
37806 for a match against the domain or identity that the ACL is currently verifying
37807 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37808 verb to a group of domains or identities. For example:
37809
37810 .code
37811 # Warn when Mail purportedly from GMail has no signature at all
37812 warn log_message = GMail sender without DKIM signature
37813      sender_domains = gmail.com
37814      dkim_signers = gmail.com
37815      dkim_status = none
37816 .endd
37817
37818 .vitem &%dkim_status%&
37819 ACL condition that checks a colon-separated list of possible DKIM verification
37820 results against the actual result of verification. This is typically used
37821 to restrict an ACL verb to a list of verification outcomes, for example:
37822
37823 .code
37824 deny message = Mail from Paypal with invalid/missing signature
37825      sender_domains = paypal.com:paypal.de
37826      dkim_signers = paypal.com:paypal.de
37827      dkim_status = none:invalid:fail
37828 .endd
37829
37830 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37831 see the documentation of the &%$dkim_verify_status%& expansion variable above
37832 for more information of what they mean.
37833 .endlist
37834
37835 . ////////////////////////////////////////////////////////////////////////////
37836 . ////////////////////////////////////////////////////////////////////////////
37837
37838 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37839          "Adding drivers or lookups"
37840 .cindex "adding drivers"
37841 .cindex "new drivers, adding"
37842 .cindex "drivers" "adding new"
37843 The following actions have to be taken in order to add a new router, transport,
37844 authenticator, or lookup type to Exim:
37845
37846 .olist
37847 Choose a name for the driver or lookup type that does not conflict with any
37848 existing name; I will use &"newdriver"& in what follows.
37849 .next
37850 Add to &_src/EDITME_& the line:
37851 .display
37852 <&'type'&>&`_NEWDRIVER=yes`&
37853 .endd
37854 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37855 code is not to be included in the binary by default, comment this line out. You
37856 should also add any relevant comments about the driver or lookup type.
37857 .next
37858 Add to &_src/config.h.defaults_& the line:
37859 .code
37860 #define <type>_NEWDRIVER
37861 .endd
37862 .next
37863 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37864 and create a table entry as is done for all the other drivers and lookup types.
37865 .next
37866 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37867 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37868 Add your &`NEWDRIVER`& to that list.
37869 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37870 simple form that most lookups have.
37871 .next
37872 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37873 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37874 driver or lookup type and add it to the definition of OBJ.
37875 .next
37876 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37877 &_src_&.
37878 .next
37879 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37880 as for other drivers and lookups.
37881 .endlist
37882
37883 Then all you need to do is write the code! A good way to start is to make a
37884 proforma by copying an existing module of the same type, globally changing all
37885 occurrences of the name, and cutting out most of the code. Note that any
37886 options you create must be listed in alphabetical order, because the tables are
37887 searched using a binary chop procedure.
37888
37889 There is a &_README_& file in each of the sub-directories of &_src_& describing
37890 the interface that is expected.
37891
37892
37893
37894
37895 . ////////////////////////////////////////////////////////////////////////////
37896 . ////////////////////////////////////////////////////////////////////////////
37897
37898 . /////////////////////////////////////////////////////////////////////////////
37899 . These lines are processing instructions for the Simple DocBook Processor that
37900 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37901 . PDFs than using xmlto and fop. They will be ignored by all other XML
37902 . processors.
37903 . /////////////////////////////////////////////////////////////////////////////
37904
37905 .literal xml
37906 <?sdop
37907   format="newpage"
37908   foot_right_recto="&chaptertitle;"
37909   foot_right_verso="&chaptertitle;"
37910 ?>
37911 .literal off
37912
37913 .makeindex "Options index"   "option"
37914 .makeindex "Variables index" "variable"
37915 .makeindex "Concept index"   "concept"
37916
37917
37918 . /////////////////////////////////////////////////////////////////////////////
37919 . /////////////////////////////////////////////////////////////////////////////