6c3d155d95598898d944d4b09569174643e118a5
[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
5014 (or &`A`& or &`AA`&), and 100M
5015 otherwise. If there is more than one macro named on the line, the condition
5016 is true if any of them are defined. That is, it is an &"or"& condition. To
5017 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5018
5019 Although you can use a macro expansion to generate one of these directives,
5020 it is not very useful, because the condition &"there was a macro substitution
5021 in this line"& will always be true.
5022
5023 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5024 to clarify complicated nestings.
5025
5026
5027
5028 .section "Common option syntax" "SECTcos"
5029 .cindex "common option syntax"
5030 .cindex "syntax of common options"
5031 .cindex "configuration file" "common option syntax"
5032 For the main set of options, driver options, and &[local_scan()]& options,
5033 each setting is on a line by itself, and starts with a name consisting of
5034 lower-case letters and underscores. Many options require a data value, and in
5035 these cases the name must be followed by an equals sign (with optional white
5036 space) and then the value. For example:
5037 .code
5038 qualify_domain = mydomain.example.com
5039 .endd
5040 .cindex "hiding configuration option values"
5041 .cindex "configuration options" "hiding value of"
5042 .cindex "options" "hiding value of"
5043 Some option settings may contain sensitive data, for example, passwords for
5044 accessing databases. To stop non-admin users from using the &%-bP%& command
5045 line option to read these values, you can precede the option settings with the
5046 word &"hide"&. For example:
5047 .code
5048 hide mysql_servers = localhost/users/admin/secret-password
5049 .endd
5050 For non-admin users, such options are displayed like this:
5051 .code
5052 mysql_servers = <value not displayable>
5053 .endd
5054 If &"hide"& is used on a driver option, it hides the value of that option on
5055 all instances of the same driver.
5056
5057 The following sections describe the syntax used for the different data types
5058 that are found in option settings.
5059
5060
5061 .section "Boolean options" "SECID47"
5062 .cindex "format" "boolean"
5063 .cindex "boolean configuration values"
5064 .oindex "&%no_%&&'xxx'&"
5065 .oindex "&%not_%&&'xxx'&"
5066 Options whose type is given as boolean are on/off switches. There are two
5067 different ways of specifying such options: with and without a data value. If
5068 the option name is specified on its own without data, the switch is turned on;
5069 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5070 boolean options may be followed by an equals sign and one of the words
5071 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5072 the following two settings have exactly the same effect:
5073 .code
5074 queue_only
5075 queue_only = true
5076 .endd
5077 The following two lines also have the same (opposite) effect:
5078 .code
5079 no_queue_only
5080 queue_only = false
5081 .endd
5082 You can use whichever syntax you prefer.
5083
5084
5085
5086
5087 .section "Integer values" "SECID48"
5088 .cindex "integer configuration values"
5089 .cindex "format" "integer"
5090 If an option's type is given as &"integer"&, the value can be given in decimal,
5091 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5092 number is assumed. Otherwise, it is treated as an octal number unless it starts
5093 with the characters &"0x"&, in which case the remainder is interpreted as a
5094 hexadecimal number.
5095
5096 If an integer value is followed by the letter K, it is multiplied by 1024; if
5097 it is followed by the letter M, it is multiplied by 1024x1024. When the values
5098 of integer option settings are output, values which are an exact multiple of
5099 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5100 and M. The printing style is independent of the actual input format that was
5101 used.
5102
5103
5104 .section "Octal integer values" "SECID49"
5105 .cindex "integer format"
5106 .cindex "format" "octal integer"
5107 If an option's type is given as &"octal integer"&, its value is always
5108 interpreted as an octal number, whether or not it starts with the digit zero.
5109 Such options are always output in octal.
5110
5111
5112 .section "Fixed point numbers" "SECID50"
5113 .cindex "fixed point configuration values"
5114 .cindex "format" "fixed point"
5115 If an option's type is given as &"fixed-point"&, its value must be a decimal
5116 integer, optionally followed by a decimal point and up to three further digits.
5117
5118
5119
5120 .section "Time intervals" "SECTtimeformat"
5121 .cindex "time interval" "specifying in configuration"
5122 .cindex "format" "time interval"
5123 A time interval is specified as a sequence of numbers, each followed by one of
5124 the following letters, with no intervening white space:
5125
5126 .table2 30pt
5127 .irow &%s%& seconds
5128 .irow &%m%& minutes
5129 .irow &%h%& hours
5130 .irow &%d%& days
5131 .irow &%w%& weeks
5132 .endtable
5133
5134 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5135 intervals are output in the same format. Exim does not restrict the values; it
5136 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5137
5138
5139
5140 .section "String values" "SECTstrings"
5141 .cindex "string" "format of configuration values"
5142 .cindex "format" "string"
5143 If an option's type is specified as &"string"&, the value can be specified with
5144 or without double-quotes. If it does not start with a double-quote, the value
5145 consists of the remainder of the line plus any continuation lines, starting at
5146 the first character after any leading white space, with trailing white space
5147 removed, and with no interpretation of the characters in the string. Because
5148 Exim removes comment lines (those beginning with #) at an early stage, they can
5149 appear in the middle of a multi-line string. The following two settings are
5150 therefore equivalent:
5151 .code
5152 trusted_users = uucp:mail
5153 trusted_users = uucp:\
5154                 # This comment line is ignored
5155                 mail
5156 .endd
5157 .cindex "string" "quoted"
5158 .cindex "escape characters in quoted strings"
5159 If a string does start with a double-quote, it must end with a closing
5160 double-quote, and any backslash characters other than those used for line
5161 continuation are interpreted as escape characters, as follows:
5162
5163 .table2 100pt
5164 .irow &`\\`&                     "single backslash"
5165 .irow &`\n`&                     "newline"
5166 .irow &`\r`&                     "carriage return"
5167 .irow &`\t`&                     "tab"
5168 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5169 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5170                                    character"
5171 .endtable
5172
5173 If a backslash is followed by some other character, including a double-quote
5174 character, that character replaces the pair.
5175
5176 Quoting is necessary only if you want to make use of the backslash escapes to
5177 insert special characters, or if you need to specify a value with leading or
5178 trailing spaces. These cases are rare, so quoting is almost never needed in
5179 current versions of Exim. In versions of Exim before 3.14, quoting was required
5180 in order to continue lines, so you may come across older configuration files
5181 and examples that apparently quote unnecessarily.
5182
5183
5184 .section "Expanded strings" "SECID51"
5185 .cindex "expansion" "definition of"
5186 Some strings in the configuration file are subjected to &'string expansion'&,
5187 by which means various parts of the string may be changed according to the
5188 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5189 is as just described; in particular, the handling of backslashes in quoted
5190 strings is done as part of the input process, before expansion takes place.
5191 However, backslash is also an escape character for the expander, so any
5192 backslashes that are required for that reason must be doubled if they are
5193 within a quoted configuration string.
5194
5195
5196 .section "User and group names" "SECID52"
5197 .cindex "user name" "format of"
5198 .cindex "format" "user name"
5199 .cindex "groups" "name format"
5200 .cindex "format" "group name"
5201 User and group names are specified as strings, using the syntax described
5202 above, but the strings are interpreted specially. A user or group name must
5203 either consist entirely of digits, or be a name that can be looked up using the
5204 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5205
5206
5207 .section "List construction" "SECTlistconstruct"
5208 .cindex "list" "syntax of in configuration"
5209 .cindex "format" "list item in configuration"
5210 .cindex "string" "list, definition of"
5211 The data for some configuration options is a list of items, with colon as the
5212 default separator. Many of these options are shown with type &"string list"& in
5213 the descriptions later in this document. Others are listed as &"domain list"&,
5214 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5215 are all the same; however, those other than &"string list"& are subject to
5216 particular kinds of interpretation, as described in chapter
5217 &<<CHAPdomhosaddlists>>&.
5218
5219 In all these cases, the entire list is treated as a single string as far as the
5220 input syntax is concerned. The &%trusted_users%& setting in section
5221 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5222 in a list, it must be entered as two colons. Leading and trailing white space
5223 on each item in a list is ignored. This makes it possible to include items that
5224 start with a colon, and in particular, certain forms of IPv6 address. For
5225 example, the list
5226 .code
5227 local_interfaces = 127.0.0.1 : ::::1
5228 .endd
5229 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5230
5231 &*Note*&: Although leading and trailing white space is ignored in individual
5232 list items, it is not ignored when parsing the list. The space after the first
5233 colon in the example above is necessary. If it were not there, the list would
5234 be interpreted as the two items 127.0.0.1:: and 1.
5235
5236 .section "Changing list separators" "SECTlistsepchange"
5237 .cindex "list separator" "changing"
5238 .cindex "IPv6" "addresses in lists"
5239 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5240 introduced to allow the separator character to be changed. If a list begins
5241 with a left angle bracket, followed by any punctuation character, that
5242 character is used instead of colon as the list separator. For example, the list
5243 above can be rewritten to use a semicolon separator like this:
5244 .code
5245 local_interfaces = <; 127.0.0.1 ; ::1
5246 .endd
5247 This facility applies to all lists, with the exception of the list in
5248 &%log_file_path%&. It is recommended that the use of non-colon separators be
5249 confined to circumstances where they really are needed.
5250
5251 .cindex "list separator" "newline as"
5252 .cindex "newline" "as list separator"
5253 It is also possible to use newline and other control characters (those with
5254 code values less than 32, plus DEL) as separators in lists. Such separators
5255 must be provided literally at the time the list is processed. For options that
5256 are string-expanded, you can write the separator using a normal escape
5257 sequence. This will be processed by the expander before the string is
5258 interpreted as a list. For example, if a newline-separated list of domains is
5259 generated by a lookup, you can process it directly by a line such as this:
5260 .code
5261 domains = <\n ${lookup mysql{.....}}
5262 .endd
5263 This avoids having to change the list separator in such data. You are unlikely
5264 to want to use a control character as a separator in an option that is not
5265 expanded, because the value is literal text. However, it can be done by giving
5266 the value in quotes. For example:
5267 .code
5268 local_interfaces = "<\n 127.0.0.1 \n ::1"
5269 .endd
5270 Unlike printing character separators, which can be included in list items by
5271 doubling, it is not possible to include a control character as data when it is
5272 set as the separator. Two such characters in succession are interpreted as
5273 enclosing an empty list item.
5274
5275
5276
5277 .section "Empty items in lists" "SECTempitelis"
5278 .cindex "list" "empty item in"
5279 An empty item at the end of a list is always ignored. In other words, trailing
5280 separator characters are ignored. Thus, the list in
5281 .code
5282 senders = user@domain :
5283 .endd
5284 contains only a single item. If you want to include an empty string as one item
5285 in a list, it must not be the last item. For example, this list contains three
5286 items, the second of which is empty:
5287 .code
5288 senders = user1@domain : : user2@domain
5289 .endd
5290 &*Note*&: There must be white space between the two colons, as otherwise they
5291 are interpreted as representing a single colon data character (and the list
5292 would then contain just one item). If you want to specify a list that contains
5293 just one, empty item, you can do it as in this example:
5294 .code
5295 senders = :
5296 .endd
5297 In this case, the first item is empty, and the second is discarded because it
5298 is at the end of the list.
5299
5300
5301
5302
5303 .section "Format of driver configurations" "SECTfordricon"
5304 .cindex "drivers" "configuration format"
5305 There are separate parts in the configuration for defining routers, transports,
5306 and authenticators. In each part, you are defining a number of driver
5307 instances, each with its own set of options. Each driver instance is defined by
5308 a sequence of lines like this:
5309 .display
5310 <&'instance name'&>:
5311   <&'option'&>
5312   ...
5313   <&'option'&>
5314 .endd
5315 In the following example, the instance name is &(localuser)&, and it is
5316 followed by three options settings:
5317 .code
5318 localuser:
5319   driver = accept
5320   check_local_user
5321   transport = local_delivery
5322 .endd
5323 For each driver instance, you specify which Exim code module it uses &-- by the
5324 setting of the &%driver%& option &-- and (optionally) some configuration
5325 settings. For example, in the case of transports, if you want a transport to
5326 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5327 a local file you would use the &(appendfile)& driver. Each of the drivers is
5328 described in detail in its own separate chapter later in this manual.
5329
5330 You can have several routers, transports, or authenticators that are based on
5331 the same underlying driver (each must have a different instance name).
5332
5333 The order in which routers are defined is important, because addresses are
5334 passed to individual routers one by one, in order. The order in which
5335 transports are defined does not matter at all. The order in which
5336 authenticators are defined is used only when Exim, as a client, is searching
5337 them to find one that matches an authentication mechanism offered by the
5338 server.
5339
5340 .cindex "generic options"
5341 .cindex "options" "generic &-- definition of"
5342 Within a driver instance definition, there are two kinds of option: &'generic'&
5343 and &'private'&. The generic options are those that apply to all drivers of the
5344 same type (that is, all routers, all transports or all authenticators). The
5345 &%driver%& option is a generic option that must appear in every definition.
5346 .cindex "private options"
5347 The private options are special for each driver, and none need appear, because
5348 they all have default values.
5349
5350 The options may appear in any order, except that the &%driver%& option must
5351 precede any private options, since these depend on the particular driver. For
5352 this reason, it is recommended that &%driver%& always be the first option.
5353
5354 Driver instance names, which are used for reference in log entries and
5355 elsewhere, can be any sequence of letters, digits, and underscores (starting
5356 with a letter) and must be unique among drivers of the same type. A router and
5357 a transport (for example) can each have the same name, but no two router
5358 instances can have the same name. The name of a driver instance should not be
5359 confused with the name of the underlying driver module. For example, the
5360 configuration lines:
5361 .code
5362 remote_smtp:
5363   driver = smtp
5364 .endd
5365 create an instance of the &(smtp)& transport driver whose name is
5366 &(remote_smtp)&. The same driver code can be used more than once, with
5367 different instance names and different option settings each time. A second
5368 instance of the &(smtp)& transport, with different options, might be defined
5369 thus:
5370 .code
5371 special_smtp:
5372   driver = smtp
5373   port = 1234
5374   command_timeout = 10s
5375 .endd
5376 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5377 these transport instances from routers, and these names would appear in log
5378 lines.
5379
5380 Comment lines may be present in the middle of driver specifications. The full
5381 list of option settings for any particular driver instance, including all the
5382 defaulted values, can be extracted by making use of the &%-bP%& command line
5383 option.
5384
5385
5386
5387
5388
5389
5390 . ////////////////////////////////////////////////////////////////////////////
5391 . ////////////////////////////////////////////////////////////////////////////
5392
5393 .chapter "The default configuration file" "CHAPdefconfil"
5394 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5395 .cindex "default" "configuration file &""walk through""&"
5396 The default configuration file supplied with Exim as &_src/configure.default_&
5397 is sufficient for a host with simple mail requirements. As an introduction to
5398 the way Exim is configured, this chapter &"walks through"& the default
5399 configuration, giving brief explanations of the settings. Detailed descriptions
5400 of the options are given in subsequent chapters. The default configuration file
5401 itself contains extensive comments about ways you might want to modify the
5402 initial settings. However, note that there are many options that are not
5403 mentioned at all in the default configuration.
5404
5405
5406
5407 .section "Main configuration settings" "SECTdefconfmain"
5408 The main (global) configuration option settings must always come first in the
5409 file. The first thing you'll see in the file, after some initial comments, is
5410 the line
5411 .code
5412 # primary_hostname =
5413 .endd
5414 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5415 to know the official, fully qualified name of your host, and this is where you
5416 can specify it. However, in most cases you do not need to set this option. When
5417 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5418
5419 The first three non-comment configuration lines are as follows:
5420 .code
5421 domainlist local_domains    = @
5422 domainlist relay_to_domains =
5423 hostlist   relay_from_hosts = 127.0.0.1
5424 .endd
5425 These are not, in fact, option settings. They are definitions of two named
5426 domain lists and one named host list. Exim allows you to give names to lists of
5427 domains, hosts, and email addresses, in order to make it easier to manage the
5428 configuration file (see section &<<SECTnamedlists>>&).
5429
5430 The first line defines a domain list called &'local_domains'&; this is used
5431 later in the configuration to identify domains that are to be delivered
5432 on the local host.
5433
5434 .cindex "@ in a domain list"
5435 There is just one item in this list, the string &"@"&. This is a special form
5436 of entry which means &"the name of the local host"&. Thus, if the local host is
5437 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5438 be delivered locally. Because the local host's name is referenced indirectly,
5439 the same configuration file can be used on different hosts.
5440
5441 The second line defines a domain list called &'relay_to_domains'&, but the
5442 list itself is empty. Later in the configuration we will come to the part that
5443 controls mail relaying through the local host; it allows relaying to any
5444 domains in this list. By default, therefore, no relaying on the basis of a mail
5445 domain is permitted.
5446
5447 The third line defines a host list called &'relay_from_hosts'&. This list is
5448 used later in the configuration to permit relaying from any host or IP address
5449 that matches the list. The default contains just the IP address of the IPv4
5450 loopback interface, which means that processes on the local host are able to
5451 submit mail for relaying by sending it over TCP/IP to that interface. No other
5452 hosts are permitted to submit messages for relaying.
5453
5454 Just to be sure there's no misunderstanding: at this point in the configuration
5455 we aren't actually setting up any controls. We are just defining some domains
5456 and hosts that will be used in the controls that are specified later.
5457
5458 The next two configuration lines are genuine option settings:
5459 .code
5460 acl_smtp_rcpt = acl_check_rcpt
5461 acl_smtp_data = acl_check_data
5462 .endd
5463 These options specify &'Access Control Lists'& (ACLs) that are to be used
5464 during an incoming SMTP session for every recipient of a message (every RCPT
5465 command), and after the contents of the message have been received,
5466 respectively. The names of the lists are &'acl_check_rcpt'& and
5467 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5468 section of the configuration. The RCPT ACL controls which recipients are
5469 accepted for an incoming message &-- if a configuration does not provide an ACL
5470 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5471 contents of a message to be checked.
5472
5473 Two commented-out option settings are next:
5474 .code
5475 # av_scanner = clamd:/tmp/clamd
5476 # spamd_address = 127.0.0.1 783
5477 .endd
5478 These are example settings that can be used when Exim is compiled with the
5479 content-scanning extension. The first specifies the interface to the virus
5480 scanner, and the second specifies the interface to SpamAssassin. Further
5481 details are given in chapter &<<CHAPexiscan>>&.
5482
5483 Three more commented-out option settings follow:
5484 .code
5485 # tls_advertise_hosts = *
5486 # tls_certificate = /etc/ssl/exim.crt
5487 # tls_privatekey = /etc/ssl/exim.pem
5488 .endd
5489 These are example settings that can be used when Exim is compiled with
5490 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5491 first one specifies the list of clients that are allowed to use TLS when
5492 connecting to this server; in this case the wildcard means all clients. The
5493 other options specify where Exim should find its TLS certificate and private
5494 key, which together prove the server's identity to any clients that connect.
5495 More details are given in chapter &<<CHAPTLS>>&.
5496
5497 Another two commented-out option settings follow:
5498 .code
5499 # daemon_smtp_ports = 25 : 465 : 587
5500 # tls_on_connect_ports = 465
5501 .endd
5502 .cindex "port" "465 and 587"
5503 .cindex "port" "for message submission"
5504 .cindex "message" "submission, ports for"
5505 .cindex "ssmtp protocol"
5506 .cindex "smtps protocol"
5507 .cindex "SMTP" "ssmtp protocol"
5508 .cindex "SMTP" "smtps protocol"
5509 These options provide better support for roaming users who wish to use this
5510 server for message submission. They are not much use unless you have turned on
5511 TLS (as described in the previous paragraph) and authentication (about which
5512 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5513 on end-user networks, so RFC 4409 specifies that message submission should use
5514 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5515 configured to use port 587 correctly, so these settings also enable the
5516 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5517 &<<SECTsupobssmt>>&).
5518
5519 Two more commented-out options settings follow:
5520 .code
5521 # qualify_domain =
5522 # qualify_recipient =
5523 .endd
5524 The first of these specifies a domain that Exim uses when it constructs a
5525 complete email address from a local login name. This is often needed when Exim
5526 receives a message from a local process. If you do not set &%qualify_domain%&,
5527 the value of &%primary_hostname%& is used. If you set both of these options,
5528 you can have different qualification domains for sender and recipient
5529 addresses. If you set only the first one, its value is used in both cases.
5530
5531 .cindex "domain literal" "recognizing format"
5532 The following line must be uncommented if you want Exim to recognize
5533 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5534 (an IP address within square brackets) instead of a named domain.
5535 .code
5536 # allow_domain_literals
5537 .endd
5538 The RFCs still require this form, but many people think that in the modern
5539 Internet it makes little sense to permit mail to be sent to specific hosts by
5540 quoting their IP addresses. This ancient format has been used by people who
5541 try to abuse hosts by using them for unwanted relaying. However, some
5542 people believe there are circumstances (for example, messages addressed to
5543 &'postmaster'&) where domain literals are still useful.
5544
5545 The next configuration line is a kind of trigger guard:
5546 .code
5547 never_users = root
5548 .endd
5549 It specifies that no delivery must ever be run as the root user. The normal
5550 convention is to set up &'root'& as an alias for the system administrator. This
5551 setting is a guard against slips in the configuration.
5552 The list of users specified by &%never_users%& is not, however, the complete
5553 list; the build-time configuration in &_Local/Makefile_& has an option called
5554 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5555 contents of &%never_users%& are added to this list. By default
5556 FIXED_NEVER_USERS also specifies root.
5557
5558 When a remote host connects to Exim in order to send mail, the only information
5559 Exim has about the host's identity is its IP address. The next configuration
5560 line,
5561 .code
5562 host_lookup = *
5563 .endd
5564 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5565 in order to get a host name. This improves the quality of the logging
5566 information, but if you feel it is too expensive, you can remove it entirely,
5567 or restrict the lookup to hosts on &"nearby"& networks.
5568 Note that it is not always possible to find a host name from an IP address,
5569 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5570 unreachable.
5571
5572 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5573 1413 (hence their names):
5574 .code
5575 rfc1413_hosts = *
5576 rfc1413_query_timeout = 0s
5577 .endd
5578 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5579 Few hosts offer RFC1413 service these days; calls have to be
5580 terminated by a timeout and this needlessly delays the startup
5581 of an incoming SMTP connection.
5582 If you have hosts for which you trust RFC1413 and need this
5583 information, you can change this.
5584
5585 This line enables an efficiency SMTP option.  It is negotiated by clients
5586 and not expected to cause problems but can be disabled if needed.
5587 .code
5588 prdr_enable = true
5589 .endd
5590
5591 When Exim receives messages over SMTP connections, it expects all addresses to
5592 be fully qualified with a domain, as required by the SMTP definition. However,
5593 if you are running a server to which simple clients submit messages, you may
5594 find that they send unqualified addresses. The two commented-out options:
5595 .code
5596 # sender_unqualified_hosts =
5597 # recipient_unqualified_hosts =
5598 .endd
5599 show how you can specify hosts that are permitted to send unqualified sender
5600 and recipient addresses, respectively.
5601
5602 The &%log_selector%& option is used to increase the detail of logging
5603 over the default:
5604 .code
5605 log_selector = +smtp_protocol_error +smtp_syntax_error \
5606                +tls_certificate_verified
5607 .endd
5608
5609 The &%percent_hack_domains%& option is also commented out:
5610 .code
5611 # percent_hack_domains =
5612 .endd
5613 It provides a list of domains for which the &"percent hack"& is to operate.
5614 This is an almost obsolete form of explicit email routing. If you do not know
5615 anything about it, you can safely ignore this topic.
5616
5617 The last two settings in the main part of the default configuration are
5618 concerned with messages that have been &"frozen"& on Exim's queue. When a
5619 message is frozen, Exim no longer continues to try to deliver it. Freezing
5620 occurs when a bounce message encounters a permanent failure because the sender
5621 address of the original message that caused the bounce is invalid, so the
5622 bounce cannot be delivered. This is probably the most common case, but there
5623 are also other conditions that cause freezing, and frozen messages are not
5624 always bounce messages.
5625 .code
5626 ignore_bounce_errors_after = 2d
5627 timeout_frozen_after = 7d
5628 .endd
5629 The first of these options specifies that failing bounce messages are to be
5630 discarded after 2 days on the queue. The second specifies that any frozen
5631 message (whether a bounce message or not) is to be timed out (and discarded)
5632 after a week. In this configuration, the first setting ensures that no failing
5633 bounce message ever lasts a week.
5634
5635
5636
5637 .section "ACL configuration" "SECID54"
5638 .cindex "default" "ACLs"
5639 .cindex "&ACL;" "default configuration"
5640 In the default configuration, the ACL section follows the main configuration.
5641 It starts with the line
5642 .code
5643 begin acl
5644 .endd
5645 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5646 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5647 and &%acl_smtp_data%& above.
5648
5649 .cindex "RCPT" "ACL for"
5650 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5651 RCPT command specifies one of the message's recipients. The ACL statements
5652 are considered in order, until the recipient address is either accepted or
5653 rejected. The RCPT command is then accepted or rejected, according to the
5654 result of the ACL processing.
5655 .code
5656 acl_check_rcpt:
5657 .endd
5658 This line, consisting of a name terminated by a colon, marks the start of the
5659 ACL, and names it.
5660 .code
5661 accept  hosts = :
5662 .endd
5663 This ACL statement accepts the recipient if the sending host matches the list.
5664 But what does that strange list mean? It doesn't actually contain any host
5665 names or IP addresses. The presence of the colon puts an empty item in the
5666 list; Exim matches this only if the incoming message did not come from a remote
5667 host, because in that case, the remote hostname is empty. The colon is
5668 important. Without it, the list itself is empty, and can never match anything.
5669
5670 What this statement is doing is to accept unconditionally all recipients in
5671 messages that are submitted by SMTP from local processes using the standard
5672 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5673 manner.
5674 .code
5675 deny    message       = Restricted characters in address
5676         domains       = +local_domains
5677         local_parts   = ^[.] : ^.*[@%!/|]
5678
5679 deny    message       = Restricted characters in address
5680         domains       = !+local_domains
5681         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5682 .endd
5683 These statements are concerned with local parts that contain any of the
5684 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5685 Although these characters are entirely legal in local parts (in the case of
5686 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5687 in Internet mail addresses.
5688
5689 The first three have in the past been associated with explicitly routed
5690 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5691 option). Addresses containing these characters are regularly tried by spammers
5692 in an attempt to bypass relaying restrictions, and also by open relay testing
5693 programs. Unless you really need them it is safest to reject these characters
5694 at this early stage. This configuration is heavy-handed in rejecting these
5695 characters for all messages it accepts from remote hosts. This is a deliberate
5696 policy of being as safe as possible.
5697
5698 The first rule above is stricter, and is applied to messages that are addressed
5699 to one of the local domains handled by this host. This is implemented by the
5700 first condition, which restricts it to domains that are listed in the
5701 &'local_domains'& domain list. The &"+"& character is used to indicate a
5702 reference to a named list. In this configuration, there is just one domain in
5703 &'local_domains'&, but in general there may be many.
5704
5705 The second condition on the first statement uses two regular expressions to
5706 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5707 or &"|"&. If you have local accounts that include these characters, you will
5708 have to modify this rule.
5709
5710 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5711 allows them because they have been encountered in practice. (Consider the
5712 common convention of local parts constructed as
5713 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5714 the author of Exim, who has no second initial.) However, a local part starting
5715 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5716 file name (for example, for a mailing list). This is also true for local parts
5717 that contain slashes. A pipe symbol can also be troublesome if the local part
5718 is incorporated unthinkingly into a shell command line.
5719
5720 The second rule above applies to all other domains, and is less strict. This
5721 allows your own users to send outgoing messages to sites that use slashes
5722 and vertical bars in their local parts. It blocks local parts that begin
5723 with a dot, slash, or vertical bar, but allows these characters within the
5724 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5725 and &"!"& is blocked, as before. The motivation here is to prevent your users
5726 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5727 .code
5728 accept  local_parts   = postmaster
5729         domains       = +local_domains
5730 .endd
5731 This statement, which has two conditions, accepts an incoming address if the
5732 local part is &'postmaster'& and the domain is one of those listed in the
5733 &'local_domains'& domain list. The &"+"& character is used to indicate a
5734 reference to a named list. In this configuration, there is just one domain in
5735 &'local_domains'&, but in general there may be many.
5736
5737 The presence of this statement means that mail to postmaster is never blocked
5738 by any of the subsequent tests. This can be helpful while sorting out problems
5739 in cases where the subsequent tests are incorrectly denying access.
5740 .code
5741 require verify        = sender
5742 .endd
5743 This statement requires the sender address to be verified before any subsequent
5744 ACL statement can be used. If verification fails, the incoming recipient
5745 address is refused. Verification consists of trying to route the address, to
5746 see if a bounce message could be delivered to it. In the case of remote
5747 addresses, basic verification checks only the domain, but &'callouts'& can be
5748 used for more verification if required. Section &<<SECTaddressverification>>&
5749 discusses the details of address verification.
5750 .code
5751 accept  hosts         = +relay_from_hosts
5752         control       = submission
5753 .endd
5754 This statement accepts the address if the message is coming from one of the
5755 hosts that are defined as being allowed to relay through this host. Recipient
5756 verification is omitted here, because in many cases the clients are dumb MUAs
5757 that do not cope well with SMTP error responses. For the same reason, the
5758 second line specifies &"submission mode"& for messages that are accepted. This
5759 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5760 messages that are deficient in some way, for example, because they lack a
5761 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5762 probably add recipient verification here, and disable submission mode.
5763 .code
5764 accept  authenticated = *
5765         control       = submission
5766 .endd
5767 This statement accepts the address if the client host has authenticated itself.
5768 Submission mode is again specified, on the grounds that such messages are most
5769 likely to come from MUAs. The default configuration does not define any
5770 authenticators, though it does include some nearly complete commented-out
5771 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5772 fact authenticate until you complete the authenticator definitions.
5773 .code
5774 require message = relay not permitted
5775         domains = +local_domains : +relay_to_domains
5776 .endd
5777 This statement rejects the address if its domain is neither a local domain nor
5778 one of the domains for which this host is a relay.
5779 .code
5780 require verify = recipient
5781 .endd
5782 This statement requires the recipient address to be verified; if verification
5783 fails, the address is rejected.
5784 .code
5785 # deny    message     = rejected because $sender_host_address \
5786 #                       is in a black list at $dnslist_domain\n\
5787 #                       $dnslist_text
5788 #         dnslists    = black.list.example
5789 #
5790 # warn    dnslists    = black.list.example
5791 #         add_header  = X-Warning: $sender_host_address is in \
5792 #                       a black list at $dnslist_domain
5793 #         log_message = found in $dnslist_domain
5794 .endd
5795 These commented-out lines are examples of how you could configure Exim to check
5796 sending hosts against a DNS black list. The first statement rejects messages
5797 from blacklisted hosts, whereas the second just inserts a warning header
5798 line.
5799 .code
5800 # require verify = csa
5801 .endd
5802 This commented-out line is an example of how you could turn on client SMTP
5803 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5804 records.
5805 .code
5806 accept
5807 .endd
5808 The final statement in the first ACL unconditionally accepts any recipient
5809 address that has successfully passed all the previous tests.
5810 .code
5811 acl_check_data:
5812 .endd
5813 This line marks the start of the second ACL, and names it. Most of the contents
5814 of this ACL are commented out:
5815 .code
5816 # deny    malware   = *
5817 #         message   = This message contains a virus \
5818 #                     ($malware_name).
5819 .endd
5820 These lines are examples of how to arrange for messages to be scanned for
5821 viruses when Exim has been compiled with the content-scanning extension, and a
5822 suitable virus scanner is installed. If the message is found to contain a
5823 virus, it is rejected with the given custom error message.
5824 .code
5825 # warn    spam      = nobody
5826 #         message   = X-Spam_score: $spam_score\n\
5827 #                     X-Spam_score_int: $spam_score_int\n\
5828 #                     X-Spam_bar: $spam_bar\n\
5829 #                     X-Spam_report: $spam_report
5830 .endd
5831 These lines are an example of how to arrange for messages to be scanned by
5832 SpamAssassin when Exim has been compiled with the content-scanning extension,
5833 and SpamAssassin has been installed. The SpamAssassin check is run with
5834 &`nobody`& as its user parameter, and the results are added to the message as a
5835 series of extra header line. In this case, the message is not rejected,
5836 whatever the spam score.
5837 .code
5838 accept
5839 .endd
5840 This final line in the DATA ACL accepts the message unconditionally.
5841
5842
5843 .section "Router configuration" "SECID55"
5844 .cindex "default" "routers"
5845 .cindex "routers" "default"
5846 The router configuration comes next in the default configuration, introduced
5847 by the line
5848 .code
5849 begin routers
5850 .endd
5851 Routers are the modules in Exim that make decisions about where to send
5852 messages. An address is passed to each router in turn, until it is either
5853 accepted, or failed. This means that the order in which you define the routers
5854 matters. Each router is fully described in its own chapter later in this
5855 manual. Here we give only brief overviews.
5856 .code
5857 # domain_literal:
5858 #   driver = ipliteral
5859 #   domains = !+local_domains
5860 #   transport = remote_smtp
5861 .endd
5862 .cindex "domain literal" "default router"
5863 This router is commented out because the majority of sites do not want to
5864 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5865 you uncomment this router, you also need to uncomment the setting of
5866 &%allow_domain_literals%& in the main part of the configuration.
5867 .code
5868 dnslookup:
5869   driver = dnslookup
5870   domains = ! +local_domains
5871   transport = remote_smtp
5872   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5873   no_more
5874 .endd
5875 The first uncommented router handles addresses that do not involve any local
5876 domains. This is specified by the line
5877 .code
5878 domains = ! +local_domains
5879 .endd
5880 The &%domains%& option lists the domains to which this router applies, but the
5881 exclamation mark is a negation sign, so the router is used only for domains
5882 that are not in the domain list called &'local_domains'& (which was defined at
5883 the start of the configuration). The plus sign before &'local_domains'&
5884 indicates that it is referring to a named list. Addresses in other domains are
5885 passed on to the following routers.
5886
5887 The name of the router driver is &(dnslookup)&,
5888 and is specified by the &%driver%& option. Do not be confused by the fact that
5889 the name of this router instance is the same as the name of the driver. The
5890 instance name is arbitrary, but the name set in the &%driver%& option must be
5891 one of the driver modules that is in the Exim binary.
5892
5893 The &(dnslookup)& router routes addresses by looking up their domains in the
5894 DNS in order to obtain a list of hosts to which the address is routed. If the
5895 router succeeds, the address is queued for the &(remote_smtp)& transport, as
5896 specified by the &%transport%& option. If the router does not find the domain
5897 in the DNS, no further routers are tried because of the &%no_more%& setting, so
5898 the address fails and is bounced.
5899
5900 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
5901 be entirely ignored. This option is present because a number of cases have been
5902 encountered where MX records in the DNS point to host names
5903 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
5904 Completely ignoring these IP addresses causes Exim to fail to route the
5905 email address, so it bounces. Otherwise, Exim would log a routing problem, and
5906 continue to try to deliver the message periodically until the address timed
5907 out.
5908 .code
5909 system_aliases:
5910   driver = redirect
5911   allow_fail
5912   allow_defer
5913   data = ${lookup{$local_part}lsearch{/etc/aliases}}
5914 # user = exim
5915   file_transport = address_file
5916   pipe_transport = address_pipe
5917 .endd
5918 Control reaches this and subsequent routers only for addresses in the local
5919 domains. This router checks to see whether the local part is defined as an
5920 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
5921 data that it looks up from that file. If no data is found for the local part,
5922 the value of the &%data%& option is empty, causing the address to be passed to
5923 the next router.
5924
5925 &_/etc/aliases_& is a conventional name for the system aliases file that is
5926 often used. That is why it is referenced by from the default configuration
5927 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
5928 &_Local/Makefile_& before building Exim.
5929 .code
5930 userforward:
5931   driver = redirect
5932   check_local_user
5933 # local_part_suffix = +* : -*
5934 # local_part_suffix_optional
5935   file = $home/.forward
5936 # allow_filter
5937   no_verify
5938   no_expn
5939   check_ancestor
5940   file_transport = address_file
5941   pipe_transport = address_pipe
5942   reply_transport = address_reply
5943 .endd
5944 This is the most complicated router in the default configuration. It is another
5945 redirection router, but this time it is looking for forwarding data set up by
5946 individual users. The &%check_local_user%& setting specifies a check that the
5947 local part of the address is the login name of a local user. If it is not, the
5948 router is skipped. The two commented options that follow &%check_local_user%&,
5949 namely:
5950 .code
5951 # local_part_suffix = +* : -*
5952 # local_part_suffix_optional
5953 .endd
5954 .vindex "&$local_part_suffix$&"
5955 show how you can specify the recognition of local part suffixes. If the first
5956 is uncommented, a suffix beginning with either a plus or a minus sign, followed
5957 by any sequence of characters, is removed from the local part and placed in the
5958 variable &$local_part_suffix$&. The second suffix option specifies that the
5959 presence of a suffix in the local part is optional. When a suffix is present,
5960 the check for a local login uses the local part with the suffix removed.
5961
5962 When a local user account is found, the file called &_.forward_& in the user's
5963 home directory is consulted. If it does not exist, or is empty, the router
5964 declines. Otherwise, the contents of &_.forward_& are interpreted as
5965 redirection data (see chapter &<<CHAPredirect>>& for more details).
5966
5967 .cindex "Sieve filter" "enabling in default router"
5968 Traditional &_.forward_& files contain just a list of addresses, pipes, or
5969 files. Exim supports this by default. However, if &%allow_filter%& is set (it
5970 is commented out by default), the contents of the file are interpreted as a set
5971 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
5972 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
5973 separate document entitled &'Exim's interfaces to mail filtering'&.
5974
5975 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
5976 verifying addresses, or when running as a consequence of an SMTP EXPN command.
5977 There are two reasons for doing this:
5978
5979 .olist
5980 Whether or not a local user has a &_.forward_& file is not really relevant when
5981 checking an address for validity; it makes sense not to waste resources doing
5982 unnecessary work.
5983 .next
5984 More importantly, when Exim is verifying addresses or handling an EXPN
5985 command during an SMTP session, it is running as the Exim user, not as root.
5986 The group is the Exim group, and no additional groups are set up.
5987 It may therefore not be possible for Exim to read users' &_.forward_& files at
5988 this time.
5989 .endlist
5990
5991 The setting of &%check_ancestor%& prevents the router from generating a new
5992 address that is the same as any previous address that was redirected. (This
5993 works round a problem concerning a bad interaction between aliasing and
5994 forwarding &-- see section &<<SECTredlocmai>>&).
5995
5996 The final three option settings specify the transports that are to be used when
5997 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
5998 auto-reply, respectively. For example, if a &_.forward_& file contains
5999 .code
6000 a.nother@elsewhere.example, /home/spqr/archive
6001 .endd
6002 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6003 transport.
6004 .code
6005 localuser:
6006   driver = accept
6007   check_local_user
6008 # local_part_suffix = +* : -*
6009 # local_part_suffix_optional
6010   transport = local_delivery
6011 .endd
6012 The final router sets up delivery into local mailboxes, provided that the local
6013 part is the name of a local login, by accepting the address and assigning it to
6014 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6015 routers, so the address is bounced. The commented suffix settings fulfil the
6016 same purpose as they do for the &(userforward)& router.
6017
6018
6019 .section "Transport configuration" "SECID56"
6020 .cindex "default" "transports"
6021 .cindex "transports" "default"
6022 Transports define mechanisms for actually delivering messages. They operate
6023 only when referenced from routers, so the order in which they are defined does
6024 not matter. The transports section of the configuration starts with
6025 .code
6026 begin transports
6027 .endd
6028 One remote transport and four local transports are defined.
6029 .code
6030 remote_smtp:
6031   driver = smtp
6032   hosts_try_prdr = *
6033 .endd
6034 This transport is used for delivering messages over SMTP connections.
6035 The list of remote hosts comes from the router.
6036 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6037 It is negotiated between client and server
6038 and not expected to cause problems but can be disabled if needed.
6039 All other options are defaulted.
6040 .code
6041 local_delivery:
6042   driver = appendfile
6043   file = /var/mail/$local_part
6044   delivery_date_add
6045   envelope_to_add
6046   return_path_add
6047 # group = mail
6048 # mode = 0660
6049 .endd
6050 This &(appendfile)& transport is used for local delivery to user mailboxes in
6051 traditional BSD mailbox format. By default it runs under the uid and gid of the
6052 local user, which requires the sticky bit to be set on the &_/var/mail_&
6053 directory. Some systems use the alternative approach of running mail deliveries
6054 under a particular group instead of using the sticky bit. The commented options
6055 show how this can be done.
6056
6057 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6058 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6059 similarly-named options above.
6060 .code
6061 address_pipe:
6062   driver = pipe
6063   return_output
6064 .endd
6065 This transport is used for handling deliveries to pipes that are generated by
6066 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6067 option specifies that any output generated by the pipe is to be returned to the
6068 sender.
6069 .code
6070 address_file:
6071   driver = appendfile
6072   delivery_date_add
6073   envelope_to_add
6074   return_path_add
6075 .endd
6076 This transport is used for handling deliveries to files that are generated by
6077 redirection. The name of the file is not specified in this instance of
6078 &(appendfile)&, because it comes from the &(redirect)& router.
6079 .code
6080 address_reply:
6081   driver = autoreply
6082 .endd
6083 This transport is used for handling automatic replies generated by users'
6084 filter files.
6085
6086
6087
6088 .section "Default retry rule" "SECID57"
6089 .cindex "retry" "default rule"
6090 .cindex "default" "retry rule"
6091 The retry section of the configuration file contains rules which affect the way
6092 Exim retries deliveries that cannot be completed at the first attempt. It is
6093 introduced by the line
6094 .code
6095 begin retry
6096 .endd
6097 In the default configuration, there is just one rule, which applies to all
6098 errors:
6099 .code
6100 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6101 .endd
6102 This causes any temporarily failing address to be retried every 15 minutes for
6103 2 hours, then at intervals starting at one hour and increasing by a factor of
6104 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6105 is not delivered after 4 days of temporary failure, it is bounced.
6106
6107 If the retry section is removed from the configuration, or is empty (that is,
6108 if no retry rules are defined), Exim will not retry deliveries. This turns
6109 temporary errors into permanent errors.
6110
6111
6112 .section "Rewriting configuration" "SECID58"
6113 The rewriting section of the configuration, introduced by
6114 .code
6115 begin rewrite
6116 .endd
6117 contains rules for rewriting addresses in messages as they arrive. There are no
6118 rewriting rules in the default configuration file.
6119
6120
6121
6122 .section "Authenticators configuration" "SECTdefconfauth"
6123 .cindex "AUTH" "configuration"
6124 The authenticators section of the configuration, introduced by
6125 .code
6126 begin authenticators
6127 .endd
6128 defines mechanisms for the use of the SMTP AUTH command. The default
6129 configuration file contains two commented-out example authenticators
6130 which support plaintext username/password authentication using the
6131 standard PLAIN mechanism and the traditional but non-standard LOGIN
6132 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6133 to support most MUA software.
6134
6135 The example PLAIN authenticator looks like this:
6136 .code
6137 #PLAIN:
6138 #  driver                  = plaintext
6139 #  server_set_id           = $auth2
6140 #  server_prompts          = :
6141 #  server_condition        = Authentication is not yet configured
6142 #  server_advertise_condition = ${if def:tls_in_cipher }
6143 .endd
6144 And the example LOGIN authenticator looks like this:
6145 .code
6146 #LOGIN:
6147 #  driver                  = plaintext
6148 #  server_set_id           = $auth1
6149 #  server_prompts          = <| Username: | Password:
6150 #  server_condition        = Authentication is not yet configured
6151 #  server_advertise_condition = ${if def:tls_in_cipher }
6152 .endd
6153
6154 The &%server_set_id%& option makes Exim remember the authenticated username
6155 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6156 &%server_prompts%& option configures the &(plaintext)& authenticator so
6157 that it implements the details of the specific authentication mechanism,
6158 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6159 when Exim offers authentication to clients; in the examples, this is only
6160 when TLS or SSL has been started, so to enable the authenticators you also
6161 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6162
6163 The &%server_condition%& setting defines how to verify that the username and
6164 password are correct. In the examples it just produces an error message.
6165 To make the authenticators work, you can use a string expansion
6166 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6167
6168 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6169 usercode and password are in different positions.
6170 Chapter &<<CHAPplaintext>>& covers both.
6171
6172 .ecindex IIDconfiwal
6173
6174
6175
6176 . ////////////////////////////////////////////////////////////////////////////
6177 . ////////////////////////////////////////////////////////////////////////////
6178
6179 .chapter "Regular expressions" "CHAPregexp"
6180
6181 .cindex "regular expressions" "library"
6182 .cindex "PCRE"
6183 Exim supports the use of regular expressions in many of its options. It
6184 uses the PCRE regular expression library; this provides regular expression
6185 matching that is compatible with Perl 5. The syntax and semantics of
6186 regular expressions is discussed in many Perl reference books, and also in
6187 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6188 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6189
6190 The documentation for the syntax and semantics of the regular expressions that
6191 are supported by PCRE is included in the PCRE distribution, and no further
6192 description is included here. The PCRE functions are called from Exim using
6193 the default option settings (that is, with no PCRE options set), except that
6194 the PCRE_CASELESS option is set when the matching is required to be
6195 case-insensitive.
6196
6197 In most cases, when a regular expression is required in an Exim configuration,
6198 it has to start with a circumflex, in order to distinguish it from plain text
6199 or an &"ends with"& wildcard. In this example of a configuration setting, the
6200 second item in the colon-separated list is a regular expression.
6201 .code
6202 domains = a.b.c : ^\\d{3} : *.y.z : ...
6203 .endd
6204 The doubling of the backslash is required because of string expansion that
6205 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6206 of this issue, and a way of avoiding the need for doubling backslashes. The
6207 regular expression that is eventually used in this example contains just one
6208 backslash. The circumflex is included in the regular expression, and has the
6209 normal effect of &"anchoring"& it to the start of the string that is being
6210 matched.
6211
6212 There are, however, two cases where a circumflex is not required for the
6213 recognition of a regular expression: these are the &%match%& condition in a
6214 string expansion, and the &%matches%& condition in an Exim filter file. In
6215 these cases, the relevant string is always treated as a regular expression; if
6216 it does not start with a circumflex, the expression is not anchored, and can
6217 match anywhere in the subject string.
6218
6219 In all cases, if you want a regular expression to match at the end of a string,
6220 you must code the $ metacharacter to indicate this. For example:
6221 .code
6222 domains = ^\\d{3}\\.example
6223 .endd
6224 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6225 You need to use:
6226 .code
6227 domains = ^\\d{3}\\.example\$
6228 .endd
6229 if you want &'example'& to be the top-level domain. The backslash before the
6230 $ is needed because string expansion also interprets dollar characters.
6231
6232
6233
6234 . ////////////////////////////////////////////////////////////////////////////
6235 . ////////////////////////////////////////////////////////////////////////////
6236
6237 .chapter "File and database lookups" "CHAPfdlookup"
6238 .scindex IIDfidalo1 "file" "lookups"
6239 .scindex IIDfidalo2 "database" "lookups"
6240 .cindex "lookup" "description of"
6241 Exim can be configured to look up data in files or databases as it processes
6242 messages. Two different kinds of syntax are used:
6243
6244 .olist
6245 A string that is to be expanded may contain explicit lookup requests. These
6246 cause parts of the string to be replaced by data that is obtained from the
6247 lookup. Lookups of this type are conditional expansion items. Different results
6248 can be defined for the cases of lookup success and failure. See chapter
6249 &<<CHAPexpand>>&, where string expansions are described in detail.
6250 .next
6251 Lists of domains, hosts, and email addresses can contain lookup requests as a
6252 way of avoiding excessively long linear lists. In this case, the data that is
6253 returned by the lookup is often (but not always) discarded; whether the lookup
6254 succeeds or fails is what really counts. These kinds of list are described in
6255 chapter &<<CHAPdomhosaddlists>>&.
6256 .endlist
6257
6258 String expansions, lists, and lookups interact with each other in such a way
6259 that there is no order in which to describe any one of them that does not
6260 involve references to the others. Each of these three chapters makes more sense
6261 if you have read the other two first. If you are reading this for the first
6262 time, be aware that some of it will make a lot more sense after you have read
6263 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6264
6265 .section "Examples of different lookup syntax" "SECID60"
6266 It is easy to confuse the two different kinds of lookup, especially as the
6267 lists that may contain the second kind are always expanded before being
6268 processed as lists. Therefore, they may also contain lookups of the first kind.
6269 Be careful to distinguish between the following two examples:
6270 .code
6271 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6272 domains = lsearch;/some/file
6273 .endd
6274 The first uses a string expansion, the result of which must be a domain list.
6275 No strings have been specified for a successful or a failing lookup; the
6276 defaults in this case are the looked-up data and an empty string, respectively.
6277 The expansion takes place before the string is processed as a list, and the
6278 file that is searched could contain lines like this:
6279 .code
6280 192.168.3.4: domain1:domain2:...
6281 192.168.1.9: domain3:domain4:...
6282 .endd
6283 When the lookup succeeds, the result of the expansion is a list of domains (and
6284 possibly other types of item that are allowed in domain lists).
6285
6286 In the second example, the lookup is a single item in a domain list. It causes
6287 Exim to use a lookup to see if the domain that is being processed can be found
6288 in the file. The file could contains lines like this:
6289 .code
6290 domain1:
6291 domain2:
6292 .endd
6293 Any data that follows the keys is not relevant when checking that the domain
6294 matches the list item.
6295
6296 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6297 Consider a file containing lines like this:
6298 .code
6299 192.168.5.6: lsearch;/another/file
6300 .endd
6301 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6302 first &%domains%& setting above generates the second setting, which therefore
6303 causes a second lookup to occur.
6304
6305 The rest of this chapter describes the different lookup types that are
6306 available. Any of them can be used in any part of the configuration where a
6307 lookup is permitted.
6308
6309
6310 .section "Lookup types" "SECID61"
6311 .cindex "lookup" "types of"
6312 .cindex "single-key lookup" "definition of"
6313 Two different types of data lookup are implemented:
6314
6315 .ilist
6316 The &'single-key'& type requires the specification of a file in which to look,
6317 and a single key to search for. The key must be a non-empty string for the
6318 lookup to succeed. The lookup type determines how the file is searched.
6319 .next
6320 .cindex "query-style lookup" "definition of"
6321 The &'query-style'& type accepts a generalized database query. No particular
6322 key value is assumed by Exim for query-style lookups. You can use whichever
6323 Exim variables you need to construct the database query.
6324 .endlist
6325
6326 The code for each lookup type is in a separate source file that is included in
6327 the binary of Exim only if the corresponding compile-time option is set. The
6328 default settings in &_src/EDITME_& are:
6329 .code
6330 LOOKUP_DBM=yes
6331 LOOKUP_LSEARCH=yes
6332 .endd
6333 which means that only linear searching and DBM lookups are included by default.
6334 For some types of lookup (e.g. SQL databases), you need to install appropriate
6335 libraries and header files before building Exim.
6336
6337
6338
6339
6340 .section "Single-key lookup types" "SECTsinglekeylookups"
6341 .cindex "lookup" "single-key types"
6342 .cindex "single-key lookup" "list of types"
6343 The following single-key lookup types are implemented:
6344
6345 .ilist
6346 .cindex "cdb" "description of"
6347 .cindex "lookup" "cdb"
6348 .cindex "binary zero" "in lookup key"
6349 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6350 string without a terminating binary zero. The cdb format is designed for
6351 indexed files that are read frequently and never updated, except by total
6352 re-creation. As such, it is particularly suitable for large files containing
6353 aliases or other indexed data referenced by an MTA. Information about cdb can
6354 be found in several places:
6355 .display
6356 &url(http://www.pobox.com/~djb/cdb.html)
6357 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6358 &url(http://packages.debian.org/stable/utils/freecdb.html)
6359 .endd
6360 A cdb distribution is not needed in order to build Exim with cdb support,
6361 because the code for reading cdb files is included directly in Exim itself.
6362 However, no means of building or testing cdb files is provided with Exim, so
6363 you need to obtain a cdb distribution in order to do this.
6364 .next
6365 .cindex "DBM" "lookup type"
6366 .cindex "lookup" "dbm"
6367 .cindex "binary zero" "in lookup key"
6368 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6369 DBM file by looking up the record with the given key. A terminating binary
6370 zero is included in the key that is passed to the DBM library. See section
6371 &<<SECTdb>>& for a discussion of DBM libraries.
6372
6373 .cindex "Berkeley DB library" "file format"
6374 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6375 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6376 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6377 the DB_UNKNOWN option. This enables it to handle any of the types of database
6378 that the library supports, and can be useful for accessing DBM files created by
6379 other applications. (For earlier DB versions, DB_HASH is always used.)
6380 .next
6381 .cindex "lookup" "dbmjz"
6382 .cindex "lookup" "dbm &-- embedded NULs"
6383 .cindex "sasldb2"
6384 .cindex "dbmjz lookup type"
6385 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6386 interpreted as an Exim list; the elements of the list are joined together with
6387 ASCII NUL characters to form the lookup key.  An example usage would be to
6388 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6389 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6390 &(cram_md5)& authenticator.
6391 .next
6392 .cindex "lookup" "dbmnz"
6393 .cindex "lookup" "dbm &-- terminating zero"
6394 .cindex "binary zero" "in lookup key"
6395 .cindex "Courier"
6396 .cindex "&_/etc/userdbshadow.dat_&"
6397 .cindex "dbmnz lookup type"
6398 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6399 is not included in the key that is passed to the DBM library. You may need this
6400 if you want to look up data in files that are created by or shared with some
6401 other application that does not use terminating zeros. For example, you need to
6402 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6403 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6404 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6405 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6406 .next
6407 .cindex "lookup" "dsearch"
6408 .cindex "dsearch lookup type"
6409 &(dsearch)&: The given file must be a directory; this is searched for an entry
6410 whose name is the key by calling the &[lstat()]& function. The key may not
6411 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6412 the lookup is the name of the entry, which may be a file, directory,
6413 symbolic link, or any other kind of directory entry. An example of how this
6414 lookup can be used to support virtual domains is given in section
6415 &<<SECTvirtualdomains>>&.
6416 .next
6417 .cindex "lookup" "iplsearch"
6418 .cindex "iplsearch lookup type"
6419 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6420 terminated by a colon or white space or the end of the line. The keys in the
6421 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6422 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6423 being interpreted as a key terminator. For example:
6424 .code
6425 1.2.3.4:           data for 1.2.3.4
6426 192.168.0.0/16:    data for 192.168.0.0/16
6427 "abcd::cdab":      data for abcd::cdab
6428 "abcd:abcd::/32"   data for abcd:abcd::/32
6429 .endd
6430 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6431 file is searched linearly, using the CIDR masks where present, until a matching
6432 key is found. The first key that matches is used; there is no attempt to find a
6433 &"best"& match. Apart from the way the keys are matched, the processing for
6434 &(iplsearch)& is the same as for &(lsearch)&.
6435
6436 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6437 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6438 lookup types support only literal keys.
6439
6440 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6441 the implicit key is the host's IP address rather than its name (see section
6442 &<<SECThoslispatsikey>>&).
6443 .next
6444 .cindex "linear search"
6445 .cindex "lookup" "lsearch"
6446 .cindex "lsearch lookup type"
6447 .cindex "case sensitivity" "in lsearch lookup"
6448 &(lsearch)&: The given file is a text file that is searched linearly for a
6449 line beginning with the search key, terminated by a colon or white space or the
6450 end of the line. The search is case-insensitive; that is, upper and lower case
6451 letters are treated as the same. The first occurrence of the key that is found
6452 in the file is used.
6453
6454 White space between the key and the colon is permitted. The remainder of the
6455 line, with leading and trailing white space removed, is the data. This can be
6456 continued onto subsequent lines by starting them with any amount of white
6457 space, but only a single space character is included in the data at such a
6458 junction. If the data begins with a colon, the key must be terminated by a
6459 colon, for example:
6460 .code
6461 baduser:  :fail:
6462 .endd
6463 Empty lines and lines beginning with # are ignored, even if they occur in the
6464 middle of an item. This is the traditional textual format of alias files. Note
6465 that the keys in an &(lsearch)& file are literal strings. There is no
6466 wildcarding of any kind.
6467
6468 .cindex "lookup" "lsearch &-- colons in keys"
6469 .cindex "white space" "in lsearch key"
6470 In most &(lsearch)& files, keys are not required to contain colons or #
6471 characters, or white space. However, if you need this feature, it is available.
6472 If a key begins with a doublequote character, it is terminated only by a
6473 matching quote (or end of line), and the normal escaping rules apply to its
6474 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6475 quoted keys (exactly as for unquoted keys). There is no special handling of
6476 quotes for the data part of an &(lsearch)& line.
6477
6478 .next
6479 .cindex "NIS lookup type"
6480 .cindex "lookup" "NIS"
6481 .cindex "binary zero" "in lookup key"
6482 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6483 the given key, without a terminating binary zero. There is a variant called
6484 &(nis0)& which does include the terminating binary zero in the key. This is
6485 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6486 aliases; the full map names must be used.
6487
6488 .next
6489 .cindex "wildlsearch lookup type"
6490 .cindex "lookup" "wildlsearch"
6491 .cindex "nwildlsearch lookup type"
6492 .cindex "lookup" "nwildlsearch"
6493 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6494 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6495 the file may be wildcarded. The difference between these two lookup types is
6496 that for &(wildlsearch)&, each key in the file is string-expanded before being
6497 used, whereas for &(nwildlsearch)&, no expansion takes place.
6498
6499 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6500 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6501 file that are regular expressions can be made case-sensitive by the use of
6502 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6503
6504 . ==== As this is a nested list, any displays it contains must be indented
6505 . ==== as otherwise they are too far to the left.
6506
6507 .olist
6508 The string may begin with an asterisk to mean &"ends with"&. For example:
6509 .code
6510     *.a.b.c       data for anything.a.b.c
6511     *fish         data for anythingfish
6512 .endd
6513 .next
6514 The string may begin with a circumflex to indicate a regular expression. For
6515 example, for &(wildlsearch)&:
6516 .code
6517     ^\N\d+\.a\.b\N    data for <digits>.a.b
6518 .endd
6519 Note the use of &`\N`& to disable expansion of the contents of the regular
6520 expression. If you are using &(nwildlsearch)&, where the keys are not
6521 string-expanded, the equivalent entry is:
6522 .code
6523     ^\d+\.a\.b        data for <digits>.a.b
6524 .endd
6525 The case-insensitive flag is set at the start of compiling the regular
6526 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6527 For example, to make the entire pattern case-sensitive:
6528 .code
6529     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6530 .endd
6531
6532 If the regular expression contains white space or colon characters, you must
6533 either quote it (see &(lsearch)& above), or represent these characters in other
6534 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6535 colon. This may be easier than quoting, because if you quote, you have to
6536 escape all the backslashes inside the quotes.
6537
6538 &*Note*&: It is not possible to capture substrings in a regular expression
6539 match for later use, because the results of all lookups are cached. If a lookup
6540 is repeated, the result is taken from the cache, and no actual pattern matching
6541 takes place. The values of all the numeric variables are unset after a
6542 &((n)wildlsearch)& match.
6543
6544 .next
6545 Although I cannot see it being of much use, the general matching function that
6546 is used to implement &((n)wildlsearch)& means that the string may begin with a
6547 lookup name terminated by a semicolon, and followed by lookup data. For
6548 example:
6549 .code
6550     cdb;/some/file  data for keys that match the file
6551 .endd
6552 The data that is obtained from the nested lookup is discarded.
6553 .endlist olist
6554
6555 Keys that do not match any of these patterns are interpreted literally. The
6556 continuation rules for the data are the same as for &(lsearch)&, and keys may
6557 be followed by optional colons.
6558
6559 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6560 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6561 lookup types support only literal keys.
6562 .endlist ilist
6563
6564
6565 .section "Query-style lookup types" "SECID62"
6566 .cindex "lookup" "query-style types"
6567 .cindex "query-style lookup" "list of types"
6568 The supported query-style lookup types are listed below. Further details about
6569 many of them are given in later sections.
6570
6571 .ilist
6572 .cindex "DNS" "as a lookup type"
6573 .cindex "lookup" "DNS"
6574 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6575 are given in the supplied query. The resulting data is the contents of the
6576 records. See section &<<SECTdnsdb>>&.
6577 .next
6578 .cindex "InterBase lookup type"
6579 .cindex "lookup" "InterBase"
6580 &(ibase)&: This does a lookup in an InterBase database.
6581 .next
6582 .cindex "LDAP" "lookup type"
6583 .cindex "lookup" "LDAP"
6584 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6585 returns attributes from a single entry. There is a variant called &(ldapm)&
6586 that permits values from multiple entries to be returned. A third variant
6587 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6588 any attribute values. See section &<<SECTldap>>&.
6589 .next
6590 .cindex "MySQL" "lookup type"
6591 .cindex "lookup" "MySQL"
6592 &(mysql)&: The format of the query is an SQL statement that is passed to a
6593 MySQL database. See section &<<SECTsql>>&.
6594 .next
6595 .cindex "NIS+ lookup type"
6596 .cindex "lookup" "NIS+"
6597 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6598 the field to be returned. See section &<<SECTnisplus>>&.
6599 .next
6600 .cindex "Oracle" "lookup type"
6601 .cindex "lookup" "Oracle"
6602 &(oracle)&: The format of the query is an SQL statement that is passed to an
6603 Oracle database. See section &<<SECTsql>>&.
6604 .next
6605 .cindex "lookup" "passwd"
6606 .cindex "passwd lookup type"
6607 .cindex "&_/etc/passwd_&"
6608 &(passwd)& is a query-style lookup with queries that are just user names. The
6609 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6610 success, the result string is the same as you would get from an &(lsearch)&
6611 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6612 password value. For example:
6613 .code
6614 *:42:42:King Rat:/home/kr:/bin/bash
6615 .endd
6616 .next
6617 .cindex "PostgreSQL lookup type"
6618 .cindex "lookup" "PostgreSQL"
6619 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6620 PostgreSQL database. See section &<<SECTsql>>&.
6621
6622 .next
6623 .cindex "sqlite lookup type"
6624 .cindex "lookup" "sqlite"
6625 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6626 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6627
6628 .next
6629 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6630 not likely to be useful in normal operation.
6631 .next
6632 .cindex "whoson lookup type"
6633 .cindex "lookup" "whoson"
6634 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6635 allows a server to check whether a particular (dynamically allocated) IP
6636 address is currently allocated to a known (trusted) user and, optionally, to
6637 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6638 at one time for &"POP before SMTP"& authentication, but that approach has been
6639 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6640 &"POP before SMTP"& checking using ACL statements such as
6641 .code
6642 require condition = \
6643   ${lookup whoson {$sender_host_address}{yes}{no}}
6644 .endd
6645 The query consists of a single IP address. The value returned is the name of
6646 the authenticated user, which is stored in the variable &$value$&. However, in
6647 this example, the data in &$value$& is not used; the result of the lookup is
6648 one of the fixed strings &"yes"& or &"no"&.
6649 .endlist
6650
6651
6652
6653 .section "Temporary errors in lookups" "SECID63"
6654 .cindex "lookup" "temporary error in"
6655 Lookup functions can return temporary error codes if the lookup cannot be
6656 completed. For example, an SQL or LDAP database might be unavailable. For this
6657 reason, it is not advisable to use a lookup that might do this for critical
6658 options such as a list of local domains.
6659
6660 When a lookup cannot be completed in a router or transport, delivery
6661 of the message (to the relevant address) is deferred, as for any other
6662 temporary error. In other circumstances Exim may assume the lookup has failed,
6663 or may give up altogether.
6664
6665
6666
6667 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6668 .cindex "wildcard lookups"
6669 .cindex "lookup" "default values"
6670 .cindex "lookup" "wildcard"
6671 .cindex "lookup" "* added to type"
6672 .cindex "default" "in single-key lookups"
6673 In this context, a &"default value"& is a value specified by the administrator
6674 that is to be used if a lookup fails.
6675
6676 &*Note:*& This section applies only to single-key lookups. For query-style
6677 lookups, the facilities of the query language must be used. An attempt to
6678 specify a default for a query-style lookup provokes an error.
6679
6680 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6681 and the initial lookup fails, the key &"*"& is looked up in the file to
6682 provide a default value. See also the section on partial matching below.
6683
6684 .cindex "*@ with single-key lookup"
6685 .cindex "lookup" "*@ added to type"
6686 .cindex "alias file" "per-domain default"
6687 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6688 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6689 character, a second lookup is done with everything before the last @ replaced
6690 by *. This makes it possible to provide per-domain defaults in alias files
6691 that include the domains in the keys. If the second lookup fails (or doesn't
6692 take place because there is no @ in the key), &"*"& is looked up.
6693 For example, a &(redirect)& router might contain:
6694 .code
6695 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6696 .endd
6697 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6698 looks up these keys, in this order:
6699 .code
6700 jane@eyre.example
6701 *@eyre.example
6702 *
6703 .endd
6704 The data is taken from whichever key it finds first. &*Note*&: In an
6705 &(lsearch)& file, this does not mean the first of these keys in the file. A
6706 complete scan is done for each key, and only if it is not found at all does
6707 Exim move on to try the next key.
6708
6709
6710
6711 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6712 .cindex "partial matching"
6713 .cindex "wildcard lookups"
6714 .cindex "lookup" "partial matching"
6715 .cindex "lookup" "wildcard"
6716 .cindex "asterisk" "in search type"
6717 The normal operation of a single-key lookup is to search the file for an exact
6718 match with the given key. However, in a number of situations where domains are
6719 being looked up, it is useful to be able to do partial matching. In this case,
6720 information in the file that has a key starting with &"*."& is matched by any
6721 domain that ends with the components that follow the full stop. For example, if
6722 a key in a DBM file is
6723 .code
6724 *.dates.fict.example
6725 .endd
6726 then when partial matching is enabled this is matched by (amongst others)
6727 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6728 by &'dates.fict.example'&, if that does not appear as a separate key in the
6729 file.
6730
6731 &*Note*&: Partial matching is not available for query-style lookups. It is
6732 also not available for any lookup items in address lists (see section
6733 &<<SECTaddresslist>>&).
6734
6735 Partial matching is implemented by doing a series of separate lookups using
6736 keys constructed by modifying the original subject key. This means that it can
6737 be used with any of the single-key lookup types, provided that
6738 partial matching keys
6739 beginning with a special prefix (default &"*."&) are included in the data file.
6740 Keys in the file that do not begin with the prefix are matched only by
6741 unmodified subject keys when partial matching is in use.
6742
6743 Partial matching is requested by adding the string &"partial-"& to the front of
6744 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6745 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6746 is added at the start of the subject key, and it is looked up again. If that
6747 fails, further lookups are tried with dot-separated components removed from the
6748 start of the subject key, one-by-one, and &"*."& added on the front of what
6749 remains.
6750
6751 A minimum number of two non-* components are required. This can be adjusted
6752 by including a number before the hyphen in the search type. For example,
6753 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6754 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6755 subject key is &'2250.dates.fict.example'& then the following keys are looked
6756 up when the minimum number of non-* components is two:
6757 .code
6758 2250.dates.fict.example
6759 *.2250.dates.fict.example
6760 *.dates.fict.example
6761 *.fict.example
6762 .endd
6763 As soon as one key in the sequence is successfully looked up, the lookup
6764 finishes.
6765
6766 .cindex "lookup" "partial matching &-- changing prefix"
6767 .cindex "prefix" "for partial matching"
6768 The use of &"*."& as the partial matching prefix is a default that can be
6769 changed. The motivation for this feature is to allow Exim to operate with file
6770 formats that are used by other MTAs. A different prefix can be supplied in
6771 parentheses instead of the hyphen after &"partial"&. For example:
6772 .code
6773 domains = partial(.)lsearch;/some/file
6774 .endd
6775 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6776 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6777 components is unchanged). The prefix may consist of any punctuation characters
6778 other than a closing parenthesis. It may be empty, for example:
6779 .code
6780 domains = partial1()cdb;/some/file
6781 .endd
6782 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6783 &`a.b.c`&, &`b.c`&, and &`c`&.
6784
6785 If &"partial0"& is specified, what happens at the end (when the lookup with
6786 just one non-wild component has failed, and the original key is shortened right
6787 down to the null string) depends on the prefix:
6788
6789 .ilist
6790 If the prefix has zero length, the whole lookup fails.
6791 .next
6792 If the prefix has length 1, a lookup for just the prefix is done. For
6793 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6794 .next
6795 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6796 remainder is looked up. With the default prefix, therefore, the final lookup is
6797 for &"*"& on its own.
6798 .next
6799 Otherwise, the whole prefix is looked up.
6800 .endlist
6801
6802
6803 If the search type ends in &"*"& or &"*@"& (see section
6804 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6805 this implies happens after all partial lookups have failed. If &"partial0"& is
6806 specified, adding &"*"& to the search type has no effect with the default
6807 prefix, because the &"*"& key is already included in the sequence of partial
6808 lookups. However, there might be a use for lookup types such as
6809 &"partial0(.)lsearch*"&.
6810
6811 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6812 in domain lists and the like. Partial matching works only in terms of
6813 dot-separated components; a key such as &`*fict.example`&
6814 in a database file is useless, because the asterisk in a partial matching
6815 subject key is always followed by a dot.
6816
6817
6818
6819
6820 .section "Lookup caching" "SECID64"
6821 .cindex "lookup" "caching"
6822 .cindex "caching" "lookup data"
6823 Exim caches all lookup results in order to avoid needless repetition of
6824 lookups. However, because (apart from the daemon) Exim operates as a collection
6825 of independent, short-lived processes, this caching applies only within a
6826 single Exim process. There is no inter-process lookup caching facility.
6827
6828 For single-key lookups, Exim keeps the relevant files open in case there is
6829 another lookup that needs them. In some types of configuration this can lead to
6830 many files being kept open for messages with many recipients. To avoid hitting
6831 the operating system limit on the number of simultaneously open files, Exim
6832 closes the least recently used file when it needs to open more files than its
6833 own internal limit, which can be changed via the &%lookup_open_max%& option.
6834
6835 The single-key lookup files are closed and the lookup caches are flushed at
6836 strategic points during delivery &-- for example, after all routing is
6837 complete.
6838
6839
6840
6841
6842 .section "Quoting lookup data" "SECID65"
6843 .cindex "lookup" "quoting"
6844 .cindex "quoting" "in lookups"
6845 When data from an incoming message is included in a query-style lookup, there
6846 is the possibility of special characters in the data messing up the syntax of
6847 the query. For example, a NIS+ query that contains
6848 .code
6849 [name=$local_part]
6850 .endd
6851 will be broken if the local part happens to contain a closing square bracket.
6852 For NIS+, data can be enclosed in double quotes like this:
6853 .code
6854 [name="$local_part"]
6855 .endd
6856 but this still leaves the problem of a double quote in the data. The rule for
6857 NIS+ is that double quotes must be doubled. Other lookup types have different
6858 rules, and to cope with the differing requirements, an expansion operator
6859 of the following form is provided:
6860 .code
6861 ${quote_<lookup-type>:<string>}
6862 .endd
6863 For example, the safest way to write the NIS+ query is
6864 .code
6865 [name="${quote_nisplus:$local_part}"]
6866 .endd
6867 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6868 operator can be used for all lookup types, but has no effect for single-key
6869 lookups, since no quoting is ever needed in their key strings.
6870
6871
6872
6873
6874 .section "More about dnsdb" "SECTdnsdb"
6875 .cindex "dnsdb lookup"
6876 .cindex "lookup" "dnsdb"
6877 .cindex "DNS" "as a lookup type"
6878 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6879 of a record type and a domain name, separated by an equals sign. For example,
6880 an expansion string could contain:
6881 .code
6882 ${lookup dnsdb{mx=a.b.example}{$value}fail}
6883 .endd
6884 If the lookup succeeds, the result is placed in &$value$&, which in this case
6885 is used on its own as the result. If the lookup does not succeed, the
6886 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
6887 &<<SECTforexpfai>>& for an explanation of what this means.
6888
6889 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
6890 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
6891 If no type is given, TXT is assumed.
6892
6893 For any record type, if multiple records are found, the data is returned as a
6894 concatenation, with newline as the default separator. The order, of course,
6895 depends on the DNS resolver. You can specify a different separator character
6896 between multiple records by putting a right angle-bracket followed immediately
6897 by the new separator at the start of the query. For example:
6898 .code
6899 ${lookup dnsdb{>: a=host1.example}}
6900 .endd
6901 It is permitted to specify a space as the separator character. Further
6902 white space is ignored.
6903 For lookup types that return multiple fields per record,
6904 an alternate field separator can be specified using a comma after the main
6905 separator character, followed immediately by the field separator.
6906
6907 .cindex "PTR record" "in &(dnsdb)& lookup"
6908 When the type is PTR,
6909 the data can be an IP address, written as normal; inversion and the addition of
6910 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
6911 .code
6912 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
6913 .endd
6914 If the data for a PTR record is not a syntactically valid IP address, it is not
6915 altered and nothing is added.
6916
6917 .cindex "MX record" "in &(dnsdb)& lookup"
6918 .cindex "SRV record" "in &(dnsdb)& lookup"
6919 For an MX lookup, both the preference value and the host name are returned for
6920 each record, separated by a space. For an SRV lookup, the priority, weight,
6921 port, and host name are returned for each record, separated by spaces.
6922 The field separator can be modified as above.
6923
6924 .cindex "TXT record" "in &(dnsdb)& lookup"
6925 .cindex "SPF record" "in &(dnsdb)& lookup"
6926 For TXT records with multiple items of data, only the first item is returned,
6927 unless a field separator is specified.
6928 To concatenate items without a separator, use a semicolon instead.
6929 For SPF records the
6930 default behaviour is to concatenate multiple items without using a separator.
6931 .code
6932 ${lookup dnsdb{>\n,: txt=a.b.example}}
6933 ${lookup dnsdb{>\n; txt=a.b.example}}
6934 ${lookup dnsdb{spf=example.org}}
6935 .endd
6936 It is permitted to specify a space as the separator character. Further
6937 white space is ignored.
6938
6939 .cindex "SOA record" "in &(dnsdb)& lookup"
6940 For an SOA lookup, while no result is obtained the lookup is redone with
6941 successively more leading components dropped from the given domain.
6942 Only the primary-nameserver field is returned unless a field separator is
6943 specified.
6944 .code
6945 ${lookup dnsdb{>:,; soa=a.b.example.com}}
6946 .endd
6947
6948 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
6949 .cindex "dnsdb modifiers"
6950 .cindex "modifiers" "dnsdb"
6951 .cindex "options" "dnsdb"
6952 Modifiers for &(dnsdb)& lookups are givien by optional keywords,
6953 each followed by a comma,
6954 that may appear before the record type.
6955
6956 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
6957 temporary DNS error for any of them, the behaviour is controlled by
6958 a defer-option modifier.
6959 The possible keywords are
6960 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
6961 With &"strict"& behaviour, any temporary DNS error causes the
6962 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
6963 ignored, and the behaviour is as if the DNS lookup failed to find anything.
6964 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
6965 error causes the whole lookup to defer only if none of the other lookups
6966 succeed. The default is &"lax"&, so the following lookups are equivalent:
6967 .code
6968 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
6969 ${lookup dnsdb{a=one.host.com:two.host.com}}
6970 .endd
6971 Thus, in the default case, as long as at least one of the DNS lookups
6972 yields some data, the lookup succeeds.
6973
6974 .cindex "DNSSEC" "dns lookup"
6975 Use of &(DNSSEC)& is controlled by a dnssec modifier.
6976 The possible keywords are
6977 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
6978 With &"strict"& or &"lax"& DNSSEC information is requested
6979 with the lookup.
6980 With &"strict"& a response from the DNS resolver that
6981 is not labelled as authenticated data
6982 is treated as equivalent to a temporary DNS error.
6983 The default is &"never"&.
6984
6985 See also the &$lookup_dnssec_authenticated$& variable.
6986
6987 .cindex timeout "dns lookup"
6988 .cindex "DNS" timeout
6989 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
6990 The form is &"retrans_VAL"& where VAL is an Exim time specification
6991 (eg &"5s"&).
6992 The default value is set by the main configuration option &%dns_retrans%&.
6993
6994 Retries for the dnsdb lookup can be controlled by a retry modifier.
6995 The form if &"retry_VAL"& where VAL is an integer.
6996 The default count is set by the main configuration option &%dns_retry%&.
6997
6998
6999 .section "Pseudo dnsdb record types" "SECID66"
7000 .cindex "MX record" "in &(dnsdb)& lookup"
7001 By default, both the preference value and the host name are returned for
7002 each MX record, separated by a space. If you want only host names, you can use
7003 the pseudo-type MXH:
7004 .code
7005 ${lookup dnsdb{mxh=a.b.example}}
7006 .endd
7007 In this case, the preference values are omitted, and just the host names are
7008 returned.
7009
7010 .cindex "name server for enclosing domain"
7011 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7012 records on the given domain, but if none are found, it removes the first
7013 component of the domain name, and tries again. This process continues until NS
7014 records are found or there are no more components left (or there is a DNS
7015 error). In other words, it may return the name servers for a top-level domain,
7016 but it never returns the root name servers. If there are no NS records for the
7017 top-level domain, the lookup fails. Consider these examples:
7018 .code
7019 ${lookup dnsdb{zns=xxx.quercite.com}}
7020 ${lookup dnsdb{zns=xxx.edu}}
7021 .endd
7022 Assuming that in each case there are no NS records for the full domain name,
7023 the first returns the name servers for &%quercite.com%&, and the second returns
7024 the name servers for &%edu%&.
7025
7026 You should be careful about how you use this lookup because, unless the
7027 top-level domain does not exist, the lookup always returns some host names. The
7028 sort of use to which this might be put is for seeing if the name servers for a
7029 given domain are on a blacklist. You can probably assume that the name servers
7030 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7031 such a list.
7032
7033 .cindex "CSA" "in &(dnsdb)& lookup"
7034 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7035 records according to the CSA rules, which are described in section
7036 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7037 not sufficient because of the extra parent domain search behaviour of CSA. The
7038 result of a successful lookup such as:
7039 .code
7040 ${lookup dnsdb {csa=$sender_helo_name}}
7041 .endd
7042 has two space-separated fields: an authorization code and a target host name.
7043 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7044 authorization required but absent, or &"?"& for unknown.
7045
7046 .cindex "A+" "in &(dnsdb)& lookup"
7047 The pseudo-type A+ performs an AAAA
7048 and then an A lookup.  All results are returned; defer processing
7049 (see below) is handled separately for each lookup.  Example:
7050 .code
7051 ${lookup dnsdb {>; a+=$sender_helo_name}}
7052 .endd
7053
7054
7055 .section "Multiple dnsdb lookups" "SECID67"
7056 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7057 However, you can specify a list of domains or IP addresses in a single
7058 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7059 the default separator, but with the ability to change this. For example:
7060 .code
7061 ${lookup dnsdb{one.domain.com:two.domain.com}}
7062 ${lookup dnsdb{a=one.host.com:two.host.com}}
7063 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7064 .endd
7065 In order to retain backwards compatibility, there is one special case: if
7066 the lookup type is PTR and no change of separator is specified, Exim looks
7067 to see if the rest of the string is precisely one IPv6 address. In this
7068 case, it does not treat it as a list.
7069
7070 The data from each lookup is concatenated, with newline separators by default,
7071 in the same way that multiple DNS records for a single item are handled. A
7072 different separator can be specified, as described above.
7073
7074
7075
7076
7077 .section "More about LDAP" "SECTldap"
7078 .cindex "LDAP" "lookup, more about"
7079 .cindex "lookup" "LDAP"
7080 .cindex "Solaris" "LDAP"
7081 The original LDAP implementation came from the University of Michigan; this has
7082 become &"Open LDAP"&, and there are now two different releases. Another
7083 implementation comes from Netscape, and Solaris 7 and subsequent releases
7084 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7085 the lookup function level, their error handling is different. For this reason
7086 it is necessary to set a compile-time variable when building Exim with LDAP, to
7087 indicate which LDAP library is in use. One of the following should appear in
7088 your &_Local/Makefile_&:
7089 .code
7090 LDAP_LIB_TYPE=UMICHIGAN
7091 LDAP_LIB_TYPE=OPENLDAP1
7092 LDAP_LIB_TYPE=OPENLDAP2
7093 LDAP_LIB_TYPE=NETSCAPE
7094 LDAP_LIB_TYPE=SOLARIS
7095 .endd
7096 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7097 same interface as the University of Michigan version.
7098
7099 There are three LDAP lookup types in Exim. These behave slightly differently in
7100 the way they handle the results of a query:
7101
7102 .ilist
7103 &(ldap)& requires the result to contain just one entry; if there are more, it
7104 gives an error.
7105 .next
7106 &(ldapdn)& also requires the result to contain just one entry, but it is the
7107 Distinguished Name that is returned rather than any attribute values.
7108 .next
7109 &(ldapm)& permits the result to contain more than one entry; the attributes
7110 from all of them are returned.
7111 .endlist
7112
7113
7114 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7115 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7116 the data returned by a successful lookup is described in the next section.
7117 First we explain how LDAP queries are coded.
7118
7119
7120 .section "Format of LDAP queries" "SECTforldaque"
7121 .cindex "LDAP" "query format"
7122 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7123 the configuration of a &(redirect)& router one might have this setting:
7124 .code
7125 data = ${lookup ldap \
7126   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7127   c=UK?mailbox?base?}}
7128 .endd
7129 .cindex "LDAP" "with TLS"
7130 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7131 secure (encrypted) LDAP connections. The second of these ensures that an
7132 encrypted TLS connection is used.
7133
7134 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7135 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7136 See the &%ldap_start_tls%& option.
7137
7138 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7139 controlled. Every part of the TLS configuration can be configured by settings in
7140 &_exim.conf_&. Depending on the version of the client libraries installed on
7141 your system, some of the initialization may have required setting options in
7142 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7143 certificates. This revealed a nuance where the current UID that exim was
7144 running as could affect which config files it read. With Exim 4.83, these
7145 methods become optional, only taking effect if not specifically set in
7146 &_exim.conf_&.
7147
7148
7149 .section "LDAP quoting" "SECID68"
7150 .cindex "LDAP" "quoting"
7151 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7152 and the second because the LDAP query is represented as a URL. Furthermore,
7153 within an LDAP query, two different kinds of quoting are required. For this
7154 reason, there are two different LDAP-specific quoting operators.
7155
7156 The &%quote_ldap%& operator is designed for use on strings that are part of
7157 filter specifications. Conceptually, it first does the following conversions on
7158 the string:
7159 .code
7160 *   =>   \2A
7161 (   =>   \28
7162 )   =>   \29
7163 \   =>   \5C
7164 .endd
7165 in accordance with RFC 2254. The resulting string is then quoted according
7166 to the rules for URLs, that is, all non-alphanumeric characters except
7167 .code
7168 ! $ ' - . _ ( ) * +
7169 .endd
7170 are converted to their hex values, preceded by a percent sign. For example:
7171 .code
7172 ${quote_ldap: a(bc)*, a<yz>; }
7173 .endd
7174 yields
7175 .code
7176 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7177 .endd
7178 Removing the URL quoting, this is (with a leading and a trailing space):
7179 .code
7180 a\28bc\29\2A, a<yz>;
7181 .endd
7182 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7183 base DN specifications in queries. Conceptually, it first converts the string
7184 by inserting a backslash in front of any of the following characters:
7185 .code
7186 , + " \ < > ;
7187 .endd
7188 It also inserts a backslash before any leading spaces or # characters, and
7189 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7190 is then quoted according to the rules for URLs. For example:
7191 .code
7192 ${quote_ldap_dn: a(bc)*, a<yz>; }
7193 .endd
7194 yields
7195 .code
7196 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7197 .endd
7198 Removing the URL quoting, this is (with a trailing space):
7199 .code
7200 \ a(bc)*\, a\<yz\>\;\
7201 .endd
7202 There are some further comments about quoting in the section on LDAP
7203 authentication below.
7204
7205
7206 .section "LDAP connections" "SECID69"
7207 .cindex "LDAP" "connections"
7208 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7209 is in use, via a Unix domain socket. The example given above does not specify
7210 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7211 by starting it with
7212 .code
7213 ldap://<hostname>:<port>/...
7214 .endd
7215 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7216 used. When no server is specified in a query, a list of default servers is
7217 taken from the &%ldap_default_servers%& configuration option. This supplies a
7218 colon-separated list of servers which are tried in turn until one successfully
7219 handles a query, or there is a serious error. Successful handling either
7220 returns the requested data, or indicates that it does not exist. Serious errors
7221 are syntactical, or multiple values when only a single value is expected.
7222 Errors which cause the next server to be tried are connection failures, bind
7223 failures, and timeouts.
7224
7225 For each server name in the list, a port number can be given. The standard way
7226 of specifying a host and port is to use a colon separator (RFC 1738). Because
7227 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7228 doubled. For example
7229 .code
7230 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7231 .endd
7232 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7233 to the LDAP library with no server name, and the library's default (normally
7234 the local host) is used.
7235
7236 If you are using the OpenLDAP library, you can connect to an LDAP server using
7237 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7238 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7239 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7240 not available.
7241
7242 For this type of connection, instead of a host name for the server, a pathname
7243 for the socket is required, and the port number is not relevant. The pathname
7244 can be specified either as an item in &%ldap_default_servers%&, or inline in
7245 the query. In the former case, you can have settings such as
7246 .code
7247 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7248 .endd
7249 When the pathname is given in the query, you have to escape the slashes as
7250 &`%2F`& to fit in with the LDAP URL syntax. For example:
7251 .code
7252 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7253 .endd
7254 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7255 a pathname, it uses the Unix domain socket code, even if the query actually
7256 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7257 socket connection. This behaviour means that you can use a setting of
7258 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7259 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7260 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7261 backup host.
7262
7263 If an explicit &`ldapi`& type is given in a query when a host name is
7264 specified, an error is diagnosed. However, if there are more items in
7265 &%ldap_default_servers%&, they are tried. In other words:
7266
7267 .ilist
7268 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7269 interface.
7270 .next
7271 Using &`ldapi`& with a host name causes an error.
7272 .endlist
7273
7274
7275 Using &`ldapi`& with no host or path in the query, and no setting of
7276 &%ldap_default_servers%&, does whatever the library does by default.
7277
7278
7279
7280 .section "LDAP authentication and control information" "SECID70"
7281 .cindex "LDAP" "authentication"
7282 The LDAP URL syntax provides no way of passing authentication and other control
7283 information to the server. To make this possible, the URL in an LDAP query may
7284 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7285 spaces. If a value contains spaces it must be enclosed in double quotes, and
7286 when double quotes are used, backslash is interpreted in the usual way inside
7287 them. The following names are recognized:
7288 .display
7289 &`DEREFERENCE`&  set the dereferencing parameter
7290 &`NETTIME    `&  set a timeout for a network operation
7291 &`USER       `&  set the DN, for authenticating the LDAP bind
7292 &`PASS       `&  set the password, likewise
7293 &`REFERRALS  `&  set the referrals parameter
7294 &`SERVERS    `&  set alternate server list for this query only
7295 &`SIZE       `&  set the limit for the number of entries returned
7296 &`TIME       `&  set the maximum waiting time for a query
7297 .endd
7298 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7299 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7300 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7301 library from trying to follow referrals issued by the LDAP server.
7302
7303 The name CONNECT is an obsolete name for NETTIME, retained for
7304 backwards compatibility. This timeout (specified as a number of seconds) is
7305 enforced from the client end for operations that can be carried out over a
7306 network. Specifically, it applies to network connections and calls to the
7307 &'ldap_result()'& function. If the value is greater than zero, it is used if
7308 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7309 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7310 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7311 Netscape SDK; for OpenLDAP no action is taken.
7312
7313 The TIME parameter (also a number of seconds) is passed to the server to
7314 set a server-side limit on the time taken to complete a search.
7315
7316 The SERVERS parameter allows you to specify an alternate list of ldap servers
7317 to use for an individual lookup.  The global ldap_servers option provides a
7318 default list of ldap servers, and a single lookup can specify a single ldap
7319 server to use.  But when you need to do a lookup with a list of servers that is
7320 different than the default list (maybe different order, maybe a completely
7321 different set of servers), the SERVERS parameter allows you to specify this
7322 alternate list (colon-separated).
7323
7324 Here is an example of an LDAP query in an Exim lookup that uses some of these
7325 values. This is a single line, folded to fit on the page:
7326 .code
7327 ${lookup ldap
7328   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7329   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7330   {$value}fail}
7331 .endd
7332 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7333 any of the auxiliary data. Exim configuration settings that include lookups
7334 which contain password information should be preceded by &"hide"& to prevent
7335 non-admin users from using the &%-bP%& option to see their values.
7336
7337 The auxiliary data items may be given in any order. The default is no
7338 connection timeout (the system timeout is used), no user or password, no limit
7339 on the number of entries returned, and no time limit on queries.
7340
7341 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7342 removes any URL quoting that it may contain before passing it LDAP. Apparently
7343 some libraries do this for themselves, but some do not. Removing the URL
7344 quoting has two advantages:
7345
7346 .ilist
7347 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7348 DNs as with DNs inside actual queries.
7349 .next
7350 It permits spaces inside USER= DNs.
7351 .endlist
7352
7353 For example, a setting such as
7354 .code
7355 USER=cn=${quote_ldap_dn:$1}
7356 .endd
7357 should work even if &$1$& contains spaces.
7358
7359 Expanded data for the PASS= value should be quoted using the &%quote%&
7360 expansion operator, rather than the LDAP quote operators. The only reason this
7361 field needs quoting is to ensure that it conforms to the Exim syntax, which
7362 does not allow unquoted spaces. For example:
7363 .code
7364 PASS=${quote:$3}
7365 .endd
7366 The LDAP authentication mechanism can be used to check passwords as part of
7367 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7368 &<<CHAPexpand>>&.
7369
7370
7371
7372 .section "Format of data returned by LDAP" "SECID71"
7373 .cindex "LDAP" "returned data formats"
7374 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7375 as a sequence of values, for example
7376 .code
7377 cn=manager, o=University of Cambridge, c=UK
7378 .endd
7379 The &(ldap)& lookup type generates an error if more than one entry matches the
7380 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7381 the result between the data from different entries. It is possible for multiple
7382 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7383 you know that whatever values are returned all came from a single entry in the
7384 directory.
7385
7386 In the common case where you specify a single attribute in your LDAP query, the
7387 result is not quoted, and does not contain the attribute name. If the attribute
7388 has multiple values, they are separated by commas.
7389
7390 If you specify multiple attributes, the result contains space-separated, quoted
7391 strings, each preceded by the attribute name and an equals sign. Within the
7392 quotes, the quote character, backslash, and newline are escaped with
7393 backslashes, and commas are used to separate multiple values for the attribute.
7394 Any commas in attribute values are doubled
7395 (permitting treatment of the values as a comma-separated list).
7396 Apart from the escaping, the string within quotes takes the same form as the
7397 output when a single attribute is requested. Specifying no attributes is the
7398 same as specifying all of an entry's attributes.
7399
7400 Here are some examples of the output format. The first line of each pair is an
7401 LDAP query, and the second is the data that is returned. The attribute called
7402 &%attr1%& has two values, one of them with an embedded comma, whereas
7403 &%attr2%& has only one value:
7404 .code
7405 ldap:///o=base?attr1?sub?(uid=fred)
7406 value1.1,value1,,2
7407
7408 ldap:///o=base?attr2?sub?(uid=fred)
7409 value two
7410
7411 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7412 attr1="value1.1,value1,,2" attr2="value two"
7413
7414 ldap:///o=base??sub?(uid=fred)
7415 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7416 .endd
7417 You can
7418 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7419 results of LDAP lookups.
7420 The &%extract%& operator in string expansions can be used to pick out
7421 individual fields from data that consists of &'key'&=&'value'& pairs.
7422 The &%listextract%& operator should be used to pick out individual values
7423 of attributes, even when only a single value is expected.
7424 The doubling of embedded commas allows you to use the returned data as a
7425 comma separated list (using the "<," syntax for changing the input list separator).
7426
7427
7428
7429
7430 .section "More about NIS+" "SECTnisplus"
7431 .cindex "NIS+ lookup type"
7432 .cindex "lookup" "NIS+"
7433 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7434 and field name. If this is given, the result of a successful query is the
7435 contents of the named field; otherwise the result consists of a concatenation
7436 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7437 values containing spaces are quoted. For example, the query
7438 .code
7439 [name=mg1456],passwd.org_dir
7440 .endd
7441 might return the string
7442 .code
7443 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7444 home=/home/mg1456 shell=/bin/bash shadow=""
7445 .endd
7446 (split over two lines here to fit on the page), whereas
7447 .code
7448 [name=mg1456],passwd.org_dir:gcos
7449 .endd
7450 would just return
7451 .code
7452 Martin Guerre
7453 .endd
7454 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7455 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7456 operator is to double any quote characters within the text.
7457
7458
7459
7460 .section "SQL lookups" "SECTsql"
7461 .cindex "SQL lookup types"
7462 .cindex "MySQL" "lookup type"
7463 .cindex "PostgreSQL lookup type"
7464 .cindex "lookup" "MySQL"
7465 .cindex "lookup" "PostgreSQL"
7466 .cindex "Oracle" "lookup type"
7467 .cindex "lookup" "Oracle"
7468 .cindex "InterBase lookup type"
7469 .cindex "lookup" "InterBase"
7470 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, and SQLite
7471 databases. Queries for these databases contain SQL statements, so an example
7472 might be
7473 .code
7474 ${lookup mysql{select mailbox from users where id='userx'}\
7475   {$value}fail}
7476 .endd
7477 If the result of the query contains more than one field, the data for each
7478 field in the row is returned, preceded by its name, so the result of
7479 .code
7480 ${lookup pgsql{select home,name from users where id='userx'}\
7481   {$value}}
7482 .endd
7483 might be
7484 .code
7485 home=/home/userx name="Mister X"
7486 .endd
7487 Empty values and values containing spaces are double quoted, with embedded
7488 quotes escaped by a backslash. If the result of the query contains just one
7489 field, the value is passed back verbatim, without a field name, for example:
7490 .code
7491 Mister X
7492 .endd
7493 If the result of the query yields more than one row, it is all concatenated,
7494 with a newline between the data for each row.
7495
7496
7497 .section "More about MySQL, PostgreSQL, Oracle, and InterBase" "SECID72"
7498 .cindex "MySQL" "lookup type"
7499 .cindex "PostgreSQL lookup type"
7500 .cindex "lookup" "MySQL"
7501 .cindex "lookup" "PostgreSQL"
7502 .cindex "Oracle" "lookup type"
7503 .cindex "lookup" "Oracle"
7504 .cindex "InterBase lookup type"
7505 .cindex "lookup" "InterBase"
7506 If any MySQL, PostgreSQL, Oracle, or InterBase lookups are used, the
7507 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, or &%ibase_servers%&
7508 option (as appropriate) must be set to a colon-separated list of server
7509 information.
7510 (For MySQL and PostgreSQL only, the global option need not be set if all
7511 queries contain their own server information &-- see section
7512 &<<SECTspeserque>>&.) Each item in the list is a slash-separated list of four
7513 items: host name, database name, user name, and password. In the case of
7514 Oracle, the host name field is used for the &"service name"&, and the database
7515 name field is not used and should be empty. For example:
7516 .code
7517 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7518 .endd
7519 Because password data is sensitive, you should always precede the setting with
7520 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7521 option. Here is an example where two MySQL servers are listed:
7522 .code
7523 hide mysql_servers = localhost/users/root/secret:\
7524                      otherhost/users/root/othersecret
7525 .endd
7526 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7527 because this is a colon-separated list, the colon has to be doubled. For each
7528 query, these parameter groups are tried in order until a connection is made and
7529 a query is successfully processed. The result of a query may be that no data is
7530 found, but that is still a successful query. In other words, the list of
7531 servers provides a backup facility, not a list of different places to look.
7532
7533 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7534 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7535 respectively, and the characters single-quote, double-quote, and backslash
7536 itself are escaped with backslashes. The &%quote_pgsql%& expansion operator, in
7537 addition, escapes the percent and underscore characters. This cannot be done
7538 for MySQL because these escapes are not recognized in contexts where these
7539 characters are not special.
7540
7541 .section "Specifying the server in the query" "SECTspeserque"
7542 For MySQL and PostgreSQL lookups (but not currently for Oracle and InterBase),
7543 it is possible to specify a list of servers with an individual query. This is
7544 done by starting the query with
7545 .display
7546 &`servers=`&&'server1:server2:server3:...'&&`;`&
7547 .endd
7548 Each item in the list may take one of two forms:
7549 .olist
7550 If it contains no slashes it is assumed to be just a host name. The appropriate
7551 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7552 of the same name, and the remaining parameters (database, user, password) are
7553 taken from there.
7554 .next
7555 If it contains any slashes, it is taken as a complete parameter set.
7556 .endlist
7557 The list of servers is used in exactly the same way as the global list.
7558 Once a connection to a server has happened and a query has been
7559 successfully executed, processing of the lookup ceases.
7560
7561 This feature is intended for use in master/slave situations where updates
7562 are occurring and you want to update the master rather than a slave. If the
7563 master is in the list as a backup for reading, you might have a global setting
7564 like this:
7565 .code
7566 mysql_servers = slave1/db/name/pw:\
7567                 slave2/db/name/pw:\
7568                 master/db/name/pw
7569 .endd
7570 In an updating lookup, you could then write:
7571 .code
7572 ${lookup mysql{servers=master; UPDATE ...} }
7573 .endd
7574 That query would then be sent only to the master server. If, on the other hand,
7575 the master is not to be used for reading, and so is not present in the global
7576 option, you can still update it by a query of this form:
7577 .code
7578 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7579 .endd
7580
7581
7582 .section "Special MySQL features" "SECID73"
7583 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7584 causes a connection to the server on the local host by means of a Unix domain
7585 socket. An alternate socket can be specified in parentheses. The full syntax of
7586 each item in &%mysql_servers%& is:
7587 .display
7588 <&'hostname'&>::<&'port'&>(<&'socket name'&>)/<&'database'&>/&&&
7589   <&'user'&>/<&'password'&>
7590 .endd
7591 Any of the three sub-parts of the first field can be omitted. For normal use on
7592 the local host it can be left blank or set to just &"localhost"&.
7593
7594 No database need be supplied &-- but if it is absent here, it must be given in
7595 the queries.
7596
7597 If a MySQL query is issued that does not request any data (an insert, update,
7598 or delete command), the result of the lookup is the number of rows affected.
7599
7600 &*Warning*&: This can be misleading. If an update does not actually change
7601 anything (for example, setting a field to the value it already has), the result
7602 is zero because no rows are affected.
7603
7604
7605 .section "Special PostgreSQL features" "SECID74"
7606 PostgreSQL lookups can also use Unix domain socket connections to the database.
7607 This is usually faster and costs less CPU time than a TCP/IP connection.
7608 However it can be used only if the mail server runs on the same machine as the
7609 database server. A configuration line for PostgreSQL via Unix domain sockets
7610 looks like this:
7611 .code
7612 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7613 .endd
7614 In other words, instead of supplying a host name, a path to the socket is
7615 given. The path name is enclosed in parentheses so that its slashes aren't
7616 visually confused with the delimiters for the other server parameters.
7617
7618 If a PostgreSQL query is issued that does not request any data (an insert,
7619 update, or delete command), the result of the lookup is the number of rows
7620 affected.
7621
7622 .section "More about SQLite" "SECTsqlite"
7623 .cindex "lookup" "SQLite"
7624 .cindex "sqlite lookup type"
7625 SQLite is different to the other SQL lookups because a file name is required in
7626 addition to the SQL query. An SQLite database is a single file, and there is no
7627 daemon as in the other SQL databases. The interface to Exim requires the name
7628 of the file, as an absolute path, to be given at the start of the query. It is
7629 separated from the query by white space. This means that the path name cannot
7630 contain white space. Here is a lookup expansion example:
7631 .code
7632 ${lookup sqlite {/some/thing/sqlitedb \
7633   select name from aliases where id='userx';}}
7634 .endd
7635 In a list, the syntax is similar. For example:
7636 .code
7637 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7638    select * from relays where ip='$sender_host_address';
7639 .endd
7640 The only character affected by the &%quote_sqlite%& operator is a single
7641 quote, which it doubles.
7642
7643 The SQLite library handles multiple simultaneous accesses to the database
7644 internally. Multiple readers are permitted, but only one process can
7645 update at once. Attempts to access the database while it is being updated
7646 are rejected after a timeout period, during which the SQLite library
7647 waits for the lock to be released. In Exim, the default timeout is set
7648 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7649 option.
7650 .ecindex IIDfidalo1
7651 .ecindex IIDfidalo2
7652
7653
7654 . ////////////////////////////////////////////////////////////////////////////
7655 . ////////////////////////////////////////////////////////////////////////////
7656
7657 .chapter "Domain, host, address, and local part lists" &&&
7658          "CHAPdomhosaddlists" &&&
7659          "Domain, host, and address lists"
7660 .scindex IIDdohoadli "lists of domains; hosts; etc."
7661 A number of Exim configuration options contain lists of domains, hosts,
7662 email addresses, or local parts. For example, the &%hold_domains%& option
7663 contains a list of domains whose delivery is currently suspended. These lists
7664 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7665 arguments to expansion conditions such as &%match_domain%&.
7666
7667 Each item in one of these lists is a pattern to be matched against a domain,
7668 host, email address, or local part, respectively. In the sections below, the
7669 different types of pattern for each case are described, but first we cover some
7670 general facilities that apply to all four kinds of list.
7671
7672
7673
7674 .section "Expansion of lists" "SECID75"
7675 .cindex "expansion" "of lists"
7676 Each list is expanded as a single string before it is used. The result of
7677 expansion must be a list, possibly containing empty items, which is split up
7678 into separate items for matching. By default, colon is the separator character,
7679 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7680 &<<SECTempitelis>>& for details of the list syntax; the second of these
7681 discusses the way to specify empty list items.
7682
7683
7684 If the string expansion is forced to fail, Exim behaves as if the item it is
7685 testing (domain, host, address, or local part) is not in the list. Other
7686 expansion failures cause temporary errors.
7687
7688 If an item in a list is a regular expression, backslashes, dollars and possibly
7689 other special characters in the expression must be protected against
7690 misinterpretation by the string expander. The easiest way to do this is to use
7691 the &`\N`& expansion feature to indicate that the contents of the regular
7692 expression should not be expanded. For example, in an ACL you might have:
7693 .code
7694 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7695                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7696 .endd
7697 The first item is a regular expression that is protected from expansion by
7698 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7699 senders based on the receiving domain.
7700
7701
7702
7703
7704 .section "Negated items in lists" "SECID76"
7705 .cindex "list" "negation"
7706 .cindex "negation" "in lists"
7707 Items in a list may be positive or negative. Negative items are indicated by a
7708 leading exclamation mark, which may be followed by optional white space. A list
7709 defines a set of items (domains, etc). When Exim processes one of these lists,
7710 it is trying to find out whether a domain, host, address, or local part
7711 (respectively) is in the set that is defined by the list. It works like this:
7712
7713 The list is scanned from left to right. If a positive item is matched, the
7714 subject that is being checked is in the set; if a negative item is matched, the
7715 subject is not in the set. If the end of the list is reached without the
7716 subject having matched any of the patterns, it is in the set if the last item
7717 was a negative one, but not if it was a positive one. For example, the list in
7718 .code
7719 domainlist relay_to_domains = !a.b.c : *.b.c
7720 .endd
7721 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7722 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7723 list is positive. However, if the setting were
7724 .code
7725 domainlist relay_to_domains = !a.b.c
7726 .endd
7727 then all domains other than &'a.b.c'& would match because the last item in the
7728 list is negative. In other words, a list that ends with a negative item behaves
7729 as if it had an extra item &`:*`& on the end.
7730
7731 Another way of thinking about positive and negative items in lists is to read
7732 the connector as &"or"& after a positive item and as &"and"& after a negative
7733 item.
7734
7735
7736
7737 .section "File names in lists" "SECTfilnamlis"
7738 .cindex "list" "file name in"
7739 If an item in a domain, host, address, or local part list is an absolute file
7740 name (beginning with a slash character), each line of the file is read and
7741 processed as if it were an independent item in the list, except that further
7742 file names are not allowed,
7743 and no expansion of the data from the file takes place.
7744 Empty lines in the file are ignored, and the file may also contain comment
7745 lines:
7746
7747 .ilist
7748 For domain and host lists, if a # character appears anywhere in a line of the
7749 file, it and all following characters are ignored.
7750 .next
7751 Because local parts may legitimately contain # characters, a comment in an
7752 address list or local part list file is recognized only if # is preceded by
7753 white space or the start of the line. For example:
7754 .code
7755 not#comment@x.y.z   # but this is a comment
7756 .endd
7757 .endlist
7758
7759 Putting a file name in a list has the same effect as inserting each line of the
7760 file as an item in the list (blank lines and comments excepted). However, there
7761 is one important difference: the file is read each time the list is processed,
7762 so if its contents vary over time, Exim's behaviour changes.
7763
7764 If a file name is preceded by an exclamation mark, the sense of any match
7765 within the file is inverted. For example, if
7766 .code
7767 hold_domains = !/etc/nohold-domains
7768 .endd
7769 and the file contains the lines
7770 .code
7771 !a.b.c
7772 *.b.c
7773 .endd
7774 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7775 any domain matching &`*.b.c`& is not.
7776
7777
7778
7779 .section "An lsearch file is not an out-of-line list" "SECID77"
7780 As will be described in the sections that follow, lookups can be used in lists
7781 to provide indexed methods of checking list membership. There has been some
7782 confusion about the way &(lsearch)& lookups work in lists. Because
7783 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7784 sometimes thought that it is allowed to contain wild cards and other kinds of
7785 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7786 always fixed strings, just as for any other single-key lookup type.
7787
7788 If you want to use a file to contain wild-card patterns that form part of a
7789 list, just give the file name on its own, without a search type, as described
7790 in the previous section. You could also use the &(wildlsearch)& or
7791 &(nwildlsearch)&, but there is no advantage in doing this.
7792
7793
7794
7795
7796 .section "Named lists" "SECTnamedlists"
7797 .cindex "named lists"
7798 .cindex "list" "named"
7799 A list of domains, hosts, email addresses, or local parts can be given a name
7800 which is then used to refer to the list elsewhere in the configuration. This is
7801 particularly convenient if the same list is required in several different
7802 places. It also allows lists to be given meaningful names, which can improve
7803 the readability of the configuration. For example, it is conventional to define
7804 a domain list called &'local_domains'& for all the domains that are handled
7805 locally on a host, using a configuration line such as
7806 .code
7807 domainlist local_domains = localhost:my.dom.example
7808 .endd
7809 Named lists are referenced by giving their name preceded by a plus sign, so,
7810 for example, a router that is intended to handle local domains would be
7811 configured with the line
7812 .code
7813 domains = +local_domains
7814 .endd
7815 The first router in a configuration is often one that handles all domains
7816 except the local ones, using a configuration with a negated item like this:
7817 .code
7818 dnslookup:
7819   driver = dnslookup
7820   domains = ! +local_domains
7821   transport = remote_smtp
7822   no_more
7823 .endd
7824 The four kinds of named list are created by configuration lines starting with
7825 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
7826 respectively. Then there follows the name that you are defining, followed by an
7827 equals sign and the list itself. For example:
7828 .code
7829 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
7830 addresslist bad_senders = cdb;/etc/badsenders
7831 .endd
7832 A named list may refer to other named lists:
7833 .code
7834 domainlist  dom1 = first.example : second.example
7835 domainlist  dom2 = +dom1 : third.example
7836 domainlist  dom3 = fourth.example : +dom2 : fifth.example
7837 .endd
7838 &*Warning*&: If the last item in a referenced list is a negative one, the
7839 effect may not be what you intended, because the negation does not propagate
7840 out to the higher level. For example, consider:
7841 .code
7842 domainlist  dom1 = !a.b
7843 domainlist  dom2 = +dom1 : *.b
7844 .endd
7845 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
7846 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
7847 means it matches the second list as well. The effect is not the same as
7848 .code
7849 domainlist  dom2 = !a.b : *.b
7850 .endd
7851 where &'x.y'& does not match. It's best to avoid negation altogether in
7852 referenced lists if you can.
7853
7854 Named lists may have a performance advantage. When Exim is routing an
7855 address or checking an incoming message, it caches the result of tests on named
7856 lists. So, if you have a setting such as
7857 .code
7858 domains = +local_domains
7859 .endd
7860 on several of your routers
7861 or in several ACL statements,
7862 the actual test is done only for the first one. However, the caching works only
7863 if there are no expansions within the list itself or any sublists that it
7864 references. In other words, caching happens only for lists that are known to be
7865 the same each time they are referenced.
7866
7867 By default, there may be up to 16 named lists of each type. This limit can be
7868 extended by changing a compile-time variable. The use of domain and host lists
7869 is recommended for concepts such as local domains, relay domains, and relay
7870 hosts. The default configuration is set up like this.
7871
7872
7873
7874 .section "Named lists compared with macros" "SECID78"
7875 .cindex "list" "named compared with macro"
7876 .cindex "macro" "compared with named list"
7877 At first sight, named lists might seem to be no different from macros in the
7878 configuration file. However, macros are just textual substitutions. If you
7879 write
7880 .code
7881 ALIST = host1 : host2
7882 auth_advertise_hosts = !ALIST
7883 .endd
7884 it probably won't do what you want, because that is exactly the same as
7885 .code
7886 auth_advertise_hosts = !host1 : host2
7887 .endd
7888 Notice that the second host name is not negated. However, if you use a host
7889 list, and write
7890 .code
7891 hostlist alist = host1 : host2
7892 auth_advertise_hosts = ! +alist
7893 .endd
7894 the negation applies to the whole list, and so that is equivalent to
7895 .code
7896 auth_advertise_hosts = !host1 : !host2
7897 .endd
7898
7899
7900 .section "Named list caching" "SECID79"
7901 .cindex "list" "caching of named"
7902 .cindex "caching" "named lists"
7903 While processing a message, Exim caches the result of checking a named list if
7904 it is sure that the list is the same each time. In practice, this means that
7905 the cache operates only if the list contains no $ characters, which guarantees
7906 that it will not change when it is expanded. Sometimes, however, you may have
7907 an expanded list that you know will be the same each time within a given
7908 message. For example:
7909 .code
7910 domainlist special_domains = \
7911            ${lookup{$sender_host_address}cdb{/some/file}}
7912 .endd
7913 This provides a list of domains that depends only on the sending host's IP
7914 address. If this domain list is referenced a number of times (for example,
7915 in several ACL lines, or in several routers) the result of the check is not
7916 cached by default, because Exim does not know that it is going to be the
7917 same list each time.
7918
7919 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
7920 cache the result anyway. For example:
7921 .code
7922 domainlist_cache special_domains = ${lookup{...
7923 .endd
7924 If you do this, you should be absolutely sure that caching is going to do
7925 the right thing in all cases. When in doubt, leave it out.
7926
7927
7928
7929 .section "Domain lists" "SECTdomainlist"
7930 .cindex "domain list" "patterns for"
7931 .cindex "list" "domain list"
7932 Domain lists contain patterns that are to be matched against a mail domain.
7933 The following types of item may appear in domain lists:
7934
7935 .ilist
7936 .cindex "primary host name"
7937 .cindex "host name" "matched in domain list"
7938 .oindex "&%primary_hostname%&"
7939 .cindex "domain list" "matching primary host name"
7940 .cindex "@ in a domain list"
7941 If a pattern consists of a single @ character, it matches the local host name,
7942 as set by the &%primary_hostname%& option (or defaulted). This makes it
7943 possible to use the same configuration file on several different hosts that
7944 differ only in their names.
7945 .next
7946 .cindex "@[] in a domain list"
7947 .cindex "domain list" "matching local IP interfaces"
7948 .cindex "domain literal"
7949 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
7950 in square brackets (as in an email address that contains a domain literal), but
7951 only if that IP address is recognized as local for email routing purposes. The
7952 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
7953 control which of a host's several IP addresses are treated as local.
7954 In today's Internet, the use of domain literals is controversial.
7955 .next
7956 .cindex "@mx_any"
7957 .cindex "@mx_primary"
7958 .cindex "@mx_secondary"
7959 .cindex "domain list" "matching MX pointers to local host"
7960 If a pattern consists of the string &`@mx_any`& it matches any domain that
7961 has an MX record pointing to the local host or to any host that is listed in
7962 .oindex "&%hosts_treat_as_local%&"
7963 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
7964 are similar, except that the first matches only when a primary MX target is the
7965 local host, and the second only when no primary MX target is the local host,
7966 but a secondary MX target is. &"Primary"& means an MX record with the lowest
7967 preference value &-- there may of course be more than one of them.
7968
7969 The MX lookup that takes place when matching a pattern of this type is
7970 performed with the resolver options for widening names turned off. Thus, for
7971 example, a single-component domain will &'not'& be expanded by adding the
7972 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
7973 options of the &(dnslookup)& router for a discussion of domain widening.
7974
7975 Sometimes you may want to ignore certain IP addresses when using one of these
7976 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
7977 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
7978 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
7979 on a router). For example:
7980 .code
7981 domains = @mx_any/ignore=127.0.0.1
7982 .endd
7983 This example matches any domain that has an MX record pointing to one of
7984 the local host's IP addresses other than 127.0.0.1.
7985
7986 The list of IP addresses is in fact processed by the same code that processes
7987 host lists, so it may contain CIDR-coded network specifications and it may also
7988 contain negative items.
7989
7990 Because the list of IP addresses is a sublist within a domain list, you have to
7991 be careful about delimiters if there is more than one address. Like any other
7992 list, the default delimiter can be changed. Thus, you might have:
7993 .code
7994 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
7995           an.other.domain : ...
7996 .endd
7997 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
7998 involved, it is easiest to change the delimiter for the main list as well:
7999 .code
8000 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8001           an.other.domain ? ...
8002 .endd
8003 .next
8004 .cindex "asterisk" "in domain list"
8005 .cindex "domain list" "asterisk in"
8006 .cindex "domain list" "matching &""ends with""&"
8007 If a pattern starts with an asterisk, the remaining characters of the pattern
8008 are compared with the terminating characters of the domain. The use of &"*"& in
8009 domain lists differs from its use in partial matching lookups. In a domain
8010 list, the character following the asterisk need not be a dot, whereas partial
8011 matching works only in terms of dot-separated components. For example, a domain
8012 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8013 &'cipher.key.ex'&.
8014
8015 .next
8016 .cindex "regular expressions" "in domain list"
8017 .cindex "domain list" "matching regular expression"
8018 If a pattern starts with a circumflex character, it is treated as a regular
8019 expression, and matched against the domain using a regular expression matching
8020 function. The circumflex is treated as part of the regular expression.
8021 Email domains are case-independent, so this regular expression match is by
8022 default case-independent, but you can make it case-dependent by starting it
8023 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8024 are given in chapter &<<CHAPregexp>>&.
8025
8026 &*Warning*&: Because domain lists are expanded before being processed, you
8027 must escape any backslash and dollar characters in the regular expression, or
8028 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8029 it is not to be expanded (unless you really do want to build a regular
8030 expression by expansion, of course).
8031 .next
8032 .cindex "lookup" "in domain list"
8033 .cindex "domain list" "matching by lookup"
8034 If a pattern starts with the name of a single-key lookup type followed by a
8035 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8036 must be a file name in a suitable format for the lookup type. For example, for
8037 &"cdb;"& it must be an absolute path:
8038 .code
8039 domains = cdb;/etc/mail/local_domains.cdb
8040 .endd
8041 The appropriate type of lookup is done on the file using the domain name as the
8042 key. In most cases, the data that is looked up is not used; Exim is interested
8043 only in whether or not the key is present in the file. However, when a lookup
8044 is used for the &%domains%& option on a router
8045 or a &%domains%& condition in an ACL statement, the data is preserved in the
8046 &$domain_data$& variable and can be referred to in other router options or
8047 other statements in the same ACL.
8048
8049 .next
8050 Any of the single-key lookup type names may be preceded by
8051 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8052 .code
8053 domains = partial-dbm;/partial/domains
8054 .endd
8055 This causes partial matching logic to be invoked; a description of how this
8056 works is given in section &<<SECTpartiallookup>>&.
8057
8058 .next
8059 .cindex "asterisk" "in lookup type"
8060 Any of the single-key lookup types may be followed by an asterisk. This causes
8061 a default lookup for a key consisting of a single asterisk to be done if the
8062 original lookup fails. This is not a useful feature when using a domain list to
8063 select particular domains (because any domain would match), but it might have
8064 value if the result of the lookup is being used via the &$domain_data$&
8065 expansion variable.
8066 .next
8067 If the pattern starts with the name of a query-style lookup type followed by a
8068 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8069 pattern must be an appropriate query for the lookup type, as described in
8070 chapter &<<CHAPfdlookup>>&. For example:
8071 .code
8072 hold_domains = mysql;select domain from holdlist \
8073   where domain = '${quote_mysql:$domain}';
8074 .endd
8075 In most cases, the data that is looked up is not used (so for an SQL query, for
8076 example, it doesn't matter what field you select). Exim is interested only in
8077 whether or not the query succeeds. However, when a lookup is used for the
8078 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8079 variable and can be referred to in other options.
8080 .next
8081 .cindex "domain list" "matching literal domain name"
8082 If none of the above cases apply, a caseless textual comparison is made
8083 between the pattern and the domain.
8084 .endlist
8085
8086 Here is an example that uses several different kinds of pattern:
8087 .code
8088 domainlist funny_domains = \
8089   @ : \
8090   lib.unseen.edu : \
8091   *.foundation.fict.example : \
8092   \N^[1-2]\d{3}\.fict\.example$\N : \
8093   partial-dbm;/opt/data/penguin/book : \
8094   nis;domains.byname : \
8095   nisplus;[name=$domain,status=local],domains.org_dir
8096 .endd
8097 There are obvious processing trade-offs among the various matching modes. Using
8098 an asterisk is faster than a regular expression, and listing a few names
8099 explicitly probably is too. The use of a file or database lookup is expensive,
8100 but may be the only option if hundreds of names are required. Because the
8101 patterns are tested in order, it makes sense to put the most commonly matched
8102 patterns earlier.
8103
8104
8105
8106 .section "Host lists" "SECThostlist"
8107 .cindex "host list" "patterns in"
8108 .cindex "list" "host list"
8109 Host lists are used to control what remote hosts are allowed to do. For
8110 example, some hosts may be allowed to use the local host as a relay, and some
8111 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8112 two different ways, by name or by IP address. In a host list, some types of
8113 pattern are matched to a host name, and some are matched to an IP address.
8114 You need to be particularly careful with this when single-key lookups are
8115 involved, to ensure that the right value is being used as the key.
8116
8117
8118 .section "Special host list patterns" "SECID80"
8119 .cindex "empty item in hosts list"
8120 .cindex "host list" "empty string in"
8121 If a host list item is the empty string, it matches only when no remote host is
8122 involved. This is the case when a message is being received from a local
8123 process using SMTP on the standard input, that is, when a TCP/IP connection is
8124 not used.
8125
8126 .cindex "asterisk" "in host list"
8127 The special pattern &"*"& in a host list matches any host or no host. Neither
8128 the IP address nor the name is actually inspected.
8129
8130
8131
8132 .section "Host list patterns that match by IP address" "SECThoslispatip"
8133 .cindex "host list" "matching IP addresses"
8134 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8135 the incoming address actually appears in the IPv6 host as
8136 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8137 list, it is converted into a traditional IPv4 address first. (Not all operating
8138 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8139 concerns.)
8140
8141 The following types of pattern in a host list check the remote host by
8142 inspecting its IP address:
8143
8144 .ilist
8145 If the pattern is a plain domain name (not a regular expression, not starting
8146 with *, not a lookup of any kind), Exim calls the operating system function
8147 to find the associated IP address(es). Exim uses the newer
8148 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8149 This typically causes a forward DNS lookup of the name. The result is compared
8150 with the IP address of the subject host.
8151
8152 If there is a temporary problem (such as a DNS timeout) with the host name
8153 lookup, a temporary error occurs. For example, if the list is being used in an
8154 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8155 temporary SMTP error code. If no IP address can be found for the host name,
8156 what happens is described in section &<<SECTbehipnot>>& below.
8157
8158 .next
8159 .cindex "@ in a host list"
8160 If the pattern is &"@"&, the primary host name is substituted and used as a
8161 domain name, as just described.
8162
8163 .next
8164 If the pattern is an IP address, it is matched against the IP address of the
8165 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8166 IPv6 addresses can be given in colon-separated format, but the colons have to
8167 be doubled so as not to be taken as item separators when the default list
8168 separator is used. IPv6 addresses are recognized even when Exim is compiled
8169 without IPv6 support. This means that if they appear in a host list on an
8170 IPv4-only host, Exim will not treat them as host names. They are just addresses
8171 that can never match a client host.
8172
8173 .next
8174 .cindex "@[] in a host list"
8175 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8176 the local host. For example, if the local host is an IPv4 host with one
8177 interface address 10.45.23.56, these two ACL statements have the same effect:
8178 .code
8179 accept hosts = 127.0.0.1 : 10.45.23.56
8180 accept hosts = @[]
8181 .endd
8182 .next
8183 .cindex "CIDR notation"
8184 If the pattern is an IP address followed by a slash and a mask length (for
8185 example 10.11.42.0/24), it is matched against the IP address of the subject
8186 host under the given mask. This allows, an entire network of hosts to be
8187 included (or excluded) by a single item. The mask uses CIDR notation; it
8188 specifies the number of address bits that must match, starting from the most
8189 significant end of the address.
8190
8191 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8192 of a range of addresses. It is the number of bits in the network portion of the
8193 address. The above example specifies a 24-bit netmask, so it matches all 256
8194 addresses in the 10.11.42.0 network. An item such as
8195 .code
8196 192.168.23.236/31
8197 .endd
8198 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8199 32 for an IPv4 address is the same as no mask at all; just a single address
8200 matches.
8201
8202 Here is another example which shows an IPv4 and an IPv6 network:
8203 .code
8204 recipient_unqualified_hosts = 192.168.0.0/16: \
8205                               3ffe::ffff::836f::::/48
8206 .endd
8207 The doubling of list separator characters applies only when these items
8208 appear inline in a host list. It is not required when indirecting via a file.
8209 For example:
8210 .code
8211 recipient_unqualified_hosts = /opt/exim/unqualnets
8212 .endd
8213 could make use of a file containing
8214 .code
8215 172.16.0.0/12
8216 3ffe:ffff:836f::/48
8217 .endd
8218 to have exactly the same effect as the previous example. When listing IPv6
8219 addresses inline, it is usually more convenient to use the facility for
8220 changing separator characters. This list contains the same two networks:
8221 .code
8222 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8223                                  3ffe:ffff:836f::/48
8224 .endd
8225 The separator is changed to semicolon by the leading &"<;"& at the start of the
8226 list.
8227 .endlist
8228
8229
8230
8231 .section "Host list patterns for single-key lookups by host address" &&&
8232          "SECThoslispatsikey"
8233 .cindex "host list" "lookup of IP address"
8234 When a host is to be identified by a single-key lookup of its complete IP
8235 address, the pattern takes this form:
8236 .display
8237 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8238 .endd
8239 For example:
8240 .code
8241 hosts_lookup = net-cdb;/hosts-by-ip.db
8242 .endd
8243 The text form of the IP address of the subject host is used as the lookup key.
8244 IPv6 addresses are converted to an unabbreviated form, using lower case
8245 letters, with dots as separators because colon is the key terminator in
8246 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8247 quoting the keys, but this is a facility that was added later.] The data
8248 returned by the lookup is not used.
8249
8250 .cindex "IP address" "masking"
8251 .cindex "host list" "masked IP address"
8252 Single-key lookups can also be performed using masked IP addresses, using
8253 patterns of this form:
8254 .display
8255 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8256 .endd
8257 For example:
8258 .code
8259 net24-dbm;/networks.db
8260 .endd
8261 The IP address of the subject host is masked using <&'number'&> as the mask
8262 length. A textual string is constructed from the masked value, followed by the
8263 mask, and this is used as the lookup key. For example, if the host's IP address
8264 is 192.168.34.6, the key that is looked up for the above example is
8265 &"192.168.34.0/24"&.
8266
8267 When an IPv6 address is converted to a string, dots are normally used instead
8268 of colons, so that keys in &(lsearch)& files need not contain colons (which
8269 terminate &(lsearch)& keys). This was implemented some time before the ability
8270 to quote keys was made available in &(lsearch)& files. However, the more
8271 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8272 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8273 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8274 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8275 addresses are always used.
8276
8277 Ideally, it would be nice to tidy up this anomalous situation by changing to
8278 colons in all cases, given that quoting is now available for &(lsearch)&.
8279 However, this would be an incompatible change that might break some existing
8280 configurations.
8281
8282 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8283 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8284 the former case the key strings include the mask value, whereas in the latter
8285 case the IP address is used on its own.
8286
8287
8288
8289 .section "Host list patterns that match by host name" "SECThoslispatnam"
8290 .cindex "host" "lookup failures"
8291 .cindex "unknown host name"
8292 .cindex "host list" "matching host name"
8293 There are several types of pattern that require Exim to know the name of the
8294 remote host. These are either wildcard patterns or lookups by name. (If a
8295 complete hostname is given without any wildcarding, it is used to find an IP
8296 address to match against, as described in section &<<SECThoslispatip>>&
8297 above.)
8298
8299 If the remote host name is not already known when Exim encounters one of these
8300 patterns, it has to be found from the IP address.
8301 Although many sites on the Internet are conscientious about maintaining reverse
8302 DNS data for their hosts, there are also many that do not do this.
8303 Consequently, a name cannot always be found, and this may lead to unwanted
8304 effects. Take care when configuring host lists with wildcarded name patterns.
8305 Consider what will happen if a name cannot be found.
8306
8307 Because of the problems of determining host names from IP addresses, matching
8308 against host names is not as common as matching against IP addresses.
8309
8310 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8311 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8312 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8313 are done can be changed by setting the &%host_lookup_order%& option. For
8314 security, once Exim has found one or more names, it looks up the IP addresses
8315 for these names and compares them with the IP address that it started with.
8316 Only those names whose IP addresses match are accepted. Any other names are
8317 discarded. If no names are left, Exim behaves as if the host name cannot be
8318 found. In the most common case there is only one name and one IP address.
8319
8320 There are some options that control what happens if a host name cannot be
8321 found. These are described in section &<<SECTbehipnot>>& below.
8322
8323 .cindex "host" "alias for"
8324 .cindex "alias for host"
8325 As a result of aliasing, hosts may have more than one name. When processing any
8326 of the following types of pattern, all the host's names are checked:
8327
8328 .ilist
8329 .cindex "asterisk" "in host list"
8330 If a pattern starts with &"*"& the remainder of the item must match the end of
8331 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8332 &'.b.c'&. This special simple form is provided because this is a very common
8333 requirement. Other kinds of wildcarding require the use of a regular
8334 expression.
8335 .next
8336 .cindex "regular expressions" "in host list"
8337 .cindex "host list" "regular expression in"
8338 If the item starts with &"^"& it is taken to be a regular expression which is
8339 matched against the host name. Host names are case-independent, so this regular
8340 expression match is by default case-independent, but you can make it
8341 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8342 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8343 example,
8344 .code
8345 ^(a|b)\.c\.d$
8346 .endd
8347 is a regular expression that matches either of the two hosts &'a.c.d'& or
8348 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8349 that backslash and dollar characters are not misinterpreted as part of the
8350 string expansion. The simplest way to do this is to use &`\N`& to mark that
8351 part of the string as non-expandable. For example:
8352 .code
8353 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8354 .endd
8355 &*Warning*&: If you want to match a complete host name, you must include the
8356 &`$`& terminating metacharacter in the regular expression, as in the above
8357 example. Without it, a match at the start of the host name is all that is
8358 required.
8359 .endlist
8360
8361
8362
8363
8364 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8365 .cindex "host" "lookup failures, permanent"
8366 While processing a host list, Exim may need to look up an IP address from a
8367 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8368 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8369 behaviour when it fails to find the information it is seeking is the same.
8370
8371 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8372 apply to temporary DNS errors, whose handling is described in the next section.
8373
8374 .cindex "&`+include_unknown`&"
8375 .cindex "&`+ignore_unknown`&"
8376 Exim parses a host list from left to right. If it encounters a permanent
8377 lookup failure in any item in the host list before it has found a match,
8378 Exim treats it as a failure and the default behavior is as if the host
8379 does not match the list. This may not always be what you want to happen.
8380 To change Exim's behaviour, the special items &`+include_unknown`& or
8381 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8382 not recognized in an indirected file).
8383
8384 .ilist
8385 If any item that follows &`+include_unknown`& requires information that
8386 cannot found, Exim behaves as if the host does match the list. For example,
8387 .code
8388 host_reject_connection = +include_unknown:*.enemy.ex
8389 .endd
8390 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8391 any hosts whose name it cannot find.
8392
8393 .next
8394 If any item that follows &`+ignore_unknown`& requires information that cannot
8395 be found, Exim ignores that item and proceeds to the rest of the list. For
8396 example:
8397 .code
8398 accept hosts = +ignore_unknown : friend.example : \
8399                192.168.4.5
8400 .endd
8401 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8402 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8403 name can be found for 192.168.4.5, it is rejected.
8404 .endlist
8405
8406 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8407 list. The effect of each one lasts until the next, or until the end of the
8408 list.
8409
8410 .section "Mixing wildcarded host names and addresses in host lists" &&&
8411          "SECTmixwilhos"
8412 .cindex "host list" "mixing names and addresses in"
8413
8414 This section explains the host/ip processing logic with the same concepts
8415 as the previous section, but specifically addresses what happens when a
8416 wildcarded hostname is one of the items in the hostlist.
8417
8418 .ilist
8419 If you have name lookups or wildcarded host names and
8420 IP addresses in the same host list, you should normally put the IP
8421 addresses first. For example, in an ACL you could have:
8422 .code
8423 accept hosts = 10.9.8.7 : *.friend.example
8424 .endd
8425 The reason you normally would order it this way lies in the
8426 left-to-right way that Exim processes lists.  It can test IP addresses
8427 without doing any DNS lookups, but when it reaches an item that requires
8428 a host name, it fails if it cannot find a host name to compare with the
8429 pattern. If the above list is given in the opposite order, the
8430 &%accept%& statement fails for a host whose name cannot be found, even
8431 if its IP address is 10.9.8.7.
8432
8433 .next
8434 If you really do want to do the name check first, and still recognize the IP
8435 address, you can rewrite the ACL like this:
8436 .code
8437 accept hosts = *.friend.example
8438 accept hosts = 10.9.8.7
8439 .endd
8440 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8441 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8442 &`+ignore_unknown`&, which was discussed in depth in the first example in
8443 this section.
8444 .endlist
8445
8446
8447 .section "Temporary DNS errors when looking up host information" &&&
8448          "SECTtemdnserr"
8449 .cindex "host" "lookup failures, temporary"
8450 .cindex "&`+include_defer`&"
8451 .cindex "&`+ignore_defer`&"
8452 A temporary DNS lookup failure normally causes a defer action (except when
8453 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8454 host lists can include &`+ignore_defer`& and &`+include_defer`&, analagous to
8455 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8456 section. These options should be used with care, probably only in non-critical
8457 host lists such as whitelists.
8458
8459
8460
8461 .section "Host list patterns for single-key lookups by host name" &&&
8462          "SECThoslispatnamsk"
8463 .cindex "unknown host name"
8464 .cindex "host list" "matching host name"
8465 If a pattern is of the form
8466 .display
8467 <&'single-key-search-type'&>;<&'search-data'&>
8468 .endd
8469 for example
8470 .code
8471 dbm;/host/accept/list
8472 .endd
8473 a single-key lookup is performed, using the host name as its key. If the
8474 lookup succeeds, the host matches the item. The actual data that is looked up
8475 is not used.
8476
8477 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8478 keys in the file, not IP addresses. If you want to do lookups based on IP
8479 addresses, you must precede the search type with &"net-"& (see section
8480 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8481 two items in the same list, one doing an address lookup and one doing a name
8482 lookup, both using the same file.
8483
8484
8485
8486 .section "Host list patterns for query-style lookups" "SECID81"
8487 If a pattern is of the form
8488 .display
8489 <&'query-style-search-type'&>;<&'query'&>
8490 .endd
8491 the query is obeyed, and if it succeeds, the host matches the item. The actual
8492 data that is looked up is not used. The variables &$sender_host_address$& and
8493 &$sender_host_name$& can be used in the query. For example:
8494 .code
8495 hosts_lookup = pgsql;\
8496   select ip from hostlist where ip='$sender_host_address'
8497 .endd
8498 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8499 can use the &%sg%& expansion item to change this if you need to. If you want to
8500 use masked IP addresses in database queries, you can use the &%mask%& expansion
8501 operator.
8502
8503 If the query contains a reference to &$sender_host_name$&, Exim automatically
8504 looks up the host name if it has not already done so. (See section
8505 &<<SECThoslispatnam>>& for comments on finding host names.)
8506
8507 Historical note: prior to release 4.30, Exim would always attempt to find a
8508 host name before running the query, unless the search type was preceded by
8509 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8510 still recognized for query-style lookups, but its presence or absence has no
8511 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8512 See section &<<SECThoslispatsikey>>&.)
8513
8514
8515
8516
8517
8518 .section "Address lists" "SECTaddresslist"
8519 .cindex "list" "address list"
8520 .cindex "address list" "empty item"
8521 .cindex "address list" "patterns"
8522 Address lists contain patterns that are matched against mail addresses. There
8523 is one special case to be considered: the sender address of a bounce message is
8524 always empty. You can test for this by providing an empty item in an address
8525 list. For example, you can set up a router to process bounce messages by
8526 using this option setting:
8527 .code
8528 senders = :
8529 .endd
8530 The presence of the colon creates an empty item. If you do not provide any
8531 data, the list is empty and matches nothing. The empty sender can also be
8532 detected by a regular expression that matches an empty string,
8533 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8534
8535 Non-empty items in an address list can be straightforward email addresses. For
8536 example:
8537 .code
8538 senders = jbc@askone.example : hs@anacreon.example
8539 .endd
8540 A certain amount of wildcarding is permitted. If a pattern contains an @
8541 character, but is not a regular expression and does not begin with a
8542 semicolon-terminated lookup type (described below), the local part of the
8543 subject address is compared with the local part of the pattern, which may start
8544 with an asterisk. If the local parts match, the domain is checked in exactly
8545 the same way as for a pattern in a domain list. For example, the domain can be
8546 wildcarded, refer to a named list, or be a lookup:
8547 .code
8548 deny senders = *@*.spamming.site:\
8549                *@+hostile_domains:\
8550                bozo@partial-lsearch;/list/of/dodgy/sites:\
8551                *@dbm;/bad/domains.db
8552 .endd
8553 .cindex "local part" "starting with !"
8554 .cindex "address list" "local part starting with !"
8555 If a local part that begins with an exclamation mark is required, it has to be
8556 specified using a regular expression, because otherwise the exclamation mark is
8557 treated as a sign of negation, as is standard in lists.
8558
8559 If a non-empty pattern that is not a regular expression or a lookup does not
8560 contain an @ character, it is matched against the domain part of the subject
8561 address. The only two formats that are recognized this way are a literal
8562 domain, or a domain pattern that starts with *. In both these cases, the effect
8563 is the same as if &`*@`& preceded the pattern. For example:
8564 .code
8565 deny senders = enemy.domain : *.enemy.domain
8566 .endd
8567
8568 The following kinds of more complicated address list pattern can match any
8569 address, including the empty address that is characteristic of bounce message
8570 senders:
8571
8572 .ilist
8573 .cindex "regular expressions" "in address list"
8574 .cindex "address list" "regular expression in"
8575 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8576 done against the complete address, with the pattern as the regular expression.
8577 You must take care that backslash and dollar characters are not misinterpreted
8578 as part of the string expansion. The simplest way to do this is to use &`\N`&
8579 to mark that part of the string as non-expandable. For example:
8580 .code
8581 deny senders = \N^.*this.*@example\.com$\N : \
8582                \N^\d{8}.+@spamhaus.example$\N : ...
8583 .endd
8584 The &`\N`& sequences are removed by the expansion, so these items do indeed
8585 start with &"^"& by the time they are being interpreted as address patterns.
8586
8587 .next
8588 .cindex "address list" "lookup for complete address"
8589 Complete addresses can be looked up by using a pattern that starts with a
8590 lookup type terminated by a semicolon, followed by the data for the lookup. For
8591 example:
8592 .code
8593 deny senders = cdb;/etc/blocked.senders : \
8594   mysql;select address from blocked where \
8595   address='${quote_mysql:$sender_address}'
8596 .endd
8597 Both query-style and single-key lookup types can be used. For a single-key
8598 lookup type, Exim uses the complete address as the key. However, empty keys are
8599 not supported for single-key lookups, so a match against the empty address
8600 always fails. This restriction does not apply to query-style lookups.
8601
8602 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8603 cannot be used, and is ignored if specified, with an entry being written to the
8604 panic log.
8605 .cindex "*@ with single-key lookup"
8606 However, you can configure lookup defaults, as described in section
8607 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8608 default. For example, with this lookup:
8609 .code
8610 accept senders = lsearch*@;/some/file
8611 .endd
8612 the file could contains lines like this:
8613 .code
8614 user1@domain1.example
8615 *@domain2.example
8616 .endd
8617 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8618 that are tried is:
8619 .code
8620 nimrod@jaeger.example
8621 *@jaeger.example
8622 *
8623 .endd
8624 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8625 would mean that every address matches, thus rendering the test useless.
8626
8627 &*Warning 2*&: Do not confuse these two kinds of item:
8628 .code
8629 deny recipients = dbm*@;/some/file
8630 deny recipients = *@dbm;/some/file
8631 .endd
8632 The first does a whole address lookup, with defaulting, as just described,
8633 because it starts with a lookup type. The second matches the local part and
8634 domain independently, as described in a bullet point below.
8635 .endlist
8636
8637
8638 The following kinds of address list pattern can match only non-empty addresses.
8639 If the subject address is empty, a match against any of these pattern types
8640 always fails.
8641
8642
8643 .ilist
8644 .cindex "@@ with single-key lookup"
8645 .cindex "address list" "@@ lookup type"
8646 .cindex "address list" "split local part and domain"
8647 If a pattern starts with &"@@"& followed by a single-key lookup item
8648 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8649 split into a local part and a domain. The domain is looked up in the file. If
8650 it is not found, there is no match. If it is found, the data that is looked up
8651 from the file is treated as a colon-separated list of local part patterns, each
8652 of which is matched against the subject local part in turn.
8653
8654 .cindex "asterisk" "in address list"
8655 The lookup may be a partial one, and/or one involving a search for a default
8656 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8657 patterns that are looked up can be regular expressions or begin with &"*"&, or
8658 even be further lookups. They may also be independently negated. For example,
8659 with
8660 .code
8661 deny senders = @@dbm;/etc/reject-by-domain
8662 .endd
8663 the data from which the DBM file is built could contain lines like
8664 .code
8665 baddomain.com:  !postmaster : *
8666 .endd
8667 to reject all senders except &%postmaster%& from that domain.
8668
8669 .cindex "local part" "starting with !"
8670 If a local part that actually begins with an exclamation mark is required, it
8671 has to be specified using a regular expression. In &(lsearch)& files, an entry
8672 may be split over several lines by indenting the second and subsequent lines,
8673 but the separating colon must still be included at line breaks. White space
8674 surrounding the colons is ignored. For example:
8675 .code
8676 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8677   spammer3 : spammer4
8678 .endd
8679 As in all colon-separated lists in Exim, a colon can be included in an item by
8680 doubling.
8681
8682 If the last item in the list starts with a right angle-bracket, the remainder
8683 of the item is taken as a new key to look up in order to obtain a continuation
8684 list of local parts. The new key can be any sequence of characters. Thus one
8685 might have entries like
8686 .code
8687 aol.com: spammer1 : spammer 2 : >*
8688 xyz.com: spammer3 : >*
8689 *:       ^\d{8}$
8690 .endd
8691 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8692 local parts for all domains, in addition to the specific local parts listed for
8693 each domain. Of course, using this feature costs another lookup each time a
8694 chain is followed, but the effort needed to maintain the data is reduced.
8695
8696 .cindex "loop" "in lookups"
8697 It is possible to construct loops using this facility, and in order to catch
8698 them, the chains may be no more than fifty items long.
8699
8700 .next
8701 The @@<&'lookup'&> style of item can also be used with a query-style
8702 lookup, but in this case, the chaining facility is not available. The lookup
8703 can only return a single list of local parts.
8704 .endlist
8705
8706 &*Warning*&: There is an important difference between the address list items
8707 in these two examples:
8708 .code
8709 senders = +my_list
8710 senders = *@+my_list
8711 .endd
8712 In the first one, &`my_list`& is a named address list, whereas in the second
8713 example it is a named domain list.
8714
8715
8716
8717
8718 .section "Case of letters in address lists" "SECTcasletadd"
8719 .cindex "case of local parts"
8720 .cindex "address list" "case forcing"
8721 .cindex "case forcing in address lists"
8722 Domains in email addresses are always handled caselessly, but for local parts
8723 case may be significant on some systems (see &%caseful_local_part%& for how
8724 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8725 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8726 blocking lists should be done in a case-independent manner. Since most address
8727 lists in Exim are used for this kind of control, Exim attempts to do this by
8728 default.
8729
8730 The domain portion of an address is always lowercased before matching it to an
8731 address list. The local part is lowercased by default, and any string
8732 comparisons that take place are done caselessly. This means that the data in
8733 the address list itself, in files included as plain file names, and in any file
8734 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8735 keys in files that are looked up by a search type other than &(lsearch)& (which
8736 works caselessly) must be in lower case, because these lookups are not
8737 case-independent.
8738
8739 .cindex "&`+caseful`&"
8740 To allow for the possibility of caseful address list matching, if an item in
8741 an address list is the string &"+caseful"&, the original case of the local
8742 part is restored for any comparisons that follow, and string comparisons are no
8743 longer case-independent. This does not affect the domain, which remains in
8744 lower case. However, although independent matches on the domain alone are still
8745 performed caselessly, regular expressions that match against an entire address
8746 become case-sensitive after &"+caseful"& has been seen.
8747
8748
8749
8750 .section "Local part lists" "SECTlocparlis"
8751 .cindex "list" "local part list"
8752 .cindex "local part" "list"
8753 Case-sensitivity in local part lists is handled in the same way as for address
8754 lists, as just described. The &"+caseful"& item can be used if required. In a
8755 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8756 set false, the subject is lowercased and the matching is initially
8757 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8758 matching in the local part list, but not elsewhere in the router. If
8759 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8760 option is case-sensitive from the start.
8761
8762 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8763 comments are handled in the same way as address lists &-- they are recognized
8764 only if the # is preceded by white space or the start of the line.
8765 Otherwise, local part lists are matched in the same way as domain lists, except
8766 that the special items that refer to the local host (&`@`&, &`@[]`&,
8767 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8768 Refer to section &<<SECTdomainlist>>& for details of the other available item
8769 types.
8770 .ecindex IIDdohoadli
8771
8772
8773
8774
8775 . ////////////////////////////////////////////////////////////////////////////
8776 . ////////////////////////////////////////////////////////////////////////////
8777
8778 .chapter "String expansions" "CHAPexpand"
8779 .scindex IIDstrexp "expansion" "of strings"
8780 Many strings in Exim's run time configuration are expanded before use. Some of
8781 them are expanded every time they are used; others are expanded only once.
8782
8783 When a string is being expanded it is copied verbatim from left to right except
8784 when a dollar or backslash character is encountered. A dollar specifies the
8785 start of a portion of the string that is interpreted and replaced as described
8786 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8787 escape character, as described in the following section.
8788
8789 Whether a string is expanded depends upon the context.  Usually this is solely
8790 dependent upon the option for which a value is sought; in this documentation,
8791 options for which string expansion is performed are marked with &dagger; after
8792 the data type.  ACL rules always expand strings.  A couple of expansion
8793 conditions do not expand some of the brace-delimited branches, for security
8794 reasons.
8795
8796
8797
8798 .section "Literal text in expanded strings" "SECTlittext"
8799 .cindex "expansion" "including literal text"
8800 An uninterpreted dollar can be included in an expanded string by putting a
8801 backslash in front of it. A backslash can be used to prevent any special
8802 character being treated specially in an expansion, including backslash itself.
8803 If the string appears in quotes in the configuration file, two backslashes are
8804 required because the quotes themselves cause interpretation of backslashes when
8805 the string is read in (see section &<<SECTstrings>>&).
8806
8807 .cindex "expansion" "non-expandable substrings"
8808 A portion of the string can specified as non-expandable by placing it between
8809 two occurrences of &`\N`&. This is particularly useful for protecting regular
8810 expressions, which often contain backslashes and dollar signs. For example:
8811 .code
8812 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8813 .endd
8814 On encountering the first &`\N`&, the expander copies subsequent characters
8815 without interpretation until it reaches the next &`\N`& or the end of the
8816 string.
8817
8818
8819
8820 .section "Character escape sequences in expanded strings" "SECID82"
8821 .cindex "expansion" "escape sequences"
8822 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
8823 expanded string is recognized as an escape sequence for the character newline,
8824 carriage return, or tab, respectively. A backslash followed by up to three
8825 octal digits is recognized as an octal encoding for a single character, and a
8826 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
8827 encoding.
8828
8829 These escape sequences are also recognized in quoted strings when they are read
8830 in. Their interpretation in expansions as well is useful for unquoted strings,
8831 and for other cases such as looked-up strings that are then expanded.
8832
8833
8834 .section "Testing string expansions" "SECID83"
8835 .cindex "expansion" "testing"
8836 .cindex "testing" "string expansion"
8837 .oindex "&%-be%&"
8838 Many expansions can be tested by calling Exim with the &%-be%& option. This
8839 takes the command arguments, or lines from the standard input if there are no
8840 arguments, runs them through the string expansion code, and writes the results
8841 to the standard output. Variables based on configuration values are set up, but
8842 since no message is being processed, variables such as &$local_part$& have no
8843 value. Nevertheless the &%-be%& option can be useful for checking out file and
8844 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
8845 and &%nhash%&.
8846
8847 Exim gives up its root privilege when it is called with the &%-be%& option, and
8848 instead runs under the uid and gid it was called with, to prevent users from
8849 using &%-be%& for reading files to which they do not have access.
8850
8851 .oindex "&%-bem%&"
8852 If you want to test expansions that include variables whose values are taken
8853 from a message, there are two other options that can be used. The &%-bem%&
8854 option is like &%-be%& except that it is followed by a file name. The file is
8855 read as a message before doing the test expansions. For example:
8856 .code
8857 exim -bem /tmp/test.message '$h_subject:'
8858 .endd
8859 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
8860 Exim message identifier. For example:
8861 .code
8862 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
8863 .endd
8864 This loads the message from Exim's spool before doing the test expansions, and
8865 is therefore restricted to admin users.
8866
8867
8868 .section "Forced expansion failure" "SECTforexpfai"
8869 .cindex "expansion" "forced failure"
8870 A number of expansions that are described in the following section have
8871 alternative &"true"& and &"false"& substrings, enclosed in brace characters
8872 (which are sometimes called &"curly brackets"&). Which of the two strings is
8873 used depends on some condition that is evaluated as part of the expansion. If,
8874 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
8875 the entire string expansion fails in a way that can be detected by the code
8876 that requested the expansion. This is called &"forced expansion failure"&, and
8877 its consequences depend on the circumstances. In some cases it is no different
8878 from any other expansion failure, but in others a different action may be
8879 taken. Such variations are mentioned in the documentation of the option that is
8880 being expanded.
8881
8882
8883
8884
8885 .section "Expansion items" "SECTexpansionitems"
8886 The following items are recognized in expanded strings. White space may be used
8887 between sub-items that are keywords or substrings enclosed in braces inside an
8888 outer set of braces, to improve readability. &*Warning*&: Within braces,
8889 white space is significant.
8890
8891 .vlist
8892 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
8893 .cindex "expansion" "variables"
8894 Substitute the contents of the named variable, for example:
8895 .code
8896 $local_part
8897 ${domain}
8898 .endd
8899 The second form can be used to separate the name from subsequent alphanumeric
8900 characters. This form (using braces) is available only for variables; it does
8901 &'not'& apply to message headers. The names of the variables are given in
8902 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
8903 given, the expansion fails.
8904
8905 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
8906 .cindex "expansion" "operators"
8907 The string is first itself expanded, and then the operation specified by
8908 <&'op'&> is applied to it. For example:
8909 .code
8910 ${lc:$local_part}
8911 .endd
8912 The string starts with the first character after the colon, which may be
8913 leading white space. A list of operators is given in section &<<SECTexpop>>&
8914 below. The operator notation is used for simple expansion items that have just
8915 one argument, because it reduces the number of braces and therefore makes the
8916 string easier to understand.
8917
8918 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
8919 This item inserts &"basic"& header lines. It is described with the &%header%&
8920 expansion item below.
8921
8922
8923 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
8924 .cindex "expansion" "calling an acl"
8925 .cindex "&%acl%&" "call from expansion"
8926 The name and zero to nine argument strings are first expanded separately.  The expanded
8927 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
8928 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
8929 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
8930 and may use the variables; if another acl expansion is used the values
8931 are restored after it returns.  If the ACL sets
8932 a value using a "message =" modifier and returns accept or deny, the value becomes
8933 the result of the expansion.
8934 If no message is set and the ACL returns accept or deny
8935 the expansion result is an empty string.
8936 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
8937
8938
8939 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
8940        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
8941 .cindex "expansion" "extracting cerificate fields"
8942 .cindex "&%certextract%&" "certificate fields"
8943 .cindex "certificate" "extracting fields"
8944 The <&'certificate'&> must be a variable of type certificate.
8945 The field name is expanded and used to retrive the relevant field from
8946 the certificate.  Supported fields are:
8947 .display
8948 &`version        `&
8949 &`serial_number  `&
8950 &`subject        `& RFC4514 DN
8951 &`issuer         `& RFC4514 DN
8952 &`notbefore      `& time
8953 &`notafter       `& time
8954 &`sig_algorithm  `&
8955 &`signature      `&
8956 &`subj_altname   `& tagged list
8957 &`ocsp_uri       `& list
8958 &`crl_uri        `& list
8959 .endd
8960 If the field is found,
8961 <&'string2'&> is expanded, and replaces the whole item;
8962 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
8963 variable &$value$& contains the value that has been extracted. Afterwards, it
8964 is restored to any previous value it might have had.
8965
8966 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
8967 key is not found. If {<&'string2'&>} is also omitted, the value that was
8968 extracted is used.
8969
8970 Some field names take optional modifiers, appended and separated by commas.
8971
8972 The field selectors marked as "RFC4514" above
8973 output a Distinguished Name string which is
8974 not quite
8975 parseable by Exim as a comma-separated tagged list
8976 (the exceptions being elements containing commas).
8977 RDN elements of a single type may be selected by
8978 a modifier of the type label; if so the expansion
8979 result is a list (newline-separated by default).
8980 The separator may be changed by another modifer of
8981 a right angle-bracket followed immediately by the new separator.
8982 Recognised RDN type labels include "CN", "O", "OU" and "DC".
8983
8984 The field selectors marked as "time" above
8985 take an optional modifier of "int"
8986 for which the result is the number of seconds since epoch.
8987 Otherwise the result is a human-readable string
8988 in the timezone selected by the main "timezone" option.
8989
8990 The field selectors marked as "list" above return a list,
8991 newline-separated by default,
8992 (embedded separator characters in elements are doubled).
8993 The separator may be changed by a modifier of
8994 a right angle-bracket followed immediately by the new separator.
8995
8996 The field selectors marked as "tagged" above
8997 prefix each list element with a type string and an equals sign.
8998 Elements of only one type may be selected by a modifier
8999 which is one of "dns", "uri" or "mail";
9000 if so the elenment tags are omitted.
9001
9002 If not otherwise noted field values are presented in human-readable form.
9003
9004 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9005        {*&<&'arg'&>&*}...}*&"
9006 .cindex &%dlfunc%&
9007 This expansion dynamically loads and then calls a locally-written C function.
9008 This functionality is available only if Exim is compiled with
9009 .code
9010 EXPAND_DLFUNC=yes
9011 .endd
9012 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9013 object so that it doesn't reload the same object file in the same Exim process
9014 (but of course Exim does start new processes frequently).
9015
9016 There may be from zero to eight arguments to the function. When compiling
9017 a local function that is to be called in this way, &_local_scan.h_& should be
9018 included. The Exim variables and functions that are defined by that API
9019 are also available for dynamically loaded functions. The function itself
9020 must have the following type:
9021 .code
9022 int dlfunction(uschar **yield, int argc, uschar *argv[])
9023 .endd
9024 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9025 function should return one of the following values:
9026
9027 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9028 into the expanded string that is being built.
9029
9030 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9031 from &'yield'&, if it is set.
9032
9033 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9034 taken from &'yield'& if it is set.
9035
9036 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9037
9038 When compiling a function that is to be used in this way with gcc,
9039 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9040 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9041
9042
9043 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9044 .cindex "expansion" "extracting value from environment"
9045 .cindex "environment" "value from"
9046 The key is first expanded separately, and leading and trailing white space
9047 removed.
9048 This is then searched for as a name in the environment.
9049 If a variable is found then its value is placed in &$value$&
9050 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9051
9052 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9053 appear, for example:
9054 .code
9055 ${env{USER}{$value} fail }
9056 .endd
9057 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9058 {<&'string1'&>} must be present for &"fail"& to be recognized.
9059
9060 If {<&'string2'&>} is omitted an empty string is substituted on 
9061 search failure.
9062 If {<&'string1'&>} is omitted the search result is substituted on
9063 search success.
9064
9065
9066 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9067        {*&<&'string3'&>&*}}*&"
9068 .cindex "expansion" "extracting substrings by key"
9069 .cindex "&%extract%&" "substrings by key"
9070 The key and <&'string1'&> are first expanded separately. Leading and trailing
9071 white space is removed from the key (but not from any of the strings). The key
9072 must not consist entirely of digits. The expanded <&'string1'&> must be of the
9073 form:
9074 .display
9075 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9076 .endd
9077 .vindex "&$value$&"
9078 where the equals signs and spaces (but not both) are optional. If any of the
9079 values contain white space, they must be enclosed in double quotes, and any
9080 values that are enclosed in double quotes are subject to escape processing as
9081 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9082 for the value that corresponds to the key. The search is case-insensitive. If
9083 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9084 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9085 variable &$value$& contains the value that has been extracted. Afterwards, it
9086 is restored to any previous value it might have had.
9087
9088 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9089 key is not found. If {<&'string2'&>} is also omitted, the value that was
9090 extracted is used. Thus, for example, these two expansions are identical, and
9091 yield &"2001"&:
9092 .code
9093 ${extract{gid}{uid=1984 gid=2001}}
9094 ${extract{gid}{uid=1984 gid=2001}{$value}}
9095 .endd
9096 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9097 appear, for example:
9098 .code
9099 ${extract{Z}{A=... B=...}{$value} fail }
9100 .endd
9101 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9102 {<&'string2'&>} must be present for &"fail"& to be recognized.
9103
9104
9105 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9106         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9107 .cindex "expansion" "extracting substrings by number"
9108 .cindex "&%extract%&" "substrings by number"
9109 The <&'number'&> argument must consist entirely of decimal digits,
9110 apart from leading and trailing white space, which is ignored.
9111 This is what distinguishes this form of &%extract%& from the previous kind. It
9112 behaves in the same way, except that, instead of extracting a named field, it
9113 extracts from <&'string1'&> the field whose number is given as the first
9114 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9115 <&'string3'&> as before.
9116
9117 The fields in the string are separated by any one of the characters in the
9118 separator string. These may include space or tab characters.
9119 The first field is numbered one. If the number is negative, the fields are
9120 counted from the end of the string, with the rightmost one numbered -1. If the
9121 number given is zero, the entire string is returned. If the modulus of the
9122 number is greater than the number of fields in the string, the result is the
9123 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9124 provided. For example:
9125 .code
9126 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9127 .endd
9128 yields &"42"&, and
9129 .code
9130 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9131 .endd
9132 yields &"99"&. Two successive separators mean that the field between them is
9133 empty (for example, the fifth field above).
9134
9135
9136 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9137 .cindex "list" "selecting by condition"
9138 .cindex "expansion" "selecting from list by condition"
9139 .vindex "&$item$&"
9140 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9141 default, but the separator can be changed in the usual way. For each item
9142 in this list, its value is place in &$item$&, and then the condition is
9143 evaluated. If the condition is true, &$item$& is added to the output as an
9144 item in a new list; if the condition is false, the item is discarded. The
9145 separator used for the output list is the same as the one used for the
9146 input, but a separator setting is not included in the output. For example:
9147 .code
9148 ${filter{a:b:c}{!eq{$item}{b}}
9149 .endd
9150 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9151 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9152
9153
9154 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9155 .cindex "hash function" "textual"
9156 .cindex "expansion" "textual hash"
9157 This is a textual hashing function, and was the first to be implemented in
9158 early versions of Exim. In current releases, there are other hashing functions
9159 (numeric, MD5, and SHA-1), which are described below.
9160
9161 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9162 <&'n'&>. If you are using fixed values for these numbers, that is, if
9163 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9164 use the simpler operator notation that avoids some of the braces:
9165 .code
9166 ${hash_<n>_<m>:<string>}
9167 .endd
9168 The second number is optional (in both notations). If <&'n'&> is greater than
9169 or equal to the length of the string, the expansion item returns the string.
9170 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9171 function to the string. The new string consists of characters taken from the
9172 first <&'m'&> characters of the string
9173 .code
9174 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9175 .endd
9176 If <&'m'&> is not present the value 26 is used, so that only lower case
9177 letters appear. For example:
9178 .display
9179 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9180 &`$hash{5}{monty}}           `&   yields  &`monty`&
9181 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9182 .endd
9183
9184 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9185         &*$h_*&<&'header&~name'&>&*:*&" &&&
9186        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9187         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9188        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9189         &*$rh_*&<&'header&~name'&>&*:*&"
9190 .cindex "expansion" "header insertion"
9191 .vindex "&$header_$&"
9192 .vindex "&$bheader_$&"
9193 .vindex "&$rheader_$&"
9194 .cindex "header lines" "in expansion strings"
9195 .cindex "header lines" "character sets"
9196 .cindex "header lines" "decoding"
9197 Substitute the contents of the named message header line, for example
9198 .code
9199 $header_reply-to:
9200 .endd
9201 The newline that terminates a header line is not included in the expansion, but
9202 internal newlines (caused by splitting the header line over several physical
9203 lines) may be present.
9204
9205 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9206 the data in the header line is interpreted.
9207
9208 .ilist
9209 .cindex "white space" "in header lines"
9210 &%rheader%& gives the original &"raw"& content of the header line, with no
9211 processing at all, and without the removal of leading and trailing white space.
9212
9213 .next
9214 .cindex "base64 encoding" "in header lines"
9215 &%bheader%& removes leading and trailing white space, and then decodes base64
9216 or quoted-printable MIME &"words"& within the header text, but does no
9217 character set translation. If decoding of what looks superficially like a MIME
9218 &"word"& fails, the raw string is returned. If decoding
9219 .cindex "binary zero" "in header line"
9220 produces a binary zero character, it is replaced by a question mark &-- this is
9221 what Exim does for binary zeros that are actually received in header lines.
9222
9223 .next
9224 &%header%& tries to translate the string as decoded by &%bheader%& to a
9225 standard character set. This is an attempt to produce the same string as would
9226 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9227 returned. Translation is attempted only on operating systems that support the
9228 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9229 a system Makefile or in &_Local/Makefile_&.
9230 .endlist ilist
9231
9232 In a filter file, the target character set for &%header%& can be specified by a
9233 command of the following form:
9234 .code
9235 headers charset "UTF-8"
9236 .endd
9237 This command affects all references to &$h_$& (or &$header_$&) expansions in
9238 subsequently obeyed filter commands. In the absence of this command, the target
9239 character set in a filter is taken from the setting of the &%headers_charset%&
9240 option in the runtime configuration. The value of this option defaults to the
9241 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9242 ISO-8859-1.
9243
9244 Header names follow the syntax of RFC 2822, which states that they may contain
9245 any printing characters except space and colon. Consequently, curly brackets
9246 &'do not'& terminate header names, and should not be used to enclose them as
9247 if they were variables. Attempting to do so causes a syntax error.
9248
9249 Only header lines that are common to all copies of a message are visible to
9250 this mechanism. These are the original header lines that are received with the
9251 message, and any that are added by an ACL statement or by a system
9252 filter. Header lines that are added to a particular copy of a message by a
9253 router or transport are not accessible.
9254
9255 For incoming SMTP messages, no header lines are visible in ACLs that are obeyed
9256 before the DATA ACL, because the header structure is not set up until the
9257 message is received. Header lines that are added in a RCPT ACL (for example)
9258 are saved until the message's incoming header lines are available, at which
9259 point they are added. When a DATA ACL is running, however, header lines added
9260 by earlier ACLs are visible.
9261
9262 Upper case and lower case letters are synonymous in header names. If the
9263 following character is white space, the terminating colon may be omitted, but
9264 this is not recommended, because you may then forget it when it is needed. When
9265 white space terminates the header name, it is included in the expanded string.
9266 If the message does not contain the given header, the expansion item is
9267 replaced by an empty string. (See the &%def%& condition in section
9268 &<<SECTexpcond>>& for a means of testing for the existence of a header.)
9269
9270 If there is more than one header with the same name, they are all concatenated
9271 to form the substitution string, up to a maximum length of 64K. Unless
9272 &%rheader%& is being used, leading and trailing white space is removed from
9273 each header before concatenation, and a completely empty header is ignored. A
9274 newline character is then inserted between non-empty headers, but there is no
9275 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9276 those headers that contain lists of addresses, a comma is also inserted at the
9277 junctions between headers. This does not happen for the &%rheader%& expansion.
9278
9279
9280 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9281 .cindex "expansion" "hmac hashing"
9282 .cindex &%hmac%&
9283 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9284 shared secret and some text into a message authentication code, as specified in
9285 RFC 2104. This differs from &`${md5:secret_text...}`& or
9286 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9287 cryptographic hash, allowing for authentication that is not possible with MD5
9288 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9289 present. For example:
9290 .code
9291 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9292 .endd
9293 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9294 produces:
9295 .code
9296 dd97e3ba5d1a61b5006108f8c8252953
9297 .endd
9298 As an example of how this might be used, you might put in the main part of
9299 an Exim configuration:
9300 .code
9301 SPAMSCAN_SECRET=cohgheeLei2thahw
9302 .endd
9303 In a router or a transport you could then have:
9304 .code
9305 headers_add = \
9306   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9307   ${hmac{md5}{SPAMSCAN_SECRET}\
9308   {${primary_hostname},${message_exim_id},$h_message-id:}}
9309 .endd
9310 Then given a message, you can check where it was scanned by looking at the
9311 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9312 this header line is authentic by recomputing the authentication code from the
9313 host name, message ID and the &'Message-id:'& header line. This can be done
9314 using Exim's &%-be%& option, or by other means, for example by using the
9315 &'hmac_md5_hex()'& function in Perl.
9316
9317
9318 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9319 .cindex "expansion" "conditional"
9320 .cindex "&%if%&, expansion item"
9321 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9322 item; otherwise <&'string2'&> is used. The available conditions are described
9323 in section &<<SECTexpcond>>& below. For example:
9324 .code
9325 ${if eq {$local_part}{postmaster} {yes}{no} }
9326 .endd
9327 The second string need not be present; if it is not and the condition is not
9328 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9329 be present instead of the second string (without any curly brackets). In this
9330 case, the expansion is forced to fail if the condition is not true (see section
9331 &<<SECTforexpfai>>&).
9332
9333 If both strings are omitted, the result is the string &`true`& if the condition
9334 is true, and the empty string if the condition is false. This makes it less
9335 cumbersome to write custom ACL and router conditions. For example, instead of
9336 .code
9337 condition = ${if >{$acl_m4}{3}{true}{false}}
9338 .endd
9339 you can use
9340 .code
9341 condition = ${if >{$acl_m4}{3}}
9342 .endd
9343
9344 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9345 .cindex "expansion" "string truncation"
9346 .cindex "&%length%& expansion item"
9347 The &%length%& item is used to extract the initial portion of a string. Both
9348 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9349 you are using a fixed value for the number, that is, if <&'string1'&> does not
9350 change when expanded, you can use the simpler operator notation that avoids
9351 some of the braces:
9352 .code
9353 ${length_<n>:<string>}
9354 .endd
9355 The result of this item is either the first <&'n'&> characters or the whole
9356 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9357 &%strlen%&, which gives the length of a string.
9358
9359
9360 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9361         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9362 .cindex "expansion" "extracting list elements by number"
9363 .cindex "&%listextract%&" "extract list elements by number"
9364 .cindex "list" "extracting elements by number"
9365 The <&'number'&> argument must consist entirely of decimal digits,
9366 apart from an optional leading minus,
9367 and leading and trailing white space (which is ignored).
9368
9369 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9370 default, but the separator can be changed in the usual way.
9371
9372 The first field of the list is numbered one.
9373 If the number is negative, the fields are
9374 counted from the end of the list, with the rightmost one numbered -1.
9375 The numbered element of the list is extracted and placed in &$value$&,
9376 then <&'string2'&> is expanded as the result.
9377
9378 If the modulus of the
9379 number is zero or greater than the number of fields in the string,
9380 the result is the expansion of <&'string3'&>.
9381
9382 For example:
9383 .code
9384 ${listextract{2}{x:42:99}}
9385 .endd
9386 yields &"42"&, and
9387 .code
9388 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9389 .endd
9390 yields &"result: 99"&.
9391
9392 If {<&'string3'&>} is omitted, an empty string is used for string3.
9393 If {<&'string2'&>} is also omitted, the value that was
9394 extracted is used.
9395 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9396
9397
9398 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9399         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9400 This is the first of one of two different types of lookup item, which are both
9401 described in the next item.
9402
9403 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9404         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9405 .cindex "expansion" "lookup in"
9406 .cindex "file" "lookups"
9407 .cindex "lookup" "in expanded string"
9408 The two forms of lookup item specify data lookups in files and databases, as
9409 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9410 lookups, and the second is used for query-style lookups. The <&'key'&>,
9411 <&'file'&>, and <&'query'&> strings are expanded before use.
9412
9413 If there is any white space in a lookup item which is part of a filter command,
9414 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9415 other place where white space is significant, the lookup item must be enclosed
9416 in double quotes. The use of data lookups in users' filter files may be locked
9417 out by the system administrator.
9418
9419 .vindex "&$value$&"
9420 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9421 During its expansion, the variable &$value$& contains the data returned by the
9422 lookup. Afterwards it reverts to the value it had previously (at the outer
9423 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9424 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9425 string on failure. If <&'string2'&> is provided, it can itself be a nested
9426 lookup, thus providing a mechanism for looking up a default value when the
9427 original lookup fails.
9428
9429 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9430 data for the outer lookup while the parameters of the second lookup are
9431 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9432 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9433 appear, and in this case, if the lookup fails, the entire expansion is forced
9434 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9435 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9436 successful lookup, and nothing in the case of failure.
9437
9438 For single-key lookups, the string &"partial"& is permitted to precede the
9439 search type in order to do partial matching, and * or *@ may follow a search
9440 type to request default lookups if the key does not match (see sections
9441 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9442
9443 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9444 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9445 and non-wild parts of the key during the expansion of the replacement text.
9446 They return to their previous values at the end of the lookup item.
9447
9448 This example looks up the postmaster alias in the conventional alias file:
9449 .code
9450 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9451 .endd
9452 This example uses NIS+ to look up the full name of the user corresponding to
9453 the local part of an address, forcing the expansion to fail if it is not found:
9454 .code
9455 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9456   {$value}fail}
9457 .endd
9458
9459
9460 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9461 .cindex "expansion" "list creation"
9462 .vindex "&$item$&"
9463 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9464 default, but the separator can be changed in the usual way. For each item
9465 in this list, its value is place in &$item$&, and then <&'string2'&> is
9466 expanded and added to the output as an item in a new list. The separator used
9467 for the output list is the same as the one used for the input, but a separator
9468 setting is not included in the output. For example:
9469 .code
9470 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9471 .endd
9472 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9473 value of &$item$& is restored to what it was before. See also the &*filter*&
9474 and &*reduce*& expansion items.
9475
9476 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9477 .cindex "expansion" "numeric hash"
9478 .cindex "hash function" "numeric"
9479 The three strings are expanded; the first two must yield numbers. Call them
9480 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9481 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9482 can use the simpler operator notation that avoids some of the braces:
9483 .code
9484 ${nhash_<n>_<m>:<string>}
9485 .endd
9486 The second number is optional (in both notations). If there is only one number,
9487 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9488 processed by a div/mod hash function that returns two numbers, separated by a
9489 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9490 example,
9491 .code
9492 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9493 .endd
9494 returns the string &"6/33"&.
9495
9496
9497
9498 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9499 .cindex "Perl" "use in expanded string"
9500 .cindex "expansion" "calling Perl from"
9501 This item is available only if Exim has been built to include an embedded Perl
9502 interpreter. The subroutine name and the arguments are first separately
9503 expanded, and then the Perl subroutine is called with those arguments. No
9504 additional arguments need be given; the maximum number permitted, including the
9505 name of the subroutine, is nine.
9506
9507 The return value of the subroutine is inserted into the expanded string, unless
9508 the return value is &%undef%&. In that case, the expansion fails in the same
9509 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9510 Whatever you return is evaluated in a scalar context. For example, if you
9511 return the name of a Perl vector, the return value is the size of the vector,
9512 not its contents.
9513
9514 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9515 with the error message that was passed to &%die%&. More details of the embedded
9516 Perl facility are given in chapter &<<CHAPperl>>&.
9517
9518 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9519 out the use of this expansion item in filter files.
9520
9521
9522 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9523 .cindex "&%prvs%& expansion item"
9524 The first argument is a complete email address and the second is secret
9525 keystring. The third argument, specifying a key number, is optional. If absent,
9526 it defaults to 0. The result of the expansion is a prvs-signed email address,
9527 to be typically used with the &%return_path%& option on an &(smtp)& transport
9528 as part of a bounce address tag validation (BATV) scheme. For more discussion
9529 and an example, see section &<<SECTverifyPRVS>>&.
9530
9531 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9532         {*&<&'string'&>&*}}*&"
9533 .cindex "&%prvscheck%& expansion item"
9534 This expansion item is the complement of the &%prvs%& item. It is used for
9535 checking prvs-signed addresses. If the expansion of the first argument does not
9536 yield a syntactically valid prvs-signed address, the whole item expands to the
9537 empty string. When the first argument does expand to a syntactically valid
9538 prvs-signed address, the second argument is expanded, with the prvs-decoded
9539 version of the address and the key number extracted from the address in the
9540 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9541
9542 These two variables can be used in the expansion of the second argument to
9543 retrieve the secret. The validity of the prvs-signed address is then checked
9544 against the secret. The result is stored in the variable &$prvscheck_result$&,
9545 which is empty for failure or &"1"& for success.
9546
9547 The third argument is optional; if it is missing, it defaults to an empty
9548 string. This argument is now expanded. If the result is an empty string, the
9549 result of the expansion is the decoded version of the address. This is the case
9550 whether or not the signature was valid. Otherwise, the result of the expansion
9551 is the expansion of the third argument.
9552
9553 All three variables can be used in the expansion of the third argument.
9554 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9555 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9556
9557 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9558 .cindex "expansion" "inserting an entire file"
9559 .cindex "file" "inserting into expansion"
9560 .cindex "&%readfile%& expansion item"
9561 The file name and end-of-line string are first expanded separately. The file is
9562 then read, and its contents replace the entire item. All newline characters in
9563 the file are replaced by the end-of-line string if it is present. Otherwise,
9564 newlines are left in the string.
9565 String expansion is not applied to the contents of the file. If you want this,
9566 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9567 the string expansion fails.
9568
9569 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9570 locks out the use of this expansion item in filter files.
9571
9572
9573
9574 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9575         {*&<&'timeout'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9576 .cindex "expansion" "inserting from a socket"
9577 .cindex "socket, use of in expansion"
9578 .cindex "&%readsocket%& expansion item"
9579 This item inserts data from a Unix domain or TCP socket into the expanded
9580 string. The minimal way of using it uses just two arguments, as in these
9581 examples:
9582 .code
9583 ${readsocket{/socket/name}{request string}}
9584 ${readsocket{inet:some.host:1234}{request string}}
9585 .endd
9586 For a Unix domain socket, the first substring must be the path to the socket.
9587 For an Internet socket, the first substring must contain &`inet:`& followed by
9588 a host name or IP address, followed by a colon and a port, which can be a
9589 number or the name of a TCP port in &_/etc/services_&. An IP address may
9590 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9591 example:
9592 .code
9593 ${readsocket{inet:[::1]:1234}{request string}}
9594 .endd
9595 Only a single host name may be given, but if looking it up yields more than
9596 one IP address, they are each tried in turn until a connection is made. For
9597 both kinds of socket, Exim makes a connection, writes the request string
9598 (unless it is an empty string) and reads from the socket until an end-of-file
9599 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9600 extend what can be done. Firstly, you can vary the timeout. For example:
9601 .code
9602 ${readsocket{/socket/name}{request string}{3s}}
9603 .endd
9604 A fourth argument allows you to change any newlines that are in the data
9605 that is read, in the same way as for &%readfile%& (see above). This example
9606 turns them into spaces:
9607 .code
9608 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9609 .endd
9610 As with all expansions, the substrings are expanded before the processing
9611 happens. Errors in these sub-expansions cause the expansion to fail. In
9612 addition, the following errors can occur:
9613
9614 .ilist
9615 Failure to create a socket file descriptor;
9616 .next
9617 Failure to connect the socket;
9618 .next
9619 Failure to write the request string;
9620 .next
9621 Timeout on reading from the socket.
9622 .endlist
9623
9624 By default, any of these errors causes the expansion to fail. However, if
9625 you supply a fifth substring, it is expanded and used when any of the above
9626 errors occurs. For example:
9627 .code
9628 ${readsocket{/socket/name}{request string}{3s}{\n}\
9629   {socket failure}}
9630 .endd
9631 You can test for the existence of a Unix domain socket by wrapping this
9632 expansion in &`${if exists`&, but there is a race condition between that test
9633 and the actual opening of the socket, so it is safer to use the fifth argument
9634 if you want to be absolutely sure of avoiding an expansion error for a
9635 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9636
9637 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9638 locks out the use of this expansion item in filter files.
9639
9640
9641 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9642 .cindex "expansion" "reducing a list to a scalar"
9643 .cindex "list" "reducing to a scalar"
9644 .vindex "&$value$&"
9645 .vindex "&$item$&"
9646 This operation reduces a list to a single, scalar string. After expansion,
9647 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9648 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9649 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9650 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9651 them. The result of that expansion is assigned to &$value$& before the next
9652 iteration. When the end of the list is reached, the final value of &$value$& is
9653 added to the expansion output. The &*reduce*& expansion item can be used in a
9654 number of ways. For example, to add up a list of numbers:
9655 .code
9656 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9657 .endd
9658 The result of that expansion would be &`6`&. The maximum of a list of numbers
9659 can be found:
9660 .code
9661 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9662 .endd
9663 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9664 restored to what they were before. See also the &*filter*& and &*map*&
9665 expansion items.
9666
9667 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9668 This item inserts &"raw"& header lines. It is described with the &%header%&
9669 expansion item above.
9670
9671 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9672         {*&<&'string2'&>&*}}*&"
9673 .cindex "expansion" "running a command"
9674 .cindex "&%run%& expansion item"
9675 The command and its arguments are first expanded as one string. The string is
9676 split apart into individual arguments by spaces, and then the command is run
9677 in a separate process, but under the same uid and gid.  As in other command
9678 executions from Exim, a shell is not used by default. If the command requires
9679 a shell, you must explicitly code it.
9680
9681 Since the arguments are split by spaces, when there is a variable expansion
9682 which has an empty result, it will cause the situation that the argument will
9683 simply be omitted when the program is actually executed by Exim. If the
9684 script/program requires a specific number of arguments and the expanded
9685 variable could possibly result in this empty expansion, the variable must be
9686 quoted. This is more difficult if the expanded variable itself could result
9687 in a string containing quotes, because it would interfere with the quotes
9688 around the command arguments. A possible guard against this is to wrap the
9689 variable in the &%sg%& operator to change any quote marks to some other
9690 character.
9691
9692 The standard input for the command exists, but is empty. The standard output
9693 and standard error are set to the same file descriptor.
9694 .cindex "return code" "from &%run%& expansion"
9695 .vindex "&$value$&"
9696 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9697 and replaces the entire item; during this expansion, the standard output/error
9698 from the command is in the variable &$value$&. If the command fails,
9699 <&'string2'&>, if present, is expanded and used. Once again, during the
9700 expansion, the standard output/error from the command is in the variable
9701 &$value$&.
9702
9703 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9704 can be the word &"fail"& (not in braces) to force expansion failure if the
9705 command does not succeed. If both strings are omitted, the result is contents
9706 of the standard output/error on success, and nothing on failure.
9707
9708 .vindex "&$run_in_acl$&"
9709 The standard output/error of the command is put in the variable &$value$&.
9710 In this ACL example, the output of a command is logged for the admin to
9711 troubleshoot:
9712 .code
9713 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9714       log_message  = Output of id: $value
9715 .endd
9716 If the command requires shell idioms, such as the > redirect operator, the
9717 shell must be invoked directly, such as with:
9718 .code
9719 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9720 .endd
9721
9722 .vindex "&$runrc$&"
9723 The return code from the command is put in the variable &$runrc$&, and this
9724 remains set afterwards, so in a filter file you can do things like this:
9725 .code
9726 if "${run{x y z}{}}$runrc" is 1 then ...
9727   elif $runrc is 2 then ...
9728   ...
9729 endif
9730 .endd
9731 If execution of the command fails (for example, the command does not exist),
9732 the return code is 127 &-- the same code that shells use for non-existent
9733 commands.
9734
9735 &*Warning*&: In a router or transport, you cannot assume the order in which
9736 option values are expanded, except for those preconditions whose order of
9737 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9738 by the expansion of one option, and use it in another.
9739
9740 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9741 out the use of this expansion item in filter files.
9742
9743
9744 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9745 .cindex "expansion" "string substitution"
9746 .cindex "&%sg%& expansion item"
9747 This item works like Perl's substitution operator (s) with the global (/g)
9748 option; hence its name. However, unlike the Perl equivalent, Exim does not
9749 modify the subject string; instead it returns the modified string for insertion
9750 into the overall expansion. The item takes three arguments: the subject string,
9751 a regular expression, and a substitution string. For example:
9752 .code
9753 ${sg{abcdefabcdef}{abc}{xyz}}
9754 .endd
9755 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9756 if any $ or \ characters are required in the regular expression or in the
9757 substitution string, they have to be escaped. For example:
9758 .code
9759 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9760 .endd
9761 yields &"defabc"&, and
9762 .code
9763 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9764 .endd
9765 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9766 the regular expression from string expansion.
9767
9768
9769
9770 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9771 .cindex sorting "a list"
9772 .cindex list sorting
9773 .cindex expansion "list sorting"
9774 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9775 default, but the separator can be changed in the usual way.
9776 The <&'comparator'&> argument is interpreted as the operator
9777 of a two-argument expansion condition.
9778 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9779 The comparison should return true when applied to two values
9780 if the first value should sort before the second value.
9781 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9782 the element being placed in &$item$&,
9783 to give values for comparison.
9784
9785 The item result is a sorted list,
9786 with the original list separator,
9787 of the list elements (in full) of the original.
9788
9789 Examples:
9790 .code
9791 ${sort{3:2:1:4}{<}{$item}}
9792 .endd
9793 sorts a list of numbers, and
9794 .code
9795 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
9796 .endd
9797 will sort an MX lookup into priority order.
9798
9799
9800 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9801 .cindex "&%substr%& expansion item"
9802 .cindex "substring extraction"
9803 .cindex "expansion" "substring extraction"
9804 The three strings are expanded; the first two must yield numbers. Call them
9805 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9806 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9807 can use the simpler operator notation that avoids some of the braces:
9808 .code
9809 ${substr_<n>_<m>:<string>}
9810 .endd
9811 The second number is optional (in both notations).
9812 If it is absent in the simpler format, the preceding underscore must also be
9813 omitted.
9814
9815 The &%substr%& item can be used to extract more general substrings than
9816 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
9817 length required. For example
9818 .code
9819 ${substr{3}{2}{$local_part}}
9820 .endd
9821 If the starting offset is greater than the string length the result is the
9822 null string; if the length plus starting offset is greater than the string
9823 length, the result is the right-hand part of the string, starting from the
9824 given offset. The first character in the string has offset zero.
9825
9826 The &%substr%& expansion item can take negative offset values to count
9827 from the right-hand end of its operand. The last character is offset -1, the
9828 second-last is offset -2, and so on. Thus, for example,
9829 .code
9830 ${substr{-5}{2}{1234567}}
9831 .endd
9832 yields &"34"&. If the absolute value of a negative offset is greater than the
9833 length of the string, the substring starts at the beginning of the string, and
9834 the length is reduced by the amount of overshoot. Thus, for example,
9835 .code
9836 ${substr{-5}{2}{12}}
9837 .endd
9838 yields an empty string, but
9839 .code
9840 ${substr{-3}{2}{12}}
9841 .endd
9842 yields &"1"&.
9843
9844 When the second number is omitted from &%substr%&, the remainder of the string
9845 is taken if the offset is positive. If it is negative, all characters in the
9846 string preceding the offset point are taken. For example, an offset of -1 and
9847 no length, as in these semantically identical examples:
9848 .code
9849 ${substr_-1:abcde}
9850 ${substr{-1}{abcde}}
9851 .endd
9852 yields all but the last character of the string, that is, &"abcd"&.
9853
9854
9855
9856 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
9857         {*&<&'replacements'&>&*}}*&"
9858 .cindex "expansion" "character translation"
9859 .cindex "&%tr%& expansion item"
9860 This item does single-character translation on its subject string. The second
9861 argument is a list of characters to be translated in the subject string. Each
9862 matching character is replaced by the corresponding character from the
9863 replacement list. For example
9864 .code
9865 ${tr{abcdea}{ac}{13}}
9866 .endd
9867 yields &`1b3de1`&. If there are duplicates in the second character string, the
9868 last occurrence is used. If the third string is shorter than the second, its
9869 last character is replicated. However, if it is empty, no translation takes
9870 place.
9871 .endlist
9872
9873
9874
9875 .section "Expansion operators" "SECTexpop"
9876 .cindex "expansion" "operators"
9877 For expansion items that perform transformations on a single argument string,
9878 the &"operator"& notation is used because it is simpler and uses fewer braces.
9879 The substring is first expanded before the operation is applied to it. The
9880 following operations can be performed:
9881
9882 .vlist
9883 .vitem &*${address:*&<&'string'&>&*}*&
9884 .cindex "expansion" "RFC 2822 address handling"
9885 .cindex "&%address%& expansion item"
9886 The string is interpreted as an RFC 2822 address, as it might appear in a
9887 header line, and the effective address is extracted from it. If the string does
9888 not parse successfully, the result is empty.
9889
9890
9891 .vitem &*${addresses:*&<&'string'&>&*}*&
9892 .cindex "expansion" "RFC 2822 address handling"
9893 .cindex "&%addresses%& expansion item"
9894 The string (after expansion) is interpreted as a list of addresses in RFC
9895 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
9896 operative address (&'local-part@domain'&) is extracted from each item, and the
9897 result of the expansion is a colon-separated list, with appropriate
9898 doubling of colons should any happen to be present in the email addresses.
9899 Syntactically invalid RFC2822 address items are omitted from the output.
9900
9901 It is possible to specify a character other than colon for the output
9902 separator by starting the string with > followed by the new separator
9903 character. For example:
9904 .code
9905 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
9906 .endd
9907 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
9908 expansion item, which extracts the working address from a single RFC2822
9909 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
9910 processing lists.
9911
9912 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
9913 a strict interpretation of header line formatting.  Exim parses the bare,
9914 unquoted portion of an email address and if it finds a comma, treats it as an
9915 email address seperator. For the example header line:
9916 .code
9917 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
9918 .endd
9919 The first example below demonstrates that Q-encoded email addresses are parsed
9920 properly if it is given the raw header (in this example, &`$rheader_from:`&).
9921 It does not see the comma because it's still encoded as "=2C".  The second
9922 example below is passed the contents of &`$header_from:`&, meaning it gets
9923 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
9924 The third example shows that the presence of a comma is skipped when it is
9925 quoted.
9926 .code
9927 # exim -be '${addresses:From: \
9928 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
9929 user@example.com
9930 # exim -be '${addresses:From: Last, First <user@example.com>}'
9931 Last:user@example.com
9932 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
9933 user@example.com
9934 .endd
9935
9936 .vitem &*${base62:*&<&'digits'&>&*}*&
9937 .cindex "&%base62%& expansion item"
9938 .cindex "expansion" "conversion to base 62"
9939 The string must consist entirely of decimal digits. The number is converted to
9940 base 62 and output as a string of six characters, including leading zeros. In
9941 the few operating environments where Exim uses base 36 instead of base 62 for
9942 its message identifiers (because those systems do not have case-sensitive file
9943 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
9944 be absolutely clear: this is &'not'& base64 encoding.
9945
9946 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
9947 .cindex "&%base62d%& expansion item"
9948 .cindex "expansion" "conversion to base 62"
9949 The string must consist entirely of base-62 digits, or, in operating
9950 environments where Exim uses base 36 instead of base 62 for its message
9951 identifiers, base-36 digits. The number is converted to decimal and output as a
9952 string.
9953
9954
9955 .vitem &*${domain:*&<&'string'&>&*}*&
9956 .cindex "domain" "extraction"
9957 .cindex "expansion" "domain extraction"
9958 The string is interpreted as an RFC 2822 address and the domain is extracted
9959 from it. If the string does not parse successfully, the result is empty.
9960
9961
9962 .vitem &*${escape:*&<&'string'&>&*}*&
9963 .cindex "expansion" "escaping non-printing characters"
9964 .cindex "&%escape%& expansion item"
9965 If the string contains any non-printing characters, they are converted to
9966 escape sequences starting with a backslash. Whether characters with the most
9967 significant bit set (so-called &"8-bit characters"&) count as printing or not
9968 is controlled by the &%print_topbitchars%& option.
9969
9970
9971 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
9972 .cindex "expansion" "expression evaluation"
9973 .cindex "expansion" "arithmetic expression"
9974 .cindex "&%eval%& expansion item"
9975 These items supports simple arithmetic and bitwise logical operations in
9976 expansion strings. The string (after expansion) must be a conventional
9977 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
9978 logical operators, and parentheses. All operations are carried out using
9979 integer arithmetic. The operator priorities are as follows (the same as in the
9980 C programming language):
9981 .table2 70pt 300pt
9982 .irow &'highest:'& "not (~), negate (-)"
9983 .irow ""   "multiply (*), divide (/), remainder (%)"
9984 .irow ""   "plus (+), minus (-)"
9985 .irow ""   "shift-left (<<), shift-right (>>)"
9986 .irow ""   "and (&&)"
9987 .irow ""   "xor (^)"
9988 .irow &'lowest:'&  "or (|)"
9989 .endtable
9990 Binary operators with the same priority are evaluated from left to right. White
9991 space is permitted before or after operators.
9992
9993 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
9994 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
9995 decimal, even if they start with a leading zero; hexadecimal numbers are not
9996 permitted. This can be useful when processing numbers extracted from dates or
9997 times, which often do have leading zeros.
9998
9999 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10000 or 1024*1024*1024,
10001 respectively. Negative numbers are supported. The result of the computation is
10002 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10003
10004 .display
10005 &`${eval:1+1}            `&  yields 2
10006 &`${eval:1+2*3}          `&  yields 7
10007 &`${eval:(1+2)*3}        `&  yields 9
10008 &`${eval:2+42%5}         `&  yields 4
10009 &`${eval:0xc&amp;5}          `&  yields 4
10010 &`${eval:0xc|5}          `&  yields 13
10011 &`${eval:0xc^5}          `&  yields 9
10012 &`${eval:0xc>>1}         `&  yields 6
10013 &`${eval:0xc<<1}         `&  yields 24
10014 &`${eval:~255&amp;0x1234}    `&  yields 4608
10015 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10016 .endd
10017
10018 As a more realistic example, in an ACL you might have
10019 .code
10020 deny   message = Too many bad recipients
10021        condition =                    \
10022          ${if and {                   \
10023            {>{$rcpt_count}{10}}       \
10024            {                          \
10025            <                          \
10026              {$recipients_count}      \
10027              {${eval:$rcpt_count/2}}  \
10028            }                          \
10029          }{yes}{no}}
10030 .endd
10031 The condition is true if there have been more than 10 RCPT commands and
10032 fewer than half of them have resulted in a valid recipient.
10033
10034
10035 .vitem &*${expand:*&<&'string'&>&*}*&
10036 .cindex "expansion" "re-expansion of substring"
10037 The &%expand%& operator causes a string to be expanded for a second time. For
10038 example,
10039 .code
10040 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10041 .endd
10042 first looks up a string in a file while expanding the operand for &%expand%&,
10043 and then re-expands what it has found.
10044
10045
10046 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10047 .cindex "Unicode"
10048 .cindex "UTF-8" "conversion from"
10049 .cindex "expansion" "UTF-8 conversion"
10050 .cindex "&%from_utf8%& expansion item"
10051 The world is slowly moving towards Unicode, although there are no standards for
10052 email yet. However, other applications (including some databases) are starting
10053 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10054 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10055 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10056 the result is an undefined sequence of bytes.
10057
10058 Unicode code points with values less than 256 are compatible with ASCII and
10059 ISO-8859-1 (also known as Latin-1).
10060 For example, character 169 is the copyright symbol in both cases, though the
10061 way it is encoded is different. In UTF-8, more than one byte is needed for
10062 characters with code values greater than 127, whereas ISO-8859-1 is a
10063 single-byte encoding (but thereby limited to 256 characters). This makes
10064 translation from UTF-8 to ISO-8859-1 straightforward.
10065
10066
10067 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10068 .cindex "hash function" "textual"
10069 .cindex "expansion" "textual hash"
10070 The &%hash%& operator is a simpler interface to the hashing function that can
10071 be used when the two parameters are fixed numbers (as opposed to strings that
10072 change when expanded). The effect is the same as
10073 .code
10074 ${hash{<n>}{<m>}{<string>}}
10075 .endd
10076 See the description of the general &%hash%& item above for details. The
10077 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10078
10079
10080
10081 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10082 .cindex "base64 encoding" "conversion from hex"
10083 .cindex "expansion" "hex to base64"
10084 .cindex "&%hex2b64%& expansion item"
10085 This operator converts a hex string into one that is base64 encoded. This can
10086 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10087
10088
10089
10090 .vitem &*${hexquote:*&<&'string'&>&*}*&
10091 .cindex "quoting" "hex-encoded unprintable characters"
10092 .cindex "&%hexquote%& expansion item"
10093 This operator converts non-printable characters in a string into a hex
10094 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10095 as is, and other byte values are converted to &`\xNN`&, for example a
10096 byte value 127 is converted to &`\x7f`&.
10097
10098
10099 .vitem &*${lc:*&<&'string'&>&*}*&
10100 .cindex "case forcing in strings"
10101 .cindex "string" "case forcing"
10102 .cindex "lower casing"
10103 .cindex "expansion" "case forcing"
10104 .cindex "&%lc%& expansion item"
10105 This forces the letters in the string into lower-case, for example:
10106 .code
10107 ${lc:$local_part}
10108 .endd
10109
10110 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10111 .cindex "expansion" "string truncation"
10112 .cindex "&%length%& expansion item"
10113 The &%length%& operator is a simpler interface to the &%length%& function that
10114 can be used when the parameter is a fixed number (as opposed to a string that
10115 changes when expanded). The effect is the same as
10116 .code
10117 ${length{<number>}{<string>}}
10118 .endd
10119 See the description of the general &%length%& item above for details. Note that
10120 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10121 when &%length%& is used as an operator.
10122
10123
10124 .vitem &*${listcount:*&<&'string'&>&*}*&
10125 .cindex "expansion" "list item count"
10126 .cindex "list" "item count"
10127 .cindex "list" "count of items"
10128 .cindex "&%listcount%& expansion item"
10129 The string is interpreted as a list and the number of items is returned.
10130
10131
10132 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10133 .cindex "expansion" "named list"
10134 .cindex "&%listnamed%& expansion item"
10135 The name is interpreted as a named list and the content of the list is returned,
10136 expanding any referenced lists, re-quoting as needed for colon-separation.
10137 If the optional type is given it must be one of "a", "d", "h" or "l"
10138 and selects address-, domain-, host- or localpart- lists to search among respectively.
10139 Otherwise all types are searched in an undefined order and the first
10140 matching list is returned.
10141
10142
10143 .vitem &*${local_part:*&<&'string'&>&*}*&
10144 .cindex "expansion" "local part extraction"
10145 .cindex "&%local_part%& expansion item"
10146 The string is interpreted as an RFC 2822 address and the local part is
10147 extracted from it. If the string does not parse successfully, the result is
10148 empty.
10149
10150
10151 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10152 .cindex "masked IP address"
10153 .cindex "IP address" "masking"
10154 .cindex "CIDR notation"
10155 .cindex "expansion" "IP address masking"
10156 .cindex "&%mask%& expansion item"
10157 If the form of the string to be operated on is not an IP address followed by a
10158 slash and an integer (that is, a network address in CIDR notation), the
10159 expansion fails. Otherwise, this operator converts the IP address to binary,
10160 masks off the least significant bits according to the bit count, and converts
10161 the result back to text, with mask appended. For example,
10162 .code
10163 ${mask:10.111.131.206/28}
10164 .endd
10165 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10166 be mostly used for looking up masked addresses in files, the result for an IPv6
10167 address uses dots to separate components instead of colons, because colon
10168 terminates a key string in lsearch files. So, for example,
10169 .code
10170 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10171 .endd
10172 returns the string
10173 .code
10174 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10175 .endd
10176 Letters in IPv6 addresses are always output in lower case.
10177
10178
10179 .vitem &*${md5:*&<&'string'&>&*}*&
10180 .cindex "MD5 hash"
10181 .cindex "expansion" "MD5 hash"
10182 .cindex "certificate fingerprint"
10183 .cindex "&%md5%& expansion item"
10184 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10185 as a 32-digit hexadecimal number, in which any letters are in lower case.
10186
10187
10188 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10189 .cindex "expansion" "numeric hash"
10190 .cindex "hash function" "numeric"
10191 The &%nhash%& operator is a simpler interface to the numeric hashing function
10192 that can be used when the two parameters are fixed numbers (as opposed to
10193 strings that change when expanded). The effect is the same as
10194 .code
10195 ${nhash{<n>}{<m>}{<string>}}
10196 .endd
10197 See the description of the general &%nhash%& item above for details.
10198
10199
10200 .vitem &*${quote:*&<&'string'&>&*}*&
10201 .cindex "quoting" "in string expansions"
10202 .cindex "expansion" "quoting"
10203 .cindex "&%quote%& expansion item"
10204 The &%quote%& operator puts its argument into double quotes if it
10205 is an empty string or
10206 contains anything other than letters, digits, underscores, dots, and hyphens.
10207 Any occurrences of double quotes and backslashes are escaped with a backslash.
10208 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10209 respectively For example,
10210 .code
10211 ${quote:ab"*"cd}
10212 .endd
10213 becomes
10214 .code
10215 "ab\"*\"cd"
10216 .endd
10217 The place where this is useful is when the argument is a substitution from a
10218 variable or a message header.
10219
10220 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10221 .cindex "&%quote_local_part%& expansion item"
10222 This operator is like &%quote%&, except that it quotes the string only if
10223 required to do so by the rules of RFC 2822 for quoting local parts. For
10224 example, a plus sign would not cause quoting (but it would for &%quote%&).
10225 If you are creating a new email address from the contents of &$local_part$&
10226 (or any other unknown data), you should always use this operator.
10227
10228
10229 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10230 .cindex "quoting" "lookup-specific"
10231 This operator applies lookup-specific quoting rules to the string. Each
10232 query-style lookup type has its own quoting rules which are described with
10233 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10234 .code
10235 ${quote_ldap:two * two}
10236 .endd
10237 returns
10238 .code
10239 two%20%5C2A%20two
10240 .endd
10241 For single-key lookup types, no quoting is ever necessary and this operator
10242 yields an unchanged string.
10243
10244
10245 .vitem &*${randint:*&<&'n'&>&*}*&
10246 .cindex "random number"
10247 This operator returns a somewhat random number which is less than the
10248 supplied number and is at least 0.  The quality of this randomness depends
10249 on how Exim was built; the values are not suitable for keying material.
10250 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10251 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10252 for versions of GnuTLS with that function.
10253 Otherwise, the implementation may be arc4random(), random() seeded by
10254 srandomdev() or srandom(), or a custom implementation even weaker than
10255 random().
10256
10257
10258 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10259 .cindex "expansion" "IP address"
10260 This operator reverses an IP address; for IPv4 addresses, the result is in
10261 dotted-quad decimal form, while for IPv6 addreses the result is in
10262 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10263 for DNS.  For example,
10264 .code
10265 ${reverse_ip:192.0.2.4}
10266 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10267 .endd
10268 returns
10269 .code
10270 4.2.0.192
10271 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
10272 .endd
10273
10274
10275 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10276 .cindex "expansion" "RFC 2047"
10277 .cindex "RFC 2047" "expansion operator"
10278 .cindex "&%rfc2047%& expansion item"
10279 This operator encodes text according to the rules of RFC 2047. This is an
10280 encoding that is used in header lines to encode non-ASCII characters. It is
10281 assumed that the input string is in the encoding specified by the
10282 &%headers_charset%& option, which defaults to ISO-8859-1. If the string
10283 contains only characters in the range 33&--126, and no instances of the
10284 characters
10285 .code
10286 ? = ( ) < > @ , ; : \ " . [ ] _
10287 .endd
10288 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10289 string, using as many &"encoded words"& as necessary to encode all the
10290 characters.
10291
10292
10293 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10294 .cindex "expansion" "RFC 2047"
10295 .cindex "RFC 2047" "decoding"
10296 .cindex "&%rfc2047d%& expansion item"
10297 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10298 bytes are replaced by question marks. Characters are converted into the
10299 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10300 not recognized unless &%check_rfc2047_length%& is set false.
10301
10302 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10303 access a header line, RFC 2047 decoding is done automatically. You do not need
10304 to use this operator as well.
10305
10306
10307
10308 .vitem &*${rxquote:*&<&'string'&>&*}*&
10309 .cindex "quoting" "in regular expressions"
10310 .cindex "regular expressions" "quoting"
10311 .cindex "&%rxquote%& expansion item"
10312 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10313 characters in its argument. This is useful when substituting the values of
10314 variables or headers inside regular expressions.
10315
10316
10317 .vitem &*${sha1:*&<&'string'&>&*}*&
10318 .cindex "SHA-1 hash"
10319 .cindex "expansion" "SHA-1 hashing"
10320 .cindex "certificate fingerprint"
10321 .cindex "&%sha2%& expansion item"
10322 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10323 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10324
10325
10326 .vitem &*${sha256:*&<&'certificate'&>&*}*&
10327 .cindex "SHA-256 hash"
10328 .cindex "certificate fingerprint"
10329 .cindex "expansion" "SHA-256 hashing"
10330 .cindex "&%sha256%& expansion item"
10331 The &%sha256%& operator computes the SHA-256 hash fingerprint of the
10332 certificate,
10333 and returns
10334 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10335 Only arguments which are a single variable of certificate type are supported.
10336
10337
10338 .vitem &*${stat:*&<&'string'&>&*}*&
10339 .cindex "expansion" "statting a file"
10340 .cindex "file" "extracting characteristics"
10341 .cindex "&%stat%& expansion item"
10342 The string, after expansion, must be a file path. A call to the &[stat()]&
10343 function is made for this path. If &[stat()]& fails, an error occurs and the
10344 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10345 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10346 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10347 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10348 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10349 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10350 can extract individual fields using the &%extract%& expansion item.
10351
10352 The use of the &%stat%& expansion in users' filter files can be locked out by
10353 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10354 systems for files larger than 2GB.
10355
10356 .vitem &*${str2b64:*&<&'string'&>&*}*&
10357 .cindex "expansion" "base64 encoding"
10358 .cindex "base64 encoding" "in string expansion"
10359 .cindex "&%str2b64%& expansion item"
10360 This operator converts a string into one that is base64 encoded.
10361
10362
10363
10364 .vitem &*${strlen:*&<&'string'&>&*}*&
10365 .cindex "expansion" "string length"
10366 .cindex "string" "length in expansion"
10367 .cindex "&%strlen%& expansion item"
10368 The item is replace by the length of the expanded string, expressed as a
10369 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10370
10371
10372 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10373 .cindex "&%substr%& expansion item"
10374 .cindex "substring extraction"
10375 .cindex "expansion" "substring expansion"
10376 The &%substr%& operator is a simpler interface to the &%substr%& function that
10377 can be used when the two parameters are fixed numbers (as opposed to strings
10378 that change when expanded). The effect is the same as
10379 .code
10380 ${substr{<start>}{<length>}{<string>}}
10381 .endd
10382 See the description of the general &%substr%& item above for details. The
10383 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10384
10385 .vitem &*${time_eval:*&<&'string'&>&*}*&
10386 .cindex "&%time_eval%& expansion item"
10387 .cindex "time interval" "decoding"
10388 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10389 seconds.
10390
10391 .vitem &*${time_interval:*&<&'string'&>&*}*&
10392 .cindex "&%time_interval%& expansion item"
10393 .cindex "time interval" "formatting"
10394 The argument (after sub-expansion) must be a sequence of decimal digits that
10395 represents an interval of time as a number of seconds. It is converted into a
10396 number of larger units and output in Exim's normal time format, for example,
10397 &`1w3d4h2m6s`&.
10398
10399 .vitem &*${uc:*&<&'string'&>&*}*&
10400 .cindex "case forcing in strings"
10401 .cindex "string" "case forcing"
10402 .cindex "upper casing"
10403 .cindex "expansion" "case forcing"
10404 .cindex "&%uc%& expansion item"
10405 This forces the letters in the string into upper-case.
10406
10407 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10408 .cindex "correction of invalid utf-8 sequences in strings"
10409 .cindex "utf-8" "utf-8 sequences"
10410 .cindex "incorrect utf-8"
10411 .cindex "expansion" "utf-8 forcing"
10412 .cindex "&%utf8clean%& expansion item"
10413 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10414 .endlist
10415
10416
10417
10418
10419
10420
10421 .section "Expansion conditions" "SECTexpcond"
10422 .scindex IIDexpcond "expansion" "conditions"
10423 The following conditions are available for testing by the &%${if%& construct
10424 while expanding strings:
10425
10426 .vlist
10427 .vitem &*!*&<&'condition'&>
10428 .cindex "expansion" "negating a condition"
10429 .cindex "negation" "in expansion condition"
10430 Preceding any condition with an exclamation mark negates the result of the
10431 condition.
10432
10433 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10434 .cindex "numeric comparison"
10435 .cindex "expansion" "numeric comparison"
10436 There are a number of symbolic operators for doing numeric comparisons. They
10437 are:
10438 .display
10439 &`=   `&   equal
10440 &`==  `&   equal
10441 &`>   `&   greater
10442 &`>=  `&   greater or equal
10443 &`<   `&   less
10444 &`<=  `&   less or equal
10445 .endd
10446 For example:
10447 .code
10448 ${if >{$message_size}{10M} ...
10449 .endd
10450 Note that the general negation operator provides for inequality testing. The
10451 two strings must take the form of optionally signed decimal integers,
10452 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10453 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10454 As a special case, the numerical value of an empty string is taken as
10455 zero.
10456
10457 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10458 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10459 10M, not if 10M is larger than &$message_size$&.
10460
10461
10462 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10463         {*&<&'arg2'&>&*}...}*&
10464 .cindex "expansion" "calling an acl"
10465 .cindex "&%acl%&" "expansion condition"
10466 The name and zero to nine argument strings are first expanded separately.  The expanded
10467 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10468 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10469 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10470 and may use the variables; if another acl expansion is used the values
10471 are restored after it returns.  If the ACL sets
10472 a value using a "message =" modifier the variable $value becomes
10473 the result of the expansion, otherwise it is empty.
10474 If the ACL returns accept the condition is true; if deny, false.
10475 If the ACL returns defer the result is a forced-fail.
10476
10477 .vitem &*bool&~{*&<&'string'&>&*}*&
10478 .cindex "expansion" "boolean parsing"
10479 .cindex "&%bool%& expansion condition"
10480 This condition turns a string holding a true or false representation into
10481 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10482 (case-insensitively); also integer numbers map to true if non-zero,
10483 false if zero.
10484 An empty string is treated as false.
10485 Leading and trailing whitespace is ignored;
10486 thus a string consisting only of whitespace is false.
10487 All other string values will result in expansion failure.
10488
10489 When combined with ACL variables, this expansion condition will let you
10490 make decisions in one place and act on those decisions in another place.
10491 For example:
10492 .code
10493 ${if bool{$acl_m_privileged_sender} ...
10494 .endd
10495
10496
10497 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10498 .cindex "expansion" "boolean parsing"
10499 .cindex "&%bool_lax%& expansion condition"
10500 Like &%bool%&, this condition turns a string into a boolean state.  But
10501 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10502 loose definition that the Router &%condition%& option uses.  The empty string
10503 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10504 true.  Leading and trailing whitespace is ignored.
10505
10506 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10507
10508 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10509 .cindex "expansion" "encrypted comparison"
10510 .cindex "encrypted strings, comparing"
10511 .cindex "&%crypteq%& expansion condition"
10512 This condition is included in the Exim binary if it is built to support any
10513 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10514 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10515 included in the binary.
10516
10517 The &%crypteq%& condition has two arguments. The first is encrypted and
10518 compared against the second, which is already encrypted. The second string may
10519 be in the LDAP form for storing encrypted strings, which starts with the
10520 encryption type in curly brackets, followed by the data. If the second string
10521 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10522 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10523 Typically this will be a field from a password file. An example of an encrypted
10524 string in LDAP form is:
10525 .code
10526 {md5}CY9rzUYh03PK3k6DJie09g==
10527 .endd
10528 If such a string appears directly in an expansion, the curly brackets have to
10529 be quoted, because they are part of the expansion syntax. For example:
10530 .code
10531 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10532 .endd
10533 The following encryption types (whose names are matched case-independently) are
10534 supported:
10535
10536 .ilist
10537 .cindex "MD5 hash"
10538 .cindex "base64 encoding" "in encrypted password"
10539 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10540 printable characters to compare with the remainder of the second string. If the
10541 length of the comparison string is 24, Exim assumes that it is base64 encoded
10542 (as in the above example). If the length is 32, Exim assumes that it is a
10543 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10544 comparison fails.
10545
10546 .next
10547 .cindex "SHA-1 hash"
10548 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10549 printable characters to compare with the remainder of the second string. If the
10550 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10551 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10552 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10553
10554 .next
10555 .cindex "&[crypt()]&"
10556 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10557 only the first eight characters of the password. However, in modern operating
10558 systems this is no longer true, and in many cases the entire password is used,
10559 whatever its length.
10560
10561 .next
10562 .cindex "&[crypt16()]&"
10563 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10564 use up to 16 characters of the password in some operating systems. Again, in
10565 modern operating systems, more characters may be used.
10566 .endlist
10567 Exim has its own version of &[crypt16()]&, which is just a double call to
10568 &[crypt()]&. For operating systems that have their own version, setting
10569 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10570 operating system version instead of its own. This option is set by default in
10571 the OS-dependent &_Makefile_& for those operating systems that are known to
10572 support &[crypt16()]&.
10573
10574 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10575 it was not using the same algorithm as some operating systems' versions. It
10576 turns out that as well as &[crypt16()]& there is a function called
10577 &[bigcrypt()]& in some operating systems. This may or may not use the same
10578 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10579
10580 However, since there is now a move away from the traditional &[crypt()]&
10581 functions towards using SHA1 and other algorithms, tidying up this area of
10582 Exim is seen as very low priority.
10583
10584 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10585 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10586 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10587 default is &`{crypt}`&. Whatever the default, you can always use either
10588 function by specifying it explicitly in curly brackets.
10589
10590 .vitem &*def:*&<&'variable&~name'&>
10591 .cindex "expansion" "checking for empty variable"
10592 .cindex "&%def%& expansion condition"
10593 The &%def%& condition must be followed by the name of one of the expansion
10594 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10595 variable does not contain the empty string. For example:
10596 .code
10597 ${if def:sender_ident {from $sender_ident}}
10598 .endd
10599 Note that the variable name is given without a leading &%$%& character. If the
10600 variable does not exist, the expansion fails.
10601
10602 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10603         &~&*def:h_*&<&'header&~name'&>&*:*&"
10604 .cindex "expansion" "checking header line existence"
10605 This condition is true if a message is being processed and the named header
10606 exists in the message. For example,
10607 .code
10608 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10609 .endd
10610 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10611 the header name must be terminated by a colon if white space does not follow.
10612
10613 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10614        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10615 .cindex "string" "comparison"
10616 .cindex "expansion" "string comparison"
10617 .cindex "&%eq%& expansion condition"
10618 .cindex "&%eqi%& expansion condition"
10619 The two substrings are first expanded. The condition is true if the two
10620 resulting strings are identical. For &%eq%& the comparison includes the case of
10621 letters, whereas for &%eqi%& the comparison is case-independent.
10622
10623 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10624 .cindex "expansion" "file existence test"
10625 .cindex "file" "existence test"
10626 .cindex "&%exists%&, expansion condition"
10627 The substring is first expanded and then interpreted as an absolute path. The
10628 condition is true if the named file (or directory) exists. The existence test
10629 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10630 users' filter files may be locked out by the system administrator.
10631
10632 .vitem &*first_delivery*&
10633 .cindex "delivery" "first"
10634 .cindex "first delivery"
10635 .cindex "expansion" "first delivery test"
10636 .cindex "&%first_delivery%& expansion condition"
10637 This condition, which has no data, is true during a message's first delivery
10638 attempt. It is false during any subsequent delivery attempts.
10639
10640
10641 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10642        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10643 .cindex "list" "iterative conditions"
10644 .cindex "expansion" "&*forall*& condition"
10645 .cindex "expansion" "&*forany*& condition"
10646 .vindex "&$item$&"
10647 These conditions iterate over a list. The first argument is expanded to form
10648 the list. By default, the list separator is a colon, but it can be changed by
10649 the normal method. The second argument is interpreted as a condition that is to
10650 be applied to each item in the list in turn. During the interpretation of the
10651 condition, the current list item is placed in a variable called &$item$&.
10652 .ilist
10653 For &*forany*&, interpretation stops if the condition is true for any item, and
10654 the result of the whole condition is true. If the condition is false for all
10655 items in the list, the overall condition is false.
10656 .next
10657 For &*forall*&, interpretation stops if the condition is false for any item,
10658 and the result of the whole condition is false. If the condition is true for
10659 all items in the list, the overall condition is true.
10660 .endlist
10661 Note that negation of &*forany*& means that the condition must be false for all
10662 items for the overall condition to succeed, and negation of &*forall*& means
10663 that the condition must be false for at least one item. In this example, the
10664 list separator is changed to a comma:
10665 .code
10666 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10667 .endd
10668 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10669 being processed, to enable these expansion items to be nested.
10670
10671 To scan a named list, expand it with the &*listnamed*& operator.
10672
10673
10674 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10675        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10676 .cindex "string" "comparison"
10677 .cindex "expansion" "string comparison"
10678 .cindex "&%ge%& expansion condition"
10679 .cindex "&%gei%& expansion condition"
10680 The two substrings are first expanded. The condition is true if the first
10681 string is lexically greater than or equal to the second string. For &%ge%& the
10682 comparison includes the case of letters, whereas for &%gei%& the comparison is
10683 case-independent.
10684
10685 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10686        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10687 .cindex "string" "comparison"
10688 .cindex "expansion" "string comparison"
10689 .cindex "&%gt%& expansion condition"
10690 .cindex "&%gti%& expansion condition"
10691 The two substrings are first expanded. The condition is true if the first
10692 string is lexically greater than the second string. For &%gt%& the comparison
10693 includes the case of letters, whereas for &%gti%& the comparison is
10694 case-independent.
10695
10696 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10697        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10698 .cindex "string" "comparison"
10699 .cindex "list" "iterative conditions"
10700 Both strings are expanded; the second string is treated as a list of simple
10701 strings; if the first string is a member of the second, then the condition
10702 is true.
10703
10704 These are simpler to use versions of the more powerful &*forany*& condition.
10705 Examples, and the &*forany*& equivalents:
10706 .code
10707 ${if inlist{needle}{foo:needle:bar}}
10708   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
10709 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
10710   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
10711 .endd
10712
10713 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
10714        &*isip4&~{*&<&'string'&>&*}*& &&&
10715        &*isip6&~{*&<&'string'&>&*}*&
10716 .cindex "IP address" "testing string format"
10717 .cindex "string" "testing for IP address"
10718 .cindex "&%isip%& expansion condition"
10719 .cindex "&%isip4%& expansion condition"
10720 .cindex "&%isip6%& expansion condition"
10721 The substring is first expanded, and then tested to see if it has the form of
10722 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
10723 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
10724
10725 For an IPv4 address, the test is for four dot-separated components, each of
10726 which consists of from one to three digits. For an IPv6 address, up to eight
10727 colon-separated components are permitted, each containing from one to four
10728 hexadecimal digits. There may be fewer than eight components if an empty
10729 component (adjacent colons) is present. Only one empty component is permitted.
10730
10731 &*Note*&: The checks are just on the form of the address; actual numerical
10732 values are not considered. Thus, for example, 999.999.999.999 passes the IPv4
10733 check. The main use of these tests is to distinguish between IP addresses and
10734 host names, or between IPv4 and IPv6 addresses. For example, you could use
10735 .code
10736 ${if isip4{$sender_host_address}...
10737 .endd
10738 to test which IP version an incoming SMTP connection is using.
10739
10740 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
10741 .cindex "LDAP" "use for authentication"
10742 .cindex "expansion" "LDAP authentication test"
10743 .cindex "&%ldapauth%& expansion condition"
10744 This condition supports user authentication using LDAP. See section
10745 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
10746 queries. For this use, the query must contain a user name and password. The
10747 query itself is not used, and can be empty. The condition is true if the
10748 password is not empty, and the user name and password are accepted by the LDAP
10749 server. An empty password is rejected without calling LDAP because LDAP binds
10750 with an empty password are considered anonymous regardless of the username, and
10751 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
10752 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
10753 this can be used.
10754
10755
10756 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10757        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10758 .cindex "string" "comparison"
10759 .cindex "expansion" "string comparison"
10760 .cindex "&%le%& expansion condition"
10761 .cindex "&%lei%& expansion condition"
10762 The two substrings are first expanded. The condition is true if the first
10763 string is lexically less than or equal to the second string. For &%le%& the
10764 comparison includes the case of letters, whereas for &%lei%& the comparison is
10765 case-independent.
10766
10767 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10768        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10769 .cindex "string" "comparison"
10770 .cindex "expansion" "string comparison"
10771 .cindex "&%lt%& expansion condition"
10772 .cindex "&%lti%& expansion condition"
10773 The two substrings are first expanded. The condition is true if the first
10774 string is lexically less than the second string. For &%lt%& the comparison
10775 includes the case of letters, whereas for &%lti%& the comparison is
10776 case-independent.
10777
10778
10779 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10780 .cindex "expansion" "regular expression comparison"
10781 .cindex "regular expressions" "match in expanded string"
10782 .cindex "&%match%& expansion condition"
10783 The two substrings are first expanded. The second is then treated as a regular
10784 expression and applied to the first. Because of the pre-expansion, if the
10785 regular expression contains dollar, or backslash characters, they must be
10786 escaped. Care must also be taken if the regular expression contains braces
10787 (curly brackets). A closing brace must be escaped so that it is not taken as a
10788 premature termination of <&'string2'&>. The easiest approach is to use the
10789 &`\N`& feature to disable expansion of the regular expression.
10790 For example,
10791 .code
10792 ${if match {$local_part}{\N^\d{3}\N} ...
10793 .endd
10794 If the whole expansion string is in double quotes, further escaping of
10795 backslashes is also required.
10796
10797 The condition is true if the regular expression match succeeds.
10798 The regular expression is not required to begin with a circumflex
10799 metacharacter, but if there is no circumflex, the expression is not anchored,
10800 and it may match anywhere in the subject, not just at the start. If you want
10801 the pattern to match at the end of the subject, you must include the &`$`&
10802 metacharacter at an appropriate point.
10803
10804 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
10805 At the start of an &%if%& expansion the values of the numeric variable
10806 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
10807 succeeds causes them to be reset to the substrings of that condition and they
10808 will have these values during the expansion of the success string. At the end
10809 of the &%if%& expansion, the previous values are restored. After testing a
10810 combination of conditions using &%or%&, the subsequent values of the numeric
10811 variables are those of the condition that succeeded.
10812
10813 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10814 .cindex "&%match_address%& expansion condition"
10815 See &*match_local_part*&.
10816
10817 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10818 .cindex "&%match_domain%& expansion condition"
10819 See &*match_local_part*&.
10820
10821 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10822 .cindex "&%match_ip%& expansion condition"
10823 This condition matches an IP address to a list of IP address patterns. It must
10824 be followed by two argument strings. The first (after expansion) must be an IP
10825 address or an empty string. The second (not expanded) is a restricted host
10826 list that can match only an IP address, not a host name. For example:
10827 .code
10828 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
10829 .endd
10830 The specific types of host list item that are permitted in the list are:
10831
10832 .ilist
10833 An IP address, optionally with a CIDR mask.
10834 .next
10835 A single asterisk, which matches any IP address.
10836 .next
10837 An empty item, which matches only if the IP address is empty. This could be
10838 useful for testing for a locally submitted message or one from specific hosts
10839 in a single test such as
10840 . ==== As this is a nested list, any displays it contains must be indented
10841 . ==== as otherwise they are too far to the left. This comment applies to
10842 . ==== the use of xmlto plus fop. There's no problem when formatting with
10843 . ==== sdop, with or without the extra indent.
10844 .code
10845   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
10846 .endd
10847 where the first item in the list is the empty string.
10848 .next
10849 The item @[] matches any of the local host's interface addresses.
10850 .next
10851 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
10852 even if &`net-`& is not specified. There is never any attempt to turn the IP
10853 address into a host name. The most common type of linear search for
10854 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
10855 masks. For example:
10856 .code
10857   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
10858 .endd
10859 It is of course possible to use other kinds of lookup, and in such a case, you
10860 do need to specify the &`net-`& prefix if you want to specify a specific
10861 address mask, for example:
10862 .code
10863   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
10864 .endd
10865 However, unless you are combining a &%match_ip%& condition with others, it is
10866 just as easy to use the fact that a lookup is itself a condition, and write:
10867 .code
10868   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
10869 .endd
10870 .endlist ilist
10871
10872 Note that <&'string2'&> is not itself subject to string expansion, unless
10873 Exim was built with the EXPAND_LISTMATCH_RHS option.
10874
10875 Consult section &<<SECThoslispatip>>& for further details of these patterns.
10876
10877 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10878 .cindex "domain list" "in expansion condition"
10879 .cindex "address list" "in expansion condition"
10880 .cindex "local part" "list, in expansion condition"
10881 .cindex "&%match_local_part%& expansion condition"
10882 This condition, together with &%match_address%& and &%match_domain%&, make it
10883 possible to test domain, address, and local part lists within expansions. Each
10884 condition requires two arguments: an item and a list to match. A trivial
10885 example is:
10886 .code
10887 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
10888 .endd
10889 In each case, the second argument may contain any of the allowable items for a
10890 list of the appropriate type. Also, because the second argument (after
10891 expansion) is a standard form of list, it is possible to refer to a named list.
10892 Thus, you can use conditions like this:
10893 .code
10894 ${if match_domain{$domain}{+local_domains}{...
10895 .endd
10896 .cindex "&`+caseful`&"
10897 For address lists, the matching starts off caselessly, but the &`+caseful`&
10898 item can be used, as in all address lists, to cause subsequent items to
10899 have their local parts matched casefully. Domains are always matched
10900 caselessly.
10901
10902 Note that <&'string2'&> is not itself subject to string expansion, unless
10903 Exim was built with the EXPAND_LISTMATCH_RHS option.
10904
10905 &*Note*&: Host lists are &'not'& supported in this way. This is because
10906 hosts have two identities: a name and an IP address, and it is not clear
10907 how to specify cleanly how such a test would work. However, IP addresses can be
10908 matched using &%match_ip%&.
10909
10910 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
10911 .cindex "PAM authentication"
10912 .cindex "AUTH" "with PAM"
10913 .cindex "Solaris" "PAM support"
10914 .cindex "expansion" "PAM authentication test"
10915 .cindex "&%pam%& expansion condition"
10916 &'Pluggable Authentication Modules'&
10917 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
10918 available in the latest releases of Solaris and in some GNU/Linux
10919 distributions. The Exim support, which is intended for use in conjunction with
10920 the SMTP AUTH command, is available only if Exim is compiled with
10921 .code
10922 SUPPORT_PAM=yes
10923 .endd
10924 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
10925 in some releases of GNU/Linux &%-ldl%& is also needed.
10926
10927 The argument string is first expanded, and the result must be a
10928 colon-separated list of strings. Leading and trailing white space is ignored.
10929 The PAM module is initialized with the service name &"exim"& and the user name
10930 taken from the first item in the colon-separated data string (<&'string1'&>).
10931 The remaining items in the data string are passed over in response to requests
10932 from the authentication function. In the simple case there will only be one
10933 request, for a password, so the data consists of just two strings.
10934
10935 There can be problems if any of the strings are permitted to contain colon
10936 characters. In the usual way, these have to be doubled to avoid being taken as
10937 separators. If the data is being inserted from a variable, the &%sg%& expansion
10938 item can be used to double any existing colons. For example, the configuration
10939 of a LOGIN authenticator might contain this setting:
10940 .code
10941 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
10942 .endd
10943 For a PLAIN authenticator you could use:
10944 .code
10945 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
10946 .endd
10947 In some operating systems, PAM authentication can be done only from a process
10948 running as root. Since Exim is running as the Exim user when receiving
10949 messages, this means that PAM cannot be used directly in those systems.
10950 A patched version of the &'pam_unix'& module that comes with the
10951 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
10952 The patched module allows one special uid/gid combination, in addition to root,
10953 to authenticate. If you build the patched module to allow the Exim user and
10954 group, PAM can then be used from an Exim authenticator.
10955
10956
10957 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
10958 .cindex "&'pwcheck'& daemon"
10959 .cindex "Cyrus"
10960 .cindex "expansion" "&'pwcheck'& authentication test"
10961 .cindex "&%pwcheck%& expansion condition"
10962 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
10963 This is one way of making it possible for passwords to be checked by a process
10964 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
10965 deprecated. Its replacement is &'saslauthd'& (see below).
10966
10967 The pwcheck support is not included in Exim by default. You need to specify
10968 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
10969 building Exim. For example:
10970 .code
10971 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
10972 .endd
10973 You do not need to install the full Cyrus software suite in order to use
10974 the pwcheck daemon. You can compile and install just the daemon alone
10975 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
10976 access to the &_/var/pwcheck_& directory.
10977
10978 The &%pwcheck%& condition takes one argument, which must be the user name and
10979 password, separated by a colon. For example, in a LOGIN authenticator
10980 configuration, you might have this:
10981 .code
10982 server_condition = ${if pwcheck{$auth1:$auth2}}
10983 .endd
10984 Again, for a PLAIN authenticator configuration, this would be:
10985 .code
10986 server_condition = ${if pwcheck{$auth2:$auth3}}
10987 .endd
10988 .vitem &*queue_running*&
10989 .cindex "queue runner" "detecting when delivering from"
10990 .cindex "expansion" "queue runner test"
10991 .cindex "&%queue_running%& expansion condition"
10992 This condition, which has no data, is true during delivery attempts that are
10993 initiated by queue runner processes, and false otherwise.
10994
10995
10996 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
10997 .cindex "Radius"
10998 .cindex "expansion" "Radius authentication"
10999 .cindex "&%radius%& expansion condition"
11000 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11001 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11002 the Radius client configuration file in order to build Exim with Radius
11003 support.
11004
11005 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11006 library, using the original API. If you are using release 0.4.0 or later of
11007 this library, you need to set
11008 .code
11009 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11010 .endd
11011 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11012 &%libradius%& library that comes with FreeBSD. To do this, set
11013 .code
11014 RADIUS_LIB_TYPE=RADLIB
11015 .endd
11016 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11017 You may also have to supply a suitable setting in EXTRALIBS so that the
11018 Radius library can be found when Exim is linked.
11019
11020 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11021 Radius client library, which calls the Radius server. The condition is true if
11022 the authentication is successful. For example:
11023 .code
11024 server_condition = ${if radius{<arguments>}}
11025 .endd
11026
11027
11028 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11029         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11030 .cindex "&'saslauthd'& daemon"
11031 .cindex "Cyrus"
11032 .cindex "expansion" "&'saslauthd'& authentication test"
11033 .cindex "&%saslauthd%& expansion condition"
11034 This condition supports user authentication using the Cyrus &'saslauthd'&
11035 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11036 Using this daemon is one way of making it possible for passwords to be checked
11037 by a process that is not running as root.
11038
11039 The saslauthd support is not included in Exim by default. You need to specify
11040 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11041 building Exim. For example:
11042 .code
11043 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11044 .endd
11045 You do not need to install the full Cyrus software suite in order to use
11046 the saslauthd daemon. You can compile and install just the daemon alone
11047 from the Cyrus SASL library.
11048
11049 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11050 two are mandatory. For example:
11051 .code
11052 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11053 .endd
11054 The service and the realm are optional (which is why the arguments are enclosed
11055 in their own set of braces). For details of the meaning of the service and
11056 realm, and how to run the daemon, consult the Cyrus documentation.
11057 .endlist vlist
11058
11059
11060
11061 .section "Combining expansion conditions" "SECID84"
11062 .cindex "expansion" "combining conditions"
11063 Several conditions can be tested at once by combining them using the &%and%&
11064 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11065 conditions on their own, and precede their lists of sub-conditions. Each
11066 sub-condition must be enclosed in braces within the overall braces that contain
11067 the list. No repetition of &%if%& is used.
11068
11069
11070 .vlist
11071 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11072 .cindex "&""or""& expansion condition"
11073 .cindex "expansion" "&""or""& of conditions"
11074 The sub-conditions are evaluated from left to right. The condition is true if
11075 any one of the sub-conditions is true.
11076 For example,
11077 .code
11078 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11079 .endd
11080 When a true sub-condition is found, the following ones are parsed but not
11081 evaluated. If there are several &"match"& sub-conditions the values of the
11082 numeric variables afterwards are taken from the first one that succeeds.
11083
11084 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11085 .cindex "&""and""& expansion condition"
11086 .cindex "expansion" "&""and""& of conditions"
11087 The sub-conditions are evaluated from left to right. The condition is true if
11088 all of the sub-conditions are true. If there are several &"match"&
11089 sub-conditions, the values of the numeric variables afterwards are taken from
11090 the last one. When a false sub-condition is found, the following ones are
11091 parsed but not evaluated.
11092 .endlist
11093 .ecindex IIDexpcond
11094
11095
11096
11097
11098 .section "Expansion variables" "SECTexpvar"
11099 .cindex "expansion" "variables, list of"
11100 This section contains an alphabetical list of all the expansion variables. Some
11101 of them are available only when Exim is compiled with specific options such as
11102 support for TLS or the content scanning extension.
11103
11104 .vlist
11105 .vitem "&$0$&, &$1$&, etc"
11106 .cindex "numerical variables (&$1$& &$2$& etc)"
11107 When a &%match%& expansion condition succeeds, these variables contain the
11108 captured substrings identified by the regular expression during subsequent
11109 processing of the success string of the containing &%if%& expansion item.
11110 However, they do not retain their values afterwards; in fact, their previous
11111 values are restored at the end of processing an &%if%& item. The numerical
11112 variables may also be set externally by some other matching process which
11113 precedes the expansion of the string. For example, the commands available in
11114 Exim filter files include an &%if%& command with its own regular expression
11115 matching condition.
11116
11117 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11118 Within an acl condition, expansion condition or expansion item
11119 any arguments are copied to these variables,
11120 any unused variables being made empty.
11121
11122 .vitem "&$acl_c...$&"
11123 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11124 can be given any name that starts with &$acl_c$& and is at least six characters
11125 long, but the sixth character must be either a digit or an underscore. For
11126 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11127 variables persist throughout the lifetime of an SMTP connection. They can be
11128 used to pass information between ACLs and between different invocations of the
11129 same ACL. When a message is received, the values of these variables are saved
11130 with the message, and can be accessed by filters, routers, and transports
11131 during subsequent delivery.
11132
11133 .vitem "&$acl_m...$&"
11134 These variables are like the &$acl_c...$& variables, except that their values
11135 are reset after a message has been received. Thus, if several messages are
11136 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11137 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11138 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11139 message is received, the values of these variables are saved with the message,
11140 and can be accessed by filters, routers, and transports during subsequent
11141 delivery.
11142
11143 .vitem &$acl_narg$&
11144 Within an acl condition, expansion condition or expansion item
11145 this variable has the number of arguments.
11146
11147 .vitem &$acl_verify_message$&
11148 .vindex "&$acl_verify_message$&"
11149 After an address verification has failed, this variable contains the failure
11150 message. It retains its value for use in subsequent modifiers. The message can
11151 be preserved by coding like this:
11152 .code
11153 warn !verify = sender
11154      set acl_m0 = $acl_verify_message
11155 .endd
11156 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11157 &%log_message%& modifiers, to include information about the verification
11158 failure.
11159
11160 .vitem &$address_data$&
11161 .vindex "&$address_data$&"
11162 This variable is set by means of the &%address_data%& option in routers. The
11163 value then remains with the address while it is processed by subsequent routers
11164 and eventually a transport. If the transport is handling multiple addresses,
11165 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11166 for more details. &*Note*&: The contents of &$address_data$& are visible in
11167 user filter files.
11168
11169 If &$address_data$& is set when the routers are called from an ACL to verify
11170 a recipient address, the final value is still in the variable for subsequent
11171 conditions and modifiers of the ACL statement. If routing the address caused it
11172 to be redirected to just one address, the child address is also routed as part
11173 of the verification, and in this case the final value of &$address_data$& is
11174 from the child's routing.
11175
11176 If &$address_data$& is set when the routers are called from an ACL to verify a
11177 sender address, the final value is also preserved, but this time in
11178 &$sender_address_data$&, to distinguish it from data from a recipient
11179 address.
11180
11181 In both cases (recipient and sender verification), the value does not persist
11182 after the end of the current ACL statement. If you want to preserve
11183 these values for longer, you can save them in ACL variables.
11184
11185 .vitem &$address_file$&
11186 .vindex "&$address_file$&"
11187 When, as a result of aliasing, forwarding, or filtering, a message is directed
11188 to a specific file, this variable holds the name of the file when the transport
11189 is running. At other times, the variable is empty. For example, using the
11190 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11191 .code
11192 /home/r2d2/savemail
11193 .endd
11194 then when the &(address_file)& transport is running, &$address_file$&
11195 contains the text string &`/home/r2d2/savemail`&.
11196 .cindex "Sieve filter" "value of &$address_file$&"
11197 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11198 then up to the transport configuration to generate an appropriate absolute path
11199 to the relevant file.
11200
11201 .vitem &$address_pipe$&
11202 .vindex "&$address_pipe$&"
11203 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11204 this variable holds the pipe command when the transport is running.
11205
11206 .vitem "&$auth1$& &-- &$auth3$&"
11207 .vindex "&$auth1$&, &$auth2$&, etc"
11208 These variables are used in SMTP authenticators (see chapters
11209 &<<CHAPplaintext>>&&--&<<CHAPspa>>&). Elsewhere, they are empty.
11210
11211 .vitem &$authenticated_id$&
11212 .cindex "authentication" "id"
11213 .vindex "&$authenticated_id$&"
11214 When a server successfully authenticates a client it may be configured to
11215 preserve some of the authentication information in the variable
11216 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11217 user/password authenticator configuration might preserve the user name for use
11218 in the routers. Note that this is not the same information that is saved in
11219 &$sender_host_authenticated$&.
11220 When a message is submitted locally (that is, not over a TCP connection)
11221 the value of &$authenticated_id$& is normally the login name of the calling
11222 process. However, a trusted user can override this by means of the &%-oMai%&
11223 command line option.
11224
11225 .vitem &$authenticated_fail_id$&
11226 .cindex "authentication" "fail" "id"
11227 .vindex "&$authenticated_fail_id$&"
11228 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11229 will contain the failed authentication id. If more than one authentication
11230 id is attempted, it will contain only the last one. The variable is
11231 available for processing in the ACL's, generally the quit or notquit ACL.
11232 A message to a local recipient could still be accepted without requiring
11233 authentication, which means this variable could also be visible in all of
11234 the ACL's as well.
11235
11236
11237 .vitem &$authenticated_sender$&
11238 .cindex "sender" "authenticated"
11239 .cindex "authentication" "sender"
11240 .cindex "AUTH" "on MAIL command"
11241 .vindex "&$authenticated_sender$&"
11242 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11243 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11244 described in section &<<SECTauthparamail>>&. Unless the data is the string
11245 &"<>"&, it is set as the authenticated sender of the message, and the value is
11246 available during delivery in the &$authenticated_sender$& variable. If the
11247 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11248
11249 .vindex "&$qualify_domain$&"
11250 When a message is submitted locally (that is, not over a TCP connection), the
11251 value of &$authenticated_sender$& is an address constructed from the login
11252 name of the calling process and &$qualify_domain$&, except that a trusted user
11253 can override this by means of the &%-oMas%& command line option.
11254
11255
11256 .vitem &$authentication_failed$&
11257 .cindex "authentication" "failure"
11258 .vindex "&$authentication_failed$&"
11259 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11260 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11261 possible to distinguish between &"did not try to authenticate"&
11262 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11263 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11264 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11265 negative response to an AUTH command, including (for example) an attempt to use
11266 an undefined mechanism.
11267
11268 .vitem &$av_failed$&
11269 .cindex "content scanning" "AV scanner failure"
11270 This variable is available when Exim is compiled with the content-scanning
11271 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11272 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11273 the ACL malware condition.
11274
11275 .vitem &$body_linecount$&
11276 .cindex "message body" "line count"
11277 .cindex "body of message" "line count"
11278 .vindex "&$body_linecount$&"
11279 When a message is being received or delivered, this variable contains the
11280 number of lines in the message's body. See also &$message_linecount$&.
11281
11282 .vitem &$body_zerocount$&
11283 .cindex "message body" "binary zero count"
11284 .cindex "body of message" "binary zero count"
11285 .cindex "binary zero" "in message body"
11286 .vindex "&$body_zerocount$&"
11287 When a message is being received or delivered, this variable contains the
11288 number of binary zero bytes (ASCII NULs) in the message's body.
11289
11290 .vitem &$bounce_recipient$&
11291 .vindex "&$bounce_recipient$&"
11292 This is set to the recipient address of a bounce message while Exim is creating
11293 it. It is useful if a customized bounce message text file is in use (see
11294 chapter &<<CHAPemsgcust>>&).
11295
11296 .vitem &$bounce_return_size_limit$&
11297 .vindex "&$bounce_return_size_limit$&"
11298 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11299 up to a multiple of 1000. It is useful when a customized error message text
11300 file is in use (see chapter &<<CHAPemsgcust>>&).
11301
11302 .vitem &$caller_gid$&
11303 .cindex "gid (group id)" "caller"
11304 .vindex "&$caller_gid$&"
11305 The real group id under which the process that called Exim was running. This is
11306 not the same as the group id of the originator of a message (see
11307 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11308 incarnation normally contains the Exim gid.
11309
11310 .vitem &$caller_uid$&
11311 .cindex "uid (user id)" "caller"
11312 .vindex "&$caller_uid$&"
11313 The real user id under which the process that called Exim was running. This is
11314 not the same as the user id of the originator of a message (see
11315 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11316 incarnation normally contains the Exim uid.
11317
11318 .vitem &$compile_date$&
11319 .vindex "&$compile_date$&"
11320 The date on which the Exim binary was compiled.
11321
11322 .vitem &$compile_number$&
11323 .vindex "&$compile_number$&"
11324 The building process for Exim keeps a count of the number
11325 of times it has been compiled. This serves to distinguish different
11326 compilations of the same version of the program.
11327
11328 .new
11329 .vitem &$config_dir$&
11330 .vindex "&$config_dir$&"
11331 The directory name of the main configuration file. That is, the content of
11332 &$config_file$& with the last component stripped. The value does not
11333 contain the trailing slash. If &$config_file$& does not contain a slash,
11334 &$config_dir$& is ".".
11335
11336 .vitem &$config_file$&
11337 .vindex "&$config_file$&"
11338 The name of the main configuration file Exim is using.
11339 .wen
11340
11341 .vitem &$demime_errorlevel$&
11342 .vindex "&$demime_errorlevel$&"
11343 This variable is available when Exim is compiled with
11344 the content-scanning extension and the obsolete &%demime%& condition. For
11345 details, see section &<<SECTdemimecond>>&.
11346
11347 .vitem &$demime_reason$&
11348 .vindex "&$demime_reason$&"
11349 This variable is available when Exim is compiled with the
11350 content-scanning extension and the obsolete &%demime%& condition. For details,
11351 see section &<<SECTdemimecond>>&.
11352
11353 .vitem &$dkim_cur_signer$& &&&
11354        &$dkim_verify_status$& &&&
11355        &$dkim_verify_reason$& &&&
11356        &$dkim_domain$& &&&
11357        &$dkim_identity$& &&&
11358        &$dkim_selector$& &&&
11359        &$dkim_algo$& &&&
11360        &$dkim_canon_body$& &&&
11361        &$dkim_canon_headers$& &&&
11362        &$dkim_copiedheaders$& &&&
11363        &$dkim_bodylength$& &&&
11364        &$dkim_created$& &&&
11365        &$dkim_expires$& &&&
11366        &$dkim_headernames$& &&&
11367        &$dkim_key_testing$& &&&
11368        &$dkim_key_nosubdomains$& &&&
11369        &$dkim_key_srvtype$& &&&
11370        &$dkim_key_granularity$& &&&
11371        &$dkim_key_notes$&
11372 These variables are only available within the DKIM ACL.
11373 For details see chapter &<<CHAPdkim>>&.
11374
11375 .vitem &$dkim_signers$&
11376 .vindex &$dkim_signers$&
11377 When a message has been received this variable contains
11378 a colon-separated list of signer domains and identities for the message.
11379 For details see chapter &<<CHAPdkim>>&.
11380
11381 .vitem &$dnslist_domain$& &&&
11382        &$dnslist_matched$& &&&
11383        &$dnslist_text$& &&&
11384        &$dnslist_value$&
11385 .vindex "&$dnslist_domain$&"
11386 .vindex "&$dnslist_matched$&"
11387 .vindex "&$dnslist_text$&"
11388 .vindex "&$dnslist_value$&"
11389 .cindex "black list (DNS)"
11390 When a DNS (black) list lookup succeeds, these variables are set to contain
11391 the following data from the lookup: the list's domain name, the key that was
11392 looked up, the contents of any associated TXT record, and the value from the
11393 main A record. See section &<<SECID204>>& for more details.
11394
11395 .vitem &$domain$&
11396 .vindex "&$domain$&"
11397 When an address is being routed, or delivered on its own, this variable
11398 contains the domain. Uppercase letters in the domain are converted into lower
11399 case for &$domain$&.
11400
11401 Global address rewriting happens when a message is received, so the value of
11402 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11403 is set during user filtering, but not during system filtering, because a
11404 message may have many recipients and the system filter is called just once.
11405
11406 When more than one address is being delivered at once (for example, several
11407 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11408 have the same domain. Transports can be restricted to handling only one domain
11409 at a time if the value of &$domain$& is required at transport time &-- this is
11410 the default for local transports. For further details of the environment in
11411 which local transports are run, see chapter &<<CHAPenvironment>>&.
11412
11413 .oindex "&%delay_warning_condition%&"
11414 At the end of a delivery, if all deferred addresses have the same domain, it is
11415 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11416
11417 The &$domain$& variable is also used in some other circumstances:
11418
11419 .ilist
11420 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11421 the recipient address. The domain of the &'sender'& address is in
11422 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11423 normally set during the running of the MAIL ACL. However, if the sender address
11424 is verified with a callout during the MAIL ACL, the sender domain is placed in
11425 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11426 the &(smtp)& transport.
11427
11428 .next
11429 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11430 &$domain$& contains the domain portion of the address that is being rewritten;
11431 it can be used in the expansion of the replacement address, for example, to
11432 rewrite domains by file lookup.
11433
11434 .next
11435 With one important exception, whenever a domain list is being scanned,
11436 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11437 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11438 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11439 that, in a RCPT ACL, the sender domain list can be dependent on the
11440 recipient domain (which is what is in &$domain$& at this time).
11441
11442 .next
11443 .cindex "ETRN" "value of &$domain$&"
11444 .oindex "&%smtp_etrn_command%&"
11445 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11446 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11447 .endlist
11448
11449
11450 .vitem &$domain_data$&
11451 .vindex "&$domain_data$&"
11452 When the &%domains%& option on a router matches a domain by
11453 means of a lookup, the data read by the lookup is available during the running
11454 of the router as &$domain_data$&. In addition, if the driver routes the
11455 address to a transport, the value is available in that transport. If the
11456 transport is handling multiple addresses, the value from the first address is
11457 used.
11458
11459 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11460 domain by means of a lookup. The data read by the lookup is available during
11461 the rest of the ACL statement. In all other situations, this variable expands
11462 to nothing.
11463
11464 .vitem &$exim_gid$&
11465 .vindex "&$exim_gid$&"
11466 This variable contains the numerical value of the Exim group id.
11467
11468 .vitem &$exim_path$&
11469 .vindex "&$exim_path$&"
11470 This variable contains the path to the Exim binary.
11471
11472 .vitem &$exim_uid$&
11473 .vindex "&$exim_uid$&"
11474 This variable contains the numerical value of the Exim user id.
11475
11476 .new
11477 .vitem &$exim_version$&
11478 .vindex "&$exim_version$&"
11479 This variable contains the version string of the Exim build.
11480 The first character is a major version number, currently 4.
11481 Then after a dot, the next group of digits is a minor version number.
11482 There may be other characters following the minor version.
11483 .wen
11484
11485 .vitem &$found_extension$&
11486 .vindex "&$found_extension$&"
11487 This variable is available when Exim is compiled with the
11488 content-scanning extension and the obsolete &%demime%& condition. For details,
11489 see section &<<SECTdemimecond>>&.
11490
11491 .vitem &$header_$&<&'name'&>
11492 This is not strictly an expansion variable. It is expansion syntax for
11493 inserting the message header line with the given name. Note that the name must
11494 be terminated by colon or white space, because it may contain a wide variety of
11495 characters. Note also that braces must &'not'& be used.
11496
11497 .vitem &$headers_added$&
11498 .vindex "&$headers_added$&"
11499 Within an ACL this variable contains the headers added so far by
11500 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11501 The headers are a newline-separated list.
11502
11503 .vitem &$home$&
11504 .vindex "&$home$&"
11505 When the &%check_local_user%& option is set for a router, the user's home
11506 directory is placed in &$home$& when the check succeeds. In particular, this
11507 means it is set during the running of users' filter files. A router may also
11508 explicitly set a home directory for use by a transport; this can be overridden
11509 by a setting on the transport itself.
11510
11511 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11512 of the environment variable HOME.
11513
11514 .vitem &$host$&
11515 .vindex "&$host$&"
11516 If a router assigns an address to a transport (any transport), and passes a
11517 list of hosts with the address, the value of &$host$& when the transport starts
11518 to run is the name of the first host on the list. Note that this applies both
11519 to local and remote transports.
11520
11521 .cindex "transport" "filter"
11522 .cindex "filter" "transport filter"
11523 For the &(smtp)& transport, if there is more than one host, the value of
11524 &$host$& changes as the transport works its way through the list. In
11525 particular, when the &(smtp)& transport is expanding its options for encryption
11526 using TLS, or for specifying a transport filter (see chapter
11527 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11528 is connected.
11529
11530 When used in the client part of an authenticator configuration (see chapter
11531 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11532 client is connected.
11533
11534
11535 .vitem &$host_address$&
11536 .vindex "&$host_address$&"
11537 This variable is set to the remote host's IP address whenever &$host$& is set
11538 for a remote connection. It is also set to the IP address that is being checked
11539 when the &%ignore_target_hosts%& option is being processed.
11540
11541 .vitem &$host_data$&
11542 .vindex "&$host_data$&"
11543 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11544 result of the lookup is made available in the &$host_data$& variable. This
11545 allows you, for example, to do things like this:
11546 .code
11547 deny  hosts = net-lsearch;/some/file
11548 message = $host_data
11549 .endd
11550 .vitem &$host_lookup_deferred$&
11551 .cindex "host name" "lookup, failure of"
11552 .vindex "&$host_lookup_deferred$&"
11553 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11554 message comes from a remote host and there is an attempt to look up the host's
11555 name from its IP address, and the attempt is not successful, one of these
11556 variables is set to &"1"&.
11557
11558 .ilist
11559 If the lookup receives a definite negative response (for example, a DNS lookup
11560 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11561
11562 .next
11563 If there is any kind of problem during the lookup, such that Exim cannot
11564 tell whether or not the host name is defined (for example, a timeout for a DNS
11565 lookup), &$host_lookup_deferred$& is set to &"1"&.
11566 .endlist ilist
11567
11568 Looking up a host's name from its IP address consists of more than just a
11569 single reverse lookup. Exim checks that a forward lookup of at least one of the
11570 names it receives from a reverse lookup yields the original IP address. If this
11571 is not the case, Exim does not accept the looked up name(s), and
11572 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11573 IP address (for example, the existence of a PTR record in the DNS) is not
11574 sufficient on its own for the success of a host name lookup. If the reverse
11575 lookup succeeds, but there is a lookup problem such as a timeout when checking
11576 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11577 &"1"&. See also &$sender_host_name$&.
11578
11579 .vitem &$host_lookup_failed$&
11580 .vindex "&$host_lookup_failed$&"
11581 See &$host_lookup_deferred$&.
11582
11583 .vitem &$host_port$&
11584 .vindex "&$host_port$&"
11585 This variable is set to the remote host's TCP port whenever &$host$& is set
11586 for an outbound connection.
11587
11588
11589 .vitem &$inode$&
11590 .vindex "&$inode$&"
11591 The only time this variable is set is while expanding the &%directory_file%&
11592 option in the &(appendfile)& transport. The variable contains the inode number
11593 of the temporary file which is about to be renamed. It can be used to construct
11594 a unique name for the file.
11595
11596 .vitem &$interface_address$&
11597 .vindex "&$interface_address$&"
11598 This is an obsolete name for &$received_ip_address$&.
11599
11600 .vitem &$interface_port$&
11601 .vindex "&$interface_port$&"
11602 This is an obsolete name for &$received_port$&.
11603
11604 .vitem &$item$&
11605 .vindex "&$item$&"
11606 This variable is used during the expansion of &*forall*& and &*forany*&
11607 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11608 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11609 empty.
11610
11611 .vitem &$ldap_dn$&
11612 .vindex "&$ldap_dn$&"
11613 This variable, which is available only when Exim is compiled with LDAP support,
11614 contains the DN from the last entry in the most recently successful LDAP
11615 lookup.
11616
11617 .vitem &$load_average$&
11618 .vindex "&$load_average$&"
11619 This variable contains the system load average, multiplied by 1000 so that it
11620 is an integer. For example, if the load average is 0.21, the value of the
11621 variable is 210. The value is recomputed every time the variable is referenced.
11622
11623 .vitem &$local_part$&
11624 .vindex "&$local_part$&"
11625 When an address is being routed, or delivered on its own, this
11626 variable contains the local part. When a number of addresses are being
11627 delivered together (for example, multiple RCPT commands in an SMTP
11628 session), &$local_part$& is not set.
11629
11630 Global address rewriting happens when a message is received, so the value of
11631 &$local_part$& during routing and delivery is the value after rewriting.
11632 &$local_part$& is set during user filtering, but not during system filtering,
11633 because a message may have many recipients and the system filter is called just
11634 once.
11635
11636 .vindex "&$local_part_prefix$&"
11637 .vindex "&$local_part_suffix$&"
11638 If a local part prefix or suffix has been recognized, it is not included in the
11639 value of &$local_part$& during routing and subsequent delivery. The values of
11640 any prefix or suffix are in &$local_part_prefix$& and
11641 &$local_part_suffix$&, respectively.
11642
11643 When a message is being delivered to a file, pipe, or autoreply transport as a
11644 result of aliasing or forwarding, &$local_part$& is set to the local part of
11645 the parent address, not to the file name or command (see &$address_file$& and
11646 &$address_pipe$&).
11647
11648 When an ACL is running for a RCPT command, &$local_part$& contains the
11649 local part of the recipient address.
11650
11651 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11652 &$local_part$& contains the local part of the address that is being rewritten;
11653 it can be used in the expansion of the replacement address, for example.
11654
11655 In all cases, all quoting is removed from the local part. For example, for both
11656 the addresses
11657 .code
11658 "abc:xyz"@test.example
11659 abc\:xyz@test.example
11660 .endd
11661 the value of &$local_part$& is
11662 .code
11663 abc:xyz
11664 .endd
11665 If you use &$local_part$& to create another address, you should always wrap it
11666 inside a quoting operator. For example, in a &(redirect)& router you could
11667 have:
11668 .code
11669 data = ${quote_local_part:$local_part}@new.domain.example
11670 .endd
11671 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11672 to process local parts in a case-dependent manner in a router, you can set the
11673 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11674
11675 .vitem &$local_part_data$&
11676 .vindex "&$local_part_data$&"
11677 When the &%local_parts%& option on a router matches a local part by means of a
11678 lookup, the data read by the lookup is available during the running of the
11679 router as &$local_part_data$&. In addition, if the driver routes the address
11680 to a transport, the value is available in that transport. If the transport is
11681 handling multiple addresses, the value from the first address is used.
11682
11683 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11684 matches a local part by means of a lookup. The data read by the lookup is
11685 available during the rest of the ACL statement. In all other situations, this
11686 variable expands to nothing.
11687
11688 .vitem &$local_part_prefix$&
11689 .vindex "&$local_part_prefix$&"
11690 When an address is being routed or delivered, and a
11691 specific prefix for the local part was recognized, it is available in this
11692 variable, having been removed from &$local_part$&.
11693
11694 .vitem &$local_part_suffix$&
11695 .vindex "&$local_part_suffix$&"
11696 When an address is being routed or delivered, and a
11697 specific suffix for the local part was recognized, it is available in this
11698 variable, having been removed from &$local_part$&.
11699
11700 .vitem &$local_scan_data$&
11701 .vindex "&$local_scan_data$&"
11702 This variable contains the text returned by the &[local_scan()]& function when
11703 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
11704
11705 .vitem &$local_user_gid$&
11706 .vindex "&$local_user_gid$&"
11707 See &$local_user_uid$&.
11708
11709 .vitem &$local_user_uid$&
11710 .vindex "&$local_user_uid$&"
11711 This variable and &$local_user_gid$& are set to the uid and gid after the
11712 &%check_local_user%& router precondition succeeds. This means that their values
11713 are available for the remaining preconditions (&%senders%&, &%require_files%&,
11714 and &%condition%&), for the &%address_data%& expansion, and for any
11715 router-specific expansions. At all other times, the values in these variables
11716 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
11717
11718 .vitem &$localhost_number$&
11719 .vindex "&$localhost_number$&"
11720 This contains the expanded value of the
11721 &%localhost_number%& option. The expansion happens after the main options have
11722 been read.
11723
11724 .vitem &$log_inodes$&
11725 .vindex "&$log_inodes$&"
11726 The number of free inodes in the disk partition where Exim's
11727 log files are being written. The value is recalculated whenever the variable is
11728 referenced. If the relevant file system does not have the concept of inodes,
11729 the value of is -1. See also the &%check_log_inodes%& option.
11730
11731 .vitem &$log_space$&
11732 .vindex "&$log_space$&"
11733 The amount of free space (as a number of kilobytes) in the disk
11734 partition where Exim's log files are being written. The value is recalculated
11735 whenever the variable is referenced. If the operating system does not have the
11736 ability to find the amount of free space (only true for experimental systems),
11737 the space value is -1. See also the &%check_log_space%& option.
11738
11739
11740 .vitem &$lookup_dnssec_authenticated$&
11741 .vindex "&$lookup_dnssec_authenticated$&"
11742 This variable is set after a DNS lookup done by
11743 a dnsdb lookup expansion, dnslookup router or smtp transport.
11744 .cindex "DNS" "DNSSEC"
11745 It will be empty if &(DNSSEC)& was not requested,
11746 &"no"& if the result was not labelled as authenticated data
11747 and &"yes"& if it was.
11748 Results that are labelled as authoritive answer that match
11749 the $%dns_trust_aa%$ configuration variable count also
11750 as authenticated data.
11751
11752 .vitem &$mailstore_basename$&
11753 .vindex "&$mailstore_basename$&"
11754 This variable is set only when doing deliveries in &"mailstore"& format in the
11755 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
11756 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
11757 contains the basename of the files that are being written, that is, the name
11758 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
11759 variable is empty.
11760
11761 .vitem &$malware_name$&
11762 .vindex "&$malware_name$&"
11763 This variable is available when Exim is compiled with the
11764 content-scanning extension. It is set to the name of the virus that was found
11765 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
11766
11767 .vitem &$max_received_linelength$&
11768 .vindex "&$max_received_linelength$&"
11769 .cindex "maximum" "line length"
11770 .cindex "line length" "maximum"
11771 This variable contains the number of bytes in the longest line that was
11772 received as part of the message, not counting the line termination
11773 character(s).
11774
11775 .vitem &$message_age$&
11776 .cindex "message" "age of"
11777 .vindex "&$message_age$&"
11778 This variable is set at the start of a delivery attempt to contain the number
11779 of seconds since the message was received. It does not change during a single
11780 delivery attempt.
11781
11782 .vitem &$message_body$&
11783 .cindex "body of message" "expansion variable"
11784 .cindex "message body" "in expansion"
11785 .cindex "binary zero" "in message body"
11786 .vindex "&$message_body$&"
11787 .oindex "&%message_body_visible%&"
11788 This variable contains the initial portion of a message's body while it is
11789 being delivered, and is intended mainly for use in filter files. The maximum
11790 number of characters of the body that are put into the variable is set by the
11791 &%message_body_visible%& configuration option; the default is 500.
11792
11793 .oindex "&%message_body_newlines%&"
11794 By default, newlines are converted into spaces in &$message_body$&, to make it
11795 easier to search for phrases that might be split over a line break. However,
11796 this can be disabled by setting &%message_body_newlines%& to be true. Binary
11797 zeros are always converted into spaces.
11798
11799 .vitem &$message_body_end$&
11800 .cindex "body of message" "expansion variable"
11801 .cindex "message body" "in expansion"
11802 .vindex "&$message_body_end$&"
11803 This variable contains the final portion of a message's
11804 body while it is being delivered. The format and maximum size are as for
11805 &$message_body$&.
11806
11807 .vitem &$message_body_size$&
11808 .cindex "body of message" "size"
11809 .cindex "message body" "size"
11810 .vindex "&$message_body_size$&"
11811 When a message is being delivered, this variable contains the size of the body
11812 in bytes. The count starts from the character after the blank line that
11813 separates the body from the header. Newlines are included in the count. See
11814 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
11815
11816 .vitem &$message_exim_id$&
11817 .vindex "&$message_exim_id$&"
11818 When a message is being received or delivered, this variable contains the
11819 unique message id that is generated and used by Exim to identify the message.
11820 An id is not created for a message until after its header has been successfully
11821 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
11822 line; it is the local id that Exim assigns to the message, for example:
11823 &`1BXTIK-0001yO-VA`&.
11824
11825 .vitem &$message_headers$&
11826 .vindex &$message_headers$&
11827 This variable contains a concatenation of all the header lines when a message
11828 is being processed, except for lines added by routers or transports. The header
11829 lines are separated by newline characters. Their contents are decoded in the
11830 same way as a header line that is inserted by &%bheader%&.
11831
11832 .vitem &$message_headers_raw$&
11833 .vindex &$message_headers_raw$&
11834 This variable is like &$message_headers$& except that no processing of the
11835 contents of header lines is done.
11836
11837 .vitem &$message_id$&
11838 This is an old name for &$message_exim_id$&. It is now deprecated.
11839
11840 .vitem &$message_linecount$&
11841 .vindex "&$message_linecount$&"
11842 This variable contains the total number of lines in the header and body of the
11843 message. Compare &$body_linecount$&, which is the count for the body only.
11844 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
11845 number of lines received. Before delivery happens (that is, before filters,
11846 routers, and transports run) the count is increased to include the
11847 &'Received:'& header line that Exim standardly adds, and also any other header
11848 lines that are added by ACLs. The blank line that separates the message header
11849 from the body is not counted.
11850
11851 As with the special case of &$message_size$&, during the expansion of the
11852 appendfile transport's maildir_tag option in maildir format, the value of
11853 &$message_linecount$& is the precise size of the number of newlines in the
11854 file that has been written (minus one for the blank line between the
11855 header and the body).
11856
11857 Here is an example of the use of this variable in a DATA ACL:
11858 .code
11859 deny message   = Too many lines in message header
11860      condition = \
11861       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
11862 .endd
11863 In the MAIL and RCPT ACLs, the value is zero because at that stage the
11864 message has not yet been received.
11865
11866 .vitem &$message_size$&
11867 .cindex "size" "of message"
11868 .cindex "message" "size"
11869 .vindex "&$message_size$&"
11870 When a message is being processed, this variable contains its size in bytes. In
11871 most cases, the size includes those headers that were received with the
11872 message, but not those (such as &'Envelope-to:'&) that are added to individual
11873 deliveries as they are written. However, there is one special case: during the
11874 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
11875 doing a delivery in maildir format, the value of &$message_size$& is the
11876 precise size of the file that has been written. See also
11877 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
11878
11879 .cindex "RCPT" "value of &$message_size$&"
11880 While running a per message ACL (mail/rcpt/predata), &$message_size$&
11881 contains the size supplied on the MAIL command, or -1 if no size was given. The
11882 value may not, of course, be truthful.
11883
11884 .vitem &$mime_$&&'xxx'&
11885 A number of variables whose names start with &$mime$& are
11886 available when Exim is compiled with the content-scanning extension. For
11887 details, see section &<<SECTscanmimepart>>&.
11888
11889 .vitem "&$n0$& &-- &$n9$&"
11890 These variables are counters that can be incremented by means
11891 of the &%add%& command in filter files.
11892
11893 .vitem &$original_domain$&
11894 .vindex "&$domain$&"
11895 .vindex "&$original_domain$&"
11896 When a top-level address is being processed for delivery, this contains the
11897 same value as &$domain$&. However, if a &"child"& address (for example,
11898 generated by an alias, forward, or filter file) is being processed, this
11899 variable contains the domain of the original address (lower cased). This
11900 differs from &$parent_domain$& only when there is more than one level of
11901 aliasing or forwarding. When more than one address is being delivered in a
11902 single transport run, &$original_domain$& is not set.
11903
11904 If a new address is created by means of a &%deliver%& command in a system
11905 filter, it is set up with an artificial &"parent"& address. This has the local
11906 part &'system-filter'& and the default qualify domain.
11907
11908 .vitem &$original_local_part$&
11909 .vindex "&$local_part$&"
11910 .vindex "&$original_local_part$&"
11911 When a top-level address is being processed for delivery, this contains the
11912 same value as &$local_part$&, unless a prefix or suffix was removed from the
11913 local part, because &$original_local_part$& always contains the full local
11914 part. When a &"child"& address (for example, generated by an alias, forward, or
11915 filter file) is being processed, this variable contains the full local part of
11916 the original address.
11917
11918 If the router that did the redirection processed the local part
11919 case-insensitively, the value in &$original_local_part$& is in lower case.
11920 This variable differs from &$parent_local_part$& only when there is more than
11921 one level of aliasing or forwarding. When more than one address is being
11922 delivered in a single transport run, &$original_local_part$& is not set.
11923
11924 If a new address is created by means of a &%deliver%& command in a system
11925 filter, it is set up with an artificial &"parent"& address. This has the local
11926 part &'system-filter'& and the default qualify domain.
11927
11928 .vitem &$originator_gid$&
11929 .cindex "gid (group id)" "of originating user"
11930 .cindex "sender" "gid"
11931 .vindex "&$caller_gid$&"
11932 .vindex "&$originator_gid$&"
11933 This variable contains the value of &$caller_gid$& that was set when the
11934 message was received. For messages received via the command line, this is the
11935 gid of the sending user. For messages received by SMTP over TCP/IP, this is
11936 normally the gid of the Exim user.
11937
11938 .vitem &$originator_uid$&
11939 .cindex "uid (user id)" "of originating user"
11940 .cindex "sender" "uid"
11941 .vindex "&$caller_uid$&"
11942 .vindex "&$originaltor_uid$&"
11943 The value of &$caller_uid$& that was set when the message was received. For
11944 messages received via the command line, this is the uid of the sending user.
11945 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
11946 user.
11947
11948 .vitem &$parent_domain$&
11949 .vindex "&$parent_domain$&"
11950 This variable is similar to &$original_domain$& (see
11951 above), except that it refers to the immediately preceding parent address.
11952
11953 .vitem &$parent_local_part$&
11954 .vindex "&$parent_local_part$&"
11955 This variable is similar to &$original_local_part$&
11956 (see above), except that it refers to the immediately preceding parent address.
11957
11958 .vitem &$pid$&
11959 .cindex "pid (process id)" "of current process"
11960 .vindex "&$pid$&"
11961 This variable contains the current process id.
11962
11963 .vitem &$pipe_addresses$&
11964 .cindex "filter" "transport filter"
11965 .cindex "transport" "filter"
11966 .vindex "&$pipe_addresses$&"
11967 This is not an expansion variable, but is mentioned here because the string
11968 &`$pipe_addresses`& is handled specially in the command specification for the
11969 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
11970 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
11971 It cannot be used in general expansion strings, and provokes an &"unknown
11972 variable"& error if encountered.
11973
11974 .vitem &$primary_hostname$&
11975 .vindex "&$primary_hostname$&"
11976 This variable contains the value set by &%primary_hostname%& in the
11977 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
11978 a single-component name, Exim calls &[gethostbyname()]& (or
11979 &[getipnodebyname()]& where available) in an attempt to acquire a fully
11980 qualified host name. See also &$smtp_active_hostname$&.
11981
11982
11983 .vitem &$prvscheck_address$&
11984 This variable is used in conjunction with the &%prvscheck%& expansion item,
11985 which is described in sections &<<SECTexpansionitems>>& and
11986 &<<SECTverifyPRVS>>&.
11987
11988 .vitem &$prvscheck_keynum$&
11989 This variable is used in conjunction with the &%prvscheck%& expansion item,
11990 which is described in sections &<<SECTexpansionitems>>& and
11991 &<<SECTverifyPRVS>>&.
11992
11993 .vitem &$prvscheck_result$&
11994 This variable is used in conjunction with the &%prvscheck%& expansion item,
11995 which is described in sections &<<SECTexpansionitems>>& and
11996 &<<SECTverifyPRVS>>&.
11997
11998 .vitem &$qualify_domain$&
11999 .vindex "&$qualify_domain$&"
12000 The value set for the &%qualify_domain%& option in the configuration file.
12001
12002 .vitem &$qualify_recipient$&
12003 .vindex "&$qualify_recipient$&"
12004 The value set for the &%qualify_recipient%& option in the configuration file,
12005 or if not set, the value of &$qualify_domain$&.
12006
12007 .vitem &$rcpt_count$&
12008 .vindex "&$rcpt_count$&"
12009 When a message is being received by SMTP, this variable contains the number of
12010 RCPT commands received for the current message. If this variable is used in a
12011 RCPT ACL, its value includes the current command.
12012
12013 .vitem &$rcpt_defer_count$&
12014 .vindex "&$rcpt_defer_count$&"
12015 .cindex "4&'xx'& responses" "count of"
12016 When a message is being received by SMTP, this variable contains the number of
12017 RCPT commands in the current message that have previously been rejected with a
12018 temporary (4&'xx'&) response.
12019
12020 .vitem &$rcpt_fail_count$&
12021 .vindex "&$rcpt_fail_count$&"
12022 When a message is being received by SMTP, this variable contains the number of
12023 RCPT commands in the current message that have previously been rejected with a
12024 permanent (5&'xx'&) response.
12025
12026 .vitem &$received_count$&
12027 .vindex "&$received_count$&"
12028 This variable contains the number of &'Received:'& header lines in the message,
12029 including the one added by Exim (so its value is always greater than zero). It
12030 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12031 delivering.
12032
12033 .vitem &$received_for$&
12034 .vindex "&$received_for$&"
12035 If there is only a single recipient address in an incoming message, this
12036 variable contains that address when the &'Received:'& header line is being
12037 built. The value is copied after recipient rewriting has happened, but before
12038 the &[local_scan()]& function is run.
12039
12040 .vitem &$received_ip_address$&
12041 .vindex "&$received_ip_address$&"
12042 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12043 variable is set to the address of the local IP interface, and &$received_port$&
12044 is set to the local port number. (The remote IP address and port are in
12045 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12046 the port value is -1 unless it has been set using the &%-oMi%& command line
12047 option.
12048
12049 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12050 could be used, for example, to make the file name for a TLS certificate depend
12051 on which interface and/or port is being used for the incoming connection. The
12052 values of &$received_ip_address$& and &$received_port$& are saved with any
12053 messages that are received, thus making these variables available at delivery
12054 time.
12055 For outbound connections see &$sending_ip_address$&.
12056
12057 .vitem &$received_port$&
12058 .vindex "&$received_port$&"
12059 See &$received_ip_address$&.
12060
12061 .vitem &$received_protocol$&
12062 .vindex "&$received_protocol$&"
12063 When a message is being processed, this variable contains the name of the
12064 protocol by which it was received. Most of the names used by Exim are defined
12065 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12066 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12067 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12068 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12069 connection and the client was successfully authenticated.
12070
12071 Exim uses the protocol name &"smtps"& for the case when encryption is
12072 automatically set up on connection without the use of STARTTLS (see
12073 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12074 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12075 where the client initially uses EHLO, sets up an encrypted connection using
12076 STARTTLS, and then uses HELO afterwards.
12077
12078 The &%-oMr%& option provides a way of specifying a custom protocol name for
12079 messages that are injected locally by trusted callers. This is commonly used to
12080 identify messages that are being re-injected after some kind of scanning.
12081
12082 .vitem &$received_time$&
12083 .vindex "&$received_time$&"
12084 This variable contains the date and time when the current message was received,
12085 as a number of seconds since the start of the Unix epoch.
12086
12087 .vitem &$recipient_data$&
12088 .vindex "&$recipient_data$&"
12089 This variable is set after an indexing lookup success in an ACL &%recipients%&
12090 condition. It contains the data from the lookup, and the value remains set
12091 until the next &%recipients%& test. Thus, you can do things like this:
12092 .display
12093 &`require recipients  = cdb*@;/some/file`&
12094 &`deny    `&&'some further test involving'& &`$recipient_data`&
12095 .endd
12096 &*Warning*&: This variable is set only when a lookup is used as an indexing
12097 method in the address list, using the semicolon syntax as in the example above.
12098 The variable is not set for a lookup that is used as part of the string
12099 expansion that all such lists undergo before being interpreted.
12100
12101 .vitem &$recipient_verify_failure$&
12102 .vindex "&$recipient_verify_failure$&"
12103 In an ACL, when a recipient verification fails, this variable contains
12104 information about the failure. It is set to one of the following words:
12105
12106 .ilist
12107 &"qualify"&: The address was unqualified (no domain), and the message
12108 was neither local nor came from an exempted host.
12109
12110 .next
12111 &"route"&: Routing failed.
12112
12113 .next
12114 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12115 or before the MAIL command (that is, on initial connection, HELO, or
12116 MAIL).
12117
12118 .next
12119 &"recipient"&: The RCPT command in a callout was rejected.
12120 .next
12121
12122 &"postmaster"&: The postmaster check in a callout was rejected.
12123 .endlist
12124
12125 The main use of this variable is expected to be to distinguish between
12126 rejections of MAIL and rejections of RCPT.
12127
12128 .vitem &$recipients$&
12129 .vindex "&$recipients$&"
12130 This variable contains a list of envelope recipients for a message. A comma and
12131 a space separate the addresses in the replacement text. However, the variable
12132 is not generally available, to prevent exposure of Bcc recipients in
12133 unprivileged users' filter files. You can use &$recipients$& only in these
12134 cases:
12135
12136 .olist
12137 In a system filter file.
12138 .next
12139 In the ACLs associated with the DATA command and with non-SMTP messages, that
12140 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12141 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12142 &%acl_not_smtp_mime%&.
12143 .next
12144 From within a &[local_scan()]& function.
12145 .endlist
12146
12147
12148 .vitem &$recipients_count$&
12149 .vindex "&$recipients_count$&"
12150 When a message is being processed, this variable contains the number of
12151 envelope recipients that came with the message. Duplicates are not excluded
12152 from the count. While a message is being received over SMTP, the number
12153 increases for each accepted recipient. It can be referenced in an ACL.
12154
12155
12156 .vitem &$regex_match_string$&
12157 .vindex "&$regex_match_string$&"
12158 This variable is set to contain the matching regular expression after a
12159 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12160
12161
12162 .vitem &$reply_address$&
12163 .vindex "&$reply_address$&"
12164 When a message is being processed, this variable contains the contents of the
12165 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12166 contents of the &'From:'& header line. Apart from the removal of leading
12167 white space, the value is not processed in any way. In particular, no RFC 2047
12168 decoding or character code translation takes place.
12169
12170 .vitem &$return_path$&
12171 .vindex "&$return_path$&"
12172 When a message is being delivered, this variable contains the return path &--
12173 the sender field that will be sent as part of the envelope. It is not enclosed
12174 in <> characters. At the start of routing an address, &$return_path$& has the
12175 same value as &$sender_address$&, but if, for example, an incoming message to a
12176 mailing list has been expanded by a router which specifies a different address
12177 for bounce messages, &$return_path$& subsequently contains the new bounce
12178 address, whereas &$sender_address$& always contains the original sender address
12179 that was received with the message. In other words, &$sender_address$& contains
12180 the incoming envelope sender, and &$return_path$& contains the outgoing
12181 envelope sender.
12182
12183 .vitem &$return_size_limit$&
12184 .vindex "&$return_size_limit$&"
12185 This is an obsolete name for &$bounce_return_size_limit$&.
12186
12187 .vitem &$router_name$&
12188 .cindex "router" "name"
12189 .cindex "name" "of router"
12190 .vindex "&$router_name$&"
12191 During the running of a router this variable contains its name.
12192
12193 .vitem &$runrc$&
12194 .cindex "return code" "from &%run%& expansion"
12195 .vindex "&$runrc$&"
12196 This variable contains the return code from a command that is run by the
12197 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12198 assume the order in which option values are expanded, except for those
12199 preconditions whose order of testing is documented. Therefore, you cannot
12200 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12201 another.
12202
12203 .vitem &$self_hostname$&
12204 .oindex "&%self%&" "value of host name"
12205 .vindex "&$self_hostname$&"
12206 When an address is routed to a supposedly remote host that turns out to be the
12207 local host, what happens is controlled by the &%self%& generic router option.
12208 One of its values causes the address to be passed to another router. When this
12209 happens, &$self_hostname$& is set to the name of the local host that the
12210 original router encountered. In other circumstances its contents are null.
12211
12212 .vitem &$sender_address$&
12213 .vindex "&$sender_address$&"
12214 When a message is being processed, this variable contains the sender's address
12215 that was received in the message's envelope. The case of letters in the address
12216 is retained, in both the local part and the domain. For bounce messages, the
12217 value of this variable is the empty string. See also &$return_path$&.
12218
12219 .vitem &$sender_address_data$&
12220 .vindex "&$address_data$&"
12221 .vindex "&$sender_address_data$&"
12222 If &$address_data$& is set when the routers are called from an ACL to verify a
12223 sender address, the final value is preserved in &$sender_address_data$&, to
12224 distinguish it from data from a recipient address. The value does not persist
12225 after the end of the current ACL statement. If you want to preserve it for
12226 longer, you can save it in an ACL variable.
12227
12228 .vitem &$sender_address_domain$&
12229 .vindex "&$sender_address_domain$&"
12230 The domain portion of &$sender_address$&.
12231
12232 .vitem &$sender_address_local_part$&
12233 .vindex "&$sender_address_local_part$&"
12234 The local part portion of &$sender_address$&.
12235
12236 .vitem &$sender_data$&
12237 .vindex "&$sender_data$&"
12238 This variable is set after a lookup success in an ACL &%senders%& condition or
12239 in a router &%senders%& option. It contains the data from the lookup, and the
12240 value remains set until the next &%senders%& test. Thus, you can do things like
12241 this:
12242 .display
12243 &`require senders      = cdb*@;/some/file`&
12244 &`deny    `&&'some further test involving'& &`$sender_data`&
12245 .endd
12246 &*Warning*&: This variable is set only when a lookup is used as an indexing
12247 method in the address list, using the semicolon syntax as in the example above.
12248 The variable is not set for a lookup that is used as part of the string
12249 expansion that all such lists undergo before being interpreted.
12250
12251 .vitem &$sender_fullhost$&
12252 .vindex "&$sender_fullhost$&"
12253 When a message is received from a remote host, this variable contains the host
12254 name and IP address in a single string. It ends with the IP address in square
12255 brackets, followed by a colon and a port number if the logging of ports is
12256 enabled. The format of the rest of the string depends on whether the host
12257 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12258 looking up its IP address. (Looking up the IP address can be forced by the
12259 &%host_lookup%& option, independent of verification.) A plain host name at the
12260 start of the string is a verified host name; if this is not present,
12261 verification either failed or was not requested. A host name in parentheses is
12262 the argument of a HELO or EHLO command. This is omitted if it is identical to
12263 the verified host name or to the host's IP address in square brackets.
12264
12265 .new
12266 .vitem &$sender_helo_dnssec$&
12267 .vindex "&$sender_helo_dnssec$&"
12268 This boolean variable is true if a successful HELO verification was
12269 .cindex "DNS" "DNSSEC"
12270 done using DNS information the resolver library stated was authenticatied data.
12271 .wen
12272
12273 .vitem &$sender_helo_name$&
12274 .vindex "&$sender_helo_name$&"
12275 When a message is received from a remote host that has issued a HELO or EHLO
12276 command, the argument of that command is placed in this variable. It is also
12277 set if HELO or EHLO is used when a message is received using SMTP locally via
12278 the &%-bs%& or &%-bS%& options.
12279
12280 .vitem &$sender_host_address$&
12281 .vindex "&$sender_host_address$&"
12282 When a message is received from a remote host using SMTP,
12283 this variable contains that
12284 host's IP address. For locally non-SMTP submitted messages, it is empty.
12285
12286 .vitem &$sender_host_authenticated$&
12287 .vindex "&$sender_host_authenticated$&"
12288 This variable contains the name (not the public name) of the authenticator
12289 driver that successfully authenticated the client from which the message was
12290 received. It is empty if there was no successful authentication. See also
12291 &$authenticated_id$&.
12292
12293 .vitem &$sender_host_dnssec$&
12294 .vindex "&$sender_host_dnssec$&"
12295 If an attempt to populate &$sender_host_name$& has been made
12296 (by reference, &%hosts_lookup%& or
12297 otherwise) then this boolean will have been set true if, and only if, the
12298 resolver library states that both
12299 the reverse and forward DNS were authenticated data.  At all
12300 other times, this variable is false.
12301
12302 .cindex "DNS" "DNSSEC"
12303 It is likely that you will need to coerce DNSSEC support on in the resolver
12304 library, by setting:
12305 .code
12306 dns_dnssec_ok = 1
12307 .endd
12308
12309 Exim does not perform DNSSEC validation itself, instead leaving that to a
12310 validating resolver (eg, unbound, or bind with suitable configuration).
12311
12312 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12313 mechanism in the list, then this variable will be false.
12314
12315
12316 .vitem &$sender_host_name$&
12317 .vindex "&$sender_host_name$&"
12318 When a message is received from a remote host, this variable contains the
12319 host's name as obtained by looking up its IP address. For messages received by
12320 other means, this variable is empty.
12321
12322 .vindex "&$host_lookup_failed$&"
12323 If the host name has not previously been looked up, a reference to
12324 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12325 A looked up name is accepted only if it leads back to the original IP address
12326 via a forward lookup. If either the reverse or the forward lookup fails to find
12327 any data, or if the forward lookup does not yield the original IP address,
12328 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12329
12330 .vindex "&$host_lookup_deferred$&"
12331 However, if either of the lookups cannot be completed (for example, there is a
12332 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12333 &$host_lookup_failed$& remains set to &"0"&.
12334
12335 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12336 host name again if there is a subsequent reference to &$sender_host_name$&
12337 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12338 is set to &"1"&.
12339
12340 Exim does not automatically look up every calling host's name. If you want
12341 maximum efficiency, you should arrange your configuration so that it avoids
12342 these lookups altogether. The lookup happens only if one or more of the
12343 following are true:
12344
12345 .ilist
12346 A string containing &$sender_host_name$& is expanded.
12347 .next
12348 The calling host matches the list in &%host_lookup%&. In the default
12349 configuration, this option is set to *, so it must be changed if lookups are
12350 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12351 .next
12352 Exim needs the host name in order to test an item in a host list. The items
12353 that require this are described in sections &<<SECThoslispatnam>>& and
12354 &<<SECThoslispatnamsk>>&.
12355 .next
12356 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12357 In this case, the host name is required to compare with the name quoted in any
12358 EHLO or HELO commands that the client issues.
12359 .next
12360 The remote host issues a EHLO or HELO command that quotes one of the
12361 domains in &%helo_lookup_domains%&. The default value of this option is
12362 . ==== As this is a nested list, any displays it contains must be indented
12363 . ==== as otherwise they are too far to the left.
12364 .code
12365   helo_lookup_domains = @ : @[]
12366 .endd
12367 which causes a lookup if a remote host (incorrectly) gives the server's name or
12368 IP address in an EHLO or HELO command.
12369 .endlist
12370
12371
12372 .vitem &$sender_host_port$&
12373 .vindex "&$sender_host_port$&"
12374 When a message is received from a remote host, this variable contains the port
12375 number that was used on the remote host.
12376
12377 .vitem &$sender_ident$&
12378 .vindex "&$sender_ident$&"
12379 When a message is received from a remote host, this variable contains the
12380 identification received in response to an RFC 1413 request. When a message has
12381 been received locally, this variable contains the login name of the user that
12382 called Exim.
12383
12384 .vitem &$sender_rate_$&&'xxx'&
12385 A number of variables whose names begin &$sender_rate_$& are set as part of the
12386 &%ratelimit%& ACL condition. Details are given in section
12387 &<<SECTratelimiting>>&.
12388
12389 .vitem &$sender_rcvhost$&
12390 .cindex "DNS" "reverse lookup"
12391 .cindex "reverse DNS lookup"
12392 .vindex "&$sender_rcvhost$&"
12393 This is provided specifically for use in &'Received:'& headers. It starts with
12394 either the verified host name (as obtained from a reverse DNS lookup) or, if
12395 there is no verified host name, the IP address in square brackets. After that
12396 there may be text in parentheses. When the first item is a verified host name,
12397 the first thing in the parentheses is the IP address in square brackets,
12398 followed by a colon and a port number if port logging is enabled. When the
12399 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12400 the parentheses.
12401
12402 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12403 was used and its argument was not identical to the real host name or IP
12404 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12405 all three items are present in the parentheses, a newline and tab are inserted
12406 into the string, to improve the formatting of the &'Received:'& header.
12407
12408 .vitem &$sender_verify_failure$&
12409 .vindex "&$sender_verify_failure$&"
12410 In an ACL, when a sender verification fails, this variable contains information
12411 about the failure. The details are the same as for
12412 &$recipient_verify_failure$&.
12413
12414 .vitem &$sending_ip_address$&
12415 .vindex "&$sending_ip_address$&"
12416 This variable is set whenever an outgoing SMTP connection to another host has
12417 been set up. It contains the IP address of the local interface that is being
12418 used. This is useful if a host that has more than one IP address wants to take
12419 on different personalities depending on which one is being used. For incoming
12420 connections, see &$received_ip_address$&.
12421
12422 .vitem &$sending_port$&
12423 .vindex "&$sending_port$&"
12424 This variable is set whenever an outgoing SMTP connection to another host has
12425 been set up. It contains the local port that is being used. For incoming
12426 connections, see &$received_port$&.
12427
12428 .vitem &$smtp_active_hostname$&
12429 .vindex "&$smtp_active_hostname$&"
12430 During an incoming SMTP session, this variable contains the value of the active
12431 host name, as specified by the &%smtp_active_hostname%& option. The value of
12432 &$smtp_active_hostname$& is saved with any message that is received, so its
12433 value can be consulted during routing and delivery.
12434
12435 .vitem &$smtp_command$&
12436 .vindex "&$smtp_command$&"
12437 During the processing of an incoming SMTP command, this variable contains the
12438 entire command. This makes it possible to distinguish between HELO and EHLO in
12439 the HELO ACL, and also to distinguish between commands such as these:
12440 .code
12441 MAIL FROM:<>
12442 MAIL FROM: <>
12443 .endd
12444 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12445 command, the address in &$smtp_command$& is the original address before any
12446 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12447 the address after SMTP-time rewriting.
12448
12449 .vitem &$smtp_command_argument$&
12450 .cindex "SMTP" "command, argument for"
12451 .vindex "&$smtp_command_argument$&"
12452 While an ACL is running to check an SMTP command, this variable contains the
12453 argument, that is, the text that follows the command name, with leading white
12454 space removed. Following the introduction of &$smtp_command$&, this variable is
12455 somewhat redundant, but is retained for backwards compatibility.
12456
12457 .vitem &$smtp_count_at_connection_start$&
12458 .vindex "&$smtp_count_at_connection_start$&"
12459 This variable is set greater than zero only in processes spawned by the Exim
12460 daemon for handling incoming SMTP connections. The name is deliberately long,
12461 in order to emphasize what the contents are. When the daemon accepts a new
12462 connection, it increments this variable. A copy of the variable is passed to
12463 the child process that handles the connection, but its value is fixed, and
12464 never changes. It is only an approximation of how many incoming connections
12465 there actually are, because many other connections may come and go while a
12466 single connection is being processed. When a child process terminates, the
12467 daemon decrements its copy of the variable.
12468
12469 .vitem "&$sn0$& &-- &$sn9$&"
12470 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12471 that were current at the end of the system filter file. This allows a system
12472 filter file to set values that can be tested in users' filter files. For
12473 example, a system filter could set a value indicating how likely it is that a
12474 message is junk mail.
12475
12476 .vitem &$spam_$&&'xxx'&
12477 A number of variables whose names start with &$spam$& are available when Exim
12478 is compiled with the content-scanning extension. For details, see section
12479 &<<SECTscanspamass>>&.
12480
12481
12482 .vitem &$spool_directory$&
12483 .vindex "&$spool_directory$&"
12484 The name of Exim's spool directory.
12485
12486 .vitem &$spool_inodes$&
12487 .vindex "&$spool_inodes$&"
12488 The number of free inodes in the disk partition where Exim's spool files are
12489 being written. The value is recalculated whenever the variable is referenced.
12490 If the relevant file system does not have the concept of inodes, the value of
12491 is -1. See also the &%check_spool_inodes%& option.
12492
12493 .vitem &$spool_space$&
12494 .vindex "&$spool_space$&"
12495 The amount of free space (as a number of kilobytes) in the disk partition where
12496 Exim's spool files are being written. The value is recalculated whenever the
12497 variable is referenced. If the operating system does not have the ability to
12498 find the amount of free space (only true for experimental systems), the space
12499 value is -1. For example, to check in an ACL that there is at least 50
12500 megabytes free on the spool, you could write:
12501 .code
12502 condition = ${if > {$spool_space}{50000}}
12503 .endd
12504 See also the &%check_spool_space%& option.
12505
12506
12507 .vitem &$thisaddress$&
12508 .vindex "&$thisaddress$&"
12509 This variable is set only during the processing of the &%foranyaddress%&
12510 command in a filter file. Its use is explained in the description of that
12511 command, which can be found in the separate document entitled &'Exim's
12512 interfaces to mail filtering'&.
12513
12514 .vitem &$tls_in_bits$&
12515 .vindex "&$tls_in_bits$&"
12516 Contains an approximation of the TLS cipher's bit-strength
12517 on the inbound connection; the meaning of
12518 this depends upon the TLS implementation used.
12519 If TLS has not been negotiated, the value will be 0.
12520 The value of this is automatically fed into the Cyrus SASL authenticator
12521 when acting as a server, to specify the "external SSF" (a SASL term).
12522
12523 The deprecated &$tls_bits$& variable refers to the inbound side
12524 except when used in the context of an outbound SMTP delivery, when it refers to
12525 the outbound.
12526
12527 .vitem &$tls_out_bits$&
12528 .vindex "&$tls_out_bits$&"
12529 Contains an approximation of the TLS cipher's bit-strength
12530 on an outbound SMTP connection; the meaning of
12531 this depends upon the TLS implementation used.
12532 If TLS has not been negotiated, the value will be 0.
12533
12534 .vitem &$tls_in_ourcert$&
12535 .vindex "&$tls_in_ourcert$&"
12536 This variable refers to the certificate presented to the peer of an
12537 inbound connection when the message was received.
12538 It is only useful as the argument of a
12539 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12540 or a &%def%& condition.
12541
12542 .vitem &$tls_in_peercert$&
12543 .vindex "&$tls_in_peercert$&"
12544 This variable refers to the certificate presented by the peer of an
12545 inbound connection when the message was received.
12546 It is only useful as the argument of a
12547 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12548 or a &%def%& condition.
12549 If certificate verification fails it may refer to a failing chain element
12550 which is not the leaf.
12551
12552 .vitem &$tls_out_ourcert$&
12553 .vindex "&$tls_out_ourcert$&"
12554 This variable refers to the certificate presented to the peer of an
12555 outbound connection.  It is only useful as the argument of a
12556 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12557 or a &%def%& condition.
12558
12559 .vitem &$tls_out_peercert$&
12560 .vindex "&$tls_out_peercert$&"
12561 This variable refers to the certificate presented by the peer of an
12562 outbound connection.  It is only useful as the argument of a
12563 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12564 or a &%def%& condition.
12565 If certificate verification fails it may refer to a failing chain element
12566 which is not the leaf.
12567
12568 .vitem &$tls_in_certificate_verified$&
12569 .vindex "&$tls_in_certificate_verified$&"
12570 This variable is set to &"1"& if a TLS certificate was verified when the
12571 message was received, and &"0"& otherwise.
12572
12573 The deprecated &$tls_certificate_verfied$& variable refers to the inbound side
12574 except when used in the context of an outbound SMTP delivery, when it refers to
12575 the outbound.
12576
12577 .vitem &$tls_out_certificate_verified$&
12578 .vindex "&$tls_out_certificate_verified$&"
12579 This variable is set to &"1"& if a TLS certificate was verified when an
12580 outbound SMTP connection was made,
12581 and &"0"& otherwise.
12582
12583 .vitem &$tls_in_cipher$&
12584 .vindex "&$tls_in_cipher$&"
12585 .vindex "&$tls_cipher$&"
12586 When a message is received from a remote host over an encrypted SMTP
12587 connection, this variable is set to the cipher suite that was negotiated, for
12588 example DES-CBC3-SHA. In other circumstances, in particular, for message
12589 received over unencrypted connections, the variable is empty. Testing
12590 &$tls_cipher$& for emptiness is one way of distinguishing between encrypted and
12591 non-encrypted connections during ACL processing.
12592
12593 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12594 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12595 becomes the same as &$tls_out_cipher$&.
12596
12597 .vitem &$tls_out_cipher$&
12598 .vindex "&$tls_out_cipher$&"
12599 This variable is
12600 cleared before any outgoing SMTP connection is made,
12601 and then set to the outgoing cipher suite if one is negotiated. See chapter
12602 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12603 details of the &(smtp)& transport.
12604
12605 .vitem &$tls_in_ocsp$&
12606 .vindex "&$tls_in_ocsp$&"
12607 When a message is received from a remote client connection
12608 the result of any OCSP request from the client is encoded in this variable:
12609 .code
12610 0 OCSP proof was not requested (default value)
12611 1 No response to request
12612 2 Response not verified
12613 3 Verification failed
12614 4 Verification succeeded
12615 .endd
12616
12617 .vitem &$tls_out_ocsp$&
12618 .vindex "&$tls_out_ocsp$&"
12619 When a message is sent to a remote host connection
12620 the result of any OCSP request made is encoded in this variable.
12621 See &$tls_in_ocsp$& for values.
12622
12623 .vitem &$tls_in_peerdn$&
12624 .vindex "&$tls_in_peerdn$&"
12625 .vindex "&$tls_peerdn$&"
12626 When a message is received from a remote host over an encrypted SMTP
12627 connection, and Exim is configured to request a certificate from the client,
12628 the value of the Distinguished Name of the certificate is made available in the
12629 &$tls_in_peerdn$& during subsequent processing.
12630 If certificate verification fails it may refer to a failing chain element
12631 which is not the leaf.
12632
12633 The deprecated &$tls_peerdn$& variable refers to the inbound side
12634 except when used in the context of an outbound SMTP delivery, when it refers to
12635 the outbound.
12636
12637 .vitem &$tls_out_peerdn$&
12638 .vindex "&$tls_out_peerdn$&"
12639 When a message is being delivered to a remote host over an encrypted SMTP
12640 connection, and Exim is configured to request a certificate from the server,
12641 the value of the Distinguished Name of the certificate is made available in the
12642 &$tls_out_peerdn$& during subsequent processing.
12643 If certificate verification fails it may refer to a failing chain element
12644 which is not the leaf.
12645
12646 .vitem &$tls_in_sni$&
12647 .vindex "&$tls_in_sni$&"
12648 .vindex "&$tls_sni$&"
12649 .cindex "TLS" "Server Name Indication"
12650 When a TLS session is being established, if the client sends the Server
12651 Name Indication extension, the value will be placed in this variable.
12652 If the variable appears in &%tls_certificate%& then this option and
12653 some others, described in &<<SECTtlssni>>&,
12654 will be re-expanded early in the TLS session, to permit
12655 a different certificate to be presented (and optionally a different key to be
12656 used) to the client, based upon the value of the SNI extension.
12657
12658 The deprecated &$tls_sni$& variable refers to the inbound side
12659 except when used in the context of an outbound SMTP delivery, when it refers to
12660 the outbound.
12661
12662 .vitem &$tls_out_sni$&
12663 .vindex "&$tls_out_sni$&"
12664 .cindex "TLS" "Server Name Indication"
12665 During outbound
12666 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
12667 the transport.
12668
12669 .vitem &$tod_bsdinbox$&
12670 .vindex "&$tod_bsdinbox$&"
12671 The time of day and the date, in the format required for BSD-style mailbox
12672 files, for example: Thu Oct 17 17:14:09 1995.
12673
12674 .vitem &$tod_epoch$&
12675 .vindex "&$tod_epoch$&"
12676 The time and date as a number of seconds since the start of the Unix epoch.
12677
12678 .vitem &$tod_epoch_l$&
12679 .vindex "&$tod_epoch_l$&"
12680 The time and date as a number of microseconds since the start of the Unix epoch.
12681
12682 .vitem &$tod_full$&
12683 .vindex "&$tod_full$&"
12684 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
12685 +0100. The timezone is always given as a numerical offset from UTC, with
12686 positive values used for timezones that are ahead (east) of UTC, and negative
12687 values for those that are behind (west).
12688
12689 .vitem &$tod_log$&
12690 .vindex "&$tod_log$&"
12691 The time and date in the format used for writing Exim's log files, for example:
12692 1995-10-12 15:32:29, but without a timezone.
12693
12694 .vitem &$tod_logfile$&
12695 .vindex "&$tod_logfile$&"
12696 This variable contains the date in the format yyyymmdd. This is the format that
12697 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
12698 flag.
12699
12700 .vitem &$tod_zone$&
12701 .vindex "&$tod_zone$&"
12702 This variable contains the numerical value of the local timezone, for example:
12703 -0500.
12704
12705 .vitem &$tod_zulu$&
12706 .vindex "&$tod_zulu$&"
12707 This variable contains the UTC date and time in &"Zulu"& format, as specified
12708 by ISO 8601, for example: 20030221154023Z.
12709
12710 .vitem &$transport_name$&
12711 .cindex "transport" "name"
12712 .cindex "name" "of transport"
12713 .vindex "&$transport_name$&"
12714 During the running of a transport, this variable contains its name.
12715
12716 .vitem &$value$&
12717 .vindex "&$value$&"
12718 This variable contains the result of an expansion lookup, extraction operation,
12719 or external command, as described above. It is also used during a
12720 &*reduce*& expansion.
12721
12722 .vitem &$verify_mode$&
12723 .vindex "&$verify_mode$&"
12724 While a router or transport is being run in verify mode
12725 or for cutthrough delivery,
12726 contains "S" for sender-verification or "R" for recipient-verification.
12727 Otherwise, empty.
12728
12729 .vitem &$version_number$&
12730 .vindex "&$version_number$&"
12731 The version number of Exim.
12732
12733 .vitem &$warn_message_delay$&
12734 .vindex "&$warn_message_delay$&"
12735 This variable is set only during the creation of a message warning about a
12736 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12737
12738 .vitem &$warn_message_recipients$&
12739 .vindex "&$warn_message_recipients$&"
12740 This variable is set only during the creation of a message warning about a
12741 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
12742 .endlist
12743 .ecindex IIDstrexp
12744
12745
12746
12747 . ////////////////////////////////////////////////////////////////////////////
12748 . ////////////////////////////////////////////////////////////////////////////
12749
12750 .chapter "Embedded Perl" "CHAPperl"
12751 .scindex IIDperl "Perl" "calling from Exim"
12752 Exim can be built to include an embedded Perl interpreter. When this is done,
12753 Perl subroutines can be called as part of the string expansion process. To make
12754 use of the Perl support, you need version 5.004 or later of Perl installed on
12755 your system. To include the embedded interpreter in the Exim binary, include
12756 the line
12757 .code
12758 EXIM_PERL = perl.o
12759 .endd
12760 in your &_Local/Makefile_& and then build Exim in the normal way.
12761
12762
12763 .section "Setting up so Perl can be used" "SECID85"
12764 .oindex "&%perl_startup%&"
12765 Access to Perl subroutines is via a global configuration option called
12766 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
12767 no &%perl_startup%& option in the Exim configuration file then no Perl
12768 interpreter is started and there is almost no overhead for Exim (since none of
12769 the Perl library will be paged in unless used). If there is a &%perl_startup%&
12770 option then the associated value is taken to be Perl code which is executed in
12771 a newly created Perl interpreter.
12772
12773 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
12774 need backslashes before any characters to escape special meanings. The option
12775 should usually be something like
12776 .code
12777 perl_startup = do '/etc/exim.pl'
12778 .endd
12779 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
12780 use from Exim. Exim can be configured either to start up a Perl interpreter as
12781 soon as it is entered, or to wait until the first time it is needed. Starting
12782 the interpreter at the beginning ensures that it is done while Exim still has
12783 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
12784 fact used in a particular run. Also, note that this does not mean that Exim is
12785 necessarily running as root when Perl is called at a later time. By default,
12786 the interpreter is started only when it is needed, but this can be changed in
12787 two ways:
12788
12789 .ilist
12790 .oindex "&%perl_at_start%&"
12791 Setting &%perl_at_start%& (a boolean option) in the configuration requests
12792 a startup when Exim is entered.
12793 .next
12794 The command line option &%-ps%& also requests a startup when Exim is entered,
12795 overriding the setting of &%perl_at_start%&.
12796 .endlist
12797
12798 There is also a command line option &%-pd%& (for delay) which suppresses the
12799 initial startup, even if &%perl_at_start%& is set.
12800
12801
12802 .section "Calling Perl subroutines" "SECID86"
12803 When the configuration file includes a &%perl_startup%& option you can make use
12804 of the string expansion item to call the Perl subroutines that are defined
12805 by the &%perl_startup%& code. The operator is used in any of the following
12806 forms:
12807 .code
12808 ${perl{foo}}
12809 ${perl{foo}{argument}}
12810 ${perl{foo}{argument1}{argument2} ... }
12811 .endd
12812 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
12813 arguments may be passed. Passing more than this results in an expansion failure
12814 with an error message of the form
12815 .code
12816 Too many arguments passed to Perl subroutine "foo" (max is 8)
12817 .endd
12818 The return value of the Perl subroutine is evaluated in a scalar context before
12819 it is passed back to Exim to be inserted into the expanded string. If the
12820 return value is &'undef'&, the expansion is forced to fail in the same way as
12821 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
12822 by obeying Perl's &%die%& function, the expansion fails with the error message
12823 that was passed to &%die%&.
12824
12825
12826 .section "Calling Exim functions from Perl" "SECID87"
12827 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
12828 is available to call back into Exim's string expansion function. For example,
12829 the Perl code
12830 .code
12831 my $lp = Exim::expand_string('$local_part');
12832 .endd
12833 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
12834 Note those are single quotes and not double quotes to protect against
12835 &$local_part$& being interpolated as a Perl variable.
12836
12837 If the string expansion is forced to fail by a &"fail"& item, the result of
12838 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
12839 expansion string, the Perl call from the original expansion string fails with
12840 an appropriate error message, in the same way as if &%die%& were used.
12841
12842 .cindex "debugging" "from embedded Perl"
12843 .cindex "log" "writing from embedded Perl"
12844 Two other Exim functions are available for use from within Perl code.
12845 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
12846 debugging is enabled. If you want a newline at the end, you must supply it.
12847 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
12848 timestamp. In this case, you should not supply a terminating newline.
12849
12850
12851 .section "Use of standard output and error by Perl" "SECID88"
12852 .cindex "Perl" "standard output and error"
12853 You should not write to the standard error or output streams from within your
12854 Perl code, as it is not defined how these are set up. In versions of Exim
12855 before 4.50, it is possible for the standard output or error to refer to the
12856 SMTP connection during message reception via the daemon. Writing to this stream
12857 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
12858 error streams are connected to &_/dev/null_& in the daemon. The chaos is
12859 avoided, but the output is lost.
12860
12861 .cindex "Perl" "use of &%warn%&"
12862 The Perl &%warn%& statement writes to the standard error stream by default.
12863 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
12864 you have no control. When Exim starts up the Perl interpreter, it arranges for
12865 output from the &%warn%& statement to be written to the Exim main log. You can
12866 change this by including appropriate Perl magic somewhere in your Perl code.
12867 For example, to discard &%warn%& output completely, you need this:
12868 .code
12869 $SIG{__WARN__} = sub { };
12870 .endd
12871 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
12872 example, the code for the subroutine is empty, so it does nothing, but you can
12873 include any Perl code that you like. The text of the &%warn%& message is passed
12874 as the first subroutine argument.
12875 .ecindex IIDperl
12876
12877
12878 . ////////////////////////////////////////////////////////////////////////////
12879 . ////////////////////////////////////////////////////////////////////////////
12880
12881 .chapter "Starting the daemon and the use of network interfaces" &&&
12882          "CHAPinterfaces" &&&
12883          "Starting the daemon"
12884 .cindex "daemon" "starting"
12885 .cindex "interface" "listening"
12886 .cindex "network interface"
12887 .cindex "interface" "network"
12888 .cindex "IP address" "for listening"
12889 .cindex "daemon" "listening IP addresses"
12890 .cindex "TCP/IP" "setting listening interfaces"
12891 .cindex "TCP/IP" "setting listening ports"
12892 A host that is connected to a TCP/IP network may have one or more physical
12893 hardware network interfaces. Each of these interfaces may be configured as one
12894 or more &"logical"& interfaces, which are the entities that a program actually
12895 works with. Each of these logical interfaces is associated with an IP address.
12896 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
12897 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
12898 knowledge about the host's interfaces for use in three different circumstances:
12899
12900 .olist
12901 When a listening daemon is started, Exim needs to know which interfaces
12902 and ports to listen on.
12903 .next
12904 When Exim is routing an address, it needs to know which IP addresses
12905 are associated with local interfaces. This is required for the correct
12906 processing of MX lists by removing the local host and others with the
12907 same or higher priority values. Also, Exim needs to detect cases
12908 when an address is routed to an IP address that in fact belongs to the
12909 local host. Unless the &%self%& router option or the &%allow_localhost%&
12910 option of the smtp transport is set (as appropriate), this is treated
12911 as an error situation.
12912 .next
12913 When Exim connects to a remote host, it may need to know which interface to use
12914 for the outgoing connection.
12915 .endlist
12916
12917
12918 Exim's default behaviour is likely to be appropriate in the vast majority
12919 of cases. If your host has only one interface, and you want all its IP
12920 addresses to be treated in the same way, and you are using only the
12921 standard SMTP port, you should not need to take any special action. The
12922 rest of this chapter does not apply to you.
12923
12924 In a more complicated situation you may want to listen only on certain
12925 interfaces, or on different ports, and for this reason there are a number of
12926 options that can be used to influence Exim's behaviour. The rest of this
12927 chapter describes how they operate.
12928
12929 When a message is received over TCP/IP, the interface and port that were
12930 actually used are set in &$received_ip_address$& and &$received_port$&.
12931
12932
12933
12934 .section "Starting a listening daemon" "SECID89"
12935 When a listening daemon is started (by means of the &%-bd%& command line
12936 option), the interfaces and ports on which it listens are controlled by the
12937 following options:
12938
12939 .ilist
12940 &%daemon_smtp_ports%& contains a list of default ports
12941 or service names.
12942 (For backward compatibility, this option can also be specified in the singular.)
12943 .next
12944 &%local_interfaces%& contains list of interface IP addresses on which to
12945 listen. Each item may optionally also specify a port.
12946 .endlist
12947
12948 The default list separator in both cases is a colon, but this can be changed as
12949 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
12950 it is usually best to change the separator to avoid having to double all the
12951 colons. For example:
12952 .code
12953 local_interfaces = <; 127.0.0.1 ; \
12954                       192.168.23.65 ; \
12955                       ::1 ; \
12956                       3ffe:ffff:836f::fe86:a061
12957 .endd
12958 There are two different formats for specifying a port along with an IP address
12959 in &%local_interfaces%&:
12960
12961 .olist
12962 The port is added onto the address with a dot separator. For example, to listen
12963 on port 1234 on two different IP addresses:
12964 .code
12965 local_interfaces = <; 192.168.23.65.1234 ; \
12966                       3ffe:ffff:836f::fe86:a061.1234
12967 .endd
12968 .next
12969 The IP address is enclosed in square brackets, and the port is added
12970 with a colon separator, for example:
12971 .code
12972 local_interfaces = <; [192.168.23.65]:1234 ; \
12973                       [3ffe:ffff:836f::fe86:a061]:1234
12974 .endd
12975 .endlist
12976
12977 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
12978 default setting contains just one port:
12979 .code
12980 daemon_smtp_ports = smtp
12981 .endd
12982 If more than one port is listed, each interface that does not have its own port
12983 specified listens on all of them. Ports that are listed in
12984 &%daemon_smtp_ports%& can be identified either by name (defined in
12985 &_/etc/services_&) or by number. However, when ports are given with individual
12986 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
12987
12988
12989
12990 .section "Special IP listening addresses" "SECID90"
12991 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
12992 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
12993 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
12994 instead of setting up separate listening sockets for each interface. The
12995 default value of &%local_interfaces%& is
12996 .code
12997 local_interfaces = 0.0.0.0
12998 .endd
12999 when Exim is built without IPv6 support; otherwise it is:
13000 .code
13001 local_interfaces = <; ::0 ; 0.0.0.0
13002 .endd
13003 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13004
13005
13006
13007 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13008 The &%-oX%& command line option can be used to override the values of
13009 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13010 instance. Another way of doing this would be to use macros and the &%-D%&
13011 option. However, &%-oX%& can be used by any admin user, whereas modification of
13012 the runtime configuration by &%-D%& is allowed only when the caller is root or
13013 exim.
13014
13015 The value of &%-oX%& is a list of items. The default colon separator can be
13016 changed in the usual way if required. If there are any items that do not
13017 contain dots or colons (that is, are not IP addresses), the value of
13018 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13019 items that do contain dots or colons, the value of &%local_interfaces%& is
13020 replaced by those items. Thus, for example,
13021 .code
13022 -oX 1225
13023 .endd
13024 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13025 whereas
13026 .code
13027 -oX 192.168.34.5.1125
13028 .endd
13029 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13030 (However, since &%local_interfaces%& now contains no items without ports, the
13031 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13032
13033
13034
13035 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13036 .cindex "ssmtp protocol"
13037 .cindex "smtps protocol"
13038 .cindex "SMTP" "ssmtp protocol"
13039 .cindex "SMTP" "smtps protocol"
13040 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13041 before the STARTTLS command was standardized for SMTP. Some legacy clients
13042 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13043 list of port numbers or service names,
13044 connections to those ports must use SSMTP. The most
13045 common use of this option is expected to be
13046 .code
13047 tls_on_connect_ports = 465
13048 .endd
13049 because 465 is the usual port number used by the legacy clients. There is also
13050 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13051 this way when a daemon is started.
13052
13053 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13054 daemon to listen on those ports. You must still specify them in
13055 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13056 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13057 connections via the daemon.)
13058
13059
13060
13061
13062 .section "IPv6 address scopes" "SECID92"
13063 .cindex "IPv6" "address scopes"
13064 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13065 can, in principle, have the same link-local IPv6 address on different
13066 interfaces. Thus, additional information is needed, over and above the IP
13067 address, to distinguish individual interfaces. A convention of using a
13068 percent sign followed by something (often the interface name) has been
13069 adopted in some cases, leading to addresses like this:
13070 .code
13071 fe80::202:b3ff:fe03:45c1%eth0
13072 .endd
13073 To accommodate this usage, a percent sign followed by an arbitrary string is
13074 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13075 to convert a textual IPv6 address for actual use. This function recognizes the
13076 percent convention in operating systems that support it, and it processes the
13077 address appropriately. Unfortunately, some older libraries have problems with
13078 &[getaddrinfo()]&. If
13079 .code
13080 IPV6_USE_INET_PTON=yes
13081 .endd
13082 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13083 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13084 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13085 function.) Of course, this means that the additional functionality of
13086 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13087
13088 .section "Disabling IPv6" "SECID93"
13089 .cindex "IPv6" "disabling"
13090 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13091 run on a host whose kernel does not support IPv6. The binary will fall back to
13092 using IPv4, but it may waste resources looking up AAAA records, and trying to
13093 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13094 .oindex "&%disable_ipv6%&"
13095 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13096 activities take place. AAAA records are never looked up, and any IPv6 addresses
13097 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13098 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13099 to handle IPv6 literal addresses.
13100
13101 On the other hand, when IPv6 is in use, there may be times when you want to
13102 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13103 option to globally suppress the lookup of AAAA records for specified domains,
13104 and you can use the &%ignore_target_hosts%& generic router option to ignore
13105 IPv6 addresses in an individual router.
13106
13107
13108
13109 .section "Examples of starting a listening daemon" "SECID94"
13110 The default case in an IPv6 environment is
13111 .code
13112 daemon_smtp_ports = smtp
13113 local_interfaces = <; ::0 ; 0.0.0.0
13114 .endd
13115 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13116 Either one or two sockets may be used, depending on the characteristics of
13117 the TCP/IP stack. (This is complicated and messy; for more information,
13118 read the comments in the &_daemon.c_& source file.)
13119
13120 To specify listening on ports 25 and 26 on all interfaces:
13121 .code
13122 daemon_smtp_ports = 25 : 26
13123 .endd
13124 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13125 .code
13126 local_interfaces = <; ::0.25     ; ::0.26 \
13127                       0.0.0.0.25 ; 0.0.0.0.26
13128 .endd
13129 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13130 IPv4 loopback address only:
13131 .code
13132 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13133 .endd
13134 To specify listening on the default port on specific interfaces only:
13135 .code
13136 local_interfaces = 10.0.0.67 : 192.168.34.67
13137 .endd
13138 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13139
13140
13141
13142 .section "Recognizing the local host" "SECTreclocipadd"
13143 The &%local_interfaces%& option is also used when Exim needs to determine
13144 whether or not an IP address refers to the local host. That is, the IP
13145 addresses of all the interfaces on which a daemon is listening are always
13146 treated as local.
13147
13148 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13149 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13150 available interfaces from the operating system, and extracts the relevant
13151 (that is, IPv4 or IPv6) addresses to use for checking.
13152
13153 Some systems set up large numbers of virtual interfaces in order to provide
13154 many virtual web servers. In this situation, you may want to listen for
13155 email on only a few of the available interfaces, but nevertheless treat all
13156 interfaces as local when routing. You can do this by setting
13157 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13158 &"all"& wildcard values. These addresses are recognized as local, but are not
13159 used for listening. Consider this example:
13160 .code
13161 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13162                       192.168.53.235 ; \
13163                       3ffe:2101:12:1:a00:20ff:fe86:a061
13164
13165 extra_local_interfaces = <; ::0 ; 0.0.0.0
13166 .endd
13167 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13168 address, but all available interface addresses are treated as local when
13169 Exim is routing.
13170
13171 In some environments the local host name may be in an MX list, but with an IP
13172 address that is not assigned to any local interface. In other cases it may be
13173 desirable to treat other host names as if they referred to the local host. Both
13174 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13175 This contains host names rather than IP addresses. When a host is referenced
13176 during routing, either via an MX record or directly, it is treated as the local
13177 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13178 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13179
13180
13181
13182 .section "Delivering to a remote host" "SECID95"
13183 Delivery to a remote host is handled by the smtp transport. By default, it
13184 allows the system's TCP/IP functions to choose which interface to use (if
13185 there is more than one) when connecting to a remote host. However, the
13186 &%interface%& option can be set to specify which interface is used. See the
13187 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13188 details.
13189
13190
13191
13192
13193 . ////////////////////////////////////////////////////////////////////////////
13194 . ////////////////////////////////////////////////////////////////////////////
13195
13196 .chapter "Main configuration" "CHAPmainconfig"
13197 .scindex IIDconfima "configuration file" "main section"
13198 .scindex IIDmaiconf "main configuration"
13199 The first part of the run time configuration file contains three types of item:
13200
13201 .ilist
13202 Macro definitions: These lines start with an upper case letter. See section
13203 &<<SECTmacrodefs>>& for details of macro processing.
13204 .next
13205 Named list definitions: These lines start with one of the words &"domainlist"&,
13206 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13207 section &<<SECTnamedlists>>&.
13208 .next
13209 Main configuration settings: Each setting occupies one line of the file
13210 (with possible continuations). If any setting is preceded by the word
13211 &"hide"&, the &%-bP%& command line option displays its value to admin users
13212 only. See section &<<SECTcos>>& for a description of the syntax of these option
13213 settings.
13214 .endlist
13215
13216 This chapter specifies all the main configuration options, along with their
13217 types and default values. For ease of finding a particular option, they appear
13218 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13219 are now so many options, they are first listed briefly in functional groups, as
13220 an aid to finding the name of the option you are looking for. Some options are
13221 listed in more than one group.
13222
13223 .section "Miscellaneous" "SECID96"
13224 .table2
13225 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13226 .row &%disable_ipv6%&                "do no IPv6 processing"
13227 .row &%keep_malformed%&              "for broken files &-- should not happen"
13228 .row &%localhost_number%&            "for unique message ids in clusters"
13229 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13230 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13231 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13232 .row &%print_topbitchars%&           "top-bit characters are printing"
13233 .row &%timezone%&                    "force time zone"
13234 .endtable
13235
13236
13237 .section "Exim parameters" "SECID97"
13238 .table2
13239 .row &%exim_group%&                  "override compiled-in value"
13240 .row &%exim_path%&                   "override compiled-in value"
13241 .row &%exim_user%&                   "override compiled-in value"
13242 .row &%primary_hostname%&            "default from &[uname()]&"
13243 .row &%split_spool_directory%&       "use multiple directories"
13244 .row &%spool_directory%&             "override compiled-in value"
13245 .endtable
13246
13247
13248
13249 .section "Privilege controls" "SECID98"
13250 .table2
13251 .row &%admin_groups%&                "groups that are Exim admin users"
13252 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13253 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13254 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13255 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13256 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13257 .row &%never_users%&                 "do not run deliveries as these"
13258 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13259 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13260 .row &%trusted_groups%&              "groups that are trusted"
13261 .row &%trusted_users%&               "users that are trusted"
13262 .endtable
13263
13264
13265
13266 .section "Logging" "SECID99"
13267 .table2
13268 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13269 .row &%log_file_path%&               "override compiled-in value"
13270 .row &%log_selector%&                "set/unset optional logging"
13271 .row &%log_timezone%&                "add timezone to log lines"
13272 .row &%message_logs%&                "create per-message logs"
13273 .row &%preserve_message_logs%&       "after message completion"
13274 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13275 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13276 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13277 .row &%syslog_facility%&             "set syslog &""facility""& field"
13278 .row &%syslog_processname%&          "set syslog &""ident""& field"
13279 .row &%syslog_timestamp%&            "timestamp syslog lines"
13280 .row &%write_rejectlog%&             "control use of message log"
13281 .endtable
13282
13283
13284
13285 .section "Frozen messages" "SECID100"
13286 .table2
13287 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13288 .row &%freeze_tell%&                 "send message when freezing"
13289 .row &%move_frozen_messages%&        "to another directory"
13290 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13291 .endtable
13292
13293
13294
13295 .section "Data lookups" "SECID101"
13296 .table2
13297 .row &%ibase_servers%&               "InterBase servers"
13298 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13299 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13300 .row &%ldap_cert_file%&              "client cert file for LDAP"
13301 .row &%ldap_cert_key%&               "client key file for LDAP"
13302 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13303 .row &%ldap_default_servers%&        "used if no server in query"
13304 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13305 .row &%ldap_start_tls%&              "require TLS within LDAP"
13306 .row &%ldap_version%&                "set protocol version"
13307 .row &%lookup_open_max%&             "lookup files held open"
13308 .row &%mysql_servers%&               "default MySQL servers"
13309 .row &%oracle_servers%&              "Oracle servers"
13310 .row &%pgsql_servers%&               "default PostgreSQL servers"
13311 .row &%sqlite_lock_timeout%&         "as it says"
13312 .endtable
13313
13314
13315
13316 .section "Message ids" "SECID102"
13317 .table2
13318 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13319 .row &%message_id_header_text%&      "ditto"
13320 .endtable
13321
13322
13323
13324 .section "Embedded Perl Startup" "SECID103"
13325 .table2
13326 .row &%perl_at_start%&               "always start the interpreter"
13327 .row &%perl_startup%&                "code to obey when starting Perl"
13328 .endtable
13329
13330
13331
13332 .section "Daemon" "SECID104"
13333 .table2
13334 .row &%daemon_smtp_ports%&           "default ports"
13335 .row &%daemon_startup_retries%&      "number of times to retry"
13336 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13337 .row &%extra_local_interfaces%&      "not necessarily listened on"
13338 .row &%local_interfaces%&            "on which to listen, with optional ports"
13339 .row &%pid_file_path%&               "override compiled-in value"
13340 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13341 .endtable
13342
13343
13344
13345 .section "Resource control" "SECID105"
13346 .table2
13347 .row &%check_log_inodes%&            "before accepting a message"
13348 .row &%check_log_space%&             "before accepting a message"
13349 .row &%check_spool_inodes%&          "before accepting a message"
13350 .row &%check_spool_space%&           "before accepting a message"
13351 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13352 .row &%queue_only_load%&             "queue incoming if load high"
13353 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13354 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13355 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13356 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13357 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13358 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13359 .row &%smtp_accept_max_per_connection%& "messages per connection"
13360 .row &%smtp_accept_max_per_host%&    "connections from one host"
13361 .row &%smtp_accept_queue%&           "queue mail if more connections"
13362 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13363                                            connection"
13364 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13365 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13366 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13367 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13368 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13369 .endtable
13370
13371
13372
13373 .section "Policy controls" "SECID106"
13374 .table2
13375 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13376 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13377 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13378 .row &%acl_smtp_auth%&               "ACL for AUTH"
13379 .row &%acl_smtp_connect%&            "ACL for connection"
13380 .row &%acl_smtp_data%&               "ACL for DATA"
13381 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13382 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13383 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13384 .row &%acl_smtp_expn%&               "ACL for EXPN"
13385 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13386 .row &%acl_smtp_mail%&               "ACL for MAIL"
13387 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13388 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13389 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13390 .row &%acl_smtp_predata%&            "ACL for start of data"
13391 .row &%acl_smtp_quit%&               "ACL for QUIT"
13392 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13393 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13394 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13395 .row &%av_scanner%&                  "specify virus scanner"
13396 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13397                                       words""&"
13398 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13399 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13400 .row &%header_maxsize%&              "total size of message header"
13401 .row &%header_line_maxsize%&         "individual header line limit"
13402 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13403 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13404 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13405 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13406 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13407 .row &%host_lookup%&                 "host name looked up for these hosts"
13408 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13409 .row &%host_reject_connection%&      "reject connection from these hosts"
13410 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13411 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13412 .row &%message_size_limit%&          "for all messages"
13413 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13414 .row &%spamd_address%&               "set interface to SpamAssassin"
13415 .row &%strict_acl_vars%&             "object to unset ACL variables"
13416 .endtable
13417
13418
13419
13420 .section "Callout cache" "SECID107"
13421 .table2
13422 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13423                                          item"
13424 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13425                                          item"
13426 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13427 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13428 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13429 .endtable
13430
13431
13432
13433 .section "TLS" "SECID108"
13434 .table2
13435 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13436 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13437 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13438 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13439 .row &%tls_certificate%&             "location of server certificate"
13440 .row &%tls_crl%&                     "certificate revocation list"
13441 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13442 .row &%tls_dhparam%&                 "DH parameters for server"
13443 .row &%tls_eccurve%&                 "EC curve selection for server"
13444 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13445 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13446 .row &%tls_privatekey%&              "location of server private key"
13447 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13448 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13449 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13450 .row &%tls_verify_certificates%&     "expected client certificates"
13451 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13452 .endtable
13453
13454
13455
13456 .section "Local user handling" "SECID109"
13457 .table2
13458 .row &%finduser_retries%&            "useful in NIS environments"
13459 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13460 .row &%gecos_pattern%&               "ditto"
13461 .row &%max_username_length%&         "for systems that truncate"
13462 .row &%unknown_login%&               "used when no login name found"
13463 .row &%unknown_username%&            "ditto"
13464 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13465 .row &%uucp_from_sender%&            "ditto"
13466 .endtable
13467
13468
13469
13470 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13471 .table2
13472 .row &%header_maxsize%&              "total size of message header"
13473 .row &%header_line_maxsize%&         "individual header line limit"
13474 .row &%message_size_limit%&          "applies to all messages"
13475 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13476 .row &%received_header_text%&        "expanded to make &'Received:'&"
13477 .row &%received_headers_max%&        "for mail loop detection"
13478 .row &%recipients_max%&              "limit per message"
13479 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13480 .endtable
13481
13482
13483
13484
13485 .section "Non-SMTP incoming messages" "SECID111"
13486 .table2
13487 .row &%receive_timeout%&             "for non-SMTP messages"
13488 .endtable
13489
13490
13491
13492
13493
13494 .section "Incoming SMTP messages" "SECID112"
13495 See also the &'Policy controls'& section above.
13496
13497 .table2
13498 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13499 .row &%host_lookup%&                 "host name looked up for these hosts"
13500 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13501 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13502 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13503 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13504 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13505 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13506 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13507 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13508 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13509 .row &%smtp_accept_max_per_connection%& "messages per connection"
13510 .row &%smtp_accept_max_per_host%&    "connections from one host"
13511 .row &%smtp_accept_queue%&           "queue mail if more connections"
13512 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13513                                            connection"
13514 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13515 .row &%smtp_active_hostname%&        "host name to use in messages"
13516 .row &%smtp_banner%&                 "text for welcome banner"
13517 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13518 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13519 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13520 .row &%smtp_etrn_command%&           "what to run for ETRN"
13521 .row &%smtp_etrn_serialize%&         "only one at once"
13522 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13523 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13524 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13525 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13526 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13527 .row &%smtp_receive_timeout%&        "per command or data line"
13528 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13529 .row &%smtp_return_error_details%&   "give detail on rejections"
13530 .endtable
13531
13532
13533
13534 .section "SMTP extensions" "SECID113"
13535 .table2
13536 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13537 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13538 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13539 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13540 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13541 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13542 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13543 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13544 .endtable
13545
13546
13547
13548 .section "Processing messages" "SECID114"
13549 .table2
13550 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13551 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13552 .row &%allow_utf8_domains%&          "in addresses"
13553 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13554                                       words""&"
13555 .row &%delivery_date_remove%&        "from incoming messages"
13556 .row &%envelope_to_remove%&          "from incoming messages"
13557 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13558 .row &%headers_charset%&             "default for translations"
13559 .row &%qualify_domain%&              "default for senders"
13560 .row &%qualify_recipient%&           "default for recipients"
13561 .row &%return_path_remove%&          "from incoming messages"
13562 .row &%strip_excess_angle_brackets%& "in addresses"
13563 .row &%strip_trailing_dot%&          "at end of addresses"
13564 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13565 .endtable
13566
13567
13568
13569 .section "System filter" "SECID115"
13570 .table2
13571 .row &%system_filter%&               "locate system filter"
13572 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13573                                             directory"
13574 .row &%system_filter_file_transport%& "transport for delivery to a file"
13575 .row &%system_filter_group%&         "group for filter running"
13576 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13577 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13578 .row &%system_filter_user%&          "user for filter running"
13579 .endtable
13580
13581
13582
13583 .section "Routing and delivery" "SECID116"
13584 .table2
13585 .row &%disable_ipv6%&                "do no IPv6 processing"
13586 .row &%dns_again_means_nonexist%&    "for broken domains"
13587 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13588 .row &%dns_dnssec_ok%&               "parameter for resolver"
13589 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13590 .row &%dns_retrans%&                 "parameter for resolver"
13591 .row &%dns_retry%&                   "parameter for resolver"
13592 .row &%dns_trust_aa%&                "nameservers trusted as authentic"
13593 .row &%dns_use_edns0%&               "parameter for resolver"
13594 .row &%hold_domains%&                "hold delivery for these domains"
13595 .row &%local_interfaces%&            "for routing checks"
13596 .row &%queue_domains%&               "no immediate delivery for these"
13597 .row &%queue_only%&                  "no immediate delivery at all"
13598 .row &%queue_only_file%&             "no immediate delivery if file exists"
13599 .row &%queue_only_load%&             "no immediate delivery if load is high"
13600 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13601 .row &%queue_only_override%&         "allow command line to override"
13602 .row &%queue_run_in_order%&          "order of arrival"
13603 .row &%queue_run_max%&               "of simultaneous queue runners"
13604 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13605 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13606 .row &%remote_sort_domains%&         "order of remote deliveries"
13607 .row &%retry_data_expire%&           "timeout for retry data"
13608 .row &%retry_interval_max%&          "safety net for retry rules"
13609 .endtable
13610
13611
13612
13613 .section "Bounce and warning messages" "SECID117"
13614 .table2
13615 .row &%bounce_message_file%&         "content of bounce"
13616 .row &%bounce_message_text%&         "content of bounce"
13617 .row &%bounce_return_body%&          "include body if returning message"
13618 .row &%bounce_return_message%&       "include original message in bounce"
13619 .row &%bounce_return_size_limit%&    "limit on returned message"
13620 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13621 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13622 .row &%errors_copy%&                 "copy bounce messages"
13623 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13624 .row &%delay_warning%&               "time schedule"
13625 .row &%delay_warning_condition%&     "condition for warning messages"
13626 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13627 .row &%smtp_return_error_details%&   "give detail on rejections"
13628 .row &%warn_message_file%&           "content of warning message"
13629 .endtable
13630
13631
13632
13633 .section "Alphabetical list of main options" "SECTalomo"
13634 Those options that undergo string expansion before use are marked with
13635 &dagger;.
13636
13637 .option accept_8bitmime main boolean true
13638 .cindex "8BITMIME"
13639 .cindex "8-bit characters"
13640 .cindex "log" "selectors"
13641 .cindex "log" "8BITMIME"
13642 This option causes Exim to send 8BITMIME in its response to an SMTP
13643 EHLO command, and to accept the BODY= parameter on MAIL commands.
13644 However, though Exim is 8-bit clean, it is not a protocol converter, and it
13645 takes no steps to do anything special with messages received by this route.
13646
13647 Historically Exim kept this option off by default, but the maintainers
13648 feel that in today's Internet, this causes more problems than it solves.
13649 It now defaults to true.
13650 A more detailed analysis of the issues is provided by Dan Bernstein:
13651 .display
13652 &url(http://cr.yp.to/smtp/8bitmime.html)
13653 .endd
13654
13655 To log received 8BITMIME status use
13656 .code
13657 log_selector = +8bitmime
13658 .endd
13659
13660 .option acl_not_smtp main string&!! unset
13661 .cindex "&ACL;" "for non-SMTP messages"
13662 .cindex "non-SMTP messages" "ACLs for"
13663 This option defines the ACL that is run when a non-SMTP message has been
13664 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
13665 further details.
13666
13667 .option acl_not_smtp_mime main string&!! unset
13668 This option defines the ACL that is run for individual MIME parts of non-SMTP
13669 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
13670 SMTP messages.
13671
13672 .option acl_not_smtp_start main string&!! unset
13673 .cindex "&ACL;" "at start of non-SMTP message"
13674 .cindex "non-SMTP messages" "ACLs for"
13675 This option defines the ACL that is run before Exim starts reading a
13676 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
13677
13678 .option acl_smtp_auth main string&!! unset
13679 .cindex "&ACL;" "setting up for SMTP commands"
13680 .cindex "AUTH" "ACL for"
13681 This option defines the ACL that is run when an SMTP AUTH command is
13682 received. See chapter &<<CHAPACL>>& for further details.
13683
13684 .option acl_smtp_connect main string&!! unset
13685 .cindex "&ACL;" "on SMTP connection"
13686 This option defines the ACL that is run when an SMTP connection is received.
13687 See chapter &<<CHAPACL>>& for further details.
13688
13689 .option acl_smtp_data main string&!! unset
13690 .cindex "DATA" "ACL for"
13691 This option defines the ACL that is run after an SMTP DATA command has been
13692 processed and the message itself has been received, but before the final
13693 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13694
13695 .new
13696 .option acl_smtp_data_prdr main string&!! accept
13697 .cindex "PRDR" "ACL for"
13698 .cindex "DATA" "PRDR ACL for"
13699 .cindex "&ACL;" "PRDR-related"
13700 .cindex "&ACL;" "per-user data processing"
13701 .wen
13702 This option defines the ACL that,
13703 if the PRDR feature has been negotiated,
13704 is run for each recipient after an SMTP DATA command has been
13705 processed and the message itself has been received, but before the
13706 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
13707
13708 .option acl_smtp_dkim main string&!! unset
13709 .cindex DKIM "ACL for"
13710 This option defines the ACL that is run for each DKIM signature
13711 of a received message.
13712 See chapter &<<CHAPdkim>>& for further details.
13713
13714 .option acl_smtp_etrn main string&!! unset
13715 .cindex "ETRN" "ACL for"
13716 This option defines the ACL that is run when an SMTP ETRN command is
13717 received. See chapter &<<CHAPACL>>& for further details.
13718
13719 .option acl_smtp_expn main string&!! unset
13720 .cindex "EXPN" "ACL for"
13721 This option defines the ACL that is run when an SMTP EXPN command is
13722 received. See chapter &<<CHAPACL>>& for further details.
13723
13724 .option acl_smtp_helo main string&!! unset
13725 .cindex "EHLO" "ACL for"
13726 .cindex "HELO" "ACL for"
13727 This option defines the ACL that is run when an SMTP EHLO or HELO
13728 command is received. See chapter &<<CHAPACL>>& for further details.
13729
13730
13731 .option acl_smtp_mail main string&!! unset
13732 .cindex "MAIL" "ACL for"
13733 This option defines the ACL that is run when an SMTP MAIL command is
13734 received. See chapter &<<CHAPACL>>& for further details.
13735
13736 .option acl_smtp_mailauth main string&!! unset
13737 .cindex "AUTH" "on MAIL command"
13738 This option defines the ACL that is run when there is an AUTH parameter on
13739 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
13740 &<<CHAPSMTPAUTH>>& for details of authentication.
13741
13742 .option acl_smtp_mime main string&!! unset
13743 .cindex "MIME content scanning" "ACL for"
13744 This option is available when Exim is built with the content-scanning
13745 extension. It defines the ACL that is run for each MIME part in a message. See
13746 section &<<SECTscanmimepart>>& for details.
13747
13748 .option acl_smtp_notquit main string&!! unset
13749 .cindex "not-QUIT, ACL for"
13750 This option defines the ACL that is run when an SMTP session
13751 ends without a QUIT command being received.
13752 See chapter &<<CHAPACL>>& for further details.
13753
13754 .option acl_smtp_predata main string&!! unset
13755 This option defines the ACL that is run when an SMTP DATA command is
13756 received, before the message itself is received. See chapter &<<CHAPACL>>& for
13757 further details.
13758
13759 .option acl_smtp_quit main string&!! unset
13760 .cindex "QUIT, ACL for"
13761 This option defines the ACL that is run when an SMTP QUIT command is
13762 received. See chapter &<<CHAPACL>>& for further details.
13763
13764 .option acl_smtp_rcpt main string&!! unset
13765 .cindex "RCPT" "ACL for"
13766 This option defines the ACL that is run when an SMTP RCPT command is
13767 received. See chapter &<<CHAPACL>>& for further details.
13768
13769 .option acl_smtp_starttls main string&!! unset
13770 .cindex "STARTTLS, ACL for"
13771 This option defines the ACL that is run when an SMTP STARTTLS command is
13772 received. See chapter &<<CHAPACL>>& for further details.
13773
13774 .option acl_smtp_vrfy main string&!! unset
13775 .cindex "VRFY" "ACL for"
13776 This option defines the ACL that is run when an SMTP VRFY command is
13777 received. See chapter &<<CHAPACL>>& for further details.
13778
13779 .option admin_groups main "string list&!!" unset
13780 .cindex "admin user"
13781 This option is expanded just once, at the start of Exim's processing. If the
13782 current group or any of the supplementary groups of an Exim caller is in this
13783 colon-separated list, the caller has admin privileges. If all your system
13784 programmers are in a specific group, for example, you can give them all Exim
13785 admin privileges by putting that group in &%admin_groups%&. However, this does
13786 not permit them to read Exim's spool files (whose group owner is the Exim gid).
13787 To permit this, you have to add individuals to the Exim group.
13788
13789 .option allow_domain_literals main boolean false
13790 .cindex "domain literal"
13791 If this option is set, the RFC 2822 domain literal format is permitted in
13792 email addresses. The option is not set by default, because the domain literal
13793 format is not normally required these days, and few people know about it. It
13794 has, however, been exploited by mail abusers.
13795
13796 Unfortunately, it seems that some DNS black list maintainers are using this
13797 format to report black listing to postmasters. If you want to accept messages
13798 addressed to your hosts by IP address, you need to set
13799 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
13800 domains (defined in the named domain list &%local_domains%& in the default
13801 configuration). This &"magic string"& matches the domain literal form of all
13802 the local host's IP addresses.
13803
13804
13805 .option allow_mx_to_ip main boolean false
13806 .cindex "MX record" "pointing to IP address"
13807 It appears that more and more DNS zone administrators are breaking the rules
13808 and putting domain names that look like IP addresses on the right hand side of
13809 MX records. Exim follows the rules and rejects this, giving an error message
13810 that explains the mis-configuration. However, some other MTAs support this
13811 practice, so to avoid &"Why can't Exim do this?"& complaints,
13812 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
13813 recommended, except when you have no other choice.
13814
13815 .option allow_utf8_domains main boolean false
13816 .cindex "domain" "UTF-8 characters in"
13817 .cindex "UTF-8" "in domain name"
13818 Lots of discussion is going on about internationalized domain names. One
13819 camp is strongly in favour of just using UTF-8 characters, and it seems
13820 that at least two other MTAs permit this. This option allows Exim users to
13821 experiment if they wish.
13822
13823 If it is set true, Exim's domain parsing function allows valid
13824 UTF-8 multicharacters to appear in domain name components, in addition to
13825 letters, digits, and hyphens. However, just setting this option is not
13826 enough; if you want to look up these domain names in the DNS, you must also
13827 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
13828 suitable setting is:
13829 .code
13830 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
13831   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
13832 .endd
13833 Alternatively, you can just disable this feature by setting
13834 .code
13835 dns_check_names_pattern =
13836 .endd
13837 That is, set the option to an empty string so that no check is done.
13838
13839
13840 .option auth_advertise_hosts main "host list&!!" *
13841 .cindex "authentication" "advertising"
13842 .cindex "AUTH" "advertising"
13843 If any server authentication mechanisms are configured, Exim advertises them in
13844 response to an EHLO command only if the calling host matches this list.
13845 Otherwise, Exim does not advertise AUTH.
13846 Exim does not accept AUTH commands from clients to which it has not
13847 advertised the availability of AUTH. The advertising of individual
13848 authentication mechanisms can be controlled by the use of the
13849 &%server_advertise_condition%& generic authenticator option on the individual
13850 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
13851
13852 Certain mail clients (for example, Netscape) require the user to provide a name
13853 and password for authentication if AUTH is advertised, even though it may
13854 not be needed (the host may accept messages from hosts on its local LAN without
13855 authentication, for example). The &%auth_advertise_hosts%& option can be used
13856 to make these clients more friendly by excluding them from the set of hosts to
13857 which Exim advertises AUTH.
13858
13859 .cindex "AUTH" "advertising when encrypted"
13860 If you want to advertise the availability of AUTH only when the connection
13861 is encrypted using TLS, you can make use of the fact that the value of this
13862 option is expanded, with a setting like this:
13863 .code
13864 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
13865 .endd
13866 .vindex "&$tls_in_cipher$&"
13867 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
13868 the expansion is empty, thus matching no hosts. Otherwise, the result of the
13869 expansion is *, which matches all hosts.
13870
13871
13872 .option auto_thaw main time 0s
13873 .cindex "thawing messages"
13874 .cindex "unfreezing messages"
13875 If this option is set to a time greater than zero, a queue runner will try a
13876 new delivery attempt on any frozen message, other than a bounce message, if
13877 this much time has passed since it was frozen. This may result in the message
13878 being re-frozen if nothing has changed since the last attempt. It is a way of
13879 saying &"keep on trying, even though there are big problems"&.
13880
13881 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
13882 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
13883 thought to be very useful any more, and its use should probably be avoided.
13884
13885
13886 .option av_scanner main string "see below"
13887 This option is available if Exim is built with the content-scanning extension.
13888 It specifies which anti-virus scanner to use. The default value is:
13889 .code
13890 sophie:/var/run/sophie
13891 .endd
13892 If the value of &%av_scanner%& starts with a dollar character, it is expanded
13893 before use. See section &<<SECTscanvirus>>& for further details.
13894
13895
13896 .option bi_command main string unset
13897 .oindex "&%-bi%&"
13898 This option supplies the name of a command that is run when Exim is called with
13899 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
13900 just the command name, it is not a complete command line. If an argument is
13901 required, it must come from the &%-oA%& command line option.
13902
13903
13904 .option bounce_message_file main string unset
13905 .cindex "bounce message" "customizing"
13906 .cindex "customizing" "bounce message"
13907 This option defines a template file containing paragraphs of text to be used
13908 for constructing bounce messages.  Details of the file's contents are given in
13909 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
13910
13911
13912 .option bounce_message_text main string unset
13913 When this option is set, its contents are included in the default bounce
13914 message immediately after &"This message was created automatically by mail
13915 delivery software."& It is not used if &%bounce_message_file%& is set.
13916
13917 .option bounce_return_body main boolean true
13918 .cindex "bounce message" "including body"
13919 This option controls whether the body of an incoming message is included in a
13920 bounce message when &%bounce_return_message%& is true. The default setting
13921 causes the entire message, both header and body, to be returned (subject to the
13922 value of &%bounce_return_size_limit%&). If this option is false, only the
13923 message header is included. In the case of a non-SMTP message containing an
13924 error that is detected during reception, only those header lines preceding the
13925 point at which the error was detected are returned.
13926 .cindex "bounce message" "including original"
13927
13928 .option bounce_return_message main boolean true
13929 If this option is set false, none of the original message is included in
13930 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
13931 &%bounce_return_body%&.
13932
13933
13934 .option bounce_return_size_limit main integer 100K
13935 .cindex "size" "of bounce, limit"
13936 .cindex "bounce message" "size limit"
13937 .cindex "limit" "bounce message size"
13938 This option sets a limit in bytes on the size of messages that are returned to
13939 senders as part of bounce messages when &%bounce_return_message%& is true. The
13940 limit should be less than the value of the global &%message_size_limit%& and of
13941 any &%message_size_limit%& settings on transports, to allow for the bounce text
13942 that Exim generates. If this option is set to zero there is no limit.
13943
13944 When the body of any message that is to be included in a bounce message is
13945 greater than the limit, it is truncated, and a comment pointing this out is
13946 added at the top. The actual cutoff may be greater than the value given, owing
13947 to the use of buffering for transferring the message in chunks (typically 8K in
13948 size). The idea is to save bandwidth on those undeliverable 15-megabyte
13949 messages.
13950
13951 .option bounce_sender_authentication main string unset
13952 .cindex "bounce message" "sender authentication"
13953 .cindex "authentication" "bounce message"
13954 .cindex "AUTH" "on bounce message"
13955 This option provides an authenticated sender address that is sent with any
13956 bounce messages generated by Exim that are sent over an authenticated SMTP
13957 connection. A typical setting might be:
13958 .code
13959 bounce_sender_authentication = mailer-daemon@my.domain.example
13960 .endd
13961 which would cause bounce messages to be sent using the SMTP command:
13962 .code
13963 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
13964 .endd
13965 The value of &%bounce_sender_authentication%& must always be a complete email
13966 address.
13967
13968 .option callout_domain_negative_expire main time 3h
13969 .cindex "caching" "callout timeouts"
13970 .cindex "callout" "caching timeouts"
13971 This option specifies the expiry time for negative callout cache data for a
13972 domain. See section &<<SECTcallver>>& for details of callout verification, and
13973 section &<<SECTcallvercache>>& for details of the caching.
13974
13975
13976 .option callout_domain_positive_expire main time 7d
13977 This option specifies the expiry time for positive callout cache data for a
13978 domain. See section &<<SECTcallver>>& for details of callout verification, and
13979 section &<<SECTcallvercache>>& for details of the caching.
13980
13981
13982 .option callout_negative_expire main time 2h
13983 This option specifies the expiry time for negative callout cache data for an
13984 address. See section &<<SECTcallver>>& for details of callout verification, and
13985 section &<<SECTcallvercache>>& for details of the caching.
13986
13987
13988 .option callout_positive_expire main time 24h
13989 This option specifies the expiry time for positive callout cache data for an
13990 address. See section &<<SECTcallver>>& for details of callout verification, and
13991 section &<<SECTcallvercache>>& for details of the caching.
13992
13993
13994 .option callout_random_local_part main string&!! "see below"
13995 This option defines the &"random"& local part that can be used as part of
13996 callout verification. The default value is
13997 .code
13998 $primary_hostname-$tod_epoch-testing
13999 .endd
14000 See section &<<CALLaddparcall>>& for details of how this value is used.
14001
14002
14003 .option check_log_inodes main integer 0
14004 See &%check_spool_space%& below.
14005
14006
14007 .option check_log_space main integer 0
14008 See &%check_spool_space%& below.
14009
14010 .oindex "&%check_rfc2047_length%&"
14011 .cindex "RFC 2047" "disabling length check"
14012 .option check_rfc2047_length main boolean true
14013 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14014 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14015 word; strings to be encoded that exceed this length are supposed to use
14016 multiple encoded words. By default, Exim does not recognize encoded words that
14017 exceed the maximum length. However, it seems that some software, in violation
14018 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14019 set false, Exim recognizes encoded words of any length.
14020
14021
14022 .option check_spool_inodes main integer 0
14023 See &%check_spool_space%& below.
14024
14025
14026 .option check_spool_space main integer 0
14027 .cindex "checking disk space"
14028 .cindex "disk space, checking"
14029 .cindex "spool directory" "checking space"
14030 The four &%check_...%& options allow for checking of disk resources before a
14031 message is accepted.
14032
14033 .vindex "&$log_inodes$&"
14034 .vindex "&$log_space$&"
14035 .vindex "&$spool_inodes$&"
14036 .vindex "&$spool_space$&"
14037 When any of these options are set, they apply to all incoming messages. If you
14038 want to apply different checks to different kinds of message, you can do so by
14039 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14040 &$spool_space$& in an ACL with appropriate additional conditions.
14041
14042
14043 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14044 either value is greater than zero, for example:
14045 .code
14046 check_spool_space = 10M
14047 check_spool_inodes = 100
14048 .endd
14049 The spool partition is the one that contains the directory defined by
14050 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14051 transit.
14052
14053 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14054 files are written if either is greater than zero. These should be set only if
14055 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14056
14057 If there is less space or fewer inodes than requested, Exim refuses to accept
14058 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14059 error response to the MAIL command. If ESMTP is in use and there was a
14060 SIZE parameter on the MAIL command, its value is added to the
14061 &%check_spool_space%& value, and the check is performed even if
14062 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14063
14064 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14065 number of kilobytes. If a non-multiple of 1024 is specified, it is rounded up.
14066
14067 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14068 failure a message is written to stderr and Exim exits with a non-zero code, as
14069 it obviously cannot send an error message of any kind.
14070
14071 .option daemon_smtp_ports main string &`smtp`&
14072 .cindex "port" "for daemon"
14073 .cindex "TCP/IP" "setting listening ports"
14074 This option specifies one or more default SMTP ports on which the Exim daemon
14075 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14076 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14077
14078 .option daemon_startup_retries main integer 9
14079 .cindex "daemon startup, retrying"
14080 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14081 the daemon at startup when it cannot immediately bind a listening socket
14082 (typically because the socket is already in use): &%daemon_startup_retries%&
14083 defines the number of retries after the first failure, and
14084 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14085
14086 .option daemon_startup_sleep main time 30s
14087 See &%daemon_startup_retries%&.
14088
14089 .option delay_warning main "time list" 24h
14090 .cindex "warning of delay"
14091 .cindex "delay warning, specifying"
14092 When a message is delayed, Exim sends a warning message to the sender at
14093 intervals specified by this option. The data is a colon-separated list of times
14094 after which to send warning messages. If the value of the option is an empty
14095 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14096 message has been on the queue for longer than the last time, the last interval
14097 between the times is used to compute subsequent warning times. For example,
14098 with
14099 .code
14100 delay_warning = 4h:8h:24h
14101 .endd
14102 the first message is sent after 4 hours, the second after 8 hours, and
14103 the third one after 24 hours. After that, messages are sent every 16 hours,
14104 because that is the interval between the last two times on the list. If you set
14105 just one time, it specifies the repeat interval. For example, with:
14106 .code
14107 delay_warning = 6h
14108 .endd
14109 messages are repeated every six hours. To stop warnings after a given time, set
14110 a very large time at the end of the list. For example:
14111 .code
14112 delay_warning = 2h:12h:99d
14113 .endd
14114 Note that the option is only evaluated at the time a delivery attempt fails,
14115 which depends on retry and queue-runner configuration.
14116 Typically retries will be configured more frequently than warning messages.
14117
14118 .option delay_warning_condition main string&!! "see below"
14119 .vindex "&$domain$&"
14120 The string is expanded at the time a warning message might be sent. If all the
14121 deferred addresses have the same domain, it is set in &$domain$& during the
14122 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14123 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14124 &"false"& (the comparison being done caselessly) then the warning message is
14125 not sent. The default is:
14126 .code
14127 delay_warning_condition = ${if or {\
14128   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14129   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14130   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14131   } {no}{yes}}
14132 .endd
14133 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14134 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14135 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14136 &"auto-replied"& in an &'Auto-Submitted:'& header.
14137
14138 .option deliver_drop_privilege main boolean false
14139 .cindex "unprivileged delivery"
14140 .cindex "delivery" "unprivileged"
14141 If this option is set true, Exim drops its root privilege at the start of a
14142 delivery process, and runs as the Exim user throughout. This severely restricts
14143 the kinds of local delivery that are possible, but is viable in certain types
14144 of configuration. There is a discussion about the use of root privilege in
14145 chapter &<<CHAPsecurity>>&.
14146
14147 .option deliver_queue_load_max main fixed-point unset
14148 .cindex "load average"
14149 .cindex "queue runner" "abandoning"
14150 When this option is set, a queue run is abandoned if the system load average
14151 becomes greater than the value of the option. The option has no effect on
14152 ancient operating systems on which Exim cannot determine the load average.
14153 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14154
14155
14156 .option delivery_date_remove main boolean true
14157 .cindex "&'Delivery-date:'& header line"
14158 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14159 message when it is delivered, in exactly the same way as &'Return-path:'& is
14160 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14161 should not be present in incoming messages, and this option causes them to be
14162 removed at the time the message is received, to avoid any problems that might
14163 occur when a delivered message is subsequently sent on to some other recipient.
14164
14165 .option disable_fsync main boolean false
14166 .cindex "&[fsync()]&, disabling"
14167 This option is available only if Exim was built with the compile-time option
14168 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14169 a runtime configuration generates an &"unknown option"& error. You should not
14170 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14171 really, really, really understand what you are doing. &'No pre-compiled
14172 distributions of Exim should ever make this option available.'&
14173
14174 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14175 updated files' data to be written to disc before continuing. Unexpected events
14176 such as crashes and power outages may cause data to be lost or scrambled.
14177 Here be Dragons. &*Beware.*&
14178
14179
14180 .option disable_ipv6 main boolean false
14181 .cindex "IPv6" "disabling"
14182 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14183 activities take place. AAAA records are never looked up, and any IPv6 addresses
14184 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14185 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14186 to handle IPv6 literal addresses.
14187
14188
14189 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14190 .cindex DKIM "controlling calls to the ACL"
14191 This option gives a list of DKIM domains for which the DKIM ACL is run.
14192 It is expanded after the message is received; by default it runs
14193 the ACL once for each signature in the message.
14194 See chapter &<<CHAPdkim>>&.
14195
14196
14197 .option dns_again_means_nonexist main "domain list&!!" unset
14198 .cindex "DNS" "&""try again""& response; overriding"
14199 DNS lookups give a &"try again"& response for the DNS errors
14200 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14201 keep trying to deliver a message, or to give repeated temporary errors to
14202 incoming mail. Sometimes the effect is caused by a badly set up name server and
14203 may persist for a long time. If a domain which exhibits this problem matches
14204 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14205 This option should be used with care. You can make it apply to reverse lookups
14206 by a setting such as this:
14207 .code
14208 dns_again_means_nonexist = *.in-addr.arpa
14209 .endd
14210 This option applies to all DNS lookups that Exim does. It also applies when the
14211 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14212 since these are most likely to be caused by DNS lookup problems. The
14213 &(dnslookup)& router has some options of its own for controlling what happens
14214 when lookups for MX or SRV records give temporary errors. These more specific
14215 options are applied after this global option.
14216
14217 .option dns_check_names_pattern main string "see below"
14218 .cindex "DNS" "pre-check of name syntax"
14219 When this option is set to a non-empty string, it causes Exim to check domain
14220 names for characters that are not allowed in host names before handing them to
14221 the DNS resolver, because some resolvers give temporary errors for names that
14222 contain unusual characters. If a domain name contains any unwanted characters,
14223 a &"not found"& result is forced, and the resolver is not called. The check is
14224 done by matching the domain name against a regular expression, which is the
14225 value of this option. The default pattern is
14226 .code
14227 dns_check_names_pattern = \
14228   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14229 .endd
14230 which permits only letters, digits, slashes, and hyphens in components, but
14231 they must start and end with a letter or digit. Slashes are not, in fact,
14232 permitted in host names, but they are found in certain NS records (which can be
14233 accessed in Exim by using a &%dnsdb%& lookup). If you set
14234 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14235 empty string.
14236
14237 .option dns_csa_search_limit main integer 5
14238 This option controls the depth of parental searching for CSA SRV records in the
14239 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14240
14241 .option dns_csa_use_reverse main boolean true
14242 This option controls whether or not an IP address, given as a CSA domain, is
14243 reversed and looked up in the reverse DNS, as described in more detail in
14244 section &<<SECTverifyCSA>>&.
14245
14246
14247 .option dns_dnssec_ok main integer -1
14248 .cindex "DNS" "resolver options"
14249 .cindex "DNS" "DNSSEC"
14250 If this option is set to a non-negative number then Exim will initialise the
14251 DNS resolver library to either use or not use DNSSEC, overriding the system
14252 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14253
14254 If the resolver library does not support DNSSEC then this option has no effect.
14255
14256
14257 .option dns_ipv4_lookup main "domain list&!!" unset
14258 .cindex "IPv6" "DNS lookup for AAAA records"
14259 .cindex "DNS" "IPv6 lookup for AAAA records"
14260 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14261 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14262 (A records) when trying to find IP addresses for hosts, unless the host's
14263 domain matches this list.
14264
14265 This is a fudge to help with name servers that give big delays or otherwise do
14266 not work for the AAAA record type. In due course, when the world's name
14267 servers have all been upgraded, there should be no need for this option.
14268
14269
14270 .option dns_retrans main time 0s
14271 .cindex "DNS" "resolver options"
14272 .cindex timeout "dns lookup"
14273 .cindex "DNS" timeout
14274 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14275 retransmission and retry parameters for DNS lookups. Values of zero (the
14276 defaults) leave the system default settings unchanged. The first value is the
14277 time between retries, and the second is the number of retries. It isn't
14278 totally clear exactly how these settings affect the total time a DNS lookup may
14279 take. I haven't found any documentation about timeouts on DNS lookups; these
14280 parameter values are available in the external resolver interface structure,
14281 but nowhere does it seem to describe how they are used or what you might want
14282 to set in them.
14283 See also the &%slow_lookup_log%& option.
14284
14285
14286 .option dns_retry main integer 0
14287 See &%dns_retrans%& above.
14288
14289
14290 .option dns_trust_aa main domain list&!! unset
14291 .cindex "DNS" "resolver options"
14292 .cindex "DNS" "DNSSEC"
14293 If this option is set then lookup results marked with an AA bit
14294 (Authoratative Answer) are trusted when they come from one
14295 of the listed domains, as if they were marked as having been
14296 DNSSEC-verified.
14297
14298 Use this option only if you talk directly to the resolver
14299 for your local domains, and list only it.
14300 It is needed when the resolver does not return an AD bit
14301 for its local domains.
14302 The first SOA or NS record appearing in the results is compared
14303 against the option value.
14304
14305
14306 .cindex "DNS" "resolver options"
14307 .option dns_use_edns0 main integer -1
14308 .cindex "DNS" "resolver options"
14309 .cindex "DNS" "EDNS0"
14310 If this option is set to a non-negative number then Exim will initialise the
14311 DNS resolver library to either use or not use EDNS0 extensions, overriding
14312 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14313 on.
14314
14315 If the resolver library does not support EDNS0 then this option has no effect.
14316
14317
14318 .option drop_cr main boolean false
14319 This is an obsolete option that is now a no-op. It used to affect the way Exim
14320 handled CR and LF characters in incoming messages. What happens now is
14321 described in section &<<SECTlineendings>>&.
14322
14323 .new
14324 .option dsn_advertise_hosts main "host list&!!" unset
14325 .cindex "bounce messages" "success"
14326 .cindex "DSN" "success"
14327 .cindex "Delivery Status Notification" "success"
14328 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14329 and accepted from, these hosts.
14330 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14331 and RET and ORCPT options on MAIL FROM commands.
14332 A NOTIFY=SUCCESS option requests success-DSN messages.
14333 A NOTIFY= option with no argument requests that no delay or failure DSNs
14334 are sent.
14335 .wen
14336
14337 .option dsn_from main "string&!!" "see below"
14338 .cindex "&'From:'& header line" "in bounces"
14339 .cindex "bounce messages" "&'From:'& line, specifying"
14340 This option can be used to vary the contents of &'From:'& header lines in
14341 bounces and other automatically generated messages (&"Delivery Status
14342 Notifications"& &-- hence the name of the option). The default setting is:
14343 .code
14344 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14345 .endd
14346 The value is expanded every time it is needed. If the expansion fails, a
14347 panic is logged, and the default value is used.
14348
14349 .option envelope_to_remove main boolean true
14350 .cindex "&'Envelope-to:'& header line"
14351 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14352 message when it is delivered, in exactly the same way as &'Return-path:'& is
14353 handled. &'Envelope-to:'& records the original recipient address from the
14354 messages's envelope that caused the delivery to happen. Such headers should not
14355 be present in incoming messages, and this option causes them to be removed at
14356 the time the message is received, to avoid any problems that might occur when a
14357 delivered message is subsequently sent on to some other recipient.
14358
14359
14360 .option errors_copy main "string list&!!" unset
14361 .cindex "bounce message" "copy to other address"
14362 .cindex "copy of bounce message"
14363 Setting this option causes Exim to send bcc copies of bounce messages that it
14364 generates to other addresses. &*Note*&: This does not apply to bounce messages
14365 coming from elsewhere. The value of the option is a colon-separated list of
14366 items. Each item consists of a pattern, terminated by white space, followed by
14367 a comma-separated list of email addresses. If a pattern contains spaces, it
14368 must be enclosed in double quotes.
14369
14370 Each pattern is processed in the same way as a single item in an address list
14371 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14372 the bounce message, the message is copied to the addresses on the list. The
14373 items are scanned in order, and once a matching one is found, no further items
14374 are examined. For example:
14375 .code
14376 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14377               rqps@mydomain   hostmaster@mydomain.example,\
14378                               postmaster@mydomain.example
14379 .endd
14380 .vindex "&$domain$&"
14381 .vindex "&$local_part$&"
14382 The address list is expanded before use. The expansion variables &$local_part$&
14383 and &$domain$& are set from the original recipient of the error message, and if
14384 there was any wildcard matching in the pattern, the expansion
14385 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14386 variables &$0$&, &$1$&, etc. are set in the normal way.
14387
14388
14389 .option errors_reply_to main string unset
14390 .cindex "bounce message" "&'Reply-to:'& in"
14391 By default, Exim's bounce and delivery warning messages contain the header line
14392 .display
14393 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14394 .endd
14395 .oindex &%quota_warn_message%&
14396 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14397 A warning message that is generated by the &%quota_warn_message%& option in an
14398 &(appendfile)& transport may contain its own &'From:'& header line that
14399 overrides the default.
14400
14401 Experience shows that people reply to bounce messages. If the
14402 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14403 and warning messages. For example:
14404 .code
14405 errors_reply_to = postmaster@my.domain.example
14406 .endd
14407 The value of the option is not expanded. It must specify a valid RFC 2822
14408 address. However, if a warning message that is generated by the
14409 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14410 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14411 not used.
14412
14413
14414 .option exim_group main string "compile-time configured"
14415 .cindex "gid (group id)" "Exim's own"
14416 .cindex "Exim group"
14417 This option changes the gid under which Exim runs when it gives up root
14418 privilege. The default value is compiled into the binary. The value of this
14419 option is used only when &%exim_user%& is also set. Unless it consists entirely
14420 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14421 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14422 security issues.
14423
14424
14425 .option exim_path main string "see below"
14426 .cindex "Exim binary, path name"
14427 This option specifies the path name of the Exim binary, which is used when Exim
14428 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14429 the directory configured at compile time by the BIN_DIRECTORY setting. It
14430 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14431 other place.
14432 &*Warning*&: Do not use a macro to define the value of this option, because
14433 you will break those Exim utilities that scan the configuration file to find
14434 where the binary is. (They then use the &%-bP%& option to extract option
14435 settings such as the value of &%spool_directory%&.)
14436
14437
14438 .option exim_user main string "compile-time configured"
14439 .cindex "uid (user id)" "Exim's own"
14440 .cindex "Exim user"
14441 This option changes the uid under which Exim runs when it gives up root
14442 privilege. The default value is compiled into the binary. Ownership of the run
14443 time configuration file and the use of the &%-C%& and &%-D%& command line
14444 options is checked against the values in the binary, not what is set here.
14445
14446 Unless it consists entirely of digits, the string is looked up using
14447 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14448 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14449 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14450
14451
14452 .option extra_local_interfaces main "string list" unset
14453 This option defines network interfaces that are to be considered local when
14454 routing, but which are not used for listening by the daemon. See section
14455 &<<SECTreclocipadd>>& for details.
14456
14457
14458 . Allow this long option name to split; give it unsplit as a fifth argument
14459 . for the automatic .oindex that is generated by .option.
14460
14461 .option "extract_addresses_remove_ &~&~arguments" main boolean true &&&
14462          extract_addresses_remove_arguments
14463 .oindex "&%-t%&"
14464 .cindex "command line" "addresses with &%-t%&"
14465 .cindex "Sendmail compatibility" "&%-t%& option"
14466 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14467 are present on the command line when the &%-t%& option is used to build an
14468 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14469 line addresses are removed from the recipients list. This is also how Smail
14470 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14471 command line addresses are added to those obtained from the header lines. When
14472 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14473 argument headers. If it is set false, Exim adds rather than removes argument
14474 addresses.
14475
14476
14477 .option finduser_retries main integer 0
14478 .cindex "NIS, retrying user lookups"
14479 On systems running NIS or other schemes in which user and group information is
14480 distributed from a remote system, there can be times when &[getpwnam()]& and
14481 related functions fail, even when given valid data, because things time out.
14482 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14483 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14484 many extra times to find a user or a group, waiting for one second between
14485 retries.
14486
14487 .cindex "&_/etc/passwd_&" "multiple reading of"
14488 You should not set this option greater than zero if your user information is in
14489 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14490 search the file multiple times for non-existent users, and also cause delay.
14491
14492
14493
14494 .option freeze_tell main "string list, comma separated" unset
14495 .cindex "freezing messages" "sending a message when freezing"
14496 On encountering certain errors, or when configured to do so in a system filter,
14497 ACL, or special router, Exim freezes a message. This means that no further
14498 delivery attempts take place until an administrator thaws the message, or the
14499 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14500 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14501 warning message whenever it freezes something, unless the message it is
14502 freezing is a locally-generated bounce message. (Without this exception there
14503 is the possibility of looping.) The warning message is sent to the addresses
14504 supplied as the comma-separated value of this option. If several of the
14505 message's addresses cause freezing, only a single message is sent. If the
14506 freezing was automatic, the reason(s) for freezing can be found in the message
14507 log. If you configure freezing in a filter or ACL, you must arrange for any
14508 logging that you require.
14509
14510
14511 .option gecos_name main string&!! unset
14512 .cindex "HP-UX"
14513 .cindex "&""gecos""& field, parsing"
14514 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14515 password file to hold other information in addition to users' real names. Exim
14516 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14517 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14518 of the field are used unchanged, except that, if an ampersand is encountered,
14519 it is replaced by the user's login name with the first character forced to
14520 upper case, since this is a convention that is observed on many systems.
14521
14522 When these options are set, &%gecos_pattern%& is treated as a regular
14523 expression that is to be applied to the field (again with && replaced by the
14524 login name), and if it matches, &%gecos_name%& is expanded and used as the
14525 user's name.
14526
14527 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14528 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14529 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14530 name terminates at the first comma, the following can be used:
14531 .code
14532 gecos_pattern = ([^,]*)
14533 gecos_name = $1
14534 .endd
14535
14536 .option gecos_pattern main string unset
14537 See &%gecos_name%& above.
14538
14539
14540 .option gnutls_compat_mode main boolean unset
14541 This option controls whether GnuTLS is used in compatibility mode in an Exim
14542 server. This reduces security slightly, but improves interworking with older
14543 implementations of TLS.
14544
14545
14546 option gnutls_allow_auto_pkcs11 main boolean unset
14547 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14548 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14549
14550 See
14551 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14552 for documentation.
14553
14554
14555
14556 .option headers_charset main string "see below"
14557 This option sets a default character set for translating from encoded MIME
14558 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14559 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14560 ultimate default is ISO-8859-1. For more details see the description of header
14561 insertions in section &<<SECTexpansionitems>>&.
14562
14563
14564
14565 .option header_maxsize main integer "see below"
14566 .cindex "header section" "maximum size of"
14567 .cindex "limit" "size of message header section"
14568 This option controls the overall maximum size of a message's header
14569 section. The default is the value of HEADER_MAXSIZE in
14570 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
14571 sections are rejected.
14572
14573
14574 .option header_line_maxsize main integer 0
14575 .cindex "header lines" "maximum size of"
14576 .cindex "limit" "size of one header line"
14577 This option limits the length of any individual header line in a message, after
14578 all the continuations have been joined together. Messages with individual
14579 header lines that are longer than the limit are rejected. The default value of
14580 zero means &"no limit"&.
14581
14582
14583
14584
14585 .option helo_accept_junk_hosts main "host list&!!" unset
14586 .cindex "HELO" "accepting junk data"
14587 .cindex "EHLO" "accepting junk data"
14588 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
14589 mail, and gives an error response for invalid data. Unfortunately, there are
14590 some SMTP clients that send syntactic junk. They can be accommodated by setting
14591 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
14592 if you want to do semantic checking.
14593 See also &%helo_allow_chars%& for a way of extending the permitted character
14594 set.
14595
14596
14597 .option helo_allow_chars main string unset
14598 .cindex "HELO" "underscores in"
14599 .cindex "EHLO" "underscores in"
14600 .cindex "underscore in EHLO/HELO"
14601 This option can be set to a string of rogue characters that are permitted in
14602 all EHLO and HELO names in addition to the standard letters, digits,
14603 hyphens, and dots. If you really must allow underscores, you can set
14604 .code
14605 helo_allow_chars = _
14606 .endd
14607 Note that the value is one string, not a list.
14608
14609
14610 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
14611 .cindex "HELO" "forcing reverse lookup"
14612 .cindex "EHLO" "forcing reverse lookup"
14613 If the domain given by a client in a HELO or EHLO command matches this
14614 list, a reverse lookup is done in order to establish the host's true name. The
14615 default forces a lookup if the client host gives the server's name or any of
14616 its IP addresses (in brackets), something that broken clients have been seen to
14617 do.
14618
14619
14620 .option helo_try_verify_hosts main "host list&!!" unset
14621 .cindex "HELO verifying" "optional"
14622 .cindex "EHLO" "verifying, optional"
14623 By default, Exim just checks the syntax of HELO and EHLO commands (see
14624 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
14625 to do more extensive checking of the data supplied by these commands. The ACL
14626 condition &`verify = helo`& is provided to make this possible.
14627 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
14628 to force the check to occur. From release 4.53 onwards, this is no longer
14629 necessary. If the check has not been done before &`verify = helo`& is
14630 encountered, it is done at that time. Consequently, this option is obsolete.
14631 Its specification is retained here for backwards compatibility.
14632
14633 When an EHLO or HELO command is received, if the calling host matches
14634 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
14635 EHLO command either:
14636
14637 .ilist
14638 is an IP literal matching the calling address of the host, or
14639 .next
14640 .cindex "DNS" "reverse lookup"
14641 .cindex "reverse DNS lookup"
14642 matches the host name that Exim obtains by doing a reverse lookup of the
14643 calling host address, or
14644 .next
14645 when looked up in DNS yields the calling host address.
14646 .endlist
14647
14648 However, the EHLO or HELO command is not rejected if any of the checks
14649 fail. Processing continues, but the result of the check is remembered, and can
14650 be detected later in an ACL by the &`verify = helo`& condition.
14651
14652 If DNS was used for successful verification, the variable
14653 .cindex "DNS" "DNSSEC"
14654 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
14655
14656 .option helo_verify_hosts main "host list&!!" unset
14657 .cindex "HELO verifying" "mandatory"
14658 .cindex "EHLO" "verifying, mandatory"
14659 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
14660 backwards compatibility. For hosts that match this option, Exim checks the host
14661 name given in the HELO or EHLO in the same way as for
14662 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
14663 rejected with a 550 error, and entries are written to the main and reject logs.
14664 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
14665 error.
14666
14667 .option hold_domains main "domain list&!!" unset
14668 .cindex "domain" "delaying delivery"
14669 .cindex "delivery" "delaying certain domains"
14670 This option allows mail for particular domains to be held on the queue
14671 manually. The option is overridden if a message delivery is forced with the
14672 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
14673 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
14674 item in &%hold_domains%&, no routing or delivery for that address is done, and
14675 it is deferred every time the message is looked at.
14676
14677 This option is intended as a temporary operational measure for delaying the
14678 delivery of mail while some problem is being sorted out, or some new
14679 configuration tested. If you just want to delay the processing of some
14680 domains until a queue run occurs, you should use &%queue_domains%& or
14681 &%queue_smtp_domains%&, not &%hold_domains%&.
14682
14683 A setting of &%hold_domains%& does not override Exim's code for removing
14684 messages from the queue if they have been there longer than the longest retry
14685 time in any retry rule. If you want to hold messages for longer than the normal
14686 retry times, insert a dummy retry rule with a long retry time.
14687
14688
14689 .option host_lookup main "host list&!!" unset
14690 .cindex "host name" "lookup, forcing"
14691 Exim does not look up the name of a calling host from its IP address unless it
14692 is required to compare against some host list, or the host matches
14693 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
14694 option (which normally contains IP addresses rather than host names). The
14695 default configuration file contains
14696 .code
14697 host_lookup = *
14698 .endd
14699 which causes a lookup to happen for all hosts. If the expense of these lookups
14700 is felt to be too great, the setting can be changed or removed.
14701
14702 After a successful reverse lookup, Exim does a forward lookup on the name it
14703 has obtained, to verify that it yields the IP address that it started with. If
14704 this check fails, Exim behaves as if the name lookup failed.
14705
14706 .vindex "&$host_lookup_failed$&"
14707 .vindex "&$sender_host_name$&"
14708 After any kind of failure, the host name (in &$sender_host_name$&) remains
14709 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
14710 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
14711 &`verify = reverse_host_lookup`& in ACLs.
14712
14713
14714 .option host_lookup_order main "string list" &`bydns:byaddr`&
14715 This option specifies the order of different lookup methods when Exim is trying
14716 to find a host name from an IP address. The default is to do a DNS lookup
14717 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
14718 if that fails. You can change the order of these lookups, or omit one entirely,
14719 if you want.
14720
14721 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
14722 multiple PTR records in the DNS and the IP address is not listed in
14723 &_/etc/hosts_&. Different operating systems give different results in this
14724 case. That is why the default tries a DNS lookup first.
14725
14726
14727
14728 .option host_reject_connection main "host list&!!" unset
14729 .cindex "host" "rejecting connections from"
14730 If this option is set, incoming SMTP calls from the hosts listed are rejected
14731 as soon as the connection is made.
14732 This option is obsolete, and retained only for backward compatibility, because
14733 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
14734 connections immediately.
14735
14736 The ability to give an immediate rejection (either by this option or using an
14737 ACL) is provided for use in unusual cases. Many hosts will just try again,
14738 sometimes without much delay. Normally, it is better to use an ACL to reject
14739 incoming messages at a later stage, such as after RCPT commands. See
14740 chapter &<<CHAPACL>>&.
14741
14742
14743 .option hosts_connection_nolog main "host list&!!" unset
14744 .cindex "host" "not logging connections from"
14745 This option defines a list of hosts for which connection logging does not
14746 happen, even though the &%smtp_connection%& log selector is set. For example,
14747 you might want not to log SMTP connections from local processes, or from
14748 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
14749 the daemon; you should therefore strive to restrict its value to a short inline
14750 list of IP addresses and networks. To disable logging SMTP connections from
14751 local processes, you must create a host list with an empty item. For example:
14752 .code
14753 hosts_connection_nolog = :
14754 .endd
14755 If the &%smtp_connection%& log selector is not set, this option has no effect.
14756
14757
14758
14759 .option hosts_treat_as_local main "domain list&!!" unset
14760 .cindex "local host" "domains treated as"
14761 .cindex "host" "treated as local"
14762 If this option is set, any host names that match the domain list are treated as
14763 if they were the local host when Exim is scanning host lists obtained from MX
14764 records
14765 or other sources. Note that the value of this option is a domain list, not a
14766 host list, because it is always used to check host names, not IP addresses.
14767
14768 This option also applies when Exim is matching the special items
14769 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
14770 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
14771 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
14772 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
14773 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
14774 interfaces and recognizing the local host.
14775
14776
14777 .option ibase_servers main "string list" unset
14778 .cindex "InterBase" "server list"
14779 This option provides a list of InterBase servers and associated connection data,
14780 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
14781 The option is available only if Exim has been built with InterBase support.
14782
14783
14784
14785 .option ignore_bounce_errors_after main time 10w
14786 .cindex "bounce message" "discarding"
14787 .cindex "discarding bounce message"
14788 This option affects the processing of bounce messages that cannot be delivered,
14789 that is, those that suffer a permanent delivery failure. (Bounce messages that
14790 suffer temporary delivery failures are of course retried in the usual way.)
14791
14792 After a permanent delivery failure, bounce messages are frozen,
14793 because there is no sender to whom they can be returned. When a frozen bounce
14794 message has been on the queue for more than the given time, it is unfrozen at
14795 the next queue run, and a further delivery is attempted. If delivery fails
14796 again, the bounce message is discarded. This makes it possible to keep failed
14797 bounce messages around for a shorter time than the normal maximum retry time
14798 for frozen messages. For example,
14799 .code
14800 ignore_bounce_errors_after = 12h
14801 .endd
14802 retries failed bounce message deliveries after 12 hours, discarding any further
14803 failures. If the value of this option is set to a zero time period, bounce
14804 failures are discarded immediately. Setting a very long time (as in the default
14805 value) has the effect of disabling this option. For ways of automatically
14806 dealing with other kinds of frozen message, see &%auto_thaw%& and
14807 &%timeout_frozen_after%&.
14808
14809
14810 .option ignore_fromline_hosts main "host list&!!" unset
14811 .cindex "&""From""& line"
14812 .cindex "UUCP" "&""From""& line"
14813 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
14814 the headers of a message. By default this is treated as the start of the
14815 message's body, which means that any following headers are not recognized as
14816 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
14817 match those hosts that insist on sending it. If the sender is actually a local
14818 process rather than a remote host, and is using &%-bs%& to inject the messages,
14819 &%ignore_fromline_local%& must be set to achieve this effect.
14820
14821
14822 .option ignore_fromline_local main boolean false
14823 See &%ignore_fromline_hosts%& above.
14824
14825
14826 .option keep_malformed main time 4d
14827 This option specifies the length of time to keep messages whose spool files
14828 have been corrupted in some way. This should, of course, never happen. At the
14829 next attempt to deliver such a message, it gets removed. The incident is
14830 logged.
14831
14832
14833 .option ldap_ca_cert_dir main string unset
14834 .cindex "LDAP", "TLS CA certificate directory"
14835 This option indicates which directory contains CA certificates for verifying
14836 a TLS certificate presented by an LDAP server.
14837 While Exim does not provide a default value, your SSL library may.
14838 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14839 and constrained to be a directory.
14840
14841
14842 .option ldap_ca_cert_file main string unset
14843 .cindex "LDAP", "TLS CA certificate file"
14844 This option indicates which file contains CA certificates for verifying
14845 a TLS certificate presented by an LDAP server.
14846 While Exim does not provide a default value, your SSL library may.
14847 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
14848 and constrained to be a file.
14849
14850
14851 .option ldap_cert_file main string unset
14852 .cindex "LDAP" "TLS client certificate file"
14853 This option indicates which file contains an TLS client certificate which
14854 Exim should present to the LDAP server during TLS negotiation.
14855 Should be used together with &%ldap_cert_key%&.
14856
14857
14858 .option ldap_cert_key main string unset
14859 .cindex "LDAP" "TLS client key file"
14860 This option indicates which file contains the secret/private key to use
14861 to prove identity to the LDAP server during TLS negotiation.
14862 Should be used together with &%ldap_cert_file%&, which contains the
14863 identity to be proven.
14864
14865
14866 .option ldap_cipher_suite main string unset
14867 .cindex "LDAP" "TLS cipher suite"
14868 This controls the TLS cipher-suite negotiation during TLS negotiation with
14869 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
14870 cipher-suite options with OpenSSL (as used by LDAP client libraries).
14871
14872
14873 .option ldap_default_servers main "string list" unset
14874 .cindex "LDAP" "default servers"
14875 This option provides a list of LDAP servers which are tried in turn when an
14876 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
14877 details of LDAP queries. This option is available only when Exim has been built
14878 with LDAP support.
14879
14880
14881 .option ldap_require_cert main string unset.
14882 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
14883 This should be one of the values "hard", "demand", "allow", "try" or "never".
14884 A value other than one of these is interpreted as "never".
14885 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
14886 Although Exim does not set a default, the LDAP library probably defaults
14887 to hard/demand.
14888
14889
14890 .option ldap_start_tls main boolean false
14891 .cindex "LDAP" "whether or not to negotiate TLS"
14892 If set, Exim will attempt to negotiate TLS with the LDAP server when
14893 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
14894 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
14895 of SSL-on-connect.
14896 In the event of failure to negotiate TLS, the action taken is controlled
14897 by &%ldap_require_cert%&.
14898
14899
14900 .option ldap_version main integer unset
14901 .cindex "LDAP" "protocol version, forcing"
14902 This option can be used to force Exim to set a specific protocol version for
14903 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
14904 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
14905 the LDAP headers; otherwise it is 2. This option is available only when Exim
14906 has been built with LDAP support.
14907
14908
14909
14910 .option local_from_check main boolean true
14911 .cindex "&'Sender:'& header line" "disabling addition of"
14912 .cindex "&'From:'& header line" "disabling checking of"
14913 When a message is submitted locally (that is, not over a TCP/IP connection) by
14914 an untrusted user, Exim removes any existing &'Sender:'& header line, and
14915 checks that the &'From:'& header line matches the login of the calling user and
14916 the domain specified by &%qualify_domain%&.
14917
14918 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
14919 locally submitted message is automatically qualified by Exim, unless the
14920 &%-bnq%& command line option is used.
14921
14922 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
14923 on the local part. If the &'From:'& header line does not match, Exim adds a
14924 &'Sender:'& header with an address constructed from the calling user's login
14925 and the default qualify domain.
14926
14927 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
14928 and no &'Sender:'& header is ever added. If, in addition, you want to retain
14929 &'Sender:'& header lines supplied by untrusted users, you must also set
14930 &%local_sender_retain%& to be true.
14931
14932 .cindex "envelope sender"
14933 These options affect only the header lines in the message. The envelope sender
14934 is still forced to be the login id at the qualify domain unless
14935 &%untrusted_set_sender%& permits the user to supply an envelope sender.
14936
14937 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
14938 request similar header line checking. See section &<<SECTthesenhea>>&, which
14939 has more details about &'Sender:'& processing.
14940
14941
14942
14943
14944 .option local_from_prefix main string unset
14945 When Exim checks the &'From:'& header line of locally submitted messages for
14946 matching the login id (see &%local_from_check%& above), it can be configured to
14947 ignore certain prefixes and suffixes in the local part of the address. This is
14948 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
14949 appropriate lists, in the same form as the &%local_part_prefix%& and
14950 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
14951 example, if
14952 .code
14953 local_from_prefix = *-
14954 .endd
14955 is set, a &'From:'& line containing
14956 .code
14957 From: anything-user@your.domain.example
14958 .endd
14959 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
14960 matches the actual sender address that is constructed from the login name and
14961 qualify domain.
14962
14963
14964 .option local_from_suffix main string unset
14965 See &%local_from_prefix%& above.
14966
14967
14968 .option local_interfaces main "string list" "see below"
14969 This option controls which network interfaces are used by the daemon for
14970 listening; they are also used to identify the local host when routing. Chapter
14971 &<<CHAPinterfaces>>& contains a full description of this option and the related
14972 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
14973 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
14974 &%local_interfaces%& is
14975 .code
14976 local_interfaces = 0.0.0.0
14977 .endd
14978 when Exim is built without IPv6 support; otherwise it is
14979 .code
14980 local_interfaces = <; ::0 ; 0.0.0.0
14981 .endd
14982
14983 .option local_scan_timeout main time 5m
14984 .cindex "timeout" "for &[local_scan()]& function"
14985 .cindex "&[local_scan()]& function" "timeout"
14986 This timeout applies to the &[local_scan()]& function (see chapter
14987 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
14988 the incoming message is rejected with a temporary error if it is an SMTP
14989 message. For a non-SMTP message, the message is dropped and Exim ends with a
14990 non-zero code. The incident is logged on the main and reject logs.
14991
14992
14993
14994 .option local_sender_retain main boolean false
14995 .cindex "&'Sender:'& header line" "retaining from local submission"
14996 When a message is submitted locally (that is, not over a TCP/IP connection) by
14997 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
14998 do not want this to happen, you must set &%local_sender_retain%&, and you must
14999 also set &%local_from_check%& to be false (Exim will complain if you do not).
15000 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15001 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15002
15003
15004
15005
15006 .option localhost_number main string&!! unset
15007 .cindex "host" "locally unique number for"
15008 .cindex "message ids" "with multiple hosts"
15009 .vindex "&$localhost_number$&"
15010 Exim's message ids are normally unique only within the local host. If
15011 uniqueness among a set of hosts is required, each host must set a different
15012 value for the &%localhost_number%& option. The string is expanded immediately
15013 after reading the configuration file (so that a number can be computed from the
15014 host name, for example) and the result of the expansion must be a number in the
15015 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15016 systems). This is available in subsequent string expansions via the variable
15017 &$localhost_number$&. When &%localhost_number is set%&, the final two
15018 characters of the message id, instead of just being a fractional part of the
15019 time, are computed from the time and the local host number as described in
15020 section &<<SECTmessiden>>&.
15021
15022
15023
15024 .option log_file_path main "string list&!!" "set at compile time"
15025 .cindex "log" "file path for"
15026 This option sets the path which is used to determine the names of Exim's log
15027 files, or indicates that logging is to be to syslog, or both. It is expanded
15028 when Exim is entered, so it can, for example, contain a reference to the host
15029 name. If no specific path is set for the log files at compile or run time,
15030 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15031 they are written in a sub-directory called &_log_& in Exim's spool directory.
15032 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15033 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15034 used. If this string is fixed at your installation (contains no expansion
15035 variables) it is recommended that you do not set this option in the
15036 configuration file, but instead supply the path using LOG_FILE_PATH in
15037 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15038 early on &-- in particular, failure to read the configuration file.
15039
15040
15041 .option log_selector main string unset
15042 .cindex "log" "selectors"
15043 This option can be used to reduce or increase the number of things that Exim
15044 writes to its log files. Its argument is made up of names preceded by plus or
15045 minus characters. For example:
15046 .code
15047 log_selector = +arguments -retry_defer
15048 .endd
15049 A list of possible names and what they control is given in the chapter on
15050 logging, in section &<<SECTlogselector>>&.
15051
15052
15053 .option log_timezone main boolean false
15054 .cindex "log" "timezone for entries"
15055 .vindex "&$tod_log$&"
15056 .vindex "&$tod_zone$&"
15057 By default, the timestamps on log lines are in local time without the
15058 timezone. This means that if your timezone changes twice a year, the timestamps
15059 in log lines are ambiguous for an hour when the clocks go back. One way of
15060 avoiding this problem is to set the timezone to UTC. An alternative is to set
15061 &%log_timezone%& true. This turns on the addition of the timezone offset to
15062 timestamps in log lines. Turning on this option can add quite a lot to the size
15063 of log files because each line is extended by 6 characters. Note that the
15064 &$tod_log$& variable contains the log timestamp without the zone, but there is
15065 another variable called &$tod_zone$& that contains just the timezone offset.
15066
15067
15068 .option lookup_open_max main integer 25
15069 .cindex "too many open files"
15070 .cindex "open files, too many"
15071 .cindex "file" "too many open"
15072 .cindex "lookup" "maximum open files"
15073 .cindex "limit" "open files for lookups"
15074 This option limits the number of simultaneously open files for single-key
15075 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15076 Exim normally keeps these files open during routing, because often the same
15077 file is required several times. If the limit is reached, Exim closes the least
15078 recently used file. Note that if you are using the &'ndbm'& library, it
15079 actually opens two files for each logical DBM database, though it still counts
15080 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15081 open files"& errors with NDBM, you need to reduce the value of
15082 &%lookup_open_max%&.
15083
15084
15085 .option max_username_length main integer 0
15086 .cindex "length of login name"
15087 .cindex "user name" "maximum length"
15088 .cindex "limit" "user name length"
15089 Some operating systems are broken in that they truncate long arguments to
15090 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15091 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15092 an argument that is longer behaves as if &[getpwnam()]& failed.
15093
15094
15095 .option message_body_newlines main bool false
15096 .cindex "message body" "newlines in variables"
15097 .cindex "newline" "in message body variables"
15098 .vindex "&$message_body$&"
15099 .vindex "&$message_body_end$&"
15100 By default, newlines in the message body are replaced by spaces when setting
15101 the &$message_body$& and &$message_body_end$& expansion variables. If this
15102 option is set true, this no longer happens.
15103
15104
15105 .option message_body_visible main integer 500
15106 .cindex "body of message" "visible size"
15107 .cindex "message body" "visible size"
15108 .vindex "&$message_body$&"
15109 .vindex "&$message_body_end$&"
15110 This option specifies how much of a message's body is to be included in the
15111 &$message_body$& and &$message_body_end$& expansion variables.
15112
15113
15114 .option message_id_header_domain main string&!! unset
15115 .cindex "&'Message-ID:'& header line"
15116 If this option is set, the string is expanded and used as the right hand side
15117 (domain) of the &'Message-ID:'& header that Exim creates if a
15118 locally-originated incoming message does not have one. &"Locally-originated"&
15119 means &"not received over TCP/IP."&
15120 Otherwise, the primary host name is used.
15121 Only letters, digits, dot and hyphen are accepted; any other characters are
15122 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15123 empty string, the option is ignored.
15124
15125
15126 .option message_id_header_text main string&!! unset
15127 If this variable is set, the string is expanded and used to augment the text of
15128 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15129 message does not have one. The text of this header is required by RFC 2822 to
15130 take the form of an address. By default, Exim uses its internal message id as
15131 the local part, and the primary host name as the domain. If this option is set,
15132 it is expanded, and provided the expansion is not forced to fail, and does not
15133 yield an empty string, the result is inserted into the header immediately
15134 before the @, separated from the internal message id by a dot. Any characters
15135 that are illegal in an address are automatically converted into hyphens. This
15136 means that variables such as &$tod_log$& can be used, because the spaces and
15137 colons will become hyphens.
15138
15139
15140 .option message_logs main boolean true
15141 .cindex "message logs" "disabling"
15142 .cindex "log" "message log; disabling"
15143 If this option is turned off, per-message log files are not created in the
15144 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15145 Exim, by reducing the number of files involved in handling a message from a
15146 minimum of four (header spool file, body spool file, delivery journal, and
15147 per-message log) to three. The other major I/O activity is Exim's main log,
15148 which is not affected by this option.
15149
15150
15151 .option message_size_limit main string&!! 50M
15152 .cindex "message" "size limit"
15153 .cindex "limit" "message size"
15154 .cindex "size" "of message, limit"
15155 This option limits the maximum size of message that Exim will process. The
15156 value is expanded for each incoming connection so, for example, it can be made
15157 to depend on the IP address of the remote host for messages arriving via
15158 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15159 optionally followed by K or M.
15160
15161 &*Note*&: This limit cannot be made to depend on a message's sender or any
15162 other properties of an individual message, because it has to be advertised in
15163 the server's response to EHLO. String expansion failure causes a temporary
15164 error. A value of zero means no limit, but its use is not recommended. See also
15165 &%bounce_return_size_limit%&.
15166
15167 Incoming SMTP messages are failed with a 552 error if the limit is
15168 exceeded; locally-generated messages either get a stderr message or a delivery
15169 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15170 an oversized message is logged in both the main and the reject logs. See also
15171 the generic transport option &%message_size_limit%&, which limits the size of
15172 message that an individual transport can process.
15173
15174 If you use a virus-scanner and set this option to to a value larger than the
15175 maximum size that your virus-scanner is configured to support, you may get
15176 failures triggered by large mails.  The right size to configure for the
15177 virus-scanner depends upon what data is passed and the options in use but it's
15178 probably safest to just set it to a little larger than this value.  Eg, with a
15179 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15180 some problems may result.
15181
15182 A value of 0 will disable size limit checking; Exim will still advertise the
15183 SIZE extension in an EHLO response, but without a limit, so as to permit
15184 SMTP clients to still indicate the message size along with the MAIL verb.
15185
15186
15187 .option move_frozen_messages main boolean false
15188 .cindex "frozen messages" "moving"
15189 This option, which is available only if Exim has been built with the setting
15190 .code
15191 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15192 .endd
15193 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15194 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15195 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15196 standard utilities for handling such moved messages, and they do not show up in
15197 lists generated by &%-bp%& or by the Exim monitor.
15198
15199
15200 .option mua_wrapper main boolean false
15201 Setting this option true causes Exim to run in a very restrictive mode in which
15202 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15203 contains a full description of this facility.
15204
15205
15206
15207 .option mysql_servers main "string list" unset
15208 .cindex "MySQL" "server list"
15209 This option provides a list of MySQL servers and associated connection data, to
15210 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15211 option is available only if Exim has been built with MySQL support.
15212
15213
15214 .option never_users main "string list&!!" unset
15215 This option is expanded just once, at the start of Exim's processing. Local
15216 message deliveries are normally run in processes that are setuid to the
15217 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15218 It is usually desirable to prevent any deliveries from running as root, as a
15219 safety precaution.
15220
15221 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15222 list of users that must not be used for local deliveries. This list is fixed in
15223 the binary and cannot be overridden by the configuration file. By default, it
15224 contains just the single user name &"root"&. The &%never_users%& runtime option
15225 can be used to add more users to the fixed list.
15226
15227 If a message is to be delivered as one of the users on the fixed list or the
15228 &%never_users%& list, an error occurs, and delivery is deferred. A common
15229 example is
15230 .code
15231 never_users = root:daemon:bin
15232 .endd
15233 Including root is redundant if it is also on the fixed list, but it does no
15234 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15235 transport driver.
15236
15237
15238 .option openssl_options main "string list" "+no_sslv2"
15239 .cindex "OpenSSL "compatibility options"
15240 This option allows an administrator to adjust the SSL options applied
15241 by OpenSSL to connections.  It is given as a space-separated list of items,
15242 each one to be +added or -subtracted from the current value.
15243
15244 This option is only available if Exim is built against OpenSSL.  The values
15245 available for this option vary according to the age of your OpenSSL install.
15246 The &"all"& value controls a subset of flags which are available, typically
15247 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15248 list the values known on your system and Exim should support all the
15249 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15250 names lose the leading &"SSL_OP_"& and are lower-cased.
15251
15252 Note that adjusting the options can have severe impact upon the security of
15253 SSL as used by Exim.  It is possible to disable safety checks and shoot
15254 yourself in the foot in various unpleasant ways.  This option should not be
15255 adjusted lightly.  An unrecognised item will be detected at startup, by
15256 invoking Exim with the &%-bV%& flag.
15257
15258 The option affects Exim operating both as a server and as a client.
15259
15260 Historical note: prior to release 4.80, Exim defaulted this value to
15261 "+dont_insert_empty_fragments", which may still be needed for compatibility
15262 with some clients, but which lowers security by increasing exposure to
15263 some now infamous attacks.
15264
15265 Examples:
15266 .code
15267 # Make both old MS and old Eudora happy:
15268 openssl_options = -all +microsoft_big_sslv3_buffer \
15269                        +dont_insert_empty_fragments
15270
15271 # Disable older protocol versions:
15272 openssl_options = +no_sslv2 +no_sslv3
15273 .endd
15274
15275 Possible options may include:
15276 .ilist
15277 &`all`&
15278 .next
15279 &`allow_unsafe_legacy_renegotiation`&
15280 .next
15281 &`cipher_server_preference`&
15282 .next
15283 &`dont_insert_empty_fragments`&
15284 .next
15285 &`ephemeral_rsa`&
15286 .next
15287 &`legacy_server_connect`&
15288 .next
15289 &`microsoft_big_sslv3_buffer`&
15290 .next
15291 &`microsoft_sess_id_bug`&
15292 .next
15293 &`msie_sslv2_rsa_padding`&
15294 .next
15295 &`netscape_challenge_bug`&
15296 .next
15297 &`netscape_reuse_cipher_change_bug`&
15298 .next
15299 &`no_compression`&
15300 .next
15301 &`no_session_resumption_on_renegotiation`&
15302 .next
15303 &`no_sslv2`&
15304 .next
15305 &`no_sslv3`&
15306 .next
15307 &`no_ticket`&
15308 .next
15309 &`no_tlsv1`&
15310 .next
15311 &`no_tlsv1_1`&
15312 .next
15313 &`no_tlsv1_2`&
15314 .next
15315 &`safari_ecdhe_ecdsa_bug`&
15316 .next
15317 &`single_dh_use`&
15318 .next
15319 &`single_ecdh_use`&
15320 .next
15321 &`ssleay_080_client_dh_bug`&
15322 .next
15323 &`sslref2_reuse_cert_type_bug`&
15324 .next
15325 &`tls_block_padding_bug`&
15326 .next
15327 &`tls_d5_bug`&
15328 .next
15329 &`tls_rollback_bug`&
15330 .endlist
15331
15332 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15333 all clients connecting using the MacOS SecureTransport TLS facility prior
15334 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15335 to negotiate TLS then this option value might help, provided that your OpenSSL
15336 release is new enough to contain this work-around.  This may be a situation
15337 where you have to upgrade OpenSSL to get buggy clients working.
15338
15339
15340 .option oracle_servers main "string list" unset
15341 .cindex "Oracle" "server list"
15342 This option provides a list of Oracle servers and associated connection data,
15343 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15344 The option is available only if Exim has been built with Oracle support.
15345
15346
15347 .option percent_hack_domains main "domain list&!!" unset
15348 .cindex "&""percent hack""&"
15349 .cindex "source routing" "in email address"
15350 .cindex "address" "source-routed"
15351 The &"percent hack"& is the convention whereby a local part containing a
15352 percent sign is re-interpreted as a new email address, with the percent
15353 replaced by @. This is sometimes called &"source routing"&, though that term is
15354 also applied to RFC 2822 addresses that begin with an @ character. If this
15355 option is set, Exim implements the percent facility for those domains listed,
15356 but no others. This happens before an incoming SMTP address is tested against
15357 an ACL.
15358
15359 &*Warning*&: The &"percent hack"& has often been abused by people who are
15360 trying to get round relaying restrictions. For this reason, it is best avoided
15361 if at all possible. Unfortunately, a number of less security-conscious MTAs
15362 implement it unconditionally. If you are running Exim on a gateway host, and
15363 routing mail through to internal MTAs without processing the local parts, it is
15364 a good idea to reject recipient addresses with percent characters in their
15365 local parts. Exim's default configuration does this.
15366
15367
15368 .option perl_at_start main boolean false
15369 This option is available only when Exim is built with an embedded Perl
15370 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15371
15372
15373 .option perl_startup main string unset
15374 This option is available only when Exim is built with an embedded Perl
15375 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15376
15377
15378 .option pgsql_servers main "string list" unset
15379 .cindex "PostgreSQL lookup type" "server list"
15380 This option provides a list of PostgreSQL servers and associated connection
15381 data, to be used in conjunction with &(pgsql)& lookups (see section
15382 &<<SECID72>>&). The option is available only if Exim has been built with
15383 PostgreSQL support.
15384
15385
15386 .option pid_file_path main string&!! "set at compile time"
15387 .cindex "daemon" "pid file path"
15388 .cindex "pid file, path for"
15389 This option sets the name of the file to which the Exim daemon writes its
15390 process id. The string is expanded, so it can contain, for example, references
15391 to the host name:
15392 .code
15393 pid_file_path = /var/log/$primary_hostname/exim.pid
15394 .endd
15395 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15396 spool directory.
15397 The value set by the option can be overridden by the &%-oP%& command line
15398 option. A pid file is not written if a &"non-standard"& daemon is run by means
15399 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15400
15401
15402 .option pipelining_advertise_hosts main "host list&!!" *
15403 .cindex "PIPELINING" "suppressing advertising"
15404 This option can be used to suppress the advertisement of the SMTP
15405 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15406 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15407 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15408 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15409 that clients will use it; &"out of order"& commands that are &"expected"& do
15410 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15411
15412
15413 .option prdr_enable main boolean false
15414 .cindex "PRDR" "enabling on server"
15415 This option can be used to enable the Per-Recipient Data Response extension
15416 to SMTP, defined by Eric Hall.
15417 If the option is set, PRDR is advertised by Exim when operating as a server.
15418 If the client requests PRDR, and more than one recipient, for a message 
15419 an additional ACL is called for each recipient after the message content
15420 is recieved.  See section &<<SECTPRDRACL>>&.
15421
15422 .option preserve_message_logs main boolean false
15423 .cindex "message logs" "preserving"
15424 If this option is set, message log files are not deleted when messages are
15425 completed. Instead, they are moved to a sub-directory of the spool directory
15426 called &_msglog.OLD_&, where they remain available for statistical or debugging
15427 purposes. This is a dangerous option to set on systems with any appreciable
15428 volume of mail. Use with care!
15429
15430
15431 .option primary_hostname main string "see below"
15432 .cindex "name" "of local host"
15433 .cindex "host" "name of local"
15434 .cindex "local host" "name of"
15435 .vindex "&$primary_hostname$&"
15436 This specifies the name of the current host. It is used in the default EHLO or
15437 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15438 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15439 The value is also used by default in some SMTP response messages from an Exim
15440 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15441
15442 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15443 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15444 contains only one component, Exim passes it to &[gethostbyname()]& (or
15445 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15446 version. The variable &$primary_hostname$& contains the host name, whether set
15447 explicitly by this option, or defaulted.
15448
15449
15450 .option print_topbitchars main boolean false
15451 .cindex "printing characters"
15452 .cindex "8-bit characters"
15453 By default, Exim considers only those characters whose codes lie in the range
15454 32&--126 to be printing characters. In a number of circumstances (for example,
15455 when writing log entries) non-printing characters are converted into escape
15456 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15457 is set, code values of 128 and above are also considered to be printing
15458 characters.
15459
15460 This option also affects the header syntax checks performed by the
15461 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15462 the user's full name when constructing From: and Sender: addresses (as
15463 described in section &<<SECTconstr>>&). Setting this option can cause
15464 Exim to generate eight bit message headers that do not conform to the
15465 standards.
15466
15467
15468 .option process_log_path main string unset
15469 .cindex "process log path"
15470 .cindex "log" "process log"
15471 .cindex "&'exiwhat'&"
15472 This option sets the name of the file to which an Exim process writes its
15473 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15474 utility script. If this option is unset, the file called &_exim-process.info_&
15475 in Exim's spool directory is used. The ability to specify the name explicitly
15476 can be useful in environments where two different Exims are running, using
15477 different spool directories.
15478
15479
15480 .option prod_requires_admin main boolean true
15481 .oindex "&%-M%&"
15482 .oindex "&%-R%&"
15483 .oindex "&%-q%&"
15484 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15485 admin user unless &%prod_requires_admin%& is set false. See also
15486 &%queue_list_requires_admin%&.
15487
15488
15489 .option qualify_domain main string "see below"
15490 .cindex "domain" "for qualifying addresses"
15491 .cindex "address" "qualification"
15492 This option specifies the domain name that is added to any envelope sender
15493 addresses that do not have a domain qualification. It also applies to
15494 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15495 are accepted by default only for locally-generated messages. Qualification is
15496 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15497 locally-generated messages, unless the &%-bnq%& command line option is used.
15498
15499 Messages from external sources must always contain fully qualified addresses,
15500 unless the sending host matches &%sender_unqualified_hosts%& or
15501 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15502 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15503 necessary. Internally, Exim always works with fully qualified envelope
15504 addresses. If &%qualify_domain%& is not set, it defaults to the
15505 &%primary_hostname%& value.
15506
15507
15508 .option qualify_recipient main string "see below"
15509 This option allows you to specify a different domain for qualifying recipient
15510 addresses to the one that is used for senders. See &%qualify_domain%& above.
15511
15512
15513
15514 .option queue_domains main "domain list&!!" unset
15515 .cindex "domain" "specifying non-immediate delivery"
15516 .cindex "queueing incoming messages"
15517 .cindex "message" "queueing certain domains"
15518 This option lists domains for which immediate delivery is not required.
15519 A delivery process is started whenever a message is received, but only those
15520 domains that do not match are processed. All other deliveries wait until the
15521 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15522
15523
15524 .option queue_list_requires_admin main boolean true
15525 .oindex "&%-bp%&"
15526 The &%-bp%& command-line option, which lists the messages that are on the
15527 queue, requires the caller to be an admin user unless
15528 &%queue_list_requires_admin%& is set false. See also &%prod_requires_admin%&.
15529
15530
15531 .option queue_only main boolean false
15532 .cindex "queueing incoming messages"
15533 .cindex "message" "queueing unconditionally"
15534 If &%queue_only%& is set, a delivery process is not automatically started
15535 whenever a message is received. Instead, the message waits on the queue for the
15536 next queue run. Even if &%queue_only%& is false, incoming messages may not get
15537 delivered immediately when certain conditions (such as heavy load) occur.
15538
15539 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
15540 and &%-odi%& command line options override &%queue_only%& unless
15541 &%queue_only_override%& is set false. See also &%queue_only_file%&,
15542 &%queue_only_load%&, and &%smtp_accept_queue%&.
15543
15544
15545 .option queue_only_file main string unset
15546 .cindex "queueing incoming messages"
15547 .cindex "message" "queueing by file existence"
15548 This option can be set to a colon-separated list of absolute path names, each
15549 one optionally preceded by &"smtp"&. When Exim is receiving a message,
15550 it tests for the existence of each listed path using a call to &[stat()]&. For
15551 each path that exists, the corresponding queueing option is set.
15552 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
15553 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
15554 .code
15555 queue_only_file = smtp/some/file
15556 .endd
15557 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
15558 &_/some/file_& exists.
15559
15560
15561 .option queue_only_load main fixed-point unset
15562 .cindex "load average"
15563 .cindex "queueing incoming messages"
15564 .cindex "message" "queueing by load"
15565 If the system load average is higher than this value, incoming messages from
15566 all sources are queued, and no automatic deliveries are started. If this
15567 happens during local or remote SMTP input, all subsequent messages received on
15568 the same SMTP connection are queued by default, whatever happens to the load in
15569 the meantime, but this can be changed by setting &%queue_only_load_latch%&
15570 false.
15571
15572 Deliveries will subsequently be performed by queue runner processes. This
15573 option has no effect on ancient operating systems on which Exim cannot
15574 determine the load average. See also &%deliver_queue_load_max%& and
15575 &%smtp_load_reserve%&.
15576
15577
15578 .option queue_only_load_latch main boolean true
15579 .cindex "load average" "re-evaluating per message"
15580 When this option is true (the default), once one message has been queued
15581 because the load average is higher than the value set by &%queue_only_load%&,
15582 all subsequent messages received on the same SMTP connection are also queued.
15583 This is a deliberate choice; even though the load average may fall below the
15584 threshold, it doesn't seem right to deliver later messages on the same
15585 connection when not delivering earlier ones. However, there are special
15586 circumstances such as very long-lived connections from scanning appliances
15587 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
15588 should be set false. This causes the value of the load average to be
15589 re-evaluated for each message.
15590
15591
15592 .option queue_only_override main boolean true
15593 .cindex "queueing incoming messages"
15594 When this option is true, the &%-od%&&'x'& command line options override the
15595 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
15596 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
15597 to override; they are accepted, but ignored.
15598
15599
15600 .option queue_run_in_order main boolean false
15601 .cindex "queue runner" "processing messages in order"
15602 If this option is set, queue runs happen in order of message arrival instead of
15603 in an arbitrary order. For this to happen, a complete list of the entire queue
15604 must be set up before the deliveries start. When the queue is all held in a
15605 single directory (the default), a single list is created for both the ordered
15606 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
15607 single list is not created when &%queue_run_in_order%& is false. In this case,
15608 the sub-directories are processed one at a time (in a random order), and this
15609 avoids setting up one huge list for the whole queue. Thus, setting
15610 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
15611 when the queue is large, because of the extra work in setting up the single,
15612 large list. In most situations, &%queue_run_in_order%& should not be set.
15613
15614
15615
15616 .option queue_run_max main integer 5
15617 .cindex "queue runner" "maximum number of"
15618 This controls the maximum number of queue runner processes that an Exim daemon
15619 can run simultaneously. This does not mean that it starts them all at once,
15620 but rather that if the maximum number are still running when the time comes to
15621 start another one, it refrains from starting another one. This can happen with
15622 very large queues and/or very sluggish deliveries. This option does not,
15623 however, interlock with other processes, so additional queue runners can be
15624 started by other means, or by killing and restarting the daemon.
15625
15626 Setting this option to zero does not suppress queue runs; rather, it disables
15627 the limit, allowing any number of simultaneous queue runner processes to be
15628 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
15629 the daemon's command line.
15630
15631 .option queue_smtp_domains main "domain list&!!" unset
15632 .cindex "queueing incoming messages"
15633 .cindex "message" "queueing remote deliveries"
15634 When this option is set, a delivery process is started whenever a message is
15635 received, routing is performed, and local deliveries take place.
15636 However, if any SMTP deliveries are required for domains that match
15637 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
15638 message waits on the queue for the next queue run. Since routing of the message
15639 has taken place, Exim knows to which remote hosts it must be delivered, and so
15640 when the queue run happens, multiple messages for the same host are delivered
15641 over a single SMTP connection. The &%-odqs%& command line option causes all
15642 SMTP deliveries to be queued in this way, and is equivalent to setting
15643 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
15644 &%queue_domains%&.
15645
15646
15647 .option receive_timeout main time 0s
15648 .cindex "timeout" "for non-SMTP input"
15649 This option sets the timeout for accepting a non-SMTP message, that is, the
15650 maximum time that Exim waits when reading a message on the standard input. If
15651 the value is zero, it will wait for ever. This setting is overridden by the
15652 &%-or%& command line option. The timeout for incoming SMTP messages is
15653 controlled by &%smtp_receive_timeout%&.
15654
15655 .option received_header_text main string&!! "see below"
15656 .cindex "customizing" "&'Received:'& header"
15657 .cindex "&'Received:'& header line" "customizing"
15658 This string defines the contents of the &'Received:'& message header that is
15659 added to each message, except for the timestamp, which is automatically added
15660 on at the end (preceded by a semicolon). The string is expanded each time it is
15661 used. If the expansion yields an empty string, no &'Received:'& header line is
15662 added to the message. Otherwise, the string should start with the text
15663 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
15664 header lines. The default setting is:
15665
15666 .code
15667 received_header_text = Received: \
15668   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
15669   {${if def:sender_ident \
15670   {from ${quote_local_part:$sender_ident} }}\
15671   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
15672   by $primary_hostname \
15673   ${if def:received_protocol {with $received_protocol}} \
15674   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
15675   (Exim $version_number)\n\t\
15676   ${if def:sender_address \
15677   {(envelope-from <$sender_address>)\n\t}}\
15678   id $message_exim_id\
15679   ${if def:received_for {\n\tfor $received_for}}
15680 .endd
15681
15682 The reference to the TLS cipher is omitted when Exim is built without TLS
15683 support. The use of conditional expansions ensures that this works for both
15684 locally generated messages and messages received from remote hosts, giving
15685 header lines such as the following:
15686 .code
15687 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
15688 by marley.carol.example with esmtp (Exim 4.00)
15689 (envelope-from <bob@carol.example>)
15690 id 16IOWa-00019l-00
15691 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
15692 Received: by scrooge.carol.example with local (Exim 4.00)
15693 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
15694 .endd
15695 Until the body of the message has been received, the timestamp is the time when
15696 the message started to be received. Once the body has arrived, and all policy
15697 checks have taken place, the timestamp is updated to the time at which the
15698 message was accepted.
15699
15700
15701 .option received_headers_max main integer 30
15702 .cindex "loop" "prevention"
15703 .cindex "mail loop prevention"
15704 .cindex "&'Received:'& header line" "counting"
15705 When a message is to be delivered, the number of &'Received:'& headers is
15706 counted, and if it is greater than this parameter, a mail loop is assumed to
15707 have occurred, the delivery is abandoned, and an error message is generated.
15708 This applies to both local and remote deliveries.
15709
15710
15711 .option recipient_unqualified_hosts main "host list&!!" unset
15712 .cindex "unqualified addresses"
15713 .cindex "host" "unqualified addresses from"
15714 This option lists those hosts from which Exim is prepared to accept unqualified
15715 recipient addresses in message envelopes. The addresses are made fully
15716 qualified by the addition of the &%qualify_recipient%& value. This option also
15717 affects message header lines. Exim does not reject unqualified recipient
15718 addresses in headers, but it qualifies them only if the message came from a
15719 host that matches &%recipient_unqualified_hosts%&,
15720 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
15721 option was not set.
15722
15723
15724 .option recipients_max main integer 0
15725 .cindex "limit" "number of recipients"
15726 .cindex "recipient" "maximum number"
15727 If this option is set greater than zero, it specifies the maximum number of
15728 original recipients for any message. Additional recipients that are generated
15729 by aliasing or forwarding do not count. SMTP messages get a 452 response for
15730 all recipients over the limit; earlier recipients are delivered as normal.
15731 Non-SMTP messages with too many recipients are failed, and no deliveries are
15732 done.
15733
15734 .cindex "RCPT" "maximum number of incoming"
15735 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
15736 RCPT commands in a single message.
15737
15738
15739 .option recipients_max_reject main boolean false
15740 If this option is set true, Exim rejects SMTP messages containing too many
15741 recipients by giving 552 errors to the surplus RCPT commands, and a 554
15742 error to the eventual DATA command. Otherwise (the default) it gives a 452
15743 error to the surplus RCPT commands and accepts the message on behalf of the
15744 initial set of recipients. The remote server should then re-send the message
15745 for the remaining recipients at a later time.
15746
15747
15748 .option remote_max_parallel main integer 2
15749 .cindex "delivery" "parallelism for remote"
15750 This option controls parallel delivery of one message to a number of remote
15751 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
15752 does all the remote deliveries for a message one by one. Otherwise, if a single
15753 message has to be delivered to more than one remote host, or if several copies
15754 have to be sent to the same remote host, up to &%remote_max_parallel%&
15755 deliveries are done simultaneously. If more than &%remote_max_parallel%&
15756 deliveries are required, the maximum number of processes are started, and as
15757 each one finishes, another is begun. The order of starting processes is the
15758 same as if sequential delivery were being done, and can be controlled by the
15759 &%remote_sort_domains%& option. If parallel delivery takes place while running
15760 with debugging turned on, the debugging output from each delivery process is
15761 tagged with its process id.
15762
15763 This option controls only the maximum number of parallel deliveries for one
15764 message in one Exim delivery process. Because Exim has no central queue
15765 manager, there is no way of controlling the total number of simultaneous
15766 deliveries if the configuration allows a delivery attempt as soon as a message
15767 is received.
15768
15769 .cindex "number of deliveries"
15770 .cindex "delivery" "maximum number of"
15771 If you want to control the total number of deliveries on the system, you
15772 need to set the &%queue_only%& option. This ensures that all incoming messages
15773 are added to the queue without starting a delivery process. Then set up an Exim
15774 daemon to start queue runner processes at appropriate intervals (probably
15775 fairly often, for example, every minute), and limit the total number of queue
15776 runners by setting the &%queue_run_max%& parameter. Because each queue runner
15777 delivers only one message at a time, the maximum number of deliveries that can
15778 then take place at once is &%queue_run_max%& multiplied by
15779 &%remote_max_parallel%&.
15780
15781 If it is purely remote deliveries you want to control, use
15782 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
15783 doing the SMTP routing before queueing, so that several messages for the same
15784 host will eventually get delivered down the same connection.
15785
15786
15787 .option remote_sort_domains main "domain list&!!" unset
15788 .cindex "sorting remote deliveries"
15789 .cindex "delivery" "sorting remote"
15790 When there are a number of remote deliveries for a message, they are sorted by
15791 domain into the order given by this list. For example,
15792 .code
15793 remote_sort_domains = *.cam.ac.uk:*.uk
15794 .endd
15795 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
15796 then to those in the &%uk%& domain, then to any others.
15797
15798
15799 .option retry_data_expire main time 7d
15800 .cindex "hints database" "data expiry"
15801 This option sets a &"use before"& time on retry information in Exim's hints
15802 database. Any older retry data is ignored. This means that, for example, once a
15803 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
15804 past failures.
15805
15806
15807 .option retry_interval_max main time 24h
15808 .cindex "retry" "limit on interval"
15809 .cindex "limit" "on retry interval"
15810 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
15811 intervals between delivery attempts for messages that cannot be delivered
15812 straight away. This option sets an overall limit to the length of time between
15813 retries. It cannot be set greater than 24 hours; any attempt to do so forces
15814 the default value.
15815
15816
15817 .option return_path_remove main boolean true
15818 .cindex "&'Return-path:'& header line" "removing"
15819 RFC 2821, section 4.4, states that an SMTP server must insert a
15820 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
15821 The &'Return-path:'& header preserves the sender address as received in the
15822 MAIL command. This description implies that this header should not be present
15823 in an incoming message. If &%return_path_remove%& is true, any existing
15824 &'Return-path:'& headers are removed from messages at the time they are
15825 received. Exim's transports have options for adding &'Return-path:'& headers at
15826 the time of delivery. They are normally used only for final local deliveries.
15827
15828
15829 .option return_size_limit main integer 100K
15830 This option is an obsolete synonym for &%bounce_return_size_limit%&.
15831
15832
15833 .new
15834 .option rfc1413_hosts main "host list&!!" @[]
15835 .cindex "RFC 1413"
15836 .cindex "host" "for RFC 1413 calls"
15837 RFC 1413 identification calls are made to any client host which matches
15838 an item in the list.
15839 The default value specifies just this host, being any local interface
15840 for the system.
15841 .wen
15842
15843 .new
15844 .option rfc1413_query_timeout main time 0s
15845 .wen
15846 .cindex "RFC 1413" "query timeout"
15847 .cindex "timeout" "for RFC 1413 call"
15848 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
15849 no RFC 1413 calls are ever made.
15850
15851
15852 .option sender_unqualified_hosts main "host list&!!" unset
15853 .cindex "unqualified addresses"
15854 .cindex "host" "unqualified addresses from"
15855 This option lists those hosts from which Exim is prepared to accept unqualified
15856 sender addresses. The addresses are made fully qualified by the addition of
15857 &%qualify_domain%&. This option also affects message header lines. Exim does
15858 not reject unqualified addresses in headers that contain sender addresses, but
15859 it qualifies them only if the message came from a host that matches
15860 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
15861 using TCP/IP), and the &%-bnq%& option was not set.
15862
15863
15864 .option slow_lookup_log main integer 0
15865 .cindex "logging" "slow lookups"
15866 .cindex "dns" "logging slow lookups"
15867 This option controls logging of slow lookups.
15868 If the value is nonzero it is taken as a number of milliseconds
15869 and lookups taking longer than this are logged.
15870 Currently this applies only to DNS lookups.
15871
15872
15873
15874 .option smtp_accept_keepalive main boolean true
15875 .cindex "keepalive" "on incoming connection"
15876 This option controls the setting of the SO_KEEPALIVE option on incoming
15877 TCP/IP socket connections. When set, it causes the kernel to probe idle
15878 connections periodically, by sending packets with &"old"& sequence numbers. The
15879 other end of the connection should send an acknowledgment if the connection is
15880 still okay or a reset if the connection has been aborted. The reason for doing
15881 this is that it has the beneficial effect of freeing up certain types of
15882 connection that can get stuck when the remote host is disconnected without
15883 tidying up the TCP/IP call properly. The keepalive mechanism takes several
15884 hours to detect unreachable hosts.
15885
15886
15887
15888 .option smtp_accept_max main integer 20
15889 .cindex "limit" "incoming SMTP connections"
15890 .cindex "SMTP" "incoming connection count"
15891 .cindex "inetd"
15892 This option specifies the maximum number of simultaneous incoming SMTP calls
15893 that Exim will accept. It applies only to the listening daemon; there is no
15894 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
15895 value is set to zero, no limit is applied. However, it is required to be
15896 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
15897 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
15898
15899 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
15900 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
15901 that limit has not been reached for the client host, &%smtp_accept_reserve%&
15902 and &%smtp_load_reserve%& are then checked before accepting the connection.
15903
15904
15905 .option smtp_accept_max_nonmail main integer 10
15906 .cindex "limit" "non-mail SMTP commands"
15907 .cindex "SMTP" "limiting non-mail commands"
15908 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
15909 the connection if there are too many. This option defines &"too many"&. The
15910 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
15911 client looping sending EHLO, for example. The check is applied only if the
15912 client host matches &%smtp_accept_max_nonmail_hosts%&.
15913
15914 When a new message is expected, one occurrence of RSET is not counted. This
15915 allows a client to send one RSET between messages (this is not necessary,
15916 but some clients do it). Exim also allows one uncounted occurrence of HELO
15917 or EHLO, and one occurrence of STARTTLS between messages. After
15918 starting up a TLS session, another EHLO is expected, and so it too is not
15919 counted. The first occurrence of AUTH in a connection, or immediately
15920 following STARTTLS is not counted. Otherwise, all commands other than
15921 MAIL, RCPT, DATA, and QUIT are counted.
15922
15923
15924 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
15925 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
15926 check by setting this option. The default value makes it apply to all hosts. By
15927 changing the value, you can exclude any badly-behaved hosts that you have to
15928 live with.
15929
15930
15931 . Allow this long option name to split; give it unsplit as a fifth argument
15932 . for the automatic .oindex that is generated by .option.
15933 . We insert " &~&~" which is both pretty nasty visually and results in
15934 . non-searchable text.  HowItWorks.txt mentions an option for inserting
15935 . zero-width-space, which would be nicer visually and results in (at least)
15936 . html that Firefox will split on when it's forced to reflow (rather than
15937 . inserting a horizontal scrollbar).  However, the text is still not
15938 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
15939 . the option name to split.
15940
15941 .option "smtp_accept_max_per_connection" main integer 1000 &&&
15942          smtp_accept_max_per_connection
15943 .cindex "SMTP" "limiting incoming message count"
15944 .cindex "limit" "messages per SMTP connection"
15945 The value of this option limits the number of MAIL commands that Exim is
15946 prepared to accept over a single SMTP connection, whether or not each command
15947 results in the transfer of a message. After the limit is reached, a 421
15948 response is given to subsequent MAIL commands. This limit is a safety
15949 precaution against a client that goes mad (incidents of this type have been
15950 seen).
15951
15952
15953 .option smtp_accept_max_per_host main string&!! unset
15954 .cindex "limit" "SMTP connections from one host"
15955 .cindex "host" "limiting SMTP connections from"
15956 This option restricts the number of simultaneous IP connections from a single
15957 host (strictly, from a single IP address) to the Exim daemon. The option is
15958 expanded, to enable different limits to be applied to different hosts by
15959 reference to &$sender_host_address$&. Once the limit is reached, additional
15960 connection attempts from the same host are rejected with error code 421. This
15961 is entirely independent of &%smtp_accept_reserve%&. The option's default value
15962 of zero imposes no limit. If this option is set greater than zero, it is
15963 required that &%smtp_accept_max%& be non-zero.
15964
15965 &*Warning*&: When setting this option you should not use any expansion
15966 constructions that take an appreciable amount of time. The expansion and test
15967 happen in the main daemon loop, in order to reject additional connections
15968 without forking additional processes (otherwise a denial-of-service attack
15969 could cause a vast number or processes to be created). While the daemon is
15970 doing this processing, it cannot accept any other incoming connections.
15971
15972
15973
15974 .option smtp_accept_queue main integer 0
15975 .cindex "SMTP" "incoming connection count"
15976 .cindex "queueing incoming messages"
15977 .cindex "message" "queueing by SMTP connection count"
15978 If the number of simultaneous incoming SMTP connections being handled via the
15979 listening daemon exceeds this value, messages received by SMTP are just placed
15980 on the queue; no delivery processes are started automatically. The count is
15981 fixed at the start of an SMTP connection. It cannot be updated in the
15982 subprocess that receives messages, and so the queueing or not queueing applies
15983 to all messages received in the same connection.
15984
15985 A value of zero implies no limit, and clearly any non-zero value is useful only
15986 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
15987 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
15988 various &%-od%&&'x'& command line options.
15989
15990
15991 . See the comment on smtp_accept_max_per_connection
15992
15993 .option "smtp_accept_queue_per_connection" main integer 10 &&&
15994          smtp_accept_queue_per_connection
15995 .cindex "queueing incoming messages"
15996 .cindex "message" "queueing by message count"
15997 This option limits the number of delivery processes that Exim starts
15998 automatically when receiving messages via SMTP, whether via the daemon or by
15999 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16000 and the number of messages received in a single SMTP session exceeds this
16001 number, subsequent messages are placed on the queue, but no delivery processes
16002 are started. This helps to limit the number of Exim processes when a server
16003 restarts after downtime and there is a lot of mail waiting for it on other
16004 systems. On large systems, the default should probably be increased, and on
16005 dial-in client systems it should probably be set to zero (that is, disabled).
16006
16007
16008 .option smtp_accept_reserve main integer 0
16009 .cindex "SMTP" "incoming call count"
16010 .cindex "host" "reserved"
16011 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16012 number of SMTP connections that are reserved for connections from the hosts
16013 that are specified in &%smtp_reserve_hosts%&. The value set in
16014 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16015 restricted to this number of connections; the option specifies a minimum number
16016 of connection slots for them, not a maximum. It is a guarantee that this group
16017 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16018 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16019 individual host.
16020
16021 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16022 set to 5, once there are 45 active connections (from any hosts), new
16023 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16024 provided the other criteria for acceptance are met.
16025
16026
16027 .option smtp_active_hostname main string&!! unset
16028 .cindex "host" "name in SMTP responses"
16029 .cindex "SMTP" "host name in responses"
16030 .vindex "&$primary_hostname$&"
16031 This option is provided for multi-homed servers that want to masquerade as
16032 several different hosts. At the start of an incoming SMTP connection, its value
16033 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16034 responses. For example, it is used as domain name in the response to an
16035 incoming HELO or EHLO command.
16036
16037 .vindex "&$smtp_active_hostname$&"
16038 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16039 is saved with any messages that are received. It is therefore available for use
16040 in routers and transports when the message is later delivered.
16041
16042 If this option is unset, or if its expansion is forced to fail, or if the
16043 expansion results in an empty string, the value of &$primary_hostname$& is
16044 used. Other expansion failures cause a message to be written to the main and
16045 panic logs, and the SMTP command receives a temporary error. Typically, the
16046 value of &%smtp_active_hostname%& depends on the incoming interface address.
16047 For example:
16048 .code
16049 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16050   {cox.mydomain}{box.mydomain}}
16051 .endd
16052
16053 Although &$smtp_active_hostname$& is primarily concerned with incoming
16054 messages, it is also used as the default for HELO commands in callout
16055 verification if there is no remote transport from which to obtain a
16056 &%helo_data%& value.
16057
16058 .option smtp_banner main string&!! "see below"
16059 .cindex "SMTP" "welcome banner"
16060 .cindex "banner for SMTP"
16061 .cindex "welcome banner for SMTP"
16062 .cindex "customizing" "SMTP banner"
16063 This string, which is expanded every time it is used, is output as the initial
16064 positive response to an SMTP connection. The default setting is:
16065 .code
16066 smtp_banner = $smtp_active_hostname ESMTP Exim \
16067   $version_number $tod_full
16068 .endd
16069 Failure to expand the string causes a panic error. If you want to create a
16070 multiline response to the initial SMTP connection, use &"\n"& in the string at
16071 appropriate points, but not at the end. Note that the 220 code is not included
16072 in this string. Exim adds it automatically (several times in the case of a
16073 multiline response).
16074
16075
16076 .option smtp_check_spool_space main boolean true
16077 .cindex "checking disk space"
16078 .cindex "disk space, checking"
16079 .cindex "spool directory" "checking space"
16080 When this option is set, if an incoming SMTP session encounters the SIZE
16081 option on a MAIL command, it checks that there is enough space in the
16082 spool directory's partition to accept a message of that size, while still
16083 leaving free the amount specified by &%check_spool_space%& (even if that value
16084 is zero). If there isn't enough space, a temporary error code is returned.
16085
16086
16087 .option smtp_connect_backlog main integer 20
16088 .cindex "connection backlog"
16089 .cindex "SMTP" "connection backlog"
16090 .cindex "backlog of connections"
16091 This option specifies a maximum number of waiting SMTP connections. Exim passes
16092 this value to the TCP/IP system when it sets up its listener. Once this number
16093 of connections are waiting for the daemon's attention, subsequent connection
16094 attempts are refused at the TCP/IP level. At least, that is what the manuals
16095 say; in some circumstances such connection attempts have been observed to time
16096 out instead. For large systems it is probably a good idea to increase the
16097 value (to 50, say). It also gives some protection against denial-of-service
16098 attacks by SYN flooding.
16099
16100
16101 .option smtp_enforce_sync main boolean true
16102 .cindex "SMTP" "synchronization checking"
16103 .cindex "synchronization checking in SMTP"
16104 The SMTP protocol specification requires the client to wait for a response from
16105 the server at certain points in the dialogue. Without PIPELINING these
16106 synchronization points are after every command; with PIPELINING they are
16107 fewer, but they still exist.
16108
16109 Some spamming sites send out a complete set of SMTP commands without waiting
16110 for any response. Exim protects against this by rejecting a message if the
16111 client has sent further input when it should not have. The error response &"554
16112 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16113 for this error cannot be perfect because of transmission delays (unexpected
16114 input may be on its way but not yet received when Exim checks). However, it
16115 does detect many instances.
16116
16117 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16118 If you want to disable the check selectively (for example, only for certain
16119 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16120 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16121
16122
16123
16124 .option smtp_etrn_command main string&!! unset
16125 .cindex "ETRN" "command to be run"
16126 .vindex "&$domain$&"
16127 If this option is set, the given command is run whenever an SMTP ETRN
16128 command is received from a host that is permitted to issue such commands (see
16129 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16130 are independently expanded. The expansion variable &$domain$& is set to the
16131 argument of the ETRN command, and no syntax checking is done on it. For
16132 example:
16133 .code
16134 smtp_etrn_command = /etc/etrn_command $domain \
16135                     $sender_host_address
16136 .endd
16137 A new process is created to run the command, but Exim does not wait for it to
16138 complete. Consequently, its status cannot be checked. If the command cannot be
16139 run, a line is written to the panic log, but the ETRN caller still receives
16140 a 250 success response. Exim is normally running under its own uid when
16141 receiving SMTP, so it is not possible for it to change the uid before running
16142 the command.
16143
16144
16145 .option smtp_etrn_serialize main boolean true
16146 .cindex "ETRN" "serializing"
16147 When this option is set, it prevents the simultaneous execution of more than
16148 one identical command as a result of ETRN in an SMTP connection. See
16149 section &<<SECTETRN>>& for details.
16150
16151
16152 .option smtp_load_reserve main fixed-point unset
16153 .cindex "load average"
16154 If the system load average ever gets higher than this, incoming SMTP calls are
16155 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16156 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16157 the load is over the limit. The option has no effect on ancient operating
16158 systems on which Exim cannot determine the load average. See also
16159 &%deliver_queue_load_max%& and &%queue_only_load%&.
16160
16161
16162
16163 .option smtp_max_synprot_errors main integer 3
16164 .cindex "SMTP" "limiting syntax and protocol errors"
16165 .cindex "limit" "SMTP syntax and protocol errors"
16166 Exim rejects SMTP commands that contain syntax or protocol errors. In
16167 particular, a syntactically invalid email address, as in this command:
16168 .code
16169 RCPT TO:<abc xyz@a.b.c>
16170 .endd
16171 causes immediate rejection of the command, before any other tests are done.
16172 (The ACL cannot be run if there is no valid address to set up for it.) An
16173 example of a protocol error is receiving RCPT before MAIL. If there are
16174 too many syntax or protocol errors in one SMTP session, the connection is
16175 dropped. The limit is set by this option.
16176
16177 .cindex "PIPELINING" "expected errors"
16178 When the PIPELINING extension to SMTP is in use, some protocol errors are
16179 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16180 Exim assumes that PIPELINING will be used if it advertises it (see
16181 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16182 not count towards the limit.
16183
16184
16185
16186 .option smtp_max_unknown_commands main integer 3
16187 .cindex "SMTP" "limiting unknown commands"
16188 .cindex "limit" "unknown SMTP commands"
16189 If there are too many unrecognized commands in an incoming SMTP session, an
16190 Exim server drops the connection. This is a defence against some kinds of abuse
16191 that subvert web
16192 clients
16193 into making connections to SMTP ports; in these circumstances, a number of
16194 non-SMTP command lines are sent first.
16195
16196
16197
16198 .option smtp_ratelimit_hosts main "host list&!!" unset
16199 .cindex "SMTP" "rate limiting"
16200 .cindex "limit" "rate of message arrival"
16201 .cindex "RCPT" "rate limiting"
16202 Some sites find it helpful to be able to limit the rate at which certain hosts
16203 can send them messages, and the rate at which an individual message can specify
16204 recipients.
16205
16206 Exim has two rate-limiting facilities. This section describes the older
16207 facility, which can limit rates within a single connection. The newer
16208 &%ratelimit%& ACL condition can limit rates across all connections. See section
16209 &<<SECTratelimiting>>& for details of the newer facility.
16210
16211 When a host matches &%smtp_ratelimit_hosts%&, the values of
16212 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16213 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16214 respectively. Each option, if set, must contain a set of four comma-separated
16215 values:
16216
16217 .ilist
16218 A threshold, before which there is no rate limiting.
16219 .next
16220 An initial time delay. Unlike other times in Exim, numbers with decimal
16221 fractional parts are allowed here.
16222 .next
16223 A factor by which to increase the delay each time.
16224 .next
16225 A maximum value for the delay. This should normally be less than 5 minutes,
16226 because after that time, the client is liable to timeout the SMTP command.
16227 .endlist
16228
16229 For example, these settings have been used successfully at the site which
16230 first suggested this feature, for controlling mail from their customers:
16231 .code
16232 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16233 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16234 .endd
16235 The first setting specifies delays that are applied to MAIL commands after
16236 two have been received over a single connection. The initial delay is 0.5
16237 seconds, increasing by a factor of 1.05 each time. The second setting applies
16238 delays to RCPT commands when more than four occur in a single message.
16239
16240
16241 .option smtp_ratelimit_mail main string unset
16242 See &%smtp_ratelimit_hosts%& above.
16243
16244
16245 .option smtp_ratelimit_rcpt main string unset
16246 See &%smtp_ratelimit_hosts%& above.
16247
16248
16249 .option smtp_receive_timeout main time&!! 5m
16250 .cindex "timeout" "for SMTP input"
16251 .cindex "SMTP" "input timeout"
16252 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16253 input, including batch SMTP. If a line of input (either an SMTP command or a
16254 data line) is not received within this time, the SMTP connection is dropped and
16255 the message is abandoned.
16256 A line is written to the log containing one of the following messages:
16257 .code
16258 SMTP command timeout on connection from...
16259 SMTP data timeout on connection from...
16260 .endd
16261 The former means that Exim was expecting to read an SMTP command; the latter
16262 means that it was in the DATA phase, reading the contents of a message.
16263
16264 If the first character of the option is a &"$"& the option is
16265 expanded before use and may depend on
16266 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16267
16268
16269 .oindex "&%-os%&"
16270 The value set by this option can be overridden by the
16271 &%-os%& command-line option. A setting of zero time disables the timeout, but
16272 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16273 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16274 timeout is controlled by &%receive_timeout%& and &%-or%&.
16275
16276
16277 .option smtp_reserve_hosts main "host list&!!" unset
16278 This option defines hosts for which SMTP connections are reserved; see
16279 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16280
16281
16282 .option smtp_return_error_details main boolean false
16283 .cindex "SMTP" "details policy failures"
16284 .cindex "policy control" "rejection, returning details"
16285 In the default state, Exim uses bland messages such as
16286 &"Administrative prohibition"& when it rejects SMTP commands for policy
16287 reasons. Many sysadmins like this because it gives away little information
16288 to spammers. However, some other sysadmins who are applying strict checking
16289 policies want to give out much fuller information about failures. Setting
16290 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16291 example, instead of &"Administrative prohibition"&, it might give:
16292 .code
16293 550-Rejected after DATA: '>' missing at end of address:
16294 550 failing address in "From" header is: <user@dom.ain
16295 .endd
16296
16297 .option spamd_address main string "see below"
16298 This option is available when Exim is compiled with the content-scanning
16299 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16300 The default value is
16301 .code
16302 127.0.0.1 783
16303 .endd
16304 See section &<<SECTscanspamass>>& for more details.
16305
16306
16307
16308 .option split_spool_directory main boolean false
16309 .cindex "multiple spool directories"
16310 .cindex "spool directory" "split"
16311 .cindex "directories, multiple"
16312 If this option is set, it causes Exim to split its input directory into 62
16313 subdirectories, each with a single alphanumeric character as its name. The
16314 sixth character of the message id is used to allocate messages to
16315 subdirectories; this is the least significant base-62 digit of the time of
16316 arrival of the message.
16317
16318 Splitting up the spool in this way may provide better performance on systems
16319 where there are long mail queues, by reducing the number of files in any one
16320 directory. The msglog directory is also split up in a similar way to the input
16321 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16322 are still placed in the single directory &_msglog.OLD_&.
16323
16324 It is not necessary to take any special action for existing messages when
16325 changing &%split_spool_directory%&. Exim notices messages that are in the
16326 &"wrong"& place, and continues to process them. If the option is turned off
16327 after a period of being on, the subdirectories will eventually empty and be
16328 automatically deleted.
16329
16330 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16331 changes. Instead of creating a list of all messages in the queue, and then
16332 trying to deliver each one in turn, it constructs a list of those in one
16333 sub-directory and tries to deliver them, before moving on to the next
16334 sub-directory. The sub-directories are processed in a random order. This
16335 spreads out the scanning of the input directories, and uses less memory. It is
16336 particularly beneficial when there are lots of messages on the queue. However,
16337 if &%queue_run_in_order%& is set, none of this new processing happens. The
16338 entire queue has to be scanned and sorted before any deliveries can start.
16339
16340
16341 .option spool_directory main string&!! "set at compile time"
16342 .cindex "spool directory" "path to"
16343 This defines the directory in which Exim keeps its spool, that is, the messages
16344 it is waiting to deliver. The default value is taken from the compile-time
16345 configuration setting, if there is one. If not, this option must be set. The
16346 string is expanded, so it can contain, for example, a reference to
16347 &$primary_hostname$&.
16348
16349 If the spool directory name is fixed on your installation, it is recommended
16350 that you set it at build time rather than from this option, particularly if the
16351 log files are being written to the spool directory (see &%log_file_path%&).
16352 Otherwise log files cannot be used for errors that are detected early on, such
16353 as failures in the configuration file.
16354
16355 By using this option to override the compiled-in path, it is possible to run
16356 tests of Exim without using the standard spool.
16357
16358 .option sqlite_lock_timeout main time 5s
16359 .cindex "sqlite lookup type" "lock timeout"
16360 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16361 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16362
16363 .option strict_acl_vars main boolean false
16364 .cindex "&ACL;" "variables, handling unset"
16365 This option controls what happens if a syntactically valid but undefined ACL
16366 variable is referenced. If it is false (the default), an empty string
16367 is substituted; if it is true, an error is generated. See section
16368 &<<SECTaclvariables>>& for details of ACL variables.
16369
16370 .option strip_excess_angle_brackets main boolean false
16371 .cindex "angle brackets, excess"
16372 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16373 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16374 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16375 passed on to another MTA, the excess angle brackets are not passed on. If this
16376 option is not set, multiple pairs of angle brackets cause a syntax error.
16377
16378
16379 .option strip_trailing_dot main boolean false
16380 .cindex "trailing dot on domain"
16381 .cindex "dot" "trailing on domain"
16382 If this option is set, a trailing dot at the end of a domain in an address is
16383 ignored. If this is in the envelope and the message is passed on to another
16384 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16385 domain causes a syntax error.
16386 However, addresses in header lines are checked only when an ACL requests header
16387 syntax checking.
16388
16389
16390 .option syslog_duplication main boolean true
16391 .cindex "syslog" "duplicate log lines; suppressing"
16392 When Exim is logging to syslog, it writes the log lines for its three
16393 separate logs at different syslog priorities so that they can in principle
16394 be separated on the logging hosts. Some installations do not require this
16395 separation, and in those cases, the duplication of certain log lines is a
16396 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16397 particular log line is written to syslog. For lines that normally go to
16398 both the main log and the reject log, the reject log version (possibly
16399 containing message header lines) is written, at LOG_NOTICE priority.
16400 Lines that normally go to both the main and the panic log are written at
16401 the LOG_ALERT priority.
16402
16403
16404 .option syslog_facility main string unset
16405 .cindex "syslog" "facility; setting"
16406 This option sets the syslog &"facility"& name, used when Exim is logging to
16407 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16408 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16409 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16410 details of Exim's logging.
16411
16412
16413
16414 .option syslog_processname main string &`exim`&
16415 .cindex "syslog" "process name; setting"
16416 This option sets the syslog &"ident"& name, used when Exim is logging to
16417 syslog. The value must be no longer than 32 characters. See chapter
16418 &<<CHAPlog>>& for details of Exim's logging.
16419
16420
16421
16422 .option syslog_timestamp main boolean true
16423 .cindex "syslog" "timestamps"
16424 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16425 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16426 details of Exim's logging.
16427
16428
16429 .option system_filter main string&!! unset
16430 .cindex "filter" "system filter"
16431 .cindex "system filter" "specifying"
16432 .cindex "Sieve filter" "not available for system filter"
16433 This option specifies an Exim filter file that is applied to all messages at
16434 the start of each delivery attempt, before any routing is done. System filters
16435 must be Exim filters; they cannot be Sieve filters. If the system filter
16436 generates any deliveries to files or pipes, or any new mail messages, the
16437 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16438 which transports are to be used. Details of this facility are given in chapter
16439 &<<CHAPsystemfilter>>&.
16440
16441
16442 .option system_filter_directory_transport main string&!! unset
16443 .vindex "&$address_file$&"
16444 This sets the name of the transport driver that is to be used when the
16445 &%save%& command in a system message filter specifies a path ending in &"/"&,
16446 implying delivery of each message into a separate file in some directory.
16447 During the delivery, the variable &$address_file$& contains the path name.
16448
16449
16450 .option system_filter_file_transport main string&!! unset
16451 .cindex "file" "transport for system filter"
16452 This sets the name of the transport driver that is to be used when the &%save%&
16453 command in a system message filter specifies a path not ending in &"/"&. During
16454 the delivery, the variable &$address_file$& contains the path name.
16455
16456 .option system_filter_group main string unset
16457 .cindex "gid (group id)" "system filter"
16458 This option is used only when &%system_filter_user%& is also set. It sets the
16459 gid under which the system filter is run, overriding any gid that is associated
16460 with the user. The value may be numerical or symbolic.
16461
16462 .option system_filter_pipe_transport main string&!! unset
16463 .cindex "&(pipe)& transport" "for system filter"
16464 .vindex "&$address_pipe$&"
16465 This specifies the transport driver that is to be used when a &%pipe%& command
16466 is used in a system filter. During the delivery, the variable &$address_pipe$&
16467 contains the pipe command.
16468
16469
16470 .option system_filter_reply_transport main string&!! unset
16471 .cindex "&(autoreply)& transport" "for system filter"
16472 This specifies the transport driver that is to be used when a &%mail%& command
16473 is used in a system filter.
16474
16475
16476 .option system_filter_user main string unset
16477 .cindex "uid (user id)" "system filter"
16478 If this option is set to root, the system filter is run in the main Exim
16479 delivery process, as root.  Otherwise, the system filter runs in a separate
16480 process, as the given user, defaulting to the Exim run-time user.
16481 Unless the string consists entirely of digits, it
16482 is looked up in the password data. Failure to find the named user causes a
16483 configuration error. The gid is either taken from the password data, or
16484 specified by &%system_filter_group%&. When the uid is specified numerically,
16485 &%system_filter_group%& is required to be set.
16486
16487 If the system filter generates any pipe, file, or reply deliveries, the uid
16488 under which the filter is run is used when transporting them, unless a
16489 transport option overrides.
16490
16491
16492 .option tcp_nodelay main boolean true
16493 .cindex "daemon" "TCP_NODELAY on sockets"
16494 .cindex "Nagle algorithm"
16495 .cindex "TCP_NODELAY on listening sockets"
16496 If this option is set false, it stops the Exim daemon setting the
16497 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
16498 turns off the &"Nagle algorithm"&, which is a way of improving network
16499 performance in interactive (character-by-character) situations. Turning it off
16500 should improve Exim's performance a bit, so that is what happens by default.
16501 However, it appears that some broken clients cannot cope, and time out. Hence
16502 this option. It affects only those sockets that are set up for listening by the
16503 daemon. Sockets created by the smtp transport for delivering mail always set
16504 TCP_NODELAY.
16505
16506
16507 .option timeout_frozen_after main time 0s
16508 .cindex "frozen messages" "timing out"
16509 .cindex "timeout" "frozen messages"
16510 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
16511 message of any kind that has been on the queue for longer than the given time
16512 is automatically cancelled at the next queue run. If the frozen message is a
16513 bounce message, it is just discarded; otherwise, a bounce is sent to the
16514 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
16515 If you want to timeout frozen bounce messages earlier than other kinds of
16516 frozen message, see &%ignore_bounce_errors_after%&.
16517
16518 &*Note:*& the default value of zero means no timeouts; with this setting,
16519 frozen messages remain on the queue forever (except for any frozen bounce
16520 messages that are released by &%ignore_bounce_errors_after%&).
16521
16522
16523 .option timezone main string unset
16524 .cindex "timezone, setting"
16525 The value of &%timezone%& is used to set the environment variable TZ while
16526 running Exim (if it is different on entry). This ensures that all timestamps
16527 created by Exim are in the required timezone. If you want all your timestamps
16528 to be in UTC (aka GMT) you should set
16529 .code
16530 timezone = UTC
16531 .endd
16532 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
16533 or, if that is not set, from the value of the TZ environment variable when Exim
16534 is built. If &%timezone%& is set to the empty string, either at build or run
16535 time, any existing TZ variable is removed from the environment when Exim
16536 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
16537 unfortunately not all, operating systems.
16538
16539
16540 .option tls_advertise_hosts main "host list&!!" unset
16541 .cindex "TLS" "advertising"
16542 .cindex "encryption" "on SMTP connection"
16543 .cindex "SMTP" "encrypted connection"
16544 When Exim is built with support for TLS encrypted connections, the availability
16545 of the STARTTLS command to set up an encrypted session is advertised in
16546 response to EHLO only to those client hosts that match this option. See
16547 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
16548
16549
16550 .option tls_certificate main string&!! unset
16551 .cindex "TLS" "server certificate; location of"
16552 .cindex "certificate" "server, location of"
16553 The value of this option is expanded, and must then be the absolute path to a
16554 file which contains the server's certificates. The server's private key is also
16555 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
16556 &<<CHAPTLS>>& for further details.
16557
16558 &*Note*&: The certificates defined by this option are used only when Exim is
16559 receiving incoming messages as a server. If you want to supply certificates for
16560 use when sending messages as a client, you must set the &%tls_certificate%&
16561 option in the relevant &(smtp)& transport.
16562
16563 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
16564 if the OpenSSL build supports TLS extensions and the TLS client sends the
16565 Server Name Indication extension, then this option and others documented in
16566 &<<SECTtlssni>>& will be re-expanded.
16567
16568 .option tls_crl main string&!! unset
16569 .cindex "TLS" "server certificate revocation list"
16570 .cindex "certificate" "revocation list for server"
16571 This option specifies a certificate revocation list. The expanded value must
16572 be the name of a file that contains a CRL in PEM format.
16573
16574 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16575
16576
16577 .option tls_dh_max_bits main integer 2236
16578 .cindex "TLS" "D-H bit count"
16579 The number of bits used for Diffie-Hellman key-exchange may be suggested by
16580 the chosen TLS library.  That value might prove to be too high for
16581 interoperability.  This option provides a maximum clamp on the value
16582 suggested, trading off security for interoperability.
16583
16584 The value must be at least 1024.
16585
16586 The value 2236 was chosen because, at time of adding the option, it was the
16587 hard-coded maximum value supported by the NSS cryptographic library, as used
16588 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
16589
16590 If you prefer more security and are willing to break some clients, raise this
16591 number.
16592
16593 Note that the value passed to GnuTLS for *generating* a new prime may be a
16594 little less than this figure, because GnuTLS is inexact and may produce a
16595 larger prime than requested.
16596
16597
16598 .option tls_dhparam main string&!! unset
16599 .cindex "TLS" "D-H parameters for server"
16600 The value of this option is expanded and indicates the source of DH parameters
16601 to be used by Exim.
16602
16603 If it is a filename starting with a &`/`&, then it names a file from which DH
16604 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
16605 PKCS#3 representation of the DH prime.  If the file does not exist, for
16606 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
16607 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
16608 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
16609 and treated as though the &%tls_dhparam%& were set to "none".
16610
16611 If this option expands to the string "none", then no DH parameters will be
16612 loaded by Exim.
16613
16614 If this option expands to the string "historic" and Exim is using GnuTLS, then
16615 Exim will attempt to load a file from inside the spool directory.  If the file
16616 does not exist, Exim will attempt to create it.
16617 See section &<<SECTgnutlsparam>>& for further details.
16618
16619 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
16620 a default DH prime; the default is the 2048 bit prime described in section
16621 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
16622 in IKE is assigned number 23.
16623
16624 Otherwise, the option must expand to the name used by Exim for any of a number
16625 of DH primes specified in RFC 2409, RFC 3526 and RFC 5114.  As names, Exim uses
16626 "ike" followed by the number used by IKE, of "default" which corresponds to
16627 "ike23".
16628
16629 The available primes are:
16630 &`ike1`&, &`ike2`&, &`ike5`&,
16631 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
16632 &`ike22`&, &`ike23`& (aka &`default`&) and &`ike24`&.
16633
16634 Some of these will be too small to be accepted by clients.
16635 Some may be too large to be accepted by clients.
16636
16637 The TLS protocol does not negotiate an acceptable size for this; clients tend
16638 to hard-drop connections if what is offered by the server is unacceptable,
16639 whether too large or too small, and there's no provision for the client to
16640 tell the server what these constraints are.  Thus, as a server operator, you
16641 need to make an educated guess as to what is most likely to work for your
16642 userbase.
16643
16644 Some known size constraints suggest that a bit-size in the range 2048 to 2236
16645 is most likely to maximise interoperability.  The upper bound comes from
16646 applications using the Mozilla Network Security Services (NSS) library, which
16647 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
16648 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
16649 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
16650 acceptable bound from 1024 to 2048.
16651
16652
16653 .option tls_eccurve main string&!! prime256v1
16654 .cindex TLS "EC cryptography"
16655 If built with a recent-enough version of OpenSSL,
16656 this option selects a EC curve for use by Exim.
16657
16658 Curve names of the form &'prime256v1'& are accepted.
16659 For even more-recent library versions, names of the form &'P-512'&
16660 are also accepted, plus the special value &'auto'&
16661 which tell the library to choose.
16662
16663 If the option is set to an empty string, no EC curves will be enabled.
16664
16665
16666 .option tls_ocsp_file main string&!! unset
16667 .cindex TLS "certificate status"
16668 .cindex TLS "OCSP proof file"
16669 This option
16670 must if set expand to the absolute path to a file which contains a current
16671 status proof for the server's certificate, as obtained from the
16672 Certificate Authority.
16673
16674
16675 .option tls_on_connect_ports main "string list" unset
16676 .cindex SSMTP
16677 .cindex SMTPS
16678 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
16679 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
16680 set up without waiting for the client to issue a STARTTLS command. For
16681 further details, see section &<<SECTsupobssmt>>&.
16682
16683
16684
16685 .option tls_privatekey main string&!! unset
16686 .cindex "TLS" "server private key; location of"
16687 The value of this option is expanded, and must then be the absolute path to a
16688 file which contains the server's private key. If this option is unset, or if
16689 the expansion is forced to fail, or the result is an empty string, the private
16690 key is assumed to be in the same file as the server's certificates. See chapter
16691 &<<CHAPTLS>>& for further details.
16692
16693 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16694
16695
16696 .option tls_remember_esmtp main boolean false
16697 .cindex "TLS" "esmtp state; remembering"
16698 .cindex "TLS" "broken clients"
16699 If this option is set true, Exim violates the RFCs by remembering that it is in
16700 &"esmtp"& state after successfully negotiating a TLS session. This provides
16701 support for broken clients that fail to send a new EHLO after starting a
16702 TLS session.
16703
16704
16705 .option tls_require_ciphers main string&!! unset
16706 .cindex "TLS" "requiring specific ciphers"
16707 .cindex "cipher" "requiring specific"
16708 This option controls which ciphers can be used for incoming TLS connections.
16709 The &(smtp)& transport has an option of the same name for controlling outgoing
16710 connections. This option is expanded for each connection, so can be varied for
16711 different clients if required. The value of this option must be a list of
16712 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
16713 in somewhat different ways. If GnuTLS is being used, the client controls the
16714 preference order of the available ciphers. Details are given in sections
16715 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
16716
16717
16718 .option tls_try_verify_hosts main "host list&!!" unset
16719 .cindex "TLS" "client certificate verification"
16720 .cindex "certificate" "verification of client"
16721 See &%tls_verify_hosts%& below.
16722
16723
16724 .new
16725 .option tls_verify_certificates main string&!! system
16726 .cindex "TLS" "client certificate verification"
16727 .cindex "certificate" "verification of client"
16728 The value of this option is expanded, and must then be either the
16729 word "system"
16730 or the absolute path to
16731 a file or directory containing permitted certificates for clients that
16732 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
16733
16734 The "system" value for the option will use a
16735 system default location compiled into the SSL library.
16736 This is not available for GnuTLS versions preceding 3.0.20,
16737 and will be taken as empty; an explicit location
16738 must be specified.
16739
16740 The use of a directory for the option value is not avilable for GnuTLS versions
16741 preceding 3.3.6 and a single file must be used.
16742
16743 With OpenSSL the certificates specified
16744 explicitly
16745 either by file or directory
16746 are added to those given by the system default location.
16747 .wen
16748
16749 These certificates should be for the certificate authorities trusted, rather
16750 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
16751 the value is a file then the certificates are sent by Exim as a server to
16752 connecting clients, defining the list of accepted certificate authorities.
16753 Thus the values defined should be considered public data.  To avoid this,
16754 use the explicit directory version.
16755
16756 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
16757
16758 A forced expansion failure or setting to an empty string is equivalent to
16759 being unset.
16760
16761
16762 .option tls_verify_hosts main "host list&!!" unset
16763 .cindex "TLS" "client certificate verification"
16764 .cindex "certificate" "verification of client"
16765 This option, along with &%tls_try_verify_hosts%&, controls the checking of
16766 certificates from clients. The expected certificates are defined by
16767 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
16768 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
16769 &%tls_verify_certificates%& is not set.
16770
16771 Any client that matches &%tls_verify_hosts%& is constrained by
16772 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
16773 present one of the listed certificates. If it does not, the connection is
16774 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
16775 the host to use TLS. It can still send SMTP commands through unencrypted
16776 connections. Forcing a client to use TLS has to be done separately using an
16777 ACL to reject inappropriate commands when the connection is not encrypted.
16778
16779 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
16780 matches this option (but not &%tls_verify_hosts%&), Exim requests a
16781 certificate and checks it against &%tls_verify_certificates%&, but does not
16782 abort the connection if there is no certificate or if it does not match. This
16783 state can be detected in an ACL, which makes it possible to implement policies
16784 such as &"accept for relay only if a verified certificate has been received,
16785 but accept for local delivery if encrypted, even without a verified
16786 certificate"&.
16787
16788 Client hosts that match neither of these lists are not asked to present
16789 certificates.
16790
16791
16792 .option trusted_groups main "string list&!!" unset
16793 .cindex "trusted groups"
16794 .cindex "groups" "trusted"
16795 This option is expanded just once, at the start of Exim's processing. If this
16796 option is set, any process that is running in one of the listed groups, or
16797 which has one of them as a supplementary group, is trusted. The groups can be
16798 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
16799 details of what trusted callers are permitted to do. If neither
16800 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
16801 are trusted.
16802
16803 .option trusted_users main "string list&!!" unset
16804 .cindex "trusted users"
16805 .cindex "user" "trusted"
16806 This option is expanded just once, at the start of Exim's processing. If this
16807 option is set, any process that is running as one of the listed users is
16808 trusted. The users can be specified numerically or by name. See section
16809 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
16810 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
16811 Exim user are trusted.
16812
16813 .option unknown_login main string&!! unset
16814 .cindex "uid (user id)" "unknown caller"
16815 .vindex "&$caller_uid$&"
16816 This is a specialized feature for use in unusual configurations. By default, if
16817 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
16818 gives up. The &%unknown_login%& option can be used to set a login name to be
16819 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
16820 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
16821 is used for the user's real name (gecos field), unless this has been set by the
16822 &%-F%& option.
16823
16824 .option unknown_username main string unset
16825 See &%unknown_login%&.
16826
16827 .option untrusted_set_sender main "address list&!!" unset
16828 .cindex "trusted users"
16829 .cindex "sender" "setting by untrusted user"
16830 .cindex "untrusted user setting sender"
16831 .cindex "user" "untrusted setting sender"
16832 .cindex "envelope sender"
16833 When an untrusted user submits a message to Exim using the standard input, Exim
16834 normally creates an envelope sender address from the user's login and the
16835 default qualification domain. Data from the &%-f%& option (for setting envelope
16836 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
16837 is used) is ignored.
16838
16839 However, untrusted users are permitted to set an empty envelope sender address,
16840 to declare that a message should never generate any bounces. For example:
16841 .code
16842 exim -f '<>' user@domain.example
16843 .endd
16844 .vindex "&$sender_ident$&"
16845 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
16846 other envelope sender addresses in a controlled way. When it is set, untrusted
16847 users are allowed to set envelope sender addresses that match any of the
16848 patterns in the list. Like all address lists, the string is expanded. The
16849 identity of the user is in &$sender_ident$&, so you can, for example, restrict
16850 users to setting senders that start with their login ids
16851 followed by a hyphen
16852 by a setting like this:
16853 .code
16854 untrusted_set_sender = ^$sender_ident-
16855 .endd
16856 If you want to allow untrusted users to set envelope sender addresses without
16857 restriction, you can use
16858 .code
16859 untrusted_set_sender = *
16860 .endd
16861 The &%untrusted_set_sender%& option applies to all forms of local input, but
16862 only to the setting of the envelope sender. It does not permit untrusted users
16863 to use the other options which trusted user can use to override message
16864 parameters. Furthermore, it does not stop Exim from removing an existing
16865 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
16866 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
16867 overriding these actions. The handling of the &'Sender:'& header is also
16868 described in section &<<SECTthesenhea>>&.
16869
16870 The log line for a message's arrival shows the envelope sender following
16871 &"<="&. For local messages, the user's login always follows, after &"U="&. In
16872 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
16873 envelope sender address, the user's login is shown in parentheses after the
16874 sender address.
16875
16876
16877 .option uucp_from_pattern main string "see below"
16878 .cindex "&""From""& line"
16879 .cindex "UUCP" "&""From""& line"
16880 Some applications that pass messages to an MTA via a command line interface use
16881 an initial line starting with &"From&~"& to pass the envelope sender. In
16882 particular, this is used by UUCP software. Exim recognizes such a line by means
16883 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
16884 matches, the sender address is constructed by expanding the contents of
16885 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
16886 default pattern recognizes lines in the following two forms:
16887 .code
16888 From ph10 Fri Jan  5 12:35 GMT 1996
16889 From ph10 Fri, 7 Jan 97 14:00:00 GMT
16890 .endd
16891 The pattern can be seen by running
16892 .code
16893 exim -bP uucp_from_pattern
16894 .endd
16895 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
16896 year in the second case. The first word after &"From&~"& is matched in the
16897 regular expression by a parenthesized subpattern. The default value for
16898 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
16899 (&"ph10"& in the example above) as the message's sender. See also
16900 &%ignore_fromline_hosts%&.
16901
16902
16903 .option uucp_from_sender main string&!! &`$1`&
16904 See &%uucp_from_pattern%& above.
16905
16906
16907 .option warn_message_file main string unset
16908 .cindex "warning of delay" "customizing the message"
16909 .cindex "customizing" "warning message"
16910 This option defines a template file containing paragraphs of text to be used
16911 for constructing the warning message which is sent by Exim when a message has
16912 been on the queue for a specified amount of time, as specified by
16913 &%delay_warning%&. Details of the file's contents are given in chapter
16914 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
16915
16916
16917 .option write_rejectlog main boolean true
16918 .cindex "reject log" "disabling"
16919 If this option is set false, Exim no longer writes anything to the reject log.
16920 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
16921 .ecindex IIDconfima
16922 .ecindex IIDmaiconf
16923
16924
16925
16926
16927 . ////////////////////////////////////////////////////////////////////////////
16928 . ////////////////////////////////////////////////////////////////////////////
16929
16930 .chapter "Generic options for routers" "CHAProutergeneric"
16931 .scindex IIDgenoprou1 "options" "generic; for routers"
16932 .scindex IIDgenoprou2 "generic options" "router"
16933 This chapter describes the generic options that apply to all routers.
16934 Those that are preconditions are marked with &Dagger; in the &"use"& field.
16935
16936 For a general description of how a router operates, see sections
16937 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
16938 which the preconditions are tested. The order of expansion of the options that
16939 provide data for a transport is: &%errors_to%&, &%headers_add%&,
16940 &%headers_remove%&, &%transport%&.
16941
16942
16943
16944 .option address_data routers string&!! unset
16945 .cindex "router" "data attached to address"
16946 The string is expanded just before the router is run, that is, after all the
16947 precondition tests have succeeded. If the expansion is forced to fail, the
16948 router declines, the value of &%address_data%& remains unchanged, and the
16949 &%more%& option controls what happens next. Other expansion failures cause
16950 delivery of the address to be deferred.
16951
16952 .vindex "&$address_data$&"
16953 When the expansion succeeds, the value is retained with the address, and can be
16954 accessed using the variable &$address_data$& in the current router, subsequent
16955 routers, and the eventual transport.
16956
16957 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
16958 that runs a user's filter file, the contents of &$address_data$& are accessible
16959 in the filter. This is not normally a problem, because such data is usually
16960 either not confidential or it &"belongs"& to the current user, but if you do
16961 put confidential data into &$address_data$& you need to remember this point.
16962
16963 Even if the router declines or passes, the value of &$address_data$& remains
16964 with the address, though it can be changed by another &%address_data%& setting
16965 on a subsequent router. If a router generates child addresses, the value of
16966 &$address_data$& propagates to them. This also applies to the special kind of
16967 &"child"& that is generated by a router with the &%unseen%& option.
16968
16969 The idea of &%address_data%& is that you can use it to look up a lot of data
16970 for the address once, and then pick out parts of the data later. For example,
16971 you could use a single LDAP lookup to return a string of the form
16972 .code
16973 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
16974 .endd
16975 In the transport you could pick out the mailbox by a setting such as
16976 .code
16977 file = ${extract{mailbox}{$address_data}}
16978 .endd
16979 This makes the configuration file less messy, and also reduces the number of
16980 lookups (though Exim does cache lookups).
16981
16982 .vindex "&$sender_address_data$&"
16983 .vindex "&$address_data$&"
16984 The &%address_data%& facility is also useful as a means of passing information
16985 from one router to another, and from a router to a transport. In addition, if
16986 &$address_data$& is set by a router when verifying a recipient address from an
16987 ACL, it remains available for use in the rest of the ACL statement. After
16988 verifying a sender, the value is transferred to &$sender_address_data$&.
16989
16990
16991
16992 .option address_test routers&!? boolean true
16993 .oindex "&%-bt%&"
16994 .cindex "router" "skipping when address testing"
16995 If this option is set false, the router is skipped when routing is being tested
16996 by means of the &%-bt%& command line option. This can be a convenience when
16997 your first router sends messages to an external scanner, because it saves you
16998 having to set the &"already scanned"& indicator when testing real address
16999 routing.
17000
17001
17002
17003 .option cannot_route_message routers string&!! unset
17004 .cindex "router" "customizing &""cannot route""& message"
17005 .cindex "customizing" "&""cannot route""& message"
17006 This option specifies a text message that is used when an address cannot be
17007 routed because Exim has run out of routers. The default message is
17008 &"Unrouteable address"&. This option is useful only on routers that have
17009 &%more%& set false, or on the very last router in a configuration, because the
17010 value that is used is taken from the last router that is considered. This
17011 includes a router that is skipped because its preconditions are not met, as
17012 well as a router that declines. For example, using the default configuration,
17013 you could put:
17014 .code
17015 cannot_route_message = Remote domain not found in DNS
17016 .endd
17017 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17018 and
17019 .code
17020 cannot_route_message = Unknown local user
17021 .endd
17022 on the final router that checks for local users. If string expansion fails for
17023 this option, the default message is used. Unless the expansion failure was
17024 explicitly forced, a message about the failure is written to the main and panic
17025 logs, in addition to the normal message about the routing failure.
17026
17027
17028 .option caseful_local_part routers boolean false
17029 .cindex "case of local parts"
17030 .cindex "router" "case of local parts"
17031 By default, routers handle the local parts of addresses in a case-insensitive
17032 manner, though the actual case is preserved for transmission with the message.
17033 If you want the case of letters to be significant in a router, you must set
17034 this option true. For individual router options that contain address or local
17035 part lists (for example, &%local_parts%&), case-sensitive matching can be
17036 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17037 more details.
17038
17039 .vindex "&$local_part$&"
17040 .vindex "&$original_local_part$&"
17041 .vindex "&$parent_local_part$&"
17042 The value of the &$local_part$& variable is forced to lower case while a
17043 router is running unless &%caseful_local_part%& is set. When a router assigns
17044 an address to a transport, the value of &$local_part$& when the transport runs
17045 is the same as it was in the router. Similarly, when a router generates child
17046 addresses by aliasing or forwarding, the values of &$original_local_part$&
17047 and &$parent_local_part$& are those that were used by the redirecting router.
17048
17049 This option applies to the processing of an address by a router. When a
17050 recipient address is being processed in an ACL, there is a separate &%control%&
17051 modifier that can be used to specify case-sensitive processing within the ACL
17052 (see section &<<SECTcontrols>>&).
17053
17054
17055
17056 .option check_local_user routers&!? boolean false
17057 .cindex "local user, checking in router"
17058 .cindex "router" "checking for local user"
17059 .cindex "&_/etc/passwd_&"
17060 .vindex "&$home$&"
17061 When this option is true, Exim checks that the local part of the recipient
17062 address (with affixes removed if relevant) is the name of an account on the
17063 local system. The check is done by calling the &[getpwnam()]& function rather
17064 than trying to read &_/etc/passwd_& directly. This means that other methods of
17065 holding password data (such as NIS) are supported. If the local part is a local
17066 user, &$home$& is set from the password data, and can be tested in other
17067 preconditions that are evaluated after this one (the order of evaluation is
17068 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17069 overridden by &%router_home_directory%&. If the local part is not a local user,
17070 the router is skipped.
17071
17072 If you want to check that the local part is either the name of a local user
17073 or matches something else, you cannot combine &%check_local_user%& with a
17074 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17075 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17076 setting to achieve this. For example:
17077 .code
17078 local_parts = passwd;$local_part : lsearch;/etc/other/users
17079 .endd
17080 Note, however, that the side effects of &%check_local_user%& (such as setting
17081 up a home directory) do not occur when a &(passwd)& lookup is used in a
17082 &%local_parts%& (or any other) precondition.
17083
17084
17085
17086 .option condition routers&!? string&!! unset
17087 .cindex "router" "customized precondition"
17088 This option specifies a general precondition test that has to succeed for the
17089 router to be called. The &%condition%& option is the last precondition to be
17090 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17091 result is a forced failure, or an empty string, or one of the strings &"0"& or
17092 &"no"& or &"false"& (checked without regard to the case of the letters), the
17093 router is skipped, and the address is offered to the next one.
17094
17095 If the result is any other value, the router is run (as this is the last
17096 precondition to be evaluated, all the other preconditions must be true).
17097
17098 This option is unusual in that multiple &%condition%& options may be present.
17099 All &%condition%& options must succeed.
17100
17101 The &%condition%& option provides a means of applying custom conditions to the
17102 running of routers. Note that in the case of a simple conditional expansion,
17103 the default expansion values are exactly what is wanted. For example:
17104 .code
17105 condition = ${if >{$message_age}{600}}
17106 .endd
17107 Because of the default behaviour of the string expansion, this is equivalent to
17108 .code
17109 condition = ${if >{$message_age}{600}{true}{}}
17110 .endd
17111
17112 A multiple condition example, which succeeds:
17113 .code
17114 condition = ${if >{$message_age}{600}}
17115 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17116 condition = foobar
17117 .endd
17118
17119 If the expansion fails (other than forced failure) delivery is deferred. Some
17120 of the other precondition options are common special cases that could in fact
17121 be specified using &%condition%&.
17122
17123 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17124 are far older, and use one set of semantics.  ACLs are newer and when
17125 they were created, the ACL &%condition%& process was given far stricter
17126 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17127 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17128 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17129 Router rules processing behavior.
17130
17131 This is best illustrated in an example:
17132 .code
17133 # If used in an ACL condition will fail with a syntax error, but
17134 # in a router condition any extra characters are treated as a string
17135
17136 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17137 true {yes} {no}}
17138
17139 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17140  {yes} {no}}
17141 .endd
17142 In each example above, the &%if%& statement actually ends after
17143 &"{google.com}}"&.  Since no true or false braces were defined, the
17144 default &%if%& behavior is to return a boolean true or a null answer
17145 (which evaluates to false). The rest of the line is then treated as a
17146 string. So the first example resulted in the boolean answer &"true"&
17147 with the string &" {yes} {no}}"& appended to it. The second example
17148 resulted in the null output (indicating false) with the string
17149 &" {yes} {no}}"& appended to it.
17150
17151 In fact you can put excess forward braces in too.  In the router
17152 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17153 mean something, like after a &"$"& or when required as part of a
17154 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17155 string characters.
17156
17157 Thus, in a Router, the above expansion strings will both always evaluate
17158 true, as the result of expansion is a non-empty string which doesn't
17159 match an explicit false value.  This can be tricky to debug.  By
17160 contrast, in an ACL either of those strings will always result in an
17161 expansion error because the result doesn't look sufficiently boolean.
17162
17163
17164 .option debug_print routers string&!! unset
17165 .cindex "testing" "variables in drivers"
17166 If this option is set and debugging is enabled (see the &%-d%& command line
17167 option) or in address-testing mode (see the &%-bt%& command line option),
17168 the string is expanded and included in the debugging output.
17169 If expansion of the string fails, the error message is written to the debugging
17170 output, and Exim carries on processing.
17171 This option is provided to help with checking out the values of variables and
17172 so on when debugging router configurations. For example, if a &%condition%&
17173 option appears not to be working, &%debug_print%& can be used to output the
17174 variables it references. The output happens after checks for &%domains%&,
17175 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17176 are tested. A newline is added to the text if it does not end with one.
17177 The variable &$router_name$& contains the name of the router.
17178
17179
17180
17181 .option disable_logging routers boolean false
17182 If this option is set true, nothing is logged for any routing errors
17183 or for any deliveries caused by this router. You should not set this option
17184 unless you really, really know what you are doing. See also the generic
17185 transport option of the same name.
17186
17187 .option dnssec_request_domains routers "domain list&!!" unset
17188 .cindex "MX record" "security"
17189 .cindex "DNSSEC" "MX lookup"
17190 .cindex "security" "MX lookup"
17191 .cindex "DNS" "DNSSEC"
17192 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17193 the dnssec request bit set.
17194 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17195
17196 .option dnssec_require_domains routers "domain list&!!" unset
17197 .cindex "MX record" "security"
17198 .cindex "DNSSEC" "MX lookup"
17199 .cindex "security" "MX lookup"
17200 .cindex "DNS" "DNSSEC"
17201 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17202 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17203 (AD bit) set will be ignored and logged as a host-lookup failure.
17204 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17205
17206
17207 .option domains routers&!? "domain list&!!" unset
17208 .cindex "router" "restricting to specific domains"
17209 .vindex "&$domain_data$&"
17210 If this option is set, the router is skipped unless the current domain matches
17211 the list. If the match is achieved by means of a file lookup, the data that the
17212 lookup returned for the domain is placed in &$domain_data$& for use in string
17213 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17214 a list of the order in which preconditions are evaluated.
17215
17216
17217
17218 .option driver routers string unset
17219 This option must always be set. It specifies which of the available routers is
17220 to be used.
17221
17222
17223 .new
17224 .option dsn_lasthop routers boolean false
17225 .cindex "DSN" "success"
17226 .cindex "Delivery Status Notification" "success"
17227 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17228 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17229 instead send a success DSN as if the next hop does not support DSN.
17230 Not effective on redirect routers.
17231 .wen
17232
17233
17234
17235 .option errors_to routers string&!! unset
17236 .cindex "envelope sender"
17237 .cindex "router" "changing address for errors"
17238 If a router successfully handles an address, it may assign the address to a
17239 transport for delivery or it may generate child addresses. In both cases, if
17240 there is a delivery problem during later processing, the resulting bounce
17241 message is sent to the address that results from expanding this string,
17242 provided that the address verifies successfully. The &%errors_to%& option is
17243 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17244
17245 The &%errors_to%& setting associated with an address can be overridden if it
17246 subsequently passes through other routers that have their own &%errors_to%&
17247 settings, or if the message is delivered by a transport with a &%return_path%&
17248 setting.
17249
17250 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17251 the expansion fails to verify, the errors address associated with the incoming
17252 address is used. At top level, this is the envelope sender. A non-forced
17253 expansion failure causes delivery to be deferred.
17254
17255 If an address for which &%errors_to%& has been set ends up being delivered over
17256 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17257 any bounces that are generated by other MTAs on the delivery route are also
17258 sent there. You can set &%errors_to%& to the empty string by either of these
17259 settings:
17260 .code
17261 errors_to =
17262 errors_to = ""
17263 .endd
17264 An expansion item that yields an empty string has the same effect. If you do
17265 this, a locally detected delivery error for addresses processed by this router
17266 no longer gives rise to a bounce message; the error is discarded. If the
17267 address is delivered to a remote host, the return path is set to &`<>`&, unless
17268 overridden by the &%return_path%& option on the transport.
17269
17270 .vindex "&$address_data$&"
17271 If for some reason you want to discard local errors, but use a non-empty
17272 MAIL command for remote delivery, you can preserve the original return
17273 path in &$address_data$& in the router, and reinstate it in the transport by
17274 setting &%return_path%&.
17275
17276 The most common use of &%errors_to%& is to direct mailing list bounces to the
17277 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17278 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17279
17280
17281
17282 .option expn routers&!? boolean true
17283 .cindex "address" "testing"
17284 .cindex "testing" "addresses"
17285 .cindex "EXPN" "router skipping"
17286 .cindex "router" "skipping for EXPN"
17287 If this option is turned off, the router is skipped when testing an address
17288 as a result of processing an SMTP EXPN command. You might, for example,
17289 want to turn it off on a router for users' &_.forward_& files, while leaving it
17290 on for the system alias file.
17291 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17292 are evaluated.
17293
17294 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17295 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17296 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17297
17298
17299
17300 .option fail_verify routers boolean false
17301 .cindex "router" "forcing verification failure"
17302 Setting this option has the effect of setting both &%fail_verify_sender%& and
17303 &%fail_verify_recipient%& to the same value.
17304
17305
17306
17307 .option fail_verify_recipient routers boolean false
17308 If this option is true and an address is accepted by this router when
17309 verifying a recipient, verification fails.
17310
17311
17312
17313 .option fail_verify_sender routers boolean false
17314 If this option is true and an address is accepted by this router when
17315 verifying a sender, verification fails.
17316
17317
17318
17319 .option fallback_hosts routers "string list" unset
17320 .cindex "router" "fallback hosts"
17321 .cindex "fallback" "hosts specified on router"
17322 String expansion is not applied to this option. The argument must be a
17323 colon-separated list of host names or IP addresses. The list separator can be
17324 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17325 each name or address. In fact, the format of each item is exactly the same as
17326 defined for the list of hosts in a &(manualroute)& router (see section
17327 &<<SECTformatonehostitem>>&).
17328
17329 If a router queues an address for a remote transport, this host list is
17330 associated with the address, and used instead of the transport's fallback host
17331 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17332 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17333 transport for further details.
17334
17335
17336 .option group routers string&!! "see below"
17337 .cindex "gid (group id)" "local delivery"
17338 .cindex "local transports" "uid and gid"
17339 .cindex "transport" "local"
17340 .cindex "router" "setting group"
17341 When a router queues an address for a transport, and the transport does not
17342 specify a group, the group given here is used when running the delivery
17343 process.
17344 The group may be specified numerically or by name. If expansion fails, the
17345 error is logged and delivery is deferred.
17346 The default is unset, unless &%check_local_user%& is set, when the default
17347 is taken from the password information. See also &%initgroups%& and &%user%&
17348 and the discussion in chapter &<<CHAPenvironment>>&.
17349
17350
17351
17352 .option headers_add routers list&!! unset
17353 .cindex "header lines" "adding"
17354 .cindex "router" "adding header lines"
17355 This option specifies a list of text headers,
17356 .new
17357 newline-separated (by default, changeable in the usual way),
17358 .wen
17359 that is associated with any addresses that are accepted by the router.
17360 Each item is separately expanded, at routing time.  However, this
17361 option has no effect when an address is just being verified. The way in which
17362 the text is used to add header lines at transport time is described in section
17363 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17364 message is in the process of being transported. This means that references to
17365 header lines in string expansions in the transport's configuration do not
17366 &"see"& the added header lines.
17367
17368 The &%headers_add%& option is expanded after &%errors_to%&, but before
17369 &%headers_remove%& and &%transport%&. If an item is empty, or if
17370 an item expansion is forced to fail, the item has no effect. Other expansion
17371 failures are treated as configuration errors.
17372
17373 Unlike most options, &%headers_add%& can be specified multiple times
17374 for a router; all listed headers are added.
17375
17376 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17377 router that has the &%one_time%& option set.
17378
17379 .cindex "duplicate addresses"
17380 .oindex "&%unseen%&"
17381 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17382 additions are deleted when the address is passed on to subsequent routers.
17383 For a &%redirect%& router, if a generated address is the same as the incoming
17384 address, this can lead to duplicate addresses with different header
17385 modifications. Exim does not do duplicate deliveries (except, in certain
17386 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17387 which of the duplicates is discarded, so this ambiguous situation should be
17388 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17389
17390
17391
17392 .option headers_remove routers list&!! unset
17393 .cindex "header lines" "removing"
17394 .cindex "router" "removing header lines"
17395 This option specifies a list of text headers,
17396 .new
17397 colon-separated (by default, changeable in the usual way),
17398 .wen
17399 that is associated with any addresses that are accepted by the router.
17400 Each item is separately expanded, at routing time.  However, this
17401 option has no effect when an address is just being verified. The way in which
17402 the text is used to remove header lines at transport time is described in
17403 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17404 the message is in the process of being transported. This means that references
17405 to header lines in string expansions in the transport's configuration still
17406 &"see"& the original header lines.
17407
17408 The &%headers_remove%& option is expanded after &%errors_to%& and
17409 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17410 the item has no effect. Other expansion failures are treated as configuration
17411 errors.
17412
17413 Unlike most options, &%headers_remove%& can be specified multiple times
17414 for a router; all listed headers are removed.
17415
17416 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17417 router that has the &%one_time%& option set.
17418
17419 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17420 removal requests are deleted when the address is passed on to subsequent
17421 routers, and this can lead to problems with duplicates -- see the similar
17422 warning for &%headers_add%& above.
17423
17424 &*Warning 3*&: Because of the separate expansion of the list items,
17425 items that contain a list separator must have it doubled.
17426 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17427
17428
17429
17430 .option ignore_target_hosts routers "host list&!!" unset
17431 .cindex "IP address" "discarding"
17432 .cindex "router" "discarding IP addresses"
17433 Although this option is a host list, it should normally contain IP address
17434 entries rather than names. If any host that is looked up by the router has an
17435 IP address that matches an item in this list, Exim behaves as if that IP
17436 address did not exist. This option allows you to cope with rogue DNS entries
17437 like
17438 .code
17439 remote.domain.example.  A  127.0.0.1
17440 .endd
17441 by setting
17442 .code
17443 ignore_target_hosts = 127.0.0.1
17444 .endd
17445 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17446 discarded in this way, the router declines. In a conventional configuration, an
17447 attempt to mail to such a domain would normally provoke the &"unrouteable
17448 domain"& error, and an attempt to verify an address in the domain would fail.
17449 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
17450 router declines if presented with one of the listed addresses.
17451
17452 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
17453 means of the first or the second of the following settings, respectively:
17454 .code
17455 ignore_target_hosts = 0.0.0.0/0
17456 ignore_target_hosts = <; 0::0/0
17457 .endd
17458 The pattern in the first line matches all IPv4 addresses, whereas the pattern
17459 in the second line matches all IPv6 addresses.
17460
17461 This option may also be useful for ignoring link-local and site-local IPv6
17462 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
17463 is expanded before use as a list, it is possible to make it dependent on the
17464 domain that is being routed.
17465
17466 .vindex "&$host_address$&"
17467 During its expansion, &$host_address$& is set to the IP address that is being
17468 checked.
17469
17470 .option initgroups routers boolean false
17471 .cindex "additional groups"
17472 .cindex "groups" "additional"
17473 .cindex "local transports" "uid and gid"
17474 .cindex "transport" "local"
17475 If the router queues an address for a transport, and this option is true, and
17476 the uid supplied by the router is not overridden by the transport, the
17477 &[initgroups()]& function is called when running the transport to ensure that
17478 any additional groups associated with the uid are set up. See also &%group%&
17479 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
17480
17481
17482
17483 .option local_part_prefix routers&!? "string list" unset
17484 .cindex "router" "prefix for local part"
17485 .cindex "prefix" "for local part, used in router"
17486 If this option is set, the router is skipped unless the local part starts with
17487 one of the given strings, or &%local_part_prefix_optional%& is true. See
17488 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
17489 evaluated.
17490
17491 The list is scanned from left to right, and the first prefix that matches is
17492 used. A limited form of wildcard is available; if the prefix begins with an
17493 asterisk, it matches the longest possible sequence of arbitrary characters at
17494 the start of the local part. An asterisk should therefore always be followed by
17495 some character that does not occur in normal local parts.
17496 .cindex "multiple mailboxes"
17497 .cindex "mailbox" "multiple"
17498 Wildcarding can be used to set up multiple user mailboxes, as described in
17499 section &<<SECTmulbox>>&.
17500
17501 .vindex "&$local_part$&"
17502 .vindex "&$local_part_prefix$&"
17503 During the testing of the &%local_parts%& option, and while the router is
17504 running, the prefix is removed from the local part, and is available in the
17505 expansion variable &$local_part_prefix$&. When a message is being delivered, if
17506 the router accepts the address, this remains true during subsequent delivery by
17507 a transport. In particular, the local part that is transmitted in the RCPT
17508 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
17509 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
17510 the relevant transport.
17511
17512 When an address is being verified, &%local_part_prefix%& affects only the
17513 behaviour of the router. If the callout feature of verification is in use, this
17514 means that the full address, including the prefix, will be used during the
17515 callout.
17516
17517 The prefix facility is commonly used to handle local parts of the form
17518 &%owner-something%&. Another common use is to support local parts of the form
17519 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
17520 to tell a user their forwarding is broken &-- by placing a router like this one
17521 immediately before the router that handles &_.forward_& files:
17522 .code
17523 real_localuser:
17524   driver = accept
17525   local_part_prefix = real-
17526   check_local_user
17527   transport = local_delivery
17528 .endd
17529 For security, it would probably be a good idea to restrict the use of this
17530 router to locally-generated messages, using a condition such as this:
17531 .code
17532   condition = ${if match {$sender_host_address}\
17533                          {\N^(|127\.0\.0\.1)$\N}}
17534 .endd
17535
17536 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
17537 both conditions must be met if not optional. Care must be taken if wildcards
17538 are used in both a prefix and a suffix on the same router. Different
17539 separator characters must be used to avoid ambiguity.
17540
17541
17542 .option local_part_prefix_optional routers boolean false
17543 See &%local_part_prefix%& above.
17544
17545
17546
17547 .option local_part_suffix routers&!? "string list" unset
17548 .cindex "router" "suffix for local part"
17549 .cindex "suffix for local part" "used in router"
17550 This option operates in the same way as &%local_part_prefix%&, except that the
17551 local part must end (rather than start) with the given string, the
17552 &%local_part_suffix_optional%& option determines whether the suffix is
17553 mandatory, and the wildcard * character, if present, must be the last
17554 character of the suffix. This option facility is commonly used to handle local
17555 parts of the form &%something-request%& and multiple user mailboxes of the form
17556 &%username-foo%&.
17557
17558
17559 .option local_part_suffix_optional routers boolean false
17560 See &%local_part_suffix%& above.
17561
17562
17563
17564 .option local_parts routers&!? "local part list&!!" unset
17565 .cindex "router" "restricting to specific local parts"
17566 .cindex "local part" "checking in router"
17567 The router is run only if the local part of the address matches the list.
17568 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17569 are evaluated, and
17570 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
17571 string is expanded, it is possible to make it depend on the domain, for
17572 example:
17573 .code
17574 local_parts = dbm;/usr/local/specials/$domain
17575 .endd
17576 .vindex "&$local_part_data$&"
17577 If the match is achieved by a lookup, the data that the lookup returned
17578 for the local part is placed in the variable &$local_part_data$& for use in
17579 expansions of the router's private options. You might use this option, for
17580 example, if you have a large number of local virtual domains, and you want to
17581 send all postmaster mail to the same place without having to set up an alias in
17582 each virtual domain:
17583 .code
17584 postmaster:
17585   driver = redirect
17586   local_parts = postmaster
17587   data = postmaster@real.domain.example
17588 .endd
17589
17590
17591 .option log_as_local routers boolean "see below"
17592 .cindex "log" "delivery line"
17593 .cindex "delivery" "log line format"
17594 Exim has two logging styles for delivery, the idea being to make local
17595 deliveries stand out more visibly from remote ones. In the &"local"& style, the
17596 recipient address is given just as the local part, without a domain. The use of
17597 this style is controlled by this option. It defaults to true for the &(accept)&
17598 router, and false for all the others. This option applies only when a
17599 router assigns an address to a transport. It has no effect on routers that
17600 redirect addresses.
17601
17602
17603
17604 .option more routers boolean&!! true
17605 The result of string expansion for this option must be a valid boolean value,
17606 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17607 result causes an error, and delivery is deferred. If the expansion is forced to
17608 fail, the default value for the option (true) is used. Other failures cause
17609 delivery to be deferred.
17610
17611 If this option is set false, and the router declines to handle the address, no
17612 further routers are tried, routing fails, and the address is bounced.
17613 .oindex "&%self%&"
17614 However, if the router explicitly passes an address to the following router by
17615 means of the setting
17616 .code
17617 self = pass
17618 .endd
17619 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
17620 does not affect the behaviour if one of the precondition tests fails. In that
17621 case, the address is always passed to the next router.
17622
17623 Note that &%address_data%& is not considered to be a precondition. If its
17624 expansion is forced to fail, the router declines, and the value of &%more%&
17625 controls what happens next.
17626
17627
17628 .option pass_on_timeout routers boolean false
17629 .cindex "timeout" "of router"
17630 .cindex "router" "timeout"
17631 If a router times out during a host lookup, it normally causes deferral of the
17632 address. If &%pass_on_timeout%& is set, the address is passed on to the next
17633 router, overriding &%no_more%&. This may be helpful for systems that are
17634 intermittently connected to the Internet, or those that want to pass to a smart
17635 host any messages that cannot immediately be delivered.
17636
17637 There are occasional other temporary errors that can occur while doing DNS
17638 lookups. They are treated in the same way as a timeout, and this option
17639 applies to all of them.
17640
17641
17642
17643 .option pass_router routers string unset
17644 .cindex "router" "go to after &""pass""&"
17645 Routers that recognize the generic &%self%& option (&(dnslookup)&,
17646 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
17647 routing to continue, and overriding a false setting of &%more%&. When one of
17648 these routers returns &"pass"&, the address is normally handed on to the next
17649 router in sequence. This can be changed by setting &%pass_router%& to the name
17650 of another router. However (unlike &%redirect_router%&) the named router must
17651 be below the current router, to avoid loops. Note that this option applies only
17652 to the special case of &"pass"&. It does not apply when a router returns
17653 &"decline"& because it cannot handle an address.
17654
17655
17656
17657 .option redirect_router routers string unset
17658 .cindex "router" "start at after redirection"
17659 Sometimes an administrator knows that it is pointless to reprocess addresses
17660 generated from alias or forward files with the same router again. For
17661 example, if an alias file translates real names into login ids there is no
17662 point searching the alias file a second time, especially if it is a large file.
17663
17664 The &%redirect_router%& option can be set to the name of any router instance.
17665 It causes the routing of any generated addresses to start at the named router
17666 instead of at the first router. This option has no effect if the router in
17667 which it is set does not generate new addresses.
17668
17669
17670
17671 .option require_files routers&!? "string list&!!" unset
17672 .cindex "file" "requiring for router"
17673 .cindex "router" "requiring file existence"
17674 This option provides a general mechanism for predicating the running of a
17675 router on the existence or non-existence of certain files or directories.
17676 Before running a router, as one of its precondition tests, Exim works its way
17677 through the &%require_files%& list, expanding each item separately.
17678
17679 Because the list is split before expansion, any colons in expansion items must
17680 be doubled, or the facility for using a different list separator must be used.
17681 If any expansion is forced to fail, the item is ignored. Other expansion
17682 failures cause routing of the address to be deferred.
17683
17684 If any expanded string is empty, it is ignored. Otherwise, except as described
17685 below, each string must be a fully qualified file path, optionally preceded by
17686 &"!"&. The paths are passed to the &[stat()]& function to test for the
17687 existence of the files or directories. The router is skipped if any paths not
17688 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
17689
17690 .cindex "NFS"
17691 If &[stat()]& cannot determine whether a file exists or not, delivery of
17692 the message is deferred. This can happen when NFS-mounted filesystems are
17693 unavailable.
17694
17695 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
17696 options, so you cannot use it to check for the existence of a file in which to
17697 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
17698 full list of the order in which preconditions are evaluated.) However, as
17699 these options are all expanded, you can use the &%exists%& expansion condition
17700 to make such tests. The &%require_files%& option is intended for checking files
17701 that the router may be going to use internally, or which are needed by a
17702 transport (for example &_.procmailrc_&).
17703
17704 During delivery, the &[stat()]& function is run as root, but there is a
17705 facility for some checking of the accessibility of a file by another user.
17706 This is not a proper permissions check, but just a &"rough"& check that
17707 operates as follows:
17708
17709 If an item in a &%require_files%& list does not contain any forward slash
17710 characters, it is taken to be the user (and optional group, separated by a
17711 comma) to be checked for subsequent files in the list. If no group is specified
17712 but the user is specified symbolically, the gid associated with the uid is
17713 used. For example:
17714 .code
17715 require_files = mail:/some/file
17716 require_files = $local_part:$home/.procmailrc
17717 .endd
17718 If a user or group name in a &%require_files%& list does not exist, the
17719 &%require_files%& condition fails.
17720
17721 Exim performs the check by scanning along the components of the file path, and
17722 checking the access for the given uid and gid. It checks for &"x"& access on
17723 directories, and &"r"& access on the final file. Note that this means that file
17724 access control lists, if the operating system has them, are ignored.
17725
17726 &*Warning 1*&: When the router is being run to verify addresses for an
17727 incoming SMTP message, Exim is not running as root, but under its own uid. This
17728 may affect the result of a &%require_files%& check. In particular, &[stat()]&
17729 may yield the error EACCES (&"Permission denied"&). This means that the Exim
17730 user is not permitted to read one of the directories on the file's path.
17731
17732 &*Warning 2*&: Even when Exim is running as root while delivering a message,
17733 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
17734 without root access. In this case, if a check for access by a particular user
17735 is requested, Exim creates a subprocess that runs as that user, and tries the
17736 check again in that process.
17737
17738 The default action for handling an unresolved EACCES is to consider it to
17739 be caused by a configuration error, and routing is deferred because the
17740 existence or non-existence of the file cannot be determined. However, in some
17741 circumstances it may be desirable to treat this condition as if the file did
17742 not exist. If the file name (or the exclamation mark that precedes the file
17743 name for non-existence) is preceded by a plus sign, the EACCES error is treated
17744 as if the file did not exist. For example:
17745 .code
17746 require_files = +/some/file
17747 .endd
17748 If the router is not an essential part of verification (for example, it
17749 handles users' &_.forward_& files), another solution is to set the &%verify%&
17750 option false so that the router is skipped when verifying.
17751
17752
17753
17754 .option retry_use_local_part routers boolean "see below"
17755 .cindex "hints database" "retry keys"
17756 .cindex "local part" "in retry keys"
17757 When a delivery suffers a temporary routing failure, a retry record is created
17758 in Exim's hints database. For addresses whose routing depends only on the
17759 domain, the key for the retry record should not involve the local part, but for
17760 other addresses, both the domain and the local part should be included.
17761 Usually, remote routing is of the former kind, and local routing is of the
17762 latter kind.
17763
17764 This option controls whether the local part is used to form the key for retry
17765 hints for addresses that suffer temporary errors while being handled by this
17766 router. The default value is true for any router that has &%check_local_user%&
17767 set, and false otherwise. Note that this option does not apply to hints keys
17768 for transport delays; they are controlled by a generic transport option of the
17769 same name.
17770
17771 The setting of &%retry_use_local_part%& applies only to the router on which it
17772 appears. If the router generates child addresses, they are routed
17773 independently; this setting does not become attached to them.
17774
17775
17776
17777 .option router_home_directory routers string&!! unset
17778 .cindex "router" "home directory for"
17779 .cindex "home directory" "for router"
17780 .vindex "&$home$&"
17781 This option sets a home directory for use while the router is running. (Compare
17782 &%transport_home_directory%&, which sets a home directory for later
17783 transporting.) In particular, if used on a &(redirect)& router, this option
17784 sets a value for &$home$& while a filter is running. The value is expanded;
17785 forced expansion failure causes the option to be ignored &-- other failures
17786 cause the router to defer.
17787
17788 Expansion of &%router_home_directory%& happens immediately after the
17789 &%check_local_user%& test (if configured), before any further expansions take
17790 place.
17791 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17792 are evaluated.)
17793 While the router is running, &%router_home_directory%& overrides the value of
17794 &$home$& that came from &%check_local_user%&.
17795
17796 When a router accepts an address and assigns it to a local transport (including
17797 the cases when a &(redirect)& router generates a pipe, file, or autoreply
17798 delivery), the home directory setting for the transport is taken from the first
17799 of these values that is set:
17800
17801 .ilist
17802 The &%home_directory%& option on the transport;
17803 .next
17804 The &%transport_home_directory%& option on the router;
17805 .next
17806 The password data if &%check_local_user%& is set on the router;
17807 .next
17808 The &%router_home_directory%& option on the router.
17809 .endlist
17810
17811 In other words, &%router_home_directory%& overrides the password data for the
17812 router, but not for the transport.
17813
17814
17815
17816 .option self routers string freeze
17817 .cindex "MX record" "pointing to local host"
17818 .cindex "local host" "MX pointing to"
17819 This option applies to those routers that use a recipient address to find a
17820 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
17821 and &(manualroute)& routers.
17822 Certain configurations of the &(queryprogram)& router can also specify a list
17823 of remote hosts.
17824 Usually such routers are configured to send the message to a remote host via an
17825 &(smtp)& transport. The &%self%& option specifies what happens when the first
17826 host on the list turns out to be the local host.
17827 The way in which Exim checks for the local host is described in section
17828 &<<SECTreclocipadd>>&.
17829
17830 Normally this situation indicates either an error in Exim's configuration (for
17831 example, the router should be configured not to process this domain), or an
17832 error in the DNS (for example, the MX should not point to this host). For this
17833 reason, the default action is to log the incident, defer the address, and
17834 freeze the message. The following alternatives are provided for use in special
17835 cases:
17836
17837 .vlist
17838 .vitem &%defer%&
17839 Delivery of the message is tried again later, but the message is not frozen.
17840
17841 .vitem "&%reroute%&: <&'domain'&>"
17842 The domain is changed to the given domain, and the address is passed back to
17843 be reprocessed by the routers. No rewriting of headers takes place. This
17844 behaviour is essentially a redirection.
17845
17846 .vitem "&%reroute: rewrite:%& <&'domain'&>"
17847 The domain is changed to the given domain, and the address is passed back to be
17848 reprocessed by the routers. Any headers that contain the original domain are
17849 rewritten.
17850
17851 .vitem &%pass%&
17852 .oindex "&%more%&"
17853 .vindex "&$self_hostname$&"
17854 The router passes the address to the next router, or to the router named in the
17855 &%pass_router%& option if it is set. This overrides &%no_more%&. During
17856 subsequent routing and delivery, the variable &$self_hostname$& contains the
17857 name of the local host that the router encountered. This can be used to
17858 distinguish between different cases for hosts with multiple names. The
17859 combination
17860 .code
17861 self = pass
17862 no_more
17863 .endd
17864 ensures that only those addresses that routed to the local host are passed on.
17865 Without &%no_more%&, addresses that were declined for other reasons would also
17866 be passed to the next router.
17867
17868 .vitem &%fail%&
17869 Delivery fails and an error report is generated.
17870
17871 .vitem &%send%&
17872 .cindex "local host" "sending to"
17873 The anomaly is ignored and the address is queued for the transport. This
17874 setting should be used with extreme caution. For an &(smtp)& transport, it
17875 makes sense only in cases where the program that is listening on the SMTP port
17876 is not this version of Exim. That is, it must be some other MTA, or Exim with a
17877 different configuration file that handles the domain in another way.
17878 .endlist
17879
17880
17881
17882 .option senders routers&!? "address list&!!" unset
17883 .cindex "router" "checking senders"
17884 If this option is set, the router is skipped unless the message's sender
17885 address matches something on the list.
17886 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17887 are evaluated.
17888
17889 There are issues concerning verification when the running of routers is
17890 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
17891 setting, it sets the sender to the null string. When using the &%-bt%& option
17892 to check a configuration file, it is necessary also to use the &%-f%& option to
17893 set an appropriate sender. For incoming mail, the sender is unset when
17894 verifying the sender, but is available when verifying any recipients. If the
17895 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
17896 matters.
17897
17898
17899 .option translate_ip_address routers string&!! unset
17900 .cindex "IP address" "translating"
17901 .cindex "packet radio"
17902 .cindex "router" "IP address translation"
17903 There exist some rare networking situations (for example, packet radio) where
17904 it is helpful to be able to translate IP addresses generated by normal routing
17905 mechanisms into other IP addresses, thus performing a kind of manual IP
17906 routing. This should be done only if the normal IP routing of the TCP/IP stack
17907 is inadequate or broken. Because this is an extremely uncommon requirement, the
17908 code to support this option is not included in the Exim binary unless
17909 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
17910
17911 .vindex "&$host_address$&"
17912 The &%translate_ip_address%& string is expanded for every IP address generated
17913 by the router, with the generated address set in &$host_address$&. If the
17914 expansion is forced to fail, no action is taken.
17915 For any other expansion error, delivery of the message is deferred.
17916 If the result of the expansion is an IP address, that replaces the original
17917 address; otherwise the result is assumed to be a host name &-- this is looked
17918 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
17919 produce one or more replacement IP addresses. For example, to subvert all IP
17920 addresses in some specific networks, this could be added to a router:
17921 .code
17922 translate_ip_address = \
17923   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
17924     {$value}fail}}
17925 .endd
17926 The file would contain lines like
17927 .code
17928 10.2.3.128/26    some.host
17929 10.8.4.34/26     10.44.8.15
17930 .endd
17931 You should not make use of this facility unless you really understand what you
17932 are doing.
17933
17934
17935
17936 .option transport routers string&!! unset
17937 This option specifies the transport to be used when a router accepts an address
17938 and sets it up for delivery. A transport is never needed if a router is used
17939 only for verification. The value of the option is expanded at routing time,
17940 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
17941 and result must be the name of one of the configured transports. If it is not,
17942 delivery is deferred.
17943
17944 The &%transport%& option is not used by the &(redirect)& router, but it does
17945 have some private options that set up transports for pipe and file deliveries
17946 (see chapter &<<CHAPredirect>>&).
17947
17948
17949
17950 .option transport_current_directory routers string&!! unset
17951 .cindex "current directory for local transport"
17952 This option associates a current directory with any address that is routed
17953 to a local transport. This can happen either because a transport is
17954 explicitly configured for the router, or because it generates a delivery to a
17955 file or a pipe. During the delivery process (that is, at transport time), this
17956 option string is expanded and is set as the current directory, unless
17957 overridden by a setting on the transport.
17958 If the expansion fails for any reason, including forced failure, an error is
17959 logged, and delivery is deferred.
17960 See chapter &<<CHAPenvironment>>& for details of the local delivery
17961 environment.
17962
17963
17964
17965
17966 .option transport_home_directory routers string&!! "see below"
17967 .cindex "home directory" "for local transport"
17968 This option associates a home directory with any address that is routed to a
17969 local transport. This can happen either because a transport is explicitly
17970 configured for the router, or because it generates a delivery to a file or a
17971 pipe. During the delivery process (that is, at transport time), the option
17972 string is expanded and is set as the home directory, unless overridden by a
17973 setting of &%home_directory%& on the transport.
17974 If the expansion fails for any reason, including forced failure, an error is
17975 logged, and delivery is deferred.
17976
17977 If the transport does not specify a home directory, and
17978 &%transport_home_directory%& is not set for the router, the home directory for
17979 the transport is taken from the password data if &%check_local_user%& is set for
17980 the router. Otherwise it is taken from &%router_home_directory%& if that option
17981 is set; if not, no home directory is set for the transport.
17982
17983 See chapter &<<CHAPenvironment>>& for further details of the local delivery
17984 environment.
17985
17986
17987
17988
17989 .option unseen routers boolean&!! false
17990 .cindex "router" "carrying on after success"
17991 The result of string expansion for this option must be a valid boolean value,
17992 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
17993 result causes an error, and delivery is deferred. If the expansion is forced to
17994 fail, the default value for the option (false) is used. Other failures cause
17995 delivery to be deferred.
17996
17997 When this option is set true, routing does not cease if the router accepts the
17998 address. Instead, a copy of the incoming address is passed to the next router,
17999 overriding a false setting of &%more%&. There is little point in setting
18000 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18001 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18002 sometimes true and sometimes false).
18003
18004 .cindex "copy of message (&%unseen%& option)"
18005 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18006 qualifier in filter files. It can be used to cause copies of messages to be
18007 delivered to some other destination, while also carrying out a normal delivery.
18008 In effect, the current address is made into a &"parent"& that has two children
18009 &-- one that is delivered as specified by this router, and a clone that goes on
18010 to be routed further. For this reason, &%unseen%& may not be combined with the
18011 &%one_time%& option in a &(redirect)& router.
18012
18013 &*Warning*&: Header lines added to the address (or specified for removal) by
18014 this router or by previous routers affect the &"unseen"& copy of the message
18015 only. The clone that continues to be processed by further routers starts with
18016 no added headers and none specified for removal. For a &%redirect%& router, if
18017 a generated address is the same as the incoming address, this can lead to
18018 duplicate addresses with different header modifications. Exim does not do
18019 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18020 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18021 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18022 &%redirect%& router may be of help.
18023
18024 Unlike the handling of header modifications, any data that was set by the
18025 &%address_data%& option in the current or previous routers &'is'& passed on to
18026 subsequent routers.
18027
18028
18029 .option user routers string&!! "see below"
18030 .cindex "uid (user id)" "local delivery"
18031 .cindex "local transports" "uid and gid"
18032 .cindex "transport" "local"
18033 .cindex "router" "user for filter processing"
18034 .cindex "filter" "user for processing"
18035 When a router queues an address for a transport, and the transport does not
18036 specify a user, the user given here is used when running the delivery process.
18037 The user may be specified numerically or by name. If expansion fails, the
18038 error is logged and delivery is deferred.
18039 This user is also used by the &(redirect)& router when running a filter file.
18040 The default is unset, except when &%check_local_user%& is set. In this case,
18041 the default is taken from the password information. If the user is specified as
18042 a name, and &%group%& is not set, the group associated with the user is used.
18043 See also &%initgroups%& and &%group%& and the discussion in chapter
18044 &<<CHAPenvironment>>&.
18045
18046
18047
18048 .option verify routers&!? boolean true
18049 Setting this option has the effect of setting &%verify_sender%& and
18050 &%verify_recipient%& to the same value.
18051
18052
18053 .option verify_only routers&!? boolean false
18054 .cindex "EXPN" "with &%verify_only%&"
18055 .oindex "&%-bv%&"
18056 .cindex "router" "used only when verifying"
18057 If this option is set, the router is used only when verifying an address,
18058 delivering in cutthrough mode or
18059 testing with the &%-bv%& option, not when actually doing a delivery, testing
18060 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18061 restricted to verifying only senders or recipients by means of
18062 &%verify_sender%& and &%verify_recipient%&.
18063
18064 &*Warning*&: When the router is being run to verify addresses for an incoming
18065 SMTP message, Exim is not running as root, but under its own uid. If the router
18066 accesses any files, you need to make sure that they are accessible to the Exim
18067 user or group.
18068
18069
18070 .option verify_recipient routers&!? boolean true
18071 If this option is false, the router is skipped when verifying recipient
18072 addresses,
18073 delivering in cutthrough mode
18074 or testing recipient verification using &%-bv%&.
18075 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18076 are evaluated.
18077 See also the &$verify_mode$& variable.
18078
18079
18080 .option verify_sender routers&!? boolean true
18081 If this option is false, the router is skipped when verifying sender addresses
18082 or testing sender verification using &%-bvs%&.
18083 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18084 are evaluated.
18085 See also the &$verify_mode$& variable.
18086 .ecindex IIDgenoprou1
18087 .ecindex IIDgenoprou2
18088
18089
18090
18091
18092
18093
18094 . ////////////////////////////////////////////////////////////////////////////
18095 . ////////////////////////////////////////////////////////////////////////////
18096
18097 .chapter "The accept router" "CHID4"
18098 .cindex "&(accept)& router"
18099 .cindex "routers" "&(accept)&"
18100 The &(accept)& router has no private options of its own. Unless it is being
18101 used purely for verification (see &%verify_only%&) a transport is required to
18102 be defined by the generic &%transport%& option. If the preconditions that are
18103 specified by generic options are met, the router accepts the address and queues
18104 it for the given transport. The most common use of this router is for setting
18105 up deliveries to local mailboxes. For example:
18106 .code
18107 localusers:
18108   driver = accept
18109   domains = mydomain.example
18110   check_local_user
18111   transport = local_delivery
18112 .endd
18113 The &%domains%& condition in this example checks the domain of the address, and
18114 &%check_local_user%& checks that the local part is the login of a local user.
18115 When both preconditions are met, the &(accept)& router runs, and queues the
18116 address for the &(local_delivery)& transport.
18117
18118
18119
18120
18121
18122
18123 . ////////////////////////////////////////////////////////////////////////////
18124 . ////////////////////////////////////////////////////////////////////////////
18125
18126 .chapter "The dnslookup router" "CHAPdnslookup"
18127 .scindex IIDdnsrou1 "&(dnslookup)& router"
18128 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18129 The &(dnslookup)& router looks up the hosts that handle mail for the
18130 recipient's domain in the DNS. A transport must always be set for this router,
18131 unless &%verify_only%& is set.
18132
18133 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18134 SRV records. If none are found, or if SRV support is not configured,
18135 MX records are looked up. If no MX records exist, address records are sought.
18136 However, &%mx_domains%& can be set to disable the direct use of address
18137 records.
18138
18139 MX records of equal priority are sorted by Exim into a random order. Exim then
18140 looks for address records for the host names obtained from MX or SRV records.
18141 When a host has more than one IP address, they are sorted into a random order,
18142 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18143 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18144 generic option, the router declines.
18145
18146 Unless they have the highest priority (lowest MX value), MX records that point
18147 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18148 are discarded, together with any other MX records of equal or lower priority.
18149
18150 .cindex "MX record" "pointing to local host"
18151 .cindex "local host" "MX pointing to"
18152 .oindex "&%self%&" "in &(dnslookup)& router"
18153 If the host pointed to by the highest priority MX record, or looked up as an
18154 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18155 happens is controlled by the generic &%self%& option.
18156
18157
18158 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18159 There have been problems with DNS servers when SRV records are looked up.
18160 Some mis-behaving servers return a DNS error or timeout when a non-existent
18161 SRV record is sought. Similar problems have in the past been reported for
18162 MX records. The global &%dns_again_means_nonexist%& option can help with this
18163 problem, but it is heavy-handed because it is a global option.
18164
18165 For this reason, there are two options, &%srv_fail_domains%& and
18166 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18167 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18168 an attempt to look up an SRV or MX record causes one of these results, and the
18169 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18170 such record"&. In the case of an SRV lookup, this means that the router
18171 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18172 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18173 case routing fails.
18174
18175
18176 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18177 .cindex "&(dnslookup)& router" "declines"
18178 There are a few cases where a &(dnslookup)& router will decline to accept
18179 an address; if such a router is expected to handle "all remaining non-local
18180 domains", then it is important to set &%no_more%&.
18181
18182 The router will defer rather than decline if the domain
18183 is found in the &%fail_defer_domains%& router option.
18184
18185 Reasons for a &(dnslookup)& router to decline currently include:
18186 .ilist
18187 The domain does not exist in DNS
18188 .next
18189 The domain exists but the MX record's host part is just "."; this is a common
18190 convention (borrowed from SRV) used to indicate that there is no such service
18191 for this domain and to not fall back to trying A/AAAA records.
18192 .next
18193 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18194 .next
18195 MX record points to a non-existent host.
18196 .next
18197 MX record points to an IP address and the main section option
18198 &%allow_mx_to_ip%& is not set.
18199 .next
18200 MX records exist and point to valid hosts, but all hosts resolve only to
18201 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18202 .next
18203 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18204 &%dns_check_names_pattern%& for handling one variant of this)
18205 .next
18206 &%check_secondary_mx%& is set on this router but the local host can
18207 not be found in the MX records (see below)
18208 .endlist
18209
18210
18211
18212
18213 .section "Private options for dnslookup" "SECID118"
18214 .cindex "options" "&(dnslookup)& router"
18215 The private options for the &(dnslookup)& router are as follows:
18216
18217 .option check_secondary_mx dnslookup boolean false
18218 .cindex "MX record" "checking for secondary"
18219 If this option is set, the router declines unless the local host is found in
18220 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18221 process domains for which the local host is a secondary mail exchanger
18222 differently to other domains. The way in which Exim decides whether a host is
18223 the local host is described in section &<<SECTreclocipadd>>&.
18224
18225
18226 .option check_srv dnslookup string&!! unset
18227 .cindex "SRV record" "enabling use of"
18228 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18229 addition to MX and address records. The support is disabled by default. To
18230 enable SRV support, set the &%check_srv%& option to the name of the service
18231 required. For example,
18232 .code
18233 check_srv = smtp
18234 .endd
18235 looks for SRV records that refer to the normal smtp service. The option is
18236 expanded, so the service name can vary from message to message or address
18237 to address. This might be helpful if SRV records are being used for a
18238 submission service. If the expansion is forced to fail, the &%check_srv%&
18239 option is ignored, and the router proceeds to look for MX records in the
18240 normal way.
18241
18242 When the expansion succeeds, the router searches first for SRV records for
18243 the given service (it assumes TCP protocol). A single SRV record with a
18244 host name that consists of just a single dot indicates &"no such service for
18245 this domain"&; if this is encountered, the router declines. If other kinds of
18246 SRV record are found, they are used to construct a host list for delivery
18247 according to the rules of RFC 2782. MX records are not sought in this case.
18248
18249 When no SRV records are found, MX records (and address records) are sought in
18250 the traditional way. In other words, SRV records take precedence over MX
18251 records, just as MX records take precedence over address records. Note that
18252 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18253 defined it. It is apparently believed that MX records are sufficient for email
18254 and that SRV records should not be used for this purpose. However, SRV records
18255 have an additional &"weight"& feature which some people might find useful when
18256 trying to split an SMTP load between hosts of different power.
18257
18258 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18259 when there is a DNS lookup error.
18260
18261
18262
18263
18264 .option fail_defer_domains dnslookup "domain list&!!" unset
18265 .cindex "MX record" "not found"
18266 DNS lookups for domains matching &%fail_defer_domains%&
18267 which find no matching record will cause the router to defer
18268 rather than the default behaviour of decline.
18269 This maybe be useful for queueing messages for a newly created
18270 domain while the DNS configuration is not ready.
18271 However, it will result in any message with mistyped domains
18272 also being queued.
18273
18274
18275 .option mx_domains dnslookup "domain list&!!" unset
18276 .cindex "MX record" "required to exist"
18277 .cindex "SRV record" "required to exist"
18278 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18279 record in order to be recognized. (The name of this option could be improved.)
18280 For example, if all the mail hosts in &'fict.example'& are known to have MX
18281 records, except for those in &'discworld.fict.example'&, you could use this
18282 setting:
18283 .code
18284 mx_domains = ! *.discworld.fict.example : *.fict.example
18285 .endd
18286 This specifies that messages addressed to a domain that matches the list but
18287 has no MX record should be bounced immediately instead of being routed using
18288 the address record.
18289
18290
18291 .option mx_fail_domains dnslookup "domain list&!!" unset
18292 If the DNS lookup for MX records for one of the domains in this list causes a
18293 DNS lookup error, Exim behaves as if no MX records were found. See section
18294 &<<SECTprowitdnsloo>>& for more discussion.
18295
18296
18297
18298
18299 .option qualify_single dnslookup boolean true
18300 .cindex "DNS" "resolver options"
18301 .cindex "DNS" "qualifying single-component names"
18302 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18303 lookups. Typically, but not standardly, this causes the resolver to qualify
18304 single-component names with the default domain. For example, on a machine
18305 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18306 &'thesaurus.ref.example'& inside the resolver. For details of what your
18307 resolver actually does, consult your man pages for &'resolver'& and
18308 &'resolv.conf'&.
18309
18310
18311
18312 .option rewrite_headers dnslookup boolean true
18313 .cindex "rewriting" "header lines"
18314 .cindex "header lines" "rewriting"
18315 If the domain name in the address that is being processed is not fully
18316 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18317 an address is specified as &'dormouse@teaparty'&, the domain might be
18318 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18319 occur as a result of setting the &%widen_domains%& option. If
18320 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18321 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18322 header lines of the message are rewritten with the full domain name.
18323
18324 This option should be turned off only when it is known that no message is
18325 ever going to be sent outside an environment where the abbreviation makes
18326 sense.
18327
18328 When an MX record is looked up in the DNS and matches a wildcard record, name
18329 servers normally return a record containing the name that has been looked up,
18330 making it impossible to detect whether a wildcard was present or not. However,
18331 some name servers have recently been seen to return the wildcard entry. If the
18332 name returned by a DNS lookup begins with an asterisk, it is not used for
18333 header rewriting.
18334
18335
18336 .option same_domain_copy_routing dnslookup boolean false
18337 .cindex "address" "copying routing"
18338 Addresses with the same domain are normally routed by the &(dnslookup)& router
18339 to the same list of hosts. However, this cannot be presumed, because the router
18340 options and preconditions may refer to the local part of the address. By
18341 default, therefore, Exim routes each address in a message independently. DNS
18342 servers run caches, so repeated DNS lookups are not normally expensive, and in
18343 any case, personal messages rarely have more than a few recipients.
18344
18345 If you are running mailing lists with large numbers of subscribers at the same
18346 domain, and you are using a &(dnslookup)& router which is independent of the
18347 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18348 lookups for identical domains in one message. In this case, when &(dnslookup)&
18349 routes an address to a remote transport, any other unrouted addresses in the
18350 message that have the same domain are automatically given the same routing
18351 without processing them independently,
18352 provided the following conditions are met:
18353
18354 .ilist
18355 No router that processed the address specified &%headers_add%& or
18356 &%headers_remove%&.
18357 .next
18358 The router did not change the address in any way, for example, by &"widening"&
18359 the domain.
18360 .endlist
18361
18362
18363
18364
18365 .option search_parents dnslookup boolean false
18366 .cindex "DNS" "resolver options"
18367 When this option is true, the resolver option RES_DNSRCH is set for DNS
18368 lookups. This is different from the &%qualify_single%& option in that it
18369 applies to domains containing dots. Typically, but not standardly, it causes
18370 the resolver to search for the name in the current domain and in parent
18371 domains. For example, on a machine in the &'fict.example'& domain, if looking
18372 up &'teaparty.wonderland'& failed, the resolver would try
18373 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18374 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18375
18376 Setting this option true can cause problems in domains that have a wildcard MX
18377 record, because any domain that does not have its own MX record matches the
18378 local wildcard.
18379
18380
18381
18382 .option srv_fail_domains dnslookup "domain list&!!" unset
18383 If the DNS lookup for SRV records for one of the domains in this list causes a
18384 DNS lookup error, Exim behaves as if no SRV records were found. See section
18385 &<<SECTprowitdnsloo>>& for more discussion.
18386
18387
18388
18389
18390 .option widen_domains dnslookup "string list" unset
18391 .cindex "domain" "partial; widening"
18392 If a DNS lookup fails and this option is set, each of its strings in turn is
18393 added onto the end of the domain, and the lookup is tried again. For example,
18394 if
18395 .code
18396 widen_domains = fict.example:ref.example
18397 .endd
18398 is set and a lookup of &'klingon.dictionary'& fails,
18399 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18400 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18401 and &%search_parents%& options can cause some widening to be undertaken inside
18402 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18403 when verifying, unless &%rewrite_headers%& is false (not the default).
18404
18405
18406 .section "Effect of qualify_single and search_parents" "SECID119"
18407 When a domain from an envelope recipient is changed by the resolver as a result
18408 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18409 corresponding address in the message's header lines unless &%rewrite_headers%&
18410 is set false. Exim then re-routes the address, using the full domain.
18411
18412 These two options affect only the DNS lookup that takes place inside the router
18413 for the domain of the address that is being routed. They do not affect lookups
18414 such as that implied by
18415 .code
18416 domains = @mx_any
18417 .endd
18418 that may happen while processing a router precondition before the router is
18419 entered. No widening ever takes place for these lookups.
18420 .ecindex IIDdnsrou1
18421 .ecindex IIDdnsrou2
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431 . ////////////////////////////////////////////////////////////////////////////
18432 . ////////////////////////////////////////////////////////////////////////////
18433
18434 .chapter "The ipliteral router" "CHID5"
18435 .cindex "&(ipliteral)& router"
18436 .cindex "domain literal" "routing"
18437 .cindex "routers" "&(ipliteral)&"
18438 This router has no private options. Unless it is being used purely for
18439 verification (see &%verify_only%&) a transport is required to be defined by the
18440 generic &%transport%& option. The router accepts the address if its domain part
18441 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18442 router handles the address
18443 .code
18444 root@[192.168.1.1]
18445 .endd
18446 by setting up delivery to the host with that IP address. IPv4 domain literals
18447 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
18448 are similar, but the address is preceded by &`ipv6:`&. For example:
18449 .code
18450 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
18451 .endd
18452 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
18453 grounds that sooner or later somebody will try it.
18454
18455 .oindex "&%self%&" "in &(ipliteral)& router"
18456 If the IP address matches something in &%ignore_target_hosts%&, the router
18457 declines. If an IP literal turns out to refer to the local host, the generic
18458 &%self%& option determines what happens.
18459
18460 The RFCs require support for domain literals; however, their use is
18461 controversial in today's Internet. If you want to use this router, you must
18462 also set the main configuration option &%allow_domain_literals%&. Otherwise,
18463 Exim will not recognize the domain literal syntax in addresses.
18464
18465
18466
18467 . ////////////////////////////////////////////////////////////////////////////
18468 . ////////////////////////////////////////////////////////////////////////////
18469
18470 .chapter "The iplookup router" "CHID6"
18471 .cindex "&(iplookup)& router"
18472 .cindex "routers" "&(iplookup)&"
18473 The &(iplookup)& router was written to fulfil a specific requirement in
18474 Cambridge University (which in fact no longer exists). For this reason, it is
18475 not included in the binary of Exim by default. If you want to include it, you
18476 must set
18477 .code
18478 ROUTER_IPLOOKUP=yes
18479 .endd
18480 in your &_Local/Makefile_& configuration file.
18481
18482 The &(iplookup)& router routes an address by sending it over a TCP or UDP
18483 connection to one or more specific hosts. The host can then return the same or
18484 a different address &-- in effect rewriting the recipient address in the
18485 message's envelope. The new address is then passed on to subsequent routers. If
18486 this process fails, the address can be passed on to other routers, or delivery
18487 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
18488 must not be specified for it.
18489
18490 .cindex "options" "&(iplookup)& router"
18491 .option hosts iplookup string unset
18492 This option must be supplied. Its value is a colon-separated list of host
18493 names. The hosts are looked up using &[gethostbyname()]&
18494 (or &[getipnodebyname()]& when available)
18495 and are tried in order until one responds to the query. If none respond, what
18496 happens is controlled by &%optional%&.
18497
18498
18499 .option optional iplookup boolean false
18500 If &%optional%& is true, if no response is obtained from any host, the address
18501 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
18502 delivery to the address is deferred.
18503
18504
18505 .option port iplookup integer 0
18506 .cindex "port" "&(iplookup)& router"
18507 This option must be supplied. It specifies the port number for the TCP or UDP
18508 call.
18509
18510
18511 .option protocol iplookup string udp
18512 This option can be set to &"udp"& or &"tcp"& to specify which of the two
18513 protocols is to be used.
18514
18515
18516 .option query iplookup string&!! "see below"
18517 This defines the content of the query that is sent to the remote hosts. The
18518 default value is:
18519 .code
18520 $local_part@$domain $local_part@$domain
18521 .endd
18522 The repetition serves as a way of checking that a response is to the correct
18523 query in the default case (see &%response_pattern%& below).
18524
18525
18526 .option reroute iplookup string&!! unset
18527 If this option is not set, the rerouted address is precisely the byte string
18528 returned by the remote host, up to the first white space, if any. If set, the
18529 string is expanded to form the rerouted address. It can include parts matched
18530 in the response by &%response_pattern%& by means of numeric variables such as
18531 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
18532 whether or not a pattern is in use. In all cases, the rerouted address must end
18533 up in the form &'local_part@domain'&.
18534
18535
18536 .option response_pattern iplookup string unset
18537 This option can be set to a regular expression that is applied to the string
18538 returned from the remote host. If the pattern does not match the response, the
18539 router declines. If &%response_pattern%& is not set, no checking of the
18540 response is done, unless the query was defaulted, in which case there is a
18541 check that the text returned after the first white space is the original
18542 address. This checks that the answer that has been received is in response to
18543 the correct question. For example, if the response is just a new domain, the
18544 following could be used:
18545 .code
18546 response_pattern = ^([^@]+)$
18547 reroute = $local_part@$1
18548 .endd
18549
18550 .option timeout iplookup time 5s
18551 This specifies the amount of time to wait for a response from the remote
18552 machine. The same timeout is used for the &[connect()]& function for a TCP
18553 call. It does not apply to UDP.
18554
18555
18556
18557
18558 . ////////////////////////////////////////////////////////////////////////////
18559 . ////////////////////////////////////////////////////////////////////////////
18560
18561 .chapter "The manualroute router" "CHID7"
18562 .scindex IIDmanrou1 "&(manualroute)& router"
18563 .scindex IIDmanrou2 "routers" "&(manualroute)&"
18564 .cindex "domain" "manually routing"
18565 The &(manualroute)& router is so-called because it provides a way of manually
18566 routing an address according to its domain. It is mainly used when you want to
18567 route addresses to remote hosts according to your own rules, bypassing the
18568 normal DNS routing that looks up MX records. However, &(manualroute)& can also
18569 route to local transports, a facility that may be useful if you want to save
18570 messages for dial-in hosts in local files.
18571
18572 The &(manualroute)& router compares a list of domain patterns with the domain
18573 it is trying to route. If there is no match, the router declines. Each pattern
18574 has associated with it a list of hosts and some other optional data, which may
18575 include a transport. The combination of a pattern and its data is called a
18576 &"routing rule"&. For patterns that do not have an associated transport, the
18577 generic &%transport%& option must specify a transport, unless the router is
18578 being used purely for verification (see &%verify_only%&).
18579
18580 .vindex "&$host$&"
18581 In the case of verification, matching the domain pattern is sufficient for the
18582 router to accept the address. When actually routing an address for delivery,
18583 an address that matches a domain pattern is queued for the associated
18584 transport. If the transport is not a local one, a host list must be associated
18585 with the pattern; IP addresses are looked up for the hosts, and these are
18586 passed to the transport along with the mail address. For local transports, a
18587 host list is optional. If it is present, it is passed in &$host$& as a single
18588 text string.
18589
18590 The list of routing rules can be provided as an inline string in
18591 &%route_list%&, or the data can be obtained by looking up the domain in a file
18592 or database by setting &%route_data%&. Only one of these settings may appear in
18593 any one instance of &(manualroute)&. The format of routing rules is described
18594 below, following the list of private options.
18595
18596
18597 .section "Private options for manualroute" "SECTprioptman"
18598
18599 .cindex "options" "&(manualroute)& router"
18600 The private options for the &(manualroute)& router are as follows:
18601
18602 .option host_all_ignored manualroute string defer
18603 See &%host_find_failed%&.
18604
18605 .option host_find_failed manualroute string freeze
18606 This option controls what happens when &(manualroute)& tries to find an IP
18607 address for a host, and the host does not exist. The option can be set to one
18608 of the following values:
18609 .code
18610 decline
18611 defer
18612 fail
18613 freeze
18614 ignore
18615 pass
18616 .endd
18617 The default (&"freeze"&) assumes that this state is a serious configuration
18618 error. The difference between &"pass"& and &"decline"& is that the former
18619 forces the address to be passed to the next router (or the router defined by
18620 &%pass_router%&),
18621 .oindex "&%more%&"
18622 overriding &%no_more%&, whereas the latter passes the address to the next
18623 router only if &%more%& is true.
18624
18625 The value &"ignore"& causes Exim to completely ignore a host whose IP address
18626 cannot be found. If all the hosts in the list are ignored, the behaviour is
18627 controlled by the &%host_all_ignored%& option. This takes the same values
18628 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
18629
18630 The &%host_find_failed%& option applies only to a definite &"does not exist"&
18631 state; if a host lookup gets a temporary error, delivery is deferred unless the
18632 generic &%pass_on_timeout%& option is set.
18633
18634
18635 .option hosts_randomize manualroute boolean false
18636 .cindex "randomized host list"
18637 .cindex "host" "list of; randomized"
18638 If this option is set, the order of the items in a host list in a routing rule
18639 is randomized each time the list is used, unless an option in the routing rule
18640 overrides (see below). Randomizing the order of a host list can be used to do
18641 crude load sharing. However, if more than one mail address is routed by the
18642 same router to the same host list, the host lists are considered to be the same
18643 (even though they may be randomized into different orders) for the purpose of
18644 deciding whether to batch the deliveries into a single SMTP transaction.
18645
18646 When &%hosts_randomize%& is true, a host list may be split
18647 into groups whose order is separately randomized. This makes it possible to
18648 set up MX-like behaviour. The boundaries between groups are indicated by an
18649 item that is just &`+`& in the host list. For example:
18650 .code
18651 route_list = * host1:host2:host3:+:host4:host5
18652 .endd
18653 The order of the first three hosts and the order of the last two hosts is
18654 randomized for each use, but the first three always end up before the last two.
18655 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
18656 randomized host list is passed to an &(smtp)& transport that also has
18657 &%hosts_randomize set%&, the list is not re-randomized.
18658
18659
18660 .option route_data manualroute string&!! unset
18661 If this option is set, it must expand to yield the data part of a routing rule.
18662 Typically, the expansion string includes a lookup based on the domain. For
18663 example:
18664 .code
18665 route_data = ${lookup{$domain}dbm{/etc/routes}}
18666 .endd
18667 If the expansion is forced to fail, or the result is an empty string, the
18668 router declines. Other kinds of expansion failure cause delivery to be
18669 deferred.
18670
18671
18672 .option route_list manualroute "string list" unset
18673 This string is a list of routing rules, in the form defined below. Note that,
18674 unlike most string lists, the items are separated by semicolons. This is so
18675 that they may contain colon-separated host lists.
18676
18677
18678 .option same_domain_copy_routing manualroute boolean false
18679 .cindex "address" "copying routing"
18680 Addresses with the same domain are normally routed by the &(manualroute)&
18681 router to the same list of hosts. However, this cannot be presumed, because the
18682 router options and preconditions may refer to the local part of the address. By
18683 default, therefore, Exim routes each address in a message independently. DNS
18684 servers run caches, so repeated DNS lookups are not normally expensive, and in
18685 any case, personal messages rarely have more than a few recipients.
18686
18687 If you are running mailing lists with large numbers of subscribers at the same
18688 domain, and you are using a &(manualroute)& router which is independent of the
18689 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18690 lookups for identical domains in one message. In this case, when
18691 &(manualroute)& routes an address to a remote transport, any other unrouted
18692 addresses in the message that have the same domain are automatically given the
18693 same routing without processing them independently. However, this is only done
18694 if &%headers_add%& and &%headers_remove%& are unset.
18695
18696
18697
18698
18699 .section "Routing rules in route_list" "SECID120"
18700 The value of &%route_list%& is a string consisting of a sequence of routing
18701 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
18702 entered as two semicolons. Alternatively, the list separator can be changed as
18703 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
18704 Empty rules are ignored. The format of each rule is
18705 .display
18706 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
18707 .endd
18708 The following example contains two rules, each with a simple domain pattern and
18709 no options:
18710 .code
18711 route_list = \
18712   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
18713   thes.ref.example  mail-3.ref.example:mail-4.ref.example
18714 .endd
18715 The three parts of a rule are separated by white space. The pattern and the
18716 list of hosts can be enclosed in quotes if necessary, and if they are, the
18717 usual quoting rules apply. Each rule in a &%route_list%& must start with a
18718 single domain pattern, which is the only mandatory item in the rule. The
18719 pattern is in the same format as one item in a domain list (see section
18720 &<<SECTdomainlist>>&),
18721 except that it may not be the name of an interpolated file.
18722 That is, it may be wildcarded, or a regular expression, or a file or database
18723 lookup (with semicolons doubled, because of the use of semicolon as a separator
18724 in a &%route_list%&).
18725
18726 The rules in &%route_list%& are searched in order until one of the patterns
18727 matches the domain that is being routed. The list of hosts and then options are
18728 then used as described below. If there is no match, the router declines. When
18729 &%route_list%& is set, &%route_data%& must not be set.
18730
18731
18732
18733 .section "Routing rules in route_data" "SECID121"
18734 The use of &%route_list%& is convenient when there are only a small number of
18735 routing rules. For larger numbers, it is easier to use a file or database to
18736 hold the routing information, and use the &%route_data%& option instead.
18737 The value of &%route_data%& is a list of hosts, followed by (optional) options.
18738 Most commonly, &%route_data%& is set as a string that contains an
18739 expansion lookup. For example, suppose we place two routing rules in a file
18740 like this:
18741 .code
18742 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
18743 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
18744 .endd
18745 This data can be accessed by setting
18746 .code
18747 route_data = ${lookup{$domain}lsearch{/the/file/name}}
18748 .endd
18749 Failure of the lookup results in an empty string, causing the router to
18750 decline. However, you do not have to use a lookup in &%route_data%&. The only
18751 requirement is that the result of expanding the string is a list of hosts,
18752 possibly followed by options, separated by white space. The list of hosts must
18753 be enclosed in quotes if it contains white space.
18754
18755
18756
18757
18758 .section "Format of the list of hosts" "SECID122"
18759 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
18760 always separately expanded before use. If the expansion fails, the router
18761 declines. The result of the expansion must be a colon-separated list of names
18762 and/or IP addresses, optionally also including ports. The format of each item
18763 in the list is described in the next section. The list separator can be changed
18764 as described in section &<<SECTlistconstruct>>&.
18765
18766 If the list of hosts was obtained from a &%route_list%& item, the following
18767 variables are set during its expansion:
18768
18769 .ilist
18770 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
18771 If the domain was matched against a regular expression, the numeric variables
18772 &$1$&, &$2$&, etc. may be set. For example:
18773 .code
18774 route_list = ^domain(\d+)   host-$1.text.example
18775 .endd
18776 .next
18777 &$0$& is always set to the entire domain.
18778 .next
18779 &$1$& is also set when partial matching is done in a file lookup.
18780
18781 .next
18782 .vindex "&$value$&"
18783 If the pattern that matched the domain was a lookup item, the data that was
18784 looked up is available in the expansion variable &$value$&. For example:
18785 .code
18786 route_list = lsearch;;/some/file.routes  $value
18787 .endd
18788 .endlist
18789
18790 Note the doubling of the semicolon in the pattern that is necessary because
18791 semicolon is the default route list separator.
18792
18793
18794
18795 .section "Format of one host item" "SECTformatonehostitem"
18796 Each item in the list of hosts is either a host name or an IP address,
18797 optionally with an attached port number. When no port is given, an IP address
18798 is not enclosed in brackets. When a port is specified, it overrides the port
18799 specification on the transport. The port is separated from the name or address
18800 by a colon. This leads to some complications:
18801
18802 .ilist
18803 Because colon is the default separator for the list of hosts, either
18804 the colon that specifies a port must be doubled, or the list separator must
18805 be changed. The following two examples have the same effect:
18806 .code
18807 route_list = * "host1.tld::1225 : host2.tld::1226"
18808 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
18809 .endd
18810 .next
18811 When IPv6 addresses are involved, it gets worse, because they contain
18812 colons of their own. To make this case easier, it is permitted to
18813 enclose an IP address (either v4 or v6) in square brackets if a port
18814 number follows. For example:
18815 .code
18816 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
18817 .endd
18818 .endlist
18819
18820 .section "How the list of hosts is used" "SECThostshowused"
18821 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
18822 the hosts is tried, in the order specified, when carrying out the SMTP
18823 delivery. However, the order can be changed by setting the &%hosts_randomize%&
18824 option, either on the router (see section &<<SECTprioptman>>& above), or on the
18825 transport.
18826
18827 Hosts may be listed by name or by IP address. An unadorned name in the list of
18828 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
18829 interpreted as an indirection to a sublist of hosts obtained by looking up MX
18830 records in the DNS. For example:
18831 .code
18832 route_list = *  x.y.z:p.q.r/MX:e.f.g
18833 .endd
18834 If this feature is used with a port specifier, the port must come last. For
18835 example:
18836 .code
18837 route_list = *  dom1.tld/mx::1225
18838 .endd
18839 If the &%hosts_randomize%& option is set, the order of the items in the list is
18840 randomized before any lookups are done. Exim then scans the list; for any name
18841 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
18842 be an interface on the local host and the item is not the first in the list,
18843 Exim discards it and any subsequent items. If it is the first item, what
18844 happens is controlled by the
18845 .oindex "&%self%&" "in &(manualroute)& router"
18846 &%self%& option of the router.
18847
18848 A name on the list that is followed by &`/MX`& is replaced with the list of
18849 hosts obtained by looking up MX records for the name. This is always a DNS
18850 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
18851 below) are not relevant here. The order of these hosts is determined by the
18852 preference values in the MX records, according to the usual rules. Because
18853 randomizing happens before the MX lookup, it does not affect the order that is
18854 defined by MX preferences.
18855
18856 If the local host is present in the sublist obtained from MX records, but is
18857 not the most preferred host in that list, it and any equally or less
18858 preferred hosts are removed before the sublist is inserted into the main list.
18859
18860 If the local host is the most preferred host in the MX list, what happens
18861 depends on where in the original list of hosts the &`/MX`& item appears. If it
18862 is not the first item (that is, there are previous hosts in the main list),
18863 Exim discards this name and any subsequent items in the main list.
18864
18865 If the MX item is first in the list of hosts, and the local host is the
18866 most preferred host, what happens is controlled by the &%self%& option of the
18867 router.
18868
18869 DNS failures when lookup up the MX records are treated in the same way as DNS
18870 failures when looking up IP addresses: &%pass_on_timeout%& and
18871 &%host_find_failed%& are used when relevant.
18872
18873 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
18874 whether obtained from an MX lookup or not.
18875
18876
18877
18878 .section "How the options are used" "SECThowoptused"
18879 The options are a sequence of words; in practice no more than three are ever
18880 present. One of the words can be the name of a transport; this overrides the
18881 &%transport%& option on the router for this particular routing rule only. The
18882 other words (if present) control randomization of the list of hosts on a
18883 per-rule basis, and how the IP addresses of the hosts are to be found when
18884 routing to a remote transport. These options are as follows:
18885
18886 .ilist
18887 &%randomize%&: randomize the order of the hosts in this list, overriding the
18888 setting of &%hosts_randomize%& for this routing rule only.
18889 .next
18890 &%no_randomize%&: do not randomize the order of the hosts in this list,
18891 overriding the setting of &%hosts_randomize%& for this routing rule only.
18892 .next
18893 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
18894 find IP addresses. This function may ultimately cause a DNS lookup, but it may
18895 also look in &_/etc/hosts_& or other sources of information.
18896 .next
18897 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
18898 no address records are found. If there is a temporary DNS error (such as a
18899 timeout), delivery is deferred.
18900 .endlist
18901
18902 For example:
18903 .code
18904 route_list = domain1  host1:host2:host3  randomize bydns;\
18905              domain2  host4:host5
18906 .endd
18907 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
18908 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
18909 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
18910 or &[gethostbyname()]&, and the result of the lookup is the result of that
18911 call.
18912
18913 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
18914 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
18915 instead of TRY_AGAIN. That is why the default action is to try a DNS
18916 lookup first. Only if that gives a definite &"no such host"& is the local
18917 function called.
18918
18919
18920
18921 If no IP address for a host can be found, what happens is controlled by the
18922 &%host_find_failed%& option.
18923
18924 .vindex "&$host$&"
18925 When an address is routed to a local transport, IP addresses are not looked up.
18926 The host list is passed to the transport in the &$host$& variable.
18927
18928
18929
18930 .section "Manualroute examples" "SECID123"
18931 In some of the examples that follow, the presence of the &%remote_smtp%&
18932 transport, as defined in the default configuration file, is assumed:
18933
18934 .ilist
18935 .cindex "smart host" "example router"
18936 The &(manualroute)& router can be used to forward all external mail to a
18937 &'smart host'&. If you have set up, in the main part of the configuration, a
18938 named domain list that contains your local domains, for example:
18939 .code
18940 domainlist local_domains = my.domain.example
18941 .endd
18942 You can arrange for all other domains to be routed to a smart host by making
18943 your first router something like this:
18944 .code
18945 smart_route:
18946   driver = manualroute
18947   domains = !+local_domains
18948   transport = remote_smtp
18949   route_list = * smarthost.ref.example
18950 .endd
18951 This causes all non-local addresses to be sent to the single host
18952 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
18953 they are tried in order
18954 (but you can use &%hosts_randomize%& to vary the order each time).
18955 Another way of configuring the same thing is this:
18956 .code
18957 smart_route:
18958   driver = manualroute
18959   transport = remote_smtp
18960   route_list = !+local_domains  smarthost.ref.example
18961 .endd
18962 There is no difference in behaviour between these two routers as they stand.
18963 However, they behave differently if &%no_more%& is added to them. In the first
18964 example, the router is skipped if the domain does not match the &%domains%&
18965 precondition; the following router is always tried. If the router runs, it
18966 always matches the domain and so can never decline. Therefore, &%no_more%&
18967 would have no effect. In the second case, the router is never skipped; it
18968 always runs. However, if it doesn't match the domain, it declines. In this case
18969 &%no_more%& would prevent subsequent routers from running.
18970
18971 .next
18972 .cindex "mail hub example"
18973 A &'mail hub'& is a host which receives mail for a number of domains via MX
18974 records in the DNS and delivers it via its own private routing mechanism. Often
18975 the final destinations are behind a firewall, with the mail hub being the one
18976 machine that can connect to machines both inside and outside the firewall. The
18977 &(manualroute)& router is usually used on a mail hub to route incoming messages
18978 to the correct hosts. For a small number of domains, the routing can be inline,
18979 using the &%route_list%& option, but for a larger number a file or database
18980 lookup is easier to manage.
18981
18982 If the domain names are in fact the names of the machines to which the mail is
18983 to be sent by the mail hub, the configuration can be quite simple. For
18984 example:
18985 .code
18986 hub_route:
18987   driver = manualroute
18988   transport = remote_smtp
18989   route_list = *.rhodes.tvs.example  $domain
18990 .endd
18991 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
18992 whose names are the same as the mail domains. A similar approach can be taken
18993 if the host name can be obtained from the domain name by a string manipulation
18994 that the expansion facilities can handle. Otherwise, a lookup based on the
18995 domain can be used to find the host:
18996 .code
18997 through_firewall:
18998   driver = manualroute
18999   transport = remote_smtp
19000   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19001 .endd
19002 The result of the lookup must be the name or IP address of the host (or
19003 hosts) to which the address is to be routed. If the lookup fails, the route
19004 data is empty, causing the router to decline. The address then passes to the
19005 next router.
19006
19007 .next
19008 .cindex "batched SMTP output example"
19009 .cindex "SMTP" "batched outgoing; example"
19010 You can use &(manualroute)& to deliver messages to pipes or files in batched
19011 SMTP format for onward transportation by some other means. This is one way of
19012 storing mail for a dial-up host when it is not connected. The route list entry
19013 can be as simple as a single domain name in a configuration like this:
19014 .code
19015 save_in_file:
19016   driver = manualroute
19017   transport = batchsmtp_appendfile
19018   route_list = saved.domain.example
19019 .endd
19020 though often a pattern is used to pick up more than one domain. If there are
19021 several domains or groups of domains with different transport requirements,
19022 different transports can be listed in the routing information:
19023 .code
19024 save_in_file:
19025   driver = manualroute
19026   route_list = \
19027     *.saved.domain1.example  $domain  batch_appendfile; \
19028     *.saved.domain2.example  \
19029       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19030       batch_pipe
19031 .endd
19032 .vindex "&$domain$&"
19033 .vindex "&$host$&"
19034 The first of these just passes the domain in the &$host$& variable, which
19035 doesn't achieve much (since it is also in &$domain$&), but the second does a
19036 file lookup to find a value to pass, causing the router to decline to handle
19037 the address if the lookup fails.
19038
19039 .next
19040 .cindex "UUCP" "example of router for"
19041 Routing mail directly to UUCP software is a specific case of the use of
19042 &(manualroute)& in a gateway to another mail environment. This is an example of
19043 one way it can be done:
19044 .code
19045 # Transport
19046 uucp:
19047   driver = pipe
19048   user = nobody
19049   command = /usr/local/bin/uux -r - \
19050     ${substr_-5:$host}!rmail ${local_part}
19051   return_fail_output = true
19052
19053 # Router
19054 uucphost:
19055   transport = uucp
19056   driver = manualroute
19057   route_data = \
19058     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19059 .endd
19060 The file &_/usr/local/exim/uucphosts_& contains entries like
19061 .code
19062 darksite.ethereal.example:           darksite.UUCP
19063 .endd
19064 It can be set up more simply without adding and removing &".UUCP"& but this way
19065 makes clear the distinction between the domain name
19066 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19067 .endlist
19068 .ecindex IIDmanrou1
19069 .ecindex IIDmanrou2
19070
19071
19072
19073
19074
19075
19076
19077
19078 . ////////////////////////////////////////////////////////////////////////////
19079 . ////////////////////////////////////////////////////////////////////////////
19080
19081 .chapter "The queryprogram router" "CHAPdriverlast"
19082 .scindex IIDquerou1 "&(queryprogram)& router"
19083 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19084 .cindex "routing" "by external program"
19085 The &(queryprogram)& router routes an address by running an external command
19086 and acting on its output. This is an expensive way to route, and is intended
19087 mainly for use in lightly-loaded systems, or for performing experiments.
19088 However, if it is possible to use the precondition options (&%domains%&,
19089 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19090 be used in special cases, even on a busy host. There are the following private
19091 options:
19092 .cindex "options" "&(queryprogram)& router"
19093
19094 .option command queryprogram string&!! unset
19095 This option must be set. It specifies the command that is to be run. The
19096 command is split up into a command name and arguments, and then each is
19097 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19098 &<<CHAPpipetransport>>&).
19099
19100
19101 .option command_group queryprogram string unset
19102 .cindex "gid (group id)" "in &(queryprogram)& router"
19103 This option specifies a gid to be set when running the command while routing an
19104 address for deliver. It must be set if &%command_user%& specifies a numerical
19105 uid. If it begins with a digit, it is interpreted as the numerical value of the
19106 gid. Otherwise it is looked up using &[getgrnam()]&.
19107
19108
19109 .option command_user queryprogram string unset
19110 .cindex "uid (user id)" "for &(queryprogram)&"
19111 This option must be set. It specifies the uid which is set when running the
19112 command while routing an address for delivery. If the value begins with a digit,
19113 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19114 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19115 not set, a value for the gid also.
19116
19117 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19118 root, which it does during a normal delivery in a conventional configuration.
19119 However, when an address is being verified during message reception, Exim is
19120 usually running as the Exim user, not as root. If the &(queryprogram)& router
19121 is called from a non-root process, Exim cannot change uid or gid before running
19122 the command. In this circumstance the command runs under the current uid and
19123 gid.
19124
19125
19126 .option current_directory queryprogram string /
19127 This option specifies an absolute path which is made the current directory
19128 before running the command.
19129
19130
19131 .option timeout queryprogram time 1h
19132 If the command does not complete within the timeout period, its process group
19133 is killed and the message is frozen. A value of zero time specifies no
19134 timeout.
19135
19136
19137 The standard output of the command is connected to a pipe, which is read when
19138 the command terminates. It should consist of a single line of output,
19139 containing up to five fields, separated by white space. The maximum length of
19140 the line is 1023 characters. Longer lines are silently truncated. The first
19141 field is one of the following words (case-insensitive):
19142
19143 .ilist
19144 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19145 below).
19146 .next
19147 &'Decline'&: the router declines; pass the address to the next router, unless
19148 &%no_more%& is set.
19149 .next
19150 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19151 subsequent text on the line is an error message. If the router is run as part
19152 of address verification during an incoming SMTP message, the message is
19153 included in the SMTP response.
19154 .next
19155 &'Defer'&: routing could not be completed at this time; try again later. Any
19156 subsequent text on the line is an error message which is logged. It is not
19157 included in any SMTP response.
19158 .next
19159 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19160 .next
19161 &'Pass'&: pass the address to the next router (or the router specified by
19162 &%pass_router%&), overriding &%no_more%&.
19163 .next
19164 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19165 new addresses, which are routed independently, starting with the first router,
19166 or the router specified by &%redirect_router%&, if set.
19167 .endlist
19168
19169 When the first word is &'accept'&, the remainder of the line consists of a
19170 number of keyed data values, as follows (split into two lines here, to fit on
19171 the page):
19172 .code
19173 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19174 LOOKUP=byname|bydns DATA=<text>
19175 .endd
19176 The data items can be given in any order, and all are optional. If no transport
19177 is included, the transport specified by the generic &%transport%& option is
19178 used. The list of hosts and the lookup type are needed only if the transport is
19179 an &(smtp)& transport that does not itself supply a list of hosts.
19180
19181 The format of the list of hosts is the same as for the &(manualroute)& router.
19182 As well as host names and IP addresses with optional port numbers, as described
19183 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19184 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19185 (see section &<<SECThostshowused>>&).
19186
19187 If the lookup type is not specified, Exim behaves as follows when trying to
19188 find an IP address for each host: First, a DNS lookup is done. If this yields
19189 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19190 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19191 result of the lookup is the result of that call.
19192
19193 .vindex "&$address_data$&"
19194 If the DATA field is set, its value is placed in the &$address_data$&
19195 variable. For example, this return line
19196 .code
19197 accept hosts=x1.y.example:x2.y.example data="rule1"
19198 .endd
19199 routes the address to the default transport, passing a list of two hosts. When
19200 the transport runs, the string &"rule1"& is in &$address_data$&.
19201 .ecindex IIDquerou1
19202 .ecindex IIDquerou2
19203
19204
19205
19206
19207 . ////////////////////////////////////////////////////////////////////////////
19208 . ////////////////////////////////////////////////////////////////////////////
19209
19210 .chapter "The redirect router" "CHAPredirect"
19211 .scindex IIDredrou1 "&(redirect)& router"
19212 .scindex IIDredrou2 "routers" "&(redirect)&"
19213 .cindex "alias file" "in a &(redirect)& router"
19214 .cindex "address redirection" "&(redirect)& router"
19215 The &(redirect)& router handles several kinds of address redirection. Its most
19216 common uses are for resolving local part aliases from a central alias file
19217 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19218 files, but it has many other potential uses. The incoming address can be
19219 redirected in several different ways:
19220
19221 .ilist
19222 It can be replaced by one or more new addresses which are themselves routed
19223 independently.
19224 .next
19225 It can be routed to be delivered to a given file or directory.
19226 .next
19227 It can be routed to be delivered to a specified pipe command.
19228 .next
19229 It can cause an automatic reply to be generated.
19230 .next
19231 It can be forced to fail, optionally with a custom error message.
19232 .next
19233 It can be temporarily deferred, optionally with a custom message.
19234 .next
19235 It can be discarded.
19236 .endlist
19237
19238 The generic &%transport%& option must not be set for &(redirect)& routers.
19239 However, there are some private options which define transports for delivery to
19240 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19241 &%pipe_transport%& and &%reply_transport%& descriptions below.
19242
19243 .new
19244 If success DSNs have been requested
19245 .cindex "DSN" "success"
19246 .cindex "Delivery Status Notification" "success"
19247 redirection triggers one and the DSN options are not passed any further.
19248 .wen
19249
19250
19251
19252 .section "Redirection data" "SECID124"
19253 The router operates by interpreting a text string which it obtains either by
19254 expanding the contents of the &%data%& option, or by reading the entire
19255 contents of a file whose name is given in the &%file%& option. These two
19256 options are mutually exclusive. The first is commonly used for handling system
19257 aliases, in a configuration like this:
19258 .code
19259 system_aliases:
19260   driver = redirect
19261   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19262 .endd
19263 If the lookup fails, the expanded string in this example is empty. When the
19264 expansion of &%data%& results in an empty string, the router declines. A forced
19265 expansion failure also causes the router to decline; other expansion failures
19266 cause delivery to be deferred.
19267
19268 A configuration using &%file%& is commonly used for handling users'
19269 &_.forward_& files, like this:
19270 .code
19271 userforward:
19272   driver = redirect
19273   check_local_user
19274   file = $home/.forward
19275   no_verify
19276 .endd
19277 If the file does not exist, or causes no action to be taken (for example, it is
19278 empty or consists only of comments), the router declines. &*Warning*&: This
19279 is not the case when the file contains syntactically valid items that happen to
19280 yield empty addresses, for example, items containing only RFC 2822 address
19281 comments.
19282
19283
19284
19285 .section "Forward files and address verification" "SECID125"
19286 .cindex "address redirection" "while verifying"
19287 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19288 &_.forward_& files, as in the example above. There are two reasons for this:
19289
19290 .ilist
19291 When Exim is receiving an incoming SMTP message from a remote host, it is
19292 running under the Exim uid, not as root. Exim is unable to change uid to read
19293 the file as the user, and it may not be able to read it as the Exim user. So in
19294 practice the router may not be able to operate.
19295 .next
19296 However, even when the router can operate, the existence of a &_.forward_& file
19297 is unimportant when verifying an address. What should be checked is whether the
19298 local part is a valid user name or not. Cutting out the redirection processing
19299 saves some resources.
19300 .endlist
19301
19302
19303
19304
19305
19306
19307 .section "Interpreting redirection data" "SECID126"
19308 .cindex "Sieve filter" "specifying in redirection data"
19309 .cindex "filter" "specifying in redirection data"
19310 The contents of the data string, whether obtained from &%data%& or &%file%&,
19311 can be interpreted in two different ways:
19312
19313 .ilist
19314 If the &%allow_filter%& option is set true, and the data begins with the text
19315 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19316 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19317 respectively. Details of the syntax and semantics of filter files are described
19318 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19319 document is intended for use by end users.
19320 .next
19321 Otherwise, the data must be a comma-separated list of redirection items, as
19322 described in the next section.
19323 .endlist
19324
19325 When a message is redirected to a file (a &"mail folder"&), the file name given
19326 in a non-filter redirection list must always be an absolute path. A filter may
19327 generate a relative path &-- how this is handled depends on the transport's
19328 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19329 for the &(appendfile)& transport.
19330
19331
19332
19333 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19334 .cindex "address redirection" "non-filter list items"
19335 When the redirection data is not an Exim or Sieve filter, for example, if it
19336 comes from a conventional alias or forward file, it consists of a list of
19337 addresses, file names, pipe commands, or certain special items (see section
19338 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19339 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19340 depending on their default values. The items in the list are separated by
19341 commas or newlines.
19342 If a comma is required in an item, the entire item must be enclosed in double
19343 quotes.
19344
19345 Lines starting with a # character are comments, and are ignored, and # may
19346 also appear following a comma, in which case everything between the # and the
19347 next newline character is ignored.
19348
19349 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19350 double quotes are retained because some forms of mail address require their use
19351 (but never to enclose the entire address). In the following description,
19352 &"item"& refers to what remains after any surrounding double quotes have been
19353 removed.
19354
19355 .vindex "&$local_part$&"
19356 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19357 and the expansion contains a reference to &$local_part$&, you should make use
19358 of the &%quote_local_part%& expansion operator, in case the local part contains
19359 special characters. For example, to redirect all mail for the domain
19360 &'obsolete.example'&, retaining the existing local part, you could use this
19361 setting:
19362 .code
19363 data = ${quote_local_part:$local_part}@newdomain.example
19364 .endd
19365
19366
19367 .section "Redirecting to a local mailbox" "SECTredlocmai"
19368 .cindex "routing" "loops in"
19369 .cindex "loop" "while routing, avoidance of"
19370 .cindex "address redirection" "to local mailbox"
19371 A redirection item may safely be the same as the address currently under
19372 consideration. This does not cause a routing loop, because a router is
19373 automatically skipped if any ancestor of the address that is being processed
19374 is the same as the current address and was processed by the current router.
19375 Such an address is therefore passed to the following routers, so it is handled
19376 as if there were no redirection. When making this loop-avoidance test, the
19377 complete local part, including any prefix or suffix, is used.
19378
19379 .cindex "address redirection" "local part without domain"
19380 Specifying the same local part without a domain is a common usage in personal
19381 filter files when the user wants to have messages delivered to the local
19382 mailbox and also forwarded elsewhere. For example, the user whose login is
19383 &'cleo'& might have a &_.forward_& file containing this:
19384 .code
19385 cleo, cleopatra@egypt.example
19386 .endd
19387 .cindex "backslash in alias file"
19388 .cindex "alias file" "backslash in"
19389 For compatibility with other MTAs, such unqualified local parts may be
19390 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19391 it does make a difference if more than one domain is being handled
19392 synonymously.
19393
19394 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19395 2822 address that does not include a domain, the item is qualified using the
19396 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19397 addresses are qualified using the value in &%qualify_recipient%&, but you can
19398 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19399
19400 Care must be taken if there are alias names for local users.
19401 Consider an MTA handling a single local domain where the system alias file
19402 contains:
19403 .code
19404 Sam.Reman: spqr
19405 .endd
19406 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19407 messages in the local mailbox, and also forward copies elsewhere. He creates
19408 this forward file:
19409 .code
19410 Sam.Reman, spqr@reme.elsewhere.example
19411 .endd
19412 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19413 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19414 second time round, because it has previously routed it,
19415 and the following routers presumably cannot handle the alias. The forward file
19416 should really contain
19417 .code
19418 spqr, spqr@reme.elsewhere.example
19419 .endd
19420 but because this is such a common error, the &%check_ancestor%& option (see
19421 below) exists to provide a way to get round it. This is normally set on a
19422 &(redirect)& router that is handling users' &_.forward_& files.
19423
19424
19425
19426 .section "Special items in redirection lists" "SECTspecitredli"
19427 In addition to addresses, the following types of item may appear in redirection
19428 lists (that is, in non-filter redirection data):
19429
19430 .ilist
19431 .cindex "pipe" "in redirection list"
19432 .cindex "address redirection" "to pipe"
19433 An item is treated as a pipe command if it begins with &"|"& and does not parse
19434 as a valid RFC 2822 address that includes a domain. A transport for running the
19435 command must be specified by the &%pipe_transport%& option.
19436 Normally, either the router or the transport specifies a user and a group under
19437 which to run the delivery. The default is to use the Exim user and group.
19438
19439 Single or double quotes can be used for enclosing the individual arguments of
19440 the pipe command; no interpretation of escapes is done for single quotes. If
19441 the command contains a comma character, it is necessary to put the whole item
19442 in double quotes, for example:
19443 .code
19444 "|/some/command ready,steady,go"
19445 .endd
19446 since items in redirection lists are terminated by commas. Do not, however,
19447 quote just the command. An item such as
19448 .code
19449 |"/some/command ready,steady,go"
19450 .endd
19451 is interpreted as a pipe with a rather strange command name, and no arguments.
19452
19453 Note that the above example assumes that the text comes from a lookup source
19454 of some sort, so that the quotes are part of the data.  If composing a
19455 redirect router with a &%data%& option directly specifying this command, the
19456 quotes will be used by the configuration parser to define the extent of one
19457 string, but will not be passed down into the redirect router itself.  There
19458 are two main approaches to get around this: escape quotes to be part of the
19459 data itself, or avoid using this mechanism and instead create a custom
19460 transport with the &%command%& option set and reference that transport from
19461 an &%accept%& router.
19462
19463 .next
19464 .cindex "file" "in redirection list"
19465 .cindex "address redirection" "to file"
19466 An item is interpreted as a path name if it begins with &"/"& and does not
19467 parse as a valid RFC 2822 address that includes a domain. For example,
19468 .code
19469 /home/world/minbari
19470 .endd
19471 is treated as a file name, but
19472 .code
19473 /s=molari/o=babylon/@x400gate.way
19474 .endd
19475 is treated as an address. For a file name, a transport must be specified using
19476 the &%file_transport%& option. However, if the generated path name ends with a
19477 forward slash character, it is interpreted as a directory name rather than a
19478 file name, and &%directory_transport%& is used instead.
19479
19480 Normally, either the router or the transport specifies a user and a group under
19481 which to run the delivery. The default is to use the Exim user and group.
19482
19483 .cindex "&_/dev/null_&"
19484 However, if a redirection item is the path &_/dev/null_&, delivery to it is
19485 bypassed at a high level, and the log entry shows &"**bypassed**"&
19486 instead of a transport name. In this case the user and group are not used.
19487
19488 .next
19489 .cindex "included address list"
19490 .cindex "address redirection" "included external list"
19491 If an item is of the form
19492 .code
19493 :include:<path name>
19494 .endd
19495 a list of further items is taken from the given file and included at that
19496 point. &*Note*&: Such a file can not be a filter file; it is just an
19497 out-of-line addition to the list. The items in the included list are separated
19498 by commas or newlines and are not subject to expansion. If this is the first
19499 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
19500 the alias name. This example is incorrect:
19501 .code
19502 list1    :include:/opt/lists/list1
19503 .endd
19504 It must be given as
19505 .code
19506 list1:   :include:/opt/lists/list1
19507 .endd
19508 .next
19509 .cindex "address redirection" "to black hole"
19510 Sometimes you want to throw away mail to a particular local part. Making the
19511 &%data%& option expand to an empty string does not work, because that causes
19512 the router to decline. Instead, the alias item
19513 .cindex "black hole"
19514 .cindex "abandoning mail"
19515 &':blackhole:'& can be used. It does what its name implies. No delivery is
19516 done, and no error message is generated. This has the same effect as specifing
19517 &_/dev/null_& as a destination, but it can be independently disabled.
19518
19519 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
19520 delivery is done for the original local part, even if other redirection items
19521 are present. If you are generating a multi-item list (for example, by reading a
19522 database) and need the ability to provide a no-op item, you must use
19523 &_/dev/null_&.
19524
19525 .next
19526 .cindex "delivery" "forcing failure"
19527 .cindex "delivery" "forcing deferral"
19528 .cindex "failing delivery" "forcing"
19529 .cindex "deferred delivery, forcing"
19530 .cindex "customizing" "failure message"
19531 An attempt to deliver a particular address can be deferred or forced to fail by
19532 redirection items of the form
19533 .code
19534 :defer:
19535 :fail:
19536 .endd
19537 respectively. When a redirection list contains such an item, it applies
19538 to the entire redirection; any other items in the list are ignored. Any
19539 text following &':fail:'& or &':defer:'& is placed in the error text
19540 associated with the failure. For example, an alias file might contain:
19541 .code
19542 X.Employee:  :fail: Gone away, no forwarding address
19543 .endd
19544 In the case of an address that is being verified from an ACL or as the subject
19545 of a
19546 .cindex "VRFY" "error text, display of"
19547 VRFY command, the text is included in the SMTP error response by
19548 default.
19549 .cindex "EXPN" "error text, display of"
19550 The text is not included in the response to an EXPN command. In non-SMTP cases
19551 the text is included in the error message that Exim generates.
19552
19553 .cindex "SMTP" "error codes"
19554 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
19555 &':fail:'&. However, if the message starts with three digits followed by a
19556 space, optionally followed by an extended code of the form &'n.n.n'&, also
19557 followed by a space, and the very first digit is the same as the default error
19558 code, the code from the message is used instead. If the very first digit is
19559 incorrect, a panic error is logged, and the default code is used. You can
19560 suppress the use of the supplied code in a redirect router by setting the
19561 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
19562 ignored.
19563
19564 .vindex "&$acl_verify_message$&"
19565 In an ACL, an explicitly provided message overrides the default, but the
19566 default message is available in the variable &$acl_verify_message$& and can
19567 therefore be included in a custom message if this is desired.
19568
19569 Normally the error text is the rest of the redirection list &-- a comma does
19570 not terminate it &-- but a newline does act as a terminator. Newlines are not
19571 normally present in alias expansions. In &(lsearch)& lookups they are removed
19572 as part of the continuation process, but they may exist in other kinds of
19573 lookup and in &':include:'& files.
19574
19575 During routing for message delivery (as opposed to verification), a redirection
19576 containing &':fail:'& causes an immediate failure of the incoming address,
19577 whereas &':defer:'& causes the message to remain on the queue so that a
19578 subsequent delivery attempt can happen at a later time. If an address is
19579 deferred for too long, it will ultimately fail, because the normal retry
19580 rules still apply.
19581
19582 .next
19583 .cindex "alias file" "exception to default"
19584 Sometimes it is useful to use a single-key search type with a default (see
19585 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
19586 for exceptions to the default. These can be handled by aliasing them to
19587 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
19588 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
19589 results in an empty redirection list has the same effect.
19590 .endlist
19591
19592
19593 .section "Duplicate addresses" "SECTdupaddr"
19594 .cindex "duplicate addresses"
19595 .cindex "address duplicate, discarding"
19596 .cindex "pipe" "duplicated"
19597 Exim removes duplicate addresses from the list to which it is delivering, so as
19598 to deliver just one copy to each address. This does not apply to deliveries
19599 routed to pipes by different immediate parent addresses, but an indirect
19600 aliasing scheme of the type
19601 .code
19602 pipe:       |/some/command $local_part
19603 localpart1: pipe
19604 localpart2: pipe
19605 .endd
19606 does not work with a message that is addressed to both local parts, because
19607 when the second is aliased to the intermediate local part &"pipe"& it gets
19608 discarded as being the same as a previously handled address. However, a scheme
19609 such as
19610 .code
19611 localpart1: |/some/command $local_part
19612 localpart2: |/some/command $local_part
19613 .endd
19614 does result in two different pipe deliveries, because the immediate parents of
19615 the pipes are distinct.
19616
19617
19618
19619 .section "Repeated redirection expansion" "SECID128"
19620 .cindex "repeated redirection expansion"
19621 .cindex "address redirection" "repeated for each delivery attempt"
19622 When a message cannot be delivered to all of its recipients immediately,
19623 leading to two or more delivery attempts, redirection expansion is carried out
19624 afresh each time for those addresses whose children were not all previously
19625 delivered. If redirection is being used as a mailing list, this can lead to new
19626 members of the list receiving copies of old messages. The &%one_time%& option
19627 can be used to avoid this.
19628
19629
19630 .section "Errors in redirection lists" "SECID129"
19631 .cindex "address redirection" "errors"
19632 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
19633 error is skipped, and an entry is written to the main log. This may be useful
19634 for mailing lists that are automatically managed. Otherwise, if an error is
19635 detected while generating the list of new addresses, the original address is
19636 deferred. See also &%syntax_errors_to%&.
19637
19638
19639
19640 .section "Private options for the redirect router" "SECID130"
19641
19642 .cindex "options" "&(redirect)& router"
19643 The private options for the &(redirect)& router are as follows:
19644
19645
19646 .option allow_defer redirect boolean false
19647 Setting this option allows the use of &':defer:'& in non-filter redirection
19648 data, or the &%defer%& command in an Exim filter file.
19649
19650
19651 .option allow_fail redirect boolean false
19652 .cindex "failing delivery" "from filter"
19653 If this option is true, the &':fail:'& item can be used in a redirection list,
19654 and the &%fail%& command may be used in an Exim filter file.
19655
19656
19657 .option allow_filter redirect boolean false
19658 .cindex "filter" "enabling use of"
19659 .cindex "Sieve filter" "enabling use of"
19660 Setting this option allows Exim to interpret redirection data that starts with
19661 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
19662 are some features of Exim filter files that some administrators may wish to
19663 lock out; see the &%forbid_filter_%&&'xxx'& options below.
19664
19665 It is also possible to lock out Exim filters or Sieve filters while allowing
19666 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
19667
19668
19669 The filter is run using the uid and gid set by the generic &%user%& and
19670 &%group%& options. These take their defaults from the password data if
19671 &%check_local_user%& is set, so in the normal case of users' personal filter
19672 files, the filter is run as the relevant user. When &%allow_filter%& is set
19673 true, Exim insists that either &%check_local_user%& or &%user%& is set.
19674
19675
19676
19677 .option allow_freeze redirect boolean false
19678 .cindex "freezing messages" "allowing in filter"
19679 Setting this option allows the use of the &%freeze%& command in an Exim filter.
19680 This command is more normally encountered in system filters, and is disabled by
19681 default for redirection filters because it isn't something you usually want to
19682 let ordinary users do.
19683
19684
19685
19686 .option check_ancestor redirect boolean false
19687 This option is concerned with handling generated addresses that are the same
19688 as some address in the list of redirection ancestors of the current address.
19689 Although it is turned off by default in the code, it is set in the default
19690 configuration file for handling users' &_.forward_& files. It is recommended
19691 for this use of the &(redirect)& router.
19692
19693 When &%check_ancestor%& is set, if a generated address (including the domain)
19694 is the same as any ancestor of the current address, it is replaced by a copy of
19695 the current address. This helps in the case where local part A is aliased to B,
19696 and B has a &_.forward_& file pointing back to A. For example, within a single
19697 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
19698 &_&~jb/.forward_& contains:
19699 .code
19700 \Joe.Bloggs, <other item(s)>
19701 .endd
19702 Without the &%check_ancestor%& setting, either local part (&"jb"& or
19703 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
19704 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
19705 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
19706 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
19707 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
19708 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
19709 original address. See also the &%repeat_use%& option below.
19710
19711
19712 .option check_group redirect boolean "see below"
19713 When the &%file%& option is used, the group owner of the file is checked only
19714 when this option is set. The permitted groups are those listed in the
19715 &%owngroups%& option, together with the user's default group if
19716 &%check_local_user%& is set. If the file has the wrong group, routing is
19717 deferred. The default setting for this option is true if &%check_local_user%&
19718 is set and the &%modemask%& option permits the group write bit, or if the
19719 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
19720
19721
19722
19723 .option check_owner redirect boolean "see below"
19724 When the &%file%& option is used, the owner of the file is checked only when
19725 this option is set. If &%check_local_user%& is set, the local user is
19726 permitted; otherwise the owner must be one of those listed in the &%owners%&
19727 option. The default value for this option is true if &%check_local_user%& or
19728 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
19729
19730
19731 .option data redirect string&!! unset
19732 This option is mutually exclusive with &%file%&. One or other of them must be
19733 set, but not both. The contents of &%data%& are expanded, and then used as the
19734 list of forwarding items, or as a set of filtering instructions. If the
19735 expansion is forced to fail, or the result is an empty string or a string that
19736 has no effect (consists entirely of comments), the router declines.
19737
19738 When filtering instructions are used, the string must begin with &"#Exim
19739 filter"&, and all comments in the string, including this initial one, must be
19740 terminated with newline characters. For example:
19741 .code
19742 data = #Exim filter\n\
19743        if $h_to: contains Exim then save $home/mail/exim endif
19744 .endd
19745 If you are reading the data from a database where newlines cannot be included,
19746 you can use the &${sg}$& expansion item to turn the escape string of your
19747 choice into a newline.
19748
19749
19750 .option directory_transport redirect string&!! unset
19751 A &(redirect)& router sets up a direct delivery to a directory when a path name
19752 ending with a slash is specified as a new &"address"&. The transport used is
19753 specified by this option, which, after expansion, must be the name of a
19754 configured transport. This should normally be an &(appendfile)& transport.
19755
19756
19757 .option file redirect string&!! unset
19758 This option specifies the name of a file that contains the redirection data. It
19759 is mutually exclusive with the &%data%& option. The string is expanded before
19760 use; if the expansion is forced to fail, the router declines. Other expansion
19761 failures cause delivery to be deferred. The result of a successful expansion
19762 must be an absolute path. The entire file is read and used as the redirection
19763 data. If the data is an empty string or a string that has no effect (consists
19764 entirely of comments), the router declines.
19765
19766 .cindex "NFS" "checking for file existence"
19767 If the attempt to open the file fails with a &"does not exist"& error, Exim
19768 runs a check on the containing directory,
19769 unless &%ignore_enotdir%& is true (see below).
19770 If the directory does not appear to exist, delivery is deferred. This can
19771 happen when users' &_.forward_& files are in NFS-mounted directories, and there
19772 is a mount problem. If the containing directory does exist, but the file does
19773 not, the router declines.
19774
19775
19776 .option file_transport redirect string&!! unset
19777 .vindex "&$address_file$&"
19778 A &(redirect)& router sets up a direct delivery to a file when a path name not
19779 ending in a slash is specified as a new &"address"&. The transport used is
19780 specified by this option, which, after expansion, must be the name of a
19781 configured transport. This should normally be an &(appendfile)& transport. When
19782 it is running, the file name is in &$address_file$&.
19783
19784
19785 .option filter_prepend_home redirect boolean true
19786 When this option is true, if a &(save)& command in an Exim filter specifies a
19787 relative path, and &$home$& is defined, it is automatically prepended to the
19788 relative path. If this option is set false, this action does not happen. The
19789 relative path is then passed to the transport unmodified.
19790
19791
19792 .option forbid_blackhole redirect boolean false
19793 If this option is true, the &':blackhole:'& item may not appear in a
19794 redirection list.
19795
19796
19797 .option forbid_exim_filter redirect boolean false
19798 If this option is set true, only Sieve filters are permitted when
19799 &%allow_filter%& is true.
19800
19801
19802
19803
19804 .option forbid_file redirect boolean false
19805 .cindex "delivery" "to file; forbidding"
19806 .cindex "Sieve filter" "forbidding delivery to a file"
19807 .cindex "Sieve filter" "&""keep""& facility; disabling"
19808 If this option is true, this router may not generate a new address that
19809 specifies delivery to a local file or directory, either from a filter or from a
19810 conventional forward file. This option is forced to be true if &%one_time%& is
19811 set. It applies to Sieve filters as well as to Exim filters, but if true, it
19812 locks out the Sieve's &"keep"& facility.
19813
19814
19815 .option forbid_filter_dlfunc redirect boolean false
19816 .cindex "filter" "locking out certain features"
19817 If this option is true, string expansions in Exim filters are not allowed to
19818 make use of the &%dlfunc%& expansion facility to run dynamically loaded
19819 functions.
19820
19821 .option forbid_filter_existstest redirect boolean false
19822 .cindex "expansion" "statting a file"
19823 If this option is true, string expansions in Exim filters are not allowed to
19824 make use of the &%exists%& condition or the &%stat%& expansion item.
19825
19826 .option forbid_filter_logwrite redirect boolean false
19827 If this option is true, use of the logging facility in Exim filters is not
19828 permitted. Logging is in any case available only if the filter is being run
19829 under some unprivileged uid (which is normally the case for ordinary users'
19830 &_.forward_& files).
19831
19832
19833 .option forbid_filter_lookup redirect boolean false
19834 If this option is true, string expansions in Exim filter files are not allowed
19835 to make use of &%lookup%& items.
19836
19837
19838 .option forbid_filter_perl redirect boolean false
19839 This option has an effect only if Exim is built with embedded Perl support. If
19840 it is true, string expansions in Exim filter files are not allowed to make use
19841 of the embedded Perl support.
19842
19843
19844 .option forbid_filter_readfile redirect boolean false
19845 If this option is true, string expansions in Exim filter files are not allowed
19846 to make use of &%readfile%& items.
19847
19848
19849 .option forbid_filter_readsocket redirect boolean false
19850 If this option is true, string expansions in Exim filter files are not allowed
19851 to make use of &%readsocket%& items.
19852
19853
19854 .option forbid_filter_reply redirect boolean false
19855 If this option is true, this router may not generate an automatic reply
19856 message. Automatic replies can be generated only from Exim or Sieve filter
19857 files, not from traditional forward files. This option is forced to be true if
19858 &%one_time%& is set.
19859
19860
19861 .option forbid_filter_run redirect boolean false
19862 If this option is true, string expansions in Exim filter files are not allowed
19863 to make use of &%run%& items.
19864
19865
19866 .option forbid_include redirect boolean false
19867 If this option is true, items of the form
19868 .code
19869 :include:<path name>
19870 .endd
19871 are not permitted in non-filter redirection lists.
19872
19873
19874 .option forbid_pipe redirect boolean false
19875 .cindex "delivery" "to pipe; forbidding"
19876 If this option is true, this router may not generate a new address which
19877 specifies delivery to a pipe, either from an Exim filter or from a conventional
19878 forward file. This option is forced to be true if &%one_time%& is set.
19879
19880
19881 .option forbid_sieve_filter redirect boolean false
19882 If this option is set true, only Exim filters are permitted when
19883 &%allow_filter%& is true.
19884
19885
19886 .cindex "SMTP" "error codes"
19887 .option forbid_smtp_code redirect boolean false
19888 If this option is set true, any SMTP error codes that are present at the start
19889 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
19890 the default codes (451 and 550, respectively) are always used.
19891
19892
19893
19894
19895 .option hide_child_in_errmsg redirect boolean false
19896 .cindex "bounce message" "redirection details; suppressing"
19897 If this option is true, it prevents Exim from quoting a child address if it
19898 generates a bounce or delay message for it. Instead it says &"an address
19899 generated from <&'the top level address'&>"&. Of course, this applies only to
19900 bounces generated locally. If a message is forwarded to another host, &'its'&
19901 bounce may well quote the generated address.
19902
19903
19904 .option ignore_eacces redirect boolean false
19905 .cindex "EACCES"
19906 If this option is set and an attempt to open a redirection file yields the
19907 EACCES error (permission denied), the &(redirect)& router behaves as if the
19908 file did not exist.
19909
19910
19911 .option ignore_enotdir redirect boolean false
19912 .cindex "ENOTDIR"
19913 If this option is set and an attempt to open a redirection file yields the
19914 ENOTDIR error (something on the path is not a directory), the &(redirect)&
19915 router behaves as if the file did not exist.
19916
19917 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
19918 router that has the &%file%& option set discovers that the file does not exist
19919 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
19920 against unmounted NFS directories. If the parent can not be statted, delivery
19921 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
19922 is set, because that option tells Exim to ignore &"something on the path is not
19923 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
19924 that some operating systems give ENOENT where others give ENOTDIR.
19925
19926
19927
19928 .option include_directory redirect string unset
19929 If this option is set, the path names of any &':include:'& items in a
19930 redirection list must start with this directory.
19931
19932
19933 .option modemask redirect "octal integer" 022
19934 This specifies mode bits which must not be set for a file specified by the
19935 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
19936
19937
19938 .option one_time redirect boolean false
19939 .cindex "one-time aliasing/forwarding expansion"
19940 .cindex "alias file" "one-time expansion"
19941 .cindex "forward file" "one-time expansion"
19942 .cindex "mailing lists" "one-time expansion"
19943 .cindex "address redirection" "one-time expansion"
19944 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
19945 files each time it tries to deliver a message causes a problem when one or more
19946 of the generated addresses fails be delivered at the first attempt. The problem
19947 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
19948 but of what happens when the redirection list changes during the time that the
19949 message is on Exim's queue. This is particularly true in the case of mailing
19950 lists, where new subscribers might receive copies of messages that were posted
19951 before they subscribed.
19952
19953 If &%one_time%& is set and any addresses generated by the router fail to
19954 deliver at the first attempt, the failing addresses are added to the message as
19955 &"top level"& addresses, and the parent address that generated them is marked
19956 &"delivered"&. Thus, redirection does not happen again at the next delivery
19957 attempt.
19958
19959 &*Warning 1*&: Any header line addition or removal that is specified by this
19960 router would be lost if delivery did not succeed at the first attempt. For this
19961 reason, the &%headers_add%& and &%headers_remove%& generic options are not
19962 permitted when &%one_time%& is set.
19963
19964 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
19965 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
19966 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
19967
19968 &*Warning 3*&: The &%unseen%& generic router option may not be set with
19969 &%one_time%&.
19970
19971 The original top-level address is remembered with each of the generated
19972 addresses, and is output in any log messages. However, any intermediate parent
19973 addresses are not recorded. This makes a difference to the log only if
19974 &%all_parents%& log selector is set. It is expected that &%one_time%& will
19975 typically be used for mailing lists, where there is normally just one level of
19976 expansion.
19977
19978
19979 .option owners redirect "string list" unset
19980 .cindex "ownership" "alias file"
19981 .cindex "ownership" "forward file"
19982 .cindex "alias file" "ownership"
19983 .cindex "forward file" "ownership"
19984 This specifies a list of permitted owners for the file specified by &%file%&.
19985 This list is in addition to the local user when &%check_local_user%& is set.
19986 See &%check_owner%& above.
19987
19988
19989 .option owngroups redirect "string list" unset
19990 This specifies a list of permitted groups for the file specified by &%file%&.
19991 The list is in addition to the local user's primary group when
19992 &%check_local_user%& is set. See &%check_group%& above.
19993
19994
19995 .option pipe_transport redirect string&!! unset
19996 .vindex "&$address_pipe$&"
19997 A &(redirect)& router sets up a direct delivery to a pipe when a string
19998 starting with a vertical bar character is specified as a new &"address"&. The
19999 transport used is specified by this option, which, after expansion, must be the
20000 name of a configured transport. This should normally be a &(pipe)& transport.
20001 When the transport is run, the pipe command is in &$address_pipe$&.
20002
20003
20004 .option qualify_domain redirect string&!! unset
20005 .vindex "&$qualify_recipient$&"
20006 If this option is set, and an unqualified address (one without a domain) is
20007 generated, and that address would normally be qualified by the global setting
20008 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20009 expanding this string. If the expansion fails, the router declines. If you want
20010 to revert to the default, you can have the expansion generate
20011 &$qualify_recipient$&.
20012
20013 This option applies to all unqualified addresses generated by Exim filters,
20014 but for traditional &_.forward_& files, it applies only to addresses that are
20015 not preceded by a backslash. Sieve filters cannot generate unqualified
20016 addresses.
20017
20018 .option qualify_preserve_domain redirect boolean false
20019 .cindex "domain" "in redirection; preserving"
20020 .cindex "preserving domain in redirection"
20021 .cindex "address redirection" "domain; preserving"
20022 If this option is set, the router's local &%qualify_domain%& option must not be
20023 set (a configuration error occurs if it is). If an unqualified address (one
20024 without a domain) is generated, it is qualified with the domain of the parent
20025 address (the immediately preceding ancestor) instead of the global
20026 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20027 this applies whether or not the address is preceded by a backslash.
20028
20029
20030 .option repeat_use redirect boolean true
20031 If this option is set false, the router is skipped for a child address that has
20032 any ancestor that was routed by this router. This test happens before any of
20033 the other preconditions are tested. Exim's default anti-looping rules skip
20034 only when the ancestor is the same as the current address. See also
20035 &%check_ancestor%& above and the generic &%redirect_router%& option.
20036
20037
20038 .option reply_transport redirect string&!! unset
20039 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20040 &%vacation%& command is used in a filter file. The transport used is specified
20041 by this option, which, after expansion, must be the name of a configured
20042 transport. This should normally be an &(autoreply)& transport. Other transports
20043 are unlikely to do anything sensible or useful.
20044
20045
20046 .option rewrite redirect boolean true
20047 .cindex "address redirection" "disabling rewriting"
20048 If this option is set false, addresses generated by the router are not
20049 subject to address rewriting. Otherwise, they are treated like new addresses
20050 and are rewritten according to the global rewriting rules.
20051
20052
20053 .option sieve_subaddress redirect string&!! unset
20054 The value of this option is passed to a Sieve filter to specify the
20055 :subaddress part of an address.
20056
20057 .option sieve_useraddress redirect string&!! unset
20058 The value of this option is passed to a Sieve filter to specify the :user part
20059 of an address. However, if it is unset, the entire original local part
20060 (including any prefix or suffix) is used for :user.
20061
20062
20063 .option sieve_vacation_directory redirect string&!! unset
20064 .cindex "Sieve filter" "vacation directory"
20065 To enable the &"vacation"& extension for Sieve filters, you must set
20066 &%sieve_vacation_directory%& to the directory where vacation databases are held
20067 (do not put anything else in that directory), and ensure that the
20068 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20069 needs their own directory; Exim will create it if necessary.
20070
20071
20072
20073 .option skip_syntax_errors redirect boolean false
20074 .cindex "forward file" "broken"
20075 .cindex "address redirection" "broken files"
20076 .cindex "alias file" "broken"
20077 .cindex "broken alias or forward files"
20078 .cindex "ignoring faulty addresses"
20079 .cindex "skipping faulty addresses"
20080 .cindex "error" "skipping bad syntax"
20081 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20082 non-filter redirection data are skipped, and each failing address is logged. If
20083 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20084 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20085 are expanded and placed at the head of the error message generated by
20086 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20087 be the same address as the generic &%errors_to%& option. The
20088 &%skip_syntax_errors%& option is often used when handling mailing lists.
20089
20090 If all the addresses in a redirection list are skipped because of syntax
20091 errors, the router declines to handle the original address, and it is passed to
20092 the following routers.
20093
20094 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20095 error in the filter causes filtering to be abandoned without any action being
20096 taken. The incident is logged, and the router declines to handle the address,
20097 so it is passed to the following routers.
20098
20099 .cindex "Sieve filter" "syntax errors in"
20100 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20101 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20102 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20103
20104 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20105 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20106 option, used with an address that does not get redirected, can be used to
20107 notify users of these errors, by means of a router like this:
20108 .code
20109 userforward:
20110   driver = redirect
20111   allow_filter
20112   check_local_user
20113   file = $home/.forward
20114   file_transport = address_file
20115   pipe_transport = address_pipe
20116   reply_transport = address_reply
20117   no_verify
20118   skip_syntax_errors
20119   syntax_errors_to = real-$local_part@$domain
20120   syntax_errors_text = \
20121    This is an automatically generated message. An error has\n\
20122    been found in your .forward file. Details of the error are\n\
20123    reported below. While this error persists, you will receive\n\
20124    a copy of this message for every message that is addressed\n\
20125    to you. If your .forward file is a filter file, or if it is\n\
20126    a non-filter file containing no valid forwarding addresses,\n\
20127    a copy of each incoming message will be put in your normal\n\
20128    mailbox. If a non-filter file contains at least one valid\n\
20129    forwarding address, forwarding to the valid addresses will\n\
20130    happen, and those will be the only deliveries that occur.
20131 .endd
20132 You also need a router to ensure that local addresses that are prefixed by
20133 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20134 put this immediately before the &(userforward)& router:
20135 .code
20136 real_localuser:
20137   driver = accept
20138   check_local_user
20139   local_part_prefix = real-
20140   transport = local_delivery
20141 .endd
20142 For security, it would probably be a good idea to restrict the use of this
20143 router to locally-generated messages, using a condition such as this:
20144 .code
20145   condition = ${if match {$sender_host_address}\
20146                          {\N^(|127\.0\.0\.1)$\N}}
20147 .endd
20148
20149
20150 .option syntax_errors_text redirect string&!! unset
20151 See &%skip_syntax_errors%& above.
20152
20153
20154 .option syntax_errors_to redirect string unset
20155 See &%skip_syntax_errors%& above.
20156 .ecindex IIDredrou1
20157 .ecindex IIDredrou2
20158
20159
20160
20161
20162
20163
20164 . ////////////////////////////////////////////////////////////////////////////
20165 . ////////////////////////////////////////////////////////////////////////////
20166
20167 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20168          "Environment for local transports"
20169 .scindex IIDenvlotra1 "local transports" "environment for"
20170 .scindex IIDenvlotra2 "environment for local transports"
20171 .scindex IIDenvlotra3 "transport" "local; environment for"
20172 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20173 transport can be thought of as similar to a pipe.) Exim always runs transports
20174 in subprocesses, under specified uids and gids. Typical deliveries to local
20175 mailboxes run under the uid and gid of the local user.
20176
20177 Exim also sets a specific current directory while running the transport; for
20178 some transports a home directory setting is also relevant. The &(pipe)&
20179 transport is the only one that sets up environment variables; see section
20180 &<<SECTpipeenv>>& for details.
20181
20182 The values used for the uid, gid, and the directories may come from several
20183 different places. In many cases, the router that handles the address associates
20184 settings with that address as a result of its &%check_local_user%&, &%group%&,
20185 or &%user%& options. However, values may also be given in the transport's own
20186 configuration, and these override anything that comes from the router.
20187
20188
20189
20190 .section "Concurrent deliveries" "SECID131"
20191 .cindex "concurrent deliveries"
20192 .cindex "simultaneous deliveries"
20193 If two different messages for the same local recipient arrive more or less
20194 simultaneously, the two delivery processes are likely to run concurrently. When
20195 the &(appendfile)& transport is used to write to a file, Exim applies locking
20196 rules to stop concurrent processes from writing to the same file at the same
20197 time.
20198
20199 However, when you use a &(pipe)& transport, it is up to you to arrange any
20200 locking that is needed. Here is a silly example:
20201 .code
20202 my_transport:
20203   driver = pipe
20204   command = /bin/sh -c 'cat >>/some/file'
20205 .endd
20206 This is supposed to write the message at the end of the file. However, if two
20207 messages arrive at the same time, the file will be scrambled. You can use the
20208 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20209 file using the same algorithm that Exim itself uses.
20210
20211
20212
20213
20214 .section "Uids and gids" "SECTenvuidgid"
20215 .cindex "local transports" "uid and gid"
20216 .cindex "transport" "local; uid and gid"
20217 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20218 overrides any group that the router set in the address, even if &%user%& is not
20219 set for the transport. This makes it possible, for example, to run local mail
20220 delivery under the uid of the recipient (set by the router), but in a special
20221 group (set by the transport). For example:
20222 .code
20223 # Routers ...
20224 # User/group are set by check_local_user in this router
20225 local_users:
20226   driver = accept
20227   check_local_user
20228   transport = group_delivery
20229
20230 # Transports ...
20231 # This transport overrides the group
20232 group_delivery:
20233   driver = appendfile
20234   file = /var/spool/mail/$local_part
20235   group = mail
20236 .endd
20237 If &%user%& is set for a transport, its value overrides what is set in the
20238 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20239 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20240 set.
20241
20242 .oindex "&%initgroups%&"
20243 When the uid is taken from the transport's configuration, the &[initgroups()]&
20244 function is called for the groups associated with that uid if the
20245 &%initgroups%& option is set for the transport. When the uid is not specified
20246 by the transport, but is associated with the address by a router, the option
20247 for calling &[initgroups()]& is taken from the router configuration.
20248
20249 .cindex "&(pipe)& transport" "uid for"
20250 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20251 is set and &%user%& is not set, the uid of the process that called Exim to
20252 receive the message is used, and if &%group%& is not set, the corresponding
20253 original gid is also used.
20254
20255 This is the detailed preference order for obtaining a gid; the first of the
20256 following that is set is used:
20257
20258 .ilist
20259 A &%group%& setting of the transport;
20260 .next
20261 A &%group%& setting of the router;
20262 .next
20263 A gid associated with a user setting of the router, either as a result of
20264 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20265 .next
20266 The group associated with a non-numeric &%user%& setting of the transport;
20267 .next
20268 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20269 the uid is the creator's uid;
20270 .next
20271 The Exim gid if the Exim uid is being used as a default.
20272 .endlist
20273
20274 If, for example, the user is specified numerically on the router and there are
20275 no group settings, no gid is available. In this situation, an error occurs.
20276 This is different for the uid, for which there always is an ultimate default.
20277 The first of the following that is set is used:
20278
20279 .ilist
20280 A &%user%& setting of the transport;
20281 .next
20282 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20283 .next
20284 A &%user%& setting of the router;
20285 .next
20286 A &%check_local_user%& setting of the router;
20287 .next
20288 The Exim uid.
20289 .endlist
20290
20291 Of course, an error will still occur if the uid that is chosen is on the
20292 &%never_users%& list.
20293
20294
20295
20296
20297
20298 .section "Current and home directories" "SECID132"
20299 .cindex "current directory for local transport"
20300 .cindex "home directory" "for local transport"
20301 .cindex "transport" "local; home directory for"
20302 .cindex "transport" "local; current directory for"
20303 Routers may set current and home directories for local transports by means of
20304 the &%transport_current_directory%& and &%transport_home_directory%& options.
20305 However, if the transport's &%current_directory%& or &%home_directory%& options
20306 are set, they override the router's values. In detail, the home directory
20307 for a local transport is taken from the first of these values that is set:
20308
20309 .ilist
20310 The &%home_directory%& option on the transport;
20311 .next
20312 The &%transport_home_directory%& option on the router;
20313 .next
20314 The password data if &%check_local_user%& is set on the router;
20315 .next
20316 The &%router_home_directory%& option on the router.
20317 .endlist
20318
20319 The current directory is taken from the first of these values that is set:
20320
20321 .ilist
20322 The &%current_directory%& option on the transport;
20323 .next
20324 The &%transport_current_directory%& option on the router.
20325 .endlist
20326
20327
20328 If neither the router nor the transport sets a current directory, Exim uses the
20329 value of the home directory, if it is set. Otherwise it sets the current
20330 directory to &_/_& before running a local transport.
20331
20332
20333
20334 .section "Expansion variables derived from the address" "SECID133"
20335 .vindex "&$domain$&"
20336 .vindex "&$local_part$&"
20337 .vindex "&$original_domain$&"
20338 Normally a local delivery is handling a single address, and in that case the
20339 variables such as &$domain$& and &$local_part$& are set during local
20340 deliveries. However, in some circumstances more than one address may be handled
20341 at once (for example, while writing batch SMTP for onward transmission by some
20342 other means). In this case, the variables associated with the local part are
20343 never set, &$domain$& is set only if all the addresses have the same domain,
20344 and &$original_domain$& is never set.
20345 .ecindex IIDenvlotra1
20346 .ecindex IIDenvlotra2
20347 .ecindex IIDenvlotra3
20348
20349
20350
20351
20352
20353
20354
20355 . ////////////////////////////////////////////////////////////////////////////
20356 . ////////////////////////////////////////////////////////////////////////////
20357
20358 .chapter "Generic options for transports" "CHAPtransportgeneric"
20359 .scindex IIDgenoptra1 "generic options" "transport"
20360 .scindex IIDgenoptra2 "options" "generic; for transports"
20361 .scindex IIDgenoptra3 "transport" "generic options for"
20362 The following generic options apply to all transports:
20363
20364
20365 .option body_only transports boolean false
20366 .cindex "transport" "body only"
20367 .cindex "message" "transporting body only"
20368 .cindex "body of message" "transporting"
20369 If this option is set, the message's headers are not transported. It is
20370 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20371 or &(pipe)& transports, the settings of &%message_prefix%& and
20372 &%message_suffix%& should be checked, because this option does not
20373 automatically suppress them.
20374
20375
20376 .option current_directory transports string&!! unset
20377 .cindex "transport" "current directory for"
20378 This specifies the current directory that is to be set while running the
20379 transport, overriding any value that may have been set by the router.
20380 If the expansion fails for any reason, including forced failure, an error is
20381 logged, and delivery is deferred.
20382
20383
20384 .option disable_logging transports boolean false
20385 If this option is set true, nothing is logged for any
20386 deliveries by the transport or for any
20387 transport errors. You should not set this option unless you really, really know
20388 what you are doing.
20389
20390
20391 .option debug_print transports string&!! unset
20392 .cindex "testing" "variables in drivers"
20393 If this option is set and debugging is enabled (see the &%-d%& command line
20394 option), the string is expanded and included in the debugging output when the
20395 transport is run.
20396 If expansion of the string fails, the error message is written to the debugging
20397 output, and Exim carries on processing.
20398 This facility is provided to help with checking out the values of variables and
20399 so on when debugging driver configurations. For example, if a &%headers_add%&
20400 option is not working properly, &%debug_print%& could be used to output the
20401 variables it references. A newline is added to the text if it does not end with
20402 one.
20403 The variables &$transport_name$& and &$router_name$& contain the name of the
20404 transport and the router that called it.
20405
20406 .option delivery_date_add transports boolean false
20407 .cindex "&'Delivery-date:'& header line"
20408 If this option is true, a &'Delivery-date:'& header is added to the message.
20409 This gives the actual time the delivery was made. As this is not a standard
20410 header, Exim has a configuration option (&%delivery_date_remove%&) which
20411 requests its removal from incoming messages, so that delivered messages can
20412 safely be resent to other recipients.
20413
20414
20415 .option driver transports string unset
20416 This specifies which of the available transport drivers is to be used.
20417 There is no default, and this option must be set for every transport.
20418
20419
20420 .option envelope_to_add transports boolean false
20421 .cindex "&'Envelope-to:'& header line"
20422 If this option is true, an &'Envelope-to:'& header is added to the message.
20423 This gives the original address(es) in the incoming envelope that caused this
20424 delivery to happen. More than one address may be present if the transport is
20425 configured to handle several addresses at once, or if more than one original
20426 address was redirected to the same final address. As this is not a standard
20427 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
20428 its removal from incoming messages, so that delivered messages can safely be
20429 resent to other recipients.
20430
20431
20432 .option group transports string&!! "Exim group"
20433 .cindex "transport" "group; specifying"
20434 This option specifies a gid for running the transport process, overriding any
20435 value that the router supplies, and also overriding any value associated with
20436 &%user%& (see below).
20437
20438
20439 .option headers_add transports list&!! unset
20440 .cindex "header lines" "adding in transport"
20441 .cindex "transport" "header lines; adding"
20442 This option specifies a list of text headers,
20443 .new
20444 newline-separated (by default, changeable in the usual way),
20445 .wen
20446 which are (separately) expanded and added to the header
20447 portion of a message as it is transported, as described in section
20448 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
20449 routers. If the result of the expansion is an empty string, or if the expansion
20450 is forced to fail, no action is taken. Other expansion failures are treated as
20451 errors and cause the delivery to be deferred.
20452
20453 Unlike most options, &%headers_add%& can be specified multiple times
20454 for a transport; all listed headers are added.
20455
20456
20457 .option headers_only transports boolean false
20458 .cindex "transport" "header lines only"
20459 .cindex "message" "transporting headers only"
20460 .cindex "header lines" "transporting"
20461 If this option is set, the message's body is not transported. It is mutually
20462 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
20463 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
20464 checked, since this option does not automatically suppress them.
20465
20466
20467 .option headers_remove transports list&!! unset
20468 .cindex "header lines" "removing"
20469 .cindex "transport" "header lines; removing"
20470 This option specifies a list of header names,
20471 .new
20472 colon-separated (by default, changeable in the usual way);
20473 .wen
20474 these headers are omitted from the message as it is transported, as described
20475 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
20476 routers.
20477 Each list item is separately expanded.
20478 If the result of the expansion is an empty string, or if the expansion
20479 is forced to fail, no action is taken. Other expansion failures are treated as
20480 errors and cause the delivery to be deferred.
20481
20482 Unlike most options, &%headers_remove%& can be specified multiple times
20483 for a router; all listed headers are removed.
20484
20485 &*Warning*&: Because of the separate expansion of the list items,
20486 items that contain a list separator must have it doubled.
20487 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
20488
20489
20490
20491 .option headers_rewrite transports string unset
20492 .cindex "transport" "header lines; rewriting"
20493 .cindex "rewriting" "at transport time"
20494 This option allows addresses in header lines to be rewritten at transport time,
20495 that is, as the message is being copied to its destination. The contents of the
20496 option are a colon-separated list of rewriting rules. Each rule is in exactly
20497 the same form as one of the general rewriting rules that are applied when a
20498 message is received. These are described in chapter &<<CHAPrewrite>>&. For
20499 example,
20500 .code
20501 headers_rewrite = a@b c@d f : \
20502                   x@y w@z
20503 .endd
20504 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
20505 &'w@z'& in all address-bearing header lines. The rules are applied to the
20506 header lines just before they are written out at transport time, so they affect
20507 only those copies of the message that pass through the transport. However, only
20508 the message's original header lines, and any that were added by a system
20509 filter, are rewritten. If a router or transport adds header lines, they are not
20510 affected by this option. These rewriting rules are &'not'& applied to the
20511 envelope. You can change the return path using &%return_path%&, but you cannot
20512 change envelope recipients at this time.
20513
20514
20515 .option home_directory transports string&!! unset
20516 .cindex "transport" "home directory for"
20517 .vindex "&$home$&"
20518 This option specifies a home directory setting for a local transport,
20519 overriding any value that may be set by the router. The home directory is
20520 placed in &$home$& while expanding the transport's private options. It is also
20521 used as the current directory if no current directory is set by the
20522 &%current_directory%& option on the transport or the
20523 &%transport_current_directory%& option on the router. If the expansion fails
20524 for any reason, including forced failure, an error is logged, and delivery is
20525 deferred.
20526
20527
20528 .option initgroups transports boolean false
20529 .cindex "additional groups"
20530 .cindex "groups" "additional"
20531 .cindex "transport" "group; additional"
20532 If this option is true and the uid for the delivery process is provided by the
20533 transport, the &[initgroups()]& function is called when running the transport
20534 to ensure that any additional groups associated with the uid are set up.
20535
20536
20537 .option message_size_limit transports string&!! 0
20538 .cindex "limit" "message size per transport"
20539 .cindex "size" "of message, limit"
20540 .cindex "transport" "message size; limiting"
20541 This option controls the size of messages passed through the transport. It is
20542 expanded before use; the result of the expansion must be a sequence of decimal
20543 digits, optionally followed by K or M. If the expansion fails for any reason,
20544 including forced failure, or if the result is not of the required form,
20545 delivery is deferred. If the value is greater than zero and the size of a
20546 message exceeds this limit, the address is failed. If there is any chance that
20547 the resulting bounce message could be routed to the same transport, you should
20548 ensure that &%return_size_limit%& is less than the transport's
20549 &%message_size_limit%&, as otherwise the bounce message will fail to get
20550 delivered.
20551
20552
20553
20554 .option rcpt_include_affixes transports boolean false
20555 .cindex "prefix" "for local part, including in envelope"
20556 .cindex "suffix for local part" "including in envelope"
20557 .cindex "local part" "prefix"
20558 .cindex "local part" "suffix"
20559 When this option is false (the default), and an address that has had any
20560 affixes (prefixes or suffixes) removed from the local part is delivered by any
20561 form of SMTP or LMTP, the affixes are not included. For example, if a router
20562 that contains
20563 .code
20564 local_part_prefix = *-
20565 .endd
20566 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
20567 is delivered with
20568 .code
20569 RCPT TO:<xyz@some.domain>
20570 .endd
20571 This is also the case when an ACL-time callout is being used to verify a
20572 recipient address. However, if &%rcpt_include_affixes%& is set true, the
20573 whole local part is included in the RCPT command. This option applies to BSMTP
20574 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
20575 &(lmtp)& and &(smtp)& transports.
20576
20577
20578 .option retry_use_local_part transports boolean "see below"
20579 .cindex "hints database" "retry keys"
20580 When a delivery suffers a temporary failure, a retry record is created
20581 in Exim's hints database. For remote deliveries, the key for the retry record
20582 is based on the name and/or IP address of the failing remote host. For local
20583 deliveries, the key is normally the entire address, including both the local
20584 part and the domain. This is suitable for most common cases of local delivery
20585 temporary failure &-- for example, exceeding a mailbox quota should delay only
20586 deliveries to that mailbox, not to the whole domain.
20587
20588 However, in some special cases you may want to treat a temporary local delivery
20589 as a failure associated with the domain, and not with a particular local part.
20590 (For example, if you are storing all mail for some domain in files.) You can do
20591 this by setting &%retry_use_local_part%& false.
20592
20593 For all the local transports, its default value is true. For remote transports,
20594 the default value is false for tidiness, but changing the value has no effect
20595 on a remote transport in the current implementation.
20596
20597
20598 .option return_path transports string&!! unset
20599 .cindex "envelope sender"
20600 .cindex "transport" "return path; changing"
20601 .cindex "return path" "changing in transport"
20602 If this option is set, the string is expanded at transport time and replaces
20603 the existing return path (envelope sender) value in the copy of the message
20604 that is being delivered. An empty return path is permitted. This feature is
20605 designed for remote deliveries, where the value of this option is used in the
20606 SMTP MAIL command. If you set &%return_path%& for a local transport, the
20607 only effect is to change the address that is placed in the &'Return-path:'&
20608 header line, if one is added to the message (see the next option).
20609
20610 &*Note:*& A changed return path is not logged unless you add
20611 &%return_path_on_delivery%& to the log selector.
20612
20613 .vindex "&$return_path$&"
20614 The expansion can refer to the existing value via &$return_path$&. This is
20615 either the message's envelope sender, or an address set by the
20616 &%errors_to%& option on a router. If the expansion is forced to fail, no
20617 replacement occurs; if it fails for another reason, delivery is deferred. This
20618 option can be used to support VERP (Variable Envelope Return Paths) &-- see
20619 section &<<SECTverp>>&.
20620
20621 &*Note*&: If a delivery error is detected locally, including the case when a
20622 remote server rejects a message at SMTP time, the bounce message is not sent to
20623 the value of this option. It is sent to the previously set errors address.
20624 This defaults to the incoming sender address, but can be changed by setting
20625 &%errors_to%& in a router.
20626
20627
20628
20629 .option return_path_add transports boolean false
20630 .cindex "&'Return-path:'& header line"
20631 If this option is true, a &'Return-path:'& header is added to the message.
20632 Although the return path is normally available in the prefix line of BSD
20633 mailboxes, this is commonly not displayed by MUAs, and so the user does not
20634 have easy access to it.
20635
20636 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
20637 the delivery SMTP server makes the final delivery"&. This implies that this
20638 header should not be present in incoming messages. Exim has a configuration
20639 option, &%return_path_remove%&, which requests removal of this header from
20640 incoming messages, so that delivered messages can safely be resent to other
20641 recipients.
20642
20643
20644 .option shadow_condition transports string&!! unset
20645 See &%shadow_transport%& below.
20646
20647
20648 .option shadow_transport transports string unset
20649 .cindex "shadow transport"
20650 .cindex "transport" "shadow"
20651 A local transport may set the &%shadow_transport%& option to the name of
20652 another local transport. Shadow remote transports are not supported.
20653
20654 Whenever a delivery to the main transport succeeds, and either
20655 &%shadow_condition%& is unset, or its expansion does not result in the empty
20656 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
20657 passed to the shadow transport, with the same delivery address or addresses. If
20658 expansion fails, no action is taken except that non-forced expansion failures
20659 cause a log line to be written.
20660
20661 The result of the shadow transport is discarded and does not affect the
20662 subsequent processing of the message. Only a single level of shadowing is
20663 provided; the &%shadow_transport%& option is ignored on any transport when it
20664 is running as a shadow. Options concerned with output from pipes are also
20665 ignored. The log line for the successful delivery has an item added on the end,
20666 of the form
20667 .code
20668 ST=<shadow transport name>
20669 .endd
20670 If the shadow transport did not succeed, the error message is put in
20671 parentheses afterwards. Shadow transports can be used for a number of different
20672 purposes, including keeping more detailed log information than Exim normally
20673 provides, and implementing automatic acknowledgment policies based on message
20674 headers that some sites insist on.
20675
20676
20677 .option transport_filter transports string&!! unset
20678 .cindex "transport" "filter"
20679 .cindex "filter" "transport filter"
20680 This option sets up a filtering (in the Unix shell sense) process for messages
20681 at transport time. It should not be confused with mail filtering as set up by
20682 individual users or via a system filter.
20683
20684 When the message is about to be written out, the command specified by
20685 &%transport_filter%& is started up in a separate, parallel process, and
20686 the entire message, including the header lines, is passed to it on its standard
20687 input (this in fact is done from a third process, to avoid deadlock). The
20688 command must be specified as an absolute path.
20689
20690 The lines of the message that are written to the transport filter are
20691 terminated by newline (&"\n"&). The message is passed to the filter before any
20692 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
20693 lines beginning with a dot, and also before any processing implied by the
20694 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
20695 &(pipe)& transports.
20696
20697 The standard error for the filter process is set to the same destination as its
20698 standard output; this is read and written to the message's ultimate
20699 destination. The process that writes the message to the filter, the
20700 filter itself, and the original process that reads the result and delivers it
20701 are all run in parallel, like a shell pipeline.
20702
20703 The filter can perform any transformations it likes, but of course should take
20704 care not to break RFC 2822 syntax. Exim does not check the result, except to
20705 test for a final newline when SMTP is in use. All messages transmitted over
20706 SMTP must end with a newline, so Exim supplies one if it is missing.
20707
20708 .cindex "content scanning" "per user"
20709 A transport filter can be used to provide content-scanning on a per-user basis
20710 at delivery time if the only required effect of the scan is to modify the
20711 message. For example, a content scan could insert a new header line containing
20712 a spam score. This could be interpreted by a filter in the user's MUA. It is
20713 not possible to discard a message at this stage.
20714
20715 .cindex "SMTP" "SIZE"
20716 A problem might arise if the filter increases the size of a message that is
20717 being sent down an SMTP connection. If the receiving SMTP server has indicated
20718 support for the SIZE parameter, Exim will have sent the size of the message
20719 at the start of the SMTP session. If what is actually sent is substantially
20720 more, the server might reject the message. This can be worked round by setting
20721 the &%size_addition%& option on the &(smtp)& transport, either to allow for
20722 additions to the message, or to disable the use of SIZE altogether.
20723
20724 .vindex "&$pipe_addresses$&"
20725 The value of the &%transport_filter%& option is the command string for starting
20726 the filter, which is run directly from Exim, not under a shell. The string is
20727 parsed by Exim in the same way as a command string for the &(pipe)& transport:
20728 Exim breaks it up into arguments and then expands each argument separately (see
20729 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
20730 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
20731 of arguments, one for each address that applies to this delivery. (This isn't
20732 an ideal name for this feature here, but as it was already implemented for the
20733 &(pipe)& transport, it seemed sensible not to change it.)
20734
20735 .vindex "&$host$&"
20736 .vindex "&$host_address$&"
20737 The expansion variables &$host$& and &$host_address$& are available when the
20738 transport is a remote one. They contain the name and IP address of the host to
20739 which the message is being sent. For example:
20740 .code
20741 transport_filter = /some/directory/transport-filter.pl \
20742   $host $host_address $sender_address $pipe_addresses
20743 .endd
20744
20745 Two problems arise if you want to use more complicated expansion items to
20746 generate transport filter commands, both of which due to the fact that the
20747 command is split up &'before'& expansion.
20748 .ilist
20749 If an expansion item contains white space, you must quote it, so that it is all
20750 part of the same command item. If the entire option setting is one such
20751 expansion item, you have to take care what kind of quoting you use. For
20752 example:
20753 .code
20754 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
20755 .endd
20756 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
20757 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
20758 stripped by Exim when it read the option's value. When the value is used, if
20759 the single quotes were missing, the line would be split into two items,
20760 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
20761 Exim tried to expand the first one.
20762 .next
20763 Except for the special case of &$pipe_addresses$& that is mentioned above, an
20764 expansion cannot generate multiple arguments, or a command name followed by
20765 arguments. Consider this example:
20766 .code
20767 transport_filter = ${lookup{$host}lsearch{/a/file}\
20768                     {$value}{/bin/cat}}
20769 .endd
20770 The result of the lookup is interpreted as the name of the command, even
20771 if it contains white space. The simplest way round this is to use a shell:
20772 .code
20773 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
20774                                {$value}{/bin/cat}}
20775 .endd
20776 .endlist
20777
20778 The filter process is run under the same uid and gid as the normal delivery.
20779 For remote deliveries this is the Exim uid/gid by default. The command should
20780 normally yield a zero return code. Transport filters are not supposed to fail.
20781 A non-zero code is taken to mean that the transport filter encountered some
20782 serious problem. Delivery of the message is deferred; the message remains on
20783 the queue and is tried again later. It is not possible to cause a message to be
20784 bounced from a transport filter.
20785
20786 If a transport filter is set on an autoreply transport, the original message is
20787 passed through the filter as it is being copied into the newly generated
20788 message, which happens if the &%return_message%& option is set.
20789
20790
20791 .option transport_filter_timeout transports time 5m
20792 .cindex "transport" "filter, timeout"
20793 When Exim is reading the output of a transport filter, it applies a timeout
20794 that can be set by this option. Exceeding the timeout is normally treated as a
20795 temporary delivery failure. However, if a transport filter is used with a
20796 &(pipe)& transport, a timeout in the transport filter is treated in the same
20797 way as a timeout in the pipe command itself. By default, a timeout is a hard
20798 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
20799 becomes a temporary error.
20800
20801
20802 .option user transports string&!! "Exim user"
20803 .cindex "uid (user id)" "local delivery"
20804 .cindex "transport" "user, specifying"
20805 This option specifies the user under whose uid the delivery process is to be
20806 run, overriding any uid that may have been set by the router. If the user is
20807 given as a name, the uid is looked up from the password data, and the
20808 associated group is taken as the value of the gid to be used if the &%group%&
20809 option is not set.
20810
20811 For deliveries that use local transports, a user and group are normally
20812 specified explicitly or implicitly (for example, as a result of
20813 &%check_local_user%&) by the router or transport.
20814
20815 .cindex "hints database" "access by remote transport"
20816 For remote transports, you should leave this option unset unless you really are
20817 sure you know what you are doing. When a remote transport is running, it needs
20818 to be able to access Exim's hints databases, because each host may have its own
20819 retry data.
20820 .ecindex IIDgenoptra1
20821 .ecindex IIDgenoptra2
20822 .ecindex IIDgenoptra3
20823
20824
20825
20826
20827
20828
20829 . ////////////////////////////////////////////////////////////////////////////
20830 . ////////////////////////////////////////////////////////////////////////////
20831
20832 .chapter "Address batching in local transports" "CHAPbatching" &&&
20833          "Address batching"
20834 .cindex "transport" "local; address batching in"
20835 The only remote transport (&(smtp)&) is normally configured to handle more than
20836 one address at a time, so that when several addresses are routed to the same
20837 remote host, just one copy of the message is sent. Local transports, however,
20838 normally handle one address at a time. That is, a separate instance of the
20839 transport is run for each address that is routed to the transport. A separate
20840 copy of the message is delivered each time.
20841
20842 .cindex "batched local delivery"
20843 .oindex "&%batch_max%&"
20844 .oindex "&%batch_id%&"
20845 In special cases, it may be desirable to handle several addresses at once in a
20846 local transport, for example:
20847
20848 .ilist
20849 In an &(appendfile)& transport, when storing messages in files for later
20850 delivery by some other means, a single copy of the message with multiple
20851 recipients saves space.
20852 .next
20853 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
20854 a single copy saves time, and is the normal way LMTP is expected to work.
20855 .next
20856 In a &(pipe)& transport, when passing the message
20857 to a scanner program or
20858 to some other delivery mechanism such as UUCP, multiple recipients may be
20859 acceptable.
20860 .endlist
20861
20862 These three local transports all have the same options for controlling multiple
20863 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
20864 repeating the information for each transport, these options are described here.
20865
20866 The &%batch_max%& option specifies the maximum number of addresses that can be
20867 delivered together in a single run of the transport. Its default value is one
20868 (no batching). When more than one address is routed to a transport that has a
20869 &%batch_max%& value greater than one, the addresses are delivered in a batch
20870 (that is, in a single run of the transport with multiple recipients), subject
20871 to certain conditions:
20872
20873 .ilist
20874 .vindex "&$local_part$&"
20875 If any of the transport's options contain a reference to &$local_part$&, no
20876 batching is possible.
20877 .next
20878 .vindex "&$domain$&"
20879 If any of the transport's options contain a reference to &$domain$&, only
20880 addresses with the same domain are batched.
20881 .next
20882 .cindex "customizing" "batching condition"
20883 If &%batch_id%& is set, it is expanded for each address, and only those
20884 addresses with the same expanded value are batched. This allows you to specify
20885 customized batching conditions. Failure of the expansion for any reason,
20886 including forced failure, disables batching, but it does not stop the delivery
20887 from taking place.
20888 .next
20889 Batched addresses must also have the same errors address (where to send
20890 delivery errors), the same header additions and removals, the same user and
20891 group for the transport, and if a host list is present, the first host must
20892 be the same.
20893 .endlist
20894
20895 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
20896 both when the file or pipe command is specified in the transport, and when it
20897 is specified by a &(redirect)& router, but all the batched addresses must of
20898 course be routed to the same file or pipe command. These two transports have an
20899 option called &%use_bsmtp%&, which causes them to deliver the message in
20900 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
20901 &%check_string%& and &%escape_string%& options are forced to the values
20902 .code
20903 check_string = "."
20904 escape_string = ".."
20905 .endd
20906 when batched SMTP is in use. A full description of the batch SMTP mechanism is
20907 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
20908 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
20909
20910 .cindex "&'Envelope-to:'& header line"
20911 If the generic &%envelope_to_add%& option is set for a batching transport, the
20912 &'Envelope-to:'& header that is added to the message contains all the addresses
20913 that are being processed together. If you are using a batching &(appendfile)&
20914 transport without &%use_bsmtp%&, the only way to preserve the recipient
20915 addresses is to set the &%envelope_to_add%& option.
20916
20917 .cindex "&(pipe)& transport" "with multiple addresses"
20918 .vindex "&$pipe_addresses$&"
20919 If you are using a &(pipe)& transport without BSMTP, and setting the
20920 transport's &%command%& option, you can include &$pipe_addresses$& as part of
20921 the command. This is not a true variable; it is a bit of magic that causes each
20922 of the recipient addresses to be inserted into the command as a separate
20923 argument. This provides a way of accessing all the addresses that are being
20924 delivered in the batch. &*Note:*& This is not possible for pipe commands that
20925 are specified by a &(redirect)& router.
20926
20927
20928
20929
20930 . ////////////////////////////////////////////////////////////////////////////
20931 . ////////////////////////////////////////////////////////////////////////////
20932
20933 .chapter "The appendfile transport" "CHAPappendfile"
20934 .scindex IIDapptra1 "&(appendfile)& transport"
20935 .scindex IIDapptra2 "transports" "&(appendfile)&"
20936 .cindex "directory creation"
20937 .cindex "creating directories"
20938 The &(appendfile)& transport delivers a message by appending it to an existing
20939 file, or by creating an entirely new file in a specified directory. Single
20940 files to which messages are appended can be in the traditional Unix mailbox
20941 format, or optionally in the MBX format supported by the Pine MUA and
20942 University of Washington IMAP daemon, &'inter alia'&. When each message is
20943 being delivered as a separate file, &"maildir"& format can optionally be used
20944 to give added protection against failures that happen part-way through the
20945 delivery. A third form of separate-file delivery known as &"mailstore"& is also
20946 supported. For all file formats, Exim attempts to create as many levels of
20947 directory as necessary, provided that &%create_directory%& is set.
20948
20949 The code for the optional formats is not included in the Exim binary by
20950 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
20951 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
20952 included.
20953
20954 .cindex "quota" "system"
20955 Exim recognizes system quota errors, and generates an appropriate message. Exim
20956 also supports its own quota control within the transport, for use when the
20957 system facility is unavailable or cannot be used for some reason.
20958
20959 If there is an error while appending to a file (for example, quota exceeded or
20960 partition filled), Exim attempts to reset the file's length and last
20961 modification time back to what they were before. If there is an error while
20962 creating an entirely new file, the new file is removed.
20963
20964 Before appending to a file, a number of security checks are made, and the
20965 file is locked. A detailed description is given below, after the list of
20966 private options.
20967
20968 The &(appendfile)& transport is most commonly used for local deliveries to
20969 users' mailboxes. However, it can also be used as a pseudo-remote transport for
20970 putting messages into files for remote delivery by some means other than Exim.
20971 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
20972 option).
20973
20974
20975
20976 .section "The file and directory options" "SECTfildiropt"
20977 The &%file%& option specifies a single file, to which the message is appended;
20978 the &%directory%& option specifies a directory, in which a new file containing
20979 the message is created. Only one of these two options can be set, and for
20980 normal deliveries to mailboxes, one of them &'must'& be set.
20981
20982 .vindex "&$address_file$&"
20983 .vindex "&$local_part$&"
20984 However, &(appendfile)& is also used for delivering messages to files or
20985 directories whose names (or parts of names) are obtained from alias,
20986 forwarding, or filtering operations (for example, a &%save%& command in a
20987 user's Exim filter). When such a transport is running, &$local_part$& contains
20988 the local part that was aliased or forwarded, and &$address_file$& contains the
20989 name (or partial name) of the file or directory generated by the redirection
20990 operation. There are two cases:
20991
20992 .ilist
20993 If neither &%file%& nor &%directory%& is set, the redirection operation
20994 must specify an absolute path (one that begins with &`/`&). This is the most
20995 common case when users with local accounts use filtering to sort mail into
20996 different folders. See for example, the &(address_file)& transport in the
20997 default configuration. If the path ends with a slash, it is assumed to be the
20998 name of a directory. A delivery to a directory can also be forced by setting
20999 &%maildir_format%& or &%mailstore_format%&.
21000 .next
21001 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21002 used to determine the file or directory name for the delivery. Normally, the
21003 contents of &$address_file$& are used in some way in the string expansion.
21004 .endlist
21005
21006
21007 .cindex "Sieve filter" "configuring &(appendfile)&"
21008 .cindex "Sieve filter" "relative mailbox path handling"
21009 As an example of the second case, consider an environment where users do not
21010 have home directories. They may be permitted to use Exim filter commands of the
21011 form:
21012 .code
21013 save folder23
21014 .endd
21015 or Sieve filter commands of the form:
21016 .code
21017 require "fileinto";
21018 fileinto "folder23";
21019 .endd
21020 In this situation, the expansion of &%file%& or &%directory%& in the transport
21021 must transform the relative path into an appropriate absolute file name. In the
21022 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21023 is used as a result of a &"keep"& action in the filter. This example shows one
21024 way of handling this requirement:
21025 .code
21026 file = ${if eq{$address_file}{inbox} \
21027             {/var/mail/$local_part} \
21028             {${if eq{${substr_0_1:$address_file}}{/} \
21029                   {$address_file} \
21030                   {$home/mail/$address_file} \
21031             }} \
21032        }
21033 .endd
21034 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21035 location, absolute paths are used without change, and other folders are in the
21036 &_mail_& directory within the home directory.
21037
21038 &*Note 1*&: While processing an Exim filter, a relative path such as
21039 &_folder23_& is turned into an absolute path if a home directory is known to
21040 the router. In particular, this is the case if &%check_local_user%& is set. If
21041 you want to prevent this happening at routing time, you can set
21042 &%router_home_directory%& empty. This forces the router to pass the relative
21043 path to the transport.
21044
21045 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21046 the &%file%& or &%directory%& option is still used if it is set.
21047
21048
21049
21050
21051 .section "Private options for appendfile" "SECID134"
21052 .cindex "options" "&(appendfile)& transport"
21053
21054
21055
21056 .option allow_fifo appendfile boolean false
21057 .cindex "fifo (named pipe)"
21058 .cindex "named pipe (fifo)"
21059 .cindex "pipe" "named (fifo)"
21060 Setting this option permits delivery to named pipes (FIFOs) as well as to
21061 regular files. If no process is reading the named pipe at delivery time, the
21062 delivery is deferred.
21063
21064
21065 .option allow_symlink appendfile boolean false
21066 .cindex "symbolic link" "to mailbox"
21067 .cindex "mailbox" "symbolic link"
21068 By default, &(appendfile)& will not deliver if the path name for the file is
21069 that of a symbolic link. Setting this option relaxes that constraint, but there
21070 are security issues involved in the use of symbolic links. Be sure you know
21071 what you are doing if you set this. Details of exactly what this option affects
21072 are included in the discussion which follows this list of options.
21073
21074
21075 .option batch_id appendfile string&!! unset
21076 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21077 However, batching is automatically disabled for &(appendfile)& deliveries that
21078 happen as a result of forwarding or aliasing or other redirection directly to a
21079 file.
21080
21081
21082 .option batch_max appendfile integer 1
21083 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21084
21085
21086 .option check_group appendfile boolean false
21087 When this option is set, the group owner of the file defined by the &%file%&
21088 option is checked to see that it is the same as the group under which the
21089 delivery process is running. The default setting is false because the default
21090 file mode is 0600, which means that the group is irrelevant.
21091
21092
21093 .option check_owner appendfile boolean true
21094 When this option is set, the owner of the file defined by the &%file%& option
21095 is checked to ensure that it is the same as the user under which the delivery
21096 process is running.
21097
21098
21099 .option check_string appendfile string "see below"
21100 .cindex "&""From""& line"
21101 As &(appendfile)& writes the message, the start of each line is tested for
21102 matching &%check_string%&, and if it does, the initial matching characters are
21103 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21104 a literal string, not a regular expression, and the case of any letters it
21105 contains is significant.
21106
21107 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21108 are forced to &"."& and &".."& respectively, and any settings in the
21109 configuration are ignored. Otherwise, they default to &"From&~"& and
21110 &">From&~"& when the &%file%& option is set, and unset when any of the
21111 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21112
21113 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21114 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21115 &"From&~"& indicates the start of a new message. All four options need changing
21116 if another format is used. For example, to deliver to mailboxes in MMDF format:
21117 .cindex "MMDF format mailbox"
21118 .cindex "mailbox" "MMDF format"
21119 .code
21120 check_string = "\1\1\1\1\n"
21121 escape_string = "\1\1\1\1 \n"
21122 message_prefix = "\1\1\1\1\n"
21123 message_suffix = "\1\1\1\1\n"
21124 .endd
21125 .option create_directory appendfile boolean true
21126 .cindex "directory creation"
21127 When this option is true, Exim attempts to create any missing superior
21128 directories for the file that it is about to write. A created directory's mode
21129 is given by the &%directory_mode%& option.
21130
21131 The group ownership of a newly created directory is highly dependent on the
21132 operating system (and possibly the file system) that is being used. For
21133 example, in Solaris, if the parent directory has the setgid bit set, its group
21134 is propagated to the child; if not, the currently set group is used. However,
21135 in FreeBSD, the parent's group is always used.
21136
21137
21138
21139 .option create_file appendfile string anywhere
21140 This option constrains the location of files and directories that are created
21141 by this transport. It applies to files defined by the &%file%& option and
21142 directories defined by the &%directory%& option. In the case of maildir
21143 delivery, it applies to the top level directory, not the maildir directories
21144 beneath.
21145
21146 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21147 &"belowhome"&. In the second and third cases, a home directory must have been
21148 set for the transport. This option is not useful when an explicit file name is
21149 given for normal mailbox deliveries. It is intended for the case when file
21150 names are generated from users' &_.forward_& files. These are usually handled
21151 by an &(appendfile)& transport called &%address_file%&. See also
21152 &%file_must_exist%&.
21153
21154
21155 .option directory appendfile string&!! unset
21156 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21157 or &%directory%& must be set, unless the delivery is the direct result of a
21158 redirection (see section &<<SECTfildiropt>>&).
21159
21160 When &%directory%& is set, the string is expanded, and the message is delivered
21161 into a new file or files in or below the given directory, instead of being
21162 appended to a single mailbox file. A number of different formats are provided
21163 (see &%maildir_format%& and &%mailstore_format%&), and see section
21164 &<<SECTopdir>>& for further details of this form of delivery.
21165
21166
21167 .option directory_file appendfile string&!! "see below"
21168 .cindex "base62"
21169 .vindex "&$inode$&"
21170 When &%directory%& is set, but neither &%maildir_format%& nor
21171 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21172 whose name is obtained by expanding this string. The default value is:
21173 .code
21174 q${base62:$tod_epoch}-$inode
21175 .endd
21176 This generates a unique name from the current time, in base 62 form, and the
21177 inode of the file. The variable &$inode$& is available only when expanding this
21178 option.
21179
21180
21181 .option directory_mode appendfile "octal integer" 0700
21182 If &(appendfile)& creates any directories as a result of the
21183 &%create_directory%& option, their mode is specified by this option.
21184
21185
21186 .option escape_string appendfile string "see description"
21187 See &%check_string%& above.
21188
21189
21190 .option file appendfile string&!! unset
21191 This option is mutually exclusive with the &%directory%& option, but one of
21192 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21193 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21194 specifies a single file, to which the message is appended. One or more of
21195 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21196 &%file%&.
21197
21198 .cindex "NFS" "lock file"
21199 .cindex "locking files"
21200 .cindex "lock files"
21201 If you are using more than one host to deliver over NFS into the same
21202 mailboxes, you should always use lock files.
21203
21204 The string value is expanded for each delivery, and must yield an absolute
21205 path. The most common settings of this option are variations on one of these
21206 examples:
21207 .code
21208 file = /var/spool/mail/$local_part
21209 file = /home/$local_part/inbox
21210 file = $home/inbox
21211 .endd
21212 .cindex "&""sticky""& bit"
21213 In the first example, all deliveries are done into the same directory. If Exim
21214 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21215 create a file in the directory, so the &"sticky"& bit must be turned on for
21216 deliveries to be possible, or alternatively the &%group%& option can be used to
21217 run the delivery under a group id which has write access to the directory.
21218
21219
21220
21221 .option file_format appendfile string unset
21222 .cindex "file" "mailbox; checking existing format"
21223 This option requests the transport to check the format of an existing file
21224 before adding to it. The check consists of matching a specific string at the
21225 start of the file. The value of the option consists of an even number of
21226 colon-separated strings. The first of each pair is the test string, and the
21227 second is the name of a transport. If the transport associated with a matched
21228 string is not the current transport, control is passed over to the other
21229 transport. For example, suppose the standard &(local_delivery)& transport has
21230 this added to it:
21231 .code
21232 file_format = "From       : local_delivery :\
21233                \1\1\1\1\n : local_mmdf_delivery"
21234 .endd
21235 Mailboxes that begin with &"From"& are still handled by this transport, but if
21236 a mailbox begins with four binary ones followed by a newline, control is passed
21237 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21238 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21239 is assumed to match the current transport. If the start of a mailbox doesn't
21240 match any string, or if the transport named for a given string is not defined,
21241 delivery is deferred.
21242
21243
21244 .option file_must_exist appendfile boolean false
21245 If this option is true, the file specified by the &%file%& option must exist.
21246 A temporary error occurs if it does not, causing delivery to be deferred.
21247 If this option is false, the file is created if it does not exist.
21248
21249
21250 .option lock_fcntl_timeout appendfile time 0s
21251 .cindex "timeout" "mailbox locking"
21252 .cindex "mailbox" "locking, blocking and non-blocking"
21253 .cindex "locking files"
21254 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21255 when locking an open mailbox file. If the call fails, the delivery process
21256 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21257 Non-blocking calls are used so that the file is not kept open during the wait
21258 for the lock; the reason for this is to make it as safe as possible for
21259 deliveries over NFS in the case when processes might be accessing an NFS
21260 mailbox without using a lock file. This should not be done, but
21261 misunderstandings and hence misconfigurations are not unknown.
21262
21263 On a busy system, however, the performance of a non-blocking lock approach is
21264 not as good as using a blocking lock with a timeout. In this case, the waiting
21265 is done inside the system call, and Exim's delivery process acquires the lock
21266 and can proceed as soon as the previous lock holder releases it.
21267
21268 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21269 timeout, are used. There may still be some retrying: the maximum number of
21270 retries is
21271 .code
21272 (lock_retries * lock_interval) / lock_fcntl_timeout
21273 .endd
21274 rounded up to the next whole number. In other words, the total time during
21275 which &(appendfile)& is trying to get a lock is roughly the same, unless
21276 &%lock_fcntl_timeout%& is set very large.
21277
21278 You should consider setting this option if you are getting a lot of delayed
21279 local deliveries because of errors of the form
21280 .code
21281 failed to lock mailbox /some/file (fcntl)
21282 .endd
21283
21284 .option lock_flock_timeout appendfile time 0s
21285 This timeout applies to file locking when using &[flock()]& (see
21286 &%use_flock%&); the timeout operates in a similar manner to
21287 &%lock_fcntl_timeout%&.
21288
21289
21290 .option lock_interval appendfile time 3s
21291 This specifies the time to wait between attempts to lock the file. See below
21292 for details of locking.
21293
21294
21295 .option lock_retries appendfile integer 10
21296 This specifies the maximum number of attempts to lock the file. A value of zero
21297 is treated as 1. See below for details of locking.
21298
21299
21300 .option lockfile_mode appendfile "octal integer" 0600
21301 This specifies the mode of the created lock file, when a lock file is being
21302 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21303
21304
21305 .option lockfile_timeout appendfile time 30m
21306 .cindex "timeout" "mailbox locking"
21307 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21308 exists and is older than this value, it is assumed to have been left behind by
21309 accident, and Exim attempts to remove it.
21310
21311
21312 .option mailbox_filecount appendfile string&!! unset
21313 .cindex "mailbox" "specifying size of"
21314 .cindex "size" "of mailbox"
21315 If this option is set, it is expanded, and the result is taken as the current
21316 number of files in the mailbox. It must be a decimal number, optionally
21317 followed by K or M. This provides a way of obtaining this information from an
21318 external source that maintains the data.
21319
21320
21321 .option mailbox_size appendfile string&!! unset
21322 .cindex "mailbox" "specifying size of"
21323 .cindex "size" "of mailbox"
21324 If this option is set, it is expanded, and the result is taken as the current
21325 size the mailbox. It must be a decimal number, optionally followed by K or M.
21326 This provides a way of obtaining this information from an external source that
21327 maintains the data. This is likely to be helpful for maildir deliveries where
21328 it is computationally expensive to compute the size of a mailbox.
21329
21330
21331
21332 .option maildir_format appendfile boolean false
21333 .cindex "maildir format" "specifying"
21334 If this option is set with the &%directory%& option, the delivery is into a new
21335 file, in the &"maildir"& format that is used by other mail software. When the
21336 transport is activated directly from a &(redirect)& router (for example, the
21337 &(address_file)& transport in the default configuration), setting
21338 &%maildir_format%& causes the path received from the router to be treated as a
21339 directory, whether or not it ends with &`/`&. This option is available only if
21340 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21341 &<<SECTmaildirdelivery>>& below for further details.
21342
21343
21344 .option maildir_quota_directory_regex appendfile string "See below"
21345 .cindex "maildir format" "quota; directories included in"
21346 .cindex "quota" "maildir; directories included in"
21347 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21348 a regular expression for specifying directories, relative to the quota
21349 directory (see &%quota_directory%&), that should be included in the quota
21350 calculation. The default value is:
21351 .code
21352 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21353 .endd
21354 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21355 (directories whose names begin with a dot). If you want to exclude the
21356 &_Trash_&
21357 folder from the count (as some sites do), you need to change this setting to
21358 .code
21359 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21360 .endd
21361 This uses a negative lookahead in the regular expression to exclude the
21362 directory whose name is &_.Trash_&. When a directory is excluded from quota
21363 calculations, quota processing is bypassed for any messages that are delivered
21364 directly into that directory.
21365
21366
21367 .option maildir_retries appendfile integer 10
21368 This option specifies the number of times to retry when writing a file in
21369 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21370
21371
21372 .option maildir_tag appendfile string&!! unset
21373 This option applies only to deliveries in maildir format, and is described in
21374 section &<<SECTmaildirdelivery>>& below.
21375
21376
21377 .option maildir_use_size_file appendfile&!! boolean false
21378 .cindex "maildir format" "&_maildirsize_& file"
21379 The result of string expansion for this option must be a valid boolean value.
21380 If it is true, it enables support for &_maildirsize_& files. Exim
21381 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21382 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21383 value is zero. See &%maildir_quota_directory_regex%& above and section
21384 &<<SECTmaildirdelivery>>& below for further details.
21385
21386 .option maildirfolder_create_regex appendfile string unset
21387 .cindex "maildir format" "&_maildirfolder_& file"
21388 .cindex "&_maildirfolder_&, creating"
21389 The value of this option is a regular expression. If it is unset, it has no
21390 effect. Otherwise, before a maildir delivery takes place, the pattern is
21391 matched against the name of the maildir directory, that is, the directory
21392 containing the &_new_& and &_tmp_& subdirectories that will be used for the
21393 delivery. If there is a match, Exim checks for the existence of a file called
21394 &_maildirfolder_& in the directory, and creates it if it does not exist.
21395 See section &<<SECTmaildirdelivery>>& for more details.
21396
21397
21398 .option mailstore_format appendfile boolean false
21399 .cindex "mailstore format" "specifying"
21400 If this option is set with the &%directory%& option, the delivery is into two
21401 new files in  &"mailstore"& format. The option is available only if
21402 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
21403 below for further details.
21404
21405
21406 .option mailstore_prefix appendfile string&!! unset
21407 This option applies only to deliveries in mailstore format, and is described in
21408 section &<<SECTopdir>>& below.
21409
21410
21411 .option mailstore_suffix appendfile string&!! unset
21412 This option applies only to deliveries in mailstore format, and is described in
21413 section &<<SECTopdir>>& below.
21414
21415
21416 .option mbx_format appendfile boolean false
21417 .cindex "locking files"
21418 .cindex "file" "locking"
21419 .cindex "file" "MBX format"
21420 .cindex "MBX format, specifying"
21421 This option is available only if Exim has been compiled with SUPPORT_MBX
21422 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
21423 the message is appended to the mailbox file in MBX format instead of
21424 traditional Unix format. This format is supported by Pine4 and its associated
21425 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
21426
21427 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
21428 automatically changed by the use of &%mbx_format%&. They should normally be set
21429 empty when using MBX format, so this option almost always appears in this
21430 combination:
21431 .code
21432 mbx_format = true
21433 message_prefix =
21434 message_suffix =
21435 .endd
21436 If none of the locking options are mentioned in the configuration,
21437 &%use_mbx_lock%& is assumed and the other locking options default to false. It
21438 is possible to specify the other kinds of locking with &%mbx_format%&, but
21439 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
21440 interworks with &'c-client'&, providing for shared access to the mailbox. It
21441 should not be used if any program that does not use this form of locking is
21442 going to access the mailbox, nor should it be used if the mailbox file is NFS
21443 mounted, because it works only when the mailbox is accessed from a single host.
21444
21445 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
21446 the standard version of &'c-client'&, because as long as it has a mailbox open
21447 (this means for the whole of a Pine or IMAP session), Exim will not be able to
21448 append messages to it.
21449
21450
21451 .option message_prefix appendfile string&!! "see below"
21452 .cindex "&""From""& line"
21453 The string specified here is expanded and output at the start of every message.
21454 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21455 in which case it is:
21456 .code
21457 message_prefix = "From ${if def:return_path{$return_path}\
21458   {MAILER-DAEMON}} $tod_bsdinbox\n"
21459 .endd
21460 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21461 &`\n`& to &`\r\n`& in &%message_prefix%&.
21462
21463 .option message_suffix appendfile string&!! "see below"
21464 The string specified here is expanded and output at the end of every message.
21465 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
21466 in which case it is a single newline character. The suffix can be suppressed by
21467 setting
21468 .code
21469 message_suffix =
21470 .endd
21471 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
21472 &`\n`& to &`\r\n`& in &%message_suffix%&.
21473
21474 .option mode appendfile "octal integer" 0600
21475 If the output file is created, it is given this mode. If it already exists and
21476 has wider permissions, they are reduced to this mode. If it has narrower
21477 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
21478 if the delivery is the result of a &%save%& command in a filter file specifying
21479 a particular mode, the mode of the output file is always forced to take that
21480 value, and this option is ignored.
21481
21482
21483 .option mode_fail_narrower appendfile boolean true
21484 This option applies in the case when an existing mailbox file has a narrower
21485 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
21486 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
21487 continues with the delivery attempt, using the existing mode of the file.
21488
21489
21490 .option notify_comsat appendfile boolean false
21491 If this option is true, the &'comsat'& daemon is notified after every
21492 successful delivery to a user mailbox. This is the daemon that notifies logged
21493 on users about incoming mail.
21494
21495
21496 .option quota appendfile string&!! unset
21497 .cindex "quota" "imposed by Exim"
21498 This option imposes a limit on the size of the file to which Exim is appending,
21499 or to the total space used in the directory tree when the &%directory%& option
21500 is set. In the latter case, computation of the space used is expensive, because
21501 all the files in the directory (and any sub-directories) have to be
21502 individually inspected and their sizes summed. (See &%quota_size_regex%& and
21503 &%maildir_use_size_file%& for ways to avoid this in environments where users
21504 have no shell access to their mailboxes).
21505
21506 As there is no interlock against two simultaneous deliveries into a
21507 multi-file mailbox, it is possible for the quota to be overrun in this case.
21508 For single-file mailboxes, of course, an interlock is a necessity.
21509
21510 A file's size is taken as its &'used'& value. Because of blocking effects, this
21511 may be a lot less than the actual amount of disk space allocated to the file.
21512 If the sizes of a number of files are being added up, the rounding effect can
21513 become quite noticeable, especially on systems that have large block sizes.
21514 Nevertheless, it seems best to stick to the &'used'& figure, because this is
21515 the obvious value which users understand most easily.
21516
21517 The value of the option is expanded, and must then be a numerical value
21518 (decimal point allowed), optionally followed by one of the letters K, M, or G,
21519 for kilobytes, megabytes, or gigabytes. If Exim is running on a system with
21520 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
21521 be handled.
21522
21523 &*Note*&: A value of zero is interpreted as &"no quota"&.
21524
21525 The expansion happens while Exim is running as root, before it changes uid for
21526 the delivery. This means that files that are inaccessible to the end user can
21527 be used to hold quota values that are looked up in the expansion. When delivery
21528 fails because this quota is exceeded, the handling of the error is as for
21529 system quota failures.
21530
21531 By default, Exim's quota checking mimics system quotas, and restricts the
21532 mailbox to the specified maximum size, though the value is not accurate to the
21533 last byte, owing to separator lines and additional headers that may get added
21534 during message delivery. When a mailbox is nearly full, large messages may get
21535 refused even though small ones are accepted, because the size of the current
21536 message is added to the quota when the check is made. This behaviour can be
21537 changed by setting &%quota_is_inclusive%& false. When this is done, the check
21538 for exceeding the quota does not include the current message. Thus, deliveries
21539 continue until the quota has been exceeded; thereafter, no further messages are
21540 delivered. See also &%quota_warn_threshold%&.
21541
21542
21543 .option quota_directory appendfile string&!! unset
21544 This option defines the directory to check for quota purposes when delivering
21545 into individual files. The default is the delivery directory, or, if a file
21546 called &_maildirfolder_& exists in a maildir directory, the parent of the
21547 delivery directory.
21548
21549
21550 .option quota_filecount appendfile string&!! 0
21551 This option applies when the &%directory%& option is set. It limits the total
21552 number of files in the directory (compare the inode limit in system quotas). It
21553 can only be used if &%quota%& is also set. The value is expanded; an expansion
21554 failure causes delivery to be deferred. A value of zero is interpreted as
21555 &"no quota"&.
21556
21557
21558 .option quota_is_inclusive appendfile boolean true
21559 See &%quota%& above.
21560
21561
21562 .option quota_size_regex appendfile string unset
21563 This option applies when one of the delivery modes that writes a separate file
21564 for each message is being used. When Exim wants to find the size of one of
21565 these files in order to test the quota, it first checks &%quota_size_regex%&.
21566 If this is set to a regular expression that matches the file name, and it
21567 captures one string, that string is interpreted as a representation of the
21568 file's size. The value of &%quota_size_regex%& is not expanded.
21569
21570 This feature is useful only when users have no shell access to their mailboxes
21571 &-- otherwise they could defeat the quota simply by renaming the files. This
21572 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
21573 the file length to the file name. For example:
21574 .code
21575 maildir_tag = ,S=$message_size
21576 quota_size_regex = ,S=(\d+)
21577 .endd
21578 An alternative to &$message_size$& is &$message_linecount$&, which contains the
21579 number of lines in the message.
21580
21581 The regular expression should not assume that the length is at the end of the
21582 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
21583 sometimes add other information onto the ends of message file names.
21584
21585 Section &<<SECID136>>& contains further information.
21586
21587
21588 .option quota_warn_message appendfile string&!! "see below"
21589 See below for the use of this option. If it is not set when
21590 &%quota_warn_threshold%& is set, it defaults to
21591 .code
21592 quota_warn_message = "\
21593   To: $local_part@$domain\n\
21594   Subject: Your mailbox\n\n\
21595   This message is automatically created \
21596   by mail delivery software.\n\n\
21597   The size of your mailbox has exceeded \
21598   a warning threshold that is\n\
21599   set by the system administrator.\n"
21600 .endd
21601
21602
21603 .option quota_warn_threshold appendfile string&!! 0
21604 .cindex "quota" "warning threshold"
21605 .cindex "mailbox" "size warning"
21606 .cindex "size" "of mailbox"
21607 This option is expanded in the same way as &%quota%& (see above). If the
21608 resulting value is greater than zero, and delivery of the message causes the
21609 size of the file or total space in the directory tree to cross the given
21610 threshold, a warning message is sent. If &%quota%& is also set, the threshold
21611 may be specified as a percentage of it by following the value with a percent
21612 sign. For example:
21613 .code
21614 quota = 10M
21615 quota_warn_threshold = 75%
21616 .endd
21617 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
21618 percent sign is ignored.
21619
21620 The warning message itself is specified by the &%quota_warn_message%& option,
21621 and it must start with a &'To:'& header line containing the recipient(s) of the
21622 warning message. These do not necessarily have to include the recipient(s) of
21623 the original message. A &'Subject:'& line should also normally be supplied. You
21624 can include any other header lines that you want. If you do not include a
21625 &'From:'& line, the default is:
21626 .code
21627 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
21628 .endd
21629 .oindex &%errors_reply_to%&
21630 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
21631 option.
21632
21633 The &%quota%& option does not have to be set in order to use this option; they
21634 are independent of one another except when the threshold is specified as a
21635 percentage.
21636
21637
21638 .option use_bsmtp appendfile boolean false
21639 .cindex "envelope sender"
21640 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
21641 format, with the envelope sender and recipient(s) included as SMTP commands. If
21642 you want to include a leading HELO command with such messages, you can do
21643 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
21644 for details of batch SMTP.
21645
21646
21647 .option use_crlf appendfile boolean false
21648 .cindex "carriage return"
21649 .cindex "linefeed"
21650 This option causes lines to be terminated with the two-character CRLF sequence
21651 (carriage return, linefeed) instead of just a linefeed character. In the case
21652 of batched SMTP, the byte sequence written to the file is then an exact image
21653 of what would be sent down a real SMTP connection.
21654
21655 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
21656 (which are used to supply the traditional &"From&~"& and blank line separators
21657 in Berkeley-style mailboxes) are written verbatim, so must contain their own
21658 carriage return characters if these are needed. In cases where these options
21659 have non-empty defaults, the values end with a single linefeed, so they must be
21660 changed to end with &`\r\n`& if &%use_crlf%& is set.
21661
21662
21663 .option use_fcntl_lock appendfile boolean "see below"
21664 This option controls the use of the &[fcntl()]& function to lock a file for
21665 exclusive use when a message is being appended. It is set by default unless
21666 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
21667 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
21668 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
21669
21670
21671 .option use_flock_lock appendfile boolean false
21672 This option is provided to support the use of &[flock()]& for file locking, for
21673 the few situations where it is needed. Most modern operating systems support
21674 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
21675 each other. Exim uses &[fcntl()]& locking by default.
21676
21677 This option is required only if you are using an operating system where
21678 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
21679 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
21680 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
21681
21682 .cindex "Solaris" "&[flock()]& support"
21683 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
21684 have it (and some, I think, provide a not quite right version built on top of
21685 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
21686 the ability to use it, and any attempt to do so will cause a configuration
21687 error.
21688
21689 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
21690 is just being mapped onto &[fcntl()]& by the OS).
21691
21692
21693 .option use_lockfile appendfile boolean "see below"
21694 If this option is turned off, Exim does not attempt to create a lock file when
21695 appending to a mailbox file. In this situation, the only locking is by
21696 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
21697 sure that every MUA that is ever going to look at your users' mailboxes uses
21698 &[fcntl()]& rather than a lock file, and even then only when you are not
21699 delivering over NFS from more than one host.
21700
21701 .cindex "NFS" "lock file"
21702 In order to append to an NFS file safely from more than one host, it is
21703 necessary to take out a lock &'before'& opening the file, and the lock file
21704 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
21705 file corruption.
21706
21707 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
21708 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
21709 except when &%mbx_format%& is set.
21710
21711
21712 .option use_mbx_lock appendfile boolean "see below"
21713 This option is available only if Exim has been compiled with SUPPORT_MBX
21714 set in &_Local/Makefile_&. Setting the option specifies that special MBX
21715 locking rules be used. It is set by default if &%mbx_format%& is set and none
21716 of the locking options are mentioned in the configuration. The locking rules
21717 are the same as are used by the &'c-client'& library that underlies Pine and
21718 the IMAP4 and POP daemons that come with it (see the discussion below). The
21719 rules allow for shared access to the mailbox. However, this kind of locking
21720 does not work when the mailbox is NFS mounted.
21721
21722 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
21723 &%use_flock_lock%& to control what kind of locking is used in implementing the
21724 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
21725 without &%use_fcntl_lock%& or &%use_flock_lock%&.
21726
21727
21728
21729
21730 .section "Operational details for appending" "SECTopappend"
21731 .cindex "appending to a file"
21732 .cindex "file" "appending"
21733 Before appending to a file, the following preparations are made:
21734
21735 .ilist
21736 If the name of the file is &_/dev/null_&, no action is taken, and a success
21737 return is given.
21738
21739 .next
21740 .cindex "directory creation"
21741 If any directories on the file's path are missing, Exim creates them if the
21742 &%create_directory%& option is set. A created directory's mode is given by the
21743 &%directory_mode%& option.
21744
21745 .next
21746 If &%file_format%& is set, the format of an existing file is checked. If this
21747 indicates that a different transport should be used, control is passed to that
21748 transport.
21749
21750 .next
21751 .cindex "file" "locking"
21752 .cindex "locking files"
21753 .cindex "NFS" "lock file"
21754 If &%use_lockfile%& is set, a lock file is built in a way that will work
21755 reliably over NFS, as follows:
21756
21757 .olist
21758 Create a &"hitching post"& file whose name is that of the lock file with the
21759 current time, primary host name, and process id added, by opening for writing
21760 as a new file. If this fails with an access error, delivery is deferred.
21761 .next
21762 Close the hitching post file, and hard link it to the lock file name.
21763 .next
21764 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
21765 Unlink the hitching post name.
21766 .next
21767 Otherwise, use &[stat()]& to get information about the hitching post file, and
21768 then unlink hitching post name. If the number of links is exactly two, creation
21769 of the lock file succeeded but something (for example, an NFS server crash and
21770 restart) caused this fact not to be communicated to the &[link()]& call.
21771 .next
21772 If creation of the lock file failed, wait for &%lock_interval%& and try again,
21773 up to &%lock_retries%& times. However, since any program that writes to a
21774 mailbox should complete its task very quickly, it is reasonable to time out old
21775 lock files that are normally the result of user agent and system crashes. If an
21776 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
21777 it before trying again.
21778 .endlist olist
21779
21780 .next
21781 A call is made to &[lstat()]& to discover whether the main file exists, and if
21782 so, what its characteristics are. If &[lstat()]& fails for any reason other
21783 than non-existence, delivery is deferred.
21784
21785 .next
21786 .cindex "symbolic link" "to mailbox"
21787 .cindex "mailbox" "symbolic link"
21788 If the file does exist and is a symbolic link, delivery is deferred, unless the
21789 &%allow_symlink%& option is set, in which case the ownership of the link is
21790 checked, and then &[stat()]& is called to find out about the real file, which
21791 is then subjected to the checks below. The check on the top-level link
21792 ownership prevents one user creating a link for another's mailbox in a sticky
21793 directory, though allowing symbolic links in this case is definitely not a good
21794 idea. If there is a chain of symbolic links, the intermediate ones are not
21795 checked.
21796
21797 .next
21798 If the file already exists but is not a regular file, or if the file's owner
21799 and group (if the group is being checked &-- see &%check_group%& above) are
21800 different from the user and group under which the delivery is running,
21801 delivery is deferred.
21802
21803 .next
21804 If the file's permissions are more generous than specified, they are reduced.
21805 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
21806 is set false, in which case the delivery is tried using the existing
21807 permissions.
21808
21809 .next
21810 The file's inode number is saved, and the file is then opened for appending.
21811 If this fails because the file has vanished, &(appendfile)& behaves as if it
21812 hadn't existed (see below). For any other failures, delivery is deferred.
21813
21814 .next
21815 If the file is opened successfully, check that the inode number hasn't
21816 changed, that it is still a regular file, and that the owner and permissions
21817 have not changed. If anything is wrong, defer delivery and freeze the message.
21818
21819 .next
21820 If the file did not exist originally, defer delivery if the &%file_must_exist%&
21821 option is set. Otherwise, check that the file is being created in a permitted
21822 directory if the &%create_file%& option is set (deferring on failure), and then
21823 open for writing as a new file, with the O_EXCL and O_CREAT options,
21824 except when dealing with a symbolic link (the &%allow_symlink%& option must be
21825 set). In this case, which can happen if the link points to a non-existent file,
21826 the file is opened for writing using O_CREAT but not O_EXCL, because
21827 that prevents link following.
21828
21829 .next
21830 .cindex "loop" "while file testing"
21831 If opening fails because the file exists, obey the tests given above for
21832 existing files. However, to avoid looping in a situation where the file is
21833 being continuously created and destroyed, the exists/not-exists loop is broken
21834 after 10 repetitions, and the message is then frozen.
21835
21836 .next
21837 If opening fails with any other error, defer delivery.
21838
21839 .next
21840 .cindex "file" "locking"
21841 .cindex "locking files"
21842 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
21843 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
21844 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
21845 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
21846 file, and an exclusive lock on the file whose name is
21847 .code
21848 /tmp/.<device-number>.<inode-number>
21849 .endd
21850 using the device and inode numbers of the open mailbox file, in accordance with
21851 the MBX locking rules. This file is created with a mode that is specified by
21852 the &%lockfile_mode%& option.
21853
21854 If Exim fails to lock the file, there are two possible courses of action,
21855 depending on the value of the locking timeout. This is obtained from
21856 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
21857
21858 If the timeout value is zero, the file is closed, Exim waits for
21859 &%lock_interval%&, and then goes back and re-opens the file as above and tries
21860 to lock it again. This happens up to &%lock_retries%& times, after which the
21861 delivery is deferred.
21862
21863 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
21864 &[flock()]& are used (with the given timeout), so there has already been some
21865 waiting involved by the time locking fails. Nevertheless, Exim does not give up
21866 immediately. It retries up to
21867 .code
21868 (lock_retries * lock_interval) / <timeout>
21869 .endd
21870 times (rounded up).
21871 .endlist
21872
21873 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
21874 and/or &[flock()]& locks) and then deletes the lock file if one was created.
21875
21876
21877 .section "Operational details for delivery to a new file" "SECTopdir"
21878 .cindex "delivery" "to single file"
21879 .cindex "&""From""& line"
21880 When the &%directory%& option is set instead of &%file%&, each message is
21881 delivered into a newly-created file or set of files. When &(appendfile)& is
21882 activated directly from a &(redirect)& router, neither &%file%& nor
21883 &%directory%& is normally set, because the path for delivery is supplied by the
21884 router. (See for example, the &(address_file)& transport in the default
21885 configuration.) In this case, delivery is to a new file if either the path name
21886 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
21887
21888 No locking is required while writing the message to a new file, so the various
21889 locking options of the transport are ignored. The &"From"& line that by default
21890 separates messages in a single file is not normally needed, nor is the escaping
21891 of message lines that start with &"From"&, and there is no need to ensure a
21892 newline at the end of each message. Consequently, the default values for
21893 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
21894 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
21895
21896 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
21897 the files in the delivery directory by default. However, you can specify a
21898 different directory by setting &%quota_directory%&. Also, for maildir
21899 deliveries (see below) the &_maildirfolder_& convention is honoured.
21900
21901
21902 .cindex "maildir format"
21903 .cindex "mailstore format"
21904 There are three different ways in which delivery to individual files can be
21905 done, controlled by the settings of the &%maildir_format%& and
21906 &%mailstore_format%& options. Note that code to support maildir or mailstore
21907 formats is not included in the binary unless SUPPORT_MAILDIR or
21908 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
21909
21910 .cindex "directory creation"
21911 In all three cases an attempt is made to create the directory and any necessary
21912 sub-directories if they do not exist, provided that the &%create_directory%&
21913 option is set (the default). The location of a created directory can be
21914 constrained by setting &%create_file%&. A created directory's mode is given by
21915 the &%directory_mode%& option. If creation fails, or if the
21916 &%create_directory%& option is not set when creation is required, delivery is
21917 deferred.
21918
21919
21920
21921 .section "Maildir delivery" "SECTmaildirdelivery"
21922 .cindex "maildir format" "description of"
21923 If the &%maildir_format%& option is true, Exim delivers each message by writing
21924 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
21925 directory that is defined by the &%directory%& option (the &"delivery
21926 directory"&). If the delivery is successful, the file is renamed into the
21927 &_new_& subdirectory.
21928
21929 In the file name, <&'stime'&> is the current time of day in seconds, and
21930 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
21931 Exim checks that the time-of-day clock has moved on by at least one microsecond
21932 before terminating the delivery process. This guarantees uniqueness for the
21933 file name. However, as a precaution, Exim calls &[stat()]& for the file before
21934 opening it. If any response other than ENOENT (does not exist) is given,
21935 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
21936
21937 Before Exim carries out a maildir delivery, it ensures that subdirectories
21938 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
21939 do not exist, Exim tries to create them and any superior directories in their
21940 path, subject to the &%create_directory%& and &%create_file%& options. If the
21941 &%maildirfolder_create_regex%& option is set, and the regular expression it
21942 contains matches the delivery directory, Exim also ensures that a file called
21943 &_maildirfolder_& exists in the delivery directory. If a missing directory or
21944 &_maildirfolder_& file cannot be created, delivery is deferred.
21945
21946 These features make it possible to use Exim to create all the necessary files
21947 and directories in a maildir mailbox, including subdirectories for maildir++
21948 folders. Consider this example:
21949 .code
21950 maildir_format = true
21951 directory = /var/mail/$local_part\
21952            ${if eq{$local_part_suffix}{}{}\
21953            {/.${substr_1:$local_part_suffix}}}
21954 maildirfolder_create_regex = /\.[^/]+$
21955 .endd
21956 If &$local_part_suffix$& is empty (there was no suffix for the local part),
21957 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
21958 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
21959 not match this name, so Exim will not look for or create the file
21960 &_/var/mail/pimbo/maildirfolder_&, though it will create
21961 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
21962
21963 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
21964 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
21965 does match &%maildirfolder_create_regex%&. In this case, Exim will create
21966 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
21967 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
21968
21969 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
21970 not inadvertently match the toplevel maildir directory, because a
21971 &_maildirfolder_& file at top level would completely break quota calculations.
21972
21973 .cindex "quota" "in maildir delivery"
21974 .cindex "maildir++"
21975 If Exim is required to check a &%quota%& setting before a maildir delivery, and
21976 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
21977 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
21978 Exim assumes the directory is a maildir++ folder directory, which is one level
21979 down from the user's top level mailbox directory. This causes it to start at
21980 the parent directory instead of the current directory when calculating the
21981 amount of space used.
21982
21983 One problem with delivering into a multi-file mailbox is that it is
21984 computationally expensive to compute the size of the mailbox for quota
21985 checking. Various approaches have been taken to reduce the amount of work
21986 needed. The next two sections describe two of them. A third alternative is to
21987 use some external process for maintaining the size data, and use the expansion
21988 of the &%mailbox_size%& option as a way of importing it into Exim.
21989
21990
21991
21992
21993 .section "Using tags to record message sizes" "SECID135"
21994 If &%maildir_tag%& is set, the string is expanded for each delivery.
21995 When the maildir file is renamed into the &_new_& sub-directory, the
21996 tag is added to its name. However, if adding the tag takes the length of the
21997 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
21998 the tag is dropped and the maildir file is created with no tag.
21999
22000
22001 .vindex "&$message_size$&"
22002 Tags can be used to encode the size of files in their names; see
22003 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22004 happens after the message has been written. The value of the &$message_size$&
22005 variable is set to the number of bytes actually written. If the expansion is
22006 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22007 be deferred. The expanded tag may contain any printing characters except &"/"&.
22008 Non-printing characters in the string are ignored; if the resulting string is
22009 empty, it is ignored. If it starts with an alphanumeric character, a leading
22010 colon is inserted; this default has not proven to be the path that popular
22011 maildir implementations have chosen (but changing it in Exim would break
22012 backwards compatibility).
22013
22014 For one common implementation, you might set:
22015 .code
22016 maildir_tag = ,S=${message_size}
22017 .endd
22018 but you should check the documentation of the other software to be sure.
22019
22020 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22021 as this allows Exim to extract the size from your tag, instead of having to
22022 &[stat()]& each message file.
22023
22024
22025 .section "Using a maildirsize file" "SECID136"
22026 .cindex "quota" "in maildir delivery"
22027 .cindex "maildir format" "&_maildirsize_& file"
22028 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22029 storing quota and message size information in a file called &_maildirsize_&
22030 within the toplevel maildir directory. If this file does not exist, Exim
22031 creates it, setting the quota from the &%quota%& option of the transport. If
22032 the maildir directory itself does not exist, it is created before any attempt
22033 to write a &_maildirsize_& file.
22034
22035 The &_maildirsize_& file is used to hold information about the sizes of
22036 messages in the maildir, thus speeding up quota calculations. The quota value
22037 in the file is just a cache; if the quota is changed in the transport, the new
22038 value overrides the cached value when the next message is delivered. The cache
22039 is maintained for the benefit of other programs that access the maildir and
22040 need to know the quota.
22041
22042 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22043 file is maintained (with a zero quota setting), but no quota is imposed.
22044
22045 A regular expression is available for controlling which directories in the
22046 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22047 See the description of the &%maildir_quota_directory_regex%& option above for
22048 details.
22049
22050
22051 .section "Mailstore delivery" "SECID137"
22052 .cindex "mailstore format" "description of"
22053 If the &%mailstore_format%& option is true, each message is written as two
22054 files in the given directory. A unique base name is constructed from the
22055 message id and the current delivery process, and the files that are written use
22056 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22057 contains the message's envelope, and the &_.msg_& file contains the message
22058 itself. The base name is placed in the variable &$mailstore_basename$&.
22059
22060 During delivery, the envelope is first written to a file with the suffix
22061 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22062 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22063 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22064 file before accessing either of them. An alternative approach is to wait for
22065 the absence of a &_.tmp_& file.
22066
22067 The envelope file starts with any text defined by the &%mailstore_prefix%&
22068 option, expanded and terminated by a newline if there isn't one. Then follows
22069 the sender address on one line, then all the recipient addresses, one per line.
22070 There can be more than one recipient only if the &%batch_max%& option is set
22071 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22072 appended to the file, followed by a newline if it does not end with one.
22073
22074 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22075 failure, it is ignored. Other expansion errors are treated as serious
22076 configuration errors, and delivery is deferred. The variable
22077 &$mailstore_basename$& is available for use during these expansions.
22078
22079
22080 .section "Non-special new file delivery" "SECID138"
22081 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22082 file is created directly in the named directory. For example, when delivering
22083 messages into files in batched SMTP format for later delivery to some host (see
22084 section &<<SECTbatchSMTP>>&), a setting such as
22085 .code
22086 directory = /var/bsmtp/$host
22087 .endd
22088 might be used. A message is written to a file with a temporary name, which is
22089 then renamed when the delivery is complete. The final name is obtained by
22090 expanding the contents of the &%directory_file%& option.
22091 .ecindex IIDapptra1
22092 .ecindex IIDapptra2
22093
22094
22095
22096
22097
22098
22099 . ////////////////////////////////////////////////////////////////////////////
22100 . ////////////////////////////////////////////////////////////////////////////
22101
22102 .chapter "The autoreply transport" "CHID8"
22103 .scindex IIDauttra1 "transports" "&(autoreply)&"
22104 .scindex IIDauttra2 "&(autoreply)& transport"
22105 The &(autoreply)& transport is not a true transport in that it does not cause
22106 the message to be transmitted. Instead, it generates a new mail message as an
22107 automatic reply to the incoming message. &'References:'& and
22108 &'Auto-Submitted:'& header lines are included. These are constructed according
22109 to the rules in RFCs 2822 and 3834, respectively.
22110
22111 If the router that passes the message to this transport does not have the
22112 &%unseen%& option set, the original message (for the current recipient) is not
22113 delivered anywhere. However, when the &%unseen%& option is set on the router
22114 that passes the message to this transport, routing of the address continues, so
22115 another router can set up a normal message delivery.
22116
22117
22118 The &(autoreply)& transport is usually run as the result of mail filtering, a
22119 &"vacation"& message being the standard example. However, it can also be run
22120 directly from a router like any other transport. To reduce the possibility of
22121 message cascades, messages created by the &(autoreply)& transport always have
22122 empty envelope sender addresses, like bounce messages.
22123
22124 The parameters of the message to be sent can be specified in the configuration
22125 by options described below. However, these are used only when the address
22126 passed to the transport does not contain its own reply information. When the
22127 transport is run as a consequence of a
22128 &%mail%&
22129 or &%vacation%& command in a filter file, the parameters of the message are
22130 supplied by the filter, and passed with the address. The transport's options
22131 that define the message are then ignored (so they are not usually set in this
22132 case). The message is specified entirely by the filter or by the transport; it
22133 is never built from a mixture of options. However, the &%file_optional%&,
22134 &%mode%&, and &%return_message%& options apply in all cases.
22135
22136 &(Autoreply)& is implemented as a local transport. When used as a result of a
22137 command in a user's filter file, &(autoreply)& normally runs under the uid and
22138 gid of the user, and with appropriate current and home directories (see chapter
22139 &<<CHAPenvironment>>&).
22140
22141 There is a subtle difference between routing a message to a &(pipe)& transport
22142 that generates some text to be returned to the sender, and routing it to an
22143 &(autoreply)& transport. This difference is noticeable only if more than one
22144 address from the same message is so handled. In the case of a pipe, the
22145 separate outputs from the different addresses are gathered up and returned to
22146 the sender in a single message, whereas if &(autoreply)& is used, a separate
22147 message is generated for each address that is passed to it.
22148
22149 Non-printing characters are not permitted in the header lines generated for the
22150 message that &(autoreply)& creates, with the exception of newlines that are
22151 immediately followed by white space. If any non-printing characters are found,
22152 the transport defers.
22153 Whether characters with the top bit set count as printing characters or not is
22154 controlled by the &%print_topbitchars%& global option.
22155
22156 If any of the generic options for manipulating headers (for example,
22157 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22158 of the original message that is included in the generated message when
22159 &%return_message%& is set. They do not apply to the generated message itself.
22160
22161 .vindex "&$sender_address$&"
22162 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22163 the message, indicating that there were no recipients, it does not treat this
22164 as an error. This means that autoreplies sent to &$sender_address$& when this
22165 is empty (because the incoming message is a bounce message) do not cause
22166 problems. They are just discarded.
22167
22168
22169
22170 .section "Private options for autoreply" "SECID139"
22171 .cindex "options" "&(autoreply)& transport"
22172
22173 .option bcc autoreply string&!! unset
22174 This specifies the addresses that are to receive &"blind carbon copies"& of the
22175 message when the message is specified by the transport.
22176
22177
22178 .option cc autoreply string&!! unset
22179 This specifies recipients of the message and the contents of the &'Cc:'& header
22180 when the message is specified by the transport.
22181
22182
22183 .option file autoreply string&!! unset
22184 The contents of the file are sent as the body of the message when the message
22185 is specified by the transport. If both &%file%& and &%text%& are set, the text
22186 string comes first.
22187
22188
22189 .option file_expand autoreply boolean false
22190 If this is set, the contents of the file named by the &%file%& option are
22191 subjected to string expansion as they are added to the message.
22192
22193
22194 .option file_optional autoreply boolean false
22195 If this option is true, no error is generated if the file named by the &%file%&
22196 option or passed with the address does not exist or cannot be read.
22197
22198
22199 .option from autoreply string&!! unset
22200 This specifies the contents of the &'From:'& header when the message is
22201 specified by the transport.
22202
22203
22204 .option headers autoreply string&!! unset
22205 This specifies additional RFC 2822 headers that are to be added to the message
22206 when the message is specified by the transport. Several can be given by using
22207 &"\n"& to separate them. There is no check on the format.
22208
22209
22210 .option log autoreply string&!! unset
22211 This option names a file in which a record of every message sent is logged when
22212 the message is specified by the transport.
22213
22214
22215 .option mode autoreply "octal integer" 0600
22216 If either the log file or the &"once"& file has to be created, this mode is
22217 used.
22218
22219
22220 .option never_mail autoreply "address list&!!" unset
22221 If any run of the transport creates a message with a recipient that matches any
22222 item in the list, that recipient is quietly discarded. If all recipients are
22223 discarded, no message is created. This applies both when the recipients are
22224 generated by a filter and when they are specified in the transport.
22225
22226
22227
22228 .option once autoreply string&!! unset
22229 This option names a file or DBM database in which a record of each &'To:'&
22230 recipient is kept when the message is specified by the transport. &*Note*&:
22231 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22232
22233 If &%once%& is unset, or is set to an empty string, the message is always sent.
22234 By default, if &%once%& is set to a non-empty file name, the message
22235 is not sent if a potential recipient is already listed in the database.
22236 However, if the &%once_repeat%& option specifies a time greater than zero, the
22237 message is sent if that much time has elapsed since a message was last sent to
22238 this recipient. A setting of zero time for &%once_repeat%& (the default)
22239 prevents a message from being sent a second time &-- in this case, zero means
22240 infinity.
22241
22242 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22243 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22244 greater than zero, it changes the way Exim implements the &%once%& option.
22245 Instead of using a DBM file to record every recipient it sends to, it uses a
22246 regular file, whose size will never get larger than the given value.
22247
22248 In the file, Exim keeps a linear list of recipient addresses and the times at
22249 which they were sent messages. If the file is full when a new address needs to
22250 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22251 means that a given recipient may receive multiple messages, but at
22252 unpredictable intervals that depend on the rate of turnover of addresses in the
22253 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22254
22255
22256 .option once_file_size autoreply integer 0
22257 See &%once%& above.
22258
22259
22260 .option once_repeat autoreply time&!! 0s
22261 See &%once%& above.
22262 After expansion, the value of this option must be a valid time value.
22263
22264
22265 .option reply_to autoreply string&!! unset
22266 This specifies the contents of the &'Reply-To:'& header when the message is
22267 specified by the transport.
22268
22269
22270 .option return_message autoreply boolean false
22271 If this is set, a copy of the original message is returned with the new
22272 message, subject to the maximum size set in the &%return_size_limit%& global
22273 configuration option.
22274
22275
22276 .option subject autoreply string&!! unset
22277 This specifies the contents of the &'Subject:'& header when the message is
22278 specified by the transport. It is tempting to quote the original subject in
22279 automatic responses. For example:
22280 .code
22281 subject = Re: $h_subject:
22282 .endd
22283 There is a danger in doing this, however. It may allow a third party to
22284 subscribe your users to an opt-in mailing list, provided that the list accepts
22285 bounce messages as subscription confirmations. Well-managed lists require a
22286 non-bounce message to confirm a subscription, so the danger is relatively
22287 small.
22288
22289
22290
22291 .option text autoreply string&!! unset
22292 This specifies a single string to be used as the body of the message when the
22293 message is specified by the transport. If both &%text%& and &%file%& are set,
22294 the text comes first.
22295
22296
22297 .option to autoreply string&!! unset
22298 This specifies recipients of the message and the contents of the &'To:'& header
22299 when the message is specified by the transport.
22300 .ecindex IIDauttra1
22301 .ecindex IIDauttra2
22302
22303
22304
22305
22306 . ////////////////////////////////////////////////////////////////////////////
22307 . ////////////////////////////////////////////////////////////////////////////
22308
22309 .chapter "The lmtp transport" "CHAPLMTP"
22310 .cindex "transports" "&(lmtp)&"
22311 .cindex "&(lmtp)& transport"
22312 .cindex "LMTP" "over a pipe"
22313 .cindex "LMTP" "over a socket"
22314 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22315 specified command
22316 or by interacting with a Unix domain socket.
22317 This transport is something of a cross between the &(pipe)& and &(smtp)&
22318 transports. Exim also has support for using LMTP over TCP/IP; this is
22319 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22320 to be of minority interest, the default build-time configure in &_src/EDITME_&
22321 has it commented out. You need to ensure that
22322 .code
22323 TRANSPORT_LMTP=yes
22324 .endd
22325 .cindex "options" "&(lmtp)& transport"
22326 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22327 included in the Exim binary. The private options of the &(lmtp)& transport are
22328 as follows:
22329
22330 .option batch_id lmtp string&!! unset
22331 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22332
22333
22334 .option batch_max lmtp integer 1
22335 This limits the number of addresses that can be handled in a single delivery.
22336 Most LMTP servers can handle several addresses at once, so it is normally a
22337 good idea to increase this value. See the description of local delivery
22338 batching in chapter &<<CHAPbatching>>&.
22339
22340
22341 .option command lmtp string&!! unset
22342 This option must be set if &%socket%& is not set. The string is a command which
22343 is run in a separate process. It is split up into a command name and list of
22344 arguments, each of which is separately expanded (so expansion cannot change the
22345 number of arguments). The command is run directly, not via a shell. The message
22346 is passed to the new process using the standard input and output to operate the
22347 LMTP protocol.
22348
22349 .option ignore_quota lmtp boolean false
22350 .cindex "LMTP" "ignoring quota errors"
22351 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22352 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22353 in its response to the LHLO command.
22354
22355 .option socket lmtp string&!! unset
22356 This option must be set if &%command%& is not set. The result of expansion must
22357 be the name of a Unix domain socket. The transport connects to the socket and
22358 delivers the message to it using the LMTP protocol.
22359
22360
22361 .option timeout lmtp time 5m
22362 The transport is aborted if the created process or Unix domain socket does not
22363 respond to LMTP commands or message input within this timeout. Delivery
22364 is deferred, and will be tried again later. Here is an example of a typical
22365 LMTP transport:
22366 .code
22367 lmtp:
22368   driver = lmtp
22369   command = /some/local/lmtp/delivery/program
22370   batch_max = 20
22371   user = exim
22372 .endd
22373 This delivers up to 20 addresses at a time, in a mixture of domains if
22374 necessary, running as the user &'exim'&.
22375
22376
22377
22378 . ////////////////////////////////////////////////////////////////////////////
22379 . ////////////////////////////////////////////////////////////////////////////
22380
22381 .chapter "The pipe transport" "CHAPpipetransport"
22382 .scindex IIDpiptra1 "transports" "&(pipe)&"
22383 .scindex IIDpiptra2 "&(pipe)& transport"
22384 The &(pipe)& transport is used to deliver messages via a pipe to a command
22385 running in another process. One example is the use of &(pipe)& as a
22386 pseudo-remote transport for passing messages to some other delivery mechanism
22387 (such as UUCP). Another is the use by individual users to automatically process
22388 their incoming messages. The &(pipe)& transport can be used in one of the
22389 following ways:
22390
22391 .ilist
22392 .vindex "&$local_part$&"
22393 A router routes one address to a transport in the normal way, and the
22394 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
22395 contains the local part of the address (as usual), and the command that is run
22396 is specified by the &%command%& option on the transport.
22397 .next
22398 .vindex "&$pipe_addresses$&"
22399 If the &%batch_max%& option is set greater than 1 (the default is 1), the
22400 transport can handle more than one address in a single run. In this case, when
22401 more than one address is routed to the transport, &$local_part$& is not set
22402 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
22403 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
22404 that are routed to the transport.
22405 .next
22406 .vindex "&$address_pipe$&"
22407 A router redirects an address directly to a pipe command (for example, from an
22408 alias or forward file). In this case, &$address_pipe$& contains the text of the
22409 pipe command, and the &%command%& option on the transport is ignored unless
22410 &%force_command%& is set. If only one address is being transported
22411 (&%batch_max%& is not greater than one, or only one address was redirected to
22412 this pipe command), &$local_part$& contains the local part that was redirected.
22413 .endlist
22414
22415
22416 The &(pipe)& transport is a non-interactive delivery method. Exim can also
22417 deliver messages over pipes using the LMTP interactive protocol. This is
22418 implemented by the &(lmtp)& transport.
22419
22420 In the case when &(pipe)& is run as a consequence of an entry in a local user's
22421 &_.forward_& file, the command runs under the uid and gid of that user. In
22422 other cases, the uid and gid have to be specified explicitly, either on the
22423 transport or on the router that handles the address. Current and &"home"&
22424 directories are also controllable. See chapter &<<CHAPenvironment>>& for
22425 details of the local delivery environment and chapter &<<CHAPbatching>>&
22426 for a discussion of local delivery batching.
22427
22428
22429 .section "Concurrent delivery" "SECID140"
22430 If two messages arrive at almost the same time, and both are routed to a pipe
22431 delivery, the two pipe transports may be run concurrently. You must ensure that
22432 any pipe commands you set up are robust against this happening. If the commands
22433 write to a file, the &%exim_lock%& utility might be of use.
22434
22435
22436
22437
22438 .section "Returned status and data" "SECID141"
22439 .cindex "&(pipe)& transport" "returned data"
22440 If the command exits with a non-zero return code, the delivery is deemed to
22441 have failed, unless either the &%ignore_status%& option is set (in which case
22442 the return code is treated as zero), or the return code is one of those listed
22443 in the &%temp_errors%& option, which are interpreted as meaning &"try again
22444 later"&. In this case, delivery is deferred. Details of a permanent failure are
22445 logged, but are not included in the bounce message, which merely contains
22446 &"local delivery failed"&.
22447
22448 If the command exits on a signal and the &%freeze_signal%& option is set then
22449 the message will be frozen in the queue. If that option is not set, a bounce
22450 will be sent as normal.
22451
22452 If the return code is greater than 128 and the command being run is a shell
22453 script, it normally means that the script was terminated by a signal whose
22454 value is the return code minus 128. The &%freeze_signal%& option does not
22455 apply in this case.
22456
22457 If Exim is unable to run the command (that is, if &[execve()]& fails), the
22458 return code is set to 127. This is the value that a shell returns if it is
22459 asked to run a non-existent command. The wording for the log line suggests that
22460 a non-existent command may be the problem.
22461
22462 The &%return_output%& option can affect the result of a pipe delivery. If it is
22463 set and the command produces any output on its standard output or standard
22464 error streams, the command is considered to have failed, even if it gave a zero
22465 return code or if &%ignore_status%& is set. The output from the command is
22466 included as part of the bounce message. The &%return_fail_output%& option is
22467 similar, except that output is returned only when the command exits with a
22468 failure return code, that is, a value other than zero or a code that matches
22469 &%temp_errors%&.
22470
22471
22472
22473 .section "How the command is run" "SECThowcommandrun"
22474 .cindex "&(pipe)& transport" "path for command"
22475 The command line is (by default) broken down into a command name and arguments
22476 by the &(pipe)& transport itself. The &%allow_commands%& and
22477 &%restrict_to_path%& options can be used to restrict the commands that may be
22478 run.
22479
22480 .cindex "quoting" "in pipe command"
22481 Unquoted arguments are delimited by white space. If an argument appears in
22482 double quotes, backslash is interpreted as an escape character in the usual
22483 way. If an argument appears in single quotes, no escaping is done.
22484
22485 String expansion is applied to the command line except when it comes from a
22486 traditional &_.forward_& file (commands from a filter file are expanded). The
22487 expansion is applied to each argument in turn rather than to the whole line.
22488 For this reason, any string expansion item that contains white space must be
22489 quoted so as to be contained within a single argument. A setting such as
22490 .code
22491 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
22492 .endd
22493 will not work, because the expansion item gets split between several
22494 arguments. You have to write
22495 .code
22496 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
22497 .endd
22498 to ensure that it is all in one argument. The expansion is done in this way,
22499 argument by argument, so that the number of arguments cannot be changed as a
22500 result of expansion, and quotes or backslashes in inserted variables do not
22501 interact with external quoting. However, this leads to problems if you want to
22502 generate multiple arguments (or the command name plus arguments) from a single
22503 expansion. In this situation, the simplest solution is to use a shell. For
22504 example:
22505 .code
22506 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
22507 .endd
22508
22509 .cindex "transport" "filter"
22510 .cindex "filter" "transport filter"
22511 .vindex "&$pipe_addresses$&"
22512 Special handling takes place when an argument consists of precisely the text
22513 &`$pipe_addresses`&. This is not a general expansion variable; the only
22514 place this string is recognized is when it appears as an argument for a pipe or
22515 transport filter command. It causes each address that is being handled to be
22516 inserted in the argument list at that point &'as a separate argument'&. This
22517 avoids any problems with spaces or shell metacharacters, and is of use when a
22518 &(pipe)& transport is handling groups of addresses in a batch.
22519
22520 If &%force_command%& is enabled on the transport, Special handling takes place
22521 for an argument that consists of precisely the text &`$address_pipe`&.  It
22522 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
22523 argument is inserted in the argument list at that point
22524 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
22525 the only item in the argument; in fact, if it were then &%force_command%&
22526 should behave as a no-op.  Rather, it should be used to adjust the command
22527 run while preserving the argument vector separation.
22528
22529 After splitting up into arguments and expansion, the resulting command is run
22530 in a subprocess directly from the transport, &'not'& under a shell. The
22531 message that is being delivered is supplied on the standard input, and the
22532 standard output and standard error are both connected to a single pipe that is
22533 read by Exim. The &%max_output%& option controls how much output the command
22534 may produce, and the &%return_output%& and &%return_fail_output%& options
22535 control what is done with it.
22536
22537 Not running the command under a shell (by default) lessens the security risks
22538 in cases when a command from a user's filter file is built out of data that was
22539 taken from an incoming message. If a shell is required, it can of course be
22540 explicitly specified as the command to be run. However, there are circumstances
22541 where existing commands (for example, in &_.forward_& files) expect to be run
22542 under a shell and cannot easily be modified. To allow for these cases, there is
22543 an option called &%use_shell%&, which changes the way the &(pipe)& transport
22544 works. Instead of breaking up the command line as just described, it expands it
22545 as a single string and passes the result to &_/bin/sh_&. The
22546 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
22547 with &%use_shell%&, and the whole mechanism is inherently less secure.
22548
22549
22550
22551 .section "Environment variables" "SECTpipeenv"
22552 .cindex "&(pipe)& transport" "environment for command"
22553 .cindex "environment for pipe transport"
22554 The environment variables listed below are set up when the command is invoked.
22555 This list is a compromise for maximum compatibility with other MTAs. Note that
22556 the &%environment%& option can be used to add additional variables to this
22557 environment.
22558 .display
22559 &`DOMAIN            `&   the domain of the address
22560 &`HOME              `&   the home directory, if set
22561 &`HOST              `&   the host name when called from a router (see below)
22562 &`LOCAL_PART        `&   see below
22563 &`LOCAL_PART_PREFIX `&   see below
22564 &`LOCAL_PART_SUFFIX `&   see below
22565 &`LOGNAME           `&   see below
22566 &`MESSAGE_ID        `&   Exim's local ID for the message
22567 &`PATH              `&   as specified by the &%path%& option below
22568 &`QUALIFY_DOMAIN    `&   the sender qualification domain
22569 &`RECIPIENT         `&   the complete recipient address
22570 &`SENDER            `&   the sender of the message (empty if a bounce)
22571 &`SHELL             `&   &`/bin/sh`&
22572 &`TZ                `&   the value of the &%timezone%& option, if set
22573 &`USER              `&   see below
22574 .endd
22575 When a &(pipe)& transport is called directly from (for example) an &(accept)&
22576 router, LOCAL_PART is set to the local part of the address. When it is
22577 called as a result of a forward or alias expansion, LOCAL_PART is set to
22578 the local part of the address that was expanded. In both cases, any affixes are
22579 removed from the local part, and made available in LOCAL_PART_PREFIX and
22580 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
22581 same value as LOCAL_PART for compatibility with other MTAs.
22582
22583 .cindex "HOST"
22584 HOST is set only when a &(pipe)& transport is called from a router that
22585 associates hosts with an address, typically when using &(pipe)& as a
22586 pseudo-remote transport. HOST is set to the first host name specified by
22587 the router.
22588
22589 .cindex "HOME"
22590 If the transport's generic &%home_directory%& option is set, its value is used
22591 for the HOME environment variable. Otherwise, a home directory may be set
22592 by the router's &%transport_home_directory%& option, which defaults to the
22593 user's home directory if &%check_local_user%& is set.
22594
22595
22596 .section "Private options for pipe" "SECID142"
22597 .cindex "options" "&(pipe)& transport"
22598
22599
22600
22601 .option allow_commands pipe "string list&!!" unset
22602 .cindex "&(pipe)& transport" "permitted commands"
22603 The string is expanded, and is then interpreted as a colon-separated list of
22604 permitted commands. If &%restrict_to_path%& is not set, the only commands
22605 permitted are those in the &%allow_commands%& list. They need not be absolute
22606 paths; the &%path%& option is still used for relative paths. If
22607 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
22608 in the &%allow_commands%& list, or a name without any slashes that is found on
22609 the path. In other words, if neither &%allow_commands%& nor
22610 &%restrict_to_path%& is set, there is no restriction on the command, but
22611 otherwise only commands that are permitted by one or the other are allowed. For
22612 example, if
22613 .code
22614 allow_commands = /usr/bin/vacation
22615 .endd
22616 and &%restrict_to_path%& is not set, the only permitted command is
22617 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
22618 &%use_shell%& is set.
22619
22620
22621 .option batch_id pipe string&!! unset
22622 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22623
22624
22625 .option batch_max pipe integer 1
22626 This limits the number of addresses that can be handled in a single delivery.
22627 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22628
22629
22630 .option check_string pipe string unset
22631 As &(pipe)& writes the message, the start of each line is tested for matching
22632 &%check_string%&, and if it does, the initial matching characters are replaced
22633 by the contents of &%escape_string%&, provided both are set. The value of
22634 &%check_string%& is a literal string, not a regular expression, and the case of
22635 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
22636 of &%check_string%& and &%escape_string%& are forced to values that implement
22637 the SMTP escaping protocol. Any settings made in the configuration file are
22638 ignored.
22639
22640
22641 .option command pipe string&!! unset
22642 This option need not be set when &(pipe)& is being used to deliver to pipes
22643 obtained directly from address redirections. In other cases, the option must be
22644 set, to provide a command to be run. It need not yield an absolute path (see
22645 the &%path%& option below). The command is split up into separate arguments by
22646 Exim, and each argument is separately expanded, as described in section
22647 &<<SECThowcommandrun>>& above.
22648
22649
22650 .option environment pipe string&!! unset
22651 .cindex "&(pipe)& transport" "environment for command"
22652 .cindex "environment for &(pipe)& transport"
22653 This option is used to add additional variables to the environment in which the
22654 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
22655 a string which is expanded, and then interpreted as a colon-separated list of
22656 environment settings of the form <&'name'&>=<&'value'&>.
22657
22658
22659 .option escape_string pipe string unset
22660 See &%check_string%& above.
22661
22662
22663 .option freeze_exec_fail pipe boolean false
22664 .cindex "exec failure"
22665 .cindex "failure of exec"
22666 .cindex "&(pipe)& transport" "failure of exec"
22667 Failure to exec the command in a pipe transport is by default treated like
22668 any other failure while running the command. However, if &%freeze_exec_fail%&
22669 is set, failure to exec is treated specially, and causes the message to be
22670 frozen, whatever the setting of &%ignore_status%&.
22671
22672
22673 .option freeze_signal pipe boolean false
22674 .cindex "signal exit"
22675 .cindex "&(pipe)& transport", "signal exit"
22676 Normally if the process run by a command in a pipe transport exits on a signal,
22677 a bounce message is sent. If &%freeze_signal%& is set, the message will be
22678 frozen in Exim's queue instead.
22679
22680
22681 .option force_command pipe boolean false
22682 .cindex "force command"
22683 .cindex "&(pipe)& transport", "force command"
22684 Normally when a router redirects an address directly to a pipe command
22685 the &%command%& option on the transport is ignored.  If &%force_command%&
22686 is set, the &%command%& option will used. This is especially
22687 useful for forcing a wrapper or additional argument to be added to the
22688 command. For example:
22689 .code
22690 command = /usr/bin/remote_exec myhost -- $address_pipe
22691 force_command
22692 .endd
22693
22694 Note that &$address_pipe$& is handled specially in &%command%& when
22695 &%force_command%& is set, expanding out to the original argument vector as
22696 separate items, similarly to a Unix shell &`"$@"`& construct.
22697
22698 .option ignore_status pipe boolean false
22699 If this option is true, the status returned by the subprocess that is set up to
22700 run the command is ignored, and Exim behaves as if zero had been returned.
22701 Otherwise, a non-zero status or termination by signal causes an error return
22702 from the transport unless the status value is one of those listed in
22703 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
22704
22705 &*Note*&: This option does not apply to timeouts, which do not return a status.
22706 See the &%timeout_defer%& option for how timeouts are handled.
22707
22708 .option log_defer_output pipe boolean false
22709 .cindex "&(pipe)& transport" "logging output"
22710 If this option is set, and the status returned by the command is
22711 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
22712 and any output was produced, the first line of it is written to the main log.
22713
22714
22715 .option log_fail_output pipe boolean false
22716 If this option is set, and the command returns any output, and also ends with a
22717 return code that is neither zero nor one of the return codes listed in
22718 &%temp_errors%& (that is, the delivery failed), the first line of output is
22719 written to the main log. This option and &%log_output%& are mutually exclusive.
22720 Only one of them may be set.
22721
22722
22723
22724 .option log_output pipe boolean false
22725 If this option is set and the command returns any output, the first line of
22726 output is written to the main log, whatever the return code. This option and
22727 &%log_fail_output%& are mutually exclusive. Only one of them may be set.
22728
22729
22730
22731 .option max_output pipe integer 20K
22732 This specifies the maximum amount of output that the command may produce on its
22733 standard output and standard error file combined. If the limit is exceeded, the
22734 process running the command is killed. This is intended as a safety measure to
22735 catch runaway processes. The limit is applied independently of the settings of
22736 the options that control what is done with such output (for example,
22737 &%return_output%&). Because of buffering effects, the amount of output may
22738 exceed the limit by a small amount before Exim notices.
22739
22740
22741 .option message_prefix pipe string&!! "see below"
22742 The string specified here is expanded and output at the start of every message.
22743 The default is unset if &%use_bsmtp%& is set. Otherwise it is
22744 .code
22745 message_prefix = \
22746   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
22747   ${tod_bsdinbox}\n
22748 .endd
22749 .cindex "Cyrus"
22750 .cindex "&%tmail%&"
22751 .cindex "&""From""& line"
22752 This is required by the commonly used &_/usr/bin/vacation_& program.
22753 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
22754 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
22755 setting
22756 .code
22757 message_prefix =
22758 .endd
22759 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22760 &`\n`& to &`\r\n`& in &%message_prefix%&.
22761
22762
22763 .option message_suffix pipe string&!! "see below"
22764 The string specified here is expanded and output at the end of every message.
22765 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
22766 The suffix can be suppressed by setting
22767 .code
22768 message_suffix =
22769 .endd
22770 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22771 &`\n`& to &`\r\n`& in &%message_suffix%&.
22772
22773
22774 .option path pipe string "see below"
22775 This option specifies the string that is set up in the PATH environment
22776 variable of the subprocess. The default is:
22777 .code
22778 /bin:/usr/bin
22779 .endd
22780 If the &%command%& option does not yield an absolute path name, the command is
22781 sought in the PATH directories, in the usual way. &*Warning*&: This does not
22782 apply to a command specified as a transport filter.
22783
22784
22785 .option permit_coredump pipe boolean false
22786 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
22787 a core-dump of a pipe command, enable this command.  This enables core-dumps
22788 during delivery and affects both the Exim binary and the pipe command run.
22789 It is recommended that this option remain off unless and until you have a need
22790 for it and that this only be enabled when needed, as the risk of excessive
22791 resource consumption can be quite high.  Note also that Exim is typically
22792 installed as a setuid binary and most operating systems will inhibit coredumps
22793 of these by default, so further OS-specific action may be required.
22794
22795
22796 .option pipe_as_creator pipe boolean false
22797 .cindex "uid (user id)" "local delivery"
22798 If the generic &%user%& option is not set and this option is true, the delivery
22799 process is run under the uid that was in force when Exim was originally called
22800 to accept the message. If the group id is not otherwise set (via the generic
22801 &%group%& option), the gid that was in force when Exim was originally called to
22802 accept the message is used.
22803
22804
22805 .option restrict_to_path pipe boolean false
22806 When this option is set, any command name not listed in &%allow_commands%& must
22807 contain no slashes. The command is searched for only in the directories listed
22808 in the &%path%& option. This option is intended for use in the case when a pipe
22809 command has been generated from a user's &_.forward_& file. This is usually
22810 handled by a &(pipe)& transport called &%address_pipe%&.
22811
22812
22813 .option return_fail_output pipe boolean false
22814 If this option is true, and the command produced any output and ended with a
22815 return code other than zero or one of the codes listed in &%temp_errors%& (that
22816 is, the delivery failed), the output is returned in the bounce message.
22817 However, if the message has a null sender (that is, it is itself a bounce
22818 message), output from the command is discarded. This option and
22819 &%return_output%& are mutually exclusive. Only one of them may be set.
22820
22821
22822
22823 .option return_output pipe boolean false
22824 If this option is true, and the command produced any output, the delivery is
22825 deemed to have failed whatever the return code from the command, and the output
22826 is returned in the bounce message. Otherwise, the output is just discarded.
22827 However, if the message has a null sender (that is, it is a bounce message),
22828 output from the command is always discarded, whatever the setting of this
22829 option. This option and &%return_fail_output%& are mutually exclusive. Only one
22830 of them may be set.
22831
22832
22833
22834 .option temp_errors pipe "string list" "see below"
22835 .cindex "&(pipe)& transport" "temporary failure"
22836 This option contains either a colon-separated list of numbers, or a single
22837 asterisk. If &%ignore_status%& is false
22838 and &%return_output%& is not set,
22839 and the command exits with a non-zero return code, the failure is treated as
22840 temporary and the delivery is deferred if the return code matches one of the
22841 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
22842 codes are treated as permanent errors. The default setting contains the codes
22843 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
22844 compiled on a system that does not define these macros, it assumes values of 75
22845 and 73, respectively.
22846
22847
22848 .option timeout pipe time 1h
22849 If the command fails to complete within this time, it is killed. This normally
22850 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
22851 specifies no timeout. In order to ensure that any subprocesses created by the
22852 command are also killed, Exim makes the initial process a process group leader,
22853 and kills the whole process group on a timeout. However, this can be defeated
22854 if one of the processes starts a new process group.
22855
22856 .option timeout_defer pipe boolean false
22857 A timeout in a &(pipe)& transport, either in the command that the transport
22858 runs, or in a transport filter that is associated with it, is by default
22859 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
22860 is set true, both kinds of timeout become temporary errors, causing the
22861 delivery to be deferred.
22862
22863 .option umask pipe "octal integer" 022
22864 This specifies the umask setting for the subprocess that runs the command.
22865
22866
22867 .option use_bsmtp pipe boolean false
22868 .cindex "envelope sender"
22869 If this option is set true, the &(pipe)& transport writes messages in &"batch
22870 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
22871 commands. If you want to include a leading HELO command with such messages,
22872 you can do so by setting the &%message_prefix%& option. See section
22873 &<<SECTbatchSMTP>>& for details of batch SMTP.
22874
22875 .option use_classresources pipe boolean false
22876 .cindex "class resources (BSD)"
22877 This option is available only when Exim is running on FreeBSD, NetBSD, or
22878 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
22879 resource limits when a &(pipe)& transport is run to perform a delivery. The
22880 limits for the uid under which the pipe is to run are obtained from the login
22881 class database.
22882
22883
22884 .option use_crlf pipe boolean false
22885 .cindex "carriage return"
22886 .cindex "linefeed"
22887 This option causes lines to be terminated with the two-character CRLF sequence
22888 (carriage return, linefeed) instead of just a linefeed character. In the case
22889 of batched SMTP, the byte sequence written to the pipe is then an exact image
22890 of what would be sent down a real SMTP connection.
22891
22892 The contents of the &%message_prefix%& and &%message_suffix%& options are
22893 written verbatim, so must contain their own carriage return characters if these
22894 are needed. When &%use_bsmtp%& is not set, the default values for both
22895 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
22896 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
22897
22898
22899 .option use_shell pipe boolean false
22900 .vindex "&$pipe_addresses$&"
22901 If this option is set, it causes the command to be passed to &_/bin/sh_&
22902 instead of being run directly from the transport, as described in section
22903 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
22904 where the command is expected to be run under a shell and cannot easily be
22905 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
22906 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
22907 command is expanded as a single string, and handed to &_/bin/sh_& as data for
22908 its &%-c%& option.
22909
22910
22911
22912 .section "Using an external local delivery agent" "SECID143"
22913 .cindex "local delivery" "using an external agent"
22914 .cindex "&'procmail'&"
22915 .cindex "external local delivery"
22916 .cindex "delivery" "&'procmail'&"
22917 .cindex "delivery" "by external agent"
22918 The &(pipe)& transport can be used to pass all messages that require local
22919 delivery to a separate local delivery agent such as &%procmail%&. When doing
22920 this, care must be taken to ensure that the pipe is run under an appropriate
22921 uid and gid. In some configurations one wants this to be a uid that is trusted
22922 by the delivery agent to supply the correct sender of the message. It may be
22923 necessary to recompile or reconfigure the delivery agent so that it trusts an
22924 appropriate user. The following is an example transport and router
22925 configuration for &%procmail%&:
22926 .code
22927 # transport
22928 procmail_pipe:
22929   driver = pipe
22930   command = /usr/local/bin/procmail -d $local_part
22931   return_path_add
22932   delivery_date_add
22933   envelope_to_add
22934   check_string = "From "
22935   escape_string = ">From "
22936   umask = 077
22937   user = $local_part
22938   group = mail
22939
22940 # router
22941 procmail:
22942   driver = accept
22943   check_local_user
22944   transport = procmail_pipe
22945 .endd
22946 In this example, the pipe is run as the local user, but with the group set to
22947 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
22948 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
22949 user to supply a correct sender address. If you do not specify either a
22950 &%group%& or a &%user%& option, the pipe command is run as the local user. The
22951 home directory is the user's home directory by default.
22952
22953 &*Note*&: The command that the pipe transport runs does &'not'& begin with
22954 .code
22955 IFS=" "
22956 .endd
22957 as shown in some &%procmail%& documentation, because Exim does not by default
22958 use a shell to run pipe commands.
22959
22960 .cindex "Cyrus"
22961 The next example shows a transport and a router for a system where local
22962 deliveries are handled by the Cyrus IMAP server.
22963 .code
22964 # transport
22965 local_delivery_cyrus:
22966   driver = pipe
22967   command = /usr/cyrus/bin/deliver \
22968             -m ${substr_1:$local_part_suffix} -- $local_part
22969   user = cyrus
22970   group = mail
22971   return_output
22972   log_output
22973   message_prefix =
22974   message_suffix =
22975
22976 # router
22977 local_user_cyrus:
22978   driver = accept
22979   check_local_user
22980   local_part_suffix = .*
22981   transport = local_delivery_cyrus
22982 .endd
22983 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
22984 &%return_output%& to cause any text written by Cyrus to be returned to the
22985 sender.
22986 .ecindex IIDpiptra1
22987 .ecindex IIDpiptra2
22988
22989
22990 . ////////////////////////////////////////////////////////////////////////////
22991 . ////////////////////////////////////////////////////////////////////////////
22992
22993 .chapter "The smtp transport" "CHAPsmtptrans"
22994 .scindex IIDsmttra1 "transports" "&(smtp)&"
22995 .scindex IIDsmttra2 "&(smtp)& transport"
22996 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
22997 or LMTP protocol. The list of hosts to try can either be taken from the address
22998 that is being processed (having been set up by the router), or specified
22999 explicitly for the transport. Timeout and retry processing (see chapter
23000 &<<CHAPretry>>&) is applied to each IP address independently.
23001
23002
23003 .section "Multiple messages on a single connection" "SECID144"
23004 The sending of multiple messages over a single TCP/IP connection can arise in
23005 two ways:
23006
23007 .ilist
23008 If a message contains more than &%max_rcpt%& (see below) addresses that are
23009 routed to the same host, more than one copy of the message has to be sent to
23010 that host. In this situation, multiple copies may be sent in a single run of
23011 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23012 does when it has too many addresses to send in one message also depends on the
23013 value of the global &%remote_max_parallel%& option. Details are given in
23014 section &<<SECToutSMTPTCP>>&.)
23015 .next
23016 .cindex "hints database" "remembering routing"
23017 When a message has been successfully delivered over a TCP/IP connection, Exim
23018 looks in its hints database to see if there are any other messages awaiting a
23019 connection to the same host. If there are, a new delivery process is started
23020 for one of them, and the current TCP/IP connection is passed on to it. The new
23021 process may in turn send multiple copies and possibly create yet another
23022 process.
23023 .endlist
23024
23025
23026 For each copy sent over the same TCP/IP connection, a sequence counter is
23027 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23028 no further messages are sent over that connection.
23029
23030
23031
23032 .section "Use of the $host and $host_address variables" "SECID145"
23033 .vindex "&$host$&"
23034 .vindex "&$host_address$&"
23035 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23036 &$host_address$& are the name and IP address of the first host on the host list
23037 passed by the router. However, when the transport is about to connect to a
23038 specific host, and while it is connected to that host, &$host$& and
23039 &$host_address$& are set to the values for that host. These are the values
23040 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23041 &%serialize_hosts%&, and the various TLS options are expanded.
23042
23043
23044 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23045 .vindex &$tls_bits$&
23046 .vindex &$tls_cipher$&
23047 .vindex &$tls_peerdn$&
23048 .vindex &$tls_sni$&
23049 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23050 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23051 are the values that were set when the message was received.
23052 These are the values that are used for options that are expanded before any
23053 SMTP connections are made. Just before each connection is made, these four
23054 variables are emptied. If TLS is subsequently started, they are set to the
23055 appropriate values for the outgoing connection, and these are the values that
23056 are in force when any authenticators are run and when the
23057 &%authenticated_sender%& option is expanded.
23058
23059 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23060 and will be removed in a future release.
23061
23062
23063 .section "Private options for smtp" "SECID146"
23064 .cindex "options" "&(smtp)& transport"
23065 The private options of the &(smtp)& transport are as follows:
23066
23067
23068 .option address_retry_include_sender smtp boolean true
23069 .cindex "4&'xx'& responses" "retrying after"
23070 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23071 is the combination of sender and recipient that is delayed in subsequent queue
23072 runs until the retry time is reached. You can delay the recipient without
23073 reference to the sender (which is what earlier versions of Exim did), by
23074 setting &%address_retry_include_sender%& false. However, this can lead to
23075 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23076
23077 .option allow_localhost smtp boolean false
23078 .cindex "local host" "sending to"
23079 .cindex "fallback" "hosts specified on transport"
23080 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23081 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23082 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23083 the delivery anyway. This should be used only in special cases when the
23084 configuration ensures that no looping will result (for example, a differently
23085 configured Exim is listening on the port to which the message is sent).
23086
23087
23088 .option authenticated_sender smtp string&!! unset
23089 .cindex "Cyrus"
23090 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23091 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23092 overriding any existing authenticated sender value. If the string expansion is
23093 forced to fail, the option is ignored. Other expansion failures cause delivery
23094 to be deferred. If the result of expansion is an empty string, that is also
23095 ignored.
23096
23097 The expansion happens after the outgoing connection has been made and TLS
23098 started, if required. This means that the &$host$&, &$host_address$&,
23099 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23100 particular connection.
23101
23102 If the SMTP session is not authenticated, the expansion of
23103 &%authenticated_sender%& still happens (and can cause the delivery to be
23104 deferred if it fails), but no AUTH= item is added to MAIL commands
23105 unless &%authenticated_sender_force%& is true.
23106
23107 This option allows you to use the &(smtp)& transport in LMTP mode to
23108 deliver mail to Cyrus IMAP and provide the proper local part as the
23109 &"authenticated sender"&, via a setting such as:
23110 .code
23111 authenticated_sender = $local_part
23112 .endd
23113 This removes the need for IMAP subfolders to be assigned special ACLs to
23114 allow direct delivery to those subfolders.
23115
23116 Because of expected uses such as that just described for Cyrus (when no
23117 domain is involved), there is no checking on the syntax of the provided
23118 value.
23119
23120
23121 .option authenticated_sender_force smtp boolean false
23122 If this option is set true, the &%authenticated_sender%& option's value
23123 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23124 authenticated as a client.
23125
23126
23127 .option command_timeout smtp time 5m
23128 This sets a timeout for receiving a response to an SMTP command that has been
23129 sent out. It is also used when waiting for the initial banner line from the
23130 remote host. Its value must not be zero.
23131
23132
23133 .option connect_timeout smtp time 5m
23134 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23135 to a remote host. A setting of zero allows the system timeout (typically
23136 several minutes) to act. To have any effect, the value of this option must be
23137 less than the system timeout. However, it has been observed that on some
23138 systems there is no system timeout, which is why the default value for this
23139 option is 5 minutes, a value recommended by RFC 1123.
23140
23141
23142 .option connection_max_messages smtp integer 500
23143 .cindex "SMTP" "passed connection"
23144 .cindex "SMTP" "multiple deliveries"
23145 .cindex "multiple SMTP deliveries"
23146 This controls the maximum number of separate message deliveries that are sent
23147 over a single TCP/IP connection. If the value is zero, there is no limit.
23148 For testing purposes, this value can be overridden by the &%-oB%& command line
23149 option.
23150
23151
23152 .option data_timeout smtp time 5m
23153 This sets a timeout for the transmission of each block in the data portion of
23154 the message. As a result, the overall timeout for a message depends on the size
23155 of the message. Its value must not be zero. See also &%final_timeout%&.
23156
23157
23158 .option delay_after_cutoff smtp boolean true
23159 This option controls what happens when all remote IP addresses for a given
23160 domain have been inaccessible for so long that they have passed their retry
23161 cutoff times.
23162
23163 In the default state, if the next retry time has not been reached for any of
23164 them, the address is bounced without trying any deliveries. In other words,
23165 Exim delays retrying an IP address after the final cutoff time until a new
23166 retry time is reached, and can therefore bounce an address without ever trying
23167 a delivery, when machines have been down for a long time. Some people are
23168 unhappy at this prospect, so...
23169
23170 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23171 addresses are past their final cutoff time, Exim tries to deliver to those
23172 IP addresses that have not been tried since the message arrived. If there are
23173 none, of if they all fail, the address is bounced. In other words, it does not
23174 delay when a new message arrives, but immediately tries those expired IP
23175 addresses that haven't been tried since the message arrived. If there is a
23176 continuous stream of messages for the dead hosts, unsetting
23177 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23178 to them.
23179
23180
23181 .option dns_qualify_single smtp boolean true
23182 If the &%hosts%& or &%fallback_hosts%& option is being used,
23183 and the &%gethostbyname%& option is false,
23184 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23185 in chapter &<<CHAPdnslookup>>& for more details.
23186
23187
23188 .option dns_search_parents smtp boolean false
23189 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23190 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23191 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23192 details.
23193
23194
23195 .option dnssec_request_domains smtp "domain list&!!" unset
23196 .cindex "MX record" "security"
23197 .cindex "DNSSEC" "MX lookup"
23198 .cindex "security" "MX lookup"
23199 .cindex "DNS" "DNSSEC"
23200 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23201 the dnssec request bit set.
23202 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23203
23204
23205
23206 .option dnssec_require_domains smtp "domain list&!!" unset
23207 .cindex "MX record" "security"
23208 .cindex "DNSSEC" "MX lookup"
23209 .cindex "security" "MX lookup"
23210 .cindex "DNS" "DNSSEC"
23211 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23212 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23213 (AD bit) set wil be ignored and logged as a host-lookup failure.
23214 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23215
23216
23217
23218 .option dscp smtp string&!! unset
23219 .cindex "DCSP" "outbound"
23220 This option causes the DSCP value associated with a socket to be set to one
23221 of a number of fixed strings or to numeric value.
23222 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23223 Common values include &`throughput`&, &`mincost`&, and on newer systems
23224 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23225
23226 The outbound packets from Exim will be marked with this value in the header
23227 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23228 that these values will have any effect, not be stripped by networking
23229 equipment, or do much of anything without cooperation with your Network
23230 Engineer and those of all network operators between the source and destination.
23231
23232
23233 .option fallback_hosts smtp "string list" unset
23234 .cindex "fallback" "hosts specified on transport"
23235 String expansion is not applied to this option. The argument must be a
23236 colon-separated list of host names or IP addresses, optionally also including
23237 port numbers, though the separator can be changed, as described in section
23238 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23239 item in a &%route_list%& setting for the &(manualroute)& router, as described
23240 in section &<<SECTformatonehostitem>>&.
23241
23242 Fallback hosts can also be specified on routers, which associate them with the
23243 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23244 &%fallback_hosts%& specified on the transport is used only if the address does
23245 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23246 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23247 However, &%hosts_randomize%& does apply to fallback host lists.
23248
23249 If Exim is unable to deliver to any of the hosts for a particular address, and
23250 the errors are not permanent rejections, the address is put on a separate
23251 transport queue with its host list replaced by the fallback hosts, unless the
23252 address was routed via MX records and the current host was in the original MX
23253 list. In that situation, the fallback host list is not used.
23254
23255 Once normal deliveries are complete, the fallback queue is delivered by
23256 re-running the same transports with the new host lists. If several failing
23257 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23258 copy of the message is sent.
23259
23260 The resolution of the host names on the fallback list is controlled by the
23261 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23262 both to cases when the host list comes with the address and when it is taken
23263 from &%hosts%&. This option provides a &"use a smart host only if delivery
23264 fails"& facility.
23265
23266
23267 .option final_timeout smtp time 10m
23268 This is the timeout that applies while waiting for the response to the final
23269 line containing just &"."& that terminates a message. Its value must not be
23270 zero.
23271
23272 .option gethostbyname smtp boolean false
23273 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23274 being used, names are looked up using &[gethostbyname()]&
23275 (or &[getipnodebyname()]& when available)
23276 instead of using the DNS. Of course, that function may in fact use the DNS, but
23277 it may also consult other sources of information such as &_/etc/hosts_&.
23278
23279 .option gnutls_compat_mode smtp boolean unset
23280 This option controls whether GnuTLS is used in compatibility mode in an Exim
23281 server. This reduces security slightly, but improves interworking with older
23282 implementations of TLS.
23283
23284 .option helo_data smtp string&!! "see below"
23285 .cindex "HELO" "argument, setting"
23286 .cindex "EHLO" "argument, setting"
23287 .cindex "LHLO argument setting"
23288 The value of this option is expanded after a connection to a another host has
23289 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23290 command that starts the outgoing SMTP or LMTP session. The default value of the
23291 option is:
23292 .code
23293 $primary_hostname
23294 .endd
23295 During the expansion, the variables &$host$& and &$host_address$& are set to
23296 the identity of the remote host, and the variables &$sending_ip_address$& and
23297 &$sending_port$& are set to the local IP address and port number that are being
23298 used. These variables can be used to generate different values for different
23299 servers or different local IP addresses. For example, if you want the string
23300 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23301 interface address, you could use this:
23302 .code
23303 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23304   {$primary_hostname}}
23305 .endd
23306 The use of &%helo_data%& applies both to sending messages and when doing
23307 callouts.
23308
23309 .option hosts smtp "string list&!!" unset
23310 Hosts are associated with an address by a router such as &(dnslookup)&, which
23311 finds the hosts by looking up the address domain in the DNS, or by
23312 &(manualroute)&, which has lists of hosts in its configuration. However,
23313 email addresses can be passed to the &(smtp)& transport by any router, and not
23314 all of them can provide an associated list of hosts.
23315
23316 The &%hosts%& option specifies a list of hosts to be used if the address being
23317 processed does not have any hosts associated with it. The hosts specified by
23318 &%hosts%& are also used, whether or not the address has its own hosts, if
23319 &%hosts_override%& is set.
23320
23321 The string is first expanded, before being interpreted as a colon-separated
23322 list of host names or IP addresses, possibly including port numbers. The
23323 separator may be changed to something other than colon, as described in section
23324 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23325 item in a &%route_list%& setting for the &(manualroute)& router, as described
23326 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23327 of the &(manualroute)& router is not available here.
23328
23329 If the expansion fails, delivery is deferred. Unless the failure was caused by
23330 the inability to complete a lookup, the error is logged to the panic log as
23331 well as the main log. Host names are looked up either by searching directly for
23332 address records in the DNS or by calling &[gethostbyname()]& (or
23333 &[getipnodebyname()]& when available), depending on the setting of the
23334 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23335 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23336 address are used.
23337
23338 During delivery, the hosts are tried in order, subject to their retry status,
23339 unless &%hosts_randomize%& is set.
23340
23341
23342 .option hosts_avoid_esmtp smtp "host list&!!" unset
23343 .cindex "ESMTP, avoiding use of"
23344 .cindex "HELO" "forcing use of"
23345 .cindex "EHLO" "avoiding use of"
23346 .cindex "PIPELINING" "avoiding the use of"
23347 This option is for use with broken hosts that announce ESMTP facilities (for
23348 example, PIPELINING) and then fail to implement them properly. When a host
23349 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23350 start of the SMTP session. This means that it cannot use any of the ESMTP
23351 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23352
23353
23354 .option hosts_avoid_pipelining smtp "host list&!!" unset
23355 .cindex "PIPELINING" "avoiding the use of"
23356 Exim will not use the SMTP PIPELINING extension when delivering to any host
23357 that matches this list, even if the server host advertises PIPELINING support.
23358
23359
23360 .option hosts_avoid_tls smtp "host list&!!" unset
23361 .cindex "TLS" "avoiding for certain hosts"
23362 Exim will not try to start a TLS session when delivering to any host that
23363 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23364
23365 .new
23366 .option hosts_verify_avoid_tls smtp "host list&!!" unset
23367 .cindex "TLS" "avoiding for certain hosts"
23368 Exim will not try to start a TLS session for a verify callout,
23369 or when delivering in cutthrough mode,
23370 to any host that matches this list.
23371 .wen
23372
23373
23374 .option hosts_max_try smtp integer 5
23375 .cindex "host" "maximum number to try"
23376 .cindex "limit" "number of hosts tried"
23377 .cindex "limit" "number of MX tried"
23378 .cindex "MX record" "maximum tried"
23379 This option limits the number of IP addresses that are tried for any one
23380 delivery in cases where there are temporary delivery errors. Section
23381 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
23382
23383
23384 .option hosts_max_try_hardlimit smtp integer 50
23385 This is an additional check on the maximum number of IP addresses that Exim
23386 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
23387 why it exists.
23388
23389
23390
23391 .option hosts_nopass_tls smtp "host list&!!" unset
23392 .cindex "TLS" "passing connection"
23393 .cindex "multiple SMTP deliveries"
23394 .cindex "TLS" "multiple message deliveries"
23395 For any host that matches this list, a connection on which a TLS session has
23396 been started will not be passed to a new delivery process for sending another
23397 message on the same connection. See section &<<SECTmulmessam>>& for an
23398 explanation of when this might be needed.
23399
23400
23401 .option hosts_override smtp boolean false
23402 If this option is set and the &%hosts%& option is also set, any hosts that are
23403 attached to the address are ignored, and instead the hosts specified by the
23404 &%hosts%& option are always used. This option does not apply to
23405 &%fallback_hosts%&.
23406
23407
23408 .option hosts_randomize smtp boolean false
23409 .cindex "randomized host list"
23410 .cindex "host" "list of; randomized"
23411 .cindex "fallback" "randomized hosts"
23412 If this option is set, and either the list of hosts is taken from the
23413 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
23414 were not obtained from MX records (this includes fallback hosts from the
23415 router), and were not randomized by the router, the order of trying the hosts
23416 is randomized each time the transport runs. Randomizing the order of a host
23417 list can be used to do crude load sharing.
23418
23419 When &%hosts_randomize%& is true, a host list may be split into groups whose
23420 order is separately randomized. This makes it possible to set up MX-like
23421 behaviour. The boundaries between groups are indicated by an item that is just
23422 &`+`& in the host list. For example:
23423 .code
23424 hosts = host1:host2:host3:+:host4:host5
23425 .endd
23426 The order of the first three hosts and the order of the last two hosts is
23427 randomized for each use, but the first three always end up before the last two.
23428 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
23429
23430 .option hosts_require_auth smtp "host list&!!" unset
23431 .cindex "authentication" "required by client"
23432 This option provides a list of servers for which authentication must succeed
23433 before Exim will try to transfer a message. If authentication fails for
23434 servers which are not in this list, Exim tries to send unauthenticated. If
23435 authentication fails for one of these servers, delivery is deferred. This
23436 temporary error is detectable in the retry rules, so it can be turned into a
23437 hard failure if required. See also &%hosts_try_auth%&, and chapter
23438 &<<CHAPSMTPAUTH>>& for details of authentication.
23439
23440
23441 .option hosts_request_ocsp smtp "host list&!!" *
23442 .cindex "TLS" "requiring for certain servers"
23443 Exim will request a Certificate Status on a
23444 TLS session for any host that matches this list.
23445 &%tls_verify_certificates%& should also be set for the transport.
23446
23447 .option hosts_require_ocsp smtp "host list&!!" unset
23448 .cindex "TLS" "requiring for certain servers"
23449 Exim will request, and check for a valid Certificate Status being given, on a
23450 TLS session for any host that matches this list.
23451 &%tls_verify_certificates%& should also be set for the transport.
23452
23453 .option hosts_require_tls smtp "host list&!!" unset
23454 .cindex "TLS" "requiring for certain servers"
23455 Exim will insist on using a TLS session when delivering to any host that
23456 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23457 &*Note*&: This option affects outgoing mail only. To insist on TLS for
23458 incoming messages, use an appropriate ACL.
23459
23460 .option hosts_try_auth smtp "host list&!!" unset
23461 .cindex "authentication" "optional in client"
23462 This option provides a list of servers to which, provided they announce
23463 authentication support, Exim will attempt to authenticate as a client when it
23464 connects. If authentication fails, Exim will try to transfer the message
23465 unauthenticated. See also &%hosts_require_auth%&, and chapter
23466 &<<CHAPSMTPAUTH>>& for details of authentication.
23467
23468 .new
23469 .option hosts_try_prdr smtp "host list&!!" *
23470 .cindex "PRDR" "enabling, optional in client"
23471 This option provides a list of servers to which, provided they announce
23472 PRDR support, Exim will attempt to negotiate PRDR
23473 for multi-recipient messages.
23474 The option can usually be left as default.
23475 .wen
23476
23477 .option interface smtp "string list&!!" unset
23478 .cindex "bind IP address"
23479 .cindex "IP address" "binding"
23480 .vindex "&$host$&"
23481 .vindex "&$host_address$&"
23482 This option specifies which interface to bind to when making an outgoing SMTP
23483 call. The value is an IP address, not an interface name such as
23484 &`eth0`&. Do not confuse this with the interface address that was used when a
23485 message was received, which is in &$received_ip_address$&, formerly known as
23486 &$interface_address$&. The name was changed to minimize confusion with the
23487 outgoing interface address. There is no variable that contains an outgoing
23488 interface address because, unless it is set by this option, its value is
23489 unknown.
23490
23491 During the expansion of the &%interface%& option the variables &$host$& and
23492 &$host_address$& refer to the host to which a connection is about to be made
23493 during the expansion of the string. Forced expansion failure, or an empty
23494 string result causes the option to be ignored. Otherwise, after expansion, the
23495 string must be a list of IP addresses, colon-separated by default, but the
23496 separator can be changed in the usual way. For example:
23497 .code
23498 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
23499 .endd
23500 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
23501 connection. If none of them are the correct type, the option is ignored. If
23502 &%interface%& is not set, or is ignored, the system's IP functions choose which
23503 interface to use if the host has more than one.
23504
23505
23506 .option keepalive smtp boolean true
23507 .cindex "keepalive" "on outgoing connection"
23508 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
23509 connections. When set, it causes the kernel to probe idle connections
23510 periodically, by sending packets with &"old"& sequence numbers. The other end
23511 of the connection should send a acknowledgment if the connection is still okay
23512 or a reset if the connection has been aborted. The reason for doing this is
23513 that it has the beneficial effect of freeing up certain types of connection
23514 that can get stuck when the remote host is disconnected without tidying up the
23515 TCP/IP call properly. The keepalive mechanism takes several hours to detect
23516 unreachable hosts.
23517
23518
23519 .option lmtp_ignore_quota smtp boolean false
23520 .cindex "LMTP" "ignoring quota errors"
23521 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
23522 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
23523 has advertised support for IGNOREQUOTA in its response to the LHLO command.
23524
23525 .option max_rcpt smtp integer 100
23526 .cindex "RCPT" "maximum number of outgoing"
23527 This option limits the number of RCPT commands that are sent in a single
23528 SMTP message transaction. Each set of addresses is treated independently, and
23529 so can cause parallel connections to the same host if &%remote_max_parallel%&
23530 permits this.
23531
23532
23533 .option multi_domain smtp boolean&!! true
23534 .vindex "&$domain$&"
23535 When this option is set, the &(smtp)& transport can handle a number of
23536 addresses containing a mixture of different domains provided they all resolve
23537 to the same list of hosts. Turning the option off restricts the transport to
23538 handling only one domain at a time. This is useful if you want to use
23539 &$domain$& in an expansion for the transport, because it is set only when there
23540 is a single domain involved in a remote delivery.
23541
23542 .new
23543 It is expanded per-address and can depend on any of
23544 &$address_data$&, &$domain_data$&, &$local_part_data$&,
23545 &$host$&, &$host_address$& and &$host_port$&.
23546 .wen
23547
23548 .option port smtp string&!! "see below"
23549 .cindex "port" "sending TCP/IP"
23550 .cindex "TCP/IP" "setting outgoing port"
23551 This option specifies the TCP/IP port on the server to which Exim connects.
23552 &*Note:*& Do not confuse this with the port that was used when a message was
23553 received, which is in &$received_port$&, formerly known as &$interface_port$&.
23554 The name was changed to minimize confusion with the outgoing port. There is no
23555 variable that contains an outgoing port.
23556
23557 If the value of this option begins with a digit it is taken as a port number;
23558 otherwise it is looked up using &[getservbyname()]&. The default value is
23559 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
23560 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
23561 is deferred.
23562
23563
23564
23565 .option protocol smtp string smtp
23566 .cindex "LMTP" "over TCP/IP"
23567 .cindex "ssmtp protocol" "outbound"
23568 .cindex "TLS" "SSL-on-connect outbound"
23569 .vindex "&$port$&"
23570 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
23571 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
23572 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
23573 deliveries into closed message stores. Exim also has support for running LMTP
23574 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
23575
23576 If this option is set to &"smtps"&, the default vaule for the &%port%& option
23577 changes to &"smtps"&, and the transport initiates TLS immediately after
23578 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
23579 The Internet standards bodies strongly discourage use of this mode.
23580
23581
23582 .option retry_include_ip_address smtp boolean&!! true
23583 Exim normally includes both the host name and the IP address in the key it
23584 constructs for indexing retry data after a temporary delivery failure. This
23585 means that when one of several IP addresses for a host is failing, it gets
23586 tried periodically (controlled by the retry rules), but use of the other IP
23587 addresses is not affected.
23588
23589 However, in some dialup environments hosts are assigned a different IP address
23590 each time they connect. In this situation the use of the IP address as part of
23591 the retry key leads to undesirable behaviour. Setting this option false causes
23592 Exim to use only the host name.
23593 .new
23594 Since it is expanded it can be made to depend on the host or domain.
23595 .wen
23596
23597
23598 .option serialize_hosts smtp "host list&!!" unset
23599 .cindex "serializing connections"
23600 .cindex "host" "serializing connections"
23601 Because Exim operates in a distributed manner, if several messages for the same
23602 host arrive at around the same time, more than one simultaneous connection to
23603 the remote host can occur. This is not usually a problem except when there is a
23604 slow link between the hosts. In that situation it may be helpful to restrict
23605 Exim to one connection at a time. This can be done by setting
23606 &%serialize_hosts%& to match the relevant hosts.
23607
23608 .cindex "hints database" "serializing deliveries to a host"
23609 Exim implements serialization by means of a hints database in which a record is
23610 written whenever a process connects to one of the restricted hosts. The record
23611 is deleted when the connection is completed. Obviously there is scope for
23612 records to get left lying around if there is a system or program crash. To
23613 guard against this, Exim ignores any records that are more than six hours old.
23614
23615 If you set up this kind of serialization, you should also arrange to delete the
23616 relevant hints database whenever your system reboots. The names of the files
23617 start with &_misc_& and they are kept in the &_spool/db_& directory. There
23618 may be one or two files, depending on the type of DBM in use. The same files
23619 are used for ETRN serialization.
23620
23621
23622 .option size_addition smtp integer 1024
23623 .cindex "SMTP" "SIZE"
23624 .cindex "message" "size issue for transport filter"
23625 .cindex "size" "of message"
23626 .cindex "transport" "filter"
23627 .cindex "filter" "transport filter"
23628 If a remote SMTP server indicates that it supports the SIZE option of the
23629 MAIL command, Exim uses this to pass over the message size at the start of
23630 an SMTP transaction. It adds the value of &%size_addition%& to the value it
23631 sends, to allow for headers and other text that may be added during delivery by
23632 configuration options or in a transport filter. It may be necessary to increase
23633 this if a lot of text is added to messages.
23634
23635 Alternatively, if the value of &%size_addition%& is set negative, it disables
23636 the use of the SIZE option altogether.
23637
23638
23639 .option tls_certificate smtp string&!! unset
23640 .cindex "TLS" "client certificate, location of"
23641 .cindex "certificate" "client, location of"
23642 .vindex "&$host$&"
23643 .vindex "&$host_address$&"
23644 The value of this option must be the absolute path to a file which contains the
23645 client's certificate, for possible use when sending a message over an encrypted
23646 connection. The values of &$host$& and &$host_address$& are set to the name and
23647 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
23648 details of TLS.
23649
23650 &*Note*&: This option must be set if you want Exim to be able to use a TLS
23651 certificate when sending messages as a client. The global option of the same
23652 name specifies the certificate for Exim as a server; it is not automatically
23653 assumed that the same certificate should be used when Exim is operating as a
23654 client.
23655
23656
23657 .option tls_crl smtp string&!! unset
23658 .cindex "TLS" "client certificate revocation list"
23659 .cindex "certificate" "revocation list for client"
23660 This option specifies a certificate revocation list. The expanded value must
23661 be the name of a file that contains a CRL in PEM format.
23662
23663
23664 .option tls_dh_min_bits smtp integer 1024
23665 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
23666 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
23667 key agreement is negotiated, the server will provide a large prime number
23668 for use.  This option establishes the minimum acceptable size of that number.
23669 If the parameter offered by the server is too small, then the TLS handshake
23670 will fail.
23671
23672 Only supported when using GnuTLS.
23673
23674
23675 .option tls_privatekey smtp string&!! unset
23676 .cindex "TLS" "client private key, location of"
23677 .vindex "&$host$&"
23678 .vindex "&$host_address$&"
23679 The value of this option must be the absolute path to a file which contains the
23680 client's private key. This is used when sending a message over an encrypted
23681 connection using a client certificate. The values of &$host$& and
23682 &$host_address$& are set to the name and address of the server during the
23683 expansion. If this option is unset, or the expansion is forced to fail, or the
23684 result is an empty string, the private key is assumed to be in the same file as
23685 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
23686
23687
23688 .option tls_require_ciphers smtp string&!! unset
23689 .cindex "TLS" "requiring specific ciphers"
23690 .cindex "cipher" "requiring specific"
23691 .vindex "&$host$&"
23692 .vindex "&$host_address$&"
23693 The value of this option must be a list of permitted cipher suites, for use
23694 when setting up an outgoing encrypted connection. (There is a global option of
23695 the same name for controlling incoming connections.) The values of &$host$& and
23696 &$host_address$& are set to the name and address of the server during the
23697 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
23698 is used in different ways by OpenSSL and GnuTLS (see sections
23699 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
23700 ciphers is a preference order.
23701
23702
23703
23704 .option tls_sni smtp string&!! unset
23705 .cindex "TLS" "Server Name Indication"
23706 .vindex "&$tls_sni$&"
23707 If this option is set then it sets the $tls_out_sni variable and causes any
23708 TLS session to pass this value as the Server Name Indication extension to
23709 the remote side, which can be used by the remote side to select an appropriate
23710 certificate and private key for the session.
23711
23712 See &<<SECTtlssni>>& for more information.
23713
23714 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
23715 TLS extensions.
23716
23717
23718
23719
23720 .option tls_tempfail_tryclear smtp boolean true
23721 .cindex "4&'xx'& responses" "to STARTTLS"
23722 When the server host is not in &%hosts_require_tls%&, and there is a problem in
23723 setting up a TLS session, this option determines whether or not Exim should try
23724 to deliver the message unencrypted. If it is set false, delivery to the
23725 current host is deferred; if there are other hosts, they are tried. If this
23726 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
23727 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
23728 TLS negotiation fails, Exim closes the current connection (because it is in an
23729 unknown state), opens a new one to the same host, and then tries the delivery
23730 in clear.
23731
23732
23733 .new
23734 .option tls_try_verify_hosts smtp "host list&!!" *
23735 .wen
23736 .cindex "TLS" "server certificate verification"
23737 .cindex "certificate" "verification of server"
23738 This option gives a list of hosts for which, on encrypted connections,
23739 certificate verification will be tried but need not succeed.
23740 The &%tls_verify_certificates%& option must also be set.
23741 Note that unless the host is in this list
23742 TLS connections will be denied to hosts using self-signed certificates
23743 when &%tls_verify_certificates%& is matched.
23744 The &$tls_out_certificate_verified$& variable is set when
23745 certificate verification succeeds.
23746
23747
23748 .new
23749 .option tls_verify_cert_hostnames smtp "host list&!!" *
23750 .cindex "TLS" "server certificate hostname verification"
23751 .cindex "certificate" "verification of server"
23752 This option give a list of hosts for which,
23753 while verifying the server certificate,
23754 checks will be included on the host name
23755 (note that this will generally be the result of a DNS MX lookup)
23756 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
23757 limited to being the initial component of a 3-or-more component FQDN.
23758
23759 There is no equivalent checking on client certificates.
23760 .wen
23761
23762
23763 .new
23764 .option tls_verify_certificates smtp string&!! system
23765 .cindex "TLS" "server certificate verification"
23766 .cindex "certificate" "verification of server"
23767 .vindex "&$host$&"
23768 .vindex "&$host_address$&"
23769 The value of this option must be either the
23770 word "system"
23771 or the absolute path to
23772 a file or directory containing permitted certificates for servers,
23773 for use when setting up an encrypted connection.
23774
23775 The "system" value for the option will use a location compiled into the SSL library.
23776 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
23777 is taken as empty and an explicit location
23778 must be specified.
23779
23780 The use of a directory for the option value is not avilable for GnuTLS versions
23781 preceding 3.3.6 and a single file must be used.
23782 .wen
23783
23784 With OpenSSL the certificates specified
23785 explicitly
23786 either by file or directory
23787 are added to those given by the system default location.
23788
23789 The values of &$host$& and
23790 &$host_address$& are set to the name and address of the server during the
23791 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
23792
23793 For back-compatability,
23794 if neither tls_verify_hosts nor tls_try_verify_hosts are set
23795 (a single-colon empty list counts as being set)
23796 and certificate verification fails the TLS connection is closed.
23797
23798
23799 .option tls_verify_hosts smtp "host list&!!" unset
23800 .cindex "TLS" "server certificate verification"
23801 .cindex "certificate" "verification of server"
23802 This option gives a list of hosts for which. on encrypted connections,
23803 certificate verification must succeed.
23804 The &%tls_verify_certificates%& option must also be set.
23805 If both this option and &%tls_try_verify_hosts%& are unset
23806 operation is as if this option selected all hosts.
23807
23808
23809
23810
23811 .section "How the limits for the number of hosts to try are used" &&&
23812          "SECTvalhosmax"
23813 .cindex "host" "maximum number to try"
23814 .cindex "limit" "hosts; maximum number tried"
23815 There are two options that are concerned with the number of hosts that are
23816 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
23817 &%hosts_max_try_hardlimit%&.
23818
23819
23820 The &%hosts_max_try%& option limits the number of hosts that are tried
23821 for a single delivery. However, despite the term &"host"& in its name, the
23822 option actually applies to each IP address independently. In other words, a
23823 multihomed host is treated as several independent hosts, just as it is for
23824 retrying.
23825
23826 Many of the larger ISPs have multiple MX records which often point to
23827 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
23828 created as a result of routing one of these domains.
23829
23830 Trying every single IP address on such a long list does not seem sensible; if
23831 several at the top of the list fail, it is reasonable to assume there is some
23832 problem that is likely to affect all of them. Roughly speaking, the value of
23833 &%hosts_max_try%& is the maximum number that are tried before deferring the
23834 delivery. However, the logic cannot be quite that simple.
23835
23836 Firstly, IP addresses that are skipped because their retry times have not
23837 arrived do not count, and in addition, addresses that are past their retry
23838 limits are also not counted, even when they are tried. This means that when
23839 some IP addresses are past their retry limits, more than the value of
23840 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
23841 that all IP addresses are considered before timing out an email address (but
23842 see below for an exception).
23843
23844 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
23845 list to see if there is a subsequent host with a different (higher valued) MX.
23846 If there is, that host is considered next, and the current IP address is used
23847 but not counted. This behaviour helps in the case of a domain with a retry rule
23848 that hardly ever delays any hosts, as is now explained:
23849
23850 Consider the case of a long list of hosts with one MX value, and a few with a
23851 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
23852 hosts at the top of the list are tried at first. With the default retry rule,
23853 which specifies increasing retry times, the higher MX hosts are eventually
23854 tried when those at the top of the list are skipped because they have not
23855 reached their retry times.
23856
23857 However, it is common practice to put a fixed short retry time on domains for
23858 large ISPs, on the grounds that their servers are rarely down for very long.
23859 Unfortunately, these are exactly the domains that tend to resolve to long lists
23860 of hosts. The short retry time means that the lowest MX hosts are tried every
23861 time. The attempts may be in a different order because of random sorting, but
23862 without the special MX check, the higher MX hosts would never be tried until
23863 all the lower MX hosts had timed out (which might be several days), because
23864 there are always some lower MX hosts that have reached their retry times. With
23865 the special check, Exim considers at least one IP address from each MX value at
23866 every delivery attempt, even if the &%hosts_max_try%& limit has already been
23867 reached.
23868
23869 The above logic means that &%hosts_max_try%& is not a hard limit, and in
23870 particular, Exim normally eventually tries all the IP addresses before timing
23871 out an email address. When &%hosts_max_try%& was implemented, this seemed a
23872 reasonable thing to do. Recently, however, some lunatic DNS configurations have
23873 been set up with hundreds of IP addresses for some domains. It can
23874 take a very long time indeed for an address to time out in these cases.
23875
23876 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
23877 Exim never tries more than this number of IP addresses; if it hits this limit
23878 and they are all timed out, the email address is bounced, even though not all
23879 possible IP addresses have been tried.
23880 .ecindex IIDsmttra1
23881 .ecindex IIDsmttra2
23882
23883
23884
23885
23886
23887 . ////////////////////////////////////////////////////////////////////////////
23888 . ////////////////////////////////////////////////////////////////////////////
23889
23890 .chapter "Address rewriting" "CHAPrewrite"
23891 .scindex IIDaddrew "rewriting" "addresses"
23892 There are some circumstances in which Exim automatically rewrites domains in
23893 addresses. The two most common are when an address is given without a domain
23894 (referred to as an &"unqualified address"&) or when an address contains an
23895 abbreviated domain that is expanded by DNS lookup.
23896
23897 Unqualified envelope addresses are accepted only for locally submitted
23898 messages, or for messages that are received from hosts matching
23899 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
23900 appropriate. Unqualified addresses in header lines are qualified if they are in
23901 locally submitted messages, or messages from hosts that are permitted to send
23902 unqualified envelope addresses. Otherwise, unqualified addresses in header
23903 lines are neither qualified nor rewritten.
23904
23905 One situation in which Exim does &'not'& automatically rewrite a domain is
23906 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
23907 such a domain should be rewritten using the &"canonical"& name, and some MTAs
23908 do this. The new RFCs do not contain this suggestion.
23909
23910
23911 .section "Explicitly configured address rewriting" "SECID147"
23912 This chapter describes the rewriting rules that can be used in the
23913 main rewrite section of the configuration file, and also in the generic
23914 &%headers_rewrite%& option that can be set on any transport.
23915
23916 Some people believe that configured address rewriting is a Mortal Sin.
23917 Others believe that life is not possible without it. Exim provides the
23918 facility; you do not have to use it.
23919
23920 The main rewriting rules that appear in the &"rewrite"& section of the
23921 configuration file are applied to addresses in incoming messages, both envelope
23922 addresses and addresses in header lines. Each rule specifies the types of
23923 address to which it applies.
23924
23925 Whether or not addresses in header lines are rewritten depends on the origin of
23926 the headers and the type of rewriting. Global rewriting, that is, rewriting
23927 rules from the rewrite section of the configuration file, is applied only to
23928 those headers that were received with the message. Header lines that are added
23929 by ACLs or by a system filter or by individual routers or transports (which
23930 are specific to individual recipient addresses) are not rewritten by the global
23931 rules.
23932
23933 Rewriting at transport time, by means of the &%headers_rewrite%& option,
23934 applies all headers except those added by routers and transports. That is, as
23935 well as the headers that were received with the message, it also applies to
23936 headers that were added by an ACL or a system filter.
23937
23938
23939 In general, rewriting addresses from your own system or domain has some
23940 legitimacy. Rewriting other addresses should be done only with great care and
23941 in special circumstances. The author of Exim believes that rewriting should be
23942 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
23943 Although it can sometimes be used as a routing tool, this is very strongly
23944 discouraged.
23945
23946 There are two commonly encountered circumstances where rewriting is used, as
23947 illustrated by these examples:
23948
23949 .ilist
23950 The company whose domain is &'hitch.fict.example'& has a number of hosts that
23951 exchange mail with each other behind a firewall, but there is only a single
23952 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
23953 &'hitch.fict.example'& when sending mail off-site.
23954 .next
23955 A host rewrites the local parts of its own users so that, for example,
23956 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
23957 .endlist
23958
23959
23960
23961 .section "When does rewriting happen?" "SECID148"
23962 .cindex "rewriting" "timing of"
23963 .cindex "&ACL;" "rewriting addresses in"
23964 Configured address rewriting can take place at several different stages of a
23965 message's processing.
23966
23967 .vindex "&$sender_address$&"
23968 At the start of an ACL for MAIL, the sender address may have been rewritten
23969 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
23970 ordinary rewrite rules have yet been applied. If, however, the sender address
23971 is verified in the ACL, it is rewritten before verification, and remains
23972 rewritten thereafter. The subsequent value of &$sender_address$& is the
23973 rewritten address. This also applies if sender verification happens in a
23974 RCPT ACL. Otherwise, when the sender address is not verified, it is
23975 rewritten as soon as a message's header lines have been received.
23976
23977 .vindex "&$domain$&"
23978 .vindex "&$local_part$&"
23979 Similarly, at the start of an ACL for RCPT, the current recipient's address
23980 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
23981 rewrite rules have yet been applied to it. However, the behaviour is different
23982 from the sender address when a recipient is verified. The address is rewritten
23983 for the verification, but the rewriting is not remembered at this stage. The
23984 value of &$local_part$& and &$domain$& after verification are always the same
23985 as they were before (that is, they contain the unrewritten &-- except for
23986 SMTP-time rewriting &-- address).
23987
23988 As soon as a message's header lines have been received, all the envelope
23989 recipient addresses are permanently rewritten, and rewriting is also applied to
23990 the addresses in the header lines (if configured). This happens before adding
23991 any header lines that were specified in MAIL or RCPT ACLs, and
23992 .cindex "&[local_scan()]& function" "address rewriting; timing of"
23993 before the DATA ACL and &[local_scan()]& functions are run.
23994
23995 When an address is being routed, either for delivery or for verification,
23996 rewriting is applied immediately to child addresses that are generated by
23997 redirection, unless &%no_rewrite%& is set on the router.
23998
23999 .cindex "envelope sender" "rewriting at transport time"
24000 .cindex "rewriting" "at transport time"
24001 .cindex "header lines" "rewriting at transport time"
24002 At transport time, additional rewriting of addresses in header lines can be
24003 specified by setting the generic &%headers_rewrite%& option on a transport.
24004 This option contains rules that are identical in form to those in the rewrite
24005 section of the configuration file. They are applied to the original message
24006 header lines and any that were added by ACLs or a system filter. They are not
24007 applied to header lines that are added by routers or the transport.
24008
24009 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24010 transport option. However, it is not possible to rewrite envelope recipients at
24011 transport time.
24012
24013
24014
24015
24016 .section "Testing the rewriting rules that apply on input" "SECID149"
24017 .cindex "rewriting" "testing"
24018 .cindex "testing" "rewriting"
24019 Exim's input rewriting configuration appears in a part of the run time
24020 configuration file headed by &"begin rewrite"&. It can be tested by the
24021 &%-brw%& command line option. This takes an address (which can be a full RFC
24022 2822 address) as its argument. The output is a list of how the address would be
24023 transformed by the rewriting rules for each of the different places it might
24024 appear in an incoming message, that is, for each different header and for the
24025 envelope sender and recipient fields. For example,
24026 .code
24027 exim -brw ph10@exim.workshop.example
24028 .endd
24029 might produce the output
24030 .code
24031 sender: Philip.Hazel@exim.workshop.example
24032 from: Philip.Hazel@exim.workshop.example
24033 to: ph10@exim.workshop.example
24034 cc: ph10@exim.workshop.example
24035 bcc: ph10@exim.workshop.example
24036 reply-to: Philip.Hazel@exim.workshop.example
24037 env-from: Philip.Hazel@exim.workshop.example
24038 env-to: ph10@exim.workshop.example
24039 .endd
24040 which shows that rewriting has been set up for that address when used in any of
24041 the source fields, but not when it appears as a recipient address. At the
24042 present time, there is no equivalent way of testing rewriting rules that are
24043 set for a particular transport.
24044
24045
24046 .section "Rewriting rules" "SECID150"
24047 .cindex "rewriting" "rules"
24048 The rewrite section of the configuration file consists of lines of rewriting
24049 rules in the form
24050 .display
24051 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24052 .endd
24053 Rewriting rules that are specified for the &%headers_rewrite%& generic
24054 transport option are given as a colon-separated list. Each item in the list
24055 takes the same form as a line in the main rewriting configuration (except that
24056 any colons must be doubled, of course).
24057
24058 The formats of source patterns and replacement strings are described below.
24059 Each is terminated by white space, unless enclosed in double quotes, in which
24060 case normal quoting conventions apply inside the quotes. The flags are single
24061 characters which may appear in any order. Spaces and tabs between them are
24062 ignored.
24063
24064 For each address that could potentially be rewritten, the rules are scanned in
24065 order, and replacements for the address from earlier rules can themselves be
24066 replaced by later rules (but see the &"q"& and &"R"& flags).
24067
24068 The order in which addresses are rewritten is undefined, may change between
24069 releases, and must not be relied on, with one exception: when a message is
24070 received, the envelope sender is always rewritten first, before any header
24071 lines are rewritten. For example, the replacement string for a rewrite of an
24072 address in &'To:'& must not assume that the message's address in &'From:'& has
24073 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24074 that the envelope sender has already been rewritten.
24075
24076 .vindex "&$domain$&"
24077 .vindex "&$local_part$&"
24078 The variables &$local_part$& and &$domain$& can be used in the replacement
24079 string to refer to the address that is being rewritten. Note that lookup-driven
24080 rewriting can be done by a rule of the form
24081 .code
24082 *@*   ${lookup ...
24083 .endd
24084 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24085 refer to the address that is being rewritten.
24086
24087
24088 .section "Rewriting patterns" "SECID151"
24089 .cindex "rewriting" "patterns"
24090 .cindex "address list" "in a rewriting pattern"
24091 The source pattern in a rewriting rule is any item which may appear in an
24092 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24093 single-item address list, which means that it is expanded before being tested
24094 against the address. As always, if you use a regular expression as a pattern,
24095 you must take care to escape dollar and backslash characters, or use the &`\N`&
24096 facility to suppress string expansion within the regular expression.
24097
24098 Domains in patterns should be given in lower case. Local parts in patterns are
24099 case-sensitive. If you want to do case-insensitive matching of local parts, you
24100 can use a regular expression that starts with &`^(?i)`&.
24101
24102 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24103 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24104 depending on the type of match which occurred. These can be used in the
24105 replacement string to insert portions of the incoming address. &$0$& always
24106 refers to the complete incoming address. When a regular expression is used, the
24107 numerical variables are set from its capturing subexpressions. For other types
24108 of pattern they are set as follows:
24109
24110 .ilist
24111 If a local part or domain starts with an asterisk, the numerical variables
24112 refer to the character strings matched by asterisks, with &$1$& associated with
24113 the first asterisk, and &$2$& with the second, if present. For example, if the
24114 pattern
24115 .code
24116 *queen@*.fict.example
24117 .endd
24118 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24119 .code
24120 $0 = hearts-queen@wonderland.fict.example
24121 $1 = hearts-
24122 $2 = wonderland
24123 .endd
24124 Note that if the local part does not start with an asterisk, but the domain
24125 does, it is &$1$& that contains the wild part of the domain.
24126
24127 .next
24128 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24129 of the domain are placed in the next available numerical variables. Suppose,
24130 for example, that the address &'foo@bar.baz.example'& is processed by a
24131 rewriting rule of the form
24132 .display
24133 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24134 .endd
24135 and the key in the file that matches the domain is &`*.baz.example`&. Then
24136 .code
24137 $1 = foo
24138 $2 = bar
24139 $3 = baz.example
24140 .endd
24141 If the address &'foo@baz.example'& is looked up, this matches the same
24142 wildcard file entry, and in this case &$2$& is set to the empty string, but
24143 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24144 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24145 whole domain. For non-partial domain lookups, no numerical variables are set.
24146 .endlist
24147
24148
24149 .section "Rewriting replacements" "SECID152"
24150 .cindex "rewriting" "replacements"
24151 If the replacement string for a rule is a single asterisk, addresses that
24152 match the pattern and the flags are &'not'& rewritten, and no subsequent
24153 rewriting rules are scanned. For example,
24154 .code
24155 hatta@lookingglass.fict.example  *  f
24156 .endd
24157 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24158 &'From:'& headers.
24159
24160 .vindex "&$domain$&"
24161 .vindex "&$local_part$&"
24162 If the replacement string is not a single asterisk, it is expanded, and must
24163 yield a fully qualified address. Within the expansion, the variables
24164 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24165 Any letters they contain retain their original case &-- they are not lower
24166 cased. The numerical variables are set up according to the type of pattern that
24167 matched the address, as described above. If the expansion is forced to fail by
24168 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24169 current rule is abandoned, but subsequent rules may take effect. Any other
24170 expansion failure causes the entire rewriting operation to be abandoned, and an
24171 entry written to the panic log.
24172
24173
24174
24175 .section "Rewriting flags" "SECID153"
24176 There are three different kinds of flag that may appear on rewriting rules:
24177
24178 .ilist
24179 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24180 c, f, h, r, s, t.
24181 .next
24182 A flag that specifies rewriting at SMTP time: S.
24183 .next
24184 Flags that control the rewriting process: Q, q, R, w.
24185 .endlist
24186
24187 For rules that are part of the &%headers_rewrite%& generic transport option,
24188 E, F, T, and S are not permitted.
24189
24190
24191
24192 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24193          "SECID154"
24194 .cindex "rewriting" "flags"
24195 If none of the following flag letters, nor the &"S"& flag (see section
24196 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24197 and to both the sender and recipient fields of the envelope, whereas a
24198 transport-time rewriting rule just applies to all headers. Otherwise, the
24199 rewriting rule is skipped unless the relevant addresses are being processed.
24200 .display
24201 &`E`&       rewrite all envelope fields
24202 &`F`&       rewrite the envelope From field
24203 &`T`&       rewrite the envelope To field
24204 &`b`&       rewrite the &'Bcc:'& header
24205 &`c`&       rewrite the &'Cc:'& header
24206 &`f`&       rewrite the &'From:'& header
24207 &`h`&       rewrite all headers
24208 &`r`&       rewrite the &'Reply-To:'& header
24209 &`s`&       rewrite the &'Sender:'& header
24210 &`t`&       rewrite the &'To:'& header
24211 .endd
24212 "All headers" means all of the headers listed above that can be selected
24213 individually, plus their &'Resent-'& versions. It does not include
24214 other headers such as &'Subject:'& etc.
24215
24216 You should be particularly careful about rewriting &'Sender:'& headers, and
24217 restrict this to special known cases in your own domains.
24218
24219
24220 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24221 .cindex "SMTP" "rewriting malformed addresses"
24222 .cindex "RCPT" "rewriting argument of"
24223 .cindex "MAIL" "rewriting argument of"
24224 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24225 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24226 before any other processing; even before syntax checking. The pattern is
24227 required to be a regular expression, and it is matched against the whole of the
24228 data for the command, including any surrounding angle brackets.
24229
24230 .vindex "&$domain$&"
24231 .vindex "&$local_part$&"
24232 This form of rewrite rule allows for the handling of addresses that are not
24233 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24234 input). Because the input is not required to be a syntactically valid address,
24235 the variables &$local_part$& and &$domain$& are not available during the
24236 expansion of the replacement string. The result of rewriting replaces the
24237 original address in the MAIL or RCPT command.
24238
24239
24240 .section "Flags controlling the rewriting process" "SECID155"
24241 There are four flags which control the way the rewriting process works. These
24242 take effect only when a rule is invoked, that is, when the address is of the
24243 correct type (matches the flags) and matches the pattern:
24244
24245 .ilist
24246 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24247 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24248 absence of &"Q"& the rewritten address must always include a domain.
24249 .next
24250 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24251 even if no rewriting actually takes place because of a &"fail"& in the
24252 expansion. The &"q"& flag is not effective if the address is of the wrong type
24253 (does not match the flags) or does not match the pattern.
24254 .next
24255 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24256 address, up to ten times. It can be combined with the &"q"& flag, to stop
24257 rewriting once it fails to match (after at least one successful rewrite).
24258 .next
24259 .cindex "rewriting" "whole addresses"
24260 When an address in a header is rewritten, the rewriting normally applies only
24261 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24262 left unchanged. For example, rewriting might change
24263 .code
24264 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24265 .endd
24266 into
24267 .code
24268 From: Ford Prefect <prefectf@hitch.fict.example>
24269 .endd
24270 .cindex "RFC 2047"
24271 Sometimes there is a need to replace the whole address item, and this can be
24272 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24273 causes an address in a header line to be rewritten, the entire address is
24274 replaced, not just the working part. The replacement must be a complete RFC
24275 2822 address, including the angle brackets if necessary. If text outside angle
24276 brackets contains a character whose value is greater than 126 or less than 32
24277 (except for tab), the text is encoded according to RFC 2047. The character set
24278 is taken from &%headers_charset%&, which defaults to ISO-8859-1.
24279
24280 When the &"w"& flag is set on a rule that causes an envelope address to be
24281 rewritten, all but the working part of the replacement address is discarded.
24282 .endlist
24283
24284
24285 .section "Rewriting examples" "SECID156"
24286 Here is an example of the two common rewriting paradigms:
24287 .code
24288 *@*.hitch.fict.example  $1@hitch.fict.example
24289 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24290                      {$value}fail}@hitch.fict.example bctfrF
24291 .endd
24292 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24293 the string expansion to fail if the lookup does not succeed. In this context it
24294 has the effect of leaving the original address unchanged, but Exim goes on to
24295 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24296 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24297 explicitly, which would cause the rewritten address to be the same as before,
24298 at the cost of a small bit of processing. Not supplying either of these is an
24299 error, since the rewritten address would then contain no local part.
24300
24301 The first example above replaces the domain with a superior, more general
24302 domain. This may not be desirable for certain local parts. If the rule
24303 .code
24304 root@*.hitch.fict.example  *
24305 .endd
24306 were inserted before the first rule, rewriting would be suppressed for the
24307 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24308
24309 Rewriting can be made conditional on a number of tests, by making use of
24310 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24311 messages that originate outside the local host:
24312 .code
24313 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24314                          {$1@hitch.fict.example}fail}"
24315 .endd
24316 The replacement string is quoted in this example because it contains white
24317 space.
24318
24319 .cindex "rewriting" "bang paths"
24320 .cindex "bang paths" "rewriting"
24321 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24322 an address it treats it as an unqualified local part which it qualifies with
24323 the local qualification domain (if the source of the message is local or if the
24324 remote host is permitted to send unqualified addresses). Rewriting can
24325 sometimes be used to handle simple bang paths with a fixed number of
24326 components. For example, the rule
24327 .code
24328 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
24329 .endd
24330 rewrites a two-component bang path &'host.name!user'& as the domain address
24331 &'user@host.name'&. However, there is a security implication in using this as
24332 a global rewriting rule for envelope addresses. It can provide a backdoor
24333 method for using your system as a relay, because the incoming addresses appear
24334 to be local. If the bang path addresses are received via SMTP, it is safer to
24335 use the &"S"& flag to rewrite them as they are received, so that relay checking
24336 can be done on the rewritten addresses.
24337 .ecindex IIDaddrew
24338
24339
24340
24341
24342
24343 . ////////////////////////////////////////////////////////////////////////////
24344 . ////////////////////////////////////////////////////////////////////////////
24345
24346 .chapter "Retry configuration" "CHAPretry"
24347 .scindex IIDretconf1 "retry" "configuration, description of"
24348 .scindex IIDregconf2 "configuration file" "retry section"
24349 The &"retry"& section of the runtime configuration file contains a list of
24350 retry rules that control how often Exim tries to deliver messages that cannot
24351 be delivered at the first attempt. If there are no retry rules (the section is
24352 empty or not present), there are no retries. In this situation, temporary
24353 errors are treated as permanent. The default configuration contains a single,
24354 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
24355 line option can be used to test which retry rule will be used for a given
24356 address, domain and error.
24357
24358 The most common cause of retries is temporary failure to deliver to a remote
24359 host because the host is down, or inaccessible because of a network problem.
24360 Exim's retry processing in this case is applied on a per-host (strictly, per IP
24361 address) basis, not on a per-message basis. Thus, if one message has recently
24362 been delayed, delivery of a new message to the same host is not immediately
24363 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
24364 log selector is set, the message
24365 .cindex "retry" "time not reached"
24366 &"retry time not reached"& is written to the main log whenever a delivery is
24367 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
24368 the handling of errors during remote deliveries.
24369
24370 Retry processing applies to routing as well as to delivering, except as covered
24371 in the next paragraph. The retry rules do not distinguish between these
24372 actions. It is not possible, for example, to specify different behaviour for
24373 failures to route the domain &'snark.fict.example'& and failures to deliver to
24374 the host &'snark.fict.example'&. I didn't think anyone would ever need this
24375 added complication, so did not implement it. However, although they share the
24376 same retry rule, the actual retry times for routing and transporting a given
24377 domain are maintained independently.
24378
24379 When a delivery is not part of a queue run (typically an immediate delivery on
24380 receipt of a message), the routers are always run, and local deliveries are
24381 always attempted, even if retry times are set for them. This makes for better
24382 behaviour if one particular message is causing problems (for example, causing
24383 quota overflow, or provoking an error in a filter file). If such a delivery
24384 suffers a temporary failure, the retry data is updated as normal, and
24385 subsequent delivery attempts from queue runs occur only when the retry time for
24386 the local address is reached.
24387
24388 .section "Changing retry rules" "SECID157"
24389 If you change the retry rules in your configuration, you should consider
24390 whether or not to delete the retry data that is stored in Exim's spool area in
24391 files with names like &_db/retry_&. Deleting any of Exim's hints files is
24392 always safe; that is why they are called &"hints"&.
24393
24394 The hints retry data contains suggested retry times based on the previous
24395 rules. In the case of a long-running problem with a remote host, it might
24396 record the fact that the host has timed out. If your new rules increase the
24397 timeout time for such a host, you should definitely remove the old retry data
24398 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
24399 messages that it should now be retaining.
24400
24401
24402
24403 .section "Format of retry rules" "SECID158"
24404 .cindex "retry" "rules"
24405 Each retry rule occupies one line and consists of three or four parts,
24406 separated by white space: a pattern, an error name, an optional list of sender
24407 addresses, and a list of retry parameters. The pattern and sender lists must be
24408 enclosed in double quotes if they contain white space. The rules are searched
24409 in order until one is found where the pattern, error name, and sender list (if
24410 present) match the failing host or address, the error that occurred, and the
24411 message's sender, respectively.
24412
24413
24414 The pattern is any single item that may appear in an address list (see section
24415 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
24416 which means that it is expanded before being tested against the address that
24417 has been delayed. A negated address list item is permitted. Address
24418 list processing treats a plain domain name as if it were preceded by &"*@"&,
24419 which makes it possible for many retry rules to start with just a domain. For
24420 example,
24421 .code
24422 lookingglass.fict.example        *  F,24h,30m;
24423 .endd
24424 provides a rule for any address in the &'lookingglass.fict.example'& domain,
24425 whereas
24426 .code
24427 alice@lookingglass.fict.example  *  F,24h,30m;
24428 .endd
24429 applies only to temporary failures involving the local part &%alice%&.
24430 In practice, almost all rules start with a domain name pattern without a local
24431 part.
24432
24433 .cindex "regular expressions" "in retry rules"
24434 &*Warning*&: If you use a regular expression in a retry rule pattern, it
24435 must match a complete address, not just a domain, because that is how regular
24436 expressions work in address lists.
24437 .display
24438 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
24439 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
24440 .endd
24441
24442
24443 .section "Choosing which retry rule to use for address errors" "SECID159"
24444 When Exim is looking for a retry rule after a routing attempt has failed (for
24445 example, after a DNS timeout), each line in the retry configuration is tested
24446 against the complete address only if &%retry_use_local_part%& is set for the
24447 router. Otherwise, only the domain is used, except when matching against a
24448 regular expression, when the local part of the address is replaced with &"*"&.
24449 A domain on its own can match a domain pattern, or a pattern that starts with
24450 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
24451 &%check_local_user%& is true, and false for other routers.
24452
24453 Similarly, when Exim is looking for a retry rule after a local delivery has
24454 failed (for example, after a mailbox full error), each line in the retry
24455 configuration is tested against the complete address only if
24456 &%retry_use_local_part%& is set for the transport (it defaults true for all
24457 local transports).
24458
24459 .cindex "4&'xx'& responses" "retry rules for"
24460 However, when Exim is looking for a retry rule after a remote delivery attempt
24461 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
24462 whole address is always used as the key when searching the retry rules. The
24463 rule that is found is used to create a retry time for the combination of the
24464 failing address and the message's sender. It is the combination of sender and
24465 recipient that is delayed in subsequent queue runs until its retry time is
24466 reached. You can delay the recipient without regard to the sender by setting
24467 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
24468 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
24469 commands.
24470
24471
24472
24473 .section "Choosing which retry rule to use for host and message errors" &&&
24474          "SECID160"
24475 For a temporary error that is not related to an individual address (for
24476 example, a connection timeout), each line in the retry configuration is checked
24477 twice. First, the name of the remote host is used as a domain name (preceded by
24478 &"*@"& when matching a regular expression). If this does not match the line,
24479 the domain from the email address is tried in a similar fashion. For example,
24480 suppose the MX records for &'a.b.c.example'& are
24481 .code
24482 a.b.c.example  MX  5  x.y.z.example
24483                MX  6  p.q.r.example
24484                MX  7  m.n.o.example
24485 .endd
24486 and the retry rules are
24487 .code
24488 p.q.r.example    *      F,24h,30m;
24489 a.b.c.example    *      F,4d,45m;
24490 .endd
24491 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
24492 first rule matches neither the host nor the domain, so Exim looks at the second
24493 rule. This does not match the host, but it does match the domain, so it is used
24494 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
24495 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
24496 first retry rule is used, because it matches the host.
24497
24498 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
24499 first rule to determine retry times, but for all the other hosts for the domain
24500 &'a.b.c.example'&, the second rule is used. The second rule is also used if
24501 routing to &'a.b.c.example'& suffers a temporary failure.
24502
24503 &*Note*&: The host name is used when matching the patterns, not its IP address.
24504 However, if a message is routed directly to an IP address without the use of a
24505 host name, for example, if a &(manualroute)& router contains a setting such as:
24506 .code
24507 route_list = *.a.example  192.168.34.23
24508 .endd
24509 then the &"host name"& that is used when searching for a retry rule is the
24510 textual form of the IP address.
24511
24512 .section "Retry rules for specific errors" "SECID161"
24513 .cindex "retry" "specific errors; specifying"
24514 The second field in a retry rule is the name of a particular error, or an
24515 asterisk, which matches any error. The errors that can be tested for are:
24516
24517 .vlist
24518 .vitem &%auth_failed%&
24519 Authentication failed when trying to send to a host in the
24520 &%hosts_require_auth%& list in an &(smtp)& transport.
24521
24522 .vitem &%data_4xx%&
24523 A 4&'xx'& error was received for an outgoing DATA command, either immediately
24524 after the command, or after sending the message's data.
24525
24526 .vitem &%mail_4xx%&
24527 A 4&'xx'& error was received for an outgoing MAIL command.
24528
24529 .vitem &%rcpt_4xx%&
24530 A 4&'xx'& error was received for an outgoing RCPT command.
24531 .endlist
24532
24533 For the three 4&'xx'& errors, either the first or both of the x's can be given
24534 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
24535 recognize 452 errors given to RCPT commands for addresses in a certain domain,
24536 and have retries every ten minutes with a one-hour timeout, you could set up a
24537 retry rule of this form:
24538 .code
24539 the.domain.name  rcpt_452   F,1h,10m
24540 .endd
24541 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
24542 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
24543
24544 .vlist
24545 .vitem &%lost_connection%&
24546 A server unexpectedly closed the SMTP connection. There may, of course,
24547 legitimate reasons for this (host died, network died), but if it repeats a lot
24548 for the same host, it indicates something odd.
24549
24550 .vitem &%lookup%&
24551 A DNS lookup for a host failed.
24552 Note that a &%dnslookup%& router will need to have matched
24553 its &%fail_defer_domains%& option for this retry type to be usable.
24554 Also note that a &%manualroute%& router will probably need
24555 its &%host_find_failed%& option set to &%defer%&.
24556
24557 .vitem &%refused_MX%&
24558 A connection to a host obtained from an MX record was refused.
24559
24560 .vitem &%refused_A%&
24561 A connection to a host not obtained from an MX record was refused.
24562
24563 .vitem &%refused%&
24564 A connection was refused.
24565
24566 .vitem &%timeout_connect_MX%&
24567 A connection attempt to a host obtained from an MX record timed out.
24568
24569 .vitem &%timeout_connect_A%&
24570 A connection attempt to a host not obtained from an MX record timed out.
24571
24572 .vitem &%timeout_connect%&
24573 A connection attempt timed out.
24574
24575 .vitem &%timeout_MX%&
24576 There was a timeout while connecting or during an SMTP session with a host
24577 obtained from an MX record.
24578
24579 .vitem &%timeout_A%&
24580 There was a timeout while connecting or during an SMTP session with a host not
24581 obtained from an MX record.
24582
24583 .vitem &%timeout%&
24584 There was a timeout while connecting or during an SMTP session.
24585
24586 .vitem &%tls_required%&
24587 The server was required to use TLS (it matched &%hosts_require_tls%& in the
24588 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
24589 to STARTTLS, or there was a problem setting up the TLS connection.
24590
24591 .vitem &%quota%&
24592 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24593 transport.
24594
24595 .vitem &%quota_%&<&'time'&>
24596 .cindex "quota" "error testing in retry rule"
24597 .cindex "retry" "quota error testing"
24598 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
24599 transport, and the mailbox has not been accessed for <&'time'&>. For example,
24600 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
24601 for four days.
24602 .endlist
24603
24604 .cindex "mailbox" "time of last read"
24605 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
24606 timeouts when the mailbox is full and is not being read by its owner. Ideally,
24607 it should be based on the last time that the user accessed the mailbox.
24608 However, it is not always possible to determine this. Exim uses the following
24609 heuristic rules:
24610
24611 .ilist
24612 If the mailbox is a single file, the time of last access (the &"atime"&) is
24613 used. As no new messages are being delivered (because the mailbox is over
24614 quota), Exim does not access the file, so this is the time of last user access.
24615 .next
24616 .cindex "maildir format" "time of last read"
24617 For a maildir delivery, the time of last modification of the &_new_&
24618 subdirectory is used. As the mailbox is over quota, no new files are created in
24619 the &_new_& subdirectory, because no new messages are being delivered. Any
24620 change to the &_new_& subdirectory is therefore assumed to be the result of an
24621 MUA moving a new message to the &_cur_& directory when it is first read. The
24622 time that is used is therefore the last time that the user read a new message.
24623 .next
24624 For other kinds of multi-file mailbox, the time of last access cannot be
24625 obtained, so a retry rule that uses this type of error field is never matched.
24626 .endlist
24627
24628 The quota errors apply both to system-enforced quotas and to Exim's own quota
24629 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
24630 when a local delivery is deferred because a partition is full (the ENOSPC
24631 error).
24632
24633
24634
24635 .section "Retry rules for specified senders" "SECID162"
24636 .cindex "retry" "rules; sender-specific"
24637 You can specify retry rules that apply only when the failing message has a
24638 specific sender. In particular, this can be used to define retry rules that
24639 apply only to bounce messages. The third item in a retry rule can be of this
24640 form:
24641 .display
24642 &`senders=`&<&'address list'&>
24643 .endd
24644 The retry timings themselves are then the fourth item. For example:
24645 .code
24646 *   rcpt_4xx   senders=:   F,1h,30m
24647 .endd
24648 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
24649 host. If the address list contains white space, it must be enclosed in quotes.
24650 For example:
24651 .code
24652 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
24653 .endd
24654 &*Warning*&: This facility can be unhelpful if it is used for host errors
24655 (which do not depend on the recipient). The reason is that the sender is used
24656 only to match the retry rule. Once the rule has been found for a host error,
24657 its contents are used to set a retry time for the host, and this will apply to
24658 all messages, not just those with specific senders.
24659
24660 When testing retry rules using &%-brt%&, you can supply a sender using the
24661 &%-f%& command line option, like this:
24662 .code
24663 exim -f "" -brt user@dom.ain
24664 .endd
24665 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
24666 list is never matched.
24667
24668
24669
24670
24671
24672 .section "Retry parameters" "SECID163"
24673 .cindex "retry" "parameters in rules"
24674 The third (or fourth, if a senders list is present) field in a retry rule is a
24675 sequence of retry parameter sets, separated by semicolons. Each set consists of
24676 .display
24677 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
24678 .endd
24679 The letter identifies the algorithm for computing a new retry time; the cutoff
24680 time is the time beyond which this algorithm no longer applies, and the
24681 arguments vary the algorithm's action. The cutoff time is measured from the
24682 time that the first failure for the domain (combined with the local part if
24683 relevant) was detected, not from the time the message was received.
24684
24685 .cindex "retry" "algorithms"
24686 .cindex "retry" "fixed intervals"
24687 .cindex "retry" "increasing intervals"
24688 .cindex "retry" "random intervals"
24689 The available algorithms are:
24690
24691 .ilist
24692 &'F'&: retry at fixed intervals. There is a single time parameter specifying
24693 the interval.
24694 .next
24695 &'G'&: retry at geometrically increasing intervals. The first argument
24696 specifies a starting value for the interval, and the second a multiplier, which
24697 is used to increase the size of the interval at each retry.
24698 .next
24699 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
24700 retry, the previous interval is multiplied by the factor in order to get a
24701 maximum for the next interval. The minimum interval is the first argument of
24702 the parameter, and an actual interval is chosen randomly between them. Such a
24703 rule has been found to be helpful in cluster configurations when all the
24704 members of the cluster restart at once, and may therefore synchronize their
24705 queue processing times.
24706 .endlist
24707
24708 When computing the next retry time, the algorithm definitions are scanned in
24709 order until one whose cutoff time has not yet passed is reached. This is then
24710 used to compute a new retry time that is later than the current time. In the
24711 case of fixed interval retries, this simply means adding the interval to the
24712 current time. For geometrically increasing intervals, retry intervals are
24713 computed from the rule's parameters until one that is greater than the previous
24714 interval is found. The main configuration variable
24715 .cindex "limit" "retry interval"
24716 .cindex "retry" "interval, maximum"
24717 .oindex "&%retry_interval_max%&"
24718 &%retry_interval_max%& limits the maximum interval between retries. It
24719 cannot be set greater than &`24h`&, which is its default value.
24720
24721 A single remote domain may have a number of hosts associated with it, and each
24722 host may have more than one IP address. Retry algorithms are selected on the
24723 basis of the domain name, but are applied to each IP address independently. If,
24724 for example, a host has two IP addresses and one is unusable, Exim will
24725 generate retry times for it and will not try to use it until its next retry
24726 time comes. Thus the good IP address is likely to be tried first most of the
24727 time.
24728
24729 .cindex "hints database" "use for retrying"
24730 Retry times are hints rather than promises. Exim does not make any attempt to
24731 run deliveries exactly at the computed times. Instead, a queue runner process
24732 starts delivery processes for delayed messages periodically, and these attempt
24733 new deliveries only for those addresses that have passed their next retry time.
24734 If a new message arrives for a deferred address, an immediate delivery attempt
24735 occurs only if the address has passed its retry time. In the absence of new
24736 messages, the minimum time between retries is the interval between queue runner
24737 processes. There is not much point in setting retry times of five minutes if
24738 your queue runners happen only once an hour, unless there are a significant
24739 number of incoming messages (which might be the case on a system that is
24740 sending everything to a smart host, for example).
24741
24742 The data in the retry hints database can be inspected by using the
24743 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
24744 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
24745 &'exinext'& utility script can be used to find out what the next retry times
24746 are for the hosts associated with a particular mail domain, and also for local
24747 deliveries that have been deferred.
24748
24749
24750 .section "Retry rule examples" "SECID164"
24751 Here are some example retry rules:
24752 .code
24753 alice@wonderland.fict.example quota_5d  F,7d,3h
24754 wonderland.fict.example       quota_5d
24755 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
24756 lookingglass.fict.example     *         F,24h,30m;
24757 *                 refused_A   F,2h,20m;
24758 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
24759 .endd
24760 The first rule sets up special handling for mail to
24761 &'alice@wonderland.fict.example'& when there is an over-quota error and the
24762 mailbox has not been read for at least 5 days. Retries continue every three
24763 hours for 7 days. The second rule handles over-quota errors for all other local
24764 parts at &'wonderland.fict.example'&; the absence of a local part has the same
24765 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
24766 fail are bounced immediately if the mailbox has not been read for at least 5
24767 days.
24768
24769 The third rule handles all other errors at &'wonderland.fict.example'&; retries
24770 happen every 15 minutes for an hour, then with geometrically increasing
24771 intervals until two days have passed since a delivery first failed. After the
24772 first hour there is a delay of one hour, then two hours, then four hours, and
24773 so on (this is a rather extreme example).
24774
24775 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
24776 They happen every 30 minutes for 24 hours only. The remaining two rules handle
24777 all other domains, with special action for connection refusal from hosts that
24778 were not obtained from an MX record.
24779
24780 The final rule in a retry configuration should always have asterisks in the
24781 first two fields so as to provide a general catch-all for any addresses that do
24782 not have their own special handling. This example tries every 15 minutes for 2
24783 hours, then with intervals starting at one hour and increasing by a factor of
24784 1.5 up to 16 hours, then every 8 hours up to 5 days.
24785
24786
24787
24788 .section "Timeout of retry data" "SECID165"
24789 .cindex "timeout" "of retry data"
24790 .oindex "&%retry_data_expire%&"
24791 .cindex "hints database" "data expiry"
24792 .cindex "retry" "timeout of data"
24793 Exim timestamps the data that it writes to its retry hints database. When it
24794 consults the data during a delivery it ignores any that is older than the value
24795 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
24796 been tried for 7 days, Exim will try to deliver to it immediately a message
24797 arrives, and if that fails, it will calculate a retry time as if it were
24798 failing for the first time.
24799
24800 This improves the behaviour for messages routed to rarely-used hosts such as MX
24801 backups. If such a host was down at one time, and happens to be down again when
24802 Exim tries a month later, using the old retry data would imply that it had been
24803 down all the time, which is not a justified assumption.
24804
24805 If a host really is permanently dead, this behaviour causes a burst of retries
24806 every now and again, but only if messages routed to it are rare. If there is a
24807 message at least once every 7 days the retry data never expires.
24808
24809
24810
24811
24812 .section "Long-term failures" "SECID166"
24813 .cindex "delivery failure, long-term"
24814 .cindex "retry" "after long-term failure"
24815 Special processing happens when an email address has been failing for so long
24816 that the cutoff time for the last algorithm is reached. For example, using the
24817 default retry rule:
24818 .code
24819 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
24820 .endd
24821 the cutoff time is four days. Reaching the retry cutoff is independent of how
24822 long any specific message has been failing; it is the length of continuous
24823 failure for the recipient address that counts.
24824
24825 When the cutoff time is reached for a local delivery, or for all the IP
24826 addresses associated with a remote delivery, a subsequent delivery failure
24827 causes Exim to give up on the address, and a bounce message is generated.
24828 In order to cater for new messages that use the failing address, a next retry
24829 time is still computed from the final algorithm, and is used as follows:
24830
24831 For local deliveries, one delivery attempt is always made for any subsequent
24832 messages. If this delivery fails, the address fails immediately. The
24833 post-cutoff retry time is not used.
24834
24835 If the delivery is remote, there are two possibilities, controlled by the
24836 .oindex "&%delay_after_cutoff%&"
24837 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
24838 default. Until the post-cutoff retry time for one of the IP addresses is
24839 reached, the failing email address is bounced immediately, without a delivery
24840 attempt taking place. After that time, one new delivery attempt is made to
24841 those IP addresses that are past their retry times, and if that still fails,
24842 the address is bounced and new retry times are computed.
24843
24844 In other words, when all the hosts for a given email address have been failing
24845 for a long time, Exim bounces rather then defers until one of the hosts' retry
24846 times is reached. Then it tries once, and bounces if that attempt fails. This
24847 behaviour ensures that few resources are wasted in repeatedly trying to deliver
24848 to a broken destination, but if the host does recover, Exim will eventually
24849 notice.
24850
24851 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24852 addresses are past their final cutoff time, Exim tries to deliver to those IP
24853 addresses that have not been tried since the message arrived. If there are
24854 no suitable IP addresses, or if they all fail, the address is bounced. In other
24855 words, it does not delay when a new message arrives, but tries the expired
24856 addresses immediately, unless they have been tried since the message arrived.
24857 If there is a continuous stream of messages for the failing domains, setting
24858 &%delay_after_cutoff%& false means that there will be many more attempts to
24859 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
24860 true.
24861
24862 .section "Deliveries that work intermittently" "SECID167"
24863 .cindex "retry" "intermittently working deliveries"
24864 Some additional logic is needed to cope with cases where a host is
24865 intermittently available, or when a message has some attribute that prevents
24866 its delivery when others to the same address get through. In this situation,
24867 because some messages are successfully delivered, the &"retry clock"& for the
24868 host or address keeps getting reset by the successful deliveries, and so
24869 failing messages remain on the queue for ever because the cutoff time is never
24870 reached.
24871
24872 Two exceptional actions are applied to prevent this happening. The first
24873 applies to errors that are related to a message rather than a remote host.
24874 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
24875 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
24876 commands, and quota failures. For this type of error, if a message's arrival
24877 time is earlier than the &"first failed"& time for the error, the earlier time
24878 is used when scanning the retry rules to decide when to try next and when to
24879 time out the address.
24880
24881 The exceptional second action applies in all cases. If a message has been on
24882 the queue for longer than the cutoff time of any applicable retry rule for a
24883 given address, a delivery is attempted for that address, even if it is not yet
24884 time, and if this delivery fails, the address is timed out. A new retry time is
24885 not computed in this case, so that other messages for the same address are
24886 considered immediately.
24887 .ecindex IIDretconf1
24888 .ecindex IIDregconf2
24889
24890
24891
24892
24893
24894
24895 . ////////////////////////////////////////////////////////////////////////////
24896 . ////////////////////////////////////////////////////////////////////////////
24897
24898 .chapter "SMTP authentication" "CHAPSMTPAUTH"
24899 .scindex IIDauthconf1 "SMTP" "authentication configuration"
24900 .scindex IIDauthconf2 "authentication"
24901 The &"authenticators"& section of Exim's run time configuration is concerned
24902 with SMTP authentication. This facility is an extension to the SMTP protocol,
24903 described in RFC 2554, which allows a client SMTP host to authenticate itself
24904 to a server. This is a common way for a server to recognize clients that are
24905 permitted to use it as a relay. SMTP authentication is not of relevance to the
24906 transfer of mail between servers that have no managerial connection with each
24907 other.
24908
24909 .cindex "AUTH" "description of"
24910 Very briefly, the way SMTP authentication works is as follows:
24911
24912 .ilist
24913 The server advertises a number of authentication &'mechanisms'& in response to
24914 the client's EHLO command.
24915 .next
24916 The client issues an AUTH command, naming a specific mechanism. The command
24917 may, optionally, contain some authentication data.
24918 .next
24919 The server may issue one or more &'challenges'&, to which the client must send
24920 appropriate responses. In simple authentication mechanisms, the challenges are
24921 just prompts for user names and passwords. The server does not have to issue
24922 any challenges &-- in some mechanisms the relevant data may all be transmitted
24923 with the AUTH command.
24924 .next
24925 The server either accepts or denies authentication.
24926 .next
24927 If authentication succeeds, the client may optionally make use of the AUTH
24928 option on the MAIL command to pass an authenticated sender in subsequent
24929 mail transactions. Authentication lasts for the remainder of the SMTP
24930 connection.
24931 .next
24932 If authentication fails, the client may give up, or it may try a different
24933 authentication mechanism, or it may try transferring mail over the
24934 unauthenticated connection.
24935 .endlist
24936
24937 If you are setting up a client, and want to know which authentication
24938 mechanisms the server supports, you can use Telnet to connect to port 25 (the
24939 SMTP port) on the server, and issue an EHLO command. The response to this
24940 includes the list of supported mechanisms. For example:
24941 .display
24942 &`$ `&&*&`telnet server.example 25`&*&
24943 &`Trying 192.168.34.25...`&
24944 &`Connected to server.example.`&
24945 &`Escape character is &#x0027;^]&#x0027;.`&
24946 &`220 server.example ESMTP Exim 4.20 ...`&
24947 &*&`ehlo client.example`&*&
24948 &`250-server.example Hello client.example [10.8.4.5]`&
24949 &`250-SIZE 52428800`&
24950 &`250-PIPELINING`&
24951 &`250-AUTH PLAIN`&
24952 &`250 HELP`&
24953 .endd
24954 The second-last line of this example output shows that the server supports
24955 authentication using the PLAIN mechanism. In Exim, the different authentication
24956 mechanisms are configured by specifying &'authenticator'& drivers. Like the
24957 routers and transports, which authenticators are included in the binary is
24958 controlled by build-time definitions. The following are currently available,
24959 included by setting
24960 .code
24961 AUTH_CRAM_MD5=yes
24962 AUTH_CYRUS_SASL=yes
24963 AUTH_DOVECOT=yes
24964 AUTH_GSASL=yes
24965 AUTH_HEIMDAL_GSSAPI=yes
24966 AUTH_PLAINTEXT=yes
24967 AUTH_SPA=yes
24968 AUTH_TLS=yes
24969 .endd
24970 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
24971 authentication mechanism (RFC 2195), and the second provides an interface to
24972 the Cyrus SASL authentication library.
24973 The third is an interface to Dovecot's authentication system, delegating the
24974 work via a socket interface.
24975 The fourth provides an interface to the GNU SASL authentication library, which
24976 provides mechanisms but typically not data sources.
24977 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
24978 supporting setting a server keytab.
24979 The sixth can be configured to support
24980 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
24981 not formally documented, but used by several MUAs. The seventh authenticator
24982 supports Microsoft's &'Secure Password Authentication'& mechanism.
24983 The eighth is an Exim authenticator but not an SMTP one;
24984 instead it can use information from a TLS negotiation.
24985
24986 The authenticators are configured using the same syntax as other drivers (see
24987 section &<<SECTfordricon>>&). If no authenticators are required, no
24988 authentication section need be present in the configuration file. Each
24989 authenticator can in principle have both server and client functions. When Exim
24990 is receiving SMTP mail, it is acting as a server; when it is sending out
24991 messages over SMTP, it is acting as a client. Authenticator configuration
24992 options are provided for use in both these circumstances.
24993
24994 To make it clear which options apply to which situation, the prefixes
24995 &%server_%& and &%client_%& are used on option names that are specific to
24996 either the server or the client function, respectively. Server and client
24997 functions are disabled if none of their options are set. If an authenticator is
24998 to be used for both server and client functions, a single definition, using
24999 both sets of options, is required. For example:
25000 .code
25001 cram:
25002   driver = cram_md5
25003   public_name = CRAM-MD5
25004   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25005   client_name = ph10
25006   client_secret = secret2
25007 .endd
25008 The &%server_%& option is used when Exim is acting as a server, and the
25009 &%client_%& options when it is acting as a client.
25010
25011 Descriptions of the individual authenticators are given in subsequent chapters.
25012 The remainder of this chapter covers the generic options for the
25013 authenticators, followed by general discussion of the way authentication works
25014 in Exim.
25015
25016 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25017 per-mechanism basis.  Please read carefully to determine which variables hold
25018 account labels such as usercodes and which hold passwords or other
25019 authenticating data.
25020
25021 Note that some mechanisms support two different identifiers for accounts: the
25022 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25023 and &'authz'& are commonly encountered.  The American spelling is standard here.
25024 Conceptually, authentication data such as passwords are tied to the identifier
25025 used to authenticate; servers may have rules to permit one user to act as a
25026 second user, so that after login the session is treated as though that second
25027 user had logged in.  That second user is the &'authorization id'&.  A robust
25028 configuration might confirm that the &'authz'& field is empty or matches the
25029 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25030 as verified data, the &'authz'& as an unverified request which the server might
25031 choose to honour.
25032
25033 A &'realm'& is a text string, typically a domain name, presented by a server
25034 to a client to help it select an account and credentials to use.  In some
25035 mechanisms, the client and server provably agree on the realm, but clients
25036 typically can not treat the realm as secure data to be blindly trusted.
25037
25038
25039
25040 .section "Generic options for authenticators" "SECID168"
25041 .cindex "authentication" "generic options"
25042 .cindex "options" "generic; for authenticators"
25043
25044 .option client_condition authenticators string&!! unset
25045 When Exim is authenticating as a client, it skips any authenticator whose
25046 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25047 used, for example, to skip plain text authenticators when the connection is not
25048 encrypted by a setting such as:
25049 .code
25050 client_condition = ${if !eq{$tls_out_cipher}{}}
25051 .endd
25052
25053
25054 .option client_set_id authenticators string&!! unset
25055 When client authentication succeeds, this condition is expanded; the
25056 result is used in the log lines for outbound messasges.
25057 Typically it will be the user name used for authentication.
25058
25059
25060 .option driver authenticators string unset
25061 This option must always be set. It specifies which of the available
25062 authenticators is to be used.
25063
25064
25065 .option public_name authenticators string unset
25066 This option specifies the name of the authentication mechanism that the driver
25067 implements, and by which it is known to the outside world. These names should
25068 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25069 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25070 defaults to the driver's instance name.
25071
25072
25073 .option server_advertise_condition authenticators string&!! unset
25074 When a server is about to advertise an authentication mechanism, the condition
25075 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25076 mechanism is not advertised.
25077 If the expansion fails, the mechanism is not advertised. If the failure was not
25078 forced, and was not caused by a lookup defer, the incident is logged.
25079 See section &<<SECTauthexiser>>& below for further discussion.
25080
25081
25082 .option server_condition authenticators string&!! unset
25083 This option must be set for a &%plaintext%& server authenticator, where it
25084 is used directly to control authentication. See section &<<SECTplainserver>>&
25085 for details.
25086
25087 For the &(gsasl)& authenticator, this option is required for various
25088 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25089
25090 For the other authenticators, &%server_condition%& can be used as an additional
25091 authentication or authorization mechanism that is applied after the other
25092 authenticator conditions succeed. If it is set, it is expanded when the
25093 authenticator would otherwise return a success code. If the expansion is forced
25094 to fail, authentication fails. Any other expansion failure causes a temporary
25095 error code to be returned. If the result of a successful expansion is an empty
25096 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25097 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25098 other result, a temporary error code is returned, with the expanded string as
25099 the error text.
25100
25101
25102 .option server_debug_print authenticators string&!! unset
25103 If this option is set and authentication debugging is enabled (see the &%-d%&
25104 command line option), the string is expanded and included in the debugging
25105 output when the authenticator is run as a server. This can help with checking
25106 out the values of variables.
25107 If expansion of the string fails, the error message is written to the debugging
25108 output, and Exim carries on processing.
25109
25110
25111 .option server_set_id authenticators string&!! unset
25112 .vindex "&$authenticated_id$&"
25113 When an Exim server successfully authenticates a client, this string is
25114 expanded using data from the authentication, and preserved for any incoming
25115 messages in the variable &$authenticated_id$&. It is also included in the log
25116 lines for incoming messages. For example, a user/password authenticator
25117 configuration might preserve the user name that was used to authenticate, and
25118 refer to it subsequently during delivery of the message.
25119 If expansion fails, the option is ignored.
25120
25121
25122 .option server_mail_auth_condition authenticators string&!! unset
25123 This option allows a server to discard authenticated sender addresses supplied
25124 as part of MAIL commands in SMTP connections that are authenticated by the
25125 driver on which &%server_mail_auth_condition%& is set. The option is not used
25126 as part of the authentication process; instead its (unexpanded) value is
25127 remembered for later use.
25128 How it is used is described in the following section.
25129
25130
25131
25132
25133
25134 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25135 .cindex "authentication" "sender; authenticated"
25136 .cindex "AUTH" "on MAIL command"
25137 When a client supplied an AUTH= item on a MAIL command, Exim applies
25138 the following checks before accepting it as the authenticated sender of the
25139 message:
25140
25141 .ilist
25142 If the connection is not using extended SMTP (that is, HELO was used rather
25143 than EHLO), the use of AUTH= is a syntax error.
25144 .next
25145 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25146 .next
25147 .vindex "&$authenticated_sender$&"
25148 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25149 running, the value of &$authenticated_sender$& is set to the value obtained
25150 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25151 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25152 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25153 given for the MAIL command.
25154 .next
25155 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25156 is accepted and placed in &$authenticated_sender$& only if the client has
25157 authenticated.
25158 .next
25159 If the AUTH= value was accepted by either of the two previous rules, and
25160 the client has authenticated, and the authenticator has a setting for the
25161 &%server_mail_auth_condition%&, the condition is checked at this point. The
25162 valued that was saved from the authenticator is expanded. If the expansion
25163 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25164 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25165 the value of &$authenticated_sender$& is retained and passed on with the
25166 message.
25167 .endlist
25168
25169
25170 When &$authenticated_sender$& is set for a message, it is passed on to other
25171 hosts to which Exim authenticates as a client. Do not confuse this value with
25172 &$authenticated_id$&, which is a string obtained from the authentication
25173 process, and which is not usually a complete email address.
25174
25175 .vindex "&$sender_address$&"
25176 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25177 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25178 therefore make use of &$authenticated_sender$&. The converse is not true: the
25179 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25180 ACL is run.
25181
25182
25183
25184 .section "Authentication on an Exim server" "SECTauthexiser"
25185 .cindex "authentication" "on an Exim server"
25186 When Exim receives an EHLO command, it advertises the public names of those
25187 authenticators that are configured as servers, subject to the following
25188 conditions:
25189
25190 .ilist
25191 The client host must match &%auth_advertise_hosts%& (default *).
25192 .next
25193 It the &%server_advertise_condition%& option is set, its expansion must not
25194 yield the empty string, &"0"&, &"no"&, or &"false"&.
25195 .endlist
25196
25197 The order in which the authenticators are defined controls the order in which
25198 the mechanisms are advertised.
25199
25200 Some mail clients (for example, some versions of Netscape) require the user to
25201 provide a name and password for authentication whenever AUTH is advertised,
25202 even though authentication may not in fact be needed (for example, Exim may be
25203 set up to allow unconditional relaying from the client by an IP address check).
25204 You can make such clients more friendly by not advertising AUTH to them.
25205 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25206 that runs for RCPT) to relay without authentication, you should set
25207 .code
25208 auth_advertise_hosts = ! 10.9.8.0/24
25209 .endd
25210 so that no authentication mechanisms are advertised to them.
25211
25212 The &%server_advertise_condition%& controls the advertisement of individual
25213 authentication mechanisms. For example, it can be used to restrict the
25214 advertisement of a particular mechanism to encrypted connections, by a setting
25215 such as:
25216 .code
25217 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25218 .endd
25219 .vindex "&$tls_in_cipher$&"
25220 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25221 yields &"yes"&, which allows the advertisement to happen.
25222
25223 When an Exim server receives an AUTH command from a client, it rejects it
25224 immediately if AUTH was not advertised in response to an earlier EHLO
25225 command. This is the case if
25226
25227 .ilist
25228 The client host does not match &%auth_advertise_hosts%&; or
25229 .next
25230 No authenticators are configured with server options; or
25231 .next
25232 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25233 server authenticators.
25234 .endlist
25235
25236
25237 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25238 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25239 AUTH is accepted from any client host.
25240
25241 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25242 server authentication mechanism that was advertised in response to EHLO and
25243 that matches the one named in the AUTH command. If it finds one, it runs
25244 the appropriate authentication protocol, and authentication either succeeds or
25245 fails. If there is no matching advertised mechanism, the AUTH command is
25246 rejected with a 504 error.
25247
25248 .vindex "&$received_protocol$&"
25249 .vindex "&$sender_host_authenticated$&"
25250 When a message is received from an authenticated host, the value of
25251 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25252 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25253 public name) of the authenticator driver that successfully authenticated the
25254 client from which the message was received. This variable is empty if there was
25255 no successful authentication.
25256
25257
25258
25259
25260 .section "Testing server authentication" "SECID169"
25261 .cindex "authentication" "testing a server"
25262 .cindex "AUTH" "testing a server"
25263 .cindex "base64 encoding" "creating authentication test data"
25264 Exim's &%-bh%& option can be useful for testing server authentication
25265 configurations. The data for the AUTH command has to be sent using base64
25266 encoding. A quick way to produce such data for testing is the following Perl
25267 script:
25268 .code
25269 use MIME::Base64;
25270 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25271 .endd
25272 .cindex "binary zero" "in authentication data"
25273 This interprets its argument as a Perl string, and then encodes it. The
25274 interpretation as a Perl string allows binary zeros, which are required for
25275 some kinds of authentication, to be included in the data. For example, a
25276 command line to run this script on such data might be
25277 .code
25278 encode '\0user\0password'
25279 .endd
25280 Note the use of single quotes to prevent the shell interpreting the
25281 backslashes, so that they can be interpreted by Perl to specify characters
25282 whose code value is zero.
25283
25284 &*Warning 1*&: If either of the user or password strings starts with an octal
25285 digit, you must use three zeros instead of one after the leading backslash. If
25286 you do not, the octal digit that starts your string will be incorrectly
25287 interpreted as part of the code for the first character.
25288
25289 &*Warning 2*&: If there are characters in the strings that Perl interprets
25290 specially, you must use a Perl escape to prevent them being misinterpreted. For
25291 example, a command such as
25292 .code
25293 encode '\0user@domain.com\0pas$$word'
25294 .endd
25295 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25296
25297 If you have the &%mimencode%& command installed, another way to do produce
25298 base64-encoded strings is to run the command
25299 .code
25300 echo -e -n `\0user\0password' | mimencode
25301 .endd
25302 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25303 in the argument, and the &%-n%& option specifies no newline at the end of its
25304 output. However, not all versions of &%echo%& recognize these options, so you
25305 should check your version before relying on this suggestion.
25306
25307
25308
25309 .section "Authentication by an Exim client" "SECID170"
25310 .cindex "authentication" "on an Exim client"
25311 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25312 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25313 announces support for authentication, and the host matches an entry in either
25314 of these options, Exim (as a client) tries to authenticate as follows:
25315
25316 .ilist
25317 For each authenticator that is configured as a client, in the order in which
25318 they are defined in the configuration, it searches the authentication
25319 mechanisms announced by the server for one whose name matches the public name
25320 of the authenticator.
25321 .next
25322 .vindex "&$host$&"
25323 .vindex "&$host_address$&"
25324 When it finds one that matches, it runs the authenticator's client code. The
25325 variables &$host$& and &$host_address$& are available for any string expansions
25326 that the client might do. They are set to the server's name and IP address. If
25327 any expansion is forced to fail, the authentication attempt is abandoned, and
25328 Exim moves on to the next authenticator. Otherwise an expansion failure causes
25329 delivery to be deferred.
25330 .next
25331 If the result of the authentication attempt is a temporary error or a timeout,
25332 Exim abandons trying to send the message to the host for the moment. It will
25333 try again later. If there are any backup hosts available, they are tried in the
25334 usual way.
25335 .next
25336 If the response to authentication is a permanent error (5&'xx'& code), Exim
25337 carries on searching the list of authenticators and tries another one if
25338 possible. If all authentication attempts give permanent errors, or if there are
25339 no attempts because no mechanisms match (or option expansions force failure),
25340 what happens depends on whether the host matches &%hosts_require_auth%& or
25341 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
25342 delivery is deferred. The error can be detected in the retry rules, and thereby
25343 turned into a permanent error if you wish. In the second case, Exim tries to
25344 deliver the message unauthenticated.
25345 .endlist
25346
25347 .cindex "AUTH" "on MAIL command"
25348 When Exim has authenticated itself to a remote server, it adds the AUTH
25349 parameter to the MAIL commands it sends, if it has an authenticated sender for
25350 the message. If the message came from a remote host, the authenticated sender
25351 is the one that was receiving on an incoming MAIL command, provided that the
25352 incoming connection was authenticated and the &%server_mail_auth%& condition
25353 allowed the authenticated sender to be retained. If a local process calls Exim
25354 to send a message, the sender address that is built from the login name and
25355 &%qualify_domain%& is treated as authenticated. However, if the
25356 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
25357 the authenticated sender that was received with the message.
25358 .ecindex IIDauthconf1
25359 .ecindex IIDauthconf2
25360
25361
25362
25363
25364
25365
25366 . ////////////////////////////////////////////////////////////////////////////
25367 . ////////////////////////////////////////////////////////////////////////////
25368
25369 .chapter "The plaintext authenticator" "CHAPplaintext"
25370 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
25371 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
25372 The &(plaintext)& authenticator can be configured to support the PLAIN and
25373 LOGIN authentication mechanisms, both of which transfer authentication data as
25374 plain (unencrypted) text (though base64 encoded). The use of plain text is a
25375 security risk; you are strongly advised to insist on the use of SMTP encryption
25376 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
25377 use unencrypted plain text, you should not use the same passwords for SMTP
25378 connections as you do for login accounts.
25379
25380 .section "Plaintext options" "SECID171"
25381 .cindex "options" "&(plaintext)& authenticator (server)"
25382 When configured as a server, &(plaintext)& uses the following options:
25383
25384 .option server_condition authenticators string&!! unset
25385 This is actually a global authentication option, but it must be set in order to
25386 configure the &(plaintext)& driver as a server. Its use is described below.
25387
25388 .option server_prompts plaintext string&!! unset
25389 The contents of this option, after expansion, must be a colon-separated list of
25390 prompt strings. If expansion fails, a temporary authentication rejection is
25391 given.
25392
25393 .section "Using plaintext in a server" "SECTplainserver"
25394 .cindex "AUTH" "in &(plaintext)& authenticator"
25395 .cindex "binary zero" "in &(plaintext)& authenticator"
25396 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
25397         "in &(plaintext)& authenticator"
25398 .vindex "&$auth1$&, &$auth2$&, etc"
25399 .cindex "base64 encoding" "in &(plaintext)& authenticator"
25400
25401 When running as a server, &(plaintext)& performs the authentication test by
25402 expanding a string. The data sent by the client with the AUTH command, or in
25403 response to subsequent prompts, is base64 encoded, and so may contain any byte
25404 values when decoded. If any data is supplied with the command, it is treated as
25405 a list of strings, separated by NULs (binary zeros), the first three of which
25406 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
25407 (neither LOGIN nor PLAIN uses more than three strings).
25408
25409 For compatibility with previous releases of Exim, the values are also placed in
25410 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
25411 variables for this purpose is now deprecated, as it can lead to confusion in
25412 string expansions that also use them for other things.
25413
25414 If there are more strings in &%server_prompts%& than the number of strings
25415 supplied with the AUTH command, the remaining prompts are used to obtain more
25416 data. Each response from the client may be a list of NUL-separated strings.
25417
25418 .vindex "&$authenticated_id$&"
25419 Once a sufficient number of data strings have been received,
25420 &%server_condition%& is expanded. If the expansion is forced to fail,
25421 authentication fails. Any other expansion failure causes a temporary error code
25422 to be returned. If the result of a successful expansion is an empty string,
25423 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25424 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
25425 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
25426 For any other result, a temporary error code is returned, with the expanded
25427 string as the error text
25428
25429 &*Warning*&: If you use a lookup in the expansion to find the user's
25430 password, be sure to make the authentication fail if the user is unknown.
25431 There are good and bad examples at the end of the next section.
25432
25433
25434
25435 .section "The PLAIN authentication mechanism" "SECID172"
25436 .cindex "PLAIN authentication mechanism"
25437 .cindex "authentication" "PLAIN mechanism"
25438 .cindex "binary zero" "in &(plaintext)& authenticator"
25439 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
25440 sent as one item of data (that is, one combined string containing two NUL
25441 separators). The data is sent either as part of the AUTH command, or
25442 subsequently in response to an empty prompt from the server.
25443
25444 The second and third strings are a user name and a corresponding password.
25445 Using a single fixed user name and password as an example, this could be
25446 configured as follows:
25447 .code
25448 fixed_plain:
25449   driver = plaintext
25450   public_name = PLAIN
25451   server_prompts = :
25452   server_condition = \
25453     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
25454   server_set_id = $auth2
25455 .endd
25456 Note that the default result strings from &%if%& (&"true"& or an empty string)
25457 are exactly what we want here, so they need not be specified. Obviously, if the
25458 password contains expansion-significant characters such as dollar, backslash,
25459 or closing brace, they have to be escaped.
25460
25461 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
25462 the end of a string list are ignored). If all the data comes as part of the
25463 AUTH command, as is commonly the case, the prompt is not used. This
25464 authenticator is advertised in the response to EHLO as
25465 .code
25466 250-AUTH PLAIN
25467 .endd
25468 and a client host can authenticate itself by sending the command
25469 .code
25470 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
25471 .endd
25472 As this contains three strings (more than the number of prompts), no further
25473 data is required from the client. Alternatively, the client may just send
25474 .code
25475 AUTH PLAIN
25476 .endd
25477 to initiate authentication, in which case the server replies with an empty
25478 prompt. The client must respond with the combined data string.
25479
25480 The data string is base64 encoded, as required by the RFC. This example,
25481 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
25482 represents a zero byte. This is split up into three strings, the first of which
25483 is empty. The &%server_condition%& option in the authenticator checks that the
25484 second two are &`username`& and &`mysecret`& respectively.
25485
25486 Having just one fixed user name and password, as in this example, is not very
25487 realistic, though for a small organization with only a handful of
25488 authenticating clients it could make sense.
25489
25490 A more sophisticated instance of this authenticator could use the user name in
25491 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
25492 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
25493 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
25494 This is an incorrect example:
25495 .code
25496 server_condition = \
25497   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
25498 .endd
25499 The expansion uses the user name (&$auth2$&) as the key to look up a password,
25500 which it then compares to the supplied password (&$auth3$&). Why is this example
25501 incorrect? It works fine for existing users, but consider what happens if a
25502 non-existent user name is given. The lookup fails, but as no success/failure
25503 strings are given for the lookup, it yields an empty string. Thus, to defeat
25504 the authentication, all a client has to do is to supply a non-existent user
25505 name and an empty password. The correct way of writing this test is:
25506 .code
25507 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
25508   {${if eq{$value}{$auth3}}} {false}}
25509 .endd
25510 In this case, if the lookup succeeds, the result is checked; if the lookup
25511 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
25512 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
25513 always fails if its second argument is empty. However, the second way of
25514 writing the test makes the logic clearer.
25515
25516
25517 .section "The LOGIN authentication mechanism" "SECID173"
25518 .cindex "LOGIN authentication mechanism"
25519 .cindex "authentication" "LOGIN mechanism"
25520 The LOGIN authentication mechanism is not documented in any RFC, but is in use
25521 in a number of programs. No data is sent with the AUTH command. Instead, a
25522 user name and password are supplied separately, in response to prompts. The
25523 plaintext authenticator can be configured to support this as in this example:
25524 .code
25525 fixed_login:
25526   driver = plaintext
25527   public_name = LOGIN
25528   server_prompts = User Name : Password
25529   server_condition = \
25530     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
25531   server_set_id = $auth1
25532 .endd
25533 Because of the way plaintext operates, this authenticator accepts data supplied
25534 with the AUTH command (in contravention of the specification of LOGIN), but
25535 if the client does not supply it (as is the case for LOGIN clients), the prompt
25536 strings are used to obtain two data items.
25537
25538 Some clients are very particular about the precise text of the prompts. For
25539 example, Outlook Express is reported to recognize only &"Username:"& and
25540 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
25541 strings. It uses the &%ldapauth%& expansion condition to check the user
25542 name and password by binding to an LDAP server:
25543 .code
25544 login:
25545   driver = plaintext
25546   public_name = LOGIN
25547   server_prompts = Username:: : Password::
25548   server_condition = ${if and{{ \
25549     !eq{}{$auth1} }{ \
25550     ldapauth{\
25551       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
25552       pass=${quote:$auth2} \
25553       ldap://ldap.example.org/} }} }
25554   server_set_id = uid=$auth1,ou=people,o=example.org
25555 .endd
25556 We have to check that the username is not empty before using it, because LDAP
25557 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
25558 operator to correctly quote the DN for authentication. However, the basic
25559 &%quote%& operator, rather than any of the LDAP quoting operators, is the
25560 correct one to use for the password, because quoting is needed only to make
25561 the password conform to the Exim syntax. At the LDAP level, the password is an
25562 uninterpreted string.
25563
25564
25565 .section "Support for different kinds of authentication" "SECID174"
25566 A number of string expansion features are provided for the purpose of
25567 interfacing to different ways of user authentication. These include checking
25568 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
25569 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
25570 &<<SECTexpcond>>&.
25571
25572
25573
25574
25575 .section "Using plaintext in a client" "SECID175"
25576 .cindex "options" "&(plaintext)& authenticator (client)"
25577 The &(plaintext)& authenticator has two client options:
25578
25579 .option client_ignore_invalid_base64 plaintext boolean false
25580 If the client receives a server prompt that is not a valid base64 string,
25581 authentication is abandoned by default. However, if this option is set true,
25582 the error in the challenge is ignored and the client sends the response as
25583 usual.
25584
25585 .option client_send plaintext string&!! unset
25586 The string is a colon-separated list of authentication data strings. Each
25587 string is independently expanded before being sent to the server. The first
25588 string is sent with the AUTH command; any more strings are sent in response
25589 to prompts from the server. Before each string is expanded, the value of the
25590 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
25591 with &$auth1$& for the first prompt. Up to three prompts are stored in this
25592 way. Thus, the prompt that is received in response to sending the first string
25593 (with the AUTH command) can be used in the expansion of the second string, and
25594 so on. If an invalid base64 string is received when
25595 &%client_ignore_invalid_base64%& is set, an empty string is put in the
25596 &$auth$&<&'n'&> variable.
25597
25598 &*Note*&: You cannot use expansion to create multiple strings, because
25599 splitting takes priority and happens first.
25600
25601 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
25602 the data, further processing is applied to each string before it is sent. If
25603 there are any single circumflex characters in the string, they are converted to
25604 NULs. Should an actual circumflex be required as data, it must be doubled in
25605 the string.
25606
25607 This is an example of a client configuration that implements the PLAIN
25608 authentication mechanism with a fixed user name and password:
25609 .code
25610 fixed_plain:
25611   driver = plaintext
25612   public_name = PLAIN
25613   client_send = ^username^mysecret
25614 .endd
25615 The lack of colons means that the entire text is sent with the AUTH
25616 command, with the circumflex characters converted to NULs. A similar example
25617 that uses the LOGIN mechanism is:
25618 .code
25619 fixed_login:
25620   driver = plaintext
25621   public_name = LOGIN
25622   client_send = : username : mysecret
25623 .endd
25624 The initial colon means that the first string is empty, so no data is sent with
25625 the AUTH command itself. The remaining strings are sent in response to
25626 prompts.
25627 .ecindex IIDplaiauth1
25628 .ecindex IIDplaiauth2
25629
25630
25631
25632
25633 . ////////////////////////////////////////////////////////////////////////////
25634 . ////////////////////////////////////////////////////////////////////////////
25635
25636 .chapter "The cram_md5 authenticator" "CHID9"
25637 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
25638 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
25639 .cindex "CRAM-MD5 authentication mechanism"
25640 .cindex "authentication" "CRAM-MD5 mechanism"
25641 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
25642 sends a challenge string to the client, and the response consists of a user
25643 name and the CRAM-MD5 digest of the challenge string combined with a secret
25644 string (password) which is known to both server and client. Thus, the secret
25645 is not sent over the network as plain text, which makes this authenticator more
25646 secure than &(plaintext)&. However, the downside is that the secret has to be
25647 available in plain text at either end.
25648
25649
25650 .section "Using cram_md5 as a server" "SECID176"
25651 .cindex "options" "&(cram_md5)& authenticator (server)"
25652 This authenticator has one server option, which must be set to configure the
25653 authenticator as a server:
25654
25655 .option server_secret cram_md5 string&!! unset
25656 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
25657 When the server receives the client's response, the user name is placed in
25658 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
25659 obtain the password for that user. The server then computes the CRAM-MD5 digest
25660 that the client should have sent, and checks that it received the correct
25661 string. If the expansion of &%server_secret%& is forced to fail, authentication
25662 fails. If the expansion fails for some other reason, a temporary error code is
25663 returned to the client.
25664
25665 For compatibility with previous releases of Exim, the user name is also placed
25666 in &$1$&. However, the use of this variables for this purpose is now
25667 deprecated, as it can lead to confusion in string expansions that also use
25668 numeric variables for other things.
25669
25670 For example, the following authenticator checks that the user name given by the
25671 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
25672 user name, authentication fails.
25673 .code
25674 fixed_cram:
25675   driver = cram_md5
25676   public_name = CRAM-MD5
25677   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
25678   server_set_id = $auth1
25679 .endd
25680 .vindex "&$authenticated_id$&"
25681 If authentication succeeds, the setting of &%server_set_id%& preserves the user
25682 name in &$authenticated_id$&. A more typical configuration might look up the
25683 secret string in a file, using the user name as the key. For example:
25684 .code
25685 lookup_cram:
25686   driver = cram_md5
25687   public_name = CRAM-MD5
25688   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
25689                   {$value}fail}
25690   server_set_id = $auth1
25691 .endd
25692 Note that this expansion explicitly forces failure if the lookup fails
25693 because &$auth1$& contains an unknown user name.
25694
25695 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
25696 using the relevant libraries, you need to know the realm to specify in the
25697 lookup and then ask for the &"userPassword"& attribute for that user in that
25698 realm, with:
25699 .code
25700 cyrusless_crammd5:
25701   driver = cram_md5
25702   public_name = CRAM-MD5
25703   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
25704                   dbmjz{/etc/sasldb2}{$value}fail}
25705   server_set_id = $auth1
25706 .endd
25707
25708 .section "Using cram_md5 as a client" "SECID177"
25709 .cindex "options" "&(cram_md5)& authenticator (client)"
25710 When used as a client, the &(cram_md5)& authenticator has two options:
25711
25712
25713
25714 .option client_name cram_md5 string&!! "the primary host name"
25715 This string is expanded, and the result used as the user name data when
25716 computing the response to the server's challenge.
25717
25718
25719 .option client_secret cram_md5 string&!! unset
25720 This option must be set for the authenticator to work as a client. Its value is
25721 expanded and the result used as the secret string when computing the response.
25722
25723
25724 .vindex "&$host$&"
25725 .vindex "&$host_address$&"
25726 Different user names and secrets can be used for different servers by referring
25727 to &$host$& or &$host_address$& in the options. Forced failure of either
25728 expansion string is treated as an indication that this authenticator is not
25729 prepared to handle this case. Exim moves on to the next configured client
25730 authenticator. Any other expansion failure causes Exim to give up trying to
25731 send the message to the current server.
25732
25733 A simple example configuration of a &(cram_md5)& authenticator, using fixed
25734 strings, is:
25735 .code
25736 fixed_cram:
25737   driver = cram_md5
25738   public_name = CRAM-MD5
25739   client_name = ph10
25740   client_secret = secret
25741 .endd
25742 .ecindex IIDcramauth1
25743 .ecindex IIDcramauth2
25744
25745
25746
25747 . ////////////////////////////////////////////////////////////////////////////
25748 . ////////////////////////////////////////////////////////////////////////////
25749
25750 .chapter "The cyrus_sasl authenticator" "CHID10"
25751 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
25752 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
25753 .cindex "Cyrus" "SASL library"
25754 .cindex "Kerberos"
25755 The code for this authenticator was provided by Matthew Byng-Maddick of A L
25756 Digital Ltd (&url(http://www.aldigital.co.uk)).
25757
25758 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
25759 library implementation of the RFC 2222 (&"Simple Authentication and Security
25760 Layer"&). This library supports a number of authentication mechanisms,
25761 including PLAIN and LOGIN, but also several others that Exim does not support
25762 directly. In particular, there is support for Kerberos authentication.
25763
25764 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
25765 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
25766 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
25767 name of the driver to determine which mechanism to support.
25768
25769 Where access to some kind of secret file is required, for example in GSSAPI
25770 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
25771 user, and that the Cyrus SASL library has no way of escalating privileges
25772 by default. You may also find you need to set environment variables,
25773 depending on the driver you are using.
25774
25775 The application name provided by Exim is &"exim"&, so various SASL options may
25776 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
25777 Kerberos, note that because of limitations in the GSSAPI interface,
25778 changing the server keytab might need to be communicated down to the Kerberos
25779 layer independently. The mechanism for doing so is dependent upon the Kerberos
25780 implementation.
25781
25782 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
25783 may be set to point to an alternative keytab file. Exim will pass this
25784 variable through from its own inherited environment when started as root or the
25785 Exim user. The keytab file needs to be readable by the Exim user.
25786 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
25787 environment variable.  In practice, for those releases, the Cyrus authenticator
25788 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
25789 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
25790
25791
25792 .section "Using cyrus_sasl as a server" "SECID178"
25793 The &(cyrus_sasl)& authenticator has four private options. It puts the username
25794 (on a successful authentication) into &$auth1$&. For compatibility with
25795 previous releases of Exim, the username is also placed in &$1$&. However, the
25796 use of this variable for this purpose is now deprecated, as it can lead to
25797 confusion in string expansions that also use numeric variables for other
25798 things.
25799
25800
25801 .option server_hostname cyrus_sasl string&!! "see below"
25802 This option selects the hostname that is used when communicating with the
25803 library. The default value is &`$primary_hostname`&. It is up to the underlying
25804 SASL plug-in what it does with this data.
25805
25806
25807 .option server_mech cyrus_sasl string "see below"
25808 This option selects the authentication mechanism this driver should use. The
25809 default is the value of the generic &%public_name%& option. This option allows
25810 you to use a different underlying mechanism from the advertised name. For
25811 example:
25812 .code
25813 sasl:
25814   driver = cyrus_sasl
25815   public_name = X-ANYTHING
25816   server_mech = CRAM-MD5
25817   server_set_id = $auth1
25818 .endd
25819
25820 .option server_realm cyrus_sasl string&!! unset
25821 This specifies the SASL realm that the server claims to be in.
25822
25823
25824 .option server_service cyrus_sasl string &`smtp`&
25825 This is the SASL service that the server claims to implement.
25826
25827
25828 For straightforward cases, you do not need to set any of the authenticator's
25829 private options. All you need to do is to specify an appropriate mechanism as
25830 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
25831 PLAIN, you could have two authenticators as follows:
25832 .code
25833 sasl_cram_md5:
25834   driver = cyrus_sasl
25835   public_name = CRAM-MD5
25836   server_set_id = $auth1
25837
25838 sasl_plain:
25839   driver = cyrus_sasl
25840   public_name = PLAIN
25841   server_set_id = $auth2
25842 .endd
25843 Cyrus SASL does implement the LOGIN authentication method, even though it is
25844 not a standard method. It is disabled by default in the source distribution,
25845 but it is present in many binary distributions.
25846 .ecindex IIDcyrauth1
25847 .ecindex IIDcyrauth2
25848
25849
25850
25851
25852 . ////////////////////////////////////////////////////////////////////////////
25853 . ////////////////////////////////////////////////////////////////////////////
25854 .chapter "The dovecot authenticator" "CHAPdovecot"
25855 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
25856 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
25857 This authenticator is an interface to the authentication facility of the
25858 Dovecot POP/IMAP server, which can support a number of authentication methods.
25859 Note that Dovecot must be configured to use auth-client not auth-userdb.
25860 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
25861 to use the same mechanisms for SMTP authentication. This is a server
25862 authenticator only. There is only one option:
25863
25864 .option server_socket dovecot string unset
25865
25866 This option must specify the socket that is the interface to Dovecot
25867 authentication. The &%public_name%& option must specify an authentication
25868 mechanism that Dovecot is configured to support. You can have several
25869 authenticators for different mechanisms. For example:
25870 .code
25871 dovecot_plain:
25872   driver = dovecot
25873   public_name = PLAIN
25874   server_socket = /var/run/dovecot/auth-client
25875   server_set_id = $auth1
25876
25877 dovecot_ntlm:
25878   driver = dovecot
25879   public_name = NTLM
25880   server_socket = /var/run/dovecot/auth-client
25881   server_set_id = $auth1
25882 .endd
25883 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
25884 &$received_ip_address$& (that is, the connection is local), the &"secured"&
25885 option is passed in the Dovecot authentication command. If, for a TLS
25886 connection, a client certificate has been verified, the &"valid-client-cert"&
25887 option is passed. When authentication succeeds, the identity of the user
25888 who authenticated is placed in &$auth1$&.
25889 .ecindex IIDdcotauth1
25890 .ecindex IIDdcotauth2
25891
25892
25893 . ////////////////////////////////////////////////////////////////////////////
25894 . ////////////////////////////////////////////////////////////////////////////
25895 .chapter "The gsasl authenticator" "CHAPgsasl"
25896 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
25897 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
25898 .cindex "authentication" "GNU SASL"
25899 .cindex "authentication" "SASL"
25900 .cindex "authentication" "EXTERNAL"
25901 .cindex "authentication" "ANONYMOUS"
25902 .cindex "authentication" "PLAIN"
25903 .cindex "authentication" "LOGIN"
25904 .cindex "authentication" "DIGEST-MD5"
25905 .cindex "authentication" "CRAM-MD5"
25906 .cindex "authentication" "SCRAM-SHA-1"
25907 The &(gsasl)& authenticator provides server integration for the GNU SASL
25908 library and the mechanisms it provides.  This is new as of the 4.80 release
25909 and there are a few areas where the library does not let Exim smoothly
25910 scale to handle future authentication mechanisms, so no guarantee can be
25911 made that any particular new authentication mechanism will be supported
25912 without code changes in Exim.
25913
25914
25915 .option server_channelbinding gsasl boolean false
25916 Some authentication mechanisms are able to use external context at both ends
25917 of the session to bind the authentication to that context, and fail the
25918 authentication process if that context differs.  Specifically, some TLS
25919 ciphersuites can provide identifying information about the cryptographic
25920 context.
25921
25922 This means that certificate identity and verification becomes a non-issue,
25923 as a man-in-the-middle attack will cause the correct client and server to
25924 see different identifiers and authentication will fail.
25925
25926 This is currently only supported when using the GnuTLS library.  This is
25927 only usable by mechanisms which support "channel binding"; at time of
25928 writing, that's the SCRAM family.
25929
25930 This defaults off to ensure smooth upgrade across Exim releases, in case
25931 this option causes some clients to start failing.  Some future release
25932 of Exim may switch the default to be true.
25933
25934
25935 .option server_hostname gsasl string&!! "see below"
25936 This option selects the hostname that is used when communicating with the
25937 library. The default value is &`$primary_hostname`&.
25938 Some mechanisms will use this data.
25939
25940
25941 .option server_mech gsasl string "see below"
25942 This option selects the authentication mechanism this driver should use. The
25943 default is the value of the generic &%public_name%& option. This option allows
25944 you to use a different underlying mechanism from the advertised name. For
25945 example:
25946 .code
25947 sasl:
25948   driver = gsasl
25949   public_name = X-ANYTHING
25950   server_mech = CRAM-MD5
25951   server_set_id = $auth1
25952 .endd
25953
25954
25955 .option server_password gsasl string&!! unset
25956 Various mechanisms need access to the cleartext password on the server, so
25957 that proof-of-possession can be demonstrated on the wire, without sending
25958 the password itself.
25959
25960 The data available for lookup varies per mechanism.
25961 In all cases, &$auth1$& is set to the &'authentication id'&.
25962 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
25963 if available, else the empty string.
25964 The &$auth3$& variable will always be the &'realm'& if available,
25965 else the empty string.
25966
25967 A forced failure will cause authentication to defer.
25968
25969 If using this option, it may make sense to set the &%server_condition%&
25970 option to be simply "true".
25971
25972
25973 .option server_realm gsasl string&!! unset
25974 This specifies the SASL realm that the server claims to be in.
25975 Some mechanisms will use this data.
25976
25977
25978 .option server_scram_iter gsasl string&!! unset
25979 This option provides data for the SCRAM family of mechanisms.
25980 &$auth1$& is not available at evaluation time.
25981 (This may change, as we receive feedback on use)
25982
25983
25984 .option server_scram_salt gsasl string&!! unset
25985 This option provides data for the SCRAM family of mechanisms.
25986 &$auth1$& is not available at evaluation time.
25987 (This may change, as we receive feedback on use)
25988
25989
25990 .option server_service gsasl string &`smtp`&
25991 This is the SASL service that the server claims to implement.
25992 Some mechanisms will use this data.
25993
25994
25995 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
25996 .vindex "&$auth1$&, &$auth2$&, etc"
25997 These may be set when evaluating specific options, as detailed above.
25998 They will also be set when evaluating &%server_condition%&.
25999
26000 Unless otherwise stated below, the &(gsasl)& integration will use the following
26001 meanings for these variables:
26002
26003 .ilist
26004 .vindex "&$auth1$&"
26005 &$auth1$&: the &'authentication id'&
26006 .next
26007 .vindex "&$auth2$&"
26008 &$auth2$&: the &'authorization id'&
26009 .next
26010 .vindex "&$auth3$&"
26011 &$auth3$&: the &'realm'&
26012 .endlist
26013
26014 On a per-mechanism basis:
26015
26016 .ilist
26017 .cindex "authentication" "EXTERNAL"
26018 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26019 the &%server_condition%& option must be present.
26020 .next
26021 .cindex "authentication" "ANONYMOUS"
26022 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26023 the &%server_condition%& option must be present.
26024 .next
26025 .cindex "authentication" "GSSAPI"
26026 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26027 &$auth2$& will be set to the &'authorization id'&,
26028 the &%server_condition%& option must be present.
26029 .endlist
26030
26031 An &'anonymous token'& is something passed along as an unauthenticated
26032 identifier; this is analogous to FTP anonymous authentication passing an
26033 email address, or software-identifier@, as the "password".
26034
26035
26036 An example showing the password having the realm specified in the callback
26037 and demonstrating a Cyrus SASL to GSASL migration approach is:
26038 .code
26039 gsasl_cyrusless_crammd5:
26040   driver = gsasl
26041   public_name = CRAM-MD5
26042   server_realm = imap.example.org
26043   server_password = ${lookup{$auth1:$auth3:userPassword}\
26044                     dbmjz{/etc/sasldb2}{$value}fail}
26045   server_set_id = ${quote:$auth1}
26046   server_condition = yes
26047 .endd
26048
26049
26050 . ////////////////////////////////////////////////////////////////////////////
26051 . ////////////////////////////////////////////////////////////////////////////
26052
26053 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26054 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26055 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26056 .cindex "authentication" "GSSAPI"
26057 .cindex "authentication" "Kerberos"
26058 The &(heimdal_gssapi)& authenticator provides server integration for the
26059 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26060 reliably.
26061
26062 .option server_hostname heimdal_gssapi string&!! "see below"
26063 This option selects the hostname that is used, with &%server_service%&,
26064 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26065 identifier.  The default value is &`$primary_hostname`&.
26066
26067 .option server_keytab heimdal_gssapi string&!! unset
26068 If set, then Heimdal will not use the system default keytab (typically
26069 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26070 The value should be a pathname, with no &"file:"& prefix.
26071
26072 .option server_service heimdal_gssapi string&!! "smtp"
26073 This option specifies the service identifier used, in conjunction with
26074 &%server_hostname%&, for building the identifer for finding credentials
26075 from the keytab.
26076
26077
26078 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26079 Beware that these variables will typically include a realm, thus will appear
26080 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26081 not verified, so a malicious client can set it to anything.
26082
26083 The &$auth1$& field should be safely trustable as a value from the Key
26084 Distribution Center.  Note that these are not quite email addresses.
26085 Each identifier is for a role, and so the left-hand-side may include a
26086 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26087
26088 .vindex "&$auth1$&, &$auth2$&, etc"
26089 .ilist
26090 .vindex "&$auth1$&"
26091 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26092 .next
26093 .vindex "&$auth2$&"
26094 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26095 authentication.  If that was empty, this will also be set to the
26096 GSS Display Name.
26097 .endlist
26098
26099
26100 . ////////////////////////////////////////////////////////////////////////////
26101 . ////////////////////////////////////////////////////////////////////////////
26102
26103 .chapter "The spa authenticator" "CHAPspa"
26104 .scindex IIDspaauth1 "&(spa)& authenticator"
26105 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26106 .cindex "authentication" "Microsoft Secure Password"
26107 .cindex "authentication" "NTLM"
26108 .cindex "Microsoft Secure Password Authentication"
26109 .cindex "NTLM authentication"
26110 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26111 Password Authentication'& mechanism,
26112 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26113 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26114 taken from the Samba project (&url(http://www.samba.org)). The code for the
26115 server side was subsequently contributed by Tom Kistner. The mechanism works as
26116 follows:
26117
26118 .ilist
26119 After the AUTH command has been accepted, the client sends an SPA
26120 authentication request based on the user name and optional domain.
26121 .next
26122 The server sends back a challenge.
26123 .next
26124 The client builds a challenge response which makes use of the user's password
26125 and sends it to the server, which then accepts or rejects it.
26126 .endlist
26127
26128 Encryption is used to protect the password in transit.
26129
26130
26131
26132 .section "Using spa as a server" "SECID179"
26133 .cindex "options" "&(spa)& authenticator (server)"
26134 The &(spa)& authenticator has just one server option:
26135
26136 .option server_password spa string&!! unset
26137 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26138 This option is expanded, and the result must be the cleartext password for the
26139 authenticating user, whose name is at this point in &$auth1$&. For
26140 compatibility with previous releases of Exim, the user name is also placed in
26141 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26142 it can lead to confusion in string expansions that also use numeric variables
26143 for other things. For example:
26144 .code
26145 spa:
26146   driver = spa
26147   public_name = NTLM
26148   server_password = \
26149     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26150 .endd
26151 If the expansion is forced to fail, authentication fails. Any other expansion
26152 failure causes a temporary error code to be returned.
26153
26154
26155
26156
26157
26158 .section "Using spa as a client" "SECID180"
26159 .cindex "options" "&(spa)& authenticator (client)"
26160 The &(spa)& authenticator has the following client options:
26161
26162
26163
26164 .option client_domain spa string&!! unset
26165 This option specifies an optional domain for the authentication.
26166
26167
26168 .option client_password spa string&!! unset
26169 This option specifies the user's password, and must be set.
26170
26171
26172 .option client_username spa string&!! unset
26173 This option specifies the user name, and must be set. Here is an example of a
26174 configuration of this authenticator for use with the mail servers at
26175 &'msn.com'&:
26176 .code
26177 msn:
26178   driver = spa
26179   public_name = MSN
26180   client_username = msn/msn_username
26181   client_password = msn_plaintext_password
26182   client_domain = DOMAIN_OR_UNSET
26183 .endd
26184 .ecindex IIDspaauth1
26185 .ecindex IIDspaauth2
26186
26187
26188
26189
26190
26191 . ////////////////////////////////////////////////////////////////////////////
26192 . ////////////////////////////////////////////////////////////////////////////
26193
26194 .new
26195 .chapter "The tls authenticator" "CHAPtlsauth"
26196 .scindex IIDtlsauth1 "&(tls)& authenticator"
26197 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26198 .cindex "authentication" "Client Certificate"
26199 .cindex "authentication" "X509"
26200 .cindex "Certificate-based authentication"
26201 The &(tls)& authenticator provides server support for
26202 authentication based on client certificates.
26203
26204 It is not an SMTP authentication mechanism and is not
26205 advertised by the server as part of the SMTP EHLO response.
26206 It is an Exim authenticator in the sense that it affects
26207 the protocol element of the log line, can be tested for
26208 by the &%authenticated%& ACL condition, and can set
26209 the &$authenticated_id$& variable.
26210
26211 The client must present a verifiable certificate,
26212 for which it must have been requested via the
26213 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26214 (see &<<CHAPTLS>>&).
26215
26216 If an authenticator of this type is configured it is
26217 run before any SMTP-level communication is done,
26218 and can authenticate the connection.
26219 If it does, SMTP suthentication is not offered.
26220
26221 A maximum of one authenticator of this type may be present.
26222
26223
26224 .cindex "options" "&(tls)& authenticator (server)"
26225 The &(tls)& authenticator has three server options:
26226
26227 .option server_param1 tls string&!! unset
26228 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26229 This option is expanded after the TLS negotiation and
26230 the result is placed in &$auth1$&.
26231 If the expansion is forced to fail, authentication fails. Any other expansion
26232 failure causes a temporary error code to be returned.
26233
26234 .option server_param2 tls string&!! unset
26235 .option server_param3 tls string&!! unset
26236 As above, for &$auth2$& and &$auth3$&.
26237
26238 &%server_param1%& may also be spelled &%server_param%&.
26239
26240
26241 Example:
26242 .code
26243 tls:
26244   driver = tls
26245   server_param1 =     ${certextract {subj_altname,mail,>:} \
26246                                     {$tls_in_peercert}}
26247   server_condition =  ${if forany {$auth1} \
26248                             {!= {0} \
26249                                 {${lookup ldap{ldap:///\
26250                          mailname=${quote_ldap_dn:${lc:$item}},\
26251                          ou=users,LDAP_DC?mailid} {$value}{0} \
26252                        }    }   } }
26253   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26254 .endd
26255 .ecindex IIDtlsauth1
26256 .ecindex IIDtlsauth2
26257 .wen
26258
26259
26260 Note that because authentication is traditionally an SMTP operation,
26261 the &%authenticated%& ACL condition cannot be used in
26262 a connect- or helo-ACL.
26263
26264
26265
26266 . ////////////////////////////////////////////////////////////////////////////
26267 . ////////////////////////////////////////////////////////////////////////////
26268
26269 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26270          "Encrypted SMTP connections"
26271 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26272 .scindex IIDencsmtp2 "SMTP" "encryption"
26273 .cindex "TLS" "on SMTP connection"
26274 .cindex "OpenSSL"
26275 .cindex "GnuTLS"
26276 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26277 Sockets Layer), is implemented by making use of the OpenSSL library or the
26278 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26279 cryptographic code in the Exim distribution itself for implementing TLS. In
26280 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26281 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26282 You also need to understand the basic concepts of encryption at a managerial
26283 level, and in particular, the way that public keys, private keys, and
26284 certificates are used.
26285
26286 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26287 connection is established, the client issues a STARTTLS command. If the
26288 server accepts this, the client and the server negotiate an encryption
26289 mechanism. If the negotiation succeeds, the data that subsequently passes
26290 between them is encrypted.
26291
26292 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26293 and if so, what cipher suite is in use, whether the client supplied a
26294 certificate, and whether or not that certificate was verified. This makes it
26295 possible for an Exim server to deny or accept certain commands based on the
26296 encryption state.
26297
26298 &*Warning*&: Certain types of firewall and certain anti-virus products can
26299 disrupt TLS connections. You need to turn off SMTP scanning for these products
26300 in order to get TLS to work.
26301
26302
26303
26304 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
26305          "SECID284"
26306 .cindex "ssmtp protocol"
26307 .cindex "smtps protocol"
26308 .cindex "SMTP" "ssmtp protocol"
26309 .cindex "SMTP" "smtps protocol"
26310 Early implementations of encrypted SMTP used a different TCP port from normal
26311 SMTP, and expected an encryption negotiation to start immediately, instead of
26312 waiting for a STARTTLS command from the client using the standard SMTP
26313 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
26314 allocated for this purpose.
26315
26316 This approach was abandoned when encrypted SMTP was standardized, but there are
26317 still some legacy clients that use it. Exim supports these clients by means of
26318 the &%tls_on_connect_ports%& global option. Its value must be a list of port
26319 numbers; the most common use is expected to be:
26320 .code
26321 tls_on_connect_ports = 465
26322 .endd
26323 The port numbers specified by this option apply to all SMTP connections, both
26324 via the daemon and via &'inetd'&. You still need to specify all the ports that
26325 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
26326 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
26327 an extra port &-- rather, it specifies different behaviour on a port that is
26328 defined elsewhere.
26329
26330 There is also a &%-tls-on-connect%& command line option. This overrides
26331 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
26332
26333
26334
26335
26336
26337
26338 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
26339 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
26340 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
26341 followed later, when the first versions of GnuTLS were released. To build Exim
26342 to use GnuTLS, you need to set
26343 .code
26344 USE_GNUTLS=yes
26345 .endd
26346 in Local/Makefile, in addition to
26347 .code
26348 SUPPORT_TLS=yes
26349 .endd
26350 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
26351 include files and libraries for GnuTLS can be found.
26352
26353 There are some differences in usage when using GnuTLS instead of OpenSSL:
26354
26355 .ilist
26356 The &%tls_verify_certificates%& option
26357 cannot be the path of a directory
26358 for GnuTLS versions before 3.3.6
26359 (for later versions, or OpenSSL, it can be either).
26360 .next
26361 The default value for &%tls_dhparam%& differs for historical reasons.
26362 .next
26363 .vindex "&$tls_in_peerdn$&"
26364 .vindex "&$tls_out_peerdn$&"
26365 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
26366 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
26367 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
26368 .next
26369 OpenSSL identifies cipher suites using hyphens as separators, for example:
26370 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
26371 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
26372 in a cipher list. To make life simpler, Exim changes underscores to hyphens
26373 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
26374 to handle its own older variants) when processing lists of cipher suites in the
26375 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
26376 option).
26377 .next
26378 The &%tls_require_ciphers%& options operate differently, as described in the
26379 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
26380 .next
26381 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
26382 When using OpenSSL, this option is ignored.
26383 (If an API is found to let OpenSSL be configured in this way,
26384 let the Exim Maintainers know and we'll likely use it).
26385 .next
26386 Some other recently added features may only be available in one or the other.
26387 This should be documented with the feature.  If the documentation does not
26388 explicitly state that the feature is infeasible in the other TLS
26389 implementation, then patches are welcome.
26390 .endlist
26391
26392
26393 .section "GnuTLS parameter computation" "SECTgnutlsparam"
26394 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
26395 an explicit path; if the latter, then the text about generation still applies,
26396 but not the chosen filename.
26397 By default, as of Exim 4.80 a hard-coded D-H prime is used.
26398 See the documentation of &%tls_dhparam%& for more information.
26399
26400 GnuTLS uses D-H parameters that may take a substantial amount of time
26401 to compute. It is unreasonable to re-compute them for every TLS session.
26402 Therefore, Exim keeps this data in a file in its spool directory, called
26403 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
26404 of bits requested.
26405 The file is owned by the Exim user and is readable only by
26406 its owner. Every Exim process that start up GnuTLS reads the D-H
26407 parameters from this file. If the file does not exist, the first Exim process
26408 that needs it computes the data and writes it to a temporary file which is
26409 renamed once it is complete. It does not matter if several Exim processes do
26410 this simultaneously (apart from wasting a few resources). Once a file is in
26411 place, new Exim processes immediately start using it.
26412
26413 For maximum security, the parameters that are stored in this file should be
26414 recalculated periodically, the frequency depending on your paranoia level.
26415 If you are avoiding using the fixed D-H primes published in RFCs, then you
26416 are concerned about some advanced attacks and will wish to do this; if you do
26417 not regenerate then you might as well stick to the standard primes.
26418
26419 Arranging this is easy in principle; just delete the file when you want new
26420 values to be computed. However, there may be a problem. The calculation of new
26421 parameters needs random numbers, and these are obtained from &_/dev/random_&.
26422 If the system is not very active, &_/dev/random_& may delay returning data
26423 until enough randomness (entropy) is available. This may cause Exim to hang for
26424 a substantial amount of time, causing timeouts on incoming connections.
26425
26426 The solution is to generate the parameters externally to Exim. They are stored
26427 in &_gnutls-params-N_& in PEM format, which means that they can be
26428 generated externally using the &(certtool)& command that is part of GnuTLS.
26429
26430 To replace the parameters with new ones, instead of deleting the file
26431 and letting Exim re-create it, you can generate new parameters using
26432 &(certtool)& and, when this has been done, replace Exim's cache file by
26433 renaming. The relevant commands are something like this:
26434 .code
26435 # ls
26436 [ look for file; assume gnutls-params-2236 is the most recent ]
26437 # rm -f new-params
26438 # touch new-params
26439 # chown exim:exim new-params
26440 # chmod 0600 new-params
26441 # certtool --generate-dh-params --bits 2236 >>new-params
26442 # openssl dhparam -noout -text -in new-params | head
26443 [ check the first line, make sure it's not more than 2236;
26444   if it is, then go back to the start ("rm") and repeat
26445   until the size generated is at most the size requested ]
26446 # chmod 0400 new-params
26447 # mv new-params gnutls-params-2236
26448 .endd
26449 If Exim never has to generate the parameters itself, the possibility of
26450 stalling is removed.
26451
26452 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
26453 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
26454 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
26455 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
26456 and Exim does so.  This attempt to remove Exim from TLS policy decisions
26457 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
26458 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
26459 which applies to all D-H usage, client or server.  If the value returned by
26460 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
26461 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
26462 limit, which is still much higher than Exim historically used.
26463
26464 The filename and bits used will change as the GnuTLS maintainers change the
26465 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
26466 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
26467 2432 bits, while NSS is limited to 2236 bits.
26468
26469 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
26470 increase the chance of the generated prime actually being within acceptable
26471 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
26472 procedure above.  There is no sane procedure available to Exim to double-check
26473 the size of the generated prime, so it might still be too large.
26474
26475
26476 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
26477 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
26478 .oindex "&%tls_require_ciphers%&" "OpenSSL"
26479 There is a function in the OpenSSL library that can be passed a list of cipher
26480 suites before the cipher negotiation takes place. This specifies which ciphers
26481 are acceptable. The list is colon separated and may contain names like
26482 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
26483 directly to this function call.
26484 Many systems will install the OpenSSL manual-pages, so you may have
26485 &'ciphers(1)'& available to you.
26486 The following quotation from the OpenSSL
26487 documentation specifies what forms of item are allowed in the cipher string:
26488
26489 .ilist
26490 It can consist of a single cipher suite such as RC4-SHA.
26491 .next
26492 It can represent a list of cipher suites containing a certain algorithm,
26493 or cipher suites of a certain type. For example SHA1 represents all
26494 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
26495 SSL v3 algorithms.
26496 .next
26497 Lists of cipher suites can be combined in a single cipher string using
26498 the + character. This is used as a logical and operation. For example
26499 SHA1+DES represents all cipher suites containing the SHA1 and the DES
26500 algorithms.
26501 .endlist
26502
26503 Each cipher string can be optionally preceded by one of the characters &`!`&,
26504 &`-`& or &`+`&.
26505 .ilist
26506 If &`!`& is used, the ciphers are permanently deleted from the list. The
26507 ciphers deleted can never reappear in the list even if they are explicitly
26508 stated.
26509 .next
26510 If &`-`& is used, the ciphers are deleted from the list, but some or all
26511 of the ciphers can be added again by later options.
26512 .next
26513 If &`+`& is used, the ciphers are moved to the end of the list. This
26514 option does not add any new ciphers; it just moves matching existing ones.
26515 .endlist
26516
26517 If none of these characters is present, the string is interpreted as
26518 a list of ciphers to be appended to the current preference list. If the list
26519 includes any ciphers already present they will be ignored: that is, they will
26520 not be moved to the end of the list.
26521 .endlist
26522
26523 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
26524 string:
26525 .code
26526 # note single-quotes to get ! past any shell history expansion
26527 $ openssl ciphers 'HIGH:!MD5:!SHA1'
26528 .endd
26529
26530 This example will let the library defaults be permitted on the MX port, where
26531 there's probably no identity verification anyway, but ups the ante on the
26532 submission ports where the administrator might have some influence on the
26533 choice of clients used:
26534 .code
26535 # OpenSSL variant; see man ciphers(1)
26536 tls_require_ciphers = ${if =={$received_port}{25}\
26537                            {DEFAULT}\
26538                            {HIGH:!MD5:!SHA1}}
26539 .endd
26540
26541
26542
26543 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
26544          "SECTreqciphgnu"
26545 .cindex "GnuTLS" "specifying parameters for"
26546 .cindex "TLS" "specifying ciphers (GnuTLS)"
26547 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
26548 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
26549 .cindex "TLS" "specifying protocols (GnuTLS)"
26550 .cindex "TLS" "specifying priority string (GnuTLS)"
26551 .oindex "&%tls_require_ciphers%&" "GnuTLS"
26552 The GnuTLS library allows the caller to provide a "priority string", documented
26553 as part of the &[gnutls_priority_init]& function.  This is very similar to the
26554 ciphersuite specification in OpenSSL.
26555
26556 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
26557 and controls both protocols and ciphers.
26558
26559 The &%tls_require_ciphers%& option is available both as an global option,
26560 controlling how Exim behaves as a server, and also as an option of the
26561 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
26562 the value is string expanded.  The resulting string is not an Exim list and
26563 the string is given to the GnuTLS library, so that Exim does not need to be
26564 aware of future feature enhancements of GnuTLS.
26565
26566 Documentation of the strings accepted may be found in the GnuTLS manual, under
26567 "Priority strings".  This is online as
26568 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
26569 but beware that this relates to GnuTLS 3, which may be newer than the version
26570 installed on your system.  If you are using GnuTLS 3,
26571 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string, then the example code)
26572 on that site can be used to test a given string.
26573
26574 For example:
26575 .code
26576 # Disable older versions of protocols
26577 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
26578 .endd
26579
26580 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
26581 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
26582 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
26583
26584 This example will let the library defaults be permitted on the MX port, where
26585 there's probably no identity verification anyway, and lowers security further
26586 by increasing compatibility; but this ups the ante on the submission ports
26587 where the administrator might have some influence on the choice of clients
26588 used:
26589 .code
26590 # GnuTLS variant
26591 tls_require_ciphers = ${if =={$received_port}{25}\
26592                            {NORMAL:%COMPAT}\
26593                            {SECURE128}}
26594 .endd
26595
26596
26597 .section "Configuring an Exim server to use TLS" "SECID182"
26598 .cindex "TLS" "configuring an Exim server"
26599 When Exim has been built with TLS support, it advertises the availability of
26600 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
26601 but not to any others. The default value of this option is unset, which means
26602 that STARTTLS is not advertised at all. This default is chosen because you
26603 need to set some other options in order to make TLS available, and also it is
26604 sensible for systems that want to use TLS only as a client.
26605
26606 If a client issues a STARTTLS command and there is some configuration
26607 problem in the server, the command is rejected with a 454 error. If the client
26608 persists in trying to issue SMTP commands, all except QUIT are rejected
26609 with the error
26610 .code
26611 554 Security failure
26612 .endd
26613 If a STARTTLS command is issued within an existing TLS session, it is
26614 rejected with a 554 error code.
26615
26616 To enable TLS operations on a server, you must set &%tls_advertise_hosts%& to
26617 match some hosts. You can, of course, set it to * to match all hosts.
26618 However, this is not all you need to do. TLS sessions to a server won't work
26619 without some further configuration at the server end.
26620
26621 It is rumoured that all existing clients that support TLS/SSL use RSA
26622 encryption. To make this work you need to set, in the server,
26623 .code
26624 tls_certificate = /some/file/name
26625 tls_privatekey = /some/file/name
26626 .endd
26627 These options are, in fact, expanded strings, so you can make them depend on
26628 the identity of the client that is connected if you wish. The first file
26629 contains the server's X509 certificate, and the second contains the private key
26630 that goes with it. These files need to be
26631 PEM format and readable by the Exim user, and must
26632 always be given as full path names.
26633 The key must not be password-protected.
26634 They can be the same file if both the
26635 certificate and the key are contained within it. If &%tls_privatekey%& is not
26636 set, or if its expansion is forced to fail or results in an empty string, this
26637 is assumed to be the case. The certificate file may also contain intermediate
26638 certificates that need to be sent to the client to enable it to authenticate
26639 the server's certificate.
26640
26641 If you do not understand about certificates and keys, please try to find a
26642 source of this background information, which is not Exim-specific. (There are a
26643 few comments below in section &<<SECTcerandall>>&.)
26644
26645 &*Note*&: These options do not apply when Exim is operating as a client &--
26646 they apply only in the case of a server. If you need to use a certificate in an
26647 Exim client, you must set the options of the same names in an &(smtp)&
26648 transport.
26649
26650 With just these options, an Exim server will be able to use TLS. It does not
26651 require the client to have a certificate (but see below for how to insist on
26652 this). There is one other option that may be needed in other situations. If
26653 .code
26654 tls_dhparam = /some/file/name
26655 .endd
26656 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
26657 with the parameters contained in the file.
26658 Set this to &`none`& to disable use of DH entirely, by making no prime
26659 available:
26660 .code
26661 tls_dhparam = none
26662 .endd
26663 This may also be set to a string identifying a standard prime to be used for
26664 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
26665 used is &`ike23`&.  There are a few standard primes available, see the
26666 documentation for &%tls_dhparam%& for the complete list.
26667
26668 See the command
26669 .code
26670 openssl dhparam
26671 .endd
26672 for a way of generating file data.
26673
26674 The strings supplied for these three options are expanded every time a client
26675 host connects. It is therefore possible to use different certificates and keys
26676 for different hosts, if you so wish, by making use of the client's IP address
26677 in &$sender_host_address$& to control the expansion. If a string expansion is
26678 forced to fail, Exim behaves as if the option is not set.
26679
26680 .cindex "cipher" "logging"
26681 .cindex "log" "TLS cipher"
26682 .vindex "&$tls_in_cipher$&"
26683 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
26684 an incoming TLS connection. It is included in the &'Received:'& header of an
26685 incoming message (by default &-- you can, of course, change this), and it is
26686 also included in the log line that records a message's arrival, keyed by
26687 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
26688 condition can be used to test for specific cipher suites in ACLs.
26689
26690 Once TLS has been established, the ACLs that run for subsequent SMTP commands
26691 can check the name of the cipher suite and vary their actions accordingly. The
26692 cipher suite names vary, depending on which TLS library is being used. For
26693 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
26694 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
26695 documentation for more details.
26696
26697 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
26698 (again depending on the &%tls_cipher%& log selector).
26699
26700
26701 .section "Requesting and verifying client certificates" "SECID183"
26702 .cindex "certificate" "verification of client"
26703 .cindex "TLS" "client certificate verification"
26704 If you want an Exim server to request a certificate when negotiating a TLS
26705 session with a client, you must set either &%tls_verify_hosts%& or
26706 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
26707 apply to all TLS connections. For any host that matches one of these options,
26708 Exim requests a certificate as part of the setup of the TLS session. The
26709 contents of the certificate are verified by comparing it with a list of
26710 expected certificates.
26711 .new
26712 These may be the system default set (depending on library version),
26713 .wen
26714 an explicit file or,
26715 depending on library version, a directory, identified by
26716 &%tls_verify_certificates%&.
26717
26718 A file can contain multiple certificates, concatenated end to end. If a
26719 directory is used
26720 (OpenSSL only),
26721 each certificate must be in a separate file, with a name (or a symbolic link)
26722 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
26723 certificate. You can compute the relevant hash by running the command
26724 .code
26725 openssl x509 -hash -noout -in /cert/file
26726 .endd
26727 where &_/cert/file_& contains a single certificate.
26728
26729 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
26730 what happens if the client does not supply a certificate, or if the certificate
26731 does not match any of the certificates in the collection named by
26732 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
26733 attempt to set up a TLS session is aborted, and the incoming connection is
26734 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
26735 session continues. ACLs that run for subsequent SMTP commands can detect the
26736 fact that no certificate was verified, and vary their actions accordingly. For
26737 example, you can insist on a certificate before accepting a message for
26738 relaying, but not when the message is destined for local delivery.
26739
26740 .vindex "&$tls_in_peerdn$&"
26741 When a client supplies a certificate (whether it verifies or not), the value of
26742 the Distinguished Name of the certificate is made available in the variable
26743 &$tls_in_peerdn$& during subsequent processing of the message.
26744
26745 .cindex "log" "distinguished name"
26746 Because it is often a long text string, it is not included in the log line or
26747 &'Received:'& header by default. You can arrange for it to be logged, keyed by
26748 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
26749 &%received_header_text%& to change the &'Received:'& header. When no
26750 certificate is supplied, &$tls_in_peerdn$& is empty.
26751
26752
26753 .section "Revoked certificates" "SECID184"
26754 .cindex "TLS" "revoked certificates"
26755 .cindex "revocation list"
26756 .cindex "certificate" "revocation list"
26757 .cindex "OCSP" "stapling"
26758 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
26759 certificates are revoked. If you have such a list, you can pass it to an Exim
26760 server using the global option called &%tls_crl%& and to an Exim client using
26761 an identically named option for the &(smtp)& transport. In each case, the value
26762 of the option is expanded and must then be the name of a file that contains a
26763 CRL in PEM format.
26764 The downside is that clients have to periodically re-download a potentially huge
26765 file from every certificate authority they know of.
26766
26767 The way with most moving parts at query time is Online Certificate
26768 Status Protocol (OCSP), where the client verifies the certificate
26769 against an OCSP server run by the CA.  This lets the CA track all
26770 usage of the certs.  It requires running software with access to the
26771 private key of the CA, to sign the responses to the OCSP queries.  OCSP
26772 is based on HTTP and can be proxied accordingly.
26773
26774 The only widespread OCSP server implementation (known to this writer)
26775 comes as part of OpenSSL and aborts on an invalid request, such as
26776 connecting to the port and then disconnecting.  This requires
26777 re-entering the passphrase each time some random client does this.
26778
26779 The third way is OCSP Stapling; in this, the server using a certificate
26780 issued by the CA periodically requests an OCSP proof of validity from
26781 the OCSP server, then serves it up inline as part of the TLS
26782 negotiation.   This approach adds no extra round trips, does not let the
26783 CA track users, scales well with number of certs issued by the CA and is
26784 resilient to temporary OCSP server failures, as long as the server
26785 starts retrying to fetch an OCSP proof some time before its current
26786 proof expires.  The downside is that it requires server support.
26787
26788 Unless Exim is built with the support disabled,
26789 or with GnuTLS earlier than version 3.1.3,
26790 support for OCSP stapling is included.
26791
26792 There is a global option called &%tls_ocsp_file%&.
26793 The file specified therein is expected to be in DER format, and contain
26794 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
26795 option will be re-expanded for SNI, if the &%tls_certificate%& option
26796 contains &`tls_in_sni`&, as per other TLS options.
26797
26798 Exim does not at this time implement any support for fetching a new OCSP
26799 proof.  The burden is on the administrator to handle this, outside of
26800 Exim.  The file specified should be replaced atomically, so that the
26801 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
26802 on each connection, so a new file will be handled transparently on the
26803 next connection.
26804
26805 When built with OpenSSL Exim will check for a valid next update timestamp
26806 in the OCSP proof; if not present, or if the proof has expired, it will be
26807 ignored.
26808
26809 For the client to be able to verify the stapled OCSP the server must
26810 also supply, in its stapled information, any intermediate
26811 certificates for the chain leading to the OCSP proof from the signer
26812 of the server certificate.  There may be zero or one such. These
26813 intermediate certificates should be added to the server OCSP stapling
26814 file named by &%tls_ocsp_file%&.
26815
26816 Note that the proof only covers the terminal server certificate,
26817 not any of the chain from CA to it.
26818
26819 There is no current way to staple a proof for a client certificate.
26820
26821 .code
26822   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
26823   OCSP server is supplied.  The server URL may be included in the
26824   server certificate, if the CA is helpful.
26825
26826   One failure mode seen was the OCSP Signer cert expiring before the end
26827   of validity of the OCSP proof. The checking done by Exim/OpenSSL
26828   noted this as invalid overall, but the re-fetch script did not.
26829 .endd
26830
26831
26832
26833
26834 .section "Configuring an Exim client to use TLS" "SECID185"
26835 .cindex "cipher" "logging"
26836 .cindex "log" "TLS cipher"
26837 .cindex "log" "distinguished name"
26838 .cindex "TLS" "configuring an Exim client"
26839 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
26840 deliveries as well as to incoming, the latter one causing logging of the
26841 server certificate's DN. The remaining client configuration for TLS is all
26842 within the &(smtp)& transport.
26843
26844 It is not necessary to set any options to have TLS work in the &(smtp)&
26845 transport. If Exim is built with TLS support, and TLS is advertised by a
26846 server, the &(smtp)& transport always tries to start a TLS session. However,
26847 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
26848 transport) to a list of server hosts for which TLS should not be used.
26849
26850 If you do not want Exim to attempt to send messages unencrypted when an attempt
26851 to set up an encrypted connection fails in any way, you can set
26852 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
26853 those hosts, delivery is always deferred if an encrypted connection cannot be
26854 set up. If there are any other hosts for the address, they are tried in the
26855 usual way.
26856
26857 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
26858 the message unencrypted. It always does this if the response to STARTTLS is
26859 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
26860 session after a success response code, what happens is controlled by the
26861 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
26862 delivery to this host is deferred, and other hosts (if available) are tried. If
26863 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
26864 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
26865 negotiation fails, Exim closes the current connection (because it is in an
26866 unknown state), opens a new one to the same host, and then tries the delivery
26867 unencrypted.
26868
26869 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
26870 transport provide the client with a certificate, which is passed to the server
26871 if it requests it. If the server is Exim, it will request a certificate only if
26872 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
26873
26874 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
26875 specifies a collection of expected server certificates.
26876 .new
26877 These may be the system default set (depending on library version),
26878 .wen
26879 a file or,
26880 depnding on liibrary version, a directory,
26881 must name a file or,
26882 for OpenSSL only (not GnuTLS), a directory.
26883 The client verifies the server's certificate
26884 against this collection, taking into account any revoked certificates that are
26885 in the list defined by &%tls_crl%&.
26886 Failure to verify fails the TLS connection unless either of the
26887 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
26888
26889 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
26890 certificate verification to the listed servers.  Verification either must
26891 or need not succeed respectively.
26892
26893 The &(smtp)& transport has two OCSP-related options:
26894 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
26895 is requested and required for the connection to proceed.  The default
26896 value is empty.
26897 &%hosts_request_ocsp%&; a host-list for which (additionally)
26898 a Certificate Status is requested (but not necessarily verified).  The default
26899 value is "*" meaning that requests are made unless configured
26900 otherwise.
26901
26902 The host(s) should also be in &%hosts_require_tls%&, and
26903 &%tls_verify_certificates%& configured for the transport,
26904 for OCSP to be relevant.
26905
26906 If
26907 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
26908 list of permitted cipher suites. If either of these checks fails, delivery to
26909 the current host is abandoned, and the &(smtp)& transport tries to deliver to
26910 alternative hosts, if any.
26911
26912  &*Note*&:
26913 These options must be set in the &(smtp)& transport for Exim to use TLS when it
26914 is operating as a client. Exim does not assume that a server certificate (set
26915 by the global options of the same name) should also be used when operating as a
26916 client.
26917
26918 .vindex "&$host$&"
26919 .vindex "&$host_address$&"
26920 All the TLS options in the &(smtp)& transport are expanded before use, with
26921 &$host$& and &$host_address$& containing the name and address of the server to
26922 which the client is connected. Forced failure of an expansion causes Exim to
26923 behave as if the relevant option were unset.
26924
26925 .vindex &$tls_out_bits$&
26926 .vindex &$tls_out_cipher$&
26927 .vindex &$tls_out_peerdn$&
26928 .vindex &$tls_out_sni$&
26929 Before an SMTP connection is established, the
26930 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
26931 variables are emptied. (Until the first connection, they contain the values
26932 that were set when the message was received.) If STARTTLS is subsequently
26933 successfully obeyed, these variables are set to the relevant values for the
26934 outgoing connection.
26935
26936
26937
26938 .section "Use of TLS Server Name Indication" "SECTtlssni"
26939 .cindex "TLS" "Server Name Indication"
26940 .vindex "&$tls_in_sni$&"
26941 .oindex "&%tls_in_sni%&"
26942 With TLS1.0 or above, there is an extension mechanism by which extra
26943 information can be included at various points in the protocol.  One of these
26944 extensions, documented in RFC 6066 (and before that RFC 4366) is
26945 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
26946 client in the initial handshake, so that the server can examine the servername
26947 within and possibly choose to use different certificates and keys (and more)
26948 for this session.
26949
26950 This is analagous to HTTP's &"Host:"& header, and is the main mechanism by
26951 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
26952 address.
26953
26954 With SMTP to MX, there are the same problems here as in choosing the identity
26955 against which to validate a certificate: you can't rely on insecure DNS to
26956 provide the identity which you then cryptographically verify.  So this will
26957 be of limited use in that environment.
26958
26959 With SMTP to Submission, there is a well-defined hostname which clients are
26960 connecting to and can validate certificates against.  Thus clients &*can*&
26961 choose to include this information in the TLS negotiation.  If this becomes
26962 wide-spread, then hosters can choose to present different certificates to
26963 different clients.  Or even negotiate different cipher suites.
26964
26965 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
26966 if not empty, will be sent on a TLS session as part of the handshake.  There's
26967 nothing more to it.  Choosing a sensible value not derived insecurely is the
26968 only point of caution.  The &$tls_out_sni$& variable will be set to this string
26969 for the lifetime of the client connection (including during authentication).
26970
26971 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
26972 received from a client.
26973 It can be logged with the &%log_selector%& item &`+tls_sni`&.
26974
26975 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
26976 option (prior to expansion) then the following options will be re-expanded
26977 during TLS session handshake, to permit alternative values to be chosen:
26978
26979 .ilist
26980 .vindex "&%tls_certificate%&"
26981 &%tls_certificate%&
26982 .next
26983 .vindex "&%tls_crl%&"
26984 &%tls_crl%&
26985 .next
26986 .vindex "&%tls_privatekey%&"
26987 &%tls_privatekey%&
26988 .next
26989 .vindex "&%tls_verify_certificates%&"
26990 &%tls_verify_certificates%&
26991 .next
26992 .vindex "&%tls_ocsp_file%&"
26993 &%tls_ocsp_file%&
26994 .endlist
26995
26996 Great care should be taken to deal with matters of case, various injection
26997 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
26998 can always be referenced; it is important to remember that &$tls_sni$& is
26999 arbitrary unverified data provided prior to authentication.
27000
27001 The Exim developers are proceeding cautiously and so far no other TLS options
27002 are re-expanded.
27003
27004 When Exim is built againt OpenSSL, OpenSSL must have been built with support
27005 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27006 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27007 see &`-servername`& in the output, then OpenSSL has support.
27008
27009 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27010 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27011 built, then you have SNI support).
27012
27013
27014
27015 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27016          "SECTmulmessam"
27017 .cindex "multiple SMTP deliveries with TLS"
27018 .cindex "TLS" "multiple message deliveries"
27019 Exim sends multiple messages down the same TCP/IP connection by starting up
27020 an entirely new delivery process for each message, passing the socket from
27021 one process to the next. This implementation does not fit well with the use
27022 of TLS, because there is quite a lot of state information associated with a TLS
27023 connection, not just a socket identification. Passing all the state information
27024 to a new process is not feasible. Consequently, Exim shuts down an existing TLS
27025 session before passing the socket to a new process. The new process may then
27026 try to start a new TLS session, and if successful, may try to re-authenticate
27027 if AUTH is in use, before sending the next message.
27028
27029 The RFC is not clear as to whether or not an SMTP session continues in clear
27030 after TLS has been shut down, or whether TLS may be restarted again later, as
27031 just described. However, if the server is Exim, this shutdown and
27032 reinitialization works. It is not known which (if any) other servers operate
27033 successfully if the client closes a TLS session and continues with unencrypted
27034 SMTP, but there are certainly some that do not work. For such servers, Exim
27035 should not pass the socket to another process, because the failure of the
27036 subsequent attempt to use it would cause Exim to record a temporary host error,
27037 and delay other deliveries to that host.
27038
27039 To test for this case, Exim sends an EHLO command to the server after
27040 closing down the TLS session. If this fails in any way, the connection is
27041 closed instead of being passed to a new delivery process, but no retry
27042 information is recorded.
27043
27044 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27045 &(smtp)& transport to match those hosts for which Exim should not pass
27046 connections to new processes if TLS has been used.
27047
27048
27049
27050
27051 .section "Certificates and all that" "SECTcerandall"
27052 .cindex "certificate" "references to discussion"
27053 In order to understand fully how TLS works, you need to know about
27054 certificates, certificate signing, and certificate authorities. This is not the
27055 place to give a tutorial, especially as I do not know very much about it
27056 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27057 to Apache, currently at
27058 .display
27059 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27060 .endd
27061 Other parts of the &'modssl'& documentation are also helpful, and have
27062 links to further files.
27063 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27064 0-201-61598-3), contains both introductory and more in-depth descriptions.
27065 Some sample programs taken from the book are available from
27066 .display
27067 &url(http://www.rtfm.com/openssl-examples/)
27068 .endd
27069
27070
27071 .section "Certificate chains" "SECID186"
27072 The file named by &%tls_certificate%& may contain more than one
27073 certificate. This is useful in the case where the certificate that is being
27074 sent is validated by an intermediate certificate which the other end does
27075 not have. Multiple certificates must be in the correct order in the file.
27076 First the host's certificate itself, then the first intermediate
27077 certificate to validate the issuer of the host certificate, then the next
27078 intermediate certificate to validate the issuer of the first intermediate
27079 certificate, and so on, until finally (optionally) the root certificate.
27080 The root certificate must already be trusted by the recipient for
27081 validation to succeed, of course, but if it's not preinstalled, sending the
27082 root certificate along with the rest makes it available for the user to
27083 install if the receiving end is a client MUA that can interact with a user.
27084
27085 Note that certificates using MD5 are unlikely to work on today's Internet;
27086 even if your libraries allow loading them for use in Exim when acting as a
27087 server, increasingly clients will not accept such certificates.  The error
27088 diagnostics in such a case can be frustratingly vague.
27089
27090
27091
27092 .section "Self-signed certificates" "SECID187"
27093 .cindex "certificate" "self-signed"
27094 You can create a self-signed certificate using the &'req'& command provided
27095 with OpenSSL, like this:
27096 . ==== Do not shorten the duration here without reading and considering
27097 . ==== the text below.  Please leave it at 9999 days.
27098 .code
27099 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27100             -days 9999 -nodes
27101 .endd
27102 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27103 delimited and so can be identified independently. The &%-days%& option
27104 specifies a period for which the certificate is valid. The &%-nodes%& option is
27105 important: if you do not set it, the key is encrypted with a passphrase
27106 that you are prompted for, and any use that is made of the key causes more
27107 prompting for the passphrase. This is not helpful if you are going to use
27108 this certificate and key in an MTA, where prompting is not possible.
27109
27110 . ==== I expect to still be working 26 years from now.  The less technical
27111 . ==== debt I create, in terms of storing up trouble for my later years, the
27112 . ==== happier I will be then.  We really have reached the point where we
27113 . ==== should start, at the very least, provoking thought and making folks
27114 . ==== pause before proceeding, instead of leaving all the fixes until two
27115 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27116 . ==== -pdp, 2012
27117 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27118 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27119 the above command might produce a date in the past.  Think carefully about
27120 the lifetime of the systems you're deploying, and either reduce the duration
27121 of the certificate or reconsider your platform deployment.  (At time of
27122 writing, reducing the duration is the most likely choice, but the inexorable
27123 progression of time takes us steadily towards an era where this will not
27124 be a sensible resolution).
27125
27126 A self-signed certificate made in this way is sufficient for testing, and
27127 may be adequate for all your requirements if you are mainly interested in
27128 encrypting transfers, and not in secure identification.
27129
27130 However, many clients require that the certificate presented by the server be a
27131 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27132 certificate. In this situation, the self-signed certificate described above
27133 must be installed on the client host as a trusted root &'certification
27134 authority'& (CA), and the certificate used by Exim must be a user certificate
27135 signed with that self-signed certificate.
27136
27137 For information on creating self-signed CA certificates and using them to sign
27138 user certificates, see the &'General implementation overview'& chapter of the
27139 Open-source PKI book, available online at
27140 &url(http://ospkibook.sourceforge.net/).
27141 .ecindex IIDencsmtp1
27142 .ecindex IIDencsmtp2
27143
27144
27145
27146 . ////////////////////////////////////////////////////////////////////////////
27147 . ////////////////////////////////////////////////////////////////////////////
27148
27149 .chapter "Access control lists" "CHAPACL"
27150 .scindex IIDacl "&ACL;" "description"
27151 .cindex "control of incoming mail"
27152 .cindex "message" "controlling incoming"
27153 .cindex "policy control" "access control lists"
27154 Access Control Lists (ACLs) are defined in a separate section of the run time
27155 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27156 name, terminated by a colon. Here is a complete ACL section that contains just
27157 one very small ACL:
27158 .code
27159 begin acl
27160 small_acl:
27161   accept   hosts = one.host.only
27162 .endd
27163 You can have as many lists as you like in the ACL section, and the order in
27164 which they appear does not matter. The lists are self-terminating.
27165
27166 The majority of ACLs are used to control Exim's behaviour when it receives
27167 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27168 when a local process submits a message using SMTP by specifying the &%-bs%&
27169 option. The most common use is for controlling which recipients are accepted
27170 in incoming messages. In addition, you can define an ACL that is used to check
27171 local non-SMTP messages. The default configuration file contains an example of
27172 a realistic ACL for checking RCPT commands. This is discussed in chapter
27173 &<<CHAPdefconfil>>&.
27174
27175
27176 .section "Testing ACLs" "SECID188"
27177 The &%-bh%& command line option provides a way of testing your ACL
27178 configuration locally by running a fake SMTP session with which you interact.
27179 The host &'relay-test.mail-abuse.org'& provides a service for checking your
27180 relaying configuration (see section &<<SECTcheralcon>>& for more details).
27181
27182
27183
27184 .section "Specifying when ACLs are used" "SECID189"
27185 .cindex "&ACL;" "options for specifying"
27186 In order to cause an ACL to be used, you have to name it in one of the relevant
27187 options in the main part of the configuration. These options are:
27188 .cindex "AUTH" "ACL for"
27189 .cindex "DATA" "ACLs for"
27190 .cindex "ETRN" "ACL for"
27191 .cindex "EXPN" "ACL for"
27192 .cindex "HELO" "ACL for"
27193 .cindex "EHLO" "ACL for"
27194 .cindex "DKIM" "ACL for"
27195 .cindex "MAIL" "ACL for"
27196 .cindex "QUIT, ACL for"
27197 .cindex "RCPT" "ACL for"
27198 .cindex "STARTTLS, ACL for"
27199 .cindex "VRFY" "ACL for"
27200 .cindex "SMTP" "connection, ACL for"
27201 .cindex "non-SMTP messages" "ACLs for"
27202 .cindex "MIME content scanning" "ACL for"
27203 .cindex "PRDR" "ACL for"
27204
27205 .table2 140pt
27206 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27207 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27208 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27209 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27210 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27211 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27212 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27213 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27214 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27215 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27216 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27217 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27218 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27219 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27220 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27221 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27222 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27223 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27224 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27225 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27226 .endtable
27227
27228 For example, if you set
27229 .code
27230 acl_smtp_rcpt = small_acl
27231 .endd
27232 the little ACL defined above is used whenever Exim receives a RCPT command
27233 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27234 done when RCPT commands arrive. A rejection of RCPT should cause the
27235 sending MTA to give up on the recipient address contained in the RCPT
27236 command, whereas rejection at other times may cause the client MTA to keep on
27237 trying to deliver the message. It is therefore recommended that you do as much
27238 testing as possible at RCPT time.
27239
27240
27241 .section "The non-SMTP ACLs" "SECID190"
27242 .cindex "non-SMTP messages" "ACLs for"
27243 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27244 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27245 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27246 the state of the SMTP connection such as encryption and authentication) are not
27247 relevant and are forbidden in these ACLs. However, the sender and recipients
27248 are known, so the &%senders%& and &%sender_domains%& conditions and the
27249 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27250 &$authenticated_sender$& are also available. You can specify added header lines
27251 in any of these ACLs.
27252
27253 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27254 non-SMTP message, before any of the message has been read. (This is the
27255 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27256 batched SMTP input, it runs after the DATA command has been reached. The
27257 result of this ACL is ignored; it cannot be used to reject a message. If you
27258 really need to, you could set a value in an ACL variable here and reject based
27259 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27260 controls, and in particular, it can be used to set
27261 .code
27262 control = suppress_local_fixups
27263 .endd
27264 This cannot be used in the other non-SMTP ACLs because by the time they are
27265 run, it is too late.
27266
27267 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27268 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27269
27270 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27271 kind of rejection is treated as permanent, because there is no way of sending a
27272 temporary error for these kinds of message.
27273
27274
27275 .section "The SMTP connect ACL" "SECID191"
27276 .cindex "SMTP" "connection, ACL for"
27277 .oindex &%smtp_banner%&
27278 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27279 session, after the test specified by &%host_reject_connection%& (which is now
27280 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27281 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27282 the message override the banner message that is otherwise specified by the
27283 &%smtp_banner%& option.
27284
27285
27286 .section "The EHLO/HELO ACL" "SECID192"
27287 .cindex "EHLO" "ACL for"
27288 .cindex "HELO" "ACL for"
27289 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
27290 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
27291 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
27292 Note that a client may issue more than one EHLO or HELO command in an SMTP
27293 session, and indeed is required to issue a new EHLO or HELO after successfully
27294 setting up encryption following a STARTTLS command.
27295
27296 If the command is accepted by an &%accept%& verb that has a &%message%&
27297 modifier, the message may not contain more than one line (it will be truncated
27298 at the first newline and a panic logged if it does). Such a message cannot
27299 affect the EHLO options that are listed on the second and subsequent lines of
27300 an EHLO response.
27301
27302
27303 .section "The DATA ACLs" "SECID193"
27304 .cindex "DATA" "ACLs for"
27305 Two ACLs are associated with the DATA command, because it is two-stage
27306 command, with two responses being sent to the client.
27307 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
27308 is obeyed. This gives you control after all the RCPT commands, but before
27309 the message itself is received. It offers the opportunity to give a negative
27310 response to the DATA command before the data is transmitted. Header lines
27311 added by MAIL or RCPT ACLs are not visible at this time, but any that
27312 are defined here are visible when the &%acl_smtp_data%& ACL is run.
27313
27314 You cannot test the contents of the message, for example, to verify addresses
27315 in the headers, at RCPT time or when the DATA command is received. Such
27316 tests have to appear in the ACL that is run after the message itself has been
27317 received, before the final response to the DATA command is sent. This is
27318 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
27319 associated with the DATA command.
27320
27321 For both of these ACLs, it is not possible to reject individual recipients. An
27322 error response rejects the entire message. Unfortunately, it is known that some
27323 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
27324 before or after the data) correctly &-- they keep the message on their queues
27325 and try again later, but that is their problem, though it does waste some of
27326 your resources.
27327
27328 The &%acl_smtp_data%& ACL is run after
27329 the &%acl_smtp_data_prdr%&,
27330 the &%acl_smtp_dkim%&
27331 and the &%acl_smtp_mime%& ACLs.
27332
27333 .section "The SMTP DKIM ACL" "SECTDKIMACL"
27334 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
27335 enabled (which is the default).
27336
27337 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
27338 received, and is executed for each DKIM signature found in a message.  If not
27339 otherwise specified, the default action is to accept.
27340
27341 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
27342
27343 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
27344
27345
27346 .section "The SMTP MIME ACL" "SECID194"
27347 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
27348 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27349
27350 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27351
27352
27353 .section "The SMTP PRDR ACL" "SECTPRDRACL"
27354 .cindex "PRDR" "ACL for"
27355 .oindex "&%prdr_enable%&"
27356 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
27357 with PRDR support enabled (which is the default).
27358 It becomes active only when the PRDR feature is negotiated between
27359 client and server for a message, and more than one recipient
27360 has been accepted.
27361
27362 The ACL test specfied by &%acl_smtp_data_prdr%& happens after a message
27363 has been recieved, and is executed once for each recipient of the message
27364 with &$local_part$& and &$domain$& valid.
27365 The test may accept, defer or deny for inividual recipients.
27366 The &%acl_smtp_data%& will still be called after this ACL and
27367 can reject the message overall, even if this ACL has accepted it
27368 for some or all recipients.
27369
27370 PRDR may be used to support per-user content filtering.  Without it
27371 one must defer any recipient after the first that has a different
27372 content-filter configuration.  With PRDR, the RCPT-time check
27373 for this can be disabled when the MAIL-time $smtp_command included
27374 "PRDR".  Any required difference in behaviour of the main DATA-time
27375 ACL should however depend on the PRDR-time ACL having run, as Exim
27376 will avoid doing so in some situations (eg.  single-recipient mails).
27377
27378 See also the &%prdr_enable%& global option
27379 and the &%hosts_try_prdr%& smtp transport option.
27380
27381 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
27382 If the ACL is not defined, processing completes as if
27383 the feature was not requested by the client.
27384
27385 .section "The QUIT ACL" "SECTQUITACL"
27386 .cindex "QUIT, ACL for"
27387 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
27388 does not affect the response code to QUIT, which is always 221. Thus, the ACL
27389 does not in fact control any access. For this reason, it may only accept
27390 or warn as its final result.
27391
27392 This ACL can be used for tasks such as custom logging at the end of an SMTP
27393 session. For example, you can use ACL variables in other ACLs to count
27394 messages, recipients, etc., and log the totals at QUIT time using one or
27395 more &%logwrite%& modifiers on a &%warn%& verb.
27396
27397 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
27398 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
27399
27400 You do not need to have a final &%accept%&, but if you do, you can use a
27401 &%message%& modifier to specify custom text that is sent as part of the 221
27402 response to QUIT.
27403
27404 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
27405 failure (for example, failure to open a log file, or when Exim is bombing out
27406 because it has detected an unrecoverable error), all SMTP commands from the
27407 client are given temporary error responses until QUIT is received or the
27408 connection is closed. In these special cases, the QUIT ACL does not run.
27409
27410
27411 .section "The not-QUIT ACL" "SECTNOTQUITACL"
27412 .vindex &$acl_smtp_notquit$&
27413 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
27414 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
27415 trouble, such as being unable to write to its log files, this ACL is not run,
27416 because it might try to do things (such as write to log files) that make the
27417 situation even worse.
27418
27419 Like the QUIT ACL, this ACL is provided to make it possible to do customized
27420 logging or to gather statistics, and its outcome is ignored. The &%delay%&
27421 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
27422 and &%warn%&.
27423
27424 .vindex &$smtp_notquit_reason$&
27425 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
27426 to a string that indicates the reason for the termination of the SMTP
27427 connection. The possible values are:
27428 .table2
27429 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
27430 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
27431 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
27432 .irow &`connection-lost`&          "The SMTP connection has been lost"
27433 .irow &`data-timeout`&             "Timeout while reading message data"
27434 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
27435 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
27436 .irow &`signal-exit`&              "SIGTERM or SIGINT"
27437 .irow &`synchronization-error`&    "SMTP synchronization error"
27438 .irow &`tls-failed`&               "TLS failed to start"
27439 .endtable
27440 In most cases when an SMTP connection is closed without having received QUIT,
27441 Exim sends an SMTP response message before actually closing the connection.
27442 With the exception of the &`acl-drop`& case, the default message can be
27443 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
27444 &%drop%& verb in another ACL, it is the message from the other ACL that is
27445 used.
27446
27447
27448 .section "Finding an ACL to use" "SECID195"
27449 .cindex "&ACL;" "finding which to use"
27450 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
27451 you can use different ACLs in different circumstances. For example,
27452 .code
27453 acl_smtp_rcpt = ${if ={25}{$interface_port} \
27454                      {acl_check_rcpt} {acl_check_rcpt_submit} }
27455 .endd
27456 In the default configuration file there are some example settings for
27457 providing an RFC 4409 message submission service on port 587 and a
27458 non-standard &"smtps"& service on port 465. You can use a string
27459 expansion like this to choose an ACL for MUAs on these ports which is
27460 more appropriate for this purpose than the default ACL on port 25.
27461
27462 The expanded string does not have to be the name of an ACL in the
27463 configuration file; there are other possibilities. Having expanded the
27464 string, Exim searches for an ACL as follows:
27465
27466 .ilist
27467 If the string begins with a slash, Exim uses it as a file name, and reads its
27468 contents as an ACL. The lines are processed in the same way as lines in the
27469 Exim configuration file. In particular, continuation lines are supported, blank
27470 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
27471 If the file does not exist or cannot be read, an error occurs (typically
27472 causing a temporary failure of whatever caused the ACL to be run). For example:
27473 .code
27474 acl_smtp_data = /etc/acls/\
27475   ${lookup{$sender_host_address}lsearch\
27476   {/etc/acllist}{$value}{default}}
27477 .endd
27478 This looks up an ACL file to use on the basis of the host's IP address, falling
27479 back to a default if the lookup fails. If an ACL is successfully read from a
27480 file, it is retained in memory for the duration of the Exim process, so that it
27481 can be re-used without having to re-read the file.
27482 .next
27483 If the string does not start with a slash, and does not contain any spaces,
27484 Exim searches the ACL section of the configuration for an ACL whose name
27485 matches the string.
27486 .next
27487 If no named ACL is found, or if the string contains spaces, Exim parses
27488 the string as an inline ACL. This can save typing in cases where you just
27489 want to have something like
27490 .code
27491 acl_smtp_vrfy = accept
27492 .endd
27493 in order to allow free use of the VRFY command. Such a string may contain
27494 newlines; it is processed in the same way as an ACL that is read from a file.
27495 .endlist
27496
27497
27498
27499
27500 .section "ACL return codes" "SECID196"
27501 .cindex "&ACL;" "return codes"
27502 Except for the QUIT ACL, which does not affect the SMTP return code (see
27503 section &<<SECTQUITACL>>& above), the result of running an ACL is either
27504 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
27505 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
27506 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
27507 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
27508 This also causes a 4&'xx'& return code.
27509
27510 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
27511 &"deny"&, because there is no mechanism for passing temporary errors to the
27512 submitters of non-SMTP messages.
27513
27514
27515 ACLs that are relevant to message reception may also return &"discard"&. This
27516 has the effect of &"accept"&, but causes either the entire message or an
27517 individual recipient address to be discarded. In other words, it is a
27518 blackholing facility. Use it with care.
27519
27520 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
27521 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
27522 RCPT ACL is to discard just the one recipient address. If there are no
27523 recipients left when the message's data is received, the DATA ACL is not
27524 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
27525 remaining recipients. The &"discard"& return is not permitted for the
27526 &%acl_smtp_predata%& ACL.
27527
27528
27529 .cindex "&[local_scan()]& function" "when all recipients discarded"
27530 The &[local_scan()]& function is always run, even if there are no remaining
27531 recipients; it may create new recipients.
27532
27533
27534
27535 .section "Unset ACL options" "SECID197"
27536 .cindex "&ACL;" "unset options"
27537 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
27538 all the same. &*Note*&: These defaults apply only when the relevant ACL is
27539 not defined at all. For any defined ACL, the default action when control
27540 reaches the end of the ACL statements is &"deny"&.
27541
27542 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
27543 these two are ACLs that are used only for their side effects. They cannot be
27544 used to accept or reject anything.
27545
27546 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
27547 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
27548 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
27549 when the ACL is not defined is &"accept"&.
27550
27551 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
27552 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
27553 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
27554 messages over an SMTP connection. For an example, see the ACL in the default
27555 configuration file.
27556
27557
27558
27559
27560 .section "Data for message ACLs" "SECID198"
27561 .cindex "&ACL;" "data for message ACL"
27562 .vindex &$domain$&
27563 .vindex &$local_part$&
27564 .vindex &$sender_address$&
27565 .vindex &$sender_host_address$&
27566 .vindex &$smtp_command$&
27567 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
27568 that contain information about the host and the message's sender (for example,
27569 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
27570 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
27571 &$local_part$& are set from the argument address. The entire SMTP command
27572 is available in &$smtp_command$&.
27573
27574 When an ACL for the AUTH parameter of MAIL is running, the variables that
27575 contain information about the host are set, but &$sender_address$& is not yet
27576 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
27577 how it is used.
27578
27579 .vindex "&$message_size$&"
27580 The &$message_size$& variable is set to the value of the SIZE parameter on
27581 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
27582 that parameter is not given. The value is updated to the true message size by
27583 the time the final DATA ACL is run (after the message data has been
27584 received).
27585
27586 .vindex "&$rcpt_count$&"
27587 .vindex "&$recipients_count$&"
27588 The &$rcpt_count$& variable increases by one for each RCPT command received.
27589 The &$recipients_count$& variable increases by one each time a RCPT command is
27590 accepted, so while an ACL for RCPT is being processed, it contains the number
27591 of previously accepted recipients. At DATA time (for both the DATA ACLs),
27592 &$rcpt_count$& contains the total number of RCPT commands, and
27593 &$recipients_count$& contains the total number of accepted recipients.
27594
27595
27596
27597
27598
27599 .section "Data for non-message ACLs" "SECTdatfornon"
27600 .cindex "&ACL;" "data for non-message ACL"
27601 .vindex &$smtp_command_argument$&
27602 .vindex &$smtp_command$&
27603 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
27604 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
27605 and the entire SMTP command is available in &$smtp_command$&.
27606 These variables can be tested using a &%condition%& condition. For example,
27607 here is an ACL for use with AUTH, which insists that either the session is
27608 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
27609 does not permit authentication methods that use cleartext passwords on
27610 unencrypted connections.
27611 .code
27612 acl_check_auth:
27613   accept encrypted = *
27614   accept condition = ${if eq{${uc:$smtp_command_argument}}\
27615                      {CRAM-MD5}}
27616   deny   message   = TLS encryption or CRAM-MD5 required
27617 .endd
27618 (Another way of applying this restriction is to arrange for the authenticators
27619 that use cleartext passwords not to be advertised when the connection is not
27620 encrypted. You can use the generic &%server_advertise_condition%& authenticator
27621 option to do this.)
27622
27623
27624
27625 .section "Format of an ACL" "SECID199"
27626 .cindex "&ACL;" "format of"
27627 .cindex "&ACL;" "verbs, definition of"
27628 An individual ACL consists of a number of statements. Each statement starts
27629 with a verb, optionally followed by a number of conditions and &"modifiers"&.
27630 Modifiers can change the way the verb operates, define error and log messages,
27631 set variables, insert delays, and vary the processing of accepted messages.
27632
27633 If all the conditions are met, the verb is obeyed. The same condition may be
27634 used (with different arguments) more than once in the same statement. This
27635 provides a means of specifying an &"and"& conjunction between conditions. For
27636 example:
27637 .code
27638 deny  dnslists = list1.example
27639 dnslists = list2.example
27640 .endd
27641 If there are no conditions, the verb is always obeyed. Exim stops evaluating
27642 the conditions and modifiers when it reaches a condition that fails. What
27643 happens then depends on the verb (and in one case, on a special modifier). Not
27644 all the conditions make sense at every testing point. For example, you cannot
27645 test a sender address in the ACL that is run for a VRFY command.
27646
27647
27648 .section "ACL verbs" "SECID200"
27649 The ACL verbs are as follows:
27650
27651 .ilist
27652 .cindex "&%accept%& ACL verb"
27653 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
27654 of the conditions are not met, what happens depends on whether &%endpass%&
27655 appears among the conditions (for syntax see below). If the failing condition
27656 is before &%endpass%&, control is passed to the next ACL statement; if it is
27657 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
27658 check a RCPT command:
27659 .code
27660 accept domains = +local_domains
27661 endpass
27662 verify = recipient
27663 .endd
27664 If the recipient domain does not match the &%domains%& condition, control
27665 passes to the next statement. If it does match, the recipient is verified, and
27666 the command is accepted if verification succeeds. However, if verification
27667 fails, the ACL yields &"deny"&, because the failing condition is after
27668 &%endpass%&.
27669
27670 The &%endpass%& feature has turned out to be confusing to many people, so its
27671 use is not recommended nowadays. It is always possible to rewrite an ACL so
27672 that &%endpass%& is not needed, and it is no longer used in the default
27673 configuration.
27674
27675 .cindex "&%message%& ACL modifier" "with &%accept%&"
27676 If a &%message%& modifier appears on an &%accept%& statement, its action
27677 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
27678 (when an &%accept%& verb either accepts or passes control to the next
27679 statement), &%message%& can be used to vary the message that is sent when an
27680 SMTP command is accepted. For example, in a RCPT ACL you could have:
27681 .display
27682 &`accept  `&<&'some conditions'&>
27683 &`        message = OK, I will allow you through today`&
27684 .endd
27685 You can specify an SMTP response code, optionally followed by an &"extended
27686 response code"& at the start of the message, but the first digit must be the
27687 same as would be sent by default, which is 2 for an &%accept%& verb.
27688
27689 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
27690 an error message that is used when access is denied. This behaviour is retained
27691 for backward compatibility, but current &"best practice"& is to avoid the use
27692 of &%endpass%&.
27693
27694
27695 .next
27696 .cindex "&%defer%& ACL verb"
27697 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
27698 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
27699 &%defer%& is the same as &%deny%&, because there is no way of sending a
27700 temporary error. For a RCPT command, &%defer%& is much the same as using a
27701 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
27702 be used in any ACL, and even for a recipient it might be a simpler approach.
27703
27704
27705 .next
27706 .cindex "&%deny%& ACL verb"
27707 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
27708 the conditions are not met, control is passed to the next ACL statement. For
27709 example,
27710 .code
27711 deny dnslists = blackholes.mail-abuse.org
27712 .endd
27713 rejects commands from hosts that are on a DNS black list.
27714
27715
27716 .next
27717 .cindex "&%discard%& ACL verb"
27718 &%discard%&: This verb behaves like &%accept%&, except that it returns
27719 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
27720 that are concerned with receiving messages. When all the conditions are true,
27721 the sending entity receives a &"success"& response. However, &%discard%& causes
27722 recipients to be discarded. If it is used in an ACL for RCPT, just the one
27723 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
27724 message's recipients are discarded. Recipients that are discarded before DATA
27725 do not appear in the log line when the &%received_recipients%& log selector is set.
27726
27727 If the &%log_message%& modifier is set when &%discard%& operates,
27728 its contents are added to the line that is automatically written to the log.
27729 The &%message%& modifier operates exactly as it does for &%accept%&.
27730
27731
27732 .next
27733 .cindex "&%drop%& ACL verb"
27734 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
27735 forcibly closed after the 5&'xx'& error message has been sent. For example:
27736 .code
27737 drop   message   = I don't take more than 20 RCPTs
27738        condition = ${if > {$rcpt_count}{20}}
27739 .endd
27740 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
27741 The connection is always dropped after sending a 550 response.
27742
27743 .next
27744 .cindex "&%require%& ACL verb"
27745 &%require%&: If all the conditions are met, control is passed to the next ACL
27746 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
27747 example, when checking a RCPT command,
27748 .code
27749 require message = Sender did not verify
27750         verify  = sender
27751 .endd
27752 passes control to subsequent statements only if the message's sender can be
27753 verified. Otherwise, it rejects the command. Note the positioning of the
27754 &%message%& modifier, before the &%verify%& condition. The reason for this is
27755 discussed in section &<<SECTcondmodproc>>&.
27756
27757 .next
27758 .cindex "&%warn%& ACL verb"
27759 &%warn%&: If all the conditions are true, a line specified by the
27760 &%log_message%& modifier is written to Exim's main log. Control always passes
27761 to the next ACL statement. If any condition is false, the log line is not
27762 written. If an identical log line is requested several times in the same
27763 message, only one copy is actually written to the log. If you want to force
27764 duplicates to be written, use the &%logwrite%& modifier instead.
27765
27766 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
27767 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
27768 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
27769 first failing condition. There is more about adding header lines in section
27770 &<<SECTaddheadacl>>&.
27771
27772 If any condition on a &%warn%& statement cannot be completed (that is, there is
27773 some sort of defer), the log line specified by &%log_message%& is not written.
27774 This does not include the case of a forced failure from a lookup, which
27775 is considered to be a successful completion. After a defer, no further
27776 conditions or modifiers in the &%warn%& statement are processed. The incident
27777 is logged, and the ACL continues to be processed, from the next statement
27778 onwards.
27779
27780
27781 .vindex "&$acl_verify_message$&"
27782 When one of the &%warn%& conditions is an address verification that fails, the
27783 text of the verification failure message is in &$acl_verify_message$&. If you
27784 want this logged, you must set it up explicitly. For example:
27785 .code
27786 warn   !verify = sender
27787        log_message = sender verify failed: $acl_verify_message
27788 .endd
27789 .endlist
27790
27791 At the end of each ACL there is an implicit unconditional &%deny%&.
27792
27793 As you can see from the examples above, the conditions and modifiers are
27794 written one to a line, with the first one on the same line as the verb, and
27795 subsequent ones on following lines. If you have a very long condition, you can
27796 continue it onto several physical lines by the usual backslash continuation
27797 mechanism. It is conventional to align the conditions vertically.
27798
27799
27800
27801 .section "ACL variables" "SECTaclvariables"
27802 .cindex "&ACL;" "variables"
27803 There are some special variables that can be set during ACL processing. They
27804 can be used to pass information between different ACLs, different invocations
27805 of the same ACL in the same SMTP connection, and between ACLs and the routers,
27806 transports, and filters that are used to deliver a message. The names of these
27807 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
27808 an underscore, but the remainder of the name can be any sequence of
27809 alphanumeric characters and underscores that you choose. There is no limit on
27810 the number of ACL variables. The two sets act as follows:
27811 .ilist
27812 The values of those variables whose names begin with &$acl_c$& persist
27813 throughout an SMTP connection. They are never reset. Thus, a value that is set
27814 while receiving one message is still available when receiving the next message
27815 on the same SMTP connection.
27816 .next
27817 The values of those variables whose names begin with &$acl_m$& persist only
27818 while a message is being received. They are reset afterwards. They are also
27819 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
27820 .endlist
27821
27822 When a message is accepted, the current values of all the ACL variables are
27823 preserved with the message and are subsequently made available at delivery
27824 time. The ACL variables are set by a modifier called &%set%&. For example:
27825 .code
27826 accept hosts = whatever
27827        set acl_m4 = some value
27828 accept authenticated = *
27829        set acl_c_auth = yes
27830 .endd
27831 &*Note*&: A leading dollar sign is not used when naming a variable that is to
27832 be set. If you want to set a variable without taking any action, you can use a
27833 &%warn%& verb without any other modifiers or conditions.
27834
27835 .oindex &%strict_acl_vars%&
27836 What happens if a syntactically valid but undefined ACL variable is
27837 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
27838 false (the default), an empty string is substituted; if it is true, an
27839 error is generated.
27840
27841 Versions of Exim before 4.64 have a limited set of numbered variables, but
27842 their names are compatible, so there is no problem with upgrading.
27843
27844
27845 .section "Condition and modifier processing" "SECTcondmodproc"
27846 .cindex "&ACL;" "conditions; processing"
27847 .cindex "&ACL;" "modifiers; processing"
27848 An exclamation mark preceding a condition negates its result. For example:
27849 .code
27850 deny   domains = *.dom.example
27851       !verify  = recipient
27852 .endd
27853 causes the ACL to return &"deny"& if the recipient domain ends in
27854 &'dom.example'& and the recipient address cannot be verified. Sometimes
27855 negation can be used on the right-hand side of a condition. For example, these
27856 two statements are equivalent:
27857 .code
27858 deny  hosts = !192.168.3.4
27859 deny !hosts =  192.168.3.4
27860 .endd
27861 However, for many conditions (&%verify%& being a good example), only left-hand
27862 side negation of the whole condition is possible.
27863
27864 The arguments of conditions and modifiers are expanded. A forced failure
27865 of an expansion causes a condition to be ignored, that is, it behaves as if the
27866 condition is true. Consider these two statements:
27867 .code
27868 accept  senders = ${lookup{$host_name}lsearch\
27869                   {/some/file}{$value}fail}
27870 accept  senders = ${lookup{$host_name}lsearch\
27871                   {/some/file}{$value}{}}
27872 .endd
27873 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
27874 the returned list is searched, but if the lookup fails the behaviour is
27875 different in the two cases. The &%fail%& in the first statement causes the
27876 condition to be ignored, leaving no further conditions. The &%accept%& verb
27877 therefore succeeds. The second statement, however, generates an empty list when
27878 the lookup fails. No sender can match an empty list, so the condition fails,
27879 and therefore the &%accept%& also fails.
27880
27881 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
27882 specify actions that are taken as the conditions for a statement are checked;
27883 others specify text for messages that are used when access is denied or a
27884 warning is generated. The &%control%& modifier affects the way an incoming
27885 message is handled.
27886
27887 The positioning of the modifiers in an ACL statement is important, because the
27888 processing of a verb ceases as soon as its outcome is known. Only those
27889 modifiers that have already been encountered will take effect. For example,
27890 consider this use of the &%message%& modifier:
27891 .code
27892 require message = Can't verify sender
27893         verify  = sender
27894         message = Can't verify recipient
27895         verify  = recipient
27896         message = This message cannot be used
27897 .endd
27898 If sender verification fails, Exim knows that the result of the statement is
27899 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
27900 so its text is used as the error message. If sender verification succeeds, but
27901 recipient verification fails, the second message is used. If recipient
27902 verification succeeds, the third message becomes &"current"&, but is never used
27903 because there are no more conditions to cause failure.
27904
27905 For the &%deny%& verb, on the other hand, it is always the last &%message%&
27906 modifier that is used, because all the conditions must be true for rejection to
27907 happen. Specifying more than one &%message%& modifier does not make sense, and
27908 the message can even be specified after all the conditions. For example:
27909 .code
27910 deny   hosts = ...
27911       !senders = *@my.domain.example
27912        message = Invalid sender from client host
27913 .endd
27914 The &"deny"& result does not happen until the end of the statement is reached,
27915 by which time Exim has set up the message.
27916
27917
27918
27919 .section "ACL modifiers" "SECTACLmodi"
27920 .cindex "&ACL;" "modifiers; list of"
27921 The ACL modifiers are as follows:
27922
27923 .vlist
27924 .vitem &*add_header*&&~=&~<&'text'&>
27925 This modifier specifies one or more header lines that are to be added to an
27926 incoming message, assuming, of course, that the message is ultimately
27927 accepted. For details, see section &<<SECTaddheadacl>>&.
27928
27929 .vitem &*continue*&&~=&~<&'text'&>
27930 .cindex "&%continue%& ACL modifier"
27931 .cindex "database" "updating in ACL"
27932 This modifier does nothing of itself, and processing of the ACL always
27933 continues with the next condition or modifier. The value of &%continue%& is in
27934 the side effects of expanding its argument. Typically this could be used to
27935 update a database. It is really just a syntactic tidiness, to avoid having to
27936 write rather ugly lines like this:
27937 .display
27938 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
27939 .endd
27940 Instead, all you need is
27941 .display
27942 &`continue = `&<&'some expansion'&>
27943 .endd
27944
27945 .vitem &*control*&&~=&~<&'text'&>
27946 .cindex "&%control%& ACL modifier"
27947 This modifier affects the subsequent processing of the SMTP connection or of an
27948 incoming message that is accepted. The effect of the first type of control
27949 lasts for the duration of the connection, whereas the effect of the second type
27950 lasts only until the current message has been received. The message-specific
27951 controls always apply to the whole message, not to individual recipients,
27952 even if the &%control%& modifier appears in a RCPT ACL.
27953
27954 As there are now quite a few controls that can be applied, they are described
27955 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
27956 in several different ways. For example:
27957
27958 . ==== As this is a nested list, any displays it contains must be indented
27959 . ==== as otherwise they are too far to the left. That comment applies only
27960 . ==== when xmlto and fop are used; formatting with sdop gets it right either
27961 . ==== way.
27962
27963 .ilist
27964 It can be at the end of an &%accept%& statement:
27965 .code
27966     accept  ...some conditions
27967             control = queue_only
27968 .endd
27969 In this case, the control is applied when this statement yields &"accept"&, in
27970 other words, when the conditions are all true.
27971
27972 .next
27973 It can be in the middle of an &%accept%& statement:
27974 .code
27975     accept  ...some conditions...
27976             control = queue_only
27977             ...some more conditions...
27978 .endd
27979 If the first set of conditions are true, the control is applied, even if the
27980 statement does not accept because one of the second set of conditions is false.
27981 In this case, some subsequent statement must yield &"accept"& for the control
27982 to be relevant.
27983
27984 .next
27985 It can be used with &%warn%& to apply the control, leaving the
27986 decision about accepting or denying to a subsequent verb. For
27987 example:
27988 .code
27989     warn    ...some conditions...
27990             control = freeze
27991     accept  ...
27992 .endd
27993 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
27994 &%logwrite%&, so it does not add anything to the message and does not write a
27995 log entry.
27996
27997 .next
27998 If you want to apply a control unconditionally, you can use it with a
27999 &%require%& verb. For example:
28000 .code
28001     require  control = no_multiline_responses
28002 .endd
28003 .endlist
28004
28005 .vitem &*delay*&&~=&~<&'time'&>
28006 .cindex "&%delay%& ACL modifier"
28007 .oindex "&%-bh%&"
28008 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28009 the time interval before proceeding. However, when testing Exim using the
28010 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28011 output instead). The time is given in the usual Exim notation, and the delay
28012 happens as soon as the modifier is processed. In an SMTP session, pending
28013 output is flushed before the delay is imposed.
28014
28015 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28016 example:
28017 .code
28018 deny    ...some conditions...
28019         delay = 30s
28020 .endd
28021 The delay happens if all the conditions are true, before the statement returns
28022 &"deny"&. Compare this with:
28023 .code
28024 deny    delay = 30s
28025         ...some conditions...
28026 .endd
28027 which waits for 30s before processing the conditions. The &%delay%& modifier
28028 can also be used with &%warn%& and together with &%control%&:
28029 .code
28030 warn    ...some conditions...
28031         delay = 2m
28032         control = freeze
28033 accept  ...
28034 .endd
28035
28036 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28037 responses to several commands are no longer buffered and sent in one packet (as
28038 they would normally be) because all output is flushed before imposing the
28039 delay. This optimization is disabled so that a number of small delays do not
28040 appear to the client as one large aggregated delay that might provoke an
28041 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28042 using a &%control%& modifier to set &%no_delay_flush%&.
28043
28044
28045 .vitem &*endpass*&
28046 .cindex "&%endpass%& ACL modifier"
28047 This modifier, which has no argument, is recognized only in &%accept%& and
28048 &%discard%& statements. It marks the boundary between the conditions whose
28049 failure causes control to pass to the next statement, and the conditions whose
28050 failure causes the ACL to return &"deny"&. This concept has proved to be
28051 confusing to some people, so the use of &%endpass%& is no longer recommended as
28052 &"best practice"&. See the description of &%accept%& above for more details.
28053
28054
28055 .vitem &*log_message*&&~=&~<&'text'&>
28056 .cindex "&%log_message%& ACL modifier"
28057 This modifier sets up a message that is used as part of the log message if the
28058 ACL denies access or a &%warn%& statement's conditions are true. For example:
28059 .code
28060 require log_message = wrong cipher suite $tls_in_cipher
28061         encrypted   = DES-CBC3-SHA
28062 .endd
28063 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28064 example:
28065 .display
28066 &`discard `&<&'some conditions'&>
28067 &`        log_message = Discarded $local_part@$domain because...`&
28068 .endd
28069 When access is denied, &%log_message%& adds to any underlying error message
28070 that may exist because of a condition failure. For example, while verifying a
28071 recipient address, a &':fail:'& redirection might have already set up a
28072 message.
28073
28074 The message may be defined before the conditions to which it applies, because
28075 the string expansion does not happen until Exim decides that access is to be
28076 denied. This means that any variables that are set by the condition are
28077 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28078 variables are set after a DNS black list lookup succeeds. If the expansion of
28079 &%log_message%& fails, or if the result is an empty string, the modifier is
28080 ignored.
28081
28082 .vindex "&$acl_verify_message$&"
28083 If you want to use a &%warn%& statement to log the result of an address
28084 verification, you can use &$acl_verify_message$& to include the verification
28085 error message.
28086
28087 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28088 the start of the logged message. If the same warning log message is requested
28089 more than once while receiving  a single email message, only one copy is
28090 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28091 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28092 is logged for a successful &%warn%& statement.
28093
28094 If &%log_message%& is not present and there is no underlying error message (for
28095 example, from the failure of address verification), but &%message%& is present,
28096 the &%message%& text is used for logging rejections. However, if any text for
28097 logging contains newlines, only the first line is logged. In the absence of
28098 both &%log_message%& and &%message%&, a default built-in message is used for
28099 logging rejections.
28100
28101
28102 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28103 .cindex "&%log_reject_target%& ACL modifier"
28104 .cindex "logging in ACL" "specifying which log"
28105 This modifier makes it possible to specify which logs are used for messages
28106 about ACL rejections. Its argument is a colon-separated list of words that can
28107 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28108 may be empty, in which case a rejection is not logged at all. For example, this
28109 ACL fragment writes no logging information when access is denied:
28110 .display
28111 &`deny `&<&'some conditions'&>
28112 &`     log_reject_target =`&
28113 .endd
28114 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28115 permanent and temporary rejections. Its effect lasts for the rest of the
28116 current ACL.
28117
28118
28119 .vitem &*logwrite*&&~=&~<&'text'&>
28120 .cindex "&%logwrite%& ACL modifier"
28121 .cindex "logging in ACL" "immediate"
28122 This modifier writes a message to a log file as soon as it is encountered when
28123 processing an ACL. (Compare &%log_message%&, which, except in the case of
28124 &%warn%& and &%discard%&, is used only if the ACL statement denies
28125 access.) The &%logwrite%& modifier can be used to log special incidents in
28126 ACLs. For example:
28127 .display
28128 &`accept `&<&'some special conditions'&>
28129 &`       control  = freeze`&
28130 &`       logwrite = froze message because ...`&
28131 .endd
28132 By default, the message is written to the main log. However, it may begin
28133 with a colon, followed by a comma-separated list of log names, and then
28134 another colon, to specify exactly which logs are to be written. For
28135 example:
28136 .code
28137 logwrite = :main,reject: text for main and reject logs
28138 logwrite = :panic: text for panic log only
28139 .endd
28140
28141
28142 .vitem &*message*&&~=&~<&'text'&>
28143 .cindex "&%message%& ACL modifier"
28144 This modifier sets up a text string that is expanded and used as a response
28145 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28146 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28147 there is some complication if &%endpass%& is involved; see the description of
28148 &%accept%& for details.)
28149
28150 The expansion of the message happens at the time Exim decides that the ACL is
28151 to end, not at the time it processes &%message%&. If the expansion fails, or
28152 generates an empty string, the modifier is ignored. Here is an example where
28153 &%message%& must be specified first, because the ACL ends with a rejection if
28154 the &%hosts%& condition fails:
28155 .code
28156 require  message = Host not recognized
28157          hosts = 10.0.0.0/8
28158 .endd
28159 (Once a condition has failed, no further conditions or modifiers are
28160 processed.)
28161
28162 .cindex "SMTP" "error codes"
28163 .oindex "&%smtp_banner%&
28164 For ACLs that are triggered by SMTP commands, the message is returned as part
28165 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28166 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28167 is accepted. In the case of the connect ACL, accepting with a message modifier
28168 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28169 accept message may not contain more than one line (otherwise it will be
28170 truncated at the first newline and a panic logged), and it cannot affect the
28171 EHLO options.
28172
28173 When SMTP is involved, the message may begin with an overriding response code,
28174 consisting of three digits optionally followed by an &"extended response code"&
28175 of the form &'n.n.n'&, each code being followed by a space. For example:
28176 .code
28177 deny  message = 599 1.2.3 Host not welcome
28178       hosts = 192.168.34.0/24
28179 .endd
28180 The first digit of the supplied response code must be the same as would be sent
28181 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28182 access, but for the predata ACL, note that the default success code is 354, not
28183 2&'xx'&.
28184
28185 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28186 the message modifier cannot override the 221 response code.
28187
28188 The text in a &%message%& modifier is literal; any quotes are taken as
28189 literals, but because the string is expanded, backslash escapes are processed
28190 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28191 response.
28192
28193 .vindex "&$acl_verify_message$&"
28194 For ACLs that are called by an &%acl =%& ACL condition, the message is
28195 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28196
28197 If &%message%& is used on a statement that verifies an address, the message
28198 specified overrides any message that is generated by the verification process.
28199 However, the original message is available in the variable
28200 &$acl_verify_message$&, so you can incorporate it into your message if you
28201 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28202 routers to be passed back as part of the SMTP response, you should either not
28203 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28204
28205 For compatibility with previous releases of Exim, a &%message%& modifier that
28206 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28207 modifier, but this usage is now deprecated. However, &%message%& acts only when
28208 all the conditions are true, wherever it appears in an ACL command, whereas
28209 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28210 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28211 effect.
28212
28213
28214 .vitem &*remove_header*&&~=&~<&'text'&>
28215 This modifier specifies one or more header names in a colon-separated list
28216  that are to be removed from an incoming message, assuming, of course, that
28217 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28218
28219
28220 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28221 .cindex "&%set%& ACL modifier"
28222 This modifier puts a value into one of the ACL variables (see section
28223 &<<SECTaclvariables>>&).
28224
28225
28226 .vitem &*udpsend*&&~=&~<&'parameters'&>
28227 This modifier sends a UDP packet, for purposes such as statistics
28228 collection or behaviour monitoring. The parameters are expanded, and
28229 the result of the expansion must be a colon-separated list consisting
28230 of a destination server, port number, and the packet contents. The
28231 server can be specified as a host name or IPv4 or IPv6 address. The
28232 separator can be changed with the usual angle bracket syntax. For
28233 example, you might want to collect information on which hosts connect
28234 when:
28235 .code
28236 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28237              $tod_zulu $sender_host_address
28238 .endd
28239 .endlist
28240
28241
28242
28243
28244 .section "Use of the control modifier" "SECTcontrols"
28245 .cindex "&%control%& ACL modifier"
28246 The &%control%& modifier supports the following settings:
28247
28248 .vlist
28249 .vitem &*control&~=&~allow_auth_unadvertised*&
28250 This modifier allows a client host to use the SMTP AUTH command even when it
28251 has not been advertised in response to EHLO. Furthermore, because there are
28252 apparently some really broken clients that do this, Exim will accept AUTH after
28253 HELO (rather than EHLO) when this control is set. It should be used only if you
28254 really need it, and you should limit its use to those broken clients that do
28255 not work without it. For example:
28256 .code
28257 warn hosts   = 192.168.34.25
28258      control = allow_auth_unadvertised
28259 .endd
28260 Normally, when an Exim server receives an AUTH command, it checks the name of
28261 the authentication mechanism that is given in the command to ensure that it
28262 matches an advertised mechanism. When this control is set, the check that a
28263 mechanism has been advertised is bypassed. Any configured mechanism can be used
28264 by the client. This control is permitted only in the connection and HELO ACLs.
28265
28266
28267 .vitem &*control&~=&~caseful_local_part*& &&&
28268        &*control&~=&~caselower_local_part*&
28269 .cindex "&ACL;" "case of local part in"
28270 .cindex "case of local parts"
28271 .vindex "&$local_part$&"
28272 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
28273 (that is, during RCPT processing). By default, the contents of &$local_part$&
28274 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
28275 any uppercase letters in the original local part are restored in &$local_part$&
28276 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
28277 is encountered.
28278
28279 These controls affect only the current recipient. Moreover, they apply only to
28280 local part handling that takes place directly in the ACL (for example, as a key
28281 in lookups). If a test to verify the recipient is obeyed, the case-related
28282 handling of the local part during the verification is controlled by the router
28283 configuration (see the &%caseful_local_part%& generic router option).
28284
28285 This facility could be used, for example, to add a spam score to local parts
28286 containing upper case letters. For example, using &$acl_m4$& to accumulate the
28287 spam score:
28288 .code
28289 warn  control = caseful_local_part
28290       set acl_m4 = ${eval:\
28291                      $acl_m4 + \
28292                      ${if match{$local_part}{[A-Z]}{1}{0}}\
28293                     }
28294       control = caselower_local_part
28295 .endd
28296 Notice that we put back the lower cased version afterwards, assuming that
28297 is what is wanted for subsequent tests.
28298
28299
28300 .vitem &*control&~=&~cutthrough_delivery*&
28301 .cindex "&ACL;" "cutthrough routing"
28302 .cindex "cutthrough" "requesting"
28303 This option requests delivery be attempted while the item is being received.
28304
28305 The option is usable in the RCPT ACL.
28306 If enabled for a message recieved via smtp and routed to an smtp transport,
28307 and only one transport, interface, destination host and port combination
28308 is used for all recipients of the message,
28309 then the delivery connection is made while the receiving connection is open
28310 and data is copied from one to the other.
28311
28312 An attempt to set this option for any recipient but the first
28313 for a mail will be quietly ignored.
28314 If a recipient-verify callout connection is subsequently
28315 requested in the same ACL it is held open and used for
28316 any subsequent receipients and the data,
28317 otherwise one is made after the initial RCPT ACL completes.
28318
28319 Note that routers are used in verify mode,
28320 and cannot depend on content of received headers.
28321 Note also that headers cannot be
28322 modified by any of the post-data ACLs (DATA, MIME and DKIM).
28323 Headers may be modified by routers (subject to the above) and transports.
28324
28325 Cutthrough delivery is not supported via transport-filters or when DKIM signing
28326 of outgoing messages is done, because it sends data to the ultimate destination
28327 before the entire message has been received from the source.
28328 It is not supported for messages recieved with the SMTP PRDR option in use.
28329
28330 Should the ultimate destination system positively accept or reject the mail,
28331 a corresponding indication is given to the source system and nothing is queued.
28332 If there is a temporary error the item is queued for later delivery in the
28333 usual fashion. If the item is successfully delivered in cutthrough mode
28334 the delivery log lines are tagged with ">>" rather than "=>" and appear
28335 before the acceptance "<=" line.
28336
28337 Delivery in this mode avoids the generation of a bounce mail to a
28338 (possibly faked)
28339 sender when the destination system is doing content-scan based rejection.
28340
28341
28342 .vitem &*control&~=&~debug/*&<&'options'&>
28343 .cindex "&ACL;" "enabling debug logging"
28344 .cindex "debugging" "enabling from an ACL"
28345 This control turns on debug logging, almost as though Exim had been invoked
28346 with &`-d`&, with the output going to a new logfile, by default called
28347 &'debuglog'&.  The filename can be adjusted with the &'tag'& option, which
28348 may access any variables already defined.  The logging may be adjusted with
28349 the &'opts'& option, which takes the same values as the &`-d`& command-line
28350 option.  Some examples (which depend on variables that don't exist in all
28351 contexts):
28352 .code
28353       control = debug
28354       control = debug/tag=.$sender_host_address
28355       control = debug/opts=+expand+acl
28356       control = debug/tag=.$message_exim_id/opts=+expand
28357 .endd
28358
28359
28360 .vitem &*control&~=&~dkim_disable_verify*&
28361 .cindex "disable DKIM verify"
28362 .cindex "DKIM" "disable verify"
28363 This control turns off DKIM verification processing entirely.  For details on
28364 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
28365
28366
28367 .vitem &*control&~=&~dscp/*&<&'value'&>
28368 .cindex "&ACL;" "setting DSCP value"
28369 .cindex "DSCP" "inbound"
28370 This option causes the DSCP value associated with the socket for the inbound
28371 connection to be adjusted to a given value, given as one of a number of fixed
28372 strings or to numeric value.
28373 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
28374 Common values include &`throughput`&, &`mincost`&, and on newer systems
28375 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
28376
28377 The outbound packets from Exim will be marked with this value in the header
28378 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
28379 that these values will have any effect, not be stripped by networking
28380 equipment, or do much of anything without cooperation with your Network
28381 Engineer and those of all network operators between the source and destination.
28382
28383
28384 .vitem &*control&~=&~enforce_sync*& &&&
28385        &*control&~=&~no_enforce_sync*&
28386 .cindex "SMTP" "synchronization checking"
28387 .cindex "synchronization checking in SMTP"
28388 These controls make it possible to be selective about when SMTP synchronization
28389 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
28390 state of the switch (it is true by default). See the description of this option
28391 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
28392
28393 The effect of these two controls lasts for the remainder of the SMTP
28394 connection. They can appear in any ACL except the one for the non-SMTP
28395 messages. The most straightforward place to put them is in the ACL defined by
28396 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
28397 before the first synchronization check. The expected use is to turn off the
28398 synchronization checks for badly-behaved hosts that you nevertheless need to
28399 work with.
28400
28401
28402 .vitem &*control&~=&~fakedefer/*&<&'message'&>
28403 .cindex "fake defer"
28404 .cindex "defer, fake"
28405 This control works in exactly the same way as &%fakereject%& (described below)
28406 except that it causes an SMTP 450 response after the message data instead of a
28407 550 response. You must take care when using &%fakedefer%& because it causes the
28408 messages to be duplicated when the sender retries. Therefore, you should not
28409 use &%fakedefer%& if the message is to be delivered normally.
28410
28411 .vitem &*control&~=&~fakereject/*&<&'message'&>
28412 .cindex "fake rejection"
28413 .cindex "rejection, fake"
28414 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
28415 words, only when an SMTP message is being received. If Exim accepts the
28416 message, instead the final 250 response, a 550 rejection message is sent.
28417 However, Exim proceeds to deliver the message as normal. The control applies
28418 only to the current message, not to any subsequent ones that may be received in
28419 the same SMTP connection.
28420
28421 The text for the 550 response is taken from the &%control%& modifier. If no
28422 message is supplied, the following is used:
28423 .code
28424 550-Your message has been rejected but is being
28425 550-kept for evaluation.
28426 550-If it was a legitimate message, it may still be
28427 550 delivered to the target recipient(s).
28428 .endd
28429 This facility should be used with extreme caution.
28430
28431 .vitem &*control&~=&~freeze*&
28432 .cindex "frozen messages" "forcing in ACL"
28433 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28434 other words, only when a message is being received. If the message is accepted,
28435 it is placed on Exim's queue and frozen. The control applies only to the
28436 current message, not to any subsequent ones that may be received in the same
28437 SMTP connection.
28438
28439 This modifier can optionally be followed by &`/no_tell`&. If the global option
28440 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
28441 is told about the freezing), provided all the &*control=freeze*& modifiers that
28442 are obeyed for the current message have the &`/no_tell`& option.
28443
28444 .vitem &*control&~=&~no_delay_flush*&
28445 .cindex "SMTP" "output flushing, disabling for delay"
28446 Exim normally flushes SMTP output before implementing a delay in an ACL, to
28447 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28448 use. This control, as long as it is encountered before the &%delay%& modifier,
28449 disables such output flushing.
28450
28451 .vitem &*control&~=&~no_callout_flush*&
28452 .cindex "SMTP" "output flushing, disabling for callout"
28453 Exim normally flushes SMTP output before performing a callout in an ACL, to
28454 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
28455 use. This control, as long as it is encountered before the &%verify%& condition
28456 that causes the callout, disables such output flushing.
28457
28458 .vitem &*control&~=&~no_mbox_unspool*&
28459 This control is available when Exim is compiled with the content scanning
28460 extension. Content scanning may require a copy of the current message, or parts
28461 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
28462 or spam scanner. Normally, such copies are deleted when they are no longer
28463 needed. If this control is set, the copies are not deleted. The control applies
28464 only to the current message, not to any subsequent ones that may be received in
28465 the same SMTP connection. It is provided for debugging purposes and is unlikely
28466 to be useful in production.
28467
28468 .vitem &*control&~=&~no_multiline_responses*&
28469 .cindex "multiline responses, suppressing"
28470 This control is permitted for any ACL except the one for non-SMTP messages.
28471 It seems that there are broken clients in use that cannot handle multiline
28472 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
28473
28474 If this control is set, multiline SMTP responses from ACL rejections are
28475 suppressed. One way of doing this would have been to put out these responses as
28476 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
28477 (&"use multiline responses for more"& it says &-- ha!), and some of the
28478 responses might get close to that. So this facility, which is after all only a
28479 sop to broken clients, is implemented by doing two very easy things:
28480
28481 .ilist
28482 Extra information that is normally output as part of a rejection caused by
28483 sender verification failure is omitted. Only the final line (typically &"sender
28484 verification failed"&) is sent.
28485 .next
28486 If a &%message%& modifier supplies a multiline response, only the first
28487 line is output.
28488 .endlist
28489
28490 The setting of the switch can, of course, be made conditional on the
28491 calling host. Its effect lasts until the end of the SMTP connection.
28492
28493 .vitem &*control&~=&~no_pipelining*&
28494 .cindex "PIPELINING" "suppressing advertising"
28495 This control turns off the advertising of the PIPELINING extension to SMTP in
28496 the current session. To be useful, it must be obeyed before Exim sends its
28497 response to an EHLO command. Therefore, it should normally appear in an ACL
28498 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
28499 &%pipelining_advertise_hosts%&.
28500
28501 .vitem &*control&~=&~queue_only*&
28502 .oindex "&%queue_only%&"
28503 .cindex "queueing incoming messages"
28504 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
28505 other words, only when a message is being received. If the message is accepted,
28506 it is placed on Exim's queue and left there for delivery by a subsequent queue
28507 runner. No immediate delivery process is started. In other words, it has the
28508 effect as the &%queue_only%& global option. However, the control applies only
28509 to the current message, not to any subsequent ones that may be received in the
28510 same SMTP connection.
28511
28512 .vitem &*control&~=&~submission/*&<&'options'&>
28513 .cindex "message" "submission"
28514 .cindex "submission mode"
28515 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
28516 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
28517 the current message is a submission from a local MUA. In this case, Exim
28518 operates in &"submission mode"&, and applies certain fixups to the message if
28519 necessary. For example, it adds a &'Date:'& header line if one is not present.
28520 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
28521 late (the message has already been created).
28522
28523 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
28524 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
28525 submission mode; the available options for this control are described there.
28526 The control applies only to the current message, not to any subsequent ones
28527 that may be received in the same SMTP connection.
28528
28529 .vitem &*control&~=&~suppress_local_fixups*&
28530 .cindex "submission fixups, suppressing"
28531 This control applies to locally submitted (non TCP/IP) messages, and is the
28532 complement of &`control = submission`&. It disables the fixups that are
28533 normally applied to locally-submitted messages. Specifically:
28534
28535 .ilist
28536 Any &'Sender:'& header line is left alone (in this respect, it is a
28537 dynamic version of &%local_sender_retain%&).
28538 .next
28539 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
28540 .next
28541 There is no check that &'From:'& corresponds to the actual sender.
28542 .endlist ilist
28543
28544 This control may be useful when a remotely-originated message is accepted,
28545 passed to some scanning program, and then re-submitted for delivery. It can be
28546 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
28547 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
28548 data is read.
28549
28550 &*Note:*& This control applies only to the current message, not to any others
28551 that are being submitted at the same time using &%-bs%& or &%-bS%&.
28552 .endlist vlist
28553
28554
28555 .section "Summary of message fixup control" "SECTsummesfix"
28556 All four possibilities for message fixups can be specified:
28557
28558 .ilist
28559 Locally submitted, fixups applied: the default.
28560 .next
28561 Locally submitted, no fixups applied: use
28562 &`control = suppress_local_fixups`&.
28563 .next
28564 Remotely submitted, no fixups applied: the default.
28565 .next
28566 Remotely submitted, fixups applied: use &`control = submission`&.
28567 .endlist
28568
28569
28570
28571 .section "Adding header lines in ACLs" "SECTaddheadacl"
28572 .cindex "header lines" "adding in an ACL"
28573 .cindex "header lines" "position of added lines"
28574 .cindex "&%add_header%& ACL modifier"
28575 The &%add_header%& modifier can be used to add one or more extra header lines
28576 to an incoming message, as in this example:
28577 .code
28578 warn dnslists = sbl.spamhaus.org : \
28579                 dialup.mail-abuse.org
28580      add_header = X-blacklisted-at: $dnslist_domain
28581 .endd
28582 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28583 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28584 receiving a message). The message must ultimately be accepted for
28585 &%add_header%& to have any significant effect. You can use &%add_header%& with
28586 any ACL verb, including &%deny%& (though this is potentially useful only in a
28587 RCPT ACL).
28588
28589 Headers will not be added to the message if the modifier is used in
28590 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28591
28592 Leading and trailing newlines are removed from
28593 the data for the &%add_header%& modifier; if it then
28594 contains one or more newlines that
28595 are not followed by a space or a tab, it is assumed to contain multiple header
28596 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
28597 front of any line that is not a valid header line.
28598
28599 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28600 They are added to the message before processing the DATA and MIME ACLs.
28601 However, if an identical header line is requested more than once, only one copy
28602 is actually added to the message. Further header lines may be accumulated
28603 during the DATA and MIME ACLs, after which they are added to the message, again
28604 with duplicates suppressed. Thus, it is possible to add two identical header
28605 lines to an SMTP message, but only if one is added before DATA and one after.
28606 In the case of non-SMTP messages, new headers are accumulated during the
28607 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
28608 message is rejected after DATA or by the non-SMTP ACL, all added header lines
28609 are included in the entry that is written to the reject log.
28610
28611 .cindex "header lines" "added; visibility of"
28612 Header lines are not visible in string expansions
28613 of message headers
28614 until they are added to the
28615 message. It follows that header lines defined in the MAIL, RCPT, and predata
28616 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
28617 header lines that are added by the DATA or MIME ACLs are not visible in those
28618 ACLs. Because of this restriction, you cannot use header lines as a way of
28619 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
28620 this, you can use ACL variables, as described in section
28621 &<<SECTaclvariables>>&.
28622
28623 The list of headers yet to be added is given by the &%$headers_added%& variable.
28624
28625 The &%add_header%& modifier acts immediately as it is encountered during the
28626 processing of an ACL. Notice the difference between these two cases:
28627 .display
28628 &`accept add_header = ADDED: some text`&
28629 &`       `&<&'some condition'&>
28630
28631 &`accept `&<&'some condition'&>
28632 &`       add_header = ADDED: some text`&
28633 .endd
28634 In the first case, the header line is always added, whether or not the
28635 condition is true. In the second case, the header line is added only if the
28636 condition is true. Multiple occurrences of &%add_header%& may occur in the same
28637 ACL statement. All those that are encountered before a condition fails are
28638 honoured.
28639
28640 .cindex "&%warn%& ACL verb"
28641 For compatibility with previous versions of Exim, a &%message%& modifier for a
28642 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
28643 effect only if all the conditions are true, even if it appears before some of
28644 them. Furthermore, only the last occurrence of &%message%& is honoured. This
28645 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
28646 are present on a &%warn%& verb, both are processed according to their
28647 specifications.
28648
28649 By default, new header lines are added to a message at the end of the existing
28650 header lines. However, you can specify that any particular header line should
28651 be added right at the start (before all the &'Received:'& lines), immediately
28652 after the first block of &'Received:'& lines, or immediately before any line
28653 that is not a &'Received:'& or &'Resent-something:'& header.
28654
28655 This is done by specifying &":at_start:"&, &":after_received:"&, or
28656 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
28657 header line, respectively. (Header text cannot start with a colon, as there has
28658 to be a header name first.) For example:
28659 .code
28660 warn add_header = \
28661        :after_received:X-My-Header: something or other...
28662 .endd
28663 If more than one header line is supplied in a single &%add_header%& modifier,
28664 each one is treated independently and can therefore be placed differently. If
28665 you add more than one line at the start, or after the Received: block, they end
28666 up in reverse order.
28667
28668 &*Warning*&: This facility currently applies only to header lines that are
28669 added in an ACL. It does NOT work for header lines that are added in a
28670 system filter or in a router or transport.
28671
28672
28673
28674 .section "Removing header lines in ACLs" "SECTremoveheadacl"
28675 .cindex "header lines" "removing in an ACL"
28676 .cindex "header lines" "position of removed lines"
28677 .cindex "&%remove_header%& ACL modifier"
28678 The &%remove_header%& modifier can be used to remove one or more header lines
28679 from an incoming message, as in this example:
28680 .code
28681 warn   message        = Remove internal headers
28682        remove_header  = x-route-mail1 : x-route-mail2
28683 .endd
28684 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
28685 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
28686 receiving a message). The message must ultimately be accepted for
28687 &%remove_header%& to have any significant effect. You can use &%remove_header%&
28688 with any ACL verb, including &%deny%&, though this is really not useful for
28689 any verb that doesn't result in a delivered message.
28690
28691 Headers will not be removed to the message if the modifier is used in
28692 DATA, MIME or DKIM ACLs for messages delivered by cutthrough routing.
28693
28694 More than one header can be removed at the same time by using a colon separated
28695 list of header names. The header matching is case insensitive. Wildcards are
28696 not permitted, nor is list expansion performed, so you cannot use hostlists to
28697 create a list of headers, however both connection and message variable expansion
28698 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
28699 .code
28700 warn   hosts           = +internal_hosts
28701        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
28702 warn   message         = Remove internal headers
28703        remove_header   = $acl_c_ihdrs
28704 .endd
28705 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
28706 They are removed from the message before processing the DATA and MIME ACLs.
28707 There is no harm in attempting to remove the same header twice nor is removing
28708 a non-existent header. Further header lines to be removed may be accumulated
28709 during the DATA and MIME ACLs, after which they are removed from the message,
28710 if present. In the case of non-SMTP messages, headers to be removed are
28711 accumulated during the non-SMTP ACLs, and are removed from the message after
28712 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
28713 ACL, there really is no effect because there is no logging of what headers
28714 would have been removed.
28715
28716 .cindex "header lines" "removed; visibility of"
28717 Header lines are not visible in string expansions until the DATA phase when it
28718 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
28719 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
28720 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
28721 this restriction, you cannot use header lines as a way of controlling data
28722 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
28723 you should instead use ACL variables, as described in section
28724 &<<SECTaclvariables>>&.
28725
28726 The &%remove_header%& modifier acts immediately as it is encountered during the
28727 processing of an ACL. Notice the difference between these two cases:
28728 .display
28729 &`accept remove_header = X-Internal`&
28730 &`       `&<&'some condition'&>
28731
28732 &`accept `&<&'some condition'&>
28733 &`       remove_header = X-Internal`&
28734 .endd
28735 In the first case, the header line is always removed, whether or not the
28736 condition is true. In the second case, the header line is removed only if the
28737 condition is true. Multiple occurrences of &%remove_header%& may occur in the
28738 same ACL statement. All those that are encountered before a condition fails
28739 are honoured.
28740
28741 &*Warning*&: This facility currently applies only to header lines that are
28742 present during ACL processing. It does NOT remove header lines that are added
28743 in a system filter or in a router or transport.
28744
28745
28746
28747
28748 .section "ACL conditions" "SECTaclconditions"
28749 .cindex "&ACL;" "conditions; list of"
28750 Some of the conditions listed in this section are available only when Exim is
28751 compiled with the content-scanning extension. They are included here briefly
28752 for completeness. More detailed descriptions can be found in the discussion on
28753 content scanning in chapter &<<CHAPexiscan>>&.
28754
28755 Not all conditions are relevant in all circumstances. For example, testing
28756 senders and recipients does not make sense in an ACL that is being run as the
28757 result of the arrival of an ETRN command, and checks on message headers can be
28758 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
28759 can use the same condition (with different parameters) more than once in the
28760 same ACL statement. This provides a way of specifying an &"and"& conjunction.
28761 The conditions are as follows:
28762
28763
28764 .vlist
28765 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
28766 .cindex "&ACL;" "nested"
28767 .cindex "&ACL;" "indirect"
28768 .cindex "&ACL;" "arguments"
28769 .cindex "&%acl%& ACL condition"
28770 The possible values of the argument are the same as for the
28771 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
28772 &"accept"& the condition is true; if it returns &"deny"& the condition is
28773 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
28774 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
28775 condition false. This means that further processing of the &%warn%& verb
28776 ceases, but processing of the ACL continues.
28777
28778 If the argument is a named ACL, up to nine space-separated optional values
28779 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
28780 and $acl_narg is set to the count of values.
28781 Previous values of these variables are restored after the call returns.
28782 The name and values are expanded separately.
28783 Note that spaces in complex expansions which are used as arguments
28784 will act as argument separators.
28785
28786 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
28787 the connection is dropped. If it returns &"discard"&, the verb must be
28788 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
28789 conditions are tested.
28790
28791 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
28792 loops. This condition allows you to use different ACLs in different
28793 circumstances. For example, different ACLs can be used to handle RCPT commands
28794 for different local users or different local domains.
28795
28796 .vitem &*authenticated&~=&~*&<&'string&~list'&>
28797 .cindex "&%authenticated%& ACL condition"
28798 .cindex "authentication" "ACL checking"
28799 .cindex "&ACL;" "testing for authentication"
28800 If the SMTP connection is not authenticated, the condition is false. Otherwise,
28801 the name of the authenticator is tested against the list. To test for
28802 authentication by any authenticator, you can set
28803 .code
28804 authenticated = *
28805 .endd
28806
28807 .vitem &*condition&~=&~*&<&'string'&>
28808 .cindex "&%condition%& ACL condition"
28809 .cindex "customizing" "ACL condition"
28810 .cindex "&ACL;" "customized test"
28811 .cindex "&ACL;" "testing, customized"
28812 This feature allows you to make up custom conditions. If the result of
28813 expanding the string is an empty string, the number zero, or one of the strings
28814 &"no"& or &"false"&, the condition is false. If the result is any non-zero
28815 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
28816 any other value, some error is assumed to have occurred, and the ACL returns
28817 &"defer"&. However, if the expansion is forced to fail, the condition is
28818 ignored. The effect is to treat it as true, whether it is positive or
28819 negative.
28820
28821 .vitem &*decode&~=&~*&<&'location'&>
28822 .cindex "&%decode%& ACL condition"
28823 This condition is available only when Exim is compiled with the
28824 content-scanning extension, and it is allowed only in the ACL defined by
28825 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
28826 If all goes well, the condition is true. It is false only if there are
28827 problems such as a syntax error or a memory shortage. For more details, see
28828 chapter &<<CHAPexiscan>>&.
28829
28830 .vitem &*demime&~=&~*&<&'extension&~list'&>
28831 .cindex "&%demime%& ACL condition"
28832 This condition is available only when Exim is compiled with the
28833 content-scanning extension. Its use is described in section
28834 &<<SECTdemimecond>>&.
28835
28836 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
28837 .cindex "&%dnslists%& ACL condition"
28838 .cindex "DNS list" "in ACL"
28839 .cindex "black list (DNS)"
28840 .cindex "&ACL;" "testing a DNS list"
28841 This condition checks for entries in DNS black lists. These are also known as
28842 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
28843 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
28844 different variants of this condition to describe briefly here. See sections
28845 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
28846
28847 .vitem &*domains&~=&~*&<&'domain&~list'&>
28848 .cindex "&%domains%& ACL condition"
28849 .cindex "domain" "ACL checking"
28850 .cindex "&ACL;" "testing a recipient domain"
28851 .vindex "&$domain_data$&"
28852 This condition is relevant only after a RCPT command. It checks that the domain
28853 of the recipient address is in the domain list. If percent-hack processing is
28854 enabled, it is done before this test is done. If the check succeeds with a
28855 lookup, the result of the lookup is placed in &$domain_data$& until the next
28856 &%domains%& test.
28857
28858 &*Note carefully*& (because many people seem to fall foul of this): you cannot
28859 use &%domains%& in a DATA ACL.
28860
28861
28862 .vitem &*encrypted&~=&~*&<&'string&~list'&>
28863 .cindex "&%encrypted%& ACL condition"
28864 .cindex "encryption" "checking in an ACL"
28865 .cindex "&ACL;" "testing for encryption"
28866 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
28867 name of the cipher suite in use is tested against the list. To test for
28868 encryption without testing for any specific cipher suite(s), set
28869 .code
28870 encrypted = *
28871 .endd
28872
28873
28874 .vitem &*hosts&~=&~*&<&'host&~list'&>
28875 .cindex "&%hosts%& ACL condition"
28876 .cindex "host" "ACL checking"
28877 .cindex "&ACL;" "testing the client host"
28878 This condition tests that the calling host matches the host list. If you have
28879 name lookups or wildcarded host names and IP addresses in the same host list,
28880 you should normally put the IP addresses first. For example, you could have:
28881 .code
28882 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
28883 .endd
28884 The lookup in this example uses the host name for its key. This is implied by
28885 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
28886 and it wouldn't matter which way round you had these two items.)
28887
28888 The reason for the problem with host names lies in the left-to-right way that
28889 Exim processes lists. It can test IP addresses without doing any DNS lookups,
28890 but when it reaches an item that requires a host name, it fails if it cannot
28891 find a host name to compare with the pattern. If the above list is given in the
28892 opposite order, the &%accept%& statement fails for a host whose name cannot be
28893 found, even if its IP address is 10.9.8.7.
28894
28895 If you really do want to do the name check first, and still recognize the IP
28896 address even if the name lookup fails, you can rewrite the ACL like this:
28897 .code
28898 accept hosts = dbm;/etc/friendly/hosts
28899 accept hosts = 10.9.8.7
28900 .endd
28901 The default action on failing to find the host name is to assume that the host
28902 is not in the list, so the first &%accept%& statement fails. The second
28903 statement can then check the IP address.
28904
28905 .vindex "&$host_data$&"
28906 If a &%hosts%& condition is satisfied by means of a lookup, the result
28907 of the lookup is made available in the &$host_data$& variable. This
28908 allows you, for example, to set up a statement like this:
28909 .code
28910 deny  hosts = net-lsearch;/some/file
28911 message = $host_data
28912 .endd
28913 which gives a custom error message for each denied host.
28914
28915 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
28916 .cindex "&%local_parts%& ACL condition"
28917 .cindex "local part" "ACL checking"
28918 .cindex "&ACL;" "testing a local part"
28919 .vindex "&$local_part_data$&"
28920 This condition is relevant only after a RCPT command. It checks that the local
28921 part of the recipient address is in the list. If percent-hack processing is
28922 enabled, it is done before this test. If the check succeeds with a lookup, the
28923 result of the lookup is placed in &$local_part_data$&, which remains set until
28924 the next &%local_parts%& test.
28925
28926 .vitem &*malware&~=&~*&<&'option'&>
28927 .cindex "&%malware%& ACL condition"
28928 .cindex "&ACL;" "virus scanning"
28929 .cindex "&ACL;" "scanning for viruses"
28930 This condition is available only when Exim is compiled with the
28931 content-scanning extension. It causes the incoming message to be scanned for
28932 viruses. For details, see chapter &<<CHAPexiscan>>&.
28933
28934 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28935 .cindex "&%mime_regex%& ACL condition"
28936 .cindex "&ACL;" "testing by regex matching"
28937 This condition is available only when Exim is compiled with the
28938 content-scanning extension, and it is allowed only in the ACL defined by
28939 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
28940 with any of the regular expressions. For details, see chapter
28941 &<<CHAPexiscan>>&.
28942
28943 .vitem &*ratelimit&~=&~*&<&'parameters'&>
28944 .cindex "rate limiting"
28945 This condition can be used to limit the rate at which a user or host submits
28946 messages. Details are given in section &<<SECTratelimiting>>&.
28947
28948 .vitem &*recipients&~=&~*&<&'address&~list'&>
28949 .cindex "&%recipients%& ACL condition"
28950 .cindex "recipient" "ACL checking"
28951 .cindex "&ACL;" "testing a recipient"
28952 This condition is relevant only after a RCPT command. It checks the entire
28953 recipient address against a list of recipients.
28954
28955 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
28956 .cindex "&%regex%& ACL condition"
28957 .cindex "&ACL;" "testing by regex matching"
28958 This condition is available only when Exim is compiled with the
28959 content-scanning extension, and is available only in the DATA, MIME, and
28960 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
28961 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
28962
28963 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
28964 .cindex "&%sender_domains%& ACL condition"
28965 .cindex "sender" "ACL checking"
28966 .cindex "&ACL;" "testing a sender domain"
28967 .vindex "&$domain$&"
28968 .vindex "&$sender_address_domain$&"
28969 This condition tests the domain of the sender of the message against the given
28970 domain list. &*Note*&: The domain of the sender address is in
28971 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
28972 of this condition. This is an exception to the general rule for testing domain
28973 lists. It is done this way so that, if this condition is used in an ACL for a
28974 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
28975 influence the sender checking.
28976
28977 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28978 relaying, because sender addresses are easily, and commonly, forged.
28979
28980 .vitem &*senders&~=&~*&<&'address&~list'&>
28981 .cindex "&%senders%& ACL condition"
28982 .cindex "sender" "ACL checking"
28983 .cindex "&ACL;" "testing a sender"
28984 This condition tests the sender of the message against the given list. To test
28985 for a bounce message, which has an empty sender, set
28986 .code
28987 senders = :
28988 .endd
28989 &*Warning*&: It is a bad idea to use this condition on its own as a control on
28990 relaying, because sender addresses are easily, and commonly, forged.
28991
28992 .vitem &*spam&~=&~*&<&'username'&>
28993 .cindex "&%spam%& ACL condition"
28994 .cindex "&ACL;" "scanning for spam"
28995 This condition is available only when Exim is compiled with the
28996 content-scanning extension. It causes the incoming message to be scanned by
28997 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
28998
28999 .vitem &*verify&~=&~certificate*&
29000 .cindex "&%verify%& ACL condition"
29001 .cindex "TLS" "client certificate verification"
29002 .cindex "certificate" "verification of client"
29003 .cindex "&ACL;" "certificate verification"
29004 .cindex "&ACL;" "testing a TLS certificate"
29005 This condition is true in an SMTP session if the session is encrypted, and a
29006 certificate was received from the client, and the certificate was verified. The
29007 server requests a certificate only if the client matches &%tls_verify_hosts%&
29008 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29009
29010 .vitem &*verify&~=&~csa*&
29011 .cindex "CSA verification"
29012 This condition checks whether the sending host (the client) is authorized to
29013 send email. Details of how this works are given in section
29014 &<<SECTverifyCSA>>&.
29015
29016 .vitem &*verify&~=&~header_names_ascii*&
29017 .cindex "&%verify%& ACL condition"
29018 .cindex "&ACL;" "verifying header names only ASCII"
29019 .cindex "header lines" "verifying header names only ASCII"
29020 .cindex "verifying" "header names only ASCII"
29021 This condition is relevant only in an ACL that is run after a message has been
29022 received, that is, in an ACL specified by &%acl_smtp_data%& or
29023 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29024 there are no non-ASCII characters, also excluding control characters.  The
29025 allowable characters are decimal ASCII values 33 through 126.
29026
29027 Exim itself will handle headers with non-ASCII characters, but it can cause
29028 problems for downstream applications, so this option will allow their
29029 detection and rejection in the DATA ACL's.
29030
29031 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29032 .cindex "&%verify%& ACL condition"
29033 .cindex "&ACL;" "verifying sender in the header"
29034 .cindex "header lines" "verifying the sender in"
29035 .cindex "sender" "verifying in header"
29036 .cindex "verifying" "sender in header"
29037 This condition is relevant only in an ACL that is run after a message has been
29038 received, that is, in an ACL specified by &%acl_smtp_data%& or
29039 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29040 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29041 is loosely thought of as a &"sender"& address (hence the name of the test).
29042 However, an address that appears in one of these headers need not be an address
29043 that accepts bounce messages; only sender addresses in envelopes are required
29044 to accept bounces. Therefore, if you use the callout option on this check, you
29045 might want to arrange for a non-empty address in the MAIL command.
29046
29047 Details of address verification and the options are given later, starting at
29048 section &<<SECTaddressverification>>& (callouts are described in section
29049 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29050 condition to restrict it to bounce messages only:
29051 .code
29052 deny    senders = :
29053         message = A valid sender header is required for bounces
29054        !verify  = header_sender
29055 .endd
29056
29057 .vitem &*verify&~=&~header_syntax*&
29058 .cindex "&%verify%& ACL condition"
29059 .cindex "&ACL;" "verifying header syntax"
29060 .cindex "header lines" "verifying syntax"
29061 .cindex "verifying" "header syntax"
29062 This condition is relevant only in an ACL that is run after a message has been
29063 received, that is, in an ACL specified by &%acl_smtp_data%& or
29064 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29065 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29066 and &'Bcc:'&). Unqualified addresses (local parts without domains) are
29067 permitted only in locally generated messages and from hosts that match
29068 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29069 appropriate.
29070
29071 Note that this condition is a syntax check only. However, a common spamming
29072 ploy used to be to send syntactically invalid headers such as
29073 .code
29074 To: @
29075 .endd
29076 and this condition can be used to reject such messages, though they are not as
29077 common as they used to be.
29078
29079 .vitem &*verify&~=&~helo*&
29080 .cindex "&%verify%& ACL condition"
29081 .cindex "&ACL;" "verifying HELO/EHLO"
29082 .cindex "HELO" "verifying"
29083 .cindex "EHLO" "verifying"
29084 .cindex "verifying" "EHLO"
29085 .cindex "verifying" "HELO"
29086 This condition is true if a HELO or EHLO command has been received from the
29087 client host, and its contents have been verified. If there has been no previous
29088 attempt to verify the HELO/EHLO contents, it is carried out when this
29089 condition is encountered. See the description of the &%helo_verify_hosts%& and
29090 &%helo_try_verify_hosts%& options for details of how to request verification
29091 independently of this condition.
29092
29093 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29094 option), this condition is always true.
29095
29096
29097 .vitem &*verify&~=&~not_blind*&
29098 .cindex "verifying" "not blind"
29099 .cindex "bcc recipients, verifying none"
29100 This condition checks that there are no blind (bcc) recipients in the message.
29101 Every envelope recipient must appear either in a &'To:'& header line or in a
29102 &'Cc:'& header line for this condition to be true. Local parts are checked
29103 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29104 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29105 used only in a DATA or non-SMTP ACL.
29106
29107 There are, of course, many legitimate messages that make use of blind (bcc)
29108 recipients. This check should not be used on its own for blocking messages.
29109
29110
29111 .vitem &*verify&~=&~recipient/*&<&'options'&>
29112 .cindex "&%verify%& ACL condition"
29113 .cindex "&ACL;" "verifying recipient"
29114 .cindex "recipient" "verifying"
29115 .cindex "verifying" "recipient"
29116 .vindex "&$address_data$&"
29117 This condition is relevant only after a RCPT command. It verifies the current
29118 recipient. Details of address verification are given later, starting at section
29119 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29120 of &$address_data$& is the last value that was set while routing the address.
29121 This applies even if the verification fails. When an address that is being
29122 verified is redirected to a single address, verification continues with the new
29123 address, and in that case, the subsequent value of &$address_data$& is the
29124 value for the child address.
29125
29126 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29127 .cindex "&%verify%& ACL condition"
29128 .cindex "&ACL;" "verifying host reverse lookup"
29129 .cindex "host" "verifying reverse lookup"
29130 This condition ensures that a verified host name has been looked up from the IP
29131 address of the client host. (This may have happened already if the host name
29132 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29133 Verification ensures that the host name obtained from a reverse DNS lookup, or
29134 one of its aliases, does, when it is itself looked up in the DNS, yield the
29135 original IP address.
29136
29137 There is one possible option, &`defer_ok`&.  If this is present and a
29138 DNS operation returns a temporary error, the verify condition succeeds.
29139
29140 If this condition is used for a locally generated message (that is, when there
29141 is no client host involved), it always succeeds.
29142
29143 .vitem &*verify&~=&~sender/*&<&'options'&>
29144 .cindex "&%verify%& ACL condition"
29145 .cindex "&ACL;" "verifying sender"
29146 .cindex "sender" "verifying"
29147 .cindex "verifying" "sender"
29148 This condition is relevant only after a MAIL or RCPT command, or after a
29149 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29150 the message's sender is empty (that is, this is a bounce message), the
29151 condition is true. Otherwise, the sender address is verified.
29152
29153 .vindex "&$address_data$&"
29154 .vindex "&$sender_address_data$&"
29155 If there is data in the &$address_data$& variable at the end of routing, its
29156 value is placed in &$sender_address_data$& at the end of verification. This
29157 value can be used in subsequent conditions and modifiers in the same ACL
29158 statement. It does not persist after the end of the current statement. If you
29159 want to preserve the value for longer, you can save it in an ACL variable.
29160
29161 Details of verification are given later, starting at section
29162 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29163 to avoid doing it more than once per message.
29164
29165 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29166 .cindex "&%verify%& ACL condition"
29167 This is a variation of the previous option, in which a modified address is
29168 verified as a sender.
29169 .endlist
29170
29171
29172
29173 .section "Using DNS lists" "SECTmorednslists"
29174 .cindex "DNS list" "in ACL"
29175 .cindex "black list (DNS)"
29176 .cindex "&ACL;" "testing a DNS list"
29177 In its simplest form, the &%dnslists%& condition tests whether the calling host
29178 is on at least one of a number of DNS lists by looking up the inverted IP
29179 address in one or more DNS domains. (Note that DNS list domains are not mail
29180 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29181 special options instead.) For example, if the calling host's IP
29182 address is 192.168.62.43, and the ACL statement is
29183 .code
29184 deny dnslists = blackholes.mail-abuse.org : \
29185                 dialups.mail-abuse.org
29186 .endd
29187 the following records are looked up:
29188 .code
29189 43.62.168.192.blackholes.mail-abuse.org
29190 43.62.168.192.dialups.mail-abuse.org
29191 .endd
29192 As soon as Exim finds an existing DNS record, processing of the list stops.
29193 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29194 to test that a host is on more than one list (an &"and"& conjunction), you can
29195 use two separate conditions:
29196 .code
29197 deny dnslists = blackholes.mail-abuse.org
29198      dnslists = dialups.mail-abuse.org
29199 .endd
29200 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29201 behaves as if the host does not match the list item, that is, as if the DNS
29202 record does not exist. If there are further items in the DNS list, they are
29203 processed.
29204
29205 This is usually the required action when &%dnslists%& is used with &%deny%&
29206 (which is the most common usage), because it prevents a DNS failure from
29207 blocking mail. However, you can change this behaviour by putting one of the
29208 following special items in the list:
29209 .display
29210 &`+include_unknown `&   behave as if the item is on the list
29211 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29212 &`+defer_unknown   `&   give a temporary error
29213 .endd
29214 .cindex "&`+include_unknown`&"
29215 .cindex "&`+exclude_unknown`&"
29216 .cindex "&`+defer_unknown`&"
29217 Each of these applies to any subsequent items on the list. For example:
29218 .code
29219 deny dnslists = +defer_unknown : foo.bar.example
29220 .endd
29221 Testing the list of domains stops as soon as a match is found. If you want to
29222 warn for one list and block for another, you can use two different statements:
29223 .code
29224 deny  dnslists = blackholes.mail-abuse.org
29225 warn  message  = X-Warn: sending host is on dialups list
29226       dnslists = dialups.mail-abuse.org
29227 .endd
29228 DNS list lookups are cached by Exim for the duration of the SMTP session,
29229 so a lookup based on the IP address is done at most once for any incoming
29230 connection. Exim does not share information between multiple incoming
29231 connections (but your local name server cache should be active).
29232
29233
29234
29235 .section "Specifying the IP address for a DNS list lookup" "SECID201"
29236 .cindex "DNS list" "keyed by explicit IP address"
29237 By default, the IP address that is used in a DNS list lookup is the IP address
29238 of the calling host. However, you can specify another IP address by listing it
29239 after the domain name, introduced by a slash. For example:
29240 .code
29241 deny dnslists = black.list.tld/192.168.1.2
29242 .endd
29243 This feature is not very helpful with explicit IP addresses; it is intended for
29244 use with IP addresses that are looked up, for example, the IP addresses of the
29245 MX hosts or nameservers of an email sender address. For an example, see section
29246 &<<SECTmulkeyfor>>& below.
29247
29248
29249
29250
29251 .section "DNS lists keyed on domain names" "SECID202"
29252 .cindex "DNS list" "keyed by domain name"
29253 There are some lists that are keyed on domain names rather than inverted IP
29254 addresses (see for example the &'domain based zones'& link at
29255 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
29256 with these lists. You can change the name that is looked up in a DNS list by
29257 listing it after the domain name, introduced by a slash. For example,
29258 .code
29259 deny  message  = Sender's domain is listed at $dnslist_domain
29260       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
29261 .endd
29262 This particular example is useful only in ACLs that are obeyed after the
29263 RCPT or DATA commands, when a sender address is available. If (for
29264 example) the message's sender is &'user@tld.example'& the name that is looked
29265 up by this example is
29266 .code
29267 tld.example.dsn.rfc-ignorant.org
29268 .endd
29269 A single &%dnslists%& condition can contain entries for both names and IP
29270 addresses. For example:
29271 .code
29272 deny dnslists = sbl.spamhaus.org : \
29273                 dsn.rfc-ignorant.org/$sender_address_domain
29274 .endd
29275 The first item checks the sending host's IP address; the second checks a domain
29276 name. The whole condition is true if either of the DNS lookups succeeds.
29277
29278
29279
29280
29281 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
29282 .cindex "DNS list" "multiple keys for"
29283 The syntax described above for looking up explicitly-defined values (either
29284 names or IP addresses) in a DNS blacklist is a simplification. After the domain
29285 name for the DNS list, what follows the slash can in fact be a list of items.
29286 As with all lists in Exim, the default separator is a colon. However, because
29287 this is a sublist within the list of DNS blacklist domains, it is necessary
29288 either to double the separators like this:
29289 .code
29290 dnslists = black.list.tld/name.1::name.2
29291 .endd
29292 or to change the separator character, like this:
29293 .code
29294 dnslists = black.list.tld/<;name.1;name.2
29295 .endd
29296 If an item in the list is an IP address, it is inverted before the DNS
29297 blacklist domain is appended. If it is not an IP address, no inversion
29298 occurs. Consider this condition:
29299 .code
29300 dnslists = black.list.tld/<;192.168.1.2;a.domain
29301 .endd
29302 The DNS lookups that occur are:
29303 .code
29304 2.1.168.192.black.list.tld
29305 a.domain.black.list.tld
29306 .endd
29307 Once a DNS record has been found (that matches a specific IP return
29308 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
29309 are done. If there is a temporary DNS error, the rest of the sublist of domains
29310 or IP addresses is tried. A temporary error for the whole dnslists item occurs
29311 only if no other DNS lookup in this sublist succeeds. In other words, a
29312 successful lookup for any of the items in the sublist overrides a temporary
29313 error for a previous item.
29314
29315 The ability to supply a list of items after the slash is in some sense just a
29316 syntactic convenience. These two examples have the same effect:
29317 .code
29318 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
29319 dnslists = black.list.tld/a.domain::b.domain
29320 .endd
29321 However, when the data for the list is obtained from a lookup, the second form
29322 is usually much more convenient. Consider this example:
29323 .code
29324 deny message  = The mail servers for the domain \
29325                 $sender_address_domain \
29326                 are listed at $dnslist_domain ($dnslist_value); \
29327                 see $dnslist_text.
29328      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
29329                                    ${lookup dnsdb {>|mxh=\
29330                                    $sender_address_domain} }} }
29331 .endd
29332 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
29333 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
29334 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
29335 of expanding the condition might be something like this:
29336 .code
29337 dnslists = sbl.spahmaus.org/<|192.168.2.3|192.168.5.6|...
29338 .endd
29339 Thus, this example checks whether or not the IP addresses of the sender
29340 domain's mail servers are on the Spamhaus black list.
29341
29342 The key that was used for a successful DNS list lookup is put into the variable
29343 &$dnslist_matched$& (see section &<<SECID204>>&).
29344
29345
29346
29347
29348 .section "Data returned by DNS lists" "SECID203"
29349 .cindex "DNS list" "data returned from"
29350 DNS lists are constructed using address records in the DNS. The original RBL
29351 just used the address 127.0.0.1 on the right hand side of each record, but the
29352 RBL+ list and some other lists use a number of values with different meanings.
29353 The values used on the RBL+ list are:
29354 .display
29355 127.1.0.1  RBL
29356 127.1.0.2  DUL
29357 127.1.0.3  DUL and RBL
29358 127.1.0.4  RSS
29359 127.1.0.5  RSS and RBL
29360 127.1.0.6  RSS and DUL
29361 127.1.0.7  RSS and DUL and RBL
29362 .endd
29363 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
29364 different values. Some DNS lists may return more than one address record;
29365 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
29366
29367
29368 .section "Variables set from DNS lists" "SECID204"
29369 .cindex "expansion" "variables, set from DNS list"
29370 .cindex "DNS list" "variables set from"
29371 .vindex "&$dnslist_domain$&"
29372 .vindex "&$dnslist_matched$&"
29373 .vindex "&$dnslist_text$&"
29374 .vindex "&$dnslist_value$&"
29375 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
29376 the name of the overall domain that matched (for example,
29377 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
29378 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
29379 the DNS record. When the key is an IP address, it is not reversed in
29380 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
29381 cases, for example:
29382 .code
29383 deny dnslists = spamhaus.example
29384 .endd
29385 the key is also available in another variable (in this case,
29386 &$sender_host_address$&). In more complicated cases, however, this is not true.
29387 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
29388 might generate a dnslists lookup like this:
29389 .code
29390 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
29391 .endd
29392 If this condition succeeds, the value in &$dnslist_matched$& might be
29393 &`192.168.6.7`& (for example).
29394
29395 If more than one address record is returned by the DNS lookup, all the IP
29396 addresses are included in &$dnslist_value$&, separated by commas and spaces.
29397 The variable &$dnslist_text$& contains the contents of any associated TXT
29398 record. For lists such as RBL+ the TXT record for a merged entry is often not
29399 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
29400 information.
29401
29402 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
29403 &-- although these appear before the condition in the ACL, they are not
29404 expanded until after it has failed. For example:
29405 .code
29406 deny    hosts = !+local_networks
29407         message = $sender_host_address is listed \
29408                   at $dnslist_domain
29409         dnslists = rbl-plus.mail-abuse.example
29410 .endd
29411
29412
29413
29414 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
29415 .cindex "DNS list" "matching specific returned data"
29416 You can add an equals sign and an IP address after a &%dnslists%& domain name
29417 in order to restrict its action to DNS records with a matching right hand side.
29418 For example,
29419 .code
29420 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
29421 .endd
29422 rejects only those hosts that yield 127.0.0.2. Without this additional data,
29423 any address record is considered to be a match. For the moment, we assume
29424 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
29425 describes how multiple records are handled.
29426
29427 More than one IP address may be given for checking, using a comma as a
29428 separator. These are alternatives &-- if any one of them matches, the
29429 &%dnslists%& condition is true. For example:
29430 .code
29431 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29432 .endd
29433 If you want to specify a constraining address list and also specify names or IP
29434 addresses to be looked up, the constraining address list must be specified
29435 first. For example:
29436 .code
29437 deny dnslists = dsn.rfc-ignorant.org\
29438                 =127.0.0.2/$sender_address_domain
29439 .endd
29440
29441 If the character &`&&`& is used instead of &`=`&, the comparison for each
29442 listed IP address is done by a bitwise &"and"& instead of by an equality test.
29443 In other words, the listed addresses are used as bit masks. The comparison is
29444 true if all the bits in the mask are present in the address that is being
29445 tested. For example:
29446 .code
29447 dnslists = a.b.c&0.0.0.3
29448 .endd
29449 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
29450 want to test whether one bit or another bit is present (as opposed to both
29451 being present), you must use multiple values. For example:
29452 .code
29453 dnslists = a.b.c&0.0.0.1,0.0.0.2
29454 .endd
29455 matches if the final component of the address is an odd number or two times
29456 an odd number.
29457
29458
29459
29460 .section "Negated DNS matching conditions" "SECID205"
29461 You can supply a negative list of IP addresses as part of a &%dnslists%&
29462 condition. Whereas
29463 .code
29464 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
29465 .endd
29466 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29467 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
29468 .code
29469 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
29470 .endd
29471 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
29472 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
29473 words, the result of the test is inverted if an exclamation mark appears before
29474 the &`=`& (or the &`&&`&) sign.
29475
29476 &*Note*&: This kind of negation is not the same as negation in a domain,
29477 host, or address list (which is why the syntax is different).
29478
29479 If you are using just one list, the negation syntax does not gain you much. The
29480 previous example is precisely equivalent to
29481 .code
29482 deny  dnslists = a.b.c
29483      !dnslists = a.b.c=127.0.0.2,127.0.0.3
29484 .endd
29485 However, if you are using multiple lists, the negation syntax is clearer.
29486 Consider this example:
29487 .code
29488 deny  dnslists = sbl.spamhaus.org : \
29489                  list.dsbl.org : \
29490                  dnsbl.njabl.org!=127.0.0.3 : \
29491                  relays.ordb.org
29492 .endd
29493 Using only positive lists, this would have to be:
29494 .code
29495 deny  dnslists = sbl.spamhaus.org : \
29496                  list.dsbl.org
29497 deny  dnslists = dnsbl.njabl.org
29498      !dnslists = dnsbl.njabl.org=127.0.0.3
29499 deny  dnslists = relays.ordb.org
29500 .endd
29501 which is less clear, and harder to maintain.
29502
29503
29504
29505
29506 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
29507 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
29508 thereby providing more than one IP address. When an item in a &%dnslists%& list
29509 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
29510 the match to specific results from the DNS lookup, there are two ways in which
29511 the checking can be handled. For example, consider the condition:
29512 .code
29513 dnslists = a.b.c=127.0.0.1
29514 .endd
29515 What happens if the DNS lookup for the incoming IP address yields both
29516 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
29517 condition true because at least one given value was found, or is it false
29518 because at least one of the found values was not listed? And how does this
29519 affect negated conditions? Both possibilities are provided for with the help of
29520 additional separators &`==`& and &`=&&`&.
29521
29522 .ilist
29523 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
29524 IP addresses matches one of the listed addresses. For the example above, the
29525 condition is true because 127.0.0.1 matches.
29526 .next
29527 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
29528 looked up IP addresses matches one of the listed addresses. If the condition is
29529 changed to:
29530 .code
29531 dnslists = a.b.c==127.0.0.1
29532 .endd
29533 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29534 false because 127.0.0.2 is not listed. You would need to have:
29535 .code
29536 dnslists = a.b.c==127.0.0.1,127.0.0.2
29537 .endd
29538 for the condition to be true.
29539 .endlist
29540
29541 When &`!`& is used to negate IP address matching, it inverts the result, giving
29542 the precise opposite of the behaviour above. Thus:
29543 .ilist
29544 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
29545 addresses matches one of the listed addresses. Consider:
29546 .code
29547 dnslists = a.b.c!&0.0.0.1
29548 .endd
29549 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29550 false because 127.0.0.1 matches.
29551 .next
29552 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
29553 looked up IP address that does not match. Consider:
29554 .code
29555 dnslists = a.b.c!=&0.0.0.1
29556 .endd
29557 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
29558 true, because 127.0.0.2 does not match. You would need to have:
29559 .code
29560 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
29561 .endd
29562 for the condition to be false.
29563 .endlist
29564 When the DNS lookup yields only a single IP address, there is no difference
29565 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
29566
29567
29568
29569
29570 .section "Detailed information from merged DNS lists" "SECTmordetinf"
29571 .cindex "DNS list" "information from merged"
29572 When the facility for restricting the matching IP values in a DNS list is used,
29573 the text from the TXT record that is set in &$dnslist_text$& may not reflect
29574 the true reason for rejection. This happens when lists are merged and the IP
29575 address in the A record is used to distinguish them; unfortunately there is
29576 only one TXT record. One way round this is not to use merged lists, but that
29577 can be inefficient because it requires multiple DNS lookups where one would do
29578 in the vast majority of cases when the host of interest is not on any of the
29579 lists.
29580
29581 A less inefficient way of solving this problem is available. If
29582 two domain names, comma-separated, are given, the second is used first to
29583 do an initial check, making use of any IP value restrictions that are set.
29584 If there is a match, the first domain is used, without any IP value
29585 restrictions, to get the TXT record. As a byproduct of this, there is also
29586 a check that the IP being tested is indeed on the first list. The first
29587 domain is the one that is put in &$dnslist_domain$&. For example:
29588 .code
29589 reject message  = \
29590          rejected because $sender_host_address is blacklisted \
29591          at $dnslist_domain\n$dnslist_text
29592        dnslists = \
29593          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
29594          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29595 .endd
29596 For the first blacklist item, this starts by doing a lookup in
29597 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
29598 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
29599 value, and as long as something is found, it looks for the corresponding TXT
29600 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
29601 The second blacklist item is processed similarly.
29602
29603 If you are interested in more than one merged list, the same list must be
29604 given several times, but because the results of the DNS lookups are cached,
29605 the DNS calls themselves are not repeated. For example:
29606 .code
29607 reject dnslists = \
29608          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
29609          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
29610          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
29611          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
29612 .endd
29613 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
29614 values matches (or if no record is found), this is the only lookup that is
29615 done. Only if there is a match is one of the more specific lists consulted.
29616
29617
29618
29619 .section "DNS lists and IPv6" "SECTmorednslistslast"
29620 .cindex "IPv6" "DNS black lists"
29621 .cindex "DNS list" "IPv6 usage"
29622 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
29623 nibble by nibble. For example, if the calling host's IP address is
29624 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
29625 .code
29626 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
29627   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
29628 .endd
29629 (split over two lines here to fit on the page). Unfortunately, some of the DNS
29630 lists contain wildcard records, intended for IPv4, that interact badly with
29631 IPv6. For example, the DNS entry
29632 .code
29633 *.3.some.list.example.    A    127.0.0.1
29634 .endd
29635 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
29636 Unfortunately, it also matches the entire 3::/4 IPv6 network.
29637
29638 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
29639 &%condition%& condition, as in this example:
29640 .code
29641 deny   condition = ${if isip4{$sender_host_address}}
29642        dnslists  = some.list.example
29643 .endd
29644
29645 If an explicit key is being used for a DNS lookup and it may be an IPv6
29646 address you should specify alternate list separators for both the outer
29647 (DNS list name) list and inner (lookup keys) list:
29648 .code
29649        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
29650 .endd
29651
29652 .section "Rate limiting incoming messages" "SECTratelimiting"
29653 .cindex "rate limiting" "client sending"
29654 .cindex "limiting client sending rates"
29655 .oindex "&%smtp_ratelimit_*%&"
29656 The &%ratelimit%& ACL condition can be used to measure and control the rate at
29657 which clients can send email. This is more powerful than the
29658 &%smtp_ratelimit_*%& options, because those options control the rate of
29659 commands in a single SMTP session only, whereas the &%ratelimit%& condition
29660 works across all connections (concurrent and sequential) from the same client
29661 host. The syntax of the &%ratelimit%& condition is:
29662 .display
29663 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
29664 .endd
29665 If the average client sending rate is less than &'m'& messages per time
29666 period &'p'& then the condition is false; otherwise it is true.
29667
29668 As a side-effect, the &%ratelimit%& condition sets the expansion variable
29669 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
29670 configured value of &'m'&, and &$sender_rate_period$& to the configured value
29671 of &'p'&.
29672
29673 The parameter &'p'& is the smoothing time constant, in the form of an Exim
29674 time interval, for example, &`8h`& for eight hours. A larger time constant
29675 means that it takes Exim longer to forget a client's past behaviour. The
29676 parameter &'m'& is the maximum number of messages that a client is permitted to
29677 send in each time interval. It also specifies the number of messages permitted
29678 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
29679 constant, you can allow a client to send more messages in a burst without
29680 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
29681 both small, messages must be sent at an even rate.
29682
29683 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
29684 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
29685 when deploying the &%ratelimit%& ACL condition. The script prints usage
29686 instructions when it is run with no arguments.
29687
29688 The key is used to look up the data for calculating the client's average
29689 sending rate. This data is stored in Exim's spool directory, alongside the
29690 retry and other hints databases. The default key is &$sender_host_address$&,
29691 which means Exim computes the sending rate of each client host IP address.
29692 By changing the key you can change how Exim identifies clients for the purpose
29693 of ratelimiting. For example, to limit the sending rate of each authenticated
29694 user, independent of the computer they are sending from, set the key to
29695 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
29696 example, &$authenticated_id$& is only meaningful if the client has
29697 authenticated (which you can check with the &%authenticated%& ACL condition).
29698
29699 The lookup key does not have to identify clients: If you want to limit the
29700 rate at which a recipient receives messages, you can use the key
29701 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
29702 ACL.
29703
29704 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
29705 specifies what Exim measures the rate of, for example messages or recipients
29706 or bytes. You can adjust the measurement using the &%unique=%& and/or
29707 &%count=%& options. You can also control when Exim updates the recorded rate
29708 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
29709 separated by a slash, like the other parameters. They may appear in any order.
29710
29711 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
29712 any options that alter the meaning of the stored data. The limit &'m'& is not
29713 stored, so you can alter the configured maximum rate and Exim will still
29714 remember clients' past behaviour. If you change the &%per_*%& mode or add or
29715 remove the &%unique=%& option, the lookup key changes so Exim will forget past
29716 behaviour. The lookup key is not affected by changes to the update mode and
29717 the &%count=%& option.
29718
29719
29720 .section "Ratelimit options for what is being measured" "ratoptmea"
29721 .cindex "rate limiting" "per_* options"
29722 The &%per_conn%& option limits the client's connection rate. It is not
29723 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
29724 &%acl_not_smtp_start%& ACLs.
29725
29726 The &%per_mail%& option limits the client's rate of sending messages. This is
29727 the default if none of the &%per_*%& options is specified. It can be used in
29728 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
29729 &%acl_smtp_data%&, or &%acl_not_smtp%&.
29730
29731 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
29732 the same ACLs as the &%per_mail%& option, though it is best to use this option
29733 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
29734 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
29735 in its MAIL command, which may be inaccurate or completely missing. You can
29736 follow the limit &'m'& in the configuration with K, M, or G to specify limits
29737 in kilobytes, megabytes, or gigabytes, respectively.
29738
29739 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
29740 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29741 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
29742 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
29743 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
29744 in either case the rate limiting engine will see a message with many
29745 recipients as a large high-speed burst.
29746
29747 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
29748 number of different recipients that the client has sent messages to in the
29749 last time period. That is, if the client repeatedly sends messages to the same
29750 recipient, its measured rate is not increased. This option can only be used in
29751 &%acl_smtp_rcpt%&.
29752
29753 The &%per_cmd%& option causes Exim to recompute the rate every time the
29754 condition is processed. This can be used to limit the rate of any SMTP
29755 command. If it is used in multiple ACLs it can limit the aggregate rate of
29756 multiple different commands.
29757
29758 The &%count=%& option can be used to alter how much Exim adds to the client's
29759 measured rate. For example, the &%per_byte%& option is equivalent to
29760 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
29761 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
29762 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
29763
29764 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
29765
29766
29767 .section "Ratelimit update modes" "ratoptupd"
29768 .cindex "rate limiting" "reading data without updating"
29769 You can specify one of three options with the &%ratelimit%& condition to
29770 control when its database is updated. This section describes the &%readonly%&
29771 mode, and the next section describes the &%strict%& and &%leaky%& modes.
29772
29773 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
29774 previously-computed rate to check against the limit.
29775
29776 For example, you can test the client's sending rate and deny it access (when
29777 it is too fast) in the connect ACL. If the client passes this check then it
29778 can go on to send a message, in which case its recorded rate will be updated
29779 in the MAIL ACL. Subsequent connections from the same client will check this
29780 new rate.
29781 .code
29782 acl_check_connect:
29783  deny ratelimit = 100 / 5m / readonly
29784     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
29785                   (max $sender_rate_limit)
29786 # ...
29787 acl_check_mail:
29788  warn ratelimit = 100 / 5m / strict
29789     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
29790                   (max $sender_rate_limit)
29791 .endd
29792
29793 If Exim encounters multiple &%ratelimit%& conditions with the same key when
29794 processing a message then it may increase the client's measured rate more than
29795 it should. For example, this will happen if you check the &%per_rcpt%& option
29796 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
29797 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
29798 multiple update problems by using the &%readonly%& option on later ratelimit
29799 checks.
29800
29801 The &%per_*%& options described above do not make sense in some ACLs. If you
29802 use a &%per_*%& option in an ACL where it is not normally permitted then the
29803 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
29804 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
29805 next section) so you must specify the &%readonly%& option explicitly.
29806
29807
29808 .section "Ratelimit options for handling fast clients" "ratoptfast"
29809 .cindex "rate limiting" "strict and leaky modes"
29810 If a client's average rate is greater than the maximum, the rate limiting
29811 engine can react in two possible ways, depending on the presence of the
29812 &%strict%& or &%leaky%& update modes. This is independent of the other
29813 counter-measures (such as rejecting the message) that may be specified by the
29814 rest of the ACL.
29815
29816 The &%leaky%& (default) option means that the client's recorded rate is not
29817 updated if it is above the limit. The effect of this is that Exim measures the
29818 client's average rate of successfully sent email, which cannot be greater than
29819 the maximum allowed. If the client is over the limit it may suffer some
29820 counter-measures (as specified in the ACL), but it will still be able to send
29821 email at the configured maximum rate, whatever the rate of its attempts. This
29822 is generally the better choice if you have clients that retry automatically.
29823 For example, it does not prevent a sender with an over-aggressive retry rate
29824 from getting any email through.
29825
29826 The &%strict%& option means that the client's recorded rate is always
29827 updated. The effect of this is that Exim measures the client's average rate
29828 of attempts to send email, which can be much higher than the maximum it is
29829 actually allowed. If the client is over the limit it may be subjected to
29830 counter-measures by the ACL. It must slow down and allow sufficient time to
29831 pass that its computed rate falls below the maximum before it can send email
29832 again. The time (the number of smoothing periods) it must wait and not
29833 attempt to send mail can be calculated with this formula:
29834 .code
29835         ln(peakrate/maxrate)
29836 .endd
29837
29838
29839 .section "Limiting the rate of different events" "ratoptuniq"
29840 .cindex "rate limiting" "counting unique events"
29841 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
29842 rate of different events. For example, the &%per_addr%& option uses this
29843 mechanism to count the number of different recipients that the client has
29844 sent messages to in the last time period; it is equivalent to
29845 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
29846 measure the rate that a client uses different sender addresses with the
29847 options &`per_mail/unique=$sender_address`&.
29848
29849 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
29850 has seen for that key. The whole set is thrown away when it is older than the
29851 rate smoothing period &'p'&, so each different event is counted at most once
29852 per period. In the &%leaky%& update mode, an event that causes the client to
29853 go over the limit is not added to the set, in the same way that the client's
29854 recorded rate is not updated in the same situation.
29855
29856 When you combine the &%unique=%& and &%readonly%& options, the specific
29857 &%unique=%& value is ignored, and Exim just retrieves the client's stored
29858 rate.
29859
29860 The &%unique=%& mechanism needs more space in the ratelimit database than the
29861 other &%ratelimit%& options in order to store the event set. The number of
29862 unique values is potentially as large as the rate limit, so the extra space
29863 required increases with larger limits.
29864
29865 The uniqueification is not perfect: there is a small probability that Exim
29866 will think a new event has happened before. If the sender's rate is less than
29867 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
29868 the measured rate can go above the limit, in which case Exim may under-count
29869 events by a significant margin. Fortunately, if the rate is high enough (2.7
29870 times the limit) that the false positive rate goes above 9%, then Exim will
29871 throw away the over-full event set before the measured rate falls below the
29872 limit. Therefore the only harm should be that exceptionally high sending rates
29873 are logged incorrectly; any countermeasures you configure will be as effective
29874 as intended.
29875
29876
29877 .section "Using rate limiting" "useratlim"
29878 Exim's other ACL facilities are used to define what counter-measures are taken
29879 when the rate limit is exceeded. This might be anything from logging a warning
29880 (for example, while measuring existing sending rates in order to define
29881 policy), through time delays to slow down fast senders, up to rejecting the
29882 message. For example:
29883 .code
29884 # Log all senders' rates
29885 warn ratelimit = 0 / 1h / strict
29886      log_message = Sender rate $sender_rate / $sender_rate_period
29887
29888 # Slow down fast senders; note the need to truncate $sender_rate
29889 # at the decimal point.
29890 warn ratelimit = 100 / 1h / per_rcpt / strict
29891      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
29892                    $sender_rate_limit }s
29893
29894 # Keep authenticated users under control
29895 deny authenticated = *
29896      ratelimit = 100 / 1d / strict / $authenticated_id
29897
29898 # System-wide rate limit
29899 defer message = Sorry, too busy. Try again later.
29900      ratelimit = 10 / 1s / $primary_hostname
29901
29902 # Restrict incoming rate from each host, with a default
29903 # set using a macro and special cases looked up in a table.
29904 defer message = Sender rate exceeds $sender_rate_limit \
29905                messages per $sender_rate_period
29906      ratelimit = ${lookup {$sender_host_address} \
29907                    cdb {DB/ratelimits.cdb} \
29908                    {$value} {RATELIMIT} }
29909 .endd
29910 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
29911 especially with the &%per_rcpt%& option, you may suffer from a performance
29912 bottleneck caused by locking on the ratelimit hints database. Apart from
29913 making your ACLs less complicated, you can reduce the problem by using a
29914 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
29915 this means that Exim will lose its hints data after a reboot (including retry
29916 hints, the callout cache, and ratelimit data).
29917
29918
29919
29920 .section "Address verification" "SECTaddressverification"
29921 .cindex "verifying address" "options for"
29922 .cindex "policy control" "address verification"
29923 Several of the &%verify%& conditions described in section
29924 &<<SECTaclconditions>>& cause addresses to be verified. Section
29925 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
29926 The verification conditions can be followed by options that modify the
29927 verification process. The options are separated from the keyword and from each
29928 other by slashes, and some of them contain parameters. For example:
29929 .code
29930 verify = sender/callout
29931 verify = recipient/defer_ok/callout=10s,defer_ok
29932 .endd
29933 The first stage of address verification, which always happens, is to run the
29934 address through the routers, in &"verify mode"&. Routers can detect the
29935 difference between verification and routing for delivery, and their actions can
29936 be varied by a number of generic options such as &%verify%& and &%verify_only%&
29937 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
29938 The available options are as follows:
29939
29940 .ilist
29941 If the &%callout%& option is specified, successful routing to one or more
29942 remote hosts is followed by a &"callout"& to those hosts as an additional
29943 check. Callouts and their sub-options are discussed in the next section.
29944 .next
29945 If there is a defer error while doing verification routing, the ACL
29946 normally returns &"defer"&. However, if you include &%defer_ok%& in the
29947 options, the condition is forced to be true instead. Note that this is a main
29948 verification option as well as a suboption for callouts.
29949 .next
29950 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
29951 discusses the reporting of sender address verification failures.
29952 .next
29953 The &%success_on_redirect%& option causes verification always to succeed
29954 immediately after a successful redirection. By default, if a redirection
29955 generates just one address, that address is also verified. See further
29956 discussion in section &<<SECTredirwhilveri>>&.
29957 .endlist
29958
29959 .cindex "verifying address" "differentiating failures"
29960 .vindex "&$recipient_verify_failure$&"
29961 .vindex "&$sender_verify_failure$&"
29962 .vindex "&$acl_verify_message$&"
29963 After an address verification failure, &$acl_verify_message$& contains the
29964 error message that is associated with the failure. It can be preserved by
29965 coding like this:
29966 .code
29967 warn  !verify = sender
29968        set acl_m0 = $acl_verify_message
29969 .endd
29970 If you are writing your own custom rejection message or log message when
29971 denying access, you can use this variable to include information about the
29972 verification failure.
29973
29974 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
29975 appropriate) contains one of the following words:
29976
29977 .ilist
29978 &%qualify%&: The address was unqualified (no domain), and the message
29979 was neither local nor came from an exempted host.
29980 .next
29981 &%route%&: Routing failed.
29982 .next
29983 &%mail%&: Routing succeeded, and a callout was attempted; rejection
29984 occurred at or before the MAIL command (that is, on initial
29985 connection, HELO, or MAIL).
29986 .next
29987 &%recipient%&: The RCPT command in a callout was rejected.
29988 .next
29989 &%postmaster%&: The postmaster check in a callout was rejected.
29990 .endlist
29991
29992 The main use of these variables is expected to be to distinguish between
29993 rejections of MAIL and rejections of RCPT in callouts.
29994
29995
29996
29997
29998 .section "Callout verification" "SECTcallver"
29999 .cindex "verifying address" "by callout"
30000 .cindex "callout" "verification"
30001 .cindex "SMTP" "callout verification"
30002 For non-local addresses, routing verifies the domain, but is unable to do any
30003 checking of the local part. There are situations where some means of verifying
30004 the local part is desirable. One way this can be done is to make an SMTP
30005 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30006 a subsequent host for a recipient address, to see if the host accepts the
30007 address. We use the term &'callout'& to cover both cases. Note that for a
30008 sender address, the callback is not to the client host that is trying to
30009 deliver the message, but to one of the hosts that accepts incoming mail for the
30010 sender's domain.
30011
30012 Exim does not do callouts by default. If you want them to happen, you must
30013 request them by setting appropriate options on the &%verify%& condition, as
30014 described below. This facility should be used with care, because it can add a
30015 lot of resource usage to the cost of verifying an address. However, Exim does
30016 cache the results of callouts, which helps to reduce the cost. Details of
30017 caching are in section &<<SECTcallvercache>>&.
30018
30019 Recipient callouts are usually used only between hosts that are controlled by
30020 the same administration. For example, a corporate gateway host could use
30021 callouts to check for valid recipients on an internal mailserver. A successful
30022 callout does not guarantee that a real delivery to the address would succeed;
30023 on the other hand, a failing callout does guarantee that a delivery would fail.
30024
30025 If the &%callout%& option is present on a condition that verifies an address, a
30026 second stage of verification occurs if the address is successfully routed to
30027 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30028 &(manualroute)& router, where the router specifies the hosts. However, if a
30029 router that does not set up hosts routes to an &(smtp)& transport with a
30030 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30031 &%hosts_override%& set, its hosts are always used, whether or not the router
30032 supplies a host list.
30033 Callouts are only supported on &(smtp)& transports.
30034
30035 The port that is used is taken from the transport, if it is specified and is a
30036 remote transport. (For routers that do verification only, no transport need be
30037 specified.) Otherwise, the default SMTP port is used. If a remote transport
30038 specifies an outgoing interface, this is used; otherwise the interface is not
30039 specified. Likewise, the text that is used for the HELO command is taken from
30040 the transport's &%helo_data%& option; if there is no transport, the value of
30041 &$smtp_active_hostname$& is used.
30042
30043 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30044 test whether a bounce message could be delivered to the sender address. The
30045 following SMTP commands are sent:
30046 .display
30047 &`HELO `&<&'local host name'&>
30048 &`MAIL FROM:<>`&
30049 &`RCPT TO:`&<&'the address to be tested'&>
30050 &`QUIT`&
30051 .endd
30052 LHLO is used instead of HELO if the transport's &%protocol%& option is
30053 set to &"lmtp"&.
30054
30055 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30056 settings.
30057
30058 A recipient callout check is similar. By default, it also uses an empty address
30059 for the sender. This default is chosen because most hosts do not make use of
30060 the sender address when verifying a recipient. Using the same address means
30061 that a single cache entry can be used for each recipient. Some sites, however,
30062 do make use of the sender address when verifying. These are catered for by the
30063 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30064
30065 If the response to the RCPT command is a 2&'xx'& code, the verification
30066 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30067 Exim tries the next host, if any. If there is a problem with all the remote
30068 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30069 &%callout%& option is given, in which case the condition is forced to succeed.
30070
30071 .cindex "SMTP" "output flushing, disabling for callout"
30072 A callout may take a little time. For this reason, Exim normally flushes SMTP
30073 output before performing a callout in an ACL, to avoid unexpected timeouts in
30074 clients when the SMTP PIPELINING extension is in use. The flushing can be
30075 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30076
30077
30078
30079
30080 .section "Additional parameters for callouts" "CALLaddparcall"
30081 .cindex "callout" "additional parameters for"
30082 The &%callout%& option can be followed by an equals sign and a number of
30083 optional parameters, separated by commas. For example:
30084 .code
30085 verify = recipient/callout=10s,defer_ok
30086 .endd
30087 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30088 separate verify options, is retained for backwards compatibility, but is now
30089 deprecated. The additional parameters for &%callout%& are as follows:
30090
30091
30092 .vlist
30093 .vitem <&'a&~time&~interval'&>
30094 .cindex "callout" "timeout, specifying"
30095 This specifies the timeout that applies for the callout attempt to each host.
30096 For example:
30097 .code
30098 verify = sender/callout=5s
30099 .endd
30100 The default is 30 seconds. The timeout is used for each response from the
30101 remote host. It is also used for the initial connection, unless overridden by
30102 the &%connect%& parameter.
30103
30104
30105 .vitem &*connect&~=&~*&<&'time&~interval'&>
30106 .cindex "callout" "connection timeout, specifying"
30107 This parameter makes it possible to set a different (usually smaller) timeout
30108 for making the SMTP connection. For example:
30109 .code
30110 verify = sender/callout=5s,connect=1s
30111 .endd
30112 If not specified, this timeout defaults to the general timeout value.
30113
30114 .vitem &*defer_ok*&
30115 .cindex "callout" "defer, action on"
30116 When this parameter is present, failure to contact any host, or any other kind
30117 of temporary error, is treated as success by the ACL. However, the cache is not
30118 updated in this circumstance.
30119
30120 .vitem &*fullpostmaster*&
30121 .cindex "callout" "full postmaster check"
30122 This operates like the &%postmaster%& option (see below), but if the check for
30123 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30124 accordance with the specification in RFC 2821. The RFC states that the
30125 unqualified address &'postmaster'& should be accepted.
30126
30127
30128 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30129 .cindex "callout" "sender when verifying header"
30130 When verifying addresses in header lines using the &%header_sender%&
30131 verification option, Exim behaves by default as if the addresses are envelope
30132 sender addresses from a message. Callout verification therefore tests to see
30133 whether a bounce message could be delivered, by using an empty address in the
30134 MAIL command. However, it is arguable that these addresses might never be used
30135 as envelope senders, and could therefore justifiably reject bounce messages
30136 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30137 address to use in the MAIL command. For example:
30138 .code
30139 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30140 .endd
30141 This parameter is available only for the &%header_sender%& verification option.
30142
30143
30144 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30145 .cindex "callout" "overall timeout, specifying"
30146 This parameter sets an overall timeout for performing a callout verification.
30147 For example:
30148 .code
30149 verify = sender/callout=5s,maxwait=30s
30150 .endd
30151 This timeout defaults to four times the callout timeout for individual SMTP
30152 commands. The overall timeout applies when there is more than one host that can
30153 be tried. The timeout is checked before trying the next host. This prevents
30154 very long delays if there are a large number of hosts and all are timing out
30155 (for example, when network connections are timing out).
30156
30157
30158 .vitem &*no_cache*&
30159 .cindex "callout" "cache, suppressing"
30160 .cindex "caching callout, suppressing"
30161 When this parameter is given, the callout cache is neither read nor updated.
30162
30163 .vitem &*postmaster*&
30164 .cindex "callout" "postmaster; checking"
30165 When this parameter is set, a successful callout check is followed by a similar
30166 check for the local part &'postmaster'& at the same domain. If this address is
30167 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30168 the postmaster check is recorded in a cache record; if it is a failure, this is
30169 used to fail subsequent callouts for the domain without a connection being
30170 made, until the cache record expires.
30171
30172 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30173 The postmaster check uses an empty sender in the MAIL command by default.
30174 You can use this parameter to do a postmaster check using a different address.
30175 For example:
30176 .code
30177 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30178 .endd
30179 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30180 one overrides. The &%postmaster%& parameter is equivalent to this example:
30181 .code
30182 require  verify = sender/callout=postmaster_mailfrom=
30183 .endd
30184 &*Warning*&: The caching arrangements for postmaster checking do not take
30185 account of the sender address. It is assumed that either the empty address or
30186 a fixed non-empty address will be used. All that Exim remembers is that the
30187 postmaster check for the domain succeeded or failed.
30188
30189
30190 .vitem &*random*&
30191 .cindex "callout" "&""random""& check"
30192 When this parameter is set, before doing the normal callout check, Exim does a
30193 check for a &"random"& local part at the same domain. The local part is not
30194 really random &-- it is defined by the expansion of the option
30195 &%callout_random_local_part%&, which defaults to
30196 .code
30197 $primary_hostname-$tod_epoch-testing
30198 .endd
30199 The idea here is to try to determine whether the remote host accepts all local
30200 parts without checking. If it does, there is no point in doing callouts for
30201 specific local parts. If the &"random"& check succeeds, the result is saved in
30202 a cache record, and used to force the current and subsequent callout checks to
30203 succeed without a connection being made, until the cache record expires.
30204
30205 .vitem &*use_postmaster*&
30206 .cindex "callout" "sender for recipient check"
30207 This parameter applies to recipient callouts only. For example:
30208 .code
30209 deny  !verify = recipient/callout=use_postmaster
30210 .endd
30211 .vindex "&$qualify_domain$&"
30212 It causes a non-empty postmaster address to be used in the MAIL command when
30213 performing the callout for the recipient, and also for a &"random"& check if
30214 that is configured. The local part of the address is &`postmaster`& and the
30215 domain is the contents of &$qualify_domain$&.
30216
30217 .vitem &*use_sender*&
30218 This option applies to recipient callouts only. For example:
30219 .code
30220 require  verify = recipient/callout=use_sender
30221 .endd
30222 It causes the message's actual sender address to be used in the MAIL
30223 command when performing the callout, instead of an empty address. There is no
30224 need to use this option unless you know that the called hosts make use of the
30225 sender when checking recipients. If used indiscriminately, it reduces the
30226 usefulness of callout caching.
30227 .endlist
30228
30229 If you use any of the parameters that set a non-empty sender for the MAIL
30230 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
30231 &%use_sender%&), you should think about possible loops. Recipient checking is
30232 usually done between two hosts that are under the same management, and the host
30233 that receives the callouts is not normally configured to do callouts itself.
30234 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
30235 these circumstances.
30236
30237 However, if you use a non-empty sender address for a callout to an arbitrary
30238 host, there is the likelihood that the remote host will itself initiate a
30239 callout check back to your host. As it is checking what appears to be a message
30240 sender, it is likely to use an empty address in MAIL, thus avoiding a
30241 callout loop. However, to be on the safe side it would be best to set up your
30242 own ACLs so that they do not do sender verification checks when the recipient
30243 is the address you use for header sender or postmaster callout checking.
30244
30245 Another issue to think about when using non-empty senders for callouts is
30246 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
30247 by the sender/recipient combination; thus, for any given recipient, many more
30248 actual callouts are performed than when an empty sender or postmaster is used.
30249
30250
30251
30252
30253 .section "Callout caching" "SECTcallvercache"
30254 .cindex "hints database" "callout cache"
30255 .cindex "callout" "cache, description of"
30256 .cindex "caching" "callout"
30257 Exim caches the results of callouts in order to reduce the amount of resources
30258 used, unless you specify the &%no_cache%& parameter with the &%callout%&
30259 option. A hints database called &"callout"& is used for the cache. Two
30260 different record types are used: one records the result of a callout check for
30261 a specific address, and the other records information that applies to the
30262 entire domain (for example, that it accepts the local part &'postmaster'&).
30263
30264 When an original callout fails, a detailed SMTP error message is given about
30265 the failure. However, for subsequent failures use the cache data, this message
30266 is not available.
30267
30268 The expiry times for negative and positive address cache records are
30269 independent, and can be set by the global options &%callout_negative_expire%&
30270 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
30271
30272 If a host gives a negative response to an SMTP connection, or rejects any
30273 commands up to and including
30274 .code
30275 MAIL FROM:<>
30276 .endd
30277 (but not including the MAIL command with a non-empty address),
30278 any callout attempt is bound to fail. Exim remembers such failures in a
30279 domain cache record, which it uses to fail callouts for the domain without
30280 making new connections, until the domain record times out. There are two
30281 separate expiry times for domain cache records:
30282 &%callout_domain_negative_expire%& (default 3h) and
30283 &%callout_domain_positive_expire%& (default 7d).
30284
30285 Domain records expire when the negative expiry time is reached if callouts
30286 cannot be made for the domain, or if the postmaster check failed.
30287 Otherwise, they expire when the positive expiry time is reached. This
30288 ensures that, for example, a host that stops accepting &"random"& local parts
30289 will eventually be noticed.
30290
30291 The callout caching mechanism is based on the domain of the address that is
30292 being tested. If the domain routes to several hosts, it is assumed that their
30293 behaviour will be the same.
30294
30295
30296
30297 .section "Sender address verification reporting" "SECTsenaddver"
30298 .cindex "verifying" "suppressing error details"
30299 See section &<<SECTaddressverification>>& for a general discussion of
30300 verification. When sender verification fails in an ACL, the details of the
30301 failure are given as additional output lines before the 550 response to the
30302 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
30303 you might see:
30304 .code
30305 MAIL FROM:<xyz@abc.example>
30306 250 OK
30307 RCPT TO:<pqr@def.example>
30308 550-Verification failed for <xyz@abc.example>
30309 550-Called:   192.168.34.43
30310 550-Sent:     RCPT TO:<xyz@abc.example>
30311 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
30312 550 Sender verification failed
30313 .endd
30314 If more than one RCPT command fails in the same way, the details are given
30315 only for the first of them. However, some administrators do not want to send
30316 out this much information. You can suppress the details by adding
30317 &`/no_details`& to the ACL statement that requests sender verification. For
30318 example:
30319 .code
30320 verify = sender/no_details
30321 .endd
30322
30323 .section "Redirection while verifying" "SECTredirwhilveri"
30324 .cindex "verifying" "redirection while"
30325 .cindex "address redirection" "while verifying"
30326 A dilemma arises when a local address is redirected by aliasing or forwarding
30327 during verification: should the generated addresses themselves be verified,
30328 or should the successful expansion of the original address be enough to verify
30329 it? By default, Exim takes the following pragmatic approach:
30330
30331 .ilist
30332 When an incoming address is redirected to just one child address, verification
30333 continues with the child address, and if that fails to verify, the original
30334 verification also fails.
30335 .next
30336 When an incoming address is redirected to more than one child address,
30337 verification does not continue. A success result is returned.
30338 .endlist
30339
30340 This seems the most reasonable behaviour for the common use of aliasing as a
30341 way of redirecting different local parts to the same mailbox. It means, for
30342 example, that a pair of alias entries of the form
30343 .code
30344 A.Wol:   aw123
30345 aw123:   :fail: Gone away, no forwarding address
30346 .endd
30347 work as expected, with both local parts causing verification failure. When a
30348 redirection generates more than one address, the behaviour is more like a
30349 mailing list, where the existence of the alias itself is sufficient for
30350 verification to succeed.
30351
30352 It is possible, however, to change the default behaviour so that all successful
30353 redirections count as successful verifications, however many new addresses are
30354 generated. This is specified by the &%success_on_redirect%& verification
30355 option. For example:
30356 .code
30357 require verify = recipient/success_on_redirect/callout=10s
30358 .endd
30359 In this example, verification succeeds if a router generates a new address, and
30360 the callout does not occur, because no address was routed to a remote host.
30361
30362 When verification is being tested via the &%-bv%& option, the treatment of
30363 redirections is as just described, unless the &%-v%& or any debugging option is
30364 also specified. In that case, full verification is done for every generated
30365 address and a report is output for each of them.
30366
30367
30368
30369 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
30370 .cindex "CSA" "verifying"
30371 Client SMTP Authorization is a system that allows a site to advertise
30372 which machines are and are not permitted to send email. This is done by placing
30373 special SRV records in the DNS; these are looked up using the client's HELO
30374 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
30375 Authorization checks in Exim are performed by the ACL condition:
30376 .code
30377 verify = csa
30378 .endd
30379 This fails if the client is not authorized. If there is a DNS problem, or if no
30380 valid CSA SRV record is found, or if the client is authorized, the condition
30381 succeeds. These three cases can be distinguished using the expansion variable
30382 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
30383 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
30384 be likely to cause problems for legitimate email.
30385
30386 The error messages produced by the CSA code include slightly more
30387 detail. If &$csa_status$& is &"defer"&, this may be because of problems
30388 looking up the CSA SRV record, or problems looking up the CSA target
30389 address record. There are four reasons for &$csa_status$& being &"fail"&:
30390
30391 .ilist
30392 The client's host name is explicitly not authorized.
30393 .next
30394 The client's IP address does not match any of the CSA target IP addresses.
30395 .next
30396 The client's host name is authorized but it has no valid target IP addresses
30397 (for example, the target's addresses are IPv6 and the client is using IPv4).
30398 .next
30399 The client's host name has no CSA SRV record but a parent domain has asserted
30400 that all subdomains must be explicitly authorized.
30401 .endlist
30402
30403 The &%csa%& verification condition can take an argument which is the domain to
30404 use for the DNS query. The default is:
30405 .code
30406 verify = csa/$sender_helo_name
30407 .endd
30408 This implementation includes an extension to CSA. If the query domain
30409 is an address literal such as [192.0.2.95], or if it is a bare IP
30410 address, Exim searches for CSA SRV records in the reverse DNS as if
30411 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
30412 meaningful to say:
30413 .code
30414 verify = csa/$sender_host_address
30415 .endd
30416 In fact, this is the check that Exim performs if the client does not say HELO.
30417 This extension can be turned off by setting the main configuration option
30418 &%dns_csa_use_reverse%& to be false.
30419
30420 If a CSA SRV record is not found for the domain itself, a search
30421 is performed through its parent domains for a record which might be
30422 making assertions about subdomains. The maximum depth of this search is limited
30423 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
30424 default. Exim does not look for CSA SRV records in a top level domain, so the
30425 default settings handle HELO domains as long as seven
30426 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
30427 of legitimate HELO domains.
30428
30429 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
30430 direct SRV lookups, this is not sufficient because of the extra parent domain
30431 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
30432 addresses into lookups in the reverse DNS space. The result of a successful
30433 lookup such as:
30434 .code
30435 ${lookup dnsdb {csa=$sender_helo_name}}
30436 .endd
30437 has two space-separated fields: an authorization code and a target host name.
30438 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
30439 authorization required but absent, or &"?"& for unknown.
30440
30441
30442
30443
30444 .section "Bounce address tag validation" "SECTverifyPRVS"
30445 .cindex "BATV, verifying"
30446 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
30447 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
30448 Genuine incoming bounce messages should therefore always be addressed to
30449 recipients that have a valid tag. This scheme is a way of detecting unwanted
30450 bounce messages caused by sender address forgeries (often called &"collateral
30451 spam"&), because the recipients of such messages do not include valid tags.
30452
30453 There are two expansion items to help with the implementation of the BATV
30454 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
30455 the original envelope sender address by using a simple key to add a hash of the
30456 address and some time-based randomizing information. The &%prvs%& expansion
30457 item creates a signed address, and the &%prvscheck%& expansion item checks one.
30458 The syntax of these expansion items is described in section
30459 &<<SECTexpansionitems>>&.
30460
30461 As an example, suppose the secret per-address keys are stored in an MySQL
30462 database. A query to look up the key for an address could be defined as a macro
30463 like this:
30464 .code
30465 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
30466                 WHERE sender='${quote_mysql:$prvscheck_address}'\
30467                 }{$value}}
30468 .endd
30469 Suppose also that the senders who make use of BATV are defined by an address
30470 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
30471 use this:
30472 .code
30473 # Bounces: drop unsigned addresses for BATV senders
30474 deny message = This address does not send an unsigned reverse path
30475      senders = :
30476      recipients = +batv_senders
30477
30478 # Bounces: In case of prvs-signed address, check signature.
30479 deny message = Invalid reverse path signature.
30480      senders = :
30481      condition  = ${prvscheck {$local_part@$domain}\
30482                   {PRVSCHECK_SQL}{1}}
30483      !condition = $prvscheck_result
30484 .endd
30485 The first statement rejects recipients for bounce messages that are addressed
30486 to plain BATV sender addresses, because it is known that BATV senders do not
30487 send out messages with plain sender addresses. The second statement rejects
30488 recipients that are prvs-signed, but with invalid signatures (either because
30489 the key is wrong, or the signature has timed out).
30490
30491 A non-prvs-signed address is not rejected by the second statement, because the
30492 &%prvscheck%& expansion yields an empty string if its first argument is not a
30493 prvs-signed address, thus causing the &%condition%& condition to be false. If
30494 the first argument is a syntactically valid prvs-signed address, the yield is
30495 the third string (in this case &"1"&), whether or not the cryptographic and
30496 timeout checks succeed. The &$prvscheck_result$& variable contains the result
30497 of the checks (empty for failure, &"1"& for success).
30498
30499 There is one more issue you must consider when implementing prvs-signing:
30500 you have to ensure that the routers accept prvs-signed addresses and
30501 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
30502 router to remove the signature with a configuration along these lines:
30503 .code
30504 batv_redirect:
30505   driver = redirect
30506   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
30507 .endd
30508 This works because, if the third argument of &%prvscheck%& is empty, the result
30509 of the expansion of a prvs-signed address is the decoded value of the original
30510 address. This router should probably be the first of your routers that handles
30511 local addresses.
30512
30513 To create BATV-signed addresses in the first place, a transport of this form
30514 can be used:
30515 .code
30516 external_smtp_batv:
30517   driver = smtp
30518   return_path = ${prvs {$return_path} \
30519                        {${lookup mysql{SELECT \
30520                        secret FROM batv_prvs WHERE \
30521                        sender='${quote_mysql:$sender_address}'} \
30522                        {$value}fail}}}
30523 .endd
30524 If no key can be found for the existing return path, no signing takes place.
30525
30526
30527
30528 .section "Using an ACL to control relaying" "SECTrelaycontrol"
30529 .cindex "&ACL;" "relay control"
30530 .cindex "relaying" "control by ACL"
30531 .cindex "policy control" "relay control"
30532 An MTA is said to &'relay'& a message if it receives it from some host and
30533 delivers it directly to another host as a result of a remote address contained
30534 within it. Redirecting a local address via an alias or forward file and then
30535 passing the message on to another host is not relaying,
30536 .cindex "&""percent hack""&"
30537 but a redirection as a result of the &"percent hack"& is.
30538
30539 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
30540 A host which is acting as a gateway or an MX backup is concerned with incoming
30541 relaying from arbitrary hosts to a specific set of domains. On the other hand,
30542 a host which is acting as a smart host for a number of clients is concerned
30543 with outgoing relaying from those clients to the Internet at large. Often the
30544 same host is fulfilling both functions,
30545 . ///
30546 . as illustrated in the diagram below,
30547 . ///
30548 but in principle these two kinds of relaying are entirely independent. What is
30549 not wanted is the transmission of mail from arbitrary remote hosts through your
30550 system to arbitrary domains.
30551
30552
30553 You can implement relay control by means of suitable statements in the ACL that
30554 runs for each RCPT command. For convenience, it is often easiest to use
30555 Exim's named list facility to define the domains and hosts involved. For
30556 example, suppose you want to do the following:
30557
30558 .ilist
30559 Deliver a number of domains to mailboxes on the local host (or process them
30560 locally in some other way). Let's say these are &'my.dom1.example'& and
30561 &'my.dom2.example'&.
30562 .next
30563 Relay mail for a number of other domains for which you are the secondary MX.
30564 These might be &'friend1.example'& and &'friend2.example'&.
30565 .next
30566 Relay mail from the hosts on your local LAN, to whatever domains are involved.
30567 Suppose your LAN is 192.168.45.0/24.
30568 .endlist
30569
30570
30571 In the main part of the configuration, you put the following definitions:
30572 .code
30573 domainlist local_domains    = my.dom1.example : my.dom2.example
30574 domainlist relay_to_domains = friend1.example : friend2.example
30575 hostlist   relay_from_hosts = 192.168.45.0/24
30576 .endd
30577 Now you can use these definitions in the ACL that is run for every RCPT
30578 command:
30579 .code
30580 acl_check_rcpt:
30581   accept domains = +local_domains : +relay_to_domains
30582   accept hosts   = +relay_from_hosts
30583 .endd
30584 The first statement accepts any RCPT command that contains an address in
30585 the local or relay domains. For any other domain, control passes to the second
30586 statement, which accepts the command only if it comes from one of the relay
30587 hosts. In practice, you will probably want to make your ACL more sophisticated
30588 than this, for example, by including sender and recipient verification. The
30589 default configuration includes a more comprehensive example, which is described
30590 in chapter &<<CHAPdefconfil>>&.
30591
30592
30593
30594 .section "Checking a relay configuration" "SECTcheralcon"
30595 .cindex "relaying" "checking control of"
30596 You can check the relay characteristics of your configuration in the same way
30597 that you can test any ACL behaviour for an incoming SMTP connection, by using
30598 the &%-bh%& option to run a fake SMTP session with which you interact.
30599
30600 For specifically testing for unwanted relaying, the host
30601 &'relay-test.mail-abuse.org'& provides a useful service. If you telnet to this
30602 host from the host on which Exim is running, using the normal telnet port, you
30603 will see a normal telnet connection message and then quite a long delay. Be
30604 patient. The remote host is making an SMTP connection back to your host, and
30605 trying a number of common probes to test for open relay vulnerability. The
30606 results of the tests will eventually appear on your terminal.
30607 .ecindex IIDacl
30608
30609
30610
30611 . ////////////////////////////////////////////////////////////////////////////
30612 . ////////////////////////////////////////////////////////////////////////////
30613
30614 .chapter "Content scanning at ACL time" "CHAPexiscan"
30615 .scindex IIDcosca "content scanning" "at ACL time"
30616 The extension of Exim to include content scanning at ACL time, formerly known
30617 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
30618 was integrated into the main source for Exim release 4.50, and Tom continues to
30619 maintain it. Most of the wording of this chapter is taken from Tom's
30620 specification.
30621
30622 It is also possible to scan the content of messages at other times. The
30623 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
30624 scanning after all the ACLs have run. A transport filter can be used to scan
30625 messages at delivery time (see the &%transport_filter%& option, described in
30626 chapter &<<CHAPtransportgeneric>>&).
30627
30628 If you want to include the ACL-time content-scanning features when you compile
30629 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
30630 &_Local/Makefile_&. When you do that, the Exim binary is built with:
30631
30632 .ilist
30633 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
30634 for all MIME parts for SMTP and non-SMTP messages, respectively.
30635 .next
30636 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
30637 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
30638 run at the end of message reception (the &%acl_smtp_data%& ACL).
30639 .next
30640 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
30641 of messages, or parts of messages, for debugging purposes.
30642 .next
30643 Additional expansion variables that are set in the new ACL and by the new
30644 conditions.
30645 .next
30646 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
30647 .endlist
30648
30649 There is another content-scanning configuration option for &_Local/Makefile_&,
30650 called WITH_OLD_DEMIME. If this is set, the old, deprecated &%demime%& ACL
30651 condition is compiled, in addition to all the other content-scanning features.
30652
30653 Content-scanning is continually evolving, and new features are still being
30654 added. While such features are still unstable and liable to incompatible
30655 changes, they are made available in Exim by setting options whose names begin
30656 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
30657 this manual. You can find out about them by reading the file called
30658 &_doc/experimental.txt_&.
30659
30660 All the content-scanning facilities work on a MBOX copy of the message that is
30661 temporarily created in a file called:
30662 .display
30663 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
30664 .endd
30665 The &_.eml_& extension is a friendly hint to virus scanners that they can
30666 expect an MBOX-like structure inside that file. The file is created when the
30667 first content scanning facility is called. Subsequent calls to content
30668 scanning conditions open the same file again. The directory is recursively
30669 removed when the &%acl_smtp_data%& ACL has finished running, unless
30670 .code
30671 control = no_mbox_unspool
30672 .endd
30673 has been encountered. When the MIME ACL decodes files, they are put into the
30674 same directory by default.
30675
30676
30677
30678 .section "Scanning for viruses" "SECTscanvirus"
30679 .cindex "virus scanning"
30680 .cindex "content scanning" "for viruses"
30681 .cindex "content scanning" "the &%malware%& condition"
30682 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
30683 It supports a &"generic"& interface to scanners called via the shell, and
30684 specialized interfaces for &"daemon"& type virus scanners, which are resident
30685 in memory and thus are much faster.
30686
30687 .new
30688 A timeout of 2 minutes is applied to a scanner call (by default);
30689 if it expires then a defer action is taken.
30690 .wen
30691
30692 .oindex "&%av_scanner%&"
30693 You can set the &%av_scanner%& option in the main part of the configuration
30694 to specify which scanner to use, together with any additional options that
30695 are needed. The basic syntax is as follows:
30696 .display
30697 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
30698 .endd
30699 If you do not set &%av_scanner%&, it defaults to
30700 .code
30701 av_scanner = sophie:/var/run/sophie
30702 .endd
30703 If the value of &%av_scanner%& starts with a dollar character, it is expanded
30704 before use.
30705 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
30706 The following scanner types are supported in this release:
30707
30708 .vlist
30709 .new
30710 .vitem &%avast%&
30711 .cindex "virus scanners" "avast"
30712 This is the scanner daemon of Avast. It has been tested with Avast Core
30713 Security (currenty at version 1.1.7).
30714 You can get a trial version at &url(http://www.avast.com) or for Linux
30715 at &url(http://www.avast.com/linux-server-antivirus).
30716 This scanner type takes one option,
30717 which can be either a full path to a UNIX socket,
30718 or host and port specifiers separated by white space.
30719 The host may be a name or an IP address; the port is either a
30720 single number or a pair of numbers with a dash between.
30721 Any further options are given, on separate lines,
30722 to the daemon as options before the main scan command.
30723 For example:
30724 .code
30725 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
30726 av_scanner = avast:192.168.2.22 5036
30727 .endd
30728 If you omit the argument, the default path
30729 &_/var/run/avast/scan.sock_&
30730 is used.
30731 If you use a remote host,
30732 you need to make Exim's spool directory available to it,
30733 as the scanner is passed a file path, not file contents.
30734 For information about available commands and their options you may use 
30735 .code
30736 $ socat UNIX:/var/run/avast/scan.sock STDIO:
30737     FLAGS
30738     SENSITIVITY
30739     PACK
30740 .endd
30741 .wen
30742
30743
30744 .vitem &%aveserver%&
30745 .cindex "virus scanners" "Kaspersky"
30746 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
30747 at &url(http://www.kaspersky.com). This scanner type takes one option,
30748 which is the path to the daemon's UNIX socket. The default is shown in this
30749 example:
30750 .code
30751 av_scanner = aveserver:/var/run/aveserver
30752 .endd
30753
30754
30755 .vitem &%clamd%&
30756 .cindex "virus scanners" "clamd"
30757 This daemon-type scanner is GPL and free. You can get it at
30758 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
30759 unpack MIME containers, so it used to be recommended to unpack MIME attachments
30760 in the MIME ACL. This is no longer believed to be necessary.
30761
30762 The options are a list of server specifiers, which may be
30763 a UNIX socket specification,
30764 a TCP socket specification,
30765 or a (global) option.
30766
30767 A socket specification consists of a space-separated list.
30768 For a Unix socket the first element is a full path for the socket,
30769 for a TCP socket the first element is the IP address
30770 and the second a port number,
30771 Any further elements are per-server (non-global) options.
30772 These per-server options are supported:
30773 .code
30774 retry=<timespec>        Retry on connect fail
30775 .endd
30776
30777 The &`retry`& option specifies a time after which a single retry for
30778 a failed connect is made.  The default is to not retry.
30779
30780 If a Unix socket file is specified, only one server is supported.
30781
30782 Examples:
30783 .code
30784 av_scanner = clamd:/opt/clamd/socket
30785 av_scanner = clamd:192.0.2.3 1234
30786 av_scanner = clamd:192.0.2.3 1234:local
30787 av_scanner = clamd:192.0.2.3 1234 retry=10s
30788 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
30789 .endd
30790 If the value of av_scanner points to a UNIX socket file or contains the
30791 &`local`&
30792 option, then the ClamAV interface will pass a filename containing the data
30793 to be scanned, which will should normally result in less I/O happening and be
30794 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
30795 Exim does not assume that there is a common filesystem with the remote host.
30796 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
30797 you be running a version of ClamAV prior to 0.95.
30798
30799 The final example shows that multiple TCP targets can be specified.  Exim will
30800 randomly use one for each incoming email (i.e. it load balances them).  Note
30801 that only TCP targets may be used if specifying a list of scanners; a UNIX
30802 socket cannot be mixed in with TCP targets.  If one of the servers becomes
30803 unavailable, Exim will try the remaining one(s) until it finds one that works.
30804 When a clamd server becomes unreachable, Exim will log a message.  Exim does
30805 not keep track of scanner state between multiple messages, and the scanner
30806 selection is random, so the message will get logged in the mainlog for each
30807 email that the down scanner gets chosen first (message wrapped to be readable):
30808 .code
30809 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
30810    clamd: connection to localhost, port 3310 failed
30811    (Connection refused)
30812 .endd
30813
30814 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
30815 contributing the code for this scanner.
30816
30817 .vitem &%cmdline%&
30818 .cindex "virus scanners" "command line interface"
30819 This is the keyword for the generic command line scanner interface. It can be
30820 used to attach virus scanners that are invoked from the shell. This scanner
30821 type takes 3 mandatory options:
30822
30823 .olist
30824 The full path and name of the scanner binary, with all command line options,
30825 and a placeholder (&`%s`&) for the directory to scan.
30826
30827 .next
30828 A regular expression to match against the STDOUT and STDERR output of the
30829 virus scanner. If the expression matches, a virus was found. You must make
30830 absolutely sure that this expression matches on &"virus found"&. This is called
30831 the &"trigger"& expression.
30832
30833 .next
30834 Another regular expression, containing exactly one pair of parentheses, to
30835 match the name of the virus found in the scanners output. This is called the
30836 &"name"& expression.
30837 .endlist olist
30838
30839 For example, Sophos Sweep reports a virus on a line like this:
30840 .code
30841 Virus 'W32/Magistr-B' found in file ./those.bat
30842 .endd
30843 For the trigger expression, we can match the phrase &"found in file"&. For the
30844 name expression, we want to extract the W32/Magistr-B string, so we can match
30845 for the single quotes left and right of it. Altogether, this makes the
30846 configuration setting:
30847 .code
30848 av_scanner = cmdline:\
30849              /path/to/sweep -ss -all -rec -archive %s:\
30850              found in file:'(.+)'
30851 .endd
30852 .vitem &%drweb%&
30853 .cindex "virus scanners" "DrWeb"
30854 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
30855 takes one option,
30856 either a full path to a UNIX socket,
30857 or host and port specifiers separated by white space.
30858 The host may be a name or an IP address; the port is either a
30859 single number or a pair of numbers with a dash between.
30860 For example:
30861 .code
30862 av_scanner = drweb:/var/run/drwebd.sock
30863 av_scanner = drweb:192.168.2.20 31337
30864 .endd
30865 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
30866 is used. Thanks to Alex Miller for contributing the code for this scanner.
30867
30868 .vitem &%f-protd%&
30869 .cindex "virus scanners" "f-protd"
30870 The f-protd scanner is accessed via HTTP over TCP.
30871 One argument is taken, being a space-separated hostname and port number
30872 (or port-range).
30873 For example:
30874 .code
30875 av_scanner = f-protd:localhost 10200-10204
30876 .endd
30877 If you omit the argument, the default values show above are used.
30878
30879 .vitem &%fsecure%&
30880 .cindex "virus scanners" "F-Secure"
30881 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
30882 argument which is the path to a UNIX socket. For example:
30883 .code
30884 av_scanner = fsecure:/path/to/.fsav
30885 .endd
30886 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
30887 Thelmen for contributing the code for this scanner.
30888
30889 .vitem &%kavdaemon%&
30890 .cindex "virus scanners" "Kaspersky"
30891 This is the scanner daemon of Kaspersky Version 4. This version of the
30892 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
30893 scanner type takes one option, which is the path to the daemon's UNIX socket.
30894 For example:
30895 .code
30896 av_scanner = kavdaemon:/opt/AVP/AvpCtl
30897 .endd
30898 The default path is &_/var/run/AvpCtl_&.
30899
30900 .vitem &%mksd%&
30901 .cindex "virus scanners" "mksd"
30902 This is a daemon type scanner that is aimed mainly at Polish users, though some
30903 parts of documentation are now available in English. You can get it at
30904 &url(http://linux.mks.com.pl/). The only option for this scanner type is
30905 the maximum number of processes used simultaneously to scan the attachments,
30906 provided that the demime facility is employed and also provided that mksd has
30907 been run with at least the same number of child processes. For example:
30908 .code
30909 av_scanner = mksd:2
30910 .endd
30911 You can safely omit this option (the default value is 1).
30912
30913 .vitem &%sock%&
30914 .cindex "virus scanners" "simple socket-connected"
30915 This is a general-purpose way of talking to simple scanner daemons
30916 running on the local machine.
30917 There are four options:
30918 an address (which may be an IP addres and port, or the path of a Unix socket),
30919 a commandline to send (may include a single %s which will be replaced with
30920 the path to the mail file to be scanned),
30921 an RE to trigger on from the returned data,
30922 an RE to extract malware_name from the returned data.
30923 For example:
30924 .code
30925 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)\$
30926 .endd
30927 Default for the socket specifier is &_/tmp/malware.sock_&.
30928 Default for the commandline is &_%s\n_&.
30929 Both regular-expressions are required.
30930
30931 .vitem &%sophie%&
30932 .cindex "virus scanners" "Sophos and Sophie"
30933 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
30934 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
30935 for this scanner type is the path to the UNIX socket that Sophie uses for
30936 client communication. For example:
30937 .code
30938 av_scanner = sophie:/tmp/sophie
30939 .endd
30940 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
30941 the option.
30942 .endlist
30943
30944 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
30945 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
30946 ACL.
30947
30948 The &%av_scanner%& option is expanded each time &%malware%& is called. This
30949 makes it possible to use different scanners. See further below for an example.
30950 The &%malware%& condition caches its results, so when you use it multiple times
30951 for the same message, the actual scanning process is only carried out once.
30952 However, using expandable items in &%av_scanner%& disables this caching, in
30953 which case each use of the &%malware%& condition causes a new scan of the
30954 message.
30955
30956 The &%malware%& condition takes a right-hand argument that is expanded before
30957 .new
30958 use and taken as a list, slash-separated by default.
30959 .wen
30960 The first element can then be one of
30961
30962 .ilist
30963 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
30964 The condition succeeds if a virus was found, and fail otherwise. This is the
30965 recommended usage.
30966 .next
30967 &"false"& or &"0"& or an empty string, in which case no scanning is done and
30968 the condition fails immediately.
30969 .next
30970 A regular expression, in which case the message is scanned for viruses. The
30971 condition succeeds if a virus is found and its name matches the regular
30972 expression. This allows you to take special actions on certain types of virus.
30973 .new
30974 Note that &"/"& characters in the RE must be doubled due to the list-processing,
30975 unless the separator is changed (in the usual way).
30976 .wen
30977 .endlist
30978
30979 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
30980 messages even if there is a problem with the virus scanner.
30981 Otherwise, such a problem causes the ACL to defer.
30982
30983 .new
30984 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
30985 specify a non-default timeout.  The default is two minutes.
30986 For example:
30987 .code
30988 malware = * / defer_ok / tmo=10s
30989 .endd
30990 A timeout causes the ACL to defer.
30991 .wen
30992
30993 .vindex "&$malware_name$&"
30994 When a virus is found, the condition sets up an expansion variable called
30995 &$malware_name$& that contains the name of the virus. You can use it in a
30996 &%message%& modifier that specifies the error returned to the sender, and/or in
30997 logging data.
30998
30999 If your virus scanner cannot unpack MIME and TNEF containers itself, you should
31000 use the &%demime%& condition (see section &<<SECTdemimecond>>&) before the
31001 &%malware%& condition.
31002
31003 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31004 imposed by your anti-virus scanner.
31005
31006 Here is a very simple scanning example:
31007 .code
31008 deny message = This message contains malware ($malware_name)
31009      demime = *
31010      malware = *
31011 .endd
31012 The next example accepts messages when there is a problem with the scanner:
31013 .code
31014 deny message = This message contains malware ($malware_name)
31015      demime = *
31016      malware = */defer_ok
31017 .endd
31018 The next example shows how to use an ACL variable to scan with both sophie and
31019 aveserver. It assumes you have set:
31020 .code
31021 av_scanner = $acl_m0
31022 .endd
31023 in the main Exim configuration.
31024 .code
31025 deny message = This message contains malware ($malware_name)
31026      set acl_m0 = sophie
31027      malware = *
31028
31029 deny message = This message contains malware ($malware_name)
31030      set acl_m0 = aveserver
31031      malware = *
31032 .endd
31033
31034
31035 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31036 .cindex "content scanning" "for spam"
31037 .cindex "spam scanning"
31038 .cindex "SpamAssassin"
31039 .cindex "Rspamd"
31040 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31041 score and a report for the message.
31042 .new
31043 Support is also provided for Rspamd.
31044
31045 For more information about installation and configuration of SpamAssassin or 
31046 Rspamd refer to their respective websites at
31047 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31048 .wen
31049
31050 SpamAssassin can be installed with CPAN by running:
31051 .code
31052 perl -MCPAN -e 'install Mail::SpamAssassin'
31053 .endd
31054 SpamAssassin has its own set of configuration files. Please review its
31055 documentation to see how you can tweak it. The default installation should work
31056 nicely, however.
31057
31058 .oindex "&%spamd_address%&"
31059 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you 
31060 intend to use an instance running on the local host you do not need to set
31061 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31062 you must set the &%spamd_address%& option in the global part of the Exim
31063 configuration as follows (example):
31064 .code
31065 spamd_address = 192.168.99.45 387
31066 .endd
31067
31068 .new
31069 To use Rspamd (which by default listens on all local addresses
31070 on TCP port 11333)
31071 you should add &%variant=rspamd%& after the address/port pair, for example:
31072 .code
31073 spamd_address = 127.0.0.1 11333 variant=rspamd
31074 .endd
31075 .wen
31076
31077 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31078 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31079 file name instead of an address/port pair:
31080 .code
31081 spamd_address = /var/run/spamd_socket
31082 .endd
31083 You can have multiple &%spamd%& servers to improve scalability. These can
31084 reside on other hardware reachable over the network. To specify multiple
31085 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31086 option, separated with colons (the separator can be changed in the usual way):
31087 .code
31088 spamd_address = 192.168.2.10 783 : \
31089                 192.168.2.11 783 : \
31090                 192.168.2.12 783
31091 .endd
31092 Up to 32 &%spamd%& servers are supported.
31093 When a server fails to respond to the connection attempt, all other
31094 servers are tried until one succeeds. If no server responds, the &%spam%&
31095 condition defers.
31096
31097 .new
31098 Unix and TCP socket specifications may be mixed in any order.
31099 Each element of the list is a list itself, space-separated by default
31100 and changeable in the usual way.
31101
31102 For TCP socket specifications a host name or IP (v4 or v6, but
31103 subject to list-separator quoting rules) address can be used,
31104 and the port can be one or a dash-separated pair.
31105 In the latter case, the range is tried in strict order.
31106
31107 Elements after the first for Unix sockets, or second for TCP socket,
31108 are options.
31109 The supported option are:
31110 .code
31111 pri=<priority>      Selection priority
31112 weight=<value>      Selection bias
31113 time=<start>-<end>  Use only between these times of day
31114 retry=<timespec>    Retry on connect fail
31115 tmo=<timespec>      Connection time limit
31116 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31117 .endd
31118
31119 The &`pri`& option specifies a priority for the server within the list,
31120 higher values being tried first.
31121 The deafult priority is 1.
31122
31123 The &`weight`& option specifies a selection bias.
31124 Within a priority set
31125 servers are queried in a random fashion, weighted by this value.
31126 The default value for selection bias is 1.
31127
31128 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31129 in the local time zone; each element being one or more digits.
31130 Either the seconds or both minutes and seconds, plus the leading &`.`&
31131 characters, may be omitted and will be taken as zero.
31132
31133 Timeout specifications for the &`retry`& and &`tmo`& options
31134 are the usual Exim time interval standard, eg. &`20s`& or &`1m`&.
31135
31136 The &`tmo`& option specifies an overall timeout for communication.
31137 The default value is two minutes.
31138
31139 The &`retry`& option specifies a time after which a single retry for
31140 a failed connect is made.
31141 The default is to not retry.
31142 .wen
31143
31144 The &%spamd_address%& variable is expanded before use if it starts with
31145 a dollar sign. In this case, the expansion may return a string that is
31146 used as the list so that multiple spamd servers can be the result of an
31147 expansion.
31148
31149 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31150 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31151 .code
31152 deny message = This message was classified as SPAM
31153      spam = joe
31154 .endd
31155 The right-hand side of the &%spam%& condition specifies a name. This is
31156 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31157 to scan using a specific profile, but rather use the SpamAssassin system-wide
31158 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31159 .new
31160 Rspamd does not use this setting. However, you must put something on the
31161 right-hand side.
31162 .wen
31163
31164 The name allows you to use per-domain or per-user antispam profiles in
31165 principle, but this is not straightforward in practice, because a message may
31166 have multiple recipients, not necessarily all in the same domain. Because the
31167 &%spam%& condition has to be called from a DATA ACL in order to be able to
31168 read the contents of the message, the variables &$local_part$& and &$domain$&
31169 are not set.
31170 Careful enforcement of single-recipient messages
31171 (eg. by responding with defer in the recipient ACL for all recipients
31172 after the first),
31173 or the use of PRDR,
31174 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31175 are needed to use this feature.
31176
31177 The right-hand side of the &%spam%& condition is expanded before being used, so
31178 you can put lookups or conditions there. When the right-hand side evaluates to
31179 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31180
31181
31182 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31183 large ones may cause significant performance degradation. As most spam messages
31184 are quite small, it is recommended that you do not scan the big ones. For
31185 example:
31186 .code
31187 deny message = This message was classified as SPAM
31188      condition = ${if < {$message_size}{10K}}
31189      spam = nobody
31190 .endd
31191
31192 The &%spam%& condition returns true if the threshold specified in the user's
31193 SpamAssassin profile has been matched or exceeded. If you want to use the
31194 &%spam%& condition for its side effects (see the variables below), you can make
31195 it always return &"true"& by appending &`:true`& to the username.
31196
31197 .cindex "spam scanning" "returned variables"
31198 When the &%spam%& condition is run, it sets up a number of expansion
31199 variables.
31200 .new
31201 Except for &$spam_report$&,
31202 .wen
31203 these variables are saved with the received message so are
31204 available for use at delivery time.
31205
31206 .vlist
31207 .vitem &$spam_score$&
31208 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
31209 for inclusion in log or reject messages.
31210
31211 .vitem &$spam_score_int$&
31212 The spam score of the message, multiplied by ten, as an integer value. For
31213 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
31214 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
31215 The integer value is useful for numeric comparisons in conditions.
31216
31217 .vitem &$spam_bar$&
31218 A string consisting of a number of &"+"& or &"-"& characters, representing the
31219 integer part of the spam score value. A spam score of 4.4 would have a
31220 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
31221 headers, since MUAs can match on such strings.
31222
31223 .vitem &$spam_report$&
31224 A multiline text table, containing the full SpamAssassin report for the
31225 message. Useful for inclusion in headers or reject messages.
31226 .new
31227 This variable is only usable in a DATA-time ACL.
31228 .wen
31229
31230 .new
31231 .vitem &$spam_action$&
31232 For SpamAssassin either 'reject' or 'no action' depending on the
31233 spam score versus threshold.
31234 For Rspamd, the recommended action.
31235 .wen
31236
31237 .endlist
31238
31239 The &%spam%& condition caches its results unless expansion in
31240 spamd_address was used. If you call it again with the same user name, it
31241 does not scan again, but rather returns the same values as before.
31242
31243 The &%spam%& condition returns DEFER if there is any error while running
31244 the message through SpamAssassin or if the expansion of spamd_address
31245 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
31246 statement block), append &`/defer_ok`& to the right-hand side of the
31247 spam condition, like this:
31248 .code
31249 deny message = This message was classified as SPAM
31250      spam    = joe/defer_ok
31251 .endd
31252 This causes messages to be accepted even if there is a problem with &%spamd%&.
31253
31254 Here is a longer, commented example of the use of the &%spam%&
31255 condition:
31256 .code
31257 # put headers in all messages (no matter if spam or not)
31258 warn  spam = nobody:true
31259       add_header = X-Spam-Score: $spam_score ($spam_bar)
31260       add_header = X-Spam-Report: $spam_report
31261
31262 # add second subject line with *SPAM* marker when message
31263 # is over threshold
31264 warn  spam = nobody
31265       add_header = Subject: *SPAM* $h_Subject:
31266
31267 # reject spam at high scores (> 12)
31268 deny  message = This message scored $spam_score spam points.
31269       spam = nobody:true
31270       condition = ${if >{$spam_score_int}{120}{1}{0}}
31271 .endd
31272
31273
31274
31275 .section "Scanning MIME parts" "SECTscanmimepart"
31276 .cindex "content scanning" "MIME parts"
31277 .cindex "MIME content scanning"
31278 .oindex "&%acl_smtp_mime%&"
31279 .oindex "&%acl_not_smtp_mime%&"
31280 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
31281 each MIME part of an SMTP message, including multipart types, in the sequence
31282 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
31283 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
31284 options may both refer to the same ACL if you want the same processing in both
31285 cases.
31286
31287 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
31288 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
31289 the case of a non-SMTP message. However, a MIME ACL is called only if the
31290 message contains a &'Content-Type:'& header line. When a call to a MIME
31291 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
31292 result code is sent to the client. In the case of an SMTP message, the
31293 &%acl_smtp_data%& ACL is not called when this happens.
31294
31295 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
31296 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
31297 condition to match against the raw MIME part. You can also use the
31298 &%mime_regex%& condition to match against the decoded MIME part (see section
31299 &<<SECTscanregex>>&).
31300
31301 At the start of a MIME ACL, a number of variables are set from the header
31302 information for the relevant MIME part. These are described below. The contents
31303 of the MIME part are not by default decoded into a disk file except for MIME
31304 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
31305 part into a disk file, you can use the &%decode%& condition. The general
31306 syntax is:
31307 .display
31308 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
31309 .endd
31310 The right hand side is expanded before use. After expansion,
31311 the value can be:
31312
31313 .olist
31314 &"0"& or &"false"&, in which case no decoding is done.
31315 .next
31316 The string &"default"&. In that case, the file is put in the temporary
31317 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
31318 a sequential file name consisting of the message id and a sequence number. The
31319 full path and name is available in &$mime_decoded_filename$& after decoding.
31320 .next
31321 A full path name starting with a slash. If the full name is an existing
31322 directory, it is used as a replacement for the default directory. The filename
31323 is then sequentially assigned. If the path does not exist, it is used as
31324 the full path and file name.
31325 .next
31326 If the string does not start with a slash, it is used as the
31327 filename, and the default path is then used.
31328 .endlist
31329 The &%decode%& condition normally succeeds. It is only false for syntax
31330 errors or unusual circumstances such as memory shortages. You can easily decode
31331 a file with its original, proposed filename using
31332 .code
31333 decode = $mime_filename
31334 .endd
31335 However, you should keep in mind that &$mime_filename$& might contain
31336 anything. If you place files outside of the default path, they are not
31337 automatically unlinked.
31338
31339 For RFC822 attachments (these are messages attached to messages, with a
31340 content-type of &"message/rfc822"&), the ACL is called again in the same manner
31341 as for the primary message, only that the &$mime_is_rfc822$& expansion
31342 variable is set (see below). Attached messages are always decoded to disk
31343 before being checked, and the files are unlinked once the check is done.
31344
31345 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
31346 used to match regular expressions against raw and decoded MIME parts,
31347 respectively. They are described in section &<<SECTscanregex>>&.
31348
31349 .cindex "MIME content scanning" "returned variables"
31350 The following list describes all expansion variables that are
31351 available in the MIME ACL:
31352
31353 .vlist
31354 .vitem &$mime_boundary$&
31355 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
31356 have a boundary string, which is stored in this variable. If the current part
31357 has no boundary parameter in the &'Content-Type:'& header, this variable
31358 contains the empty string.
31359
31360 .vitem &$mime_charset$&
31361 This variable contains the character set identifier, if one was found in the
31362 &'Content-Type:'& header. Examples for charset identifiers are:
31363 .code
31364 us-ascii
31365 gb2312 (Chinese)
31366 iso-8859-1
31367 .endd
31368 Please note that this value is not normalized, so you should do matches
31369 case-insensitively.
31370
31371 .vitem &$mime_content_description$&
31372 This variable contains the normalized content of the &'Content-Description:'&
31373 header. It can contain a human-readable description of the parts content. Some
31374 implementations repeat the filename for attachments here, but they are usually
31375 only used for display purposes.
31376
31377 .vitem &$mime_content_disposition$&
31378 This variable contains the normalized content of the &'Content-Disposition:'&
31379 header. You can expect strings like &"attachment"& or &"inline"& here.
31380
31381 .vitem &$mime_content_id$&
31382 This variable contains the normalized content of the &'Content-ID:'& header.
31383 This is a unique ID that can be used to reference a part from another part.
31384
31385 .vitem &$mime_content_size$&
31386 This variable is set only after the &%decode%& modifier (see above) has been
31387 successfully run. It contains the size of the decoded part in kilobytes. The
31388 size is always rounded up to full kilobytes, so only a completely empty part
31389 has a &$mime_content_size$& of zero.
31390
31391 .vitem &$mime_content_transfer_encoding$&
31392 This variable contains the normalized content of the
31393 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
31394 type. Typical values are &"base64"& and &"quoted-printable"&.
31395
31396 .vitem &$mime_content_type$&
31397 If the MIME part has a &'Content-Type:'& header, this variable contains its
31398 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
31399 are some examples of popular MIME types, as they may appear in this variable:
31400 .code
31401 text/plain
31402 text/html
31403 application/octet-stream
31404 image/jpeg
31405 audio/midi
31406 .endd
31407 If the MIME part has no &'Content-Type:'& header, this variable contains the
31408 empty string.
31409
31410 .vitem &$mime_decoded_filename$&
31411 This variable is set only after the &%decode%& modifier (see above) has been
31412 successfully run. It contains the full path and file name of the file
31413 containing the decoded data.
31414 .endlist
31415
31416 .cindex "RFC 2047"
31417 .vlist
31418 .vitem &$mime_filename$&
31419 This is perhaps the most important of the MIME variables. It contains a
31420 proposed filename for an attachment, if one was found in either the
31421 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
31422 RFC2047 or RFC2231 decoded, but no additional sanity checks are done.
31423  If no filename was
31424 found, this variable contains the empty string.
31425
31426 .vitem &$mime_is_coverletter$&
31427 This variable attempts to differentiate the &"cover letter"& of an e-mail from
31428 attached data. It can be used to clamp down on flashy or unnecessarily encoded
31429 content in the cover letter, while not restricting attachments at all.
31430
31431 The variable contains 1 (true) for a MIME part believed to be part of the
31432 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
31433 follows:
31434
31435 .olist
31436 The outermost MIME part of a message is always a cover letter.
31437
31438 .next
31439 If a multipart/alternative or multipart/related MIME part is a cover letter,
31440 so are all MIME subparts within that multipart.
31441
31442 .next
31443 If any other multipart is a cover letter, the first subpart is a cover letter,
31444 and the rest are attachments.
31445
31446 .next
31447 All parts contained within an attachment multipart are attachments.
31448 .endlist olist
31449
31450 As an example, the following will ban &"HTML mail"& (including that sent with
31451 alternative plain text), while allowing HTML files to be attached. HTML
31452 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
31453 .code
31454 deny message = HTML mail is not accepted here
31455 !condition = $mime_is_rfc822
31456 condition = $mime_is_coverletter
31457 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
31458 .endd
31459 .vitem &$mime_is_multipart$&
31460 This variable has the value 1 (true) when the current part has the main type
31461 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
31462 Since multipart entities only serve as containers for other parts, you may not
31463 want to carry out specific actions on them.
31464
31465 .vitem &$mime_is_rfc822$&
31466 This variable has the value 1 (true) if the current part is not a part of the
31467 checked message itself, but part of an attached message. Attached message
31468 decoding is fully recursive.
31469
31470 .vitem &$mime_part_count$&
31471 This variable is a counter that is raised for each processed MIME part. It
31472 starts at zero for the very first part (which is usually a multipart). The
31473 counter is per-message, so it is reset when processing RFC822 attachments (see
31474 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
31475 complete, so you can use it in the DATA ACL to determine the number of MIME
31476 parts of a message. For non-MIME messages, this variable contains the value -1.
31477 .endlist
31478
31479
31480
31481 .section "Scanning with regular expressions" "SECTscanregex"
31482 .cindex "content scanning" "with regular expressions"
31483 .cindex "regular expressions" "content scanning with"
31484 You can specify your own custom regular expression matches on the full body of
31485 the message, or on individual MIME parts.
31486
31487 The &%regex%& condition takes one or more regular expressions as arguments and
31488 matches them against the full message (when called in the DATA ACL) or a raw
31489 MIME part (when called in the MIME ACL). The &%regex%& condition matches
31490 linewise, with a maximum line length of 32K characters. That means you cannot
31491 have multiline matches with the &%regex%& condition.
31492
31493 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
31494 to 32K of decoded content (the whole content at once, not linewise). If the
31495 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
31496 is decoded automatically when &%mime_regex%& is executed (using default path
31497 and filename values). If the decoded data is larger than  32K, only the first
31498 32K characters are checked.
31499
31500 The regular expressions are passed as a colon-separated list. To include a
31501 literal colon, you must double it. Since the whole right-hand side string is
31502 expanded before being used, you must also escape dollar signs and backslashes
31503 with more backslashes, or use the &`\N`& facility to disable expansion.
31504 Here is a simple example that contains two regular expressions:
31505 .code
31506 deny message = contains blacklisted regex ($regex_match_string)
31507      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
31508 .endd
31509 The conditions returns true if any one of the regular expressions matches. The
31510 &$regex_match_string$& expansion variable is then set up and contains the
31511 matching regular expression.
31512
31513 &*Warning*&: With large messages, these conditions can be fairly
31514 CPU-intensive.
31515
31516
31517
31518
31519 .section "The demime condition" "SECTdemimecond"
31520 .cindex "content scanning" "MIME checking"
31521 .cindex "MIME content scanning"
31522 The &%demime%& ACL condition provides MIME unpacking, sanity checking and file
31523 extension blocking. It is usable only in the DATA and non-SMTP ACLs. The
31524 &%demime%& condition uses a simpler interface to MIME decoding than the MIME
31525 ACL functionality, but provides no additional facilities. Please note that this
31526 condition is deprecated and kept only for backward compatibility. You must set
31527 the WITH_OLD_DEMIME option in &_Local/Makefile_& at build time to be able to
31528 use the &%demime%& condition.
31529
31530 The &%demime%& condition unpacks MIME containers in the message. It detects
31531 errors in MIME containers and can match file extensions found in the message
31532 against a list. Using this facility produces files containing the unpacked MIME
31533 parts of the message in the temporary scan directory. If you do antivirus
31534 scanning, it is recommended that you use the &%demime%& condition before the
31535 antivirus (&%malware%&) condition.
31536
31537 On the right-hand side of the &%demime%& condition you can pass a
31538 colon-separated list of file extensions that it should match against. For
31539 example:
31540 .code
31541 deny message = Found blacklisted file attachment
31542      demime  = vbs:com:bat:pif:prf:lnk
31543 .endd
31544 If one of the file extensions is found, the condition is true, otherwise it is
31545 false. If there is a temporary error while demimeing (for example, &"disk
31546 full"&), the condition defers, and the message is temporarily rejected (unless
31547 the condition is on a &%warn%& verb).
31548
31549 The right-hand side is expanded before being treated as a list, so you can have
31550 conditions and lookups there. If it expands to an empty string, &"false"&, or
31551 zero (&"0"&), no demimeing is done and the condition is false.
31552
31553 The &%demime%& condition set the following variables:
31554
31555 .vlist
31556 .vitem &$demime_errorlevel$&
31557 .vindex "&$demime_errorlevel$&"
31558 When an error is detected in a MIME container, this variable contains the
31559 severity of the error, as an integer number. The higher the value, the more
31560 severe the error (the current maximum value is 3). If this variable is unset or
31561 zero, no error occurred.
31562
31563 .vitem &$demime_reason$&
31564 .vindex "&$demime_reason$&"
31565 When &$demime_errorlevel$& is greater than zero, this variable contains a
31566 human-readable text string describing the MIME error that occurred.
31567 .endlist
31568
31569 .vlist
31570 .vitem &$found_extension$&
31571 .vindex "&$found_extension$&"
31572 When the &%demime%& condition is true, this variable contains the file
31573 extension it found.
31574 .endlist
31575
31576 Both &$demime_errorlevel$& and &$demime_reason$& are set by the first call of
31577 the &%demime%& condition, and are not changed on subsequent calls.
31578
31579 If you do not want to check for file extensions, but rather use the &%demime%&
31580 condition for unpacking or error checking purposes, pass &"*"& as the
31581 right-hand side value. Here is a more elaborate example of how to use this
31582 facility:
31583 .code
31584 # Reject messages with serious MIME container errors
31585 deny  message = Found MIME error ($demime_reason).
31586       demime = *
31587       condition = ${if >{$demime_errorlevel}{2}{1}{0}}
31588
31589 # Reject known virus spreading file extensions.
31590 # Accepting these is pretty much braindead.
31591 deny  message = contains $found_extension file (blacklisted).
31592       demime  = com:vbs:bat:pif:scr
31593
31594 # Freeze .exe and .doc files. Postmaster can
31595 # examine them and eventually thaw them.
31596 deny  log_message = Another $found_extension file.
31597       demime = exe:doc
31598       control = freeze
31599 .endd
31600 .ecindex IIDcosca
31601
31602
31603
31604
31605 . ////////////////////////////////////////////////////////////////////////////
31606 . ////////////////////////////////////////////////////////////////////////////
31607
31608 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
31609          "Local scan function"
31610 .scindex IIDlosca "&[local_scan()]& function" "description of"
31611 .cindex "customizing" "input scan using C function"
31612 .cindex "policy control" "by local scan function"
31613 In these days of email worms, viruses, and ever-increasing spam, some sites
31614 want to apply a lot of checking to messages before accepting them.
31615
31616 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
31617 passing messages to external virus and spam scanning software. You can also do
31618 a certain amount in Exim itself through string expansions and the &%condition%&
31619 condition in the ACL that runs after the SMTP DATA command or the ACL for
31620 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
31621
31622 To allow for further customization to a site's own requirements, there is the
31623 possibility of linking Exim with a private message scanning function, written
31624 in C. If you want to run code that is written in something other than C, you
31625 can of course use a little C stub to call it.
31626
31627 The local scan function is run once for every incoming message, at the point
31628 when Exim is just about to accept the message.
31629 It can therefore be used to control non-SMTP messages from local processes as
31630 well as messages arriving via SMTP.
31631
31632 Exim applies a timeout to calls of the local scan function, and there is an
31633 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
31634 Zero means &"no timeout"&.
31635 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
31636 before calling the local scan function, so that the most common types of crash
31637 are caught. If the timeout is exceeded or one of those signals is caught, the
31638 incoming message is rejected with a temporary error if it is an SMTP message.
31639 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
31640 code. The incident is logged on the main and reject logs.
31641
31642
31643
31644 .section "Building Exim to use a local scan function" "SECID207"
31645 .cindex "&[local_scan()]& function" "building Exim to use"
31646 To make use of the local scan function feature, you must tell Exim where your
31647 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
31648 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
31649 directory, so you might set
31650 .code
31651 LOCAL_SCAN_SOURCE=Local/local_scan.c
31652 .endd
31653 for example. The function must be called &[local_scan()]&. It is called by
31654 Exim after it has received a message, when the success return code is about to
31655 be sent. This is after all the ACLs have been run. The return code from your
31656 function controls whether the message is actually accepted or not. There is a
31657 commented template function (that just accepts the message) in the file
31658 _src/local_scan.c_.
31659
31660 If you want to make use of Exim's run time configuration file to set options
31661 for your &[local_scan()]& function, you must also set
31662 .code
31663 LOCAL_SCAN_HAS_OPTIONS=yes
31664 .endd
31665 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
31666
31667
31668
31669
31670 .section "API for local_scan()" "SECTapiforloc"
31671 .cindex "&[local_scan()]& function" "API description"
31672 You must include this line near the start of your code:
31673 .code
31674 #include "local_scan.h"
31675 .endd
31676 This header file defines a number of variables and other values, and the
31677 prototype for the function itself. Exim is coded to use unsigned char values
31678 almost exclusively, and one of the things this header defines is a shorthand
31679 for &`unsigned char`& called &`uschar`&.
31680 It also contains the following macro definitions, to simplify casting character
31681 strings and pointers to character strings:
31682 .code
31683 #define CS   (char *)
31684 #define CCS  (const char *)
31685 #define CSS  (char **)
31686 #define US   (unsigned char *)
31687 #define CUS  (const unsigned char *)
31688 #define USS  (unsigned char **)
31689 .endd
31690 The function prototype for &[local_scan()]& is:
31691 .code
31692 extern int local_scan(int fd, uschar **return_text);
31693 .endd
31694 The arguments are as follows:
31695
31696 .ilist
31697 &%fd%& is a file descriptor for the file that contains the body of the message
31698 (the -D file). The file is open for reading and writing, but updating it is not
31699 recommended. &*Warning*&: You must &'not'& close this file descriptor.
31700
31701 The descriptor is positioned at character 19 of the file, which is the first
31702 character of the body itself, because the first 19 characters are the message
31703 id followed by &`-D`& and a newline. If you rewind the file, you should use the
31704 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
31705 case this changes in some future version.
31706 .next
31707 &%return_text%& is an address which you can use to return a pointer to a text
31708 string at the end of the function. The value it points to on entry is NULL.
31709 .endlist
31710
31711 The function must return an &%int%& value which is one of the following macros:
31712
31713 .vlist
31714 .vitem &`LOCAL_SCAN_ACCEPT`&
31715 .vindex "&$local_scan_data$&"
31716 The message is accepted. If you pass back a string of text, it is saved with
31717 the message, and made available in the variable &$local_scan_data$&. No
31718 newlines are permitted (if there are any, they are turned into spaces) and the
31719 maximum length of text is 1000 characters.
31720
31721 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
31722 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31723 queued without immediate delivery, and is frozen.
31724
31725 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
31726 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
31727 queued without immediate delivery.
31728
31729 .vitem &`LOCAL_SCAN_REJECT`&
31730 The message is rejected; the returned text is used as an error message which is
31731 passed back to the sender and which is also logged. Newlines are permitted &--
31732 they cause a multiline response for SMTP rejections, but are converted to
31733 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
31734 used.
31735
31736 .vitem &`LOCAL_SCAN_TEMPREJECT`&
31737 The message is temporarily rejected; the returned text is used as an error
31738 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
31739 problem"& is used.
31740
31741 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
31742 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
31743 message is not written to the reject log. It has the effect of unsetting the
31744 &%rejected_header%& log selector for just this rejection. If
31745 &%rejected_header%& is already unset (see the discussion of the
31746 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
31747 same as LOCAL_SCAN_REJECT.
31748
31749 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
31750 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
31751 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
31752 .endlist
31753
31754 If the message is not being received by interactive SMTP, rejections are
31755 reported by writing to &%stderr%& or by sending an email, as configured by the
31756 &%-oe%& command line options.
31757
31758
31759
31760 .section "Configuration options for local_scan()" "SECTconoptloc"
31761 .cindex "&[local_scan()]& function" "configuration options"
31762 It is possible to have option settings in the main configuration file
31763 that set values in static variables in the &[local_scan()]& module. If you
31764 want to do this, you must have the line
31765 .code
31766 LOCAL_SCAN_HAS_OPTIONS=yes
31767 .endd
31768 in your &_Local/Makefile_& when you build Exim. (This line is in
31769 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
31770 file, you must define static variables to hold the option values, and a table
31771 to define them.
31772
31773 The table must be a vector called &%local_scan_options%&, of type
31774 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
31775 and a pointer to the variable that holds the value. The entries must appear in
31776 alphabetical order. Following &%local_scan_options%& you must also define a
31777 variable called &%local_scan_options_count%& that contains the number of
31778 entries in the table. Here is a short example, showing two kinds of option:
31779 .code
31780 static int my_integer_option = 42;
31781 static uschar *my_string_option = US"a default string";
31782
31783 optionlist local_scan_options[] = {
31784   { "my_integer", opt_int,       &my_integer_option },
31785   { "my_string",  opt_stringptr, &my_string_option }
31786 };
31787
31788 int local_scan_options_count =
31789   sizeof(local_scan_options)/sizeof(optionlist);
31790 .endd
31791 The values of the variables can now be changed from Exim's runtime
31792 configuration file by including a local scan section as in this example:
31793 .code
31794 begin local_scan
31795 my_integer = 99
31796 my_string = some string of text...
31797 .endd
31798 The available types of option data are as follows:
31799
31800 .vlist
31801 .vitem &*opt_bool*&
31802 This specifies a boolean (true/false) option. The address should point to a
31803 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
31804 that are defined as &"1"& and &"0"&, respectively. If you want to detect
31805 whether such a variable has been set at all, you can initialize it to
31806 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
31807 values.)
31808
31809 .vitem &*opt_fixed*&
31810 This specifies a fixed point number, such as is used for load averages.
31811 The address should point to a variable of type &`int`&. The value is stored
31812 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
31813
31814 .vitem &*opt_int*&
31815 This specifies an integer; the address should point to a variable of type
31816 &`int`&. The value may be specified in any of the integer formats accepted by
31817 Exim.
31818
31819 .vitem &*opt_mkint*&
31820 This is the same as &%opt_int%&, except that when such a value is output in a
31821 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
31822 printed with the suffix K or M.
31823
31824 .vitem &*opt_octint*&
31825 This also specifies an integer, but the value is always interpreted as an
31826 octal integer, whether or not it starts with the digit zero, and it is
31827 always output in octal.
31828
31829 .vitem &*opt_stringptr*&
31830 This specifies a string value; the address must be a pointer to a
31831 variable that points to a string (for example, of type &`uschar *`&).
31832
31833 .vitem &*opt_time*&
31834 This specifies a time interval value. The address must point to a variable of
31835 type &`int`&. The value that is placed there is a number of seconds.
31836 .endlist
31837
31838 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
31839 out the values of all the &[local_scan()]& options.
31840
31841
31842
31843 .section "Available Exim variables" "SECID208"
31844 .cindex "&[local_scan()]& function" "available Exim variables"
31845 The header &_local_scan.h_& gives you access to a number of C variables. These
31846 are the only ones that are guaranteed to be maintained from release to release.
31847 Note, however, that you can obtain the value of any Exim expansion variable,
31848 including &$recipients$&, by calling &'expand_string()'&. The exported
31849 C variables are as follows:
31850
31851 .vlist
31852 .vitem &*int&~body_linecount*&
31853 This variable contains the number of lines in the message's body.
31854
31855 .vitem &*int&~body_zerocount*&
31856 This variable contains the number of binary zero bytes in the message's body.
31857
31858 .vitem &*unsigned&~int&~debug_selector*&
31859 This variable is set to zero when no debugging is taking place. Otherwise, it
31860 is a bitmap of debugging selectors. Two bits are identified for use in
31861 &[local_scan()]&; they are defined as macros:
31862
31863 .ilist
31864 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
31865 testing option that is not privileged &-- any caller may set it. All the
31866 other selector bits can be set only by admin users.
31867
31868 .next
31869 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
31870 by the &`+local_scan`& debug selector. It is not included in the default set
31871 of debugging bits.
31872 .endlist ilist
31873
31874 Thus, to write to the debugging output only when &`+local_scan`& has been
31875 selected, you should use code like this:
31876 .code
31877 if ((debug_selector & D_local_scan) != 0)
31878   debug_printf("xxx", ...);
31879 .endd
31880 .vitem &*uschar&~*expand_string_message*&
31881 After a failing call to &'expand_string()'& (returned value NULL), the
31882 variable &%expand_string_message%& contains the error message, zero-terminated.
31883
31884 .vitem &*header_line&~*header_list*&
31885 A pointer to a chain of header lines. The &%header_line%& structure is
31886 discussed below.
31887
31888 .vitem &*header_line&~*header_last*&
31889 A pointer to the last of the header lines.
31890
31891 .vitem &*uschar&~*headers_charset*&
31892 The value of the &%headers_charset%& configuration option.
31893
31894 .vitem &*BOOL&~host_checking*&
31895 This variable is TRUE during a host checking session that is initiated by the
31896 &%-bh%& command line option.
31897
31898 .vitem &*uschar&~*interface_address*&
31899 The IP address of the interface that received the message, as a string. This
31900 is NULL for locally submitted messages.
31901
31902 .vitem &*int&~interface_port*&
31903 The port on which this message was received. When testing with the &%-bh%&
31904 command line option, the value of this variable is -1 unless a port has been
31905 specified via the &%-oMi%& option.
31906
31907 .vitem &*uschar&~*message_id*&
31908 This variable contains Exim's message id for the incoming message (the value of
31909 &$message_exim_id$&) as a zero-terminated string.
31910
31911 .vitem &*uschar&~*received_protocol*&
31912 The name of the protocol by which the message was received.
31913
31914 .vitem &*int&~recipients_count*&
31915 The number of accepted recipients.
31916
31917 .vitem &*recipient_item&~*recipients_list*&
31918 .cindex "recipient" "adding in local scan"
31919 .cindex "recipient" "removing in local scan"
31920 The list of accepted recipients, held in a vector of length
31921 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
31922 can add additional recipients by calling &'receive_add_recipient()'& (see
31923 below). You can delete recipients by removing them from the vector and
31924 adjusting the value in &%recipients_count%&. In particular, by setting
31925 &%recipients_count%& to zero you remove all recipients. If you then return the
31926 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
31927 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
31928 and then call &'receive_add_recipient()'& as often as needed.
31929
31930 .vitem &*uschar&~*sender_address*&
31931 The envelope sender address. For bounce messages this is the empty string.
31932
31933 .vitem &*uschar&~*sender_host_address*&
31934 The IP address of the sending host, as a string. This is NULL for
31935 locally-submitted messages.
31936
31937 .vitem &*uschar&~*sender_host_authenticated*&
31938 The name of the authentication mechanism that was used, or NULL if the message
31939 was not received over an authenticated SMTP connection.
31940
31941 .vitem &*uschar&~*sender_host_name*&
31942 The name of the sending host, if known.
31943
31944 .vitem &*int&~sender_host_port*&
31945 The port on the sending host.
31946
31947 .vitem &*BOOL&~smtp_input*&
31948 This variable is TRUE for all SMTP input, including BSMTP.
31949
31950 .vitem &*BOOL&~smtp_batched_input*&
31951 This variable is TRUE for BSMTP input.
31952
31953 .vitem &*int&~store_pool*&
31954 The contents of this variable control which pool of memory is used for new
31955 requests. See section &<<SECTmemhanloc>>& for details.
31956 .endlist
31957
31958
31959 .section "Structure of header lines" "SECID209"
31960 The &%header_line%& structure contains the members listed below.
31961 You can add additional header lines by calling the &'header_add()'& function
31962 (see below). You can cause header lines to be ignored (deleted) by setting
31963 their type to *.
31964
31965
31966 .vlist
31967 .vitem &*struct&~header_line&~*next*&
31968 A pointer to the next header line, or NULL for the last line.
31969
31970 .vitem &*int&~type*&
31971 A code identifying certain headers that Exim recognizes. The codes are printing
31972 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
31973 Notice in particular that any header line whose type is * is not transmitted
31974 with the message. This flagging is used for header lines that have been
31975 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
31976 lines.) Effectively, * means &"deleted"&.
31977
31978 .vitem &*int&~slen*&
31979 The number of characters in the header line, including the terminating and any
31980 internal newlines.
31981
31982 .vitem &*uschar&~*text*&
31983 A pointer to the text of the header. It always ends with a newline, followed by
31984 a zero byte. Internal newlines are preserved.
31985 .endlist
31986
31987
31988
31989 .section "Structure of recipient items" "SECID210"
31990 The &%recipient_item%& structure contains these members:
31991
31992 .vlist
31993 .vitem &*uschar&~*address*&
31994 This is a pointer to the recipient address as it was received.
31995
31996 .vitem &*int&~pno*&
31997 This is used in later Exim processing when top level addresses are created by
31998 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
31999 and must always contain -1 at this stage.
32000
32001 .vitem &*uschar&~*errors_to*&
32002 If this value is not NULL, bounce messages caused by failing to deliver to the
32003 recipient are sent to the address it contains. In other words, it overrides the
32004 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32005 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32006 an unqualified address, Exim qualifies it using the domain from
32007 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32008 is NULL for all recipients.
32009 .endlist
32010
32011
32012
32013 .section "Available Exim functions" "SECID211"
32014 .cindex "&[local_scan()]& function" "available Exim functions"
32015 The header &_local_scan.h_& gives you access to a number of Exim functions.
32016 These are the only ones that are guaranteed to be maintained from release to
32017 release:
32018
32019 .vlist
32020 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32021        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32022
32023 This function creates a child process that runs the command specified by
32024 &%argv%&. The environment for the process is specified by &%envp%&, which can
32025 be NULL if no environment variables are to be passed. A new umask is supplied
32026 for the process in &%newumask%&.
32027
32028 Pipes to the standard input and output of the new process are set up
32029 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32030 standard error is cloned to the standard output. If there are any file
32031 descriptors &"in the way"& in the new process, they are closed. If the final
32032 argument is TRUE, the new process is made into a process group leader.
32033
32034 The function returns the pid of the new process, or -1 if things go wrong.
32035
32036 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32037 This function waits for a child process to terminate, or for a timeout (in
32038 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32039 return value is as follows:
32040
32041 .ilist
32042 >= 0
32043
32044 The process terminated by a normal exit and the value is the process
32045 ending status.
32046
32047 .next
32048 < 0 and > &--256
32049
32050 The process was terminated by a signal and the value is the negation of the
32051 signal number.
32052
32053 .next
32054 &--256
32055
32056 The process timed out.
32057 .next
32058 &--257
32059
32060 The was some other error in wait(); &%errno%& is still set.
32061 .endlist
32062
32063 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32064 This function provide you with a means of submitting a new message to
32065 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32066 want, but this packages it all up for you.) The function creates a pipe,
32067 forks a subprocess that is running
32068 .code
32069 exim -t -oem -oi -f <>
32070 .endd
32071 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32072 that is connected to the standard input. The yield of the function is the PID
32073 of the subprocess. You can then write a message to the file descriptor, with
32074 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32075
32076 When you have finished, call &'child_close()'& to wait for the process to
32077 finish and to collect its ending status. A timeout value of zero is usually
32078 fine in this circumstance. Unless you have made a mistake with the recipient
32079 addresses, you should get a return code of zero.
32080
32081
32082 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32083        *sender_authentication)*&
32084 This function is a more sophisticated version of &'child_open()'&. The command
32085 that it runs is:
32086 .display
32087 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32088 .endd
32089 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32090
32091
32092 .vitem &*void&~debug_printf(char&~*,&~...)*&
32093 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32094 output is written to the standard error stream. If no debugging is selected,
32095 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32096 conditional on the &`local_scan`& debug selector by coding like this:
32097 .code
32098 if ((debug_selector & D_local_scan) != 0)
32099   debug_printf("xxx", ...);
32100 .endd
32101
32102 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32103 This is an interface to Exim's string expansion code. The return value is the
32104 expanded string, or NULL if there was an expansion failure.
32105 The C variable &%expand_string_message%& contains an error message after an
32106 expansion failure. If expansion does not change the string, the return value is
32107 the pointer to the input string. Otherwise, the return value points to a new
32108 block of memory that was obtained by a call to &'store_get()'&. See section
32109 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32110
32111 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32112 This function allows you to an add additional header line at the end of the
32113 existing ones. The first argument is the type, and should normally be a space
32114 character. The second argument is a format string and any number of
32115 substitution arguments as for &[sprintf()]&. You may include internal newlines
32116 if you want, and you must ensure that the string ends with a newline.
32117
32118 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32119         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32120 This function adds a new header line at a specified point in the header
32121 chain. The header itself is specified as for &'header_add()'&.
32122
32123 If &%name%& is NULL, the new header is added at the end of the chain if
32124 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32125 NULL, the header lines are searched for the first non-deleted header that
32126 matches the name. If one is found, the new header is added before it if
32127 &%after%& is false. If &%after%& is true, the new header is added after the
32128 found header and any adjacent subsequent ones with the same name (even if
32129 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32130 option controls where the header is added. If it is true, addition is at the
32131 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32132 headers, or at the top if there are no &'Received:'& headers, you could use
32133 .code
32134 header_add_at_position(TRUE, US"Received", TRUE,
32135   ' ', "X-xxx: ...");
32136 .endd
32137 Normally, there is always at least one non-deleted &'Received:'& header, but
32138 there may not be if &%received_header_text%& expands to an empty string.
32139
32140
32141 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32142 This function removes header lines. If &%occurrence%& is zero or negative, all
32143 occurrences of the header are removed. If occurrence is greater than zero, that
32144 particular instance of the header is removed. If no header(s) can be found that
32145 match the specification, the function does nothing.
32146
32147
32148 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32149         int&~length,&~BOOL&~notdel)*&"
32150 This function tests whether the given header has the given name. It is not just
32151 a string comparison, because white space is permitted between the name and the
32152 colon. If the &%notdel%& argument is true, a false return is forced for all
32153 &"deleted"& headers; otherwise they are not treated specially. For example:
32154 .code
32155 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32156 .endd
32157 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32158 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32159 This function base64-encodes a string, which is passed by address and length.
32160 The text may contain bytes of any value, including zero. The result is passed
32161 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32162 zero-terminated.
32163
32164 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32165 This function decodes a base64-encoded string. Its arguments are a
32166 zero-terminated base64-encoded string and the address of a variable that is set
32167 to point to the result, which is in dynamic memory. The length of the decoded
32168 string is the yield of the function. If the input is invalid base64 data, the
32169 yield is -1. A zero byte is added to the end of the output string to make it
32170 easy to interpret as a C string (assuming it contains no zeros of its own). The
32171 added zero byte is not included in the returned count.
32172
32173 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32174 This function checks for a match in a domain list. Domains are always
32175 matched caselessly. The return value is one of the following:
32176 .display
32177 &`OK     `& match succeeded
32178 &`FAIL   `& match failed
32179 &`DEFER  `& match deferred
32180 .endd
32181 DEFER is usually caused by some kind of lookup defer, such as the
32182 inability to contact a database.
32183
32184 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32185         BOOL&~caseless)*&"
32186 This function checks for a match in a local part list. The third argument
32187 controls case-sensitivity. The return values are as for
32188 &'lss_match_domain()'&.
32189
32190 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32191         BOOL&~caseless)*&"
32192 This function checks for a match in an address list. The third argument
32193 controls the case-sensitivity of the local part match. The domain is always
32194 matched caselessly. The return values are as for &'lss_match_domain()'&.
32195
32196 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32197         uschar&~*list)*&"
32198 This function checks for a match in a host list. The most common usage is
32199 expected to be
32200 .code
32201 lss_match_host(sender_host_name, sender_host_address, ...)
32202 .endd
32203 .vindex "&$sender_host_address$&"
32204 An empty address field matches an empty item in the host list. If the host name
32205 is NULL, the name corresponding to &$sender_host_address$& is automatically
32206 looked up if a host name is required to match an item in the list. The return
32207 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32208 returns ERROR in the case when it had to look up a host name, but the lookup
32209 failed.
32210
32211 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32212         *format,&~...)*&"
32213 This function writes to Exim's log files. The first argument should be zero (it
32214 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32215 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32216 them. It specifies to which log or logs the message is written. The remaining
32217 arguments are a format and relevant insertion arguments. The string should not
32218 contain any newlines, not even at the end.
32219
32220
32221 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32222 This function adds an additional recipient to the message. The first argument
32223 is the recipient address. If it is unqualified (has no domain), it is qualified
32224 with the &%qualify_recipient%& domain. The second argument must always be -1.
32225
32226 This function does not allow you to specify a private &%errors_to%& address (as
32227 described with the structure of &%recipient_item%& above), because it pre-dates
32228 the addition of that field to the structure. However, it is easy to add such a
32229 value afterwards. For example:
32230 .code
32231  receive_add_recipient(US"monitor@mydom.example", -1);
32232  recipients_list[recipients_count-1].errors_to =
32233    US"postmaster@mydom.example";
32234 .endd
32235
32236 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32237 This is a convenience function to remove a named recipient from the list of
32238 recipients. It returns true if a recipient was removed, and false if no
32239 matching recipient could be found. The argument must be a complete email
32240 address.
32241 .endlist
32242
32243
32244 .cindex "RFC 2047"
32245 .vlist
32246 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32247   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32248 This function decodes strings that are encoded according to RFC 2047. Typically
32249 these are the contents of header lines. First, each &"encoded word"& is decoded
32250 from the Q or B encoding into a byte-string. Then, if provided with the name of
32251 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32252 made  to translate the result to the named character set. If this fails, the
32253 binary string is returned with an error message.
32254
32255 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32256 maximum MIME word length is enforced. The third argument is the target
32257 encoding, or NULL if no translation is wanted.
32258
32259 .cindex "binary zero" "in RFC 2047 decoding"
32260 .cindex "RFC 2047" "binary zero in"
32261 If a binary zero is encountered in the decoded string, it is replaced by the
32262 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32263 not be 0 because header lines are handled as zero-terminated strings.
32264
32265 The function returns the result of processing the string, zero-terminated; if
32266 &%lenptr%& is not NULL, the length of the result is set in the variable to
32267 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32268
32269 If an error is encountered, the function returns NULL and uses the &%error%&
32270 argument to return an error message. The variable pointed to by &%error%& is
32271 set to NULL if there is no error; it may be set non-NULL even when the function
32272 returns a non-NULL value if decoding was successful, but there was a problem
32273 with translation.
32274
32275
32276 .vitem &*int&~smtp_fflush(void)*&
32277 This function is used in conjunction with &'smtp_printf()'&, as described
32278 below.
32279
32280 .vitem &*void&~smtp_printf(char&~*,&~...)*&
32281 The arguments of this function are like &[printf()]&; it writes to the SMTP
32282 output stream. You should use this function only when there is an SMTP output
32283 stream, that is, when the incoming message is being received via interactive
32284 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
32285 is FALSE. If you want to test for an incoming message from another host (as
32286 opposed to a local process that used the &%-bs%& command line option), you can
32287 test the value of &%sender_host_address%&, which is non-NULL when a remote host
32288 is involved.
32289
32290 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
32291 output function, so it can be used for all forms of SMTP connection.
32292
32293 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
32294 must start with an appropriate response code: 550 if you are going to return
32295 LOCAL_SCAN_REJECT, 451 if you are going to return
32296 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
32297 initial lines of a multi-line response, the code must be followed by a hyphen
32298 to indicate that the line is not the final response line. You must also ensure
32299 that the lines you write terminate with CRLF. For example:
32300 .code
32301 smtp_printf("550-this is some extra info\r\n");
32302 return LOCAL_SCAN_REJECT;
32303 .endd
32304 Note that you can also create multi-line responses by including newlines in
32305 the data returned via the &%return_text%& argument. The added value of using
32306 &'smtp_printf()'& is that, for instance, you could introduce delays between
32307 multiple output lines.
32308
32309 The &'smtp_printf()'& function does not return any error indication, because it
32310 does not automatically flush pending output, and therefore does not test
32311 the state of the stream. (In the main code of Exim, flushing and error
32312 detection is done when Exim is ready for the next SMTP input command.) If
32313 you want to flush the output and check for an error (for example, the
32314 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
32315 arguments. It flushes the output stream, and returns a non-zero value if there
32316 is an error.
32317
32318 .vitem &*void&~*store_get(int)*&
32319 This function accesses Exim's internal store (memory) manager. It gets a new
32320 chunk of memory whose size is given by the argument. Exim bombs out if it ever
32321 runs out of memory. See the next section for a discussion of memory handling.
32322
32323 .vitem &*void&~*store_get_perm(int)*&
32324 This function is like &'store_get()'&, but it always gets memory from the
32325 permanent pool. See the next section for a discussion of memory handling.
32326
32327 .vitem &*uschar&~*string_copy(uschar&~*string)*&
32328 See below.
32329
32330 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
32331 See below.
32332
32333 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
32334 These three functions create strings using Exim's dynamic memory facilities.
32335 The first makes a copy of an entire string. The second copies up to a maximum
32336 number of characters, indicated by the second argument. The third uses a format
32337 and insertion arguments to create a new string. In each case, the result is a
32338 pointer to a new string in the current memory pool. See the next section for
32339 more discussion.
32340 .endlist
32341
32342
32343
32344 .section "More about Exim's memory handling" "SECTmemhanloc"
32345 .cindex "&[local_scan()]& function" "memory handling"
32346 No function is provided for freeing memory, because that is never needed.
32347 The dynamic memory that Exim uses when receiving a message is automatically
32348 recycled if another message is received by the same process (this applies only
32349 to incoming SMTP connections &-- other input methods can supply only one
32350 message at a time). After receiving the last message, a reception process
32351 terminates.
32352
32353 Because it is recycled, the normal dynamic memory cannot be used for holding
32354 data that must be preserved over a number of incoming messages on the same SMTP
32355 connection. However, Exim in fact uses two pools of dynamic memory; the second
32356 one is not recycled, and can be used for this purpose.
32357
32358 If you want to allocate memory that remains available for subsequent messages
32359 in the same SMTP connection, you should set
32360 .code
32361 store_pool = POOL_PERM
32362 .endd
32363 before calling the function that does the allocation. There is no need to
32364 restore the value if you do not need to; however, if you do want to revert to
32365 the normal pool, you can either restore the previous value of &%store_pool%& or
32366 set it explicitly to POOL_MAIN.
32367
32368 The pool setting applies to all functions that get dynamic memory, including
32369 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
32370 There is also a convenience function called &'store_get_perm()'& that gets a
32371 block of memory from the permanent pool while preserving the value of
32372 &%store_pool%&.
32373 .ecindex IIDlosca
32374
32375
32376
32377
32378 . ////////////////////////////////////////////////////////////////////////////
32379 . ////////////////////////////////////////////////////////////////////////////
32380
32381 .chapter "System-wide message filtering" "CHAPsystemfilter"
32382 .scindex IIDsysfil1 "filter" "system filter"
32383 .scindex IIDsysfil2 "filtering all mail"
32384 .scindex IIDsysfil3 "system filter"
32385 The previous chapters (on ACLs and the local scan function) describe checks
32386 that can be applied to messages before they are accepted by a host. There is
32387 also a mechanism for checking messages once they have been received, but before
32388 they are delivered. This is called the &'system filter'&.
32389
32390 The system filter operates in a similar manner to users' filter files, but it
32391 is run just once per message (however many recipients the message has).
32392 It should not normally be used as a substitute for routing, because &%deliver%&
32393 commands in a system router provide new envelope recipient addresses.
32394 The system filter must be an Exim filter. It cannot be a Sieve filter.
32395
32396 The system filter is run at the start of a delivery attempt, before any routing
32397 is done. If a message fails to be completely delivered at the first attempt,
32398 the system filter is run again at the start of every retry.
32399 If you want your filter to do something only once per message, you can make use
32400 of the &%first_delivery%& condition in an &%if%& command in the filter to
32401 prevent it happening on retries.
32402
32403 .vindex "&$domain$&"
32404 .vindex "&$local_part$&"
32405 &*Warning*&: Because the system filter runs just once, variables that are
32406 specific to individual recipient addresses, such as &$local_part$& and
32407 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
32408 you want to run a centrally-specified filter for each recipient address
32409 independently, you can do so by setting up a suitable &(redirect)& router, as
32410 described in section &<<SECTperaddfil>>& below.
32411
32412
32413 .section "Specifying a system filter" "SECID212"
32414 .cindex "uid (user id)" "system filter"
32415 .cindex "gid (group id)" "system filter"
32416 The name of the file that contains the system filter must be specified by
32417 setting &%system_filter%&. If you want the filter to run under a uid and gid
32418 other than root, you must also set &%system_filter_user%& and
32419 &%system_filter_group%& as appropriate. For example:
32420 .code
32421 system_filter = /etc/mail/exim.filter
32422 system_filter_user = exim
32423 .endd
32424 If a system filter generates any deliveries directly to files or pipes (via the
32425 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
32426 specified by setting &%system_filter_file_transport%& and
32427 &%system_filter_pipe_transport%&, respectively. Similarly,
32428 &%system_filter_reply_transport%& must be set to handle any messages generated
32429 by the &%reply%& command.
32430
32431
32432 .section "Testing a system filter" "SECID213"
32433 You can run simple tests of a system filter in the same way as for a user
32434 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
32435 are permitted only in system filters are recognized.
32436
32437 If you want to test the combined effect of a system filter and a user filter,
32438 you can use both &%-bF%& and &%-bf%& on the same command line.
32439
32440
32441
32442 .section "Contents of a system filter" "SECID214"
32443 The language used to specify system filters is the same as for users' filter
32444 files. It is described in the separate end-user document &'Exim's interface to
32445 mail filtering'&. However, there are some additional features that are
32446 available only in system filters; these are described in subsequent sections.
32447 If they are encountered in a user's filter file or when testing with &%-bf%&,
32448 they cause errors.
32449
32450 .cindex "frozen messages" "manual thaw; testing in filter"
32451 There are two special conditions which, though available in users' filter
32452 files, are designed for use in system filters. The condition &%first_delivery%&
32453 is true only for the first attempt at delivering a message, and
32454 &%manually_thawed%& is true only if the message has been frozen, and
32455 subsequently thawed by an admin user. An explicit forced delivery counts as a
32456 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
32457
32458 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
32459 specify an &"unseen"& (non-significant) delivery, and that delivery does not
32460 succeed, it will not be tried again.
32461 If you want Exim to retry an unseen delivery until it succeeds, you should
32462 arrange to set it up every time the filter runs.
32463
32464 When a system filter finishes running, the values of the variables &$n0$& &--
32465 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
32466 users' filter files. Thus a system filter can, for example, set up &"scores"&
32467 to which users' filter files can refer.
32468
32469
32470
32471 .section "Additional variable for system filters" "SECID215"
32472 .vindex "&$recipients$&"
32473 The expansion variable &$recipients$&, containing a list of all the recipients
32474 of the message (separated by commas and white space), is available in system
32475 filters. It is not available in users' filters for privacy reasons.
32476
32477
32478
32479 .section "Defer, freeze, and fail commands for system filters" "SECID216"
32480 .cindex "freezing messages"
32481 .cindex "message" "freezing"
32482 .cindex "message" "forced failure"
32483 .cindex "&%fail%&" "in system filter"
32484 .cindex "&%freeze%& in system filter"
32485 .cindex "&%defer%& in system filter"
32486 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
32487 always available in system filters, but are not normally enabled in users'
32488 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
32489 for the &(redirect)& router.) These commands can optionally be followed by the
32490 word &%text%& and a string containing an error message, for example:
32491 .code
32492 fail text "this message looks like spam to me"
32493 .endd
32494 The keyword &%text%& is optional if the next character is a double quote.
32495
32496 The &%defer%& command defers delivery of the original recipients of the
32497 message. The &%fail%& command causes all the original recipients to be failed,
32498 and a bounce message to be created. The &%freeze%& command suspends all
32499 delivery attempts for the original recipients. In all cases, any new deliveries
32500 that are specified by the filter are attempted as normal after the filter has
32501 run.
32502
32503 The &%freeze%& command is ignored if the message has been manually unfrozen and
32504 not manually frozen since. This means that automatic freezing by a system
32505 filter can be used as a way of checking out suspicious messages. If a message
32506 is found to be all right, manually unfreezing it allows it to be delivered.
32507
32508 .cindex "log" "&%fail%& command log line"
32509 .cindex "&%fail%&" "log line; reducing"
32510 The text given with a fail command is used as part of the bounce message as
32511 well as being written to the log. If the message is quite long, this can fill
32512 up a lot of log space when such failures are common. To reduce the size of the
32513 log message, Exim interprets the text in a special way if it starts with the
32514 two characters &`<<`& and contains &`>>`& later. The text between these two
32515 strings is written to the log, and the rest of the text is used in the bounce
32516 message. For example:
32517 .code
32518 fail "<<filter test 1>>Your message is rejected \
32519      because it contains attachments that we are \
32520      not prepared to receive."
32521 .endd
32522
32523 .cindex "loop" "caused by &%fail%&"
32524 Take great care with the &%fail%& command when basing the decision to fail on
32525 the contents of the message, because the bounce message will of course include
32526 the contents of the original message and will therefore trigger the &%fail%&
32527 command again (causing a mail loop) unless steps are taken to prevent this.
32528 Testing the &%error_message%& condition is one way to prevent this. You could
32529 use, for example
32530 .code
32531 if $message_body contains "this is spam" and not error_message
32532 then fail text "spam is not wanted here" endif
32533 .endd
32534 though of course that might let through unwanted bounce messages. The
32535 alternative is clever checking of the body and/or headers to detect bounces
32536 generated by the filter.
32537
32538 The interpretation of a system filter file ceases after a
32539 &%defer%&,
32540 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
32541 set up earlier in the filter file are honoured, so you can use a sequence such
32542 as
32543 .code
32544 mail ...
32545 freeze
32546 .endd
32547 to send a specified message when the system filter is freezing (or deferring or
32548 failing) a message. The normal deliveries for the message do not, of course,
32549 take place.
32550
32551
32552
32553 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
32554 .cindex "header lines" "adding; in system filter"
32555 .cindex "header lines" "removing; in system filter"
32556 .cindex "filter" "header lines; adding/removing"
32557 Two filter commands that are available only in system filters are:
32558 .code
32559 headers add <string>
32560 headers remove <string>
32561 .endd
32562 The argument for the &%headers add%& is a string that is expanded and then
32563 added to the end of the message's headers. It is the responsibility of the
32564 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
32565 space is ignored, and if the string is otherwise empty, or if the expansion is
32566 forced to fail, the command has no effect.
32567
32568 You can use &"\n"& within the string, followed by white space, to specify
32569 continued header lines. More than one header may be added in one command by
32570 including &"\n"& within the string without any following white space. For
32571 example:
32572 .code
32573 headers add "X-header-1: ....\n  \
32574              continuation of X-header-1 ...\n\
32575              X-header-2: ...."
32576 .endd
32577 Note that the header line continuation white space after the first newline must
32578 be placed before the backslash that continues the input string, because white
32579 space after input continuations is ignored.
32580
32581 The argument for &%headers remove%& is a colon-separated list of header names.
32582 This command applies only to those headers that are stored with the message;
32583 those that are added at delivery time (such as &'Envelope-To:'& and
32584 &'Return-Path:'&) cannot be removed by this means. If there is more than one
32585 header with the same name, they are all removed.
32586
32587 The &%headers%& command in a system filter makes an immediate change to the set
32588 of header lines that was received with the message (with possible additions
32589 from ACL processing). Subsequent commands in the system filter operate on the
32590 modified set, which also forms the basis for subsequent message delivery.
32591 Unless further modified during routing or transporting, this set of headers is
32592 used for all recipients of the message.
32593
32594 During routing and transporting, the variables that refer to the contents of
32595 header lines refer only to those lines that are in this set. Thus, header lines
32596 that are added by a system filter are visible to users' filter files and to all
32597 routers and transports. This contrasts with the manipulation of header lines by
32598 routers and transports, which is not immediate, but which instead is saved up
32599 until the message is actually being written (see section
32600 &<<SECTheadersaddrem>>&).
32601
32602 If the message is not delivered at the first attempt, header lines that were
32603 added by the system filter are stored with the message, and so are still
32604 present at the next delivery attempt. Header lines that were removed are still
32605 present, but marked &"deleted"& so that they are not transported with the
32606 message. For this reason, it is usual to make the &%headers%& command
32607 conditional on &%first_delivery%& so that the set of header lines is not
32608 modified more than once.
32609
32610 Because header modification in a system filter acts immediately, you have to
32611 use an indirect approach if you want to modify the contents of a header line.
32612 For example:
32613 .code
32614 headers add "Old-Subject: $h_subject:"
32615 headers remove "Subject"
32616 headers add "Subject: new subject (was: $h_old-subject:)"
32617 headers remove "Old-Subject"
32618 .endd
32619
32620
32621
32622 .section "Setting an errors address in a system filter" "SECID217"
32623 .cindex "envelope sender"
32624 In a system filter, if a &%deliver%& command is followed by
32625 .code
32626 errors_to <some address>
32627 .endd
32628 in order to change the envelope sender (and hence the error reporting) for that
32629 delivery, any address may be specified. (In a user filter, only the current
32630 user's address can be set.) For example, if some mail is being monitored, you
32631 might use
32632 .code
32633 unseen deliver monitor@spying.example errors_to root@local.example
32634 .endd
32635 to take a copy which would not be sent back to the normal error reporting
32636 address if its delivery failed.
32637
32638
32639
32640 .section "Per-address filtering" "SECTperaddfil"
32641 .vindex "&$domain$&"
32642 .vindex "&$local_part$&"
32643 In contrast to the system filter, which is run just once per message for each
32644 delivery attempt, it is also possible to set up a system-wide filtering
32645 operation that runs once for each recipient address. In this case, variables
32646 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
32647 filter file could be made dependent on them. This is an example of a router
32648 which implements such a filter:
32649 .code
32650 central_filter:
32651   check_local_user
32652   driver = redirect
32653   domains = +local_domains
32654   file = /central/filters/$local_part
32655   no_verify
32656   allow_filter
32657   allow_freeze
32658 .endd
32659 The filter is run in a separate process under its own uid. Therefore, either
32660 &%check_local_user%& must be set (as above), in which case the filter is run as
32661 the local user, or the &%user%& option must be used to specify which user to
32662 use. If both are set, &%user%& overrides.
32663
32664 Care should be taken to ensure that none of the commands in the filter file
32665 specify a significant delivery if the message is to go on to be delivered to
32666 its intended recipient. The router will not then claim to have dealt with the
32667 address, so it will be passed on to subsequent routers to be delivered in the
32668 normal way.
32669 .ecindex IIDsysfil1
32670 .ecindex IIDsysfil2
32671 .ecindex IIDsysfil3
32672
32673
32674
32675
32676
32677
32678 . ////////////////////////////////////////////////////////////////////////////
32679 . ////////////////////////////////////////////////////////////////////////////
32680
32681 .chapter "Message processing" "CHAPmsgproc"
32682 .scindex IIDmesproc "message" "general processing"
32683 Exim performs various transformations on the sender and recipient addresses of
32684 all messages that it handles, and also on the messages' header lines. Some of
32685 these are optional and configurable, while others always take place. All of
32686 this processing, except rewriting as a result of routing, and the addition or
32687 removal of header lines while delivering, happens when a message is received,
32688 before it is placed on Exim's queue.
32689
32690 Some of the automatic processing takes place by default only for
32691 &"locally-originated"& messages. This adjective is used to describe messages
32692 that are not received over TCP/IP, but instead are passed to an Exim process on
32693 its standard input. This includes the interactive &"local SMTP"& case that is
32694 set up by the &%-bs%& command line option.
32695
32696 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
32697 or ::1) are not considered to be locally-originated. Exim does not treat the
32698 loopback interface specially in any way.
32699
32700 If you want the loopback interface to be treated specially, you must ensure
32701 that there are appropriate entries in your ACLs.
32702
32703
32704
32705
32706 .section "Submission mode for non-local messages" "SECTsubmodnon"
32707 .cindex "message" "submission"
32708 .cindex "submission mode"
32709 Processing that happens automatically for locally-originated messages (unless
32710 &%suppress_local_fixups%& is set) can also be requested for messages that are
32711 received over TCP/IP. The term &"submission mode"& is used to describe this
32712 state. Submission mode is set by the modifier
32713 .code
32714 control = submission
32715 .endd
32716 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
32717 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
32718 a local submission, and is normally used when the source of the message is
32719 known to be an MUA running on a client host (as opposed to an MTA). For
32720 example, to set submission mode for messages originating on the IPv4 loopback
32721 interface, you could include the following in the MAIL ACL:
32722 .code
32723 warn  hosts = 127.0.0.1
32724       control = submission
32725 .endd
32726 .cindex "&%sender_retain%& submission option"
32727 There are some options that can be used when setting submission mode. A slash
32728 is used to separate options. For example:
32729 .code
32730 control = submission/sender_retain
32731 .endd
32732 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
32733 true and &%local_from_check%& false for the current incoming message. The first
32734 of these allows an existing &'Sender:'& header in the message to remain, and
32735 the second suppresses the check to ensure that &'From:'& matches the
32736 authenticated sender. With this setting, Exim still fixes up messages by adding
32737 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
32738 attempt to check sender authenticity in header lines.
32739
32740 When &%sender_retain%& is not set, a submission mode setting may specify a
32741 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
32742 example:
32743 .code
32744 control = submission/domain=some.domain
32745 .endd
32746 The domain may be empty. How this value is used is described in sections
32747 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
32748 that allows you to specify the user's full name for inclusion in a created
32749 &'Sender:'& or &'From:'& header line. For example:
32750 .code
32751 accept authenticated = *
32752        control = submission/domain=wonderland.example/\
32753                             name=${lookup {$authenticated_id} \
32754                                    lsearch {/etc/exim/namelist}}
32755 .endd
32756 Because the name may contain any characters, including slashes, the &%name%&
32757 option must be given last. The remainder of the string is used as the name. For
32758 the example above, if &_/etc/exim/namelist_& contains:
32759 .code
32760 bigegg:  Humpty Dumpty
32761 .endd
32762 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
32763 line would be:
32764 .code
32765 Sender: Humpty Dumpty <bigegg@wonderland.example>
32766 .endd
32767 .cindex "return path" "in submission mode"
32768 By default, submission mode forces the return path to the same address as is
32769 used to create the &'Sender:'& header. However, if &%sender_retain%& is
32770 specified, the return path is also left unchanged.
32771
32772 &*Note*&: The changes caused by submission mode take effect after the predata
32773 ACL. This means that any sender checks performed before the fix-ups use the
32774 untrusted sender address specified by the user, not the trusted sender address
32775 specified by submission mode. Although this might be slightly unexpected, it
32776 does mean that you can configure ACL checks to spot that a user is trying to
32777 spoof another's address.
32778
32779 .section "Line endings" "SECTlineendings"
32780 .cindex "line endings"
32781 .cindex "carriage return"
32782 .cindex "linefeed"
32783 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
32784 linefeed) is the line ending for messages transmitted over the Internet using
32785 SMTP over TCP/IP. However, within individual operating systems, different
32786 conventions are used. For example, Unix-like systems use just LF, but others
32787 use CRLF or just CR.
32788
32789 Exim was designed for Unix-like systems, and internally, it stores messages
32790 using the system's convention of a single LF as a line terminator. When
32791 receiving a message, all line endings are translated to this standard format.
32792 Originally, it was thought that programs that passed messages directly to an
32793 MTA within an operating system would use that system's convention. Experience
32794 has shown that this is not the case; for example, there are Unix applications
32795 that use CRLF in this circumstance. For this reason, and for compatibility with
32796 other MTAs, the way Exim handles line endings for all messages is now as
32797 follows:
32798
32799 .ilist
32800 LF not preceded by CR is treated as a line ending.
32801 .next
32802 CR is treated as a line ending; if it is immediately followed by LF, the LF
32803 is ignored.
32804 .next
32805 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
32806 nor a local message in the state where a line containing only a dot is a
32807 terminator.
32808 .next
32809 If a bare CR is encountered within a header line, an extra space is added after
32810 the line terminator so as not to end the header line. The reasoning behind this
32811 is that bare CRs in header lines are most likely either to be mistakes, or
32812 people trying to play silly games.
32813 .next
32814 If the first header line received in a message ends with CRLF, a subsequent
32815 bare LF in a header line is treated in the same way as a bare CR in a header
32816 line.
32817 .endlist
32818
32819
32820
32821
32822
32823 .section "Unqualified addresses" "SECID218"
32824 .cindex "unqualified addresses"
32825 .cindex "address" "qualification"
32826 By default, Exim expects every envelope address it receives from an external
32827 host to be fully qualified. Unqualified addresses cause negative responses to
32828 SMTP commands. However, because SMTP is used as a means of transporting
32829 messages from MUAs running on personal workstations, there is sometimes a
32830 requirement to accept unqualified addresses from specific hosts or IP networks.
32831
32832 Exim has two options that separately control which hosts may send unqualified
32833 sender or recipient addresses in SMTP commands, namely
32834 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
32835 cases, if an unqualified address is accepted, it is qualified by adding the
32836 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
32837
32838 .oindex "&%qualify_domain%&"
32839 .oindex "&%qualify_recipient%&"
32840 Unqualified addresses in header lines are automatically qualified for messages
32841 that are locally originated, unless the &%-bnq%& option is given on the command
32842 line. For messages received over SMTP, unqualified addresses in header lines
32843 are qualified only if unqualified addresses are permitted in SMTP commands. In
32844 other words, such qualification is also controlled by
32845 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
32846
32847
32848
32849
32850 .section "The UUCP From line" "SECID219"
32851 .cindex "&""From""& line"
32852 .cindex "UUCP" "&""From""& line"
32853 .cindex "sender" "address"
32854 .oindex "&%uucp_from_pattern%&"
32855 .oindex "&%uucp_from_sender%&"
32856 .cindex "envelope sender"
32857 .cindex "Sendmail compatibility" "&""From""& line"
32858 Messages that have come from UUCP (and some other applications) often begin
32859 with a line containing the envelope sender and a timestamp, following the word
32860 &"From"&. Examples of two common formats are:
32861 .code
32862 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
32863 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
32864 .endd
32865 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
32866 Exim recognizes such lines at the start of messages that are submitted to it
32867 via the command line (that is, on the standard input). It does not recognize
32868 such lines in incoming SMTP messages, unless the sending host matches
32869 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
32870 and &%ignore_fromline_local%& is set. The recognition is controlled by a
32871 regular expression that is defined by the &%uucp_from_pattern%& option, whose
32872 default value matches the two common cases shown above and puts the address
32873 that follows &"From"& into &$1$&.
32874
32875 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
32876 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
32877 a trusted user, the message's sender address is constructed by expanding the
32878 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
32879 then parsed as an RFC 2822 address. If there is no domain, the local part is
32880 qualified with &%qualify_domain%& unless it is the empty string. However, if
32881 the command line &%-f%& option is used, it overrides the &"From"& line.
32882
32883 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
32884 sender address is not changed. This is also the case for incoming SMTP messages
32885 that are permitted to contain &"From"& lines.
32886
32887 Only one &"From"& line is recognized. If there is more than one, the second is
32888 treated as a data line that starts the body of the message, as it is not valid
32889 as a header line. This also happens if a &"From"& line is present in an
32890 incoming SMTP message from a source that is not permitted to send them.
32891
32892
32893
32894 .section "Resent- header lines" "SECID220"
32895 .cindex "&%Resent-%& header lines"
32896 RFC 2822 makes provision for sets of header lines starting with the string
32897 &`Resent-`& to be added to a message when it is resent by the original
32898 recipient to somebody else. These headers are &'Resent-Date:'&,
32899 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
32900 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
32901
32902 .blockquote
32903 &'Resent fields are strictly informational. They MUST NOT be used in the normal
32904 processing of replies or other such automatic actions on messages.'&
32905 .endblockquote
32906
32907 This leaves things a bit vague as far as other processing actions such as
32908 address rewriting are concerned. Exim treats &%Resent-%& header lines as
32909 follows:
32910
32911 .ilist
32912 A &'Resent-From:'& line that just contains the login id of the submitting user
32913 is automatically rewritten in the same way as &'From:'& (see below).
32914 .next
32915 If there's a rewriting rule for a particular header line, it is also applied to
32916 &%Resent-%& header lines of the same type. For example, a rule that rewrites
32917 &'From:'& also rewrites &'Resent-From:'&.
32918 .next
32919 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
32920 also removed.
32921 .next
32922 For a locally-submitted message,
32923 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
32924 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
32925 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
32926 included in log lines in this case.
32927 .next
32928 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
32929 &%Resent-%& header lines are present.
32930 .endlist
32931
32932
32933
32934
32935 .section "The Auto-Submitted: header line" "SECID221"
32936 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
32937 includes the header line:
32938 .code
32939 Auto-Submitted: auto-replied
32940 .endd
32941
32942 .section "The Bcc: header line" "SECID222"
32943 .cindex "&'Bcc:'& header line"
32944 If Exim is called with the &%-t%& option, to take recipient addresses from a
32945 message's header, it removes any &'Bcc:'& header line that may exist (after
32946 extracting its addresses). If &%-t%& is not present on the command line, any
32947 existing &'Bcc:'& is not removed.
32948
32949
32950 .section "The Date: header line" "SECID223"
32951 .cindex "&'Date:'& header line"
32952 If a locally-generated or submission-mode message has no &'Date:'& header line,
32953 Exim adds one, using the current date and time, unless the
32954 &%suppress_local_fixups%& control has been specified.
32955
32956 .section "The Delivery-date: header line" "SECID224"
32957 .cindex "&'Delivery-date:'& header line"
32958 .oindex "&%delivery_date_remove%&"
32959 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
32960 set. Exim can be configured to add them to the final delivery of messages. (See
32961 the generic &%delivery_date_add%& transport option.) They should not be present
32962 in messages in transit. If the &%delivery_date_remove%& configuration option is
32963 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
32964 messages.
32965
32966
32967 .section "The Envelope-to: header line" "SECID225"
32968 .cindex "&'Envelope-to:'& header line"
32969 .oindex "&%envelope_to_remove%&"
32970 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
32971 Exim can be configured to add them to the final delivery of messages. (See the
32972 generic &%envelope_to_add%& transport option.) They should not be present in
32973 messages in transit. If the &%envelope_to_remove%& configuration option is set
32974 (the default), Exim removes &'Envelope-to:'& header lines from incoming
32975 messages.
32976
32977
32978 .section "The From: header line" "SECTthefrohea"
32979 .cindex "&'From:'& header line"
32980 .cindex "Sendmail compatibility" "&""From""& line"
32981 .cindex "message" "submission"
32982 .cindex "submission mode"
32983 If a submission-mode message does not contain a &'From:'& header line, Exim
32984 adds one if either of the following conditions is true:
32985
32986 .ilist
32987 The envelope sender address is not empty (that is, this is not a bounce
32988 message). The added header line copies the envelope sender address.
32989 .next
32990 .vindex "&$authenticated_id$&"
32991 The SMTP session is authenticated and &$authenticated_id$& is not empty.
32992 .olist
32993 .vindex "&$qualify_domain$&"
32994 If no domain is specified by the submission control, the local part is
32995 &$authenticated_id$& and the domain is &$qualify_domain$&.
32996 .next
32997 If a non-empty domain is specified by the submission control, the local
32998 part is &$authenticated_id$&, and the domain is the specified domain.
32999 .next
33000 If an empty domain is specified by the submission control,
33001 &$authenticated_id$& is assumed to be the complete address.
33002 .endlist
33003 .endlist
33004
33005 A non-empty envelope sender takes precedence.
33006
33007 If a locally-generated incoming message does not contain a &'From:'& header
33008 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33009 containing the sender's address. The calling user's login name and full name
33010 are used to construct the address, as described in section &<<SECTconstr>>&.
33011 They are obtained from the password data by calling &[getpwuid()]& (but see the
33012 &%unknown_login%& configuration option). The address is qualified with
33013 &%qualify_domain%&.
33014
33015 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33016 &'From:'& header line containing just the unqualified login name of the calling
33017 user, this is replaced by an address containing the user's login name and full
33018 name as described in section &<<SECTconstr>>&.
33019
33020
33021 .section "The Message-ID: header line" "SECID226"
33022 .cindex "&'Message-ID:'& header line"
33023 .cindex "message" "submission"
33024 .oindex "&%message_id_header_text%&"
33025 If a locally-generated or submission-mode incoming message does not contain a
33026 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33027 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33028 to the message. If there are any &'Resent-:'& headers in the message, it
33029 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33030 message id, preceded by the letter E to ensure it starts with a letter, and
33031 followed by @ and the primary host name. Additional information can be included
33032 in this header line by setting the &%message_id_header_text%& and/or
33033 &%message_id_header_domain%& options.
33034
33035
33036 .section "The Received: header line" "SECID227"
33037 .cindex "&'Received:'& header line"
33038 A &'Received:'& header line is added at the start of every message. The
33039 contents are defined by the &%received_header_text%& configuration option, and
33040 Exim automatically adds a semicolon and a timestamp to the configured string.
33041
33042 The &'Received:'& header is generated as soon as the message's header lines
33043 have been received. At this stage, the timestamp in the &'Received:'& header
33044 line is the time that the message started to be received. This is the value
33045 that is seen by the DATA ACL and by the &[local_scan()]& function.
33046
33047 Once a message is accepted, the timestamp in the &'Received:'& header line is
33048 changed to the time of acceptance, which is (apart from a small delay while the
33049 -H spool file is written) the earliest time at which delivery could start.
33050
33051
33052 .section "The References: header line" "SECID228"
33053 .cindex "&'References:'& header line"
33054 Messages created by the &(autoreply)& transport include a &'References:'&
33055 header line. This is constructed according to the rules that are described in
33056 section 3.64 of RFC 2822 (which states that replies should contain such a
33057 header line), and section 3.14 of RFC 3834 (which states that automatic
33058 responses are not different in this respect). However, because some mail
33059 processing software does not cope well with very long header lines, no more
33060 than 12 message IDs are copied from the &'References:'& header line in the
33061 incoming message. If there are more than 12, the first one and then the final
33062 11 are copied, before adding the message ID of the incoming message.
33063
33064
33065
33066 .section "The Return-path: header line" "SECID229"
33067 .cindex "&'Return-path:'& header line"
33068 .oindex "&%return_path_remove%&"
33069 &'Return-path:'& header lines are defined as something an MTA may insert when
33070 it does the final delivery of messages. (See the generic &%return_path_add%&
33071 transport option.) Therefore, they should not be present in messages in
33072 transit. If the &%return_path_remove%& configuration option is set (the
33073 default), Exim removes &'Return-path:'& header lines from incoming messages.
33074
33075
33076
33077 .section "The Sender: header line" "SECTthesenhea"
33078 .cindex "&'Sender:'& header line"
33079 .cindex "message" "submission"
33080 For a locally-originated message from an untrusted user, Exim may remove an
33081 existing &'Sender:'& header line, and it may add a new one. You can modify
33082 these actions by setting the &%local_sender_retain%& option true, the
33083 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33084 control setting.
33085
33086 When a local message is received from an untrusted user and
33087 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33088 control has not been set, a check is made to see if the address given in the
33089 &'From:'& header line is the correct (local) sender of the message. The address
33090 that is expected has the login name as the local part and the value of
33091 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33092 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33093 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33094 line is added to the message.
33095
33096 If you set &%local_from_check%& false, this checking does not occur. However,
33097 the removal of an existing &'Sender:'& line still happens, unless you also set
33098 &%local_sender_retain%& to be true. It is not possible to set both of these
33099 options true at the same time.
33100
33101 .cindex "submission mode"
33102 By default, no processing of &'Sender:'& header lines is done for messages
33103 received over TCP/IP or for messages submitted by trusted users. However, when
33104 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33105 not specified on the submission control, the following processing takes place:
33106
33107 .vindex "&$authenticated_id$&"
33108 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33109 authenticated, and &$authenticated_id$& is not empty, a sender address is
33110 created as follows:
33111
33112 .ilist
33113 .vindex "&$qualify_domain$&"
33114 If no domain is specified by the submission control, the local part is
33115 &$authenticated_id$& and the domain is &$qualify_domain$&.
33116 .next
33117 If a non-empty domain is specified by the submission control, the local part
33118 is &$authenticated_id$&, and the domain is the specified domain.
33119 .next
33120 If an empty domain is specified by the submission control,
33121 &$authenticated_id$& is assumed to be the complete address.
33122 .endlist
33123
33124 This address is compared with the address in the &'From:'& header line. If they
33125 are different, a &'Sender:'& header line containing the created address is
33126 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33127 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33128
33129 .cindex "return path" "created from &'Sender:'&"
33130 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33131 the message (the envelope sender address) is changed to be the same address,
33132 except in the case of submission mode when &%sender_retain%& is specified.
33133
33134
33135
33136 .section "Adding and removing header lines in routers and transports" &&&
33137          "SECTheadersaddrem"
33138 .cindex "header lines" "adding; in router or transport"
33139 .cindex "header lines" "removing; in router or transport"
33140 When a message is delivered, the addition and removal of header lines can be
33141 specified in a system filter, or on any of the routers and transports that
33142 process the message. Section &<<SECTaddremheasys>>& contains details about
33143 modifying headers in a system filter. Header lines can also be added in an ACL
33144 as a message is received (see section &<<SECTaddheadacl>>&).
33145
33146 In contrast to what happens in a system filter, header modifications that are
33147 specified on routers and transports apply only to the particular recipient
33148 addresses that are being processed by those routers and transports. These
33149 changes do not actually take place until a copy of the message is being
33150 transported. Therefore, they do not affect the basic set of header lines, and
33151 they do not affect the values of the variables that refer to header lines.
33152
33153 &*Note*&: In particular, this means that any expansions in the configuration of
33154 the transport cannot refer to the modified header lines, because such
33155 expansions all occur before the message is actually transported.
33156
33157 For both routers and transports, the argument of a &%headers_add%&
33158 option must be in the form of one or more RFC 2822 header lines, separated by
33159 newlines (coded as &"\n"&). For example:
33160 .code
33161 headers_add = X-added-header: added by $primary_hostname\n\
33162               X-added-second: another added header line
33163 .endd
33164 Exim does not check the syntax of these added header lines.
33165
33166 Multiple &%headers_add%& options for a single router or transport can be
33167 specified; the values will append to a single list of header lines.
33168 Each header-line is separately expanded.
33169
33170 The argument of a &%headers_remove%& option must consist of a colon-separated
33171 list of header names. This is confusing, because header names themselves are
33172 often terminated by colons. In this case, the colons are the list separators,
33173 not part of the names. For example:
33174 .code
33175 headers_remove = return-receipt-to:acknowledge-to
33176 .endd
33177
33178 Multiple &%headers_remove%& options for a single router or transport can be
33179 specified; the arguments will append to a single header-names list.
33180 Each item is separately expanded.
33181 Note that colons in complex expansions which are used to
33182 form all or part of a &%headers_remove%& list
33183 will act as list separators.
33184
33185 When &%headers_add%& or &%headers_remove%& is specified on a router,
33186 items are expanded at routing time,
33187 and then associated with all addresses that are
33188 accepted by that router, and also with any new addresses that it generates. If
33189 an address passes through several routers as a result of aliasing or
33190 forwarding, the changes are cumulative.
33191
33192 .oindex "&%unseen%&"
33193 However, this does not apply to multiple routers that result from the use of
33194 the &%unseen%& option. Any header modifications that were specified by the
33195 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33196
33197 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33198 settings cannot be delivered together in a batch, so a transport is always
33199 dealing with a set of addresses that have the same header-processing
33200 requirements.
33201
33202 The transport starts by writing the original set of header lines that arrived
33203 with the message, possibly modified by the system filter. As it writes out
33204 these lines, it consults the list of header names that were attached to the
33205 recipient address(es) by &%headers_remove%& options in routers, and it also
33206 consults the transport's own &%headers_remove%& option. Header lines whose
33207 names are on either of these lists are not written out. If there are multiple
33208 instances of any listed header, they are all skipped.
33209
33210 After the remaining original header lines have been written, new header
33211 lines that were specified by routers' &%headers_add%& options are written, in
33212 the order in which they were attached to the address. These are followed by any
33213 header lines specified by the transport's &%headers_add%& option.
33214
33215 This way of handling header line modifications in routers and transports has
33216 the following consequences:
33217
33218 .ilist
33219 The original set of header lines, possibly modified by the system filter,
33220 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33221 to it, at all times.
33222 .next
33223 Header lines that are added by a router's
33224 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33225 expansion syntax in subsequent routers or the transport.
33226 .next
33227 Conversely, header lines that are specified for removal by &%headers_remove%&
33228 in a router remain visible to subsequent routers and the transport.
33229 .next
33230 Headers added to an address by &%headers_add%& in a router cannot be removed by
33231 a later router or by a transport.
33232 .next
33233 An added header can refer to the contents of an original header that is to be
33234 removed, even it has the same name as the added header. For example:
33235 .code
33236 headers_remove = subject
33237 headers_add = Subject: new subject (was: $h_subject:)
33238 .endd
33239 .endlist
33240
33241 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33242 for a &(redirect)& router that has the &%one_time%& option set.
33243
33244
33245
33246
33247
33248 .section "Constructed addresses" "SECTconstr"
33249 .cindex "address" "constructed"
33250 .cindex "constructed address"
33251 When Exim constructs a sender address for a locally-generated message, it uses
33252 the form
33253 .display
33254 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33255 .endd
33256 For example:
33257 .code
33258 Zaphod Beeblebrox <zaphod@end.univ.example>
33259 .endd
33260 The user name is obtained from the &%-F%& command line option if set, or
33261 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33262 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33263 ampersand character, this is replaced by the login name with the first letter
33264 upper cased, as is conventional in a number of operating systems. See the
33265 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33266 The &%unknown_username%& option can be used to specify user names in cases when
33267 there is no password file entry.
33268
33269 .cindex "RFC 2047"
33270 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33271 parts of it if necessary. In addition, if it contains any non-printing
33272 characters, it is encoded as described in RFC 2047, which defines a way of
33273 including non-ASCII characters in header lines. The value of the
33274 &%headers_charset%& option specifies the name of the encoding that is used (the
33275 characters are assumed to be in this encoding). The setting of
33276 &%print_topbitchars%& controls whether characters with the top bit set (that
33277 is, with codes greater than 127) count as printing characters or not.
33278
33279
33280
33281 .section "Case of local parts" "SECID230"
33282 .cindex "case of local parts"
33283 .cindex "local part" "case of"
33284 RFC 2822 states that the case of letters in the local parts of addresses cannot
33285 be assumed to be non-significant. Exim preserves the case of local parts of
33286 addresses, but by default it uses a lower-cased form when it is routing,
33287 because on most Unix systems, usernames are in lower case and case-insensitive
33288 routing is required. However, any particular router can be made to use the
33289 original case for local parts by setting the &%caseful_local_part%& generic
33290 router option.
33291
33292 .cindex "mixed-case login names"
33293 If you must have mixed-case user names on your system, the best way to proceed,
33294 assuming you want case-independent handling of incoming email, is to set up
33295 your first router to convert incoming local parts in your domains to the
33296 correct case by means of a file lookup. For example:
33297 .code
33298 correct_case:
33299   driver = redirect
33300   domains = +local_domains
33301   data = ${lookup{$local_part}cdb\
33302               {/etc/usercased.cdb}{$value}fail}\
33303               @$domain
33304 .endd
33305 For this router, the local part is forced to lower case by the default action
33306 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
33307 up a new local part in the correct case. If you then set &%caseful_local_part%&
33308 on any subsequent routers which process your domains, they will operate on
33309 local parts with the correct case in a case-sensitive manner.
33310
33311
33312
33313 .section "Dots in local parts" "SECID231"
33314 .cindex "dot" "in local part"
33315 .cindex "local part" "dots in"
33316 RFC 2822 forbids empty components in local parts. That is, an unquoted local
33317 part may not begin or end with a dot, nor have two consecutive dots in the
33318 middle. However, it seems that many MTAs do not enforce this, so Exim permits
33319 empty components for compatibility.
33320
33321
33322
33323 .section "Rewriting addresses" "SECID232"
33324 .cindex "rewriting" "addresses"
33325 Rewriting of sender and recipient addresses, and addresses in headers, can
33326 happen automatically, or as the result of configuration options, as described
33327 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
33328 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
33329
33330 Automatic rewriting includes qualification, as mentioned above. The other case
33331 in which it can happen is when an incomplete non-local domain is given. The
33332 routing process may cause this to be expanded into the full domain name. For
33333 example, a header such as
33334 .code
33335 To: hare@teaparty
33336 .endd
33337 might get rewritten as
33338 .code
33339 To: hare@teaparty.wonderland.fict.example
33340 .endd
33341 Rewriting as a result of routing is the one kind of message processing that
33342 does not happen at input time, as it cannot be done until the address has
33343 been routed.
33344
33345 Strictly, one should not do &'any'& deliveries of a message until all its
33346 addresses have been routed, in case any of the headers get changed as a
33347 result of routing. However, doing this in practice would hold up many
33348 deliveries for unreasonable amounts of time, just because one address could not
33349 immediately be routed. Exim therefore does not delay other deliveries when
33350 routing of one or more addresses is deferred.
33351 .ecindex IIDmesproc
33352
33353
33354
33355 . ////////////////////////////////////////////////////////////////////////////
33356 . ////////////////////////////////////////////////////////////////////////////
33357
33358 .chapter "SMTP processing" "CHAPSMTP"
33359 .scindex IIDsmtpproc1 "SMTP" "processing details"
33360 .scindex IIDsmtpproc2 "LMTP" "processing details"
33361 Exim supports a number of different ways of using the SMTP protocol, and its
33362 LMTP variant, which is an interactive protocol for transferring messages into a
33363 closed mail store application. This chapter contains details of how SMTP is
33364 processed. For incoming mail, the following are available:
33365
33366 .ilist
33367 SMTP over TCP/IP (Exim daemon or &'inetd'&);
33368 .next
33369 SMTP over the standard input and output (the &%-bs%& option);
33370 .next
33371 Batched SMTP on the standard input (the &%-bS%& option).
33372 .endlist
33373
33374 For mail delivery, the following are available:
33375
33376 .ilist
33377 SMTP over TCP/IP (the &(smtp)& transport);
33378 .next
33379 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
33380 &"lmtp"&);
33381 .next
33382 LMTP over a pipe to a process running in the local host (the &(lmtp)&
33383 transport);
33384 .next
33385 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
33386 the &%use_bsmtp%& option set).
33387 .endlist
33388
33389 &'Batched SMTP'& is the name for a process in which batches of messages are
33390 stored in or read from files (or pipes), in a format in which SMTP commands are
33391 used to contain the envelope information.
33392
33393
33394
33395 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
33396 .cindex "SMTP" "outgoing over TCP/IP"
33397 .cindex "outgoing SMTP over TCP/IP"
33398 .cindex "LMTP" "over TCP/IP"
33399 .cindex "outgoing LMTP over TCP/IP"
33400 .cindex "EHLO"
33401 .cindex "HELO"
33402 .cindex "SIZE option on MAIL command"
33403 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
33404 The &%protocol%& option selects which protocol is to be used, but the actual
33405 processing is the same in both cases.
33406
33407 If, in response to its EHLO command, Exim is told that the SIZE
33408 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
33409 command. The value of <&'n'&> is the message size plus the value of the
33410 &%size_addition%& option (default 1024) to allow for additions to the message
33411 such as per-transport header lines, or changes made in a
33412 .cindex "transport" "filter"
33413 .cindex "filter" "transport filter"
33414 transport filter. If &%size_addition%& is set negative, the use of SIZE is
33415 suppressed.
33416
33417 If the remote server advertises support for PIPELINING, Exim uses the
33418 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
33419 required for the transaction.
33420
33421 If the remote server advertises support for the STARTTLS command, and Exim
33422 was built to support TLS encryption, it tries to start a TLS session unless the
33423 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
33424 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
33425 is called for verification.
33426
33427 If the remote server advertises support for the AUTH command, Exim scans
33428 the authenticators configuration for any suitable client settings, as described
33429 in chapter &<<CHAPSMTPAUTH>>&.
33430
33431 .cindex "carriage return"
33432 .cindex "linefeed"
33433 Responses from the remote host are supposed to be terminated by CR followed by
33434 LF. However, there are known to be hosts that do not send CR characters, so in
33435 order to be able to interwork with such hosts, Exim treats LF on its own as a
33436 line terminator.
33437
33438 If a message contains a number of different addresses, all those with the same
33439 characteristics (for example, the same envelope sender) that resolve to the
33440 same set of hosts, in the same order, are sent in a single SMTP transaction,
33441 even if they are for different domains, unless there are more than the setting
33442 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
33443 they are split into groups containing no more than &%max_rcpt%&s addresses
33444 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
33445 in parallel sessions. The order of hosts with identical MX values is not
33446 significant when checking whether addresses can be batched in this way.
33447
33448 When the &(smtp)& transport suffers a temporary failure that is not
33449 message-related, Exim updates its transport-specific database, which contains
33450 records indexed by host name that remember which messages are waiting for each
33451 particular host. It also updates the retry database with new retry times.
33452
33453 .cindex "hints database" "retry keys"
33454 Exim's retry hints are based on host name plus IP address, so if one address of
33455 a multi-homed host is broken, it will soon be skipped most of the time.
33456 See the next section for more detail about error handling.
33457
33458 .cindex "SMTP" "passed connection"
33459 .cindex "SMTP" "batching over TCP/IP"
33460 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
33461 looks in the hints database for the transport to see if there are any queued
33462 messages waiting for the host to which it is connected. If it finds one, it
33463 creates a new Exim process using the &%-MC%& option (which can only be used by
33464 a process running as root or the Exim user) and passes the TCP/IP socket to it
33465 so that it can deliver another message using the same socket. The new process
33466 does only those deliveries that are routed to the connected host, and may in
33467 turn pass the socket on to a third process, and so on.
33468
33469 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
33470 limit the number of messages sent down a single TCP/IP connection.
33471
33472 .cindex "asterisk" "after IP address"
33473 The second and subsequent messages delivered down an existing connection are
33474 identified in the main log by the addition of an asterisk after the closing
33475 square bracket of the IP address.
33476
33477
33478
33479
33480 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
33481 .cindex "error" "in outgoing SMTP"
33482 .cindex "SMTP" "errors in outgoing"
33483 .cindex "host" "error"
33484 Three different kinds of error are recognized for outgoing SMTP: host errors,
33485 message errors, and recipient errors.
33486
33487 .vlist
33488 .vitem "&*Host errors*&"
33489 A host error is not associated with a particular message or with a
33490 particular recipient of a message. The host errors are:
33491
33492 .ilist
33493 Connection refused or timed out,
33494 .next
33495 Any error response code on connection,
33496 .next
33497 Any error response code to EHLO or HELO,
33498 .next
33499 Loss of connection at any time, except after &"."&,
33500 .next
33501 I/O errors at any time,
33502 .next
33503 Timeouts during the session, other than in response to MAIL, RCPT or
33504 the &"."& at the end of the data.
33505 .endlist ilist
33506
33507 For a host error, a permanent error response on connection, or in response to
33508 EHLO, causes all addresses routed to the host to be failed. Any other host
33509 error causes all addresses to be deferred, and retry data to be created for the
33510 host. It is not tried again, for any message, until its retry time arrives. If
33511 the current set of addresses are not all delivered in this run (to some
33512 alternative host), the message is added to the list of those waiting for this
33513 host, so if it is still undelivered when a subsequent successful delivery is
33514 made to the host, it will be sent down the same SMTP connection.
33515
33516 .vitem "&*Message errors*&"
33517 .cindex "message" "error"
33518 A message error is associated with a particular message when sent to a
33519 particular host, but not with a particular recipient of the message. The
33520 message errors are:
33521
33522 .ilist
33523 Any error response code to MAIL, DATA, or the &"."& that terminates
33524 the data,
33525 .next
33526 Timeout after MAIL,
33527 .next
33528 Timeout or loss of connection after the &"."& that terminates the data. A
33529 timeout after the DATA command itself is treated as a host error, as is loss of
33530 connection at any other time.
33531 .endlist ilist
33532
33533 For a message error, a permanent error response (5&'xx'&) causes all addresses
33534 to be failed, and a delivery error report to be returned to the sender. A
33535 temporary error response (4&'xx'&), or one of the timeouts, causes all
33536 addresses to be deferred. Retry data is not created for the host, but instead,
33537 a retry record for the combination of host plus message id is created. The
33538 message is not added to the list of those waiting for this host. This ensures
33539 that the failing message will not be sent to this host again until the retry
33540 time arrives. However, other messages that are routed to the host are not
33541 affected, so if it is some property of the message that is causing the error,
33542 it will not stop the delivery of other mail.
33543
33544 If the remote host specified support for the SIZE parameter in its response
33545 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
33546 over-large message will cause a message error because the error arrives as a
33547 response to MAIL.
33548
33549 .vitem "&*Recipient errors*&"
33550 .cindex "recipient" "error"
33551 A recipient error is associated with a particular recipient of a message. The
33552 recipient errors are:
33553
33554 .ilist
33555 Any error response to RCPT,
33556 .next
33557 Timeout after RCPT.
33558 .endlist
33559
33560 For a recipient error, a permanent error response (5&'xx'&) causes the
33561 recipient address to be failed, and a bounce message to be returned to the
33562 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
33563 address to be deferred, and routing retry data to be created for it. This is
33564 used to delay processing of the address in subsequent queue runs, until its
33565 routing retry time arrives. This applies to all messages, but because it
33566 operates only in queue runs, one attempt will be made to deliver a new message
33567 to the failing address before the delay starts to operate. This ensures that,
33568 if the failure is really related to the message rather than the recipient
33569 (&"message too big for this recipient"& is a possible example), other messages
33570 have a chance of getting delivered. If a delivery to the address does succeed,
33571 the retry information gets cleared, so all stuck messages get tried again, and
33572 the retry clock is reset.
33573
33574 The message is not added to the list of those waiting for this host. Use of the
33575 host for other messages is unaffected, and except in the case of a timeout,
33576 other recipients are processed independently, and may be successfully delivered
33577 in the current SMTP session. After a timeout it is of course impossible to
33578 proceed with the session, so all addresses get deferred. However, those other
33579 than the one that failed do not suffer any subsequent retry delays. Therefore,
33580 if one recipient is causing trouble, the others have a chance of getting
33581 through when a subsequent delivery attempt occurs before the failing
33582 recipient's retry time.
33583 .endlist
33584
33585 In all cases, if there are other hosts (or IP addresses) available for the
33586 current set of addresses (for example, from multiple MX records), they are
33587 tried in this run for any undelivered addresses, subject of course to their
33588 own retry data. In other words, recipient error retry data does not take effect
33589 until the next delivery attempt.
33590
33591 Some hosts have been observed to give temporary error responses to every
33592 MAIL command at certain times (&"insufficient space"& has been seen). It
33593 would be nice if such circumstances could be recognized, and defer data for the
33594 host itself created, but this is not possible within the current Exim design.
33595 What actually happens is that retry data for every (host, message) combination
33596 is created.
33597
33598 The reason that timeouts after MAIL and RCPT are treated specially is that
33599 these can sometimes arise as a result of the remote host's verification
33600 procedures. Exim makes this assumption, and treats them as if a temporary error
33601 response had been received. A timeout after &"."& is treated specially because
33602 it is known that some broken implementations fail to recognize the end of the
33603 message if the last character of the last line is a binary zero. Thus, it is
33604 helpful to treat this case as a message error.
33605
33606 Timeouts at other times are treated as host errors, assuming a problem with the
33607 host, or the connection to it. If a timeout after MAIL, RCPT,
33608 or &"."& is really a connection problem, the assumption is that at the next try
33609 the timeout is likely to occur at some other point in the dialogue, causing it
33610 then to be treated as a host error.
33611
33612 There is experimental evidence that some MTAs drop the connection after the
33613 terminating &"."& if they do not like the contents of the message for some
33614 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
33615 should be given. That is why Exim treats this case as a message rather than a
33616 host error, in order not to delay other messages to the same host.
33617
33618
33619
33620
33621 .section "Incoming SMTP messages over TCP/IP" "SECID233"
33622 .cindex "SMTP" "incoming over TCP/IP"
33623 .cindex "incoming SMTP over TCP/IP"
33624 .cindex "inetd"
33625 .cindex "daemon"
33626 Incoming SMTP messages can be accepted in one of two ways: by running a
33627 listening daemon, or by using &'inetd'&. In the latter case, the entry in
33628 &_/etc/inetd.conf_& should be like this:
33629 .code
33630 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
33631 .endd
33632 Exim distinguishes between this case and the case of a locally running user
33633 agent using the &%-bs%& option by checking whether or not the standard input is
33634 a socket. When it is, either the port must be privileged (less than 1024), or
33635 the caller must be root or the Exim user. If any other user passes a socket
33636 with an unprivileged port number, Exim prints a message on the standard error
33637 stream and exits with an error code.
33638
33639 By default, Exim does not make a log entry when a remote host connects or
33640 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
33641 unexpected. It can be made to write such log entries by setting the
33642 &%smtp_connection%& log selector.
33643
33644 .cindex "carriage return"
33645 .cindex "linefeed"
33646 Commands from the remote host are supposed to be terminated by CR followed by
33647 LF. However, there are known to be hosts that do not send CR characters. In
33648 order to be able to interwork with such hosts, Exim treats LF on its own as a
33649 line terminator.
33650 Furthermore, because common code is used for receiving messages from all
33651 sources, a CR on its own is also interpreted as a line terminator. However, the
33652 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
33653
33654 .cindex "EHLO" "invalid data"
33655 .cindex "HELO" "invalid data"
33656 One area that sometimes gives rise to problems concerns the EHLO or
33657 HELO commands. Some clients send syntactically invalid versions of these
33658 commands, which Exim rejects by default. (This is nothing to do with verifying
33659 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
33660 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
33661 match the broken hosts that send invalid commands.
33662
33663 .cindex "SIZE option on MAIL command"
33664 .cindex "MAIL" "SIZE option"
33665 The amount of disk space available is checked whenever SIZE is received on
33666 a MAIL command, independently of whether &%message_size_limit%& or
33667 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
33668 false. A temporary error is given if there is not enough space. If
33669 &%check_spool_space%& is set, the check is for that amount of space plus the
33670 value given with SIZE, that is, it checks that the addition of the incoming
33671 message will not reduce the space below the threshold.
33672
33673 When a message is successfully received, Exim includes the local message id in
33674 its response to the final &"."& that terminates the data. If the remote host
33675 logs this text it can help with tracing what has happened to a message.
33676
33677 The Exim daemon can limit the number of simultaneous incoming connections it is
33678 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
33679 number of simultaneous incoming connections from a single remote host (see the
33680 &%smtp_accept_max_per_host%& option). Additional connection attempts are
33681 rejected using the SMTP temporary error code 421.
33682
33683 The Exim daemon does not rely on the SIGCHLD signal to detect when a
33684 subprocess has finished, as this can get lost at busy times. Instead, it looks
33685 for completed subprocesses every time it wakes up. Provided there are other
33686 things happening (new incoming calls, starts of queue runs), completed
33687 processes will be noticed and tidied away. On very quiet systems you may
33688 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
33689 it will be noticed when the daemon next wakes up.
33690
33691 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
33692 and can also be set up to reject SMTP calls from non-reserved hosts at times of
33693 high system load &-- for details see the &%smtp_accept_reserve%&,
33694 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
33695 applies in both the daemon and &'inetd'& cases.
33696
33697 Exim normally starts a delivery process for each message received, though this
33698 can be varied by means of the &%-odq%& command line option and the
33699 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
33700 number of simultaneously running delivery processes started in this way from
33701 SMTP input can be limited by the &%smtp_accept_queue%& and
33702 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
33703 subsequently received messages are just put on the input queue without starting
33704 a delivery process.
33705
33706 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
33707 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
33708 started up from the &'inetd'& daemon, because in that case each connection is
33709 handled by an entirely independent Exim process. Control by load average is,
33710 however, available with &'inetd'&.
33711
33712 Exim can be configured to verify addresses in incoming SMTP commands as they
33713 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
33714 to rewrite addresses at this time &-- before any syntax checking is done. See
33715 section &<<SECTrewriteS>>&.
33716
33717 Exim can also be configured to limit the rate at which a client host submits
33718 MAIL and RCPT commands in a single SMTP session. See the
33719 &%smtp_ratelimit_hosts%& option.
33720
33721
33722
33723 .section "Unrecognized SMTP commands" "SECID234"
33724 .cindex "SMTP" "unrecognized commands"
33725 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
33726 commands during a single SMTP connection, it drops the connection after sending
33727 the error response to the last command. The default value for
33728 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
33729 abuse that subvert web servers into making connections to SMTP ports; in these
33730 circumstances, a number of non-SMTP lines are sent first.
33731
33732
33733 .section "Syntax and protocol errors in SMTP commands" "SECID235"
33734 .cindex "SMTP" "syntax errors"
33735 .cindex "SMTP" "protocol errors"
33736 A syntax error is detected if an SMTP command is recognized, but there is
33737 something syntactically wrong with its data, for example, a malformed email
33738 address in a RCPT command. Protocol errors include invalid command
33739 sequencing such as RCPT before MAIL. If Exim receives more than
33740 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
33741 drops the connection after sending the error response to the last command. The
33742 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
33743 broken clients that loop sending bad commands (yes, it has been seen).
33744
33745
33746
33747 .section "Use of non-mail SMTP commands" "SECID236"
33748 .cindex "SMTP" "non-mail commands"
33749 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
33750 DATA. Exim counts such commands, and drops the connection if there are too
33751 many of them in a single SMTP session. This action catches some
33752 denial-of-service attempts and things like repeated failing AUTHs, or a mad
33753 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
33754 defines what &"too many"& means. Its default value is 10.
33755
33756 When a new message is expected, one occurrence of RSET is not counted. This
33757 allows a client to send one RSET between messages (this is not necessary,
33758 but some clients do it). Exim also allows one uncounted occurrence of HELO
33759 or EHLO, and one occurrence of STARTTLS between messages. After
33760 starting up a TLS session, another EHLO is expected, and so it too is not
33761 counted.
33762
33763 The first occurrence of AUTH in a connection, or immediately following
33764 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
33765 RCPT, DATA, and QUIT are counted.
33766
33767 You can control which hosts are subject to the limit set by
33768 &%smtp_accept_max_nonmail%& by setting
33769 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
33770 the limit apply to all hosts. This option means that you can exclude any
33771 specific badly-behaved hosts that you have to live with.
33772
33773
33774
33775
33776 .section "The VRFY and EXPN commands" "SECID237"
33777 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
33778 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
33779 appropriate) in order to decide whether the command should be accepted or not.
33780 If no ACL is defined, the command is rejected.
33781
33782 .cindex "VRFY" "processing"
33783 When VRFY is accepted, it runs exactly the same code as when Exim is
33784 called with the &%-bv%& option.
33785
33786 .cindex "EXPN" "processing"
33787 When EXPN is accepted, a single-level expansion of the address is done.
33788 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
33789 than a verification (the &%-bv%& option). If an unqualified local part is given
33790 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
33791 of VRFY and EXPN commands are logged on the main and reject logs, and
33792 VRFY verification failures are logged on the main log for consistency with
33793 RCPT failures.
33794
33795
33796
33797 .section "The ETRN command" "SECTETRN"
33798 .cindex "ETRN" "processing"
33799 RFC 1985 describes an SMTP command called ETRN that is designed to
33800 overcome the security problems of the TURN command (which has fallen into
33801 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
33802 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
33803 should be accepted or not. If no ACL is defined, the command is rejected.
33804
33805 The ETRN command is concerned with &"releasing"& messages that are awaiting
33806 delivery to certain hosts. As Exim does not organize its message queue by host,
33807 the only form of ETRN that is supported by default is the one where the
33808 text starts with the &"#"& prefix, in which case the remainder of the text is
33809 specific to the SMTP server. A valid ETRN command causes a run of Exim with
33810 the &%-R%& option to happen, with the remainder of the ETRN text as its
33811 argument. For example,
33812 .code
33813 ETRN #brigadoon
33814 .endd
33815 runs the command
33816 .code
33817 exim -R brigadoon
33818 .endd
33819 which causes a delivery attempt on all messages with undelivered addresses
33820 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
33821 default), Exim prevents the simultaneous execution of more than one queue run
33822 for the same argument string as a result of an ETRN command. This stops
33823 a misbehaving client from starting more than one queue runner at once.
33824
33825 .cindex "hints database" "ETRN serialization"
33826 Exim implements the serialization by means of a hints database in which a
33827 record is written whenever a process is started by ETRN, and deleted when
33828 the process completes. However, Exim does not keep the SMTP session waiting for
33829 the ETRN process to complete. Once ETRN is accepted, the client is sent
33830 a &"success"& return code. Obviously there is scope for hints records to get
33831 left lying around if there is a system or program crash. To guard against this,
33832 Exim ignores any records that are more than six hours old.
33833
33834 .oindex "&%smtp_etrn_command%&"
33835 For more control over what ETRN does, the &%smtp_etrn_command%& option can
33836 used. This specifies a command that is run whenever ETRN is received,
33837 whatever the form of its argument. For
33838 example:
33839 .code
33840 smtp_etrn_command = /etc/etrn_command $domain \
33841                     $sender_host_address
33842 .endd
33843 .vindex "&$domain$&"
33844 The string is split up into arguments which are independently expanded. The
33845 expansion variable &$domain$& is set to the argument of the ETRN command,
33846 and no syntax checking is done on the contents of this argument. Exim does not
33847 wait for the command to complete, so its status code is not checked. Exim runs
33848 under its own uid and gid when receiving incoming SMTP, so it is not possible
33849 for it to change them before running the command.
33850
33851
33852
33853 .section "Incoming local SMTP" "SECID238"
33854 .cindex "SMTP" "local incoming"
33855 Some user agents use SMTP to pass messages to their local MTA using the
33856 standard input and output, as opposed to passing the envelope on the command
33857 line and writing the message to the standard input. This is supported by the
33858 &%-bs%& option. This form of SMTP is handled in the same way as incoming
33859 messages over TCP/IP (including the use of ACLs), except that the envelope
33860 sender given in a MAIL command is ignored unless the caller is trusted. In
33861 an ACL you can detect this form of SMTP input by testing for an empty host
33862 identification. It is common to have this as the first line in the ACL that
33863 runs for RCPT commands:
33864 .code
33865 accept hosts = :
33866 .endd
33867 This accepts SMTP messages from local processes without doing any other tests.
33868
33869
33870
33871 .section "Outgoing batched SMTP" "SECTbatchSMTP"
33872 .cindex "SMTP" "batched outgoing"
33873 .cindex "batched SMTP output"
33874 Both the &(appendfile)& and &(pipe)& transports can be used for handling
33875 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
33876 be output in BSMTP format. No SMTP responses are possible for this form of
33877 delivery. All it is doing is using SMTP commands as a way of transmitting the
33878 envelope along with the message.
33879
33880 The message is written to the file or pipe preceded by the SMTP commands
33881 MAIL and RCPT, and followed by a line containing a single dot. Lines in
33882 the message that start with a dot have an extra dot added. The SMTP command
33883 HELO is not normally used. If it is required, the &%message_prefix%& option
33884 can be used to specify it.
33885
33886 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
33887 one recipient address at a time by default. However, you can arrange for them
33888 to handle several addresses at once by setting the &%batch_max%& option. When
33889 this is done for BSMTP, messages may contain multiple RCPT commands. See
33890 chapter &<<CHAPbatching>>& for more details.
33891
33892 .vindex "&$host$&"
33893 When one or more addresses are routed to a BSMTP transport by a router that
33894 sets up a host list, the name of the first host on the list is available to the
33895 transport in the variable &$host$&. Here is an example of such a transport and
33896 router:
33897 .code
33898 begin routers
33899 route_append:
33900   driver = manualroute
33901   transport = smtp_appendfile
33902   route_list = domain.example  batch.host.example
33903
33904 begin transports
33905 smtp_appendfile:
33906   driver = appendfile
33907   directory = /var/bsmtp/$host
33908   batch_max = 1000
33909   use_bsmtp
33910   user = exim
33911 .endd
33912 This causes messages addressed to &'domain.example'& to be written in BSMTP
33913 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
33914 message (unless there are more than 1000 recipients).
33915
33916
33917
33918 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
33919 .cindex "SMTP" "batched incoming"
33920 .cindex "batched SMTP input"
33921 The &%-bS%& command line option causes Exim to accept one or more messages by
33922 reading SMTP on the standard input, but to generate no responses. If the caller
33923 is trusted, the senders in the MAIL commands are believed; otherwise the
33924 sender is always the caller of Exim. Unqualified senders and receivers are not
33925 rejected (there seems little point) but instead just get qualified. HELO
33926 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
33927 as NOOP; QUIT quits.
33928
33929 Minimal policy checking is done for BSMTP input. Only the non-SMTP
33930 ACL is run in the same way as for non-SMTP local input.
33931
33932 If an error is detected while reading a message, including a missing &"."& at
33933 the end, Exim gives up immediately. It writes details of the error to the
33934 standard output in a stylized way that the calling program should be able to
33935 make some use of automatically, for example:
33936 .code
33937 554 Unexpected end of file
33938 Transaction started in line 10
33939 Error detected in line 14
33940 .endd
33941 It writes a more verbose version, for human consumption, to the standard error
33942 file, for example:
33943 .code
33944 An error was detected while processing a file of BSMTP input.
33945 The error message was:
33946
33947 501 '>' missing at end of address
33948
33949 The SMTP transaction started in line 10.
33950 The error was detected in line 12.
33951 The SMTP command at fault was:
33952
33953 rcpt to:<malformed@in.com.plete
33954
33955 1 previous message was successfully processed.
33956 The rest of the batch was abandoned.
33957 .endd
33958 The return code from Exim is zero only if there were no errors. It is 1 if some
33959 messages were accepted before an error was detected, and 2 if no messages were
33960 accepted.
33961 .ecindex IIDsmtpproc1
33962 .ecindex IIDsmtpproc2
33963
33964
33965
33966 . ////////////////////////////////////////////////////////////////////////////
33967 . ////////////////////////////////////////////////////////////////////////////
33968
33969 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
33970          "Customizing messages"
33971 When a message fails to be delivered, or remains on the queue for more than a
33972 configured amount of time, Exim sends a message to the original sender, or
33973 to an alternative configured address. The text of these messages is built into
33974 the code of Exim, but it is possible to change it, either by adding a single
33975 string, or by replacing each of the paragraphs by text supplied in a file.
33976
33977 The &'From:'& and &'To:'& header lines are automatically generated; you can
33978 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
33979 option. Exim also adds the line
33980 .code
33981 Auto-Submitted: auto-generated
33982 .endd
33983 to all warning and bounce messages,
33984
33985
33986 .section "Customizing bounce messages" "SECID239"
33987 .cindex "customizing" "bounce message"
33988 .cindex "bounce message" "customizing"
33989 If &%bounce_message_text%& is set, its contents are included in the default
33990 message immediately after &"This message was created automatically by mail
33991 delivery software."& The string is not expanded. It is not used if
33992 &%bounce_message_file%& is set.
33993
33994 When &%bounce_message_file%& is set, it must point to a template file for
33995 constructing error messages. The file consists of a series of text items,
33996 separated by lines consisting of exactly four asterisks. If the file cannot be
33997 opened, default text is used and a message is written to the main and panic
33998 logs. If any text item in the file is empty, default text is used for that
33999 item.
34000
34001 .vindex "&$bounce_recipient$&"
34002 .vindex "&$bounce_return_size_limit$&"
34003 Each item of text that is read from the file is expanded, and there are two
34004 expansion variables which can be of use here: &$bounce_recipient$& is set to
34005 the recipient of an error message while it is being created, and
34006 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34007 option, rounded to a whole number.
34008
34009 The items must appear in the file in the following order:
34010
34011 .ilist
34012 The first item is included in the headers, and should include at least a
34013 &'Subject:'& header. Exim does not check the syntax of these headers.
34014 .next
34015 The second item forms the start of the error message. After it, Exim lists the
34016 failing addresses with their error messages.
34017 .next
34018 The third item is used to introduce any text from pipe transports that is to be
34019 returned to the sender. It is omitted if there is no such text.
34020 .next
34021 .new
34022 The fourth, fifth and sixth items will be ignored and may be empty.
34023 The fields exist for back-compatibility
34024 .wen
34025 .endlist
34026
34027 The default state (&%bounce_message_file%& unset) is equivalent to the
34028 following file, in which the sixth item is empty. The &'Subject:'& and some
34029 other lines have been split in order to fit them on the page:
34030 .code
34031 Subject: Mail delivery failed
34032   ${if eq{$sender_address}{$bounce_recipient}
34033   {: returning message to sender}}
34034 ****
34035 This message was created automatically by mail delivery software.
34036
34037 A message ${if eq{$sender_address}{$bounce_recipient}
34038   {that you sent }{sent by
34039
34040 <$sender_address>
34041
34042 }}could not be delivered to all of its recipients.
34043 This is a permanent error. The following address(es) failed:
34044 ****
34045 The following text was generated during the delivery attempt(s):
34046 ****
34047 ------ This is a copy of the message, including all the headers.
34048   ------
34049 ****
34050 ------ The body of the message is $message_size characters long;
34051   only the first
34052 ------ $bounce_return_size_limit or so are included here.
34053 ****
34054 .endd
34055 .section "Customizing warning messages" "SECTcustwarn"
34056 .cindex "customizing" "warning message"
34057 .cindex "warning of delay" "customizing the message"
34058 The option &%warn_message_file%& can be pointed at a template file for use when
34059 warnings about message delays are created. In this case there are only three
34060 text sections:
34061
34062 .ilist
34063 The first item is included in the headers, and should include at least a
34064 &'Subject:'& header. Exim does not check the syntax of these headers.
34065 .next
34066 The second item forms the start of the warning message. After it, Exim lists
34067 the delayed addresses.
34068 .next
34069 The third item then ends the message.
34070 .endlist
34071
34072 The default state is equivalent to the following file, except that some lines
34073 have been split here, in order to fit them on the page:
34074 .code
34075 Subject: Warning: message $message_exim_id delayed
34076   $warn_message_delay
34077 ****
34078 This message was created automatically by mail delivery software.
34079
34080 A message ${if eq{$sender_address}{$warn_message_recipients}
34081 {that you sent }{sent by
34082
34083 <$sender_address>
34084
34085 }}has not been delivered to all of its recipients after
34086 more than $warn_message_delay on the queue on $primary_hostname.
34087
34088 The message identifier is:     $message_exim_id
34089 The subject of the message is: $h_subject
34090 The date of the message is:    $h_date
34091
34092 The following address(es) have not yet been delivered:
34093 ****
34094 No action is required on your part. Delivery attempts will
34095 continue for some time, and this warning may be repeated at
34096 intervals if the message remains undelivered. Eventually the
34097 mail delivery software will give up, and when that happens,
34098 the message will be returned to you.
34099 .endd
34100 .vindex "&$warn_message_delay$&"
34101 .vindex "&$warn_message_recipients$&"
34102 However, in the default state the subject and date lines are omitted if no
34103 appropriate headers exist. During the expansion of this file,
34104 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34105 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34106 of recipients for the warning message. There may be more than one if there are
34107 multiple addresses with different &%errors_to%& settings on the routers that
34108 handled them.
34109
34110
34111
34112
34113 . ////////////////////////////////////////////////////////////////////////////
34114 . ////////////////////////////////////////////////////////////////////////////
34115
34116 .chapter "Some common configuration settings" "CHAPcomconreq"
34117 This chapter discusses some configuration settings that seem to be fairly
34118 common. More examples and discussion can be found in the Exim book.
34119
34120
34121
34122 .section "Sending mail to a smart host" "SECID240"
34123 .cindex "smart host" "example router"
34124 If you want to send all mail for non-local domains to a &"smart host"&, you
34125 should replace the default &(dnslookup)& router with a router which does the
34126 routing explicitly:
34127 .code
34128 send_to_smart_host:
34129   driver = manualroute
34130   route_list = !+local_domains smart.host.name
34131   transport = remote_smtp
34132 .endd
34133 You can use the smart host's IP address instead of the name if you wish.
34134 If you are using Exim only to submit messages to a smart host, and not for
34135 receiving incoming messages, you can arrange for it to do the submission
34136 synchronously by setting the &%mua_wrapper%& option (see chapter
34137 &<<CHAPnonqueueing>>&).
34138
34139
34140
34141
34142 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34143 .cindex "mailing lists"
34144 Exim can be used to run simple mailing lists, but for large and/or complicated
34145 requirements, the use of additional specialized mailing list software such as
34146 Majordomo or Mailman is recommended.
34147
34148 The &(redirect)& router can be used to handle mailing lists where each list
34149 is maintained in a separate file, which can therefore be managed by an
34150 independent manager. The &%domains%& router option can be used to run these
34151 lists in a separate domain from normal mail. For example:
34152 .code
34153 lists:
34154   driver = redirect
34155   domains = lists.example
34156   file = /usr/lists/$local_part
34157   forbid_pipe
34158   forbid_file
34159   errors_to = $local_part-request@lists.example
34160   no_more
34161 .endd
34162 This router is skipped for domains other than &'lists.example'&. For addresses
34163 in that domain, it looks for a file that matches the local part. If there is no
34164 such file, the router declines, but because &%no_more%& is set, no subsequent
34165 routers are tried, and so the whole delivery fails.
34166
34167 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34168 expanded into a file name or a pipe delivery, which is usually inappropriate in
34169 a mailing list.
34170
34171 .oindex "&%errors_to%&"
34172 The &%errors_to%& option specifies that any delivery errors caused by addresses
34173 taken from a mailing list are to be sent to the given address rather than the
34174 original sender of the message. However, before acting on this, Exim verifies
34175 the error address, and ignores it if verification fails.
34176
34177 For example, using the configuration above, mail sent to
34178 &'dicts@lists.example'& is passed on to those addresses contained in
34179 &_/usr/lists/dicts_&, with error reports directed to
34180 &'dicts-request@lists.example'&, provided that this address can be verified.
34181 There could be a file called &_/usr/lists/dicts-request_& containing
34182 the address(es) of this particular list's manager(s), but other approaches,
34183 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34184 or &%local_part_suffix%& options) to handle addresses of the form
34185 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34186
34187
34188
34189 .section "Syntax errors in mailing lists" "SECID241"
34190 .cindex "mailing lists" "syntax errors in"
34191 If an entry in redirection data contains a syntax error, Exim normally defers
34192 delivery of the original address. That means that a syntax error in a mailing
34193 list holds up all deliveries to the list. This may not be appropriate when a
34194 list is being maintained automatically from data supplied by users, and the
34195 addresses are not rigorously checked.
34196
34197 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34198 entries that fail to parse, noting the incident in the log. If in addition
34199 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34200 whenever a broken address is skipped. It is usually appropriate to set
34201 &%syntax_errors_to%& to the same address as &%errors_to%&.
34202
34203
34204
34205 .section "Re-expansion of mailing lists" "SECID242"
34206 .cindex "mailing lists" "re-expansion of"
34207 Exim remembers every individual address to which a message has been delivered,
34208 in order to avoid duplication, but it normally stores only the original
34209 recipient addresses with a message. If all the deliveries to a mailing list
34210 cannot be done at the first attempt, the mailing list is re-expanded when the
34211 delivery is next tried. This means that alterations to the list are taken into
34212 account at each delivery attempt, so addresses that have been added to
34213 the list since the message arrived will therefore receive a copy of the
34214 message, even though it pre-dates their subscription.
34215
34216 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34217 on the &(redirect)& router. If this is done, any addresses generated by the
34218 router that fail to deliver at the first attempt are added to the message as
34219 &"top level"& addresses, and the parent address that generated them is marked
34220 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34221 subsequent delivery attempts. The disadvantage of this is that if any of the
34222 failing addresses are incorrect, correcting them in the file has no effect on
34223 pre-existing messages.
34224
34225 The original top-level address is remembered with each of the generated
34226 addresses, and is output in any log messages. However, any intermediate parent
34227 addresses are not recorded. This makes a difference to the log only if the
34228 &%all_parents%& selector is set, but for mailing lists there is normally only
34229 one level of expansion anyway.
34230
34231
34232
34233 .section "Closed mailing lists" "SECID243"
34234 .cindex "mailing lists" "closed"
34235 The examples so far have assumed open mailing lists, to which anybody may
34236 send mail. It is also possible to set up closed lists, where mail is accepted
34237 from specified senders only. This is done by making use of the generic
34238 &%senders%& option to restrict the router that handles the list.
34239
34240 The following example uses the same file as a list of recipients and as a list
34241 of permitted senders. It requires three routers:
34242 .code
34243 lists_request:
34244   driver = redirect
34245   domains = lists.example
34246   local_part_suffix = -request
34247   file = /usr/lists/$local_part$local_part_suffix
34248   no_more
34249
34250 lists_post:
34251   driver = redirect
34252   domains = lists.example
34253   senders = ${if exists {/usr/lists/$local_part}\
34254              {lsearch;/usr/lists/$local_part}{*}}
34255   file = /usr/lists/$local_part
34256   forbid_pipe
34257   forbid_file
34258   errors_to = $local_part-request@lists.example
34259   no_more
34260
34261 lists_closed:
34262   driver = redirect
34263   domains = lists.example
34264   allow_fail
34265   data = :fail: $local_part@lists.example is a closed mailing list
34266 .endd
34267 All three routers have the same &%domains%& setting, so for any other domains,
34268 they are all skipped. The first router runs only if the local part ends in
34269 &%-request%&. It handles messages to the list manager(s) by means of an open
34270 mailing list.
34271
34272 The second router runs only if the &%senders%& precondition is satisfied. It
34273 checks for the existence of a list that corresponds to the local part, and then
34274 checks that the sender is on the list by means of a linear search. It is
34275 necessary to check for the existence of the file before trying to search it,
34276 because otherwise Exim thinks there is a configuration error. If the file does
34277 not exist, the expansion of &%senders%& is *, which matches all senders. This
34278 means that the router runs, but because there is no list, declines, and
34279 &%no_more%& ensures that no further routers are run. The address fails with an
34280 &"unrouteable address"& error.
34281
34282 The third router runs only if the second router is skipped, which happens when
34283 a mailing list exists, but the sender is not on it. This router forcibly fails
34284 the address, giving a suitable error message.
34285
34286
34287
34288
34289 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
34290 .cindex "VERP"
34291 .cindex "Variable Envelope Return Paths"
34292 .cindex "envelope sender"
34293 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
34294 are a way of helping mailing list administrators discover which subscription
34295 address is the cause of a particular delivery failure. The idea is to encode
34296 the original recipient address in the outgoing envelope sender address, so that
34297 if the message is forwarded by another host and then subsequently bounces, the
34298 original recipient can be extracted from the recipient address of the bounce.
34299
34300 .oindex &%errors_to%&
34301 .oindex &%return_path%&
34302 Envelope sender addresses can be modified by Exim using two different
34303 facilities: the &%errors_to%& option on a router (as shown in previous mailing
34304 list examples), or the &%return_path%& option on a transport. The second of
34305 these is effective only if the message is successfully delivered to another
34306 host; it is not used for errors detected on the local host (see the description
34307 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
34308 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
34309 .code
34310 verp_smtp:
34311   driver = smtp
34312   max_rcpt = 1
34313   return_path = \
34314     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34315       {$1-request+$local_part=$domain@your.dom.example}fail}
34316 .endd
34317 This has the effect of rewriting the return path (envelope sender) on outgoing
34318 SMTP messages, if the local part of the original return path ends in
34319 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
34320 local part and domain of the recipient into the return path. Suppose, for
34321 example, that a message whose return path has been set to
34322 &'somelist-request@your.dom.example'& is sent to
34323 &'subscriber@other.dom.example'&. In the transport, the return path is
34324 rewritten as
34325 .code
34326 somelist-request+subscriber=other.dom.example@your.dom.example
34327 .endd
34328 .vindex "&$local_part$&"
34329 For this to work, you must tell Exim to send multiple copies of messages that
34330 have more than one recipient, so that each copy has just one recipient. This is
34331 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
34332 might be sent to several different recipients in the same domain, in which case
34333 &$local_part$& is not available in the transport, because it is not unique.
34334
34335 Unless your host is doing nothing but mailing list deliveries, you should
34336 probably use a separate transport for the VERP deliveries, so as not to use
34337 extra resources in making one-per-recipient copies for other deliveries. This
34338 can easily be done by expanding the &%transport%& option in the router:
34339 .code
34340 dnslookup:
34341   driver = dnslookup
34342   domains = ! +local_domains
34343   transport = \
34344     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
34345       {verp_smtp}{remote_smtp}}
34346   no_more
34347 .endd
34348 If you want to change the return path using &%errors_to%& in a router instead
34349 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
34350 routers that handle mailing list addresses. This will ensure that all delivery
34351 errors, including those detected on the local host, are sent to the VERP
34352 address.
34353
34354 On a host that does no local deliveries and has no manual routing, only the
34355 &(dnslookup)& router needs to be changed. A special transport is not needed for
34356 SMTP deliveries. Every mailing list recipient has its own return path value,
34357 and so Exim must hand them to the transport one at a time. Here is an example
34358 of a &(dnslookup)& router that implements VERP:
34359 .code
34360 verp_dnslookup:
34361   driver = dnslookup
34362   domains = ! +local_domains
34363   transport = remote_smtp
34364   errors_to = \
34365     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
34366      {$1-request+$local_part=$domain@your.dom.example}fail}
34367   no_more
34368 .endd
34369 Before you start sending out messages with VERPed return paths, you must also
34370 configure Exim to accept the bounce messages that come back to those paths.
34371 Typically this is done by setting a &%local_part_suffix%& option for a
34372 router, and using this to route the messages to wherever you want to handle
34373 them.
34374
34375 The overhead incurred in using VERP depends very much on the size of the
34376 message, the number of recipient addresses that resolve to the same remote
34377 host, and the speed of the connection over which the message is being sent. If
34378 a lot of addresses resolve to the same host and the connection is slow, sending
34379 a separate copy of the message for each address may take substantially longer
34380 than sending a single copy with many recipients (for which VERP cannot be
34381 used).
34382
34383
34384
34385
34386
34387
34388 .section "Virtual domains" "SECTvirtualdomains"
34389 .cindex "virtual domains"
34390 .cindex "domain" "virtual"
34391 The phrase &'virtual domain'& is unfortunately used with two rather different
34392 meanings:
34393
34394 .ilist
34395 A domain for which there are no real mailboxes; all valid local parts are
34396 aliases for other email addresses. Common examples are organizational
34397 top-level domains and &"vanity"& domains.
34398 .next
34399 One of a number of independent domains that are all handled by the same host,
34400 with mailboxes on that host, but where the mailbox owners do not necessarily
34401 have login accounts on that host.
34402 .endlist
34403
34404 The first usage is probably more common, and does seem more &"virtual"& than
34405 the second. This kind of domain can be handled in Exim with a straightforward
34406 aliasing router. One approach is to create a separate alias file for each
34407 virtual domain. Exim can test for the existence of the alias file to determine
34408 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
34409 to a router of this form:
34410 .code
34411 virtual:
34412   driver = redirect
34413   domains = dsearch;/etc/mail/virtual
34414   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
34415   no_more
34416 .endd
34417 The &%domains%& option specifies that the router is to be skipped, unless there
34418 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
34419 domain that is being processed. When the router runs, it looks up the local
34420 part in the file to find a new address (or list of addresses). The &%no_more%&
34421 setting ensures that if the lookup fails (leading to &%data%& being an empty
34422 string), Exim gives up on the address without trying any subsequent routers.
34423
34424 This one router can handle all the virtual domains because the alias file names
34425 follow a fixed pattern. Permissions can be arranged so that appropriate people
34426 can edit the different alias files. A successful aliasing operation results in
34427 a new envelope recipient address, which is then routed from scratch.
34428
34429 The other kind of &"virtual"& domain can also be handled in a straightforward
34430 way. One approach is to create a file for each domain containing a list of
34431 valid local parts, and use it in a router like this:
34432 .code
34433 my_domains:
34434   driver = accept
34435   domains = dsearch;/etc/mail/domains
34436   local_parts = lsearch;/etc/mail/domains/$domain
34437   transport = my_mailboxes
34438 .endd
34439 The address is accepted if there is a file for the domain, and the local part
34440 can be found in the file. The &%domains%& option is used to check for the
34441 file's existence because &%domains%& is tested before the &%local_parts%&
34442 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
34443 because that option is tested after &%local_parts%&. The transport is as
34444 follows:
34445 .code
34446 my_mailboxes:
34447   driver = appendfile
34448   file = /var/mail/$domain/$local_part
34449   user = mail
34450 .endd
34451 This uses a directory of mailboxes for each domain. The &%user%& setting is
34452 required, to specify which uid is to be used for writing to the mailboxes.
34453
34454 The configuration shown here is just one example of how you might support this
34455 requirement. There are many other ways this kind of configuration can be set
34456 up, for example, by using a database instead of separate files to hold all the
34457 information about the domains.
34458
34459
34460
34461 .section "Multiple user mailboxes" "SECTmulbox"
34462 .cindex "multiple mailboxes"
34463 .cindex "mailbox" "multiple"
34464 .cindex "local part" "prefix"
34465 .cindex "local part" "suffix"
34466 Heavy email users often want to operate with multiple mailboxes, into which
34467 incoming mail is automatically sorted. A popular way of handling this is to
34468 allow users to use multiple sender addresses, so that replies can easily be
34469 identified. Users are permitted to add prefixes or suffixes to their local
34470 parts for this purpose. The wildcard facility of the generic router options
34471 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
34472 example, consider this router:
34473 .code
34474 userforward:
34475   driver = redirect
34476   check_local_user
34477   file = $home/.forward
34478   local_part_suffix = -*
34479   local_part_suffix_optional
34480   allow_filter
34481 .endd
34482 .vindex "&$local_part_suffix$&"
34483 It runs a user's &_.forward_& file for all local parts of the form
34484 &'username-*'&. Within the filter file the user can distinguish different
34485 cases by testing the variable &$local_part_suffix$&. For example:
34486 .code
34487 if $local_part_suffix contains -special then
34488 save /home/$local_part/Mail/special
34489 endif
34490 .endd
34491 If the filter file does not exist, or does not deal with such addresses, they
34492 fall through to subsequent routers, and, assuming no subsequent use of the
34493 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
34494 control over which suffixes are valid.
34495
34496 Alternatively, a suffix can be used to trigger the use of a different
34497 &_.forward_& file &-- which is the way a similar facility is implemented in
34498 another MTA:
34499 .code
34500 userforward:
34501   driver = redirect
34502   check_local_user
34503   file = $home/.forward$local_part_suffix
34504   local_part_suffix = -*
34505   local_part_suffix_optional
34506   allow_filter
34507 .endd
34508 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
34509 example, &_.forward-special_& is used. Once again, if the appropriate file
34510 does not exist, or does not deal with the address, it is passed on to
34511 subsequent routers, which could, if required, look for an unqualified
34512 &_.forward_& file to use as a default.
34513
34514
34515
34516 .section "Simplified vacation processing" "SECID244"
34517 .cindex "vacation processing"
34518 The traditional way of running the &'vacation'& program is for a user to set up
34519 a pipe command in a &_.forward_& file
34520 (see section &<<SECTspecitredli>>& for syntax details).
34521 This is prone to error by inexperienced users. There are two features of Exim
34522 that can be used to make this process simpler for users:
34523
34524 .ilist
34525 A local part prefix such as &"vacation-"& can be specified on a router which
34526 can cause the message to be delivered directly to the &'vacation'& program, or
34527 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
34528 &_.forward_& file are then much simpler. For example:
34529 .code
34530 spqr, vacation-spqr
34531 .endd
34532 .next
34533 The &%require_files%& generic router option can be used to trigger a
34534 vacation delivery by checking for the existence of a certain file in the
34535 user's home directory. The &%unseen%& generic option should also be used, to
34536 ensure that the original delivery also proceeds. In this case, all the user has
34537 to do is to create a file called, say, &_.vacation_&, containing a vacation
34538 message.
34539 .endlist
34540
34541 Another advantage of both these methods is that they both work even when the
34542 use of arbitrary pipes by users is locked out.
34543
34544
34545
34546 .section "Taking copies of mail" "SECID245"
34547 .cindex "message" "copying every"
34548 Some installations have policies that require archive copies of all messages to
34549 be made. A single copy of each message can easily be taken by an appropriate
34550 command in a system filter, which could, for example, use a different file for
34551 each day's messages.
34552
34553 There is also a shadow transport mechanism that can be used to take copies of
34554 messages that are successfully delivered by local transports, one copy per
34555 delivery. This could be used, &'inter alia'&, to implement automatic
34556 notification of delivery by sites that insist on doing such things.
34557
34558
34559
34560 .section "Intermittently connected hosts" "SECID246"
34561 .cindex "intermittently connected hosts"
34562 It has become quite common (because it is cheaper) for hosts to connect to the
34563 Internet periodically rather than remain connected all the time. The normal
34564 arrangement is that mail for such hosts accumulates on a system that is
34565 permanently connected.
34566
34567 Exim was designed for use on permanently connected hosts, and so it is not
34568 particularly well-suited to use in an intermittently connected environment.
34569 Nevertheless there are some features that can be used.
34570
34571
34572 .section "Exim on the upstream server host" "SECID247"
34573 It is tempting to arrange for incoming mail for the intermittently connected
34574 host to remain on Exim's queue until the client connects. However, this
34575 approach does not scale very well. Two different kinds of waiting message are
34576 being mixed up in the same queue &-- those that cannot be delivered because of
34577 some temporary problem, and those that are waiting for their destination host
34578 to connect. This makes it hard to manage the queue, as well as wasting
34579 resources, because each queue runner scans the entire queue.
34580
34581 A better approach is to separate off those messages that are waiting for an
34582 intermittently connected host. This can be done by delivering these messages
34583 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
34584 format, from where they are transmitted by other software when their
34585 destination connects. This makes it easy to collect all the mail for one host
34586 in a single directory, and to apply local timeout rules on a per-message basis
34587 if required.
34588
34589 On a very small scale, leaving the mail on Exim's queue can be made to work. If
34590 you are doing this, you should configure Exim with a long retry period for the
34591 intermittent host. For example:
34592 .code
34593 cheshire.wonderland.fict.example    *   F,5d,24h
34594 .endd
34595 This stops a lot of failed delivery attempts from occurring, but Exim remembers
34596 which messages it has queued up for that host. Once the intermittent host comes
34597 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
34598 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
34599 causes all the queued up messages to be delivered, often down a single SMTP
34600 connection. While the host remains connected, any new messages get delivered
34601 immediately.
34602
34603 If the connecting hosts do not have fixed IP addresses, that is, if a host is
34604 issued with a different IP address each time it connects, Exim's retry
34605 mechanisms on the holding host get confused, because the IP address is normally
34606 used as part of the key string for holding retry information. This can be
34607 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
34608 Since this has disadvantages for permanently connected hosts, it is best to
34609 arrange a separate transport for the intermittently connected ones.
34610
34611
34612
34613 .section "Exim on the intermittently connected client host" "SECID248"
34614 The value of &%smtp_accept_queue_per_connection%& should probably be
34615 increased, or even set to zero (that is, disabled) on the intermittently
34616 connected host, so that all incoming messages down a single connection get
34617 delivered immediately.
34618
34619 .cindex "SMTP" "passed connection"
34620 .cindex "SMTP" "multiple deliveries"
34621 .cindex "multiple SMTP deliveries"
34622 Mail waiting to be sent from an intermittently connected host will probably
34623 not have been routed, because without a connection DNS lookups are not
34624 possible. This means that if a normal queue run is done at connection time,
34625 each message is likely to be sent in a separate SMTP session. This can be
34626 avoided by starting the queue run with a command line option beginning with
34627 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
34628 first pass, routing is done but no deliveries take place. The second pass is a
34629 normal queue run; since all the messages have been previously routed, those
34630 destined for the same host are likely to get sent as multiple deliveries in a
34631 single SMTP connection.
34632
34633
34634
34635 . ////////////////////////////////////////////////////////////////////////////
34636 . ////////////////////////////////////////////////////////////////////////////
34637
34638 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
34639          "Exim as a non-queueing client"
34640 .cindex "client, non-queueing"
34641 .cindex "smart host" "suppressing queueing"
34642 On a personal computer, it is a common requirement for all
34643 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
34644 configured to operate that way, for all the popular operating systems.
34645 However, there are some MUAs for Unix-like systems that cannot be so
34646 configured: they submit messages using the command line interface of
34647 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
34648 messages this way.
34649
34650 If the personal computer runs continuously, there is no problem, because it can
34651 run a conventional MTA that handles delivery to the smart host, and deal with
34652 any delays via its queueing mechanism. However, if the computer does not run
34653 continuously or runs different operating systems at different times, queueing
34654 email is not desirable.
34655
34656 There is therefore a requirement for something that can provide the
34657 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
34658 any queueing or retrying facilities. Furthermore, the delivery to the smart
34659 host should be synchronous, so that if it fails, the sending MUA is immediately
34660 informed. In other words, we want something that extends an MUA that submits
34661 to a local MTA via the command line so that it behaves like one that submits
34662 to a remote smart host using TCP/SMTP.
34663
34664 There are a number of applications (for example, there is one called &'ssmtp'&)
34665 that do this job. However, people have found them to be lacking in various
34666 ways. For instance, you might want to allow aliasing and forwarding to be done
34667 before sending a message to the smart host.
34668
34669 Exim already had the necessary infrastructure for doing this job. Just a few
34670 tweaks were needed to make it behave as required, though it is somewhat of an
34671 overkill to use a fully-featured MTA for this purpose.
34672
34673 .oindex "&%mua_wrapper%&"
34674 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
34675 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
34676 assumes that it is being used to &"wrap"& a command-line MUA in the manner
34677 just described. As well as setting &%mua_wrapper%&, you also need to provide a
34678 compatible router and transport configuration. Typically there will be just one
34679 router and one transport, sending everything to a smart host.
34680
34681 When run in MUA wrapping mode, the behaviour of Exim changes in the
34682 following ways:
34683
34684 .ilist
34685 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
34686 In other words, the only way to submit messages is via the command line.
34687 .next
34688 Each message is synchronously delivered as soon as it is received (&%-odi%& is
34689 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
34690 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
34691 does not finish until the delivery attempt is complete. If the delivery is
34692 successful, a zero return code is given.
34693 .next
34694 Address redirection is permitted, but the final routing for all addresses must
34695 be to the same remote transport, and to the same list of hosts. Furthermore,
34696 the return address (envelope sender) must be the same for all recipients, as
34697 must any added or deleted header lines. In other words, it must be possible to
34698 deliver the message in a single SMTP transaction, however many recipients there
34699 are.
34700 .next
34701 If these conditions are not met, or if routing any address results in a
34702 failure or defer status, or if Exim is unable to deliver all the recipients
34703 successfully to one of the smart hosts, delivery of the entire message fails.
34704 .next
34705 Because no queueing is allowed, all failures are treated as permanent; there
34706 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
34707 smart host. Furthermore, because only a single yes/no response can be given to
34708 the caller, it is not possible to deliver to some recipients and not others. If
34709 there is an error (temporary or permanent) for any recipient, all are failed.
34710 .next
34711 If more than one smart host is listed, Exim will try another host after a
34712 connection failure or a timeout, in the normal way. However, if this kind of
34713 failure happens for all the hosts, the delivery fails.
34714 .next
34715 When delivery fails, an error message is written to the standard error stream
34716 (as well as to Exim's log), and Exim exits to the caller with a return code
34717 value 1. The message is expunged from Exim's spool files. No bounce messages
34718 are ever generated.
34719 .next
34720 No retry data is maintained, and any retry rules are ignored.
34721 .next
34722 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
34723 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
34724 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
34725 .endlist
34726
34727 The overall effect is that Exim makes a single synchronous attempt to deliver
34728 the message, failing if there is any kind of problem. Because no local
34729 deliveries are done and no daemon can be run, Exim does not need root
34730 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
34731 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
34732 the advantages and disadvantages of running without root privilege.
34733
34734
34735
34736
34737 . ////////////////////////////////////////////////////////////////////////////
34738 . ////////////////////////////////////////////////////////////////////////////
34739
34740 .chapter "Log files" "CHAPlog"
34741 .scindex IIDloggen "log" "general description"
34742 .cindex "log" "types of"
34743 Exim writes three different logs, referred to as the main log, the reject log,
34744 and the panic log:
34745
34746 .ilist
34747 .cindex "main log"
34748 The main log records the arrival of each message and each delivery in a single
34749 line in each case. The format is as compact as possible, in an attempt to keep
34750 down the size of log files. Two-character flag sequences make it easy to pick
34751 out these lines. A number of other events are recorded in the main log. Some of
34752 them are optional, in which case the &%log_selector%& option controls whether
34753 they are included or not. A Perl script called &'eximstats'&, which does simple
34754 analysis of main log files, is provided in the Exim distribution (see section
34755 &<<SECTmailstat>>&).
34756 .next
34757 .cindex "reject log"
34758 The reject log records information from messages that are rejected as a result
34759 of a configuration option (that is, for policy reasons).
34760 The first line of each rejection is a copy of the line that is also written to
34761 the main log. Then, if the message's header has been read at the time the log
34762 is written, its contents are written to this log. Only the original header
34763 lines are available; header lines added by ACLs are not logged. You can use the
34764 reject log to check that your policy controls are working correctly; on a busy
34765 host this may be easier than scanning the main log for rejection messages. You
34766 can suppress the writing of the reject log by setting &%write_rejectlog%&
34767 false.
34768 .next
34769 .cindex "panic log"
34770 .cindex "system log"
34771 When certain serious errors occur, Exim writes entries to its panic log. If the
34772 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
34773 are usually written to the main log as well, but can get lost amid the mass of
34774 other entries. The panic log should be empty under normal circumstances. It is
34775 therefore a good idea to check it (or to have a &'cron'& script check it)
34776 regularly, in order to become aware of any problems. When Exim cannot open its
34777 panic log, it tries as a last resort to write to the system log (syslog). This
34778 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
34779 message itself is written at priority LOG_CRIT.
34780 .endlist
34781
34782 Every log line starts with a timestamp, in the format shown in the following
34783 example. Note that many of the examples shown in this chapter are line-wrapped.
34784 In the log file, this would be all on one line:
34785 .code
34786 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
34787   by QUIT
34788 .endd
34789 By default, the timestamps are in the local timezone. There are two
34790 ways of changing this:
34791
34792 .ilist
34793 You can set the &%timezone%& option to a different time zone; in particular, if
34794 you set
34795 .code
34796 timezone = UTC
34797 .endd
34798 the timestamps will be in UTC (aka GMT).
34799 .next
34800 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
34801 example:
34802 .code
34803 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
34804 .endd
34805 .endlist
34806
34807 .cindex "log" "process ids in"
34808 .cindex "pid (process id)" "in log lines"
34809 Exim does not include its process id in log lines by default, but you can
34810 request that it does so by specifying the &`pid`& log selector (see section
34811 &<<SECTlogselector>>&). When this is set, the process id is output, in square
34812 brackets, immediately after the time and date.
34813
34814
34815
34816
34817 .section "Where the logs are written" "SECTwhelogwri"
34818 .cindex "log" "destination"
34819 .cindex "log" "to file"
34820 .cindex "log" "to syslog"
34821 .cindex "syslog"
34822 The logs may be written to local files, or to syslog, or both. However, it
34823 should be noted that many syslog implementations use UDP as a transport, and
34824 are therefore unreliable in the sense that messages are not guaranteed to
34825 arrive at the loghost, nor is the ordering of messages necessarily maintained.
34826 It has also been reported that on large log files (tens of megabytes) you may
34827 need to tweak syslog to prevent it syncing the file with each write &-- on
34828 Linux this has been seen to make syslog take 90% plus of CPU time.
34829
34830 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
34831 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
34832 configuration. This latter string is expanded, so it can contain, for example,
34833 references to the host name:
34834 .code
34835 log_file_path = /var/log/$primary_hostname/exim_%slog
34836 .endd
34837 It is generally advisable, however, to set the string in &_Local/Makefile_&
34838 rather than at run time, because then the setting is available right from the
34839 start of Exim's execution. Otherwise, if there's something it wants to log
34840 before it has read the configuration file (for example, an error in the
34841 configuration file) it will not use the path you want, and may not be able to
34842 log at all.
34843
34844 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
34845 list, currently limited to at most two items. This is one option where the
34846 facility for changing a list separator may not be used. The list must always be
34847 colon-separated. If an item in the list is &"syslog"& then syslog is used;
34848 otherwise the item must either be an absolute path, containing &`%s`& at the
34849 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
34850 implying the use of a default path.
34851
34852 When Exim encounters an empty item in the list, it searches the list defined by
34853 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
34854 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
34855 mean &"use the path specified at build time"&. It no such item exists, log
34856 files are written in the &_log_& subdirectory of the spool directory. This is
34857 equivalent to the setting:
34858 .code
34859 log_file_path = $spool_directory/log/%slog
34860 .endd
34861 If you do not specify anything at build time or run time,
34862 or if you unset the option at run time (i.e. &`log_file_path = `&),
34863 that is where the logs are written.
34864
34865 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
34866 are in use &-- see section &<<SECTdatlogfil>>& below.
34867
34868 Here are some examples of possible settings:
34869 .display
34870 &`LOG_FILE_PATH=syslog                    `& syslog only
34871 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
34872 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
34873 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
34874 .endd
34875 If there are more than two paths in the list, the first is used and a panic
34876 error is logged.
34877
34878
34879
34880 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
34881 .cindex "log" "cycling local files"
34882 .cindex "cycling logs"
34883 .cindex "&'exicyclog'&"
34884 .cindex "log" "local files; writing to"
34885 Some operating systems provide centralized and standardized methods for cycling
34886 log files. For those that do not, a utility script called &'exicyclog'& is
34887 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
34888 main and reject logs each time it is called. The maximum number of old logs to
34889 keep can be set. It is suggested this script is run as a daily &'cron'& job.
34890
34891 An Exim delivery process opens the main log when it first needs to write to it,
34892 and it keeps the file open in case subsequent entries are required &-- for
34893 example, if a number of different deliveries are being done for the same
34894 message. However, remote SMTP deliveries can take a long time, and this means
34895 that the file may be kept open long after it is renamed if &'exicyclog'& or
34896 something similar is being used to rename log files on a regular basis. To
34897 ensure that a switch of log files is noticed as soon as possible, Exim calls
34898 &[stat()]& on the main log's name before reusing an open file, and if the file
34899 does not exist, or its inode has changed, the old file is closed and Exim
34900 tries to open the main log from scratch. Thus, an old log file may remain open
34901 for quite some time, but no Exim processes should write to it once it has been
34902 renamed.
34903
34904
34905
34906 .section "Datestamped log files" "SECTdatlogfil"
34907 .cindex "log" "datestamped files"
34908 Instead of cycling the main and reject log files by renaming them
34909 periodically, some sites like to use files whose names contain a datestamp,
34910 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
34911 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
34912 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
34913 point where the datestamp is required. For example:
34914 .code
34915 log_file_path = /var/spool/exim/log/%slog-%D
34916 log_file_path = /var/log/exim-%s-%D.log
34917 log_file_path = /var/spool/exim/log/%D-%slog
34918 log_file_path = /var/log/exim/%s.%M
34919 .endd
34920 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
34921 examples of names generated by the above examples:
34922 .code
34923 /var/spool/exim/log/mainlog-20021225
34924 /var/log/exim-reject-20021225.log
34925 /var/spool/exim/log/20021225-mainlog
34926 /var/log/exim/main.200212
34927 .endd
34928 When this form of log file is specified, Exim automatically switches to new
34929 files at midnight. It does not make any attempt to compress old logs; you
34930 will need to write your own script if you require this. You should not
34931 run &'exicyclog'& with this form of logging.
34932
34933 The location of the panic log is also determined by &%log_file_path%&, but it
34934 is not datestamped, because rotation of the panic log does not make sense.
34935 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
34936 the string. In addition, if it immediately follows a slash, a following
34937 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
34938 character is removed. Thus, the four examples above would give these panic
34939 log names:
34940 .code
34941 /var/spool/exim/log/paniclog
34942 /var/log/exim-panic.log
34943 /var/spool/exim/log/paniclog
34944 /var/log/exim/panic
34945 .endd
34946
34947
34948 .section "Logging to syslog" "SECID249"
34949 .cindex "log" "syslog; writing to"
34950 The use of syslog does not change what Exim logs or the format of its messages,
34951 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
34952 Exim's log lines are omitted when these lines are sent to syslog. Apart from
34953 that, the same strings are written to syslog as to log files. The syslog
34954 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
34955 by default, but you can change these by setting the &%syslog_facility%& and
34956 &%syslog_processname%& options, respectively. If Exim was compiled with
34957 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
34958 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
34959 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
34960 the time and host name to each line.
34961 The three log streams are mapped onto syslog priorities as follows:
34962
34963 .ilist
34964 &'mainlog'& is mapped to LOG_INFO
34965 .next
34966 &'rejectlog'& is mapped to LOG_NOTICE
34967 .next
34968 &'paniclog'& is mapped to LOG_ALERT
34969 .endlist
34970
34971 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
34972 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
34973 these are routed by syslog to the same place. You can suppress this duplication
34974 by setting &%syslog_duplication%& false.
34975
34976 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
34977 entries contain multiple lines when headers are included. To cope with both
34978 these cases, entries written to syslog are split into separate &[syslog()]&
34979 calls at each internal newline, and also after a maximum of
34980 870 data characters. (This allows for a total syslog line length of 1024, when
34981 additions such as timestamps are added.) If you are running a syslog
34982 replacement that can handle lines longer than the 1024 characters allowed by
34983 RFC 3164, you should set
34984 .code
34985 SYSLOG_LONG_LINES=yes
34986 .endd
34987 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
34988 lines, but it still splits at internal newlines in &'reject'& log entries.
34989
34990 To make it easy to re-assemble split lines later, each component of a split
34991 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
34992 where <&'n'&> is the component number and <&'m'&> is the total number of
34993 components in the entry. The / delimiter is used when the line was split
34994 because it was too long; if it was split because of an internal newline, the \
34995 delimiter is used. For example, supposing the length limit to be 50 instead of
34996 870, the following would be the result of a typical rejection message to
34997 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
34998 name, and pid as added by syslog:
34999 .code
35000 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35001 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35002 [3/5]  when scanning for sender: missing or malformed lo
35003 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35004 [5/5] mple>)
35005 .endd
35006 The same error might cause the following lines to be written to &"rejectlog"&
35007 (LOG_NOTICE):
35008 .code
35009 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35010 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35011 [3/18] er when scanning for sender: missing or malformed
35012 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35013 [5\18] .example>)
35014 [6\18] Recipients: ph10@some.domain.cam.example
35015 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35016 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35017 [9\18]        id 16RdAL-0006pc-00
35018 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35019 [11\18] 09:43 +0100
35020 [12\18] F From: <>
35021 [13\18]   Subject: this is a test header
35022 [18\18]   X-something: this is another header
35023 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35024 [16\18] le>
35025 [17\18] B Bcc:
35026 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35027 .endd
35028 Log lines that are neither too long nor contain newlines are written to syslog
35029 without modification.
35030
35031 If only syslog is being used, the Exim monitor is unable to provide a log tail
35032 display, unless syslog is routing &'mainlog'& to a file on the local host and
35033 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35034 where it is.
35035
35036
35037
35038 .section "Log line flags" "SECID250"
35039 One line is written to the main log for each message received, and for each
35040 successful, unsuccessful, and delayed delivery. These lines can readily be
35041 picked out by the distinctive two-character flags that immediately follow the
35042 timestamp. The flags are:
35043 .display
35044 &`<=`&     message arrival
35045 &`=>`&     normal message delivery
35046 &`->`&     additional address in same delivery
35047 &`>>`&     cutthrough message delivery
35048 &`*>`&     delivery suppressed by &%-N%&
35049 &`**`&     delivery failed; address bounced
35050 &`==`&     delivery deferred; temporary problem
35051 .endd
35052
35053
35054 .section "Logging message reception" "SECID251"
35055 .cindex "log" "reception line"
35056 The format of the single-line entry in the main log that is written for every
35057 message received is shown in the basic example below, which is split over
35058 several lines in order to fit it on the page:
35059 .code
35060 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35061   H=mailer.fict.example [192.168.123.123] U=exim
35062   P=smtp S=5678 id=<incoming message id>
35063 .endd
35064 The address immediately following &"<="& is the envelope sender address. A
35065 bounce message is shown with the sender address &"<>"&, and if it is locally
35066 generated, this is followed by an item of the form
35067 .code
35068 R=<message id>
35069 .endd
35070 which is a reference to the message that caused the bounce to be sent.
35071
35072 .cindex "HELO"
35073 .cindex "EHLO"
35074 For messages from other hosts, the H and U fields identify the remote host and
35075 record the RFC 1413 identity of the user that sent the message, if one was
35076 received. The number given in square brackets is the IP address of the sending
35077 host. If there is a single, unparenthesized  host name in the H field, as
35078 above, it has been verified to correspond to the IP address (see the
35079 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35080 by the remote host in the SMTP HELO or EHLO command, and has not been
35081 verified. If verification yields a different name to that given for HELO or
35082 EHLO, the verified name appears first, followed by the HELO or EHLO
35083 name in parentheses.
35084
35085 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35086 without brackets, in the HELO or EHLO command, leading to entries in
35087 the log containing text like these examples:
35088 .code
35089 H=(10.21.32.43) [192.168.8.34]
35090 H=([10.21.32.43]) [192.168.8.34]
35091 .endd
35092 This can be confusing. Only the final address in square brackets can be relied
35093 on.
35094
35095 For locally generated messages (that is, messages not received over TCP/IP),
35096 the H field is omitted, and the U field contains the login name of the caller
35097 of Exim.
35098
35099 .cindex "authentication" "logging"
35100 .cindex "AUTH" "logging"
35101 For all messages, the P field specifies the protocol used to receive the
35102 message. This is the value that is stored in &$received_protocol$&. In the case
35103 of incoming SMTP messages, the value indicates whether or not any SMTP
35104 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35105 session was encrypted, there is an additional X field that records the cipher
35106 suite that was used.
35107
35108 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35109 hosts that have authenticated themselves using the SMTP AUTH command. The first
35110 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35111 there is an additional item A= followed by the name of the authenticator that
35112 was used. If an authenticated identification was set up by the authenticator's
35113 &%server_set_id%& option, this is logged too, separated by a colon from the
35114 authenticator name.
35115
35116 .cindex "size" "of message"
35117 The id field records the existing message id, if present. The size of the
35118 received message is given by the S field. When the message is delivered,
35119 headers may be removed or added, so that the size of delivered copies of the
35120 message may not correspond with this value (and indeed may be different to each
35121 other).
35122
35123 The &%log_selector%& option can be used to request the logging of additional
35124 data when a message is received. See section &<<SECTlogselector>>& below.
35125
35126
35127
35128 .section "Logging deliveries" "SECID252"
35129 .cindex "log" "delivery line"
35130 The format of the single-line entry in the main log that is written for every
35131 delivery is shown in one of the examples below, for local and remote
35132 deliveries, respectively. Each example has been split into two lines in order
35133 to fit it on the page:
35134 .code
35135 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35136   <marv@hitch.fict.example> R=localuser T=local_delivery
35137 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35138   monk@holistic.fict.example R=dnslookup T=remote_smtp
35139   H=holistic.fict.example [192.168.234.234]
35140 .endd
35141 For ordinary local deliveries, the original address is given in angle brackets
35142 after the final delivery address, which might be a pipe or a file. If
35143 intermediate address(es) exist between the original and the final address, the
35144 last of these is given in parentheses after the final address. The R and T
35145 fields record the router and transport that were used to process the address.
35146
35147 If SMTP AUTH was used for the delivery there is an additional item A=
35148 followed by the name of the authenticator that was used.
35149 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35150 option, this is logged too, separated by a colon from the authenticator name.
35151
35152 If a shadow transport was run after a successful local delivery, the log line
35153 for the successful delivery has an item added on the end, of the form
35154 .display
35155 &`ST=<`&&'shadow transport name'&&`>`&
35156 .endd
35157 If the shadow transport did not succeed, the error message is put in
35158 parentheses afterwards.
35159
35160 .cindex "asterisk" "after IP address"
35161 When more than one address is included in a single delivery (for example, two
35162 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35163 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35164 down a single SMTP connection, an asterisk follows the IP address in the log
35165 lines for the second and subsequent messages.
35166
35167 .cindex "delivery" "cutthrough; logging"
35168 .cindex "cutthrough" "logging"
35169 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35170 line precedes the reception line, since cutthrough waits for a possible
35171 rejection from the destination in case it can reject the sourced item.
35172
35173 The generation of a reply message by a filter file gets logged as a
35174 &"delivery"& to the addressee, preceded by &">"&.
35175
35176 The &%log_selector%& option can be used to request the logging of additional
35177 data when a message is delivered. See section &<<SECTlogselector>>& below.
35178
35179
35180 .section "Discarded deliveries" "SECID253"
35181 .cindex "discarded messages"
35182 .cindex "message" "discarded"
35183 .cindex "delivery" "discarded; logging"
35184 When a message is discarded as a result of the command &"seen finish"& being
35185 obeyed in a filter file which generates no deliveries, a log entry of the form
35186 .code
35187 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35188   <low.club@bridge.example> R=userforward
35189 .endd
35190 is written, to record why no deliveries are logged. When a message is discarded
35191 because it is aliased to &":blackhole:"& the log line is like this:
35192 .code
35193 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35194   <hole@nowhere.example> R=blackhole_router
35195 .endd
35196
35197
35198 .section "Deferred deliveries" "SECID254"
35199 When a delivery is deferred, a line of the following form is logged:
35200 .code
35201 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35202   R=dnslookup T=smtp defer (146): Connection refused
35203 .endd
35204 In the case of remote deliveries, the error is the one that was given for the
35205 last IP address that was tried. Details of individual SMTP failures are also
35206 written to the log, so the above line would be preceded by something like
35207 .code
35208 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35209   mail1.endrest.example [192.168.239.239]: Connection refused
35210 .endd
35211 When a deferred address is skipped because its retry time has not been reached,
35212 a message is written to the log, but this can be suppressed by setting an
35213 appropriate value in &%log_selector%&.
35214
35215
35216
35217 .section "Delivery failures" "SECID255"
35218 .cindex "delivery" "failure; logging"
35219 If a delivery fails because an address cannot be routed, a line of the
35220 following form is logged:
35221 .code
35222 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35223   <jim@trek99.example>: unknown mail domain
35224 .endd
35225 If a delivery fails at transport time, the router and transport are shown, and
35226 the response from the remote host is included, as in this example:
35227 .code
35228 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35229   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35230   after pipelined RCPT TO:<ace400@pb.example>: host
35231   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35232   <ace400@pb.example>...Addressee unknown
35233 .endd
35234 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35235 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35236 disabling PIPELINING. The log lines for all forms of delivery failure are
35237 flagged with &`**`&.
35238
35239
35240
35241 .section "Fake deliveries" "SECID256"
35242 .cindex "delivery" "fake; logging"
35243 If a delivery does not actually take place because the &%-N%& option has been
35244 used to suppress it, a normal delivery line is written to the log, except that
35245 &"=>"& is replaced by &"*>"&.
35246
35247
35248
35249 .section "Completion" "SECID257"
35250 A line of the form
35251 .code
35252 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35253 .endd
35254 is written to the main log when a message is about to be removed from the spool
35255 at the end of its processing.
35256
35257
35258
35259
35260 .section "Summary of Fields in Log Lines" "SECID258"
35261 .cindex "log" "summary of fields"
35262 A summary of the field identifiers that are used in log lines is shown in
35263 the following table:
35264 .display
35265 &`A   `&        authenticator name (and optional id and sender)
35266 &`C   `&        SMTP confirmation on delivery
35267 &`    `&        command list for &"no mail in SMTP session"&
35268 &`CV  `&        certificate verification status
35269 &`D   `&        duration of &"no mail in SMTP session"&
35270 &`DN  `&        distinguished name from peer certificate
35271 &`DT  `&        on &`=>`& lines: time taken for a delivery
35272 &`F   `&        sender address (on delivery lines)
35273 &`H   `&        host name and IP address
35274 &`I   `&        local interface used
35275 &`id  `&        message id for incoming message
35276 &`P   `&        on &`<=`& lines: protocol used
35277 &`    `&        on &`=>`& and &`**`& lines: return path
35278 &`QT  `&        on &`=>`& lines: time spent on queue so far
35279 &`    `&        on &"Completed"& lines: time spent on queue
35280 &`R   `&        on &`<=`& lines: reference for local bounce
35281 &`    `&        on &`=>`&  &`**`& and &`==`& lines: router name
35282 &`S   `&        size of message
35283 &`SNI `&        server name indication from TLS client hello
35284 &`ST  `&        shadow transport name
35285 &`T   `&        on &`<=`& lines: message subject (topic)
35286 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
35287 &`U   `&        local user or RFC 1413 identity
35288 &`X   `&        TLS cipher suite
35289 .endd
35290
35291
35292 .section "Other log entries" "SECID259"
35293 Various other types of log entry are written from time to time. Most should be
35294 self-explanatory. Among the more common are:
35295
35296 .ilist
35297 .cindex "retry" "time not reached"
35298 &'retry time not reached'&&~&~An address previously suffered a temporary error
35299 during routing or local delivery, and the time to retry has not yet arrived.
35300 This message is not written to an individual message log file unless it happens
35301 during the first delivery attempt.
35302 .next
35303 &'retry time not reached for any host'&&~&~An address previously suffered
35304 temporary errors during remote delivery, and the retry time has not yet arrived
35305 for any of the hosts to which it is routed.
35306 .next
35307 .cindex "spool directory" "file locked"
35308 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
35309 some other Exim process is already working on the message. This can be quite
35310 common if queue running processes are started at frequent intervals. The
35311 &'exiwhat'& utility script can be used to find out what Exim processes are
35312 doing.
35313 .next
35314 .cindex "error" "ignored"
35315 &'error ignored'&&~&~There are several circumstances that give rise to this
35316 message:
35317 .olist
35318 Exim failed to deliver a bounce message whose age was greater than
35319 &%ignore_bounce_errors_after%&. The bounce was discarded.
35320 .next
35321 A filter file set up a delivery using the &"noerror"& option, and the delivery
35322 failed. The delivery was discarded.
35323 .next
35324 A delivery set up by a router configured with
35325 . ==== As this is a nested list, any displays it contains must be indented
35326 . ==== as otherwise they are too far to the left.
35327 .code
35328     errors_to = <>
35329 .endd
35330 failed. The delivery was discarded.
35331 .endlist olist
35332 .endlist ilist
35333
35334
35335
35336
35337
35338 .section "Reducing or increasing what is logged" "SECTlogselector"
35339 .cindex "log" "selectors"
35340 By setting the &%log_selector%& global option, you can disable some of Exim's
35341 default logging, or you can request additional logging. The value of
35342 &%log_selector%& is made up of names preceded by plus or minus characters. For
35343 example:
35344 .code
35345 log_selector = +arguments -retry_defer
35346 .endd
35347 The list of optional log items is in the following table, with the default
35348 selection marked by asterisks:
35349 .display
35350 &` 8bitmime                   `&  received 8BITMIME status
35351 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
35352 &` address_rewrite            `&  address rewriting
35353 &` all_parents                `&  all parents in => lines
35354 &` arguments                  `&  command line arguments
35355 &`*connection_reject          `&  connection rejections
35356 &`*delay_delivery             `&  immediate delivery delayed
35357 &` deliver_time               `&  time taken to perform delivery
35358 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
35359 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
35360 &`*etrn                       `&  ETRN commands
35361 &`*host_lookup_failed         `&  as it says
35362 &` ident_timeout              `&  timeout for ident connection
35363 &` incoming_interface         `&  local interface on <= and => lines
35364 &` incoming_port              `&  remote port on <= lines
35365 &`*lost_incoming_connection   `&  as it says (includes timeouts)
35366 &` outgoing_port              `&  add remote port to => lines
35367 &`*queue_run                  `&  start and end queue runs
35368 &` queue_time                 `&  time on queue for one recipient
35369 &` queue_time_overall         `&  time on queue for whole message
35370 &` pid                        `&  Exim process id
35371 &` received_recipients        `&  recipients on <= lines
35372 &` received_sender            `&  sender on <= lines
35373 &`*rejected_header            `&  header contents on reject log
35374 &`*retry_defer                `&  &"retry time not reached"&
35375 &` return_path_on_delivery    `&  put return path on => and ** lines
35376 &` sender_on_delivery         `&  add sender to => lines
35377 &`*sender_verify_fail         `&  sender verification failures
35378 &`*size_reject                `&  rejection because too big
35379 &`*skip_delivery              `&  delivery skipped in a queue run
35380 &`*smtp_confirmation          `&  SMTP confirmation on => lines
35381 &` smtp_connection            `&  SMTP connections
35382 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
35383 &` smtp_mailauth              `&  AUTH argument to MAIL commands
35384 &` smtp_no_mail               `&  session with no MAIL commands
35385 &` smtp_protocol_error        `&  SMTP protocol errors
35386 &` smtp_syntax_error          `&  SMTP syntax errors
35387 &` subject                    `&  contents of &'Subject:'& on <= lines
35388 .new
35389 &`*tls_certificate_verified   `&  certificate verification status
35390 .wen
35391 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
35392 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
35393 &` tls_sni                    `&  TLS SNI on <= lines
35394 &` unknown_in_list            `&  DNS lookup failed in list match
35395
35396 &` all                        `&  all of the above
35397 .endd
35398 More details on each of these items follows:
35399
35400 .ilist
35401 .cindex "8BITMIME"
35402 .cindex "log" "8BITMIME"
35403 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
35404 which may help in tracking down interoperability issues with ancient MTAs
35405 that are not 8bit clean.  This is added to the &"<="& line, tagged with
35406 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
35407 &`7BIT`& and &`8BITMIME`& respectively.
35408 .next
35409 .cindex "&%warn%& ACL verb" "log when skipping"
35410 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
35411 its conditions cannot be evaluated, a log line to this effect is written if
35412 this log selector is set.
35413 .next
35414 .cindex "log" "rewriting"
35415 .cindex "rewriting" "logging"
35416 &%address_rewrite%&: This applies both to global rewrites and per-transport
35417 rewrites, but not to rewrites in filters run as an unprivileged user (because
35418 such users cannot access the log).
35419 .next
35420 .cindex "log" "full parentage"
35421 &%all_parents%&: Normally only the original and final addresses are logged on
35422 delivery lines; with this selector, intermediate parents are given in
35423 parentheses between them.
35424 .next
35425 .cindex "log" "Exim arguments"
35426 .cindex "Exim arguments, logging"
35427 &%arguments%&: This causes Exim to write the arguments with which it was called
35428 to the main log, preceded by the current working directory. This is a debugging
35429 feature, added to make it easier to find out how certain MUAs call
35430 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
35431 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
35432 that are empty or that contain white space are quoted. Non-printing characters
35433 are shown as escape sequences. This facility cannot log unrecognized arguments,
35434 because the arguments are checked before the configuration file is read. The
35435 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
35436 between the caller and Exim.
35437 .next
35438 .cindex "log" "connection rejections"
35439 &%connection_reject%&: A log entry is written whenever an incoming SMTP
35440 connection is rejected, for whatever reason.
35441 .next
35442 .cindex "log" "delayed delivery"
35443 .cindex "delayed delivery, logging"
35444 &%delay_delivery%&: A log entry is written whenever a delivery process is not
35445 started for an incoming message because the load is too high or too many
35446 messages were received on one connection. Logging does not occur if no delivery
35447 process is started because &%queue_only%& is set or &%-odq%& was used.
35448 .next
35449 .cindex "log" "delivery duration"
35450 &%deliver_time%&: For each delivery, the amount of real time it has taken to
35451 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
35452 .next
35453 .cindex "log" "message size on delivery"
35454 .cindex "size" "of message"
35455 &%delivery_size%&: For each delivery, the size of message delivered is added to
35456 the &"=>"& line, tagged with S=.
35457 .next
35458 .cindex "log" "dnslist defer"
35459 .cindex "DNS list" "logging defer"
35460 .cindex "black list (DNS)"
35461 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
35462 DNS black list suffers a temporary error.
35463 .next
35464 .cindex "log" "ETRN commands"
35465 .cindex "ETRN" "logging"
35466 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
35467 is run to determine whether or not it is actually accepted. An invalid ETRN
35468 command, or one received within a message transaction is not logged by this
35469 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
35470 .next
35471 .cindex "log" "host lookup failure"
35472 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
35473 any addresses, or when a lookup of an IP address fails to find a host name, a
35474 log line is written. This logging does not apply to direct DNS lookups when
35475 routing email addresses, but it does apply to &"byname"& lookups.
35476 .next
35477 .cindex "log" "ident timeout"
35478 .cindex "RFC 1413" "logging timeout"
35479 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
35480 client's ident port times out.
35481 .next
35482 .cindex "log" "incoming interface"
35483 .cindex "log" "local interface"
35484 .cindex "log" "local address and port"
35485 .cindex "TCP/IP" "logging local address and port"
35486 .cindex "interface" "logging"
35487 &%incoming_interface%&: The interface on which a message was received is added
35488 to the &"<="& line as an IP address in square brackets, tagged by I= and
35489 followed by a colon and the port number. The local interface and port are also
35490 added to other SMTP log lines, for example &"SMTP connection from"& and to
35491 rejection lines
35492 and (despite the name) the local interface is added to &"=>"& lines..
35493 .next
35494 .cindex "log" "incoming remote port"
35495 .cindex "port" "logging remote"
35496 .cindex "TCP/IP" "logging incoming remote port"
35497 .vindex "&$sender_fullhost$&"
35498 .vindex "&$sender_rcvhost$&"
35499 &%incoming_port%&: The remote port number from which a message was received is
35500 added to log entries and &'Received:'& header lines, following the IP address
35501 in square brackets, and separated from it by a colon. This is implemented by
35502 changing the value that is put in the &$sender_fullhost$& and
35503 &$sender_rcvhost$& variables. Recording the remote port number has become more
35504 important with the widening use of NAT (see RFC 2505).
35505 .next
35506 .cindex "log" "dropped connection"
35507 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
35508 connection is unexpectedly dropped.
35509 .next
35510 .cindex "log" "outgoing remote port"
35511 .cindex "port" "logging outgoint remote"
35512 .cindex "TCP/IP" "logging ougtoing remote port"
35513 &%outgoing_port%&: The remote port number is added to delivery log lines (those
35514 containing => tags) following the IP address. This option is not included in
35515 the default setting, because for most ordinary configurations, the remote port
35516 number is always 25 (the SMTP port).
35517 .next
35518 .cindex "log" "process ids in"
35519 .cindex "pid (process id)" "in log lines"
35520 &%pid%&: The current process id is added to every log line, in square brackets,
35521 immediately after the time and date.
35522 .next
35523 .cindex "log" "queue run"
35524 .cindex "queue runner" "logging"
35525 &%queue_run%&: The start and end of every queue run are logged.
35526 .next
35527 .cindex "log" "queue time"
35528 &%queue_time%&: The amount of time the message has been in the queue on the
35529 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
35530 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
35531 includes reception time as well as the delivery time for the current address.
35532 This means that it may be longer than the difference between the arrival and
35533 delivery log line times, because the arrival log line is not written until the
35534 message has been successfully received.
35535 .next
35536 &%queue_time_overall%&: The amount of time the message has been in the queue on
35537 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
35538 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
35539 message, so it includes reception time as well as the total delivery time.
35540 .next
35541 .cindex "log" "recipients"
35542 &%received_recipients%&: The recipients of a message are listed in the main log
35543 as soon as the message is received. The list appears at the end of the log line
35544 that is written when a message is received, preceded by the word &"for"&. The
35545 addresses are listed after they have been qualified, but before any rewriting
35546 has taken place.
35547 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
35548 in the list.
35549 .next
35550 .cindex "log" "sender reception"
35551 &%received_sender%&: The unrewritten original sender of a message is added to
35552 the end of the log line that records the message's arrival, after the word
35553 &"from"& (before the recipients if &%received_recipients%& is also set).
35554 .next
35555 .cindex "log" "header lines for rejection"
35556 &%rejected_header%&: If a message's header has been received at the time a
35557 rejection is written to the reject log, the complete header is added to the
35558 log. Header logging can be turned off individually for messages that are
35559 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
35560 .next
35561 .cindex "log" "retry defer"
35562 &%retry_defer%&: A log line is written if a delivery is deferred because a
35563 retry time has not yet been reached. However, this &"retry time not reached"&
35564 message is always omitted from individual message logs after the first delivery
35565 attempt.
35566 .next
35567 .cindex "log" "return path"
35568 &%return_path_on_delivery%&: The return path that is being transmitted with
35569 the message is included in delivery and bounce lines, using the tag P=.
35570 This is omitted if no delivery actually happens, for example, if routing fails,
35571 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
35572 .next
35573 .cindex "log" "sender on delivery"
35574 &%sender_on_delivery%&: The message's sender address is added to every delivery
35575 and bounce line, tagged by F= (for &"from"&).
35576 This is the original sender that was received with the message; it is not
35577 necessarily the same as the outgoing return path.
35578 .next
35579 .cindex "log" "sender verify failure"
35580 &%sender_verify_fail%&: If this selector is unset, the separate log line that
35581 gives details of a sender verification failure is not written. Log lines for
35582 the rejection of SMTP commands contain just &"sender verify failed"&, so some
35583 detail is lost.
35584 .next
35585 .cindex "log" "size rejection"
35586 &%size_reject%&: A log line is written whenever a message is rejected because
35587 it is too big.
35588 .next
35589 .cindex "log" "frozen messages; skipped"
35590 .cindex "frozen messages" "logging skipping"
35591 &%skip_delivery%&: A log line is written whenever a message is skipped during a
35592 queue run because it is frozen or because another process is already delivering
35593 it.
35594 .cindex "&""spool file is locked""&"
35595 The message that is written is &"spool file is locked"&.
35596 .next
35597 .cindex "log" "smtp confirmation"
35598 .cindex "SMTP" "logging confirmation"
35599 .cindex "LMTP" "logging confirmation"
35600 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
35601 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
35602 A number of MTAs (including Exim) return an identifying string in this
35603 response.
35604 .next
35605 .cindex "log" "SMTP connections"
35606 .cindex "SMTP" "logging connections"
35607 &%smtp_connection%&: A log line is written whenever an SMTP connection is
35608 established or closed, unless the connection is from a host that matches
35609 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
35610 only when the closure is unexpected.) This applies to connections from local
35611 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
35612 dropped in the middle of a message, a log line is always written, whether or
35613 not this selector is set, but otherwise nothing is written at the start and end
35614 of connections unless this selector is enabled.
35615
35616 For TCP/IP connections to an Exim daemon, the current number of connections is
35617 included in the log message for each new connection, but note that the count is
35618 reset if the daemon is restarted.
35619 Also, because connections are closed (and the closure is logged) in
35620 subprocesses, the count may not include connections that have been closed but
35621 whose termination the daemon has not yet noticed. Thus, while it is possible to
35622 match up the opening and closing of connections in the log, the value of the
35623 logged counts may not be entirely accurate.
35624 .next
35625 .cindex "log" "SMTP transaction; incomplete"
35626 .cindex "SMTP" "logging incomplete transactions"
35627 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
35628 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
35629 and the message sender plus any accepted recipients are included in the log
35630 line. This can provide evidence of dictionary attacks.
35631 .next
35632 .cindex "log" "non-MAIL SMTP sessions"
35633 .cindex "MAIL" "logging session without"
35634 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
35635 connection terminates without having issued a MAIL command. This includes both
35636 the case when the connection is dropped, and the case when QUIT is used. It
35637 does not include cases where the connection is rejected right at the start (by
35638 an ACL, or because there are too many connections, or whatever). These cases
35639 already have their own log lines.
35640
35641 The log line that is written contains the identity of the client in the usual
35642 way, followed by D= and a time, which records the duration of the connection.
35643 If the connection was authenticated, this fact is logged exactly as it is for
35644 an incoming message, with an A= item. If the connection was encrypted, CV=,
35645 DN=, and X= items may appear as they do for an incoming message, controlled by
35646 the same logging options.
35647
35648 Finally, if any SMTP commands were issued during the connection, a C= item
35649 is added to the line, listing the commands that were used. For example,
35650 .code
35651 C=EHLO,QUIT
35652 .endd
35653 shows that the client issued QUIT straight after EHLO. If there were fewer
35654 than 20 commands, they are all listed. If there were more than 20 commands,
35655 the last 20 are listed, preceded by &"..."&. However, with the default
35656 setting of 10 for &%smtp_accep_max_nonmail%&, the connection will in any case
35657 have been aborted before 20 non-mail commands are processed.
35658 .next
35659 &%smtp_mailauth%&: A third subfield with the authenticated sender,
35660 colon-separated, is appended to the A= item for a message arrival or delivery
35661 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
35662 was accepted or used.
35663 .next
35664 .cindex "log" "SMTP protocol error"
35665 .cindex "SMTP" "logging protocol error"
35666 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
35667 encountered. Exim does not have perfect detection of all protocol errors
35668 because of transmission delays and the use of pipelining. If PIPELINING has
35669 been advertised to a client, an Exim server assumes that the client will use
35670 it, and therefore it does not count &"expected"& errors (for example, RCPT
35671 received after rejecting MAIL) as protocol errors.
35672 .next
35673 .cindex "SMTP" "logging syntax errors"
35674 .cindex "SMTP" "syntax errors; logging"
35675 .cindex "SMTP" "unknown command; logging"
35676 .cindex "log" "unknown SMTP command"
35677 .cindex "log" "SMTP syntax error"
35678 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
35679 encountered. An unrecognized command is treated as a syntax error. For an
35680 external connection, the host identity is given; for an internal connection
35681 using &%-bs%& the sender identification (normally the calling user) is given.
35682 .next
35683 .cindex "log" "subject"
35684 .cindex "subject, logging"
35685 &%subject%&: The subject of the message is added to the arrival log line,
35686 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
35687 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
35688 specifies whether characters with values greater than 127 should be logged
35689 unchanged, or whether they should be rendered as escape sequences.
35690 .next
35691 .cindex "log" "certificate verification"
35692 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
35693 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
35694 verified, and &`CV=no`& if not.
35695 .next
35696 .cindex "log" "TLS cipher"
35697 .cindex "TLS" "logging cipher"
35698 &%tls_cipher%&: When a message is sent or received over an encrypted
35699 connection, the cipher suite used is added to the log line, preceded by X=.
35700 .next
35701 .cindex "log" "TLS peer DN"
35702 .cindex "TLS" "logging peer DN"
35703 &%tls_peerdn%&: When a message is sent or received over an encrypted
35704 connection, and a certificate is supplied by the remote host, the peer DN is
35705 added to the log line, preceded by DN=.
35706 .next
35707 .cindex "log" "TLS SNI"
35708 .cindex "TLS" "logging SNI"
35709 &%tls_sni%&: When a message is received over an encrypted connection, and
35710 the remote host provided the Server Name Indication extension, the SNI is
35711 added to the log line, preceded by SNI=.
35712 .next
35713 .cindex "log" "DNS failure in list"
35714 &%unknown_in_list%&: This setting causes a log entry to be written when the
35715 result of a list match is failure because a DNS lookup failed.
35716 .endlist
35717
35718
35719 .section "Message log" "SECID260"
35720 .cindex "message" "log file for"
35721 .cindex "log" "message log; description of"
35722 .cindex "&_msglog_& directory"
35723 .oindex "&%preserve_message_logs%&"
35724 In addition to the general log files, Exim writes a log file for each message
35725 that it handles. The names of these per-message logs are the message ids, and
35726 they are kept in the &_msglog_& sub-directory of the spool directory. Each
35727 message log contains copies of the log lines that apply to the message. This
35728 makes it easier to inspect the status of an individual message without having
35729 to search the main log. A message log is deleted when processing of the message
35730 is complete, unless &%preserve_message_logs%& is set, but this should be used
35731 only with great care because they can fill up your disk very quickly.
35732
35733 On a heavily loaded system, it may be desirable to disable the use of
35734 per-message logs, in order to reduce disk I/O. This can be done by setting the
35735 &%message_logs%& option false.
35736 .ecindex IIDloggen
35737
35738
35739
35740
35741 . ////////////////////////////////////////////////////////////////////////////
35742 . ////////////////////////////////////////////////////////////////////////////
35743
35744 .chapter "Exim utilities" "CHAPutils"
35745 .scindex IIDutils "utilities"
35746 A number of utility scripts and programs are supplied with Exim and are
35747 described in this chapter. There is also the Exim Monitor, which is covered in
35748 the next chapter. The utilities described here are:
35749
35750 .itable none 0 0 3  7* left  15* left  40* left
35751 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
35752   "list what Exim processes are doing"
35753 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
35754 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
35755 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
35756 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
35757                                                 various criteria"
35758 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
35759 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
35760   "extract statistics from the log"
35761 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
35762   "check address acceptance from given IP"
35763 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
35764 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
35765 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
35766 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
35767 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
35768 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
35769 .endtable
35770
35771 Another utility that might be of use to sites with many MTAs is Tom Kistner's
35772 &'exilog'&. It provides log visualizations across multiple Exim servers. See
35773 &url(http://duncanthrax.net/exilog/) for details.
35774
35775
35776
35777
35778 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
35779 .cindex "&'exiwhat'&"
35780 .cindex "process, querying"
35781 .cindex "SIGUSR1"
35782 On operating systems that can restart a system call after receiving a signal
35783 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
35784 a line describing what it is doing to the file &_exim-process.info_& in the
35785 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
35786 processes it can find, having first emptied the file. It then waits for one
35787 second to allow the Exim processes to react before displaying the results. In
35788 order to run &'exiwhat'& successfully you have to have sufficient privilege to
35789 send the signal to the Exim processes, so it is normally run as root.
35790
35791 &*Warning*&: This is not an efficient process. It is intended for occasional
35792 use by system administrators. It is not sensible, for example, to set up a
35793 script that sends SIGUSR1 signals to Exim processes at short intervals.
35794
35795
35796 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
35797 varies in different operating systems. Not only are different options used,
35798 but the format of the output is different. For this reason, there are some
35799 system configuration options that configure exactly how &'exiwhat'& works. If
35800 it doesn't seem to be working for you, check the following compile-time
35801 options:
35802 .display
35803 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
35804 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
35805 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
35806 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
35807 .endd
35808 An example of typical output from &'exiwhat'& is
35809 .code
35810 164 daemon: -q1h, listening on port 25
35811 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
35812 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
35813   [10.19.42.42] (editor@ref.example)
35814 10592 handling incoming call from [192.168.243.242]
35815 10628 accepting a local non-SMTP message
35816 .endd
35817 The first number in the output line is the process number. The third line has
35818 been split here, in order to fit it on the page.
35819
35820
35821
35822 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
35823 .cindex "&'exiqgrep'&"
35824 .cindex "queue" "grepping"
35825 This utility is a Perl script contributed by Matt Hubbard. It runs
35826 .code
35827 exim -bpu
35828 .endd
35829 or (in case &*-a*& switch is specified)
35830 .code
35831 exim -bp
35832 .endd
35833 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
35834 contain alternate exim configuration the queue management might be using.
35835
35836 to obtain a queue listing, and then greps the output to select messages 
35837 that match given criteria. The following selection options are available:
35838
35839 .vlist
35840 .vitem &*-f*&&~<&'regex'&>
35841 Match the sender address using a case-insensitive search. The field that is
35842 tested is enclosed in angle brackets, so you can test for bounce messages with
35843 .code
35844 exiqgrep -f '^<>$'
35845 .endd
35846 .vitem &*-r*&&~<&'regex'&>
35847 Match a recipient address using a case-insensitve search. The field that is
35848 tested is not enclosed in angle brackets.
35849
35850 .vitem &*-s*&&~<&'regex'&>
35851 Match against the size field.
35852
35853 .vitem &*-y*&&~<&'seconds'&>
35854 Match messages that are younger than the given time.
35855
35856 .vitem &*-o*&&~<&'seconds'&>
35857 Match messages that are older than the given time.
35858
35859 .vitem &*-z*&
35860 Match only frozen messages.
35861
35862 .vitem &*-x*&
35863 Match only non-frozen messages.
35864 .endlist
35865
35866 The following options control the format of the output:
35867
35868 .vlist
35869 .vitem &*-c*&
35870 Display only the count of matching messages.
35871
35872 .vitem &*-l*&
35873 Long format &-- display the full message information as output by Exim. This is
35874 the default.
35875
35876 .vitem &*-i*&
35877 Display message ids only.
35878
35879 .vitem &*-b*&
35880 Brief format &-- one line per message.
35881
35882 .vitem &*-R*&
35883 Display messages in reverse order.
35884
35885 .vitem &*-a*&
35886 Include delivered recipients in queue listing.
35887 .endlist
35888
35889 There is one more option, &%-h%&, which outputs a list of options.
35890
35891
35892
35893 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
35894 .cindex "&'exiqsumm'&"
35895 .cindex "queue" "summary"
35896 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
35897 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
35898 running a command such as
35899 .code
35900 exim -bp | exiqsumm
35901 .endd
35902 The output consists of one line for each domain that has messages waiting for
35903 it, as in the following example:
35904 .code
35905 3   2322   74m   66m  msn.com.example
35906 .endd
35907 Each line lists the number of pending deliveries for a domain, their total
35908 volume, and the length of time that the oldest and the newest messages have
35909 been waiting. Note that the number of pending deliveries is greater than the
35910 number of messages when messages have more than one recipient.
35911
35912 A summary line is output at the end. By default the output is sorted on the
35913 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
35914 the output to be sorted by oldest message and by count of messages,
35915 respectively. There are also three options that split the messages for each
35916 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
35917 separates frozen messages, and &%-s%& separates messages according to their
35918 sender.
35919
35920 The output of &'exim -bp'& contains the original addresses in the message, so
35921 this also applies to the output from &'exiqsumm'&. No domains from addresses
35922 generated by aliasing or forwarding are included (unless the &%one_time%&
35923 option of the &(redirect)& router has been used to convert them into &"top
35924 level"& addresses).
35925
35926
35927
35928
35929 .section "Extracting specific information from the log (exigrep)" &&&
35930          "SECTextspeinf"
35931 .cindex "&'exigrep'&"
35932 .cindex "log" "extracts; grepping for"
35933 The &'exigrep'& utility is a Perl script that searches one or more main log
35934 files for entries that match a given pattern. When it finds a match, it
35935 extracts all the log entries for the relevant message, not just those that
35936 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
35937 given message, or all mail for a given user, or for a given host, for example.
35938 The input files can be in Exim log format or syslog format.
35939 If a matching log line is not associated with a specific message, it is
35940 included in &'exigrep'&'s output without any additional lines. The usage is:
35941 .display
35942 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
35943 .endd
35944 If no log file names are given on the command line, the standard input is read.
35945
35946 The &%-t%& argument specifies a number of seconds. It adds an additional
35947 condition for message selection. Messages that are complete are shown only if
35948 they spent more than <&'n'&> seconds on the queue.
35949
35950 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
35951 makes it case-sensitive. This may give a performance improvement when searching
35952 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
35953 option; with &%-I%& they do not. In both cases it is possible to change the
35954 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
35955
35956 The &%-l%& option means &"literal"&, that is, treat all characters in the
35957 pattern as standing for themselves. Otherwise the pattern must be a Perl
35958 regular expression.
35959
35960 The &%-v%& option inverts the matching condition. That is, a line is selected
35961 if it does &'not'& match the pattern.
35962
35963 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
35964 that are generated as a result/response to a message that &'exigrep'& matched
35965 normally.
35966
35967 Example of &%-M%&:
35968 user_a sends a message to user_b, which generates a bounce back to user_b. If
35969 &'exigrep'& is used to search for &"user_a"&, only the first message will be
35970 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
35971 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
35972 when searching for &"user_a"& will show both messages since the bounce is
35973 &"related"& to or a &"result"& of the first message that was found by the
35974 search term.
35975
35976 If the location of a &'zcat'& command is known from the definition of
35977 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
35978 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
35979 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
35980 autodetection of some well known compression extensions.
35981
35982
35983 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
35984 .cindex "&'exipick'&"
35985 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
35986 lists messages from the queue according to a variety of criteria. For details
35987 of &'exipick'&'s facilities, visit the web page at
35988 &url(http://www.exim.org/eximwiki/ToolExipickManPage) or run &'exipick'& with
35989 the &%--help%& option.
35990
35991
35992 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
35993 .cindex "log" "cycling local files"
35994 .cindex "cycling logs"
35995 .cindex "&'exicyclog'&"
35996 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
35997 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
35998 you are using log files with datestamps in their names (see section
35999 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36000 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36001 There are two command line options for &'exicyclog'&:
36002 .ilist
36003 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36004 default that is set when Exim is built. The default default is 10.
36005 .next
36006 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36007 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36008 overriding the script's default, which is to find the setting from Exim's
36009 configuration.
36010 .endlist
36011
36012 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36013 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36014 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36015 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36016 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36017 logs are handled similarly.
36018
36019 If the limit is greater than 99, the script uses 3-digit numbers such as
36020 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36021 to one that is greater, or &'vice versa'&, you will have to fix the names of
36022 any existing log files.
36023
36024 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36025 the end are deleted. All files with numbers greater than 01 are compressed,
36026 using a compression command which is configured by the COMPRESS_COMMAND
36027 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36028 root &%crontab%& entry of the form
36029 .code
36030 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36031 .endd
36032 assuming you have used the name &"exim"& for the Exim user. You can run
36033 &'exicyclog'& as root if you wish, but there is no need.
36034
36035
36036
36037 .section "Mail statistics (eximstats)" "SECTmailstat"
36038 .cindex "statistics"
36039 .cindex "&'eximstats'&"
36040 A Perl script called &'eximstats'& is provided for extracting statistical
36041 information from log files. The output is either plain text, or HTML.
36042 Exim log files are also supported by the &'Lire'& system produced by the
36043 LogReport Foundation &url(http://www.logreport.org).
36044
36045 The &'eximstats'& script has been hacked about quite a bit over time. The
36046 latest version is the result of some extensive revision by Steve Campbell. A
36047 lot of information is given by default, but there are options for suppressing
36048 various parts of it. Following any options, the arguments to the script are a
36049 list of files, which should be main log files. For example:
36050 .code
36051 eximstats -nr /var/spool/exim/log/mainlog.01
36052 .endd
36053 By default, &'eximstats'& extracts information about the number and volume of
36054 messages received from or delivered to various hosts. The information is sorted
36055 both by message count and by volume, and the top fifty hosts in each category
36056 are listed on the standard output. Similar information, based on email
36057 addresses or domains instead of hosts can be requested by means of various
36058 options. For messages delivered and received locally, similar statistics are
36059 also produced per user.
36060
36061 The output also includes total counts and statistics about delivery errors, and
36062 histograms showing the number of messages received and deliveries made in each
36063 hour of the day. A delivery with more than one address in its envelope (for
36064 example, an SMTP transaction with more than one RCPT command) is counted
36065 as a single delivery by &'eximstats'&.
36066
36067 Though normally more deliveries than receipts are reported (as messages may
36068 have multiple recipients), it is possible for &'eximstats'& to report more
36069 messages received than delivered, even though the queue is empty at the start
36070 and end of the period in question. If an incoming message contains no valid
36071 recipients, no deliveries are recorded for it. A bounce message is handled as
36072 an entirely separate message.
36073
36074 &'eximstats'& always outputs a grand total summary giving the volume and number
36075 of messages received and deliveries made, and the number of hosts involved in
36076 each case. It also outputs the number of messages that were delayed (that is,
36077 not completely delivered at the first attempt), and the number that had at
36078 least one address that failed.
36079
36080 The remainder of the output is in sections that can be independently disabled
36081 or modified by various options. It consists of a summary of deliveries by
36082 transport, histograms of messages received and delivered per time interval
36083 (default per hour), information about the time messages spent on the queue,
36084 a list of relayed messages, lists of the top fifty sending hosts, local
36085 senders, destination hosts, and destination local users by count and by volume,
36086 and a list of delivery errors that occurred.
36087
36088 The relay information lists messages that were actually relayed, that is, they
36089 came from a remote host and were directly delivered to some other remote host,
36090 without being processed (for example, for aliasing or forwarding) locally.
36091
36092 There are quite a few options for &'eximstats'& to control exactly what it
36093 outputs. These are documented in the Perl script itself, and can be extracted
36094 by running the command &(perldoc)& on the script. For example:
36095 .code
36096 perldoc /usr/exim/bin/eximstats
36097 .endd
36098
36099 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36100 .cindex "&'exim_checkaccess'&"
36101 .cindex "policy control" "checking access"
36102 .cindex "checking access"
36103 The &%-bh%& command line argument allows you to run a fake SMTP session with
36104 debugging output, in order to check what Exim is doing when it is applying
36105 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36106 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36107 sometimes you just want to answer the question &"Does this address have
36108 access?"& without bothering with any further details.
36109
36110 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36111 two arguments, an IP address and an email address:
36112 .code
36113 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36114 .endd
36115 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36116 given email address would be accepted in a RCPT command in a TCP/IP
36117 connection from the host with the given IP address. The output of the utility
36118 is either the word &"accepted"&, or the SMTP error response, for example:
36119 .code
36120 Rejected:
36121 550 Relay not permitted
36122 .endd
36123 When running this test, the utility uses &`<>`& as the envelope sender address
36124 for the MAIL command, but you can change this by providing additional
36125 options. These are passed directly to the Exim command. For example, to specify
36126 that the test is to be run with the sender address &'himself@there.example'&
36127 you can use:
36128 .code
36129 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36130                  -f himself@there.example
36131 .endd
36132 Note that these additional Exim command line items must be given after the two
36133 mandatory arguments.
36134
36135 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36136 while running its checks. You can run checks that include callouts by using
36137 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36138
36139
36140
36141 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36142 .cindex "DBM" "building dbm files"
36143 .cindex "building DBM files"
36144 .cindex "&'exim_dbmbuild'&"
36145 .cindex "lower casing"
36146 .cindex "binary zero" "in lookup key"
36147 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36148 the format used by the &(lsearch)& lookup (see section
36149 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36150 names as keys and the remainder of the information as data. The lower-casing
36151 can be prevented by calling the program with the &%-nolc%& option.
36152
36153 A terminating zero is included as part of the key string. This is expected by
36154 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36155 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36156 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36157 files.
36158
36159 The program requires two arguments: the name of the input file (which can be a
36160 single hyphen to indicate the standard input), and the name of the output file.
36161 It creates the output under a temporary name, and then renames it if all went
36162 well.
36163
36164 .cindex "USE_DB"
36165 If the native DB interface is in use (USE_DB is set in a compile-time
36166 configuration file &-- this is common in free versions of Unix) the two file
36167 names must be different, because in this mode the Berkeley DB functions create
36168 a single output file using exactly the name given. For example,
36169 .code
36170 exim_dbmbuild /etc/aliases /etc/aliases.db
36171 .endd
36172 reads the system alias file and creates a DBM version of it in
36173 &_/etc/aliases.db_&.
36174
36175 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36176 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36177 environment, the suffixes are added to the second argument of
36178 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36179 when the Berkeley functions are used in compatibility mode (though this is not
36180 recommended), because in that case it adds a &_.db_& suffix to the file name.
36181
36182 If a duplicate key is encountered, the program outputs a warning, and when it
36183 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36184 option is used. By default, only the first of a set of duplicates is used &--
36185 this makes it compatible with &(lsearch)& lookups. There is an option
36186 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36187 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36188 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36189 return code is 2.
36190
36191
36192
36193
36194 .section "Finding individual retry times (exinext)" "SECTfinindret"
36195 .cindex "retry" "times"
36196 .cindex "&'exinext'&"
36197 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36198 fish specific information out of the retry database. Given a mail domain (or a
36199 complete address), it looks up the hosts for that domain, and outputs any retry
36200 information for the hosts or for the domain. At present, the retry information
36201 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36202 output. For example:
36203 .code
36204 $ exinext piglet@milne.fict.example
36205 kanga.milne.example:192.168.8.1 error 146: Connection refused
36206   first failed: 21-Feb-1996 14:57:34
36207   last tried:   21-Feb-1996 14:57:34
36208   next try at:  21-Feb-1996 15:02:34
36209 roo.milne.example:192.168.8.3 error 146: Connection refused
36210   first failed: 20-Jan-1996 13:12:08
36211   last tried:   21-Feb-1996 11:42:03
36212   next try at:  21-Feb-1996 19:42:03
36213   past final cutoff time
36214 .endd
36215 You can also give &'exinext'& a local part, without a domain, and it
36216 will give any retry information for that local part in your default domain.
36217 A message id can be used to obtain retry information pertaining to a specific
36218 message. This exists only when an attempt to deliver a message to a remote host
36219 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36220 &'exinext'& is not particularly efficient, but then it is not expected to be
36221 run very often.
36222
36223 The &'exinext'& utility calls Exim to find out information such as the location
36224 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
36225 passed on to the &'exim'& commands. The first specifies an alternate Exim
36226 configuration file, and the second sets macros for use within the configuration
36227 file. These features are mainly to help in testing, but might also be useful in
36228 environments where more than one configuration file is in use.
36229
36230
36231
36232 .section "Hints database maintenance" "SECThindatmai"
36233 .cindex "hints database" "maintenance"
36234 .cindex "maintaining Exim's hints database"
36235 Three utility programs are provided for maintaining the DBM files that Exim
36236 uses to contain its delivery hint information. Each program requires two
36237 arguments. The first specifies the name of Exim's spool directory, and the
36238 second is the name of the database it is to operate on. These are as follows:
36239
36240 .ilist
36241 &'retry'&: the database of retry information
36242 .next
36243 &'wait-'&<&'transport name'&>: databases of information about messages waiting
36244 for remote hosts
36245 .next
36246 &'callout'&: the callout cache
36247 .next
36248 &'ratelimit'&: the data for implementing the ratelimit ACL condition
36249 .next
36250 &'misc'&: other hints data
36251 .endlist
36252
36253 The &'misc'& database is used for
36254
36255 .ilist
36256 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
36257 .next
36258 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
36259 &(smtp)& transport)
36260 .endlist
36261
36262
36263
36264 .section "exim_dumpdb" "SECID261"
36265 .cindex "&'exim_dumpdb'&"
36266 The entire contents of a database are written to the standard output by the
36267 &'exim_dumpdb'& program, which has no options or arguments other than the
36268 spool and database names. For example, to dump the retry database:
36269 .code
36270 exim_dumpdb /var/spool/exim retry
36271 .endd
36272 Two lines of output are produced for each entry:
36273 .code
36274 T:mail.ref.example:192.168.242.242 146 77 Connection refused
36275 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
36276 .endd
36277 The first item on the first line is the key of the record. It starts with one
36278 of the letters R, or T, depending on whether it refers to a routing or
36279 transport retry. For a local delivery, the next part is the local address; for
36280 a remote delivery it is the name of the remote host, followed by its failing IP
36281 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
36282 transport). If the remote port is not the standard one (port 25), it is added
36283 to the IP address. Then there follows an error code, an additional error code,
36284 and a textual description of the error.
36285
36286 The three times on the second line are the time of first failure, the time of
36287 the last delivery attempt, and the computed time for the next attempt. The line
36288 ends with an asterisk if the cutoff time for the last retry rule has been
36289 exceeded.
36290
36291 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
36292 consists of a host name followed by a list of ids for messages that are or were
36293 waiting to be delivered to that host. If there are a very large number for any
36294 one host, continuation records, with a sequence number added to the host name,
36295 may be seen. The data in these records is often out of date, because a message
36296 may be routed to several alternative hosts, and Exim makes no effort to keep
36297 cross-references.
36298
36299
36300
36301 .section "exim_tidydb" "SECID262"
36302 .cindex "&'exim_tidydb'&"
36303 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
36304 database. If run with no options, it removes all records that are more than 30
36305 days old. The age is calculated from the date and time that the record was last
36306 updated. Note that, in the case of the retry database, it is &'not'& the time
36307 since the first delivery failure. Information about a host that has been down
36308 for more than 30 days will remain in the database, provided that the record is
36309 updated sufficiently often.
36310
36311 The cutoff date can be altered by means of the &%-t%& option, which must be
36312 followed by a time. For example, to remove all records older than a week from
36313 the retry database:
36314 .code
36315 exim_tidydb -t 7d /var/spool/exim retry
36316 .endd
36317 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
36318 message ids. In the former these appear as data in records keyed by host &--
36319 they were messages that were waiting for that host &-- and in the latter they
36320 are the keys for retry information for messages that have suffered certain
36321 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
36322 message ids in database records are those of messages that are still on the
36323 queue. Message ids for messages that no longer exist are removed from
36324 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
36325 For the &'retry'& database, records whose keys are non-existent message ids are
36326 removed. The &'exim_tidydb'& utility outputs comments on the standard output
36327 whenever it removes information from the database.
36328
36329 Certain records are automatically removed by Exim when they are no longer
36330 needed, but others are not. For example, if all the MX hosts for a domain are
36331 down, a retry record is created for each one. If the primary MX host comes back
36332 first, its record is removed when Exim successfully delivers to it, but the
36333 records for the others remain because Exim has not tried to use those hosts.
36334
36335 It is important, therefore, to run &'exim_tidydb'& periodically on all the
36336 hints databases. You should do this at a quiet time of day, because it requires
36337 a database to be locked (and therefore inaccessible to Exim) while it does its
36338 work. Removing records from a DBM file does not normally make the file smaller,
36339 but all the common DBM libraries are able to re-use the space that is released.
36340 After an initial phase of increasing in size, the databases normally reach a
36341 point at which they no longer get any bigger, as long as they are regularly
36342 tidied.
36343
36344 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
36345 databases is likely to keep on increasing.
36346
36347
36348
36349
36350 .section "exim_fixdb" "SECID263"
36351 .cindex "&'exim_fixdb'&"
36352 The &'exim_fixdb'& program is a utility for interactively modifying databases.
36353 Its main use is for testing Exim, but it might also be occasionally useful for
36354 getting round problems in a live system. It has no options, and its interface
36355 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
36356 key of a database record can then be entered, and the data for that record is
36357 displayed.
36358
36359 If &"d"& is typed at the next prompt, the entire record is deleted. For all
36360 except the &'retry'& database, that is the only operation that can be carried
36361 out. For the &'retry'& database, each field is output preceded by a number, and
36362 data for individual fields can be changed by typing the field number followed
36363 by new data, for example:
36364 .code
36365 > 4 951102:1000
36366 .endd
36367 resets the time of the next delivery attempt. Time values are given as a
36368 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
36369 used as optional separators.
36370
36371
36372
36373
36374 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
36375 .cindex "mailbox" "maintenance"
36376 .cindex "&'exim_lock'&"
36377 .cindex "locking mailboxes"
36378 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
36379 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
36380 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
36381 a user agent while investigating a problem. The utility requires the name of
36382 the file as its first argument. If the locking is successful, the second
36383 argument is run as a command (using C's &[system()]& function); if there is no
36384 second argument, the value of the SHELL environment variable is used; if this
36385 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
36386 is unlocked and the utility ends. The following options are available:
36387
36388 .vlist
36389 .vitem &%-fcntl%&
36390 Use &[fcntl()]& locking on the open mailbox.
36391
36392 .vitem &%-flock%&
36393 Use &[flock()]& locking on the open mailbox, provided the operating system
36394 supports it.
36395
36396 .vitem &%-interval%&
36397 This must be followed by a number, which is a number of seconds; it sets the
36398 interval to sleep between retries (default 3).
36399
36400 .vitem &%-lockfile%&
36401 Create a lock file before opening the mailbox.
36402
36403 .vitem &%-mbx%&
36404 Lock the mailbox using MBX rules.
36405
36406 .vitem &%-q%&
36407 Suppress verification output.
36408
36409 .vitem &%-retries%&
36410 This must be followed by a number; it sets the number of times to try to get
36411 the lock (default 10).
36412
36413 .vitem &%-restore_time%&
36414 This option causes &%exim_lock%& to restore the modified and read times to the
36415 locked file before exiting. This allows you to access a locked mailbox (for
36416 example, to take a backup copy) without disturbing the times that the user
36417 subsequently sees.
36418
36419 .vitem &%-timeout%&
36420 This must be followed by a number, which is a number of seconds; it sets a
36421 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
36422 default), a non-blocking call is used.
36423
36424 .vitem &%-v%&
36425 Generate verbose output.
36426 .endlist
36427
36428 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
36429 default is to create a lock file and also to use &[fcntl()]& locking on the
36430 mailbox, which is the same as Exim's default. The use of &%-flock%& or
36431 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
36432 requires that the directory containing the file be writeable. Locking by lock
36433 file does not last for ever; Exim assumes that a lock file is expired if it is
36434 more than 30 minutes old.
36435
36436 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
36437 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
36438 to be taken out on the open mailbox, and an exclusive lock on the file
36439 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
36440 number of the mailbox file. When the locking is released, if an exclusive lock
36441 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
36442
36443 The default output contains verification of the locking that takes place. The
36444 &%-v%& option causes some additional information to be given. The &%-q%& option
36445 suppresses all output except error messages.
36446
36447 A command such as
36448 .code
36449 exim_lock /var/spool/mail/spqr
36450 .endd
36451 runs an interactive shell while the file is locked, whereas
36452 .display
36453 &`exim_lock -q /var/spool/mail/spqr <<End`&
36454 <&'some commands'&>
36455 &`End`&
36456 .endd
36457 runs a specific non-interactive sequence of commands while the file is locked,
36458 suppressing all verification output. A single command can be run by a command
36459 such as
36460 .code
36461 exim_lock -q /var/spool/mail/spqr \
36462   "cp /var/spool/mail/spqr /some/where"
36463 .endd
36464 Note that if a command is supplied, it must be entirely contained within the
36465 second argument &-- hence the quotes.
36466 .ecindex IIDutils
36467
36468
36469 . ////////////////////////////////////////////////////////////////////////////
36470 . ////////////////////////////////////////////////////////////////////////////
36471
36472 .chapter "The Exim monitor" "CHAPeximon"
36473 .scindex IIDeximon "Exim monitor" "description"
36474 .cindex "X-windows"
36475 .cindex "&'eximon'&"
36476 .cindex "Local/eximon.conf"
36477 .cindex "&_exim_monitor/EDITME_&"
36478 The Exim monitor is an application which displays in an X window information
36479 about the state of Exim's queue and what Exim is doing. An admin user can
36480 perform certain operations on messages from this GUI interface; however all
36481 such facilities are also available from the command line, and indeed, the
36482 monitor itself makes use of the command line to perform any actions requested.
36483
36484
36485
36486 .section "Running the monitor" "SECID264"
36487 The monitor is started by running the script called &'eximon'&. This is a shell
36488 script that sets up a number of environment variables, and then runs the
36489 binary called &_eximon.bin_&. The default appearance of the monitor window can
36490 be changed by editing the &_Local/eximon.conf_& file created by editing
36491 &_exim_monitor/EDITME_&. Comments in that file describe what the various
36492 parameters are for.
36493
36494 The parameters that get built into the &'eximon'& script can be overridden for
36495 a particular invocation by setting up environment variables of the same names,
36496 preceded by &`EXIMON_`&. For example, a shell command such as
36497 .code
36498 EXIMON_LOG_DEPTH=400 eximon
36499 .endd
36500 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
36501 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
36502 overrides the Exim log file configuration. This makes it possible to have
36503 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
36504 syslog messages are routed to a file on the local host.
36505
36506 X resources can be used to change the appearance of the window in the normal
36507 way. For example, a resource setting of the form
36508 .code
36509 Eximon*background: gray94
36510 .endd
36511 changes the colour of the background to light grey rather than white. The
36512 stripcharts are drawn with both the data lines and the reference lines in
36513 black. This means that the reference lines are not visible when on top of the
36514 data. However, their colour can be changed by setting a resource called
36515 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
36516 For example, if your X server is running Unix, you could set up lighter
36517 reference lines in the stripcharts by obeying
36518 .code
36519 xrdb -merge <<End
36520 Eximon*highlight: gray
36521 End
36522 .endd
36523 .cindex "admin user"
36524 In order to see the contents of messages on the queue, and to operate on them,
36525 &'eximon'& must either be run as root or by an admin user.
36526
36527 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
36528 contain X11 resource parameters interpreted by the X11 library.  In addition,
36529 if the first parameter starts with the string "gdb" then it is removed and the
36530 binary is invoked under gdb (the parameter is used as the gdb command-name, so
36531 versioned variants of gdb can be invoked).
36532
36533 The monitor's window is divided into three parts. The first contains one or
36534 more stripcharts and two action buttons, the second contains a &"tail"& of the
36535 main log file, and the third is a display of the queue of messages awaiting
36536 delivery, with two more action buttons. The following sections describe these
36537 different parts of the display.
36538
36539
36540
36541
36542 .section "The stripcharts" "SECID265"
36543 .cindex "stripchart"
36544 The first stripchart is always a count of messages on the queue. Its name can
36545 be configured by setting QUEUE_STRIPCHART_NAME in the
36546 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
36547 configuration script by regular expression matches on log file entries, making
36548 it possible to display, for example, counts of messages delivered to certain
36549 hosts or using certain transports. The supplied defaults display counts of
36550 received and delivered messages, and of local and SMTP deliveries. The default
36551 period between stripchart updates is one minute; this can be adjusted by a
36552 parameter in the &_Local/eximon.conf_& file.
36553
36554 The stripchart displays rescale themselves automatically as the value they are
36555 displaying changes. There are always 10 horizontal lines in each chart; the
36556 title string indicates the value of each division when it is greater than one.
36557 For example, &"x2"& means that each division represents a value of 2.
36558
36559 It is also possible to have a stripchart which shows the percentage fullness of
36560 a particular disk partition, which is useful when local deliveries are confined
36561 to a single partition.
36562
36563 .cindex "&%statvfs%& function"
36564 This relies on the availability of the &[statvfs()]& function or equivalent in
36565 the operating system. Most, but not all versions of Unix that support Exim have
36566 this. For this particular stripchart, the top of the chart always represents
36567 100%, and the scale is given as &"x10%"&. This chart is configured by setting
36568 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
36569 &_Local/eximon.conf_& file.
36570
36571
36572
36573
36574 .section "Main action buttons" "SECID266"
36575 .cindex "size" "of monitor window"
36576 .cindex "Exim monitor" "window size"
36577 .cindex "window size"
36578 Below the stripcharts there is an action button for quitting the monitor. Next
36579 to this is another button marked &"Size"&. They are placed here so that
36580 shrinking the window to its default minimum size leaves just the queue count
36581 stripchart and these two buttons visible. Pressing the &"Size"& button causes
36582 the window to expand to its maximum size, unless it is already at the maximum,
36583 in which case it is reduced to its minimum.
36584
36585 When expanding to the maximum, if the window cannot be fully seen where it
36586 currently is, it is moved back to where it was the last time it was at full
36587 size. When it is expanding from its minimum size, the old position is
36588 remembered, and next time it is reduced to the minimum it is moved back there.
36589
36590 The idea is that you can keep a reduced window just showing one or two
36591 stripcharts at a convenient place on your screen, easily expand it to show
36592 the full window when required, and just as easily put it back to what it was.
36593 The idea is copied from what the &'twm'& window manager does for its
36594 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
36595 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
36596
36597 Normally, the monitor starts up with the window at its full size, but it can be
36598 built so that it starts up with the window at its smallest size, by setting
36599 START_SMALL=yes in &_Local/eximon.conf_&.
36600
36601
36602
36603 .section "The log display" "SECID267"
36604 .cindex "log" "tail of; in monitor"
36605 The second section of the window is an area in which a display of the tail of
36606 the main log is maintained.
36607 To save space on the screen, the timestamp on each log line is shortened by
36608 removing the date and, if &%log_timezone%& is set, the timezone.
36609 The log tail is not available when the only destination for logging data is
36610 syslog, unless the syslog lines are routed to a local file whose name is passed
36611 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
36612
36613 The log sub-window has a scroll bar at its lefthand side which can be used to
36614 move back to look at earlier text, and the up and down arrow keys also have a
36615 scrolling effect. The amount of log that is kept depends on the setting of
36616 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
36617 to use. When this is full, the earlier 50% of data is discarded &-- this is
36618 much more efficient than throwing it away line by line. The sub-window also has
36619 a horizontal scroll bar for accessing the ends of long log lines. This is the
36620 only means of horizontal scrolling; the right and left arrow keys are not
36621 available. Text can be cut from this part of the window using the mouse in the
36622 normal way. The size of this subwindow is controlled by parameters in the
36623 configuration file &_Local/eximon.conf_&.
36624
36625 Searches of the text in the log window can be carried out by means of the ^R
36626 and ^S keystrokes, which default to a reverse and a forward search,
36627 respectively. The search covers only the text that is displayed in the window.
36628 It cannot go further back up the log.
36629
36630 The point from which the search starts is indicated by a caret marker. This is
36631 normally at the end of the text in the window, but can be positioned explicitly
36632 by pointing and clicking with the left mouse button, and is moved automatically
36633 by a successful search. If new text arrives in the window when it is scrolled
36634 back, the caret remains where it is, but if the window is not scrolled back,
36635 the caret is moved to the end of the new text.
36636
36637 Pressing ^R or ^S pops up a window into which the search text can be typed.
36638 There are buttons for selecting forward or reverse searching, for carrying out
36639 the search, and for cancelling. If the &"Search"& button is pressed, the search
36640 happens and the window remains so that further searches can be done. If the
36641 &"Return"& key is pressed, a single search is done and the window is closed. If
36642 ^C is typed the search is cancelled.
36643
36644 The searching facility is implemented using the facilities of the Athena text
36645 widget. By default this pops up a window containing both &"search"& and
36646 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
36647 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
36648 However, the linkers in BSDI and HP-UX seem unable to handle an externally
36649 provided version of &%TextPop%& when the remaining parts of the text widget
36650 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
36651 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
36652 on these systems, at the expense of having unwanted items in the search popup
36653 window.
36654
36655
36656
36657 .section "The queue display" "SECID268"
36658 .cindex "queue" "display in monitor"
36659 The bottom section of the monitor window contains a list of all messages that
36660 are on the queue, which includes those currently being received or delivered,
36661 as well as those awaiting delivery. The size of this subwindow is controlled by
36662 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
36663 at which it is updated is controlled by another parameter in the same file &--
36664 the default is 5 minutes, since queue scans can be quite expensive. However,
36665 there is an &"Update"& action button just above the display which can be used
36666 to force an update of the queue display at any time.
36667
36668 When a host is down for some time, a lot of pending mail can build up for it,
36669 and this can make it hard to deal with other messages on the queue. To help
36670 with this situation there is a button next to &"Update"& called &"Hide"&. If
36671 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
36672 type anything in here and press &"Return"&, the text is added to a chain of
36673 such texts, and if every undelivered address in a message matches at least one
36674 of the texts, the message is not displayed.
36675
36676 If there is an address that does not match any of the texts, all the addresses
36677 are displayed as normal. The matching happens on the ends of addresses so, for
36678 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
36679 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
36680 has been set up, a button called &"Unhide"& is displayed. If pressed, it
36681 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
36682 a hide request is automatically cancelled after one hour.
36683
36684 While the dialogue box is displayed, you can't press any buttons or do anything
36685 else to the monitor window. For this reason, if you want to cut text from the
36686 queue display to use in the dialogue box, you have to do the cutting before
36687 pressing the &"Hide"& button.
36688
36689 The queue display contains, for each unhidden queued message, the length of
36690 time it has been on the queue, the size of the message, the message id, the
36691 message sender, and the first undelivered recipient, all on one line. If it is
36692 a bounce message, the sender is shown as &"<>"&. If there is more than one
36693 recipient to which the message has not yet been delivered, subsequent ones are
36694 listed on additional lines, up to a maximum configured number, following which
36695 an ellipsis is displayed. Recipients that have already received the message are
36696 not shown.
36697
36698 .cindex "frozen messages" "display"
36699 If a message is frozen, an asterisk is displayed at the left-hand side.
36700
36701 The queue display has a vertical scroll bar, and can also be scrolled by means
36702 of the arrow keys. Text can be cut from it using the mouse in the normal way.
36703 The text searching facilities, as described above for the log window, are also
36704 available, but the caret is always moved to the end of the text when the queue
36705 display is updated.
36706
36707
36708
36709 .section "The queue menu" "SECID269"
36710 .cindex "queue" "menu in monitor"
36711 If the &%shift%& key is held down and the left button is clicked when the mouse
36712 pointer is over the text for any message, an action menu pops up, and the first
36713 line of the queue display for the message is highlighted. This does not affect
36714 any selected text.
36715
36716 If you want to use some other event for popping up the menu, you can set the
36717 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
36718 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
36719 value set in this parameter is a standard X event description. For example, to
36720 run eximon using &%ctrl%& rather than &%shift%& you could use
36721 .code
36722 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
36723 .endd
36724 The title of the menu is the message id, and it contains entries which act as
36725 follows:
36726
36727 .ilist
36728 &'message log'&: The contents of the message log for the message are displayed
36729 in a new text window.
36730 .next
36731 &'headers'&: Information from the spool file that contains the envelope
36732 information and headers is displayed in a new text window. See chapter
36733 &<<CHAPspool>>& for a description of the format of spool files.
36734 .next
36735 &'body'&: The contents of the spool file containing the body of the message are
36736 displayed in a new text window. There is a default limit of 20,000 bytes to the
36737 amount of data displayed. This can be changed by setting the BODY_MAX
36738 option at compile time, or the EXIMON_BODY_MAX option at run time.
36739 .next
36740 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
36741 delivery of the message. This causes an automatic thaw if the message is
36742 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
36743 a new text window. The delivery is run in a separate process, to avoid holding
36744 up the monitor while the delivery proceeds.
36745 .next
36746 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
36747 that the message be frozen.
36748 .next
36749 .cindex "thawing messages"
36750 .cindex "unfreezing messages"
36751 .cindex "frozen messages" "thawing"
36752 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
36753 that the message be thawed.
36754 .next
36755 .cindex "delivery" "forcing failure"
36756 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
36757 that Exim gives up trying to deliver the message. A bounce message is generated
36758 for any remaining undelivered addresses.
36759 .next
36760 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
36761 that the message be deleted from the system without generating a bounce
36762 message.
36763 .next
36764 &'add recipient'&: A dialog box is displayed into which a recipient address can
36765 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36766 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36767 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36768 causes a call to Exim to be made using the &%-Mar%& option to request that an
36769 additional recipient be added to the message, unless the entry box is empty, in
36770 which case no action is taken.
36771 .next
36772 &'mark delivered'&: A dialog box is displayed into which a recipient address
36773 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
36774 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
36775 Otherwise it must be entered as a fully qualified address. Pressing RETURN
36776 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
36777 recipient address as already delivered, unless the entry box is empty, in which
36778 case no action is taken.
36779 .next
36780 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
36781 mark all recipient addresses as already delivered.
36782 .next
36783 &'edit sender'&: A dialog box is displayed initialized with the current
36784 sender's address. Pressing RETURN causes a call to Exim to be made using the
36785 &%-Mes%& option to replace the sender address, unless the entry box is empty,
36786 in which case no action is taken. If you want to set an empty sender (as in
36787 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
36788 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
36789 the address is qualified with that domain.
36790 .endlist
36791
36792 When a delivery is forced, a window showing the &%-v%& output is displayed. In
36793 other cases when a call to Exim is made, if there is any output from Exim (in
36794 particular, if the command fails) a window containing the command and the
36795 output is displayed. Otherwise, the results of the action are normally apparent
36796 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
36797 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
36798 if no output is generated.
36799
36800 The queue display is automatically updated for actions such as freezing and
36801 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
36802 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
36803 force an update of the display after one of these actions.
36804
36805 In any text window that is displayed as result of a menu action, the normal
36806 cut-and-paste facility is available, and searching can be carried out using ^R
36807 and ^S, as described above for the log tail window.
36808 .ecindex IIDeximon
36809
36810
36811
36812
36813
36814 . ////////////////////////////////////////////////////////////////////////////
36815 . ////////////////////////////////////////////////////////////////////////////
36816
36817 .chapter "Security considerations" "CHAPsecurity"
36818 .scindex IIDsecurcon "security" "discussion of"
36819 This chapter discusses a number of issues concerned with security, some of
36820 which are also covered in other parts of this manual.
36821
36822 For reasons that this author does not understand, some people have promoted
36823 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
36824 existence of this chapter in the documentation. However, the intent of the
36825 chapter is simply to describe the way Exim works in relation to certain
36826 security concerns, not to make any specific claims about the effectiveness of
36827 its security as compared with other MTAs.
36828
36829 What follows is a description of the way Exim is supposed to be. Best efforts
36830 have been made to try to ensure that the code agrees with the theory, but an
36831 absence of bugs can never be guaranteed. Any that are reported will get fixed
36832 as soon as possible.
36833
36834
36835 .section "Building a more &""hardened""& Exim" "SECID286"
36836 .cindex "security" "build-time features"
36837 There are a number of build-time options that can be set in &_Local/Makefile_&
36838 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
36839 Exim administrator who does not have the root password, or by someone who has
36840 penetrated the Exim (but not the root) account. These options are as follows:
36841
36842 .ilist
36843 ALT_CONFIG_PREFIX can be set to a string that is required to match the
36844 start of any file names used with the &%-C%& option. When it is set, these file
36845 names are also not allowed to contain the sequence &"/../"&. (However, if the
36846 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
36847 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
36848 default setting for &%ALT_CONFIG_PREFIX%&.
36849
36850 If the permitted configuration files are confined to a directory to
36851 which only root has access, this guards against someone who has broken
36852 into the Exim account from running a privileged Exim with an arbitrary
36853 configuration file, and using it to break into other accounts.
36854 .next
36855
36856 If a non-trusted configuration file (i.e. not the default configuration file
36857 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
36858 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
36859 the next item), then root privilege is retained only if the caller of Exim is
36860 root. This locks out the possibility of testing a configuration using &%-C%&
36861 right through message reception and delivery, even if the caller is root. The
36862 reception works, but by that time, Exim is running as the Exim user, so when
36863 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
36864 privilege to be lost. However, root can test reception and delivery using two
36865 separate commands.
36866
36867 .next
36868 The WHITELIST_D_MACROS build option declares some macros to be safe to override
36869 with &%-D%& if the real uid is one of root, the Exim run-time user or the
36870 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
36871 requiring the run-time value supplied to &%-D%& to match a regex that errs on
36872 the restrictive side.  Requiring build-time selection of safe macros is onerous
36873 but this option is intended solely as a transition mechanism to permit
36874 previously-working configurations to continue to work after release 4.73.
36875 .next
36876 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
36877 is disabled.
36878 .next
36879 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
36880 never to be used for any deliveries. This is like the &%never_users%& runtime
36881 option, but it cannot be overridden; the runtime option adds additional users
36882 to the list. The default setting is &"root"&; this prevents a non-root user who
36883 is permitted to modify the runtime file from using Exim as a way to get root.
36884 .endlist
36885
36886
36887
36888 .section "Root privilege" "SECID270"
36889 .cindex "setuid"
36890 .cindex "root privilege"
36891 The Exim binary is normally setuid to root, which means that it gains root
36892 privilege (runs as root) when it starts execution. In some special cases (for
36893 example, when the daemon is not in use and there are no local deliveries), it
36894 may be possible to run Exim setuid to some user other than root. This is
36895 discussed in the next section. However, in most installations, root privilege
36896 is required for two things:
36897
36898 .ilist
36899 To set up a socket connected to the standard SMTP port (25) when initialising
36900 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
36901 not required.
36902 .next
36903 To be able to change uid and gid in order to read users' &_.forward_& files and
36904 perform local deliveries as the receiving user or as specified in the
36905 configuration.
36906 .endlist
36907
36908 It is not necessary to be root to do any of the other things Exim does, such as
36909 receiving messages and delivering them externally over SMTP, and it is
36910 obviously more secure if Exim does not run as root except when necessary.
36911 For this reason, a user and group for Exim to use must be defined in
36912 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
36913 group"&. Their values can be changed by the run time configuration, though this
36914 is not recommended. Often a user called &'exim'& is used, but some sites use
36915 &'mail'& or another user name altogether.
36916
36917 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
36918 abdication; the process cannot regain root afterwards. Prior to release 4.00,
36919 &[seteuid()]& was used in some circumstances, but this is no longer the case.
36920
36921 After a new Exim process has interpreted its command line options, it changes
36922 uid and gid in the following cases:
36923
36924 .ilist
36925 .oindex "&%-C%&"
36926 .oindex "&%-D%&"
36927 If the &%-C%& option is used to specify an alternate configuration file, or if
36928 the &%-D%& option is used to define macro values for the configuration, and the
36929 calling process is not running as root, the uid and gid are changed to those of
36930 the calling process.
36931 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
36932 option may not be used at all.
36933 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
36934 can be supplied if the calling process is running as root, the Exim run-time
36935 user or CONFIGURE_OWNER, if defined.
36936 .next
36937 .oindex "&%-be%&"
36938 .oindex "&%-bf%&"
36939 .oindex "&%-bF%&"
36940 If the expansion test option (&%-be%&) or one of the filter testing options
36941 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
36942 calling process.
36943 .next
36944 If the process is not a daemon process or a queue runner process or a delivery
36945 process or a process for testing address routing (started with &%-bt%&), the
36946 uid and gid are changed to the Exim user and group. This means that Exim always
36947 runs under its own uid and gid when receiving messages. This also applies when
36948 testing address verification
36949 .oindex "&%-bv%&"
36950 .oindex "&%-bh%&"
36951 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
36952 option).
36953 .next
36954 For a daemon, queue runner, delivery, or address testing process, the uid
36955 remains as root at this stage, but the gid is changed to the Exim group.
36956 .endlist
36957
36958 The processes that initially retain root privilege behave as follows:
36959
36960 .ilist
36961 A daemon process changes the gid to the Exim group and the uid to the Exim
36962 user after setting up one or more listening sockets. The &[initgroups()]&
36963 function is called, so that if the Exim user is in any additional groups, they
36964 will be used during message reception.
36965 .next
36966 A queue runner process retains root privilege throughout its execution. Its
36967 job is to fork a controlled sequence of delivery processes.
36968 .next
36969 A delivery process retains root privilege throughout most of its execution,
36970 but any actual deliveries (that is, the transports themselves) are run in
36971 subprocesses which always change to a non-root uid and gid. For local
36972 deliveries this is typically the uid and gid of the owner of the mailbox; for
36973 remote deliveries, the Exim uid and gid are used. Once all the delivery
36974 subprocesses have been run, a delivery process changes to the Exim uid and gid
36975 while doing post-delivery tidying up such as updating the retry database and
36976 generating bounce and warning messages.
36977
36978 While the recipient addresses in a message are being routed, the delivery
36979 process runs as root. However, if a user's filter file has to be processed,
36980 this is done in a subprocess that runs under the individual user's uid and
36981 gid. A system filter is run as root unless &%system_filter_user%& is set.
36982 .next
36983 A process that is testing addresses (the &%-bt%& option) runs as root so that
36984 the routing is done in the same environment as a message delivery.
36985 .endlist
36986
36987
36988
36989
36990 .section "Running Exim without privilege" "SECTrunexiwitpri"
36991 .cindex "privilege, running without"
36992 .cindex "unprivileged running"
36993 .cindex "root privilege" "running without"
36994 Some installations like to run Exim in an unprivileged state for more of its
36995 operation, for added security. Support for this mode of operation is provided
36996 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
36997 gid are changed to the Exim user and group at the start of a delivery process
36998 (and also queue runner and address testing processes). This means that address
36999 routing is no longer run as root, and the deliveries themselves cannot change
37000 to any other uid.
37001
37002 .cindex SIGHUP
37003 .cindex "daemon" "restarting"
37004 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37005 that the daemon can still be started in the usual way, and it can respond
37006 correctly to SIGHUP because the re-invocation regains root privilege.
37007
37008 An alternative approach is to make Exim setuid to the Exim user and also setgid
37009 to the Exim group. If you do this, the daemon must be started from a root
37010 process. (Calling Exim from a root process makes it behave in the way it does
37011 when it is setuid root.) However, the daemon cannot restart itself after a
37012 SIGHUP signal because it cannot regain privilege.
37013
37014 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37015 stops Exim from trying to re-invoke itself to do a delivery after a message has
37016 been received. Such a re-invocation is a waste of resources because it has no
37017 effect.
37018
37019 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37020 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37021 to the Exim user seems a clean approach, but there is one complication:
37022
37023 In this style of operation, Exim is running with the real uid and gid set to
37024 those of the calling process, and the effective uid/gid set to Exim's values.
37025 Ideally, any association with the calling process' uid/gid should be dropped,
37026 that is, the real uid/gid should be reset to the effective values so as to
37027 discard any privileges that the caller may have. While some operating systems
37028 have a function that permits this action for a non-root effective uid, quite a
37029 number of them do not. Because of this lack of standardization, Exim does not
37030 address this problem at this time.
37031
37032 For this reason, the recommended approach for &"mostly unprivileged"& running
37033 is to keep the Exim binary setuid to root, and to set
37034 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37035 be used in the most straightforward way.
37036
37037 If you configure Exim not to run delivery processes as root, there are a
37038 number of restrictions on what you can do:
37039
37040 .ilist
37041 You can deliver only as the Exim user/group. You should  explicitly use the
37042 &%user%& and &%group%& options to override routers or local transports that
37043 normally deliver as the recipient. This makes sure that configurations that
37044 work in this mode function the same way in normal mode. Any implicit or
37045 explicit specification of another user causes an error.
37046 .next
37047 Use of &_.forward_& files is severely restricted, such that it is usually
37048 not worthwhile to include them in the configuration.
37049 .next
37050 Users who wish to use &_.forward_& would have to make their home directory and
37051 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37052 and their equivalents in Exim filters, cannot be used. While they could be
37053 enabled in the Exim user's name, that would be insecure and not very useful.
37054 .next
37055 Unless the local user mailboxes are all owned by the Exim user (possible in
37056 some POP3 or IMAP-only environments):
37057
37058 .olist
37059 They must be owned by the Exim group and be writeable by that group. This
37060 implies you must set &%mode%& in the appendfile configuration, as well as the
37061 mode of the mailbox files themselves.
37062 .next
37063 You must set &%no_check_owner%&, since most or all of the files will not be
37064 owned by the Exim user.
37065 .next
37066 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37067 on a newly created mailbox when unprivileged. This also implies that new
37068 mailboxes need to be created manually.
37069 .endlist olist
37070 .endlist ilist
37071
37072
37073 These restrictions severely restrict what can be done in local deliveries.
37074 However, there are no restrictions on remote deliveries. If you are running a
37075 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37076 gives more security at essentially no cost.
37077
37078 If you are using the &%mua_wrapper%& facility (see chapter
37079 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37080
37081
37082
37083
37084 .section "Delivering to local files" "SECID271"
37085 Full details of the checks applied by &(appendfile)& before it writes to a file
37086 are given in chapter &<<CHAPappendfile>>&.
37087
37088
37089
37090 .section "Running local commands" "SECTsecconslocalcmds"
37091 .cindex "security" "local commands"
37092 .cindex "security" "command injection attacks"
37093 There are a number of ways in which an administrator can configure Exim to run
37094 commands based upon received, untrustworthy, data. Further, in some
37095 configurations a user who can control a &_.forward_& file can also arrange to
37096 run commands. Configuration to check includes, but is not limited to:
37097
37098 .ilist
37099 Use of &%use_shell%& in the pipe transport: various forms of shell command
37100 injection may be possible with this option present. It is dangerous and should
37101 be used only with considerable caution. Consider constraints which whitelist
37102 allowed characters in a variable which is to be used in a pipe transport that
37103 has &%use_shell%& enabled.
37104 .next
37105 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37106 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37107 &_.forward_& files in a redirect router. If Exim is running on a central mail
37108 hub to which ordinary users do not have shell access, but home directories are
37109 NFS mounted (for instance) then administrators should review the list of these
37110 forbid options available, and should bear in mind that the options that may
37111 need forbidding can change as new features are added between releases.
37112 .next
37113 The &%${run...}%& expansion item does not use a shell by default, but
37114 administrators can configure use of &_/bin/sh_& as part of the command.
37115 Such invocations should be viewed with prejudicial suspicion.
37116 .next
37117 Administrators who use embedded Perl are advised to explore how Perl's
37118 taint checking might apply to their usage.
37119 .next
37120 Use of &%${expand...}%& is somewhat analagous to shell's eval builtin and
37121 administrators are well advised to view its use with suspicion, in case (for
37122 instance) it allows a local-part to contain embedded Exim directives.
37123 .next
37124 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37125 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37126 each can reference arbitrary lists and files, rather than just being a list
37127 of opaque strings.
37128 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37129 real-world security vulnerabilities caused by its use with untrustworthy data
37130 injected in, for SQL injection attacks.
37131 Consider the use of the &%inlisti%& expansion condition instead.
37132 .endlist
37133
37134
37135
37136
37137 .section "Trust in configuration data" "SECTsecconfdata"
37138 .cindex "security" "data sources"
37139 .cindex "security" "regular expressions"
37140 .cindex "regular expressions" "security"
37141 .cindex "PCRE" "security"
37142 If configuration data for Exim can come from untrustworthy sources, there
37143 are some issues to be aware of:
37144
37145 .ilist
37146 Use of &%${expand...}%& may provide a path for shell injection attacks.
37147 .next
37148 Letting untrusted data provide a regular expression is unwise.
37149 .next
37150 Using &%${match...}%& to apply a fixed regular expression against untrusted
37151 data may result in pathological behaviour within PCRE.  Be aware of what
37152 "backtracking" means and consider options for being more strict with a regular
37153 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37154 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37155 possessive quantifiers or just not using regular expressions against untrusted
37156 data.
37157 .next
37158 It can be important to correctly use &%${quote:...}%&,
37159 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37160 items to ensure that data is correctly constructed.
37161 .next
37162 Some lookups might return multiple results, even though normal usage is only
37163 expected to yield one result.
37164 .endlist
37165
37166
37167
37168
37169 .section "IPv4 source routing" "SECID272"
37170 .cindex "source routing" "in IP packets"
37171 .cindex "IP source routing"
37172 Many operating systems suppress IP source-routed packets in the kernel, but
37173 some cannot be made to do this, so Exim does its own check. It logs incoming
37174 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37175 IPv6. No special checking is currently done.
37176
37177
37178
37179 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37180 Support for these SMTP commands is disabled by default. If required, they can
37181 be enabled by defining suitable ACLs.
37182
37183
37184
37185
37186 .section "Privileged users" "SECID274"
37187 .cindex "trusted users"
37188 .cindex "admin user"
37189 .cindex "privileged user"
37190 .cindex "user" "trusted"
37191 .cindex "user" "admin"
37192 Exim recognizes two sets of users with special privileges. Trusted users are
37193 able to submit new messages to Exim locally, but supply their own sender
37194 addresses and information about a sending host. For other users submitting
37195 local messages, Exim sets up the sender address from the uid, and doesn't
37196 permit a remote host to be specified.
37197
37198 .oindex "&%-f%&"
37199 However, an untrusted user is permitted to use the &%-f%& command line option
37200 in the special form &%-f <>%& to indicate that a delivery failure for the
37201 message should not cause an error report. This affects the message's envelope,
37202 but it does not affect the &'Sender:'& header. Untrusted users may also be
37203 permitted to use specific forms of address with the &%-f%& option by setting
37204 the &%untrusted_set_sender%& option.
37205
37206 Trusted users are used to run processes that receive mail messages from some
37207 other mail domain and pass them on to Exim for delivery either locally, or over
37208 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37209 as any user listed in the &%trusted_users%& configuration option, or under any
37210 group listed in the &%trusted_groups%& option.
37211
37212 Admin users are permitted to do things to the messages on Exim's queue. They
37213 can freeze or thaw messages, cause them to be returned to their senders, remove
37214 them entirely, or modify them in various ways. In addition, admin users can run
37215 the Exim monitor and see all the information it is capable of providing, which
37216 includes the contents of files on the spool.
37217
37218 .oindex "&%-M%&"
37219 .oindex "&%-q%&"
37220 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
37221 delivery of messages on its queue is restricted to admin users. This
37222 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
37223 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
37224 queue is also restricted to admin users. This restriction can be relaxed by
37225 setting &%no_queue_list_requires_admin%&.
37226
37227 Exim recognizes an admin user if the calling process is running as root or as
37228 the Exim user or if any of the groups associated with the calling process is
37229 the Exim group. It is not necessary actually to be running under the Exim
37230 group. However, if admin users who are not root or the Exim user are to access
37231 the contents of files on the spool via the Exim monitor (which runs
37232 unprivileged), Exim must be built to allow group read access to its spool
37233 files.
37234
37235
37236
37237 .section "Spool files" "SECID275"
37238 .cindex "spool directory" "files"
37239 Exim's spool directory and everything it contains is owned by the Exim user and
37240 set to the Exim group. The mode for spool files is defined in the
37241 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
37242 any user who is a member of the Exim group can access these files.
37243
37244
37245
37246 .section "Use of argv[0]" "SECID276"
37247 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
37248 of specific strings, Exim assumes certain options. For example, calling Exim
37249 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
37250 to calling it with the option &%-bS%&. There are no security implications in
37251 this.
37252
37253
37254
37255 .section "Use of %f formatting" "SECID277"
37256 The only use made of &"%f"& by Exim is in formatting load average values. These
37257 are actually stored in integer variables as 1000 times the load average.
37258 Consequently, their range is limited and so therefore is the length of the
37259 converted output.
37260
37261
37262
37263 .section "Embedded Exim path" "SECID278"
37264 Exim uses its own path name, which is embedded in the code, only when it needs
37265 to re-exec in order to regain root privilege. Therefore, it is not root when it
37266 does so. If some bug allowed the path to get overwritten, it would lead to an
37267 arbitrary program's being run as exim, not as root.
37268
37269
37270
37271 .section "Dynamic module directory" "SECTdynmoddir"
37272 Any dynamically loadable modules must be installed into the directory
37273 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
37274 loading it.
37275
37276
37277 .section "Use of sprintf()" "SECID279"
37278 .cindex "&[sprintf()]&"
37279 A large number of occurrences of &"sprintf"& in the code are actually calls to
37280 &'string_sprintf()'&, a function that returns the result in malloc'd store.
37281 The intermediate formatting is done into a large fixed buffer by a function
37282 that runs through the format string itself, and checks the length of each
37283 conversion before performing it, thus preventing buffer overruns.
37284
37285 The remaining uses of &[sprintf()]& happen in controlled circumstances where
37286 the output buffer is known to be sufficiently long to contain the converted
37287 string.
37288
37289
37290
37291 .section "Use of debug_printf() and log_write()" "SECID280"
37292 Arbitrary strings are passed to both these functions, but they do their
37293 formatting by calling the function &'string_vformat()'&, which runs through
37294 the format string itself, and checks the length of each conversion.
37295
37296
37297
37298 .section "Use of strcat() and strcpy()" "SECID281"
37299 These are used only in cases where the output buffer is known to be large
37300 enough to hold the result.
37301 .ecindex IIDsecurcon
37302
37303
37304
37305
37306 . ////////////////////////////////////////////////////////////////////////////
37307 . ////////////////////////////////////////////////////////////////////////////
37308
37309 .chapter "Format of spool files" "CHAPspool"
37310 .scindex IIDforspo1 "format" "spool files"
37311 .scindex IIDforspo2 "spool directory" "format of files"
37312 .scindex IIDforspo3 "spool files" "format of"
37313 .cindex "spool files" "editing"
37314 A message on Exim's queue consists of two files, whose names are the message id
37315 followed by -D and -H, respectively. The data portion of the message is kept in
37316 the -D file on its own. The message's envelope, status, and headers are all
37317 kept in the -H file, whose format is described in this chapter. Each of these
37318 two files contains the final component of its own name as its first line. This
37319 is insurance against disk crashes where the directory is lost but the files
37320 themselves are recoverable.
37321
37322 Some people are tempted into editing -D files in order to modify messages. You
37323 need to be extremely careful if you do this; it is not recommended and you are
37324 on your own if you do it. Here are some of the pitfalls:
37325
37326 .ilist
37327 You must ensure that Exim does not try to deliver the message while you are
37328 fiddling with it. The safest way is to take out a write lock on the -D file,
37329 which is what Exim itself does, using &[fcntl()]&. If you update the file in
37330 place, the lock will be retained. If you write a new file and rename it, the
37331 lock will be lost at the instant of rename.
37332 .next
37333 .vindex "&$body_linecount$&"
37334 If you change the number of lines in the file, the value of
37335 &$body_linecount$&, which is stored in the -H file, will be incorrect. At
37336 present, this value is not used by Exim, but there is no guarantee that this
37337 will always be the case.
37338 .next
37339 If the message is in MIME format, you must take care not to break it.
37340 .next
37341 If the message is cryptographically signed, any change will invalidate the
37342 signature.
37343 .endlist
37344 All in all, modifying -D files is fraught with danger.
37345
37346 Files whose names end with -J may also be seen in the &_input_& directory (or
37347 its subdirectories when &%split_spool_directory%& is set). These are journal
37348 files, used to record addresses to which the message has been delivered during
37349 the course of a delivery attempt. If there are still undelivered recipients at
37350 the end, the -H file is updated, and the -J file is deleted. If, however, there
37351 is some kind of crash (for example, a power outage) before this happens, the -J
37352 file remains in existence. When Exim next processes the message, it notices the
37353 -J file and uses it to update the -H file before starting the next delivery
37354 attempt.
37355
37356 .section "Format of the -H file" "SECID282"
37357 .cindex "uid (user id)" "in spool file"
37358 .cindex "gid (group id)" "in spool file"
37359 The second line of the -H file contains the login name for the uid of the
37360 process that called Exim to read the message, followed by the numerical uid and
37361 gid. For a locally generated message, this is normally the user who sent the
37362 message. For a message received over TCP/IP via the daemon, it is
37363 normally the Exim user.
37364
37365 The third line of the file contains the address of the message's sender as
37366 transmitted in the envelope, contained in angle brackets. The sender address is
37367 empty for bounce messages. For incoming SMTP mail, the sender address is given
37368 in the MAIL command. For locally generated mail, the sender address is
37369 created by Exim from the login name of the current user and the configured
37370 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
37371 leading &"From&~"& line if the caller is trusted, or if the supplied address is
37372 &"<>"& or an address that matches &%untrusted_set_senders%&.
37373
37374 The fourth line contains two numbers. The first is the time that the message
37375 was received, in the conventional Unix form &-- the number of seconds since the
37376 start of the epoch. The second number is a count of the number of messages
37377 warning of delayed delivery that have been sent to the sender.
37378
37379 There follow a number of lines starting with a hyphen. These can appear in any
37380 order, and are omitted when not relevant:
37381
37382 .vlist
37383 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
37384 This item is obsolete, and is not generated from Exim release 4.61 onwards;
37385 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
37386 recognized, to provide backward compatibility. In the old format, a line of
37387 this form is present for every ACL variable that is not empty. The number
37388 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
37389 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
37390 the data string for the variable. The string itself starts at the beginning of
37391 the next line, and is followed by a newline character. It may contain internal
37392 newlines.
37393
37394 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
37395 A line of this form is present for every ACL connection variable that is
37396 defined. Note that there is a space between &%-aclc%& and the rest of the name.
37397 The length is the length of the data string for the variable. The string itself
37398 starts at the beginning of the next line, and is followed by a newline
37399 character. It may contain internal newlines.
37400
37401 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
37402 A line of this form is present for every ACL message variable that is defined.
37403 Note that there is a space between &%-aclm%& and the rest of the name. The
37404 length is the length of the data string for the variable. The string itself
37405 starts at the beginning of the next line, and is followed by a newline
37406 character. It may contain internal newlines.
37407
37408 .vitem "&%-active_hostname%&&~<&'hostname'&>"
37409 This is present if, when the message was received over SMTP, the value of
37410 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
37411
37412 .vitem &%-allow_unqualified_recipient%&
37413 This is present if unqualified recipient addresses are permitted in header
37414 lines (to stop such addresses from being qualified if rewriting occurs at
37415 transport time). Local messages that were input using &%-bnq%& and remote
37416 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
37417
37418 .vitem &%-allow_unqualified_sender%&
37419 This is present if unqualified sender addresses are permitted in header lines
37420 (to stop such addresses from being qualified if rewriting occurs at transport
37421 time). Local messages that were input using &%-bnq%& and remote messages from
37422 hosts that match &%sender_unqualified_hosts%& set this flag.
37423
37424 .vitem "&%-auth_id%&&~<&'text'&>"
37425 The id information for a message received on an authenticated SMTP connection
37426 &-- the value of the &$authenticated_id$& variable.
37427
37428 .vitem "&%-auth_sender%&&~<&'address'&>"
37429 The address of an authenticated sender &-- the value of the
37430 &$authenticated_sender$& variable.
37431
37432 .vitem "&%-body_linecount%&&~<&'number'&>"
37433 This records the number of lines in the body of the message, and is always
37434 present.
37435
37436 .vitem "&%-body_zerocount%&&~<&'number'&>"
37437 This records the number of binary zero bytes in the body of the message, and is
37438 present if the number is greater than zero.
37439
37440 .vitem &%-deliver_firsttime%&
37441 This is written when a new message is first added to the spool. When the spool
37442 file is updated after a deferral, it is omitted.
37443
37444 .vitem "&%-frozen%&&~<&'time'&>"
37445 .cindex "frozen messages" "spool data"
37446 The message is frozen, and the freezing happened at <&'time'&>.
37447
37448 .vitem "&%-helo_name%&&~<&'text'&>"
37449 This records the host name as specified by a remote host in a HELO or EHLO
37450 command.
37451
37452 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
37453 This records the IP address of the host from which the message was received and
37454 the remote port number that was used. It is omitted for locally generated
37455 messages.
37456
37457 .vitem "&%-host_auth%&&~<&'text'&>"
37458 If the message was received on an authenticated SMTP connection, this records
37459 the name of the authenticator &-- the value of the
37460 &$sender_host_authenticated$& variable.
37461
37462 .vitem &%-host_lookup_failed%&
37463 This is present if an attempt to look up the sending host's name from its IP
37464 address failed. It corresponds to the &$host_lookup_failed$& variable.
37465
37466 .vitem "&%-host_name%&&~<&'text'&>"
37467 .cindex "reverse DNS lookup"
37468 .cindex "DNS" "reverse lookup"
37469 This records the name of the remote host from which the message was received,
37470 if the host name was looked up from the IP address when the message was being
37471 received. It is not present if no reverse lookup was done.
37472
37473 .vitem "&%-ident%&&~<&'text'&>"
37474 For locally submitted messages, this records the login of the originating user,
37475 unless it was a trusted user and the &%-oMt%& option was used to specify an
37476 ident value. For messages received over TCP/IP, this records the ident string
37477 supplied by the remote host, if any.
37478
37479 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
37480 This records the IP address of the local interface and the port number through
37481 which a message was received from a remote host. It is omitted for locally
37482 generated messages.
37483
37484 .vitem &%-local%&
37485 The message is from a local sender.
37486
37487 .vitem &%-localerror%&
37488 The message is a locally-generated bounce message.
37489
37490 .vitem "&%-local_scan%&&~<&'string'&>"
37491 This records the data string that was returned by the &[local_scan()]& function
37492 when the message was received &-- the value of the &$local_scan_data$&
37493 variable. It is omitted if no data was returned.
37494
37495 .vitem &%-manual_thaw%&
37496 The message was frozen but has been thawed manually, that is, by an explicit
37497 Exim command rather than via the auto-thaw process.
37498
37499 .vitem &%-N%&
37500 A testing delivery process was started using the &%-N%& option to suppress any
37501 actual deliveries, but delivery was deferred. At any further delivery attempts,
37502 &%-N%& is assumed.
37503
37504 .vitem &%-received_protocol%&
37505 This records the value of the &$received_protocol$& variable, which contains
37506 the name of the protocol by which the message was received.
37507
37508 .vitem &%-sender_set_untrusted%&
37509 The envelope sender of this message was set by an untrusted local caller (used
37510 to ensure that the caller is displayed in queue listings).
37511
37512 .vitem "&%-spam_score_int%&&~<&'number'&>"
37513 If a message was scanned by SpamAssassin, this is present. It records the value
37514 of &$spam_score_int$&.
37515
37516 .vitem &%-tls_certificate_verified%&
37517 A TLS certificate was received from the client that sent this message, and the
37518 certificate was verified by the server.
37519
37520 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
37521 When the message was received over an encrypted connection, this records the
37522 name of the cipher suite that was used.
37523
37524 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
37525 When the message was received over an encrypted connection, and a certificate
37526 was received from the client, this records the Distinguished Name from that
37527 certificate.
37528 .endlist
37529
37530 Following the options there is a list of those addresses to which the message
37531 is not to be delivered. This set of addresses is initialized from the command
37532 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
37533 is set; otherwise it starts out empty. Whenever a successful delivery is made,
37534 the address is added to this set. The addresses are kept internally as a
37535 balanced binary tree, and it is a representation of that tree which is written
37536 to the spool file. If an address is expanded via an alias or forward file, the
37537 original address is added to the tree when deliveries to all its child
37538 addresses are complete.
37539
37540 If the tree is empty, there is a single line in the spool file containing just
37541 the text &"XX"&. Otherwise, each line consists of two letters, which are either
37542 Y or N, followed by an address. The address is the value for the node of the
37543 tree, and the letters indicate whether the node has a left branch and/or a
37544 right branch attached to it, respectively. If branches exist, they immediately
37545 follow. Here is an example of a three-node tree:
37546 .code
37547 YY darcy@austen.fict.example
37548 NN alice@wonderland.fict.example
37549 NN editor@thesaurus.ref.example
37550 .endd
37551 After the non-recipients tree, there is a list of the message's recipients.
37552 This is a simple list, preceded by a count. It includes all the original
37553 recipients of the message, including those to whom the message has already been
37554 delivered. In the simplest case, the list contains one address per line. For
37555 example:
37556 .code
37557 4
37558 editor@thesaurus.ref.example
37559 darcy@austen.fict.example
37560 rdo@foundation
37561 alice@wonderland.fict.example
37562 .endd
37563 However, when a child address has been added to the top-level addresses as a
37564 result of the use of the &%one_time%& option on a &(redirect)& router, each
37565 line is of the following form:
37566 .display
37567 <&'top-level address'&> <&'errors_to address'&> &&&
37568   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
37569 .endd
37570 The 01 flag bit indicates the presence of the three other fields that follow
37571 the top-level address. Other bits may be used in future to support additional
37572 fields. The <&'parent number'&> is the offset in the recipients list of the
37573 original parent of the &"one time"& address. The first two fields are the
37574 envelope sender that is associated with this address and its length. If the
37575 length is zero, there is no special envelope sender (there are then two space
37576 characters in the line). A non-empty field can arise from a &(redirect)& router
37577 that has an &%errors_to%& setting.
37578
37579
37580 A blank line separates the envelope and status information from the headers
37581 which follow. A header may occupy several lines of the file, and to save effort
37582 when reading it in, each header is preceded by a number and an identifying
37583 character. The number is the number of characters in the header, including any
37584 embedded newlines and the terminating newline. The character is one of the
37585 following:
37586
37587 .table2 50pt
37588 .row <&'blank'&>         "header in which Exim has no special interest"
37589 .row &`B`&               "&'Bcc:'& header"
37590 .row &`C`&               "&'Cc:'& header"
37591 .row &`F`&               "&'From:'& header"
37592 .row &`I`&               "&'Message-id:'& header"
37593 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
37594 .row &`R`&               "&'Reply-To:'& header"
37595 .row &`S`&               "&'Sender:'& header"
37596 .row &`T`&               "&'To:'& header"
37597 .row &`*`&               "replaced or deleted header"
37598 .endtable
37599
37600 Deleted or replaced (rewritten) headers remain in the spool file for debugging
37601 purposes. They are not transmitted when the message is delivered. Here is a
37602 typical set of headers:
37603 .code
37604 111P Received: by hobbit.fict.example with local (Exim 4.00)
37605 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
37606 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
37607 038* X-rewrote-sender: bb@hobbit.fict.example
37608 042* From: Bilbo Baggins <bb@hobbit.fict.example>
37609 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
37610 099* To: alice@wonderland.fict.example, rdo@foundation,
37611 darcy@austen.fict.example, editor@thesaurus.ref.example
37612 104T To: alice@wonderland.fict.example, rdo@foundation.example,
37613 darcy@austen.fict.example, editor@thesaurus.ref.example
37614 038  Date: Fri, 11 May 2001 10:28:59 +0100
37615 .endd
37616 The asterisked headers indicate that the envelope sender, &'From:'& header, and
37617 &'To:'& header have been rewritten, the last one because routing expanded the
37618 unqualified domain &'foundation'&.
37619 .ecindex IIDforspo1
37620 .ecindex IIDforspo2
37621 .ecindex IIDforspo3
37622
37623 . ////////////////////////////////////////////////////////////////////////////
37624 . ////////////////////////////////////////////////////////////////////////////
37625
37626 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
37627          "DKIM Support"
37628 .cindex "DKIM"
37629
37630 DKIM is a mechanism by which messages sent by some entity can be provably
37631 linked to a domain which that entity controls.  It permits reputation to
37632 be tracked on a per-domain basis, rather than merely upon source IP address.
37633 DKIM is documented in RFC 4871.
37634
37635 Since version 4.70, DKIM support is compiled into Exim by default. It can be
37636 disabled by setting DISABLE_DKIM=yes in Local/Makefile.
37637
37638 Exim's DKIM implementation allows to
37639 .olist
37640 Sign outgoing messages: This function is implemented in the SMTP transport.
37641 It can co-exist with all other Exim features
37642 (including transport filters)
37643 except cutthrough delivery.
37644 .next
37645 Verify signatures in incoming messages: This is implemented by an additional
37646 ACL (acl_smtp_dkim), which can be called several times per message, with
37647 different signature contexts.
37648 .endlist
37649
37650 In typical Exim style, the verification implementation does not include any
37651 default "policy". Instead it enables you to build your own policy using
37652 Exim's standard controls.
37653
37654 Please note that verification of DKIM signatures in incoming mail is turned
37655 on by default for logging purposes. For each signature in incoming email,
37656 exim will log a line displaying the most important signature details, and the
37657 signature status. Here is an example (with line-breaks added for clarity):
37658 .code
37659 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
37660     d=facebookmail.com s=q1-2009b
37661     c=relaxed/relaxed a=rsa-sha1
37662     i=@facebookmail.com t=1252484542 [verification succeeded]
37663 .endd
37664 You might want to turn off DKIM verification processing entirely for internal
37665 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
37666 control modifier. This should typically be done in the RCPT ACL, at points
37667 where you accept mail from relay sources (internal hosts or authenticated
37668 senders).
37669
37670
37671 .section "Signing outgoing messages" "SECID513"
37672 .cindex "DKIM" "signing"
37673
37674 Signing is implemented by setting private options on the SMTP transport.
37675 These options take (expandable) strings as arguments.
37676
37677 .option dkim_domain smtp string&!! unset
37678 MANDATORY:
37679 The domain you want to sign with. The result of this expanded
37680 option is put into the &%$dkim_domain%& expansion variable.
37681
37682 .option dkim_selector smtp string&!! unset
37683 MANDATORY:
37684 This sets the key selector string. You can use the &%$dkim_domain%& expansion
37685 variable to look up a matching selector. The result is put in the expansion
37686 variable &%$dkim_selector%& which should be used in the &%dkim_private_key%&
37687 option along with &%$dkim_domain%&.
37688
37689 .option dkim_private_key smtp string&!! unset
37690 MANDATORY:
37691 This sets the private key to use. You can use the &%$dkim_domain%& and
37692 &%$dkim_selector%& expansion variables to determine the private key to use.
37693 The result can either
37694 .ilist
37695 be a valid RSA private key in ASCII armor, including line breaks.
37696 .next
37697 start with a slash, in which case it is treated as a file that contains
37698 the private key.
37699 .next
37700 be "0", "false" or the empty string, in which case the message will not
37701 be signed. This case will not result in an error, even if &%dkim_strict%&
37702 is set.
37703 .endlist
37704
37705 .option dkim_canon smtp string&!! unset
37706 OPTIONAL:
37707 This option sets the canonicalization method used when signing a message.
37708 The DKIM RFC currently supports two methods: "simple" and "relaxed".
37709 The option defaults to "relaxed" when unset. Note: the current implementation
37710 only supports using the same canonicalization method for both headers and body.
37711
37712 .option dkim_strict smtp string&!! unset
37713 OPTIONAL:
37714 This  option  defines  how  Exim  behaves  when  signing a message that
37715 should be signed fails for some reason.  When the expansion evaluates to
37716 either "1" or "true", Exim will defer. Otherwise Exim will send the message
37717 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
37718 variables here.
37719
37720 .option dkim_sign_headers smtp string&!! unset
37721 OPTIONAL:
37722 When set, this option must expand to (or be specified as) a colon-separated
37723 list of header names. Headers with these names will be included in the message
37724 signature. When unspecified, the header names recommended in RFC4871 will be
37725 used.
37726
37727
37728 .section "Verifying DKIM signatures in incoming mail" "SECID514"
37729 .cindex "DKIM" "verification"
37730
37731 Verification of DKIM signatures in incoming email is implemented via the
37732 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
37733 syntactically(!) correct signature in the incoming message.
37734 A missing ACL definition defaults to accept.
37735 If any ACL call does not acccept, the message is not accepted.
37736 If a cutthrough delivery was in progress for the message it is
37737 summarily dropped (having wasted the transmission effort).
37738
37739 To evaluate the signature in the ACL a large number of expansion variables
37740 containing the signature status and its details are set up during the
37741 runtime of the ACL.
37742
37743 Calling the ACL only for existing signatures is not sufficient to build
37744 more advanced policies. For that reason, the global option
37745 &%dkim_verify_signers%&, and a global expansion variable
37746 &%$dkim_signers%& exist.
37747
37748 The global option &%dkim_verify_signers%& can be set to a colon-separated
37749 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
37750 called. It is expanded when the message has been received. At this point,
37751 the expansion variable &%$dkim_signers%& already contains a colon-separated
37752 list of signer domains and identities for the message. When
37753 &%dkim_verify_signers%& is not specified in the main configuration,
37754 it defaults as:
37755 .code
37756 dkim_verify_signers = $dkim_signers
37757 .endd
37758 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
37759 DKIM signature in the message. Current DKIM verifiers may want to explicitly
37760 call the ACL for known domains or identities. This would be achieved as follows:
37761 .code
37762 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
37763 .endd
37764 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
37765 and "ebay.com", plus all domains and identities that have signatures in the message.
37766 You can also be more creative in constructing your policy. For example:
37767 .code
37768 dkim_verify_signers = $sender_address_domain:$dkim_signers
37769 .endd
37770
37771 If a domain or identity is listed several times in the (expanded) value of
37772 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
37773
37774
37775 Inside the &%acl_smtp_dkim%&, the following expansion variables are
37776 available (from most to least important):
37777
37778
37779 .vlist
37780 .vitem &%$dkim_cur_signer%&
37781 The signer that is being evaluated in this ACL run. This can be a domain or
37782 an identity. This is one of the list items from the expanded main option
37783 &%dkim_verify_signers%& (see above).
37784 .vitem &%$dkim_verify_status%&
37785 A string describing the general status of the signature. One of
37786 .ilist
37787 &%none%&: There is no signature in the message for the current domain or
37788 identity (as reflected by &%$dkim_cur_signer%&).
37789 .next
37790 &%invalid%&: The signature could not be verified due to a processing error.
37791 More detail is available in &%$dkim_verify_reason%&.
37792 .next
37793 &%fail%&: Verification of the signature failed.  More detail is
37794 available in &%$dkim_verify_reason%&.
37795 .next
37796 &%pass%&: The signature passed verification. It is valid.
37797 .endlist
37798 .vitem &%$dkim_verify_reason%&
37799 A string giving a litte bit more detail when &%$dkim_verify_status%& is either
37800 "fail" or "invalid". One of
37801 .ilist
37802 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
37803 key for the domain could not be retrieved. This may be a temporary problem.
37804 .next
37805 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
37806 record for the domain is syntactically invalid.
37807 .next
37808 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
37809 body hash does not match the one specified in the signature header. This
37810 means that the message body was modified in transit.
37811 .next
37812 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
37813 could not be verified. This may mean that headers were modified,
37814 re-written or otherwise changed in a way which is incompatible with
37815 DKIM verification. It may of course also mean that the signature is forged.
37816 .endlist
37817 .vitem &%$dkim_domain%&
37818 The signing domain. IMPORTANT: This variable is only populated if there is
37819 an actual signature in the message for the current domain or identity (as
37820 reflected by &%$dkim_cur_signer%&).
37821 .vitem &%$dkim_identity%&
37822 The signing identity, if present. IMPORTANT: This variable is only populated
37823 if there is an actual signature in the message for the current domain or
37824 identity (as reflected by &%$dkim_cur_signer%&).
37825 .vitem &%$dkim_selector%&
37826 The key record selector string.
37827 .vitem &%$dkim_algo%&
37828 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
37829 .vitem &%$dkim_canon_body%&
37830 The body canonicalization method. One of 'relaxed' or 'simple'.
37831 .vitem &%dkim_canon_headers%&
37832 The header canonicalization method. One of 'relaxed' or 'simple'.
37833 .vitem &%$dkim_copiedheaders%&
37834 A transcript of headers and their values which are included in the signature
37835 (copied from the 'z=' tag of the signature).
37836 .vitem &%$dkim_bodylength%&
37837 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
37838 limit was set by the signer, "9999999999999" is returned. This makes sure
37839 that this variable always expands to an integer value.
37840 .vitem &%$dkim_created%&
37841 UNIX timestamp reflecting the date and time when the signature was created.
37842 When this was not specified by the signer, "0" is returned.
37843 .vitem &%$dkim_expires%&
37844 UNIX timestamp reflecting the date and time when the signer wants the
37845 signature to be treated as "expired". When this was not specified by the
37846 signer, "9999999999999" is returned. This makes it possible to do useful
37847 integer size comparisons against this value.
37848 .vitem &%$dkim_headernames%&
37849 A colon-separated list of names of headers included in the signature.
37850 .vitem &%$dkim_key_testing%&
37851 "1" if the key record has the "testing" flag set, "0" if not.
37852 .vitem &%$dkim_key_nosubdomains%&
37853 "1" if the key record forbids subdomaining, "0" otherwise.
37854 .vitem &%$dkim_key_srvtype%&
37855 Service type (tag s=) from the key record. Defaults to "*" if not specified
37856 in the key record.
37857 .vitem &%$dkim_key_granularity%&
37858 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
37859 in the key record.
37860 .vitem &%$dkim_key_notes%&
37861 Notes from the key record (tag n=).
37862 .endlist
37863
37864 In addition, two ACL conditions are provided:
37865
37866 .vlist
37867 .vitem &%dkim_signers%&
37868 ACL condition that checks a colon-separated list of domains or identities
37869 for a match against the domain or identity that the ACL is currently verifying
37870 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
37871 verb to a group of domains or identities. For example:
37872
37873 .code
37874 # Warn when Mail purportedly from GMail has no signature at all
37875 warn log_message = GMail sender without DKIM signature
37876      sender_domains = gmail.com
37877      dkim_signers = gmail.com
37878      dkim_status = none
37879 .endd
37880
37881 .vitem &%dkim_status%&
37882 ACL condition that checks a colon-separated list of possible DKIM verification
37883 results against the actual result of verification. This is typically used
37884 to restrict an ACL verb to a list of verification outcomes, for example:
37885
37886 .code
37887 deny message = Mail from Paypal with invalid/missing signature
37888      sender_domains = paypal.com:paypal.de
37889      dkim_signers = paypal.com:paypal.de
37890      dkim_status = none:invalid:fail
37891 .endd
37892
37893 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
37894 see the documentation of the &%$dkim_verify_status%& expansion variable above
37895 for more information of what they mean.
37896 .endlist
37897
37898 . ////////////////////////////////////////////////////////////////////////////
37899 . ////////////////////////////////////////////////////////////////////////////
37900
37901 .chapter "Adding new drivers or lookup types" "CHID13" &&&
37902          "Adding drivers or lookups"
37903 .cindex "adding drivers"
37904 .cindex "new drivers, adding"
37905 .cindex "drivers" "adding new"
37906 The following actions have to be taken in order to add a new router, transport,
37907 authenticator, or lookup type to Exim:
37908
37909 .olist
37910 Choose a name for the driver or lookup type that does not conflict with any
37911 existing name; I will use &"newdriver"& in what follows.
37912 .next
37913 Add to &_src/EDITME_& the line:
37914 .display
37915 <&'type'&>&`_NEWDRIVER=yes`&
37916 .endd
37917 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
37918 code is not to be included in the binary by default, comment this line out. You
37919 should also add any relevant comments about the driver or lookup type.
37920 .next
37921 Add to &_src/config.h.defaults_& the line:
37922 .code
37923 #define <type>_NEWDRIVER
37924 .endd
37925 .next
37926 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
37927 and create a table entry as is done for all the other drivers and lookup types.
37928 .next
37929 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
37930 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
37931 Add your &`NEWDRIVER`& to that list.
37932 As long as the dynamic module would be named &_newdriver.so_&, you can use the
37933 simple form that most lookups have.
37934 .next
37935 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
37936 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
37937 driver or lookup type and add it to the definition of OBJ.
37938 .next
37939 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
37940 &_src_&.
37941 .next
37942 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
37943 as for other drivers and lookups.
37944 .endlist
37945
37946 Then all you need to do is write the code! A good way to start is to make a
37947 proforma by copying an existing module of the same type, globally changing all
37948 occurrences of the name, and cutting out most of the code. Note that any
37949 options you create must be listed in alphabetical order, because the tables are
37950 searched using a binary chop procedure.
37951
37952 There is a &_README_& file in each of the sub-directories of &_src_& describing
37953 the interface that is expected.
37954
37955
37956
37957
37958 . ////////////////////////////////////////////////////////////////////////////
37959 . ////////////////////////////////////////////////////////////////////////////
37960
37961 . /////////////////////////////////////////////////////////////////////////////
37962 . These lines are processing instructions for the Simple DocBook Processor that
37963 . Philip Hazel has developed as a less cumbersome way of making PostScript and
37964 . PDFs than using xmlto and fop. They will be ignored by all other XML
37965 . processors.
37966 . /////////////////////////////////////////////////////////////////////////////
37967
37968 .literal xml
37969 <?sdop
37970   format="newpage"
37971   foot_right_recto="&chaptertitle;"
37972   foot_right_verso="&chaptertitle;"
37973 ?>
37974 .literal off
37975
37976 .makeindex "Options index"   "option"
37977 .makeindex "Variables index" "variable"
37978 .makeindex "Concept index"   "concept"
37979
37980
37981 . /////////////////////////////////////////////////////////////////////////////
37982 . /////////////////////////////////////////////////////////////////////////////