Add macro support to -be expansion test mode. Bug 1623
[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.89"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2017
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 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP and web sites" "SECID2"
449 .cindex "web site"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is currently the University of
452 Cambridge's FTP site, whose contents are described in &'Where to find the Exim
453 distribution'& below. In addition, there is a web site and an FTP site at
454 &%exim.org%&. These are now also hosted at the University of Cambridge. The
455 &%exim.org%& site was previously hosted for a number of years by Energis
456 Squared, formerly Planet Online Ltd, whose support I gratefully acknowledge.
457
458 .cindex "wiki"
459 .cindex "FAQ"
460 As well as Exim distribution tar files, the Exim web site contains a number of
461 differently formatted versions of the documentation. A recent addition to the
462 online information is the Exim wiki (&url(http://wiki.exim.org)),
463 which contains what used to be a separate FAQ, as well as various other
464 examples, tips, and know-how that have been contributed by Exim users.
465
466 .cindex Bugzilla
467 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
468 this to report bugs, and also to add items to the wish list. Please search
469 first to check that you are not duplicating a previous entry.
470
471
472
473 .section "Mailing lists" "SECID3"
474 .cindex "mailing lists" "for Exim users"
475 The following Exim mailing lists exist:
476
477 .table2 140pt
478 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
479 .row &'exim-users@exim.org'&      "General discussion list"
480 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
481 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
482 .endtable
483
484 You can subscribe to these lists, change your existing subscriptions, and view
485 or search the archives via the mailing lists link on the Exim home page.
486 .cindex "Debian" "mailing list for"
487 If you are using a Debian distribution of Exim, you may wish to subscribe to
488 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
489 via this web page:
490 .display
491 &url(http://lists.alioth.debian.org/mailman/listinfo/pkg-exim4-users)
492 .endd
493 Please ask Debian-specific questions on this list and not on the general Exim
494 lists.
495
496 .section "Bug reports" "SECID5"
497 .cindex "bug reports"
498 .cindex "reporting bugs"
499 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
500 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
501 whether some behaviour is a bug or not, the best thing to do is to post a
502 message to the &'exim-dev'& mailing list and have it discussed.
503
504
505
506 .section "Where to find the Exim distribution" "SECTavail"
507 .cindex "FTP site"
508 .cindex "distribution" "ftp site"
509 The master ftp site for the Exim distribution is
510 .display
511 &*ftp://ftp.exim.org/pub/exim*&
512 .endd
513 The file references that follow are relative to the &_exim_& directories at
514 these sites. There are now quite a number of independent mirror sites around
515 the world. Those that I know about are listed in the file called &_Mirrors_&.
516
517 Within the &_exim_& directory there are subdirectories called &_exim3_& (for
518 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
519 distributions), and &_Testing_& for testing versions. In the &_exim4_&
520 subdirectory, the current release can always be found in files called
521 .display
522 &_exim-n.nn.tar.gz_&
523 &_exim-n.nn.tar.bz2_&
524 .endd
525 where &'n.nn'& is the highest such version number in the directory. The two
526 files contain identical data; the only difference is the type of compression.
527 The &_.bz2_& file is usually a lot smaller than the &_.gz_& file.
528
529 .cindex "distribution" "signing details"
530 .cindex "distribution" "public key"
531 .cindex "public key for signed distribution"
532 The distributions will be PGP signed by an individual key of the Release
533 Coordinator.  This key will have a uid containing an email address in the
534 &'exim.org'& domain and will have signatures from other people, including
535 other Exim maintainers.  We expect that the key will be in the "strong set" of
536 PGP keys.  There should be a trust path to that key from Nigel Metheringham's
537 PGP key, a version of which can be found in the release directory in the file
538 &_nigel-pubkey.asc_&.  All keys used will be available in public keyserver pools,
539 such as &'pool.sks-keyservers.net'&.
540
541 At time of last update, releases were being made by Phil Pennock and signed with
542 key &'0x403043153903637F'&, although that key is expected to be replaced in 2013.
543 A trust path from Nigel's key to Phil's can be observed at
544 &url(https://www.security.spodhuis.org/exim-trustpath).
545
546 Releases have also been authorized to be performed by Todd Lyons who signs with
547 key &'0xC4F4F94804D29EBA'&. A direct trust path exists between previous RE Phil
548 Pennock and Todd Lyons through a common associate.
549
550 The signatures for the tar bundles are in:
551 .display
552 &_exim-n.nn.tar.gz.asc_&
553 &_exim-n.nn.tar.bz2.asc_&
554 .endd
555 For each released version, the log of changes is made separately available in a
556 separate file in the directory &_ChangeLogs_& so that it is possible to
557 find out what has changed without having to download the entire distribution.
558
559 .cindex "documentation" "available formats"
560 The main distribution contains ASCII versions of this specification and other
561 documentation; other formats of the documents are available in separate files
562 inside the &_exim4_& directory of the FTP site:
563 .display
564 &_exim-html-n.nn.tar.gz_&
565 &_exim-pdf-n.nn.tar.gz_&
566 &_exim-postscript-n.nn.tar.gz_&
567 &_exim-texinfo-n.nn.tar.gz_&
568 .endd
569 These tar files contain only the &_doc_& directory, not the complete
570 distribution, and are also available in &_.bz2_& as well as &_.gz_& forms.
571
572
573 .section "Limitations" "SECID6"
574 .ilist
575 .cindex "limitations of Exim"
576 .cindex "bang paths" "not handled by Exim"
577 Exim is designed for use as an Internet MTA, and therefore handles addresses in
578 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
579 simple two-component bang paths can be converted by a straightforward rewriting
580 configuration. This restriction does not prevent Exim from being interfaced to
581 UUCP as a transport mechanism, provided that domain addresses are used.
582 .next
583 .cindex "domainless addresses"
584 .cindex "address" "without domain"
585 Exim insists that every address it handles has a domain attached. For incoming
586 local messages, domainless addresses are automatically qualified with a
587 configured domain value. Configuration options specify from which remote
588 systems unqualified addresses are acceptable. These are then qualified on
589 arrival.
590 .next
591 .cindex "transport" "external"
592 .cindex "external transports"
593 The only external transport mechanisms that are currently implemented are SMTP
594 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
595 transport is available, and there are facilities for writing messages to files
596 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
597 to send messages to other transport mechanisms such as UUCP, provided they can
598 handle domain-style addresses. Batched SMTP input is also catered for.
599 .next
600 Exim is not designed for storing mail for dial-in hosts. When the volumes of
601 such mail are large, it is better to get the messages &"delivered"& into files
602 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
603 other means.
604 .next
605 Although Exim does have basic facilities for scanning incoming messages, these
606 are not comprehensive enough to do full virus or spam scanning. Such operations
607 are best carried out using additional specialized software packages. If you
608 compile Exim with the content-scanning extension, straightforward interfaces to
609 a number of common scanners are provided.
610 .endlist
611
612
613 .section "Run time configuration" "SECID7"
614 Exim's run time configuration is held in a single text file that is divided
615 into a number of sections. The entries in this file consist of keywords and
616 values, in the style of Smail 3 configuration files. A default configuration
617 file which is suitable for simple online installations is provided in the
618 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
619
620
621 .section "Calling interface" "SECID8"
622 .cindex "Sendmail compatibility" "command line interface"
623 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
624 can be a straight replacement for &_/usr/lib/sendmail_& or
625 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
626 about Sendmail in order to run Exim. For actions other than sending messages,
627 Sendmail-compatible options also exist, but those that produce output (for
628 example, &%-bp%&, which lists the messages on the queue) do so in Exim's own
629 format. There are also some additional options that are compatible with Smail
630 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
631 documents all Exim's command line options. This information is automatically
632 made into the man page that forms part of the Exim distribution.
633
634 Control of messages on the queue can be done via certain privileged command
635 line options. There is also an optional monitor program called &'eximon'&,
636 which displays current information in an X window, and which contains a menu
637 interface to Exim's command line administration options.
638
639
640
641 .section "Terminology" "SECID9"
642 .cindex "terminology definitions"
643 .cindex "body of message" "definition of"
644 The &'body'& of a message is the actual data that the sender wants to transmit.
645 It is the last part of a message, and is separated from the &'header'& (see
646 below) by a blank line.
647
648 .cindex "bounce message" "definition of"
649 When a message cannot be delivered, it is normally returned to the sender in a
650 delivery failure message or a &"non-delivery report"& (NDR). The term
651 &'bounce'& is commonly used for this action, and the error reports are often
652 called &'bounce messages'&. This is a convenient shorthand for &"delivery
653 failure error report"&. Such messages have an empty sender address in the
654 message's &'envelope'& (see below) to ensure that they cannot themselves give
655 rise to further bounce messages.
656
657 The term &'default'& appears frequently in this manual. It is used to qualify a
658 value which is used in the absence of any setting in the configuration. It may
659 also qualify an action which is taken unless a configuration setting specifies
660 otherwise.
661
662 The term &'defer'& is used when the delivery of a message to a specific
663 destination cannot immediately take place for some reason (a remote host may be
664 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
665 until a later time.
666
667 The word &'domain'& is sometimes used to mean all but the first component of a
668 host's name. It is &'not'& used in that sense here, where it normally refers to
669 the part of an email address following the @ sign.
670
671 .cindex "envelope, definition of"
672 .cindex "sender" "definition of"
673 A message in transit has an associated &'envelope'&, as well as a header and a
674 body. The envelope contains a sender address (to which bounce messages should
675 be delivered), and any number of recipient addresses. References to the
676 sender or the recipients of a message usually mean the addresses in the
677 envelope. An MTA uses these addresses for delivery, and for returning bounce
678 messages, not the addresses that appear in the header lines.
679
680 .cindex "message" "header, definition of"
681 .cindex "header section" "definition of"
682 The &'header'& of a message is the first part of a message's text, consisting
683 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
684 &'Subject:'&, etc. Long header lines can be split over several text lines by
685 indenting the continuations. The header is separated from the body by a blank
686 line.
687
688 .cindex "local part" "definition of"
689 .cindex "domain" "definition of"
690 The term &'local part'&, which is taken from RFC 2822, is used to refer to that
691 part of an email address that precedes the @ sign. The part that follows the
692 @ sign is called the &'domain'& or &'mail domain'&.
693
694 .cindex "local delivery" "definition of"
695 .cindex "remote delivery, definition of"
696 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
697 delivery to a file or a pipe on the local host from delivery by SMTP over
698 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
699 host it is running on are &'remote'&.
700
701 .cindex "return path" "definition of"
702 &'Return path'& is another name that is used for the sender address in a
703 message's envelope.
704
705 .cindex "queue" "definition of"
706 The term &'queue'& is used to refer to the set of messages awaiting delivery,
707 because this term is in widespread use in the context of MTAs. However, in
708 Exim's case the reality is more like a pool than a queue, because there is
709 normally no ordering of waiting messages.
710
711 .cindex "queue runner" "definition of"
712 The term &'queue runner'& is used to describe a process that scans the queue
713 and attempts to deliver those messages whose retry times have come. This term
714 is used by other MTAs, and also relates to the command &%runq%&, but in Exim
715 the waiting messages are normally processed in an unpredictable order.
716
717 .cindex "spool directory" "definition of"
718 The term &'spool directory'& is used for a directory in which Exim keeps the
719 messages on its queue &-- that is, those that it is in the process of
720 delivering. This should not be confused with the directory in which local
721 mailboxes are stored, which is called a &"spool directory"& by some people. In
722 the Exim documentation, &"spool"& is always used in the first sense.
723
724
725
726
727
728
729 . ////////////////////////////////////////////////////////////////////////////
730 . ////////////////////////////////////////////////////////////////////////////
731
732 .chapter "Incorporated code" "CHID2"
733 .cindex "incorporated code"
734 .cindex "regular expressions" "library"
735 .cindex "PCRE"
736 .cindex "OpenDMARC"
737 A number of pieces of external code are included in the Exim distribution.
738
739 .ilist
740 Regular expressions are supported in the main Exim program and in the
741 Exim monitor using the freely-distributable PCRE library, copyright
742 &copy; University of Cambridge. The source to PCRE is no longer shipped with
743 Exim, so you will need to use the version of PCRE shipped with your system,
744 or obtain and install the full version of the library from
745 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
746 .next
747 .cindex "cdb" "acknowledgment"
748 Support for the cdb (Constant DataBase) lookup method is provided by code
749 contributed by Nigel Metheringham of (at the time he contributed it) Planet
750 Online Ltd. The implementation is completely contained within the code of Exim.
751 It does not link against an external cdb library. The code contains the
752 following statements:
753
754 .blockquote
755 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
756
757 This program is free software; you can redistribute it and/or modify it under
758 the terms of the GNU General Public License as published by the Free Software
759 Foundation; either version 2 of the License, or (at your option) any later
760 version.
761 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
762 the spec and sample code for cdb can be obtained from
763 &url(http://www.pobox.com/~djb/cdb.html). This implementation borrows
764 some code from Dan Bernstein's implementation (which has no license
765 restrictions applied to it).
766 .endblockquote
767 .next
768 .cindex "SPA authentication"
769 .cindex "Samba project"
770 .cindex "Microsoft Secure Password Authentication"
771 Client support for Microsoft's &'Secure Password Authentication'& is provided
772 by code contributed by Marc Prud'hommeaux. Server support was contributed by
773 Tom Kistner. This includes code taken from the Samba project, which is released
774 under the Gnu GPL.
775 .next
776 .cindex "Cyrus"
777 .cindex "&'pwcheck'& daemon"
778 .cindex "&'pwauthd'& daemon"
779 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
780 by code taken from the Cyrus-SASL library and adapted by Alexander S.
781 Sabourenkov. The permission notice appears below, in accordance with the
782 conditions expressed therein.
783
784 .blockquote
785 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
786
787 Redistribution and use in source and binary forms, with or without
788 modification, are permitted provided that the following conditions
789 are met:
790
791 .olist
792 Redistributions of source code must retain the above copyright
793 notice, this list of conditions and the following disclaimer.
794 .next
795 Redistributions in binary form must reproduce the above copyright
796 notice, this list of conditions and the following disclaimer in
797 the documentation and/or other materials provided with the
798 distribution.
799 .next
800 The name &"Carnegie Mellon University"& must not be used to
801 endorse or promote products derived from this software without
802 prior written permission. For permission or any other legal
803 details, please contact
804 .display
805               Office of Technology Transfer
806               Carnegie Mellon University
807               5000 Forbes Avenue
808               Pittsburgh, PA  15213-3890
809               (412) 268-4387, fax: (412) 268-7395
810               tech-transfer@andrew.cmu.edu
811 .endd
812 .next
813 Redistributions of any form whatsoever must retain the following
814 acknowledgment:
815
816 &"This product includes software developed by Computing Services
817 at Carnegie Mellon University (&url(http://www.cmu.edu/computing/)."&
818
819 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
820 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
821 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
822 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
823 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
824 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
825 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
826 .endlist
827 .endblockquote
828
829 .next
830 .cindex "Exim monitor" "acknowledgment"
831 .cindex "X-windows"
832 .cindex "Athena"
833 The Exim Monitor program, which is an X-Window application, includes
834 modified versions of the Athena StripChart and TextPop widgets.
835 This code is copyright by DEC and MIT, and their permission notice appears
836 below, in accordance with the conditions expressed therein.
837
838 .blockquote
839 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
840 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
841
842 All Rights Reserved
843
844 Permission to use, copy, modify, and distribute this software and its
845 documentation for any purpose and without fee is hereby granted,
846 provided that the above copyright notice appear in all copies and that
847 both that copyright notice and this permission notice appear in
848 supporting documentation, and that the names of Digital or MIT not be
849 used in advertising or publicity pertaining to distribution of the
850 software without specific, written prior permission.
851
852 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
853 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
854 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
855 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
856 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
857 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
858 SOFTWARE.
859 .endblockquote
860
861 .next
862 .cindex "opendmarc" "acknowledgment"
863 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
864 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
865 derived code are indicated in the respective source files. The full OpenDMARC
866 license is provided in the LICENSE.opendmarc file contained in the distributed
867 source code.
868
869 .next
870 Many people have contributed code fragments, some large, some small, that were
871 not covered by any specific licence requirements. It is assumed that the
872 contributors are happy to see their code incorporated into Exim under the GPL.
873 .endlist
874
875
876
877
878
879 . ////////////////////////////////////////////////////////////////////////////
880 . ////////////////////////////////////////////////////////////////////////////
881
882 .chapter "How Exim receives and delivers mail" "CHID11" &&&
883          "Receiving and delivering mail"
884
885
886 .section "Overall philosophy" "SECID10"
887 .cindex "design philosophy"
888 Exim is designed to work efficiently on systems that are permanently connected
889 to the Internet and are handling a general mix of mail. In such circumstances,
890 most messages can be delivered immediately. Consequently, Exim does not
891 maintain independent queues of messages for specific domains or hosts, though
892 it does try to send several messages in a single SMTP connection after a host
893 has been down, and it also maintains per-host retry information.
894
895
896 .section "Policy control" "SECID11"
897 .cindex "policy control" "overview"
898 Policy controls are now an important feature of MTAs that are connected to the
899 Internet. Perhaps their most important job is to stop MTAs being abused as
900 &"open relays"& by misguided individuals who send out vast amounts of
901 unsolicited junk, and want to disguise its source. Exim provides flexible
902 facilities for specifying policy controls on incoming mail:
903
904 .ilist
905 .cindex "&ACL;" "introduction"
906 Exim 4 (unlike previous versions of Exim) implements policy controls on
907 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
908 series of statements that may either grant or deny access. ACLs can be used at
909 several places in the SMTP dialogue while receiving a message from a remote
910 host. However, the most common places are after each RCPT command, and at the
911 very end of the message. The sysadmin can specify conditions for accepting or
912 rejecting individual recipients or the entire message, respectively, at these
913 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
914 error code.
915 .next
916 An ACL is also available for locally generated, non-SMTP messages. In this
917 case, the only available actions are to accept or deny the entire message.
918 .next
919 When Exim is compiled with the content-scanning extension, facilities are
920 provided in the ACL mechanism for passing the message to external virus and/or
921 spam scanning software. The result of such a scan is passed back to the ACL,
922 which can then use it to decide what to do with the message.
923 .next
924 When a message has been received, either from a remote host or from the local
925 host, but before the final acknowledgment has been sent, a locally supplied C
926 function called &[local_scan()]& can be run to inspect the message and decide
927 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
928 is accepted, the list of recipients can be modified by the function.
929 .next
930 Using the &[local_scan()]& mechanism is another way of calling external scanner
931 software. The &%SA-Exim%& add-on package works this way. It does not require
932 Exim to be compiled with the content-scanning extension.
933 .next
934 After a message has been accepted, a further checking mechanism is available in
935 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
936 runs at the start of every delivery process.
937 .endlist
938
939
940
941 .section "User filters" "SECID12"
942 .cindex "filter" "introduction"
943 .cindex "Sieve filter"
944 In a conventional Exim configuration, users are able to run private filters by
945 setting up appropriate &_.forward_& files in their home directories. See
946 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
947 configuration needed to support this, and the separate document entitled
948 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
949 of filtering are available:
950
951 .ilist
952 Sieve filters are written in the standard filtering language that is defined
953 by RFC 3028.
954 .next
955 Exim filters are written in a syntax that is unique to Exim, but which is more
956 powerful than Sieve, which it pre-dates.
957 .endlist
958
959 User filters are run as part of the routing process, described below.
960
961
962
963 .section "Message identification" "SECTmessiden"
964 .cindex "message ids" "details of format"
965 .cindex "format" "of message id"
966 .cindex "id of message"
967 .cindex "base62"
968 .cindex "base36"
969 .cindex "Darwin"
970 .cindex "Cygwin"
971 Every message handled by Exim is given a &'message id'& which is sixteen
972 characters long. It is divided into three parts, separated by hyphens, for
973 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
974 normally encoding numbers in base 62. However, in the Darwin operating
975 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
976 (avoiding the use of lower case letters) is used instead, because the message
977 id is used to construct file names, and the names of files in those systems are
978 not always case-sensitive.
979
980 .cindex "pid (process id)" "re-use of"
981 The detail of the contents of the message id have changed as Exim has evolved.
982 Earlier versions relied on the operating system not re-using a process id (pid)
983 within one second. On modern operating systems, this assumption can no longer
984 be made, so the algorithm had to be changed. To retain backward compatibility,
985 the format of the message id was retained, which is why the following rules are
986 somewhat eccentric:
987
988 .ilist
989 The first six characters of the message id are the time at which the message
990 started to be received, to a granularity of one second. That is, this field
991 contains the number of seconds since the start of the epoch (the normal Unix
992 way of representing the date and time of day).
993 .next
994 After the first hyphen, the next six characters are the id of the process that
995 received the message.
996 .next
997 There are two different possibilities for the final two characters:
998 .olist
999 .oindex "&%localhost_number%&"
1000 If &%localhost_number%& is not set, this value is the fractional part of the
1001 time of reception, normally in units of 1/2000 of a second, but for systems
1002 that must use base 36 instead of base 62 (because of case-insensitive file
1003 systems), the units are 1/1000 of a second.
1004 .next
1005 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1006 the fractional part of the time, which in this case is in units of 1/200
1007 (1/100) of a second.
1008 .endlist
1009 .endlist
1010
1011 After a message has been received, Exim waits for the clock to tick at the
1012 appropriate resolution before proceeding, so that if another message is
1013 received by the same process, or by another process with the same (re-used)
1014 pid, it is guaranteed that the time will be different. In most cases, the clock
1015 will already have ticked while the message was being received.
1016
1017
1018 .section "Receiving mail" "SECID13"
1019 .cindex "receiving mail"
1020 .cindex "message" "reception"
1021 The only way Exim can receive mail from another host is using SMTP over
1022 TCP/IP, in which case the sender and recipient addresses are transferred using
1023 SMTP commands. However, from a locally running process (such as a user's MUA),
1024 there are several possibilities:
1025
1026 .ilist
1027 If the process runs Exim with the &%-bm%& option, the message is read
1028 non-interactively (usually via a pipe), with the recipients taken from the
1029 command line, or from the body of the message if &%-t%& is also used.
1030 .next
1031 If the process runs Exim with the &%-bS%& option, the message is also read
1032 non-interactively, but in this case the recipients are listed at the start of
1033 the message in a series of SMTP RCPT commands, terminated by a DATA
1034 command. This is so-called &"batch SMTP"& format,
1035 but it isn't really SMTP. The SMTP commands are just another way of passing
1036 envelope addresses in a non-interactive submission.
1037 .next
1038 If the process runs Exim with the &%-bs%& option, the message is read
1039 interactively, using the SMTP protocol. A two-way pipe is normally used for
1040 passing data between the local process and the Exim process.
1041 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1042 example, the ACLs for SMTP commands are used for this form of submission.
1043 .next
1044 A local process may also make a TCP/IP call to the host's loopback address
1045 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1046 does not treat the loopback address specially. It treats all such connections
1047 in the same way as connections from other hosts.
1048 .endlist
1049
1050
1051 .cindex "message sender, constructed by Exim"
1052 .cindex "sender" "constructed by Exim"
1053 In the three cases that do not involve TCP/IP, the sender address is
1054 constructed from the login name of the user that called Exim and a default
1055 qualification domain (which can be set by the &%qualify_domain%& configuration
1056 option). For local or batch SMTP, a sender address that is passed using the
1057 SMTP MAIL command is ignored. However, the system administrator may allow
1058 certain users (&"trusted users"&) to specify a different sender address
1059 unconditionally, or all users to specify certain forms of different sender
1060 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1061 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1062 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1063 users to change sender addresses.
1064
1065 Messages received by either of the non-interactive mechanisms are subject to
1066 checking by the non-SMTP ACL, if one is defined. Messages received using SMTP
1067 (either over TCP/IP, or interacting with a local process) can be checked by a
1068 number of ACLs that operate at different times during the SMTP session. Either
1069 individual recipients, or the entire message, can be rejected if local policy
1070 requirements are not met. The &[local_scan()]& function (see chapter
1071 &<<CHAPlocalscan>>&) is run for all incoming messages.
1072
1073 Exim can be configured not to start a delivery process when a message is
1074 received; this can be unconditional, or depend on the number of incoming SMTP
1075 connections or the system load. In these situations, new messages wait on the
1076 queue until a queue runner process picks them up. However, in standard
1077 configurations under normal conditions, delivery is started as soon as a
1078 message is received.
1079
1080
1081
1082
1083
1084 .section "Handling an incoming message" "SECID14"
1085 .cindex "spool directory" "files that hold a message"
1086 .cindex "file" "how a message is held"
1087 When Exim accepts a message, it writes two files in its spool directory. The
1088 first contains the envelope information, the current status of the message, and
1089 the header lines, and the second contains the body of the message. The names of
1090 the two spool files consist of the message id, followed by &`-H`& for the
1091 file containing the envelope and header, and &`-D`& for the data file.
1092
1093 .cindex "spool directory" "&_input_& sub-directory"
1094 By default all these message files are held in a single directory called
1095 &_input_& inside the general Exim spool directory. Some operating systems do
1096 not perform very well if the number of files in a directory gets large; to
1097 improve performance in such cases, the &%split_spool_directory%& option can be
1098 used. This causes Exim to split up the input files into 62 sub-directories
1099 whose names are single letters or digits. When this is done, the queue is
1100 processed one sub-directory at a time instead of all at once, which can improve
1101 overall performance even when there are not enough files in each directory to
1102 affect file system performance.
1103
1104 The envelope information consists of the address of the message's sender and
1105 the addresses of the recipients. This information is entirely separate from
1106 any addresses contained in the header lines. The status of the message includes
1107 a list of recipients who have already received the message. The format of the
1108 first spool file is described in chapter &<<CHAPspool>>&.
1109
1110 .cindex "rewriting" "addresses"
1111 Address rewriting that is specified in the rewrite section of the configuration
1112 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1113 both in the header lines and the envelope, at the time the message is accepted.
1114 If during the course of delivery additional addresses are generated (for
1115 example, via aliasing), these new addresses are rewritten as soon as they are
1116 generated. At the time a message is actually delivered (transported) further
1117 rewriting can take place; because this is a transport option, it can be
1118 different for different forms of delivery. It is also possible to specify the
1119 addition or removal of certain header lines at the time the message is
1120 delivered (see chapters &<<CHAProutergeneric>>& and
1121 &<<CHAPtransportgeneric>>&).
1122
1123
1124
1125 .section "Life of a message" "SECID15"
1126 .cindex "message" "life of"
1127 .cindex "message" "frozen"
1128 A message remains in the spool directory until it is completely delivered to
1129 its recipients or to an error address, or until it is deleted by an
1130 administrator or by the user who originally created it. In cases when delivery
1131 cannot proceed &-- for example, when a message can neither be delivered to its
1132 recipients nor returned to its sender, the message is marked &"frozen"& on the
1133 spool, and no more deliveries are attempted.
1134
1135 .cindex "frozen messages" "thawing"
1136 .cindex "message" "thawing frozen"
1137 An administrator can &"thaw"& such messages when the problem has been
1138 corrected, and can also freeze individual messages by hand if necessary. In
1139 addition, an administrator can force a delivery error, causing a bounce message
1140 to be sent.
1141
1142 .oindex "&%timeout_frozen_after%&"
1143 .oindex "&%ignore_bounce_errors_after%&"
1144 There are options called &%ignore_bounce_errors_after%& and
1145 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1146 The first applies only to frozen bounces, the second to any frozen messages.
1147
1148 .cindex "message" "log file for"
1149 .cindex "log" "file for each message"
1150 While Exim is working on a message, it writes information about each delivery
1151 attempt to its main log file. This includes successful, unsuccessful, and
1152 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1153 lines are also written to a separate &'message log'& file for each message.
1154 These logs are solely for the benefit of the administrator, and are normally
1155 deleted along with the spool files when processing of a message is complete.
1156 The use of individual message logs can be disabled by setting
1157 &%no_message_logs%&; this might give an improvement in performance on very busy
1158 systems.
1159
1160 .cindex "journal file"
1161 .cindex "file" "journal"
1162 All the information Exim itself needs to set up a delivery is kept in the first
1163 spool file, along with the header lines. When a successful delivery occurs, the
1164 address is immediately written at the end of a journal file, whose name is the
1165 message id followed by &`-J`&. At the end of a delivery run, if there are some
1166 addresses left to be tried again later, the first spool file (the &`-H`& file)
1167 is updated to indicate which these are, and the journal file is then deleted.
1168 Updating the spool file is done by writing a new file and renaming it, to
1169 minimize the possibility of data loss.
1170
1171 Should the system or the program crash after a successful delivery but before
1172 the spool file has been updated, the journal is left lying around. The next
1173 time Exim attempts to deliver the message, it reads the journal file and
1174 updates the spool file before proceeding. This minimizes the chances of double
1175 deliveries caused by crashes.
1176
1177
1178
1179 .section "Processing an address for delivery" "SECTprocaddress"
1180 .cindex "drivers" "definition of"
1181 .cindex "router" "definition of"
1182 .cindex "transport" "definition of"
1183 The main delivery processing elements of Exim are called &'routers'& and
1184 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1185 number of them is provided in the source distribution, and compile-time options
1186 specify which ones are included in the binary. Run time options specify which
1187 ones are actually used for delivering messages.
1188
1189 .cindex "drivers" "instance definition"
1190 Each driver that is specified in the run time configuration is an &'instance'&
1191 of that particular driver type. Multiple instances are allowed; for example,
1192 you can set up several different &(smtp)& transports, each with different
1193 option values that might specify different ports or different timeouts. Each
1194 instance has its own identifying name. In what follows we will normally use the
1195 instance name when discussing one particular instance (that is, one specific
1196 configuration of the driver), and the generic driver name when discussing
1197 the driver's features in general.
1198
1199 A &'router'& is a driver that operates on an address, either determining how
1200 its delivery should happen, by assigning it to a specific transport, or
1201 converting the address into one or more new addresses (for example, via an
1202 alias file). A router may also explicitly choose to fail an address, causing it
1203 to be bounced.
1204
1205 A &'transport'& is a driver that transmits a copy of the message from Exim's
1206 spool to some destination. There are two kinds of transport: for a &'local'&
1207 transport, the destination is a file or a pipe on the local host, whereas for a
1208 &'remote'& transport the destination is some other host. A message is passed
1209 to a specific transport as a result of successful routing. If a message has
1210 several recipients, it may be passed to a number of different transports.
1211
1212 .cindex "preconditions" "definition of"
1213 An address is processed by passing it to each configured router instance in
1214 turn, subject to certain preconditions, until a router accepts the address or
1215 specifies that it should be bounced. We will describe this process in more
1216 detail shortly. First, as a simple example, we consider how each recipient
1217 address in a message is processed in a small configuration of three routers.
1218
1219 To make this a more concrete example, it is described in terms of some actual
1220 routers, but remember, this is only an example. You can configure Exim's
1221 routers in many different ways, and there may be any number of routers in a
1222 configuration.
1223
1224 The first router that is specified in a configuration is often one that handles
1225 addresses in domains that are not recognized specially by the local host. These
1226 are typically addresses for arbitrary domains on the Internet. A precondition
1227 is set up which looks for the special domains known to the host (for example,
1228 its own domain name), and the router is run for addresses that do &'not'&
1229 match. Typically, this is a router that looks up domains in the DNS in order to
1230 find the hosts to which this address routes. If it succeeds, the address is
1231 assigned to a suitable SMTP transport; if it does not succeed, the router is
1232 configured to fail the address.
1233
1234 The second router is reached only when the domain is recognized as one that
1235 &"belongs"& to the local host. This router does redirection &-- also known as
1236 aliasing and forwarding. When it generates one or more new addresses from the
1237 original, each of them is routed independently from the start. Otherwise, the
1238 router may cause an address to fail, or it may simply decline to handle the
1239 address, in which case the address is passed to the next router.
1240
1241 The final router in many configurations is one that checks to see if the
1242 address belongs to a local mailbox. The precondition may involve a check to
1243 see if the local part is the name of a login account, or it may look up the
1244 local part in a file or a database. If its preconditions are not met, or if
1245 the router declines, we have reached the end of the routers. When this happens,
1246 the address is bounced.
1247
1248
1249
1250 .section "Processing an address for verification" "SECID16"
1251 .cindex "router" "for verification"
1252 .cindex "verifying address" "overview"
1253 As well as being used to decide how to deliver to an address, Exim's routers
1254 are also used for &'address verification'&. Verification can be requested as
1255 one of the checks to be performed in an ACL for incoming messages, on both
1256 sender and recipient addresses, and it can be tested using the &%-bv%& and
1257 &%-bvs%& command line options.
1258
1259 When an address is being verified, the routers are run in &"verify mode"&. This
1260 does not affect the way the routers work, but it is a state that can be
1261 detected. By this means, a router can be skipped or made to behave differently
1262 when verifying. A common example is a configuration in which the first router
1263 sends all messages to a message-scanning program, unless they have been
1264 previously scanned. Thus, the first router accepts all addresses without any
1265 checking, making it useless for verifying. Normally, the &%no_verify%& option
1266 would be set for such a router, causing it to be skipped in verify mode.
1267
1268
1269
1270
1271 .section "Running an individual router" "SECTrunindrou"
1272 .cindex "router" "running details"
1273 .cindex "preconditions" "checking"
1274 .cindex "router" "result of running"
1275 As explained in the example above, a number of preconditions are checked before
1276 running a router. If any are not met, the router is skipped, and the address is
1277 passed to the next router. When all the preconditions on a router &'are'& met,
1278 the router is run. What happens next depends on the outcome, which is one of
1279 the following:
1280
1281 .ilist
1282 &'accept'&: The router accepts the address, and either assigns it to a
1283 transport, or generates one or more &"child"& addresses. Processing the
1284 original address ceases,
1285 .oindex "&%unseen%&"
1286 unless the &%unseen%& option is set on the router. This option
1287 can be used to set up multiple deliveries with different routing (for example,
1288 for keeping archive copies of messages). When &%unseen%& is set, the address is
1289 passed to the next router. Normally, however, an &'accept'& return marks the
1290 end of routing.
1291
1292 Any child addresses generated by the router are processed independently,
1293 starting with the first router by default. It is possible to change this by
1294 setting the &%redirect_router%& option to specify which router to start at for
1295 child addresses. Unlike &%pass_router%& (see below) the router specified by
1296 &%redirect_router%& may be anywhere in the router configuration.
1297 .next
1298 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1299 requests that the address be passed to another router. By default the address
1300 is passed to the next router, but this can be changed by setting the
1301 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1302 must be below the current router (to avoid loops).
1303 .next
1304 &'decline'&: The router declines to accept the address because it does not
1305 recognize it at all. By default, the address is passed to the next router, but
1306 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1307 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1308 &'decline'& into &'fail'&.
1309 .next
1310 &'fail'&: The router determines that the address should fail, and queues it for
1311 the generation of a bounce message. There is no further processing of the
1312 original address unless &%unseen%& is set on the router.
1313 .next
1314 &'defer'&: The router cannot handle the address at the present time. (A
1315 database may be offline, or a DNS lookup may have timed out.) No further
1316 processing of the address happens in this delivery attempt. It is tried again
1317 next time the message is considered for delivery.
1318 .next
1319 &'error'&: There is some error in the router (for example, a syntax error in
1320 its configuration). The action is as for defer.
1321 .endlist
1322
1323 If an address reaches the end of the routers without having been accepted by
1324 any of them, it is bounced as unrouteable. The default error message in this
1325 situation is &"unrouteable address"&, but you can set your own message by
1326 making use of the &%cannot_route_message%& option. This can be set for any
1327 router; the value from the last router that &"saw"& the address is used.
1328
1329 Sometimes while routing you want to fail a delivery when some conditions are
1330 met but others are not, instead of passing the address on for further routing.
1331 You can do this by having a second router that explicitly fails the delivery
1332 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1333 facility for this purpose.
1334
1335
1336 .section "Duplicate addresses" "SECID17"
1337 .cindex "case of local parts"
1338 .cindex "address duplicate, discarding"
1339 .cindex "duplicate addresses"
1340 Once routing is complete, Exim scans the addresses that are assigned to local
1341 and remote transports, and discards any duplicates that it finds. During this
1342 check, local parts are treated as case-sensitive. This happens only when
1343 actually delivering a message; when testing routers with &%-bt%&, all the
1344 routed addresses are shown.
1345
1346
1347
1348 .section "Router preconditions" "SECTrouprecon"
1349 .cindex "router" "preconditions, order of processing"
1350 .cindex "preconditions" "order of processing"
1351 The preconditions that are tested for each router are listed below, in the
1352 order in which they are tested. The individual configuration options are
1353 described in more detail in chapter &<<CHAProutergeneric>>&.
1354
1355 .ilist
1356 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1357 the local parts handled by the router may or must have certain prefixes and/or
1358 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1359 skipped. These conditions are tested first. When an affix is present, it is
1360 removed from the local part before further processing, including the evaluation
1361 of any other conditions.
1362 .next
1363 Routers can be designated for use only when not verifying an address, that is,
1364 only when routing it for delivery (or testing its delivery routing). If the
1365 &%verify%& option is set false, the router is skipped when Exim is verifying an
1366 address.
1367 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1368 &%verify_recipient%&, which independently control the use of the router for
1369 sender and recipient verification. You can set these options directly if
1370 you want a router to be used for only one type of verification.
1371 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1372 .next
1373 If the &%address_test%& option is set false, the router is skipped when Exim is
1374 run with the &%-bt%& option to test an address routing. This can be helpful
1375 when the first router sends all new messages to a scanner of some sort; it
1376 makes it possible to use &%-bt%& to test subsequent delivery routing without
1377 having to simulate the effect of the scanner.
1378 .next
1379 Routers can be designated for use only when verifying an address, as
1380 opposed to routing it for delivery. The &%verify_only%& option controls this.
1381 Again, cutthrough delivery counts as a verification.
1382 .next
1383 Individual routers can be explicitly skipped when running the routers to
1384 check an address given in the SMTP EXPN command (see the &%expn%& option).
1385 .next
1386 If the &%domains%& option is set, the domain of the address must be in the set
1387 of domains that it defines.
1388 .next
1389 .vindex "&$local_part_prefix$&"
1390 .vindex "&$local_part$&"
1391 .vindex "&$local_part_suffix$&"
1392 If the &%local_parts%& option is set, the local part of the address must be in
1393 the set of local parts that it defines. If &%local_part_prefix%& or
1394 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1395 part before this check. If you want to do precondition tests on local parts
1396 that include affixes, you can do so by using a &%condition%& option (see below)
1397 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1398 &$local_part_suffix$& as necessary.
1399 .next
1400 .vindex "&$local_user_uid$&"
1401 .vindex "&$local_user_gid$&"
1402 .vindex "&$home$&"
1403 If the &%check_local_user%& option is set, the local part must be the name of
1404 an account on the local host. If this check succeeds, the uid and gid of the
1405 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1406 user's home directory is placed in &$home$&; these values can be used in the
1407 remaining preconditions.
1408 .next
1409 If the &%router_home_directory%& option is set, it is expanded at this point,
1410 because it overrides the value of &$home$&. If this expansion were left till
1411 later, the value of &$home$& as set by &%check_local_user%& would be used in
1412 subsequent tests. Having two different values of &$home$& in the same router
1413 could lead to confusion.
1414 .next
1415 If the &%senders%& option is set, the envelope sender address must be in the
1416 set of addresses that it defines.
1417 .next
1418 If the &%require_files%& option is set, the existence or non-existence of
1419 specified files is tested.
1420 .next
1421 .cindex "customizing" "precondition"
1422 If the &%condition%& option is set, it is evaluated and tested. This option
1423 uses an expanded string to allow you to set up your own custom preconditions.
1424 Expanded strings are described in chapter &<<CHAPexpand>>&.
1425 .endlist
1426
1427
1428 Note that &%require_files%& comes near the end of the list, so you cannot use
1429 it to check for the existence of a file in which to lookup up a domain, local
1430 part, or sender. However, as these options are all expanded, you can use the
1431 &%exists%& expansion condition to make such tests within each condition. The
1432 &%require_files%& option is intended for checking files that the router may be
1433 going to use internally, or which are needed by a specific transport (for
1434 example, &_.procmailrc_&).
1435
1436
1437
1438 .section "Delivery in detail" "SECID18"
1439 .cindex "delivery" "in detail"
1440 When a message is to be delivered, the sequence of events is as follows:
1441
1442 .ilist
1443 If a system-wide filter file is specified, the message is passed to it. The
1444 filter may add recipients to the message, replace the recipients, discard the
1445 message, cause a new message to be generated, or cause the message delivery to
1446 fail. The format of the system filter file is the same as for Exim user filter
1447 files, described in the separate document entitled &'Exim's interfaces to mail
1448 filtering'&.
1449 .cindex "Sieve filter" "not available for system filter"
1450 (&*Note*&: Sieve cannot be used for system filter files.)
1451
1452 Some additional features are available in system filters &-- see chapter
1453 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1454 filter only once per delivery attempt, however many recipients it has. However,
1455 if there are several delivery attempts because one or more addresses could not
1456 be immediately delivered, the system filter is run each time. The filter
1457 condition &%first_delivery%& can be used to detect the first run of the system
1458 filter.
1459 .next
1460 Each recipient address is offered to each configured router in turn, subject to
1461 its preconditions, until one is able to handle it. If no router can handle the
1462 address, that is, if they all decline, the address is failed. Because routers
1463 can be targeted at particular domains, several locally handled domains can be
1464 processed entirely independently of each other.
1465 .next
1466 .cindex "routing" "loops in"
1467 .cindex "loop" "while routing"
1468 A router that accepts an address may assign it to a local or a remote
1469 transport. However, the transport is not run at this time. Instead, the address
1470 is placed on a list for the particular transport, which will be run later.
1471 Alternatively, the router may generate one or more new addresses (typically
1472 from alias, forward, or filter files). New addresses are fed back into this
1473 process from the top, but in order to avoid loops, a router ignores any address
1474 which has an identically-named ancestor that was processed by itself.
1475 .next
1476 When all the routing has been done, addresses that have been successfully
1477 handled are passed to their assigned transports. When local transports are
1478 doing real local deliveries, they handle only one address at a time, but if a
1479 local transport is being used as a pseudo-remote transport (for example, to
1480 collect batched SMTP messages for transmission by some other means) multiple
1481 addresses can be handled. Remote transports can always handle more than one
1482 address at a time, but can be configured not to do so, or to restrict multiple
1483 addresses to the same domain.
1484 .next
1485 Each local delivery to a file or a pipe runs in a separate process under a
1486 non-privileged uid, and these deliveries are run one at a time. Remote
1487 deliveries also run in separate processes, normally under a uid that is private
1488 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1489 run in parallel. The maximum number of simultaneous remote deliveries for any
1490 one message is set by the &%remote_max_parallel%& option.
1491 The order in which deliveries are done is not defined, except that all local
1492 deliveries happen before any remote deliveries.
1493 .next
1494 .cindex "queue runner"
1495 When it encounters a local delivery during a queue run, Exim checks its retry
1496 database to see if there has been a previous temporary delivery failure for the
1497 address before running the local transport. If there was a previous failure,
1498 Exim does not attempt a new delivery until the retry time for the address is
1499 reached. However, this happens only for delivery attempts that are part of a
1500 queue run. Local deliveries are always attempted when delivery immediately
1501 follows message reception, even if retry times are set for them. This makes for
1502 better behaviour if one particular message is causing problems (for example,
1503 causing quota overflow, or provoking an error in a filter file).
1504 .next
1505 .cindex "delivery" "retry in remote transports"
1506 Remote transports do their own retry handling, since an address may be
1507 deliverable to one of a number of hosts, each of which may have a different
1508 retry time. If there have been previous temporary failures and no host has
1509 reached its retry time, no delivery is attempted, whether in a queue run or
1510 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1511 .next
1512 If there were any permanent errors, a bounce message is returned to an
1513 appropriate address (the sender in the common case), with details of the error
1514 for each failing address. Exim can be configured to send copies of bounce
1515 messages to other addresses.
1516 .next
1517 .cindex "delivery" "deferral"
1518 If one or more addresses suffered a temporary failure, the message is left on
1519 the queue, to be tried again later. Delivery of these addresses is said to be
1520 &'deferred'&.
1521 .next
1522 When all the recipient addresses have either been delivered or bounced,
1523 handling of the message is complete. The spool files and message log are
1524 deleted, though the message log can optionally be preserved if required.
1525 .endlist
1526
1527
1528
1529
1530 .section "Retry mechanism" "SECID19"
1531 .cindex "delivery" "retry mechanism"
1532 .cindex "retry" "description of mechanism"
1533 .cindex "queue runner"
1534 Exim's mechanism for retrying messages that fail to get delivered at the first
1535 attempt is the queue runner process. You must either run an Exim daemon that
1536 uses the &%-q%& option with a time interval to start queue runners at regular
1537 intervals, or use some other means (such as &'cron'&) to start them. If you do
1538 not arrange for queue runners to be run, messages that fail temporarily at the
1539 first attempt will remain on your queue for ever. A queue runner process works
1540 its way through the queue, one message at a time, trying each delivery that has
1541 passed its retry time.
1542 You can run several queue runners at once.
1543
1544 Exim uses a set of configured rules to determine when next to retry the failing
1545 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1546 should give up trying to deliver to the address, at which point it generates a
1547 bounce message. If no retry rules are set for a particular host, address, and
1548 error combination, no retries are attempted, and temporary errors are treated
1549 as permanent.
1550
1551
1552
1553 .section "Temporary delivery failure" "SECID20"
1554 .cindex "delivery" "temporary failure"
1555 There are many reasons why a message may not be immediately deliverable to a
1556 particular address. Failure to connect to a remote machine (because it, or the
1557 connection to it, is down) is one of the most common. Temporary failures may be
1558 detected during routing as well as during the transport stage of delivery.
1559 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1560 is on a file system where the user is over quota. Exim can be configured to
1561 impose its own quotas on local mailboxes; where system quotas are set they will
1562 also apply.
1563
1564 If a host is unreachable for a period of time, a number of messages may be
1565 waiting for it by the time it recovers, and sending them in a single SMTP
1566 connection is clearly beneficial. Whenever a delivery to a remote host is
1567 deferred,
1568 .cindex "hints database" "deferred deliveries"
1569 Exim makes a note in its hints database, and whenever a successful
1570 SMTP delivery has happened, it looks to see if any other messages are waiting
1571 for the same host. If any are found, they are sent over the same SMTP
1572 connection, subject to a configuration limit as to the maximum number in any
1573 one connection.
1574
1575
1576
1577 .section "Permanent delivery failure" "SECID21"
1578 .cindex "delivery" "permanent failure"
1579 .cindex "bounce message" "when generated"
1580 When a message cannot be delivered to some or all of its intended recipients, a
1581 bounce message is generated. Temporary delivery failures turn into permanent
1582 errors when their timeout expires. All the addresses that fail in a given
1583 delivery attempt are listed in a single message. If the original message has
1584 many recipients, it is possible for some addresses to fail in one delivery
1585 attempt and others to fail subsequently, giving rise to more than one bounce
1586 message. The wording of bounce messages can be customized by the administrator.
1587 See chapter &<<CHAPemsgcust>>& for details.
1588
1589 .cindex "&'X-Failed-Recipients:'& header line"
1590 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1591 failed addresses, for the benefit of programs that try to analyse such messages
1592 automatically.
1593
1594 .cindex "bounce message" "recipient of"
1595 A bounce message is normally sent to the sender of the original message, as
1596 obtained from the message's envelope. For incoming SMTP messages, this is the
1597 address given in the MAIL command. However, when an address is expanded via a
1598 forward or alias file, an alternative address can be specified for delivery
1599 failures of the generated addresses. For a mailing list expansion (see section
1600 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1601 of the list.
1602
1603
1604
1605 .section "Failures to deliver bounce messages" "SECID22"
1606 .cindex "bounce message" "failure to deliver"
1607 If a bounce message (either locally generated or received from a remote host)
1608 itself suffers a permanent delivery failure, the message is left on the queue,
1609 but it is frozen, awaiting the attention of an administrator. There are options
1610 that can be used to make Exim discard such failed messages, or to keep them
1611 for only a short time (see &%timeout_frozen_after%& and
1612 &%ignore_bounce_errors_after%&).
1613
1614
1615
1616
1617
1618 . ////////////////////////////////////////////////////////////////////////////
1619 . ////////////////////////////////////////////////////////////////////////////
1620
1621 .chapter "Building and installing Exim" "CHID3"
1622 .scindex IIDbuex "building Exim"
1623
1624 .section "Unpacking" "SECID23"
1625 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1626 creates a directory with the name of the current release (for example,
1627 &_exim-&version()_&) into which the following files are placed:
1628
1629 .table2 140pt
1630 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1631 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1632   documented"
1633 .irow &_LICENCE_&         "the GNU General Public Licence"
1634 .irow &_Makefile_&        "top-level make file"
1635 .irow &_NOTICE_&          "conditions for the use of Exim"
1636 .irow &_README_&          "list of files, directories and simple build &&&
1637   instructions"
1638 .endtable
1639
1640 Other files whose names begin with &_README_& may also be present. The
1641 following subdirectories are created:
1642
1643 .table2 140pt
1644 .irow &_Local_&           "an empty directory for local configuration files"
1645 .irow &_OS_&              "OS-specific files"
1646 .irow &_doc_&             "documentation files"
1647 .irow &_exim_monitor_&    "source files for the Exim monitor"
1648 .irow &_scripts_&         "scripts used in the build process"
1649 .irow &_src_&             "remaining source files"
1650 .irow &_util_&            "independent utilities"
1651 .endtable
1652
1653 The main utility programs are contained in the &_src_& directory, and are built
1654 with the Exim binary. The &_util_& directory contains a few optional scripts
1655 that may be useful to some sites.
1656
1657
1658 .section "Multiple machine architectures and operating systems" "SECID24"
1659 .cindex "building Exim" "multiple OS/architectures"
1660 The building process for Exim is arranged to make it easy to build binaries for
1661 a number of different architectures and operating systems from the same set of
1662 source files. Compilation does not take place in the &_src_& directory.
1663 Instead, a &'build directory'& is created for each architecture and operating
1664 system.
1665 .cindex "symbolic link" "to build directory"
1666 Symbolic links to the sources are installed in this directory, which is where
1667 the actual building takes place. In most cases, Exim can discover the machine
1668 architecture and operating system for itself, but the defaults can be
1669 overridden if necessary.
1670 .cindex compiler requirements
1671 .cindex compiler version
1672 A C99-capable compiler will be required for the build.
1673
1674
1675 .section "PCRE library" "SECTpcre"
1676 .cindex "PCRE library"
1677 Exim no longer has an embedded PCRE library as the vast majority of
1678 modern systems include PCRE as a system library, although you may need
1679 to install the PCRE or PCRE development package for your operating
1680 system. If your system has a normal PCRE installation the Exim build
1681 process will need no further configuration. If the library or the
1682 headers are in an unusual location you will need to either set the PCRE_LIBS
1683 and INCLUDE directives appropriately,
1684 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1685 If your operating system has no
1686 PCRE support then you will need to obtain and build the current PCRE
1687 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1688 More information on PCRE is available at &url(http://www.pcre.org/).
1689
1690 .section "DBM libraries" "SECTdb"
1691 .cindex "DBM libraries" "discussion of"
1692 .cindex "hints database" "DBM files used for"
1693 Even if you do not use any DBM files in your configuration, Exim still needs a
1694 DBM library in order to operate, because it uses indexed files for its hints
1695 databases. Unfortunately, there are a number of DBM libraries in existence, and
1696 different operating systems often have different ones installed.
1697
1698 .cindex "Solaris" "DBM library for"
1699 .cindex "IRIX, DBM library for"
1700 .cindex "BSD, DBM library for"
1701 .cindex "Linux, DBM library for"
1702 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1703 Linux distribution, the DBM configuration should happen automatically, and you
1704 may be able to ignore this section. Otherwise, you may have to learn more than
1705 you would like about DBM libraries from what follows.
1706
1707 .cindex "&'ndbm'& DBM library"
1708 Licensed versions of Unix normally contain a library of DBM functions operating
1709 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1710 versions of Unix seem to vary in what they contain as standard. In particular,
1711 some early versions of Linux have no default DBM library, and different
1712 distributors have chosen to bundle different libraries with their packaged
1713 versions. However, the more recent releases seem to have standardized on the
1714 Berkeley DB library.
1715
1716 Different DBM libraries have different conventions for naming the files they
1717 use. When a program opens a file called &_dbmfile_&, there are several
1718 possibilities:
1719
1720 .olist
1721 A traditional &'ndbm'& implementation, such as that supplied as part of
1722 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1723 .next
1724 .cindex "&'gdbm'& DBM library"
1725 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1726 compatibility interface it makes two different hard links to it with names
1727 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1728 file name is used unmodified.
1729 .next
1730 .cindex "Berkeley DB library"
1731 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1732 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1733 programmer exactly the same as the traditional &'ndbm'& implementation.
1734 .next
1735 If the Berkeley package is used in its native mode, it operates on a single
1736 file called &_dbmfile_&; the programmer's interface is somewhat different to
1737 the traditional &'ndbm'& interface.
1738 .next
1739 To complicate things further, there are several very different versions of the
1740 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1741 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1742 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1743 versions of Berkeley DB can be obtained from
1744 &url(http://www.sleepycat.com/).
1745 .next
1746 .cindex "&'tdb'& DBM library"
1747 Yet another DBM library, called &'tdb'&, is available from
1748 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1749 operates on a single file.
1750 .endlist
1751
1752 .cindex "USE_DB"
1753 .cindex "DBM libraries" "configuration for building"
1754 Exim and its utilities can be compiled to use any of these interfaces. In order
1755 to use any version of the Berkeley DB package in native mode, you must set
1756 USE_DB in an appropriate configuration file (typically
1757 &_Local/Makefile_&). For example:
1758 .code
1759 USE_DB=yes
1760 .endd
1761 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1762 error is diagnosed if you set more than one of these.
1763
1764 At the lowest level, the build-time configuration sets none of these options,
1765 thereby assuming an interface of type (1). However, some operating system
1766 configuration files (for example, those for the BSD operating systems and
1767 Linux) assume type (4) by setting USE_DB as their default, and the
1768 configuration files for Cygwin set USE_GDBM. Anything you set in
1769 &_Local/Makefile_&, however, overrides these system defaults.
1770
1771 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1772 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1773 in one of these lines:
1774 .code
1775 DBMLIB = -ldb
1776 DBMLIB = -ltdb
1777 .endd
1778 Settings like that will work if the DBM library is installed in the standard
1779 place. Sometimes it is not, and the library's header file may also not be in
1780 the default path. You may need to set INCLUDE to specify where the header
1781 file is, and to specify the path to the library more fully in DBMLIB, as in
1782 this example:
1783 .code
1784 INCLUDE=-I/usr/local/include/db-4.1
1785 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1786 .endd
1787 There is further detailed discussion about the various DBM libraries in the
1788 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1789
1790
1791
1792 .section "Pre-building configuration" "SECID25"
1793 .cindex "building Exim" "pre-building configuration"
1794 .cindex "configuration for building Exim"
1795 .cindex "&_Local/Makefile_&"
1796 .cindex "&_src/EDITME_&"
1797 Before building Exim, a local configuration file that specifies options
1798 independent of any operating system has to be created with the name
1799 &_Local/Makefile_&. A template for this file is supplied as the file
1800 &_src/EDITME_&, and it contains full descriptions of all the option settings
1801 therein. These descriptions are therefore not repeated here. If you are
1802 building Exim for the first time, the simplest thing to do is to copy
1803 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1804
1805 There are three settings that you must supply, because Exim will not build
1806 without them. They are the location of the run time configuration file
1807 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1808 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1809 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1810 a colon-separated list of file names; Exim uses the first of them that exists.
1811
1812 There are a few other parameters that can be specified either at build time or
1813 at run time, to enable the same binary to be used on a number of different
1814 machines. However, if the locations of Exim's spool directory and log file
1815 directory (if not within the spool directory) are fixed, it is recommended that
1816 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1817 detected early in Exim's execution (such as a malformed configuration file) can
1818 be logged.
1819
1820 .cindex "content scanning" "specifying at build time"
1821 Exim's interfaces for calling virus and spam scanning software directly from
1822 access control lists are not compiled by default. If you want to include these
1823 facilities, you need to set
1824 .code
1825 WITH_CONTENT_SCAN=yes
1826 .endd
1827 in your &_Local/Makefile_&. For details of the facilities themselves, see
1828 chapter &<<CHAPexiscan>>&.
1829
1830
1831 .cindex "&_Local/eximon.conf_&"
1832 .cindex "&_exim_monitor/EDITME_&"
1833 If you are going to build the Exim monitor, a similar configuration process is
1834 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1835 your installation and saved under the name &_Local/eximon.conf_&. If you are
1836 happy with the default settings described in &_exim_monitor/EDITME_&,
1837 &_Local/eximon.conf_& can be empty, but it must exist.
1838
1839 This is all the configuration that is needed in straightforward cases for known
1840 operating systems. However, the building process is set up so that it is easy
1841 to override options that are set by default or by operating-system-specific
1842 configuration files, for example to change the name of the C compiler, which
1843 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1844 do this.
1845
1846
1847
1848 .section "Support for iconv()" "SECID26"
1849 .cindex "&[iconv()]& support"
1850 .cindex "RFC 2047"
1851 The contents of header lines in messages may be encoded according to the rules
1852 described RFC 2047. This makes it possible to transmit characters that are not
1853 in the ASCII character set, and to label them as being in a particular
1854 character set. When Exim is inspecting header lines by means of the &%$h_%&
1855 mechanism, it decodes them, and translates them into a specified character set
1856 (default is set at build time). The translation is possible only if the operating system
1857 supports the &[iconv()]& function.
1858
1859 However, some of the operating systems that supply &[iconv()]& do not support
1860 very many conversions. The GNU &%libiconv%& library (available from
1861 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1862 systems to remedy this deficiency, as well as on systems that do not supply
1863 &[iconv()]& at all. After installing &%libiconv%&, you should add
1864 .code
1865 HAVE_ICONV=yes
1866 .endd
1867 to your &_Local/Makefile_& and rebuild Exim.
1868
1869
1870
1871 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1872 .cindex "TLS" "including support for TLS"
1873 .cindex "encryption" "including support for"
1874 .cindex "SUPPORT_TLS"
1875 .cindex "OpenSSL" "building Exim with"
1876 .cindex "GnuTLS" "building Exim with"
1877 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1878 command as per RFC 2487. It can also support legacy clients that expect to
1879 start a TLS session immediately on connection to a non-standard port (see the
1880 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1881 line option).
1882
1883 If you want to build Exim with TLS support, you must first install either the
1884 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1885 implementing SSL.
1886
1887 If OpenSSL is installed, you should set
1888 .code
1889 SUPPORT_TLS=yes
1890 TLS_LIBS=-lssl -lcrypto
1891 .endd
1892 in &_Local/Makefile_&. You may also need to specify the locations of the
1893 OpenSSL library and include files. For example:
1894 .code
1895 SUPPORT_TLS=yes
1896 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1897 TLS_INCLUDE=-I/usr/local/openssl/include/
1898 .endd
1899 .cindex "pkg-config" "OpenSSL"
1900 If you have &'pkg-config'& available, then instead you can just use:
1901 .code
1902 SUPPORT_TLS=yes
1903 USE_OPENSSL_PC=openssl
1904 .endd
1905 .cindex "USE_GNUTLS"
1906 If GnuTLS is installed, you should set
1907 .code
1908 SUPPORT_TLS=yes
1909 USE_GNUTLS=yes
1910 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1911 .endd
1912 in &_Local/Makefile_&, and again you may need to specify the locations of the
1913 library and include files. For example:
1914 .code
1915 SUPPORT_TLS=yes
1916 USE_GNUTLS=yes
1917 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1918 TLS_INCLUDE=-I/usr/gnu/include
1919 .endd
1920 .cindex "pkg-config" "GnuTLS"
1921 If you have &'pkg-config'& available, then instead you can just use:
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 USE_GNUTLS_PC=gnutls
1926 .endd
1927
1928 You do not need to set TLS_INCLUDE if the relevant directory is already
1929 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1930 given in chapter &<<CHAPTLS>>&.
1931
1932
1933
1934
1935 .section "Use of tcpwrappers" "SECID27"
1936
1937 .cindex "tcpwrappers, building Exim to support"
1938 .cindex "USE_TCP_WRAPPERS"
1939 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1940 .cindex "tcp_wrappers_daemon_name"
1941 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1942 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1943 alternative to Exim's own checking facilities for installations that are
1944 already making use of &'tcpwrappers'& for other purposes. To do this, you
1945 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1946 &_tcpd.h_& to be available at compile time, and also ensure that the library
1947 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1948 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1949 you might have
1950 .code
1951 USE_TCP_WRAPPERS=yes
1952 CFLAGS=-O -I/usr/local/include
1953 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1954 .endd
1955 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1956 files is &"exim"&. For example, the line
1957 .code
1958 exim : LOCAL  192.168.1.  .friendly.domain.example
1959 .endd
1960 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1961 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1962 All other connections are denied. The daemon name used by &'tcpwrappers'&
1963 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1964 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1965 configure file. Consult the &'tcpwrappers'& documentation for
1966 further details.
1967
1968
1969 .section "Including support for IPv6" "SECID28"
1970 .cindex "IPv6" "including support for"
1971 Exim contains code for use on systems that have IPv6 support. Setting
1972 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1973 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1974 where the IPv6 support is not fully integrated into the normal include and
1975 library files.
1976
1977 Two different types of DNS record for handling IPv6 addresses have been
1978 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1979 currently seen as the mainstream. Another record type called A6 was proposed
1980 as better than AAAA because it had more flexibility. However, it was felt to be
1981 over-complex, and its status was reduced to &"experimental"&.
1982 Exim used to
1983 have a compile option for including A6 record support but this has now been
1984 withdrawn.
1985
1986
1987
1988 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1989 .cindex "lookup modules"
1990 .cindex "dynamic modules"
1991 .cindex ".so building"
1992 On some platforms, Exim supports not compiling all lookup types directly into
1993 the main binary, instead putting some into external modules which can be loaded
1994 on demand.
1995 This permits packagers to build Exim with support for lookups with extensive
1996 library dependencies without requiring all users to install all of those
1997 dependencies.
1998 Most, but not all, lookup types can be built this way.
1999
2000 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2001 installed; Exim will only load modules from that directory, as a security
2002 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2003 for your OS; see &_OS/Makefile-Linux_& for an example.
2004 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2005 see &_src/EDITME_& for details.
2006
2007 Then, for each module to be loaded dynamically, define the relevant
2008 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2009 For example, this will build in lsearch but load sqlite and mysql support
2010 on demand:
2011 .code
2012 LOOKUP_LSEARCH=yes
2013 LOOKUP_SQLITE=2
2014 LOOKUP_MYSQL=2
2015 .endd
2016
2017
2018 .section "The building process" "SECID29"
2019 .cindex "build directory"
2020 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2021 created, run &'make'& at the top level. It determines the architecture and
2022 operating system types, and creates a build directory if one does not exist.
2023 For example, on a Sun system running Solaris 8, the directory
2024 &_build-SunOS5-5.8-sparc_& is created.
2025 .cindex "symbolic link" "to source files"
2026 Symbolic links to relevant source files are installed in the build directory.
2027
2028 If this is the first time &'make'& has been run, it calls a script that builds
2029 a make file inside the build directory, using the configuration files from the
2030 &_Local_& directory. The new make file is then passed to another instance of
2031 &'make'&. This does the real work, building a number of utility scripts, and
2032 then compiling and linking the binaries for the Exim monitor (if configured), a
2033 number of utility programs, and finally Exim itself. The command &`make
2034 makefile`& can be used to force a rebuild of the make file in the build
2035 directory, should this ever be necessary.
2036
2037 If you have problems building Exim, check for any comments there may be in the
2038 &_README_& file concerning your operating system, and also take a look at the
2039 FAQ, where some common problems are covered.
2040
2041
2042
2043 .section 'Output from &"make"&' "SECID283"
2044 The output produced by the &'make'& process for compile lines is often very
2045 unreadable, because these lines can be very long. For this reason, the normal
2046 output is suppressed by default, and instead output similar to that which
2047 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2048 each module that is being compiled or linked. However, it is still possible to
2049 get the full output, by calling &'make'& like this:
2050 .code
2051 FULLECHO='' make -e
2052 .endd
2053 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2054 command reflection in &'make'&. When you ask for the full output, it is
2055 given in addition to the short output.
2056
2057
2058
2059 .section "Overriding build-time options for Exim" "SECToverride"
2060 .cindex "build-time options, overriding"
2061 The main make file that is created at the beginning of the building process
2062 consists of the concatenation of a number of files which set configuration
2063 values, followed by a fixed set of &'make'& instructions. If a value is set
2064 more than once, the last setting overrides any previous ones. This provides a
2065 convenient way of overriding defaults. The files that are concatenated are, in
2066 order:
2067 .display
2068 &_OS/Makefile-Default_&
2069 &_OS/Makefile-_&<&'ostype'&>
2070 &_Local/Makefile_&
2071 &_Local/Makefile-_&<&'ostype'&>
2072 &_Local/Makefile-_&<&'archtype'&>
2073 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2074 &_OS/Makefile-Base_&
2075 .endd
2076 .cindex "&_Local/Makefile_&"
2077 .cindex "building Exim" "operating system type"
2078 .cindex "building Exim" "architecture type"
2079 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2080 architecture type. &_Local/Makefile_& is required to exist, and the building
2081 process fails if it is absent. The other three &_Local_& files are optional,
2082 and are often not needed.
2083
2084 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2085 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2086 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2087 values are used, thereby providing a means of forcing particular settings.
2088 Otherwise, the scripts try to get values from the &%uname%& command. If this
2089 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2090 of &'ad hoc'& transformations are then applied, to produce the standard names
2091 that Exim expects. You can run these scripts directly from the shell in order
2092 to find out what values are being used on your system.
2093
2094
2095 &_OS/Makefile-Default_& contains comments about the variables that are set
2096 therein. Some (but not all) are mentioned below. If there is something that
2097 needs changing, review the contents of this file and the contents of the make
2098 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2099 default values are.
2100
2101
2102 .cindex "building Exim" "overriding default settings"
2103 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2104 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2105 need to change the original files. Instead, you should make the changes by
2106 putting the new values in an appropriate &_Local_& file. For example,
2107 .cindex "Tru64-Unix build-time settings"
2108 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2109 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2110 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2111 called with the option &%-std1%&, to make it recognize some of the features of
2112 Standard C that Exim uses. (Most other compilers recognize Standard C by
2113 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2114 containing the lines
2115 .code
2116 CC=cc
2117 CFLAGS=-std1
2118 .endd
2119 If you are compiling for just one operating system, it may be easier to put
2120 these lines directly into &_Local/Makefile_&.
2121
2122 Keeping all your local configuration settings separate from the distributed
2123 files makes it easy to transfer them to new versions of Exim simply by copying
2124 the contents of the &_Local_& directory.
2125
2126
2127 .cindex "NIS lookup type" "including support for"
2128 .cindex "NIS+ lookup type" "including support for"
2129 .cindex "LDAP" "including support for"
2130 .cindex "lookup" "inclusion in binary"
2131 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2132 lookup, but not all systems have these components installed, so the default is
2133 not to include the relevant code in the binary. All the different kinds of file
2134 and database lookup that Exim supports are implemented as separate code modules
2135 which are included only if the relevant compile-time options are set. In the
2136 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2137 .code
2138 LOOKUP_LDAP=yes
2139 LOOKUP_NIS=yes
2140 LOOKUP_NISPLUS=yes
2141 .endd
2142 and similar settings apply to the other lookup types. They are all listed in
2143 &_src/EDITME_&. In many cases the relevant include files and interface
2144 libraries need to be installed before compiling Exim.
2145 .cindex "cdb" "including support for"
2146 However, there are some optional lookup types (such as cdb) for which
2147 the code is entirely contained within Exim, and no external include
2148 files or libraries are required. When a lookup type is not included in the
2149 binary, attempts to configure Exim to use it cause run time configuration
2150 errors.
2151
2152 .cindex "pkg-config" "lookups"
2153 .cindex "pkg-config" "authenticators"
2154 Many systems now use a tool called &'pkg-config'& to encapsulate information
2155 about how to compile against a library; Exim has some initial support for
2156 being able to use pkg-config for lookups and authenticators.  For any given
2157 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2158 variable with the &`_PC`& suffix in the name and assign as the value the
2159 name of the package to be queried.  The results of querying via the
2160 &'pkg-config'& command will be added to the appropriate Makefile variables
2161 with &`+=`& directives, so your version of &'make'& will need to support that
2162 syntax.  For instance:
2163 .code
2164 LOOKUP_SQLITE=yes
2165 LOOKUP_SQLITE_PC=sqlite3
2166 AUTH_GSASL=yes
2167 AUTH_GSASL_PC=libgsasl
2168 AUTH_HEIMDAL_GSSAPI=yes
2169 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2170 .endd
2171
2172 .cindex "Perl" "including support for"
2173 Exim can be linked with an embedded Perl interpreter, allowing Perl
2174 subroutines to be called during string expansion. To enable this facility,
2175 .code
2176 EXIM_PERL=perl.o
2177 .endd
2178 must be defined in &_Local/Makefile_&. Details of this facility are given in
2179 chapter &<<CHAPperl>>&.
2180
2181 .cindex "X11 libraries, location of"
2182 The location of the X11 libraries is something that varies a lot between
2183 operating systems, and there may be different versions of X11 to cope
2184 with. Exim itself makes no use of X11, but if you are compiling the Exim
2185 monitor, the X11 libraries must be available.
2186 The following three variables are set in &_OS/Makefile-Default_&:
2187 .code
2188 X11=/usr/X11R6
2189 XINCLUDE=-I$(X11)/include
2190 XLFLAGS=-L$(X11)/lib
2191 .endd
2192 These are overridden in some of the operating-system configuration files. For
2193 example, in &_OS/Makefile-SunOS5_& there is
2194 .code
2195 X11=/usr/openwin
2196 XINCLUDE=-I$(X11)/include
2197 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2198 .endd
2199 If you need to override the default setting for your operating system, place a
2200 definition of all three of these variables into your
2201 &_Local/Makefile-<ostype>_& file.
2202
2203 .cindex "EXTRALIBS"
2204 If you need to add any extra libraries to the link steps, these can be put in a
2205 variable called EXTRALIBS, which appears in all the link commands, but by
2206 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2207 command for linking the main Exim binary, and not for any associated utilities.
2208
2209 .cindex "DBM libraries" "configuration for building"
2210 There is also DBMLIB, which appears in the link commands for binaries that
2211 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2212 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2213 binary, and which can be used, for example, to include additional X11
2214 libraries.
2215
2216 .cindex "configuration file" "editing"
2217 The make file copes with rebuilding Exim correctly if any of the configuration
2218 files are edited. However, if an optional configuration file is deleted, it is
2219 necessary to touch the associated non-optional file (that is,
2220 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2221
2222
2223 .section "OS-specific header files" "SECID30"
2224 .cindex "&_os.h_&"
2225 .cindex "building Exim" "OS-specific C header files"
2226 The &_OS_& directory contains a number of files with names of the form
2227 &_os.h-<ostype>_&. These are system-specific C header files that should not
2228 normally need to be changed. There is a list of macro settings that are
2229 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2230 are porting Exim to a new operating system.
2231
2232
2233
2234 .section "Overriding build-time options for the monitor" "SECID31"
2235 .cindex "building Eximon"
2236 A similar process is used for overriding things when building the Exim monitor,
2237 where the files that are involved are
2238 .display
2239 &_OS/eximon.conf-Default_&
2240 &_OS/eximon.conf-_&<&'ostype'&>
2241 &_Local/eximon.conf_&
2242 &_Local/eximon.conf-_&<&'ostype'&>
2243 &_Local/eximon.conf-_&<&'archtype'&>
2244 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2245 .endd
2246 .cindex "&_Local/eximon.conf_&"
2247 As with Exim itself, the final three files need not exist, and in this case the
2248 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2249 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2250 variables of the same name, preceded by EXIMON_. For example, setting
2251 EXIMON_LOG_DEPTH in the environment overrides the value of
2252 LOG_DEPTH at run time.
2253 .ecindex IIDbuex
2254
2255
2256 .section "Installing Exim binaries and scripts" "SECID32"
2257 .cindex "installing Exim"
2258 .cindex "BIN_DIRECTORY"
2259 The command &`make install`& runs the &(exim_install)& script with no
2260 arguments. The script copies binaries and utility scripts into the directory
2261 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2262 .cindex "setuid" "installing Exim with"
2263 The install script copies files only if they are newer than the files they are
2264 going to replace. The Exim binary is required to be owned by root and have the
2265 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2266 install`& as root so that it can set up the Exim binary in this way. However, in
2267 some special situations (for example, if a host is doing no local deliveries)
2268 it may be possible to run Exim without making the binary setuid root (see
2269 chapter &<<CHAPsecurity>>& for details).
2270
2271 .cindex "CONFIGURE_FILE"
2272 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2273 in &_Local/Makefile_&. If this names a single file, and the file does not
2274 exist, the default configuration file &_src/configure.default_& is copied there
2275 by the installation script. If a run time configuration file already exists, it
2276 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2277 alternative files, no default is installed.
2278
2279 .cindex "system aliases file"
2280 .cindex "&_/etc/aliases_&"
2281 One change is made to the default configuration file when it is installed: the
2282 default configuration contains a router that references a system aliases file.
2283 The path to this file is set to the value specified by
2284 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2285 If the system aliases file does not exist, the installation script creates it,
2286 and outputs a comment to the user.
2287
2288 The created file contains no aliases, but it does contain comments about the
2289 aliases a site should normally have. Mail aliases have traditionally been
2290 kept in &_/etc/aliases_&. However, some operating systems are now using
2291 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2292 Exim's configuration if necessary.
2293
2294 The default configuration uses the local host's name as the only local domain,
2295 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2296 running as the local user. System aliases and &_.forward_& files in users' home
2297 directories are supported, but no NIS or NIS+ support is configured. Domains
2298 other than the name of the local host are routed using the DNS, with delivery
2299 over SMTP.
2300
2301 It is possible to install Exim for special purposes (such as building a binary
2302 distribution) in a private part of the file system. You can do this by a
2303 command such as
2304 .code
2305 make DESTDIR=/some/directory/ install
2306 .endd
2307 This has the effect of pre-pending the specified directory to all the file
2308 paths, except the name of the system aliases file that appears in the default
2309 configuration. (If a default alias file is created, its name &'is'& modified.)
2310 For backwards compatibility, ROOT is used if DESTDIR is not set,
2311 but this usage is deprecated.
2312
2313 .cindex "installing Exim" "what is not installed"
2314 Running &'make install'& does not copy the Exim 4 conversion script
2315 &'convert4r4'&. You will probably run this only once if you are
2316 upgrading from Exim 3. None of the documentation files in the &_doc_&
2317 directory are copied, except for the info files when you have set
2318 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2319
2320 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2321 to their names. The Exim binary itself, however, is handled differently. It is
2322 installed under a name that includes the version number and the compile number,
2323 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2324 called &_exim_& to point to the binary. If you are updating a previous version
2325 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2326 from the directory (as seen by other processes).
2327
2328 .cindex "installing Exim" "testing the script"
2329 If you want to see what the &'make install'& will do before running it for
2330 real, you can pass the &%-n%& option to the installation script by this
2331 command:
2332 .code
2333 make INSTALL_ARG=-n install
2334 .endd
2335 The contents of the variable INSTALL_ARG are passed to the installation
2336 script. You do not need to be root to run this test. Alternatively, you can run
2337 the installation script directly, but this must be from within the build
2338 directory. For example, from the top-level Exim directory you could use this
2339 command:
2340 .code
2341 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2342 .endd
2343 .cindex "installing Exim" "install script options"
2344 There are two other options that can be supplied to the installation script.
2345
2346 .ilist
2347 &%-no_chown%& bypasses the call to change the owner of the installed binary
2348 to root, and the call to make it a setuid binary.
2349 .next
2350 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2351 installed binary.
2352 .endlist
2353
2354 INSTALL_ARG can be used to pass these options to the script. For example:
2355 .code
2356 make INSTALL_ARG=-no_symlink install
2357 .endd
2358 The installation script can also be given arguments specifying which files are
2359 to be copied. For example, to install just the Exim binary, and nothing else,
2360 without creating the symbolic link, you could use:
2361 .code
2362 make INSTALL_ARG='-no_symlink exim' install
2363 .endd
2364
2365
2366
2367 .section "Installing info documentation" "SECTinsinfdoc"
2368 .cindex "installing Exim" "&'info'& documentation"
2369 Not all systems use the GNU &'info'& system for documentation, and for this
2370 reason, the Texinfo source of Exim's documentation is not included in the main
2371 distribution. Instead it is available separately from the ftp site (see section
2372 &<<SECTavail>>&).
2373
2374 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2375 source of the documentation is found in the source tree, running &`make
2376 install`& automatically builds the info files and installs them.
2377
2378
2379
2380 .section "Setting up the spool directory" "SECID33"
2381 .cindex "spool directory" "creating"
2382 When it starts up, Exim tries to create its spool directory if it does not
2383 exist. The Exim uid and gid are used for the owner and group of the spool
2384 directory. Sub-directories are automatically created in the spool directory as
2385 necessary.
2386
2387
2388
2389
2390 .section "Testing" "SECID34"
2391 .cindex "testing" "installation"
2392 Having installed Exim, you can check that the run time configuration file is
2393 syntactically valid by running the following command, which assumes that the
2394 Exim binary directory is within your PATH environment variable:
2395 .code
2396 exim -bV
2397 .endd
2398 If there are any errors in the configuration file, Exim outputs error messages.
2399 Otherwise it outputs the version number and build date,
2400 the DBM library that is being used, and information about which drivers and
2401 other optional code modules are included in the binary.
2402 Some simple routing tests can be done by using the address testing option. For
2403 example,
2404 .display
2405 &`exim -bt`& <&'local username'&>
2406 .endd
2407 should verify that it recognizes a local mailbox, and
2408 .display
2409 &`exim -bt`& <&'remote address'&>
2410 .endd
2411 a remote one. Then try getting it to deliver mail, both locally and remotely.
2412 This can be done by passing messages directly to Exim, without going through a
2413 user agent. For example:
2414 .code
2415 exim -v postmaster@your.domain.example
2416 From: user@your.domain.example
2417 To: postmaster@your.domain.example
2418 Subject: Testing Exim
2419
2420 This is a test message.
2421 ^D
2422 .endd
2423 The &%-v%& option causes Exim to output some verification of what it is doing.
2424 In this case you should see copies of three log lines, one for the message's
2425 arrival, one for its delivery, and one containing &"Completed"&.
2426
2427 .cindex "delivery" "problems with"
2428 If you encounter problems, look at Exim's log files (&'mainlog'& and
2429 &'paniclog'&) to see if there is any relevant information there. Another source
2430 of information is running Exim with debugging turned on, by specifying the
2431 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2432 with debugging turned on by a command of the form
2433 .display
2434 &`exim -d -M`& <&'exim-message-id'&>
2435 .endd
2436 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2437 produces rather a lot of output, but you can cut this down to specific areas.
2438 For example, if you use &%-d-all+route%& only the debugging information
2439 relevant to routing is included. (See the &%-d%& option in chapter
2440 &<<CHAPcommandline>>& for more details.)
2441
2442 .cindex '&"sticky"& bit'
2443 .cindex "lock files"
2444 One specific problem that has shown up on some sites is the inability to do
2445 local deliveries into a shared mailbox directory, because it does not have the
2446 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2447 writing to a mailbox file, and if it cannot create the lock file, the delivery
2448 is deferred. You can get round this either by setting the &"sticky bit"& on the
2449 directory, or by setting a specific group for local deliveries and allowing
2450 that group to create files in the directory (see the comments above the
2451 &(local_delivery)& transport in the default configuration file). Another
2452 approach is to configure Exim not to use lock files, but just to rely on
2453 &[fcntl()]& locking instead. However, you should do this only if all user
2454 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2455 see chapter &<<CHAPappendfile>>&.
2456
2457 One thing that cannot be tested on a system that is already running an MTA is
2458 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2459 &%-oX%& option can be used to run an Exim daemon that listens on some other
2460 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2461 &'exim_checkaccess'& utility can be used to check out policy controls on
2462 incoming SMTP mail.
2463
2464 Testing a new version on a system that is already running Exim can most easily
2465 be done by building a binary with a different CONFIGURE_FILE setting. From
2466 within the run time configuration, all other file and directory names
2467 that Exim uses can be altered, in order to keep it entirely clear of the
2468 production version.
2469
2470
2471 .section "Replacing another MTA with Exim" "SECID35"
2472 .cindex "replacing another MTA"
2473 Building and installing Exim for the first time does not of itself put it in
2474 general use. The name by which the system's MTA is called by mail user agents
2475 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2476 operating system), and it is necessary to make this name point to the &'exim'&
2477 binary in order to get the user agents to pass messages to Exim. This is
2478 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2479 or &_/usr/lib/sendmail_&
2480 .cindex "symbolic link" "to &'exim'& binary"
2481 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2482 privilege and executable status from the old MTA. It is then necessary to stop
2483 and restart the mailer daemon, if one is running.
2484
2485 .cindex "FreeBSD, MTA indirection"
2486 .cindex "&_/etc/mail/mailer.conf_&"
2487 Some operating systems have introduced alternative ways of switching MTAs. For
2488 example, if you are running FreeBSD, you need to edit the file
2489 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2490 described. A typical example of the contents of this file for running Exim is
2491 as follows:
2492 .code
2493 sendmail            /usr/exim/bin/exim
2494 send-mail           /usr/exim/bin/exim
2495 mailq               /usr/exim/bin/exim -bp
2496 newaliases          /usr/bin/true
2497 .endd
2498 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2499 your Exim installation is &"live"&. Check it by sending a message from your
2500 favourite user agent.
2501
2502 You should consider what to tell your users about the change of MTA. Exim may
2503 have different capabilities to what was previously running, and there are
2504 various operational differences such as the text of messages produced by
2505 command line options and in bounce messages. If you allow your users to make
2506 use of Exim's filtering capabilities, you should make the document entitled
2507 &'Exim's interface to mail filtering'& available to them.
2508
2509
2510
2511 .section "Upgrading Exim" "SECID36"
2512 .cindex "upgrading Exim"
2513 If you are already running Exim on your host, building and installing a new
2514 version automatically makes it available to MUAs, or any other programs that
2515 call the MTA directly. However, if you are running an Exim daemon, you do need
2516 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2517 new binary. You do not need to stop processing mail in order to install a new
2518 version of Exim. The install script does not modify an existing runtime
2519 configuration file.
2520
2521
2522
2523
2524 .section "Stopping the Exim daemon on Solaris" "SECID37"
2525 .cindex "Solaris" "stopping Exim on"
2526 The standard command for stopping the mailer daemon on Solaris is
2527 .code
2528 /etc/init.d/sendmail stop
2529 .endd
2530 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2531 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2532 for the text &"sendmail"&; this is not present because the actual program name
2533 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2534 solution is to replace the line that finds the process id with something like
2535 .code
2536 pid=`cat /var/spool/exim/exim-daemon.pid`
2537 .endd
2538 to obtain the daemon's pid directly from the file that Exim saves it in.
2539
2540 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2541 still be received from local processes, and if automatic delivery is configured
2542 (the normal case), deliveries will still occur.
2543
2544
2545
2546
2547 . ////////////////////////////////////////////////////////////////////////////
2548 . ////////////////////////////////////////////////////////////////////////////
2549
2550 .chapter "The Exim command line" "CHAPcommandline"
2551 .scindex IIDclo1 "command line" "options"
2552 .scindex IIDclo2 "options" "command line"
2553 Exim's command line takes the standard Unix form of a sequence of options,
2554 each starting with a hyphen character, followed by a number of arguments. The
2555 options are compatible with the main options of Sendmail, and there are also
2556 some additional options, some of which are compatible with Smail 3. Certain
2557 combinations of options do not make sense, and provoke an error if used.
2558 The form of the arguments depends on which options are set.
2559
2560
2561 .section "Setting options by program name" "SECID38"
2562 .cindex "&'mailq'&"
2563 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2564 were present before any other options.
2565 The &%-bp%& option requests a listing of the contents of the mail queue on the
2566 standard output.
2567 This feature is for compatibility with some systems that contain a command of
2568 that name in one of the standard libraries, symbolically linked to
2569 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2570
2571 .cindex "&'rsmtp'&"
2572 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2573 were present before any other options, for compatibility with Smail. The
2574 &%-bS%& option is used for reading in a number of messages in batched SMTP
2575 format.
2576
2577 .cindex "&'rmail'&"
2578 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2579 &%-oee%& options were present before any other options, for compatibility with
2580 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2581
2582 .cindex "&'runq'&"
2583 .cindex "queue runner"
2584 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2585 were present before any other options, for compatibility with Smail. The &%-q%&
2586 option causes a single queue runner process to be started.
2587
2588 .cindex "&'newaliases'&"
2589 .cindex "alias file" "building"
2590 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2591 If Exim is called under the name &'newaliases'& it behaves as if the option
2592 &%-bi%& were present before any other options, for compatibility with Sendmail.
2593 This option is used for rebuilding Sendmail's alias file. Exim does not have
2594 the concept of a single alias file, but can be configured to run a given
2595 command if called with the &%-bi%& option.
2596
2597
2598 .section "Trusted and admin users" "SECTtrustedadmin"
2599 Some Exim options are available only to &'trusted users'& and others are
2600 available only to &'admin users'&. In the description below, the phrases &"Exim
2601 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2602 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2603 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2604
2605 .ilist
2606 .cindex "trusted users" "definition of"
2607 .cindex "user" "trusted definition of"
2608 The trusted users are root, the Exim user, any user listed in the
2609 &%trusted_users%& configuration option, and any user whose current group or any
2610 supplementary group is one of those listed in the &%trusted_groups%&
2611 configuration option. Note that the Exim group is not automatically trusted.
2612
2613 .cindex '&"From"& line'
2614 .cindex "envelope sender"
2615 Trusted users are always permitted to use the &%-f%& option or a leading
2616 &"From&~"& line to specify the envelope sender of a message that is passed to
2617 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2618 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2619 users to set envelope senders.
2620
2621 .cindex "&'From:'& header line"
2622 .cindex "&'Sender:'& header line"
2623 .cindex "header lines" "From:"
2624 .cindex "header lines" "Sender:"
2625 For a trusted user, there is never any check on the contents of the &'From:'&
2626 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2627 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2628
2629 Trusted users may also specify a host name, host address, interface address,
2630 protocol name, ident value, and authentication data when submitting a message
2631 locally. Thus, they are able to insert messages into Exim's queue locally that
2632 have the characteristics of messages received from a remote host. Untrusted
2633 users may in some circumstances use &%-f%&, but can never set the other values
2634 that are available to trusted users.
2635 .next
2636 .cindex "user" "admin definition of"
2637 .cindex "admin user" "definition of"
2638 The admin users are root, the Exim user, and any user that is a member of the
2639 Exim group or of any group listed in the &%admin_groups%& configuration option.
2640 The current group does not have to be one of these groups.
2641
2642 Admin users are permitted to list the queue, and to carry out certain
2643 operations on messages, for example, to force delivery failures. It is also
2644 necessary to be an admin user in order to see the full information provided by
2645 the Exim monitor, and full debugging output.
2646
2647 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2648 Exim to attempt delivery of messages on its queue is restricted to admin users.
2649 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2650 option false (that is, specifying &%no_prod_requires_admin%&).
2651
2652 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2653 is restricted to admin users unless &%queue_list_requires_admin%& is set
2654 false.
2655 .endlist
2656
2657
2658 &*Warning*&: If you configure your system so that admin users are able to
2659 edit Exim's configuration file, you are giving those users an easy way of
2660 getting root. There is further discussion of this issue at the start of chapter
2661 &<<CHAPconf>>&.
2662
2663
2664
2665
2666 .section "Command line options" "SECID39"
2667 Exim's command line options are described in alphabetical order below. If none
2668 of the options that specifies a specific action (such as starting the daemon or
2669 a queue runner, or testing an address, or receiving a message in a specific
2670 format, or listing the queue) are present, and there is at least one argument
2671 on the command line, &%-bm%& (accept a local message on the standard input,
2672 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2673 outputs a brief message about itself and exits.
2674
2675 . ////////////////////////////////////////////////////////////////////////////
2676 . Insert a stylized XML comment here, to identify the start of the command line
2677 . options. This is for the benefit of the Perl script that automatically
2678 . creates a man page for the options.
2679 . ////////////////////////////////////////////////////////////////////////////
2680
2681 .literal xml
2682 <!-- === Start of command line options === -->
2683 .literal off
2684
2685
2686 .vlist
2687 .vitem &%--%&
2688 .oindex "--"
2689 .cindex "options" "command line; terminating"
2690 This is a pseudo-option whose only purpose is to terminate the options and
2691 therefore to cause subsequent command line items to be treated as arguments
2692 rather than options, even if they begin with hyphens.
2693
2694 .vitem &%--help%&
2695 .oindex "&%--help%&"
2696 This option causes Exim to output a few sentences stating what it is.
2697 The same output is generated if the Exim binary is called with no options and
2698 no arguments.
2699
2700 .vitem &%--version%&
2701 .oindex "&%--version%&"
2702 This option is an alias for &%-bV%& and causes version information to be
2703 displayed.
2704
2705 .vitem &%-Ac%& &&&
2706        &%-Am%&
2707 .oindex "&%-Ac%&"
2708 .oindex "&%-Am%&"
2709 These options are used by Sendmail for selecting configuration files and are
2710 ignored by Exim.
2711
2712 .vitem &%-B%&<&'type'&>
2713 .oindex "&%-B%&"
2714 .cindex "8-bit characters"
2715 .cindex "Sendmail compatibility" "8-bit characters"
2716 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2717 clean; it ignores this option.
2718
2719 .vitem &%-bd%&
2720 .oindex "&%-bd%&"
2721 .cindex "daemon"
2722 .cindex "SMTP" "listener"
2723 .cindex "queue runner"
2724 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2725 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2726 that the daemon should also initiate periodic queue runs.
2727
2728 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2729 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2730 disconnect from the controlling terminal. When running this way, it can be
2731 stopped by pressing ctrl-C.
2732
2733 By default, Exim listens for incoming connections to the standard SMTP port on
2734 all the host's running interfaces. However, it is possible to listen on other
2735 ports, on multiple ports, and only on specific interfaces. Chapter
2736 &<<CHAPinterfaces>>& contains a description of the options that control this.
2737
2738 When a listening daemon
2739 .cindex "daemon" "process id (pid)"
2740 .cindex "pid (process id)" "of daemon"
2741 is started without the use of &%-oX%& (that is, without overriding the normal
2742 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2743 in Exim's spool directory. This location can be overridden by setting
2744 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2745 running as root.
2746
2747 When &%-oX%& is used on the command line to start a listening daemon, the
2748 process id is not written to the normal pid file path. However, &%-oP%& can be
2749 used to specify a path on the command line if a pid file is required.
2750
2751 The SIGHUP signal
2752 .cindex "SIGHUP"
2753 .cindex "daemon" "restarting"
2754 can be used to cause the daemon to re-execute itself. This should be done
2755 whenever Exim's configuration file, or any file that is incorporated into it by
2756 means of the &%.include%& facility, is changed, and also whenever a new version
2757 of Exim is installed. It is not necessary to do this when other files that are
2758 referenced from the configuration (for example, alias files) are changed,
2759 because these are reread each time they are used.
2760
2761 .vitem &%-bdf%&
2762 .oindex "&%-bdf%&"
2763 This option has the same effect as &%-bd%& except that it never disconnects
2764 from the controlling terminal, even when no debugging is specified.
2765
2766 .vitem &%-be%&
2767 .oindex "&%-be%&"
2768 .cindex "testing" "string expansion"
2769 .cindex "expansion" "testing"
2770 Run Exim in expansion testing mode. Exim discards its root privilege, to
2771 prevent ordinary users from using this mode to read otherwise inaccessible
2772 files. If no arguments are given, Exim runs interactively, prompting for lines
2773 of data. Otherwise, it processes each argument in turn.
2774
2775 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2776 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2777 used without command line arguments. If successful, it uses the &[readline()]&
2778 function, which provides extensive line-editing facilities, for reading the
2779 test data. A line history is supported.
2780
2781 Long expansion expressions can be split over several lines by using backslash
2782 continuations. As in Exim's run time configuration, white space at the start of
2783 continuation lines is ignored. Each argument or data line is passed through the
2784 string expansion mechanism, and the result is output. Variable values from the
2785 configuration file (for example, &$qualify_domain$&) are available, but no
2786 message-specific values (such as &$message_exim_id$&) are set, because no message
2787 is being processed (but see &%-bem%& and &%-Mset%&).
2788
2789 &*Note*&: If you use this mechanism to test lookups, and you change the data
2790 files or databases you are using, you must exit and restart Exim before trying
2791 the same lookup again. Otherwise, because each Exim process caches the results
2792 of lookups, you will just get the same result as before.
2793
2794 .new
2795 Macro processing is done on lines before string-expansion: new macros can be
2796 defined and macros will be expanded.
2797 Because macros in thc config file are often used for secrets, those are only
2798 available to admin users.
2799 .wen
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 or directory
3055 (depending on the used scanner interface),
3056 using the malware scanning framework.  The option of &%av_scanner%& influences
3057 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3058 the expansion should have defaults which apply to this invocation.  ACLs are
3059 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3060 will never be populated and &%-bmalware%& will fail.
3061
3062 Exim will have changed working directory before resolving the filename, so
3063 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3064 user when it tries to open the file, rather than as the invoking user.
3065 This option requires admin privileges.
3066
3067 The &%-bmalware%& option will not be extended to be more generally useful,
3068 there are better tools for file-scanning.  This option exists to help
3069 administrators verify their Exim and AV scanner configuration.
3070
3071 .vitem &%-bnq%&
3072 .oindex "&%-bnq%&"
3073 .cindex "address qualification, suppressing"
3074 By default, Exim automatically qualifies unqualified addresses (those
3075 without domains) that appear in messages that are submitted locally (that
3076 is, not over TCP/IP). This qualification applies both to addresses in
3077 envelopes, and addresses in header lines. Sender addresses are qualified using
3078 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3079 defaults to the value of &%qualify_domain%&).
3080
3081 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3082 being used to re-submit messages that originally came from remote hosts after
3083 content scanning, you probably do not want to qualify unqualified addresses in
3084 header lines. (Such lines will be present only if you have not enabled a header
3085 syntax check in the appropriate ACL.)
3086
3087 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3088 messages that originate on the local host. When this is used, unqualified
3089 addresses in the envelope provoke errors (causing message rejection) and
3090 unqualified addresses in header lines are left alone.
3091
3092
3093 .vitem &%-bP%&
3094 .oindex "&%-bP%&"
3095 .cindex "configuration options" "extracting"
3096 .cindex "options" "configuration &-- extracting"
3097 If this option is given with no arguments, it causes the values of all Exim's
3098 main configuration options to be written to the standard output. The values
3099 of one or more specific options can be requested by giving their names as
3100 arguments, for example:
3101 .code
3102 exim -bP qualify_domain hold_domains
3103 .endd
3104 .cindex "hiding configuration option values"
3105 .cindex "configuration options" "hiding value of"
3106 .cindex "options" "hiding value of"
3107 However, any option setting that is preceded by the word &"hide"& in the
3108 configuration file is not shown in full, except to an admin user. For other
3109 users, the output is as in this example:
3110 .code
3111 mysql_servers = <value not displayable>
3112 .endd
3113 If &%config%& is given as an argument, the config is
3114 output, as it was parsed, any include file resolved, any comment removed.
3115
3116 If &%config_file%& is given as an argument, the name of the run time
3117 configuration file is output. (&%configure_file%& works too, for
3118 backward compatibility.)
3119 If a list of configuration files was supplied, the value that is output here
3120 is the name of the file that was actually used.
3121
3122 .cindex "options" "hiding name of"
3123 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3124 name will not be output.
3125
3126 .cindex "daemon" "process id (pid)"
3127 .cindex "pid (process id)" "of daemon"
3128 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3129 directories where log files and daemon pid files are written are output,
3130 respectively. If these values are unset, log files are written in a
3131 sub-directory of the spool directory called &%log%&, and the pid file is
3132 written directly into the spool directory.
3133
3134 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3135 .code
3136 exim -bP +local_domains
3137 .endd
3138 it searches for a matching named list of any type (domain, host, address, or
3139 local part) and outputs what it finds.
3140
3141 .cindex "options" "router &-- extracting"
3142 .cindex "options" "transport &-- extracting"
3143 .cindex "options" "authenticator &-- extracting"
3144 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3145 followed by the name of an appropriate driver instance, the option settings for
3146 that driver are output. For example:
3147 .code
3148 exim -bP transport local_delivery
3149 .endd
3150 The generic driver options are output first, followed by the driver's private
3151 options. A list of the names of drivers of a particular type can be obtained by
3152 using one of the words &%router_list%&, &%transport_list%&, or
3153 &%authenticator_list%&, and a complete list of all drivers with their option
3154 settings can be obtained by using &%routers%&, &%transports%&, or
3155 &%authenticators%&.
3156
3157 .cindex "environment"
3158 If &%environment%& is given as an argument, the set of environment
3159 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3160 variables.
3161
3162 .cindex "options" "macro &-- extracting"
3163 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3164 are available, similarly to the drivers.  Because macros are sometimes used
3165 for storing passwords, this option is restricted.
3166 The output format is one item per line.
3167
3168 .vitem &%-bp%&
3169 .oindex "&%-bp%&"
3170 .cindex "queue" "listing messages on"
3171 .cindex "listing" "messages on the queue"
3172 This option requests a listing of the contents of the mail queue on the
3173 standard output. If the &%-bp%& option is followed by a list of message ids,
3174 just those messages are listed. By default, this option can be used only by an
3175 admin user. However, the &%queue_list_requires_admin%& option can be set false
3176 to allow any user to see the queue.
3177
3178 Each message on the queue is displayed as in the following example:
3179 .code
3180 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3181           red.king@looking-glass.fict.example
3182           <other addresses>
3183 .endd
3184 .cindex "message" "size in queue listing"
3185 .cindex "size" "of message"
3186 The first line contains the length of time the message has been on the queue
3187 (in this case 25 minutes), the size of the message (2.9K), the unique local
3188 identifier for the message, and the message sender, as contained in the
3189 envelope. For bounce messages, the sender address is empty, and appears as
3190 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3191 the default sender address, the user's login name is shown in parentheses
3192 before the sender address.
3193
3194 .cindex "frozen messages" "in queue listing"
3195 If the message is frozen (attempts to deliver it are suspended) then the text
3196 &"*** frozen ***"& is displayed at the end of this line.
3197
3198 The recipients of the message (taken from the envelope, not the headers) are
3199 displayed on subsequent lines. Those addresses to which the message has already
3200 been delivered are marked with the letter D. If an original address gets
3201 expanded into several addresses via an alias or forward file, the original is
3202 displayed with a D only when deliveries for all of its child addresses are
3203 complete.
3204
3205
3206 .vitem &%-bpa%&
3207 .oindex "&%-bpa%&"
3208 This option operates like &%-bp%&, but in addition it shows delivered addresses
3209 that were generated from the original top level address(es) in each message by
3210 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3211 of just &"D"&.
3212
3213
3214 .vitem &%-bpc%&
3215 .oindex "&%-bpc%&"
3216 .cindex "queue" "count of messages on"
3217 This option counts the number of messages on the queue, and writes the total
3218 to the standard output. It is restricted to admin users, unless
3219 &%queue_list_requires_admin%& is set false.
3220
3221
3222 .vitem &%-bpr%&
3223 .oindex "&%-bpr%&"
3224 This option operates like &%-bp%&, but the output is not sorted into
3225 chronological order of message arrival. This can speed it up when there are
3226 lots of messages on the queue, and is particularly useful if the output is
3227 going to be post-processed in a way that doesn't need the sorting.
3228
3229 .vitem &%-bpra%&
3230 .oindex "&%-bpra%&"
3231 This option is a combination of &%-bpr%& and &%-bpa%&.
3232
3233 .vitem &%-bpru%&
3234 .oindex "&%-bpru%&"
3235 This option is a combination of &%-bpr%& and &%-bpu%&.
3236
3237
3238 .vitem &%-bpu%&
3239 .oindex "&%-bpu%&"
3240 This option operates like &%-bp%& but shows only undelivered top-level
3241 addresses for each message displayed. Addresses generated by aliasing or
3242 forwarding are not shown, unless the message was deferred after processing by a
3243 router with the &%one_time%& option set.
3244
3245
3246 .vitem &%-brt%&
3247 .oindex "&%-brt%&"
3248 .cindex "testing" "retry configuration"
3249 .cindex "retry" "configuration testing"
3250 This option is for testing retry rules, and it must be followed by up to three
3251 arguments. It causes Exim to look for a retry rule that matches the values
3252 and to write it to the standard output. For example:
3253 .code
3254 exim -brt bach.comp.mus.example
3255 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3256 .endd
3257 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3258 argument, which is required, can be a complete address in the form
3259 &'local_part@domain'&, or it can be just a domain name. If the second argument
3260 contains a dot, it is interpreted as an optional second domain name; if no
3261 retry rule is found for the first argument, the second is tried. This ties in
3262 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3263 rule is found that matches the host, one that matches the mail domain is
3264 sought. Finally, an argument that is the name of a specific delivery error, as
3265 used in setting up retry rules, can be given. For example:
3266 .code
3267 exim -brt haydn.comp.mus.example quota_3d
3268 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3269 .endd
3270
3271 .vitem &%-brw%&
3272 .oindex "&%-brw%&"
3273 .cindex "testing" "rewriting"
3274 .cindex "rewriting" "testing"
3275 This option is for testing address rewriting rules, and it must be followed by
3276 a single argument, consisting of either a local part without a domain, or a
3277 complete address with a fully qualified domain. Exim outputs how this address
3278 would be rewritten for each possible place it might appear. See chapter
3279 &<<CHAPrewrite>>& for further details.
3280
3281 .vitem &%-bS%&
3282 .oindex "&%-bS%&"
3283 .cindex "SMTP" "batched incoming"
3284 .cindex "batched SMTP input"
3285 This option is used for batched SMTP input, which is an alternative interface
3286 for non-interactive local message submission. A number of messages can be
3287 submitted in a single run. However, despite its name, this is not really SMTP
3288 input. Exim reads each message's envelope from SMTP commands on the standard
3289 input, but generates no responses. If the caller is trusted, or
3290 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3291 believed; otherwise the sender is always the caller of Exim.
3292
3293 The message itself is read from the standard input, in SMTP format (leading
3294 dots doubled), terminated by a line containing just a single dot. An error is
3295 provoked if the terminating dot is missing. A further message may then follow.
3296
3297 As for other local message submissions, the contents of incoming batch SMTP
3298 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3299 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3300 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3301
3302 Some other SMTP commands are recognized in the input. HELO and EHLO act
3303 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3304 QUIT quits, ignoring the rest of the standard input.
3305
3306 .cindex "return code" "for &%-bS%&"
3307 If any error is encountered, reports are written to the standard output and
3308 error streams, and Exim gives up immediately. The return code is 0 if no error
3309 was detected; it is 1 if one or more messages were accepted before the error
3310 was detected; otherwise it is 2.
3311
3312 More details of input using batched SMTP are given in section
3313 &<<SECTincomingbatchedSMTP>>&.
3314
3315 .vitem &%-bs%&
3316 .oindex "&%-bs%&"
3317 .cindex "SMTP" "local input"
3318 .cindex "local SMTP input"
3319 This option causes Exim to accept one or more messages by reading SMTP commands
3320 on the standard input, and producing SMTP replies on the standard output. SMTP
3321 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3322 Some user agents use this interface as a way of passing locally-generated
3323 messages to the MTA.
3324
3325 In
3326 .cindex "sender" "source of"
3327 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3328 set, the senders of messages are taken from the SMTP MAIL commands.
3329 Otherwise the content of these commands is ignored and the sender is set up as
3330 the calling user. Unqualified addresses are automatically qualified using
3331 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3332 &%-bnq%& option is used.
3333
3334 .cindex "inetd"
3335 The
3336 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3337 using a listening daemon. Exim can distinguish the two cases by checking
3338 whether the standard input is a TCP/IP socket. When Exim is called from
3339 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3340 above concerning senders and qualification do not apply. In this situation,
3341 Exim behaves in exactly the same way as it does when receiving a message via
3342 the listening daemon.
3343
3344 .vitem &%-bt%&
3345 .oindex "&%-bt%&"
3346 .cindex "testing" "addresses"
3347 .cindex "address" "testing"
3348 This option runs Exim in address testing mode, in which each argument is taken
3349 as a recipient address to be tested for deliverability. The results are
3350 written to the standard output. If a test fails, and the caller is not an admin
3351 user, no details of the failure are output, because these might contain
3352 sensitive information such as usernames and passwords for database lookups.
3353
3354 If no arguments are given, Exim runs in an interactive manner, prompting with a
3355 right angle bracket for addresses to be tested.
3356
3357 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3358 &[readline()]& function, because it is running as &'root'& and there are
3359 security issues.
3360
3361 Each address is handled as if it were the recipient address of a message
3362 (compare the &%-bv%& option). It is passed to the routers and the result is
3363 written to the standard output. However, any router that has
3364 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3365 genuine routing tests if your first router passes everything to a scanner
3366 program.
3367
3368 .cindex "return code" "for &%-bt%&"
3369 The return code is 2 if any address failed outright; it is 1 if no address
3370 failed outright but at least one could not be resolved for some reason. Return
3371 code 0 is given only when all addresses succeed.
3372
3373 .cindex "duplicate addresses"
3374 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3375 addresses after routing is complete, so that only one delivery takes place.
3376 This does not happen when testing with &%-bt%&; the full results of routing are
3377 always shown.
3378
3379 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3380 routers in the configuration makes any tests on the sender address of a
3381 message,
3382 .oindex "&%-f%&" "for address testing"
3383 you can use the &%-f%& option to set an appropriate sender when running
3384 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3385 default qualifying domain. However, if you have set up (for example) routers
3386 whose behaviour depends on the contents of an incoming message, you cannot test
3387 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3388 doing such tests.
3389
3390 .vitem &%-bV%&
3391 .oindex "&%-bV%&"
3392 .cindex "version number of Exim"
3393 This option causes Exim to write the current version number, compilation
3394 number, and compilation date of the &'exim'& binary to the standard output.
3395 It also lists the DBM library that is being used, the optional modules (such as
3396 specific lookup types), the drivers that are included in the binary, and the
3397 name of the run time configuration file that is in use.
3398
3399 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3400 configuration file. However, this is a static check only. It cannot check
3401 values that are to be expanded. For example, although a misspelt ACL verb is
3402 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3403 alone to discover (for example) all the typos in the configuration; some
3404 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3405 dynamic testing facilities.
3406
3407 .vitem &%-bv%&
3408 .oindex "&%-bv%&"
3409 .cindex "verifying address" "using &%-bv%&"
3410 .cindex "address" "verification"
3411 This option runs Exim in address verification mode, in which each argument is
3412 taken as a recipient address to be verified by the routers. (This does
3413 not involve any verification callouts). During normal operation, verification
3414 happens mostly as a consequence processing a &%verify%& condition in an ACL
3415 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3416 including callouts, see the &%-bh%& and &%-bhc%& options.
3417
3418 If verification fails, and the caller is not an admin user, no details of the
3419 failure are output, because these might contain sensitive information such as
3420 usernames and passwords for database lookups.
3421
3422 If no arguments are given, Exim runs in an interactive manner, prompting with a
3423 right angle bracket for addresses to be verified.
3424
3425 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3426 &[readline()]& function, because it is running as &'exim'& and there are
3427 security issues.
3428
3429 Verification differs from address testing (the &%-bt%& option) in that routers
3430 that have &%no_verify%& set are skipped, and if the address is accepted by a
3431 router that has &%fail_verify%& set, verification fails. The address is
3432 verified as a recipient if &%-bv%& is used; to test verification for a sender
3433 address, &%-bvs%& should be used.
3434
3435 If the &%-v%& option is not set, the output consists of a single line for each
3436 address, stating whether it was verified or not, and giving a reason in the
3437 latter case. Without &%-v%&, generating more than one address by redirection
3438 causes verification to end successfully, without considering the generated
3439 addresses. However, if just one address is generated, processing continues,
3440 and the generated address must verify successfully for the overall verification
3441 to succeed.
3442
3443 When &%-v%& is set, more details are given of how the address has been handled,
3444 and in the case of address redirection, all the generated addresses are also
3445 considered. Verification may succeed for some and fail for others.
3446
3447 The
3448 .cindex "return code" "for &%-bv%&"
3449 return code is 2 if any address failed outright; it is 1 if no address
3450 failed outright but at least one could not be resolved for some reason. Return
3451 code 0 is given only when all addresses succeed.
3452
3453 If any of the routers in the configuration makes any tests on the sender
3454 address of a message, you should use the &%-f%& option to set an appropriate
3455 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3456 calling user at the default qualifying domain.
3457
3458 .vitem &%-bvs%&
3459 .oindex "&%-bvs%&"
3460 This option acts like &%-bv%&, but verifies the address as a sender rather
3461 than a recipient address. This affects any rewriting and qualification that
3462 might happen.
3463
3464 .vitem &%-bw%&
3465 .oindex "&%-bw%&"
3466 .cindex "daemon"
3467 .cindex "inetd"
3468 .cindex "inetd" "wait mode"
3469 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3470 similarly to the &%-bd%& option.  All port specifications on the command-line
3471 and in the configuration file are ignored.  Queue-running may not be specified.
3472
3473 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3474 listening for connections.  This permits the system to start up and have
3475 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3476 each port only when the first connection is received.
3477
3478 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3479 which the daemon will exit, which should cause inetd to listen once more.
3480
3481 .vitem &%-C%&&~<&'filelist'&>
3482 .oindex "&%-C%&"
3483 .cindex "configuration file" "alternate"
3484 .cindex "CONFIGURE_FILE"
3485 .cindex "alternate configuration file"
3486 This option causes Exim to find the run time configuration file from the given
3487 list instead of from the list specified by the CONFIGURE_FILE
3488 compile-time setting. Usually, the list will consist of just a single file
3489 name, but it can be a colon-separated list of names. In this case, the first
3490 file that exists is used. Failure to open an existing file stops Exim from
3491 proceeding any further along the list, and an error is generated.
3492
3493 When this option is used by a caller other than root, and the list is different
3494 from the compiled-in list, Exim gives up its root privilege immediately, and
3495 runs with the real and effective uid and gid set to those of the caller.
3496 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3497 file contains a list of full pathnames, one per line, for configuration files
3498 which are trusted. Root privilege is retained for any configuration file so
3499 listed, as long as the caller is the Exim user (or the user specified in the
3500 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3501 not writeable by inappropriate users or groups.
3502
3503 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3504 configuration using &%-C%& right through message reception and delivery,
3505 even if the caller is root. The reception works, but by that time, Exim is
3506 running as the Exim user, so when it re-executes to regain privilege for the
3507 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3508 test reception and delivery using two separate commands (one to put a message
3509 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3510
3511 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3512 prefix string with which any file named in a &%-C%& command line option
3513 must start. In addition, the file name must not contain the sequence &`/../`&.
3514 However, if the value of the &%-C%& option is identical to the value of
3515 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3516 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3517 unset, any file name can be used with &%-C%&.
3518
3519 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3520 to a directory to which only root has access. This prevents someone who has
3521 broken into the Exim account from running a privileged Exim with an arbitrary
3522 configuration file.
3523
3524 The &%-C%& facility is useful for ensuring that configuration files are
3525 syntactically correct, but cannot be used for test deliveries, unless the
3526 caller is privileged, or unless it is an exotic configuration that does not
3527 require privilege. No check is made on the owner or group of the files
3528 specified by this option.
3529
3530
3531 .vitem &%-D%&<&'macro'&>=<&'value'&>
3532 .oindex "&%-D%&"
3533 .cindex "macro" "setting on command line"
3534 This option can be used to override macro definitions in the configuration file
3535 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3536 unprivileged caller, it causes Exim to give up its root privilege.
3537 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3538 completely disabled, and its use causes an immediate error exit.
3539
3540 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3541 colon-separated list of macros which are considered safe and, if &%-D%& only
3542 supplies macros from this list, and the values are acceptable, then Exim will
3543 not give up root privilege if the caller is root, the Exim run-time user, or
3544 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3545 to be removed in the future.  Acceptable values for the macros satisfy the
3546 regexp: &`^[A-Za-z0-9_/.-]*$`&
3547
3548 The entire option (including equals sign if present) must all be within one
3549 command line item. &%-D%& can be used to set the value of a macro to the empty
3550 string, in which case the equals sign is optional. These two commands are
3551 synonymous:
3552 .code
3553 exim -DABC  ...
3554 exim -DABC= ...
3555 .endd
3556 To include spaces in a macro definition item, quotes must be used. If you use
3557 quotes, spaces are permitted around the macro name and the equals sign. For
3558 example:
3559 .code
3560 exim '-D ABC = something' ...
3561 .endd
3562 &%-D%& may be repeated up to 10 times on a command line.
3563 Only macro names up to 22 letters long can be set.
3564
3565
3566 .vitem &%-d%&<&'debug&~options'&>
3567 .oindex "&%-d%&"
3568 .cindex "debugging" "list of selectors"
3569 .cindex "debugging" "&%-d%& option"
3570 This option causes debugging information to be written to the standard
3571 error stream. It is restricted to admin users because debugging output may show
3572 database queries that contain password information. Also, the details of users'
3573 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3574 writes an error message to the standard error stream and exits with a non-zero
3575 return code.
3576
3577 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3578 standard debugging data is output. This can be reduced, or increased to include
3579 some more rarely needed information, by directly following &%-d%& with a string
3580 made up of names preceded by plus or minus characters. These add or remove sets
3581 of debugging data, respectively. For example, &%-d+filter%& adds filter
3582 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3583 no spaces are allowed in the debug setting. The available debugging categories
3584 are:
3585 .display
3586 &`acl            `& ACL interpretation
3587 &`auth           `& authenticators
3588 &`deliver        `& general delivery logic
3589 &`dns            `& DNS lookups (see also resolver)
3590 &`dnsbl          `& DNS black list (aka RBL) code
3591 &`exec           `& arguments for &[execv()]& calls
3592 &`expand         `& detailed debugging for string expansions
3593 &`filter         `& filter handling
3594 &`hints_lookup   `& hints data lookups
3595 &`host_lookup    `& all types of name-to-IP address handling
3596 &`ident          `& ident lookup
3597 &`interface      `& lists of local interfaces
3598 &`lists          `& matching things in lists
3599 &`load           `& system load checks
3600 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3601                     &<<CHAPlocalscan>>&)
3602 &`lookup         `& general lookup code and all lookups
3603 &`memory         `& memory handling
3604 &`pid            `& add pid to debug output lines
3605 &`process_info   `& setting info for the process log
3606 &`queue_run      `& queue runs
3607 &`receive        `& general message reception logic
3608 &`resolver       `& turn on the DNS resolver's debugging output
3609 &`retry          `& retry handling
3610 &`rewrite        `& address rewriting
3611 &`route          `& address routing
3612 &`timestamp      `& add timestamp to debug output lines
3613 &`tls            `& TLS logic
3614 &`transport      `& transports
3615 &`uid            `& changes of uid/gid and looking up uid/gid
3616 &`verify         `& address verification logic
3617 &`all            `& almost all of the above (see below), and also &%-v%&
3618 .endd
3619 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3620 for &`-all`&. The reason for this is that &`+all`& is something that people
3621 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3622 is included, an awful lot of output that is very rarely of interest is
3623 generated, so it now has to be explicitly requested. However, &`-all`& does
3624 turn everything off.
3625
3626 .cindex "resolver, debugging output"
3627 .cindex "DNS resolver, debugging output"
3628 The &`resolver`& option produces output only if the DNS resolver was compiled
3629 with DEBUG enabled. This is not the case in some operating systems. Also,
3630 unfortunately, debugging output from the DNS resolver is written to stdout
3631 rather than stderr.
3632
3633 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3634 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3635 However, the &`pid`& selector is forced when debugging is turned on for a
3636 daemon, which then passes it on to any re-executed Exims. Exim also
3637 automatically adds the pid to debug lines when several remote deliveries are
3638 run in parallel.
3639
3640 The &`timestamp`& selector causes the current time to be inserted at the start
3641 of all debug output lines. This can be useful when trying to track down delays
3642 in processing.
3643
3644 If the &%debug_print%& option is set in any driver, it produces output whenever
3645 any debugging is selected, or if &%-v%& is used.
3646
3647 .vitem &%-dd%&<&'debug&~options'&>
3648 .oindex "&%-dd%&"
3649 This option behaves exactly like &%-d%& except when used on a command that
3650 starts a daemon process. In that case, debugging is turned off for the
3651 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3652 behaviour of the daemon without creating as much output as full debugging does.
3653
3654 .vitem &%-dropcr%&
3655 .oindex "&%-dropcr%&"
3656 This is an obsolete option that is now a no-op. It used to affect the way Exim
3657 handled CR and LF characters in incoming messages. What happens now is
3658 described in section &<<SECTlineendings>>&.
3659
3660 .vitem &%-E%&
3661 .oindex "&%-E%&"
3662 .cindex "bounce message" "generating"
3663 This option specifies that an incoming message is a locally-generated delivery
3664 failure report. It is used internally by Exim when handling delivery failures
3665 and is not intended for external use. Its only effect is to stop Exim
3666 generating certain messages to the postmaster, as otherwise message cascades
3667 could occur in some situations. As part of the same option, a message id may
3668 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3669 new message contains the id, following &"R="&, as a cross-reference.
3670
3671 .vitem &%-e%&&'x'&
3672 .oindex "&%-e%&&'x'&"
3673 There are a number of Sendmail options starting with &%-oe%& which seem to be
3674 called by various programs without the leading &%o%& in the option. For
3675 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3676 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3677
3678 .vitem &%-F%&&~<&'string'&>
3679 .oindex "&%-F%&"
3680 .cindex "sender" "name"
3681 .cindex "name" "of sender"
3682 This option sets the sender's full name for use when a locally-generated
3683 message is being accepted. In the absence of this option, the user's &'gecos'&
3684 entry from the password data is used. As users are generally permitted to alter
3685 their &'gecos'& entries, no security considerations are involved. White space
3686 between &%-F%& and the <&'string'&> is optional.
3687
3688 .vitem &%-f%&&~<&'address'&>
3689 .oindex "&%-f%&"
3690 .cindex "sender" "address"
3691 .cindex "address" "sender"
3692 .cindex "trusted users"
3693 .cindex "envelope sender"
3694 .cindex "user" "trusted"
3695 This option sets the address of the envelope sender of a locally-generated
3696 message (also known as the return path). The option can normally be used only
3697 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3698 users to use it.
3699
3700 Processes running as root or the Exim user are always trusted. Other
3701 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3702 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3703 of a local message is set to the caller's login name at the default qualify
3704 domain.
3705
3706 There is one exception to the restriction on the use of &%-f%&: an empty sender
3707 can be specified by any user, trusted or not, to create a message that can
3708 never provoke a bounce. An empty sender can be specified either as an empty
3709 string, or as a pair of angle brackets with nothing between them, as in these
3710 examples of shell commands:
3711 .code
3712 exim -f '<>' user@domain
3713 exim -f "" user@domain
3714 .endd
3715 In addition, the use of &%-f%& is not restricted when testing a filter file
3716 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3717 &%-bv%& options.
3718
3719 Allowing untrusted users to change the sender address does not of itself make
3720 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3721 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3722 though this can be overridden by setting &%no_local_from_check%&.
3723
3724 White
3725 .cindex "&""From""& line"
3726 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3727 given as two arguments or one combined argument). The sender of a
3728 locally-generated message can also be set (when permitted) by an initial
3729 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3730 if &%-f%& is also present, it overrides &"From&~"&.
3731
3732 .vitem &%-G%&
3733 .oindex "&%-G%&"
3734 .cindex "submission fixups, suppressing (command-line)"
3735 This option is equivalent to an ACL applying:
3736 .code
3737 control = suppress_local_fixups
3738 .endd
3739 for every message received.  Note that Sendmail will complain about such
3740 bad formatting, where Exim silently just does not fix it up.  This may change
3741 in future.
3742
3743 As this affects audit information, the caller must be a trusted user to use
3744 this option.
3745
3746 .vitem &%-h%&&~<&'number'&>
3747 .oindex "&%-h%&"
3748 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3749 This option is accepted for compatibility with Sendmail, but has no effect. (In
3750 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3751 headers.)
3752
3753 .vitem &%-i%&
3754 .oindex "&%-i%&"
3755 .cindex "Solaris" "&'mail'& command"
3756 .cindex "dot" "in incoming non-SMTP message"
3757 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3758 line by itself should not terminate an incoming, non-SMTP message. I can find
3759 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3760 command in Solaris 2.4 uses it. See also &%-ti%&.
3761
3762 .vitem &%-L%&&~<&'tag'&>
3763 .oindex "&%-L%&"
3764 .cindex "syslog" "process name; set with flag"
3765 This option is equivalent to setting &%syslog_processname%& in the config
3766 file and setting &%log_file_path%& to &`syslog`&.
3767 Its use is restricted to administrators.  The configuration file has to be
3768 read and parsed, to determine access rights, before this is set and takes
3769 effect, so early configuration file errors will not honour this flag.
3770
3771 The tag should not be longer than 32 characters.
3772
3773 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3774 .oindex "&%-M%&"
3775 .cindex "forcing delivery"
3776 .cindex "delivery" "forcing attempt"
3777 .cindex "frozen messages" "forcing delivery"
3778 This option requests Exim to run a delivery attempt on each message in turn. If
3779 any of the messages are frozen, they are automatically thawed before the
3780 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3781 and &%hold_domains%& are ignored.
3782
3783 Retry
3784 .cindex "hints database" "overriding retry hints"
3785 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3786 the normal retry time has not yet been reached. This option requires the caller
3787 to be an admin user. However, there is an option called &%prod_requires_admin%&
3788 which can be set false to relax this restriction (and also the same requirement
3789 for the &%-q%&, &%-R%&, and &%-S%& options).
3790
3791 The deliveries happen synchronously, that is, the original Exim process does
3792 not terminate until all the delivery attempts have finished. No output is
3793 produced unless there is a serious error. If you want to see what is happening,
3794 use the &%-v%& option as well, or inspect Exim's main log.
3795
3796 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3797 .oindex "&%-Mar%&"
3798 .cindex "message" "adding recipients"
3799 .cindex "recipient" "adding"
3800 This option requests Exim to add the addresses to the list of recipients of the
3801 message (&"ar"& for &"add recipients"&). The first argument must be a message
3802 id, and the remaining ones must be email addresses. However, if the message is
3803 active (in the middle of a delivery attempt), it is not altered. This option
3804 can be used only by an admin user.
3805
3806 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3807         &~<&'message&~id'&>"
3808 .oindex "&%-MC%&"
3809 .cindex "SMTP" "passed connection"
3810 .cindex "SMTP" "multiple deliveries"
3811 .cindex "multiple SMTP deliveries"
3812 This option is not intended for use by external callers. It is used internally
3813 by Exim to invoke another instance of itself to deliver a waiting message using
3814 an existing SMTP connection, which is passed as the standard input. Details are
3815 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3816 must be root or the Exim user in order to use it.
3817
3818 .vitem &%-MCA%&
3819 .oindex "&%-MCA%&"
3820 This option is not intended for use by external callers. It is used internally
3821 by Exim in conjunction with the &%-MC%& option. It signifies that the
3822 connection to the remote host has been authenticated.
3823
3824 .vitem &%-MCD%&
3825 .oindex "&%-MCD%&"
3826 This option is not intended for use by external callers. It is used internally
3827 by Exim in conjunction with the &%-MC%& option. It signifies that the
3828 remote host supports the ESMTP &_DSN_& extension.
3829
3830 .vitem &%-MCG%&&~<&'queue&~name'&>
3831 .oindex "&%-MCG%&"
3832 This option is not intended for use by external callers. It is used internally
3833 by Exim in conjunction with the &%-MC%& option. It signifies that an
3834 alternate queue is used, named by the following argument.
3835
3836 .vitem &%-MCK%&
3837 .oindex "&%-MCK%&"
3838 This option is not intended for use by external callers. It is used internally
3839 by Exim in conjunction with the &%-MC%& option. It signifies that an
3840 remote host supports the ESMTP &_CHUNKING_& extension.
3841
3842 .vitem &%-MCP%&
3843 .oindex "&%-MCP%&"
3844 This option is not intended for use by external callers. It is used internally
3845 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3846 which Exim is connected supports pipelining.
3847
3848 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3849 .oindex "&%-MCQ%&"
3850 This option is not intended for use by external callers. It is used internally
3851 by Exim in conjunction with the &%-MC%& option when the original delivery was
3852 started by a queue runner. It passes on the process id of the queue runner,
3853 together with the file descriptor number of an open pipe. Closure of the pipe
3854 signals the final completion of the sequence of processes that are passing
3855 messages through the same SMTP connection.
3856
3857 .vitem &%-MCS%&
3858 .oindex "&%-MCS%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3861 SMTP SIZE option should be used on messages delivered down the existing
3862 connection.
3863
3864 .vitem &%-MCT%&
3865 .oindex "&%-MCT%&"
3866 This option is not intended for use by external callers. It is used internally
3867 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3868 host to which Exim is connected supports TLS encryption.
3869
3870 .new
3871 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3872 .oindex "&%-MCt%&"
3873 This option is not intended for use by external callers. It is used internally
3874 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3875 connection is being proxied by a parent process for handling TLS encryption.
3876 The arguments give the local address and port being proxied, and the TLS cipher.
3877 .wen
3878
3879 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3880 .oindex "&%-Mc%&"
3881 .cindex "hints database" "not overridden by &%-Mc%&"
3882 .cindex "delivery" "manually started &-- not forced"
3883 This option requests Exim to run a delivery attempt on each message in turn,
3884 but unlike the &%-M%& option, it does check for retry hints, and respects any
3885 that are found. This option is not very useful to external callers. It is
3886 provided mainly for internal use by Exim when it needs to re-invoke itself in
3887 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3888 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3889 respects retry times and other options such as &%hold_domains%& that are
3890 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3891 If you want to run a specific delivery as if in a queue run, you should use
3892 &%-q%& with a message id argument. A distinction between queue run deliveries
3893 and other deliveries is made in one or two places.
3894
3895 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3896 .oindex "&%-Mes%&"
3897 .cindex "message" "changing sender"
3898 .cindex "sender" "changing"
3899 This option requests Exim to change the sender address in the message to the
3900 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3901 &"edit sender"&). There must be exactly two arguments. The first argument must
3902 be a message id, and the second one an email address. However, if the message
3903 is active (in the middle of a delivery attempt), its status is not altered.
3904 This option can be used only by an admin user.
3905
3906 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3907 .oindex "&%-Mf%&"
3908 .cindex "freezing messages"
3909 .cindex "message" "manually freezing"
3910 This option requests Exim to mark each listed message as &"frozen"&. This
3911 prevents any delivery attempts taking place until the message is &"thawed"&,
3912 either manually or as a result of the &%auto_thaw%& configuration option.
3913 However, if any of the messages are active (in the middle of a delivery
3914 attempt), their status is not altered. This option can be used only by an admin
3915 user.
3916
3917 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3918 .oindex "&%-Mg%&"
3919 .cindex "giving up on messages"
3920 .cindex "message" "abandoning delivery attempts"
3921 .cindex "delivery" "abandoning further attempts"
3922 This option requests Exim to give up trying to deliver the listed messages,
3923 including any that are frozen. However, if any of the messages are active,
3924 their status is not altered. For non-bounce messages, a delivery error message
3925 is sent to the sender, containing the text &"cancelled by administrator"&.
3926 Bounce messages are just discarded. This option can be used only by an admin
3927 user.
3928
3929 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3930 .oindex "&%-Mmad%&"
3931 .cindex "delivery" "cancelling all"
3932 This option requests Exim to mark all the recipient addresses in the messages
3933 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3934 message is active (in the middle of a delivery attempt), its status is not
3935 altered. This option can be used only by an admin user.
3936
3937 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3938 .oindex "&%-Mmd%&"
3939 .cindex "delivery" "cancelling by address"
3940 .cindex "recipient" "removing"
3941 .cindex "removing recipients"
3942 This option requests Exim to mark the given addresses as already delivered
3943 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3944 the remaining ones must be email addresses. These are matched to recipient
3945 addresses in the message in a case-sensitive manner. If the message is active
3946 (in the middle of a delivery attempt), its status is not altered. This option
3947 can be used only by an admin user.
3948
3949 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3950 .oindex "&%-Mrm%&"
3951 .cindex "removing messages"
3952 .cindex "abandoning mail"
3953 .cindex "message" "manually discarding"
3954 This option requests Exim to remove the given messages from the queue. No
3955 bounce messages are sent; each message is simply forgotten. However, if any of
3956 the messages are active, their status is not altered. This option can be used
3957 only by an admin user or by the user who originally caused the message to be
3958 placed on the queue.
3959
3960 .vitem &%-Mset%&&~<&'message&~id'&>
3961 .oindex "&%-Mset%&
3962 .cindex "testing" "string expansion"
3963 .cindex "expansion" "testing"
3964 This option is useful only in conjunction with &%-be%& (that is, when testing
3965 string expansions). Exim loads the given message from its spool before doing
3966 the test expansions, thus setting message-specific variables such as
3967 &$message_size$& and the header variables. The &$recipients$& variable is made
3968 available. This feature is provided to make it easier to test expansions that
3969 make use of these variables. However, this option can be used only by an admin
3970 user. See also &%-bem%&.
3971
3972 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3973 .oindex "&%-Mt%&"
3974 .cindex "thawing messages"
3975 .cindex "unfreezing messages"
3976 .cindex "frozen messages" "thawing"
3977 .cindex "message" "thawing frozen"
3978 This option requests Exim to &"thaw"& any of the listed messages that are
3979 &"frozen"&, so that delivery attempts can resume. However, if any of the
3980 messages are active, their status is not altered. This option can be used only
3981 by an admin user.
3982
3983 .vitem &%-Mvb%&&~<&'message&~id'&>
3984 .oindex "&%-Mvb%&"
3985 .cindex "listing" "message body"
3986 .cindex "message" "listing body of"
3987 This option causes the contents of the message body (-D) spool file to be
3988 written to the standard output. This option can be used only by an admin user.
3989
3990 .vitem &%-Mvc%&&~<&'message&~id'&>
3991 .oindex "&%-Mvc%&"
3992 .cindex "message" "listing in RFC 2822 format"
3993 .cindex "listing" "message in RFC 2822 format"
3994 This option causes a copy of the complete message (header lines plus body) to
3995 be written to the standard output in RFC 2822 format. This option can be used
3996 only by an admin user.
3997
3998 .vitem &%-Mvh%&&~<&'message&~id'&>
3999 .oindex "&%-Mvh%&"
4000 .cindex "listing" "message headers"
4001 .cindex "header lines" "listing"
4002 .cindex "message" "listing header lines"
4003 This option causes the contents of the message headers (-H) spool file to be
4004 written to the standard output. This option can be used only by an admin user.
4005
4006 .vitem &%-Mvl%&&~<&'message&~id'&>
4007 .oindex "&%-Mvl%&"
4008 .cindex "listing" "message log"
4009 .cindex "message" "listing message log"
4010 This option causes the contents of the message log spool file to be written to
4011 the standard output. This option can be used only by an admin user.
4012
4013 .vitem &%-m%&
4014 .oindex "&%-m%&"
4015 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4016 treats it that way too.
4017
4018 .vitem &%-N%&
4019 .oindex "&%-N%&"
4020 .cindex "debugging" "&%-N%& option"
4021 .cindex "debugging" "suppressing delivery"
4022 This is a debugging option that inhibits delivery of a message at the transport
4023 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4024 it just doesn't actually transport the message, but instead behaves as if it
4025 had successfully done so. However, it does not make any updates to the retry
4026 database, and the log entries for deliveries are flagged with &"*>"& rather
4027 than &"=>"&.
4028
4029 Because &%-N%& discards any message to which it applies, only root or the Exim
4030 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4031 words, an ordinary user can use it only when supplying an incoming message to
4032 which it will apply. Although transportation never fails when &%-N%& is set, an
4033 address may be deferred because of a configuration problem on a transport, or a
4034 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4035 the message, and applies to any subsequent delivery attempts that may happen
4036 for that message.
4037
4038 .vitem &%-n%&
4039 .oindex "&%-n%&"
4040 This option is interpreted by Sendmail to mean &"no aliasing"&.
4041 For normal modes of operation, it is ignored by Exim.
4042 When combined with &%-bP%& it makes the output more terse (suppresses
4043 option names, environment values and config pretty printing).
4044
4045 .vitem &%-O%&&~<&'data'&>
4046 .oindex "&%-O%&"
4047 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4048 Exim.
4049
4050 .vitem &%-oA%&&~<&'file&~name'&>
4051 .oindex "&%-oA%&"
4052 .cindex "Sendmail compatibility" "&%-oA%& option"
4053 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4054 alternative alias file name. Exim handles &%-bi%& differently; see the
4055 description above.
4056
4057 .vitem &%-oB%&&~<&'n'&>
4058 .oindex "&%-oB%&"
4059 .cindex "SMTP" "passed connection"
4060 .cindex "SMTP" "multiple deliveries"
4061 .cindex "multiple SMTP deliveries"
4062 This is a debugging option which limits the maximum number of messages that can
4063 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4064 transport. If <&'n'&> is omitted, the limit is set to 1.
4065
4066 .vitem &%-odb%&
4067 .oindex "&%-odb%&"
4068 .cindex "background delivery"
4069 .cindex "delivery" "in the background"
4070 This option applies to all modes in which Exim accepts incoming messages,
4071 including the listening daemon. It requests &"background"& delivery of such
4072 messages, which means that the accepting process automatically starts a
4073 delivery process for each message received, but does not wait for the delivery
4074 processes to finish.
4075
4076 When all the messages have been received, the reception process exits,
4077 leaving the delivery processes to finish in their own time. The standard output
4078 and error streams are closed at the start of each delivery process.
4079 This is the default action if none of the &%-od%& options are present.
4080
4081 If one of the queueing options in the configuration file
4082 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4083 overrides it if &%queue_only_override%& is set true, which is the default
4084 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4085
4086 .vitem &%-odf%&
4087 .oindex "&%-odf%&"
4088 .cindex "foreground delivery"
4089 .cindex "delivery" "in the foreground"
4090 This option requests &"foreground"& (synchronous) delivery when Exim has
4091 accepted a locally-generated message. (For the daemon it is exactly the same as
4092 &%-odb%&.) A delivery process is automatically started to deliver the message,
4093 and Exim waits for it to complete before proceeding.
4094
4095 The original Exim reception process does not finish until the delivery
4096 process for the final message has ended. The standard error stream is left open
4097 during deliveries.
4098
4099 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4100 false and one of the queueing options in the configuration file is in effect.
4101
4102 If there is a temporary delivery error during foreground delivery, the
4103 message is left on the queue for later delivery, and the original reception
4104 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4105 restricted configuration that never queues messages.
4106
4107
4108 .vitem &%-odi%&
4109 .oindex "&%-odi%&"
4110 This option is synonymous with &%-odf%&. It is provided for compatibility with
4111 Sendmail.
4112
4113 .vitem &%-odq%&
4114 .oindex "&%-odq%&"
4115 .cindex "non-immediate delivery"
4116 .cindex "delivery" "suppressing immediate"
4117 .cindex "queueing incoming messages"
4118 This option applies to all modes in which Exim accepts incoming messages,
4119 including the listening daemon. It specifies that the accepting process should
4120 not automatically start a delivery process for each message received. Messages
4121 are placed on the queue, and remain there until a subsequent queue runner
4122 process encounters them. There are several configuration options (such as
4123 &%queue_only%&) that can be used to queue incoming messages under certain
4124 conditions. This option overrides all of them and also &%-odqs%&. It always
4125 forces queueing.
4126
4127 .vitem &%-odqs%&
4128 .oindex "&%-odqs%&"
4129 .cindex "SMTP" "delaying delivery"
4130 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4131 However, like &%-odb%& and &%-odi%&, this option has no effect if
4132 &%queue_only_override%& is false and one of the queueing options in the
4133 configuration file is in effect.
4134
4135 When &%-odqs%& does operate, a delivery process is started for each incoming
4136 message, in the background by default, but in the foreground if &%-odi%& is
4137 also present. The recipient addresses are routed, and local deliveries are done
4138 in the normal way. However, if any SMTP deliveries are required, they are not
4139 done at this time, so the message remains on the queue until a subsequent queue
4140 runner process encounters it. Because routing was done, Exim knows which
4141 messages are waiting for which hosts, and so a number of messages for the same
4142 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4143 configuration option has the same effect for specific domains. See also the
4144 &%-qq%& option.
4145
4146 .vitem &%-oee%&
4147 .oindex "&%-oee%&"
4148 .cindex "error" "reporting"
4149 If an error is detected while a non-SMTP message is being received (for
4150 example, a malformed address), the error is reported to the sender in a mail
4151 message.
4152
4153 .cindex "return code" "for &%-oee%&"
4154 Provided
4155 this error message is successfully sent, the Exim receiving process
4156 exits with a return code of zero. If not, the return code is 2 if the problem
4157 is that the original message has no recipients, or 1 for any other error.
4158 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4159
4160 .vitem &%-oem%&
4161 .oindex "&%-oem%&"
4162 .cindex "error" "reporting"
4163 .cindex "return code" "for &%-oem%&"
4164 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4165 return code, whether or not the error message was successfully sent.
4166 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4167
4168 .vitem &%-oep%&
4169 .oindex "&%-oep%&"
4170 .cindex "error" "reporting"
4171 If an error is detected while a non-SMTP message is being received, the
4172 error is reported by writing a message to the standard error file (stderr).
4173 .cindex "return code" "for &%-oep%&"
4174 The return code is 1 for all errors.
4175
4176 .vitem &%-oeq%&
4177 .oindex "&%-oeq%&"
4178 .cindex "error" "reporting"
4179 This option is supported for compatibility with Sendmail, but has the same
4180 effect as &%-oep%&.
4181
4182 .vitem &%-oew%&
4183 .oindex "&%-oew%&"
4184 .cindex "error" "reporting"
4185 This option is supported for compatibility with Sendmail, but has the same
4186 effect as &%-oem%&.
4187
4188 .vitem &%-oi%&
4189 .oindex "&%-oi%&"
4190 .cindex "dot" "in incoming non-SMTP message"
4191 This option, which has the same effect as &%-i%&, specifies that a dot on a
4192 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4193 single dot does terminate, though Exim does no special processing for other
4194 lines that start with a dot. This option is set by default if Exim is called as
4195 &'rmail'&. See also &%-ti%&.
4196
4197 .vitem &%-oitrue%&
4198 .oindex "&%-oitrue%&"
4199 This option is treated as synonymous with &%-oi%&.
4200
4201 .vitem &%-oMa%&&~<&'host&~address'&>
4202 .oindex "&%-oMa%&"
4203 .cindex "sender" "host address, specifying for local message"
4204 A number of options starting with &%-oM%& can be used to set values associated
4205 with remote hosts on locally-submitted messages (that is, messages not received
4206 over TCP/IP). These options can be used by any caller in conjunction with the
4207 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4208 other circumstances, they are ignored unless the caller is trusted.
4209
4210 The &%-oMa%& option sets the sender host address. This may include a port
4211 number at the end, after a full stop (period). For example:
4212 .code
4213 exim -bs -oMa 10.9.8.7.1234
4214 .endd
4215 An alternative syntax is to enclose the IP address in square brackets,
4216 followed by a colon and the port number:
4217 .code
4218 exim -bs -oMa [10.9.8.7]:1234
4219 .endd
4220 The IP address is placed in the &$sender_host_address$& variable, and the
4221 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4222 are present on the command line, the sender host IP address is taken from
4223 whichever one is last.
4224
4225 .vitem &%-oMaa%&&~<&'name'&>
4226 .oindex "&%-oMaa%&"
4227 .cindex "authentication" "name, specifying for local message"
4228 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4229 option sets the value of &$sender_host_authenticated$& (the authenticator
4230 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4231 This option can be used with &%-bh%& and &%-bs%& to set up an
4232 authenticated SMTP session without actually using the SMTP AUTH command.
4233
4234 .vitem &%-oMai%&&~<&'string'&>
4235 .oindex "&%-oMai%&"
4236 .cindex "authentication" "id, specifying for local message"
4237 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4238 option sets the value of &$authenticated_id$& (the id that was authenticated).
4239 This overrides the default value (the caller's login id, except with &%-bh%&,
4240 where there is no default) for messages from local sources. See chapter
4241 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4242
4243 .vitem &%-oMas%&&~<&'address'&>
4244 .oindex "&%-oMas%&"
4245 .cindex "authentication" "sender, specifying for local message"
4246 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4247 option sets the authenticated sender value in &$authenticated_sender$&. It
4248 overrides the sender address that is created from the caller's login id for
4249 messages from local sources, except when &%-bh%& is used, when there is no
4250 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4251 specified on a MAIL command overrides this value. See chapter
4252 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4253
4254 .vitem &%-oMi%&&~<&'interface&~address'&>
4255 .oindex "&%-oMi%&"
4256 .cindex "interface" "address, specifying for local message"
4257 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4258 option sets the IP interface address value. A port number may be included,
4259 using the same syntax as for &%-oMa%&. The interface address is placed in
4260 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4261
4262 .vitem &%-oMm%&&~<&'message&~reference'&>
4263 .oindex "&%-oMm%&"
4264 .cindex "message reference" "message reference, specifying for local message"
4265 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4266 option sets the message reference, e.g. message-id, and is logged during
4267 delivery. This is useful when some kind of audit trail is required to tie
4268 messages together. The format of the message reference is checked and will
4269 abort if the format is invalid. The option will only be accepted if exim is
4270 running in trusted mode, not as any regular user.
4271
4272 The best example of a message reference is when Exim sends a bounce message.
4273 The message reference is the message-id of the original message for which Exim
4274 is sending the bounce.
4275
4276 .vitem &%-oMr%&&~<&'protocol&~name'&>
4277 .oindex "&%-oMr%&"
4278 .cindex "protocol, specifying for local message"
4279 .vindex "&$received_protocol$&"
4280 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4281 option sets the received protocol value that is stored in
4282 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4283 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4284 SMTP protocol names (see the description of &$received_protocol$& in section
4285 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4286 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4287 be set by &%-oMr%&. Repeated use of this option is not supported.
4288
4289 .vitem &%-oMs%&&~<&'host&~name'&>
4290 .oindex "&%-oMs%&"
4291 .cindex "sender" "host name, specifying for local message"
4292 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4293 option sets the sender host name in &$sender_host_name$&. When this option is
4294 present, Exim does not attempt to look up a host name from an IP address; it
4295 uses the name it is given.
4296
4297 .vitem &%-oMt%&&~<&'ident&~string'&>
4298 .oindex "&%-oMt%&"
4299 .cindex "sender" "ident string, specifying for local message"
4300 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4301 option sets the sender ident value in &$sender_ident$&. The default setting for
4302 local callers is the login id of the calling process, except when &%-bh%& is
4303 used, when there is no default.
4304
4305 .vitem &%-om%&
4306 .oindex "&%-om%&"
4307 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4308 In Sendmail, this option means &"me too"&, indicating that the sender of a
4309 message should receive a copy of the message if the sender appears in an alias
4310 expansion. Exim always does this, so the option does nothing.
4311
4312 .vitem &%-oo%&
4313 .oindex "&%-oo%&"
4314 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4315 This option is ignored. In Sendmail it specifies &"old style headers"&,
4316 whatever that means.
4317
4318 .vitem &%-oP%&&~<&'path'&>
4319 .oindex "&%-oP%&"
4320 .cindex "pid (process id)" "of daemon"
4321 .cindex "daemon" "process id (pid)"
4322 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4323 value. The option specifies the file to which the process id of the daemon is
4324 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4325 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4326 because in those cases, the normal pid file is not used.
4327
4328 .vitem &%-or%&&~<&'time'&>
4329 .oindex "&%-or%&"
4330 .cindex "timeout" "for non-SMTP input"
4331 This option sets a timeout value for incoming non-SMTP messages. If it is not
4332 set, Exim will wait forever for the standard input. The value can also be set
4333 by the &%receive_timeout%& option. The format used for specifying times is
4334 described in section &<<SECTtimeformat>>&.
4335
4336 .vitem &%-os%&&~<&'time'&>
4337 .oindex "&%-os%&"
4338 .cindex "timeout" "for SMTP input"
4339 .cindex "SMTP" "input timeout"
4340 This option sets a timeout value for incoming SMTP messages. The timeout
4341 applies to each SMTP command and block of data. The value can also be set by
4342 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4343 for specifying times is described in section &<<SECTtimeformat>>&.
4344
4345 .vitem &%-ov%&
4346 .oindex "&%-ov%&"
4347 This option has exactly the same effect as &%-v%&.
4348
4349 .vitem &%-oX%&&~<&'number&~or&~string'&>
4350 .oindex "&%-oX%&"
4351 .cindex "TCP/IP" "setting listening ports"
4352 .cindex "TCP/IP" "setting listening interfaces"
4353 .cindex "port" "receiving TCP/IP"
4354 This option is relevant only when the &%-bd%& (start listening daemon) option
4355 is also given. It controls which ports and interfaces the daemon uses. Details
4356 of the syntax, and how it interacts with configuration file options, are given
4357 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4358 file is written unless &%-oP%& is also present to specify a pid file name.
4359
4360 .vitem &%-pd%&
4361 .oindex "&%-pd%&"
4362 .cindex "Perl" "starting the interpreter"
4363 This option applies when an embedded Perl interpreter is linked with Exim (see
4364 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4365 option, forcing the starting of the interpreter to be delayed until it is
4366 needed.
4367
4368 .vitem &%-ps%&
4369 .oindex "&%-ps%&"
4370 .cindex "Perl" "starting the interpreter"
4371 This option applies when an embedded Perl interpreter is linked with Exim (see
4372 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4373 option, forcing the starting of the interpreter to occur as soon as Exim is
4374 started.
4375
4376 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4377 .oindex "&%-p%&"
4378 For compatibility with Sendmail, this option is equivalent to
4379 .display
4380 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4381 .endd
4382 It sets the incoming protocol and host name (for trusted callers). The
4383 host name and its colon can be omitted when only the protocol is to be set.
4384 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4385 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4386 or &`s`& using this option (but that does not seem a real limitation).
4387 Repeated use of this option is not supported.
4388
4389 .vitem &%-q%&
4390 .oindex "&%-q%&"
4391 .cindex "queue runner" "starting manually"
4392 This option is normally restricted to admin users. However, there is a
4393 configuration option called &%prod_requires_admin%& which can be set false to
4394 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4395 and &%-S%& options).
4396
4397 .cindex "queue runner" "description of operation"
4398 If other commandline options do not specify an action,
4399 the &%-q%& option starts one queue runner process. This scans the queue of
4400 waiting messages, and runs a delivery process for each one in turn. It waits
4401 for each delivery process to finish before starting the next one. A delivery
4402 process may not actually do any deliveries if the retry times for the addresses
4403 have not been reached. Use &%-qf%& (see below) if you want to override this.
4404
4405 If
4406 .cindex "SMTP" "passed connection"
4407 .cindex "SMTP" "multiple deliveries"
4408 .cindex "multiple SMTP deliveries"
4409 the delivery process spawns other processes to deliver other messages down
4410 passed SMTP connections, the queue runner waits for these to finish before
4411 proceeding.
4412
4413 When all the queued messages have been considered, the original queue runner
4414 process terminates. In other words, a single pass is made over the waiting
4415 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4416 this to be repeated periodically.
4417
4418 Exim processes the waiting messages in an unpredictable order. It isn't very
4419 random, but it is likely to be different each time, which is all that matters.
4420 If one particular message screws up a remote MTA, other messages to the same
4421 MTA have a chance of getting through if they get tried first.
4422
4423 It is possible to cause the messages to be processed in lexical message id
4424 order, which is essentially the order in which they arrived, by setting the
4425 &%queue_run_in_order%& option, but this is not recommended for normal use.
4426
4427 .vitem &%-q%&<&'qflags'&>
4428 The &%-q%& option may be followed by one or more flag letters that change its
4429 behaviour. They are all optional, but if more than one is present, they must
4430 appear in the correct order. Each flag is described in a separate item below.
4431
4432 .vitem &%-qq...%&
4433 .oindex "&%-qq%&"
4434 .cindex "queue" "double scanning"
4435 .cindex "queue" "routing"
4436 .cindex "routing" "whole queue before delivery"
4437 An option starting with &%-qq%& requests a two-stage queue run. In the first
4438 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4439 every domain. Addresses are routed, local deliveries happen, but no remote
4440 transports are run.
4441
4442 .cindex "hints database" "remembering routing"
4443 The hints database that remembers which messages are waiting for specific hosts
4444 is updated, as if delivery to those hosts had been deferred. After this is
4445 complete, a second, normal queue scan happens, with routing and delivery taking
4446 place as normal. Messages that are routed to the same host should mostly be
4447 delivered down a single SMTP
4448 .cindex "SMTP" "passed connection"
4449 .cindex "SMTP" "multiple deliveries"
4450 .cindex "multiple SMTP deliveries"
4451 connection because of the hints that were set up during the first queue scan.
4452 This option may be useful for hosts that are connected to the Internet
4453 intermittently.
4454
4455 .vitem &%-q[q]i...%&
4456 .oindex "&%-qi%&"
4457 .cindex "queue" "initial delivery"
4458 If the &'i'& flag is present, the queue runner runs delivery processes only for
4459 those messages that haven't previously been tried. (&'i'& stands for &"initial
4460 delivery"&.) This can be helpful if you are putting messages on the queue using
4461 &%-odq%& and want a queue runner just to process the new messages.
4462
4463 .vitem &%-q[q][i]f...%&
4464 .oindex "&%-qf%&"
4465 .cindex "queue" "forcing delivery"
4466 .cindex "delivery" "forcing in queue run"
4467 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4468 message, whereas without &'f'& only those non-frozen addresses that have passed
4469 their retry times are tried.
4470
4471 .vitem &%-q[q][i]ff...%&
4472 .oindex "&%-qff%&"
4473 .cindex "frozen messages" "forcing delivery"
4474 If &'ff'& is present, a delivery attempt is forced for every message, whether
4475 frozen or not.
4476
4477 .vitem &%-q[q][i][f[f]]l%&
4478 .oindex "&%-ql%&"
4479 .cindex "queue" "local deliveries only"
4480 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4481 be done. If a message requires any remote deliveries, it remains on the queue
4482 for later delivery.
4483
4484 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4485 .oindex "&%-qG%&"
4486 .cindex queue named
4487 .cindex "named queues"
4488 .cindex "queue" "delivering specific messages"
4489 If the &'G'& flag and a name is present, the queue runner operates on the
4490 queue with the given name rather than the default queue.
4491 The name should not contain a &'/'& character.
4492 For a periodic queue run (see below)
4493 append to the name a slash and a time value.
4494
4495 If other commandline options specify an action, a &'-qG<name>'& option
4496 will specify a queue to operate on.
4497 For example:
4498 .code
4499 exim -bp -qGquarantine
4500 mailq -qGquarantine
4501 exim -qGoffpeak -Rf @special.domain.example
4502 .endd
4503
4504 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4505 When scanning the queue, Exim can be made to skip over messages whose ids are
4506 lexically less than a given value by following the &%-q%& option with a
4507 starting message id. For example:
4508 .code
4509 exim -q 0t5C6f-0000c8-00
4510 .endd
4511 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4512 second message id is given, messages whose ids are lexically greater than it
4513 are also skipped. If the same id is given twice, for example,
4514 .code
4515 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4516 .endd
4517 just one delivery process is started, for that message. This differs from
4518 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4519 that it counts as a delivery from a queue run. Note that the selection
4520 mechanism does not affect the order in which the messages are scanned. There
4521 are also other ways of selecting specific sets of messages for delivery in a
4522 queue run &-- see &%-R%& and &%-S%&.
4523
4524 .vitem &%-q%&<&'qflags'&><&'time'&>
4525 .cindex "queue runner" "starting periodically"
4526 .cindex "periodic queue running"
4527 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4528 starting a queue runner process at intervals specified by the given time value
4529 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4530 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4531 single daemon process handles both functions. A common way of starting up a
4532 combined daemon at system boot time is to use a command such as
4533 .code
4534 /usr/exim/bin/exim -bd -q30m
4535 .endd
4536 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4537 process every 30 minutes.
4538
4539 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4540 pid file is written unless one is explicitly requested by the &%-oP%& option.
4541
4542 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4543 .oindex "&%-qR%&"
4544 This option is synonymous with &%-R%&. It is provided for Sendmail
4545 compatibility.
4546
4547 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4548 .oindex "&%-qS%&"
4549 This option is synonymous with &%-S%&.
4550
4551 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4552 .oindex "&%-R%&"
4553 .cindex "queue runner" "for specific recipients"
4554 .cindex "delivery" "to given domain"
4555 .cindex "domain" "delivery to"
4556 The <&'rsflags'&> may be empty, in which case the white space before the string
4557 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4558 which are the possible values for <&'rsflags'&>. White space is required if
4559 <&'rsflags'&> is not empty.
4560
4561 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4562 perform a single queue run, except that, when scanning the messages on the
4563 queue, Exim processes only those that have at least one undelivered recipient
4564 address containing the given string, which is checked in a case-independent
4565 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4566 regular expression; otherwise it is a literal string.
4567
4568 If you want to do periodic queue runs for messages with specific recipients,
4569 you can combine &%-R%& with &%-q%& and a time value. For example:
4570 .code
4571 exim -q25m -R @special.domain.example
4572 .endd
4573 This example does a queue run for messages with recipients in the given domain
4574 every 25 minutes. Any additional flags that are specified with &%-q%& are
4575 applied to each queue run.
4576
4577 Once a message is selected for delivery by this mechanism, all its addresses
4578 are processed. For the first selected message, Exim overrides any retry
4579 information and forces a delivery attempt for each undelivered address. This
4580 means that if delivery of any address in the first message is successful, any
4581 existing retry information is deleted, and so delivery attempts for that
4582 address in subsequently selected messages (which are processed without forcing)
4583 will run. However, if delivery of any address does not succeed, the retry
4584 information is updated, and in subsequently selected messages, the failing
4585 address will be skipped.
4586
4587 .cindex "frozen messages" "forcing delivery"
4588 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4589 all selected messages, not just the first; frozen messages are included when
4590 &'ff'& is present.
4591
4592 The &%-R%& option makes it straightforward to initiate delivery of all messages
4593 to a given domain after a host has been down for some time. When the SMTP
4594 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4595 effect is to run Exim with the &%-R%& option, but it can be configured to run
4596 an arbitrary command instead.
4597
4598 .vitem &%-r%&
4599 .oindex "&%-r%&"
4600 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4601
4602 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4603 .oindex "&%-S%&"
4604 .cindex "delivery" "from given sender"
4605 .cindex "queue runner" "for specific senders"
4606 This option acts like &%-R%& except that it checks the string against each
4607 message's sender instead of against the recipients. If &%-R%& is also set, both
4608 conditions must be met for a message to be selected. If either of the options
4609 has &'f'& or &'ff'& in its flags, the associated action is taken.
4610
4611 .vitem &%-Tqt%&&~<&'times'&>
4612 .oindex "&%-Tqt%&"
4613 This is an option that is exclusively for use by the Exim testing suite. It is not
4614 recognized when Exim is run normally. It allows for the setting up of explicit
4615 &"queue times"& so that various warning/retry features can be tested.
4616
4617 .vitem &%-t%&
4618 .oindex "&%-t%&"
4619 .cindex "recipient" "extracting from header lines"
4620 .cindex "&'Bcc:'& header line"
4621 .cindex "&'Cc:'& header line"
4622 .cindex "&'To:'& header line"
4623 When Exim is receiving a locally-generated, non-SMTP message on its standard
4624 input, the &%-t%& option causes the recipients of the message to be obtained
4625 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4626 from the command arguments. The addresses are extracted before any rewriting
4627 takes place and the &'Bcc:'& header line, if present, is then removed.
4628
4629 .cindex "Sendmail compatibility" "&%-t%& option"
4630 If the command has any arguments, they specify addresses to which the message
4631 is &'not'& to be delivered. That is, the argument addresses are removed from
4632 the recipients list obtained from the headers. This is compatible with Smail 3
4633 and in accordance with the documented behaviour of several versions of
4634 Sendmail, as described in man pages on a number of operating systems (e.g.
4635 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4636 argument addresses to those obtained from the headers, and the O'Reilly
4637 Sendmail book documents it that way. Exim can be made to add argument addresses
4638 instead of subtracting them by setting the option
4639 &%extract_addresses_remove_arguments%& false.
4640
4641 .cindex "&%Resent-%& header lines" "with &%-t%&"
4642 If there are any &%Resent-%& header lines in the message, Exim extracts
4643 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4644 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4645 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4646 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4647
4648 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4649 message is resent several times). The RFC also specifies that they should be
4650 added at the front of the message, and separated by &'Received:'& lines. It is
4651 not at all clear how &%-t%& should operate in the present of multiple sets,
4652 nor indeed exactly what constitutes a &"set"&.
4653 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4654 are often added at the end of the header, and if a message is resent more than
4655 once, it is common for the original set of &%Resent-%& headers to be renamed as
4656 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4657
4658 .vitem &%-ti%&
4659 .oindex "&%-ti%&"
4660 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4661 compatibility with Sendmail.
4662
4663 .vitem &%-tls-on-connect%&
4664 .oindex "&%-tls-on-connect%&"
4665 .cindex "TLS" "use without STARTTLS"
4666 .cindex "TLS" "automatic start"
4667 This option is available when Exim is compiled with TLS support. It forces all
4668 incoming SMTP connections to behave as if the incoming port is listed in the
4669 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4670 &<<CHAPTLS>>& for further details.
4671
4672
4673 .vitem &%-U%&
4674 .oindex "&%-U%&"
4675 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4676 Sendmail uses this option for &"initial message submission"&, and its
4677 documentation states that in future releases, it may complain about
4678 syntactically invalid messages rather than fixing them when this flag is not
4679 set. Exim ignores this option.
4680
4681 .vitem &%-v%&
4682 .oindex "&%-v%&"
4683 This option causes Exim to write information to the standard error stream,
4684 describing what it is doing. In particular, it shows the log lines for
4685 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4686 dialogue is shown. Some of the log lines shown may not actually be written to
4687 the log if the setting of &%log_selector%& discards them. Any relevant
4688 selectors are shown with each log line. If none are shown, the logging is
4689 unconditional.
4690
4691 .vitem &%-x%&
4692 .oindex "&%-x%&"
4693 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4694 National Language Support extended characters in the body of the mail item"&).
4695 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4696 this option.
4697
4698 .vitem &%-X%&&~<&'logfile'&>
4699 .oindex "&%-X%&"
4700 This option is interpreted by Sendmail to cause debug information to be sent
4701 to the named file.  It is ignored by Exim.
4702
4703 .vitem &%-z%&&~<&'log-line'&>
4704 .oindex "&%-z%&"
4705 This option writes its argument to Exim's logfile.
4706 Use is restricted to administrators; the intent is for operational notes.
4707 Quotes should be used to maintain a multi-word item as a single argument,
4708 under most shells.
4709 .endlist
4710
4711 .ecindex IIDclo1
4712 .ecindex IIDclo2
4713
4714
4715 . ////////////////////////////////////////////////////////////////////////////
4716 . Insert a stylized DocBook comment here, to identify the end of the command
4717 . line options. This is for the benefit of the Perl script that automatically
4718 . creates a man page for the options.
4719 . ////////////////////////////////////////////////////////////////////////////
4720
4721 .literal xml
4722 <!-- === End of command line options === -->
4723 .literal off
4724
4725
4726
4727
4728
4729 . ////////////////////////////////////////////////////////////////////////////
4730 . ////////////////////////////////////////////////////////////////////////////
4731
4732
4733 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4734          "The runtime configuration file"
4735
4736 .cindex "run time configuration"
4737 .cindex "configuration file" "general description"
4738 .cindex "CONFIGURE_FILE"
4739 .cindex "configuration file" "errors in"
4740 .cindex "error" "in configuration file"
4741 .cindex "return code" "for bad configuration"
4742 Exim uses a single run time configuration file that is read whenever an Exim
4743 binary is executed. Note that in normal operation, this happens frequently,
4744 because Exim is designed to operate in a distributed manner, without central
4745 control.
4746
4747 If a syntax error is detected while reading the configuration file, Exim
4748 writes a message on the standard error, and exits with a non-zero return code.
4749 The message is also written to the panic log. &*Note*&: Only simple syntax
4750 errors can be detected at this time. The values of any expanded options are
4751 not checked until the expansion happens, even when the expansion does not
4752 actually alter the string.
4753
4754 The name of the configuration file is compiled into the binary for security
4755 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4756 most configurations, this specifies a single file. However, it is permitted to
4757 give a colon-separated list of file names, in which case Exim uses the first
4758 existing file in the list.
4759
4760 .cindex "EXIM_USER"
4761 .cindex "EXIM_GROUP"
4762 .cindex "CONFIGURE_OWNER"
4763 .cindex "CONFIGURE_GROUP"
4764 .cindex "configuration file" "ownership"
4765 .cindex "ownership" "configuration file"
4766 The run time configuration file must be owned by root or by the user that is
4767 specified at compile time by the CONFIGURE_OWNER option (if set). The
4768 configuration file must not be world-writeable, or group-writeable unless its
4769 group is the root group or the one specified at compile time by the
4770 CONFIGURE_GROUP option.
4771
4772 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4773 to root, anybody who is able to edit the run time configuration file has an
4774 easy way to run commands as root. If you specify a user or group in the
4775 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4776 who are members of that group will trivially be able to obtain root privileges.
4777
4778 Up to Exim version 4.72, the run time configuration file was also permitted to
4779 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4780 since it offered a simple privilege escalation for any attacker who managed to
4781 compromise the Exim user account.
4782
4783 A default configuration file, which will work correctly in simple situations,
4784 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4785 defines just one file name, the installation process copies the default
4786 configuration to a new file of that name if it did not previously exist. If
4787 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4788 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4789 configuration.
4790
4791
4792
4793 .section "Using a different configuration file" "SECID40"
4794 .cindex "configuration file" "alternate"
4795 A one-off alternate configuration can be specified by the &%-C%& command line
4796 option, which may specify a single file or a list of files. However, when
4797 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4798 unless the argument for &%-C%& is identical to the built-in value from
4799 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4800 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4801 is useful mainly for checking the syntax of configuration files before
4802 installing them. No owner or group checks are done on a configuration file
4803 specified by &%-C%&, if root privilege has been dropped.
4804
4805 Even the Exim user is not trusted to specify an arbitrary configuration file
4806 with the &%-C%& option to be used with root privileges, unless that file is
4807 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4808 testing a configuration using &%-C%& right through message reception and
4809 delivery, even if the caller is root. The reception works, but by that time,
4810 Exim is running as the Exim user, so when it re-execs to regain privilege for
4811 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4812 can test reception and delivery using two separate commands (one to put a
4813 message on the queue, using &%-odq%&, and another to do the delivery, using
4814 &%-M%&).
4815
4816 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4817 prefix string with which any file named in a &%-C%& command line option must
4818 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4819 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4820 name can be used with &%-C%&.
4821
4822 One-off changes to a configuration can be specified by the &%-D%& command line
4823 option, which defines and overrides values for macros used inside the
4824 configuration file. However, like &%-C%&, the use of this option by a
4825 non-privileged user causes Exim to discard its root privilege.
4826 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4827 completely disabled, and its use causes an immediate error exit.
4828
4829 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4830 to declare certain macro names trusted, such that root privilege will not
4831 necessarily be discarded.
4832 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4833 considered safe and, if &%-D%& only supplies macros from this list, and the
4834 values are acceptable, then Exim will not give up root privilege if the caller
4835 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4836 transition mechanism and is expected to be removed in the future.  Acceptable
4837 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4838
4839 Some sites may wish to use the same Exim binary on different machines that
4840 share a file system, but to use different configuration files on each machine.
4841 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4842 looks for a file whose name is the configuration file name followed by a dot
4843 and the machine's node name, as obtained from the &[uname()]& function. If this
4844 file does not exist, the standard name is tried. This processing occurs for
4845 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4846
4847 In some esoteric situations different versions of Exim may be run under
4848 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4849 help with this. See the comments in &_src/EDITME_& for details.
4850
4851
4852
4853 .section "Configuration file format" "SECTconffilfor"
4854 .cindex "configuration file" "format of"
4855 .cindex "format" "configuration file"
4856 Exim's configuration file is divided into a number of different parts. General
4857 option settings must always appear at the start of the file. The other parts
4858 are all optional, and may appear in any order. Each part other than the first
4859 is introduced by the word &"begin"& followed by at least one literal
4860 space, and the name of the part. The optional parts are:
4861
4862 .ilist
4863 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4864 &<<CHAPACL>>&).
4865 .next
4866 .cindex "AUTH" "configuration"
4867 &'authenticators'&: Configuration settings for the authenticator drivers. These
4868 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4869 .next
4870 &'routers'&: Configuration settings for the router drivers. Routers process
4871 addresses and determine how the message is to be delivered (see chapters
4872 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4873 .next
4874 &'transports'&: Configuration settings for the transport drivers. Transports
4875 define mechanisms for copying messages to destinations (see chapters
4876 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4877 .next
4878 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4879 If there is no retry section, or if it is empty (that is, no retry rules are
4880 defined), Exim will not retry deliveries. In this situation, temporary errors
4881 are treated the same as permanent errors. Retry rules are discussed in chapter
4882 &<<CHAPretry>>&.
4883 .next
4884 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4885 when new addresses are generated during delivery. Rewriting is discussed in
4886 chapter &<<CHAPrewrite>>&.
4887 .next
4888 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4889 want to use this feature, you must set
4890 .code
4891 LOCAL_SCAN_HAS_OPTIONS=yes
4892 .endd
4893 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4894 facility are given in chapter &<<CHAPlocalscan>>&.
4895 .endlist
4896
4897 .cindex "configuration file" "leading white space in"
4898 .cindex "configuration file" "trailing white space in"
4899 .cindex "white space" "in configuration file"
4900 Leading and trailing white space in configuration lines is always ignored.
4901
4902 Blank lines in the file, and lines starting with a # character (ignoring
4903 leading white space) are treated as comments and are ignored. &*Note*&: A
4904 # character other than at the beginning of a line is not treated specially,
4905 and does not introduce a comment.
4906
4907 Any non-comment line can be continued by ending it with a backslash. Note that
4908 the general rule for white space means that trailing white space after the
4909 backslash and leading white space at the start of continuation
4910 lines is ignored. Comment lines beginning with # (but not empty lines) may
4911 appear in the middle of a sequence of continuation lines.
4912
4913 A convenient way to create a configuration file is to start from the
4914 default, which is supplied in &_src/configure.default_&, and add, delete, or
4915 change settings as required.
4916
4917 The ACLs, retry rules, and rewriting rules have their own syntax which is
4918 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4919 respectively. The other parts of the configuration file have some syntactic
4920 items in common, and these are described below, from section &<<SECTcos>>&
4921 onwards. Before that, the inclusion, macro, and conditional facilities are
4922 described.
4923
4924
4925
4926 .section "File inclusions in the configuration file" "SECID41"
4927 .cindex "inclusions in configuration file"
4928 .cindex "configuration file" "including other files"
4929 .cindex "&`.include`& in configuration file"
4930 .cindex "&`.include_if_exists`& in configuration file"
4931 You can include other files inside Exim's run time configuration file by
4932 using this syntax:
4933 .display
4934 &`.include`& <&'file name'&>
4935 &`.include_if_exists`& <&'file name'&>
4936 .endd
4937 on a line by itself. Double quotes round the file name are optional. If you use
4938 the first form, a configuration error occurs if the file does not exist; the
4939 second form does nothing for non-existent files.
4940 The first form allows a relative name. It is resolved relative to
4941 the directory of the including file. For the second form an absolute file
4942 name is required.
4943
4944 Includes may be nested to any depth, but remember that Exim reads its
4945 configuration file often, so it is a good idea to keep them to a minimum.
4946 If you change the contents of an included file, you must HUP the daemon,
4947 because an included file is read only when the configuration itself is read.
4948
4949 The processing of inclusions happens early, at a physical line level, so, like
4950 comment lines, an inclusion can be used in the middle of an option setting,
4951 for example:
4952 .code
4953 hosts_lookup = a.b.c \
4954                .include /some/file
4955 .endd
4956 Include processing happens after macro processing (see below). Its effect is to
4957 process the lines of the included file as if they occurred inline where the
4958 inclusion appears.
4959
4960
4961
4962 .section "Macros in the configuration file" "SECTmacrodefs"
4963 .cindex "macro" "description of"
4964 .cindex "configuration file" "macros"
4965 If a line in the main part of the configuration (that is, before the first
4966 &"begin"& line) begins with an upper case letter, it is taken as a macro
4967 definition, and must be of the form
4968 .display
4969 <&'name'&> = <&'rest of line'&>
4970 .endd
4971 The name must consist of letters, digits, and underscores, and need not all be
4972 in upper case, though that is recommended. The rest of the line, including any
4973 continuations, is the replacement text, and has leading and trailing white
4974 space removed. Quotes are not removed. The replacement text can never end with
4975 a backslash character, but this doesn't seem to be a serious limitation.
4976
4977 Macros may also be defined between router, transport, authenticator, or ACL
4978 definitions. They may not, however, be defined within an individual driver or
4979 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4980
4981 .section "Macro substitution" "SECID42"
4982 Once a macro is defined, all subsequent lines in the file (and any included
4983 files) are scanned for the macro name; if there are several macros, the line is
4984 scanned for each in turn, in the order in which the macros are defined. The
4985 replacement text is not re-scanned for the current macro, though it is scanned
4986 for subsequently defined macros. For this reason, a macro name may not contain
4987 the name of a previously defined macro as a substring. You could, for example,
4988 define
4989 .display
4990 &`ABCD_XYZ = `&<&'something'&>
4991 &`ABCD = `&<&'something else'&>
4992 .endd
4993 but putting the definitions in the opposite order would provoke a configuration
4994 error. Macro expansion is applied to individual physical lines from the file,
4995 before checking for line continuation or file inclusion (see above). If a line
4996 consists solely of a macro name, and the expansion of the macro is empty, the
4997 line is ignored. A macro at the start of a line may turn the line into a
4998 comment line or a &`.include`& line.
4999
5000
5001 .section "Redefining macros" "SECID43"
5002 Once defined, the value of a macro can be redefined later in the configuration
5003 (or in an included file). Redefinition is specified by using &'=='& instead of
5004 &'='&. For example:
5005 .code
5006 MAC =  initial value
5007 ...
5008 MAC == updated value
5009 .endd
5010 Redefinition does not alter the order in which the macros are applied to the
5011 subsequent lines of the configuration file. It is still the same order in which
5012 the macros were originally defined. All that changes is the macro's value.
5013 Redefinition makes it possible to accumulate values. For example:
5014 .code
5015 MAC =  initial value
5016 ...
5017 MAC == MAC and something added
5018 .endd
5019 This can be helpful in situations where the configuration file is built
5020 from a number of other files.
5021
5022 .section "Overriding macro values" "SECID44"
5023 The values set for macros in the configuration file can be overridden by the
5024 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5025 used, unless called by root or the Exim user. A definition on the command line
5026 using the &%-D%& option causes all definitions and redefinitions within the
5027 file to be ignored.
5028
5029
5030
5031 .section "Example of macro usage" "SECID45"
5032 As an example of macro usage, consider a configuration where aliases are looked
5033 up in a MySQL database. It helps to keep the file less cluttered if long
5034 strings such as SQL statements are defined separately as macros, for example:
5035 .code
5036 ALIAS_QUERY = select mailbox from user where \
5037               login='${quote_mysql:$local_part}';
5038 .endd
5039 This can then be used in a &(redirect)& router setting like this:
5040 .code
5041 data = ${lookup mysql{ALIAS_QUERY}}
5042 .endd
5043 In earlier versions of Exim macros were sometimes used for domain, host, or
5044 address lists. In Exim 4 these are handled better by named lists &-- see
5045 section &<<SECTnamedlists>>&.
5046
5047
5048 .section "Builtin macros" "SECTbuiltinmacros"
5049 Exim defines some macros depending on facilities available, which may
5050 differ due to build-time definitions and from one release to another.
5051 All of these macros start with an underscore.
5052 They can be used to conditionally include parts of a configuration
5053 (see below).
5054
5055 The following classes of macros are defined:
5056 .display
5057 &` _HAVE_*                    `&  build-time defines
5058 &` _DRIVER_ROUTER_*           `&  router drivers
5059 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5060 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5061 &` _OPT_MAIN_*                `&  main config options
5062 &` _OPT_ROUTERS_*             `&  generic router options
5063 &` _OPT_TRANSPORTS_*          `&  generic transport options
5064 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5065 &` _OPT_ROUTER_*_*            `&  private router options
5066 &` _OPT_TRANSPORT_*_*         `&  private transport options
5067 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5068 .endd
5069
5070 Use an &"exim -bP macros"& command to get the list of macros.
5071
5072
5073 .section "Conditional skips in the configuration file" "SECID46"
5074 .cindex "configuration file" "conditional skips"
5075 .cindex "&`.ifdef`&"
5076 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5077 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5078 portions of the configuration file. The processing happens whenever the file is
5079 read (that is, when an Exim binary starts to run).
5080
5081 The implementation is very simple. Instances of the first four directives must
5082 be followed by text that includes the names of one or macros. The condition
5083 that is tested is whether or not any macro substitution has taken place in the
5084 line. Thus:
5085 .code
5086 .ifdef AAA
5087 message_size_limit = 50M
5088 .else
5089 message_size_limit = 100M
5090 .endif
5091 .endd
5092 sets a message size limit of 50M if the macro &`AAA`& is defined
5093 (or &`A`& or &`AA`&), and 100M
5094 otherwise. If there is more than one macro named on the line, the condition
5095 is true if any of them are defined. That is, it is an &"or"& condition. To
5096 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5097
5098 Although you can use a macro expansion to generate one of these directives,
5099 it is not very useful, because the condition &"there was a macro substitution
5100 in this line"& will always be true.
5101
5102 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5103 to clarify complicated nestings.
5104
5105
5106
5107 .section "Common option syntax" "SECTcos"
5108 .cindex "common option syntax"
5109 .cindex "syntax of common options"
5110 .cindex "configuration file" "common option syntax"
5111 For the main set of options, driver options, and &[local_scan()]& options,
5112 each setting is on a line by itself, and starts with a name consisting of
5113 lower-case letters and underscores. Many options require a data value, and in
5114 these cases the name must be followed by an equals sign (with optional white
5115 space) and then the value. For example:
5116 .code
5117 qualify_domain = mydomain.example.com
5118 .endd
5119 .cindex "hiding configuration option values"
5120 .cindex "configuration options" "hiding value of"
5121 .cindex "options" "hiding value of"
5122 Some option settings may contain sensitive data, for example, passwords for
5123 accessing databases. To stop non-admin users from using the &%-bP%& command
5124 line option to read these values, you can precede the option settings with the
5125 word &"hide"&. For example:
5126 .code
5127 hide mysql_servers = localhost/users/admin/secret-password
5128 .endd
5129 For non-admin users, such options are displayed like this:
5130 .code
5131 mysql_servers = <value not displayable>
5132 .endd
5133 If &"hide"& is used on a driver option, it hides the value of that option on
5134 all instances of the same driver.
5135
5136 The following sections describe the syntax used for the different data types
5137 that are found in option settings.
5138
5139
5140 .section "Boolean options" "SECID47"
5141 .cindex "format" "boolean"
5142 .cindex "boolean configuration values"
5143 .oindex "&%no_%&&'xxx'&"
5144 .oindex "&%not_%&&'xxx'&"
5145 Options whose type is given as boolean are on/off switches. There are two
5146 different ways of specifying such options: with and without a data value. If
5147 the option name is specified on its own without data, the switch is turned on;
5148 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5149 boolean options may be followed by an equals sign and one of the words
5150 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5151 the following two settings have exactly the same effect:
5152 .code
5153 queue_only
5154 queue_only = true
5155 .endd
5156 The following two lines also have the same (opposite) effect:
5157 .code
5158 no_queue_only
5159 queue_only = false
5160 .endd
5161 You can use whichever syntax you prefer.
5162
5163
5164
5165
5166 .section "Integer values" "SECID48"
5167 .cindex "integer configuration values"
5168 .cindex "format" "integer"
5169 If an option's type is given as &"integer"&, the value can be given in decimal,
5170 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5171 number is assumed. Otherwise, it is treated as an octal number unless it starts
5172 with the characters &"0x"&, in which case the remainder is interpreted as a
5173 hexadecimal number.
5174
5175 If an integer value is followed by the letter K, it is multiplied by 1024; if
5176 it is followed by the letter M, it is multiplied by 1024x1024;
5177 if by the letter G, 1024x1024x1024.
5178 When the values
5179 of integer option settings are output, values which are an exact multiple of
5180 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5181 and M. The printing style is independent of the actual input format that was
5182 used.
5183
5184
5185 .section "Octal integer values" "SECID49"
5186 .cindex "integer format"
5187 .cindex "format" "octal integer"
5188 If an option's type is given as &"octal integer"&, its value is always
5189 interpreted as an octal number, whether or not it starts with the digit zero.
5190 Such options are always output in octal.
5191
5192
5193 .section "Fixed point numbers" "SECID50"
5194 .cindex "fixed point configuration values"
5195 .cindex "format" "fixed point"
5196 If an option's type is given as &"fixed-point"&, its value must be a decimal
5197 integer, optionally followed by a decimal point and up to three further digits.
5198
5199
5200
5201 .section "Time intervals" "SECTtimeformat"
5202 .cindex "time interval" "specifying in configuration"
5203 .cindex "format" "time interval"
5204 A time interval is specified as a sequence of numbers, each followed by one of
5205 the following letters, with no intervening white space:
5206
5207 .table2 30pt
5208 .irow &%s%& seconds
5209 .irow &%m%& minutes
5210 .irow &%h%& hours
5211 .irow &%d%& days
5212 .irow &%w%& weeks
5213 .endtable
5214
5215 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5216 intervals are output in the same format. Exim does not restrict the values; it
5217 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5218
5219
5220
5221 .section "String values" "SECTstrings"
5222 .cindex "string" "format of configuration values"
5223 .cindex "format" "string"
5224 If an option's type is specified as &"string"&, the value can be specified with
5225 or without double-quotes. If it does not start with a double-quote, the value
5226 consists of the remainder of the line plus any continuation lines, starting at
5227 the first character after any leading white space, with trailing white space
5228 removed, and with no interpretation of the characters in the string. Because
5229 Exim removes comment lines (those beginning with #) at an early stage, they can
5230 appear in the middle of a multi-line string. The following two settings are
5231 therefore equivalent:
5232 .code
5233 trusted_users = uucp:mail
5234 trusted_users = uucp:\
5235                 # This comment line is ignored
5236                 mail
5237 .endd
5238 .cindex "string" "quoted"
5239 .cindex "escape characters in quoted strings"
5240 If a string does start with a double-quote, it must end with a closing
5241 double-quote, and any backslash characters other than those used for line
5242 continuation are interpreted as escape characters, as follows:
5243
5244 .table2 100pt
5245 .irow &`\\`&                     "single backslash"
5246 .irow &`\n`&                     "newline"
5247 .irow &`\r`&                     "carriage return"
5248 .irow &`\t`&                     "tab"
5249 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5250 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5251                                    character"
5252 .endtable
5253
5254 If a backslash is followed by some other character, including a double-quote
5255 character, that character replaces the pair.
5256
5257 Quoting is necessary only if you want to make use of the backslash escapes to
5258 insert special characters, or if you need to specify a value with leading or
5259 trailing spaces. These cases are rare, so quoting is almost never needed in
5260 current versions of Exim. In versions of Exim before 3.14, quoting was required
5261 in order to continue lines, so you may come across older configuration files
5262 and examples that apparently quote unnecessarily.
5263
5264
5265 .section "Expanded strings" "SECID51"
5266 .cindex "expansion" "definition of"
5267 Some strings in the configuration file are subjected to &'string expansion'&,
5268 by which means various parts of the string may be changed according to the
5269 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5270 is as just described; in particular, the handling of backslashes in quoted
5271 strings is done as part of the input process, before expansion takes place.
5272 However, backslash is also an escape character for the expander, so any
5273 backslashes that are required for that reason must be doubled if they are
5274 within a quoted configuration string.
5275
5276
5277 .section "User and group names" "SECID52"
5278 .cindex "user name" "format of"
5279 .cindex "format" "user name"
5280 .cindex "groups" "name format"
5281 .cindex "format" "group name"
5282 User and group names are specified as strings, using the syntax described
5283 above, but the strings are interpreted specially. A user or group name must
5284 either consist entirely of digits, or be a name that can be looked up using the
5285 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5286
5287
5288 .section "List construction" "SECTlistconstruct"
5289 .cindex "list" "syntax of in configuration"
5290 .cindex "format" "list item in configuration"
5291 .cindex "string" "list, definition of"
5292 The data for some configuration options is a list of items, with colon as the
5293 default separator. Many of these options are shown with type &"string list"& in
5294 the descriptions later in this document. Others are listed as &"domain list"&,
5295 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5296 are all the same; however, those other than &"string list"& are subject to
5297 particular kinds of interpretation, as described in chapter
5298 &<<CHAPdomhosaddlists>>&.
5299
5300 In all these cases, the entire list is treated as a single string as far as the
5301 input syntax is concerned. The &%trusted_users%& setting in section
5302 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5303 in a list, it must be entered as two colons. Leading and trailing white space
5304 on each item in a list is ignored. This makes it possible to include items that
5305 start with a colon, and in particular, certain forms of IPv6 address. For
5306 example, the list
5307 .code
5308 local_interfaces = 127.0.0.1 : ::::1
5309 .endd
5310 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5311
5312 &*Note*&: Although leading and trailing white space is ignored in individual
5313 list items, it is not ignored when parsing the list. The space after the first
5314 colon in the example above is necessary. If it were not there, the list would
5315 be interpreted as the two items 127.0.0.1:: and 1.
5316
5317 .section "Changing list separators" "SECTlistsepchange"
5318 .cindex "list separator" "changing"
5319 .cindex "IPv6" "addresses in lists"
5320 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5321 introduced to allow the separator character to be changed. If a list begins
5322 with a left angle bracket, followed by any punctuation character, that
5323 character is used instead of colon as the list separator. For example, the list
5324 above can be rewritten to use a semicolon separator like this:
5325 .code
5326 local_interfaces = <; 127.0.0.1 ; ::1
5327 .endd
5328 This facility applies to all lists, with the exception of the list in
5329 &%log_file_path%&. It is recommended that the use of non-colon separators be
5330 confined to circumstances where they really are needed.
5331
5332 .cindex "list separator" "newline as"
5333 .cindex "newline" "as list separator"
5334 It is also possible to use newline and other control characters (those with
5335 code values less than 32, plus DEL) as separators in lists. Such separators
5336 must be provided literally at the time the list is processed. For options that
5337 are string-expanded, you can write the separator using a normal escape
5338 sequence. This will be processed by the expander before the string is
5339 interpreted as a list. For example, if a newline-separated list of domains is
5340 generated by a lookup, you can process it directly by a line such as this:
5341 .code
5342 domains = <\n ${lookup mysql{.....}}
5343 .endd
5344 This avoids having to change the list separator in such data. You are unlikely
5345 to want to use a control character as a separator in an option that is not
5346 expanded, because the value is literal text. However, it can be done by giving
5347 the value in quotes. For example:
5348 .code
5349 local_interfaces = "<\n 127.0.0.1 \n ::1"
5350 .endd
5351 Unlike printing character separators, which can be included in list items by
5352 doubling, it is not possible to include a control character as data when it is
5353 set as the separator. Two such characters in succession are interpreted as
5354 enclosing an empty list item.
5355
5356
5357
5358 .section "Empty items in lists" "SECTempitelis"
5359 .cindex "list" "empty item in"
5360 An empty item at the end of a list is always ignored. In other words, trailing
5361 separator characters are ignored. Thus, the list in
5362 .code
5363 senders = user@domain :
5364 .endd
5365 contains only a single item. If you want to include an empty string as one item
5366 in a list, it must not be the last item. For example, this list contains three
5367 items, the second of which is empty:
5368 .code
5369 senders = user1@domain : : user2@domain
5370 .endd
5371 &*Note*&: There must be white space between the two colons, as otherwise they
5372 are interpreted as representing a single colon data character (and the list
5373 would then contain just one item). If you want to specify a list that contains
5374 just one, empty item, you can do it as in this example:
5375 .code
5376 senders = :
5377 .endd
5378 In this case, the first item is empty, and the second is discarded because it
5379 is at the end of the list.
5380
5381
5382
5383
5384 .section "Format of driver configurations" "SECTfordricon"
5385 .cindex "drivers" "configuration format"
5386 There are separate parts in the configuration for defining routers, transports,
5387 and authenticators. In each part, you are defining a number of driver
5388 instances, each with its own set of options. Each driver instance is defined by
5389 a sequence of lines like this:
5390 .display
5391 <&'instance name'&>:
5392   <&'option'&>
5393   ...
5394   <&'option'&>
5395 .endd
5396 In the following example, the instance name is &(localuser)&, and it is
5397 followed by three options settings:
5398 .code
5399 localuser:
5400   driver = accept
5401   check_local_user
5402   transport = local_delivery
5403 .endd
5404 For each driver instance, you specify which Exim code module it uses &-- by the
5405 setting of the &%driver%& option &-- and (optionally) some configuration
5406 settings. For example, in the case of transports, if you want a transport to
5407 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5408 a local file you would use the &(appendfile)& driver. Each of the drivers is
5409 described in detail in its own separate chapter later in this manual.
5410
5411 You can have several routers, transports, or authenticators that are based on
5412 the same underlying driver (each must have a different instance name).
5413
5414 The order in which routers are defined is important, because addresses are
5415 passed to individual routers one by one, in order. The order in which
5416 transports are defined does not matter at all. The order in which
5417 authenticators are defined is used only when Exim, as a client, is searching
5418 them to find one that matches an authentication mechanism offered by the
5419 server.
5420
5421 .cindex "generic options"
5422 .cindex "options" "generic &-- definition of"
5423 Within a driver instance definition, there are two kinds of option: &'generic'&
5424 and &'private'&. The generic options are those that apply to all drivers of the
5425 same type (that is, all routers, all transports or all authenticators). The
5426 &%driver%& option is a generic option that must appear in every definition.
5427 .cindex "private options"
5428 The private options are special for each driver, and none need appear, because
5429 they all have default values.
5430
5431 The options may appear in any order, except that the &%driver%& option must
5432 precede any private options, since these depend on the particular driver. For
5433 this reason, it is recommended that &%driver%& always be the first option.
5434
5435 Driver instance names, which are used for reference in log entries and
5436 elsewhere, can be any sequence of letters, digits, and underscores (starting
5437 with a letter) and must be unique among drivers of the same type. A router and
5438 a transport (for example) can each have the same name, but no two router
5439 instances can have the same name. The name of a driver instance should not be
5440 confused with the name of the underlying driver module. For example, the
5441 configuration lines:
5442 .code
5443 remote_smtp:
5444   driver = smtp
5445 .endd
5446 create an instance of the &(smtp)& transport driver whose name is
5447 &(remote_smtp)&. The same driver code can be used more than once, with
5448 different instance names and different option settings each time. A second
5449 instance of the &(smtp)& transport, with different options, might be defined
5450 thus:
5451 .code
5452 special_smtp:
5453   driver = smtp
5454   port = 1234
5455   command_timeout = 10s
5456 .endd
5457 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5458 these transport instances from routers, and these names would appear in log
5459 lines.
5460
5461 Comment lines may be present in the middle of driver specifications. The full
5462 list of option settings for any particular driver instance, including all the
5463 defaulted values, can be extracted by making use of the &%-bP%& command line
5464 option.
5465
5466
5467
5468
5469
5470
5471 . ////////////////////////////////////////////////////////////////////////////
5472 . ////////////////////////////////////////////////////////////////////////////
5473
5474 .chapter "The default configuration file" "CHAPdefconfil"
5475 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5476 .cindex "default" "configuration file &""walk through""&"
5477 The default configuration file supplied with Exim as &_src/configure.default_&
5478 is sufficient for a host with simple mail requirements. As an introduction to
5479 the way Exim is configured, this chapter &"walks through"& the default
5480 configuration, giving brief explanations of the settings. Detailed descriptions
5481 of the options are given in subsequent chapters. The default configuration file
5482 itself contains extensive comments about ways you might want to modify the
5483 initial settings. However, note that there are many options that are not
5484 mentioned at all in the default configuration.
5485
5486
5487
5488 .section "Main configuration settings" "SECTdefconfmain"
5489 The main (global) configuration option settings must always come first in the
5490 file. The first thing you'll see in the file, after some initial comments, is
5491 the line
5492 .code
5493 # primary_hostname =
5494 .endd
5495 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5496 to know the official, fully qualified name of your host, and this is where you
5497 can specify it. However, in most cases you do not need to set this option. When
5498 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5499
5500 The first three non-comment configuration lines are as follows:
5501 .code
5502 domainlist local_domains    = @
5503 domainlist relay_to_domains =
5504 hostlist   relay_from_hosts = 127.0.0.1
5505 .endd
5506 These are not, in fact, option settings. They are definitions of two named
5507 domain lists and one named host list. Exim allows you to give names to lists of
5508 domains, hosts, and email addresses, in order to make it easier to manage the
5509 configuration file (see section &<<SECTnamedlists>>&).
5510
5511 The first line defines a domain list called &'local_domains'&; this is used
5512 later in the configuration to identify domains that are to be delivered
5513 on the local host.
5514
5515 .cindex "@ in a domain list"
5516 There is just one item in this list, the string &"@"&. This is a special form
5517 of entry which means &"the name of the local host"&. Thus, if the local host is
5518 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5519 be delivered locally. Because the local host's name is referenced indirectly,
5520 the same configuration file can be used on different hosts.
5521
5522 The second line defines a domain list called &'relay_to_domains'&, but the
5523 list itself is empty. Later in the configuration we will come to the part that
5524 controls mail relaying through the local host; it allows relaying to any
5525 domains in this list. By default, therefore, no relaying on the basis of a mail
5526 domain is permitted.
5527
5528 The third line defines a host list called &'relay_from_hosts'&. This list is
5529 used later in the configuration to permit relaying from any host or IP address
5530 that matches the list. The default contains just the IP address of the IPv4
5531 loopback interface, which means that processes on the local host are able to
5532 submit mail for relaying by sending it over TCP/IP to that interface. No other
5533 hosts are permitted to submit messages for relaying.
5534
5535 Just to be sure there's no misunderstanding: at this point in the configuration
5536 we aren't actually setting up any controls. We are just defining some domains
5537 and hosts that will be used in the controls that are specified later.
5538
5539 The next two configuration lines are genuine option settings:
5540 .code
5541 acl_smtp_rcpt = acl_check_rcpt
5542 acl_smtp_data = acl_check_data
5543 .endd
5544 These options specify &'Access Control Lists'& (ACLs) that are to be used
5545 during an incoming SMTP session for every recipient of a message (every RCPT
5546 command), and after the contents of the message have been received,
5547 respectively. The names of the lists are &'acl_check_rcpt'& and
5548 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5549 section of the configuration. The RCPT ACL controls which recipients are
5550 accepted for an incoming message &-- if a configuration does not provide an ACL
5551 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5552 contents of a message to be checked.
5553
5554 Two commented-out option settings are next:
5555 .code
5556 # av_scanner = clamd:/tmp/clamd
5557 # spamd_address = 127.0.0.1 783
5558 .endd
5559 These are example settings that can be used when Exim is compiled with the
5560 content-scanning extension. The first specifies the interface to the virus
5561 scanner, and the second specifies the interface to SpamAssassin. Further
5562 details are given in chapter &<<CHAPexiscan>>&.
5563
5564 Three more commented-out option settings follow:
5565 .code
5566 # tls_advertise_hosts = *
5567 # tls_certificate = /etc/ssl/exim.crt
5568 # tls_privatekey = /etc/ssl/exim.pem
5569 .endd
5570 These are example settings that can be used when Exim is compiled with
5571 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5572 first one specifies the list of clients that are allowed to use TLS when
5573 connecting to this server; in this case the wildcard means all clients. The
5574 other options specify where Exim should find its TLS certificate and private
5575 key, which together prove the server's identity to any clients that connect.
5576 More details are given in chapter &<<CHAPTLS>>&.
5577
5578 Another two commented-out option settings follow:
5579 .code
5580 # daemon_smtp_ports = 25 : 465 : 587
5581 # tls_on_connect_ports = 465
5582 .endd
5583 .cindex "port" "465 and 587"
5584 .cindex "port" "for message submission"
5585 .cindex "message" "submission, ports for"
5586 .cindex "ssmtp protocol"
5587 .cindex "smtps protocol"
5588 .cindex "SMTP" "ssmtp protocol"
5589 .cindex "SMTP" "smtps protocol"
5590 These options provide better support for roaming users who wish to use this
5591 server for message submission. They are not much use unless you have turned on
5592 TLS (as described in the previous paragraph) and authentication (about which
5593 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5594 on end-user networks, so RFC 4409 specifies that message submission should use
5595 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5596 configured to use port 587 correctly, so these settings also enable the
5597 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5598 &<<SECTsupobssmt>>&).
5599
5600 Two more commented-out options settings follow:
5601 .code
5602 # qualify_domain =
5603 # qualify_recipient =
5604 .endd
5605 The first of these specifies a domain that Exim uses when it constructs a
5606 complete email address from a local login name. This is often needed when Exim
5607 receives a message from a local process. If you do not set &%qualify_domain%&,
5608 the value of &%primary_hostname%& is used. If you set both of these options,
5609 you can have different qualification domains for sender and recipient
5610 addresses. If you set only the first one, its value is used in both cases.
5611
5612 .cindex "domain literal" "recognizing format"
5613 The following line must be uncommented if you want Exim to recognize
5614 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5615 (an IP address within square brackets) instead of a named domain.
5616 .code
5617 # allow_domain_literals
5618 .endd
5619 The RFCs still require this form, but many people think that in the modern
5620 Internet it makes little sense to permit mail to be sent to specific hosts by
5621 quoting their IP addresses. This ancient format has been used by people who
5622 try to abuse hosts by using them for unwanted relaying. However, some
5623 people believe there are circumstances (for example, messages addressed to
5624 &'postmaster'&) where domain literals are still useful.
5625
5626 The next configuration line is a kind of trigger guard:
5627 .code
5628 never_users = root
5629 .endd
5630 It specifies that no delivery must ever be run as the root user. The normal
5631 convention is to set up &'root'& as an alias for the system administrator. This
5632 setting is a guard against slips in the configuration.
5633 The list of users specified by &%never_users%& is not, however, the complete
5634 list; the build-time configuration in &_Local/Makefile_& has an option called
5635 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5636 contents of &%never_users%& are added to this list. By default
5637 FIXED_NEVER_USERS also specifies root.
5638
5639 When a remote host connects to Exim in order to send mail, the only information
5640 Exim has about the host's identity is its IP address. The next configuration
5641 line,
5642 .code
5643 host_lookup = *
5644 .endd
5645 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5646 in order to get a host name. This improves the quality of the logging
5647 information, but if you feel it is too expensive, you can remove it entirely,
5648 or restrict the lookup to hosts on &"nearby"& networks.
5649 Note that it is not always possible to find a host name from an IP address,
5650 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5651 unreachable.
5652
5653 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5654 1413 (hence their names):
5655 .code
5656 rfc1413_hosts = *
5657 rfc1413_query_timeout = 0s
5658 .endd
5659 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5660 Few hosts offer RFC1413 service these days; calls have to be
5661 terminated by a timeout and this needlessly delays the startup
5662 of an incoming SMTP connection.
5663 If you have hosts for which you trust RFC1413 and need this
5664 information, you can change this.
5665
5666 This line enables an efficiency SMTP option.  It is negotiated by clients
5667 and not expected to cause problems but can be disabled if needed.
5668 .code
5669 prdr_enable = true
5670 .endd
5671
5672 When Exim receives messages over SMTP connections, it expects all addresses to
5673 be fully qualified with a domain, as required by the SMTP definition. However,
5674 if you are running a server to which simple clients submit messages, you may
5675 find that they send unqualified addresses. The two commented-out options:
5676 .code
5677 # sender_unqualified_hosts =
5678 # recipient_unqualified_hosts =
5679 .endd
5680 show how you can specify hosts that are permitted to send unqualified sender
5681 and recipient addresses, respectively.
5682
5683 The &%log_selector%& option is used to increase the detail of logging
5684 over the default:
5685 .code
5686 log_selector = +smtp_protocol_error +smtp_syntax_error \
5687                +tls_certificate_verified
5688 .endd
5689
5690 The &%percent_hack_domains%& option is also commented out:
5691 .code
5692 # percent_hack_domains =
5693 .endd
5694 It provides a list of domains for which the &"percent hack"& is to operate.
5695 This is an almost obsolete form of explicit email routing. If you do not know
5696 anything about it, you can safely ignore this topic.
5697
5698 The next two settings in the main part of the default configuration are
5699 concerned with messages that have been &"frozen"& on Exim's queue. When a
5700 message is frozen, Exim no longer continues to try to deliver it. Freezing
5701 occurs when a bounce message encounters a permanent failure because the sender
5702 address of the original message that caused the bounce is invalid, so the
5703 bounce cannot be delivered. This is probably the most common case, but there
5704 are also other conditions that cause freezing, and frozen messages are not
5705 always bounce messages.
5706 .code
5707 ignore_bounce_errors_after = 2d
5708 timeout_frozen_after = 7d
5709 .endd
5710 The first of these options specifies that failing bounce messages are to be
5711 discarded after 2 days on the queue. The second specifies that any frozen
5712 message (whether a bounce message or not) is to be timed out (and discarded)
5713 after a week. In this configuration, the first setting ensures that no failing
5714 bounce message ever lasts a week.
5715
5716 Exim queues it's messages in a spool directory. If you expect to have
5717 large queues, you may consider using this option. It splits the spool
5718 directory into subdirectories to avoid file system degradation from
5719 many files in a single directory, resulting in better performance.
5720 Manual manipulation of queued messages becomes more complex (though fortunately
5721 not often needed).
5722 .code
5723 # split_spool_directory = true
5724 .endd
5725
5726 In an ideal world everybody follows the standards. For non-ASCII
5727 messages RFC 2047 is a standard, allowing a maximum line length of 76
5728 characters. Exim adheres that standard and won't process messages which
5729 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5730 In particular, the Exim maintainers have had multiple reports of
5731 problems from Russian administrators of issues until they disable this
5732 check, because of some popular, yet buggy, mail composition software.
5733 .code
5734 # check_rfc2047_length = false
5735 .endd
5736
5737 If you need to be strictly RFC compliant you may wish to disable the
5738 8BITMIME advertisement. Use this, if you exchange mails with systems
5739 that are not 8-bit clean.
5740 .code
5741 # accept_8bitmime = false
5742 .endd
5743
5744 Libraries you use may depend on specific environment settings.  This
5745 imposes a security risk (e.g. PATH). There are two lists:
5746 &%keep_environment%& for the variables to import as they are, and
5747 &%add_environment%& for variables we want to set to a fixed value.
5748 Note that TZ is handled separately, by the $%timezone%$ runtime
5749 option and by the TIMEZONE_DEFAULT buildtime option.
5750 .code
5751 # keep_environment = ^LDAP
5752 # add_environment = PATH=/usr/bin::/bin
5753 .endd
5754
5755
5756 .section "ACL configuration" "SECID54"
5757 .cindex "default" "ACLs"
5758 .cindex "&ACL;" "default configuration"
5759 In the default configuration, the ACL section follows the main configuration.
5760 It starts with the line
5761 .code
5762 begin acl
5763 .endd
5764 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5765 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5766 and &%acl_smtp_data%& above.
5767
5768 .cindex "RCPT" "ACL for"
5769 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5770 RCPT command specifies one of the message's recipients. The ACL statements
5771 are considered in order, until the recipient address is either accepted or
5772 rejected. The RCPT command is then accepted or rejected, according to the
5773 result of the ACL processing.
5774 .code
5775 acl_check_rcpt:
5776 .endd
5777 This line, consisting of a name terminated by a colon, marks the start of the
5778 ACL, and names it.
5779 .code
5780 accept  hosts = :
5781 .endd
5782 This ACL statement accepts the recipient if the sending host matches the list.
5783 But what does that strange list mean? It doesn't actually contain any host
5784 names or IP addresses. The presence of the colon puts an empty item in the
5785 list; Exim matches this only if the incoming message did not come from a remote
5786 host, because in that case, the remote hostname is empty. The colon is
5787 important. Without it, the list itself is empty, and can never match anything.
5788
5789 What this statement is doing is to accept unconditionally all recipients in
5790 messages that are submitted by SMTP from local processes using the standard
5791 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5792 manner.
5793 .code
5794 deny    message       = Restricted characters in address
5795         domains       = +local_domains
5796         local_parts   = ^[.] : ^.*[@%!/|]
5797
5798 deny    message       = Restricted characters in address
5799         domains       = !+local_domains
5800         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5801 .endd
5802 These statements are concerned with local parts that contain any of the
5803 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5804 Although these characters are entirely legal in local parts (in the case of
5805 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5806 in Internet mail addresses.
5807
5808 The first three have in the past been associated with explicitly routed
5809 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5810 option). Addresses containing these characters are regularly tried by spammers
5811 in an attempt to bypass relaying restrictions, and also by open relay testing
5812 programs. Unless you really need them it is safest to reject these characters
5813 at this early stage. This configuration is heavy-handed in rejecting these
5814 characters for all messages it accepts from remote hosts. This is a deliberate
5815 policy of being as safe as possible.
5816
5817 The first rule above is stricter, and is applied to messages that are addressed
5818 to one of the local domains handled by this host. This is implemented by the
5819 first condition, which restricts it to domains that are listed in the
5820 &'local_domains'& domain list. The &"+"& character is used to indicate a
5821 reference to a named list. In this configuration, there is just one domain in
5822 &'local_domains'&, but in general there may be many.
5823
5824 The second condition on the first statement uses two regular expressions to
5825 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5826 or &"|"&. If you have local accounts that include these characters, you will
5827 have to modify this rule.
5828
5829 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5830 allows them because they have been encountered in practice. (Consider the
5831 common convention of local parts constructed as
5832 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5833 the author of Exim, who has no second initial.) However, a local part starting
5834 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5835 file name (for example, for a mailing list). This is also true for local parts
5836 that contain slashes. A pipe symbol can also be troublesome if the local part
5837 is incorporated unthinkingly into a shell command line.
5838
5839 The second rule above applies to all other domains, and is less strict. This
5840 allows your own users to send outgoing messages to sites that use slashes
5841 and vertical bars in their local parts. It blocks local parts that begin
5842 with a dot, slash, or vertical bar, but allows these characters within the
5843 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5844 and &"!"& is blocked, as before. The motivation here is to prevent your users
5845 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5846 .code
5847 accept  local_parts   = postmaster
5848         domains       = +local_domains
5849 .endd
5850 This statement, which has two conditions, accepts an incoming address if the
5851 local part is &'postmaster'& and the domain is one of those listed in the
5852 &'local_domains'& domain list. The &"+"& character is used to indicate a
5853 reference to a named list. In this configuration, there is just one domain in
5854 &'local_domains'&, but in general there may be many.
5855
5856 The presence of this statement means that mail to postmaster is never blocked
5857 by any of the subsequent tests. This can be helpful while sorting out problems
5858 in cases where the subsequent tests are incorrectly denying access.
5859 .code
5860 require verify        = sender
5861 .endd
5862 This statement requires the sender address to be verified before any subsequent
5863 ACL statement can be used. If verification fails, the incoming recipient
5864 address is refused. Verification consists of trying to route the address, to
5865 see if a bounce message could be delivered to it. In the case of remote
5866 addresses, basic verification checks only the domain, but &'callouts'& can be
5867 used for more verification if required. Section &<<SECTaddressverification>>&
5868 discusses the details of address verification.
5869 .code
5870 accept  hosts         = +relay_from_hosts
5871         control       = submission
5872 .endd
5873 This statement accepts the address if the message is coming from one of the
5874 hosts that are defined as being allowed to relay through this host. Recipient
5875 verification is omitted here, because in many cases the clients are dumb MUAs
5876 that do not cope well with SMTP error responses. For the same reason, the
5877 second line specifies &"submission mode"& for messages that are accepted. This
5878 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5879 messages that are deficient in some way, for example, because they lack a
5880 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5881 probably add recipient verification here, and disable submission mode.
5882 .code
5883 accept  authenticated = *
5884         control       = submission
5885 .endd
5886 This statement accepts the address if the client host has authenticated itself.
5887 Submission mode is again specified, on the grounds that such messages are most
5888 likely to come from MUAs. The default configuration does not define any
5889 authenticators, though it does include some nearly complete commented-out
5890 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5891 fact authenticate until you complete the authenticator definitions.
5892 .code
5893 require message = relay not permitted
5894         domains = +local_domains : +relay_to_domains
5895 .endd
5896 This statement rejects the address if its domain is neither a local domain nor
5897 one of the domains for which this host is a relay.
5898 .code
5899 require verify = recipient
5900 .endd
5901 This statement requires the recipient address to be verified; if verification
5902 fails, the address is rejected.
5903 .code
5904 # deny    message     = rejected because $sender_host_address \
5905 #                       is in a black list at $dnslist_domain\n\
5906 #                       $dnslist_text
5907 #         dnslists    = black.list.example
5908 #
5909 # warn    dnslists    = black.list.example
5910 #         add_header  = X-Warning: $sender_host_address is in \
5911 #                       a black list at $dnslist_domain
5912 #         log_message = found in $dnslist_domain
5913 .endd
5914 These commented-out lines are examples of how you could configure Exim to check
5915 sending hosts against a DNS black list. The first statement rejects messages
5916 from blacklisted hosts, whereas the second just inserts a warning header
5917 line.
5918 .code
5919 # require verify = csa
5920 .endd
5921 This commented-out line is an example of how you could turn on client SMTP
5922 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5923 records.
5924 .code
5925 accept
5926 .endd
5927 The final statement in the first ACL unconditionally accepts any recipient
5928 address that has successfully passed all the previous tests.
5929 .code
5930 acl_check_data:
5931 .endd
5932 This line marks the start of the second ACL, and names it. Most of the contents
5933 of this ACL are commented out:
5934 .code
5935 # deny    malware   = *
5936 #         message   = This message contains a virus \
5937 #                     ($malware_name).
5938 .endd
5939 These lines are examples of how to arrange for messages to be scanned for
5940 viruses when Exim has been compiled with the content-scanning extension, and a
5941 suitable virus scanner is installed. If the message is found to contain a
5942 virus, it is rejected with the given custom error message.
5943 .code
5944 # warn    spam      = nobody
5945 #         message   = X-Spam_score: $spam_score\n\
5946 #                     X-Spam_score_int: $spam_score_int\n\
5947 #                     X-Spam_bar: $spam_bar\n\
5948 #                     X-Spam_report: $spam_report
5949 .endd
5950 These lines are an example of how to arrange for messages to be scanned by
5951 SpamAssassin when Exim has been compiled with the content-scanning extension,
5952 and SpamAssassin has been installed. The SpamAssassin check is run with
5953 &`nobody`& as its user parameter, and the results are added to the message as a
5954 series of extra header line. In this case, the message is not rejected,
5955 whatever the spam score.
5956 .code
5957 accept
5958 .endd
5959 This final line in the DATA ACL accepts the message unconditionally.
5960
5961
5962 .section "Router configuration" "SECID55"
5963 .cindex "default" "routers"
5964 .cindex "routers" "default"
5965 The router configuration comes next in the default configuration, introduced
5966 by the line
5967 .code
5968 begin routers
5969 .endd
5970 Routers are the modules in Exim that make decisions about where to send
5971 messages. An address is passed to each router in turn, until it is either
5972 accepted, or failed. This means that the order in which you define the routers
5973 matters. Each router is fully described in its own chapter later in this
5974 manual. Here we give only brief overviews.
5975 .code
5976 # domain_literal:
5977 #   driver = ipliteral
5978 #   domains = !+local_domains
5979 #   transport = remote_smtp
5980 .endd
5981 .cindex "domain literal" "default router"
5982 This router is commented out because the majority of sites do not want to
5983 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5984 you uncomment this router, you also need to uncomment the setting of
5985 &%allow_domain_literals%& in the main part of the configuration.
5986 .code
5987 dnslookup:
5988   driver = dnslookup
5989   domains = ! +local_domains
5990   transport = remote_smtp
5991   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5992   no_more
5993 .endd
5994 The first uncommented router handles addresses that do not involve any local
5995 domains. This is specified by the line
5996 .code
5997 domains = ! +local_domains
5998 .endd
5999 The &%domains%& option lists the domains to which this router applies, but the
6000 exclamation mark is a negation sign, so the router is used only for domains
6001 that are not in the domain list called &'local_domains'& (which was defined at
6002 the start of the configuration). The plus sign before &'local_domains'&
6003 indicates that it is referring to a named list. Addresses in other domains are
6004 passed on to the following routers.
6005
6006 The name of the router driver is &(dnslookup)&,
6007 and is specified by the &%driver%& option. Do not be confused by the fact that
6008 the name of this router instance is the same as the name of the driver. The
6009 instance name is arbitrary, but the name set in the &%driver%& option must be
6010 one of the driver modules that is in the Exim binary.
6011
6012 The &(dnslookup)& router routes addresses by looking up their domains in the
6013 DNS in order to obtain a list of hosts to which the address is routed. If the
6014 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6015 specified by the &%transport%& option. If the router does not find the domain
6016 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6017 the address fails and is bounced.
6018
6019 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6020 be entirely ignored. This option is present because a number of cases have been
6021 encountered where MX records in the DNS point to host names
6022 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6023 Completely ignoring these IP addresses causes Exim to fail to route the
6024 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6025 continue to try to deliver the message periodically until the address timed
6026 out.
6027 .code
6028 system_aliases:
6029   driver = redirect
6030   allow_fail
6031   allow_defer
6032   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6033 # user = exim
6034   file_transport = address_file
6035   pipe_transport = address_pipe
6036 .endd
6037 Control reaches this and subsequent routers only for addresses in the local
6038 domains. This router checks to see whether the local part is defined as an
6039 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6040 data that it looks up from that file. If no data is found for the local part,
6041 the value of the &%data%& option is empty, causing the address to be passed to
6042 the next router.
6043
6044 &_/etc/aliases_& is a conventional name for the system aliases file that is
6045 often used. That is why it is referenced by from the default configuration
6046 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6047 &_Local/Makefile_& before building Exim.
6048 .code
6049 userforward:
6050   driver = redirect
6051   check_local_user
6052 # local_part_suffix = +* : -*
6053 # local_part_suffix_optional
6054   file = $home/.forward
6055 # allow_filter
6056   no_verify
6057   no_expn
6058   check_ancestor
6059   file_transport = address_file
6060   pipe_transport = address_pipe
6061   reply_transport = address_reply
6062 .endd
6063 This is the most complicated router in the default configuration. It is another
6064 redirection router, but this time it is looking for forwarding data set up by
6065 individual users. The &%check_local_user%& setting specifies a check that the
6066 local part of the address is the login name of a local user. If it is not, the
6067 router is skipped. The two commented options that follow &%check_local_user%&,
6068 namely:
6069 .code
6070 # local_part_suffix = +* : -*
6071 # local_part_suffix_optional
6072 .endd
6073 .vindex "&$local_part_suffix$&"
6074 show how you can specify the recognition of local part suffixes. If the first
6075 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6076 by any sequence of characters, is removed from the local part and placed in the
6077 variable &$local_part_suffix$&. The second suffix option specifies that the
6078 presence of a suffix in the local part is optional. When a suffix is present,
6079 the check for a local login uses the local part with the suffix removed.
6080
6081 When a local user account is found, the file called &_.forward_& in the user's
6082 home directory is consulted. If it does not exist, or is empty, the router
6083 declines. Otherwise, the contents of &_.forward_& are interpreted as
6084 redirection data (see chapter &<<CHAPredirect>>& for more details).
6085
6086 .cindex "Sieve filter" "enabling in default router"
6087 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6088 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6089 is commented out by default), the contents of the file are interpreted as a set
6090 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6091 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6092 separate document entitled &'Exim's interfaces to mail filtering'&.
6093
6094 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6095 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6096 There are two reasons for doing this:
6097
6098 .olist
6099 Whether or not a local user has a &_.forward_& file is not really relevant when
6100 checking an address for validity; it makes sense not to waste resources doing
6101 unnecessary work.
6102 .next
6103 More importantly, when Exim is verifying addresses or handling an EXPN
6104 command during an SMTP session, it is running as the Exim user, not as root.
6105 The group is the Exim group, and no additional groups are set up.
6106 It may therefore not be possible for Exim to read users' &_.forward_& files at
6107 this time.
6108 .endlist
6109
6110 The setting of &%check_ancestor%& prevents the router from generating a new
6111 address that is the same as any previous address that was redirected. (This
6112 works round a problem concerning a bad interaction between aliasing and
6113 forwarding &-- see section &<<SECTredlocmai>>&).
6114
6115 The final three option settings specify the transports that are to be used when
6116 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6117 auto-reply, respectively. For example, if a &_.forward_& file contains
6118 .code
6119 a.nother@elsewhere.example, /home/spqr/archive
6120 .endd
6121 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6122 transport.
6123 .code
6124 localuser:
6125   driver = accept
6126   check_local_user
6127 # local_part_suffix = +* : -*
6128 # local_part_suffix_optional
6129   transport = local_delivery
6130 .endd
6131 The final router sets up delivery into local mailboxes, provided that the local
6132 part is the name of a local login, by accepting the address and assigning it to
6133 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6134 routers, so the address is bounced. The commented suffix settings fulfil the
6135 same purpose as they do for the &(userforward)& router.
6136
6137
6138 .section "Transport configuration" "SECID56"
6139 .cindex "default" "transports"
6140 .cindex "transports" "default"
6141 Transports define mechanisms for actually delivering messages. They operate
6142 only when referenced from routers, so the order in which they are defined does
6143 not matter. The transports section of the configuration starts with
6144 .code
6145 begin transports
6146 .endd
6147 One remote transport and four local transports are defined.
6148 .code
6149 remote_smtp:
6150   driver = smtp
6151   hosts_try_prdr = *
6152 .endd
6153 This transport is used for delivering messages over SMTP connections.
6154 The list of remote hosts comes from the router.
6155 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6156 It is negotiated between client and server
6157 and not expected to cause problems but can be disabled if needed.
6158 All other options are defaulted.
6159 .code
6160 local_delivery:
6161   driver = appendfile
6162   file = /var/mail/$local_part
6163   delivery_date_add
6164   envelope_to_add
6165   return_path_add
6166 # group = mail
6167 # mode = 0660
6168 .endd
6169 This &(appendfile)& transport is used for local delivery to user mailboxes in
6170 traditional BSD mailbox format. By default it runs under the uid and gid of the
6171 local user, which requires the sticky bit to be set on the &_/var/mail_&
6172 directory. Some systems use the alternative approach of running mail deliveries
6173 under a particular group instead of using the sticky bit. The commented options
6174 show how this can be done.
6175
6176 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6177 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6178 similarly-named options above.
6179 .code
6180 address_pipe:
6181   driver = pipe
6182   return_output
6183 .endd
6184 This transport is used for handling deliveries to pipes that are generated by
6185 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6186 option specifies that any output on stdout or stderr generated by the pipe is to
6187 be returned to the sender.
6188 .code
6189 address_file:
6190   driver = appendfile
6191   delivery_date_add
6192   envelope_to_add
6193   return_path_add
6194 .endd
6195 This transport is used for handling deliveries to files that are generated by
6196 redirection. The name of the file is not specified in this instance of
6197 &(appendfile)&, because it comes from the &(redirect)& router.
6198 .code
6199 address_reply:
6200   driver = autoreply
6201 .endd
6202 This transport is used for handling automatic replies generated by users'
6203 filter files.
6204
6205
6206
6207 .section "Default retry rule" "SECID57"
6208 .cindex "retry" "default rule"
6209 .cindex "default" "retry rule"
6210 The retry section of the configuration file contains rules which affect the way
6211 Exim retries deliveries that cannot be completed at the first attempt. It is
6212 introduced by the line
6213 .code
6214 begin retry
6215 .endd
6216 In the default configuration, there is just one rule, which applies to all
6217 errors:
6218 .code
6219 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6220 .endd
6221 This causes any temporarily failing address to be retried every 15 minutes for
6222 2 hours, then at intervals starting at one hour and increasing by a factor of
6223 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6224 is not delivered after 4 days of temporary failure, it is bounced. The time is
6225 measured from first failure, not from the time the message was received.
6226
6227 If the retry section is removed from the configuration, or is empty (that is,
6228 if no retry rules are defined), Exim will not retry deliveries. This turns
6229 temporary errors into permanent errors.
6230
6231
6232 .section "Rewriting configuration" "SECID58"
6233 The rewriting section of the configuration, introduced by
6234 .code
6235 begin rewrite
6236 .endd
6237 contains rules for rewriting addresses in messages as they arrive. There are no
6238 rewriting rules in the default configuration file.
6239
6240
6241
6242 .section "Authenticators configuration" "SECTdefconfauth"
6243 .cindex "AUTH" "configuration"
6244 The authenticators section of the configuration, introduced by
6245 .code
6246 begin authenticators
6247 .endd
6248 defines mechanisms for the use of the SMTP AUTH command. The default
6249 configuration file contains two commented-out example authenticators
6250 which support plaintext username/password authentication using the
6251 standard PLAIN mechanism and the traditional but non-standard LOGIN
6252 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6253 to support most MUA software.
6254
6255 The example PLAIN authenticator looks like this:
6256 .code
6257 #PLAIN:
6258 #  driver                  = plaintext
6259 #  server_set_id           = $auth2
6260 #  server_prompts          = :
6261 #  server_condition        = Authentication is not yet configured
6262 #  server_advertise_condition = ${if def:tls_in_cipher }
6263 .endd
6264 And the example LOGIN authenticator looks like this:
6265 .code
6266 #LOGIN:
6267 #  driver                  = plaintext
6268 #  server_set_id           = $auth1
6269 #  server_prompts          = <| Username: | Password:
6270 #  server_condition        = Authentication is not yet configured
6271 #  server_advertise_condition = ${if def:tls_in_cipher }
6272 .endd
6273
6274 The &%server_set_id%& option makes Exim remember the authenticated username
6275 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6276 &%server_prompts%& option configures the &(plaintext)& authenticator so
6277 that it implements the details of the specific authentication mechanism,
6278 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6279 when Exim offers authentication to clients; in the examples, this is only
6280 when TLS or SSL has been started, so to enable the authenticators you also
6281 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6282
6283 The &%server_condition%& setting defines how to verify that the username and
6284 password are correct. In the examples it just produces an error message.
6285 To make the authenticators work, you can use a string expansion
6286 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6287
6288 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6289 usercode and password are in different positions.
6290 Chapter &<<CHAPplaintext>>& covers both.
6291
6292 .ecindex IIDconfiwal
6293
6294
6295
6296 . ////////////////////////////////////////////////////////////////////////////
6297 . ////////////////////////////////////////////////////////////////////////////
6298
6299 .chapter "Regular expressions" "CHAPregexp"
6300
6301 .cindex "regular expressions" "library"
6302 .cindex "PCRE"
6303 Exim supports the use of regular expressions in many of its options. It
6304 uses the PCRE regular expression library; this provides regular expression
6305 matching that is compatible with Perl 5. The syntax and semantics of
6306 regular expressions is discussed in
6307 online Perl manpages, in
6308 many Perl reference books, and also in
6309 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6310 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6311
6312 The documentation for the syntax and semantics of the regular expressions that
6313 are supported by PCRE is included in the PCRE distribution, and no further
6314 description is included here. The PCRE functions are called from Exim using
6315 the default option settings (that is, with no PCRE options set), except that
6316 the PCRE_CASELESS option is set when the matching is required to be
6317 case-insensitive.
6318
6319 In most cases, when a regular expression is required in an Exim configuration,
6320 it has to start with a circumflex, in order to distinguish it from plain text
6321 or an &"ends with"& wildcard. In this example of a configuration setting, the
6322 second item in the colon-separated list is a regular expression.
6323 .code
6324 domains = a.b.c : ^\\d{3} : *.y.z : ...
6325 .endd
6326 The doubling of the backslash is required because of string expansion that
6327 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6328 of this issue, and a way of avoiding the need for doubling backslashes. The
6329 regular expression that is eventually used in this example contains just one
6330 backslash. The circumflex is included in the regular expression, and has the
6331 normal effect of &"anchoring"& it to the start of the string that is being
6332 matched.
6333
6334 There are, however, two cases where a circumflex is not required for the
6335 recognition of a regular expression: these are the &%match%& condition in a
6336 string expansion, and the &%matches%& condition in an Exim filter file. In
6337 these cases, the relevant string is always treated as a regular expression; if
6338 it does not start with a circumflex, the expression is not anchored, and can
6339 match anywhere in the subject string.
6340
6341 In all cases, if you want a regular expression to match at the end of a string,
6342 you must code the $ metacharacter to indicate this. For example:
6343 .code
6344 domains = ^\\d{3}\\.example
6345 .endd
6346 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6347 You need to use:
6348 .code
6349 domains = ^\\d{3}\\.example\$
6350 .endd
6351 if you want &'example'& to be the top-level domain. The backslash before the
6352 $ is needed because string expansion also interprets dollar characters.
6353
6354
6355
6356 . ////////////////////////////////////////////////////////////////////////////
6357 . ////////////////////////////////////////////////////////////////////////////
6358
6359 .chapter "File and database lookups" "CHAPfdlookup"
6360 .scindex IIDfidalo1 "file" "lookups"
6361 .scindex IIDfidalo2 "database" "lookups"
6362 .cindex "lookup" "description of"
6363 Exim can be configured to look up data in files or databases as it processes
6364 messages. Two different kinds of syntax are used:
6365
6366 .olist
6367 A string that is to be expanded may contain explicit lookup requests. These
6368 cause parts of the string to be replaced by data that is obtained from the
6369 lookup. Lookups of this type are conditional expansion items. Different results
6370 can be defined for the cases of lookup success and failure. See chapter
6371 &<<CHAPexpand>>&, where string expansions are described in detail.
6372 The key for the lookup is specified as part of the string expansion.
6373 .next
6374 Lists of domains, hosts, and email addresses can contain lookup requests as a
6375 way of avoiding excessively long linear lists. In this case, the data that is
6376 returned by the lookup is often (but not always) discarded; whether the lookup
6377 succeeds or fails is what really counts. These kinds of list are described in
6378 chapter &<<CHAPdomhosaddlists>>&.
6379 The key for the lookup is given by the context in which the list is expanded.
6380 .endlist
6381
6382 String expansions, lists, and lookups interact with each other in such a way
6383 that there is no order in which to describe any one of them that does not
6384 involve references to the others. Each of these three chapters makes more sense
6385 if you have read the other two first. If you are reading this for the first
6386 time, be aware that some of it will make a lot more sense after you have read
6387 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6388
6389 .section "Examples of different lookup syntax" "SECID60"
6390 It is easy to confuse the two different kinds of lookup, especially as the
6391 lists that may contain the second kind are always expanded before being
6392 processed as lists. Therefore, they may also contain lookups of the first kind.
6393 Be careful to distinguish between the following two examples:
6394 .code
6395 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6396 domains = lsearch;/some/file
6397 .endd
6398 The first uses a string expansion, the result of which must be a domain list.
6399 No strings have been specified for a successful or a failing lookup; the
6400 defaults in this case are the looked-up data and an empty string, respectively.
6401 The expansion takes place before the string is processed as a list, and the
6402 file that is searched could contain lines like this:
6403 .code
6404 192.168.3.4: domain1:domain2:...
6405 192.168.1.9: domain3:domain4:...
6406 .endd
6407 When the lookup succeeds, the result of the expansion is a list of domains (and
6408 possibly other types of item that are allowed in domain lists).
6409
6410 In the second example, the lookup is a single item in a domain list. It causes
6411 Exim to use a lookup to see if the domain that is being processed can be found
6412 in the file. The file could contains lines like this:
6413 .code
6414 domain1:
6415 domain2:
6416 .endd
6417 Any data that follows the keys is not relevant when checking that the domain
6418 matches the list item.
6419
6420 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6421 Consider a file containing lines like this:
6422 .code
6423 192.168.5.6: lsearch;/another/file
6424 .endd
6425 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6426 first &%domains%& setting above generates the second setting, which therefore
6427 causes a second lookup to occur.
6428
6429 The rest of this chapter describes the different lookup types that are
6430 available. Any of them can be used in any part of the configuration where a
6431 lookup is permitted.
6432
6433
6434 .section "Lookup types" "SECID61"
6435 .cindex "lookup" "types of"
6436 .cindex "single-key lookup" "definition of"
6437 Two different types of data lookup are implemented:
6438
6439 .ilist
6440 The &'single-key'& type requires the specification of a file in which to look,
6441 and a single key to search for. The key must be a non-empty string for the
6442 lookup to succeed. The lookup type determines how the file is searched.
6443 .next
6444 .cindex "query-style lookup" "definition of"
6445 The &'query-style'& type accepts a generalized database query. No particular
6446 key value is assumed by Exim for query-style lookups. You can use whichever
6447 Exim variables you need to construct the database query.
6448 .endlist
6449
6450 The code for each lookup type is in a separate source file that is included in
6451 the binary of Exim only if the corresponding compile-time option is set. The
6452 default settings in &_src/EDITME_& are:
6453 .code
6454 LOOKUP_DBM=yes
6455 LOOKUP_LSEARCH=yes
6456 .endd
6457 which means that only linear searching and DBM lookups are included by default.
6458 For some types of lookup (e.g. SQL databases), you need to install appropriate
6459 libraries and header files before building Exim.
6460
6461
6462
6463
6464 .section "Single-key lookup types" "SECTsinglekeylookups"
6465 .cindex "lookup" "single-key types"
6466 .cindex "single-key lookup" "list of types"
6467 The following single-key lookup types are implemented:
6468
6469 .ilist
6470 .cindex "cdb" "description of"
6471 .cindex "lookup" "cdb"
6472 .cindex "binary zero" "in lookup key"
6473 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6474 string without a terminating binary zero. The cdb format is designed for
6475 indexed files that are read frequently and never updated, except by total
6476 re-creation. As such, it is particularly suitable for large files containing
6477 aliases or other indexed data referenced by an MTA. Information about cdb can
6478 be found in several places:
6479 .display
6480 &url(http://www.pobox.com/~djb/cdb.html)
6481 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6482 &url(http://packages.debian.org/stable/utils/freecdb.html)
6483 .endd
6484 A cdb distribution is not needed in order to build Exim with cdb support,
6485 because the code for reading cdb files is included directly in Exim itself.
6486 However, no means of building or testing cdb files is provided with Exim, so
6487 you need to obtain a cdb distribution in order to do this.
6488 .next
6489 .cindex "DBM" "lookup type"
6490 .cindex "lookup" "dbm"
6491 .cindex "binary zero" "in lookup key"
6492 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6493 DBM file by looking up the record with the given key. A terminating binary
6494 zero is included in the key that is passed to the DBM library. See section
6495 &<<SECTdb>>& for a discussion of DBM libraries.
6496
6497 .cindex "Berkeley DB library" "file format"
6498 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6499 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6500 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6501 the DB_UNKNOWN option. This enables it to handle any of the types of database
6502 that the library supports, and can be useful for accessing DBM files created by
6503 other applications. (For earlier DB versions, DB_HASH is always used.)
6504 .next
6505 .cindex "lookup" "dbmjz"
6506 .cindex "lookup" "dbm &-- embedded NULs"
6507 .cindex "sasldb2"
6508 .cindex "dbmjz lookup type"
6509 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6510 interpreted as an Exim list; the elements of the list are joined together with
6511 ASCII NUL characters to form the lookup key.  An example usage would be to
6512 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6513 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6514 &(cram_md5)& authenticator.
6515 .next
6516 .cindex "lookup" "dbmnz"
6517 .cindex "lookup" "dbm &-- terminating zero"
6518 .cindex "binary zero" "in lookup key"
6519 .cindex "Courier"
6520 .cindex "&_/etc/userdbshadow.dat_&"
6521 .cindex "dbmnz lookup type"
6522 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6523 is not included in the key that is passed to the DBM library. You may need this
6524 if you want to look up data in files that are created by or shared with some
6525 other application that does not use terminating zeros. For example, you need to
6526 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6527 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6528 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6529 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6530 .next
6531 .cindex "lookup" "dsearch"
6532 .cindex "dsearch lookup type"
6533 &(dsearch)&: The given file must be a directory; this is searched for an entry
6534 whose name is the key by calling the &[lstat()]& function. The key may not
6535 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6536 the lookup is the name of the entry, which may be a file, directory,
6537 symbolic link, or any other kind of directory entry. An example of how this
6538 lookup can be used to support virtual domains is given in section
6539 &<<SECTvirtualdomains>>&.
6540 .next
6541 .cindex "lookup" "iplsearch"
6542 .cindex "iplsearch lookup type"
6543 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6544 terminated by a colon or white space or the end of the line. The keys in the
6545 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6546 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6547 being interpreted as a key terminator. For example:
6548 .code
6549 1.2.3.4:           data for 1.2.3.4
6550 192.168.0.0/16:    data for 192.168.0.0/16
6551 "abcd::cdab":      data for abcd::cdab
6552 "abcd:abcd::/32"   data for abcd:abcd::/32
6553 .endd
6554 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6555 file is searched linearly, using the CIDR masks where present, until a matching
6556 key is found. The first key that matches is used; there is no attempt to find a
6557 &"best"& match. Apart from the way the keys are matched, the processing for
6558 &(iplsearch)& is the same as for &(lsearch)&.
6559
6560 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6561 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6562 lookup types support only literal keys.
6563
6564 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6565 the implicit key is the host's IP address rather than its name (see section
6566 &<<SECThoslispatsikey>>&).
6567 .next
6568 .cindex "linear search"
6569 .cindex "lookup" "lsearch"
6570 .cindex "lsearch lookup type"
6571 .cindex "case sensitivity" "in lsearch lookup"
6572 &(lsearch)&: The given file is a text file that is searched linearly for a
6573 line beginning with the search key, terminated by a colon or white space or the
6574 end of the line. The search is case-insensitive; that is, upper and lower case
6575 letters are treated as the same. The first occurrence of the key that is found
6576 in the file is used.
6577
6578 White space between the key and the colon is permitted. The remainder of the
6579 line, with leading and trailing white space removed, is the data. This can be
6580 continued onto subsequent lines by starting them with any amount of white
6581 space, but only a single space character is included in the data at such a
6582 junction. If the data begins with a colon, the key must be terminated by a
6583 colon, for example:
6584 .code
6585 baduser:  :fail:
6586 .endd
6587 Empty lines and lines beginning with # are ignored, even if they occur in the
6588 middle of an item. This is the traditional textual format of alias files. Note
6589 that the keys in an &(lsearch)& file are literal strings. There is no
6590 wildcarding of any kind.
6591
6592 .cindex "lookup" "lsearch &-- colons in keys"
6593 .cindex "white space" "in lsearch key"
6594 In most &(lsearch)& files, keys are not required to contain colons or #
6595 characters, or white space. However, if you need this feature, it is available.
6596 If a key begins with a doublequote character, it is terminated only by a
6597 matching quote (or end of line), and the normal escaping rules apply to its
6598 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6599 quoted keys (exactly as for unquoted keys). There is no special handling of
6600 quotes for the data part of an &(lsearch)& line.
6601
6602 .next
6603 .cindex "NIS lookup type"
6604 .cindex "lookup" "NIS"
6605 .cindex "binary zero" "in lookup key"
6606 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6607 the given key, without a terminating binary zero. There is a variant called
6608 &(nis0)& which does include the terminating binary zero in the key. This is
6609 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6610 aliases; the full map names must be used.
6611
6612 .next
6613 .cindex "wildlsearch lookup type"
6614 .cindex "lookup" "wildlsearch"
6615 .cindex "nwildlsearch lookup type"
6616 .cindex "lookup" "nwildlsearch"
6617 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6618 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6619 the file may be wildcarded. The difference between these two lookup types is
6620 that for &(wildlsearch)&, each key in the file is string-expanded before being
6621 used, whereas for &(nwildlsearch)&, no expansion takes place.
6622
6623 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6624 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6625 file that are regular expressions can be made case-sensitive by the use of
6626 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6627
6628 . ==== As this is a nested list, any displays it contains must be indented
6629 . ==== as otherwise they are too far to the left.
6630
6631 .olist
6632 The string may begin with an asterisk to mean &"ends with"&. For example:
6633 .code
6634     *.a.b.c       data for anything.a.b.c
6635     *fish         data for anythingfish
6636 .endd
6637 .next
6638 The string may begin with a circumflex to indicate a regular expression. For
6639 example, for &(wildlsearch)&:
6640 .code
6641     ^\N\d+\.a\.b\N    data for <digits>.a.b
6642 .endd
6643 Note the use of &`\N`& to disable expansion of the contents of the regular
6644 expression. If you are using &(nwildlsearch)&, where the keys are not
6645 string-expanded, the equivalent entry is:
6646 .code
6647     ^\d+\.a\.b        data for <digits>.a.b
6648 .endd
6649 The case-insensitive flag is set at the start of compiling the regular
6650 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6651 For example, to make the entire pattern case-sensitive:
6652 .code
6653     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6654 .endd
6655
6656 If the regular expression contains white space or colon characters, you must
6657 either quote it (see &(lsearch)& above), or represent these characters in other
6658 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6659 colon. This may be easier than quoting, because if you quote, you have to
6660 escape all the backslashes inside the quotes.
6661
6662 &*Note*&: It is not possible to capture substrings in a regular expression
6663 match for later use, because the results of all lookups are cached. If a lookup
6664 is repeated, the result is taken from the cache, and no actual pattern matching
6665 takes place. The values of all the numeric variables are unset after a
6666 &((n)wildlsearch)& match.
6667
6668 .next
6669 Although I cannot see it being of much use, the general matching function that
6670 is used to implement &((n)wildlsearch)& means that the string may begin with a
6671 lookup name terminated by a semicolon, and followed by lookup data. For
6672 example:
6673 .code
6674     cdb;/some/file  data for keys that match the file
6675 .endd
6676 The data that is obtained from the nested lookup is discarded.
6677 .endlist olist
6678
6679 Keys that do not match any of these patterns are interpreted literally. The
6680 continuation rules for the data are the same as for &(lsearch)&, and keys may
6681 be followed by optional colons.
6682
6683 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6684 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6685 lookup types support only literal keys.
6686 .endlist ilist
6687
6688
6689 .section "Query-style lookup types" "SECTquerystylelookups"
6690 .cindex "lookup" "query-style types"
6691 .cindex "query-style lookup" "list of types"
6692 The supported query-style lookup types are listed below. Further details about
6693 many of them are given in later sections.
6694
6695 .ilist
6696 .cindex "DNS" "as a lookup type"
6697 .cindex "lookup" "DNS"
6698 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6699 are given in the supplied query. The resulting data is the contents of the
6700 records. See section &<<SECTdnsdb>>&.
6701 .next
6702 .cindex "InterBase lookup type"
6703 .cindex "lookup" "InterBase"
6704 &(ibase)&: This does a lookup in an InterBase database.
6705 .next
6706 .cindex "LDAP" "lookup type"
6707 .cindex "lookup" "LDAP"
6708 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6709 returns attributes from a single entry. There is a variant called &(ldapm)&
6710 that permits values from multiple entries to be returned. A third variant
6711 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6712 any attribute values. See section &<<SECTldap>>&.
6713 .next
6714 .cindex "MySQL" "lookup type"
6715 .cindex "lookup" "MySQL"
6716 &(mysql)&: The format of the query is an SQL statement that is passed to a
6717 MySQL database. See section &<<SECTsql>>&.
6718 .next
6719 .cindex "NIS+ lookup type"
6720 .cindex "lookup" "NIS+"
6721 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6722 the field to be returned. See section &<<SECTnisplus>>&.
6723 .next
6724 .cindex "Oracle" "lookup type"
6725 .cindex "lookup" "Oracle"
6726 &(oracle)&: The format of the query is an SQL statement that is passed to an
6727 Oracle database. See section &<<SECTsql>>&.
6728 .next
6729 .cindex "lookup" "passwd"
6730 .cindex "passwd lookup type"
6731 .cindex "&_/etc/passwd_&"
6732 &(passwd)& is a query-style lookup with queries that are just user names. The
6733 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6734 success, the result string is the same as you would get from an &(lsearch)&
6735 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6736 password value. For example:
6737 .code
6738 *:42:42:King Rat:/home/kr:/bin/bash
6739 .endd
6740 .next
6741 .cindex "PostgreSQL lookup type"
6742 .cindex "lookup" "PostgreSQL"
6743 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6744 PostgreSQL database. See section &<<SECTsql>>&.
6745
6746 .next
6747 .cindex "Redis lookup type"
6748 .cindex lookup Redis
6749 &(redis)&: The format of the query is either a simple get or simple set,
6750 passed to a Redis database. See section &<<SECTsql>>&.
6751
6752 .next
6753 .cindex "sqlite lookup type"
6754 .cindex "lookup" "sqlite"
6755 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6756 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6757
6758 .next
6759 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6760 not likely to be useful in normal operation.
6761 .next
6762 .cindex "whoson lookup type"
6763 .cindex "lookup" "whoson"
6764 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6765 allows a server to check whether a particular (dynamically allocated) IP
6766 address is currently allocated to a known (trusted) user and, optionally, to
6767 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6768 at one time for &"POP before SMTP"& authentication, but that approach has been
6769 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6770 &"POP before SMTP"& checking using ACL statements such as
6771 .code
6772 require condition = \
6773   ${lookup whoson {$sender_host_address}{yes}{no}}
6774 .endd
6775 The query consists of a single IP address. The value returned is the name of
6776 the authenticated user, which is stored in the variable &$value$&. However, in
6777 this example, the data in &$value$& is not used; the result of the lookup is
6778 one of the fixed strings &"yes"& or &"no"&.
6779 .endlist
6780
6781
6782
6783 .section "Temporary errors in lookups" "SECID63"
6784 .cindex "lookup" "temporary error in"
6785 Lookup functions can return temporary error codes if the lookup cannot be
6786 completed. For example, an SQL or LDAP database might be unavailable. For this
6787 reason, it is not advisable to use a lookup that might do this for critical
6788 options such as a list of local domains.
6789
6790 When a lookup cannot be completed in a router or transport, delivery
6791 of the message (to the relevant address) is deferred, as for any other
6792 temporary error. In other circumstances Exim may assume the lookup has failed,
6793 or may give up altogether.
6794
6795
6796
6797 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6798 .cindex "wildcard lookups"
6799 .cindex "lookup" "default values"
6800 .cindex "lookup" "wildcard"
6801 .cindex "lookup" "* added to type"
6802 .cindex "default" "in single-key lookups"
6803 In this context, a &"default value"& is a value specified by the administrator
6804 that is to be used if a lookup fails.
6805
6806 &*Note:*& This section applies only to single-key lookups. For query-style
6807 lookups, the facilities of the query language must be used. An attempt to
6808 specify a default for a query-style lookup provokes an error.
6809
6810 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6811 and the initial lookup fails, the key &"*"& is looked up in the file to
6812 provide a default value. See also the section on partial matching below.
6813
6814 .cindex "*@ with single-key lookup"
6815 .cindex "lookup" "*@ added to type"
6816 .cindex "alias file" "per-domain default"
6817 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6818 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6819 character, a second lookup is done with everything before the last @ replaced
6820 by *. This makes it possible to provide per-domain defaults in alias files
6821 that include the domains in the keys. If the second lookup fails (or doesn't
6822 take place because there is no @ in the key), &"*"& is looked up.
6823 For example, a &(redirect)& router might contain:
6824 .code
6825 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6826 .endd
6827 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6828 looks up these keys, in this order:
6829 .code
6830 jane@eyre.example
6831 *@eyre.example
6832 *
6833 .endd
6834 The data is taken from whichever key it finds first. &*Note*&: In an
6835 &(lsearch)& file, this does not mean the first of these keys in the file. A
6836 complete scan is done for each key, and only if it is not found at all does
6837 Exim move on to try the next key.
6838
6839
6840
6841 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6842 .cindex "partial matching"
6843 .cindex "wildcard lookups"
6844 .cindex "lookup" "partial matching"
6845 .cindex "lookup" "wildcard"
6846 .cindex "asterisk" "in search type"
6847 The normal operation of a single-key lookup is to search the file for an exact
6848 match with the given key. However, in a number of situations where domains are
6849 being looked up, it is useful to be able to do partial matching. In this case,
6850 information in the file that has a key starting with &"*."& is matched by any
6851 domain that ends with the components that follow the full stop. For example, if
6852 a key in a DBM file is
6853 .code
6854 *.dates.fict.example
6855 .endd
6856 then when partial matching is enabled this is matched by (amongst others)
6857 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6858 by &'dates.fict.example'&, if that does not appear as a separate key in the
6859 file.
6860
6861 &*Note*&: Partial matching is not available for query-style lookups. It is
6862 also not available for any lookup items in address lists (see section
6863 &<<SECTaddresslist>>&).
6864
6865 Partial matching is implemented by doing a series of separate lookups using
6866 keys constructed by modifying the original subject key. This means that it can
6867 be used with any of the single-key lookup types, provided that
6868 partial matching keys
6869 beginning with a special prefix (default &"*."&) are included in the data file.
6870 Keys in the file that do not begin with the prefix are matched only by
6871 unmodified subject keys when partial matching is in use.
6872
6873 Partial matching is requested by adding the string &"partial-"& to the front of
6874 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6875 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6876 is added at the start of the subject key, and it is looked up again. If that
6877 fails, further lookups are tried with dot-separated components removed from the
6878 start of the subject key, one-by-one, and &"*."& added on the front of what
6879 remains.
6880
6881 A minimum number of two non-* components are required. This can be adjusted
6882 by including a number before the hyphen in the search type. For example,
6883 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6884 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6885 subject key is &'2250.dates.fict.example'& then the following keys are looked
6886 up when the minimum number of non-* components is two:
6887 .code
6888 2250.dates.fict.example
6889 *.2250.dates.fict.example
6890 *.dates.fict.example
6891 *.fict.example
6892 .endd
6893 As soon as one key in the sequence is successfully looked up, the lookup
6894 finishes.
6895
6896 .cindex "lookup" "partial matching &-- changing prefix"
6897 .cindex "prefix" "for partial matching"
6898 The use of &"*."& as the partial matching prefix is a default that can be
6899 changed. The motivation for this feature is to allow Exim to operate with file
6900 formats that are used by other MTAs. A different prefix can be supplied in
6901 parentheses instead of the hyphen after &"partial"&. For example:
6902 .code
6903 domains = partial(.)lsearch;/some/file
6904 .endd
6905 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6906 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6907 components is unchanged). The prefix may consist of any punctuation characters
6908 other than a closing parenthesis. It may be empty, for example:
6909 .code
6910 domains = partial1()cdb;/some/file
6911 .endd
6912 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6913 &`a.b.c`&, &`b.c`&, and &`c`&.
6914
6915 If &"partial0"& is specified, what happens at the end (when the lookup with
6916 just one non-wild component has failed, and the original key is shortened right
6917 down to the null string) depends on the prefix:
6918
6919 .ilist
6920 If the prefix has zero length, the whole lookup fails.
6921 .next
6922 If the prefix has length 1, a lookup for just the prefix is done. For
6923 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6924 .next
6925 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6926 remainder is looked up. With the default prefix, therefore, the final lookup is
6927 for &"*"& on its own.
6928 .next
6929 Otherwise, the whole prefix is looked up.
6930 .endlist
6931
6932
6933 If the search type ends in &"*"& or &"*@"& (see section
6934 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6935 this implies happens after all partial lookups have failed. If &"partial0"& is
6936 specified, adding &"*"& to the search type has no effect with the default
6937 prefix, because the &"*"& key is already included in the sequence of partial
6938 lookups. However, there might be a use for lookup types such as
6939 &"partial0(.)lsearch*"&.
6940
6941 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6942 in domain lists and the like. Partial matching works only in terms of
6943 dot-separated components; a key such as &`*fict.example`&
6944 in a database file is useless, because the asterisk in a partial matching
6945 subject key is always followed by a dot.
6946
6947
6948
6949
6950 .section "Lookup caching" "SECID64"
6951 .cindex "lookup" "caching"
6952 .cindex "caching" "lookup data"
6953 Exim caches all lookup results in order to avoid needless repetition of
6954 lookups. However, because (apart from the daemon) Exim operates as a collection
6955 of independent, short-lived processes, this caching applies only within a
6956 single Exim process. There is no inter-process lookup caching facility.
6957
6958 For single-key lookups, Exim keeps the relevant files open in case there is
6959 another lookup that needs them. In some types of configuration this can lead to
6960 many files being kept open for messages with many recipients. To avoid hitting
6961 the operating system limit on the number of simultaneously open files, Exim
6962 closes the least recently used file when it needs to open more files than its
6963 own internal limit, which can be changed via the &%lookup_open_max%& option.
6964
6965 The single-key lookup files are closed and the lookup caches are flushed at
6966 strategic points during delivery &-- for example, after all routing is
6967 complete.
6968
6969
6970
6971
6972 .section "Quoting lookup data" "SECID65"
6973 .cindex "lookup" "quoting"
6974 .cindex "quoting" "in lookups"
6975 When data from an incoming message is included in a query-style lookup, there
6976 is the possibility of special characters in the data messing up the syntax of
6977 the query. For example, a NIS+ query that contains
6978 .code
6979 [name=$local_part]
6980 .endd
6981 will be broken if the local part happens to contain a closing square bracket.
6982 For NIS+, data can be enclosed in double quotes like this:
6983 .code
6984 [name="$local_part"]
6985 .endd
6986 but this still leaves the problem of a double quote in the data. The rule for
6987 NIS+ is that double quotes must be doubled. Other lookup types have different
6988 rules, and to cope with the differing requirements, an expansion operator
6989 of the following form is provided:
6990 .code
6991 ${quote_<lookup-type>:<string>}
6992 .endd
6993 For example, the safest way to write the NIS+ query is
6994 .code
6995 [name="${quote_nisplus:$local_part}"]
6996 .endd
6997 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6998 operator can be used for all lookup types, but has no effect for single-key
6999 lookups, since no quoting is ever needed in their key strings.
7000
7001
7002
7003
7004 .section "More about dnsdb" "SECTdnsdb"
7005 .cindex "dnsdb lookup"
7006 .cindex "lookup" "dnsdb"
7007 .cindex "DNS" "as a lookup type"
7008 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7009 of a record type and a domain name, separated by an equals sign. For example,
7010 an expansion string could contain:
7011 .code
7012 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7013 .endd
7014 If the lookup succeeds, the result is placed in &$value$&, which in this case
7015 is used on its own as the result. If the lookup does not succeed, the
7016 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7017 &<<SECTforexpfai>>& for an explanation of what this means.
7018
7019 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7020 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7021 If no type is given, TXT is assumed.
7022
7023 For any record type, if multiple records are found, the data is returned as a
7024 concatenation, with newline as the default separator. The order, of course,
7025 depends on the DNS resolver. You can specify a different separator character
7026 between multiple records by putting a right angle-bracket followed immediately
7027 by the new separator at the start of the query. For example:
7028 .code
7029 ${lookup dnsdb{>: a=host1.example}}
7030 .endd
7031 It is permitted to specify a space as the separator character. Further
7032 white space is ignored.
7033 For lookup types that return multiple fields per record,
7034 an alternate field separator can be specified using a comma after the main
7035 separator character, followed immediately by the field separator.
7036
7037 .cindex "PTR record" "in &(dnsdb)& lookup"
7038 When the type is PTR,
7039 the data can be an IP address, written as normal; inversion and the addition of
7040 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7041 .code
7042 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7043 .endd
7044 If the data for a PTR record is not a syntactically valid IP address, it is not
7045 altered and nothing is added.
7046
7047 .cindex "MX record" "in &(dnsdb)& lookup"
7048 .cindex "SRV record" "in &(dnsdb)& lookup"
7049 For an MX lookup, both the preference value and the host name are returned for
7050 each record, separated by a space. For an SRV lookup, the priority, weight,
7051 port, and host name are returned for each record, separated by spaces.
7052 The field separator can be modified as above.
7053
7054 .cindex "TXT record" "in &(dnsdb)& lookup"
7055 .cindex "SPF record" "in &(dnsdb)& lookup"
7056 For TXT records with multiple items of data, only the first item is returned,
7057 unless a field separator is specified.
7058 To concatenate items without a separator, use a semicolon instead.
7059 For SPF records the
7060 default behaviour is to concatenate multiple items without using a separator.
7061 .code
7062 ${lookup dnsdb{>\n,: txt=a.b.example}}
7063 ${lookup dnsdb{>\n; txt=a.b.example}}
7064 ${lookup dnsdb{spf=example.org}}
7065 .endd
7066 It is permitted to specify a space as the separator character. Further
7067 white space is ignored.
7068
7069 .cindex "SOA record" "in &(dnsdb)& lookup"
7070 For an SOA lookup, while no result is obtained the lookup is redone with
7071 successively more leading components dropped from the given domain.
7072 Only the primary-nameserver field is returned unless a field separator is
7073 specified.
7074 .code
7075 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7076 .endd
7077
7078 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7079 .cindex "dnsdb modifiers"
7080 .cindex "modifiers" "dnsdb"
7081 .cindex "options" "dnsdb"
7082 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7083 each followed by a comma,
7084 that may appear before the record type.
7085
7086 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7087 temporary DNS error for any of them, the behaviour is controlled by
7088 a defer-option modifier.
7089 The possible keywords are
7090 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7091 With &"strict"& behaviour, any temporary DNS error causes the
7092 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7093 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7094 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7095 error causes the whole lookup to defer only if none of the other lookups
7096 succeed. The default is &"lax"&, so the following lookups are equivalent:
7097 .code
7098 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7099 ${lookup dnsdb{a=one.host.com:two.host.com}}
7100 .endd
7101 Thus, in the default case, as long as at least one of the DNS lookups
7102 yields some data, the lookup succeeds.
7103
7104 .cindex "DNSSEC" "dns lookup"
7105 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7106 The possible keywords are
7107 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7108 With &"strict"& or &"lax"& DNSSEC information is requested
7109 with the lookup.
7110 With &"strict"& a response from the DNS resolver that
7111 is not labelled as authenticated data
7112 is treated as equivalent to a temporary DNS error.
7113 The default is &"never"&.
7114
7115 See also the &$lookup_dnssec_authenticated$& variable.
7116
7117 .cindex timeout "dns lookup"
7118 .cindex "DNS" timeout
7119 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7120 The form is &"retrans_VAL"& where VAL is an Exim time specification
7121 (e.g. &"5s"&).
7122 The default value is set by the main configuration option &%dns_retrans%&.
7123
7124 Retries for the dnsdb lookup can be controlled by a retry modifier.
7125 The form if &"retry_VAL"& where VAL is an integer.
7126 The default count is set by the main configuration option &%dns_retry%&.
7127
7128 .cindex caching "of dns lookup"
7129 .cindex TTL "of dns lookup"
7130 .cindex DNS TTL
7131 Dnsdb lookup results are cached within a single process (and its children).
7132 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7133 value of the set of returned DNS records.
7134
7135
7136 .section "Pseudo dnsdb record types" "SECID66"
7137 .cindex "MX record" "in &(dnsdb)& lookup"
7138 By default, both the preference value and the host name are returned for
7139 each MX record, separated by a space. If you want only host names, you can use
7140 the pseudo-type MXH:
7141 .code
7142 ${lookup dnsdb{mxh=a.b.example}}
7143 .endd
7144 In this case, the preference values are omitted, and just the host names are
7145 returned.
7146
7147 .cindex "name server for enclosing domain"
7148 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7149 records on the given domain, but if none are found, it removes the first
7150 component of the domain name, and tries again. This process continues until NS
7151 records are found or there are no more components left (or there is a DNS
7152 error). In other words, it may return the name servers for a top-level domain,
7153 but it never returns the root name servers. If there are no NS records for the
7154 top-level domain, the lookup fails. Consider these examples:
7155 .code
7156 ${lookup dnsdb{zns=xxx.quercite.com}}
7157 ${lookup dnsdb{zns=xxx.edu}}
7158 .endd
7159 Assuming that in each case there are no NS records for the full domain name,
7160 the first returns the name servers for &%quercite.com%&, and the second returns
7161 the name servers for &%edu%&.
7162
7163 You should be careful about how you use this lookup because, unless the
7164 top-level domain does not exist, the lookup always returns some host names. The
7165 sort of use to which this might be put is for seeing if the name servers for a
7166 given domain are on a blacklist. You can probably assume that the name servers
7167 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7168 such a list.
7169
7170 .cindex "CSA" "in &(dnsdb)& lookup"
7171 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7172 records according to the CSA rules, which are described in section
7173 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7174 not sufficient because of the extra parent domain search behaviour of CSA. The
7175 result of a successful lookup such as:
7176 .code
7177 ${lookup dnsdb {csa=$sender_helo_name}}
7178 .endd
7179 has two space-separated fields: an authorization code and a target host name.
7180 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7181 authorization required but absent, or &"?"& for unknown.
7182
7183 .cindex "A+" "in &(dnsdb)& lookup"
7184 The pseudo-type A+ performs an AAAA
7185 and then an A lookup.  All results are returned; defer processing
7186 (see below) is handled separately for each lookup.  Example:
7187 .code
7188 ${lookup dnsdb {>; a+=$sender_helo_name}}
7189 .endd
7190
7191
7192 .section "Multiple dnsdb lookups" "SECID67"
7193 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7194 However, you can specify a list of domains or IP addresses in a single
7195 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7196 the default separator, but with the ability to change this. For example:
7197 .code
7198 ${lookup dnsdb{one.domain.com:two.domain.com}}
7199 ${lookup dnsdb{a=one.host.com:two.host.com}}
7200 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7201 .endd
7202 In order to retain backwards compatibility, there is one special case: if
7203 the lookup type is PTR and no change of separator is specified, Exim looks
7204 to see if the rest of the string is precisely one IPv6 address. In this
7205 case, it does not treat it as a list.
7206
7207 The data from each lookup is concatenated, with newline separators by default,
7208 in the same way that multiple DNS records for a single item are handled. A
7209 different separator can be specified, as described above.
7210
7211
7212
7213
7214 .section "More about LDAP" "SECTldap"
7215 .cindex "LDAP" "lookup, more about"
7216 .cindex "lookup" "LDAP"
7217 .cindex "Solaris" "LDAP"
7218 The original LDAP implementation came from the University of Michigan; this has
7219 become &"Open LDAP"&, and there are now two different releases. Another
7220 implementation comes from Netscape, and Solaris 7 and subsequent releases
7221 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7222 the lookup function level, their error handling is different. For this reason
7223 it is necessary to set a compile-time variable when building Exim with LDAP, to
7224 indicate which LDAP library is in use. One of the following should appear in
7225 your &_Local/Makefile_&:
7226 .code
7227 LDAP_LIB_TYPE=UMICHIGAN
7228 LDAP_LIB_TYPE=OPENLDAP1
7229 LDAP_LIB_TYPE=OPENLDAP2
7230 LDAP_LIB_TYPE=NETSCAPE
7231 LDAP_LIB_TYPE=SOLARIS
7232 .endd
7233 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7234 same interface as the University of Michigan version.
7235
7236 There are three LDAP lookup types in Exim. These behave slightly differently in
7237 the way they handle the results of a query:
7238
7239 .ilist
7240 &(ldap)& requires the result to contain just one entry; if there are more, it
7241 gives an error.
7242 .next
7243 &(ldapdn)& also requires the result to contain just one entry, but it is the
7244 Distinguished Name that is returned rather than any attribute values.
7245 .next
7246 &(ldapm)& permits the result to contain more than one entry; the attributes
7247 from all of them are returned.
7248 .endlist
7249
7250
7251 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7252 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7253 the data returned by a successful lookup is described in the next section.
7254 First we explain how LDAP queries are coded.
7255
7256
7257 .section "Format of LDAP queries" "SECTforldaque"
7258 .cindex "LDAP" "query format"
7259 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7260 the configuration of a &(redirect)& router one might have this setting:
7261 .code
7262 data = ${lookup ldap \
7263   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7264   c=UK?mailbox?base?}}
7265 .endd
7266 .cindex "LDAP" "with TLS"
7267 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7268 secure (encrypted) LDAP connections. The second of these ensures that an
7269 encrypted TLS connection is used.
7270
7271 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7272 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7273 See the &%ldap_start_tls%& option.
7274
7275 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7276 controlled. Every part of the TLS configuration can be configured by settings in
7277 &_exim.conf_&. Depending on the version of the client libraries installed on
7278 your system, some of the initialization may have required setting options in
7279 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7280 certificates. This revealed a nuance where the current UID that exim was
7281 running as could affect which config files it read. With Exim 4.83, these
7282 methods become optional, only taking effect if not specifically set in
7283 &_exim.conf_&.
7284
7285
7286 .section "LDAP quoting" "SECID68"
7287 .cindex "LDAP" "quoting"
7288 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7289 and the second because the LDAP query is represented as a URL. Furthermore,
7290 within an LDAP query, two different kinds of quoting are required. For this
7291 reason, there are two different LDAP-specific quoting operators.
7292
7293 The &%quote_ldap%& operator is designed for use on strings that are part of
7294 filter specifications. Conceptually, it first does the following conversions on
7295 the string:
7296 .code
7297 *   =>   \2A
7298 (   =>   \28
7299 )   =>   \29
7300 \   =>   \5C
7301 .endd
7302 in accordance with RFC 2254. The resulting string is then quoted according
7303 to the rules for URLs, that is, all non-alphanumeric characters except
7304 .code
7305 ! $ ' - . _ ( ) * +
7306 .endd
7307 are converted to their hex values, preceded by a percent sign. For example:
7308 .code
7309 ${quote_ldap: a(bc)*, a<yz>; }
7310 .endd
7311 yields
7312 .code
7313 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7314 .endd
7315 Removing the URL quoting, this is (with a leading and a trailing space):
7316 .code
7317 a\28bc\29\2A, a<yz>;
7318 .endd
7319 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7320 base DN specifications in queries. Conceptually, it first converts the string
7321 by inserting a backslash in front of any of the following characters:
7322 .code
7323 , + " \ < > ;
7324 .endd
7325 It also inserts a backslash before any leading spaces or # characters, and
7326 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7327 is then quoted according to the rules for URLs. For example:
7328 .code
7329 ${quote_ldap_dn: a(bc)*, a<yz>; }
7330 .endd
7331 yields
7332 .code
7333 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7334 .endd
7335 Removing the URL quoting, this is (with a trailing space):
7336 .code
7337 \ a(bc)*\, a\<yz\>\;\
7338 .endd
7339 There are some further comments about quoting in the section on LDAP
7340 authentication below.
7341
7342
7343 .section "LDAP connections" "SECID69"
7344 .cindex "LDAP" "connections"
7345 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7346 is in use, via a Unix domain socket. The example given above does not specify
7347 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7348 by starting it with
7349 .code
7350 ldap://<hostname>:<port>/...
7351 .endd
7352 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7353 used. When no server is specified in a query, a list of default servers is
7354 taken from the &%ldap_default_servers%& configuration option. This supplies a
7355 colon-separated list of servers which are tried in turn until one successfully
7356 handles a query, or there is a serious error. Successful handling either
7357 returns the requested data, or indicates that it does not exist. Serious errors
7358 are syntactical, or multiple values when only a single value is expected.
7359 Errors which cause the next server to be tried are connection failures, bind
7360 failures, and timeouts.
7361
7362 For each server name in the list, a port number can be given. The standard way
7363 of specifying a host and port is to use a colon separator (RFC 1738). Because
7364 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7365 doubled. For example
7366 .code
7367 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7368 .endd
7369 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7370 to the LDAP library with no server name, and the library's default (normally
7371 the local host) is used.
7372
7373 If you are using the OpenLDAP library, you can connect to an LDAP server using
7374 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7375 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7376 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7377 not available.
7378
7379 For this type of connection, instead of a host name for the server, a pathname
7380 for the socket is required, and the port number is not relevant. The pathname
7381 can be specified either as an item in &%ldap_default_servers%&, or inline in
7382 the query. In the former case, you can have settings such as
7383 .code
7384 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7385 .endd
7386 When the pathname is given in the query, you have to escape the slashes as
7387 &`%2F`& to fit in with the LDAP URL syntax. For example:
7388 .code
7389 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7390 .endd
7391 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7392 a pathname, it uses the Unix domain socket code, even if the query actually
7393 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7394 socket connection. This behaviour means that you can use a setting of
7395 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7396 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7397 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7398 backup host.
7399
7400 If an explicit &`ldapi`& type is given in a query when a host name is
7401 specified, an error is diagnosed. However, if there are more items in
7402 &%ldap_default_servers%&, they are tried. In other words:
7403
7404 .ilist
7405 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7406 interface.
7407 .next
7408 Using &`ldapi`& with a host name causes an error.
7409 .endlist
7410
7411
7412 Using &`ldapi`& with no host or path in the query, and no setting of
7413 &%ldap_default_servers%&, does whatever the library does by default.
7414
7415
7416
7417 .section "LDAP authentication and control information" "SECID70"
7418 .cindex "LDAP" "authentication"
7419 The LDAP URL syntax provides no way of passing authentication and other control
7420 information to the server. To make this possible, the URL in an LDAP query may
7421 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7422 spaces. If a value contains spaces it must be enclosed in double quotes, and
7423 when double quotes are used, backslash is interpreted in the usual way inside
7424 them. The following names are recognized:
7425 .display
7426 &`DEREFERENCE`&  set the dereferencing parameter
7427 &`NETTIME    `&  set a timeout for a network operation
7428 &`USER       `&  set the DN, for authenticating the LDAP bind
7429 &`PASS       `&  set the password, likewise
7430 &`REFERRALS  `&  set the referrals parameter
7431 &`SERVERS    `&  set alternate server list for this query only
7432 &`SIZE       `&  set the limit for the number of entries returned
7433 &`TIME       `&  set the maximum waiting time for a query
7434 .endd
7435 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7436 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7437 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7438 library from trying to follow referrals issued by the LDAP server.
7439
7440 .cindex LDAP timeout
7441 .cindex timeout "LDAP lookup"
7442 The name CONNECT is an obsolete name for NETTIME, retained for
7443 backwards compatibility. This timeout (specified as a number of seconds) is
7444 enforced from the client end for operations that can be carried out over a
7445 network. Specifically, it applies to network connections and calls to the
7446 &'ldap_result()'& function. If the value is greater than zero, it is used if
7447 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7448 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7449 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7450 Netscape SDK; for OpenLDAP no action is taken.
7451
7452 The TIME parameter (also a number of seconds) is passed to the server to
7453 set a server-side limit on the time taken to complete a search.
7454
7455 The SERVERS parameter allows you to specify an alternate list of ldap servers
7456 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7457 default list of ldap servers, and a single lookup can specify a single ldap
7458 server to use.  But when you need to do a lookup with a list of servers that is
7459 different than the default list (maybe different order, maybe a completely
7460 different set of servers), the SERVERS parameter allows you to specify this
7461 alternate list (colon-separated).
7462
7463 Here is an example of an LDAP query in an Exim lookup that uses some of these
7464 values. This is a single line, folded to fit on the page:
7465 .code
7466 ${lookup ldap
7467   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7468   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7469   {$value}fail}
7470 .endd
7471 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7472 any of the auxiliary data. Exim configuration settings that include lookups
7473 which contain password information should be preceded by &"hide"& to prevent
7474 non-admin users from using the &%-bP%& option to see their values.
7475
7476 The auxiliary data items may be given in any order. The default is no
7477 connection timeout (the system timeout is used), no user or password, no limit
7478 on the number of entries returned, and no time limit on queries.
7479
7480 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7481 removes any URL quoting that it may contain before passing it LDAP. Apparently
7482 some libraries do this for themselves, but some do not. Removing the URL
7483 quoting has two advantages:
7484
7485 .ilist
7486 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7487 DNs as with DNs inside actual queries.
7488 .next
7489 It permits spaces inside USER= DNs.
7490 .endlist
7491
7492 For example, a setting such as
7493 .code
7494 USER=cn=${quote_ldap_dn:$1}
7495 .endd
7496 should work even if &$1$& contains spaces.
7497
7498 Expanded data for the PASS= value should be quoted using the &%quote%&
7499 expansion operator, rather than the LDAP quote operators. The only reason this
7500 field needs quoting is to ensure that it conforms to the Exim syntax, which
7501 does not allow unquoted spaces. For example:
7502 .code
7503 PASS=${quote:$3}
7504 .endd
7505 The LDAP authentication mechanism can be used to check passwords as part of
7506 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7507 &<<CHAPexpand>>&.
7508
7509
7510
7511 .section "Format of data returned by LDAP" "SECID71"
7512 .cindex "LDAP" "returned data formats"
7513 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7514 as a sequence of values, for example
7515 .code
7516 cn=manager,o=University of Cambridge,c=UK
7517 .endd
7518 The &(ldap)& lookup type generates an error if more than one entry matches the
7519 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7520 the result between the data from different entries. It is possible for multiple
7521 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7522 you know that whatever values are returned all came from a single entry in the
7523 directory.
7524
7525 In the common case where you specify a single attribute in your LDAP query, the
7526 result is not quoted, and does not contain the attribute name. If the attribute
7527 has multiple values, they are separated by commas. Any comma that is
7528 part of an attribute's value is doubled.
7529
7530 If you specify multiple attributes, the result contains space-separated, quoted
7531 strings, each preceded by the attribute name and an equals sign. Within the
7532 quotes, the quote character, backslash, and newline are escaped with
7533 backslashes, and commas are used to separate multiple values for the attribute.
7534 Any commas in attribute values are doubled
7535 (permitting treatment of the values as a comma-separated list).
7536 Apart from the escaping, the string within quotes takes the same form as the
7537 output when a single attribute is requested. Specifying no attributes is the
7538 same as specifying all of an entry's attributes.
7539
7540 Here are some examples of the output format. The first line of each pair is an
7541 LDAP query, and the second is the data that is returned. The attribute called
7542 &%attr1%& has two values, one of them with an embedded comma, whereas
7543 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7544 (they have SUP &%attr%& in their schema definitions).
7545
7546 .code
7547 ldap:///o=base?attr1?sub?(uid=fred)
7548 value1.1,value1,,2
7549
7550 ldap:///o=base?attr2?sub?(uid=fred)
7551 value two
7552
7553 ldap:///o=base?attr?sub?(uid=fred)
7554 value1.1,value1,,2,value two
7555
7556 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7557 attr1="value1.1,value1,,2" attr2="value two"
7558
7559 ldap:///o=base??sub?(uid=fred)
7560 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7561 .endd
7562 You can
7563 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7564 results of LDAP lookups.
7565 The &%extract%& operator in string expansions can be used to pick out
7566 individual fields from data that consists of &'key'&=&'value'& pairs.
7567 The &%listextract%& operator should be used to pick out individual values
7568 of attributes, even when only a single value is expected.
7569 The doubling of embedded commas allows you to use the returned data as a
7570 comma separated list (using the "<," syntax for changing the input list separator).
7571
7572
7573
7574
7575 .section "More about NIS+" "SECTnisplus"
7576 .cindex "NIS+ lookup type"
7577 .cindex "lookup" "NIS+"
7578 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7579 and field name. If this is given, the result of a successful query is the
7580 contents of the named field; otherwise the result consists of a concatenation
7581 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7582 values containing spaces are quoted. For example, the query
7583 .code
7584 [name=mg1456],passwd.org_dir
7585 .endd
7586 might return the string
7587 .code
7588 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7589 home=/home/mg1456 shell=/bin/bash shadow=""
7590 .endd
7591 (split over two lines here to fit on the page), whereas
7592 .code
7593 [name=mg1456],passwd.org_dir:gcos
7594 .endd
7595 would just return
7596 .code
7597 Martin Guerre
7598 .endd
7599 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7600 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7601 operator is to double any quote characters within the text.
7602
7603
7604
7605 .section "SQL lookups" "SECTsql"
7606 .cindex "SQL lookup types"
7607 .cindex "MySQL" "lookup type"
7608 .cindex "PostgreSQL lookup type"
7609 .cindex "lookup" "MySQL"
7610 .cindex "lookup" "PostgreSQL"
7611 .cindex "Oracle" "lookup type"
7612 .cindex "lookup" "Oracle"
7613 .cindex "InterBase lookup type"
7614 .cindex "lookup" "InterBase"
7615 .cindex "Redis lookup type"
7616 .cindex lookup Redis
7617 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7618 and SQLite
7619 databases. Queries for these databases contain SQL statements, so an example
7620 might be
7621 .code
7622 ${lookup mysql{select mailbox from users where id='userx'}\
7623   {$value}fail}
7624 .endd
7625 If the result of the query contains more than one field, the data for each
7626 field in the row is returned, preceded by its name, so the result of
7627 .code
7628 ${lookup pgsql{select home,name from users where id='userx'}\
7629   {$value}}
7630 .endd
7631 might be
7632 .code
7633 home=/home/userx name="Mister X"
7634 .endd
7635 Empty values and values containing spaces are double quoted, with embedded
7636 quotes escaped by a backslash. If the result of the query contains just one
7637 field, the value is passed back verbatim, without a field name, for example:
7638 .code
7639 Mister X
7640 .endd
7641 If the result of the query yields more than one row, it is all concatenated,
7642 with a newline between the data for each row.
7643
7644
7645 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7646 .cindex "MySQL" "lookup type"
7647 .cindex "PostgreSQL lookup type"
7648 .cindex "lookup" "MySQL"
7649 .cindex "lookup" "PostgreSQL"
7650 .cindex "Oracle" "lookup type"
7651 .cindex "lookup" "Oracle"
7652 .cindex "InterBase lookup type"
7653 .cindex "lookup" "InterBase"
7654 .cindex "Redis lookup type"
7655 .cindex lookup Redis
7656 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7657 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7658 or &%redis_servers%&
7659 option (as appropriate) must be set to a colon-separated list of server
7660 information.
7661 (For MySQL and PostgreSQL, the global option need not be set if all
7662 queries contain their own server information &-- see section
7663 &<<SECTspeserque>>&.)
7664 For all but Redis
7665 each item in the list is a slash-separated list of four
7666 items: host name, database name, user name, and password. In the case of
7667 Oracle, the host name field is used for the &"service name"&, and the database
7668 name field is not used and should be empty. For example:
7669 .code
7670 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7671 .endd
7672 Because password data is sensitive, you should always precede the setting with
7673 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7674 option. Here is an example where two MySQL servers are listed:
7675 .code
7676 hide mysql_servers = localhost/users/root/secret:\
7677                      otherhost/users/root/othersecret
7678 .endd
7679 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7680 because this is a colon-separated list, the colon has to be doubled. For each
7681 query, these parameter groups are tried in order until a connection is made and
7682 a query is successfully processed. The result of a query may be that no data is
7683 found, but that is still a successful query. In other words, the list of
7684 servers provides a backup facility, not a list of different places to look.
7685
7686 For Redis the global option need not be specified if all queries contain their
7687 own server information &-- see section &<<SECTspeserque>>&.
7688 If specified, the option must be set to a colon-separated list of server
7689 information.
7690 Each item in the list is a slash-separated list of three items:
7691 host, database number, and password.
7692 .olist
7693 The host is required and may be either an IPv4 address and optional
7694 port number (separated by a colon, which needs doubling due to the
7695 higher-level list), or a Unix socket pathname enclosed in parentheses
7696 .next
7697 The database number is optional; if present that number is selected in the backend
7698 .next
7699 The password is optional; if present it is used to authenticate to the backend
7700 .endlist
7701
7702 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7703 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7704 respectively, and the characters single-quote, double-quote, and backslash
7705 itself are escaped with backslashes.
7706
7707 The &%quote_redis%& expansion operator
7708 escapes whitespace and backslash characters with a backslash.
7709
7710 .section "Specifying the server in the query" "SECTspeserque"
7711 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7712 it is possible to specify a list of servers with an individual query. This is
7713 done by starting the query with
7714 .display
7715 &`servers=`&&'server1:server2:server3:...'&&`;`&
7716 .endd
7717 Each item in the list may take one of two forms:
7718 .olist
7719 If it contains no slashes it is assumed to be just a host name. The appropriate
7720 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7721 of the same name, and the remaining parameters (database, user, password) are
7722 taken from there.
7723 .next
7724 If it contains any slashes, it is taken as a complete parameter set.
7725 .endlist
7726 The list of servers is used in exactly the same way as the global list.
7727 Once a connection to a server has happened and a query has been
7728 successfully executed, processing of the lookup ceases.
7729
7730 This feature is intended for use in master/slave situations where updates
7731 are occurring and you want to update the master rather than a slave. If the
7732 master is in the list as a backup for reading, you might have a global setting
7733 like this:
7734 .code
7735 mysql_servers = slave1/db/name/pw:\
7736                 slave2/db/name/pw:\
7737                 master/db/name/pw
7738 .endd
7739 In an updating lookup, you could then write:
7740 .code
7741 ${lookup mysql{servers=master; UPDATE ...} }
7742 .endd
7743 That query would then be sent only to the master server. If, on the other hand,
7744 the master is not to be used for reading, and so is not present in the global
7745 option, you can still update it by a query of this form:
7746 .code
7747 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7748 .endd
7749
7750
7751 .section "Special MySQL features" "SECID73"
7752 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7753 causes a connection to the server on the local host by means of a Unix domain
7754 socket. An alternate socket can be specified in parentheses.
7755 An option group name for MySQL option files can be specified in square brackets;
7756 the default value is &"exim"&.
7757 The full syntax of each item in &%mysql_servers%& is:
7758 .display
7759 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7760   <&'database'&>/<&'user'&>/<&'password'&>
7761 .endd
7762 Any of the four sub-parts of the first field can be omitted. For normal use on
7763 the local host it can be left blank or set to just &"localhost"&.
7764
7765 No database need be supplied &-- but if it is absent here, it must be given in
7766 the queries.
7767
7768 If a MySQL query is issued that does not request any data (an insert, update,
7769 or delete command), the result of the lookup is the number of rows affected.
7770
7771 &*Warning*&: This can be misleading. If an update does not actually change
7772 anything (for example, setting a field to the value it already has), the result
7773 is zero because no rows are affected.
7774
7775
7776 .section "Special PostgreSQL features" "SECID74"
7777 PostgreSQL lookups can also use Unix domain socket connections to the database.
7778 This is usually faster and costs less CPU time than a TCP/IP connection.
7779 However it can be used only if the mail server runs on the same machine as the
7780 database server. A configuration line for PostgreSQL via Unix domain sockets
7781 looks like this:
7782 .code
7783 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7784 .endd
7785 In other words, instead of supplying a host name, a path to the socket is
7786 given. The path name is enclosed in parentheses so that its slashes aren't
7787 visually confused with the delimiters for the other server parameters.
7788
7789 If a PostgreSQL query is issued that does not request any data (an insert,
7790 update, or delete command), the result of the lookup is the number of rows
7791 affected.
7792
7793 .section "More about SQLite" "SECTsqlite"
7794 .cindex "lookup" "SQLite"
7795 .cindex "sqlite lookup type"
7796 SQLite is different to the other SQL lookups because a file name is required in
7797 addition to the SQL query. An SQLite database is a single file, and there is no
7798 daemon as in the other SQL databases. The interface to Exim requires the name
7799 of the file, as an absolute path, to be given at the start of the query. It is
7800 separated from the query by white space. This means that the path name cannot
7801 contain white space. Here is a lookup expansion example:
7802 .code
7803 ${lookup sqlite {/some/thing/sqlitedb \
7804   select name from aliases where id='userx';}}
7805 .endd
7806 In a list, the syntax is similar. For example:
7807 .code
7808 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7809    select * from relays where ip='$sender_host_address';
7810 .endd
7811 The only character affected by the &%quote_sqlite%& operator is a single
7812 quote, which it doubles.
7813
7814 .cindex timeout SQLite
7815 .cindex sqlite "lookup timeout"
7816 The SQLite library handles multiple simultaneous accesses to the database
7817 internally. Multiple readers are permitted, but only one process can
7818 update at once. Attempts to access the database while it is being updated
7819 are rejected after a timeout period, during which the SQLite library
7820 waits for the lock to be released. In Exim, the default timeout is set
7821 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7822 option.
7823
7824 .section "More about Redis" "SECTredis"
7825 .cindex "lookup" "Redis"
7826 .cindex "redis lookup type"
7827 Redis is a non-SQL database. Commands are simple get and set.
7828 Examples:
7829 .code
7830 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
7831 ${lookup redis{get keyname}}
7832 .endd
7833
7834 .ecindex IIDfidalo1
7835 .ecindex IIDfidalo2
7836
7837
7838 . ////////////////////////////////////////////////////////////////////////////
7839 . ////////////////////////////////////////////////////////////////////////////
7840
7841 .chapter "Domain, host, address, and local part lists" &&&
7842          "CHAPdomhosaddlists" &&&
7843          "Domain, host, and address lists"
7844 .scindex IIDdohoadli "lists of domains; hosts; etc."
7845 A number of Exim configuration options contain lists of domains, hosts,
7846 email addresses, or local parts. For example, the &%hold_domains%& option
7847 contains a list of domains whose delivery is currently suspended. These lists
7848 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7849 arguments to expansion conditions such as &%match_domain%&.
7850
7851 Each item in one of these lists is a pattern to be matched against a domain,
7852 host, email address, or local part, respectively. In the sections below, the
7853 different types of pattern for each case are described, but first we cover some
7854 general facilities that apply to all four kinds of list.
7855
7856 Note that other parts of Exim use a &'string list'& which does not
7857 support all the complexity available in
7858 domain, host, address and local part lists.
7859
7860
7861
7862 .section "Expansion of lists" "SECTlistexpand"
7863 .cindex "expansion" "of lists"
7864 Each list is expanded as a single string before it is used.
7865
7866 &'Exception: the router headers_remove option, where list-item
7867 splitting is done before string-expansion.'&
7868
7869 The result of
7870 expansion must be a list, possibly containing empty items, which is split up
7871 into separate items for matching. By default, colon is the separator character,
7872 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7873 &<<SECTempitelis>>& for details of the list syntax; the second of these
7874 discusses the way to specify empty list items.
7875
7876
7877 If the string expansion is forced to fail, Exim behaves as if the item it is
7878 testing (domain, host, address, or local part) is not in the list. Other
7879 expansion failures cause temporary errors.
7880
7881 If an item in a list is a regular expression, backslashes, dollars and possibly
7882 other special characters in the expression must be protected against
7883 misinterpretation by the string expander. The easiest way to do this is to use
7884 the &`\N`& expansion feature to indicate that the contents of the regular
7885 expression should not be expanded. For example, in an ACL you might have:
7886 .code
7887 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7888                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7889 .endd
7890 The first item is a regular expression that is protected from expansion by
7891 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7892 senders based on the receiving domain.
7893
7894
7895
7896
7897 .section "Negated items in lists" "SECID76"
7898 .cindex "list" "negation"
7899 .cindex "negation" "in lists"
7900 Items in a list may be positive or negative. Negative items are indicated by a
7901 leading exclamation mark, which may be followed by optional white space. A list
7902 defines a set of items (domains, etc). When Exim processes one of these lists,
7903 it is trying to find out whether a domain, host, address, or local part
7904 (respectively) is in the set that is defined by the list. It works like this:
7905
7906 The list is scanned from left to right. If a positive item is matched, the
7907 subject that is being checked is in the set; if a negative item is matched, the
7908 subject is not in the set. If the end of the list is reached without the
7909 subject having matched any of the patterns, it is in the set if the last item
7910 was a negative one, but not if it was a positive one. For example, the list in
7911 .code
7912 domainlist relay_to_domains = !a.b.c : *.b.c
7913 .endd
7914 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7915 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7916 list is positive. However, if the setting were
7917 .code
7918 domainlist relay_to_domains = !a.b.c
7919 .endd
7920 then all domains other than &'a.b.c'& would match because the last item in the
7921 list is negative. In other words, a list that ends with a negative item behaves
7922 as if it had an extra item &`:*`& on the end.
7923
7924 Another way of thinking about positive and negative items in lists is to read
7925 the connector as &"or"& after a positive item and as &"and"& after a negative
7926 item.
7927
7928
7929
7930 .section "File names in lists" "SECTfilnamlis"
7931 .cindex "list" "file name in"
7932 If an item in a domain, host, address, or local part list is an absolute file
7933 name (beginning with a slash character), each line of the file is read and
7934 processed as if it were an independent item in the list, except that further
7935 file names are not allowed,
7936 and no expansion of the data from the file takes place.
7937 Empty lines in the file are ignored, and the file may also contain comment
7938 lines:
7939
7940 .ilist
7941 For domain and host lists, if a # character appears anywhere in a line of the
7942 file, it and all following characters are ignored.
7943 .next
7944 Because local parts may legitimately contain # characters, a comment in an
7945 address list or local part list file is recognized only if # is preceded by
7946 white space or the start of the line. For example:
7947 .code
7948 not#comment@x.y.z   # but this is a comment
7949 .endd
7950 .endlist
7951
7952 Putting a file name in a list has the same effect as inserting each line of the
7953 file as an item in the list (blank lines and comments excepted). However, there
7954 is one important difference: the file is read each time the list is processed,
7955 so if its contents vary over time, Exim's behaviour changes.
7956
7957 If a file name is preceded by an exclamation mark, the sense of any match
7958 within the file is inverted. For example, if
7959 .code
7960 hold_domains = !/etc/nohold-domains
7961 .endd
7962 and the file contains the lines
7963 .code
7964 !a.b.c
7965 *.b.c
7966 .endd
7967 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7968 any domain matching &`*.b.c`& is not.
7969
7970
7971
7972 .section "An lsearch file is not an out-of-line list" "SECID77"
7973 As will be described in the sections that follow, lookups can be used in lists
7974 to provide indexed methods of checking list membership. There has been some
7975 confusion about the way &(lsearch)& lookups work in lists. Because
7976 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7977 sometimes thought that it is allowed to contain wild cards and other kinds of
7978 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7979 always fixed strings, just as for any other single-key lookup type.
7980
7981 If you want to use a file to contain wild-card patterns that form part of a
7982 list, just give the file name on its own, without a search type, as described
7983 in the previous section. You could also use the &(wildlsearch)& or
7984 &(nwildlsearch)&, but there is no advantage in doing this.
7985
7986
7987
7988
7989 .section "Named lists" "SECTnamedlists"
7990 .cindex "named lists"
7991 .cindex "list" "named"
7992 A list of domains, hosts, email addresses, or local parts can be given a name
7993 which is then used to refer to the list elsewhere in the configuration. This is
7994 particularly convenient if the same list is required in several different
7995 places. It also allows lists to be given meaningful names, which can improve
7996 the readability of the configuration. For example, it is conventional to define
7997 a domain list called &'local_domains'& for all the domains that are handled
7998 locally on a host, using a configuration line such as
7999 .code
8000 domainlist local_domains = localhost:my.dom.example
8001 .endd
8002 Named lists are referenced by giving their name preceded by a plus sign, so,
8003 for example, a router that is intended to handle local domains would be
8004 configured with the line
8005 .code
8006 domains = +local_domains
8007 .endd
8008 The first router in a configuration is often one that handles all domains
8009 except the local ones, using a configuration with a negated item like this:
8010 .code
8011 dnslookup:
8012   driver = dnslookup
8013   domains = ! +local_domains
8014   transport = remote_smtp
8015   no_more
8016 .endd
8017 The four kinds of named list are created by configuration lines starting with
8018 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8019 respectively. Then there follows the name that you are defining, followed by an
8020 equals sign and the list itself. For example:
8021 .code
8022 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8023 addresslist bad_senders = cdb;/etc/badsenders
8024 .endd
8025 A named list may refer to other named lists:
8026 .code
8027 domainlist  dom1 = first.example : second.example
8028 domainlist  dom2 = +dom1 : third.example
8029 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8030 .endd
8031 &*Warning*&: If the last item in a referenced list is a negative one, the
8032 effect may not be what you intended, because the negation does not propagate
8033 out to the higher level. For example, consider:
8034 .code
8035 domainlist  dom1 = !a.b
8036 domainlist  dom2 = +dom1 : *.b
8037 .endd
8038 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8039 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8040 means it matches the second list as well. The effect is not the same as
8041 .code
8042 domainlist  dom2 = !a.b : *.b
8043 .endd
8044 where &'x.y'& does not match. It's best to avoid negation altogether in
8045 referenced lists if you can.
8046
8047 Named lists may have a performance advantage. When Exim is routing an
8048 address or checking an incoming message, it caches the result of tests on named
8049 lists. So, if you have a setting such as
8050 .code
8051 domains = +local_domains
8052 .endd
8053 on several of your routers
8054 or in several ACL statements,
8055 the actual test is done only for the first one. However, the caching works only
8056 if there are no expansions within the list itself or any sublists that it
8057 references. In other words, caching happens only for lists that are known to be
8058 the same each time they are referenced.
8059
8060 By default, there may be up to 16 named lists of each type. This limit can be
8061 extended by changing a compile-time variable. The use of domain and host lists
8062 is recommended for concepts such as local domains, relay domains, and relay
8063 hosts. The default configuration is set up like this.
8064
8065
8066
8067 .section "Named lists compared with macros" "SECID78"
8068 .cindex "list" "named compared with macro"
8069 .cindex "macro" "compared with named list"
8070 At first sight, named lists might seem to be no different from macros in the
8071 configuration file. However, macros are just textual substitutions. If you
8072 write
8073 .code
8074 ALIST = host1 : host2
8075 auth_advertise_hosts = !ALIST
8076 .endd
8077 it probably won't do what you want, because that is exactly the same as
8078 .code
8079 auth_advertise_hosts = !host1 : host2
8080 .endd
8081 Notice that the second host name is not negated. However, if you use a host
8082 list, and write
8083 .code
8084 hostlist alist = host1 : host2
8085 auth_advertise_hosts = ! +alist
8086 .endd
8087 the negation applies to the whole list, and so that is equivalent to
8088 .code
8089 auth_advertise_hosts = !host1 : !host2
8090 .endd
8091
8092
8093 .section "Named list caching" "SECID79"
8094 .cindex "list" "caching of named"
8095 .cindex "caching" "named lists"
8096 While processing a message, Exim caches the result of checking a named list if
8097 it is sure that the list is the same each time. In practice, this means that
8098 the cache operates only if the list contains no $ characters, which guarantees
8099 that it will not change when it is expanded. Sometimes, however, you may have
8100 an expanded list that you know will be the same each time within a given
8101 message. For example:
8102 .code
8103 domainlist special_domains = \
8104            ${lookup{$sender_host_address}cdb{/some/file}}
8105 .endd
8106 This provides a list of domains that depends only on the sending host's IP
8107 address. If this domain list is referenced a number of times (for example,
8108 in several ACL lines, or in several routers) the result of the check is not
8109 cached by default, because Exim does not know that it is going to be the
8110 same list each time.
8111
8112 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8113 cache the result anyway. For example:
8114 .code
8115 domainlist_cache special_domains = ${lookup{...
8116 .endd
8117 If you do this, you should be absolutely sure that caching is going to do
8118 the right thing in all cases. When in doubt, leave it out.
8119
8120
8121
8122 .section "Domain lists" "SECTdomainlist"
8123 .cindex "domain list" "patterns for"
8124 .cindex "list" "domain list"
8125 Domain lists contain patterns that are to be matched against a mail domain.
8126 The following types of item may appear in domain lists:
8127
8128 .ilist
8129 .cindex "primary host name"
8130 .cindex "host name" "matched in domain list"
8131 .oindex "&%primary_hostname%&"
8132 .cindex "domain list" "matching primary host name"
8133 .cindex "@ in a domain list"
8134 If a pattern consists of a single @ character, it matches the local host name,
8135 as set by the &%primary_hostname%& option (or defaulted). This makes it
8136 possible to use the same configuration file on several different hosts that
8137 differ only in their names.
8138 .next
8139 .cindex "@[] in a domain list"
8140 .cindex "domain list" "matching local IP interfaces"
8141 .cindex "domain literal"
8142 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8143 in square brackets (as in an email address that contains a domain literal), but
8144 only if that IP address is recognized as local for email routing purposes. The
8145 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8146 control which of a host's several IP addresses are treated as local.
8147 In today's Internet, the use of domain literals is controversial.
8148 .next
8149 .cindex "@mx_any"
8150 .cindex "@mx_primary"
8151 .cindex "@mx_secondary"
8152 .cindex "domain list" "matching MX pointers to local host"
8153 If a pattern consists of the string &`@mx_any`& it matches any domain that
8154 has an MX record pointing to the local host or to any host that is listed in
8155 .oindex "&%hosts_treat_as_local%&"
8156 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8157 are similar, except that the first matches only when a primary MX target is the
8158 local host, and the second only when no primary MX target is the local host,
8159 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8160 preference value &-- there may of course be more than one of them.
8161
8162 The MX lookup that takes place when matching a pattern of this type is
8163 performed with the resolver options for widening names turned off. Thus, for
8164 example, a single-component domain will &'not'& be expanded by adding the
8165 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8166 options of the &(dnslookup)& router for a discussion of domain widening.
8167
8168 Sometimes you may want to ignore certain IP addresses when using one of these
8169 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8170 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8171 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8172 on a router). For example:
8173 .code
8174 domains = @mx_any/ignore=127.0.0.1
8175 .endd
8176 This example matches any domain that has an MX record pointing to one of
8177 the local host's IP addresses other than 127.0.0.1.
8178
8179 The list of IP addresses is in fact processed by the same code that processes
8180 host lists, so it may contain CIDR-coded network specifications and it may also
8181 contain negative items.
8182
8183 Because the list of IP addresses is a sublist within a domain list, you have to
8184 be careful about delimiters if there is more than one address. Like any other
8185 list, the default delimiter can be changed. Thus, you might have:
8186 .code
8187 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8188           an.other.domain : ...
8189 .endd
8190 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8191 involved, it is easiest to change the delimiter for the main list as well:
8192 .code
8193 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8194           an.other.domain ? ...
8195 .endd
8196 .next
8197 .cindex "asterisk" "in domain list"
8198 .cindex "domain list" "asterisk in"
8199 .cindex "domain list" "matching &""ends with""&"
8200 If a pattern starts with an asterisk, the remaining characters of the pattern
8201 are compared with the terminating characters of the domain. The use of &"*"& in
8202 domain lists differs from its use in partial matching lookups. In a domain
8203 list, the character following the asterisk need not be a dot, whereas partial
8204 matching works only in terms of dot-separated components. For example, a domain
8205 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8206 &'cipher.key.ex'&.
8207
8208 .next
8209 .cindex "regular expressions" "in domain list"
8210 .cindex "domain list" "matching regular expression"
8211 If a pattern starts with a circumflex character, it is treated as a regular
8212 expression, and matched against the domain using a regular expression matching
8213 function. The circumflex is treated as part of the regular expression.
8214 Email domains are case-independent, so this regular expression match is by
8215 default case-independent, but you can make it case-dependent by starting it
8216 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8217 are given in chapter &<<CHAPregexp>>&.
8218
8219 &*Warning*&: Because domain lists are expanded before being processed, you
8220 must escape any backslash and dollar characters in the regular expression, or
8221 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8222 it is not to be expanded (unless you really do want to build a regular
8223 expression by expansion, of course).
8224 .next
8225 .cindex "lookup" "in domain list"
8226 .cindex "domain list" "matching by lookup"
8227 If a pattern starts with the name of a single-key lookup type followed by a
8228 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8229 must be a file name in a suitable format for the lookup type. For example, for
8230 &"cdb;"& it must be an absolute path:
8231 .code
8232 domains = cdb;/etc/mail/local_domains.cdb
8233 .endd
8234 The appropriate type of lookup is done on the file using the domain name as the
8235 key. In most cases, the data that is looked up is not used; Exim is interested
8236 only in whether or not the key is present in the file. However, when a lookup
8237 is used for the &%domains%& option on a router
8238 or a &%domains%& condition in an ACL statement, the data is preserved in the
8239 &$domain_data$& variable and can be referred to in other router options or
8240 other statements in the same ACL.
8241
8242 .next
8243 Any of the single-key lookup type names may be preceded by
8244 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8245 .code
8246 domains = partial-dbm;/partial/domains
8247 .endd
8248 This causes partial matching logic to be invoked; a description of how this
8249 works is given in section &<<SECTpartiallookup>>&.
8250
8251 .next
8252 .cindex "asterisk" "in lookup type"
8253 Any of the single-key lookup types may be followed by an asterisk. This causes
8254 a default lookup for a key consisting of a single asterisk to be done if the
8255 original lookup fails. This is not a useful feature when using a domain list to
8256 select particular domains (because any domain would match), but it might have
8257 value if the result of the lookup is being used via the &$domain_data$&
8258 expansion variable.
8259 .next
8260 If the pattern starts with the name of a query-style lookup type followed by a
8261 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8262 pattern must be an appropriate query for the lookup type, as described in
8263 chapter &<<CHAPfdlookup>>&. For example:
8264 .code
8265 hold_domains = mysql;select domain from holdlist \
8266   where domain = '${quote_mysql:$domain}';
8267 .endd
8268 In most cases, the data that is looked up is not used (so for an SQL query, for
8269 example, it doesn't matter what field you select). Exim is interested only in
8270 whether or not the query succeeds. However, when a lookup is used for the
8271 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8272 variable and can be referred to in other options.
8273 .next
8274 .cindex "domain list" "matching literal domain name"
8275 If none of the above cases apply, a caseless textual comparison is made
8276 between the pattern and the domain.
8277 .endlist
8278
8279 Here is an example that uses several different kinds of pattern:
8280 .code
8281 domainlist funny_domains = \
8282   @ : \
8283   lib.unseen.edu : \
8284   *.foundation.fict.example : \
8285   \N^[1-2]\d{3}\.fict\.example$\N : \
8286   partial-dbm;/opt/data/penguin/book : \
8287   nis;domains.byname : \
8288   nisplus;[name=$domain,status=local],domains.org_dir
8289 .endd
8290 There are obvious processing trade-offs among the various matching modes. Using
8291 an asterisk is faster than a regular expression, and listing a few names
8292 explicitly probably is too. The use of a file or database lookup is expensive,
8293 but may be the only option if hundreds of names are required. Because the
8294 patterns are tested in order, it makes sense to put the most commonly matched
8295 patterns earlier.
8296
8297
8298
8299 .section "Host lists" "SECThostlist"
8300 .cindex "host list" "patterns in"
8301 .cindex "list" "host list"
8302 Host lists are used to control what remote hosts are allowed to do. For
8303 example, some hosts may be allowed to use the local host as a relay, and some
8304 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8305 two different ways, by name or by IP address. In a host list, some types of
8306 pattern are matched to a host name, and some are matched to an IP address.
8307 You need to be particularly careful with this when single-key lookups are
8308 involved, to ensure that the right value is being used as the key.
8309
8310
8311 .section "Special host list patterns" "SECID80"
8312 .cindex "empty item in hosts list"
8313 .cindex "host list" "empty string in"
8314 If a host list item is the empty string, it matches only when no remote host is
8315 involved. This is the case when a message is being received from a local
8316 process using SMTP on the standard input, that is, when a TCP/IP connection is
8317 not used.
8318
8319 .cindex "asterisk" "in host list"
8320 The special pattern &"*"& in a host list matches any host or no host. Neither
8321 the IP address nor the name is actually inspected.
8322
8323
8324
8325 .section "Host list patterns that match by IP address" "SECThoslispatip"
8326 .cindex "host list" "matching IP addresses"
8327 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8328 the incoming address actually appears in the IPv6 host as
8329 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8330 list, it is converted into a traditional IPv4 address first. (Not all operating
8331 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8332 concerns.)
8333
8334 The following types of pattern in a host list check the remote host by
8335 inspecting its IP address:
8336
8337 .ilist
8338 If the pattern is a plain domain name (not a regular expression, not starting
8339 with *, not a lookup of any kind), Exim calls the operating system function
8340 to find the associated IP address(es). Exim uses the newer
8341 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8342 This typically causes a forward DNS lookup of the name. The result is compared
8343 with the IP address of the subject host.
8344
8345 If there is a temporary problem (such as a DNS timeout) with the host name
8346 lookup, a temporary error occurs. For example, if the list is being used in an
8347 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8348 temporary SMTP error code. If no IP address can be found for the host name,
8349 what happens is described in section &<<SECTbehipnot>>& below.
8350
8351 .next
8352 .cindex "@ in a host list"
8353 If the pattern is &"@"&, the primary host name is substituted and used as a
8354 domain name, as just described.
8355
8356 .next
8357 If the pattern is an IP address, it is matched against the IP address of the
8358 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8359 IPv6 addresses can be given in colon-separated format, but the colons have to
8360 be doubled so as not to be taken as item separators when the default list
8361 separator is used. IPv6 addresses are recognized even when Exim is compiled
8362 without IPv6 support. This means that if they appear in a host list on an
8363 IPv4-only host, Exim will not treat them as host names. They are just addresses
8364 that can never match a client host.
8365
8366 .next
8367 .cindex "@[] in a host list"
8368 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8369 the local host. For example, if the local host is an IPv4 host with one
8370 interface address 10.45.23.56, these two ACL statements have the same effect:
8371 .code
8372 accept hosts = 127.0.0.1 : 10.45.23.56
8373 accept hosts = @[]
8374 .endd
8375 .next
8376 .cindex "CIDR notation"
8377 If the pattern is an IP address followed by a slash and a mask length (for
8378 example 10.11.42.0/24), it is matched against the IP address of the subject
8379 host under the given mask. This allows, an entire network of hosts to be
8380 included (or excluded) by a single item. The mask uses CIDR notation; it
8381 specifies the number of address bits that must match, starting from the most
8382 significant end of the address.
8383
8384 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8385 of a range of addresses. It is the number of bits in the network portion of the
8386 address. The above example specifies a 24-bit netmask, so it matches all 256
8387 addresses in the 10.11.42.0 network. An item such as
8388 .code
8389 192.168.23.236/31
8390 .endd
8391 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8392 32 for an IPv4 address is the same as no mask at all; just a single address
8393 matches.
8394
8395 Here is another example which shows an IPv4 and an IPv6 network:
8396 .code
8397 recipient_unqualified_hosts = 192.168.0.0/16: \
8398                               3ffe::ffff::836f::::/48
8399 .endd
8400 The doubling of list separator characters applies only when these items
8401 appear inline in a host list. It is not required when indirecting via a file.
8402 For example:
8403 .code
8404 recipient_unqualified_hosts = /opt/exim/unqualnets
8405 .endd
8406 could make use of a file containing
8407 .code
8408 172.16.0.0/12
8409 3ffe:ffff:836f::/48
8410 .endd
8411 to have exactly the same effect as the previous example. When listing IPv6
8412 addresses inline, it is usually more convenient to use the facility for
8413 changing separator characters. This list contains the same two networks:
8414 .code
8415 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8416                                  3ffe:ffff:836f::/48
8417 .endd
8418 The separator is changed to semicolon by the leading &"<;"& at the start of the
8419 list.
8420 .endlist
8421
8422
8423
8424 .section "Host list patterns for single-key lookups by host address" &&&
8425          "SECThoslispatsikey"
8426 .cindex "host list" "lookup of IP address"
8427 When a host is to be identified by a single-key lookup of its complete IP
8428 address, the pattern takes this form:
8429 .display
8430 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8431 .endd
8432 For example:
8433 .code
8434 hosts_lookup = net-cdb;/hosts-by-ip.db
8435 .endd
8436 The text form of the IP address of the subject host is used as the lookup key.
8437 IPv6 addresses are converted to an unabbreviated form, using lower case
8438 letters, with dots as separators because colon is the key terminator in
8439 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8440 quoting the keys, but this is a facility that was added later.] The data
8441 returned by the lookup is not used.
8442
8443 .cindex "IP address" "masking"
8444 .cindex "host list" "masked IP address"
8445 Single-key lookups can also be performed using masked IP addresses, using
8446 patterns of this form:
8447 .display
8448 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8449 .endd
8450 For example:
8451 .code
8452 net24-dbm;/networks.db
8453 .endd
8454 The IP address of the subject host is masked using <&'number'&> as the mask
8455 length. A textual string is constructed from the masked value, followed by the
8456 mask, and this is used as the lookup key. For example, if the host's IP address
8457 is 192.168.34.6, the key that is looked up for the above example is
8458 &"192.168.34.0/24"&.
8459
8460 When an IPv6 address is converted to a string, dots are normally used instead
8461 of colons, so that keys in &(lsearch)& files need not contain colons (which
8462 terminate &(lsearch)& keys). This was implemented some time before the ability
8463 to quote keys was made available in &(lsearch)& files. However, the more
8464 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8465 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8466 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8467 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8468 addresses are always used.
8469
8470 Ideally, it would be nice to tidy up this anomalous situation by changing to
8471 colons in all cases, given that quoting is now available for &(lsearch)&.
8472 However, this would be an incompatible change that might break some existing
8473 configurations.
8474
8475 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8476 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8477 the former case the key strings include the mask value, whereas in the latter
8478 case the IP address is used on its own.
8479
8480
8481
8482 .section "Host list patterns that match by host name" "SECThoslispatnam"
8483 .cindex "host" "lookup failures"
8484 .cindex "unknown host name"
8485 .cindex "host list" "matching host name"
8486 There are several types of pattern that require Exim to know the name of the
8487 remote host. These are either wildcard patterns or lookups by name. (If a
8488 complete hostname is given without any wildcarding, it is used to find an IP
8489 address to match against, as described in section &<<SECThoslispatip>>&
8490 above.)
8491
8492 If the remote host name is not already known when Exim encounters one of these
8493 patterns, it has to be found from the IP address.
8494 Although many sites on the Internet are conscientious about maintaining reverse
8495 DNS data for their hosts, there are also many that do not do this.
8496 Consequently, a name cannot always be found, and this may lead to unwanted
8497 effects. Take care when configuring host lists with wildcarded name patterns.
8498 Consider what will happen if a name cannot be found.
8499
8500 Because of the problems of determining host names from IP addresses, matching
8501 against host names is not as common as matching against IP addresses.
8502
8503 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8504 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8505 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8506 are done can be changed by setting the &%host_lookup_order%& option. For
8507 security, once Exim has found one or more names, it looks up the IP addresses
8508 for these names and compares them with the IP address that it started with.
8509 Only those names whose IP addresses match are accepted. Any other names are
8510 discarded. If no names are left, Exim behaves as if the host name cannot be
8511 found. In the most common case there is only one name and one IP address.
8512
8513 There are some options that control what happens if a host name cannot be
8514 found. These are described in section &<<SECTbehipnot>>& below.
8515
8516 .cindex "host" "alias for"
8517 .cindex "alias for host"
8518 As a result of aliasing, hosts may have more than one name. When processing any
8519 of the following types of pattern, all the host's names are checked:
8520
8521 .ilist
8522 .cindex "asterisk" "in host list"
8523 If a pattern starts with &"*"& the remainder of the item must match the end of
8524 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8525 &'.b.c'&. This special simple form is provided because this is a very common
8526 requirement. Other kinds of wildcarding require the use of a regular
8527 expression.
8528 .next
8529 .cindex "regular expressions" "in host list"
8530 .cindex "host list" "regular expression in"
8531 If the item starts with &"^"& it is taken to be a regular expression which is
8532 matched against the host name. Host names are case-independent, so this regular
8533 expression match is by default case-independent, but you can make it
8534 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8535 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8536 example,
8537 .code
8538 ^(a|b)\.c\.d$
8539 .endd
8540 is a regular expression that matches either of the two hosts &'a.c.d'& or
8541 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8542 that backslash and dollar characters are not misinterpreted as part of the
8543 string expansion. The simplest way to do this is to use &`\N`& to mark that
8544 part of the string as non-expandable. For example:
8545 .code
8546 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8547 .endd
8548 &*Warning*&: If you want to match a complete host name, you must include the
8549 &`$`& terminating metacharacter in the regular expression, as in the above
8550 example. Without it, a match at the start of the host name is all that is
8551 required.
8552 .endlist
8553
8554
8555
8556
8557 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8558 .cindex "host" "lookup failures, permanent"
8559 While processing a host list, Exim may need to look up an IP address from a
8560 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8561 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8562 behaviour when it fails to find the information it is seeking is the same.
8563
8564 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8565 apply to temporary DNS errors, whose handling is described in the next section.
8566
8567 .cindex "&`+include_unknown`&"
8568 .cindex "&`+ignore_unknown`&"
8569 Exim parses a host list from left to right. If it encounters a permanent
8570 lookup failure in any item in the host list before it has found a match,
8571 Exim treats it as a failure and the default behavior is as if the host
8572 does not match the list. This may not always be what you want to happen.
8573 To change Exim's behaviour, the special items &`+include_unknown`& or
8574 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8575 not recognized in an indirected file).
8576
8577 .ilist
8578 If any item that follows &`+include_unknown`& requires information that
8579 cannot found, Exim behaves as if the host does match the list. For example,
8580 .code
8581 host_reject_connection = +include_unknown:*.enemy.ex
8582 .endd
8583 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8584 any hosts whose name it cannot find.
8585
8586 .next
8587 If any item that follows &`+ignore_unknown`& requires information that cannot
8588 be found, Exim ignores that item and proceeds to the rest of the list. For
8589 example:
8590 .code
8591 accept hosts = +ignore_unknown : friend.example : \
8592                192.168.4.5
8593 .endd
8594 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8595 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8596 name can be found for 192.168.4.5, it is rejected.
8597 .endlist
8598
8599 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8600 list. The effect of each one lasts until the next, or until the end of the
8601 list.
8602
8603 .section "Mixing wildcarded host names and addresses in host lists" &&&
8604          "SECTmixwilhos"
8605 .cindex "host list" "mixing names and addresses in"
8606
8607 This section explains the host/ip processing logic with the same concepts
8608 as the previous section, but specifically addresses what happens when a
8609 wildcarded hostname is one of the items in the hostlist.
8610
8611 .ilist
8612 If you have name lookups or wildcarded host names and
8613 IP addresses in the same host list, you should normally put the IP
8614 addresses first. For example, in an ACL you could have:
8615 .code
8616 accept hosts = 10.9.8.7 : *.friend.example
8617 .endd
8618 The reason you normally would order it this way lies in the
8619 left-to-right way that Exim processes lists.  It can test IP addresses
8620 without doing any DNS lookups, but when it reaches an item that requires
8621 a host name, it fails if it cannot find a host name to compare with the
8622 pattern. If the above list is given in the opposite order, the
8623 &%accept%& statement fails for a host whose name cannot be found, even
8624 if its IP address is 10.9.8.7.
8625
8626 .next
8627 If you really do want to do the name check first, and still recognize the IP
8628 address, you can rewrite the ACL like this:
8629 .code
8630 accept hosts = *.friend.example
8631 accept hosts = 10.9.8.7
8632 .endd
8633 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8634 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8635 &`+ignore_unknown`&, which was discussed in depth in the first example in
8636 this section.
8637 .endlist
8638
8639
8640 .section "Temporary DNS errors when looking up host information" &&&
8641          "SECTtemdnserr"
8642 .cindex "host" "lookup failures, temporary"
8643 .cindex "&`+include_defer`&"
8644 .cindex "&`+ignore_defer`&"
8645 A temporary DNS lookup failure normally causes a defer action (except when
8646 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8647 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8648 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8649 section. These options should be used with care, probably only in non-critical
8650 host lists such as whitelists.
8651
8652
8653
8654 .section "Host list patterns for single-key lookups by host name" &&&
8655          "SECThoslispatnamsk"
8656 .cindex "unknown host name"
8657 .cindex "host list" "matching host name"
8658 If a pattern is of the form
8659 .display
8660 <&'single-key-search-type'&>;<&'search-data'&>
8661 .endd
8662 for example
8663 .code
8664 dbm;/host/accept/list
8665 .endd
8666 a single-key lookup is performed, using the host name as its key. If the
8667 lookup succeeds, the host matches the item. The actual data that is looked up
8668 is not used.
8669
8670 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8671 keys in the file, not IP addresses. If you want to do lookups based on IP
8672 addresses, you must precede the search type with &"net-"& (see section
8673 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8674 two items in the same list, one doing an address lookup and one doing a name
8675 lookup, both using the same file.
8676
8677
8678
8679 .section "Host list patterns for query-style lookups" "SECID81"
8680 If a pattern is of the form
8681 .display
8682 <&'query-style-search-type'&>;<&'query'&>
8683 .endd
8684 the query is obeyed, and if it succeeds, the host matches the item. The actual
8685 data that is looked up is not used. The variables &$sender_host_address$& and
8686 &$sender_host_name$& can be used in the query. For example:
8687 .code
8688 hosts_lookup = pgsql;\
8689   select ip from hostlist where ip='$sender_host_address'
8690 .endd
8691 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8692 can use the &%sg%& expansion item to change this if you need to. If you want to
8693 use masked IP addresses in database queries, you can use the &%mask%& expansion
8694 operator.
8695
8696 If the query contains a reference to &$sender_host_name$&, Exim automatically
8697 looks up the host name if it has not already done so. (See section
8698 &<<SECThoslispatnam>>& for comments on finding host names.)
8699
8700 Historical note: prior to release 4.30, Exim would always attempt to find a
8701 host name before running the query, unless the search type was preceded by
8702 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8703 still recognized for query-style lookups, but its presence or absence has no
8704 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8705 See section &<<SECThoslispatsikey>>&.)
8706
8707
8708
8709
8710
8711 .section "Address lists" "SECTaddresslist"
8712 .cindex "list" "address list"
8713 .cindex "address list" "empty item"
8714 .cindex "address list" "patterns"
8715 Address lists contain patterns that are matched against mail addresses. There
8716 is one special case to be considered: the sender address of a bounce message is
8717 always empty. You can test for this by providing an empty item in an address
8718 list. For example, you can set up a router to process bounce messages by
8719 using this option setting:
8720 .code
8721 senders = :
8722 .endd
8723 The presence of the colon creates an empty item. If you do not provide any
8724 data, the list is empty and matches nothing. The empty sender can also be
8725 detected by a regular expression that matches an empty string,
8726 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8727
8728 Non-empty items in an address list can be straightforward email addresses. For
8729 example:
8730 .code
8731 senders = jbc@askone.example : hs@anacreon.example
8732 .endd
8733 A certain amount of wildcarding is permitted. If a pattern contains an @
8734 character, but is not a regular expression and does not begin with a
8735 semicolon-terminated lookup type (described below), the local part of the
8736 subject address is compared with the local part of the pattern, which may start
8737 with an asterisk. If the local parts match, the domain is checked in exactly
8738 the same way as for a pattern in a domain list. For example, the domain can be
8739 wildcarded, refer to a named list, or be a lookup:
8740 .code
8741 deny senders = *@*.spamming.site:\
8742                *@+hostile_domains:\
8743                bozo@partial-lsearch;/list/of/dodgy/sites:\
8744                *@dbm;/bad/domains.db
8745 .endd
8746 .cindex "local part" "starting with !"
8747 .cindex "address list" "local part starting with !"
8748 If a local part that begins with an exclamation mark is required, it has to be
8749 specified using a regular expression, because otherwise the exclamation mark is
8750 treated as a sign of negation, as is standard in lists.
8751
8752 If a non-empty pattern that is not a regular expression or a lookup does not
8753 contain an @ character, it is matched against the domain part of the subject
8754 address. The only two formats that are recognized this way are a literal
8755 domain, or a domain pattern that starts with *. In both these cases, the effect
8756 is the same as if &`*@`& preceded the pattern. For example:
8757 .code
8758 deny senders = enemy.domain : *.enemy.domain
8759 .endd
8760
8761 The following kinds of more complicated address list pattern can match any
8762 address, including the empty address that is characteristic of bounce message
8763 senders:
8764
8765 .ilist
8766 .cindex "regular expressions" "in address list"
8767 .cindex "address list" "regular expression in"
8768 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8769 done against the complete address, with the pattern as the regular expression.
8770 You must take care that backslash and dollar characters are not misinterpreted
8771 as part of the string expansion. The simplest way to do this is to use &`\N`&
8772 to mark that part of the string as non-expandable. For example:
8773 .code
8774 deny senders = \N^.*this.*@example\.com$\N : \
8775                \N^\d{8}.+@spamhaus.example$\N : ...
8776 .endd
8777 The &`\N`& sequences are removed by the expansion, so these items do indeed
8778 start with &"^"& by the time they are being interpreted as address patterns.
8779
8780 .next
8781 .cindex "address list" "lookup for complete address"
8782 Complete addresses can be looked up by using a pattern that starts with a
8783 lookup type terminated by a semicolon, followed by the data for the lookup. For
8784 example:
8785 .code
8786 deny senders = cdb;/etc/blocked.senders : \
8787   mysql;select address from blocked where \
8788   address='${quote_mysql:$sender_address}'
8789 .endd
8790 Both query-style and single-key lookup types can be used. For a single-key
8791 lookup type, Exim uses the complete address as the key. However, empty keys are
8792 not supported for single-key lookups, so a match against the empty address
8793 always fails. This restriction does not apply to query-style lookups.
8794
8795 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8796 cannot be used, and is ignored if specified, with an entry being written to the
8797 panic log.
8798 .cindex "*@ with single-key lookup"
8799 However, you can configure lookup defaults, as described in section
8800 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8801 default. For example, with this lookup:
8802 .code
8803 accept senders = lsearch*@;/some/file
8804 .endd
8805 the file could contains lines like this:
8806 .code
8807 user1@domain1.example
8808 *@domain2.example
8809 .endd
8810 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8811 that are tried is:
8812 .code
8813 nimrod@jaeger.example
8814 *@jaeger.example
8815 *
8816 .endd
8817 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8818 would mean that every address matches, thus rendering the test useless.
8819
8820 &*Warning 2*&: Do not confuse these two kinds of item:
8821 .code
8822 deny recipients = dbm*@;/some/file
8823 deny recipients = *@dbm;/some/file
8824 .endd
8825 The first does a whole address lookup, with defaulting, as just described,
8826 because it starts with a lookup type. The second matches the local part and
8827 domain independently, as described in a bullet point below.
8828 .endlist
8829
8830
8831 The following kinds of address list pattern can match only non-empty addresses.
8832 If the subject address is empty, a match against any of these pattern types
8833 always fails.
8834
8835
8836 .ilist
8837 .cindex "@@ with single-key lookup"
8838 .cindex "address list" "@@ lookup type"
8839 .cindex "address list" "split local part and domain"
8840 If a pattern starts with &"@@"& followed by a single-key lookup item
8841 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8842 split into a local part and a domain. The domain is looked up in the file. If
8843 it is not found, there is no match. If it is found, the data that is looked up
8844 from the file is treated as a colon-separated list of local part patterns, each
8845 of which is matched against the subject local part in turn.
8846
8847 .cindex "asterisk" "in address list"
8848 The lookup may be a partial one, and/or one involving a search for a default
8849 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8850 patterns that are looked up can be regular expressions or begin with &"*"&, or
8851 even be further lookups. They may also be independently negated. For example,
8852 with
8853 .code
8854 deny senders = @@dbm;/etc/reject-by-domain
8855 .endd
8856 the data from which the DBM file is built could contain lines like
8857 .code
8858 baddomain.com:  !postmaster : *
8859 .endd
8860 to reject all senders except &%postmaster%& from that domain.
8861
8862 .cindex "local part" "starting with !"
8863 If a local part that actually begins with an exclamation mark is required, it
8864 has to be specified using a regular expression. In &(lsearch)& files, an entry
8865 may be split over several lines by indenting the second and subsequent lines,
8866 but the separating colon must still be included at line breaks. White space
8867 surrounding the colons is ignored. For example:
8868 .code
8869 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8870   spammer3 : spammer4
8871 .endd
8872 As in all colon-separated lists in Exim, a colon can be included in an item by
8873 doubling.
8874
8875 If the last item in the list starts with a right angle-bracket, the remainder
8876 of the item is taken as a new key to look up in order to obtain a continuation
8877 list of local parts. The new key can be any sequence of characters. Thus one
8878 might have entries like
8879 .code
8880 aol.com: spammer1 : spammer 2 : >*
8881 xyz.com: spammer3 : >*
8882 *:       ^\d{8}$
8883 .endd
8884 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8885 local parts for all domains, in addition to the specific local parts listed for
8886 each domain. Of course, using this feature costs another lookup each time a
8887 chain is followed, but the effort needed to maintain the data is reduced.
8888
8889 .cindex "loop" "in lookups"
8890 It is possible to construct loops using this facility, and in order to catch
8891 them, the chains may be no more than fifty items long.
8892
8893 .next
8894 The @@<&'lookup'&> style of item can also be used with a query-style
8895 lookup, but in this case, the chaining facility is not available. The lookup
8896 can only return a single list of local parts.
8897 .endlist
8898
8899 &*Warning*&: There is an important difference between the address list items
8900 in these two examples:
8901 .code
8902 senders = +my_list
8903 senders = *@+my_list
8904 .endd
8905 In the first one, &`my_list`& is a named address list, whereas in the second
8906 example it is a named domain list.
8907
8908
8909
8910
8911 .section "Case of letters in address lists" "SECTcasletadd"
8912 .cindex "case of local parts"
8913 .cindex "address list" "case forcing"
8914 .cindex "case forcing in address lists"
8915 Domains in email addresses are always handled caselessly, but for local parts
8916 case may be significant on some systems (see &%caseful_local_part%& for how
8917 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8918 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8919 blocking lists should be done in a case-independent manner. Since most address
8920 lists in Exim are used for this kind of control, Exim attempts to do this by
8921 default.
8922
8923 The domain portion of an address is always lowercased before matching it to an
8924 address list. The local part is lowercased by default, and any string
8925 comparisons that take place are done caselessly. This means that the data in
8926 the address list itself, in files included as plain file names, and in any file
8927 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8928 keys in files that are looked up by a search type other than &(lsearch)& (which
8929 works caselessly) must be in lower case, because these lookups are not
8930 case-independent.
8931
8932 .cindex "&`+caseful`&"
8933 To allow for the possibility of caseful address list matching, if an item in
8934 an address list is the string &"+caseful"&, the original case of the local
8935 part is restored for any comparisons that follow, and string comparisons are no
8936 longer case-independent. This does not affect the domain, which remains in
8937 lower case. However, although independent matches on the domain alone are still
8938 performed caselessly, regular expressions that match against an entire address
8939 become case-sensitive after &"+caseful"& has been seen.
8940
8941
8942
8943 .section "Local part lists" "SECTlocparlis"
8944 .cindex "list" "local part list"
8945 .cindex "local part" "list"
8946 Case-sensitivity in local part lists is handled in the same way as for address
8947 lists, as just described. The &"+caseful"& item can be used if required. In a
8948 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8949 set false, the subject is lowercased and the matching is initially
8950 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8951 matching in the local part list, but not elsewhere in the router. If
8952 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8953 option is case-sensitive from the start.
8954
8955 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8956 comments are handled in the same way as address lists &-- they are recognized
8957 only if the # is preceded by white space or the start of the line.
8958 Otherwise, local part lists are matched in the same way as domain lists, except
8959 that the special items that refer to the local host (&`@`&, &`@[]`&,
8960 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8961 Refer to section &<<SECTdomainlist>>& for details of the other available item
8962 types.
8963 .ecindex IIDdohoadli
8964
8965
8966
8967
8968 . ////////////////////////////////////////////////////////////////////////////
8969 . ////////////////////////////////////////////////////////////////////////////
8970
8971 .chapter "String expansions" "CHAPexpand"
8972 .scindex IIDstrexp "expansion" "of strings"
8973 Many strings in Exim's run time configuration are expanded before use. Some of
8974 them are expanded every time they are used; others are expanded only once.
8975
8976 When a string is being expanded it is copied verbatim from left to right except
8977 when a dollar or backslash character is encountered. A dollar specifies the
8978 start of a portion of the string that is interpreted and replaced as described
8979 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8980 escape character, as described in the following section.
8981
8982 Whether a string is expanded depends upon the context.  Usually this is solely
8983 dependent upon the option for which a value is sought; in this documentation,
8984 options for which string expansion is performed are marked with &dagger; after
8985 the data type.  ACL rules always expand strings.  A couple of expansion
8986 conditions do not expand some of the brace-delimited branches, for security
8987 reasons.
8988
8989
8990
8991 .section "Literal text in expanded strings" "SECTlittext"
8992 .cindex "expansion" "including literal text"
8993 An uninterpreted dollar can be included in an expanded string by putting a
8994 backslash in front of it. A backslash can be used to prevent any special
8995 character being treated specially in an expansion, including backslash itself.
8996 If the string appears in quotes in the configuration file, two backslashes are
8997 required because the quotes themselves cause interpretation of backslashes when
8998 the string is read in (see section &<<SECTstrings>>&).
8999
9000 .cindex "expansion" "non-expandable substrings"
9001 A portion of the string can specified as non-expandable by placing it between
9002 two occurrences of &`\N`&. This is particularly useful for protecting regular
9003 expressions, which often contain backslashes and dollar signs. For example:
9004 .code
9005 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9006 .endd
9007 On encountering the first &`\N`&, the expander copies subsequent characters
9008 without interpretation until it reaches the next &`\N`& or the end of the
9009 string.
9010
9011
9012
9013 .section "Character escape sequences in expanded strings" "SECID82"
9014 .cindex "expansion" "escape sequences"
9015 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9016 expanded string is recognized as an escape sequence for the character newline,
9017 carriage return, or tab, respectively. A backslash followed by up to three
9018 octal digits is recognized as an octal encoding for a single character, and a
9019 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9020 encoding.
9021
9022 These escape sequences are also recognized in quoted strings when they are read
9023 in. Their interpretation in expansions as well is useful for unquoted strings,
9024 and for other cases such as looked-up strings that are then expanded.
9025
9026
9027 .section "Testing string expansions" "SECID83"
9028 .cindex "expansion" "testing"
9029 .cindex "testing" "string expansion"
9030 .oindex "&%-be%&"
9031 Many expansions can be tested by calling Exim with the &%-be%& option. This
9032 takes the command arguments, or lines from the standard input if there are no
9033 arguments, runs them through the string expansion code, and writes the results
9034 to the standard output. Variables based on configuration values are set up, but
9035 since no message is being processed, variables such as &$local_part$& have no
9036 value. Nevertheless the &%-be%& option can be useful for checking out file and
9037 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9038 and &%nhash%&.
9039
9040 Exim gives up its root privilege when it is called with the &%-be%& option, and
9041 instead runs under the uid and gid it was called with, to prevent users from
9042 using &%-be%& for reading files to which they do not have access.
9043
9044 .oindex "&%-bem%&"
9045 If you want to test expansions that include variables whose values are taken
9046 from a message, there are two other options that can be used. The &%-bem%&
9047 option is like &%-be%& except that it is followed by a file name. The file is
9048 read as a message before doing the test expansions. For example:
9049 .code
9050 exim -bem /tmp/test.message '$h_subject:'
9051 .endd
9052 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9053 Exim message identifier. For example:
9054 .code
9055 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9056 .endd
9057 This loads the message from Exim's spool before doing the test expansions, and
9058 is therefore restricted to admin users.
9059
9060
9061 .section "Forced expansion failure" "SECTforexpfai"
9062 .cindex "expansion" "forced failure"
9063 A number of expansions that are described in the following section have
9064 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9065 (which are sometimes called &"curly brackets"&). Which of the two strings is
9066 used depends on some condition that is evaluated as part of the expansion. If,
9067 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9068 the entire string expansion fails in a way that can be detected by the code
9069 that requested the expansion. This is called &"forced expansion failure"&, and
9070 its consequences depend on the circumstances. In some cases it is no different
9071 from any other expansion failure, but in others a different action may be
9072 taken. Such variations are mentioned in the documentation of the option that is
9073 being expanded.
9074
9075
9076
9077
9078 .section "Expansion items" "SECTexpansionitems"
9079 The following items are recognized in expanded strings. White space may be used
9080 between sub-items that are keywords or substrings enclosed in braces inside an
9081 outer set of braces, to improve readability. &*Warning*&: Within braces,
9082 white space is significant.
9083
9084 .vlist
9085 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9086 .cindex "expansion" "variables"
9087 Substitute the contents of the named variable, for example:
9088 .code
9089 $local_part
9090 ${domain}
9091 .endd
9092 The second form can be used to separate the name from subsequent alphanumeric
9093 characters. This form (using braces) is available only for variables; it does
9094 &'not'& apply to message headers. The names of the variables are given in
9095 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9096 given, the expansion fails.
9097
9098 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9099 .cindex "expansion" "operators"
9100 The string is first itself expanded, and then the operation specified by
9101 <&'op'&> is applied to it. For example:
9102 .code
9103 ${lc:$local_part}
9104 .endd
9105 The string starts with the first character after the colon, which may be
9106 leading white space. A list of operators is given in section &<<SECTexpop>>&
9107 below. The operator notation is used for simple expansion items that have just
9108 one argument, because it reduces the number of braces and therefore makes the
9109 string easier to understand.
9110
9111 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9112 This item inserts &"basic"& header lines. It is described with the &%header%&
9113 expansion item below.
9114
9115
9116 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9117 .cindex "expansion" "calling an acl"
9118 .cindex "&%acl%&" "call from expansion"
9119 The name and zero to nine argument strings are first expanded separately.  The expanded
9120 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9121 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9122 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9123 and may use the variables; if another acl expansion is used the values
9124 are restored after it returns.  If the ACL sets
9125 a value using a "message =" modifier and returns accept or deny, the value becomes
9126 the result of the expansion.
9127 If no message is set and the ACL returns accept or deny
9128 the expansion result is an empty string.
9129 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9130
9131
9132 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9133        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9134 .cindex "expansion" "extracting certificate fields"
9135 .cindex "&%certextract%&" "certificate fields"
9136 .cindex "certificate" "extracting fields"
9137 The <&'certificate'&> must be a variable of type certificate.
9138 The field name is expanded and used to retrieve the relevant field from
9139 the certificate.  Supported fields are:
9140 .display
9141 &`version        `&
9142 &`serial_number  `&
9143 &`subject        `& RFC4514 DN
9144 &`issuer         `& RFC4514 DN
9145 &`notbefore      `& time
9146 &`notafter       `& time
9147 &`sig_algorithm  `&
9148 &`signature      `&
9149 &`subj_altname   `& tagged list
9150 &`ocsp_uri       `& list
9151 &`crl_uri        `& list
9152 .endd
9153 If the field is found,
9154 <&'string2'&> is expanded, and replaces the whole item;
9155 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9156 variable &$value$& contains the value that has been extracted. Afterwards, it
9157 is restored to any previous value it might have had.
9158
9159 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9160 key is not found. If {<&'string2'&>} is also omitted, the value that was
9161 extracted is used.
9162
9163 Some field names take optional modifiers, appended and separated by commas.
9164
9165 The field selectors marked as "RFC4514" above
9166 output a Distinguished Name string which is
9167 not quite
9168 parseable by Exim as a comma-separated tagged list
9169 (the exceptions being elements containing commas).
9170 RDN elements of a single type may be selected by
9171 a modifier of the type label; if so the expansion
9172 result is a list (newline-separated by default).
9173 The separator may be changed by another modifier of
9174 a right angle-bracket followed immediately by the new separator.
9175 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9176
9177 The field selectors marked as "time" above
9178 take an optional modifier of "int"
9179 for which the result is the number of seconds since epoch.
9180 Otherwise the result is a human-readable string
9181 in the timezone selected by the main "timezone" option.
9182
9183 The field selectors marked as "list" above return a list,
9184 newline-separated by default,
9185 (embedded separator characters in elements are doubled).
9186 The separator may be changed by a modifier of
9187 a right angle-bracket followed immediately by the new separator.
9188
9189 The field selectors marked as "tagged" above
9190 prefix each list element with a type string and an equals sign.
9191 Elements of only one type may be selected by a modifier
9192 which is one of "dns", "uri" or "mail";
9193 if so the element tags are omitted.
9194
9195 If not otherwise noted field values are presented in human-readable form.
9196
9197 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9198        {*&<&'arg'&>&*}...}*&"
9199 .cindex &%dlfunc%&
9200 This expansion dynamically loads and then calls a locally-written C function.
9201 This functionality is available only if Exim is compiled with
9202 .code
9203 EXPAND_DLFUNC=yes
9204 .endd
9205 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9206 object so that it doesn't reload the same object file in the same Exim process
9207 (but of course Exim does start new processes frequently).
9208
9209 There may be from zero to eight arguments to the function. When compiling
9210 a local function that is to be called in this way, &_local_scan.h_& should be
9211 included. The Exim variables and functions that are defined by that API
9212 are also available for dynamically loaded functions. The function itself
9213 must have the following type:
9214 .code
9215 int dlfunction(uschar **yield, int argc, uschar *argv[])
9216 .endd
9217 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9218 function should return one of the following values:
9219
9220 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9221 into the expanded string that is being built.
9222
9223 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9224 from &'yield'&, if it is set.
9225
9226 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9227 taken from &'yield'& if it is set.
9228
9229 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9230
9231 When compiling a function that is to be used in this way with gcc,
9232 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9233 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9234
9235
9236 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9237 .cindex "expansion" "extracting value from environment"
9238 .cindex "environment" "values from"
9239 The key is first expanded separately, and leading and trailing white space
9240 removed.
9241 This is then searched for as a name in the environment.
9242 If a variable is found then its value is placed in &$value$&
9243 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9244
9245 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9246 appear, for example:
9247 .code
9248 ${env{USER}{$value} fail }
9249 .endd
9250 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9251 {<&'string1'&>} must be present for &"fail"& to be recognized.
9252
9253 If {<&'string2'&>} is omitted an empty string is substituted on
9254 search failure.
9255 If {<&'string1'&>} is omitted the search result is substituted on
9256 search success.
9257
9258 The environment is adjusted by the &%keep_environment%& and
9259 &%add_environment%& main section options.
9260
9261
9262 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9263        {*&<&'string3'&>&*}}*&"
9264 .cindex "expansion" "extracting substrings by key"
9265 .cindex "&%extract%&" "substrings by key"
9266 The key and <&'string1'&> are first expanded separately. Leading and trailing
9267 white space is removed from the key (but not from any of the strings). The key
9268 must not be empty and must not consist entirely of digits.
9269 The expanded <&'string1'&> must be of the form:
9270 .display
9271 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9272 .endd
9273 .vindex "&$value$&"
9274 where the equals signs and spaces (but not both) are optional. If any of the
9275 values contain white space, they must be enclosed in double quotes, and any
9276 values that are enclosed in double quotes are subject to escape processing as
9277 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9278 for the value that corresponds to the key. The search is case-insensitive. If
9279 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9280 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9281 variable &$value$& contains the value that has been extracted. Afterwards, it
9282 is restored to any previous value it might have had.
9283
9284 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9285 key is not found. If {<&'string2'&>} is also omitted, the value that was
9286 extracted is used. Thus, for example, these two expansions are identical, and
9287 yield &"2001"&:
9288 .code
9289 ${extract{gid}{uid=1984 gid=2001}}
9290 ${extract{gid}{uid=1984 gid=2001}{$value}}
9291 .endd
9292 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9293 appear, for example:
9294 .code
9295 ${extract{Z}{A=... B=...}{$value} fail }
9296 .endd
9297 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9298 {<&'string2'&>} must be present for &"fail"& to be recognized.
9299
9300
9301 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9302         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9303 .cindex "expansion" "extracting substrings by number"
9304 .cindex "&%extract%&" "substrings by number"
9305 The <&'number'&> argument must consist entirely of decimal digits,
9306 apart from leading and trailing white space, which is ignored.
9307 This is what distinguishes this form of &%extract%& from the previous kind. It
9308 behaves in the same way, except that, instead of extracting a named field, it
9309 extracts from <&'string1'&> the field whose number is given as the first
9310 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9311 <&'string3'&> as before.
9312
9313 The fields in the string are separated by any one of the characters in the
9314 separator string. These may include space or tab characters.
9315 The first field is numbered one. If the number is negative, the fields are
9316 counted from the end of the string, with the rightmost one numbered -1. If the
9317 number given is zero, the entire string is returned. If the modulus of the
9318 number is greater than the number of fields in the string, the result is the
9319 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9320 provided. For example:
9321 .code
9322 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9323 .endd
9324 yields &"42"&, and
9325 .code
9326 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9327 .endd
9328 yields &"99"&. Two successive separators mean that the field between them is
9329 empty (for example, the fifth field above).
9330
9331
9332 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9333 .cindex "list" "selecting by condition"
9334 .cindex "expansion" "selecting from list by condition"
9335 .vindex "&$item$&"
9336 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9337 default, but the separator can be changed in the usual way. For each item
9338 in this list, its value is place in &$item$&, and then the condition is
9339 evaluated. If the condition is true, &$item$& is added to the output as an
9340 item in a new list; if the condition is false, the item is discarded. The
9341 separator used for the output list is the same as the one used for the
9342 input, but a separator setting is not included in the output. For example:
9343 .code
9344 ${filter{a:b:c}{!eq{$item}{b}}
9345 .endd
9346 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9347 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9348
9349
9350 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9351 .cindex "hash function" "textual"
9352 .cindex "expansion" "textual hash"
9353 This is a textual hashing function, and was the first to be implemented in
9354 early versions of Exim. In current releases, there are other hashing functions
9355 (numeric, MD5, and SHA-1), which are described below.
9356
9357 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9358 <&'n'&>. If you are using fixed values for these numbers, that is, if
9359 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9360 use the simpler operator notation that avoids some of the braces:
9361 .code
9362 ${hash_<n>_<m>:<string>}
9363 .endd
9364 The second number is optional (in both notations). If <&'n'&> is greater than
9365 or equal to the length of the string, the expansion item returns the string.
9366 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9367 function to the string. The new string consists of characters taken from the
9368 first <&'m'&> characters of the string
9369 .code
9370 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9371 .endd
9372 If <&'m'&> is not present the value 26 is used, so that only lower case
9373 letters appear. For example:
9374 .display
9375 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9376 &`$hash{5}{monty}}           `&   yields  &`monty`&
9377 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9378 .endd
9379
9380 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9381         &*$h_*&<&'header&~name'&>&*:*&" &&&
9382        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9383         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9384        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9385         &*$rh_*&<&'header&~name'&>&*:*&"
9386 .cindex "expansion" "header insertion"
9387 .vindex "&$header_$&"
9388 .vindex "&$bheader_$&"
9389 .vindex "&$rheader_$&"
9390 .cindex "header lines" "in expansion strings"
9391 .cindex "header lines" "character sets"
9392 .cindex "header lines" "decoding"
9393 Substitute the contents of the named message header line, for example
9394 .code
9395 $header_reply-to:
9396 .endd
9397 The newline that terminates a header line is not included in the expansion, but
9398 internal newlines (caused by splitting the header line over several physical
9399 lines) may be present.
9400
9401 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9402 the data in the header line is interpreted.
9403
9404 .ilist
9405 .cindex "white space" "in header lines"
9406 &%rheader%& gives the original &"raw"& content of the header line, with no
9407 processing at all, and without the removal of leading and trailing white space.
9408
9409 .next
9410 .cindex "base64 encoding" "in header lines"
9411 &%bheader%& removes leading and trailing white space, and then decodes base64
9412 or quoted-printable MIME &"words"& within the header text, but does no
9413 character set translation. If decoding of what looks superficially like a MIME
9414 &"word"& fails, the raw string is returned. If decoding
9415 .cindex "binary zero" "in header line"
9416 produces a binary zero character, it is replaced by a question mark &-- this is
9417 what Exim does for binary zeros that are actually received in header lines.
9418
9419 .next
9420 &%header%& tries to translate the string as decoded by &%bheader%& to a
9421 standard character set. This is an attempt to produce the same string as would
9422 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9423 returned. Translation is attempted only on operating systems that support the
9424 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9425 a system Makefile or in &_Local/Makefile_&.
9426 .endlist ilist
9427
9428 In a filter file, the target character set for &%header%& can be specified by a
9429 command of the following form:
9430 .code
9431 headers charset "UTF-8"
9432 .endd
9433 This command affects all references to &$h_$& (or &$header_$&) expansions in
9434 subsequently obeyed filter commands. In the absence of this command, the target
9435 character set in a filter is taken from the setting of the &%headers_charset%&
9436 option in the runtime configuration. The value of this option defaults to the
9437 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9438 ISO-8859-1.
9439
9440 Header names follow the syntax of RFC 2822, which states that they may contain
9441 any printing characters except space and colon. Consequently, curly brackets
9442 &'do not'& terminate header names, and should not be used to enclose them as
9443 if they were variables. Attempting to do so causes a syntax error.
9444
9445 Only header lines that are common to all copies of a message are visible to
9446 this mechanism. These are the original header lines that are received with the
9447 message, and any that are added by an ACL statement or by a system
9448 filter. Header lines that are added to a particular copy of a message by a
9449 router or transport are not accessible.
9450
9451 For incoming SMTP messages, no header lines are visible in
9452 ACLs that are obeyed before the data phase completes,
9453 because the header structure is not set up until the message is received.
9454 They are visible in DKIM, PRDR and DATA ACLs.
9455 Header lines that are added in a RCPT ACL (for example)
9456 are saved until the message's incoming header lines are available, at which
9457 point they are added.
9458 When any of the above ACLs ar
9459 running, however, header lines added by earlier ACLs are visible.
9460
9461 Upper case and lower case letters are synonymous in header names. If the
9462 following character is white space, the terminating colon may be omitted, but
9463 this is not recommended, because you may then forget it when it is needed. When
9464 white space terminates the header name, this white space is included in the
9465 expanded string.  If the message does not contain the given header, the
9466 expansion item is replaced by an empty string. (See the &%def%& condition in
9467 section &<<SECTexpcond>>& for a means of testing for the existence of a
9468 header.)
9469
9470 If there is more than one header with the same name, they are all concatenated
9471 to form the substitution string, up to a maximum length of 64K. Unless
9472 &%rheader%& is being used, leading and trailing white space is removed from
9473 each header before concatenation, and a completely empty header is ignored. A
9474 newline character is then inserted between non-empty headers, but there is no
9475 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9476 those headers that contain lists of addresses, a comma is also inserted at the
9477 junctions between headers. This does not happen for the &%rheader%& expansion.
9478
9479
9480 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9481 .cindex "expansion" "hmac hashing"
9482 .cindex &%hmac%&
9483 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9484 shared secret and some text into a message authentication code, as specified in
9485 RFC 2104. This differs from &`${md5:secret_text...}`& or
9486 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9487 cryptographic hash, allowing for authentication that is not possible with MD5
9488 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9489 present. For example:
9490 .code
9491 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9492 .endd
9493 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9494 produces:
9495 .code
9496 dd97e3ba5d1a61b5006108f8c8252953
9497 .endd
9498 As an example of how this might be used, you might put in the main part of
9499 an Exim configuration:
9500 .code
9501 SPAMSCAN_SECRET=cohgheeLei2thahw
9502 .endd
9503 In a router or a transport you could then have:
9504 .code
9505 headers_add = \
9506   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9507   ${hmac{md5}{SPAMSCAN_SECRET}\
9508   {${primary_hostname},${message_exim_id},$h_message-id:}}
9509 .endd
9510 Then given a message, you can check where it was scanned by looking at the
9511 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9512 this header line is authentic by recomputing the authentication code from the
9513 host name, message ID and the &'Message-id:'& header line. This can be done
9514 using Exim's &%-be%& option, or by other means, for example by using the
9515 &'hmac_md5_hex()'& function in Perl.
9516
9517
9518 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9519 .cindex "expansion" "conditional"
9520 .cindex "&%if%&, expansion item"
9521 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9522 item; otherwise <&'string2'&> is used. The available conditions are described
9523 in section &<<SECTexpcond>>& below. For example:
9524 .code
9525 ${if eq {$local_part}{postmaster} {yes}{no} }
9526 .endd
9527 The second string need not be present; if it is not and the condition is not
9528 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9529 be present instead of the second string (without any curly brackets). In this
9530 case, the expansion is forced to fail if the condition is not true (see section
9531 &<<SECTforexpfai>>&).
9532
9533 If both strings are omitted, the result is the string &`true`& if the condition
9534 is true, and the empty string if the condition is false. This makes it less
9535 cumbersome to write custom ACL and router conditions. For example, instead of
9536 .code
9537 condition = ${if >{$acl_m4}{3}{true}{false}}
9538 .endd
9539 you can use
9540 .code
9541 condition = ${if >{$acl_m4}{3}}
9542 .endd
9543
9544
9545
9546 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9547 .cindex expansion "imap folder"
9548 .cindex "&%imapfolder%& expansion item"
9549 This item converts a (possibly multilevel, or with non-ASCII characters)
9550 folder specification to a Maildir name for filesystem use.
9551 For information on internationalisation support see &<<SECTi18nMDA>>&.
9552
9553
9554
9555 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9556 .cindex "expansion" "string truncation"
9557 .cindex "&%length%& expansion item"
9558 The &%length%& item is used to extract the initial portion of a string. Both
9559 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9560 you are using a fixed value for the number, that is, if <&'string1'&> does not
9561 change when expanded, you can use the simpler operator notation that avoids
9562 some of the braces:
9563 .code
9564 ${length_<n>:<string>}
9565 .endd
9566 The result of this item is either the first <&'n'&> characters or the whole
9567 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9568 &%strlen%&, which gives the length of a string.
9569
9570
9571 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9572         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9573 .cindex "expansion" "extracting list elements by number"
9574 .cindex "&%listextract%&" "extract list elements by number"
9575 .cindex "list" "extracting elements by number"
9576 The <&'number'&> argument must consist entirely of decimal digits,
9577 apart from an optional leading minus,
9578 and leading and trailing white space (which is ignored).
9579
9580 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9581 default, but the separator can be changed in the usual way.
9582
9583 The first field of the list is numbered one.
9584 If the number is negative, the fields are
9585 counted from the end of the list, with the rightmost one numbered -1.
9586 The numbered element of the list is extracted and placed in &$value$&,
9587 then <&'string2'&> is expanded as the result.
9588
9589 If the modulus of the
9590 number is zero or greater than the number of fields in the string,
9591 the result is the expansion of <&'string3'&>.
9592
9593 For example:
9594 .code
9595 ${listextract{2}{x:42:99}}
9596 .endd
9597 yields &"42"&, and
9598 .code
9599 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9600 .endd
9601 yields &"result: 42"&.
9602
9603 If {<&'string3'&>} is omitted, an empty string is used for string3.
9604 If {<&'string2'&>} is also omitted, the value that was
9605 extracted is used.
9606 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9607
9608
9609 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9610         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9611 This is the first of one of two different types of lookup item, which are both
9612 described in the next item.
9613
9614 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9615         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9616 .cindex "expansion" "lookup in"
9617 .cindex "file" "lookups"
9618 .cindex "lookup" "in expanded string"
9619 The two forms of lookup item specify data lookups in files and databases, as
9620 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9621 lookups, and the second is used for query-style lookups. The <&'key'&>,
9622 <&'file'&>, and <&'query'&> strings are expanded before use.
9623
9624 If there is any white space in a lookup item which is part of a filter command,
9625 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9626 other place where white space is significant, the lookup item must be enclosed
9627 in double quotes. The use of data lookups in users' filter files may be locked
9628 out by the system administrator.
9629
9630 .vindex "&$value$&"
9631 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9632 During its expansion, the variable &$value$& contains the data returned by the
9633 lookup. Afterwards it reverts to the value it had previously (at the outer
9634 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9635 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9636 string on failure. If <&'string2'&> is provided, it can itself be a nested
9637 lookup, thus providing a mechanism for looking up a default value when the
9638 original lookup fails.
9639
9640 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9641 data for the outer lookup while the parameters of the second lookup are
9642 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9643 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9644 appear, and in this case, if the lookup fails, the entire expansion is forced
9645 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9646 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9647 successful lookup, and nothing in the case of failure.
9648
9649 For single-key lookups, the string &"partial"& is permitted to precede the
9650 search type in order to do partial matching, and * or *@ may follow a search
9651 type to request default lookups if the key does not match (see sections
9652 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9653
9654 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9655 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9656 and non-wild parts of the key during the expansion of the replacement text.
9657 They return to their previous values at the end of the lookup item.
9658
9659 This example looks up the postmaster alias in the conventional alias file:
9660 .code
9661 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9662 .endd
9663 This example uses NIS+ to look up the full name of the user corresponding to
9664 the local part of an address, forcing the expansion to fail if it is not found:
9665 .code
9666 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9667   {$value}fail}
9668 .endd
9669
9670
9671 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9672 .cindex "expansion" "list creation"
9673 .vindex "&$item$&"
9674 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9675 default, but the separator can be changed in the usual way. For each item
9676 in this list, its value is place in &$item$&, and then <&'string2'&> is
9677 expanded and added to the output as an item in a new list. The separator used
9678 for the output list is the same as the one used for the input, but a separator
9679 setting is not included in the output. For example:
9680 .code
9681 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9682 .endd
9683 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9684 value of &$item$& is restored to what it was before. See also the &*filter*&
9685 and &*reduce*& expansion items.
9686
9687 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9688 .cindex "expansion" "numeric hash"
9689 .cindex "hash function" "numeric"
9690 The three strings are expanded; the first two must yield numbers. Call them
9691 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9692 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9693 can use the simpler operator notation that avoids some of the braces:
9694 .code
9695 ${nhash_<n>_<m>:<string>}
9696 .endd
9697 The second number is optional (in both notations). If there is only one number,
9698 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9699 processed by a div/mod hash function that returns two numbers, separated by a
9700 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9701 example,
9702 .code
9703 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9704 .endd
9705 returns the string &"6/33"&.
9706
9707
9708
9709 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9710 .cindex "Perl" "use in expanded string"
9711 .cindex "expansion" "calling Perl from"
9712 This item is available only if Exim has been built to include an embedded Perl
9713 interpreter. The subroutine name and the arguments are first separately
9714 expanded, and then the Perl subroutine is called with those arguments. No
9715 additional arguments need be given; the maximum number permitted, including the
9716 name of the subroutine, is nine.
9717
9718 The return value of the subroutine is inserted into the expanded string, unless
9719 the return value is &%undef%&. In that case, the expansion fails in the same
9720 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9721 Whatever you return is evaluated in a scalar context. For example, if you
9722 return the name of a Perl vector, the return value is the size of the vector,
9723 not its contents.
9724
9725 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9726 with the error message that was passed to &%die%&. More details of the embedded
9727 Perl facility are given in chapter &<<CHAPperl>>&.
9728
9729 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9730 out the use of this expansion item in filter files.
9731
9732
9733 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9734 .cindex "&%prvs%& expansion item"
9735 The first argument is a complete email address and the second is secret
9736 keystring. The third argument, specifying a key number, is optional. If absent,
9737 it defaults to 0. The result of the expansion is a prvs-signed email address,
9738 to be typically used with the &%return_path%& option on an &(smtp)& transport
9739 as part of a bounce address tag validation (BATV) scheme. For more discussion
9740 and an example, see section &<<SECTverifyPRVS>>&.
9741
9742 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9743         {*&<&'string'&>&*}}*&"
9744 .cindex "&%prvscheck%& expansion item"
9745 This expansion item is the complement of the &%prvs%& item. It is used for
9746 checking prvs-signed addresses. If the expansion of the first argument does not
9747 yield a syntactically valid prvs-signed address, the whole item expands to the
9748 empty string. When the first argument does expand to a syntactically valid
9749 prvs-signed address, the second argument is expanded, with the prvs-decoded
9750 version of the address and the key number extracted from the address in the
9751 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9752
9753 These two variables can be used in the expansion of the second argument to
9754 retrieve the secret. The validity of the prvs-signed address is then checked
9755 against the secret. The result is stored in the variable &$prvscheck_result$&,
9756 which is empty for failure or &"1"& for success.
9757
9758 The third argument is optional; if it is missing, it defaults to an empty
9759 string. This argument is now expanded. If the result is an empty string, the
9760 result of the expansion is the decoded version of the address. This is the case
9761 whether or not the signature was valid. Otherwise, the result of the expansion
9762 is the expansion of the third argument.
9763
9764 All three variables can be used in the expansion of the third argument.
9765 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9766 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9767
9768 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9769 .cindex "expansion" "inserting an entire file"
9770 .cindex "file" "inserting into expansion"
9771 .cindex "&%readfile%& expansion item"
9772 The file name and end-of-line string are first expanded separately. The file is
9773 then read, and its contents replace the entire item. All newline characters in
9774 the file are replaced by the end-of-line string if it is present. Otherwise,
9775 newlines are left in the string.
9776 String expansion is not applied to the contents of the file. If you want this,
9777 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9778 the string expansion fails.
9779
9780 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9781 locks out the use of this expansion item in filter files.
9782
9783
9784
9785 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9786         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9787 .cindex "expansion" "inserting from a socket"
9788 .cindex "socket, use of in expansion"
9789 .cindex "&%readsocket%& expansion item"
9790 This item inserts data from a Unix domain or TCP socket into the expanded
9791 string. The minimal way of using it uses just two arguments, as in these
9792 examples:
9793 .code
9794 ${readsocket{/socket/name}{request string}}
9795 ${readsocket{inet:some.host:1234}{request string}}
9796 .endd
9797 For a Unix domain socket, the first substring must be the path to the socket.
9798 For an Internet socket, the first substring must contain &`inet:`& followed by
9799 a host name or IP address, followed by a colon and a port, which can be a
9800 number or the name of a TCP port in &_/etc/services_&. An IP address may
9801 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9802 example:
9803 .code
9804 ${readsocket{inet:[::1]:1234}{request string}}
9805 .endd
9806 Only a single host name may be given, but if looking it up yields more than
9807 one IP address, they are each tried in turn until a connection is made. For
9808 both kinds of socket, Exim makes a connection, writes the request string
9809 unless it is an empty string; and no terminating NUL is ever sent)
9810 and reads from the socket until an end-of-file
9811 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9812 extend what can be done. Firstly, you can vary the timeout. For example:
9813 .code
9814 ${readsocket{/socket/name}{request string}{3s}}
9815 .endd
9816 The third argument is a list of options, of which the first element is the timeout
9817 and must be present if the argument is given.
9818 Further elements are options of form &'name=value'&.
9819 One option type is currently recognised, defining whether (the default)
9820 or not a shutdown is done on the connection after sending the request.
9821 Example, to not do so (preferred, eg. by some webservers):
9822 .code
9823 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
9824 .endd
9825 A fourth argument allows you to change any newlines that are in the data
9826 that is read, in the same way as for &%readfile%& (see above). This example
9827 turns them into spaces:
9828 .code
9829 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9830 .endd
9831 As with all expansions, the substrings are expanded before the processing
9832 happens. Errors in these sub-expansions cause the expansion to fail. In
9833 addition, the following errors can occur:
9834
9835 .ilist
9836 Failure to create a socket file descriptor;
9837 .next
9838 Failure to connect the socket;
9839 .next
9840 Failure to write the request string;
9841 .next
9842 Timeout on reading from the socket.
9843 .endlist
9844
9845 By default, any of these errors causes the expansion to fail. However, if
9846 you supply a fifth substring, it is expanded and used when any of the above
9847 errors occurs. For example:
9848 .code
9849 ${readsocket{/socket/name}{request string}{3s}{\n}\
9850   {socket failure}}
9851 .endd
9852 You can test for the existence of a Unix domain socket by wrapping this
9853 expansion in &`${if exists`&, but there is a race condition between that test
9854 and the actual opening of the socket, so it is safer to use the fifth argument
9855 if you want to be absolutely sure of avoiding an expansion error for a
9856 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9857
9858 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9859 locks out the use of this expansion item in filter files.
9860
9861
9862 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9863 .cindex "expansion" "reducing a list to a scalar"
9864 .cindex "list" "reducing to a scalar"
9865 .vindex "&$value$&"
9866 .vindex "&$item$&"
9867 This operation reduces a list to a single, scalar string. After expansion,
9868 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9869 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9870 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9871 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9872 them. The result of that expansion is assigned to &$value$& before the next
9873 iteration. When the end of the list is reached, the final value of &$value$& is
9874 added to the expansion output. The &*reduce*& expansion item can be used in a
9875 number of ways. For example, to add up a list of numbers:
9876 .code
9877 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9878 .endd
9879 The result of that expansion would be &`6`&. The maximum of a list of numbers
9880 can be found:
9881 .code
9882 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9883 .endd
9884 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9885 restored to what they were before. See also the &*filter*& and &*map*&
9886 expansion items.
9887
9888 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9889 This item inserts &"raw"& header lines. It is described with the &%header%&
9890 expansion item above.
9891
9892 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9893         {*&<&'string2'&>&*}}*&"
9894 .cindex "expansion" "running a command"
9895 .cindex "&%run%& expansion item"
9896 The command and its arguments are first expanded as one string. The string is
9897 split apart into individual arguments by spaces, and then the command is run
9898 in a separate process, but under the same uid and gid.  As in other command
9899 executions from Exim, a shell is not used by default. If the command requires
9900 a shell, you must explicitly code it.
9901
9902 Since the arguments are split by spaces, when there is a variable expansion
9903 which has an empty result, it will cause the situation that the argument will
9904 simply be omitted when the program is actually executed by Exim. If the
9905 script/program requires a specific number of arguments and the expanded
9906 variable could possibly result in this empty expansion, the variable must be
9907 quoted. This is more difficult if the expanded variable itself could result
9908 in a string containing quotes, because it would interfere with the quotes
9909 around the command arguments. A possible guard against this is to wrap the
9910 variable in the &%sg%& operator to change any quote marks to some other
9911 character.
9912
9913 The standard input for the command exists, but is empty. The standard output
9914 and standard error are set to the same file descriptor.
9915 .cindex "return code" "from &%run%& expansion"
9916 .vindex "&$value$&"
9917 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9918 and replaces the entire item; during this expansion, the standard output/error
9919 from the command is in the variable &$value$&. If the command fails,
9920 <&'string2'&>, if present, is expanded and used. Once again, during the
9921 expansion, the standard output/error from the command is in the variable
9922 &$value$&.
9923
9924 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9925 can be the word &"fail"& (not in braces) to force expansion failure if the
9926 command does not succeed. If both strings are omitted, the result is contents
9927 of the standard output/error on success, and nothing on failure.
9928
9929 .vindex "&$run_in_acl$&"
9930 The standard output/error of the command is put in the variable &$value$&.
9931 In this ACL example, the output of a command is logged for the admin to
9932 troubleshoot:
9933 .code
9934 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9935       log_message  = Output of id: $value
9936 .endd
9937 If the command requires shell idioms, such as the > redirect operator, the
9938 shell must be invoked directly, such as with:
9939 .code
9940 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9941 .endd
9942
9943 .vindex "&$runrc$&"
9944 The return code from the command is put in the variable &$runrc$&, and this
9945 remains set afterwards, so in a filter file you can do things like this:
9946 .code
9947 if "${run{x y z}{}}$runrc" is 1 then ...
9948   elif $runrc is 2 then ...
9949   ...
9950 endif
9951 .endd
9952 If execution of the command fails (for example, the command does not exist),
9953 the return code is 127 &-- the same code that shells use for non-existent
9954 commands.
9955
9956 &*Warning*&: In a router or transport, you cannot assume the order in which
9957 option values are expanded, except for those preconditions whose order of
9958 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9959 by the expansion of one option, and use it in another.
9960
9961 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9962 out the use of this expansion item in filter files.
9963
9964
9965 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9966 .cindex "expansion" "string substitution"
9967 .cindex "&%sg%& expansion item"
9968 This item works like Perl's substitution operator (s) with the global (/g)
9969 option; hence its name. However, unlike the Perl equivalent, Exim does not
9970 modify the subject string; instead it returns the modified string for insertion
9971 into the overall expansion. The item takes three arguments: the subject string,
9972 a regular expression, and a substitution string. For example:
9973 .code
9974 ${sg{abcdefabcdef}{abc}{xyz}}
9975 .endd
9976 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9977 if any $, } or \ characters are required in the regular expression or in the
9978 substitution string, they have to be escaped. For example:
9979 .code
9980 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9981 .endd
9982 yields &"defabc"&, and
9983 .code
9984 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9985 .endd
9986 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9987 the regular expression from string expansion.
9988
9989
9990
9991 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9992 .cindex sorting "a list"
9993 .cindex list sorting
9994 .cindex expansion "list sorting"
9995 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9996 default, but the separator can be changed in the usual way.
9997 The <&'comparator'&> argument is interpreted as the operator
9998 of a two-argument expansion condition.
9999 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10000 The comparison should return true when applied to two values
10001 if the first value should sort before the second value.
10002 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10003 the element being placed in &$item$&,
10004 to give values for comparison.
10005
10006 The item result is a sorted list,
10007 with the original list separator,
10008 of the list elements (in full) of the original.
10009
10010 Examples:
10011 .code
10012 ${sort{3:2:1:4}{<}{$item}}
10013 .endd
10014 sorts a list of numbers, and
10015 .code
10016 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10017 .endd
10018 will sort an MX lookup into priority order.
10019
10020
10021 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10022 .cindex "&%substr%& expansion item"
10023 .cindex "substring extraction"
10024 .cindex "expansion" "substring extraction"
10025 The three strings are expanded; the first two must yield numbers. Call them
10026 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10027 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10028 can use the simpler operator notation that avoids some of the braces:
10029 .code
10030 ${substr_<n>_<m>:<string>}
10031 .endd
10032 The second number is optional (in both notations).
10033 If it is absent in the simpler format, the preceding underscore must also be
10034 omitted.
10035
10036 The &%substr%& item can be used to extract more general substrings than
10037 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10038 length required. For example
10039 .code
10040 ${substr{3}{2}{$local_part}}
10041 .endd
10042 If the starting offset is greater than the string length the result is the
10043 null string; if the length plus starting offset is greater than the string
10044 length, the result is the right-hand part of the string, starting from the
10045 given offset. The first character in the string has offset zero.
10046
10047 The &%substr%& expansion item can take negative offset values to count
10048 from the right-hand end of its operand. The last character is offset -1, the
10049 second-last is offset -2, and so on. Thus, for example,
10050 .code
10051 ${substr{-5}{2}{1234567}}
10052 .endd
10053 yields &"34"&. If the absolute value of a negative offset is greater than the
10054 length of the string, the substring starts at the beginning of the string, and
10055 the length is reduced by the amount of overshoot. Thus, for example,
10056 .code
10057 ${substr{-5}{2}{12}}
10058 .endd
10059 yields an empty string, but
10060 .code
10061 ${substr{-3}{2}{12}}
10062 .endd
10063 yields &"1"&.
10064
10065 When the second number is omitted from &%substr%&, the remainder of the string
10066 is taken if the offset is positive. If it is negative, all characters in the
10067 string preceding the offset point are taken. For example, an offset of -1 and
10068 no length, as in these semantically identical examples:
10069 .code
10070 ${substr_-1:abcde}
10071 ${substr{-1}{abcde}}
10072 .endd
10073 yields all but the last character of the string, that is, &"abcd"&.
10074
10075
10076
10077 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10078         {*&<&'replacements'&>&*}}*&"
10079 .cindex "expansion" "character translation"
10080 .cindex "&%tr%& expansion item"
10081 This item does single-character translation on its subject string. The second
10082 argument is a list of characters to be translated in the subject string. Each
10083 matching character is replaced by the corresponding character from the
10084 replacement list. For example
10085 .code
10086 ${tr{abcdea}{ac}{13}}
10087 .endd
10088 yields &`1b3de1`&. If there are duplicates in the second character string, the
10089 last occurrence is used. If the third string is shorter than the second, its
10090 last character is replicated. However, if it is empty, no translation takes
10091 place.
10092 .endlist
10093
10094
10095
10096 .section "Expansion operators" "SECTexpop"
10097 .cindex "expansion" "operators"
10098 For expansion items that perform transformations on a single argument string,
10099 the &"operator"& notation is used because it is simpler and uses fewer braces.
10100 The substring is first expanded before the operation is applied to it. The
10101 following operations can be performed:
10102
10103 .vlist
10104 .vitem &*${address:*&<&'string'&>&*}*&
10105 .cindex "expansion" "RFC 2822 address handling"
10106 .cindex "&%address%& expansion item"
10107 The string is interpreted as an RFC 2822 address, as it might appear in a
10108 header line, and the effective address is extracted from it. If the string does
10109 not parse successfully, the result is empty.
10110
10111
10112 .vitem &*${addresses:*&<&'string'&>&*}*&
10113 .cindex "expansion" "RFC 2822 address handling"
10114 .cindex "&%addresses%& expansion item"
10115 The string (after expansion) is interpreted as a list of addresses in RFC
10116 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10117 operative address (&'local-part@domain'&) is extracted from each item, and the
10118 result of the expansion is a colon-separated list, with appropriate
10119 doubling of colons should any happen to be present in the email addresses.
10120 Syntactically invalid RFC2822 address items are omitted from the output.
10121
10122 It is possible to specify a character other than colon for the output
10123 separator by starting the string with > followed by the new separator
10124 character. For example:
10125 .code
10126 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10127 .endd
10128 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10129 first, so if the expanded string starts with >, it may change the output
10130 separator unintentionally. This can be avoided by setting the output
10131 separator explicitly:
10132 .code
10133 ${addresses:>:$h_from:}
10134 .endd
10135
10136 Compare the &*address*& (singular)
10137 expansion item, which extracts the working address from a single RFC2822
10138 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10139 processing lists.
10140
10141 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10142 a strict interpretation of header line formatting.  Exim parses the bare,
10143 unquoted portion of an email address and if it finds a comma, treats it as an
10144 email address separator. For the example header line:
10145 .code
10146 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10147 .endd
10148 The first example below demonstrates that Q-encoded email addresses are parsed
10149 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10150 It does not see the comma because it's still encoded as "=2C".  The second
10151 example below is passed the contents of &`$header_from:`&, meaning it gets
10152 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10153 The third example shows that the presence of a comma is skipped when it is
10154 quoted.
10155 .code
10156 # exim -be '${addresses:From: \
10157 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10158 user@example.com
10159 # exim -be '${addresses:From: Last, First <user@example.com>}'
10160 Last:user@example.com
10161 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10162 user@example.com
10163 .endd
10164
10165 .vitem &*${base32:*&<&'digits'&>&*}*&
10166 .cindex "&%base32%& expansion item"
10167 .cindex "expansion" "conversion to base 32"
10168 The string must consist entirely of decimal digits. The number is converted to
10169 base 32 and output as a (empty, for zero) string of characters.
10170 Only lowercase letters are used.
10171
10172 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10173 .cindex "&%base32d%& expansion item"
10174 .cindex "expansion" "conversion to base 32"
10175 The string must consist entirely of base-32 digits.
10176 The number is converted to decimal and output as a string.
10177
10178 .vitem &*${base62:*&<&'digits'&>&*}*&
10179 .cindex "&%base62%& expansion item"
10180 .cindex "expansion" "conversion to base 62"
10181 The string must consist entirely of decimal digits. The number is converted to
10182 base 62 and output as a string of six characters, including leading zeros. In
10183 the few operating environments where Exim uses base 36 instead of base 62 for
10184 its message identifiers (because those systems do not have case-sensitive file
10185 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10186 be absolutely clear: this is &'not'& base64 encoding.
10187
10188 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10189 .cindex "&%base62d%& expansion item"
10190 .cindex "expansion" "conversion to base 62"
10191 The string must consist entirely of base-62 digits, or, in operating
10192 environments where Exim uses base 36 instead of base 62 for its message
10193 identifiers, base-36 digits. The number is converted to decimal and output as a
10194 string.
10195
10196 .vitem &*${base64:*&<&'string'&>&*}*&
10197 .cindex "expansion" "base64 encoding"
10198 .cindex "base64 encoding" "in string expansion"
10199 .cindex "&%base64%& expansion item"
10200 .cindex certificate "base64 of DER"
10201 This operator converts a string into one that is base64 encoded.
10202
10203 If the string is a single variable of type certificate,
10204 returns the base64 encoding of the DER form of the certificate.
10205
10206
10207 .vitem &*${base64d:*&<&'string'&>&*}*&
10208 .cindex "expansion" "base64 decoding"
10209 .cindex "base64 decoding" "in string expansion"
10210 .cindex "&%base64d%& expansion item"
10211 This operator converts a base64-encoded string into the un-coded form.
10212
10213
10214 .vitem &*${domain:*&<&'string'&>&*}*&
10215 .cindex "domain" "extraction"
10216 .cindex "expansion" "domain extraction"
10217 The string is interpreted as an RFC 2822 address and the domain is extracted
10218 from it. If the string does not parse successfully, the result is empty.
10219
10220
10221 .vitem &*${escape:*&<&'string'&>&*}*&
10222 .cindex "expansion" "escaping non-printing characters"
10223 .cindex "&%escape%& expansion item"
10224 If the string contains any non-printing characters, they are converted to
10225 escape sequences starting with a backslash. Whether characters with the most
10226 significant bit set (so-called &"8-bit characters"&) count as printing or not
10227 is controlled by the &%print_topbitchars%& option.
10228
10229 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10230 .cindex "expansion" "escaping 8-bit characters"
10231 .cindex "&%escape8bit%& expansion item"
10232 If the string contains and characters with the most significant bit set,
10233 they are converted to escape sequences starting with a backslash.
10234 Backslashes and DEL characters are also converted.
10235
10236
10237 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10238 .cindex "expansion" "expression evaluation"
10239 .cindex "expansion" "arithmetic expression"
10240 .cindex "&%eval%& expansion item"
10241 These items supports simple arithmetic and bitwise logical operations in
10242 expansion strings. The string (after expansion) must be a conventional
10243 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10244 logical operators, and parentheses. All operations are carried out using
10245 integer arithmetic. The operator priorities are as follows (the same as in the
10246 C programming language):
10247 .table2 70pt 300pt
10248 .irow &'highest:'& "not (~), negate (-)"
10249 .irow ""   "multiply (*), divide (/), remainder (%)"
10250 .irow ""   "plus (+), minus (-)"
10251 .irow ""   "shift-left (<<), shift-right (>>)"
10252 .irow ""   "and (&&)"
10253 .irow ""   "xor (^)"
10254 .irow &'lowest:'&  "or (|)"
10255 .endtable
10256 Binary operators with the same priority are evaluated from left to right. White
10257 space is permitted before or after operators.
10258
10259 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10260 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10261 decimal, even if they start with a leading zero; hexadecimal numbers are not
10262 permitted. This can be useful when processing numbers extracted from dates or
10263 times, which often do have leading zeros.
10264
10265 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10266 or 1024*1024*1024,
10267 respectively. Negative numbers are supported. The result of the computation is
10268 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10269
10270 .display
10271 &`${eval:1+1}            `&  yields 2
10272 &`${eval:1+2*3}          `&  yields 7
10273 &`${eval:(1+2)*3}        `&  yields 9
10274 &`${eval:2+42%5}         `&  yields 4
10275 &`${eval:0xc&amp;5}          `&  yields 4
10276 &`${eval:0xc|5}          `&  yields 13
10277 &`${eval:0xc^5}          `&  yields 9
10278 &`${eval:0xc>>1}         `&  yields 6
10279 &`${eval:0xc<<1}         `&  yields 24
10280 &`${eval:~255&amp;0x1234}    `&  yields 4608
10281 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10282 .endd
10283
10284 As a more realistic example, in an ACL you might have
10285 .code
10286 deny   message = Too many bad recipients
10287        condition =                    \
10288          ${if and {                   \
10289            {>{$rcpt_count}{10}}       \
10290            {                          \
10291            <                          \
10292              {$recipients_count}      \
10293              {${eval:$rcpt_count/2}}  \
10294            }                          \
10295          }{yes}{no}}
10296 .endd
10297 The condition is true if there have been more than 10 RCPT commands and
10298 fewer than half of them have resulted in a valid recipient.
10299
10300
10301 .vitem &*${expand:*&<&'string'&>&*}*&
10302 .cindex "expansion" "re-expansion of substring"
10303 The &%expand%& operator causes a string to be expanded for a second time. For
10304 example,
10305 .code
10306 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10307 .endd
10308 first looks up a string in a file while expanding the operand for &%expand%&,
10309 and then re-expands what it has found.
10310
10311
10312 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10313 .cindex "Unicode"
10314 .cindex "UTF-8" "conversion from"
10315 .cindex "expansion" "UTF-8 conversion"
10316 .cindex "&%from_utf8%& expansion item"
10317 The world is slowly moving towards Unicode, although there are no standards for
10318 email yet. However, other applications (including some databases) are starting
10319 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10320 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10321 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10322 the result is an undefined sequence of bytes.
10323
10324 Unicode code points with values less than 256 are compatible with ASCII and
10325 ISO-8859-1 (also known as Latin-1).
10326 For example, character 169 is the copyright symbol in both cases, though the
10327 way it is encoded is different. In UTF-8, more than one byte is needed for
10328 characters with code values greater than 127, whereas ISO-8859-1 is a
10329 single-byte encoding (but thereby limited to 256 characters). This makes
10330 translation from UTF-8 to ISO-8859-1 straightforward.
10331
10332
10333 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10334 .cindex "hash function" "textual"
10335 .cindex "expansion" "textual hash"
10336 The &%hash%& operator is a simpler interface to the hashing function that can
10337 be used when the two parameters are fixed numbers (as opposed to strings that
10338 change when expanded). The effect is the same as
10339 .code
10340 ${hash{<n>}{<m>}{<string>}}
10341 .endd
10342 See the description of the general &%hash%& item above for details. The
10343 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10344
10345
10346
10347 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10348 .cindex "base64 encoding" "conversion from hex"
10349 .cindex "expansion" "hex to base64"
10350 .cindex "&%hex2b64%& expansion item"
10351 This operator converts a hex string into one that is base64 encoded. This can
10352 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10353
10354
10355
10356 .vitem &*${hexquote:*&<&'string'&>&*}*&
10357 .cindex "quoting" "hex-encoded unprintable characters"
10358 .cindex "&%hexquote%& expansion item"
10359 This operator converts non-printable characters in a string into a hex
10360 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10361 as is, and other byte values are converted to &`\xNN`&, for example a
10362 byte value 127 is converted to &`\x7f`&.
10363
10364
10365 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10366 .cindex "&%ipv6denorm%& expansion item"
10367 .cindex "IP address" normalisation
10368 This expands an IPv6 address to a full eight-element colon-separated set
10369 of hex digits including leading zeroes.
10370 A trailing ipv4-style dotted-decimal set is converted to hex.
10371 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10372
10373 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10374 .cindex "&%ipv6norm%& expansion item"
10375 .cindex "IP address" normalisation
10376 .cindex "IP address" "canonical form"
10377 This converts an IPv6 address to canonical form.
10378 Leading zeroes of groups are omitted, and the longest
10379 set of zero-valued groups is replaced with a double colon.
10380 A trailing ipv4-style dotted-decimal set is converted to hex.
10381 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10382
10383
10384 .vitem &*${lc:*&<&'string'&>&*}*&
10385 .cindex "case forcing in strings"
10386 .cindex "string" "case forcing"
10387 .cindex "lower casing"
10388 .cindex "expansion" "case forcing"
10389 .cindex "&%lc%& expansion item"
10390 This forces the letters in the string into lower-case, for example:
10391 .code
10392 ${lc:$local_part}
10393 .endd
10394
10395 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10396 .cindex "expansion" "string truncation"
10397 .cindex "&%length%& expansion item"
10398 The &%length%& operator is a simpler interface to the &%length%& function that
10399 can be used when the parameter is a fixed number (as opposed to a string that
10400 changes when expanded). The effect is the same as
10401 .code
10402 ${length{<number>}{<string>}}
10403 .endd
10404 See the description of the general &%length%& item above for details. Note that
10405 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10406 when &%length%& is used as an operator.
10407
10408
10409 .vitem &*${listcount:*&<&'string'&>&*}*&
10410 .cindex "expansion" "list item count"
10411 .cindex "list" "item count"
10412 .cindex "list" "count of items"
10413 .cindex "&%listcount%& expansion item"
10414 The string is interpreted as a list and the number of items is returned.
10415
10416
10417 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10418 .cindex "expansion" "named list"
10419 .cindex "&%listnamed%& expansion item"
10420 The name is interpreted as a named list and the content of the list is returned,
10421 expanding any referenced lists, re-quoting as needed for colon-separation.
10422 If the optional type is given it must be one of "a", "d", "h" or "l"
10423 and selects address-, domain-, host- or localpart- lists to search among respectively.
10424 Otherwise all types are searched in an undefined order and the first
10425 matching list is returned.
10426
10427
10428 .vitem &*${local_part:*&<&'string'&>&*}*&
10429 .cindex "expansion" "local part extraction"
10430 .cindex "&%local_part%& expansion item"
10431 The string is interpreted as an RFC 2822 address and the local part is
10432 extracted from it. If the string does not parse successfully, the result is
10433 empty.
10434
10435
10436 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10437 .cindex "masked IP address"
10438 .cindex "IP address" "masking"
10439 .cindex "CIDR notation"
10440 .cindex "expansion" "IP address masking"
10441 .cindex "&%mask%& expansion item"
10442 If the form of the string to be operated on is not an IP address followed by a
10443 slash and an integer (that is, a network address in CIDR notation), the
10444 expansion fails. Otherwise, this operator converts the IP address to binary,
10445 masks off the least significant bits according to the bit count, and converts
10446 the result back to text, with mask appended. For example,
10447 .code
10448 ${mask:10.111.131.206/28}
10449 .endd
10450 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10451 be mostly used for looking up masked addresses in files, the result for an IPv6
10452 address uses dots to separate components instead of colons, because colon
10453 terminates a key string in lsearch files. So, for example,
10454 .code
10455 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10456 .endd
10457 returns the string
10458 .code
10459 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10460 .endd
10461 Letters in IPv6 addresses are always output in lower case.
10462
10463
10464 .vitem &*${md5:*&<&'string'&>&*}*&
10465 .cindex "MD5 hash"
10466 .cindex "expansion" "MD5 hash"
10467 .cindex certificate fingerprint
10468 .cindex "&%md5%& expansion item"
10469 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10470 as a 32-digit hexadecimal number, in which any letters are in lower case.
10471
10472 If the string is a single variable of type certificate,
10473 returns the MD5 hash fingerprint of the certificate.
10474
10475
10476 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10477 .cindex "expansion" "numeric hash"
10478 .cindex "hash function" "numeric"
10479 The &%nhash%& operator is a simpler interface to the numeric hashing function
10480 that can be used when the two parameters are fixed numbers (as opposed to
10481 strings that change when expanded). The effect is the same as
10482 .code
10483 ${nhash{<n>}{<m>}{<string>}}
10484 .endd
10485 See the description of the general &%nhash%& item above for details.
10486
10487
10488 .vitem &*${quote:*&<&'string'&>&*}*&
10489 .cindex "quoting" "in string expansions"
10490 .cindex "expansion" "quoting"
10491 .cindex "&%quote%& expansion item"
10492 The &%quote%& operator puts its argument into double quotes if it
10493 is an empty string or
10494 contains anything other than letters, digits, underscores, dots, and hyphens.
10495 Any occurrences of double quotes and backslashes are escaped with a backslash.
10496 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10497 respectively For example,
10498 .code
10499 ${quote:ab"*"cd}
10500 .endd
10501 becomes
10502 .code
10503 "ab\"*\"cd"
10504 .endd
10505 The place where this is useful is when the argument is a substitution from a
10506 variable or a message header.
10507
10508 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10509 .cindex "&%quote_local_part%& expansion item"
10510 This operator is like &%quote%&, except that it quotes the string only if
10511 required to do so by the rules of RFC 2822 for quoting local parts. For
10512 example, a plus sign would not cause quoting (but it would for &%quote%&).
10513 If you are creating a new email address from the contents of &$local_part$&
10514 (or any other unknown data), you should always use this operator.
10515
10516
10517 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10518 .cindex "quoting" "lookup-specific"
10519 This operator applies lookup-specific quoting rules to the string. Each
10520 query-style lookup type has its own quoting rules which are described with
10521 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10522 .code
10523 ${quote_ldap:two * two}
10524 .endd
10525 returns
10526 .code
10527 two%20%5C2A%20two
10528 .endd
10529 For single-key lookup types, no quoting is ever necessary and this operator
10530 yields an unchanged string.
10531
10532
10533 .vitem &*${randint:*&<&'n'&>&*}*&
10534 .cindex "random number"
10535 This operator returns a somewhat random number which is less than the
10536 supplied number and is at least 0.  The quality of this randomness depends
10537 on how Exim was built; the values are not suitable for keying material.
10538 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10539 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10540 for versions of GnuTLS with that function.
10541 Otherwise, the implementation may be arc4random(), random() seeded by
10542 srandomdev() or srandom(), or a custom implementation even weaker than
10543 random().
10544
10545
10546 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10547 .cindex "expansion" "IP address"
10548 This operator reverses an IP address; for IPv4 addresses, the result is in
10549 dotted-quad decimal form, while for IPv6 addresses the result is in
10550 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10551 for DNS.  For example,
10552 .code
10553 ${reverse_ip:192.0.2.4}
10554 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10555 .endd
10556 returns
10557 .code
10558 4.2.0.192
10559 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
10560 .endd
10561
10562
10563 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10564 .cindex "expansion" "RFC 2047"
10565 .cindex "RFC 2047" "expansion operator"
10566 .cindex "&%rfc2047%& expansion item"
10567 This operator encodes text according to the rules of RFC 2047. This is an
10568 encoding that is used in header lines to encode non-ASCII characters. It is
10569 assumed that the input string is in the encoding specified by the
10570 &%headers_charset%& option, which gets its default at build time. If the string
10571 contains only characters in the range 33&--126, and no instances of the
10572 characters
10573 .code
10574 ? = ( ) < > @ , ; : \ " . [ ] _
10575 .endd
10576 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10577 string, using as many &"encoded words"& as necessary to encode all the
10578 characters.
10579
10580
10581 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10582 .cindex "expansion" "RFC 2047"
10583 .cindex "RFC 2047" "decoding"
10584 .cindex "&%rfc2047d%& expansion item"
10585 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10586 bytes are replaced by question marks. Characters are converted into the
10587 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10588 not recognized unless &%check_rfc2047_length%& is set false.
10589
10590 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10591 access a header line, RFC 2047 decoding is done automatically. You do not need
10592 to use this operator as well.
10593
10594
10595
10596 .vitem &*${rxquote:*&<&'string'&>&*}*&
10597 .cindex "quoting" "in regular expressions"
10598 .cindex "regular expressions" "quoting"
10599 .cindex "&%rxquote%& expansion item"
10600 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10601 characters in its argument. This is useful when substituting the values of
10602 variables or headers inside regular expressions.
10603
10604
10605 .vitem &*${sha1:*&<&'string'&>&*}*&
10606 .cindex "SHA-1 hash"
10607 .cindex "expansion" "SHA-1 hashing"
10608 .cindex certificate fingerprint
10609 .cindex "&%sha1%& expansion item"
10610 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10611 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10612
10613 If the string is a single variable of type certificate,
10614 returns the SHA-1 hash fingerprint of the certificate.
10615
10616
10617 .vitem &*${sha256:*&<&'string'&>&*}*&
10618 .cindex "SHA-256 hash"
10619 .cindex certificate fingerprint
10620 .cindex "expansion" "SHA-256 hashing"
10621 .cindex "&%sha256%& expansion item"
10622 The &%sha256%& operator computes the SHA-256 hash value of the string
10623 and returns
10624 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10625
10626 If the string is a single variable of type certificate,
10627 returns the SHA-256 hash fingerprint of the certificate.
10628
10629
10630 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10631        &*${sha3_<n>:*&<&'string'&>&*}*&
10632 .cindex "SHA3 hash"
10633 .cindex "expansion" "SHA3 hashing"
10634 .cindex "&%sha3%& expansion item"
10635 The &%sha3%& operator computes the SHA3-256 hash value of the string
10636 and returns
10637 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10638
10639 If a number is appended, separated by an underbar, it specifies
10640 the output length.  Values of 224, 256, 384 and 512 are accepted;
10641 with 256 being the default.
10642
10643 The &%sha3%& expansion item is only supported if Exim has been
10644 compiled with GnuTLS 3.5.0 or later.
10645
10646
10647 .vitem &*${stat:*&<&'string'&>&*}*&
10648 .cindex "expansion" "statting a file"
10649 .cindex "file" "extracting characteristics"
10650 .cindex "&%stat%& expansion item"
10651 The string, after expansion, must be a file path. A call to the &[stat()]&
10652 function is made for this path. If &[stat()]& fails, an error occurs and the
10653 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10654 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10655 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10656 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10657 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10658 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10659 can extract individual fields using the &%extract%& expansion item.
10660
10661 The use of the &%stat%& expansion in users' filter files can be locked out by
10662 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10663 systems for files larger than 2GB.
10664
10665 .vitem &*${str2b64:*&<&'string'&>&*}*&
10666 .cindex "&%str2b64%& expansion item"
10667 Now deprecated, a synonym for the &%base64%& expansion operator.
10668
10669
10670
10671 .vitem &*${strlen:*&<&'string'&>&*}*&
10672 .cindex "expansion" "string length"
10673 .cindex "string" "length in expansion"
10674 .cindex "&%strlen%& expansion item"
10675 The item is replace by the length of the expanded string, expressed as a
10676 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10677
10678
10679 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10680 .cindex "&%substr%& expansion item"
10681 .cindex "substring extraction"
10682 .cindex "expansion" "substring expansion"
10683 The &%substr%& operator is a simpler interface to the &%substr%& function that
10684 can be used when the two parameters are fixed numbers (as opposed to strings
10685 that change when expanded). The effect is the same as
10686 .code
10687 ${substr{<start>}{<length>}{<string>}}
10688 .endd
10689 See the description of the general &%substr%& item above for details. The
10690 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10691
10692 .vitem &*${time_eval:*&<&'string'&>&*}*&
10693 .cindex "&%time_eval%& expansion item"
10694 .cindex "time interval" "decoding"
10695 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10696 seconds.
10697
10698 .vitem &*${time_interval:*&<&'string'&>&*}*&
10699 .cindex "&%time_interval%& expansion item"
10700 .cindex "time interval" "formatting"
10701 The argument (after sub-expansion) must be a sequence of decimal digits that
10702 represents an interval of time as a number of seconds. It is converted into a
10703 number of larger units and output in Exim's normal time format, for example,
10704 &`1w3d4h2m6s`&.
10705
10706 .vitem &*${uc:*&<&'string'&>&*}*&
10707 .cindex "case forcing in strings"
10708 .cindex "string" "case forcing"
10709 .cindex "upper casing"
10710 .cindex "expansion" "case forcing"
10711 .cindex "&%uc%& expansion item"
10712 This forces the letters in the string into upper-case.
10713
10714 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10715 .cindex "correction of invalid utf-8 sequences in strings"
10716 .cindex "utf-8" "utf-8 sequences"
10717 .cindex "incorrect utf-8"
10718 .cindex "expansion" "utf-8 forcing"
10719 .cindex "&%utf8clean%& expansion item"
10720 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10721
10722 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10723        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10724        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10725        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10726 .cindex expansion UTF-8
10727 .cindex UTF-8 expansion
10728 .cindex EAI
10729 .cindex internationalisation
10730 .cindex "&%utf8_domain_to_alabel%& expansion item"
10731 .cindex "&%utf8_domain_from_alabel%& expansion item"
10732 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10733 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10734 These convert EAI mail name components between UTF-8 and a-label forms.
10735 For information on internationalisation support see &<<SECTi18nMTA>>&.
10736 .endlist
10737
10738
10739
10740
10741
10742
10743 .section "Expansion conditions" "SECTexpcond"
10744 .scindex IIDexpcond "expansion" "conditions"
10745 The following conditions are available for testing by the &%${if%& construct
10746 while expanding strings:
10747
10748 .vlist
10749 .vitem &*!*&<&'condition'&>
10750 .cindex "expansion" "negating a condition"
10751 .cindex "negation" "in expansion condition"
10752 Preceding any condition with an exclamation mark negates the result of the
10753 condition.
10754
10755 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10756 .cindex "numeric comparison"
10757 .cindex "expansion" "numeric comparison"
10758 There are a number of symbolic operators for doing numeric comparisons. They
10759 are:
10760 .display
10761 &`=   `&   equal
10762 &`==  `&   equal
10763 &`>   `&   greater
10764 &`>=  `&   greater or equal
10765 &`<   `&   less
10766 &`<=  `&   less or equal
10767 .endd
10768 For example:
10769 .code
10770 ${if >{$message_size}{10M} ...
10771 .endd
10772 Note that the general negation operator provides for inequality testing. The
10773 two strings must take the form of optionally signed decimal integers,
10774 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10775 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10776 As a special case, the numerical value of an empty string is taken as
10777 zero.
10778
10779 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10780 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10781 10M, not if 10M is larger than &$message_size$&.
10782
10783
10784 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10785         {*&<&'arg2'&>&*}...}*&
10786 .cindex "expansion" "calling an acl"
10787 .cindex "&%acl%&" "expansion condition"
10788 The name and zero to nine argument strings are first expanded separately.  The expanded
10789 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10790 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10791 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10792 and may use the variables; if another acl expansion is used the values
10793 are restored after it returns.  If the ACL sets
10794 a value using a "message =" modifier the variable $value becomes
10795 the result of the expansion, otherwise it is empty.
10796 If the ACL returns accept the condition is true; if deny, false.
10797 If the ACL returns defer the result is a forced-fail.
10798
10799 .vitem &*bool&~{*&<&'string'&>&*}*&
10800 .cindex "expansion" "boolean parsing"
10801 .cindex "&%bool%& expansion condition"
10802 This condition turns a string holding a true or false representation into
10803 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10804 (case-insensitively); also integer numbers map to true if non-zero,
10805 false if zero.
10806 An empty string is treated as false.
10807 Leading and trailing whitespace is ignored;
10808 thus a string consisting only of whitespace is false.
10809 All other string values will result in expansion failure.
10810
10811 When combined with ACL variables, this expansion condition will let you
10812 make decisions in one place and act on those decisions in another place.
10813 For example:
10814 .code
10815 ${if bool{$acl_m_privileged_sender} ...
10816 .endd
10817
10818
10819 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10820 .cindex "expansion" "boolean parsing"
10821 .cindex "&%bool_lax%& expansion condition"
10822 Like &%bool%&, this condition turns a string into a boolean state.  But
10823 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10824 loose definition that the Router &%condition%& option uses.  The empty string
10825 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10826 true.  Leading and trailing whitespace is ignored.
10827
10828 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10829
10830 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10831 .cindex "expansion" "encrypted comparison"
10832 .cindex "encrypted strings, comparing"
10833 .cindex "&%crypteq%& expansion condition"
10834 This condition is included in the Exim binary if it is built to support any
10835 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10836 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10837 included in the binary.
10838
10839 The &%crypteq%& condition has two arguments. The first is encrypted and
10840 compared against the second, which is already encrypted. The second string may
10841 be in the LDAP form for storing encrypted strings, which starts with the
10842 encryption type in curly brackets, followed by the data. If the second string
10843 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10844 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10845 Typically this will be a field from a password file. An example of an encrypted
10846 string in LDAP form is:
10847 .code
10848 {md5}CY9rzUYh03PK3k6DJie09g==
10849 .endd
10850 If such a string appears directly in an expansion, the curly brackets have to
10851 be quoted, because they are part of the expansion syntax. For example:
10852 .code
10853 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10854 .endd
10855 The following encryption types (whose names are matched case-independently) are
10856 supported:
10857
10858 .ilist
10859 .cindex "MD5 hash"
10860 .cindex "base64 encoding" "in encrypted password"
10861 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10862 printable characters to compare with the remainder of the second string. If the
10863 length of the comparison string is 24, Exim assumes that it is base64 encoded
10864 (as in the above example). If the length is 32, Exim assumes that it is a
10865 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10866 comparison fails.
10867
10868 .next
10869 .cindex "SHA-1 hash"
10870 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10871 printable characters to compare with the remainder of the second string. If the
10872 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10873 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10874 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10875
10876 .next
10877 .cindex "&[crypt()]&"
10878 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10879 only the first eight characters of the password. However, in modern operating
10880 systems this is no longer true, and in many cases the entire password is used,
10881 whatever its length.
10882
10883 .next
10884 .cindex "&[crypt16()]&"
10885 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10886 use up to 16 characters of the password in some operating systems. Again, in
10887 modern operating systems, more characters may be used.
10888 .endlist
10889 Exim has its own version of &[crypt16()]&, which is just a double call to
10890 &[crypt()]&. For operating systems that have their own version, setting
10891 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10892 operating system version instead of its own. This option is set by default in
10893 the OS-dependent &_Makefile_& for those operating systems that are known to
10894 support &[crypt16()]&.
10895
10896 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10897 it was not using the same algorithm as some operating systems' versions. It
10898 turns out that as well as &[crypt16()]& there is a function called
10899 &[bigcrypt()]& in some operating systems. This may or may not use the same
10900 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10901
10902 However, since there is now a move away from the traditional &[crypt()]&
10903 functions towards using SHA1 and other algorithms, tidying up this area of
10904 Exim is seen as very low priority.
10905
10906 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10907 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10908 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10909 default is &`{crypt}`&. Whatever the default, you can always use either
10910 function by specifying it explicitly in curly brackets.
10911
10912 .vitem &*def:*&<&'variable&~name'&>
10913 .cindex "expansion" "checking for empty variable"
10914 .cindex "&%def%& expansion condition"
10915 The &%def%& condition must be followed by the name of one of the expansion
10916 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10917 variable does not contain the empty string. For example:
10918 .code
10919 ${if def:sender_ident {from $sender_ident}}
10920 .endd
10921 Note that the variable name is given without a leading &%$%& character. If the
10922 variable does not exist, the expansion fails.
10923
10924 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10925         &~&*def:h_*&<&'header&~name'&>&*:*&"
10926 .cindex "expansion" "checking header line existence"
10927 This condition is true if a message is being processed and the named header
10928 exists in the message. For example,
10929 .code
10930 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10931 .endd
10932 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10933 the header name must be terminated by a colon if white space does not follow.
10934
10935 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10936        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10937 .cindex "string" "comparison"
10938 .cindex "expansion" "string comparison"
10939 .cindex "&%eq%& expansion condition"
10940 .cindex "&%eqi%& expansion condition"
10941 The two substrings are first expanded. The condition is true if the two
10942 resulting strings are identical. For &%eq%& the comparison includes the case of
10943 letters, whereas for &%eqi%& the comparison is case-independent.
10944
10945 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10946 .cindex "expansion" "file existence test"
10947 .cindex "file" "existence test"
10948 .cindex "&%exists%&, expansion condition"
10949 The substring is first expanded and then interpreted as an absolute path. The
10950 condition is true if the named file (or directory) exists. The existence test
10951 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10952 users' filter files may be locked out by the system administrator.
10953
10954 .vitem &*first_delivery*&
10955 .cindex "delivery" "first"
10956 .cindex "first delivery"
10957 .cindex "expansion" "first delivery test"
10958 .cindex "&%first_delivery%& expansion condition"
10959 This condition, which has no data, is true during a message's first delivery
10960 attempt. It is false during any subsequent delivery attempts.
10961
10962
10963 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10964        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10965 .cindex "list" "iterative conditions"
10966 .cindex "expansion" "&*forall*& condition"
10967 .cindex "expansion" "&*forany*& condition"
10968 .vindex "&$item$&"
10969 These conditions iterate over a list. The first argument is expanded to form
10970 the list. By default, the list separator is a colon, but it can be changed by
10971 the normal method. The second argument is interpreted as a condition that is to
10972 be applied to each item in the list in turn. During the interpretation of the
10973 condition, the current list item is placed in a variable called &$item$&.
10974 .ilist
10975 For &*forany*&, interpretation stops if the condition is true for any item, and
10976 the result of the whole condition is true. If the condition is false for all
10977 items in the list, the overall condition is false.
10978 .next
10979 For &*forall*&, interpretation stops if the condition is false for any item,
10980 and the result of the whole condition is false. If the condition is true for
10981 all items in the list, the overall condition is true.
10982 .endlist
10983 Note that negation of &*forany*& means that the condition must be false for all
10984 items for the overall condition to succeed, and negation of &*forall*& means
10985 that the condition must be false for at least one item. In this example, the
10986 list separator is changed to a comma:
10987 .code
10988 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10989 .endd
10990 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10991 being processed, to enable these expansion items to be nested.
10992
10993 To scan a named list, expand it with the &*listnamed*& operator.
10994
10995
10996 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10997        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10998 .cindex "string" "comparison"
10999 .cindex "expansion" "string comparison"
11000 .cindex "&%ge%& expansion condition"
11001 .cindex "&%gei%& expansion condition"
11002 The two substrings are first expanded. The condition is true if the first
11003 string is lexically greater than or equal to the second string. For &%ge%& the
11004 comparison includes the case of letters, whereas for &%gei%& the comparison is
11005 case-independent.
11006
11007 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11008        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11009 .cindex "string" "comparison"
11010 .cindex "expansion" "string comparison"
11011 .cindex "&%gt%& expansion condition"
11012 .cindex "&%gti%& expansion condition"
11013 The two substrings are first expanded. The condition is true if the first
11014 string is lexically greater than the second string. For &%gt%& the comparison
11015 includes the case of letters, whereas for &%gti%& the comparison is
11016 case-independent.
11017
11018 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11019        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11020 .cindex "string" "comparison"
11021 .cindex "list" "iterative conditions"
11022 Both strings are expanded; the second string is treated as a list of simple
11023 strings; if the first string is a member of the second, then the condition
11024 is true.
11025
11026 These are simpler to use versions of the more powerful &*forany*& condition.
11027 Examples, and the &*forany*& equivalents:
11028 .code
11029 ${if inlist{needle}{foo:needle:bar}}
11030   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11031 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11032   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11033 .endd
11034
11035 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11036        &*isip4&~{*&<&'string'&>&*}*& &&&
11037        &*isip6&~{*&<&'string'&>&*}*&
11038 .cindex "IP address" "testing string format"
11039 .cindex "string" "testing for IP address"
11040 .cindex "&%isip%& expansion condition"
11041 .cindex "&%isip4%& expansion condition"
11042 .cindex "&%isip6%& expansion condition"
11043 The substring is first expanded, and then tested to see if it has the form of
11044 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11045 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11046
11047 For an IPv4 address, the test is for four dot-separated components, each of
11048 which consists of from one to three digits. For an IPv6 address, up to eight
11049 colon-separated components are permitted, each containing from one to four
11050 hexadecimal digits. There may be fewer than eight components if an empty
11051 component (adjacent colons) is present. Only one empty component is permitted.
11052
11053 .new
11054 &*Note*&: The checks used to be just on the form of the address; actual numerical
11055 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11056 check.
11057 This is no longer the case.
11058 .wen
11059
11060 The main use of these tests is to distinguish between IP addresses and
11061 host names, or between IPv4 and IPv6 addresses. For example, you could use
11062 .code
11063 ${if isip4{$sender_host_address}...
11064 .endd
11065 to test which IP version an incoming SMTP connection is using.
11066
11067 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11068 .cindex "LDAP" "use for authentication"
11069 .cindex "expansion" "LDAP authentication test"
11070 .cindex "&%ldapauth%& expansion condition"
11071 This condition supports user authentication using LDAP. See section
11072 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11073 queries. For this use, the query must contain a user name and password. The
11074 query itself is not used, and can be empty. The condition is true if the
11075 password is not empty, and the user name and password are accepted by the LDAP
11076 server. An empty password is rejected without calling LDAP because LDAP binds
11077 with an empty password are considered anonymous regardless of the username, and
11078 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11079 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11080 this can be used.
11081
11082
11083 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11084        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11085 .cindex "string" "comparison"
11086 .cindex "expansion" "string comparison"
11087 .cindex "&%le%& expansion condition"
11088 .cindex "&%lei%& expansion condition"
11089 The two substrings are first expanded. The condition is true if the first
11090 string is lexically less than or equal to the second string. For &%le%& the
11091 comparison includes the case of letters, whereas for &%lei%& the comparison is
11092 case-independent.
11093
11094 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11095        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11096 .cindex "string" "comparison"
11097 .cindex "expansion" "string comparison"
11098 .cindex "&%lt%& expansion condition"
11099 .cindex "&%lti%& expansion condition"
11100 The two substrings are first expanded. The condition is true if the first
11101 string is lexically less than the second string. For &%lt%& the comparison
11102 includes the case of letters, whereas for &%lti%& the comparison is
11103 case-independent.
11104
11105
11106 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11107 .cindex "expansion" "regular expression comparison"
11108 .cindex "regular expressions" "match in expanded string"
11109 .cindex "&%match%& expansion condition"
11110 The two substrings are first expanded. The second is then treated as a regular
11111 expression and applied to the first. Because of the pre-expansion, if the
11112 regular expression contains dollar, or backslash characters, they must be
11113 escaped. Care must also be taken if the regular expression contains braces
11114 (curly brackets). A closing brace must be escaped so that it is not taken as a
11115 premature termination of <&'string2'&>. The easiest approach is to use the
11116 &`\N`& feature to disable expansion of the regular expression.
11117 For example,
11118 .code
11119 ${if match {$local_part}{\N^\d{3}\N} ...
11120 .endd
11121 If the whole expansion string is in double quotes, further escaping of
11122 backslashes is also required.
11123
11124 The condition is true if the regular expression match succeeds.
11125 The regular expression is not required to begin with a circumflex
11126 metacharacter, but if there is no circumflex, the expression is not anchored,
11127 and it may match anywhere in the subject, not just at the start. If you want
11128 the pattern to match at the end of the subject, you must include the &`$`&
11129 metacharacter at an appropriate point.
11130
11131 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11132 At the start of an &%if%& expansion the values of the numeric variable
11133 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11134 succeeds causes them to be reset to the substrings of that condition and they
11135 will have these values during the expansion of the success string. At the end
11136 of the &%if%& expansion, the previous values are restored. After testing a
11137 combination of conditions using &%or%&, the subsequent values of the numeric
11138 variables are those of the condition that succeeded.
11139
11140 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11141 .cindex "&%match_address%& expansion condition"
11142 See &*match_local_part*&.
11143
11144 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11145 .cindex "&%match_domain%& expansion condition"
11146 See &*match_local_part*&.
11147
11148 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11149 .cindex "&%match_ip%& expansion condition"
11150 This condition matches an IP address to a list of IP address patterns. It must
11151 be followed by two argument strings. The first (after expansion) must be an IP
11152 address or an empty string. The second (not expanded) is a restricted host
11153 list that can match only an IP address, not a host name. For example:
11154 .code
11155 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11156 .endd
11157 The specific types of host list item that are permitted in the list are:
11158
11159 .ilist
11160 An IP address, optionally with a CIDR mask.
11161 .next
11162 A single asterisk, which matches any IP address.
11163 .next
11164 An empty item, which matches only if the IP address is empty. This could be
11165 useful for testing for a locally submitted message or one from specific hosts
11166 in a single test such as
11167 . ==== As this is a nested list, any displays it contains must be indented
11168 . ==== as otherwise they are too far to the left. This comment applies to
11169 . ==== the use of xmlto plus fop. There's no problem when formatting with
11170 . ==== sdop, with or without the extra indent.
11171 .code
11172   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11173 .endd
11174 where the first item in the list is the empty string.
11175 .next
11176 The item @[] matches any of the local host's interface addresses.
11177 .next
11178 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11179 even if &`net-`& is not specified. There is never any attempt to turn the IP
11180 address into a host name. The most common type of linear search for
11181 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11182 masks. For example:
11183 .code
11184   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11185 .endd
11186 It is of course possible to use other kinds of lookup, and in such a case, you
11187 do need to specify the &`net-`& prefix if you want to specify a specific
11188 address mask, for example:
11189 .code
11190   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11191 .endd
11192 However, unless you are combining a &%match_ip%& condition with others, it is
11193 just as easy to use the fact that a lookup is itself a condition, and write:
11194 .code
11195   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11196 .endd
11197 .endlist ilist
11198
11199 Note that <&'string2'&> is not itself subject to string expansion, unless
11200 Exim was built with the EXPAND_LISTMATCH_RHS option.
11201
11202 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11203
11204 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11205 .cindex "domain list" "in expansion condition"
11206 .cindex "address list" "in expansion condition"
11207 .cindex "local part" "list, in expansion condition"
11208 .cindex "&%match_local_part%& expansion condition"
11209 This condition, together with &%match_address%& and &%match_domain%&, make it
11210 possible to test domain, address, and local part lists within expansions. Each
11211 condition requires two arguments: an item and a list to match. A trivial
11212 example is:
11213 .code
11214 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11215 .endd
11216 In each case, the second argument may contain any of the allowable items for a
11217 list of the appropriate type. Also, because the second argument
11218 is a standard form of list, it is possible to refer to a named list.
11219 Thus, you can use conditions like this:
11220 .code
11221 ${if match_domain{$domain}{+local_domains}{...
11222 .endd
11223 .cindex "&`+caseful`&"
11224 For address lists, the matching starts off caselessly, but the &`+caseful`&
11225 item can be used, as in all address lists, to cause subsequent items to
11226 have their local parts matched casefully. Domains are always matched
11227 caselessly.
11228
11229 Note that <&'string2'&> is not itself subject to string expansion, unless
11230 Exim was built with the EXPAND_LISTMATCH_RHS option.
11231
11232 &*Note*&: Host lists are &'not'& supported in this way. This is because
11233 hosts have two identities: a name and an IP address, and it is not clear
11234 how to specify cleanly how such a test would work. However, IP addresses can be
11235 matched using &%match_ip%&.
11236
11237 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11238 .cindex "PAM authentication"
11239 .cindex "AUTH" "with PAM"
11240 .cindex "Solaris" "PAM support"
11241 .cindex "expansion" "PAM authentication test"
11242 .cindex "&%pam%& expansion condition"
11243 &'Pluggable Authentication Modules'&
11244 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11245 available in the latest releases of Solaris and in some GNU/Linux
11246 distributions. The Exim support, which is intended for use in conjunction with
11247 the SMTP AUTH command, is available only if Exim is compiled with
11248 .code
11249 SUPPORT_PAM=yes
11250 .endd
11251 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11252 in some releases of GNU/Linux &%-ldl%& is also needed.
11253
11254 The argument string is first expanded, and the result must be a
11255 colon-separated list of strings. Leading and trailing white space is ignored.
11256 The PAM module is initialized with the service name &"exim"& and the user name
11257 taken from the first item in the colon-separated data string (<&'string1'&>).
11258 The remaining items in the data string are passed over in response to requests
11259 from the authentication function. In the simple case there will only be one
11260 request, for a password, so the data consists of just two strings.
11261
11262 There can be problems if any of the strings are permitted to contain colon
11263 characters. In the usual way, these have to be doubled to avoid being taken as
11264 separators. If the data is being inserted from a variable, the &%sg%& expansion
11265 item can be used to double any existing colons. For example, the configuration
11266 of a LOGIN authenticator might contain this setting:
11267 .code
11268 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11269 .endd
11270 For a PLAIN authenticator you could use:
11271 .code
11272 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11273 .endd
11274 In some operating systems, PAM authentication can be done only from a process
11275 running as root. Since Exim is running as the Exim user when receiving
11276 messages, this means that PAM cannot be used directly in those systems.
11277 A patched version of the &'pam_unix'& module that comes with the
11278 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11279 The patched module allows one special uid/gid combination, in addition to root,
11280 to authenticate. If you build the patched module to allow the Exim user and
11281 group, PAM can then be used from an Exim authenticator.
11282
11283
11284 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11285 .cindex "&'pwcheck'& daemon"
11286 .cindex "Cyrus"
11287 .cindex "expansion" "&'pwcheck'& authentication test"
11288 .cindex "&%pwcheck%& expansion condition"
11289 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11290 This is one way of making it possible for passwords to be checked by a process
11291 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11292 deprecated. Its replacement is &'saslauthd'& (see below).
11293
11294 The pwcheck support is not included in Exim by default. You need to specify
11295 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11296 building Exim. For example:
11297 .code
11298 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11299 .endd
11300 You do not need to install the full Cyrus software suite in order to use
11301 the pwcheck daemon. You can compile and install just the daemon alone
11302 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11303 access to the &_/var/pwcheck_& directory.
11304
11305 The &%pwcheck%& condition takes one argument, which must be the user name and
11306 password, separated by a colon. For example, in a LOGIN authenticator
11307 configuration, you might have this:
11308 .code
11309 server_condition = ${if pwcheck{$auth1:$auth2}}
11310 .endd
11311 Again, for a PLAIN authenticator configuration, this would be:
11312 .code
11313 server_condition = ${if pwcheck{$auth2:$auth3}}
11314 .endd
11315 .vitem &*queue_running*&
11316 .cindex "queue runner" "detecting when delivering from"
11317 .cindex "expansion" "queue runner test"
11318 .cindex "&%queue_running%& expansion condition"
11319 This condition, which has no data, is true during delivery attempts that are
11320 initiated by queue runner processes, and false otherwise.
11321
11322
11323 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11324 .cindex "Radius"
11325 .cindex "expansion" "Radius authentication"
11326 .cindex "&%radius%& expansion condition"
11327 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11328 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11329 the Radius client configuration file in order to build Exim with Radius
11330 support.
11331
11332 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11333 library, using the original API. If you are using release 0.4.0 or later of
11334 this library, you need to set
11335 .code
11336 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11337 .endd
11338 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11339 &%libradius%& library that comes with FreeBSD. To do this, set
11340 .code
11341 RADIUS_LIB_TYPE=RADLIB
11342 .endd
11343 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11344 You may also have to supply a suitable setting in EXTRALIBS so that the
11345 Radius library can be found when Exim is linked.
11346
11347 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11348 Radius client library, which calls the Radius server. The condition is true if
11349 the authentication is successful. For example:
11350 .code
11351 server_condition = ${if radius{<arguments>}}
11352 .endd
11353
11354
11355 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11356         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11357 .cindex "&'saslauthd'& daemon"
11358 .cindex "Cyrus"
11359 .cindex "expansion" "&'saslauthd'& authentication test"
11360 .cindex "&%saslauthd%& expansion condition"
11361 This condition supports user authentication using the Cyrus &'saslauthd'&
11362 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11363 Using this daemon is one way of making it possible for passwords to be checked
11364 by a process that is not running as root.
11365
11366 The saslauthd support is not included in Exim by default. You need to specify
11367 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11368 building Exim. For example:
11369 .code
11370 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11371 .endd
11372 You do not need to install the full Cyrus software suite in order to use
11373 the saslauthd daemon. You can compile and install just the daemon alone
11374 from the Cyrus SASL library.
11375
11376 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11377 two are mandatory. For example:
11378 .code
11379 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11380 .endd
11381 The service and the realm are optional (which is why the arguments are enclosed
11382 in their own set of braces). For details of the meaning of the service and
11383 realm, and how to run the daemon, consult the Cyrus documentation.
11384 .endlist vlist
11385
11386
11387
11388 .section "Combining expansion conditions" "SECID84"
11389 .cindex "expansion" "combining conditions"
11390 Several conditions can be tested at once by combining them using the &%and%&
11391 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11392 conditions on their own, and precede their lists of sub-conditions. Each
11393 sub-condition must be enclosed in braces within the overall braces that contain
11394 the list. No repetition of &%if%& is used.
11395
11396
11397 .vlist
11398 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11399 .cindex "&""or""& expansion condition"
11400 .cindex "expansion" "&""or""& of conditions"
11401 The sub-conditions are evaluated from left to right. The condition is true if
11402 any one of the sub-conditions is true.
11403 For example,
11404 .code
11405 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11406 .endd
11407 When a true sub-condition is found, the following ones are parsed but not
11408 evaluated. If there are several &"match"& sub-conditions the values of the
11409 numeric variables afterwards are taken from the first one that succeeds.
11410
11411 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11412 .cindex "&""and""& expansion condition"
11413 .cindex "expansion" "&""and""& of conditions"
11414 The sub-conditions are evaluated from left to right. The condition is true if
11415 all of the sub-conditions are true. If there are several &"match"&
11416 sub-conditions, the values of the numeric variables afterwards are taken from
11417 the last one. When a false sub-condition is found, the following ones are
11418 parsed but not evaluated.
11419 .endlist
11420 .ecindex IIDexpcond
11421
11422
11423
11424
11425 .section "Expansion variables" "SECTexpvar"
11426 .cindex "expansion" "variables, list of"
11427 This section contains an alphabetical list of all the expansion variables. Some
11428 of them are available only when Exim is compiled with specific options such as
11429 support for TLS or the content scanning extension.
11430
11431 .vlist
11432 .vitem "&$0$&, &$1$&, etc"
11433 .cindex "numerical variables (&$1$& &$2$& etc)"
11434 When a &%match%& expansion condition succeeds, these variables contain the
11435 captured substrings identified by the regular expression during subsequent
11436 processing of the success string of the containing &%if%& expansion item.
11437 In the expansion condition case
11438 they do not retain their values afterwards; in fact, their previous
11439 values are restored at the end of processing an &%if%& item. The numerical
11440 variables may also be set externally by some other matching process which
11441 precedes the expansion of the string. For example, the commands available in
11442 Exim filter files include an &%if%& command with its own regular expression
11443 matching condition.
11444
11445 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11446 Within an acl condition, expansion condition or expansion item
11447 any arguments are copied to these variables,
11448 any unused variables being made empty.
11449
11450 .vitem "&$acl_c...$&"
11451 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11452 can be given any name that starts with &$acl_c$& and is at least six characters
11453 long, but the sixth character must be either a digit or an underscore. For
11454 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11455 variables persist throughout the lifetime of an SMTP connection. They can be
11456 used to pass information between ACLs and between different invocations of the
11457 same ACL. When a message is received, the values of these variables are saved
11458 with the message, and can be accessed by filters, routers, and transports
11459 during subsequent delivery.
11460
11461 .vitem "&$acl_m...$&"
11462 These variables are like the &$acl_c...$& variables, except that their values
11463 are reset after a message has been received. Thus, if several messages are
11464 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11465 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11466 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11467 message is received, the values of these variables are saved with the message,
11468 and can be accessed by filters, routers, and transports during subsequent
11469 delivery.
11470
11471 .vitem &$acl_narg$&
11472 Within an acl condition, expansion condition or expansion item
11473 this variable has the number of arguments.
11474
11475 .vitem &$acl_verify_message$&
11476 .vindex "&$acl_verify_message$&"
11477 After an address verification has failed, this variable contains the failure
11478 message. It retains its value for use in subsequent modifiers. The message can
11479 be preserved by coding like this:
11480 .code
11481 warn !verify = sender
11482      set acl_m0 = $acl_verify_message
11483 .endd
11484 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11485 &%log_message%& modifiers, to include information about the verification
11486 failure.
11487
11488 .vitem &$address_data$&
11489 .vindex "&$address_data$&"
11490 This variable is set by means of the &%address_data%& option in routers. The
11491 value then remains with the address while it is processed by subsequent routers
11492 and eventually a transport. If the transport is handling multiple addresses,
11493 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11494 for more details. &*Note*&: The contents of &$address_data$& are visible in
11495 user filter files.
11496
11497 If &$address_data$& is set when the routers are called from an ACL to verify
11498 a recipient address, the final value is still in the variable for subsequent
11499 conditions and modifiers of the ACL statement. If routing the address caused it
11500 to be redirected to just one address, the child address is also routed as part
11501 of the verification, and in this case the final value of &$address_data$& is
11502 from the child's routing.
11503
11504 If &$address_data$& is set when the routers are called from an ACL to verify a
11505 sender address, the final value is also preserved, but this time in
11506 &$sender_address_data$&, to distinguish it from data from a recipient
11507 address.
11508
11509 In both cases (recipient and sender verification), the value does not persist
11510 after the end of the current ACL statement. If you want to preserve
11511 these values for longer, you can save them in ACL variables.
11512
11513 .vitem &$address_file$&
11514 .vindex "&$address_file$&"
11515 When, as a result of aliasing, forwarding, or filtering, a message is directed
11516 to a specific file, this variable holds the name of the file when the transport
11517 is running. At other times, the variable is empty. For example, using the
11518 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11519 .code
11520 /home/r2d2/savemail
11521 .endd
11522 then when the &(address_file)& transport is running, &$address_file$&
11523 contains the text string &`/home/r2d2/savemail`&.
11524 .cindex "Sieve filter" "value of &$address_file$&"
11525 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11526 then up to the transport configuration to generate an appropriate absolute path
11527 to the relevant file.
11528
11529 .vitem &$address_pipe$&
11530 .vindex "&$address_pipe$&"
11531 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11532 this variable holds the pipe command when the transport is running.
11533
11534 .vitem "&$auth1$& &-- &$auth3$&"
11535 .vindex "&$auth1$&, &$auth2$&, etc"
11536 These variables are used in SMTP authenticators (see chapters
11537 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11538
11539 .vitem &$authenticated_id$&
11540 .cindex "authentication" "id"
11541 .vindex "&$authenticated_id$&"
11542 When a server successfully authenticates a client it may be configured to
11543 preserve some of the authentication information in the variable
11544 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11545 user/password authenticator configuration might preserve the user name for use
11546 in the routers. Note that this is not the same information that is saved in
11547 &$sender_host_authenticated$&.
11548 When a message is submitted locally (that is, not over a TCP connection)
11549 the value of &$authenticated_id$& is normally the login name of the calling
11550 process. However, a trusted user can override this by means of the &%-oMai%&
11551 command line option.
11552
11553 .vitem &$authenticated_fail_id$&
11554 .cindex "authentication" "fail" "id"
11555 .vindex "&$authenticated_fail_id$&"
11556 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11557 will contain the failed authentication id. If more than one authentication
11558 id is attempted, it will contain only the last one. The variable is
11559 available for processing in the ACL's, generally the quit or notquit ACL.
11560 A message to a local recipient could still be accepted without requiring
11561 authentication, which means this variable could also be visible in all of
11562 the ACL's as well.
11563
11564
11565 .vitem &$authenticated_sender$&
11566 .cindex "sender" "authenticated"
11567 .cindex "authentication" "sender"
11568 .cindex "AUTH" "on MAIL command"
11569 .vindex "&$authenticated_sender$&"
11570 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11571 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11572 described in section &<<SECTauthparamail>>&. Unless the data is the string
11573 &"<>"&, it is set as the authenticated sender of the message, and the value is
11574 available during delivery in the &$authenticated_sender$& variable. If the
11575 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11576
11577 .vindex "&$qualify_domain$&"
11578 When a message is submitted locally (that is, not over a TCP connection), the
11579 value of &$authenticated_sender$& is an address constructed from the login
11580 name of the calling process and &$qualify_domain$&, except that a trusted user
11581 can override this by means of the &%-oMas%& command line option.
11582
11583
11584 .vitem &$authentication_failed$&
11585 .cindex "authentication" "failure"
11586 .vindex "&$authentication_failed$&"
11587 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11588 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11589 possible to distinguish between &"did not try to authenticate"&
11590 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11591 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11592 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11593 negative response to an AUTH command, including (for example) an attempt to use
11594 an undefined mechanism.
11595
11596 .vitem &$av_failed$&
11597 .cindex "content scanning" "AV scanner failure"
11598 This variable is available when Exim is compiled with the content-scanning
11599 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11600 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11601 the ACL malware condition.
11602
11603 .vitem &$body_linecount$&
11604 .cindex "message body" "line count"
11605 .cindex "body of message" "line count"
11606 .vindex "&$body_linecount$&"
11607 When a message is being received or delivered, this variable contains the
11608 number of lines in the message's body. See also &$message_linecount$&.
11609
11610 .vitem &$body_zerocount$&
11611 .cindex "message body" "binary zero count"
11612 .cindex "body of message" "binary zero count"
11613 .cindex "binary zero" "in message body"
11614 .vindex "&$body_zerocount$&"
11615 When a message is being received or delivered, this variable contains the
11616 number of binary zero bytes (ASCII NULs) in the message's body.
11617
11618 .vitem &$bounce_recipient$&
11619 .vindex "&$bounce_recipient$&"
11620 This is set to the recipient address of a bounce message while Exim is creating
11621 it. It is useful if a customized bounce message text file is in use (see
11622 chapter &<<CHAPemsgcust>>&).
11623
11624 .vitem &$bounce_return_size_limit$&
11625 .vindex "&$bounce_return_size_limit$&"
11626 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11627 up to a multiple of 1000. It is useful when a customized error message text
11628 file is in use (see chapter &<<CHAPemsgcust>>&).
11629
11630 .vitem &$caller_gid$&
11631 .cindex "gid (group id)" "caller"
11632 .vindex "&$caller_gid$&"
11633 The real group id under which the process that called Exim was running. This is
11634 not the same as the group id of the originator of a message (see
11635 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11636 incarnation normally contains the Exim gid.
11637
11638 .vitem &$caller_uid$&
11639 .cindex "uid (user id)" "caller"
11640 .vindex "&$caller_uid$&"
11641 The real user id under which the process that called Exim was running. This is
11642 not the same as the user id of the originator of a message (see
11643 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11644 incarnation normally contains the Exim uid.
11645
11646 .vitem &$callout_address$&
11647 .vindex "&$callout_address$&"
11648 After a callout for verification, spamd or malware daemon service, the
11649 address that was connected to.
11650
11651 .vitem &$compile_number$&
11652 .vindex "&$compile_number$&"
11653 The building process for Exim keeps a count of the number
11654 of times it has been compiled. This serves to distinguish different
11655 compilations of the same version of the program.
11656
11657 .vitem &$config_dir$&
11658 .vindex "&$config_dir$&"
11659 The directory name of the main configuration file. That is, the content of
11660 &$config_file$& with the last component stripped. The value does not
11661 contain the trailing slash. If &$config_file$& does not contain a slash,
11662 &$config_dir$& is ".".
11663
11664 .vitem &$config_file$&
11665 .vindex "&$config_file$&"
11666 The name of the main configuration file Exim is using.
11667
11668 .vitem &$dkim_cur_signer$& &&&
11669        &$dkim_verify_status$& &&&
11670        &$dkim_verify_reason$& &&&
11671        &$dkim_domain$& &&&
11672        &$dkim_identity$& &&&
11673        &$dkim_selector$& &&&
11674        &$dkim_algo$& &&&
11675        &$dkim_canon_body$& &&&
11676        &$dkim_canon_headers$& &&&
11677        &$dkim_copiedheaders$& &&&
11678        &$dkim_bodylength$& &&&
11679        &$dkim_created$& &&&
11680        &$dkim_expires$& &&&
11681        &$dkim_headernames$& &&&
11682        &$dkim_key_testing$& &&&
11683        &$dkim_key_nosubdomains$& &&&
11684        &$dkim_key_srvtype$& &&&
11685        &$dkim_key_granularity$& &&&
11686        &$dkim_key_notes$& &&&
11687        &$dkim_key_length$&
11688 These variables are only available within the DKIM ACL.
11689 For details see chapter &<<CHAPdkim>>&.
11690
11691 .vitem &$dkim_signers$&
11692 .vindex &$dkim_signers$&
11693 When a message has been received this variable contains
11694 a colon-separated list of signer domains and identities for the message.
11695 For details see chapter &<<CHAPdkim>>&.
11696
11697 .vitem &$dnslist_domain$& &&&
11698        &$dnslist_matched$& &&&
11699        &$dnslist_text$& &&&
11700        &$dnslist_value$&
11701 .vindex "&$dnslist_domain$&"
11702 .vindex "&$dnslist_matched$&"
11703 .vindex "&$dnslist_text$&"
11704 .vindex "&$dnslist_value$&"
11705 .cindex "black list (DNS)"
11706 When a DNS (black) list lookup succeeds, these variables are set to contain
11707 the following data from the lookup: the list's domain name, the key that was
11708 looked up, the contents of any associated TXT record, and the value from the
11709 main A record. See section &<<SECID204>>& for more details.
11710
11711 .vitem &$domain$&
11712 .vindex "&$domain$&"
11713 When an address is being routed, or delivered on its own, this variable
11714 contains the domain. Uppercase letters in the domain are converted into lower
11715 case for &$domain$&.
11716
11717 Global address rewriting happens when a message is received, so the value of
11718 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11719 is set during user filtering, but not during system filtering, because a
11720 message may have many recipients and the system filter is called just once.
11721
11722 When more than one address is being delivered at once (for example, several
11723 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11724 have the same domain. Transports can be restricted to handling only one domain
11725 at a time if the value of &$domain$& is required at transport time &-- this is
11726 the default for local transports. For further details of the environment in
11727 which local transports are run, see chapter &<<CHAPenvironment>>&.
11728
11729 .oindex "&%delay_warning_condition%&"
11730 At the end of a delivery, if all deferred addresses have the same domain, it is
11731 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11732
11733 The &$domain$& variable is also used in some other circumstances:
11734
11735 .ilist
11736 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11737 the recipient address. The domain of the &'sender'& address is in
11738 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11739 normally set during the running of the MAIL ACL. However, if the sender address
11740 is verified with a callout during the MAIL ACL, the sender domain is placed in
11741 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11742 the &(smtp)& transport.
11743
11744 .next
11745 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11746 &$domain$& contains the domain portion of the address that is being rewritten;
11747 it can be used in the expansion of the replacement address, for example, to
11748 rewrite domains by file lookup.
11749
11750 .next
11751 With one important exception, whenever a domain list is being scanned,
11752 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11753 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11754 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11755 that, in a RCPT ACL, the sender domain list can be dependent on the
11756 recipient domain (which is what is in &$domain$& at this time).
11757
11758 .next
11759 .cindex "ETRN" "value of &$domain$&"
11760 .oindex "&%smtp_etrn_command%&"
11761 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11762 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11763 .endlist
11764
11765
11766 .vitem &$domain_data$&
11767 .vindex "&$domain_data$&"
11768 When the &%domains%& option on a router matches a domain by
11769 means of a lookup, the data read by the lookup is available during the running
11770 of the router as &$domain_data$&. In addition, if the driver routes the
11771 address to a transport, the value is available in that transport. If the
11772 transport is handling multiple addresses, the value from the first address is
11773 used.
11774
11775 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11776 domain by means of a lookup. The data read by the lookup is available during
11777 the rest of the ACL statement. In all other situations, this variable expands
11778 to nothing.
11779
11780 .vitem &$exim_gid$&
11781 .vindex "&$exim_gid$&"
11782 This variable contains the numerical value of the Exim group id.
11783
11784 .vitem &$exim_path$&
11785 .vindex "&$exim_path$&"
11786 This variable contains the path to the Exim binary.
11787
11788 .vitem &$exim_uid$&
11789 .vindex "&$exim_uid$&"
11790 This variable contains the numerical value of the Exim user id.
11791
11792 .vitem &$exim_version$&
11793 .vindex "&$exim_version$&"
11794 This variable contains the version string of the Exim build.
11795 The first character is a major version number, currently 4.
11796 Then after a dot, the next group of digits is a minor version number.
11797 There may be other characters following the minor version.
11798
11799 .vitem &$header_$&<&'name'&>
11800 This is not strictly an expansion variable. It is expansion syntax for
11801 inserting the message header line with the given name. Note that the name must
11802 be terminated by colon or white space, because it may contain a wide variety of
11803 characters. Note also that braces must &'not'& be used.
11804
11805 .vitem &$headers_added$&
11806 .vindex "&$headers_added$&"
11807 Within an ACL this variable contains the headers added so far by
11808 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11809 The headers are a newline-separated list.
11810
11811 .vitem &$home$&
11812 .vindex "&$home$&"
11813 When the &%check_local_user%& option is set for a router, the user's home
11814 directory is placed in &$home$& when the check succeeds. In particular, this
11815 means it is set during the running of users' filter files. A router may also
11816 explicitly set a home directory for use by a transport; this can be overridden
11817 by a setting on the transport itself.
11818
11819 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11820 of the environment variable HOME, which is subject to the
11821 &%keep_environment%& and &%add_environment%& main config options.
11822
11823 .vitem &$host$&
11824 .vindex "&$host$&"
11825 If a router assigns an address to a transport (any transport), and passes a
11826 list of hosts with the address, the value of &$host$& when the transport starts
11827 to run is the name of the first host on the list. Note that this applies both
11828 to local and remote transports.
11829
11830 .cindex "transport" "filter"
11831 .cindex "filter" "transport filter"
11832 For the &(smtp)& transport, if there is more than one host, the value of
11833 &$host$& changes as the transport works its way through the list. In
11834 particular, when the &(smtp)& transport is expanding its options for encryption
11835 using TLS, or for specifying a transport filter (see chapter
11836 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11837 is connected.
11838
11839 When used in the client part of an authenticator configuration (see chapter
11840 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11841 client is connected.
11842
11843
11844 .vitem &$host_address$&
11845 .vindex "&$host_address$&"
11846 This variable is set to the remote host's IP address whenever &$host$& is set
11847 for a remote connection. It is also set to the IP address that is being checked
11848 when the &%ignore_target_hosts%& option is being processed.
11849
11850 .vitem &$host_data$&
11851 .vindex "&$host_data$&"
11852 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11853 result of the lookup is made available in the &$host_data$& variable. This
11854 allows you, for example, to do things like this:
11855 .code
11856 deny  hosts = net-lsearch;/some/file
11857 message = $host_data
11858 .endd
11859 .vitem &$host_lookup_deferred$&
11860 .cindex "host name" "lookup, failure of"
11861 .vindex "&$host_lookup_deferred$&"
11862 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11863 message comes from a remote host and there is an attempt to look up the host's
11864 name from its IP address, and the attempt is not successful, one of these
11865 variables is set to &"1"&.
11866
11867 .ilist
11868 If the lookup receives a definite negative response (for example, a DNS lookup
11869 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11870
11871 .next
11872 If there is any kind of problem during the lookup, such that Exim cannot
11873 tell whether or not the host name is defined (for example, a timeout for a DNS
11874 lookup), &$host_lookup_deferred$& is set to &"1"&.
11875 .endlist ilist
11876
11877 Looking up a host's name from its IP address consists of more than just a
11878 single reverse lookup. Exim checks that a forward lookup of at least one of the
11879 names it receives from a reverse lookup yields the original IP address. If this
11880 is not the case, Exim does not accept the looked up name(s), and
11881 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11882 IP address (for example, the existence of a PTR record in the DNS) is not
11883 sufficient on its own for the success of a host name lookup. If the reverse
11884 lookup succeeds, but there is a lookup problem such as a timeout when checking
11885 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11886 &"1"&. See also &$sender_host_name$&.
11887
11888 .vitem &$host_lookup_failed$&
11889 .vindex "&$host_lookup_failed$&"
11890 See &$host_lookup_deferred$&.
11891
11892 .vitem &$host_port$&
11893 .vindex "&$host_port$&"
11894 This variable is set to the remote host's TCP port whenever &$host$& is set
11895 for an outbound connection.
11896
11897 .vitem &$initial_cwd$&
11898 .vindex "&$initial_cwd$&
11899 This variable contains the full path name of the initial working
11900 directory of the current Exim process. This may differ from the current
11901 working directory, as Exim changes this to "/" during early startup, and
11902 to &$spool_directory$& later.
11903
11904 .vitem &$inode$&
11905 .vindex "&$inode$&"
11906 The only time this variable is set is while expanding the &%directory_file%&
11907 option in the &(appendfile)& transport. The variable contains the inode number
11908 of the temporary file which is about to be renamed. It can be used to construct
11909 a unique name for the file.
11910
11911 .vitem &$interface_address$&
11912 .vindex "&$interface_address$&"
11913 This is an obsolete name for &$received_ip_address$&.
11914
11915 .vitem &$interface_port$&
11916 .vindex "&$interface_port$&"
11917 This is an obsolete name for &$received_port$&.
11918
11919 .vitem &$item$&
11920 .vindex "&$item$&"
11921 This variable is used during the expansion of &*forall*& and &*forany*&
11922 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11923 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11924 empty.
11925
11926 .vitem &$ldap_dn$&
11927 .vindex "&$ldap_dn$&"
11928 This variable, which is available only when Exim is compiled with LDAP support,
11929 contains the DN from the last entry in the most recently successful LDAP
11930 lookup.
11931
11932 .vitem &$load_average$&
11933 .vindex "&$load_average$&"
11934 This variable contains the system load average, multiplied by 1000 so that it
11935 is an integer. For example, if the load average is 0.21, the value of the
11936 variable is 210. The value is recomputed every time the variable is referenced.
11937
11938 .vitem &$local_part$&
11939 .vindex "&$local_part$&"
11940 When an address is being routed, or delivered on its own, this
11941 variable contains the local part. When a number of addresses are being
11942 delivered together (for example, multiple RCPT commands in an SMTP
11943 session), &$local_part$& is not set.
11944
11945 Global address rewriting happens when a message is received, so the value of
11946 &$local_part$& during routing and delivery is the value after rewriting.
11947 &$local_part$& is set during user filtering, but not during system filtering,
11948 because a message may have many recipients and the system filter is called just
11949 once.
11950
11951 .vindex "&$local_part_prefix$&"
11952 .vindex "&$local_part_suffix$&"
11953 If a local part prefix or suffix has been recognized, it is not included in the
11954 value of &$local_part$& during routing and subsequent delivery. The values of
11955 any prefix or suffix are in &$local_part_prefix$& and
11956 &$local_part_suffix$&, respectively.
11957
11958 When a message is being delivered to a file, pipe, or autoreply transport as a
11959 result of aliasing or forwarding, &$local_part$& is set to the local part of
11960 the parent address, not to the file name or command (see &$address_file$& and
11961 &$address_pipe$&).
11962
11963 When an ACL is running for a RCPT command, &$local_part$& contains the
11964 local part of the recipient address.
11965
11966 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11967 &$local_part$& contains the local part of the address that is being rewritten;
11968 it can be used in the expansion of the replacement address, for example.
11969
11970 In all cases, all quoting is removed from the local part. For example, for both
11971 the addresses
11972 .code
11973 "abc:xyz"@test.example
11974 abc\:xyz@test.example
11975 .endd
11976 the value of &$local_part$& is
11977 .code
11978 abc:xyz
11979 .endd
11980 If you use &$local_part$& to create another address, you should always wrap it
11981 inside a quoting operator. For example, in a &(redirect)& router you could
11982 have:
11983 .code
11984 data = ${quote_local_part:$local_part}@new.domain.example
11985 .endd
11986 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11987 to process local parts in a case-dependent manner in a router, you can set the
11988 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11989
11990 .vitem &$local_part_data$&
11991 .vindex "&$local_part_data$&"
11992 When the &%local_parts%& option on a router matches a local part by means of a
11993 lookup, the data read by the lookup is available during the running of the
11994 router as &$local_part_data$&. In addition, if the driver routes the address
11995 to a transport, the value is available in that transport. If the transport is
11996 handling multiple addresses, the value from the first address is used.
11997
11998 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11999 matches a local part by means of a lookup. The data read by the lookup is
12000 available during the rest of the ACL statement. In all other situations, this
12001 variable expands to nothing.
12002
12003 .vitem &$local_part_prefix$&
12004 .vindex "&$local_part_prefix$&"
12005 When an address is being routed or delivered, and a
12006 specific prefix for the local part was recognized, it is available in this
12007 variable, having been removed from &$local_part$&.
12008
12009 .vitem &$local_part_suffix$&
12010 .vindex "&$local_part_suffix$&"
12011 When an address is being routed or delivered, and a
12012 specific suffix for the local part was recognized, it is available in this
12013 variable, having been removed from &$local_part$&.
12014
12015 .vitem &$local_scan_data$&
12016 .vindex "&$local_scan_data$&"
12017 This variable contains the text returned by the &[local_scan()]& function when
12018 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12019
12020 .vitem &$local_user_gid$&
12021 .vindex "&$local_user_gid$&"
12022 See &$local_user_uid$&.
12023
12024 .vitem &$local_user_uid$&
12025 .vindex "&$local_user_uid$&"
12026 This variable and &$local_user_gid$& are set to the uid and gid after the
12027 &%check_local_user%& router precondition succeeds. This means that their values
12028 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12029 and &%condition%&), for the &%address_data%& expansion, and for any
12030 router-specific expansions. At all other times, the values in these variables
12031 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12032
12033 .vitem &$localhost_number$&
12034 .vindex "&$localhost_number$&"
12035 This contains the expanded value of the
12036 &%localhost_number%& option. The expansion happens after the main options have
12037 been read.
12038
12039 .vitem &$log_inodes$&
12040 .vindex "&$log_inodes$&"
12041 The number of free inodes in the disk partition where Exim's
12042 log files are being written. The value is recalculated whenever the variable is
12043 referenced. If the relevant file system does not have the concept of inodes,
12044 the value of is -1. See also the &%check_log_inodes%& option.
12045
12046 .vitem &$log_space$&
12047 .vindex "&$log_space$&"
12048 The amount of free space (as a number of kilobytes) in the disk
12049 partition where Exim's log files are being written. The value is recalculated
12050 whenever the variable is referenced. If the operating system does not have the
12051 ability to find the amount of free space (only true for experimental systems),
12052 the space value is -1. See also the &%check_log_space%& option.
12053
12054
12055 .vitem &$lookup_dnssec_authenticated$&
12056 .vindex "&$lookup_dnssec_authenticated$&"
12057 This variable is set after a DNS lookup done by
12058 a dnsdb lookup expansion, dnslookup router or smtp transport.
12059 .cindex "DNS" "DNSSEC"
12060 It will be empty if &(DNSSEC)& was not requested,
12061 &"no"& if the result was not labelled as authenticated data
12062 and &"yes"& if it was.
12063 Results that are labelled as authoritative answer that match
12064 the &%dns_trust_aa%& configuration variable count also
12065 as authenticated data.
12066
12067 .vitem &$mailstore_basename$&
12068 .vindex "&$mailstore_basename$&"
12069 This variable is set only when doing deliveries in &"mailstore"& format in the
12070 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12071 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12072 contains the basename of the files that are being written, that is, the name
12073 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12074 variable is empty.
12075
12076 .vitem &$malware_name$&
12077 .vindex "&$malware_name$&"
12078 This variable is available when Exim is compiled with the
12079 content-scanning extension. It is set to the name of the virus that was found
12080 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12081
12082 .vitem &$max_received_linelength$&
12083 .vindex "&$max_received_linelength$&"
12084 .cindex "maximum" "line length"
12085 .cindex "line length" "maximum"
12086 This variable contains the number of bytes in the longest line that was
12087 received as part of the message, not counting the line termination
12088 character(s).
12089 .new
12090 It is not valid if the &%spool_files_wireformat%& option is used.
12091 .wen
12092
12093 .vitem &$message_age$&
12094 .cindex "message" "age of"
12095 .vindex "&$message_age$&"
12096 This variable is set at the start of a delivery attempt to contain the number
12097 of seconds since the message was received. It does not change during a single
12098 delivery attempt.
12099
12100 .vitem &$message_body$&
12101 .cindex "body of message" "expansion variable"
12102 .cindex "message body" "in expansion"
12103 .cindex "binary zero" "in message body"
12104 .vindex "&$message_body$&"
12105 .oindex "&%message_body_visible%&"
12106 This variable contains the initial portion of a message's body while it is
12107 being delivered, and is intended mainly for use in filter files. The maximum
12108 number of characters of the body that are put into the variable is set by the
12109 &%message_body_visible%& configuration option; the default is 500.
12110
12111 .oindex "&%message_body_newlines%&"
12112 By default, newlines are converted into spaces in &$message_body$&, to make it
12113 easier to search for phrases that might be split over a line break. However,
12114 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12115 zeros are always converted into spaces.
12116
12117 .vitem &$message_body_end$&
12118 .cindex "body of message" "expansion variable"
12119 .cindex "message body" "in expansion"
12120 .vindex "&$message_body_end$&"
12121 This variable contains the final portion of a message's
12122 body while it is being delivered. The format and maximum size are as for
12123 &$message_body$&.
12124
12125 .vitem &$message_body_size$&
12126 .cindex "body of message" "size"
12127 .cindex "message body" "size"
12128 .vindex "&$message_body_size$&"
12129 When a message is being delivered, this variable contains the size of the body
12130 in bytes. The count starts from the character after the blank line that
12131 separates the body from the header. Newlines are included in the count. See
12132 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12133
12134 .new
12135 If the spool file is wireformat
12136 (see the &%spool_files_wireformat%& main option)
12137 the CRLF line-terminators are included in the count.
12138 .wen
12139
12140 .vitem &$message_exim_id$&
12141 .vindex "&$message_exim_id$&"
12142 When a message is being received or delivered, this variable contains the
12143 unique message id that is generated and used by Exim to identify the message.
12144 An id is not created for a message until after its header has been successfully
12145 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12146 line; it is the local id that Exim assigns to the message, for example:
12147 &`1BXTIK-0001yO-VA`&.
12148
12149 .vitem &$message_headers$&
12150 .vindex &$message_headers$&
12151 This variable contains a concatenation of all the header lines when a message
12152 is being processed, except for lines added by routers or transports. The header
12153 lines are separated by newline characters. Their contents are decoded in the
12154 same way as a header line that is inserted by &%bheader%&.
12155
12156 .vitem &$message_headers_raw$&
12157 .vindex &$message_headers_raw$&
12158 This variable is like &$message_headers$& except that no processing of the
12159 contents of header lines is done.
12160
12161 .vitem &$message_id$&
12162 This is an old name for &$message_exim_id$&. It is now deprecated.
12163
12164 .vitem &$message_linecount$&
12165 .vindex "&$message_linecount$&"
12166 This variable contains the total number of lines in the header and body of the
12167 message. Compare &$body_linecount$&, which is the count for the body only.
12168 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12169 number of lines received. Before delivery happens (that is, before filters,
12170 routers, and transports run) the count is increased to include the
12171 &'Received:'& header line that Exim standardly adds, and also any other header
12172 lines that are added by ACLs. The blank line that separates the message header
12173 from the body is not counted.
12174
12175 As with the special case of &$message_size$&, during the expansion of the
12176 appendfile transport's maildir_tag option in maildir format, the value of
12177 &$message_linecount$& is the precise size of the number of newlines in the
12178 file that has been written (minus one for the blank line between the
12179 header and the body).
12180
12181 Here is an example of the use of this variable in a DATA ACL:
12182 .code
12183 deny message   = Too many lines in message header
12184      condition = \
12185       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12186 .endd
12187 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12188 message has not yet been received.
12189
12190 .new
12191 This variable is not valid if the &%spool_files_wireformat%& option is used.
12192 .wen
12193
12194 .vitem &$message_size$&
12195 .cindex "size" "of message"
12196 .cindex "message" "size"
12197 .vindex "&$message_size$&"
12198 When a message is being processed, this variable contains its size in bytes. In
12199 most cases, the size includes those headers that were received with the
12200 message, but not those (such as &'Envelope-to:'&) that are added to individual
12201 deliveries as they are written. However, there is one special case: during the
12202 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12203 doing a delivery in maildir format, the value of &$message_size$& is the
12204 precise size of the file that has been written. See also
12205 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12206
12207 .cindex "RCPT" "value of &$message_size$&"
12208 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12209 contains the size supplied on the MAIL command, or -1 if no size was given. The
12210 value may not, of course, be truthful.
12211
12212 .vitem &$mime_$&&'xxx'&
12213 A number of variables whose names start with &$mime$& are
12214 available when Exim is compiled with the content-scanning extension. For
12215 details, see section &<<SECTscanmimepart>>&.
12216
12217 .vitem "&$n0$& &-- &$n9$&"
12218 These variables are counters that can be incremented by means
12219 of the &%add%& command in filter files.
12220
12221 .vitem &$original_domain$&
12222 .vindex "&$domain$&"
12223 .vindex "&$original_domain$&"
12224 When a top-level address is being processed for delivery, this contains the
12225 same value as &$domain$&. However, if a &"child"& address (for example,
12226 generated by an alias, forward, or filter file) is being processed, this
12227 variable contains the domain of the original address (lower cased). This
12228 differs from &$parent_domain$& only when there is more than one level of
12229 aliasing or forwarding. When more than one address is being delivered in a
12230 single transport run, &$original_domain$& is not set.
12231
12232 If a new address is created by means of a &%deliver%& command in a system
12233 filter, it is set up with an artificial &"parent"& address. This has the local
12234 part &'system-filter'& and the default qualify domain.
12235
12236 .vitem &$original_local_part$&
12237 .vindex "&$local_part$&"
12238 .vindex "&$original_local_part$&"
12239 When a top-level address is being processed for delivery, this contains the
12240 same value as &$local_part$&, unless a prefix or suffix was removed from the
12241 local part, because &$original_local_part$& always contains the full local
12242 part. When a &"child"& address (for example, generated by an alias, forward, or
12243 filter file) is being processed, this variable contains the full local part of
12244 the original address.
12245
12246 If the router that did the redirection processed the local part
12247 case-insensitively, the value in &$original_local_part$& is in lower case.
12248 This variable differs from &$parent_local_part$& only when there is more than
12249 one level of aliasing or forwarding. When more than one address is being
12250 delivered in a single transport run, &$original_local_part$& is not set.
12251
12252 If a new address is created by means of a &%deliver%& command in a system
12253 filter, it is set up with an artificial &"parent"& address. This has the local
12254 part &'system-filter'& and the default qualify domain.
12255
12256 .vitem &$originator_gid$&
12257 .cindex "gid (group id)" "of originating user"
12258 .cindex "sender" "gid"
12259 .vindex "&$caller_gid$&"
12260 .vindex "&$originator_gid$&"
12261 This variable contains the value of &$caller_gid$& that was set when the
12262 message was received. For messages received via the command line, this is the
12263 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12264 normally the gid of the Exim user.
12265
12266 .vitem &$originator_uid$&
12267 .cindex "uid (user id)" "of originating user"
12268 .cindex "sender" "uid"
12269 .vindex "&$caller_uid$&"
12270 .vindex "&$originator_uid$&"
12271 The value of &$caller_uid$& that was set when the message was received. For
12272 messages received via the command line, this is the uid of the sending user.
12273 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12274 user.
12275
12276 .vitem &$parent_domain$&
12277 .vindex "&$parent_domain$&"
12278 This variable is similar to &$original_domain$& (see
12279 above), except that it refers to the immediately preceding parent address.
12280
12281 .vitem &$parent_local_part$&
12282 .vindex "&$parent_local_part$&"
12283 This variable is similar to &$original_local_part$&
12284 (see above), except that it refers to the immediately preceding parent address.
12285
12286 .vitem &$pid$&
12287 .cindex "pid (process id)" "of current process"
12288 .vindex "&$pid$&"
12289 This variable contains the current process id.
12290
12291 .vitem &$pipe_addresses$&
12292 .cindex "filter" "transport filter"
12293 .cindex "transport" "filter"
12294 .vindex "&$pipe_addresses$&"
12295 This is not an expansion variable, but is mentioned here because the string
12296 &`$pipe_addresses`& is handled specially in the command specification for the
12297 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12298 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12299 It cannot be used in general expansion strings, and provokes an &"unknown
12300 variable"& error if encountered.
12301
12302 .vitem &$primary_hostname$&
12303 .vindex "&$primary_hostname$&"
12304 This variable contains the value set by &%primary_hostname%& in the
12305 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12306 a single-component name, Exim calls &[gethostbyname()]& (or
12307 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12308 qualified host name. See also &$smtp_active_hostname$&.
12309
12310
12311 .vitem &$proxy_external_address$& &&&
12312        &$proxy_external_port$& &&&
12313        &$proxy_local_address$& &&&
12314        &$proxy_local_port$& &&&
12315        &$proxy_session$&
12316 These variables are only available when built with Proxy Protocol
12317 or SOCKS5 support.
12318 For details see chapter &<<SECTproxyInbound>>&.
12319
12320 .vitem &$prdr_requested$&
12321 .cindex "PRDR" "variable for"
12322 This variable is set to &"yes"& if PRDR was requested by the client for the
12323 current message, otherwise &"no"&.
12324
12325 .vitem &$prvscheck_address$&
12326 This variable is used in conjunction with the &%prvscheck%& expansion item,
12327 which is described in sections &<<SECTexpansionitems>>& and
12328 &<<SECTverifyPRVS>>&.
12329
12330 .vitem &$prvscheck_keynum$&
12331 This variable is used in conjunction with the &%prvscheck%& expansion item,
12332 which is described in sections &<<SECTexpansionitems>>& and
12333 &<<SECTverifyPRVS>>&.
12334
12335 .vitem &$prvscheck_result$&
12336 This variable is used in conjunction with the &%prvscheck%& expansion item,
12337 which is described in sections &<<SECTexpansionitems>>& and
12338 &<<SECTverifyPRVS>>&.
12339
12340 .vitem &$qualify_domain$&
12341 .vindex "&$qualify_domain$&"
12342 The value set for the &%qualify_domain%& option in the configuration file.
12343
12344 .vitem &$qualify_recipient$&
12345 .vindex "&$qualify_recipient$&"
12346 The value set for the &%qualify_recipient%& option in the configuration file,
12347 or if not set, the value of &$qualify_domain$&.
12348
12349 .vitem &$queue_name$&
12350 .vindex &$queue_name$&
12351 .cindex "named queues"
12352 .cindex queues named
12353 The name of the spool queue in use; empty for the default queue.
12354
12355 .vitem &$rcpt_count$&
12356 .vindex "&$rcpt_count$&"
12357 When a message is being received by SMTP, this variable contains the number of
12358 RCPT commands received for the current message. If this variable is used in a
12359 RCPT ACL, its value includes the current command.
12360
12361 .vitem &$rcpt_defer_count$&
12362 .vindex "&$rcpt_defer_count$&"
12363 .cindex "4&'xx'& responses" "count of"
12364 When a message is being received by SMTP, this variable contains the number of
12365 RCPT commands in the current message that have previously been rejected with a
12366 temporary (4&'xx'&) response.
12367
12368 .vitem &$rcpt_fail_count$&
12369 .vindex "&$rcpt_fail_count$&"
12370 When a message is being received by SMTP, this variable contains the number of
12371 RCPT commands in the current message that have previously been rejected with a
12372 permanent (5&'xx'&) response.
12373
12374 .vitem &$received_count$&
12375 .vindex "&$received_count$&"
12376 This variable contains the number of &'Received:'& header lines in the message,
12377 including the one added by Exim (so its value is always greater than zero). It
12378 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12379 delivering.
12380
12381 .vitem &$received_for$&
12382 .vindex "&$received_for$&"
12383 If there is only a single recipient address in an incoming message, this
12384 variable contains that address when the &'Received:'& header line is being
12385 built. The value is copied after recipient rewriting has happened, but before
12386 the &[local_scan()]& function is run.
12387
12388 .vitem &$received_ip_address$&
12389 .vindex "&$received_ip_address$&"
12390 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12391 variable is set to the address of the local IP interface, and &$received_port$&
12392 is set to the local port number. (The remote IP address and port are in
12393 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12394 the port value is -1 unless it has been set using the &%-oMi%& command line
12395 option.
12396
12397 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12398 could be used, for example, to make the file name for a TLS certificate depend
12399 on which interface and/or port is being used for the incoming connection. The
12400 values of &$received_ip_address$& and &$received_port$& are saved with any
12401 messages that are received, thus making these variables available at delivery
12402 time.
12403 For outbound connections see &$sending_ip_address$&.
12404
12405 .vitem &$received_port$&
12406 .vindex "&$received_port$&"
12407 See &$received_ip_address$&.
12408
12409 .vitem &$received_protocol$&
12410 .vindex "&$received_protocol$&"
12411 When a message is being processed, this variable contains the name of the
12412 protocol by which it was received. Most of the names used by Exim are defined
12413 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12414 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12415 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12416 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12417 connection and the client was successfully authenticated.
12418
12419 Exim uses the protocol name &"smtps"& for the case when encryption is
12420 automatically set up on connection without the use of STARTTLS (see
12421 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12422 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12423 where the client initially uses EHLO, sets up an encrypted connection using
12424 STARTTLS, and then uses HELO afterwards.
12425
12426 The &%-oMr%& option provides a way of specifying a custom protocol name for
12427 messages that are injected locally by trusted callers. This is commonly used to
12428 identify messages that are being re-injected after some kind of scanning.
12429
12430 .vitem &$received_time$&
12431 .vindex "&$received_time$&"
12432 This variable contains the date and time when the current message was received,
12433 as a number of seconds since the start of the Unix epoch.
12434
12435 .vitem &$recipient_data$&
12436 .vindex "&$recipient_data$&"
12437 This variable is set after an indexing lookup success in an ACL &%recipients%&
12438 condition. It contains the data from the lookup, and the value remains set
12439 until the next &%recipients%& test. Thus, you can do things like this:
12440 .display
12441 &`require recipients  = cdb*@;/some/file`&
12442 &`deny    `&&'some further test involving'& &`$recipient_data`&
12443 .endd
12444 &*Warning*&: This variable is set only when a lookup is used as an indexing
12445 method in the address list, using the semicolon syntax as in the example above.
12446 The variable is not set for a lookup that is used as part of the string
12447 expansion that all such lists undergo before being interpreted.
12448
12449 .vitem &$recipient_verify_failure$&
12450 .vindex "&$recipient_verify_failure$&"
12451 In an ACL, when a recipient verification fails, this variable contains
12452 information about the failure. It is set to one of the following words:
12453
12454 .ilist
12455 &"qualify"&: The address was unqualified (no domain), and the message
12456 was neither local nor came from an exempted host.
12457
12458 .next
12459 &"route"&: Routing failed.
12460
12461 .next
12462 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12463 or before the MAIL command (that is, on initial connection, HELO, or
12464 MAIL).
12465
12466 .next
12467 &"recipient"&: The RCPT command in a callout was rejected.
12468 .next
12469
12470 &"postmaster"&: The postmaster check in a callout was rejected.
12471 .endlist
12472
12473 The main use of this variable is expected to be to distinguish between
12474 rejections of MAIL and rejections of RCPT.
12475
12476 .vitem &$recipients$&
12477 .vindex "&$recipients$&"
12478 This variable contains a list of envelope recipients for a message. A comma and
12479 a space separate the addresses in the replacement text. However, the variable
12480 is not generally available, to prevent exposure of Bcc recipients in
12481 unprivileged users' filter files. You can use &$recipients$& only in these
12482 cases:
12483
12484 .olist
12485 In a system filter file.
12486 .next
12487 In the ACLs associated with the DATA command and with non-SMTP messages, that
12488 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12489 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12490 &%acl_not_smtp_mime%&.
12491 .next
12492 From within a &[local_scan()]& function.
12493 .endlist
12494
12495
12496 .vitem &$recipients_count$&
12497 .vindex "&$recipients_count$&"
12498 When a message is being processed, this variable contains the number of
12499 envelope recipients that came with the message. Duplicates are not excluded
12500 from the count. While a message is being received over SMTP, the number
12501 increases for each accepted recipient. It can be referenced in an ACL.
12502
12503
12504 .vitem &$regex_match_string$&
12505 .vindex "&$regex_match_string$&"
12506 This variable is set to contain the matching regular expression after a
12507 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12508
12509 .vitem "&$regex1$&, &$regex2$&, etc"
12510 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12511 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12512 these variables contain the
12513 captured substrings identified by the regular expression.
12514
12515
12516 .vitem &$reply_address$&
12517 .vindex "&$reply_address$&"
12518 When a message is being processed, this variable contains the contents of the
12519 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12520 contents of the &'From:'& header line. Apart from the removal of leading
12521 white space, the value is not processed in any way. In particular, no RFC 2047
12522 decoding or character code translation takes place.
12523
12524 .vitem &$return_path$&
12525 .vindex "&$return_path$&"
12526 When a message is being delivered, this variable contains the return path &--
12527 the sender field that will be sent as part of the envelope. It is not enclosed
12528 in <> characters. At the start of routing an address, &$return_path$& has the
12529 same value as &$sender_address$&, but if, for example, an incoming message to a
12530 mailing list has been expanded by a router which specifies a different address
12531 for bounce messages, &$return_path$& subsequently contains the new bounce
12532 address, whereas &$sender_address$& always contains the original sender address
12533 that was received with the message. In other words, &$sender_address$& contains
12534 the incoming envelope sender, and &$return_path$& contains the outgoing
12535 envelope sender.
12536
12537 .vitem &$return_size_limit$&
12538 .vindex "&$return_size_limit$&"
12539 This is an obsolete name for &$bounce_return_size_limit$&.
12540
12541 .vitem &$router_name$&
12542 .cindex "router" "name"
12543 .cindex "name" "of router"
12544 .vindex "&$router_name$&"
12545 During the running of a router this variable contains its name.
12546
12547 .vitem &$runrc$&
12548 .cindex "return code" "from &%run%& expansion"
12549 .vindex "&$runrc$&"
12550 This variable contains the return code from a command that is run by the
12551 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12552 assume the order in which option values are expanded, except for those
12553 preconditions whose order of testing is documented. Therefore, you cannot
12554 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12555 another.
12556
12557 .vitem &$self_hostname$&
12558 .oindex "&%self%&" "value of host name"
12559 .vindex "&$self_hostname$&"
12560 When an address is routed to a supposedly remote host that turns out to be the
12561 local host, what happens is controlled by the &%self%& generic router option.
12562 One of its values causes the address to be passed to another router. When this
12563 happens, &$self_hostname$& is set to the name of the local host that the
12564 original router encountered. In other circumstances its contents are null.
12565
12566 .vitem &$sender_address$&
12567 .vindex "&$sender_address$&"
12568 When a message is being processed, this variable contains the sender's address
12569 that was received in the message's envelope. The case of letters in the address
12570 is retained, in both the local part and the domain. For bounce messages, the
12571 value of this variable is the empty string. See also &$return_path$&.
12572
12573 .vitem &$sender_address_data$&
12574 .vindex "&$address_data$&"
12575 .vindex "&$sender_address_data$&"
12576 If &$address_data$& is set when the routers are called from an ACL to verify a
12577 sender address, the final value is preserved in &$sender_address_data$&, to
12578 distinguish it from data from a recipient address. The value does not persist
12579 after the end of the current ACL statement. If you want to preserve it for
12580 longer, you can save it in an ACL variable.
12581
12582 .vitem &$sender_address_domain$&
12583 .vindex "&$sender_address_domain$&"
12584 The domain portion of &$sender_address$&.
12585
12586 .vitem &$sender_address_local_part$&
12587 .vindex "&$sender_address_local_part$&"
12588 The local part portion of &$sender_address$&.
12589
12590 .vitem &$sender_data$&
12591 .vindex "&$sender_data$&"
12592 This variable is set after a lookup success in an ACL &%senders%& condition or
12593 in a router &%senders%& option. It contains the data from the lookup, and the
12594 value remains set until the next &%senders%& test. Thus, you can do things like
12595 this:
12596 .display
12597 &`require senders      = cdb*@;/some/file`&
12598 &`deny    `&&'some further test involving'& &`$sender_data`&
12599 .endd
12600 &*Warning*&: This variable is set only when a lookup is used as an indexing
12601 method in the address list, using the semicolon syntax as in the example above.
12602 The variable is not set for a lookup that is used as part of the string
12603 expansion that all such lists undergo before being interpreted.
12604
12605 .vitem &$sender_fullhost$&
12606 .vindex "&$sender_fullhost$&"
12607 When a message is received from a remote host, this variable contains the host
12608 name and IP address in a single string. It ends with the IP address in square
12609 brackets, followed by a colon and a port number if the logging of ports is
12610 enabled. The format of the rest of the string depends on whether the host
12611 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12612 looking up its IP address. (Looking up the IP address can be forced by the
12613 &%host_lookup%& option, independent of verification.) A plain host name at the
12614 start of the string is a verified host name; if this is not present,
12615 verification either failed or was not requested. A host name in parentheses is
12616 the argument of a HELO or EHLO command. This is omitted if it is identical to
12617 the verified host name or to the host's IP address in square brackets.
12618
12619 .vitem &$sender_helo_dnssec$&
12620 .vindex "&$sender_helo_dnssec$&"
12621 This boolean variable is true if a successful HELO verification was
12622 .cindex "DNS" "DNSSEC"
12623 done using DNS information the resolver library stated was authenticated data.
12624
12625 .vitem &$sender_helo_name$&
12626 .vindex "&$sender_helo_name$&"
12627 When a message is received from a remote host that has issued a HELO or EHLO
12628 command, the argument of that command is placed in this variable. It is also
12629 set if HELO or EHLO is used when a message is received using SMTP locally via
12630 the &%-bs%& or &%-bS%& options.
12631
12632 .vitem &$sender_host_address$&
12633 .vindex "&$sender_host_address$&"
12634 When a message is received from a remote host using SMTP,
12635 this variable contains that
12636 host's IP address. For locally non-SMTP submitted messages, it is empty.
12637
12638 .vitem &$sender_host_authenticated$&
12639 .vindex "&$sender_host_authenticated$&"
12640 This variable contains the name (not the public name) of the authenticator
12641 driver that successfully authenticated the client from which the message was
12642 received. It is empty if there was no successful authentication. See also
12643 &$authenticated_id$&.
12644
12645 .vitem &$sender_host_dnssec$&
12646 .vindex "&$sender_host_dnssec$&"
12647 If an attempt to populate &$sender_host_name$& has been made
12648 (by reference, &%hosts_lookup%& or
12649 otherwise) then this boolean will have been set true if, and only if, the
12650 resolver library states that both
12651 the reverse and forward DNS were authenticated data.  At all
12652 other times, this variable is false.
12653
12654 .cindex "DNS" "DNSSEC"
12655 It is likely that you will need to coerce DNSSEC support on in the resolver
12656 library, by setting:
12657 .code
12658 dns_dnssec_ok = 1
12659 .endd
12660
12661 Exim does not perform DNSSEC validation itself, instead leaving that to a
12662 validating resolver (e.g. unbound, or bind with suitable configuration).
12663
12664 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12665 mechanism in the list, then this variable will be false.
12666
12667 This requires that your system resolver library support EDNS0 (and that
12668 DNSSEC flags exist in the system headers).  If the resolver silently drops
12669 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12670 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12671
12672
12673 .vitem &$sender_host_name$&
12674 .vindex "&$sender_host_name$&"
12675 When a message is received from a remote host, this variable contains the
12676 host's name as obtained by looking up its IP address. For messages received by
12677 other means, this variable is empty.
12678
12679 .vindex "&$host_lookup_failed$&"
12680 If the host name has not previously been looked up, a reference to
12681 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12682 A looked up name is accepted only if it leads back to the original IP address
12683 via a forward lookup. If either the reverse or the forward lookup fails to find
12684 any data, or if the forward lookup does not yield the original IP address,
12685 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12686
12687 .vindex "&$host_lookup_deferred$&"
12688 However, if either of the lookups cannot be completed (for example, there is a
12689 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12690 &$host_lookup_failed$& remains set to &"0"&.
12691
12692 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12693 host name again if there is a subsequent reference to &$sender_host_name$&
12694 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12695 is set to &"1"&.
12696
12697 Exim does not automatically look up every calling host's name. If you want
12698 maximum efficiency, you should arrange your configuration so that it avoids
12699 these lookups altogether. The lookup happens only if one or more of the
12700 following are true:
12701
12702 .ilist
12703 A string containing &$sender_host_name$& is expanded.
12704 .next
12705 The calling host matches the list in &%host_lookup%&. In the default
12706 configuration, this option is set to *, so it must be changed if lookups are
12707 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12708 .next
12709 Exim needs the host name in order to test an item in a host list. The items
12710 that require this are described in sections &<<SECThoslispatnam>>& and
12711 &<<SECThoslispatnamsk>>&.
12712 .next
12713 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12714 In this case, the host name is required to compare with the name quoted in any
12715 EHLO or HELO commands that the client issues.
12716 .next
12717 The remote host issues a EHLO or HELO command that quotes one of the
12718 domains in &%helo_lookup_domains%&. The default value of this option is
12719 . ==== As this is a nested list, any displays it contains must be indented
12720 . ==== as otherwise they are too far to the left.
12721 .code
12722   helo_lookup_domains = @ : @[]
12723 .endd
12724 which causes a lookup if a remote host (incorrectly) gives the server's name or
12725 IP address in an EHLO or HELO command.
12726 .endlist
12727
12728
12729 .vitem &$sender_host_port$&
12730 .vindex "&$sender_host_port$&"
12731 When a message is received from a remote host, this variable contains the port
12732 number that was used on the remote host.
12733
12734 .vitem &$sender_ident$&
12735 .vindex "&$sender_ident$&"
12736 When a message is received from a remote host, this variable contains the
12737 identification received in response to an RFC 1413 request. When a message has
12738 been received locally, this variable contains the login name of the user that
12739 called Exim.
12740
12741 .vitem &$sender_rate_$&&'xxx'&
12742 A number of variables whose names begin &$sender_rate_$& are set as part of the
12743 &%ratelimit%& ACL condition. Details are given in section
12744 &<<SECTratelimiting>>&.
12745
12746 .vitem &$sender_rcvhost$&
12747 .cindex "DNS" "reverse lookup"
12748 .cindex "reverse DNS lookup"
12749 .vindex "&$sender_rcvhost$&"
12750 This is provided specifically for use in &'Received:'& headers. It starts with
12751 either the verified host name (as obtained from a reverse DNS lookup) or, if
12752 there is no verified host name, the IP address in square brackets. After that
12753 there may be text in parentheses. When the first item is a verified host name,
12754 the first thing in the parentheses is the IP address in square brackets,
12755 followed by a colon and a port number if port logging is enabled. When the
12756 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12757 the parentheses.
12758
12759 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12760 was used and its argument was not identical to the real host name or IP
12761 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12762 all three items are present in the parentheses, a newline and tab are inserted
12763 into the string, to improve the formatting of the &'Received:'& header.
12764
12765 .vitem &$sender_verify_failure$&
12766 .vindex "&$sender_verify_failure$&"
12767 In an ACL, when a sender verification fails, this variable contains information
12768 about the failure. The details are the same as for
12769 &$recipient_verify_failure$&.
12770
12771 .vitem &$sending_ip_address$&
12772 .vindex "&$sending_ip_address$&"
12773 This variable is set whenever an outgoing SMTP connection to another host has
12774 been set up. It contains the IP address of the local interface that is being
12775 used. This is useful if a host that has more than one IP address wants to take
12776 on different personalities depending on which one is being used. For incoming
12777 connections, see &$received_ip_address$&.
12778
12779 .vitem &$sending_port$&
12780 .vindex "&$sending_port$&"
12781 This variable is set whenever an outgoing SMTP connection to another host has
12782 been set up. It contains the local port that is being used. For incoming
12783 connections, see &$received_port$&.
12784
12785 .vitem &$smtp_active_hostname$&
12786 .vindex "&$smtp_active_hostname$&"
12787 During an incoming SMTP session, this variable contains the value of the active
12788 host name, as specified by the &%smtp_active_hostname%& option. The value of
12789 &$smtp_active_hostname$& is saved with any message that is received, so its
12790 value can be consulted during routing and delivery.
12791
12792 .vitem &$smtp_command$&
12793 .vindex "&$smtp_command$&"
12794 During the processing of an incoming SMTP command, this variable contains the
12795 entire command. This makes it possible to distinguish between HELO and EHLO in
12796 the HELO ACL, and also to distinguish between commands such as these:
12797 .code
12798 MAIL FROM:<>
12799 MAIL FROM: <>
12800 .endd
12801 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12802 command, the address in &$smtp_command$& is the original address before any
12803 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12804 the address after SMTP-time rewriting.
12805
12806 .vitem &$smtp_command_argument$&
12807 .cindex "SMTP" "command, argument for"
12808 .vindex "&$smtp_command_argument$&"
12809 While an ACL is running to check an SMTP command, this variable contains the
12810 argument, that is, the text that follows the command name, with leading white
12811 space removed. Following the introduction of &$smtp_command$&, this variable is
12812 somewhat redundant, but is retained for backwards compatibility.
12813
12814 .new
12815 .vitem &$smtp_command_history$&
12816 .cindex SMTP "command history"
12817 .vindex "&$smtp_command_history$&"
12818 A comma-separated list (with no whitespace) of the most-recent SMTP commands
12819 received, in time-order left to right.  Only a limited number of commands
12820 are remembered.
12821 .wen
12822
12823 .vitem &$smtp_count_at_connection_start$&
12824 .vindex "&$smtp_count_at_connection_start$&"
12825 This variable is set greater than zero only in processes spawned by the Exim
12826 daemon for handling incoming SMTP connections. The name is deliberately long,
12827 in order to emphasize what the contents are. When the daemon accepts a new
12828 connection, it increments this variable. A copy of the variable is passed to
12829 the child process that handles the connection, but its value is fixed, and
12830 never changes. It is only an approximation of how many incoming connections
12831 there actually are, because many other connections may come and go while a
12832 single connection is being processed. When a child process terminates, the
12833 daemon decrements its copy of the variable.
12834
12835 .vitem "&$sn0$& &-- &$sn9$&"
12836 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12837 that were current at the end of the system filter file. This allows a system
12838 filter file to set values that can be tested in users' filter files. For
12839 example, a system filter could set a value indicating how likely it is that a
12840 message is junk mail.
12841
12842 .vitem &$spam_$&&'xxx'&
12843 A number of variables whose names start with &$spam$& are available when Exim
12844 is compiled with the content-scanning extension. For details, see section
12845 &<<SECTscanspamass>>&.
12846
12847
12848 .vitem &$spool_directory$&
12849 .vindex "&$spool_directory$&"
12850 The name of Exim's spool directory.
12851
12852 .vitem &$spool_inodes$&
12853 .vindex "&$spool_inodes$&"
12854 The number of free inodes in the disk partition where Exim's spool files are
12855 being written. The value is recalculated whenever the variable is referenced.
12856 If the relevant file system does not have the concept of inodes, the value of
12857 is -1. See also the &%check_spool_inodes%& option.
12858
12859 .vitem &$spool_space$&
12860 .vindex "&$spool_space$&"
12861 The amount of free space (as a number of kilobytes) in the disk partition where
12862 Exim's spool files are being written. The value is recalculated whenever the
12863 variable is referenced. If the operating system does not have the ability to
12864 find the amount of free space (only true for experimental systems), the space
12865 value is -1. For example, to check in an ACL that there is at least 50
12866 megabytes free on the spool, you could write:
12867 .code
12868 condition = ${if > {$spool_space}{50000}}
12869 .endd
12870 See also the &%check_spool_space%& option.
12871
12872
12873 .vitem &$thisaddress$&
12874 .vindex "&$thisaddress$&"
12875 This variable is set only during the processing of the &%foranyaddress%&
12876 command in a filter file. Its use is explained in the description of that
12877 command, which can be found in the separate document entitled &'Exim's
12878 interfaces to mail filtering'&.
12879
12880 .vitem &$tls_in_bits$&
12881 .vindex "&$tls_in_bits$&"
12882 Contains an approximation of the TLS cipher's bit-strength
12883 on the inbound connection; the meaning of
12884 this depends upon the TLS implementation used.
12885 If TLS has not been negotiated, the value will be 0.
12886 The value of this is automatically fed into the Cyrus SASL authenticator
12887 when acting as a server, to specify the "external SSF" (a SASL term).
12888
12889 The deprecated &$tls_bits$& variable refers to the inbound side
12890 except when used in the context of an outbound SMTP delivery, when it refers to
12891 the outbound.
12892
12893 .vitem &$tls_out_bits$&
12894 .vindex "&$tls_out_bits$&"
12895 Contains an approximation of the TLS cipher's bit-strength
12896 on an outbound SMTP connection; the meaning of
12897 this depends upon the TLS implementation used.
12898 If TLS has not been negotiated, the value will be 0.
12899
12900 .vitem &$tls_in_ourcert$&
12901 .vindex "&$tls_in_ourcert$&"
12902 .cindex certificate variables
12903 This variable refers to the certificate presented to the peer of an
12904 inbound connection when the message was received.
12905 It is only useful as the argument of a
12906 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12907 or a &%def%& condition.
12908
12909 .vitem &$tls_in_peercert$&
12910 .vindex "&$tls_in_peercert$&"
12911 This variable refers to the certificate presented by the peer of an
12912 inbound connection when the message was received.
12913 It is only useful as the argument of a
12914 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12915 or a &%def%& condition.
12916 If certificate verification fails it may refer to a failing chain element
12917 which is not the leaf.
12918
12919 .vitem &$tls_out_ourcert$&
12920 .vindex "&$tls_out_ourcert$&"
12921 This variable refers to the certificate presented to the peer of an
12922 outbound connection.  It is only useful as the argument of a
12923 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12924 or a &%def%& condition.
12925
12926 .vitem &$tls_out_peercert$&
12927 .vindex "&$tls_out_peercert$&"
12928 This variable refers to the certificate presented by the peer of an
12929 outbound connection.  It is only useful as the argument of a
12930 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12931 or a &%def%& condition.
12932 If certificate verification fails it may refer to a failing chain element
12933 which is not the leaf.
12934
12935 .vitem &$tls_in_certificate_verified$&
12936 .vindex "&$tls_in_certificate_verified$&"
12937 This variable is set to &"1"& if a TLS certificate was verified when the
12938 message was received, and &"0"& otherwise.
12939
12940 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12941 except when used in the context of an outbound SMTP delivery, when it refers to
12942 the outbound.
12943
12944 .vitem &$tls_out_certificate_verified$&
12945 .vindex "&$tls_out_certificate_verified$&"
12946 This variable is set to &"1"& if a TLS certificate was verified when an
12947 outbound SMTP connection was made,
12948 and &"0"& otherwise.
12949
12950 .vitem &$tls_in_cipher$&
12951 .vindex "&$tls_in_cipher$&"
12952 .vindex "&$tls_cipher$&"
12953 When a message is received from a remote host over an encrypted SMTP
12954 connection, this variable is set to the cipher suite that was negotiated, for
12955 example DES-CBC3-SHA. In other circumstances, in particular, for message
12956 received over unencrypted connections, the variable is empty. Testing
12957 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12958 non-encrypted connections during ACL processing.
12959
12960 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12961 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12962 becomes the same as &$tls_out_cipher$&.
12963
12964 .vitem &$tls_out_cipher$&
12965 .vindex "&$tls_out_cipher$&"
12966 This variable is
12967 cleared before any outgoing SMTP connection is made,
12968 and then set to the outgoing cipher suite if one is negotiated. See chapter
12969 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12970 details of the &(smtp)& transport.
12971
12972 .vitem &$tls_in_ocsp$&
12973 .vindex "&$tls_in_ocsp$&"
12974 When a message is received from a remote client connection
12975 the result of any OCSP request from the client is encoded in this variable:
12976 .code
12977 0 OCSP proof was not requested (default value)
12978 1 No response to request
12979 2 Response not verified
12980 3 Verification failed
12981 4 Verification succeeded
12982 .endd
12983
12984 .vitem &$tls_out_ocsp$&
12985 .vindex "&$tls_out_ocsp$&"
12986 When a message is sent to a remote host connection
12987 the result of any OCSP request made is encoded in this variable.
12988 See &$tls_in_ocsp$& for values.
12989
12990 .vitem &$tls_in_peerdn$&
12991 .vindex "&$tls_in_peerdn$&"
12992 .vindex "&$tls_peerdn$&"
12993 .cindex certificate "extracting fields"
12994 When a message is received from a remote host over an encrypted SMTP
12995 connection, and Exim is configured to request a certificate from the client,
12996 the value of the Distinguished Name of the certificate is made available in the
12997 &$tls_in_peerdn$& during subsequent processing.
12998 If certificate verification fails it may refer to a failing chain element
12999 which is not the leaf.
13000
13001 The deprecated &$tls_peerdn$& variable refers to the inbound side
13002 except when used in the context of an outbound SMTP delivery, when it refers to
13003 the outbound.
13004
13005 .vitem &$tls_out_peerdn$&
13006 .vindex "&$tls_out_peerdn$&"
13007 When a message is being delivered to a remote host over an encrypted SMTP
13008 connection, and Exim is configured to request a certificate from the server,
13009 the value of the Distinguished Name of the certificate is made available in the
13010 &$tls_out_peerdn$& during subsequent processing.
13011 If certificate verification fails it may refer to a failing chain element
13012 which is not the leaf.
13013
13014 .vitem &$tls_in_sni$&
13015 .vindex "&$tls_in_sni$&"
13016 .vindex "&$tls_sni$&"
13017 .cindex "TLS" "Server Name Indication"
13018 When a TLS session is being established, if the client sends the Server
13019 Name Indication extension, the value will be placed in this variable.
13020 If the variable appears in &%tls_certificate%& then this option and
13021 some others, described in &<<SECTtlssni>>&,
13022 will be re-expanded early in the TLS session, to permit
13023 a different certificate to be presented (and optionally a different key to be
13024 used) to the client, based upon the value of the SNI extension.
13025
13026 The deprecated &$tls_sni$& variable refers to the inbound side
13027 except when used in the context of an outbound SMTP delivery, when it refers to
13028 the outbound.
13029
13030 .vitem &$tls_out_sni$&
13031 .vindex "&$tls_out_sni$&"
13032 .cindex "TLS" "Server Name Indication"
13033 During outbound
13034 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13035 the transport.
13036
13037 .vitem &$tod_bsdinbox$&
13038 .vindex "&$tod_bsdinbox$&"
13039 The time of day and the date, in the format required for BSD-style mailbox
13040 files, for example: Thu Oct 17 17:14:09 1995.
13041
13042 .vitem &$tod_epoch$&
13043 .vindex "&$tod_epoch$&"
13044 The time and date as a number of seconds since the start of the Unix epoch.
13045
13046 .vitem &$tod_epoch_l$&
13047 .vindex "&$tod_epoch_l$&"
13048 The time and date as a number of microseconds since the start of the Unix epoch.
13049
13050 .vitem &$tod_full$&
13051 .vindex "&$tod_full$&"
13052 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13053 +0100. The timezone is always given as a numerical offset from UTC, with
13054 positive values used for timezones that are ahead (east) of UTC, and negative
13055 values for those that are behind (west).
13056
13057 .vitem &$tod_log$&
13058 .vindex "&$tod_log$&"
13059 The time and date in the format used for writing Exim's log files, for example:
13060 1995-10-12 15:32:29, but without a timezone.
13061
13062 .vitem &$tod_logfile$&
13063 .vindex "&$tod_logfile$&"
13064 This variable contains the date in the format yyyymmdd. This is the format that
13065 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13066 flag.
13067
13068 .vitem &$tod_zone$&
13069 .vindex "&$tod_zone$&"
13070 This variable contains the numerical value of the local timezone, for example:
13071 -0500.
13072
13073 .vitem &$tod_zulu$&
13074 .vindex "&$tod_zulu$&"
13075 This variable contains the UTC date and time in &"Zulu"& format, as specified
13076 by ISO 8601, for example: 20030221154023Z.
13077
13078 .vitem &$transport_name$&
13079 .cindex "transport" "name"
13080 .cindex "name" "of transport"
13081 .vindex "&$transport_name$&"
13082 During the running of a transport, this variable contains its name.
13083
13084 .vitem &$value$&
13085 .vindex "&$value$&"
13086 This variable contains the result of an expansion lookup, extraction operation,
13087 or external command, as described above. It is also used during a
13088 &*reduce*& expansion.
13089
13090 .vitem &$verify_mode$&
13091 .vindex "&$verify_mode$&"
13092 While a router or transport is being run in verify mode or for cutthrough delivery,
13093 contains "S" for sender-verification or "R" for recipient-verification.
13094 Otherwise, empty.
13095
13096 .vitem &$version_number$&
13097 .vindex "&$version_number$&"
13098 The version number of Exim.
13099
13100 .vitem &$warn_message_delay$&
13101 .vindex "&$warn_message_delay$&"
13102 This variable is set only during the creation of a message warning about a
13103 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13104
13105 .vitem &$warn_message_recipients$&
13106 .vindex "&$warn_message_recipients$&"
13107 This variable is set only during the creation of a message warning about a
13108 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13109 .endlist
13110 .ecindex IIDstrexp
13111
13112
13113
13114 . ////////////////////////////////////////////////////////////////////////////
13115 . ////////////////////////////////////////////////////////////////////////////
13116
13117 .chapter "Embedded Perl" "CHAPperl"
13118 .scindex IIDperl "Perl" "calling from Exim"
13119 Exim can be built to include an embedded Perl interpreter. When this is done,
13120 Perl subroutines can be called as part of the string expansion process. To make
13121 use of the Perl support, you need version 5.004 or later of Perl installed on
13122 your system. To include the embedded interpreter in the Exim binary, include
13123 the line
13124 .code
13125 EXIM_PERL = perl.o
13126 .endd
13127 in your &_Local/Makefile_& and then build Exim in the normal way.
13128
13129
13130 .section "Setting up so Perl can be used" "SECID85"
13131 .oindex "&%perl_startup%&"
13132 Access to Perl subroutines is via a global configuration option called
13133 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13134 no &%perl_startup%& option in the Exim configuration file then no Perl
13135 interpreter is started and there is almost no overhead for Exim (since none of
13136 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13137 option then the associated value is taken to be Perl code which is executed in
13138 a newly created Perl interpreter.
13139
13140 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13141 need backslashes before any characters to escape special meanings. The option
13142 should usually be something like
13143 .code
13144 perl_startup = do '/etc/exim.pl'
13145 .endd
13146 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13147 use from Exim. Exim can be configured either to start up a Perl interpreter as
13148 soon as it is entered, or to wait until the first time it is needed. Starting
13149 the interpreter at the beginning ensures that it is done while Exim still has
13150 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13151 fact used in a particular run. Also, note that this does not mean that Exim is
13152 necessarily running as root when Perl is called at a later time. By default,
13153 the interpreter is started only when it is needed, but this can be changed in
13154 two ways:
13155
13156 .ilist
13157 .oindex "&%perl_at_start%&"
13158 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13159 a startup when Exim is entered.
13160 .next
13161 The command line option &%-ps%& also requests a startup when Exim is entered,
13162 overriding the setting of &%perl_at_start%&.
13163 .endlist
13164
13165 There is also a command line option &%-pd%& (for delay) which suppresses the
13166 initial startup, even if &%perl_at_start%& is set.
13167
13168 .ilist
13169 .oindex "&%perl_taintmode%&"
13170 .cindex "Perl" "taintmode"
13171 To provide more security executing Perl code via the embedded Perl
13172 interpreter, the &%perl_taintmode%& option can be set. This enables the
13173 taint mode of the Perl interpreter. You are encouraged to set this
13174 option to a true value. To avoid breaking existing installations, it
13175 defaults to false.
13176
13177
13178 .section "Calling Perl subroutines" "SECID86"
13179 When the configuration file includes a &%perl_startup%& option you can make use
13180 of the string expansion item to call the Perl subroutines that are defined
13181 by the &%perl_startup%& code. The operator is used in any of the following
13182 forms:
13183 .code
13184 ${perl{foo}}
13185 ${perl{foo}{argument}}
13186 ${perl{foo}{argument1}{argument2} ... }
13187 .endd
13188 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13189 arguments may be passed. Passing more than this results in an expansion failure
13190 with an error message of the form
13191 .code
13192 Too many arguments passed to Perl subroutine "foo" (max is 8)
13193 .endd
13194 The return value of the Perl subroutine is evaluated in a scalar context before
13195 it is passed back to Exim to be inserted into the expanded string. If the
13196 return value is &'undef'&, the expansion is forced to fail in the same way as
13197 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13198 by obeying Perl's &%die%& function, the expansion fails with the error message
13199 that was passed to &%die%&.
13200
13201
13202 .section "Calling Exim functions from Perl" "SECID87"
13203 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13204 is available to call back into Exim's string expansion function. For example,
13205 the Perl code
13206 .code
13207 my $lp = Exim::expand_string('$local_part');
13208 .endd
13209 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13210 Note those are single quotes and not double quotes to protect against
13211 &$local_part$& being interpolated as a Perl variable.
13212
13213 If the string expansion is forced to fail by a &"fail"& item, the result of
13214 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13215 expansion string, the Perl call from the original expansion string fails with
13216 an appropriate error message, in the same way as if &%die%& were used.
13217
13218 .cindex "debugging" "from embedded Perl"
13219 .cindex "log" "writing from embedded Perl"
13220 Two other Exim functions are available for use from within Perl code.
13221 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13222 debugging is enabled. If you want a newline at the end, you must supply it.
13223 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13224 timestamp. In this case, you should not supply a terminating newline.
13225
13226
13227 .section "Use of standard output and error by Perl" "SECID88"
13228 .cindex "Perl" "standard output and error"
13229 You should not write to the standard error or output streams from within your
13230 Perl code, as it is not defined how these are set up. In versions of Exim
13231 before 4.50, it is possible for the standard output or error to refer to the
13232 SMTP connection during message reception via the daemon. Writing to this stream
13233 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13234 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13235 avoided, but the output is lost.
13236
13237 .cindex "Perl" "use of &%warn%&"
13238 The Perl &%warn%& statement writes to the standard error stream by default.
13239 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13240 you have no control. When Exim starts up the Perl interpreter, it arranges for
13241 output from the &%warn%& statement to be written to the Exim main log. You can
13242 change this by including appropriate Perl magic somewhere in your Perl code.
13243 For example, to discard &%warn%& output completely, you need this:
13244 .code
13245 $SIG{__WARN__} = sub { };
13246 .endd
13247 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13248 example, the code for the subroutine is empty, so it does nothing, but you can
13249 include any Perl code that you like. The text of the &%warn%& message is passed
13250 as the first subroutine argument.
13251 .ecindex IIDperl
13252
13253
13254 . ////////////////////////////////////////////////////////////////////////////
13255 . ////////////////////////////////////////////////////////////////////////////
13256
13257 .chapter "Starting the daemon and the use of network interfaces" &&&
13258          "CHAPinterfaces" &&&
13259          "Starting the daemon"
13260 .cindex "daemon" "starting"
13261 .cindex "interface" "listening"
13262 .cindex "network interface"
13263 .cindex "interface" "network"
13264 .cindex "IP address" "for listening"
13265 .cindex "daemon" "listening IP addresses"
13266 .cindex "TCP/IP" "setting listening interfaces"
13267 .cindex "TCP/IP" "setting listening ports"
13268 A host that is connected to a TCP/IP network may have one or more physical
13269 hardware network interfaces. Each of these interfaces may be configured as one
13270 or more &"logical"& interfaces, which are the entities that a program actually
13271 works with. Each of these logical interfaces is associated with an IP address.
13272 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13273 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13274 knowledge about the host's interfaces for use in three different circumstances:
13275
13276 .olist
13277 When a listening daemon is started, Exim needs to know which interfaces
13278 and ports to listen on.
13279 .next
13280 When Exim is routing an address, it needs to know which IP addresses
13281 are associated with local interfaces. This is required for the correct
13282 processing of MX lists by removing the local host and others with the
13283 same or higher priority values. Also, Exim needs to detect cases
13284 when an address is routed to an IP address that in fact belongs to the
13285 local host. Unless the &%self%& router option or the &%allow_localhost%&
13286 option of the smtp transport is set (as appropriate), this is treated
13287 as an error situation.
13288 .next
13289 When Exim connects to a remote host, it may need to know which interface to use
13290 for the outgoing connection.
13291 .endlist
13292
13293
13294 Exim's default behaviour is likely to be appropriate in the vast majority
13295 of cases. If your host has only one interface, and you want all its IP
13296 addresses to be treated in the same way, and you are using only the
13297 standard SMTP port, you should not need to take any special action. The
13298 rest of this chapter does not apply to you.
13299
13300 In a more complicated situation you may want to listen only on certain
13301 interfaces, or on different ports, and for this reason there are a number of
13302 options that can be used to influence Exim's behaviour. The rest of this
13303 chapter describes how they operate.
13304
13305 When a message is received over TCP/IP, the interface and port that were
13306 actually used are set in &$received_ip_address$& and &$received_port$&.
13307
13308
13309
13310 .section "Starting a listening daemon" "SECID89"
13311 When a listening daemon is started (by means of the &%-bd%& command line
13312 option), the interfaces and ports on which it listens are controlled by the
13313 following options:
13314
13315 .ilist
13316 &%daemon_smtp_ports%& contains a list of default ports
13317 or service names.
13318 (For backward compatibility, this option can also be specified in the singular.)
13319 .next
13320 &%local_interfaces%& contains list of interface IP addresses on which to
13321 listen. Each item may optionally also specify a port.
13322 .endlist
13323
13324 The default list separator in both cases is a colon, but this can be changed as
13325 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13326 it is usually best to change the separator to avoid having to double all the
13327 colons. For example:
13328 .code
13329 local_interfaces = <; 127.0.0.1 ; \
13330                       192.168.23.65 ; \
13331                       ::1 ; \
13332                       3ffe:ffff:836f::fe86:a061
13333 .endd
13334 There are two different formats for specifying a port along with an IP address
13335 in &%local_interfaces%&:
13336
13337 .olist
13338 The port is added onto the address with a dot separator. For example, to listen
13339 on port 1234 on two different IP addresses:
13340 .code
13341 local_interfaces = <; 192.168.23.65.1234 ; \
13342                       3ffe:ffff:836f::fe86:a061.1234
13343 .endd
13344 .next
13345 The IP address is enclosed in square brackets, and the port is added
13346 with a colon separator, for example:
13347 .code
13348 local_interfaces = <; [192.168.23.65]:1234 ; \
13349                       [3ffe:ffff:836f::fe86:a061]:1234
13350 .endd
13351 .endlist
13352
13353 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13354 default setting contains just one port:
13355 .code
13356 daemon_smtp_ports = smtp
13357 .endd
13358 If more than one port is listed, each interface that does not have its own port
13359 specified listens on all of them. Ports that are listed in
13360 &%daemon_smtp_ports%& can be identified either by name (defined in
13361 &_/etc/services_&) or by number. However, when ports are given with individual
13362 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13363
13364
13365
13366 .section "Special IP listening addresses" "SECID90"
13367 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13368 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13369 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13370 instead of setting up separate listening sockets for each interface. The
13371 default value of &%local_interfaces%& is
13372 .code
13373 local_interfaces = 0.0.0.0
13374 .endd
13375 when Exim is built without IPv6 support; otherwise it is:
13376 .code
13377 local_interfaces = <; ::0 ; 0.0.0.0
13378 .endd
13379 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13380
13381
13382
13383 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13384 The &%-oX%& command line option can be used to override the values of
13385 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13386 instance. Another way of doing this would be to use macros and the &%-D%&
13387 option. However, &%-oX%& can be used by any admin user, whereas modification of
13388 the runtime configuration by &%-D%& is allowed only when the caller is root or
13389 exim.
13390
13391 The value of &%-oX%& is a list of items. The default colon separator can be
13392 changed in the usual way if required. If there are any items that do not
13393 contain dots or colons (that is, are not IP addresses), the value of
13394 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13395 items that do contain dots or colons, the value of &%local_interfaces%& is
13396 replaced by those items. Thus, for example,
13397 .code
13398 -oX 1225
13399 .endd
13400 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13401 whereas
13402 .code
13403 -oX 192.168.34.5.1125
13404 .endd
13405 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13406 (However, since &%local_interfaces%& now contains no items without ports, the
13407 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13408
13409
13410
13411 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13412 .cindex "ssmtp protocol"
13413 .cindex "smtps protocol"
13414 .cindex "SMTP" "ssmtp protocol"
13415 .cindex "SMTP" "smtps protocol"
13416 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13417 before the STARTTLS command was standardized for SMTP. Some legacy clients
13418 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13419 list of port numbers or service names,
13420 connections to those ports must use SSMTP. The most
13421 common use of this option is expected to be
13422 .code
13423 tls_on_connect_ports = 465
13424 .endd
13425 because 465 is the usual port number used by the legacy clients. There is also
13426 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13427 this way when a daemon is started.
13428
13429 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13430 daemon to listen on those ports. You must still specify them in
13431 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13432 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13433 connections via the daemon.)
13434
13435
13436
13437
13438 .section "IPv6 address scopes" "SECID92"
13439 .cindex "IPv6" "address scopes"
13440 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13441 can, in principle, have the same link-local IPv6 address on different
13442 interfaces. Thus, additional information is needed, over and above the IP
13443 address, to distinguish individual interfaces. A convention of using a
13444 percent sign followed by something (often the interface name) has been
13445 adopted in some cases, leading to addresses like this:
13446 .code
13447 fe80::202:b3ff:fe03:45c1%eth0
13448 .endd
13449 To accommodate this usage, a percent sign followed by an arbitrary string is
13450 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13451 to convert a textual IPv6 address for actual use. This function recognizes the
13452 percent convention in operating systems that support it, and it processes the
13453 address appropriately. Unfortunately, some older libraries have problems with
13454 &[getaddrinfo()]&. If
13455 .code
13456 IPV6_USE_INET_PTON=yes
13457 .endd
13458 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13459 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13460 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13461 function.) Of course, this means that the additional functionality of
13462 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13463
13464 .section "Disabling IPv6" "SECID93"
13465 .cindex "IPv6" "disabling"
13466 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13467 run on a host whose kernel does not support IPv6. The binary will fall back to
13468 using IPv4, but it may waste resources looking up AAAA records, and trying to
13469 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13470 .oindex "&%disable_ipv6%&"
13471 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13472 activities take place. AAAA records are never looked up, and any IPv6 addresses
13473 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13474 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13475 to handle IPv6 literal addresses.
13476
13477 On the other hand, when IPv6 is in use, there may be times when you want to
13478 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13479 option to globally suppress the lookup of AAAA records for specified domains,
13480 and you can use the &%ignore_target_hosts%& generic router option to ignore
13481 IPv6 addresses in an individual router.
13482
13483
13484
13485 .section "Examples of starting a listening daemon" "SECID94"
13486 The default case in an IPv6 environment is
13487 .code
13488 daemon_smtp_ports = smtp
13489 local_interfaces = <; ::0 ; 0.0.0.0
13490 .endd
13491 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13492 Either one or two sockets may be used, depending on the characteristics of
13493 the TCP/IP stack. (This is complicated and messy; for more information,
13494 read the comments in the &_daemon.c_& source file.)
13495
13496 To specify listening on ports 25 and 26 on all interfaces:
13497 .code
13498 daemon_smtp_ports = 25 : 26
13499 .endd
13500 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13501 .code
13502 local_interfaces = <; ::0.25     ; ::0.26 \
13503                       0.0.0.0.25 ; 0.0.0.0.26
13504 .endd
13505 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13506 IPv4 loopback address only:
13507 .code
13508 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13509 .endd
13510 To specify listening on the default port on specific interfaces only:
13511 .code
13512 local_interfaces = 10.0.0.67 : 192.168.34.67
13513 .endd
13514 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13515
13516
13517
13518 .section "Recognizing the local host" "SECTreclocipadd"
13519 The &%local_interfaces%& option is also used when Exim needs to determine
13520 whether or not an IP address refers to the local host. That is, the IP
13521 addresses of all the interfaces on which a daemon is listening are always
13522 treated as local.
13523
13524 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13525 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13526 available interfaces from the operating system, and extracts the relevant
13527 (that is, IPv4 or IPv6) addresses to use for checking.
13528
13529 Some systems set up large numbers of virtual interfaces in order to provide
13530 many virtual web servers. In this situation, you may want to listen for
13531 email on only a few of the available interfaces, but nevertheless treat all
13532 interfaces as local when routing. You can do this by setting
13533 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13534 &"all"& wildcard values. These addresses are recognized as local, but are not
13535 used for listening. Consider this example:
13536 .code
13537 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13538                       192.168.53.235 ; \
13539                       3ffe:2101:12:1:a00:20ff:fe86:a061
13540
13541 extra_local_interfaces = <; ::0 ; 0.0.0.0
13542 .endd
13543 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13544 address, but all available interface addresses are treated as local when
13545 Exim is routing.
13546
13547 In some environments the local host name may be in an MX list, but with an IP
13548 address that is not assigned to any local interface. In other cases it may be
13549 desirable to treat other host names as if they referred to the local host. Both
13550 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13551 This contains host names rather than IP addresses. When a host is referenced
13552 during routing, either via an MX record or directly, it is treated as the local
13553 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13554 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13555
13556
13557
13558 .section "Delivering to a remote host" "SECID95"
13559 Delivery to a remote host is handled by the smtp transport. By default, it
13560 allows the system's TCP/IP functions to choose which interface to use (if
13561 there is more than one) when connecting to a remote host. However, the
13562 &%interface%& option can be set to specify which interface is used. See the
13563 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13564 details.
13565
13566
13567
13568
13569 . ////////////////////////////////////////////////////////////////////////////
13570 . ////////////////////////////////////////////////////////////////////////////
13571
13572 .chapter "Main configuration" "CHAPmainconfig"
13573 .scindex IIDconfima "configuration file" "main section"
13574 .scindex IIDmaiconf "main configuration"
13575 The first part of the run time configuration file contains three types of item:
13576
13577 .ilist
13578 Macro definitions: These lines start with an upper case letter. See section
13579 &<<SECTmacrodefs>>& for details of macro processing.
13580 .next
13581 Named list definitions: These lines start with one of the words &"domainlist"&,
13582 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13583 section &<<SECTnamedlists>>&.
13584 .next
13585 Main configuration settings: Each setting occupies one line of the file
13586 (with possible continuations). If any setting is preceded by the word
13587 &"hide"&, the &%-bP%& command line option displays its value to admin users
13588 only. See section &<<SECTcos>>& for a description of the syntax of these option
13589 settings.
13590 .endlist
13591
13592 This chapter specifies all the main configuration options, along with their
13593 types and default values. For ease of finding a particular option, they appear
13594 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13595 are now so many options, they are first listed briefly in functional groups, as
13596 an aid to finding the name of the option you are looking for. Some options are
13597 listed in more than one group.
13598
13599 .section "Miscellaneous" "SECID96"
13600 .table2
13601 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13602 .row &%debug_store%&                 "do extra internal checks"
13603 .row &%disable_ipv6%&                "do no IPv6 processing"
13604 .row &%keep_malformed%&              "for broken files &-- should not happen"
13605 .row &%localhost_number%&            "for unique message ids in clusters"
13606 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13607 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13608 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13609 .row &%print_topbitchars%&           "top-bit characters are printing"
13610 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
13611 .row &%timezone%&                    "force time zone"
13612 .endtable
13613
13614
13615 .section "Exim parameters" "SECID97"
13616 .table2
13617 .row &%exim_group%&                  "override compiled-in value"
13618 .row &%exim_path%&                   "override compiled-in value"
13619 .row &%exim_user%&                   "override compiled-in value"
13620 .row &%primary_hostname%&            "default from &[uname()]&"
13621 .row &%split_spool_directory%&       "use multiple directories"
13622 .row &%spool_directory%&             "override compiled-in value"
13623 .endtable
13624
13625
13626
13627 .section "Privilege controls" "SECID98"
13628 .table2
13629 .row &%admin_groups%&                "groups that are Exim admin users"
13630 .row &%commandline_checks_require_admin%& "require admin for various checks"
13631 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13632 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13633 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13634 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13635 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13636 .row &%never_users%&                 "do not run deliveries as these"
13637 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13638 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13639 .row &%trusted_groups%&              "groups that are trusted"
13640 .row &%trusted_users%&               "users that are trusted"
13641 .endtable
13642
13643
13644
13645 .section "Logging" "SECID99"
13646 .table2
13647 .row &%event_action%&                "custom logging"
13648 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13649 .row &%log_file_path%&               "override compiled-in value"
13650 .row &%log_selector%&                "set/unset optional logging"
13651 .row &%log_timezone%&                "add timezone to log lines"
13652 .row &%message_logs%&                "create per-message logs"
13653 .row &%preserve_message_logs%&       "after message completion"
13654 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13655 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13656 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13657 .row &%syslog_facility%&             "set syslog &""facility""& field"
13658 .row &%syslog_pid%&                  "pid in syslog lines"
13659 .row &%syslog_processname%&          "set syslog &""ident""& field"
13660 .row &%syslog_timestamp%&            "timestamp syslog lines"
13661 .row &%write_rejectlog%&             "control use of message log"
13662 .endtable
13663
13664
13665
13666 .section "Frozen messages" "SECID100"
13667 .table2
13668 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13669 .row &%freeze_tell%&                 "send message when freezing"
13670 .row &%move_frozen_messages%&        "to another directory"
13671 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13672 .endtable
13673
13674
13675
13676 .section "Data lookups" "SECID101"
13677 .table2
13678 .row &%ibase_servers%&               "InterBase servers"
13679 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13680 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13681 .row &%ldap_cert_file%&              "client cert file for LDAP"
13682 .row &%ldap_cert_key%&               "client key file for LDAP"
13683 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13684 .row &%ldap_default_servers%&        "used if no server in query"
13685 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13686 .row &%ldap_start_tls%&              "require TLS within LDAP"
13687 .row &%ldap_version%&                "set protocol version"
13688 .row &%lookup_open_max%&             "lookup files held open"
13689 .row &%mysql_servers%&               "default MySQL servers"
13690 .row &%oracle_servers%&              "Oracle servers"
13691 .row &%pgsql_servers%&               "default PostgreSQL servers"
13692 .row &%sqlite_lock_timeout%&         "as it says"
13693 .endtable
13694
13695
13696
13697 .section "Message ids" "SECID102"
13698 .table2
13699 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13700 .row &%message_id_header_text%&      "ditto"
13701 .endtable
13702
13703
13704
13705 .section "Embedded Perl Startup" "SECID103"
13706 .table2
13707 .row &%perl_at_start%&               "always start the interpreter"
13708 .row &%perl_startup%&                "code to obey when starting Perl"
13709 .row &%perl_taintmode%&              "enable taint mode in Perl"
13710 .endtable
13711
13712
13713
13714 .section "Daemon" "SECID104"
13715 .table2
13716 .row &%daemon_smtp_ports%&           "default ports"
13717 .row &%daemon_startup_retries%&      "number of times to retry"
13718 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13719 .row &%extra_local_interfaces%&      "not necessarily listened on"
13720 .row &%local_interfaces%&            "on which to listen, with optional ports"
13721 .row &%pid_file_path%&               "override compiled-in value"
13722 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13723 .endtable
13724
13725
13726
13727 .section "Resource control" "SECID105"
13728 .table2
13729 .row &%check_log_inodes%&            "before accepting a message"
13730 .row &%check_log_space%&             "before accepting a message"
13731 .row &%check_spool_inodes%&          "before accepting a message"
13732 .row &%check_spool_space%&           "before accepting a message"
13733 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13734 .row &%queue_only_load%&             "queue incoming if load high"
13735 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13736 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13737 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13738 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13739 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13740 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13741 .row &%smtp_accept_max_per_connection%& "messages per connection"
13742 .row &%smtp_accept_max_per_host%&    "connections from one host"
13743 .row &%smtp_accept_queue%&           "queue mail if more connections"
13744 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13745                                            connection"
13746 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13747 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13748 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13749 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13750 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13751 .endtable
13752
13753
13754
13755 .section "Policy controls" "SECID106"
13756 .table2
13757 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13758 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13759 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13760 .row &%acl_smtp_auth%&               "ACL for AUTH"
13761 .row &%acl_smtp_connect%&            "ACL for connection"
13762 .row &%acl_smtp_data%&               "ACL for DATA"
13763 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13764 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13765 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13766 .row &%acl_smtp_expn%&               "ACL for EXPN"
13767 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13768 .row &%acl_smtp_mail%&               "ACL for MAIL"
13769 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13770 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13771 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13772 .row &%acl_smtp_predata%&            "ACL for start of data"
13773 .row &%acl_smtp_quit%&               "ACL for QUIT"
13774 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13775 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13776 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13777 .row &%av_scanner%&                  "specify virus scanner"
13778 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13779                                       words""&"
13780 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13781 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13782 .row &%header_maxsize%&              "total size of message header"
13783 .row &%header_line_maxsize%&         "individual header line limit"
13784 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13785 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13786 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13787 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13788 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13789 .row &%host_lookup%&                 "host name looked up for these hosts"
13790 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13791 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13792 .row &%host_reject_connection%&      "reject connection from these hosts"
13793 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13794 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13795 .row &%message_size_limit%&          "for all messages"
13796 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13797 .row &%spamd_address%&               "set interface to SpamAssassin"
13798 .row &%strict_acl_vars%&             "object to unset ACL variables"
13799 .endtable
13800
13801
13802
13803 .section "Callout cache" "SECID107"
13804 .table2
13805 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13806                                          item"
13807 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13808                                          item"
13809 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13810 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13811 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13812 .endtable
13813
13814
13815
13816 .section "TLS" "SECID108"
13817 .table2
13818 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13819 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13820 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13821 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13822 .row &%tls_certificate%&             "location of server certificate"
13823 .row &%tls_crl%&                     "certificate revocation list"
13824 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13825 .row &%tls_dhparam%&                 "DH parameters for server"
13826 .row &%tls_eccurve%&                 "EC curve selection for server"
13827 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13828 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13829 .row &%tls_privatekey%&              "location of server private key"
13830 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13831 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13832 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13833 .row &%tls_verify_certificates%&     "expected client certificates"
13834 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13835 .endtable
13836
13837
13838
13839 .section "Local user handling" "SECID109"
13840 .table2
13841 .row &%finduser_retries%&            "useful in NIS environments"
13842 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13843 .row &%gecos_pattern%&               "ditto"
13844 .row &%max_username_length%&         "for systems that truncate"
13845 .row &%unknown_login%&               "used when no login name found"
13846 .row &%unknown_username%&            "ditto"
13847 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13848 .row &%uucp_from_sender%&            "ditto"
13849 .endtable
13850
13851
13852
13853 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13854 .table2
13855 .row &%header_maxsize%&              "total size of message header"
13856 .row &%header_line_maxsize%&         "individual header line limit"
13857 .row &%message_size_limit%&          "applies to all messages"
13858 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13859 .row &%received_header_text%&        "expanded to make &'Received:'&"
13860 .row &%received_headers_max%&        "for mail loop detection"
13861 .row &%recipients_max%&              "limit per message"
13862 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13863 .endtable
13864
13865
13866
13867
13868 .section "Non-SMTP incoming messages" "SECID111"
13869 .table2
13870 .row &%receive_timeout%&             "for non-SMTP messages"
13871 .endtable
13872
13873
13874
13875
13876
13877 .section "Incoming SMTP messages" "SECID112"
13878 See also the &'Policy controls'& section above.
13879
13880 .table2
13881 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13882 .row &%host_lookup%&                 "host name looked up for these hosts"
13883 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13884 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13885 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13886 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13887 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13888 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13889 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13890 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13891 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13892 .row &%smtp_accept_max_per_connection%& "messages per connection"
13893 .row &%smtp_accept_max_per_host%&    "connections from one host"
13894 .row &%smtp_accept_queue%&           "queue mail if more connections"
13895 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13896                                            connection"
13897 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13898 .row &%smtp_active_hostname%&        "host name to use in messages"
13899 .row &%smtp_banner%&                 "text for welcome banner"
13900 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13901 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13902 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13903 .row &%smtp_etrn_command%&           "what to run for ETRN"
13904 .row &%smtp_etrn_serialize%&         "only one at once"
13905 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13906 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13907 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13908 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13909 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13910 .row &%smtp_receive_timeout%&        "per command or data line"
13911 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13912 .row &%smtp_return_error_details%&   "give detail on rejections"
13913 .endtable
13914
13915
13916
13917 .section "SMTP extensions" "SECID113"
13918 .table2
13919 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13920 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13921 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13922 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13923 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13924 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13925 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13926 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13927 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13928 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13929 .endtable
13930
13931
13932
13933 .section "Processing messages" "SECID114"
13934 .table2
13935 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13936 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13937 .row &%allow_utf8_domains%&          "in addresses"
13938 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13939                                       words""&"
13940 .row &%delivery_date_remove%&        "from incoming messages"
13941 .row &%envelope_to_remove%&          "from incoming messages"
13942 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13943 .row &%headers_charset%&             "default for translations"
13944 .row &%qualify_domain%&              "default for senders"
13945 .row &%qualify_recipient%&           "default for recipients"
13946 .row &%return_path_remove%&          "from incoming messages"
13947 .row &%strip_excess_angle_brackets%& "in addresses"
13948 .row &%strip_trailing_dot%&          "at end of addresses"
13949 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13950 .endtable
13951
13952
13953
13954 .section "System filter" "SECID115"
13955 .table2
13956 .row &%system_filter%&               "locate system filter"
13957 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13958                                             directory"
13959 .row &%system_filter_file_transport%& "transport for delivery to a file"
13960 .row &%system_filter_group%&         "group for filter running"
13961 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13962 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13963 .row &%system_filter_user%&          "user for filter running"
13964 .endtable
13965
13966
13967
13968 .section "Routing and delivery" "SECID116"
13969 .table2
13970 .row &%disable_ipv6%&                "do no IPv6 processing"
13971 .row &%dns_again_means_nonexist%&    "for broken domains"
13972 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13973 .row &%dns_dnssec_ok%&               "parameter for resolver"
13974 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13975 .row &%dns_retrans%&                 "parameter for resolver"
13976 .row &%dns_retry%&                   "parameter for resolver"
13977 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13978 .row &%dns_use_edns0%&               "parameter for resolver"
13979 .row &%hold_domains%&                "hold delivery for these domains"
13980 .row &%local_interfaces%&            "for routing checks"
13981 .row &%queue_domains%&               "no immediate delivery for these"
13982 .row &%queue_only%&                  "no immediate delivery at all"
13983 .row &%queue_only_file%&             "no immediate delivery if file exists"
13984 .row &%queue_only_load%&             "no immediate delivery if load is high"
13985 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13986 .row &%queue_only_override%&         "allow command line to override"
13987 .row &%queue_run_in_order%&          "order of arrival"
13988 .row &%queue_run_max%&               "of simultaneous queue runners"
13989 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13990 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13991 .row &%remote_sort_domains%&         "order of remote deliveries"
13992 .row &%retry_data_expire%&           "timeout for retry data"
13993 .row &%retry_interval_max%&          "safety net for retry rules"
13994 .endtable
13995
13996
13997
13998 .section "Bounce and warning messages" "SECID117"
13999 .table2
14000 .row &%bounce_message_file%&         "content of bounce"
14001 .row &%bounce_message_text%&         "content of bounce"
14002 .row &%bounce_return_body%&          "include body if returning message"
14003 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14004 .row &%bounce_return_message%&       "include original message in bounce"
14005 .row &%bounce_return_size_limit%&    "limit on returned message"
14006 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14007 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14008 .row &%errors_copy%&                 "copy bounce messages"
14009 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14010 .row &%delay_warning%&               "time schedule"
14011 .row &%delay_warning_condition%&     "condition for warning messages"
14012 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14013 .row &%smtp_return_error_details%&   "give detail on rejections"
14014 .row &%warn_message_file%&           "content of warning message"
14015 .endtable
14016
14017
14018
14019 .section "Alphabetical list of main options" "SECTalomo"
14020 Those options that undergo string expansion before use are marked with
14021 &dagger;.
14022
14023 .option accept_8bitmime main boolean true
14024 .cindex "8BITMIME"
14025 .cindex "8-bit characters"
14026 .cindex "log" "selectors"
14027 .cindex "log" "8BITMIME"
14028 This option causes Exim to send 8BITMIME in its response to an SMTP
14029 EHLO command, and to accept the BODY= parameter on MAIL commands.
14030 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14031 takes no steps to do anything special with messages received by this route.
14032
14033 Historically Exim kept this option off by default, but the maintainers
14034 feel that in today's Internet, this causes more problems than it solves.
14035 It now defaults to true.
14036 A more detailed analysis of the issues is provided by Dan Bernstein:
14037 .display
14038 &url(http://cr.yp.to/smtp/8bitmime.html)
14039 .endd
14040
14041 To log received 8BITMIME status use
14042 .code
14043 log_selector = +8bitmime
14044 .endd
14045
14046 .option acl_not_smtp main string&!! unset
14047 .cindex "&ACL;" "for non-SMTP messages"
14048 .cindex "non-SMTP messages" "ACLs for"
14049 This option defines the ACL that is run when a non-SMTP message has been
14050 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14051 further details.
14052
14053 .option acl_not_smtp_mime main string&!! unset
14054 This option defines the ACL that is run for individual MIME parts of non-SMTP
14055 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14056 SMTP messages.
14057
14058 .option acl_not_smtp_start main string&!! unset
14059 .cindex "&ACL;" "at start of non-SMTP message"
14060 .cindex "non-SMTP messages" "ACLs for"
14061 This option defines the ACL that is run before Exim starts reading a
14062 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14063
14064 .option acl_smtp_auth main string&!! unset
14065 .cindex "&ACL;" "setting up for SMTP commands"
14066 .cindex "AUTH" "ACL for"
14067 This option defines the ACL that is run when an SMTP AUTH command is
14068 received. See chapter &<<CHAPACL>>& for further details.
14069
14070 .option acl_smtp_connect main string&!! unset
14071 .cindex "&ACL;" "on SMTP connection"
14072 This option defines the ACL that is run when an SMTP connection is received.
14073 See chapter &<<CHAPACL>>& for further details.
14074
14075 .option acl_smtp_data main string&!! unset
14076 .cindex "DATA" "ACL for"
14077 This option defines the ACL that is run after an SMTP DATA command has been
14078 processed and the message itself has been received, but before the final
14079 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14080
14081 .option acl_smtp_data_prdr main string&!! accept
14082 .cindex "PRDR" "ACL for"
14083 .cindex "DATA" "PRDR ACL for"
14084 .cindex "&ACL;" "PRDR-related"
14085 .cindex "&ACL;" "per-user data processing"
14086 This option defines the ACL that,
14087 if the PRDR feature has been negotiated,
14088 is run for each recipient after an SMTP DATA command has been
14089 processed and the message itself has been received, but before the
14090 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14091
14092 .option acl_smtp_dkim main string&!! unset
14093 .cindex DKIM "ACL for"
14094 This option defines the ACL that is run for each DKIM signature
14095 (by default, or as specified in the dkim_verify_signers option)
14096 of a received message.
14097 See chapter &<<CHAPdkim>>& for further details.
14098
14099 .option acl_smtp_etrn main string&!! unset
14100 .cindex "ETRN" "ACL for"
14101 This option defines the ACL that is run when an SMTP ETRN command is
14102 received. See chapter &<<CHAPACL>>& for further details.
14103
14104 .option acl_smtp_expn main string&!! unset
14105 .cindex "EXPN" "ACL for"
14106 This option defines the ACL that is run when an SMTP EXPN command is
14107 received. See chapter &<<CHAPACL>>& for further details.
14108
14109 .option acl_smtp_helo main string&!! unset
14110 .cindex "EHLO" "ACL for"
14111 .cindex "HELO" "ACL for"
14112 This option defines the ACL that is run when an SMTP EHLO or HELO
14113 command is received. See chapter &<<CHAPACL>>& for further details.
14114
14115
14116 .option acl_smtp_mail main string&!! unset
14117 .cindex "MAIL" "ACL for"
14118 This option defines the ACL that is run when an SMTP MAIL command is
14119 received. See chapter &<<CHAPACL>>& for further details.
14120
14121 .option acl_smtp_mailauth main string&!! unset
14122 .cindex "AUTH" "on MAIL command"
14123 This option defines the ACL that is run when there is an AUTH parameter on
14124 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14125 &<<CHAPSMTPAUTH>>& for details of authentication.
14126
14127 .option acl_smtp_mime main string&!! unset
14128 .cindex "MIME content scanning" "ACL for"
14129 This option is available when Exim is built with the content-scanning
14130 extension. It defines the ACL that is run for each MIME part in a message. See
14131 section &<<SECTscanmimepart>>& for details.
14132
14133 .option acl_smtp_notquit main string&!! unset
14134 .cindex "not-QUIT, ACL for"
14135 This option defines the ACL that is run when an SMTP session
14136 ends without a QUIT command being received.
14137 See chapter &<<CHAPACL>>& for further details.
14138
14139 .option acl_smtp_predata main string&!! unset
14140 This option defines the ACL that is run when an SMTP DATA command is
14141 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14142 further details.
14143
14144 .option acl_smtp_quit main string&!! unset
14145 .cindex "QUIT, ACL for"
14146 This option defines the ACL that is run when an SMTP QUIT command is
14147 received. See chapter &<<CHAPACL>>& for further details.
14148
14149 .option acl_smtp_rcpt main string&!! unset
14150 .cindex "RCPT" "ACL for"
14151 This option defines the ACL that is run when an SMTP RCPT command is
14152 received. See chapter &<<CHAPACL>>& for further details.
14153
14154 .option acl_smtp_starttls main string&!! unset
14155 .cindex "STARTTLS, ACL for"
14156 This option defines the ACL that is run when an SMTP STARTTLS command is
14157 received. See chapter &<<CHAPACL>>& for further details.
14158
14159 .option acl_smtp_vrfy main string&!! unset
14160 .cindex "VRFY" "ACL for"
14161 This option defines the ACL that is run when an SMTP VRFY command is
14162 received. See chapter &<<CHAPACL>>& for further details.
14163
14164 .option add_environment main "string list" empty
14165 .cindex "environment" "set values"
14166 This option allows to set individual environment variables that the
14167 currently linked libraries and programs in child processes use.
14168 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14169
14170 .option admin_groups main "string list&!!" unset
14171 .cindex "admin user"
14172 This option is expanded just once, at the start of Exim's processing. If the
14173 current group or any of the supplementary groups of an Exim caller is in this
14174 colon-separated list, the caller has admin privileges. If all your system
14175 programmers are in a specific group, for example, you can give them all Exim
14176 admin privileges by putting that group in &%admin_groups%&. However, this does
14177 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14178 To permit this, you have to add individuals to the Exim group.
14179
14180 .option allow_domain_literals main boolean false
14181 .cindex "domain literal"
14182 If this option is set, the RFC 2822 domain literal format is permitted in
14183 email addresses. The option is not set by default, because the domain literal
14184 format is not normally required these days, and few people know about it. It
14185 has, however, been exploited by mail abusers.
14186
14187 Unfortunately, it seems that some DNS black list maintainers are using this
14188 format to report black listing to postmasters. If you want to accept messages
14189 addressed to your hosts by IP address, you need to set
14190 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14191 domains (defined in the named domain list &%local_domains%& in the default
14192 configuration). This &"magic string"& matches the domain literal form of all
14193 the local host's IP addresses.
14194
14195
14196 .option allow_mx_to_ip main boolean false
14197 .cindex "MX record" "pointing to IP address"
14198 It appears that more and more DNS zone administrators are breaking the rules
14199 and putting domain names that look like IP addresses on the right hand side of
14200 MX records. Exim follows the rules and rejects this, giving an error message
14201 that explains the misconfiguration. However, some other MTAs support this
14202 practice, so to avoid &"Why can't Exim do this?"& complaints,
14203 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14204 recommended, except when you have no other choice.
14205
14206 .option allow_utf8_domains main boolean false
14207 .cindex "domain" "UTF-8 characters in"
14208 .cindex "UTF-8" "in domain name"
14209 Lots of discussion is going on about internationalized domain names. One
14210 camp is strongly in favour of just using UTF-8 characters, and it seems
14211 that at least two other MTAs permit this. This option allows Exim users to
14212 experiment if they wish.
14213
14214 If it is set true, Exim's domain parsing function allows valid
14215 UTF-8 multicharacters to appear in domain name components, in addition to
14216 letters, digits, and hyphens. However, just setting this option is not
14217 enough; if you want to look up these domain names in the DNS, you must also
14218 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14219 suitable setting is:
14220 .code
14221 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14222   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14223 .endd
14224 Alternatively, you can just disable this feature by setting
14225 .code
14226 dns_check_names_pattern =
14227 .endd
14228 That is, set the option to an empty string so that no check is done.
14229
14230
14231 .option auth_advertise_hosts main "host list&!!" *
14232 .cindex "authentication" "advertising"
14233 .cindex "AUTH" "advertising"
14234 If any server authentication mechanisms are configured, Exim advertises them in
14235 response to an EHLO command only if the calling host matches this list.
14236 Otherwise, Exim does not advertise AUTH.
14237 Exim does not accept AUTH commands from clients to which it has not
14238 advertised the availability of AUTH. The advertising of individual
14239 authentication mechanisms can be controlled by the use of the
14240 &%server_advertise_condition%& generic authenticator option on the individual
14241 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14242
14243 Certain mail clients (for example, Netscape) require the user to provide a name
14244 and password for authentication if AUTH is advertised, even though it may
14245 not be needed (the host may accept messages from hosts on its local LAN without
14246 authentication, for example). The &%auth_advertise_hosts%& option can be used
14247 to make these clients more friendly by excluding them from the set of hosts to
14248 which Exim advertises AUTH.
14249
14250 .cindex "AUTH" "advertising when encrypted"
14251 If you want to advertise the availability of AUTH only when the connection
14252 is encrypted using TLS, you can make use of the fact that the value of this
14253 option is expanded, with a setting like this:
14254 .code
14255 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14256 .endd
14257 .vindex "&$tls_in_cipher$&"
14258 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14259 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14260 expansion is *, which matches all hosts.
14261
14262
14263 .option auto_thaw main time 0s
14264 .cindex "thawing messages"
14265 .cindex "unfreezing messages"
14266 If this option is set to a time greater than zero, a queue runner will try a
14267 new delivery attempt on any frozen message, other than a bounce message, if
14268 this much time has passed since it was frozen. This may result in the message
14269 being re-frozen if nothing has changed since the last attempt. It is a way of
14270 saying &"keep on trying, even though there are big problems"&.
14271
14272 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14273 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14274 thought to be very useful any more, and its use should probably be avoided.
14275
14276
14277 .option av_scanner main string "see below"
14278 This option is available if Exim is built with the content-scanning extension.
14279 It specifies which anti-virus scanner to use. The default value is:
14280 .code
14281 sophie:/var/run/sophie
14282 .endd
14283 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14284 before use. See section &<<SECTscanvirus>>& for further details.
14285
14286
14287 .option bi_command main string unset
14288 .oindex "&%-bi%&"
14289 This option supplies the name of a command that is run when Exim is called with
14290 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14291 just the command name, it is not a complete command line. If an argument is
14292 required, it must come from the &%-oA%& command line option.
14293
14294
14295 .option bounce_message_file main string unset
14296 .cindex "bounce message" "customizing"
14297 .cindex "customizing" "bounce message"
14298 This option defines a template file containing paragraphs of text to be used
14299 for constructing bounce messages.  Details of the file's contents are given in
14300 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14301
14302
14303 .option bounce_message_text main string unset
14304 When this option is set, its contents are included in the default bounce
14305 message immediately after &"This message was created automatically by mail
14306 delivery software."& It is not used if &%bounce_message_file%& is set.
14307
14308 .option bounce_return_body main boolean true
14309 .cindex "bounce message" "including body"
14310 This option controls whether the body of an incoming message is included in a
14311 bounce message when &%bounce_return_message%& is true. The default setting
14312 causes the entire message, both header and body, to be returned (subject to the
14313 value of &%bounce_return_size_limit%&). If this option is false, only the
14314 message header is included. In the case of a non-SMTP message containing an
14315 error that is detected during reception, only those header lines preceding the
14316 point at which the error was detected are returned.
14317 .cindex "bounce message" "including original"
14318
14319 .option bounce_return_linesize_limit main integer 998
14320 .cindex "size" "of bounce lines, limit"
14321 .cindex "bounce message" "line length limit"
14322 .cindex "limit" "bounce message line length"
14323 This option sets a limit in bytes on the line length of messages
14324 that are returned to senders due to delivery problems,
14325 when &%bounce_return_message%& is true.
14326 The default value corresponds to RFC limits.
14327 If the message being returned has lines longer than this value it is
14328 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14329
14330 The option also applies to bounces returned when an error is detected
14331 during reception of a message.
14332 In this case lines from the original are truncated.
14333
14334 The option does not apply to messages generated by an &(autoreply)& transport.
14335
14336
14337 .option bounce_return_message main boolean true
14338 If this option is set false, none of the original message is included in
14339 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14340 &%bounce_return_body%&.
14341
14342
14343 .option bounce_return_size_limit main integer 100K
14344 .cindex "size" "of bounce, limit"
14345 .cindex "bounce message" "size limit"
14346 .cindex "limit" "bounce message size"
14347 This option sets a limit in bytes on the size of messages that are returned to
14348 senders as part of bounce messages when &%bounce_return_message%& is true. The
14349 limit should be less than the value of the global &%message_size_limit%& and of
14350 any &%message_size_limit%& settings on transports, to allow for the bounce text
14351 that Exim generates. If this option is set to zero there is no limit.
14352
14353 When the body of any message that is to be included in a bounce message is
14354 greater than the limit, it is truncated, and a comment pointing this out is
14355 added at the top. The actual cutoff may be greater than the value given, owing
14356 to the use of buffering for transferring the message in chunks (typically 8K in
14357 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14358 messages.
14359
14360 .option bounce_sender_authentication main string unset
14361 .cindex "bounce message" "sender authentication"
14362 .cindex "authentication" "bounce message"
14363 .cindex "AUTH" "on bounce message"
14364 This option provides an authenticated sender address that is sent with any
14365 bounce messages generated by Exim that are sent over an authenticated SMTP
14366 connection. A typical setting might be:
14367 .code
14368 bounce_sender_authentication = mailer-daemon@my.domain.example
14369 .endd
14370 which would cause bounce messages to be sent using the SMTP command:
14371 .code
14372 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14373 .endd
14374 The value of &%bounce_sender_authentication%& must always be a complete email
14375 address.
14376
14377 .option callout_domain_negative_expire main time 3h
14378 .cindex "caching" "callout timeouts"
14379 .cindex "callout" "caching timeouts"
14380 This option specifies the expiry time for negative callout cache data for a
14381 domain. See section &<<SECTcallver>>& for details of callout verification, and
14382 section &<<SECTcallvercache>>& for details of the caching.
14383
14384
14385 .option callout_domain_positive_expire main time 7d
14386 This option specifies the expiry time for positive callout cache data for a
14387 domain. See section &<<SECTcallver>>& for details of callout verification, and
14388 section &<<SECTcallvercache>>& for details of the caching.
14389
14390
14391 .option callout_negative_expire main time 2h
14392 This option specifies the expiry time for negative callout cache data for an
14393 address. See section &<<SECTcallver>>& for details of callout verification, and
14394 section &<<SECTcallvercache>>& for details of the caching.
14395
14396
14397 .option callout_positive_expire main time 24h
14398 This option specifies the expiry time for positive callout cache data for an
14399 address. See section &<<SECTcallver>>& for details of callout verification, and
14400 section &<<SECTcallvercache>>& for details of the caching.
14401
14402
14403 .option callout_random_local_part main string&!! "see below"
14404 This option defines the &"random"& local part that can be used as part of
14405 callout verification. The default value is
14406 .code
14407 $primary_hostname-$tod_epoch-testing
14408 .endd
14409 See section &<<CALLaddparcall>>& for details of how this value is used.
14410
14411
14412 .option check_log_inodes main integer 100
14413 See &%check_spool_space%& below.
14414
14415
14416 .option check_log_space main integer 10M
14417 See &%check_spool_space%& below.
14418
14419 .oindex "&%check_rfc2047_length%&"
14420 .cindex "RFC 2047" "disabling length check"
14421 .option check_rfc2047_length main boolean true
14422 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14423 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14424 word; strings to be encoded that exceed this length are supposed to use
14425 multiple encoded words. By default, Exim does not recognize encoded words that
14426 exceed the maximum length. However, it seems that some software, in violation
14427 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14428 set false, Exim recognizes encoded words of any length.
14429
14430
14431 .option check_spool_inodes main integer 100
14432 See &%check_spool_space%& below.
14433
14434
14435 .option check_spool_space main integer 10M
14436 .cindex "checking disk space"
14437 .cindex "disk space, checking"
14438 .cindex "spool directory" "checking space"
14439 The four &%check_...%& options allow for checking of disk resources before a
14440 message is accepted.
14441
14442 .vindex "&$log_inodes$&"
14443 .vindex "&$log_space$&"
14444 .vindex "&$spool_inodes$&"
14445 .vindex "&$spool_space$&"
14446 When any of these options are nonzero, they apply to all incoming messages. If you
14447 want to apply different checks to different kinds of message, you can do so by
14448 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14449 &$spool_space$& in an ACL with appropriate additional conditions.
14450
14451
14452 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14453 either value is greater than zero, for example:
14454 .code
14455 check_spool_space = 100M
14456 check_spool_inodes = 100
14457 .endd
14458 The spool partition is the one that contains the directory defined by
14459 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14460 transit.
14461
14462 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14463 files are written if either is greater than zero. These should be set only if
14464 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14465
14466 If there is less space or fewer inodes than requested, Exim refuses to accept
14467 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14468 error response to the MAIL command. If ESMTP is in use and there was a
14469 SIZE parameter on the MAIL command, its value is added to the
14470 &%check_spool_space%& value, and the check is performed even if
14471 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14472
14473 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14474 number of kilobytes (though specified in bytes).
14475 If a non-multiple of 1024 is specified, it is rounded up.
14476
14477 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14478 failure a message is written to stderr and Exim exits with a non-zero code, as
14479 it obviously cannot send an error message of any kind.
14480
14481 There is a slight performance penalty for these checks.
14482 Versions of Exim preceding 4.88 had these disabled by default;
14483 high-rate installations confident they will never run out of resources
14484 may wish to deliberately disable them.
14485
14486 .option chunking_advertise_hosts main "host list&!!" *
14487 .cindex CHUNKING advertisement
14488 .cindex "RFC 3030" "CHUNKING"
14489 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14490 these hosts.
14491 Hosts may use the BDAT command as an alternate to DATA.
14492
14493 .new
14494 .option commandline_checks_require_admin main boolean &`false`&
14495 .cindex "restricting access to features"
14496 This option restricts various basic checking features to require an
14497 administrative user.
14498 This affects most of the &%-b*%& options, such as &%-be%&.
14499 .wen
14500
14501 .option debug_store main boolean &`false`&
14502 .cindex debugging "memory corruption"
14503 .cindex memory debugging
14504 This option, when true, enables extra checking in Exim's internal memory
14505 management.  For use when a memory corruption issue is being investigated,
14506 it should normally be left as default.
14507
14508 .option daemon_smtp_ports main string &`smtp`&
14509 .cindex "port" "for daemon"
14510 .cindex "TCP/IP" "setting listening ports"
14511 This option specifies one or more default SMTP ports on which the Exim daemon
14512 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14513 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14514
14515 .option daemon_startup_retries main integer 9
14516 .cindex "daemon startup, retrying"
14517 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14518 the daemon at startup when it cannot immediately bind a listening socket
14519 (typically because the socket is already in use): &%daemon_startup_retries%&
14520 defines the number of retries after the first failure, and
14521 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14522
14523 .option daemon_startup_sleep main time 30s
14524 See &%daemon_startup_retries%&.
14525
14526 .option delay_warning main "time list" 24h
14527 .cindex "warning of delay"
14528 .cindex "delay warning, specifying"
14529 .cindex "queue" "delay warning"
14530 When a message is delayed, Exim sends a warning message to the sender at
14531 intervals specified by this option. The data is a colon-separated list of times
14532 after which to send warning messages. If the value of the option is an empty
14533 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14534 message has been on the queue for longer than the last time, the last interval
14535 between the times is used to compute subsequent warning times. For example,
14536 with
14537 .code
14538 delay_warning = 4h:8h:24h
14539 .endd
14540 the first message is sent after 4 hours, the second after 8 hours, and
14541 the third one after 24 hours. After that, messages are sent every 16 hours,
14542 because that is the interval between the last two times on the list. If you set
14543 just one time, it specifies the repeat interval. For example, with:
14544 .code
14545 delay_warning = 6h
14546 .endd
14547 messages are repeated every six hours. To stop warnings after a given time, set
14548 a very large time at the end of the list. For example:
14549 .code
14550 delay_warning = 2h:12h:99d
14551 .endd
14552 Note that the option is only evaluated at the time a delivery attempt fails,
14553 which depends on retry and queue-runner configuration.
14554 Typically retries will be configured more frequently than warning messages.
14555
14556 .option delay_warning_condition main string&!! "see below"
14557 .vindex "&$domain$&"
14558 The string is expanded at the time a warning message might be sent. If all the
14559 deferred addresses have the same domain, it is set in &$domain$& during the
14560 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14561 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14562 &"false"& (the comparison being done caselessly) then the warning message is
14563 not sent. The default is:
14564 .code
14565 delay_warning_condition = ${if or {\
14566   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14567   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14568   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14569   } {no}{yes}}
14570 .endd
14571 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14572 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14573 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14574 &"auto-replied"& in an &'Auto-Submitted:'& header.
14575
14576 .option deliver_drop_privilege main boolean false
14577 .cindex "unprivileged delivery"
14578 .cindex "delivery" "unprivileged"
14579 If this option is set true, Exim drops its root privilege at the start of a
14580 delivery process, and runs as the Exim user throughout. This severely restricts
14581 the kinds of local delivery that are possible, but is viable in certain types
14582 of configuration. There is a discussion about the use of root privilege in
14583 chapter &<<CHAPsecurity>>&.
14584
14585 .option deliver_queue_load_max main fixed-point unset
14586 .cindex "load average"
14587 .cindex "queue runner" "abandoning"
14588 When this option is set, a queue run is abandoned if the system load average
14589 becomes greater than the value of the option. The option has no effect on
14590 ancient operating systems on which Exim cannot determine the load average.
14591 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14592
14593
14594 .option delivery_date_remove main boolean true
14595 .cindex "&'Delivery-date:'& header line"
14596 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14597 message when it is delivered, in exactly the same way as &'Return-path:'& is
14598 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14599 should not be present in incoming messages, and this option causes them to be
14600 removed at the time the message is received, to avoid any problems that might
14601 occur when a delivered message is subsequently sent on to some other recipient.
14602
14603 .option disable_fsync main boolean false
14604 .cindex "&[fsync()]&, disabling"
14605 This option is available only if Exim was built with the compile-time option
14606 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14607 a runtime configuration generates an &"unknown option"& error. You should not
14608 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14609 really, really, really understand what you are doing. &'No pre-compiled
14610 distributions of Exim should ever make this option available.'&
14611
14612 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14613 updated files' data to be written to disc before continuing. Unexpected events
14614 such as crashes and power outages may cause data to be lost or scrambled.
14615 Here be Dragons. &*Beware.*&
14616
14617
14618 .option disable_ipv6 main boolean false
14619 .cindex "IPv6" "disabling"
14620 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14621 activities take place. AAAA records are never looked up, and any IPv6 addresses
14622 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14623 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14624 to handle IPv6 literal addresses.
14625
14626
14627 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14628 .cindex DKIM "controlling calls to the ACL"
14629 This option gives a list of DKIM domains for which the DKIM ACL is run.
14630 It is expanded after the message is received; by default it runs
14631 the ACL once for each signature in the message.
14632 See chapter &<<CHAPdkim>>&.
14633
14634
14635 .option dns_again_means_nonexist main "domain list&!!" unset
14636 .cindex "DNS" "&""try again""& response; overriding"
14637 DNS lookups give a &"try again"& response for the DNS errors
14638 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14639 keep trying to deliver a message, or to give repeated temporary errors to
14640 incoming mail. Sometimes the effect is caused by a badly set up name server and
14641 may persist for a long time. If a domain which exhibits this problem matches
14642 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14643 This option should be used with care. You can make it apply to reverse lookups
14644 by a setting such as this:
14645 .code
14646 dns_again_means_nonexist = *.in-addr.arpa
14647 .endd
14648 This option applies to all DNS lookups that Exim does. It also applies when the
14649 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14650 since these are most likely to be caused by DNS lookup problems. The
14651 &(dnslookup)& router has some options of its own for controlling what happens
14652 when lookups for MX or SRV records give temporary errors. These more specific
14653 options are applied after this global option.
14654
14655 .option dns_check_names_pattern main string "see below"
14656 .cindex "DNS" "pre-check of name syntax"
14657 When this option is set to a non-empty string, it causes Exim to check domain
14658 names for characters that are not allowed in host names before handing them to
14659 the DNS resolver, because some resolvers give temporary errors for names that
14660 contain unusual characters. If a domain name contains any unwanted characters,
14661 a &"not found"& result is forced, and the resolver is not called. The check is
14662 done by matching the domain name against a regular expression, which is the
14663 value of this option. The default pattern is
14664 .code
14665 dns_check_names_pattern = \
14666   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14667 .endd
14668 which permits only letters, digits, slashes, and hyphens in components, but
14669 they must start and end with a letter or digit. Slashes are not, in fact,
14670 permitted in host names, but they are found in certain NS records (which can be
14671 accessed in Exim by using a &%dnsdb%& lookup). If you set
14672 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14673 empty string.
14674
14675 .option dns_csa_search_limit main integer 5
14676 This option controls the depth of parental searching for CSA SRV records in the
14677 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14678
14679 .option dns_csa_use_reverse main boolean true
14680 This option controls whether or not an IP address, given as a CSA domain, is
14681 reversed and looked up in the reverse DNS, as described in more detail in
14682 section &<<SECTverifyCSA>>&.
14683
14684
14685 .option dns_dnssec_ok main integer -1
14686 .cindex "DNS" "resolver options"
14687 .cindex "DNS" "DNSSEC"
14688 If this option is set to a non-negative number then Exim will initialise the
14689 DNS resolver library to either use or not use DNSSEC, overriding the system
14690 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14691
14692 If the resolver library does not support DNSSEC then this option has no effect.
14693
14694
14695 .option dns_ipv4_lookup main "domain list&!!" unset
14696 .cindex "IPv6" "DNS lookup for AAAA records"
14697 .cindex "DNS" "IPv6 lookup for AAAA records"
14698 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14699 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14700 (A records) when trying to find IP addresses for hosts, unless the host's
14701 domain matches this list.
14702
14703 This is a fudge to help with name servers that give big delays or otherwise do
14704 not work for the AAAA record type. In due course, when the world's name
14705 servers have all been upgraded, there should be no need for this option.
14706
14707
14708 .option dns_retrans main time 0s
14709 .cindex "DNS" "resolver options"
14710 .cindex timeout "dns lookup"
14711 .cindex "DNS" timeout
14712 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14713 retransmission and retry parameters for DNS lookups. Values of zero (the
14714 defaults) leave the system default settings unchanged. The first value is the
14715 time between retries, and the second is the number of retries. It isn't
14716 totally clear exactly how these settings affect the total time a DNS lookup may
14717 take. I haven't found any documentation about timeouts on DNS lookups; these
14718 parameter values are available in the external resolver interface structure,
14719 but nowhere does it seem to describe how they are used or what you might want
14720 to set in them.
14721 See also the &%slow_lookup_log%& option.
14722
14723
14724 .option dns_retry main integer 0
14725 See &%dns_retrans%& above.
14726
14727
14728 .option dns_trust_aa main "domain list&!!" unset
14729 .cindex "DNS" "resolver options"
14730 .cindex "DNS" "DNSSEC"
14731 If this option is set then lookup results marked with the AA bit
14732 (Authoritative Answer) are trusted the same way as if they were
14733 DNSSEC-verified. The authority section's name of the answer must
14734 match with this expanded domain list.
14735
14736 Use this option only if you talk directly to a resolver that is
14737 authoritative for some zones and does not set the AD (Authentic Data)
14738 bit in the answer. Some DNS servers may have an configuration option to
14739 mark the answers from their own zones as verified (they set the AD bit).
14740 Others do not have this option. It is considered as poor practice using
14741 a resolver that is an authoritative server for some zones.
14742
14743 Use this option only if you really have to (e.g. if you want
14744 to use DANE for remote delivery to a server that is listed in the DNS
14745 zones that your resolver is authoritative for).
14746
14747 If the DNS answer packet has the AA bit set and contains resource record
14748 in the answer section, the name of the first NS record appearing in the
14749 authority section is compared against the list. If the answer packet is
14750 authoritative but the answer section is empty, the name of the first SOA
14751 record in the authoritative section is used instead.
14752
14753 .cindex "DNS" "resolver options"
14754 .option dns_use_edns0 main integer -1
14755 .cindex "DNS" "resolver options"
14756 .cindex "DNS" "EDNS0"
14757 .cindex "DNS" "OpenBSD
14758 If this option is set to a non-negative number then Exim will initialise the
14759 DNS resolver library to either use or not use EDNS0 extensions, overriding
14760 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14761 on.
14762
14763 If the resolver library does not support EDNS0 then this option has no effect.
14764
14765 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14766 means that DNSSEC will not work with Exim on that platform either, unless Exim
14767 is linked against an alternative DNS client library.
14768
14769
14770 .option drop_cr main boolean false
14771 This is an obsolete option that is now a no-op. It used to affect the way Exim
14772 handled CR and LF characters in incoming messages. What happens now is
14773 described in section &<<SECTlineendings>>&.
14774
14775 .option dsn_advertise_hosts main "host list&!!" unset
14776 .cindex "bounce messages" "success"
14777 .cindex "DSN" "success"
14778 .cindex "Delivery Status Notification" "success"
14779 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14780 and accepted from, these hosts.
14781 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14782 and RET and ORCPT options on MAIL FROM commands.
14783 A NOTIFY=SUCCESS option requests success-DSN messages.
14784 A NOTIFY= option with no argument requests that no delay or failure DSNs
14785 are sent.
14786
14787 .option dsn_from main "string&!!" "see below"
14788 .cindex "&'From:'& header line" "in bounces"
14789 .cindex "bounce messages" "&'From:'& line, specifying"
14790 This option can be used to vary the contents of &'From:'& header lines in
14791 bounces and other automatically generated messages (&"Delivery Status
14792 Notifications"& &-- hence the name of the option). The default setting is:
14793 .code
14794 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14795 .endd
14796 The value is expanded every time it is needed. If the expansion fails, a
14797 panic is logged, and the default value is used.
14798
14799 .option envelope_to_remove main boolean true
14800 .cindex "&'Envelope-to:'& header line"
14801 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14802 message when it is delivered, in exactly the same way as &'Return-path:'& is
14803 handled. &'Envelope-to:'& records the original recipient address from the
14804 message's envelope that caused the delivery to happen. Such headers should not
14805 be present in incoming messages, and this option causes them to be removed at
14806 the time the message is received, to avoid any problems that might occur when a
14807 delivered message is subsequently sent on to some other recipient.
14808
14809
14810 .option errors_copy main "string list&!!" unset
14811 .cindex "bounce message" "copy to other address"
14812 .cindex "copy of bounce message"
14813 Setting this option causes Exim to send bcc copies of bounce messages that it
14814 generates to other addresses. &*Note*&: This does not apply to bounce messages
14815 coming from elsewhere. The value of the option is a colon-separated list of
14816 items. Each item consists of a pattern, terminated by white space, followed by
14817 a comma-separated list of email addresses. If a pattern contains spaces, it
14818 must be enclosed in double quotes.
14819
14820 Each pattern is processed in the same way as a single item in an address list
14821 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14822 the bounce message, the message is copied to the addresses on the list. The
14823 items are scanned in order, and once a matching one is found, no further items
14824 are examined. For example:
14825 .code
14826 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14827               rqps@mydomain   hostmaster@mydomain.example,\
14828                               postmaster@mydomain.example
14829 .endd
14830 .vindex "&$domain$&"
14831 .vindex "&$local_part$&"
14832 The address list is expanded before use. The expansion variables &$local_part$&
14833 and &$domain$& are set from the original recipient of the error message, and if
14834 there was any wildcard matching in the pattern, the expansion
14835 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14836 variables &$0$&, &$1$&, etc. are set in the normal way.
14837
14838
14839 .option errors_reply_to main string unset
14840 .cindex "bounce message" "&'Reply-to:'& in"
14841 By default, Exim's bounce and delivery warning messages contain the header line
14842 .display
14843 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14844 .endd
14845 .oindex &%quota_warn_message%&
14846 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14847 A warning message that is generated by the &%quota_warn_message%& option in an
14848 &(appendfile)& transport may contain its own &'From:'& header line that
14849 overrides the default.
14850
14851 Experience shows that people reply to bounce messages. If the
14852 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14853 and warning messages. For example:
14854 .code
14855 errors_reply_to = postmaster@my.domain.example
14856 .endd
14857 The value of the option is not expanded. It must specify a valid RFC 2822
14858 address. However, if a warning message that is generated by the
14859 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14860 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14861 not used.
14862
14863
14864 .option event_action main string&!! unset
14865 .cindex events
14866 This option declares a string to be expanded for Exim's events mechanism.
14867 For details see chapter &<<CHAPevents>>&.
14868
14869
14870 .option exim_group main string "compile-time configured"
14871 .cindex "gid (group id)" "Exim's own"
14872 .cindex "Exim group"
14873 This option changes the gid under which Exim runs when it gives up root
14874 privilege. The default value is compiled into the binary. The value of this
14875 option is used only when &%exim_user%& is also set. Unless it consists entirely
14876 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14877 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14878 security issues.
14879
14880
14881 .option exim_path main string "see below"
14882 .cindex "Exim binary, path name"
14883 This option specifies the path name of the Exim binary, which is used when Exim
14884 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14885 the directory configured at compile time by the BIN_DIRECTORY setting. It
14886 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14887 other place.
14888 &*Warning*&: Do not use a macro to define the value of this option, because
14889 you will break those Exim utilities that scan the configuration file to find
14890 where the binary is. (They then use the &%-bP%& option to extract option
14891 settings such as the value of &%spool_directory%&.)
14892
14893
14894 .option exim_user main string "compile-time configured"
14895 .cindex "uid (user id)" "Exim's own"
14896 .cindex "Exim user"
14897 This option changes the uid under which Exim runs when it gives up root
14898 privilege. The default value is compiled into the binary. Ownership of the run
14899 time configuration file and the use of the &%-C%& and &%-D%& command line
14900 options is checked against the values in the binary, not what is set here.
14901
14902 Unless it consists entirely of digits, the string is looked up using
14903 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14904 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14905 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14906
14907
14908 .option extra_local_interfaces main "string list" unset
14909 This option defines network interfaces that are to be considered local when
14910 routing, but which are not used for listening by the daemon. See section
14911 &<<SECTreclocipadd>>& for details.
14912
14913
14914 . Allow this long option name to split; give it unsplit as a fifth argument
14915 . for the automatic .oindex that is generated by .option.
14916
14917 .option "extract_addresses_remove_arguments" main boolean true &&&
14918          extract_addresses_remove_arguments
14919 .oindex "&%-t%&"
14920 .cindex "command line" "addresses with &%-t%&"
14921 .cindex "Sendmail compatibility" "&%-t%& option"
14922 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14923 are present on the command line when the &%-t%& option is used to build an
14924 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14925 line addresses are removed from the recipients list. This is also how Smail
14926 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14927 command line addresses are added to those obtained from the header lines. When
14928 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14929 argument headers. If it is set false, Exim adds rather than removes argument
14930 addresses.
14931
14932
14933 .option finduser_retries main integer 0
14934 .cindex "NIS, retrying user lookups"
14935 On systems running NIS or other schemes in which user and group information is
14936 distributed from a remote system, there can be times when &[getpwnam()]& and
14937 related functions fail, even when given valid data, because things time out.
14938 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14939 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14940 many extra times to find a user or a group, waiting for one second between
14941 retries.
14942
14943 .cindex "&_/etc/passwd_&" "multiple reading of"
14944 You should not set this option greater than zero if your user information is in
14945 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14946 search the file multiple times for non-existent users, and also cause delay.
14947
14948
14949
14950 .option freeze_tell main "string list, comma separated" unset
14951 .cindex "freezing messages" "sending a message when freezing"
14952 On encountering certain errors, or when configured to do so in a system filter,
14953 ACL, or special router, Exim freezes a message. This means that no further
14954 delivery attempts take place until an administrator thaws the message, or the
14955 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14956 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14957 warning message whenever it freezes something, unless the message it is
14958 freezing is a locally-generated bounce message. (Without this exception there
14959 is the possibility of looping.) The warning message is sent to the addresses
14960 supplied as the comma-separated value of this option. If several of the
14961 message's addresses cause freezing, only a single message is sent. If the
14962 freezing was automatic, the reason(s) for freezing can be found in the message
14963 log. If you configure freezing in a filter or ACL, you must arrange for any
14964 logging that you require.
14965
14966
14967 .option gecos_name main string&!! unset
14968 .cindex "HP-UX"
14969 .cindex "&""gecos""& field, parsing"
14970 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14971 password file to hold other information in addition to users' real names. Exim
14972 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14973 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14974 of the field are used unchanged, except that, if an ampersand is encountered,
14975 it is replaced by the user's login name with the first character forced to
14976 upper case, since this is a convention that is observed on many systems.
14977
14978 When these options are set, &%gecos_pattern%& is treated as a regular
14979 expression that is to be applied to the field (again with && replaced by the
14980 login name), and if it matches, &%gecos_name%& is expanded and used as the
14981 user's name.
14982
14983 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14984 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14985 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14986 name terminates at the first comma, the following can be used:
14987 .code
14988 gecos_pattern = ([^,]*)
14989 gecos_name = $1
14990 .endd
14991
14992 .option gecos_pattern main string unset
14993 See &%gecos_name%& above.
14994
14995
14996 .option gnutls_compat_mode main boolean unset
14997 This option controls whether GnuTLS is used in compatibility mode in an Exim
14998 server. This reduces security slightly, but improves interworking with older
14999 implementations of TLS.
15000
15001
15002 option gnutls_allow_auto_pkcs11 main boolean unset
15003 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15004 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15005
15006 See
15007 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15008 for documentation.
15009
15010
15011
15012 .option headers_charset main string "see below"
15013 This option sets a default character set for translating from encoded MIME
15014 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15015 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15016 ultimate default is ISO-8859-1. For more details see the description of header
15017 insertions in section &<<SECTexpansionitems>>&.
15018
15019
15020
15021 .option header_maxsize main integer "see below"
15022 .cindex "header section" "maximum size of"
15023 .cindex "limit" "size of message header section"
15024 This option controls the overall maximum size of a message's header
15025 section. The default is the value of HEADER_MAXSIZE in
15026 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15027 sections are rejected.
15028
15029
15030 .option header_line_maxsize main integer 0
15031 .cindex "header lines" "maximum size of"
15032 .cindex "limit" "size of one header line"
15033 This option limits the length of any individual header line in a message, after
15034 all the continuations have been joined together. Messages with individual
15035 header lines that are longer than the limit are rejected. The default value of
15036 zero means &"no limit"&.
15037
15038
15039
15040
15041 .option helo_accept_junk_hosts main "host list&!!" unset
15042 .cindex "HELO" "accepting junk data"
15043 .cindex "EHLO" "accepting junk data"
15044 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15045 mail, and gives an error response for invalid data. Unfortunately, there are
15046 some SMTP clients that send syntactic junk. They can be accommodated by setting
15047 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15048 if you want to do semantic checking.
15049 See also &%helo_allow_chars%& for a way of extending the permitted character
15050 set.
15051
15052
15053 .option helo_allow_chars main string unset
15054 .cindex "HELO" "underscores in"
15055 .cindex "EHLO" "underscores in"
15056 .cindex "underscore in EHLO/HELO"
15057 This option can be set to a string of rogue characters that are permitted in
15058 all EHLO and HELO names in addition to the standard letters, digits,
15059 hyphens, and dots. If you really must allow underscores, you can set
15060 .code
15061 helo_allow_chars = _
15062 .endd
15063 Note that the value is one string, not a list.
15064
15065
15066 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15067 .cindex "HELO" "forcing reverse lookup"
15068 .cindex "EHLO" "forcing reverse lookup"
15069 If the domain given by a client in a HELO or EHLO command matches this
15070 list, a reverse lookup is done in order to establish the host's true name. The
15071 default forces a lookup if the client host gives the server's name or any of
15072 its IP addresses (in brackets), something that broken clients have been seen to
15073 do.
15074
15075
15076 .option helo_try_verify_hosts main "host list&!!" unset
15077 .cindex "HELO verifying" "optional"
15078 .cindex "EHLO" "verifying, optional"
15079 By default, Exim just checks the syntax of HELO and EHLO commands (see
15080 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15081 to do more extensive checking of the data supplied by these commands. The ACL
15082 condition &`verify = helo`& is provided to make this possible.
15083 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15084 to force the check to occur. From release 4.53 onwards, this is no longer
15085 necessary. If the check has not been done before &`verify = helo`& is
15086 encountered, it is done at that time. Consequently, this option is obsolete.
15087 Its specification is retained here for backwards compatibility.
15088
15089 When an EHLO or HELO command is received, if the calling host matches
15090 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15091 EHLO command either:
15092
15093 .ilist
15094 is an IP literal matching the calling address of the host, or
15095 .next
15096 .cindex "DNS" "reverse lookup"
15097 .cindex "reverse DNS lookup"
15098 matches the host name that Exim obtains by doing a reverse lookup of the
15099 calling host address, or
15100 .next
15101 when looked up in DNS yields the calling host address.
15102 .endlist
15103
15104 However, the EHLO or HELO command is not rejected if any of the checks
15105 fail. Processing continues, but the result of the check is remembered, and can
15106 be detected later in an ACL by the &`verify = helo`& condition.
15107
15108 If DNS was used for successful verification, the variable
15109 .cindex "DNS" "DNSSEC"
15110 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15111
15112 .option helo_verify_hosts main "host list&!!" unset
15113 .cindex "HELO verifying" "mandatory"
15114 .cindex "EHLO" "verifying, mandatory"
15115 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15116 backwards compatibility. For hosts that match this option, Exim checks the host
15117 name given in the HELO or EHLO in the same way as for
15118 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15119 rejected with a 550 error, and entries are written to the main and reject logs.
15120 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15121 error.
15122
15123 .option hold_domains main "domain list&!!" unset
15124 .cindex "domain" "delaying delivery"
15125 .cindex "delivery" "delaying certain domains"
15126 This option allows mail for particular domains to be held on the queue
15127 manually. The option is overridden if a message delivery is forced with the
15128 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15129 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15130 item in &%hold_domains%&, no routing or delivery for that address is done, and
15131 it is deferred every time the message is looked at.
15132
15133 This option is intended as a temporary operational measure for delaying the
15134 delivery of mail while some problem is being sorted out, or some new
15135 configuration tested. If you just want to delay the processing of some
15136 domains until a queue run occurs, you should use &%queue_domains%& or
15137 &%queue_smtp_domains%&, not &%hold_domains%&.
15138
15139 A setting of &%hold_domains%& does not override Exim's code for removing
15140 messages from the queue if they have been there longer than the longest retry
15141 time in any retry rule. If you want to hold messages for longer than the normal
15142 retry times, insert a dummy retry rule with a long retry time.
15143
15144
15145 .option host_lookup main "host list&!!" unset
15146 .cindex "host name" "lookup, forcing"
15147 Exim does not look up the name of a calling host from its IP address unless it
15148 is required to compare against some host list, or the host matches
15149 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15150 option (which normally contains IP addresses rather than host names). The
15151 default configuration file contains
15152 .code
15153 host_lookup = *
15154 .endd
15155 which causes a lookup to happen for all hosts. If the expense of these lookups
15156 is felt to be too great, the setting can be changed or removed.
15157
15158 After a successful reverse lookup, Exim does a forward lookup on the name it
15159 has obtained, to verify that it yields the IP address that it started with. If
15160 this check fails, Exim behaves as if the name lookup failed.
15161
15162 .vindex "&$host_lookup_failed$&"
15163 .vindex "&$sender_host_name$&"
15164 After any kind of failure, the host name (in &$sender_host_name$&) remains
15165 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15166 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15167 &`verify = reverse_host_lookup`& in ACLs.
15168
15169
15170 .option host_lookup_order main "string list" &`bydns:byaddr`&
15171 This option specifies the order of different lookup methods when Exim is trying
15172 to find a host name from an IP address. The default is to do a DNS lookup
15173 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15174 if that fails. You can change the order of these lookups, or omit one entirely,
15175 if you want.
15176
15177 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15178 multiple PTR records in the DNS and the IP address is not listed in
15179 &_/etc/hosts_&. Different operating systems give different results in this
15180 case. That is why the default tries a DNS lookup first.
15181
15182
15183
15184 .option host_reject_connection main "host list&!!" unset
15185 .cindex "host" "rejecting connections from"
15186 If this option is set, incoming SMTP calls from the hosts listed are rejected
15187 as soon as the connection is made.
15188 This option is obsolete, and retained only for backward compatibility, because
15189 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15190 connections immediately.
15191
15192 The ability to give an immediate rejection (either by this option or using an
15193 ACL) is provided for use in unusual cases. Many hosts will just try again,
15194 sometimes without much delay. Normally, it is better to use an ACL to reject
15195 incoming messages at a later stage, such as after RCPT commands. See
15196 chapter &<<CHAPACL>>&.
15197
15198
15199 .option hosts_connection_nolog main "host list&!!" unset
15200 .cindex "host" "not logging connections from"
15201 This option defines a list of hosts for which connection logging does not
15202 happen, even though the &%smtp_connection%& log selector is set. For example,
15203 you might want not to log SMTP connections from local processes, or from
15204 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15205 the daemon; you should therefore strive to restrict its value to a short inline
15206 list of IP addresses and networks. To disable logging SMTP connections from
15207 local processes, you must create a host list with an empty item. For example:
15208 .code
15209 hosts_connection_nolog = :
15210 .endd
15211 If the &%smtp_connection%& log selector is not set, this option has no effect.
15212
15213
15214
15215 .option hosts_proxy main "host list&!!" unset
15216 .cindex proxy "proxy protocol"
15217 This option enables use of Proxy Protocol proxies for incoming
15218 connections.  For details see section &<<SECTproxyInbound>>&.
15219
15220
15221 .option hosts_treat_as_local main "domain list&!!" unset
15222 .cindex "local host" "domains treated as"
15223 .cindex "host" "treated as local"
15224 If this option is set, any host names that match the domain list are treated as
15225 if they were the local host when Exim is scanning host lists obtained from MX
15226 records
15227 or other sources. Note that the value of this option is a domain list, not a
15228 host list, because it is always used to check host names, not IP addresses.
15229
15230 This option also applies when Exim is matching the special items
15231 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15232 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15233 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15234 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15235 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15236 interfaces and recognizing the local host.
15237
15238
15239 .option ibase_servers main "string list" unset
15240 .cindex "InterBase" "server list"
15241 This option provides a list of InterBase servers and associated connection data,
15242 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15243 The option is available only if Exim has been built with InterBase support.
15244
15245
15246
15247 .option ignore_bounce_errors_after main time 10w
15248 .cindex "bounce message" "discarding"
15249 .cindex "discarding bounce message"
15250 This option affects the processing of bounce messages that cannot be delivered,
15251 that is, those that suffer a permanent delivery failure. (Bounce messages that
15252 suffer temporary delivery failures are of course retried in the usual way.)
15253
15254 After a permanent delivery failure, bounce messages are frozen,
15255 because there is no sender to whom they can be returned. When a frozen bounce
15256 message has been on the queue for more than the given time, it is unfrozen at
15257 the next queue run, and a further delivery is attempted. If delivery fails
15258 again, the bounce message is discarded. This makes it possible to keep failed
15259 bounce messages around for a shorter time than the normal maximum retry time
15260 for frozen messages. For example,
15261 .code
15262 ignore_bounce_errors_after = 12h
15263 .endd
15264 retries failed bounce message deliveries after 12 hours, discarding any further
15265 failures. If the value of this option is set to a zero time period, bounce
15266 failures are discarded immediately. Setting a very long time (as in the default
15267 value) has the effect of disabling this option. For ways of automatically
15268 dealing with other kinds of frozen message, see &%auto_thaw%& and
15269 &%timeout_frozen_after%&.
15270
15271
15272 .option ignore_fromline_hosts main "host list&!!" unset
15273 .cindex "&""From""& line"
15274 .cindex "UUCP" "&""From""& line"
15275 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15276 the headers of a message. By default this is treated as the start of the
15277 message's body, which means that any following headers are not recognized as
15278 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15279 match those hosts that insist on sending it. If the sender is actually a local
15280 process rather than a remote host, and is using &%-bs%& to inject the messages,
15281 &%ignore_fromline_local%& must be set to achieve this effect.
15282
15283
15284 .option ignore_fromline_local main boolean false
15285 See &%ignore_fromline_hosts%& above.
15286
15287 .option keep_environment main "string list" unset
15288 .cindex "environment" "values from"
15289 This option contains a string list of environment variables to keep.
15290 You have to trust these variables or you have to be sure that
15291 these variables do not impose any security risk. Keep in mind that
15292 during the startup phase Exim is running with an effective UID 0 in most
15293 installations. As the default value is an empty list, the default
15294 environment for using libraries, running embedded Perl code, or running
15295 external binaries is empty, and does not not even contain PATH or HOME.
15296
15297 Actually the list is interpreted as a list of patterns
15298 (&<<SECTlistexpand>>&), except that it is not expanded first.
15299
15300 WARNING: Macro substitution is still done first, so having a macro
15301 FOO and having FOO_HOME in your &%keep_environment%& option may have
15302 unexpected results. You may work around this using a regular expression
15303 that does not match the macro name: ^[F]OO_HOME$.
15304
15305 Current versions of Exim issue a warning during startup if you do not mention
15306 &%keep_environment%& in your runtime configuration file and if your
15307 current environment is not empty. Future versions may not issue that warning
15308 anymore.
15309
15310 See the &%add_environment%& main config option for a way to set
15311 environment variables to a fixed value.  The environment for &(pipe)&
15312 transports is handled separately, see section &<<SECTpipeenv>>& for
15313 details.
15314
15315
15316 .option keep_malformed main time 4d
15317 This option specifies the length of time to keep messages whose spool files
15318 have been corrupted in some way. This should, of course, never happen. At the
15319 next attempt to deliver such a message, it gets removed. The incident is
15320 logged.
15321
15322
15323 .option ldap_ca_cert_dir main string unset
15324 .cindex "LDAP", "TLS CA certificate directory"
15325 .cindex certificate "directory for LDAP"
15326 This option indicates which directory contains CA certificates for verifying
15327 a TLS certificate presented by an LDAP server.
15328 While Exim does not provide a default value, your SSL library may.
15329 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15330 and constrained to be a directory.
15331
15332
15333 .option ldap_ca_cert_file main string unset
15334 .cindex "LDAP", "TLS CA certificate file"
15335 .cindex certificate "file for LDAP"
15336 This option indicates which file contains CA certificates for verifying
15337 a TLS certificate presented by an LDAP server.
15338 While Exim does not provide a default value, your SSL library may.
15339 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15340 and constrained to be a file.
15341
15342
15343 .option ldap_cert_file main string unset
15344 .cindex "LDAP" "TLS client certificate file"
15345 .cindex certificate "file for LDAP"
15346 This option indicates which file contains an TLS client certificate which
15347 Exim should present to the LDAP server during TLS negotiation.
15348 Should be used together with &%ldap_cert_key%&.
15349
15350
15351 .option ldap_cert_key main string unset
15352 .cindex "LDAP" "TLS client key file"
15353 .cindex certificate "key for LDAP"
15354 This option indicates which file contains the secret/private key to use
15355 to prove identity to the LDAP server during TLS negotiation.
15356 Should be used together with &%ldap_cert_file%&, which contains the
15357 identity to be proven.
15358
15359
15360 .option ldap_cipher_suite main string unset
15361 .cindex "LDAP" "TLS cipher suite"
15362 This controls the TLS cipher-suite negotiation during TLS negotiation with
15363 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15364 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15365
15366
15367 .option ldap_default_servers main "string list" unset
15368 .cindex "LDAP" "default servers"
15369 This option provides a list of LDAP servers which are tried in turn when an
15370 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15371 details of LDAP queries. This option is available only when Exim has been built
15372 with LDAP support.
15373
15374
15375 .option ldap_require_cert main string unset.
15376 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15377 This should be one of the values "hard", "demand", "allow", "try" or "never".
15378 A value other than one of these is interpreted as "never".
15379 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15380 Although Exim does not set a default, the LDAP library probably defaults
15381 to hard/demand.
15382
15383
15384 .option ldap_start_tls main boolean false
15385 .cindex "LDAP" "whether or not to negotiate TLS"
15386 If set, Exim will attempt to negotiate TLS with the LDAP server when
15387 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15388 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15389 of SSL-on-connect.
15390 In the event of failure to negotiate TLS, the action taken is controlled
15391 by &%ldap_require_cert%&.
15392 This option is ignored for &`ldapi`& connections.
15393
15394
15395 .option ldap_version main integer unset
15396 .cindex "LDAP" "protocol version, forcing"
15397 This option can be used to force Exim to set a specific protocol version for
15398 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15399 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15400 the LDAP headers; otherwise it is 2. This option is available only when Exim
15401 has been built with LDAP support.
15402
15403
15404
15405 .option local_from_check main boolean true
15406 .cindex "&'Sender:'& header line" "disabling addition of"
15407 .cindex "&'From:'& header line" "disabling checking of"
15408 When a message is submitted locally (that is, not over a TCP/IP connection) by
15409 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15410 checks that the &'From:'& header line matches the login of the calling user and
15411 the domain specified by &%qualify_domain%&.
15412
15413 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15414 locally submitted message is automatically qualified by Exim, unless the
15415 &%-bnq%& command line option is used.
15416
15417 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15418 on the local part. If the &'From:'& header line does not match, Exim adds a
15419 &'Sender:'& header with an address constructed from the calling user's login
15420 and the default qualify domain.
15421
15422 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15423 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15424 &'Sender:'& header lines supplied by untrusted users, you must also set
15425 &%local_sender_retain%& to be true.
15426
15427 .cindex "envelope sender"
15428 These options affect only the header lines in the message. The envelope sender
15429 is still forced to be the login id at the qualify domain unless
15430 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15431
15432 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15433 request similar header line checking. See section &<<SECTthesenhea>>&, which
15434 has more details about &'Sender:'& processing.
15435
15436
15437
15438
15439 .option local_from_prefix main string unset
15440 When Exim checks the &'From:'& header line of locally submitted messages for
15441 matching the login id (see &%local_from_check%& above), it can be configured to
15442 ignore certain prefixes and suffixes in the local part of the address. This is
15443 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15444 appropriate lists, in the same form as the &%local_part_prefix%& and
15445 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15446 example, if
15447 .code
15448 local_from_prefix = *-
15449 .endd
15450 is set, a &'From:'& line containing
15451 .code
15452 From: anything-user@your.domain.example
15453 .endd
15454 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15455 matches the actual sender address that is constructed from the login name and
15456 qualify domain.
15457
15458
15459 .option local_from_suffix main string unset
15460 See &%local_from_prefix%& above.
15461
15462
15463 .option local_interfaces main "string list" "see below"
15464 This option controls which network interfaces are used by the daemon for
15465 listening; they are also used to identify the local host when routing. Chapter
15466 &<<CHAPinterfaces>>& contains a full description of this option and the related
15467 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15468 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15469 &%local_interfaces%& is
15470 .code
15471 local_interfaces = 0.0.0.0
15472 .endd
15473 when Exim is built without IPv6 support; otherwise it is
15474 .code
15475 local_interfaces = <; ::0 ; 0.0.0.0
15476 .endd
15477
15478 .option local_scan_timeout main time 5m
15479 .cindex "timeout" "for &[local_scan()]& function"
15480 .cindex "&[local_scan()]& function" "timeout"
15481 This timeout applies to the &[local_scan()]& function (see chapter
15482 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15483 the incoming message is rejected with a temporary error if it is an SMTP
15484 message. For a non-SMTP message, the message is dropped and Exim ends with a
15485 non-zero code. The incident is logged on the main and reject logs.
15486
15487
15488
15489 .option local_sender_retain main boolean false
15490 .cindex "&'Sender:'& header line" "retaining from local submission"
15491 When a message is submitted locally (that is, not over a TCP/IP connection) by
15492 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15493 do not want this to happen, you must set &%local_sender_retain%&, and you must
15494 also set &%local_from_check%& to be false (Exim will complain if you do not).
15495 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15496 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15497
15498
15499
15500
15501 .option localhost_number main string&!! unset
15502 .cindex "host" "locally unique number for"
15503 .cindex "message ids" "with multiple hosts"
15504 .vindex "&$localhost_number$&"
15505 Exim's message ids are normally unique only within the local host. If
15506 uniqueness among a set of hosts is required, each host must set a different
15507 value for the &%localhost_number%& option. The string is expanded immediately
15508 after reading the configuration file (so that a number can be computed from the
15509 host name, for example) and the result of the expansion must be a number in the
15510 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15511 systems). This is available in subsequent string expansions via the variable
15512 &$localhost_number$&. When &%localhost_number is set%&, the final two
15513 characters of the message id, instead of just being a fractional part of the
15514 time, are computed from the time and the local host number as described in
15515 section &<<SECTmessiden>>&.
15516
15517
15518
15519 .option log_file_path main "string list&!!" "set at compile time"
15520 .cindex "log" "file path for"
15521 This option sets the path which is used to determine the names of Exim's log
15522 files, or indicates that logging is to be to syslog, or both. It is expanded
15523 when Exim is entered, so it can, for example, contain a reference to the host
15524 name. If no specific path is set for the log files at compile or run time,
15525 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15526 they are written in a sub-directory called &_log_& in Exim's spool directory.
15527 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15528 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15529 used. If this string is fixed at your installation (contains no expansion
15530 variables) it is recommended that you do not set this option in the
15531 configuration file, but instead supply the path using LOG_FILE_PATH in
15532 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15533 early on &-- in particular, failure to read the configuration file.
15534
15535
15536 .option log_selector main string unset
15537 .cindex "log" "selectors"
15538 This option can be used to reduce or increase the number of things that Exim
15539 writes to its log files. Its argument is made up of names preceded by plus or
15540 minus characters. For example:
15541 .code
15542 log_selector = +arguments -retry_defer
15543 .endd
15544 A list of possible names and what they control is given in the chapter on
15545 logging, in section &<<SECTlogselector>>&.
15546
15547
15548 .option log_timezone main boolean false
15549 .cindex "log" "timezone for entries"
15550 .vindex "&$tod_log$&"
15551 .vindex "&$tod_zone$&"
15552 By default, the timestamps on log lines are in local time without the
15553 timezone. This means that if your timezone changes twice a year, the timestamps
15554 in log lines are ambiguous for an hour when the clocks go back. One way of
15555 avoiding this problem is to set the timezone to UTC. An alternative is to set
15556 &%log_timezone%& true. This turns on the addition of the timezone offset to
15557 timestamps in log lines. Turning on this option can add quite a lot to the size
15558 of log files because each line is extended by 6 characters. Note that the
15559 &$tod_log$& variable contains the log timestamp without the zone, but there is
15560 another variable called &$tod_zone$& that contains just the timezone offset.
15561
15562
15563 .option lookup_open_max main integer 25
15564 .cindex "too many open files"
15565 .cindex "open files, too many"
15566 .cindex "file" "too many open"
15567 .cindex "lookup" "maximum open files"
15568 .cindex "limit" "open files for lookups"
15569 This option limits the number of simultaneously open files for single-key
15570 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15571 Exim normally keeps these files open during routing, because often the same
15572 file is required several times. If the limit is reached, Exim closes the least
15573 recently used file. Note that if you are using the &'ndbm'& library, it
15574 actually opens two files for each logical DBM database, though it still counts
15575 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15576 open files"& errors with NDBM, you need to reduce the value of
15577 &%lookup_open_max%&.
15578
15579
15580 .option max_username_length main integer 0
15581 .cindex "length of login name"
15582 .cindex "user name" "maximum length"
15583 .cindex "limit" "user name length"
15584 Some operating systems are broken in that they truncate long arguments to
15585 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15586 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15587 an argument that is longer behaves as if &[getpwnam()]& failed.
15588
15589
15590 .option message_body_newlines main bool false
15591 .cindex "message body" "newlines in variables"
15592 .cindex "newline" "in message body variables"
15593 .vindex "&$message_body$&"
15594 .vindex "&$message_body_end$&"
15595 By default, newlines in the message body are replaced by spaces when setting
15596 the &$message_body$& and &$message_body_end$& expansion variables. If this
15597 option is set true, this no longer happens.
15598
15599
15600 .option message_body_visible main integer 500
15601 .cindex "body of message" "visible size"
15602 .cindex "message body" "visible size"
15603 .vindex "&$message_body$&"
15604 .vindex "&$message_body_end$&"
15605 This option specifies how much of a message's body is to be included in the
15606 &$message_body$& and &$message_body_end$& expansion variables.
15607
15608
15609 .option message_id_header_domain main string&!! unset
15610 .cindex "&'Message-ID:'& header line"
15611 If this option is set, the string is expanded and used as the right hand side
15612 (domain) of the &'Message-ID:'& header that Exim creates if a
15613 locally-originated incoming message does not have one. &"Locally-originated"&
15614 means &"not received over TCP/IP."&
15615 Otherwise, the primary host name is used.
15616 Only letters, digits, dot and hyphen are accepted; any other characters are
15617 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15618 empty string, the option is ignored.
15619
15620
15621 .option message_id_header_text main string&!! unset
15622 If this variable is set, the string is expanded and used to augment the text of
15623 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15624 message does not have one. The text of this header is required by RFC 2822 to
15625 take the form of an address. By default, Exim uses its internal message id as
15626 the local part, and the primary host name as the domain. If this option is set,
15627 it is expanded, and provided the expansion is not forced to fail, and does not
15628 yield an empty string, the result is inserted into the header immediately
15629 before the @, separated from the internal message id by a dot. Any characters
15630 that are illegal in an address are automatically converted into hyphens. This
15631 means that variables such as &$tod_log$& can be used, because the spaces and
15632 colons will become hyphens.
15633
15634
15635 .option message_logs main boolean true
15636 .cindex "message logs" "disabling"
15637 .cindex "log" "message log; disabling"
15638 If this option is turned off, per-message log files are not created in the
15639 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15640 Exim, by reducing the number of files involved in handling a message from a
15641 minimum of four (header spool file, body spool file, delivery journal, and
15642 per-message log) to three. The other major I/O activity is Exim's main log,
15643 which is not affected by this option.
15644
15645
15646 .option message_size_limit main string&!! 50M
15647 .cindex "message" "size limit"
15648 .cindex "limit" "message size"
15649 .cindex "size" "of message, limit"
15650 This option limits the maximum size of message that Exim will process. The
15651 value is expanded for each incoming connection so, for example, it can be made
15652 to depend on the IP address of the remote host for messages arriving via
15653 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15654 optionally followed by K or M.
15655
15656 &*Note*&: This limit cannot be made to depend on a message's sender or any
15657 other properties of an individual message, because it has to be advertised in
15658 the server's response to EHLO. String expansion failure causes a temporary
15659 error. A value of zero means no limit, but its use is not recommended. See also
15660 &%bounce_return_size_limit%&.
15661
15662 Incoming SMTP messages are failed with a 552 error if the limit is
15663 exceeded; locally-generated messages either get a stderr message or a delivery
15664 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15665 an oversized message is logged in both the main and the reject logs. See also
15666 the generic transport option &%message_size_limit%&, which limits the size of
15667 message that an individual transport can process.
15668
15669 If you use a virus-scanner and set this option to to a value larger than the
15670 maximum size that your virus-scanner is configured to support, you may get
15671 failures triggered by large mails.  The right size to configure for the
15672 virus-scanner depends upon what data is passed and the options in use but it's
15673 probably safest to just set it to a little larger than this value.  E.g., with a
15674 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15675 some problems may result.
15676
15677 A value of 0 will disable size limit checking; Exim will still advertise the
15678 SIZE extension in an EHLO response, but without a limit, so as to permit
15679 SMTP clients to still indicate the message size along with the MAIL verb.
15680
15681
15682 .option move_frozen_messages main boolean false
15683 .cindex "frozen messages" "moving"
15684 This option, which is available only if Exim has been built with the setting
15685 .code
15686 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15687 .endd
15688 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15689 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15690 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15691 standard utilities for handling such moved messages, and they do not show up in
15692 lists generated by &%-bp%& or by the Exim monitor.
15693
15694
15695 .option mua_wrapper main boolean false
15696 Setting this option true causes Exim to run in a very restrictive mode in which
15697 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15698 contains a full description of this facility.
15699
15700
15701
15702 .option mysql_servers main "string list" unset
15703 .cindex "MySQL" "server list"
15704 This option provides a list of MySQL servers and associated connection data, to
15705 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15706 option is available only if Exim has been built with MySQL support.
15707
15708
15709 .option never_users main "string list&!!" unset
15710 This option is expanded just once, at the start of Exim's processing. Local
15711 message deliveries are normally run in processes that are setuid to the
15712 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15713 It is usually desirable to prevent any deliveries from running as root, as a
15714 safety precaution.
15715
15716 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15717 list of users that must not be used for local deliveries. This list is fixed in
15718 the binary and cannot be overridden by the configuration file. By default, it
15719 contains just the single user name &"root"&. The &%never_users%& runtime option
15720 can be used to add more users to the fixed list.
15721
15722 If a message is to be delivered as one of the users on the fixed list or the
15723 &%never_users%& list, an error occurs, and delivery is deferred. A common
15724 example is
15725 .code
15726 never_users = root:daemon:bin
15727 .endd
15728 Including root is redundant if it is also on the fixed list, but it does no
15729 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15730 transport driver.
15731
15732
15733 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
15734 .cindex "OpenSSL "compatibility options"
15735 This option allows an administrator to adjust the SSL options applied
15736 by OpenSSL to connections.  It is given as a space-separated list of items,
15737 each one to be +added or -subtracted from the current value.
15738
15739 This option is only available if Exim is built against OpenSSL.  The values
15740 available for this option vary according to the age of your OpenSSL install.
15741 The &"all"& value controls a subset of flags which are available, typically
15742 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15743 list the values known on your system and Exim should support all the
15744 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15745 names lose the leading &"SSL_OP_"& and are lower-cased.
15746
15747 Note that adjusting the options can have severe impact upon the security of
15748 SSL as used by Exim.  It is possible to disable safety checks and shoot
15749 yourself in the foot in various unpleasant ways.  This option should not be
15750 adjusted lightly.  An unrecognised item will be detected at startup, by
15751 invoking Exim with the &%-bV%& flag.
15752
15753 The option affects Exim operating both as a server and as a client.
15754
15755 Historical note: prior to release 4.80, Exim defaulted this value to
15756 "+dont_insert_empty_fragments", which may still be needed for compatibility
15757 with some clients, but which lowers security by increasing exposure to
15758 some now infamous attacks.
15759
15760 Examples:
15761 .code
15762 # Make both old MS and old Eudora happy:
15763 openssl_options = -all +microsoft_big_sslv3_buffer \
15764                        +dont_insert_empty_fragments
15765
15766 # Disable older protocol versions:
15767 openssl_options = +no_sslv2 +no_sslv3
15768 .endd
15769
15770 Possible options may include:
15771 .ilist
15772 &`all`&
15773 .next
15774 &`allow_unsafe_legacy_renegotiation`&
15775 .next
15776 &`cipher_server_preference`&
15777 .next
15778 &`dont_insert_empty_fragments`&
15779 .next
15780 &`ephemeral_rsa`&
15781 .next
15782 &`legacy_server_connect`&
15783 .next
15784 &`microsoft_big_sslv3_buffer`&
15785 .next
15786 &`microsoft_sess_id_bug`&
15787 .next
15788 &`msie_sslv2_rsa_padding`&
15789 .next
15790 &`netscape_challenge_bug`&
15791 .next
15792 &`netscape_reuse_cipher_change_bug`&
15793 .next
15794 &`no_compression`&
15795 .next
15796 &`no_session_resumption_on_renegotiation`&
15797 .next
15798 &`no_sslv2`&
15799 .next
15800 &`no_sslv3`&
15801 .next
15802 &`no_ticket`&
15803 .next
15804 &`no_tlsv1`&
15805 .next
15806 &`no_tlsv1_1`&
15807 .next
15808 &`no_tlsv1_2`&
15809 .next
15810 &`safari_ecdhe_ecdsa_bug`&
15811 .next
15812 &`single_dh_use`&
15813 .next
15814 &`single_ecdh_use`&
15815 .next
15816 &`ssleay_080_client_dh_bug`&
15817 .next
15818 &`sslref2_reuse_cert_type_bug`&
15819 .next
15820 &`tls_block_padding_bug`&
15821 .next
15822 &`tls_d5_bug`&
15823 .next
15824 &`tls_rollback_bug`&
15825 .endlist
15826
15827 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15828 all clients connecting using the MacOS SecureTransport TLS facility prior
15829 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15830 to negotiate TLS then this option value might help, provided that your OpenSSL
15831 release is new enough to contain this work-around.  This may be a situation
15832 where you have to upgrade OpenSSL to get buggy clients working.
15833
15834
15835 .option oracle_servers main "string list" unset
15836 .cindex "Oracle" "server list"
15837 This option provides a list of Oracle servers and associated connection data,
15838 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15839 The option is available only if Exim has been built with Oracle support.
15840
15841
15842 .option percent_hack_domains main "domain list&!!" unset
15843 .cindex "&""percent hack""&"
15844 .cindex "source routing" "in email address"
15845 .cindex "address" "source-routed"
15846 The &"percent hack"& is the convention whereby a local part containing a
15847 percent sign is re-interpreted as a new email address, with the percent
15848 replaced by @. This is sometimes called &"source routing"&, though that term is
15849 also applied to RFC 2822 addresses that begin with an @ character. If this
15850 option is set, Exim implements the percent facility for those domains listed,
15851 but no others. This happens before an incoming SMTP address is tested against
15852 an ACL.
15853
15854 &*Warning*&: The &"percent hack"& has often been abused by people who are
15855 trying to get round relaying restrictions. For this reason, it is best avoided
15856 if at all possible. Unfortunately, a number of less security-conscious MTAs
15857 implement it unconditionally. If you are running Exim on a gateway host, and
15858 routing mail through to internal MTAs without processing the local parts, it is
15859 a good idea to reject recipient addresses with percent characters in their
15860 local parts. Exim's default configuration does this.
15861
15862
15863 .option perl_at_start main boolean false
15864 .cindex "Perl"
15865 This option is available only when Exim is built with an embedded Perl
15866 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15867
15868
15869 .option perl_startup main string unset
15870 .cindex "Perl"
15871 This option is available only when Exim is built with an embedded Perl
15872 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15873
15874 .option perl_startup main boolean false
15875 .cindex "Perl"
15876 This Option enables the taint mode of the embedded Perl interpreter.
15877
15878
15879 .option pgsql_servers main "string list" unset
15880 .cindex "PostgreSQL lookup type" "server list"
15881 This option provides a list of PostgreSQL servers and associated connection
15882 data, to be used in conjunction with &(pgsql)& lookups (see section
15883 &<<SECID72>>&). The option is available only if Exim has been built with
15884 PostgreSQL support.
15885
15886
15887 .option pid_file_path main string&!! "set at compile time"
15888 .cindex "daemon" "pid file path"
15889 .cindex "pid file, path for"
15890 This option sets the name of the file to which the Exim daemon writes its
15891 process id. The string is expanded, so it can contain, for example, references
15892 to the host name:
15893 .code
15894 pid_file_path = /var/log/$primary_hostname/exim.pid
15895 .endd
15896 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15897 spool directory.
15898 The value set by the option can be overridden by the &%-oP%& command line
15899 option. A pid file is not written if a &"non-standard"& daemon is run by means
15900 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15901
15902
15903 .option pipelining_advertise_hosts main "host list&!!" *
15904 .cindex "PIPELINING" "suppressing advertising"
15905 This option can be used to suppress the advertisement of the SMTP
15906 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15907 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15908 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15909 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15910 that clients will use it; &"out of order"& commands that are &"expected"& do
15911 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15912
15913
15914 .option prdr_enable main boolean false
15915 .cindex "PRDR" "enabling on server"
15916 This option can be used to enable the Per-Recipient Data Response extension
15917 to SMTP, defined by Eric Hall.
15918 If the option is set, PRDR is advertised by Exim when operating as a server.
15919 If the client requests PRDR, and more than one recipient, for a message
15920 an additional ACL is called for each recipient after the message content
15921 is received.  See section &<<SECTPRDRACL>>&.
15922
15923 .option preserve_message_logs main boolean false
15924 .cindex "message logs" "preserving"
15925 If this option is set, message log files are not deleted when messages are
15926 completed. Instead, they are moved to a sub-directory of the spool directory
15927 called &_msglog.OLD_&, where they remain available for statistical or debugging
15928 purposes. This is a dangerous option to set on systems with any appreciable
15929 volume of mail. Use with care!
15930
15931
15932 .option primary_hostname main string "see below"
15933 .cindex "name" "of local host"
15934 .cindex "host" "name of local"
15935 .cindex "local host" "name of"
15936 .vindex "&$primary_hostname$&"
15937 This specifies the name of the current host. It is used in the default EHLO or
15938 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15939 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15940 The value is also used by default in some SMTP response messages from an Exim
15941 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15942
15943 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15944 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15945 contains only one component, Exim passes it to &[gethostbyname()]& (or
15946 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15947 version. The variable &$primary_hostname$& contains the host name, whether set
15948 explicitly by this option, or defaulted.
15949
15950
15951 .option print_topbitchars main boolean false
15952 .cindex "printing characters"
15953 .cindex "8-bit characters"
15954 By default, Exim considers only those characters whose codes lie in the range
15955 32&--126 to be printing characters. In a number of circumstances (for example,
15956 when writing log entries) non-printing characters are converted into escape
15957 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15958 is set, code values of 128 and above are also considered to be printing
15959 characters.
15960
15961 This option also affects the header syntax checks performed by the
15962 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15963 the user's full name when constructing From: and Sender: addresses (as
15964 described in section &<<SECTconstr>>&). Setting this option can cause
15965 Exim to generate eight bit message headers that do not conform to the
15966 standards.
15967
15968
15969 .option process_log_path main string unset
15970 .cindex "process log path"
15971 .cindex "log" "process log"
15972 .cindex "&'exiwhat'&"
15973 This option sets the name of the file to which an Exim process writes its
15974 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15975 utility script. If this option is unset, the file called &_exim-process.info_&
15976 in Exim's spool directory is used. The ability to specify the name explicitly
15977 can be useful in environments where two different Exims are running, using
15978 different spool directories.
15979
15980
15981 .option prod_requires_admin main boolean true
15982 .cindex "restricting access to features"
15983 .oindex "&%-M%&"
15984 .oindex "&%-R%&"
15985 .oindex "&%-q%&"
15986 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15987 admin user unless &%prod_requires_admin%& is set false. See also
15988 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
15989
15990
15991 .option qualify_domain main string "see below"
15992 .cindex "domain" "for qualifying addresses"
15993 .cindex "address" "qualification"
15994 This option specifies the domain name that is added to any envelope sender
15995 addresses that do not have a domain qualification. It also applies to
15996 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15997 are accepted by default only for locally-generated messages. Qualification is
15998 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15999 locally-generated messages, unless the &%-bnq%& command line option is used.
16000
16001 Messages from external sources must always contain fully qualified addresses,
16002 unless the sending host matches &%sender_unqualified_hosts%& or
16003 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16004 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16005 necessary. Internally, Exim always works with fully qualified envelope
16006 addresses. If &%qualify_domain%& is not set, it defaults to the
16007 &%primary_hostname%& value.
16008
16009
16010 .option qualify_recipient main string "see below"
16011 This option allows you to specify a different domain for qualifying recipient
16012 addresses to the one that is used for senders. See &%qualify_domain%& above.
16013
16014
16015
16016 .option queue_domains main "domain list&!!" unset
16017 .cindex "domain" "specifying non-immediate delivery"
16018 .cindex "queueing incoming messages"
16019 .cindex "message" "queueing certain domains"
16020 This option lists domains for which immediate delivery is not required.
16021 A delivery process is started whenever a message is received, but only those
16022 domains that do not match are processed. All other deliveries wait until the
16023 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16024
16025
16026 .option queue_list_requires_admin main boolean true
16027 .cindex "restricting access to features"
16028 .oindex "&%-bp%&"
16029 The &%-bp%& command-line option, which lists the messages that are on the
16030 queue, requires the caller to be an admin user unless
16031 &%queue_list_requires_admin%& is set false.
16032 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16033
16034
16035 .option queue_only main boolean false
16036 .cindex "queueing incoming messages"
16037 .cindex "message" "queueing unconditionally"
16038 If &%queue_only%& is set, a delivery process is not automatically started
16039 whenever a message is received. Instead, the message waits on the queue for the
16040 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16041 delivered immediately when certain conditions (such as heavy load) occur.
16042
16043 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16044 and &%-odi%& command line options override &%queue_only%& unless
16045 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16046 &%queue_only_load%&, and &%smtp_accept_queue%&.
16047
16048
16049 .option queue_only_file main string unset
16050 .cindex "queueing incoming messages"
16051 .cindex "message" "queueing by file existence"
16052 This option can be set to a colon-separated list of absolute path names, each
16053 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16054 it tests for the existence of each listed path using a call to &[stat()]&. For
16055 each path that exists, the corresponding queueing option is set.
16056 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16057 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16058 .code
16059 queue_only_file = smtp/some/file
16060 .endd
16061 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16062 &_/some/file_& exists.
16063
16064
16065 .option queue_only_load main fixed-point unset
16066 .cindex "load average"
16067 .cindex "queueing incoming messages"
16068 .cindex "message" "queueing by load"
16069 If the system load average is higher than this value, incoming messages from
16070 all sources are queued, and no automatic deliveries are started. If this
16071 happens during local or remote SMTP input, all subsequent messages received on
16072 the same SMTP connection are queued by default, whatever happens to the load in
16073 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16074 false.
16075
16076 Deliveries will subsequently be performed by queue runner processes. This
16077 option has no effect on ancient operating systems on which Exim cannot
16078 determine the load average. See also &%deliver_queue_load_max%& and
16079 &%smtp_load_reserve%&.
16080
16081
16082 .option queue_only_load_latch main boolean true
16083 .cindex "load average" "re-evaluating per message"
16084 When this option is true (the default), once one message has been queued
16085 because the load average is higher than the value set by &%queue_only_load%&,
16086 all subsequent messages received on the same SMTP connection are also queued.
16087 This is a deliberate choice; even though the load average may fall below the
16088 threshold, it doesn't seem right to deliver later messages on the same
16089 connection when not delivering earlier ones. However, there are special
16090 circumstances such as very long-lived connections from scanning appliances
16091 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16092 should be set false. This causes the value of the load average to be
16093 re-evaluated for each message.
16094
16095
16096 .option queue_only_override main boolean true
16097 .cindex "queueing incoming messages"
16098 When this option is true, the &%-od%&&'x'& command line options override the
16099 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16100 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16101 to override; they are accepted, but ignored.
16102
16103
16104 .option queue_run_in_order main boolean false
16105 .cindex "queue runner" "processing messages in order"
16106 If this option is set, queue runs happen in order of message arrival instead of
16107 in an arbitrary order. For this to happen, a complete list of the entire queue
16108 must be set up before the deliveries start. When the queue is all held in a
16109 single directory (the default), a single list is created for both the ordered
16110 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16111 single list is not created when &%queue_run_in_order%& is false. In this case,
16112 the sub-directories are processed one at a time (in a random order), and this
16113 avoids setting up one huge list for the whole queue. Thus, setting
16114 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16115 when the queue is large, because of the extra work in setting up the single,
16116 large list. In most situations, &%queue_run_in_order%& should not be set.
16117
16118
16119
16120 .option queue_run_max main integer&!! 5
16121 .cindex "queue runner" "maximum number of"
16122 This controls the maximum number of queue runner processes that an Exim daemon
16123 can run simultaneously. This does not mean that it starts them all at once,
16124 but rather that if the maximum number are still running when the time comes to
16125 start another one, it refrains from starting another one. This can happen with
16126 very large queues and/or very sluggish deliveries. This option does not,
16127 however, interlock with other processes, so additional queue runners can be
16128 started by other means, or by killing and restarting the daemon.
16129
16130 Setting this option to zero does not suppress queue runs; rather, it disables
16131 the limit, allowing any number of simultaneous queue runner processes to be
16132 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16133 the daemon's command line.
16134
16135 .cindex queues named
16136 .cindex "named queues"
16137 To set limits for different named queues use
16138 an expansion depending on the &$queue_name$& variable.
16139
16140 .option queue_smtp_domains main "domain list&!!" unset
16141 .cindex "queueing incoming messages"
16142 .cindex "message" "queueing remote deliveries"
16143 When this option is set, a delivery process is started whenever a message is
16144 received, routing is performed, and local deliveries take place.
16145 However, if any SMTP deliveries are required for domains that match
16146 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16147 message waits on the queue for the next queue run. Since routing of the message
16148 has taken place, Exim knows to which remote hosts it must be delivered, and so
16149 when the queue run happens, multiple messages for the same host are delivered
16150 over a single SMTP connection. The &%-odqs%& command line option causes all
16151 SMTP deliveries to be queued in this way, and is equivalent to setting
16152 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16153 &%queue_domains%&.
16154
16155
16156 .option receive_timeout main time 0s
16157 .cindex "timeout" "for non-SMTP input"
16158 This option sets the timeout for accepting a non-SMTP message, that is, the
16159 maximum time that Exim waits when reading a message on the standard input. If
16160 the value is zero, it will wait for ever. This setting is overridden by the
16161 &%-or%& command line option. The timeout for incoming SMTP messages is
16162 controlled by &%smtp_receive_timeout%&.
16163
16164 .option received_header_text main string&!! "see below"
16165 .cindex "customizing" "&'Received:'& header"
16166 .cindex "&'Received:'& header line" "customizing"
16167 This string defines the contents of the &'Received:'& message header that is
16168 added to each message, except for the timestamp, which is automatically added
16169 on at the end (preceded by a semicolon). The string is expanded each time it is
16170 used. If the expansion yields an empty string, no &'Received:'& header line is
16171 added to the message. Otherwise, the string should start with the text
16172 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16173 header lines. The default setting is:
16174
16175 .code
16176 received_header_text = Received: \
16177   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16178   {${if def:sender_ident \
16179   {from ${quote_local_part:$sender_ident} }}\
16180   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16181   by $primary_hostname \
16182   ${if def:received_protocol {with $received_protocol}} \
16183   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16184   (Exim $version_number)\n\t\
16185   ${if def:sender_address \
16186   {(envelope-from <$sender_address>)\n\t}}\
16187   id $message_exim_id\
16188   ${if def:received_for {\n\tfor $received_for}}
16189 .endd
16190
16191 The reference to the TLS cipher is omitted when Exim is built without TLS
16192 support. The use of conditional expansions ensures that this works for both
16193 locally generated messages and messages received from remote hosts, giving
16194 header lines such as the following:
16195 .code
16196 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16197 by marley.carol.example with esmtp (Exim 4.00)
16198 (envelope-from <bob@carol.example>)
16199 id 16IOWa-00019l-00
16200 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16201 Received: by scrooge.carol.example with local (Exim 4.00)
16202 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16203 .endd
16204 Until the body of the message has been received, the timestamp is the time when
16205 the message started to be received. Once the body has arrived, and all policy
16206 checks have taken place, the timestamp is updated to the time at which the
16207 message was accepted.
16208
16209
16210 .option received_headers_max main integer 30
16211 .cindex "loop" "prevention"
16212 .cindex "mail loop prevention"
16213 .cindex "&'Received:'& header line" "counting"
16214 When a message is to be delivered, the number of &'Received:'& headers is
16215 counted, and if it is greater than this parameter, a mail loop is assumed to
16216 have occurred, the delivery is abandoned, and an error message is generated.
16217 This applies to both local and remote deliveries.
16218
16219
16220 .option recipient_unqualified_hosts main "host list&!!" unset
16221 .cindex "unqualified addresses"
16222 .cindex "host" "unqualified addresses from"
16223 This option lists those hosts from which Exim is prepared to accept unqualified
16224 recipient addresses in message envelopes. The addresses are made fully
16225 qualified by the addition of the &%qualify_recipient%& value. This option also
16226 affects message header lines. Exim does not reject unqualified recipient
16227 addresses in headers, but it qualifies them only if the message came from a
16228 host that matches &%recipient_unqualified_hosts%&,
16229 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16230 option was not set.
16231
16232
16233 .option recipients_max main integer 0
16234 .cindex "limit" "number of recipients"
16235 .cindex "recipient" "maximum number"
16236 If this option is set greater than zero, it specifies the maximum number of
16237 original recipients for any message. Additional recipients that are generated
16238 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16239 all recipients over the limit; earlier recipients are delivered as normal.
16240 Non-SMTP messages with too many recipients are failed, and no deliveries are
16241 done.
16242
16243 .cindex "RCPT" "maximum number of incoming"
16244 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16245 RCPT commands in a single message.
16246
16247
16248 .option recipients_max_reject main boolean false
16249 If this option is set true, Exim rejects SMTP messages containing too many
16250 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16251 error to the eventual DATA command. Otherwise (the default) it gives a 452
16252 error to the surplus RCPT commands and accepts the message on behalf of the
16253 initial set of recipients. The remote server should then re-send the message
16254 for the remaining recipients at a later time.
16255
16256
16257 .option remote_max_parallel main integer 2
16258 .cindex "delivery" "parallelism for remote"
16259 This option controls parallel delivery of one message to a number of remote
16260 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16261 does all the remote deliveries for a message one by one. Otherwise, if a single
16262 message has to be delivered to more than one remote host, or if several copies
16263 have to be sent to the same remote host, up to &%remote_max_parallel%&
16264 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16265 deliveries are required, the maximum number of processes are started, and as
16266 each one finishes, another is begun. The order of starting processes is the
16267 same as if sequential delivery were being done, and can be controlled by the
16268 &%remote_sort_domains%& option. If parallel delivery takes place while running
16269 with debugging turned on, the debugging output from each delivery process is
16270 tagged with its process id.
16271
16272 This option controls only the maximum number of parallel deliveries for one
16273 message in one Exim delivery process. Because Exim has no central queue
16274 manager, there is no way of controlling the total number of simultaneous
16275 deliveries if the configuration allows a delivery attempt as soon as a message
16276 is received.
16277
16278 .cindex "number of deliveries"
16279 .cindex "delivery" "maximum number of"
16280 If you want to control the total number of deliveries on the system, you
16281 need to set the &%queue_only%& option. This ensures that all incoming messages
16282 are added to the queue without starting a delivery process. Then set up an Exim
16283 daemon to start queue runner processes at appropriate intervals (probably
16284 fairly often, for example, every minute), and limit the total number of queue
16285 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16286 delivers only one message at a time, the maximum number of deliveries that can
16287 then take place at once is &%queue_run_max%& multiplied by
16288 &%remote_max_parallel%&.
16289
16290 If it is purely remote deliveries you want to control, use
16291 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16292 doing the SMTP routing before queueing, so that several messages for the same
16293 host will eventually get delivered down the same connection.
16294
16295
16296 .option remote_sort_domains main "domain list&!!" unset
16297 .cindex "sorting remote deliveries"
16298 .cindex "delivery" "sorting remote"
16299 When there are a number of remote deliveries for a message, they are sorted by
16300 domain into the order given by this list. For example,
16301 .code
16302 remote_sort_domains = *.cam.ac.uk:*.uk
16303 .endd
16304 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16305 then to those in the &%uk%& domain, then to any others.
16306
16307
16308 .option retry_data_expire main time 7d
16309 .cindex "hints database" "data expiry"
16310 This option sets a &"use before"& time on retry information in Exim's hints
16311 database. Any older retry data is ignored. This means that, for example, once a
16312 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16313 past failures.
16314
16315
16316 .option retry_interval_max main time 24h
16317 .cindex "retry" "limit on interval"
16318 .cindex "limit" "on retry interval"
16319 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16320 intervals between delivery attempts for messages that cannot be delivered
16321 straight away. This option sets an overall limit to the length of time between
16322 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16323 the default value.
16324
16325
16326 .option return_path_remove main boolean true
16327 .cindex "&'Return-path:'& header line" "removing"
16328 RFC 2821, section 4.4, states that an SMTP server must insert a
16329 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16330 The &'Return-path:'& header preserves the sender address as received in the
16331 MAIL command. This description implies that this header should not be present
16332 in an incoming message. If &%return_path_remove%& is true, any existing
16333 &'Return-path:'& headers are removed from messages at the time they are
16334 received. Exim's transports have options for adding &'Return-path:'& headers at
16335 the time of delivery. They are normally used only for final local deliveries.
16336
16337
16338 .option return_size_limit main integer 100K
16339 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16340
16341
16342 .option rfc1413_hosts main "host list&!!" @[]
16343 .cindex "RFC 1413"
16344 .cindex "host" "for RFC 1413 calls"
16345 RFC 1413 identification calls are made to any client host which matches
16346 an item in the list.
16347 The default value specifies just this host, being any local interface
16348 for the system.
16349
16350 .option rfc1413_query_timeout main time 0s
16351 .cindex "RFC 1413" "query timeout"
16352 .cindex "timeout" "for RFC 1413 call"
16353 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16354 no RFC 1413 calls are ever made.
16355
16356
16357 .option sender_unqualified_hosts main "host list&!!" unset
16358 .cindex "unqualified addresses"
16359 .cindex "host" "unqualified addresses from"
16360 This option lists those hosts from which Exim is prepared to accept unqualified
16361 sender addresses. The addresses are made fully qualified by the addition of
16362 &%qualify_domain%&. This option also affects message header lines. Exim does
16363 not reject unqualified addresses in headers that contain sender addresses, but
16364 it qualifies them only if the message came from a host that matches
16365 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16366 using TCP/IP), and the &%-bnq%& option was not set.
16367
16368 .option set_environment main "string list" empty
16369 .cindex "environment"
16370 This option allows to set individual environment variables that the
16371 currently linked libraries and programs in child processes use. The
16372 default list is empty,
16373
16374
16375 .option slow_lookup_log main integer 0
16376 .cindex "logging" "slow lookups"
16377 .cindex "dns" "logging slow lookups"
16378 This option controls logging of slow lookups.
16379 If the value is nonzero it is taken as a number of milliseconds
16380 and lookups taking longer than this are logged.
16381 Currently this applies only to DNS lookups.
16382
16383
16384
16385 .option smtp_accept_keepalive main boolean true
16386 .cindex "keepalive" "on incoming connection"
16387 This option controls the setting of the SO_KEEPALIVE option on incoming
16388 TCP/IP socket connections. When set, it causes the kernel to probe idle
16389 connections periodically, by sending packets with &"old"& sequence numbers. The
16390 other end of the connection should send an acknowledgment if the connection is
16391 still okay or a reset if the connection has been aborted. The reason for doing
16392 this is that it has the beneficial effect of freeing up certain types of
16393 connection that can get stuck when the remote host is disconnected without
16394 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16395 hours to detect unreachable hosts.
16396
16397
16398
16399 .option smtp_accept_max main integer 20
16400 .cindex "limit" "incoming SMTP connections"
16401 .cindex "SMTP" "incoming connection count"
16402 .cindex "inetd"
16403 This option specifies the maximum number of simultaneous incoming SMTP calls
16404 that Exim will accept. It applies only to the listening daemon; there is no
16405 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16406 value is set to zero, no limit is applied. However, it is required to be
16407 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16408 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16409
16410 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16411 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16412 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16413 and &%smtp_load_reserve%& are then checked before accepting the connection.
16414
16415
16416 .option smtp_accept_max_nonmail main integer 10
16417 .cindex "limit" "non-mail SMTP commands"
16418 .cindex "SMTP" "limiting non-mail commands"
16419 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16420 the connection if there are too many. This option defines &"too many"&. The
16421 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16422 client looping sending EHLO, for example. The check is applied only if the
16423 client host matches &%smtp_accept_max_nonmail_hosts%&.
16424
16425 When a new message is expected, one occurrence of RSET is not counted. This
16426 allows a client to send one RSET between messages (this is not necessary,
16427 but some clients do it). Exim also allows one uncounted occurrence of HELO
16428 or EHLO, and one occurrence of STARTTLS between messages. After
16429 starting up a TLS session, another EHLO is expected, and so it too is not
16430 counted. The first occurrence of AUTH in a connection, or immediately
16431 following STARTTLS is not counted. Otherwise, all commands other than
16432 MAIL, RCPT, DATA, and QUIT are counted.
16433
16434
16435 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16436 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16437 check by setting this option. The default value makes it apply to all hosts. By
16438 changing the value, you can exclude any badly-behaved hosts that you have to
16439 live with.
16440
16441
16442 . Allow this long option name to split; give it unsplit as a fifth argument
16443 . for the automatic .oindex that is generated by .option.
16444 . We insert " &~&~" which is both pretty nasty visually and results in
16445 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16446 . zero-width-space, which would be nicer visually and results in (at least)
16447 . html that Firefox will split on when it's forced to reflow (rather than
16448 . inserting a horizontal scrollbar).  However, the text is still not
16449 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16450 . the option name to split.
16451
16452 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16453          smtp_accept_max_per_connection
16454 .cindex "SMTP" "limiting incoming message count"
16455 .cindex "limit" "messages per SMTP connection"
16456 The value of this option limits the number of MAIL commands that Exim is
16457 prepared to accept over a single SMTP connection, whether or not each command
16458 results in the transfer of a message. After the limit is reached, a 421
16459 response is given to subsequent MAIL commands. This limit is a safety
16460 precaution against a client that goes mad (incidents of this type have been
16461 seen).
16462
16463
16464 .option smtp_accept_max_per_host main string&!! unset
16465 .cindex "limit" "SMTP connections from one host"
16466 .cindex "host" "limiting SMTP connections from"
16467 This option restricts the number of simultaneous IP connections from a single
16468 host (strictly, from a single IP address) to the Exim daemon. The option is
16469 expanded, to enable different limits to be applied to different hosts by
16470 reference to &$sender_host_address$&. Once the limit is reached, additional
16471 connection attempts from the same host are rejected with error code 421. This
16472 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16473 of zero imposes no limit. If this option is set greater than zero, it is
16474 required that &%smtp_accept_max%& be non-zero.
16475
16476 &*Warning*&: When setting this option you should not use any expansion
16477 constructions that take an appreciable amount of time. The expansion and test
16478 happen in the main daemon loop, in order to reject additional connections
16479 without forking additional processes (otherwise a denial-of-service attack
16480 could cause a vast number or processes to be created). While the daemon is
16481 doing this processing, it cannot accept any other incoming connections.
16482
16483
16484
16485 .option smtp_accept_queue main integer 0
16486 .cindex "SMTP" "incoming connection count"
16487 .cindex "queueing incoming messages"
16488 .cindex "message" "queueing by SMTP connection count"
16489 If the number of simultaneous incoming SMTP connections being handled via the
16490 listening daemon exceeds this value, messages received by SMTP are just placed
16491 on the queue; no delivery processes are started automatically. The count is
16492 fixed at the start of an SMTP connection. It cannot be updated in the
16493 subprocess that receives messages, and so the queueing or not queueing applies
16494 to all messages received in the same connection.
16495
16496 A value of zero implies no limit, and clearly any non-zero value is useful only
16497 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16498 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16499 various &%-od%&&'x'& command line options.
16500
16501
16502 . See the comment on smtp_accept_max_per_connection
16503
16504 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16505          smtp_accept_queue_per_connection
16506 .cindex "queueing incoming messages"
16507 .cindex "message" "queueing by message count"
16508 This option limits the number of delivery processes that Exim starts
16509 automatically when receiving messages via SMTP, whether via the daemon or by
16510 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16511 and the number of messages received in a single SMTP session exceeds this
16512 number, subsequent messages are placed on the queue, but no delivery processes
16513 are started. This helps to limit the number of Exim processes when a server
16514 restarts after downtime and there is a lot of mail waiting for it on other
16515 systems. On large systems, the default should probably be increased, and on
16516 dial-in client systems it should probably be set to zero (that is, disabled).
16517
16518
16519 .option smtp_accept_reserve main integer 0
16520 .cindex "SMTP" "incoming call count"
16521 .cindex "host" "reserved"
16522 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16523 number of SMTP connections that are reserved for connections from the hosts
16524 that are specified in &%smtp_reserve_hosts%&. The value set in
16525 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16526 restricted to this number of connections; the option specifies a minimum number
16527 of connection slots for them, not a maximum. It is a guarantee that this group
16528 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16529 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16530 individual host.
16531
16532 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16533 set to 5, once there are 45 active connections (from any hosts), new
16534 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16535 provided the other criteria for acceptance are met.
16536
16537
16538 .option smtp_active_hostname main string&!! unset
16539 .cindex "host" "name in SMTP responses"
16540 .cindex "SMTP" "host name in responses"
16541 .vindex "&$primary_hostname$&"
16542 This option is provided for multi-homed servers that want to masquerade as
16543 several different hosts. At the start of an incoming SMTP connection, its value
16544 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16545 responses. For example, it is used as domain name in the response to an
16546 incoming HELO or EHLO command.
16547
16548 .vindex "&$smtp_active_hostname$&"
16549 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16550 is saved with any messages that are received. It is therefore available for use
16551 in routers and transports when the message is later delivered.
16552
16553 If this option is unset, or if its expansion is forced to fail, or if the
16554 expansion results in an empty string, the value of &$primary_hostname$& is
16555 used. Other expansion failures cause a message to be written to the main and
16556 panic logs, and the SMTP command receives a temporary error. Typically, the
16557 value of &%smtp_active_hostname%& depends on the incoming interface address.
16558 For example:
16559 .code
16560 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16561   {cox.mydomain}{box.mydomain}}
16562 .endd
16563
16564 Although &$smtp_active_hostname$& is primarily concerned with incoming
16565 messages, it is also used as the default for HELO commands in callout
16566 verification if there is no remote transport from which to obtain a
16567 &%helo_data%& value.
16568
16569 .option smtp_banner main string&!! "see below"
16570 .cindex "SMTP" "welcome banner"
16571 .cindex "banner for SMTP"
16572 .cindex "welcome banner for SMTP"
16573 .cindex "customizing" "SMTP banner"
16574 This string, which is expanded every time it is used, is output as the initial
16575 positive response to an SMTP connection. The default setting is:
16576 .code
16577 smtp_banner = $smtp_active_hostname ESMTP Exim \
16578   $version_number $tod_full
16579 .endd
16580 Failure to expand the string causes a panic error. If you want to create a
16581 multiline response to the initial SMTP connection, use &"\n"& in the string at
16582 appropriate points, but not at the end. Note that the 220 code is not included
16583 in this string. Exim adds it automatically (several times in the case of a
16584 multiline response).
16585
16586
16587 .option smtp_check_spool_space main boolean true
16588 .cindex "checking disk space"
16589 .cindex "disk space, checking"
16590 .cindex "spool directory" "checking space"
16591 When this option is set, if an incoming SMTP session encounters the SIZE
16592 option on a MAIL command, it checks that there is enough space in the
16593 spool directory's partition to accept a message of that size, while still
16594 leaving free the amount specified by &%check_spool_space%& (even if that value
16595 is zero). If there isn't enough space, a temporary error code is returned.
16596
16597
16598 .option smtp_connect_backlog main integer 20
16599 .cindex "connection backlog"
16600 .cindex "SMTP" "connection backlog"
16601 .cindex "backlog of connections"
16602 This option specifies a maximum number of waiting SMTP connections. Exim passes
16603 this value to the TCP/IP system when it sets up its listener. Once this number
16604 of connections are waiting for the daemon's attention, subsequent connection
16605 attempts are refused at the TCP/IP level. At least, that is what the manuals
16606 say; in some circumstances such connection attempts have been observed to time
16607 out instead. For large systems it is probably a good idea to increase the
16608 value (to 50, say). It also gives some protection against denial-of-service
16609 attacks by SYN flooding.
16610
16611
16612 .option smtp_enforce_sync main boolean true
16613 .cindex "SMTP" "synchronization checking"
16614 .cindex "synchronization checking in SMTP"
16615 The SMTP protocol specification requires the client to wait for a response from
16616 the server at certain points in the dialogue. Without PIPELINING these
16617 synchronization points are after every command; with PIPELINING they are
16618 fewer, but they still exist.
16619
16620 Some spamming sites send out a complete set of SMTP commands without waiting
16621 for any response. Exim protects against this by rejecting a message if the
16622 client has sent further input when it should not have. The error response &"554
16623 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16624 for this error cannot be perfect because of transmission delays (unexpected
16625 input may be on its way but not yet received when Exim checks). However, it
16626 does detect many instances.
16627
16628 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16629 If you want to disable the check selectively (for example, only for certain
16630 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16631 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16632
16633
16634
16635 .option smtp_etrn_command main string&!! unset
16636 .cindex "ETRN" "command to be run"
16637 .vindex "&$domain$&"
16638 If this option is set, the given command is run whenever an SMTP ETRN
16639 command is received from a host that is permitted to issue such commands (see
16640 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16641 are independently expanded. The expansion variable &$domain$& is set to the
16642 argument of the ETRN command, and no syntax checking is done on it. For
16643 example:
16644 .code
16645 smtp_etrn_command = /etc/etrn_command $domain \
16646                     $sender_host_address
16647 .endd
16648 A new process is created to run the command, but Exim does not wait for it to
16649 complete. Consequently, its status cannot be checked. If the command cannot be
16650 run, a line is written to the panic log, but the ETRN caller still receives
16651 a 250 success response. Exim is normally running under its own uid when
16652 receiving SMTP, so it is not possible for it to change the uid before running
16653 the command.
16654
16655
16656 .option smtp_etrn_serialize main boolean true
16657 .cindex "ETRN" "serializing"
16658 When this option is set, it prevents the simultaneous execution of more than
16659 one identical command as a result of ETRN in an SMTP connection. See
16660 section &<<SECTETRN>>& for details.
16661
16662
16663 .option smtp_load_reserve main fixed-point unset
16664 .cindex "load average"
16665 If the system load average ever gets higher than this, incoming SMTP calls are
16666 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16667 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16668 the load is over the limit. The option has no effect on ancient operating
16669 systems on which Exim cannot determine the load average. See also
16670 &%deliver_queue_load_max%& and &%queue_only_load%&.
16671
16672
16673
16674 .option smtp_max_synprot_errors main integer 3
16675 .cindex "SMTP" "limiting syntax and protocol errors"
16676 .cindex "limit" "SMTP syntax and protocol errors"
16677 Exim rejects SMTP commands that contain syntax or protocol errors. In
16678 particular, a syntactically invalid email address, as in this command:
16679 .code
16680 RCPT TO:<abc xyz@a.b.c>
16681 .endd
16682 causes immediate rejection of the command, before any other tests are done.
16683 (The ACL cannot be run if there is no valid address to set up for it.) An
16684 example of a protocol error is receiving RCPT before MAIL. If there are
16685 too many syntax or protocol errors in one SMTP session, the connection is
16686 dropped. The limit is set by this option.
16687
16688 .cindex "PIPELINING" "expected errors"
16689 When the PIPELINING extension to SMTP is in use, some protocol errors are
16690 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16691 Exim assumes that PIPELINING will be used if it advertises it (see
16692 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16693 not count towards the limit.
16694
16695
16696
16697 .option smtp_max_unknown_commands main integer 3
16698 .cindex "SMTP" "limiting unknown commands"
16699 .cindex "limit" "unknown SMTP commands"
16700 If there are too many unrecognized commands in an incoming SMTP session, an
16701 Exim server drops the connection. This is a defence against some kinds of abuse
16702 that subvert web
16703 clients
16704 into making connections to SMTP ports; in these circumstances, a number of
16705 non-SMTP command lines are sent first.
16706
16707
16708
16709 .option smtp_ratelimit_hosts main "host list&!!" unset
16710 .cindex "SMTP" "rate limiting"
16711 .cindex "limit" "rate of message arrival"
16712 .cindex "RCPT" "rate limiting"
16713 Some sites find it helpful to be able to limit the rate at which certain hosts
16714 can send them messages, and the rate at which an individual message can specify
16715 recipients.
16716
16717 Exim has two rate-limiting facilities. This section describes the older
16718 facility, which can limit rates within a single connection. The newer
16719 &%ratelimit%& ACL condition can limit rates across all connections. See section
16720 &<<SECTratelimiting>>& for details of the newer facility.
16721
16722 When a host matches &%smtp_ratelimit_hosts%&, the values of
16723 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16724 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16725 respectively. Each option, if set, must contain a set of four comma-separated
16726 values:
16727
16728 .ilist
16729 A threshold, before which there is no rate limiting.
16730 .next
16731 An initial time delay. Unlike other times in Exim, numbers with decimal
16732 fractional parts are allowed here.
16733 .next
16734 A factor by which to increase the delay each time.
16735 .next
16736 A maximum value for the delay. This should normally be less than 5 minutes,
16737 because after that time, the client is liable to timeout the SMTP command.
16738 .endlist
16739
16740 For example, these settings have been used successfully at the site which
16741 first suggested this feature, for controlling mail from their customers:
16742 .code
16743 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16744 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16745 .endd
16746 The first setting specifies delays that are applied to MAIL commands after
16747 two have been received over a single connection. The initial delay is 0.5
16748 seconds, increasing by a factor of 1.05 each time. The second setting applies
16749 delays to RCPT commands when more than four occur in a single message.
16750
16751
16752 .option smtp_ratelimit_mail main string unset
16753 See &%smtp_ratelimit_hosts%& above.
16754
16755
16756 .option smtp_ratelimit_rcpt main string unset
16757 See &%smtp_ratelimit_hosts%& above.
16758
16759
16760 .option smtp_receive_timeout main time&!! 5m
16761 .cindex "timeout" "for SMTP input"
16762 .cindex "SMTP" "input timeout"
16763 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16764 input, including batch SMTP. If a line of input (either an SMTP command or a
16765 data line) is not received within this time, the SMTP connection is dropped and
16766 the message is abandoned.
16767 A line is written to the log containing one of the following messages:
16768 .code
16769 SMTP command timeout on connection from...
16770 SMTP data timeout on connection from...
16771 .endd
16772 The former means that Exim was expecting to read an SMTP command; the latter
16773 means that it was in the DATA phase, reading the contents of a message.
16774
16775 If the first character of the option is a &"$"& the option is
16776 expanded before use and may depend on
16777 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16778
16779
16780 .oindex "&%-os%&"
16781 The value set by this option can be overridden by the
16782 &%-os%& command-line option. A setting of zero time disables the timeout, but
16783 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16784 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16785 timeout is controlled by &%receive_timeout%& and &%-or%&.
16786
16787
16788 .option smtp_reserve_hosts main "host list&!!" unset
16789 This option defines hosts for which SMTP connections are reserved; see
16790 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16791
16792
16793 .option smtp_return_error_details main boolean false
16794 .cindex "SMTP" "details policy failures"
16795 .cindex "policy control" "rejection, returning details"
16796 In the default state, Exim uses bland messages such as
16797 &"Administrative prohibition"& when it rejects SMTP commands for policy
16798 reasons. Many sysadmins like this because it gives away little information
16799 to spammers. However, some other sysadmins who are applying strict checking
16800 policies want to give out much fuller information about failures. Setting
16801 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16802 example, instead of &"Administrative prohibition"&, it might give:
16803 .code
16804 550-Rejected after DATA: '>' missing at end of address:
16805 550 failing address in "From" header is: <user@dom.ain
16806 .endd
16807
16808
16809 .option smtputf8_advertise_hosts main "host list&!!" *
16810 .cindex "SMTPUTF8" "advertising"
16811 When Exim is built with support for internationalised mail names,
16812 the availability thereof is advertised in
16813 response to EHLO only to those client hosts that match this option. See
16814 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16815
16816
16817 .option spamd_address main string "see below"
16818 This option is available when Exim is compiled with the content-scanning
16819 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16820 The default value is
16821 .code
16822 127.0.0.1 783
16823 .endd
16824 See section &<<SECTscanspamass>>& for more details.
16825
16826
16827
16828 .option split_spool_directory main boolean false
16829 .cindex "multiple spool directories"
16830 .cindex "spool directory" "split"
16831 .cindex "directories, multiple"
16832 If this option is set, it causes Exim to split its input directory into 62
16833 subdirectories, each with a single alphanumeric character as its name. The
16834 sixth character of the message id is used to allocate messages to
16835 subdirectories; this is the least significant base-62 digit of the time of
16836 arrival of the message.
16837
16838 Splitting up the spool in this way may provide better performance on systems
16839 where there are long mail queues, by reducing the number of files in any one
16840 directory. The msglog directory is also split up in a similar way to the input
16841 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16842 are still placed in the single directory &_msglog.OLD_&.
16843
16844 It is not necessary to take any special action for existing messages when
16845 changing &%split_spool_directory%&. Exim notices messages that are in the
16846 &"wrong"& place, and continues to process them. If the option is turned off
16847 after a period of being on, the subdirectories will eventually empty and be
16848 automatically deleted.
16849
16850 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16851 changes. Instead of creating a list of all messages in the queue, and then
16852 trying to deliver each one in turn, it constructs a list of those in one
16853 sub-directory and tries to deliver them, before moving on to the next
16854 sub-directory. The sub-directories are processed in a random order. This
16855 spreads out the scanning of the input directories, and uses less memory. It is
16856 particularly beneficial when there are lots of messages on the queue. However,
16857 if &%queue_run_in_order%& is set, none of this new processing happens. The
16858 entire queue has to be scanned and sorted before any deliveries can start.
16859
16860
16861 .option spool_directory main string&!! "set at compile time"
16862 .cindex "spool directory" "path to"
16863 This defines the directory in which Exim keeps its spool, that is, the messages
16864 it is waiting to deliver. The default value is taken from the compile-time
16865 configuration setting, if there is one. If not, this option must be set. The
16866 string is expanded, so it can contain, for example, a reference to
16867 &$primary_hostname$&.
16868
16869 If the spool directory name is fixed on your installation, it is recommended
16870 that you set it at build time rather than from this option, particularly if the
16871 log files are being written to the spool directory (see &%log_file_path%&).
16872 Otherwise log files cannot be used for errors that are detected early on, such
16873 as failures in the configuration file.
16874
16875 By using this option to override the compiled-in path, it is possible to run
16876 tests of Exim without using the standard spool.
16877
16878 .new
16879 .option spool_wireformat main boolean false
16880 .cindex "spool directory" "file formats"
16881 If this option is set, Exim may for some messages use an alternate format
16882 for data-files in the spool which matches the wire format.
16883 Doing this permits more efficient message reception and transmission.
16884 Currently it is only done for messages received using the EMSTP CHUNKING
16885 option.
16886
16887 The following variables will not have useful values:
16888 .code
16889 $max_received_linelength
16890 $body_linecount
16891 $body_zerocount
16892 .endd
16893
16894 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
16895 and any external programs which are passed a reference to a message data file
16896 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
16897 will need to be aware of the potential different format.
16898
16899 Using any of the ACL conditions noted will negate the reception benefit
16900 (as a Unix-mbox-format file is contructed for them).
16901 The transimssion benefit is maintained.
16902 .wen
16903
16904 .option sqlite_lock_timeout main time 5s
16905 .cindex "sqlite lookup type" "lock timeout"
16906 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16907 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16908
16909 .option strict_acl_vars main boolean false
16910 .cindex "&ACL;" "variables, handling unset"
16911 This option controls what happens if a syntactically valid but undefined ACL
16912 variable is referenced. If it is false (the default), an empty string
16913 is substituted; if it is true, an error is generated. See section
16914 &<<SECTaclvariables>>& for details of ACL variables.
16915
16916 .option strip_excess_angle_brackets main boolean false
16917 .cindex "angle brackets, excess"
16918 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16919 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16920 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16921 passed on to another MTA, the excess angle brackets are not passed on. If this
16922 option is not set, multiple pairs of angle brackets cause a syntax error.
16923
16924
16925 .option strip_trailing_dot main boolean false
16926 .cindex "trailing dot on domain"
16927 .cindex "dot" "trailing on domain"
16928 If this option is set, a trailing dot at the end of a domain in an address is
16929 ignored. If this is in the envelope and the message is passed on to another
16930 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16931 domain causes a syntax error.
16932 However, addresses in header lines are checked only when an ACL requests header
16933 syntax checking.
16934
16935
16936 .option syslog_duplication main boolean true
16937 .cindex "syslog" "duplicate log lines; suppressing"
16938 When Exim is logging to syslog, it writes the log lines for its three
16939 separate logs at different syslog priorities so that they can in principle
16940 be separated on the logging hosts. Some installations do not require this
16941 separation, and in those cases, the duplication of certain log lines is a
16942 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16943 particular log line is written to syslog. For lines that normally go to
16944 both the main log and the reject log, the reject log version (possibly
16945 containing message header lines) is written, at LOG_NOTICE priority.
16946 Lines that normally go to both the main and the panic log are written at
16947 the LOG_ALERT priority.
16948
16949
16950 .option syslog_facility main string unset
16951 .cindex "syslog" "facility; setting"
16952 This option sets the syslog &"facility"& name, used when Exim is logging to
16953 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16954 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16955 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16956 details of Exim's logging.
16957
16958
16959 .option syslog_pid main boolean true
16960 .cindex "syslog" "pid"
16961 If &%syslog_pid%& is set false, the PID on Exim's log lines are
16962 omitted when these lines are sent to syslog. (Syslog normally prefixes
16963 the log lines with the PID of the logging process automatically.) You need
16964 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
16965 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
16966
16967
16968
16969 .option syslog_processname main string &`exim`&
16970 .cindex "syslog" "process name; setting"
16971 This option sets the syslog &"ident"& name, used when Exim is logging to
16972 syslog. The value must be no longer than 32 characters. See chapter
16973 &<<CHAPlog>>& for details of Exim's logging.
16974
16975
16976
16977 .option syslog_timestamp main boolean true
16978 .cindex "syslog" "timestamps"
16979 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16980 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16981 details of Exim's logging.
16982
16983
16984 .option system_filter main string&!! unset
16985 .cindex "filter" "system filter"
16986 .cindex "system filter" "specifying"
16987 .cindex "Sieve filter" "not available for system filter"
16988 This option specifies an Exim filter file that is applied to all messages at
16989 the start of each delivery attempt, before any routing is done. System filters
16990 must be Exim filters; they cannot be Sieve filters. If the system filter
16991 generates any deliveries to files or pipes, or any new mail messages, the
16992 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16993 which transports are to be used. Details of this facility are given in chapter
16994 &<<CHAPsystemfilter>>&.
16995 A forced expansion failure results in no filter operation.
16996
16997
16998 .option system_filter_directory_transport main string&!! unset
16999 .vindex "&$address_file$&"
17000 This sets the name of the transport driver that is to be used when the
17001 &%save%& command in a system message filter specifies a path ending in &"/"&,
17002 implying delivery of each message into a separate file in some directory.
17003 During the delivery, the variable &$address_file$& contains the path name.
17004
17005
17006 .option system_filter_file_transport main string&!! unset
17007 .cindex "file" "transport for system filter"
17008 This sets the name of the transport driver that is to be used when the &%save%&
17009 command in a system message filter specifies a path not ending in &"/"&. During
17010 the delivery, the variable &$address_file$& contains the path name.
17011
17012 .option system_filter_group main string unset
17013 .cindex "gid (group id)" "system filter"
17014 This option is used only when &%system_filter_user%& is also set. It sets the
17015 gid under which the system filter is run, overriding any gid that is associated
17016 with the user. The value may be numerical or symbolic.
17017
17018 .option system_filter_pipe_transport main string&!! unset
17019 .cindex "&(pipe)& transport" "for system filter"
17020 .vindex "&$address_pipe$&"
17021 This specifies the transport driver that is to be used when a &%pipe%& command
17022 is used in a system filter. During the delivery, the variable &$address_pipe$&
17023 contains the pipe command.
17024
17025
17026 .option system_filter_reply_transport main string&!! unset
17027 .cindex "&(autoreply)& transport" "for system filter"
17028 This specifies the transport driver that is to be used when a &%mail%& command
17029 is used in a system filter.
17030
17031
17032 .option system_filter_user main string unset
17033 .cindex "uid (user id)" "system filter"
17034 If this option is set to root, the system filter is run in the main Exim
17035 delivery process, as root.  Otherwise, the system filter runs in a separate
17036 process, as the given user, defaulting to the Exim run-time user.
17037 Unless the string consists entirely of digits, it
17038 is looked up in the password data. Failure to find the named user causes a
17039 configuration error. The gid is either taken from the password data, or
17040 specified by &%system_filter_group%&. When the uid is specified numerically,
17041 &%system_filter_group%& is required to be set.
17042
17043 If the system filter generates any pipe, file, or reply deliveries, the uid
17044 under which the filter is run is used when transporting them, unless a
17045 transport option overrides.
17046
17047
17048 .option tcp_nodelay main boolean true
17049 .cindex "daemon" "TCP_NODELAY on sockets"
17050 .cindex "Nagle algorithm"
17051 .cindex "TCP_NODELAY on listening sockets"
17052 If this option is set false, it stops the Exim daemon setting the
17053 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17054 turns off the &"Nagle algorithm"&, which is a way of improving network
17055 performance in interactive (character-by-character) situations. Turning it off
17056 should improve Exim's performance a bit, so that is what happens by default.
17057 However, it appears that some broken clients cannot cope, and time out. Hence
17058 this option. It affects only those sockets that are set up for listening by the
17059 daemon. Sockets created by the smtp transport for delivering mail always set
17060 TCP_NODELAY.
17061
17062
17063 .option timeout_frozen_after main time 0s
17064 .cindex "frozen messages" "timing out"
17065 .cindex "timeout" "frozen messages"
17066 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17067 message of any kind that has been on the queue for longer than the given time
17068 is automatically cancelled at the next queue run. If the frozen message is a
17069 bounce message, it is just discarded; otherwise, a bounce is sent to the
17070 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17071 If you want to timeout frozen bounce messages earlier than other kinds of
17072 frozen message, see &%ignore_bounce_errors_after%&.
17073
17074 &*Note:*& the default value of zero means no timeouts; with this setting,
17075 frozen messages remain on the queue forever (except for any frozen bounce
17076 messages that are released by &%ignore_bounce_errors_after%&).
17077
17078
17079 .option timezone main string unset
17080 .cindex "timezone, setting"
17081 .cindex "environment" "values from"
17082 The value of &%timezone%& is used to set the environment variable TZ while
17083 running Exim (if it is different on entry). This ensures that all timestamps
17084 created by Exim are in the required timezone. If you want all your timestamps
17085 to be in UTC (aka GMT) you should set
17086 .code
17087 timezone = UTC
17088 .endd
17089 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17090 or, if that is not set, from the value of the TZ environment variable when Exim
17091 is built. If &%timezone%& is set to the empty string, either at build or run
17092 time, any existing TZ variable is removed from the environment when Exim
17093 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17094 unfortunately not all, operating systems.
17095
17096
17097 .option tls_advertise_hosts main "host list&!!" *
17098 .cindex "TLS" "advertising"
17099 .cindex "encryption" "on SMTP connection"
17100 .cindex "SMTP" "encrypted connection"
17101 When Exim is built with support for TLS encrypted connections, the availability
17102 of the STARTTLS command to set up an encrypted session is advertised in
17103 response to EHLO only to those client hosts that match this option. See
17104 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17105 Note that the default value requires that a certificate be supplied
17106 using the &%tls_certificate%& option.  If TLS support for incoming connections
17107 is not required the &%tls_advertise_hosts%& option should be set empty.
17108
17109
17110 .option tls_certificate main string&!! unset
17111 .cindex "TLS" "server certificate; location of"
17112 .cindex "certificate" "server, location of"
17113 The value of this option is expanded, and must then be the absolute path to a
17114 file which contains the server's certificates. The server's private key is also
17115 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17116 &<<CHAPTLS>>& for further details.
17117
17118 &*Note*&: The certificates defined by this option are used only when Exim is
17119 receiving incoming messages as a server. If you want to supply certificates for
17120 use when sending messages as a client, you must set the &%tls_certificate%&
17121 option in the relevant &(smtp)& transport.
17122
17123 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17124 if the OpenSSL build supports TLS extensions and the TLS client sends the
17125 Server Name Indication extension, then this option and others documented in
17126 &<<SECTtlssni>>& will be re-expanded.
17127
17128 If this option is unset or empty a fresh self-signed certificate will be
17129 generated for every connection.
17130
17131 .option tls_crl main string&!! unset
17132 .cindex "TLS" "server certificate revocation list"
17133 .cindex "certificate" "revocation list for server"
17134 This option specifies a certificate revocation list. The expanded value must
17135 be the name of a file that contains a CRL in PEM format.
17136
17137 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17138
17139
17140 .option tls_dh_max_bits main integer 2236
17141 .cindex "TLS" "D-H bit count"
17142 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17143 the chosen TLS library.  That value might prove to be too high for
17144 interoperability.  This option provides a maximum clamp on the value
17145 suggested, trading off security for interoperability.
17146
17147 The value must be at least 1024.
17148
17149 The value 2236 was chosen because, at time of adding the option, it was the
17150 hard-coded maximum value supported by the NSS cryptographic library, as used
17151 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17152
17153 If you prefer more security and are willing to break some clients, raise this
17154 number.
17155
17156 Note that the value passed to GnuTLS for *generating* a new prime may be a
17157 little less than this figure, because GnuTLS is inexact and may produce a
17158 larger prime than requested.
17159
17160
17161 .option tls_dhparam main string&!! unset
17162 .cindex "TLS" "D-H parameters for server"
17163 The value of this option is expanded and indicates the source of DH parameters
17164 to be used by Exim.
17165
17166 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17167 local DH parameters*&, which has been supported across all versions of Exim.  The
17168 other specific constants available are a fallback so that even when
17169 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17170
17171 If &%tls_dhparam%& is a filename starting with a &`/`&,
17172 then it names a file from which DH
17173 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17174 PKCS#3 representation of the DH prime.  If the file does not exist, for
17175 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17176 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17177 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17178 and treated as though the &%tls_dhparam%& were set to "none".
17179
17180 If this option expands to the string "none", then no DH parameters will be
17181 loaded by Exim.
17182
17183 If this option expands to the string "historic" and Exim is using GnuTLS, then
17184 Exim will attempt to load a file from inside the spool directory.  If the file
17185 does not exist, Exim will attempt to create it.
17186 See section &<<SECTgnutlsparam>>& for further details.
17187
17188 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17189 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17190
17191 In older versions of Exim the default was the 2048 bit prime described in section
17192 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17193 in IKE is assigned number 23.
17194
17195 Otherwise, the option must expand to the name used by Exim for any of a number
17196 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17197 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17198 the number used by IKE, or "default" which corresponds to
17199 &`exim.dev.20160529.3`&.
17200
17201 The available standard primes are:
17202 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17203 &`ike1`&, &`ike2`&, &`ike5`&,
17204 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17205 &`ike22`&, &`ike23`& and &`ike24`&.
17206
17207 The available additional primes are:
17208 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17209
17210 Some of these will be too small to be accepted by clients.
17211 Some may be too large to be accepted by clients.
17212 The open cryptographic community has suspicions about the integrity of some
17213 of the later IKE values, which led into RFC7919 providing new fixed constants
17214 (the "ffdhe" identifiers).
17215
17216 At this point, all of the "ike" values should be considered obsolete;
17217 they're still in Exim to avoid breaking unusual configurations, but are
17218 candidates for removal the next time we have backwards-incompatible changes.
17219
17220 The TLS protocol does not negotiate an acceptable size for this; clients tend
17221 to hard-drop connections if what is offered by the server is unacceptable,
17222 whether too large or too small, and there's no provision for the client to
17223 tell the server what these constraints are.  Thus, as a server operator, you
17224 need to make an educated guess as to what is most likely to work for your
17225 userbase.
17226
17227 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17228 is most likely to maximise interoperability.  The upper bound comes from
17229 applications using the Mozilla Network Security Services (NSS) library, which
17230 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17231 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17232 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17233 acceptable bound from 1024 to 2048.
17234
17235
17236 .option tls_eccurve main string&!! &`auto`&
17237 .cindex TLS "EC cryptography"
17238 This option selects a EC curve for use by Exim when used with OpenSSL.
17239 It has no effect when Exim is used with GnuTLS.
17240
17241 After expansion it must contain a valid EC curve parameter, such as
17242 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17243 for valid selections.
17244
17245 For OpenSSL versions before (and not including) 1.0.2, the string
17246 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17247 &`auto`& tells the library to choose.
17248
17249 If the option expands to an empty string, no EC curves will be enabled.
17250
17251
17252 .option tls_ocsp_file main string&!! unset
17253 .cindex TLS "certificate status"
17254 .cindex TLS "OCSP proof file"
17255 This option
17256 must if set expand to the absolute path to a file which contains a current
17257 status proof for the server's certificate, as obtained from the
17258 Certificate Authority.
17259
17260 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17261
17262
17263 .option tls_on_connect_ports main "string list" unset
17264 .cindex SSMTP
17265 .cindex SMTPS
17266 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17267 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17268 set up without waiting for the client to issue a STARTTLS command. For
17269 further details, see section &<<SECTsupobssmt>>&.
17270
17271
17272
17273 .option tls_privatekey main string&!! unset
17274 .cindex "TLS" "server private key; location of"
17275 The value of this option is expanded, and must then be the absolute path to a
17276 file which contains the server's private key. If this option is unset, or if
17277 the expansion is forced to fail, or the result is an empty string, the private
17278 key is assumed to be in the same file as the server's certificates. See chapter
17279 &<<CHAPTLS>>& for further details.
17280
17281 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17282
17283
17284 .option tls_remember_esmtp main boolean false
17285 .cindex "TLS" "esmtp state; remembering"
17286 .cindex "TLS" "broken clients"
17287 If this option is set true, Exim violates the RFCs by remembering that it is in
17288 &"esmtp"& state after successfully negotiating a TLS session. This provides
17289 support for broken clients that fail to send a new EHLO after starting a
17290 TLS session.
17291
17292
17293 .option tls_require_ciphers main string&!! unset
17294 .cindex "TLS" "requiring specific ciphers"
17295 .cindex "cipher" "requiring specific"
17296 This option controls which ciphers can be used for incoming TLS connections.
17297 The &(smtp)& transport has an option of the same name for controlling outgoing
17298 connections. This option is expanded for each connection, so can be varied for
17299 different clients if required. The value of this option must be a list of
17300 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17301 in somewhat different ways. If GnuTLS is being used, the client controls the
17302 preference order of the available ciphers. Details are given in sections
17303 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17304
17305
17306 .option tls_try_verify_hosts main "host list&!!" unset
17307 .cindex "TLS" "client certificate verification"
17308 .cindex "certificate" "verification of client"
17309 See &%tls_verify_hosts%& below.
17310
17311
17312 .option tls_verify_certificates main string&!! system
17313 .cindex "TLS" "client certificate verification"
17314 .cindex "certificate" "verification of client"
17315 The value of this option is expanded, and must then be either the
17316 word "system"
17317 or the absolute path to
17318 a file or directory containing permitted certificates for clients that
17319 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17320
17321 The "system" value for the option will use a
17322 system default location compiled into the SSL library.
17323 This is not available for GnuTLS versions preceding 3.0.20,
17324 and will be taken as empty; an explicit location
17325 must be specified.
17326
17327 The use of a directory for the option value is not available for GnuTLS versions
17328 preceding 3.3.6 and a single file must be used.
17329
17330 With OpenSSL the certificates specified
17331 explicitly
17332 either by file or directory
17333 are added to those given by the system default location.
17334
17335 These certificates should be for the certificate authorities trusted, rather
17336 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17337 the value is a file then the certificates are sent by Exim as a server to
17338 connecting clients, defining the list of accepted certificate authorities.
17339 Thus the values defined should be considered public data.  To avoid this,
17340 use the explicit directory version.
17341
17342 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17343
17344 A forced expansion failure or setting to an empty string is equivalent to
17345 being unset.
17346
17347
17348 .option tls_verify_hosts main "host list&!!" unset
17349 .cindex "TLS" "client certificate verification"
17350 .cindex "certificate" "verification of client"
17351 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17352 certificates from clients. The expected certificates are defined by
17353 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17354 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17355 &%tls_verify_certificates%& is not set.
17356
17357 Any client that matches &%tls_verify_hosts%& is constrained by
17358 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17359 present one of the listed certificates. If it does not, the connection is
17360 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17361 the host to use TLS. It can still send SMTP commands through unencrypted
17362 connections. Forcing a client to use TLS has to be done separately using an
17363 ACL to reject inappropriate commands when the connection is not encrypted.
17364
17365 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17366 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17367 certificate and checks it against &%tls_verify_certificates%&, but does not
17368 abort the connection if there is no certificate or if it does not match. This
17369 state can be detected in an ACL, which makes it possible to implement policies
17370 such as &"accept for relay only if a verified certificate has been received,
17371 but accept for local delivery if encrypted, even without a verified
17372 certificate"&.
17373
17374 Client hosts that match neither of these lists are not asked to present
17375 certificates.
17376
17377
17378 .option trusted_groups main "string list&!!" unset
17379 .cindex "trusted groups"
17380 .cindex "groups" "trusted"
17381 This option is expanded just once, at the start of Exim's processing. If this
17382 option is set, any process that is running in one of the listed groups, or
17383 which has one of them as a supplementary group, is trusted. The groups can be
17384 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17385 details of what trusted callers are permitted to do. If neither
17386 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17387 are trusted.
17388
17389 .option trusted_users main "string list&!!" unset
17390 .cindex "trusted users"
17391 .cindex "user" "trusted"
17392 This option is expanded just once, at the start of Exim's processing. If this
17393 option is set, any process that is running as one of the listed users is
17394 trusted. The users can be specified numerically or by name. See section
17395 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17396 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17397 Exim user are trusted.
17398
17399 .option unknown_login main string&!! unset
17400 .cindex "uid (user id)" "unknown caller"
17401 .vindex "&$caller_uid$&"
17402 This is a specialized feature for use in unusual configurations. By default, if
17403 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17404 gives up. The &%unknown_login%& option can be used to set a login name to be
17405 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17406 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17407 is used for the user's real name (gecos field), unless this has been set by the
17408 &%-F%& option.
17409
17410 .option unknown_username main string unset
17411 See &%unknown_login%&.
17412
17413 .option untrusted_set_sender main "address list&!!" unset
17414 .cindex "trusted users"
17415 .cindex "sender" "setting by untrusted user"
17416 .cindex "untrusted user setting sender"
17417 .cindex "user" "untrusted setting sender"
17418 .cindex "envelope sender"
17419 When an untrusted user submits a message to Exim using the standard input, Exim
17420 normally creates an envelope sender address from the user's login and the
17421 default qualification domain. Data from the &%-f%& option (for setting envelope
17422 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17423 is used) is ignored.
17424
17425 However, untrusted users are permitted to set an empty envelope sender address,
17426 to declare that a message should never generate any bounces. For example:
17427 .code
17428 exim -f '<>' user@domain.example
17429 .endd
17430 .vindex "&$sender_ident$&"
17431 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17432 other envelope sender addresses in a controlled way. When it is set, untrusted
17433 users are allowed to set envelope sender addresses that match any of the
17434 patterns in the list. Like all address lists, the string is expanded. The
17435 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17436 users to setting senders that start with their login ids
17437 followed by a hyphen
17438 by a setting like this:
17439 .code
17440 untrusted_set_sender = ^$sender_ident-
17441 .endd
17442 If you want to allow untrusted users to set envelope sender addresses without
17443 restriction, you can use
17444 .code
17445 untrusted_set_sender = *
17446 .endd
17447 The &%untrusted_set_sender%& option applies to all forms of local input, but
17448 only to the setting of the envelope sender. It does not permit untrusted users
17449 to use the other options which trusted user can use to override message
17450 parameters. Furthermore, it does not stop Exim from removing an existing
17451 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17452 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17453 overriding these actions. The handling of the &'Sender:'& header is also
17454 described in section &<<SECTthesenhea>>&.
17455
17456 The log line for a message's arrival shows the envelope sender following
17457 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17458 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17459 envelope sender address, the user's login is shown in parentheses after the
17460 sender address.
17461
17462
17463 .option uucp_from_pattern main string "see below"
17464 .cindex "&""From""& line"
17465 .cindex "UUCP" "&""From""& line"
17466 Some applications that pass messages to an MTA via a command line interface use
17467 an initial line starting with &"From&~"& to pass the envelope sender. In
17468 particular, this is used by UUCP software. Exim recognizes such a line by means
17469 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17470 matches, the sender address is constructed by expanding the contents of
17471 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17472 default pattern recognizes lines in the following two forms:
17473 .code
17474 From ph10 Fri Jan  5 12:35 GMT 1996
17475 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17476 .endd
17477 The pattern can be seen by running
17478 .code
17479 exim -bP uucp_from_pattern
17480 .endd
17481 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17482 year in the second case. The first word after &"From&~"& is matched in the
17483 regular expression by a parenthesized subpattern. The default value for
17484 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17485 (&"ph10"& in the example above) as the message's sender. See also
17486 &%ignore_fromline_hosts%&.
17487
17488
17489 .option uucp_from_sender main string&!! &`$1`&
17490 See &%uucp_from_pattern%& above.
17491
17492
17493 .option warn_message_file main string unset
17494 .cindex "warning of delay" "customizing the message"
17495 .cindex "customizing" "warning message"
17496 This option defines a template file containing paragraphs of text to be used
17497 for constructing the warning message which is sent by Exim when a message has
17498 been on the queue for a specified amount of time, as specified by
17499 &%delay_warning%&. Details of the file's contents are given in chapter
17500 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17501
17502
17503 .option write_rejectlog main boolean true
17504 .cindex "reject log" "disabling"
17505 If this option is set false, Exim no longer writes anything to the reject log.
17506 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17507 .ecindex IIDconfima
17508 .ecindex IIDmaiconf
17509
17510
17511
17512
17513 . ////////////////////////////////////////////////////////////////////////////
17514 . ////////////////////////////////////////////////////////////////////////////
17515
17516 .chapter "Generic options for routers" "CHAProutergeneric"
17517 .scindex IIDgenoprou1 "options" "generic; for routers"
17518 .scindex IIDgenoprou2 "generic options" "router"
17519 This chapter describes the generic options that apply to all routers.
17520 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17521
17522 For a general description of how a router operates, see sections
17523 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17524 which the preconditions are tested. The order of expansion of the options that
17525 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17526 &%headers_remove%&, &%transport%&.
17527
17528
17529
17530 .option address_data routers string&!! unset
17531 .cindex "router" "data attached to address"
17532 The string is expanded just before the router is run, that is, after all the
17533 precondition tests have succeeded. If the expansion is forced to fail, the
17534 router declines, the value of &%address_data%& remains unchanged, and the
17535 &%more%& option controls what happens next. Other expansion failures cause
17536 delivery of the address to be deferred.
17537
17538 .vindex "&$address_data$&"
17539 When the expansion succeeds, the value is retained with the address, and can be
17540 accessed using the variable &$address_data$& in the current router, subsequent
17541 routers, and the eventual transport.
17542
17543 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17544 that runs a user's filter file, the contents of &$address_data$& are accessible
17545 in the filter. This is not normally a problem, because such data is usually
17546 either not confidential or it &"belongs"& to the current user, but if you do
17547 put confidential data into &$address_data$& you need to remember this point.
17548
17549 Even if the router declines or passes, the value of &$address_data$& remains
17550 with the address, though it can be changed by another &%address_data%& setting
17551 on a subsequent router. If a router generates child addresses, the value of
17552 &$address_data$& propagates to them. This also applies to the special kind of
17553 &"child"& that is generated by a router with the &%unseen%& option.
17554
17555 The idea of &%address_data%& is that you can use it to look up a lot of data
17556 for the address once, and then pick out parts of the data later. For example,
17557 you could use a single LDAP lookup to return a string of the form
17558 .code
17559 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17560 .endd
17561 In the transport you could pick out the mailbox by a setting such as
17562 .code
17563 file = ${extract{mailbox}{$address_data}}
17564 .endd
17565 This makes the configuration file less messy, and also reduces the number of
17566 lookups (though Exim does cache lookups).
17567
17568 .vindex "&$sender_address_data$&"
17569 .vindex "&$address_data$&"
17570 The &%address_data%& facility is also useful as a means of passing information
17571 from one router to another, and from a router to a transport. In addition, if
17572 &$address_data$& is set by a router when verifying a recipient address from an
17573 ACL, it remains available for use in the rest of the ACL statement. After
17574 verifying a sender, the value is transferred to &$sender_address_data$&.
17575
17576
17577
17578 .option address_test routers&!? boolean true
17579 .oindex "&%-bt%&"
17580 .cindex "router" "skipping when address testing"
17581 If this option is set false, the router is skipped when routing is being tested
17582 by means of the &%-bt%& command line option. This can be a convenience when
17583 your first router sends messages to an external scanner, because it saves you
17584 having to set the &"already scanned"& indicator when testing real address
17585 routing.
17586
17587
17588
17589 .option cannot_route_message routers string&!! unset
17590 .cindex "router" "customizing &""cannot route""& message"
17591 .cindex "customizing" "&""cannot route""& message"
17592 This option specifies a text message that is used when an address cannot be
17593 routed because Exim has run out of routers. The default message is
17594 &"Unrouteable address"&. This option is useful only on routers that have
17595 &%more%& set false, or on the very last router in a configuration, because the
17596 value that is used is taken from the last router that is considered. This
17597 includes a router that is skipped because its preconditions are not met, as
17598 well as a router that declines. For example, using the default configuration,
17599 you could put:
17600 .code
17601 cannot_route_message = Remote domain not found in DNS
17602 .endd
17603 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17604 and
17605 .code
17606 cannot_route_message = Unknown local user
17607 .endd
17608 on the final router that checks for local users. If string expansion fails for
17609 this option, the default message is used. Unless the expansion failure was
17610 explicitly forced, a message about the failure is written to the main and panic
17611 logs, in addition to the normal message about the routing failure.
17612
17613
17614 .option caseful_local_part routers boolean false
17615 .cindex "case of local parts"
17616 .cindex "router" "case of local parts"
17617 By default, routers handle the local parts of addresses in a case-insensitive
17618 manner, though the actual case is preserved for transmission with the message.
17619 If you want the case of letters to be significant in a router, you must set
17620 this option true. For individual router options that contain address or local
17621 part lists (for example, &%local_parts%&), case-sensitive matching can be
17622 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17623 more details.
17624
17625 .vindex "&$local_part$&"
17626 .vindex "&$original_local_part$&"
17627 .vindex "&$parent_local_part$&"
17628 The value of the &$local_part$& variable is forced to lower case while a
17629 router is running unless &%caseful_local_part%& is set. When a router assigns
17630 an address to a transport, the value of &$local_part$& when the transport runs
17631 is the same as it was in the router. Similarly, when a router generates child
17632 addresses by aliasing or forwarding, the values of &$original_local_part$&
17633 and &$parent_local_part$& are those that were used by the redirecting router.
17634
17635 This option applies to the processing of an address by a router. When a
17636 recipient address is being processed in an ACL, there is a separate &%control%&
17637 modifier that can be used to specify case-sensitive processing within the ACL
17638 (see section &<<SECTcontrols>>&).
17639
17640
17641
17642 .option check_local_user routers&!? boolean false
17643 .cindex "local user, checking in router"
17644 .cindex "router" "checking for local user"
17645 .cindex "&_/etc/passwd_&"
17646 .vindex "&$home$&"
17647 When this option is true, Exim checks that the local part of the recipient
17648 address (with affixes removed if relevant) is the name of an account on the
17649 local system. The check is done by calling the &[getpwnam()]& function rather
17650 than trying to read &_/etc/passwd_& directly. This means that other methods of
17651 holding password data (such as NIS) are supported. If the local part is a local
17652 user, &$home$& is set from the password data, and can be tested in other
17653 preconditions that are evaluated after this one (the order of evaluation is
17654 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17655 overridden by &%router_home_directory%&. If the local part is not a local user,
17656 the router is skipped.
17657
17658 If you want to check that the local part is either the name of a local user
17659 or matches something else, you cannot combine &%check_local_user%& with a
17660 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17661 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17662 setting to achieve this. For example:
17663 .code
17664 local_parts = passwd;$local_part : lsearch;/etc/other/users
17665 .endd
17666 Note, however, that the side effects of &%check_local_user%& (such as setting
17667 up a home directory) do not occur when a &(passwd)& lookup is used in a
17668 &%local_parts%& (or any other) precondition.
17669
17670
17671
17672 .option condition routers&!? string&!! unset
17673 .cindex "router" "customized precondition"
17674 This option specifies a general precondition test that has to succeed for the
17675 router to be called. The &%condition%& option is the last precondition to be
17676 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17677 result is a forced failure, or an empty string, or one of the strings &"0"& or
17678 &"no"& or &"false"& (checked without regard to the case of the letters), the
17679 router is skipped, and the address is offered to the next one.
17680
17681 If the result is any other value, the router is run (as this is the last
17682 precondition to be evaluated, all the other preconditions must be true).
17683
17684 This option is unusual in that multiple &%condition%& options may be present.
17685 All &%condition%& options must succeed.
17686
17687 The &%condition%& option provides a means of applying custom conditions to the
17688 running of routers. Note that in the case of a simple conditional expansion,
17689 the default expansion values are exactly what is wanted. For example:
17690 .code
17691 condition = ${if >{$message_age}{600}}
17692 .endd
17693 Because of the default behaviour of the string expansion, this is equivalent to
17694 .code
17695 condition = ${if >{$message_age}{600}{true}{}}
17696 .endd
17697
17698 A multiple condition example, which succeeds:
17699 .code
17700 condition = ${if >{$message_age}{600}}
17701 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17702 condition = foobar
17703 .endd
17704
17705 If the expansion fails (other than forced failure) delivery is deferred. Some
17706 of the other precondition options are common special cases that could in fact
17707 be specified using &%condition%&.
17708
17709 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17710 are far older, and use one set of semantics.  ACLs are newer and when
17711 they were created, the ACL &%condition%& process was given far stricter
17712 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17713 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17714 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17715 Router rules processing behavior.
17716
17717 This is best illustrated in an example:
17718 .code
17719 # If used in an ACL condition will fail with a syntax error, but
17720 # in a router condition any extra characters are treated as a string
17721
17722 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17723 true {yes} {no}}
17724
17725 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17726  {yes} {no}}
17727 .endd
17728 In each example above, the &%if%& statement actually ends after
17729 &"{google.com}}"&.  Since no true or false braces were defined, the
17730 default &%if%& behavior is to return a boolean true or a null answer
17731 (which evaluates to false). The rest of the line is then treated as a
17732 string. So the first example resulted in the boolean answer &"true"&
17733 with the string &" {yes} {no}}"& appended to it. The second example
17734 resulted in the null output (indicating false) with the string
17735 &" {yes} {no}}"& appended to it.
17736
17737 In fact you can put excess forward braces in too.  In the router
17738 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17739 mean something, like after a &"$"& or when required as part of a
17740 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17741 string characters.
17742
17743 Thus, in a Router, the above expansion strings will both always evaluate
17744 true, as the result of expansion is a non-empty string which doesn't
17745 match an explicit false value.  This can be tricky to debug.  By
17746 contrast, in an ACL either of those strings will always result in an
17747 expansion error because the result doesn't look sufficiently boolean.
17748
17749
17750 .option debug_print routers string&!! unset
17751 .cindex "testing" "variables in drivers"
17752 If this option is set and debugging is enabled (see the &%-d%& command line
17753 option) or in address-testing mode (see the &%-bt%& command line option),
17754 the string is expanded and included in the debugging output.
17755 If expansion of the string fails, the error message is written to the debugging
17756 output, and Exim carries on processing.
17757 This option is provided to help with checking out the values of variables and
17758 so on when debugging router configurations. For example, if a &%condition%&
17759 option appears not to be working, &%debug_print%& can be used to output the
17760 variables it references. The output happens after checks for &%domains%&,
17761 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17762 are tested. A newline is added to the text if it does not end with one.
17763 The variable &$router_name$& contains the name of the router.
17764
17765
17766
17767 .option disable_logging routers boolean false
17768 If this option is set true, nothing is logged for any routing errors
17769 or for any deliveries caused by this router. You should not set this option
17770 unless you really, really know what you are doing. See also the generic
17771 transport option of the same name.
17772
17773 .option dnssec_request_domains routers "domain list&!!" unset
17774 .cindex "MX record" "security"
17775 .cindex "DNSSEC" "MX lookup"
17776 .cindex "security" "MX lookup"
17777 .cindex "DNS" "DNSSEC"
17778 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17779 the dnssec request bit set.
17780 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17781
17782 .option dnssec_require_domains routers "domain list&!!" unset
17783 .cindex "MX record" "security"
17784 .cindex "DNSSEC" "MX lookup"
17785 .cindex "security" "MX lookup"
17786 .cindex "DNS" "DNSSEC"
17787 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17788 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17789 (AD bit) set will be ignored and logged as a host-lookup failure.
17790 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17791
17792
17793 .option domains routers&!? "domain list&!!" unset
17794 .cindex "router" "restricting to specific domains"
17795 .vindex "&$domain_data$&"
17796 If this option is set, the router is skipped unless the current domain matches
17797 the list. If the match is achieved by means of a file lookup, the data that the
17798 lookup returned for the domain is placed in &$domain_data$& for use in string
17799 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17800 a list of the order in which preconditions are evaluated.
17801
17802
17803
17804 .option driver routers string unset
17805 This option must always be set. It specifies which of the available routers is
17806 to be used.
17807
17808
17809 .option dsn_lasthop routers boolean false
17810 .cindex "DSN" "success"
17811 .cindex "Delivery Status Notification" "success"
17812 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17813 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17814 instead send a success DSN as if the next hop does not support DSN.
17815 Not effective on redirect routers.
17816
17817
17818
17819 .option errors_to routers string&!! unset
17820 .cindex "envelope sender"
17821 .cindex "router" "changing address for errors"
17822 If a router successfully handles an address, it may assign the address to a
17823 transport for delivery or it may generate child addresses. In both cases, if
17824 there is a delivery problem during later processing, the resulting bounce
17825 message is sent to the address that results from expanding this string,
17826 provided that the address verifies successfully. The &%errors_to%& option is
17827 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17828
17829 The &%errors_to%& setting associated with an address can be overridden if it
17830 subsequently passes through other routers that have their own &%errors_to%&
17831 settings, or if the message is delivered by a transport with a &%return_path%&
17832 setting.
17833
17834 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17835 the expansion fails to verify, the errors address associated with the incoming
17836 address is used. At top level, this is the envelope sender. A non-forced
17837 expansion failure causes delivery to be deferred.
17838
17839 If an address for which &%errors_to%& has been set ends up being delivered over
17840 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17841 any bounces that are generated by other MTAs on the delivery route are also
17842 sent there. You can set &%errors_to%& to the empty string by either of these
17843 settings:
17844 .code
17845 errors_to =
17846 errors_to = ""
17847 .endd
17848 An expansion item that yields an empty string has the same effect. If you do
17849 this, a locally detected delivery error for addresses processed by this router
17850 no longer gives rise to a bounce message; the error is discarded. If the
17851 address is delivered to a remote host, the return path is set to &`<>`&, unless
17852 overridden by the &%return_path%& option on the transport.
17853
17854 .vindex "&$address_data$&"
17855 If for some reason you want to discard local errors, but use a non-empty
17856 MAIL command for remote delivery, you can preserve the original return
17857 path in &$address_data$& in the router, and reinstate it in the transport by
17858 setting &%return_path%&.
17859
17860 The most common use of &%errors_to%& is to direct mailing list bounces to the
17861 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17862 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17863
17864
17865
17866 .option expn routers&!? boolean true
17867 .cindex "address" "testing"
17868 .cindex "testing" "addresses"
17869 .cindex "EXPN" "router skipping"
17870 .cindex "router" "skipping for EXPN"
17871 If this option is turned off, the router is skipped when testing an address
17872 as a result of processing an SMTP EXPN command. You might, for example,
17873 want to turn it off on a router for users' &_.forward_& files, while leaving it
17874 on for the system alias file.
17875 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17876 are evaluated.
17877
17878 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17879 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17880 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17881
17882
17883
17884 .option fail_verify routers boolean false
17885 .cindex "router" "forcing verification failure"
17886 Setting this option has the effect of setting both &%fail_verify_sender%& and
17887 &%fail_verify_recipient%& to the same value.
17888
17889
17890
17891 .option fail_verify_recipient routers boolean false
17892 If this option is true and an address is accepted by this router when
17893 verifying a recipient, verification fails.
17894
17895
17896
17897 .option fail_verify_sender routers boolean false
17898 If this option is true and an address is accepted by this router when
17899 verifying a sender, verification fails.
17900
17901
17902
17903 .option fallback_hosts routers "string list" unset
17904 .cindex "router" "fallback hosts"
17905 .cindex "fallback" "hosts specified on router"
17906 String expansion is not applied to this option. The argument must be a
17907 colon-separated list of host names or IP addresses. The list separator can be
17908 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17909 each name or address. In fact, the format of each item is exactly the same as
17910 defined for the list of hosts in a &(manualroute)& router (see section
17911 &<<SECTformatonehostitem>>&).
17912
17913 If a router queues an address for a remote transport, this host list is
17914 associated with the address, and used instead of the transport's fallback host
17915 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17916 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17917 transport for further details.
17918
17919
17920 .option group routers string&!! "see below"
17921 .cindex "gid (group id)" "local delivery"
17922 .cindex "local transports" "uid and gid"
17923 .cindex "transport" "local"
17924 .cindex "router" "setting group"
17925 When a router queues an address for a transport, and the transport does not
17926 specify a group, the group given here is used when running the delivery
17927 process.
17928 The group may be specified numerically or by name. If expansion fails, the
17929 error is logged and delivery is deferred.
17930 The default is unset, unless &%check_local_user%& is set, when the default
17931 is taken from the password information. See also &%initgroups%& and &%user%&
17932 and the discussion in chapter &<<CHAPenvironment>>&.
17933
17934
17935
17936 .option headers_add routers list&!! unset
17937 .cindex "header lines" "adding"
17938 .cindex "router" "adding header lines"
17939 This option specifies a list of text headers,
17940 newline-separated (by default, changeable in the usual way),
17941 that is associated with any addresses that are accepted by the router.
17942 Each item is separately expanded, at routing time.  However, this
17943 option has no effect when an address is just being verified. The way in which
17944 the text is used to add header lines at transport time is described in section
17945 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17946 message is in the process of being transported. This means that references to
17947 header lines in string expansions in the transport's configuration do not
17948 &"see"& the added header lines.
17949
17950 The &%headers_add%& option is expanded after &%errors_to%&, but before
17951 &%headers_remove%& and &%transport%&. If an item is empty, or if
17952 an item expansion is forced to fail, the item has no effect. Other expansion
17953 failures are treated as configuration errors.
17954
17955 Unlike most options, &%headers_add%& can be specified multiple times
17956 for a router; all listed headers are added.
17957
17958 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17959 router that has the &%one_time%& option set.
17960
17961 .cindex "duplicate addresses"
17962 .oindex "&%unseen%&"
17963 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17964 additions are deleted when the address is passed on to subsequent routers.
17965 For a &%redirect%& router, if a generated address is the same as the incoming
17966 address, this can lead to duplicate addresses with different header
17967 modifications. Exim does not do duplicate deliveries (except, in certain
17968 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17969 which of the duplicates is discarded, so this ambiguous situation should be
17970 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17971
17972
17973
17974 .option headers_remove routers list&!! unset
17975 .cindex "header lines" "removing"
17976 .cindex "router" "removing header lines"
17977 This option specifies a list of text headers,
17978 colon-separated (by default, changeable in the usual way),
17979 that is associated with any addresses that are accepted by the router.
17980 Each item is separately expanded, at routing time.  However, this
17981 option has no effect when an address is just being verified. The way in which
17982 the text is used to remove header lines at transport time is described in
17983 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17984 the message is in the process of being transported. This means that references
17985 to header lines in string expansions in the transport's configuration still
17986 &"see"& the original header lines.
17987
17988 The &%headers_remove%& option is expanded after &%errors_to%& and
17989 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17990 the item has no effect. Other expansion failures are treated as configuration
17991 errors.
17992
17993 Unlike most options, &%headers_remove%& can be specified multiple times
17994 for a router; all listed headers are removed.
17995
17996 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17997 router that has the &%one_time%& option set.
17998
17999 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18000 removal requests are deleted when the address is passed on to subsequent
18001 routers, and this can lead to problems with duplicates -- see the similar
18002 warning for &%headers_add%& above.
18003
18004 &*Warning 3*&: Because of the separate expansion of the list items,
18005 items that contain a list separator must have it doubled.
18006 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18007
18008
18009
18010 .option ignore_target_hosts routers "host list&!!" unset
18011 .cindex "IP address" "discarding"
18012 .cindex "router" "discarding IP addresses"
18013 Although this option is a host list, it should normally contain IP address
18014 entries rather than names. If any host that is looked up by the router has an
18015 IP address that matches an item in this list, Exim behaves as if that IP
18016 address did not exist. This option allows you to cope with rogue DNS entries
18017 like
18018 .code
18019 remote.domain.example.  A  127.0.0.1
18020 .endd
18021 by setting
18022 .code
18023 ignore_target_hosts = 127.0.0.1
18024 .endd
18025 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18026 discarded in this way, the router declines. In a conventional configuration, an
18027 attempt to mail to such a domain would normally provoke the &"unrouteable
18028 domain"& error, and an attempt to verify an address in the domain would fail.
18029 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18030 router declines if presented with one of the listed addresses.
18031
18032 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18033 means of the first or the second of the following settings, respectively:
18034 .code
18035 ignore_target_hosts = 0.0.0.0/0
18036 ignore_target_hosts = <; 0::0/0
18037 .endd
18038 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18039 in the second line matches all IPv6 addresses.
18040
18041 This option may also be useful for ignoring link-local and site-local IPv6
18042 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18043 is expanded before use as a list, it is possible to make it dependent on the
18044 domain that is being routed.
18045
18046 .vindex "&$host_address$&"
18047 During its expansion, &$host_address$& is set to the IP address that is being
18048 checked.
18049
18050 .option initgroups routers boolean false
18051 .cindex "additional groups"
18052 .cindex "groups" "additional"
18053 .cindex "local transports" "uid and gid"
18054 .cindex "transport" "local"
18055 If the router queues an address for a transport, and this option is true, and
18056 the uid supplied by the router is not overridden by the transport, the
18057 &[initgroups()]& function is called when running the transport to ensure that
18058 any additional groups associated with the uid are set up. See also &%group%&
18059 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18060
18061
18062
18063 .option local_part_prefix routers&!? "string list" unset
18064 .cindex "router" "prefix for local part"
18065 .cindex "prefix" "for local part, used in router"
18066 If this option is set, the router is skipped unless the local part starts with
18067 one of the given strings, or &%local_part_prefix_optional%& is true. See
18068 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18069 evaluated.
18070
18071 The list is scanned from left to right, and the first prefix that matches is
18072 used. A limited form of wildcard is available; if the prefix begins with an
18073 asterisk, it matches the longest possible sequence of arbitrary characters at
18074 the start of the local part. An asterisk should therefore always be followed by
18075 some character that does not occur in normal local parts.
18076 .cindex "multiple mailboxes"
18077 .cindex "mailbox" "multiple"
18078 Wildcarding can be used to set up multiple user mailboxes, as described in
18079 section &<<SECTmulbox>>&.
18080
18081 .vindex "&$local_part$&"
18082 .vindex "&$local_part_prefix$&"
18083 During the testing of the &%local_parts%& option, and while the router is
18084 running, the prefix is removed from the local part, and is available in the
18085 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18086 the router accepts the address, this remains true during subsequent delivery by
18087 a transport. In particular, the local part that is transmitted in the RCPT
18088 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18089 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18090 the relevant transport.
18091
18092 When an address is being verified, &%local_part_prefix%& affects only the
18093 behaviour of the router. If the callout feature of verification is in use, this
18094 means that the full address, including the prefix, will be used during the
18095 callout.
18096
18097 The prefix facility is commonly used to handle local parts of the form
18098 &%owner-something%&. Another common use is to support local parts of the form
18099 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18100 to tell a user their forwarding is broken &-- by placing a router like this one
18101 immediately before the router that handles &_.forward_& files:
18102 .code
18103 real_localuser:
18104   driver = accept
18105   local_part_prefix = real-
18106   check_local_user
18107   transport = local_delivery
18108 .endd
18109 For security, it would probably be a good idea to restrict the use of this
18110 router to locally-generated messages, using a condition such as this:
18111 .code
18112   condition = ${if match {$sender_host_address}\
18113                          {\N^(|127\.0\.0\.1)$\N}}
18114 .endd
18115
18116 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18117 both conditions must be met if not optional. Care must be taken if wildcards
18118 are used in both a prefix and a suffix on the same router. Different
18119 separator characters must be used to avoid ambiguity.
18120
18121
18122 .option local_part_prefix_optional routers boolean false
18123 See &%local_part_prefix%& above.
18124
18125
18126
18127 .option local_part_suffix routers&!? "string list" unset
18128 .cindex "router" "suffix for local part"
18129 .cindex "suffix for local part" "used in router"
18130 This option operates in the same way as &%local_part_prefix%&, except that the
18131 local part must end (rather than start) with the given string, the
18132 &%local_part_suffix_optional%& option determines whether the suffix is
18133 mandatory, and the wildcard * character, if present, must be the last
18134 character of the suffix. This option facility is commonly used to handle local
18135 parts of the form &%something-request%& and multiple user mailboxes of the form
18136 &%username-foo%&.
18137
18138
18139 .option local_part_suffix_optional routers boolean false
18140 See &%local_part_suffix%& above.
18141
18142
18143
18144 .option local_parts routers&!? "local part list&!!" unset
18145 .cindex "router" "restricting to specific local parts"
18146 .cindex "local part" "checking in router"
18147 The router is run only if the local part of the address matches the list.
18148 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18149 are evaluated, and
18150 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18151 string is expanded, it is possible to make it depend on the domain, for
18152 example:
18153 .code
18154 local_parts = dbm;/usr/local/specials/$domain
18155 .endd
18156 .vindex "&$local_part_data$&"
18157 If the match is achieved by a lookup, the data that the lookup returned
18158 for the local part is placed in the variable &$local_part_data$& for use in
18159 expansions of the router's private options. You might use this option, for
18160 example, if you have a large number of local virtual domains, and you want to
18161 send all postmaster mail to the same place without having to set up an alias in
18162 each virtual domain:
18163 .code
18164 postmaster:
18165   driver = redirect
18166   local_parts = postmaster
18167   data = postmaster@real.domain.example
18168 .endd
18169
18170
18171 .option log_as_local routers boolean "see below"
18172 .cindex "log" "delivery line"
18173 .cindex "delivery" "log line format"
18174 Exim has two logging styles for delivery, the idea being to make local
18175 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18176 recipient address is given just as the local part, without a domain. The use of
18177 this style is controlled by this option. It defaults to true for the &(accept)&
18178 router, and false for all the others. This option applies only when a
18179 router assigns an address to a transport. It has no effect on routers that
18180 redirect addresses.
18181
18182
18183
18184 .option more routers boolean&!! true
18185 The result of string expansion for this option must be a valid boolean value,
18186 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18187 result causes an error, and delivery is deferred. If the expansion is forced to
18188 fail, the default value for the option (true) is used. Other failures cause
18189 delivery to be deferred.
18190
18191 If this option is set false, and the router declines to handle the address, no
18192 further routers are tried, routing fails, and the address is bounced.
18193 .oindex "&%self%&"
18194 However, if the router explicitly passes an address to the following router by
18195 means of the setting
18196 .code
18197 self = pass
18198 .endd
18199 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18200 does not affect the behaviour if one of the precondition tests fails. In that
18201 case, the address is always passed to the next router.
18202
18203 Note that &%address_data%& is not considered to be a precondition. If its
18204 expansion is forced to fail, the router declines, and the value of &%more%&
18205 controls what happens next.
18206
18207
18208 .option pass_on_timeout routers boolean false
18209 .cindex "timeout" "of router"
18210 .cindex "router" "timeout"
18211 If a router times out during a host lookup, it normally causes deferral of the
18212 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18213 router, overriding &%no_more%&. This may be helpful for systems that are
18214 intermittently connected to the Internet, or those that want to pass to a smart
18215 host any messages that cannot immediately be delivered.
18216
18217 There are occasional other temporary errors that can occur while doing DNS
18218 lookups. They are treated in the same way as a timeout, and this option
18219 applies to all of them.
18220
18221
18222
18223 .option pass_router routers string unset
18224 .cindex "router" "go to after &""pass""&"
18225 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18226 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18227 routing to continue, and overriding a false setting of &%more%&. When one of
18228 these routers returns &"pass"&, the address is normally handed on to the next
18229 router in sequence. This can be changed by setting &%pass_router%& to the name
18230 of another router. However (unlike &%redirect_router%&) the named router must
18231 be below the current router, to avoid loops. Note that this option applies only
18232 to the special case of &"pass"&. It does not apply when a router returns
18233 &"decline"& because it cannot handle an address.
18234
18235
18236
18237 .option redirect_router routers string unset
18238 .cindex "router" "start at after redirection"
18239 Sometimes an administrator knows that it is pointless to reprocess addresses
18240 generated from alias or forward files with the same router again. For
18241 example, if an alias file translates real names into login ids there is no
18242 point searching the alias file a second time, especially if it is a large file.
18243
18244 The &%redirect_router%& option can be set to the name of any router instance.
18245 It causes the routing of any generated addresses to start at the named router
18246 instead of at the first router. This option has no effect if the router in
18247 which it is set does not generate new addresses.
18248
18249
18250
18251 .option require_files routers&!? "string list&!!" unset
18252 .cindex "file" "requiring for router"
18253 .cindex "router" "requiring file existence"
18254 This option provides a general mechanism for predicating the running of a
18255 router on the existence or non-existence of certain files or directories.
18256 Before running a router, as one of its precondition tests, Exim works its way
18257 through the &%require_files%& list, expanding each item separately.
18258
18259 Because the list is split before expansion, any colons in expansion items must
18260 be doubled, or the facility for using a different list separator must be used.
18261 If any expansion is forced to fail, the item is ignored. Other expansion
18262 failures cause routing of the address to be deferred.
18263
18264 If any expanded string is empty, it is ignored. Otherwise, except as described
18265 below, each string must be a fully qualified file path, optionally preceded by
18266 &"!"&. The paths are passed to the &[stat()]& function to test for the
18267 existence of the files or directories. The router is skipped if any paths not
18268 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18269
18270 .cindex "NFS"
18271 If &[stat()]& cannot determine whether a file exists or not, delivery of
18272 the message is deferred. This can happen when NFS-mounted filesystems are
18273 unavailable.
18274
18275 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18276 options, so you cannot use it to check for the existence of a file in which to
18277 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18278 full list of the order in which preconditions are evaluated.) However, as
18279 these options are all expanded, you can use the &%exists%& expansion condition
18280 to make such tests. The &%require_files%& option is intended for checking files
18281 that the router may be going to use internally, or which are needed by a
18282 transport (for example &_.procmailrc_&).
18283
18284 During delivery, the &[stat()]& function is run as root, but there is a
18285 facility for some checking of the accessibility of a file by another user.
18286 This is not a proper permissions check, but just a &"rough"& check that
18287 operates as follows:
18288
18289 If an item in a &%require_files%& list does not contain any forward slash
18290 characters, it is taken to be the user (and optional group, separated by a
18291 comma) to be checked for subsequent files in the list. If no group is specified
18292 but the user is specified symbolically, the gid associated with the uid is
18293 used. For example:
18294 .code
18295 require_files = mail:/some/file
18296 require_files = $local_part:$home/.procmailrc
18297 .endd
18298 If a user or group name in a &%require_files%& list does not exist, the
18299 &%require_files%& condition fails.
18300
18301 Exim performs the check by scanning along the components of the file path, and
18302 checking the access for the given uid and gid. It checks for &"x"& access on
18303 directories, and &"r"& access on the final file. Note that this means that file
18304 access control lists, if the operating system has them, are ignored.
18305
18306 &*Warning 1*&: When the router is being run to verify addresses for an
18307 incoming SMTP message, Exim is not running as root, but under its own uid. This
18308 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18309 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18310 user is not permitted to read one of the directories on the file's path.
18311
18312 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18313 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18314 without root access. In this case, if a check for access by a particular user
18315 is requested, Exim creates a subprocess that runs as that user, and tries the
18316 check again in that process.
18317
18318 The default action for handling an unresolved EACCES is to consider it to
18319 be caused by a configuration error, and routing is deferred because the
18320 existence or non-existence of the file cannot be determined. However, in some
18321 circumstances it may be desirable to treat this condition as if the file did
18322 not exist. If the file name (or the exclamation mark that precedes the file
18323 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18324 as if the file did not exist. For example:
18325 .code
18326 require_files = +/some/file
18327 .endd
18328 If the router is not an essential part of verification (for example, it
18329 handles users' &_.forward_& files), another solution is to set the &%verify%&
18330 option false so that the router is skipped when verifying.
18331
18332
18333
18334 .option retry_use_local_part routers boolean "see below"
18335 .cindex "hints database" "retry keys"
18336 .cindex "local part" "in retry keys"
18337 When a delivery suffers a temporary routing failure, a retry record is created
18338 in Exim's hints database. For addresses whose routing depends only on the
18339 domain, the key for the retry record should not involve the local part, but for
18340 other addresses, both the domain and the local part should be included.
18341 Usually, remote routing is of the former kind, and local routing is of the
18342 latter kind.
18343
18344 This option controls whether the local part is used to form the key for retry
18345 hints for addresses that suffer temporary errors while being handled by this
18346 router. The default value is true for any router that has &%check_local_user%&
18347 set, and false otherwise. Note that this option does not apply to hints keys
18348 for transport delays; they are controlled by a generic transport option of the
18349 same name.
18350
18351 The setting of &%retry_use_local_part%& applies only to the router on which it
18352 appears. If the router generates child addresses, they are routed
18353 independently; this setting does not become attached to them.
18354
18355
18356
18357 .option router_home_directory routers string&!! unset
18358 .cindex "router" "home directory for"
18359 .cindex "home directory" "for router"
18360 .vindex "&$home$&"
18361 This option sets a home directory for use while the router is running. (Compare
18362 &%transport_home_directory%&, which sets a home directory for later
18363 transporting.) In particular, if used on a &(redirect)& router, this option
18364 sets a value for &$home$& while a filter is running. The value is expanded;
18365 forced expansion failure causes the option to be ignored &-- other failures
18366 cause the router to defer.
18367
18368 Expansion of &%router_home_directory%& happens immediately after the
18369 &%check_local_user%& test (if configured), before any further expansions take
18370 place.
18371 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18372 are evaluated.)
18373 While the router is running, &%router_home_directory%& overrides the value of
18374 &$home$& that came from &%check_local_user%&.
18375
18376 When a router accepts an address and assigns it to a local transport (including
18377 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18378 delivery), the home directory setting for the transport is taken from the first
18379 of these values that is set:
18380
18381 .ilist
18382 The &%home_directory%& option on the transport;
18383 .next
18384 The &%transport_home_directory%& option on the router;
18385 .next
18386 The password data if &%check_local_user%& is set on the router;
18387 .next
18388 The &%router_home_directory%& option on the router.
18389 .endlist
18390
18391 In other words, &%router_home_directory%& overrides the password data for the
18392 router, but not for the transport.
18393
18394
18395
18396 .option self routers string freeze
18397 .cindex "MX record" "pointing to local host"
18398 .cindex "local host" "MX pointing to"
18399 This option applies to those routers that use a recipient address to find a
18400 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18401 and &(manualroute)& routers.
18402 Certain configurations of the &(queryprogram)& router can also specify a list
18403 of remote hosts.
18404 Usually such routers are configured to send the message to a remote host via an
18405 &(smtp)& transport. The &%self%& option specifies what happens when the first
18406 host on the list turns out to be the local host.
18407 The way in which Exim checks for the local host is described in section
18408 &<<SECTreclocipadd>>&.
18409
18410 Normally this situation indicates either an error in Exim's configuration (for
18411 example, the router should be configured not to process this domain), or an
18412 error in the DNS (for example, the MX should not point to this host). For this
18413 reason, the default action is to log the incident, defer the address, and
18414 freeze the message. The following alternatives are provided for use in special
18415 cases:
18416
18417 .vlist
18418 .vitem &%defer%&
18419 Delivery of the message is tried again later, but the message is not frozen.
18420
18421 .vitem "&%reroute%&: <&'domain'&>"
18422 The domain is changed to the given domain, and the address is passed back to
18423 be reprocessed by the routers. No rewriting of headers takes place. This
18424 behaviour is essentially a redirection.
18425
18426 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18427 The domain is changed to the given domain, and the address is passed back to be
18428 reprocessed by the routers. Any headers that contain the original domain are
18429 rewritten.
18430
18431 .vitem &%pass%&
18432 .oindex "&%more%&"
18433 .vindex "&$self_hostname$&"
18434 The router passes the address to the next router, or to the router named in the
18435 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18436 subsequent routing and delivery, the variable &$self_hostname$& contains the
18437 name of the local host that the router encountered. This can be used to
18438 distinguish between different cases for hosts with multiple names. The
18439 combination
18440 .code
18441 self = pass
18442 no_more
18443 .endd
18444 ensures that only those addresses that routed to the local host are passed on.
18445 Without &%no_more%&, addresses that were declined for other reasons would also
18446 be passed to the next router.
18447
18448 .vitem &%fail%&
18449 Delivery fails and an error report is generated.
18450
18451 .vitem &%send%&
18452 .cindex "local host" "sending to"
18453 The anomaly is ignored and the address is queued for the transport. This
18454 setting should be used with extreme caution. For an &(smtp)& transport, it
18455 makes sense only in cases where the program that is listening on the SMTP port
18456 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18457 different configuration file that handles the domain in another way.
18458 .endlist
18459
18460
18461
18462 .option senders routers&!? "address list&!!" unset
18463 .cindex "router" "checking senders"
18464 If this option is set, the router is skipped unless the message's sender
18465 address matches something on the list.
18466 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18467 are evaluated.
18468
18469 There are issues concerning verification when the running of routers is
18470 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18471 setting, it sets the sender to the null string. When using the &%-bt%& option
18472 to check a configuration file, it is necessary also to use the &%-f%& option to
18473 set an appropriate sender. For incoming mail, the sender is unset when
18474 verifying the sender, but is available when verifying any recipients. If the
18475 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18476 matters.
18477
18478
18479 .option translate_ip_address routers string&!! unset
18480 .cindex "IP address" "translating"
18481 .cindex "packet radio"
18482 .cindex "router" "IP address translation"
18483 There exist some rare networking situations (for example, packet radio) where
18484 it is helpful to be able to translate IP addresses generated by normal routing
18485 mechanisms into other IP addresses, thus performing a kind of manual IP
18486 routing. This should be done only if the normal IP routing of the TCP/IP stack
18487 is inadequate or broken. Because this is an extremely uncommon requirement, the
18488 code to support this option is not included in the Exim binary unless
18489 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18490
18491 .vindex "&$host_address$&"
18492 The &%translate_ip_address%& string is expanded for every IP address generated
18493 by the router, with the generated address set in &$host_address$&. If the
18494 expansion is forced to fail, no action is taken.
18495 For any other expansion error, delivery of the message is deferred.
18496 If the result of the expansion is an IP address, that replaces the original
18497 address; otherwise the result is assumed to be a host name &-- this is looked
18498 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18499 produce one or more replacement IP addresses. For example, to subvert all IP
18500 addresses in some specific networks, this could be added to a router:
18501 .code
18502 translate_ip_address = \
18503   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18504     {$value}fail}}
18505 .endd
18506 The file would contain lines like
18507 .code
18508 10.2.3.128/26    some.host
18509 10.8.4.34/26     10.44.8.15
18510 .endd
18511 You should not make use of this facility unless you really understand what you
18512 are doing.
18513
18514
18515
18516 .option transport routers string&!! unset
18517 This option specifies the transport to be used when a router accepts an address
18518 and sets it up for delivery. A transport is never needed if a router is used
18519 only for verification. The value of the option is expanded at routing time,
18520 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18521 and result must be the name of one of the configured transports. If it is not,
18522 delivery is deferred.
18523
18524 The &%transport%& option is not used by the &(redirect)& router, but it does
18525 have some private options that set up transports for pipe and file deliveries
18526 (see chapter &<<CHAPredirect>>&).
18527
18528
18529
18530 .option transport_current_directory routers string&!! unset
18531 .cindex "current directory for local transport"
18532 This option associates a current directory with any address that is routed
18533 to a local transport. This can happen either because a transport is
18534 explicitly configured for the router, or because it generates a delivery to a
18535 file or a pipe. During the delivery process (that is, at transport time), this
18536 option string is expanded and is set as the current directory, unless
18537 overridden by a setting on the transport.
18538 If the expansion fails for any reason, including forced failure, an error is
18539 logged, and delivery is deferred.
18540 See chapter &<<CHAPenvironment>>& for details of the local delivery
18541 environment.
18542
18543
18544
18545
18546 .option transport_home_directory routers string&!! "see below"
18547 .cindex "home directory" "for local transport"
18548 This option associates a home directory with any address that is routed to a
18549 local transport. This can happen either because a transport is explicitly
18550 configured for the router, or because it generates a delivery to a file or a
18551 pipe. During the delivery process (that is, at transport time), the option
18552 string is expanded and is set as the home directory, unless overridden by a
18553 setting of &%home_directory%& on the transport.
18554 If the expansion fails for any reason, including forced failure, an error is
18555 logged, and delivery is deferred.
18556
18557 If the transport does not specify a home directory, and
18558 &%transport_home_directory%& is not set for the router, the home directory for
18559 the transport is taken from the password data if &%check_local_user%& is set for
18560 the router. Otherwise it is taken from &%router_home_directory%& if that option
18561 is set; if not, no home directory is set for the transport.
18562
18563 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18564 environment.
18565
18566
18567
18568
18569 .option unseen routers boolean&!! false
18570 .cindex "router" "carrying on after success"
18571 The result of string expansion for this option must be a valid boolean value,
18572 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18573 result causes an error, and delivery is deferred. If the expansion is forced to
18574 fail, the default value for the option (false) is used. Other failures cause
18575 delivery to be deferred.
18576
18577 When this option is set true, routing does not cease if the router accepts the
18578 address. Instead, a copy of the incoming address is passed to the next router,
18579 overriding a false setting of &%more%&. There is little point in setting
18580 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18581 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18582 sometimes true and sometimes false).
18583
18584 .cindex "copy of message (&%unseen%& option)"
18585 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18586 qualifier in filter files. It can be used to cause copies of messages to be
18587 delivered to some other destination, while also carrying out a normal delivery.
18588 In effect, the current address is made into a &"parent"& that has two children
18589 &-- one that is delivered as specified by this router, and a clone that goes on
18590 to be routed further. For this reason, &%unseen%& may not be combined with the
18591 &%one_time%& option in a &(redirect)& router.
18592
18593 &*Warning*&: Header lines added to the address (or specified for removal) by
18594 this router or by previous routers affect the &"unseen"& copy of the message
18595 only. The clone that continues to be processed by further routers starts with
18596 no added headers and none specified for removal. For a &%redirect%& router, if
18597 a generated address is the same as the incoming address, this can lead to
18598 duplicate addresses with different header modifications. Exim does not do
18599 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18600 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18601 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18602 &%redirect%& router may be of help.
18603
18604 Unlike the handling of header modifications, any data that was set by the
18605 &%address_data%& option in the current or previous routers &'is'& passed on to
18606 subsequent routers.
18607
18608
18609 .option user routers string&!! "see below"
18610 .cindex "uid (user id)" "local delivery"
18611 .cindex "local transports" "uid and gid"
18612 .cindex "transport" "local"
18613 .cindex "router" "user for filter processing"
18614 .cindex "filter" "user for processing"
18615 When a router queues an address for a transport, and the transport does not
18616 specify a user, the user given here is used when running the delivery process.
18617 The user may be specified numerically or by name. If expansion fails, the
18618 error is logged and delivery is deferred.
18619 This user is also used by the &(redirect)& router when running a filter file.
18620 The default is unset, except when &%check_local_user%& is set. In this case,
18621 the default is taken from the password information. If the user is specified as
18622 a name, and &%group%& is not set, the group associated with the user is used.
18623 See also &%initgroups%& and &%group%& and the discussion in chapter
18624 &<<CHAPenvironment>>&.
18625
18626
18627
18628 .option verify routers&!? boolean true
18629 Setting this option has the effect of setting &%verify_sender%& and
18630 &%verify_recipient%& to the same value.
18631
18632
18633 .option verify_only routers&!? boolean false
18634 .cindex "EXPN" "with &%verify_only%&"
18635 .oindex "&%-bv%&"
18636 .cindex "router" "used only when verifying"
18637 If this option is set, the router is used only when verifying an address,
18638 delivering in cutthrough mode or
18639 testing with the &%-bv%& option, not when actually doing a delivery, testing
18640 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18641 restricted to verifying only senders or recipients by means of
18642 &%verify_sender%& and &%verify_recipient%&.
18643
18644 &*Warning*&: When the router is being run to verify addresses for an incoming
18645 SMTP message, Exim is not running as root, but under its own uid. If the router
18646 accesses any files, you need to make sure that they are accessible to the Exim
18647 user or group.
18648
18649
18650 .option verify_recipient routers&!? boolean true
18651 If this option is false, the router is skipped when verifying recipient
18652 addresses,
18653 delivering in cutthrough mode
18654 or testing recipient verification using &%-bv%&.
18655 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18656 are evaluated.
18657 See also the &$verify_mode$& variable.
18658
18659
18660 .option verify_sender routers&!? boolean true
18661 If this option is false, the router is skipped when verifying sender addresses
18662 or testing sender verification using &%-bvs%&.
18663 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18664 are evaluated.
18665 See also the &$verify_mode$& variable.
18666 .ecindex IIDgenoprou1
18667 .ecindex IIDgenoprou2
18668
18669
18670
18671
18672
18673
18674 . ////////////////////////////////////////////////////////////////////////////
18675 . ////////////////////////////////////////////////////////////////////////////
18676
18677 .chapter "The accept router" "CHID4"
18678 .cindex "&(accept)& router"
18679 .cindex "routers" "&(accept)&"
18680 The &(accept)& router has no private options of its own. Unless it is being
18681 used purely for verification (see &%verify_only%&) a transport is required to
18682 be defined by the generic &%transport%& option. If the preconditions that are
18683 specified by generic options are met, the router accepts the address and queues
18684 it for the given transport. The most common use of this router is for setting
18685 up deliveries to local mailboxes. For example:
18686 .code
18687 localusers:
18688   driver = accept
18689   domains = mydomain.example
18690   check_local_user
18691   transport = local_delivery
18692 .endd
18693 The &%domains%& condition in this example checks the domain of the address, and
18694 &%check_local_user%& checks that the local part is the login of a local user.
18695 When both preconditions are met, the &(accept)& router runs, and queues the
18696 address for the &(local_delivery)& transport.
18697
18698
18699
18700
18701
18702
18703 . ////////////////////////////////////////////////////////////////////////////
18704 . ////////////////////////////////////////////////////////////////////////////
18705
18706 .chapter "The dnslookup router" "CHAPdnslookup"
18707 .scindex IIDdnsrou1 "&(dnslookup)& router"
18708 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18709 The &(dnslookup)& router looks up the hosts that handle mail for the
18710 recipient's domain in the DNS. A transport must always be set for this router,
18711 unless &%verify_only%& is set.
18712
18713 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18714 SRV records. If none are found, or if SRV support is not configured,
18715 MX records are looked up. If no MX records exist, address records are sought.
18716 However, &%mx_domains%& can be set to disable the direct use of address
18717 records.
18718
18719 MX records of equal priority are sorted by Exim into a random order. Exim then
18720 looks for address records for the host names obtained from MX or SRV records.
18721 When a host has more than one IP address, they are sorted into a random order,
18722 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18723 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18724 generic option, the router declines.
18725
18726 Unless they have the highest priority (lowest MX value), MX records that point
18727 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18728 are discarded, together with any other MX records of equal or lower priority.
18729
18730 .cindex "MX record" "pointing to local host"
18731 .cindex "local host" "MX pointing to"
18732 .oindex "&%self%&" "in &(dnslookup)& router"
18733 If the host pointed to by the highest priority MX record, or looked up as an
18734 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18735 happens is controlled by the generic &%self%& option.
18736
18737
18738 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18739 There have been problems with DNS servers when SRV records are looked up.
18740 Some misbehaving servers return a DNS error or timeout when a non-existent
18741 SRV record is sought. Similar problems have in the past been reported for
18742 MX records. The global &%dns_again_means_nonexist%& option can help with this
18743 problem, but it is heavy-handed because it is a global option.
18744
18745 For this reason, there are two options, &%srv_fail_domains%& and
18746 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18747 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18748 an attempt to look up an SRV or MX record causes one of these results, and the
18749 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18750 such record"&. In the case of an SRV lookup, this means that the router
18751 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18752 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18753 case routing fails.
18754
18755
18756 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18757 .cindex "&(dnslookup)& router" "declines"
18758 There are a few cases where a &(dnslookup)& router will decline to accept
18759 an address; if such a router is expected to handle "all remaining non-local
18760 domains", then it is important to set &%no_more%&.
18761
18762 The router will defer rather than decline if the domain
18763 is found in the &%fail_defer_domains%& router option.
18764
18765 Reasons for a &(dnslookup)& router to decline currently include:
18766 .ilist
18767 The domain does not exist in DNS
18768 .next
18769 The domain exists but the MX record's host part is just "."; this is a common
18770 convention (borrowed from SRV) used to indicate that there is no such service
18771 for this domain and to not fall back to trying A/AAAA records.
18772 .next
18773 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18774 .next
18775 MX record points to a non-existent host.
18776 .next
18777 MX record points to an IP address and the main section option
18778 &%allow_mx_to_ip%& is not set.
18779 .next
18780 MX records exist and point to valid hosts, but all hosts resolve only to
18781 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18782 .next
18783 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18784 &%dns_check_names_pattern%& for handling one variant of this)
18785 .next
18786 &%check_secondary_mx%& is set on this router but the local host can
18787 not be found in the MX records (see below)
18788 .endlist
18789
18790
18791
18792
18793 .section "Private options for dnslookup" "SECID118"
18794 .cindex "options" "&(dnslookup)& router"
18795 The private options for the &(dnslookup)& router are as follows:
18796
18797 .option check_secondary_mx dnslookup boolean false
18798 .cindex "MX record" "checking for secondary"
18799 If this option is set, the router declines unless the local host is found in
18800 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18801 process domains for which the local host is a secondary mail exchanger
18802 differently to other domains. The way in which Exim decides whether a host is
18803 the local host is described in section &<<SECTreclocipadd>>&.
18804
18805
18806 .option check_srv dnslookup string&!! unset
18807 .cindex "SRV record" "enabling use of"
18808 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18809 addition to MX and address records. The support is disabled by default. To
18810 enable SRV support, set the &%check_srv%& option to the name of the service
18811 required. For example,
18812 .code
18813 check_srv = smtp
18814 .endd
18815 looks for SRV records that refer to the normal smtp service. The option is
18816 expanded, so the service name can vary from message to message or address
18817 to address. This might be helpful if SRV records are being used for a
18818 submission service. If the expansion is forced to fail, the &%check_srv%&
18819 option is ignored, and the router proceeds to look for MX records in the
18820 normal way.
18821
18822 When the expansion succeeds, the router searches first for SRV records for
18823 the given service (it assumes TCP protocol). A single SRV record with a
18824 host name that consists of just a single dot indicates &"no such service for
18825 this domain"&; if this is encountered, the router declines. If other kinds of
18826 SRV record are found, they are used to construct a host list for delivery
18827 according to the rules of RFC 2782. MX records are not sought in this case.
18828
18829 When no SRV records are found, MX records (and address records) are sought in
18830 the traditional way. In other words, SRV records take precedence over MX
18831 records, just as MX records take precedence over address records. Note that
18832 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18833 defined it. It is apparently believed that MX records are sufficient for email
18834 and that SRV records should not be used for this purpose. However, SRV records
18835 have an additional &"weight"& feature which some people might find useful when
18836 trying to split an SMTP load between hosts of different power.
18837
18838 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18839 when there is a DNS lookup error.
18840
18841
18842
18843
18844 .option fail_defer_domains dnslookup "domain list&!!" unset
18845 .cindex "MX record" "not found"
18846 DNS lookups for domains matching &%fail_defer_domains%&
18847 which find no matching record will cause the router to defer
18848 rather than the default behaviour of decline.
18849 This maybe be useful for queueing messages for a newly created
18850 domain while the DNS configuration is not ready.
18851 However, it will result in any message with mistyped domains
18852 also being queued.
18853
18854
18855 .option mx_domains dnslookup "domain list&!!" unset
18856 .cindex "MX record" "required to exist"
18857 .cindex "SRV record" "required to exist"
18858 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18859 record in order to be recognized. (The name of this option could be improved.)
18860 For example, if all the mail hosts in &'fict.example'& are known to have MX
18861 records, except for those in &'discworld.fict.example'&, you could use this
18862 setting:
18863 .code
18864 mx_domains = ! *.discworld.fict.example : *.fict.example
18865 .endd
18866 This specifies that messages addressed to a domain that matches the list but
18867 has no MX record should be bounced immediately instead of being routed using
18868 the address record.
18869
18870
18871 .option mx_fail_domains dnslookup "domain list&!!" unset
18872 If the DNS lookup for MX records for one of the domains in this list causes a
18873 DNS lookup error, Exim behaves as if no MX records were found. See section
18874 &<<SECTprowitdnsloo>>& for more discussion.
18875
18876
18877
18878
18879 .option qualify_single dnslookup boolean true
18880 .cindex "DNS" "resolver options"
18881 .cindex "DNS" "qualifying single-component names"
18882 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18883 lookups. Typically, but not standardly, this causes the resolver to qualify
18884 single-component names with the default domain. For example, on a machine
18885 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18886 &'thesaurus.ref.example'& inside the resolver. For details of what your
18887 resolver actually does, consult your man pages for &'resolver'& and
18888 &'resolv.conf'&.
18889
18890
18891
18892 .option rewrite_headers dnslookup boolean true
18893 .cindex "rewriting" "header lines"
18894 .cindex "header lines" "rewriting"
18895 If the domain name in the address that is being processed is not fully
18896 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18897 an address is specified as &'dormouse@teaparty'&, the domain might be
18898 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18899 occur as a result of setting the &%widen_domains%& option. If
18900 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18901 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18902 header lines of the message are rewritten with the full domain name.
18903
18904 This option should be turned off only when it is known that no message is
18905 ever going to be sent outside an environment where the abbreviation makes
18906 sense.
18907
18908 When an MX record is looked up in the DNS and matches a wildcard record, name
18909 servers normally return a record containing the name that has been looked up,
18910 making it impossible to detect whether a wildcard was present or not. However,
18911 some name servers have recently been seen to return the wildcard entry. If the
18912 name returned by a DNS lookup begins with an asterisk, it is not used for
18913 header rewriting.
18914
18915
18916 .option same_domain_copy_routing dnslookup boolean false
18917 .cindex "address" "copying routing"
18918 Addresses with the same domain are normally routed by the &(dnslookup)& router
18919 to the same list of hosts. However, this cannot be presumed, because the router
18920 options and preconditions may refer to the local part of the address. By
18921 default, therefore, Exim routes each address in a message independently. DNS
18922 servers run caches, so repeated DNS lookups are not normally expensive, and in
18923 any case, personal messages rarely have more than a few recipients.
18924
18925 If you are running mailing lists with large numbers of subscribers at the same
18926 domain, and you are using a &(dnslookup)& router which is independent of the
18927 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18928 lookups for identical domains in one message. In this case, when &(dnslookup)&
18929 routes an address to a remote transport, any other unrouted addresses in the
18930 message that have the same domain are automatically given the same routing
18931 without processing them independently,
18932 provided the following conditions are met:
18933
18934 .ilist
18935 No router that processed the address specified &%headers_add%& or
18936 &%headers_remove%&.
18937 .next
18938 The router did not change the address in any way, for example, by &"widening"&
18939 the domain.
18940 .endlist
18941
18942
18943
18944
18945 .option search_parents dnslookup boolean false
18946 .cindex "DNS" "resolver options"
18947 When this option is true, the resolver option RES_DNSRCH is set for DNS
18948 lookups. This is different from the &%qualify_single%& option in that it
18949 applies to domains containing dots. Typically, but not standardly, it causes
18950 the resolver to search for the name in the current domain and in parent
18951 domains. For example, on a machine in the &'fict.example'& domain, if looking
18952 up &'teaparty.wonderland'& failed, the resolver would try
18953 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18954 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18955
18956 Setting this option true can cause problems in domains that have a wildcard MX
18957 record, because any domain that does not have its own MX record matches the
18958 local wildcard.
18959
18960
18961
18962 .option srv_fail_domains dnslookup "domain list&!!" unset
18963 If the DNS lookup for SRV records for one of the domains in this list causes a
18964 DNS lookup error, Exim behaves as if no SRV records were found. See section
18965 &<<SECTprowitdnsloo>>& for more discussion.
18966
18967
18968
18969
18970 .option widen_domains dnslookup "string list" unset
18971 .cindex "domain" "partial; widening"
18972 If a DNS lookup fails and this option is set, each of its strings in turn is
18973 added onto the end of the domain, and the lookup is tried again. For example,
18974 if
18975 .code
18976 widen_domains = fict.example:ref.example
18977 .endd
18978 is set and a lookup of &'klingon.dictionary'& fails,
18979 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18980 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18981 and &%search_parents%& options can cause some widening to be undertaken inside
18982 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18983 when verifying, unless &%rewrite_headers%& is false (not the default).
18984
18985
18986 .section "Effect of qualify_single and search_parents" "SECID119"
18987 When a domain from an envelope recipient is changed by the resolver as a result
18988 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18989 corresponding address in the message's header lines unless &%rewrite_headers%&
18990 is set false. Exim then re-routes the address, using the full domain.
18991
18992 These two options affect only the DNS lookup that takes place inside the router
18993 for the domain of the address that is being routed. They do not affect lookups
18994 such as that implied by
18995 .code
18996 domains = @mx_any
18997 .endd
18998 that may happen while processing a router precondition before the router is
18999 entered. No widening ever takes place for these lookups.
19000 .ecindex IIDdnsrou1
19001 .ecindex IIDdnsrou2
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011 . ////////////////////////////////////////////////////////////////////////////
19012 . ////////////////////////////////////////////////////////////////////////////
19013
19014 .chapter "The ipliteral router" "CHID5"
19015 .cindex "&(ipliteral)& router"
19016 .cindex "domain literal" "routing"
19017 .cindex "routers" "&(ipliteral)&"
19018 This router has no private options. Unless it is being used purely for
19019 verification (see &%verify_only%&) a transport is required to be defined by the
19020 generic &%transport%& option. The router accepts the address if its domain part
19021 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19022 router handles the address
19023 .code
19024 root@[192.168.1.1]
19025 .endd
19026 by setting up delivery to the host with that IP address. IPv4 domain literals
19027 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19028 are similar, but the address is preceded by &`ipv6:`&. For example:
19029 .code
19030 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19031 .endd
19032 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19033 grounds that sooner or later somebody will try it.
19034
19035 .oindex "&%self%&" "in &(ipliteral)& router"
19036 If the IP address matches something in &%ignore_target_hosts%&, the router
19037 declines. If an IP literal turns out to refer to the local host, the generic
19038 &%self%& option determines what happens.
19039
19040 The RFCs require support for domain literals; however, their use is
19041 controversial in today's Internet. If you want to use this router, you must
19042 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19043 Exim will not recognize the domain literal syntax in addresses.
19044
19045
19046
19047 . ////////////////////////////////////////////////////////////////////////////
19048 . ////////////////////////////////////////////////////////////////////////////
19049
19050 .chapter "The iplookup router" "CHID6"
19051 .cindex "&(iplookup)& router"
19052 .cindex "routers" "&(iplookup)&"
19053 The &(iplookup)& router was written to fulfil a specific requirement in
19054 Cambridge University (which in fact no longer exists). For this reason, it is
19055 not included in the binary of Exim by default. If you want to include it, you
19056 must set
19057 .code
19058 ROUTER_IPLOOKUP=yes
19059 .endd
19060 in your &_Local/Makefile_& configuration file.
19061
19062 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19063 connection to one or more specific hosts. The host can then return the same or
19064 a different address &-- in effect rewriting the recipient address in the
19065 message's envelope. The new address is then passed on to subsequent routers. If
19066 this process fails, the address can be passed on to other routers, or delivery
19067 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19068 must not be specified for it.
19069
19070 .cindex "options" "&(iplookup)& router"
19071 .option hosts iplookup string unset
19072 This option must be supplied. Its value is a colon-separated list of host
19073 names. The hosts are looked up using &[gethostbyname()]&
19074 (or &[getipnodebyname()]& when available)
19075 and are tried in order until one responds to the query. If none respond, what
19076 happens is controlled by &%optional%&.
19077
19078
19079 .option optional iplookup boolean false
19080 If &%optional%& is true, if no response is obtained from any host, the address
19081 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19082 delivery to the address is deferred.
19083
19084
19085 .option port iplookup integer 0
19086 .cindex "port" "&(iplookup)& router"
19087 This option must be supplied. It specifies the port number for the TCP or UDP
19088 call.
19089
19090
19091 .option protocol iplookup string udp
19092 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19093 protocols is to be used.
19094
19095
19096 .option query iplookup string&!! "see below"
19097 This defines the content of the query that is sent to the remote hosts. The
19098 default value is:
19099 .code
19100 $local_part@$domain $local_part@$domain
19101 .endd
19102 The repetition serves as a way of checking that a response is to the correct
19103 query in the default case (see &%response_pattern%& below).
19104
19105
19106 .option reroute iplookup string&!! unset
19107 If this option is not set, the rerouted address is precisely the byte string
19108 returned by the remote host, up to the first white space, if any. If set, the
19109 string is expanded to form the rerouted address. It can include parts matched
19110 in the response by &%response_pattern%& by means of numeric variables such as
19111 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19112 whether or not a pattern is in use. In all cases, the rerouted address must end
19113 up in the form &'local_part@domain'&.
19114
19115
19116 .option response_pattern iplookup string unset
19117 This option can be set to a regular expression that is applied to the string
19118 returned from the remote host. If the pattern does not match the response, the
19119 router declines. If &%response_pattern%& is not set, no checking of the
19120 response is done, unless the query was defaulted, in which case there is a
19121 check that the text returned after the first white space is the original
19122 address. This checks that the answer that has been received is in response to
19123 the correct question. For example, if the response is just a new domain, the
19124 following could be used:
19125 .code
19126 response_pattern = ^([^@]+)$
19127 reroute = $local_part@$1
19128 .endd
19129
19130 .option timeout iplookup time 5s
19131 This specifies the amount of time to wait for a response from the remote
19132 machine. The same timeout is used for the &[connect()]& function for a TCP
19133 call. It does not apply to UDP.
19134
19135
19136
19137
19138 . ////////////////////////////////////////////////////////////////////////////
19139 . ////////////////////////////////////////////////////////////////////////////
19140
19141 .chapter "The manualroute router" "CHID7"
19142 .scindex IIDmanrou1 "&(manualroute)& router"
19143 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19144 .cindex "domain" "manually routing"
19145 The &(manualroute)& router is so-called because it provides a way of manually
19146 routing an address according to its domain. It is mainly used when you want to
19147 route addresses to remote hosts according to your own rules, bypassing the
19148 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19149 route to local transports, a facility that may be useful if you want to save
19150 messages for dial-in hosts in local files.
19151
19152 The &(manualroute)& router compares a list of domain patterns with the domain
19153 it is trying to route. If there is no match, the router declines. Each pattern
19154 has associated with it a list of hosts and some other optional data, which may
19155 include a transport. The combination of a pattern and its data is called a
19156 &"routing rule"&. For patterns that do not have an associated transport, the
19157 generic &%transport%& option must specify a transport, unless the router is
19158 being used purely for verification (see &%verify_only%&).
19159
19160 .vindex "&$host$&"
19161 In the case of verification, matching the domain pattern is sufficient for the
19162 router to accept the address. When actually routing an address for delivery,
19163 an address that matches a domain pattern is queued for the associated
19164 transport. If the transport is not a local one, a host list must be associated
19165 with the pattern; IP addresses are looked up for the hosts, and these are
19166 passed to the transport along with the mail address. For local transports, a
19167 host list is optional. If it is present, it is passed in &$host$& as a single
19168 text string.
19169
19170 The list of routing rules can be provided as an inline string in
19171 &%route_list%&, or the data can be obtained by looking up the domain in a file
19172 or database by setting &%route_data%&. Only one of these settings may appear in
19173 any one instance of &(manualroute)&. The format of routing rules is described
19174 below, following the list of private options.
19175
19176
19177 .section "Private options for manualroute" "SECTprioptman"
19178
19179 .cindex "options" "&(manualroute)& router"
19180 The private options for the &(manualroute)& router are as follows:
19181
19182 .option host_all_ignored manualroute string defer
19183 See &%host_find_failed%&.
19184
19185 .option host_find_failed manualroute string freeze
19186 This option controls what happens when &(manualroute)& tries to find an IP
19187 address for a host, and the host does not exist. The option can be set to one
19188 of the following values:
19189 .code
19190 decline
19191 defer
19192 fail
19193 freeze
19194 ignore
19195 pass
19196 .endd
19197 The default (&"freeze"&) assumes that this state is a serious configuration
19198 error. The difference between &"pass"& and &"decline"& is that the former
19199 forces the address to be passed to the next router (or the router defined by
19200 &%pass_router%&),
19201 .oindex "&%more%&"
19202 overriding &%no_more%&, whereas the latter passes the address to the next
19203 router only if &%more%& is true.
19204
19205 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19206 cannot be found. If all the hosts in the list are ignored, the behaviour is
19207 controlled by the &%host_all_ignored%& option. This takes the same values
19208 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19209
19210 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19211 state; if a host lookup gets a temporary error, delivery is deferred unless the
19212 generic &%pass_on_timeout%& option is set.
19213
19214
19215 .option hosts_randomize manualroute boolean false
19216 .cindex "randomized host list"
19217 .cindex "host" "list of; randomized"
19218 If this option is set, the order of the items in a host list in a routing rule
19219 is randomized each time the list is used, unless an option in the routing rule
19220 overrides (see below). Randomizing the order of a host list can be used to do
19221 crude load sharing. However, if more than one mail address is routed by the
19222 same router to the same host list, the host lists are considered to be the same
19223 (even though they may be randomized into different orders) for the purpose of
19224 deciding whether to batch the deliveries into a single SMTP transaction.
19225
19226 When &%hosts_randomize%& is true, a host list may be split
19227 into groups whose order is separately randomized. This makes it possible to
19228 set up MX-like behaviour. The boundaries between groups are indicated by an
19229 item that is just &`+`& in the host list. For example:
19230 .code
19231 route_list = * host1:host2:host3:+:host4:host5
19232 .endd
19233 The order of the first three hosts and the order of the last two hosts is
19234 randomized for each use, but the first three always end up before the last two.
19235 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19236 randomized host list is passed to an &(smtp)& transport that also has
19237 &%hosts_randomize set%&, the list is not re-randomized.
19238
19239
19240 .option route_data manualroute string&!! unset
19241 If this option is set, it must expand to yield the data part of a routing rule.
19242 Typically, the expansion string includes a lookup based on the domain. For
19243 example:
19244 .code
19245 route_data = ${lookup{$domain}dbm{/etc/routes}}
19246 .endd
19247 If the expansion is forced to fail, or the result is an empty string, the
19248 router declines. Other kinds of expansion failure cause delivery to be
19249 deferred.
19250
19251
19252 .option route_list manualroute "string list" unset
19253 This string is a list of routing rules, in the form defined below. Note that,
19254 unlike most string lists, the items are separated by semicolons. This is so
19255 that they may contain colon-separated host lists.
19256
19257
19258 .option same_domain_copy_routing manualroute boolean false
19259 .cindex "address" "copying routing"
19260 Addresses with the same domain are normally routed by the &(manualroute)&
19261 router to the same list of hosts. However, this cannot be presumed, because the
19262 router options and preconditions may refer to the local part of the address. By
19263 default, therefore, Exim routes each address in a message independently. DNS
19264 servers run caches, so repeated DNS lookups are not normally expensive, and in
19265 any case, personal messages rarely have more than a few recipients.
19266
19267 If you are running mailing lists with large numbers of subscribers at the same
19268 domain, and you are using a &(manualroute)& router which is independent of the
19269 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19270 lookups for identical domains in one message. In this case, when
19271 &(manualroute)& routes an address to a remote transport, any other unrouted
19272 addresses in the message that have the same domain are automatically given the
19273 same routing without processing them independently. However, this is only done
19274 if &%headers_add%& and &%headers_remove%& are unset.
19275
19276
19277
19278
19279 .section "Routing rules in route_list" "SECID120"
19280 The value of &%route_list%& is a string consisting of a sequence of routing
19281 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19282 entered as two semicolons. Alternatively, the list separator can be changed as
19283 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19284 Empty rules are ignored. The format of each rule is
19285 .display
19286 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19287 .endd
19288 The following example contains two rules, each with a simple domain pattern and
19289 no options:
19290 .code
19291 route_list = \
19292   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19293   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19294 .endd
19295 The three parts of a rule are separated by white space. The pattern and the
19296 list of hosts can be enclosed in quotes if necessary, and if they are, the
19297 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19298 single domain pattern, which is the only mandatory item in the rule. The
19299 pattern is in the same format as one item in a domain list (see section
19300 &<<SECTdomainlist>>&),
19301 except that it may not be the name of an interpolated file.
19302 That is, it may be wildcarded, or a regular expression, or a file or database
19303 lookup (with semicolons doubled, because of the use of semicolon as a separator
19304 in a &%route_list%&).
19305
19306 The rules in &%route_list%& are searched in order until one of the patterns
19307 matches the domain that is being routed. The list of hosts and then options are
19308 then used as described below. If there is no match, the router declines. When
19309 &%route_list%& is set, &%route_data%& must not be set.
19310
19311
19312
19313 .section "Routing rules in route_data" "SECID121"
19314 The use of &%route_list%& is convenient when there are only a small number of
19315 routing rules. For larger numbers, it is easier to use a file or database to
19316 hold the routing information, and use the &%route_data%& option instead.
19317 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19318 Most commonly, &%route_data%& is set as a string that contains an
19319 expansion lookup. For example, suppose we place two routing rules in a file
19320 like this:
19321 .code
19322 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19323 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19324 .endd
19325 This data can be accessed by setting
19326 .code
19327 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19328 .endd
19329 Failure of the lookup results in an empty string, causing the router to
19330 decline. However, you do not have to use a lookup in &%route_data%&. The only
19331 requirement is that the result of expanding the string is a list of hosts,
19332 possibly followed by options, separated by white space. The list of hosts must
19333 be enclosed in quotes if it contains white space.
19334
19335
19336
19337
19338 .section "Format of the list of hosts" "SECID122"
19339 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19340 always separately expanded before use. If the expansion fails, the router
19341 declines. The result of the expansion must be a colon-separated list of names
19342 and/or IP addresses, optionally also including ports. The format of each item
19343 in the list is described in the next section. The list separator can be changed
19344 as described in section &<<SECTlistconstruct>>&.
19345
19346 If the list of hosts was obtained from a &%route_list%& item, the following
19347 variables are set during its expansion:
19348
19349 .ilist
19350 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19351 If the domain was matched against a regular expression, the numeric variables
19352 &$1$&, &$2$&, etc. may be set. For example:
19353 .code
19354 route_list = ^domain(\d+)   host-$1.text.example
19355 .endd
19356 .next
19357 &$0$& is always set to the entire domain.
19358 .next
19359 &$1$& is also set when partial matching is done in a file lookup.
19360
19361 .next
19362 .vindex "&$value$&"
19363 If the pattern that matched the domain was a lookup item, the data that was
19364 looked up is available in the expansion variable &$value$&. For example:
19365 .code
19366 route_list = lsearch;;/some/file.routes  $value
19367 .endd
19368 .endlist
19369
19370 Note the doubling of the semicolon in the pattern that is necessary because
19371 semicolon is the default route list separator.
19372
19373
19374
19375 .section "Format of one host item" "SECTformatonehostitem"
19376 Each item in the list of hosts is either a host name or an IP address,
19377 optionally with an attached port number. When no port is given, an IP address
19378 is not enclosed in brackets. When a port is specified, it overrides the port
19379 specification on the transport. The port is separated from the name or address
19380 by a colon. This leads to some complications:
19381
19382 .ilist
19383 Because colon is the default separator for the list of hosts, either
19384 the colon that specifies a port must be doubled, or the list separator must
19385 be changed. The following two examples have the same effect:
19386 .code
19387 route_list = * "host1.tld::1225 : host2.tld::1226"
19388 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19389 .endd
19390 .next
19391 When IPv6 addresses are involved, it gets worse, because they contain
19392 colons of their own. To make this case easier, it is permitted to
19393 enclose an IP address (either v4 or v6) in square brackets if a port
19394 number follows. For example:
19395 .code
19396 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19397 .endd
19398 .endlist
19399
19400 .section "How the list of hosts is used" "SECThostshowused"
19401 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19402 the hosts is tried, in the order specified, when carrying out the SMTP
19403 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19404 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19405 transport.
19406
19407 Hosts may be listed by name or by IP address. An unadorned name in the list of
19408 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19409 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19410 records in the DNS. For example:
19411 .code
19412 route_list = *  x.y.z:p.q.r/MX:e.f.g
19413 .endd
19414 If this feature is used with a port specifier, the port must come last. For
19415 example:
19416 .code
19417 route_list = *  dom1.tld/mx::1225
19418 .endd
19419 If the &%hosts_randomize%& option is set, the order of the items in the list is
19420 randomized before any lookups are done. Exim then scans the list; for any name
19421 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19422 be an interface on the local host and the item is not the first in the list,
19423 Exim discards it and any subsequent items. If it is the first item, what
19424 happens is controlled by the
19425 .oindex "&%self%&" "in &(manualroute)& router"
19426 &%self%& option of the router.
19427
19428 A name on the list that is followed by &`/MX`& is replaced with the list of
19429 hosts obtained by looking up MX records for the name. This is always a DNS
19430 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19431 below) are not relevant here. The order of these hosts is determined by the
19432 preference values in the MX records, according to the usual rules. Because
19433 randomizing happens before the MX lookup, it does not affect the order that is
19434 defined by MX preferences.
19435
19436 If the local host is present in the sublist obtained from MX records, but is
19437 not the most preferred host in that list, it and any equally or less
19438 preferred hosts are removed before the sublist is inserted into the main list.
19439
19440 If the local host is the most preferred host in the MX list, what happens
19441 depends on where in the original list of hosts the &`/MX`& item appears. If it
19442 is not the first item (that is, there are previous hosts in the main list),
19443 Exim discards this name and any subsequent items in the main list.
19444
19445 If the MX item is first in the list of hosts, and the local host is the
19446 most preferred host, what happens is controlled by the &%self%& option of the
19447 router.
19448
19449 DNS failures when lookup up the MX records are treated in the same way as DNS
19450 failures when looking up IP addresses: &%pass_on_timeout%& and
19451 &%host_find_failed%& are used when relevant.
19452
19453 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19454 whether obtained from an MX lookup or not.
19455
19456
19457
19458 .section "How the options are used" "SECThowoptused"
19459 The options are a sequence of words; in practice no more than three are ever
19460 present. One of the words can be the name of a transport; this overrides the
19461 &%transport%& option on the router for this particular routing rule only. The
19462 other words (if present) control randomization of the list of hosts on a
19463 per-rule basis, and how the IP addresses of the hosts are to be found when
19464 routing to a remote transport. These options are as follows:
19465
19466 .ilist
19467 &%randomize%&: randomize the order of the hosts in this list, overriding the
19468 setting of &%hosts_randomize%& for this routing rule only.
19469 .next
19470 &%no_randomize%&: do not randomize the order of the hosts in this list,
19471 overriding the setting of &%hosts_randomize%& for this routing rule only.
19472 .next
19473 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19474 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19475 also look in &_/etc/hosts_& or other sources of information.
19476 .next
19477 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19478 no address records are found. If there is a temporary DNS error (such as a
19479 timeout), delivery is deferred.
19480 .endlist
19481
19482 For example:
19483 .code
19484 route_list = domain1  host1:host2:host3  randomize bydns;\
19485              domain2  host4:host5
19486 .endd
19487 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19488 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19489 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19490 or &[gethostbyname()]&, and the result of the lookup is the result of that
19491 call.
19492
19493 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19494 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19495 instead of TRY_AGAIN. That is why the default action is to try a DNS
19496 lookup first. Only if that gives a definite &"no such host"& is the local
19497 function called.
19498
19499 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19500 inadvertent constraint that a transport name as an option had to be the last
19501 option specified.
19502
19503
19504
19505 If no IP address for a host can be found, what happens is controlled by the
19506 &%host_find_failed%& option.
19507
19508 .vindex "&$host$&"
19509 When an address is routed to a local transport, IP addresses are not looked up.
19510 The host list is passed to the transport in the &$host$& variable.
19511
19512
19513
19514 .section "Manualroute examples" "SECID123"
19515 In some of the examples that follow, the presence of the &%remote_smtp%&
19516 transport, as defined in the default configuration file, is assumed:
19517
19518 .ilist
19519 .cindex "smart host" "example router"
19520 The &(manualroute)& router can be used to forward all external mail to a
19521 &'smart host'&. If you have set up, in the main part of the configuration, a
19522 named domain list that contains your local domains, for example:
19523 .code
19524 domainlist local_domains = my.domain.example
19525 .endd
19526 You can arrange for all other domains to be routed to a smart host by making
19527 your first router something like this:
19528 .code
19529 smart_route:
19530   driver = manualroute
19531   domains = !+local_domains
19532   transport = remote_smtp
19533   route_list = * smarthost.ref.example
19534 .endd
19535 This causes all non-local addresses to be sent to the single host
19536 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19537 they are tried in order
19538 (but you can use &%hosts_randomize%& to vary the order each time).
19539 Another way of configuring the same thing is this:
19540 .code
19541 smart_route:
19542   driver = manualroute
19543   transport = remote_smtp
19544   route_list = !+local_domains  smarthost.ref.example
19545 .endd
19546 There is no difference in behaviour between these two routers as they stand.
19547 However, they behave differently if &%no_more%& is added to them. In the first
19548 example, the router is skipped if the domain does not match the &%domains%&
19549 precondition; the following router is always tried. If the router runs, it
19550 always matches the domain and so can never decline. Therefore, &%no_more%&
19551 would have no effect. In the second case, the router is never skipped; it
19552 always runs. However, if it doesn't match the domain, it declines. In this case
19553 &%no_more%& would prevent subsequent routers from running.
19554
19555 .next
19556 .cindex "mail hub example"
19557 A &'mail hub'& is a host which receives mail for a number of domains via MX
19558 records in the DNS and delivers it via its own private routing mechanism. Often
19559 the final destinations are behind a firewall, with the mail hub being the one
19560 machine that can connect to machines both inside and outside the firewall. The
19561 &(manualroute)& router is usually used on a mail hub to route incoming messages
19562 to the correct hosts. For a small number of domains, the routing can be inline,
19563 using the &%route_list%& option, but for a larger number a file or database
19564 lookup is easier to manage.
19565
19566 If the domain names are in fact the names of the machines to which the mail is
19567 to be sent by the mail hub, the configuration can be quite simple. For
19568 example:
19569 .code
19570 hub_route:
19571   driver = manualroute
19572   transport = remote_smtp
19573   route_list = *.rhodes.tvs.example  $domain
19574 .endd
19575 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19576 whose names are the same as the mail domains. A similar approach can be taken
19577 if the host name can be obtained from the domain name by a string manipulation
19578 that the expansion facilities can handle. Otherwise, a lookup based on the
19579 domain can be used to find the host:
19580 .code
19581 through_firewall:
19582   driver = manualroute
19583   transport = remote_smtp
19584   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19585 .endd
19586 The result of the lookup must be the name or IP address of the host (or
19587 hosts) to which the address is to be routed. If the lookup fails, the route
19588 data is empty, causing the router to decline. The address then passes to the
19589 next router.
19590
19591 .next
19592 .cindex "batched SMTP output example"
19593 .cindex "SMTP" "batched outgoing; example"
19594 You can use &(manualroute)& to deliver messages to pipes or files in batched
19595 SMTP format for onward transportation by some other means. This is one way of
19596 storing mail for a dial-up host when it is not connected. The route list entry
19597 can be as simple as a single domain name in a configuration like this:
19598 .code
19599 save_in_file:
19600   driver = manualroute
19601   transport = batchsmtp_appendfile
19602   route_list = saved.domain.example
19603 .endd
19604 though often a pattern is used to pick up more than one domain. If there are
19605 several domains or groups of domains with different transport requirements,
19606 different transports can be listed in the routing information:
19607 .code
19608 save_in_file:
19609   driver = manualroute
19610   route_list = \
19611     *.saved.domain1.example  $domain  batch_appendfile; \
19612     *.saved.domain2.example  \
19613       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19614       batch_pipe
19615 .endd
19616 .vindex "&$domain$&"
19617 .vindex "&$host$&"
19618 The first of these just passes the domain in the &$host$& variable, which
19619 doesn't achieve much (since it is also in &$domain$&), but the second does a
19620 file lookup to find a value to pass, causing the router to decline to handle
19621 the address if the lookup fails.
19622
19623 .next
19624 .cindex "UUCP" "example of router for"
19625 Routing mail directly to UUCP software is a specific case of the use of
19626 &(manualroute)& in a gateway to another mail environment. This is an example of
19627 one way it can be done:
19628 .code
19629 # Transport
19630 uucp:
19631   driver = pipe
19632   user = nobody
19633   command = /usr/local/bin/uux -r - \
19634     ${substr_-5:$host}!rmail ${local_part}
19635   return_fail_output = true
19636
19637 # Router
19638 uucphost:
19639   transport = uucp
19640   driver = manualroute
19641   route_data = \
19642     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19643 .endd
19644 The file &_/usr/local/exim/uucphosts_& contains entries like
19645 .code
19646 darksite.ethereal.example:           darksite.UUCP
19647 .endd
19648 It can be set up more simply without adding and removing &".UUCP"& but this way
19649 makes clear the distinction between the domain name
19650 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19651 .endlist
19652 .ecindex IIDmanrou1
19653 .ecindex IIDmanrou2
19654
19655
19656
19657
19658
19659
19660
19661
19662 . ////////////////////////////////////////////////////////////////////////////
19663 . ////////////////////////////////////////////////////////////////////////////
19664
19665 .chapter "The queryprogram router" "CHAPdriverlast"
19666 .scindex IIDquerou1 "&(queryprogram)& router"
19667 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19668 .cindex "routing" "by external program"
19669 The &(queryprogram)& router routes an address by running an external command
19670 and acting on its output. This is an expensive way to route, and is intended
19671 mainly for use in lightly-loaded systems, or for performing experiments.
19672 However, if it is possible to use the precondition options (&%domains%&,
19673 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19674 be used in special cases, even on a busy host. There are the following private
19675 options:
19676 .cindex "options" "&(queryprogram)& router"
19677
19678 .option command queryprogram string&!! unset
19679 This option must be set. It specifies the command that is to be run. The
19680 command is split up into a command name and arguments, and then each is
19681 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19682 &<<CHAPpipetransport>>&).
19683
19684
19685 .option command_group queryprogram string unset
19686 .cindex "gid (group id)" "in &(queryprogram)& router"
19687 This option specifies a gid to be set when running the command while routing an
19688 address for deliver. It must be set if &%command_user%& specifies a numerical
19689 uid. If it begins with a digit, it is interpreted as the numerical value of the
19690 gid. Otherwise it is looked up using &[getgrnam()]&.
19691
19692
19693 .option command_user queryprogram string unset
19694 .cindex "uid (user id)" "for &(queryprogram)&"
19695 This option must be set. It specifies the uid which is set when running the
19696 command while routing an address for delivery. If the value begins with a digit,
19697 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19698 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19699 not set, a value for the gid also.
19700
19701 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19702 root, which it does during a normal delivery in a conventional configuration.
19703 However, when an address is being verified during message reception, Exim is
19704 usually running as the Exim user, not as root. If the &(queryprogram)& router
19705 is called from a non-root process, Exim cannot change uid or gid before running
19706 the command. In this circumstance the command runs under the current uid and
19707 gid.
19708
19709
19710 .option current_directory queryprogram string /
19711 This option specifies an absolute path which is made the current directory
19712 before running the command.
19713
19714
19715 .option timeout queryprogram time 1h
19716 If the command does not complete within the timeout period, its process group
19717 is killed and the message is frozen. A value of zero time specifies no
19718 timeout.
19719
19720
19721 The standard output of the command is connected to a pipe, which is read when
19722 the command terminates. It should consist of a single line of output,
19723 containing up to five fields, separated by white space. The maximum length of
19724 the line is 1023 characters. Longer lines are silently truncated. The first
19725 field is one of the following words (case-insensitive):
19726
19727 .ilist
19728 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19729 below).
19730 .next
19731 &'Decline'&: the router declines; pass the address to the next router, unless
19732 &%no_more%& is set.
19733 .next
19734 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19735 subsequent text on the line is an error message. If the router is run as part
19736 of address verification during an incoming SMTP message, the message is
19737 included in the SMTP response.
19738 .next
19739 &'Defer'&: routing could not be completed at this time; try again later. Any
19740 subsequent text on the line is an error message which is logged. It is not
19741 included in any SMTP response.
19742 .next
19743 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19744 .next
19745 &'Pass'&: pass the address to the next router (or the router specified by
19746 &%pass_router%&), overriding &%no_more%&.
19747 .next
19748 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19749 new addresses, which are routed independently, starting with the first router,
19750 or the router specified by &%redirect_router%&, if set.
19751 .endlist
19752
19753 When the first word is &'accept'&, the remainder of the line consists of a
19754 number of keyed data values, as follows (split into two lines here, to fit on
19755 the page):
19756 .code
19757 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19758 LOOKUP=byname|bydns DATA=<text>
19759 .endd
19760 The data items can be given in any order, and all are optional. If no transport
19761 is included, the transport specified by the generic &%transport%& option is
19762 used. The list of hosts and the lookup type are needed only if the transport is
19763 an &(smtp)& transport that does not itself supply a list of hosts.
19764
19765 The format of the list of hosts is the same as for the &(manualroute)& router.
19766 As well as host names and IP addresses with optional port numbers, as described
19767 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19768 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19769 (see section &<<SECThostshowused>>&).
19770
19771 If the lookup type is not specified, Exim behaves as follows when trying to
19772 find an IP address for each host: First, a DNS lookup is done. If this yields
19773 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19774 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19775 result of the lookup is the result of that call.
19776
19777 .vindex "&$address_data$&"
19778 If the DATA field is set, its value is placed in the &$address_data$&
19779 variable. For example, this return line
19780 .code
19781 accept hosts=x1.y.example:x2.y.example data="rule1"
19782 .endd
19783 routes the address to the default transport, passing a list of two hosts. When
19784 the transport runs, the string &"rule1"& is in &$address_data$&.
19785 .ecindex IIDquerou1
19786 .ecindex IIDquerou2
19787
19788
19789
19790
19791 . ////////////////////////////////////////////////////////////////////////////
19792 . ////////////////////////////////////////////////////////////////////////////
19793
19794 .chapter "The redirect router" "CHAPredirect"
19795 .scindex IIDredrou1 "&(redirect)& router"
19796 .scindex IIDredrou2 "routers" "&(redirect)&"
19797 .cindex "alias file" "in a &(redirect)& router"
19798 .cindex "address redirection" "&(redirect)& router"
19799 The &(redirect)& router handles several kinds of address redirection. Its most
19800 common uses are for resolving local part aliases from a central alias file
19801 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19802 files, but it has many other potential uses. The incoming address can be
19803 redirected in several different ways:
19804
19805 .ilist
19806 It can be replaced by one or more new addresses which are themselves routed
19807 independently.
19808 .next
19809 It can be routed to be delivered to a given file or directory.
19810 .next
19811 It can be routed to be delivered to a specified pipe command.
19812 .next
19813 It can cause an automatic reply to be generated.
19814 .next
19815 It can be forced to fail, optionally with a custom error message.
19816 .next
19817 It can be temporarily deferred, optionally with a custom message.
19818 .next
19819 It can be discarded.
19820 .endlist
19821
19822 The generic &%transport%& option must not be set for &(redirect)& routers.
19823 However, there are some private options which define transports for delivery to
19824 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19825 &%pipe_transport%& and &%reply_transport%& descriptions below.
19826
19827 If success DSNs have been requested
19828 .cindex "DSN" "success"
19829 .cindex "Delivery Status Notification" "success"
19830 redirection triggers one and the DSN options are not passed any further.
19831
19832
19833
19834 .section "Redirection data" "SECID124"
19835 The router operates by interpreting a text string which it obtains either by
19836 expanding the contents of the &%data%& option, or by reading the entire
19837 contents of a file whose name is given in the &%file%& option. These two
19838 options are mutually exclusive. The first is commonly used for handling system
19839 aliases, in a configuration like this:
19840 .code
19841 system_aliases:
19842   driver = redirect
19843   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19844 .endd
19845 If the lookup fails, the expanded string in this example is empty. When the
19846 expansion of &%data%& results in an empty string, the router declines. A forced
19847 expansion failure also causes the router to decline; other expansion failures
19848 cause delivery to be deferred.
19849
19850 A configuration using &%file%& is commonly used for handling users'
19851 &_.forward_& files, like this:
19852 .code
19853 userforward:
19854   driver = redirect
19855   check_local_user
19856   file = $home/.forward
19857   no_verify
19858 .endd
19859 If the file does not exist, or causes no action to be taken (for example, it is
19860 empty or consists only of comments), the router declines. &*Warning*&: This
19861 is not the case when the file contains syntactically valid items that happen to
19862 yield empty addresses, for example, items containing only RFC 2822 address
19863 comments.
19864
19865
19866
19867 .section "Forward files and address verification" "SECID125"
19868 .cindex "address redirection" "while verifying"
19869 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19870 &_.forward_& files, as in the example above. There are two reasons for this:
19871
19872 .ilist
19873 When Exim is receiving an incoming SMTP message from a remote host, it is
19874 running under the Exim uid, not as root. Exim is unable to change uid to read
19875 the file as the user, and it may not be able to read it as the Exim user. So in
19876 practice the router may not be able to operate.
19877 .next
19878 However, even when the router can operate, the existence of a &_.forward_& file
19879 is unimportant when verifying an address. What should be checked is whether the
19880 local part is a valid user name or not. Cutting out the redirection processing
19881 saves some resources.
19882 .endlist
19883
19884
19885
19886
19887
19888
19889 .section "Interpreting redirection data" "SECID126"
19890 .cindex "Sieve filter" "specifying in redirection data"
19891 .cindex "filter" "specifying in redirection data"
19892 The contents of the data string, whether obtained from &%data%& or &%file%&,
19893 can be interpreted in two different ways:
19894
19895 .ilist
19896 If the &%allow_filter%& option is set true, and the data begins with the text
19897 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19898 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19899 respectively. Details of the syntax and semantics of filter files are described
19900 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19901 document is intended for use by end users.
19902 .next
19903 Otherwise, the data must be a comma-separated list of redirection items, as
19904 described in the next section.
19905 .endlist
19906
19907 When a message is redirected to a file (a &"mail folder"&), the file name given
19908 in a non-filter redirection list must always be an absolute path. A filter may
19909 generate a relative path &-- how this is handled depends on the transport's
19910 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19911 for the &(appendfile)& transport.
19912
19913
19914
19915 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19916 .cindex "address redirection" "non-filter list items"
19917 When the redirection data is not an Exim or Sieve filter, for example, if it
19918 comes from a conventional alias or forward file, it consists of a list of
19919 addresses, file names, pipe commands, or certain special items (see section
19920 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19921 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19922 depending on their default values. The items in the list are separated by
19923 commas or newlines.
19924 If a comma is required in an item, the entire item must be enclosed in double
19925 quotes.
19926
19927 Lines starting with a # character are comments, and are ignored, and # may
19928 also appear following a comma, in which case everything between the # and the
19929 next newline character is ignored.
19930
19931 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19932 double quotes are retained because some forms of mail address require their use
19933 (but never to enclose the entire address). In the following description,
19934 &"item"& refers to what remains after any surrounding double quotes have been
19935 removed.
19936
19937 .vindex "&$local_part$&"
19938 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19939 and the expansion contains a reference to &$local_part$&, you should make use
19940 of the &%quote_local_part%& expansion operator, in case the local part contains
19941 special characters. For example, to redirect all mail for the domain
19942 &'obsolete.example'&, retaining the existing local part, you could use this
19943 setting:
19944 .code
19945 data = ${quote_local_part:$local_part}@newdomain.example
19946 .endd
19947
19948
19949 .section "Redirecting to a local mailbox" "SECTredlocmai"
19950 .cindex "routing" "loops in"
19951 .cindex "loop" "while routing, avoidance of"
19952 .cindex "address redirection" "to local mailbox"
19953 A redirection item may safely be the same as the address currently under
19954 consideration. This does not cause a routing loop, because a router is
19955 automatically skipped if any ancestor of the address that is being processed
19956 is the same as the current address and was processed by the current router.
19957 Such an address is therefore passed to the following routers, so it is handled
19958 as if there were no redirection. When making this loop-avoidance test, the
19959 complete local part, including any prefix or suffix, is used.
19960
19961 .cindex "address redirection" "local part without domain"
19962 Specifying the same local part without a domain is a common usage in personal
19963 filter files when the user wants to have messages delivered to the local
19964 mailbox and also forwarded elsewhere. For example, the user whose login is
19965 &'cleo'& might have a &_.forward_& file containing this:
19966 .code
19967 cleo, cleopatra@egypt.example
19968 .endd
19969 .cindex "backslash in alias file"
19970 .cindex "alias file" "backslash in"
19971 For compatibility with other MTAs, such unqualified local parts may be
19972 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19973 it does make a difference if more than one domain is being handled
19974 synonymously.
19975
19976 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19977 2822 address that does not include a domain, the item is qualified using the
19978 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19979 addresses are qualified using the value in &%qualify_recipient%&, but you can
19980 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19981
19982 Care must be taken if there are alias names for local users.
19983 Consider an MTA handling a single local domain where the system alias file
19984 contains:
19985 .code
19986 Sam.Reman: spqr
19987 .endd
19988 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19989 messages in the local mailbox, and also forward copies elsewhere. He creates
19990 this forward file:
19991 .code
19992 Sam.Reman, spqr@reme.elsewhere.example
19993 .endd
19994 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19995 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19996 second time round, because it has previously routed it,
19997 and the following routers presumably cannot handle the alias. The forward file
19998 should really contain
19999 .code
20000 spqr, spqr@reme.elsewhere.example
20001 .endd
20002 but because this is such a common error, the &%check_ancestor%& option (see
20003 below) exists to provide a way to get round it. This is normally set on a
20004 &(redirect)& router that is handling users' &_.forward_& files.
20005
20006
20007
20008 .section "Special items in redirection lists" "SECTspecitredli"
20009 In addition to addresses, the following types of item may appear in redirection
20010 lists (that is, in non-filter redirection data):
20011
20012 .ilist
20013 .cindex "pipe" "in redirection list"
20014 .cindex "address redirection" "to pipe"
20015 An item is treated as a pipe command if it begins with &"|"& and does not parse
20016 as a valid RFC 2822 address that includes a domain. A transport for running the
20017 command must be specified by the &%pipe_transport%& option.
20018 Normally, either the router or the transport specifies a user and a group under
20019 which to run the delivery. The default is to use the Exim user and group.
20020
20021 Single or double quotes can be used for enclosing the individual arguments of
20022 the pipe command; no interpretation of escapes is done for single quotes. If
20023 the command contains a comma character, it is necessary to put the whole item
20024 in double quotes, for example:
20025 .code
20026 "|/some/command ready,steady,go"
20027 .endd
20028 since items in redirection lists are terminated by commas. Do not, however,
20029 quote just the command. An item such as
20030 .code
20031 |"/some/command ready,steady,go"
20032 .endd
20033 is interpreted as a pipe with a rather strange command name, and no arguments.
20034
20035 Note that the above example assumes that the text comes from a lookup source
20036 of some sort, so that the quotes are part of the data.  If composing a
20037 redirect router with a &%data%& option directly specifying this command, the
20038 quotes will be used by the configuration parser to define the extent of one
20039 string, but will not be passed down into the redirect router itself.  There
20040 are two main approaches to get around this: escape quotes to be part of the
20041 data itself, or avoid using this mechanism and instead create a custom
20042 transport with the &%command%& option set and reference that transport from
20043 an &%accept%& router.
20044
20045 .next
20046 .cindex "file" "in redirection list"
20047 .cindex "address redirection" "to file"
20048 An item is interpreted as a path name if it begins with &"/"& and does not
20049 parse as a valid RFC 2822 address that includes a domain. For example,
20050 .code
20051 /home/world/minbari
20052 .endd
20053 is treated as a file name, but
20054 .code
20055 /s=molari/o=babylon/@x400gate.way
20056 .endd
20057 is treated as an address. For a file name, a transport must be specified using
20058 the &%file_transport%& option. However, if the generated path name ends with a
20059 forward slash character, it is interpreted as a directory name rather than a
20060 file name, and &%directory_transport%& is used instead.
20061
20062 Normally, either the router or the transport specifies a user and a group under
20063 which to run the delivery. The default is to use the Exim user and group.
20064
20065 .cindex "&_/dev/null_&"
20066 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20067 bypassed at a high level, and the log entry shows &"**bypassed**"&
20068 instead of a transport name. In this case the user and group are not used.
20069
20070 .next
20071 .cindex "included address list"
20072 .cindex "address redirection" "included external list"
20073 If an item is of the form
20074 .code
20075 :include:<path name>
20076 .endd
20077 a list of further items is taken from the given file and included at that
20078 point. &*Note*&: Such a file can not be a filter file; it is just an
20079 out-of-line addition to the list. The items in the included list are separated
20080 by commas or newlines and are not subject to expansion. If this is the first
20081 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20082 the alias name. This example is incorrect:
20083 .code
20084 list1    :include:/opt/lists/list1
20085 .endd
20086 It must be given as
20087 .code
20088 list1:   :include:/opt/lists/list1
20089 .endd
20090 .next
20091 .cindex "address redirection" "to black hole"
20092 .cindex "delivery" "discard"
20093 .cindex "delivery" "blackhole"
20094 .cindex "black hole"
20095 .cindex "abandoning mail"
20096 Sometimes you want to throw away mail to a particular local part.  Making the
20097 &%data%& option expand to an empty string does not work, because that causes
20098 the router to decline. Instead, the alias item
20099 .code
20100 :blackhole:
20101 .endd
20102 can be used. It does what its name implies. No delivery is
20103 done, and no error message is generated. This has the same effect as specifying
20104 &_/dev/null_& as a destination, but it can be independently disabled.
20105
20106 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20107 delivery is done for the original local part, even if other redirection items
20108 are present. If you are generating a multi-item list (for example, by reading a
20109 database) and need the ability to provide a no-op item, you must use
20110 &_/dev/null_&.
20111
20112 .next
20113 .cindex "delivery" "forcing failure"
20114 .cindex "delivery" "forcing deferral"
20115 .cindex "failing delivery" "forcing"
20116 .cindex "deferred delivery, forcing"
20117 .cindex "customizing" "failure message"
20118 An attempt to deliver a particular address can be deferred or forced to fail by
20119 redirection items of the form
20120 .code
20121 :defer:
20122 :fail:
20123 .endd
20124 respectively. When a redirection list contains such an item, it applies
20125 to the entire redirection; any other items in the list are ignored. Any
20126 text following &':fail:'& or &':defer:'& is placed in the error text
20127 associated with the failure. For example, an alias file might contain:
20128 .code
20129 X.Employee:  :fail: Gone away, no forwarding address
20130 .endd
20131 In the case of an address that is being verified from an ACL or as the subject
20132 of a
20133 .cindex "VRFY" "error text, display of"
20134 VRFY command, the text is included in the SMTP error response by
20135 default.
20136 .cindex "EXPN" "error text, display of"
20137 The text is not included in the response to an EXPN command. In non-SMTP cases
20138 the text is included in the error message that Exim generates.
20139
20140 .cindex "SMTP" "error codes"
20141 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20142 &':fail:'&. However, if the message starts with three digits followed by a
20143 space, optionally followed by an extended code of the form &'n.n.n'&, also
20144 followed by a space, and the very first digit is the same as the default error
20145 code, the code from the message is used instead. If the very first digit is
20146 incorrect, a panic error is logged, and the default code is used. You can
20147 suppress the use of the supplied code in a redirect router by setting the
20148 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20149 ignored.
20150
20151 .vindex "&$acl_verify_message$&"
20152 In an ACL, an explicitly provided message overrides the default, but the
20153 default message is available in the variable &$acl_verify_message$& and can
20154 therefore be included in a custom message if this is desired.
20155
20156 Normally the error text is the rest of the redirection list &-- a comma does
20157 not terminate it &-- but a newline does act as a terminator. Newlines are not
20158 normally present in alias expansions. In &(lsearch)& lookups they are removed
20159 as part of the continuation process, but they may exist in other kinds of
20160 lookup and in &':include:'& files.
20161
20162 During routing for message delivery (as opposed to verification), a redirection
20163 containing &':fail:'& causes an immediate failure of the incoming address,
20164 whereas &':defer:'& causes the message to remain on the queue so that a
20165 subsequent delivery attempt can happen at a later time. If an address is
20166 deferred for too long, it will ultimately fail, because the normal retry
20167 rules still apply.
20168
20169 .next
20170 .cindex "alias file" "exception to default"
20171 Sometimes it is useful to use a single-key search type with a default (see
20172 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20173 for exceptions to the default. These can be handled by aliasing them to
20174 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20175 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20176 results in an empty redirection list has the same effect.
20177 .endlist
20178
20179
20180 .section "Duplicate addresses" "SECTdupaddr"
20181 .cindex "duplicate addresses"
20182 .cindex "address duplicate, discarding"
20183 .cindex "pipe" "duplicated"
20184 Exim removes duplicate addresses from the list to which it is delivering, so as
20185 to deliver just one copy to each address. This does not apply to deliveries
20186 routed to pipes by different immediate parent addresses, but an indirect
20187 aliasing scheme of the type
20188 .code
20189 pipe:       |/some/command $local_part
20190 localpart1: pipe
20191 localpart2: pipe
20192 .endd
20193 does not work with a message that is addressed to both local parts, because
20194 when the second is aliased to the intermediate local part &"pipe"& it gets
20195 discarded as being the same as a previously handled address. However, a scheme
20196 such as
20197 .code
20198 localpart1: |/some/command $local_part
20199 localpart2: |/some/command $local_part
20200 .endd
20201 does result in two different pipe deliveries, because the immediate parents of
20202 the pipes are distinct.
20203
20204
20205
20206 .section "Repeated redirection expansion" "SECID128"
20207 .cindex "repeated redirection expansion"
20208 .cindex "address redirection" "repeated for each delivery attempt"
20209 When a message cannot be delivered to all of its recipients immediately,
20210 leading to two or more delivery attempts, redirection expansion is carried out
20211 afresh each time for those addresses whose children were not all previously
20212 delivered. If redirection is being used as a mailing list, this can lead to new
20213 members of the list receiving copies of old messages. The &%one_time%& option
20214 can be used to avoid this.
20215
20216
20217 .section "Errors in redirection lists" "SECID129"
20218 .cindex "address redirection" "errors"
20219 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20220 error is skipped, and an entry is written to the main log. This may be useful
20221 for mailing lists that are automatically managed. Otherwise, if an error is
20222 detected while generating the list of new addresses, the original address is
20223 deferred. See also &%syntax_errors_to%&.
20224
20225
20226
20227 .section "Private options for the redirect router" "SECID130"
20228
20229 .cindex "options" "&(redirect)& router"
20230 The private options for the &(redirect)& router are as follows:
20231
20232
20233 .option allow_defer redirect boolean false
20234 Setting this option allows the use of &':defer:'& in non-filter redirection
20235 data, or the &%defer%& command in an Exim filter file.
20236
20237
20238 .option allow_fail redirect boolean false
20239 .cindex "failing delivery" "from filter"
20240 If this option is true, the &':fail:'& item can be used in a redirection list,
20241 and the &%fail%& command may be used in an Exim filter file.
20242
20243
20244 .option allow_filter redirect boolean false
20245 .cindex "filter" "enabling use of"
20246 .cindex "Sieve filter" "enabling use of"
20247 Setting this option allows Exim to interpret redirection data that starts with
20248 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20249 are some features of Exim filter files that some administrators may wish to
20250 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20251
20252 It is also possible to lock out Exim filters or Sieve filters while allowing
20253 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20254
20255
20256 The filter is run using the uid and gid set by the generic &%user%& and
20257 &%group%& options. These take their defaults from the password data if
20258 &%check_local_user%& is set, so in the normal case of users' personal filter
20259 files, the filter is run as the relevant user. When &%allow_filter%& is set
20260 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20261
20262
20263
20264 .option allow_freeze redirect boolean false
20265 .cindex "freezing messages" "allowing in filter"
20266 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20267 This command is more normally encountered in system filters, and is disabled by
20268 default for redirection filters because it isn't something you usually want to
20269 let ordinary users do.
20270
20271
20272
20273 .option check_ancestor redirect boolean false
20274 This option is concerned with handling generated addresses that are the same
20275 as some address in the list of redirection ancestors of the current address.
20276 Although it is turned off by default in the code, it is set in the default
20277 configuration file for handling users' &_.forward_& files. It is recommended
20278 for this use of the &(redirect)& router.
20279
20280 When &%check_ancestor%& is set, if a generated address (including the domain)
20281 is the same as any ancestor of the current address, it is replaced by a copy of
20282 the current address. This helps in the case where local part A is aliased to B,
20283 and B has a &_.forward_& file pointing back to A. For example, within a single
20284 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20285 &_&~jb/.forward_& contains:
20286 .code
20287 \Joe.Bloggs, <other item(s)>
20288 .endd
20289 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20290 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20291 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20292 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20293 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20294 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20295 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20296 original address. See also the &%repeat_use%& option below.
20297
20298
20299 .option check_group redirect boolean "see below"
20300 When the &%file%& option is used, the group owner of the file is checked only
20301 when this option is set. The permitted groups are those listed in the
20302 &%owngroups%& option, together with the user's default group if
20303 &%check_local_user%& is set. If the file has the wrong group, routing is
20304 deferred. The default setting for this option is true if &%check_local_user%&
20305 is set and the &%modemask%& option permits the group write bit, or if the
20306 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20307
20308
20309
20310 .option check_owner redirect boolean "see below"
20311 When the &%file%& option is used, the owner of the file is checked only when
20312 this option is set. If &%check_local_user%& is set, the local user is
20313 permitted; otherwise the owner must be one of those listed in the &%owners%&
20314 option. The default value for this option is true if &%check_local_user%& or
20315 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20316
20317
20318 .option data redirect string&!! unset
20319 This option is mutually exclusive with &%file%&. One or other of them must be
20320 set, but not both. The contents of &%data%& are expanded, and then used as the
20321 list of forwarding items, or as a set of filtering instructions. If the
20322 expansion is forced to fail, or the result is an empty string or a string that
20323 has no effect (consists entirely of comments), the router declines.
20324
20325 When filtering instructions are used, the string must begin with &"#Exim
20326 filter"&, and all comments in the string, including this initial one, must be
20327 terminated with newline characters. For example:
20328 .code
20329 data = #Exim filter\n\
20330        if $h_to: contains Exim then save $home/mail/exim endif
20331 .endd
20332 If you are reading the data from a database where newlines cannot be included,
20333 you can use the &${sg}$& expansion item to turn the escape string of your
20334 choice into a newline.
20335
20336
20337 .option directory_transport redirect string&!! unset
20338 A &(redirect)& router sets up a direct delivery to a directory when a path name
20339 ending with a slash is specified as a new &"address"&. The transport used is
20340 specified by this option, which, after expansion, must be the name of a
20341 configured transport. This should normally be an &(appendfile)& transport.
20342
20343
20344 .option file redirect string&!! unset
20345 This option specifies the name of a file that contains the redirection data. It
20346 is mutually exclusive with the &%data%& option. The string is expanded before
20347 use; if the expansion is forced to fail, the router declines. Other expansion
20348 failures cause delivery to be deferred. The result of a successful expansion
20349 must be an absolute path. The entire file is read and used as the redirection
20350 data. If the data is an empty string or a string that has no effect (consists
20351 entirely of comments), the router declines.
20352
20353 .cindex "NFS" "checking for file existence"
20354 If the attempt to open the file fails with a &"does not exist"& error, Exim
20355 runs a check on the containing directory,
20356 unless &%ignore_enotdir%& is true (see below).
20357 If the directory does not appear to exist, delivery is deferred. This can
20358 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20359 is a mount problem. If the containing directory does exist, but the file does
20360 not, the router declines.
20361
20362
20363 .option file_transport redirect string&!! unset
20364 .vindex "&$address_file$&"
20365 A &(redirect)& router sets up a direct delivery to a file when a path name not
20366 ending in a slash is specified as a new &"address"&. The transport used is
20367 specified by this option, which, after expansion, must be the name of a
20368 configured transport. This should normally be an &(appendfile)& transport. When
20369 it is running, the file name is in &$address_file$&.
20370
20371
20372 .option filter_prepend_home redirect boolean true
20373 When this option is true, if a &(save)& command in an Exim filter specifies a
20374 relative path, and &$home$& is defined, it is automatically prepended to the
20375 relative path. If this option is set false, this action does not happen. The
20376 relative path is then passed to the transport unmodified.
20377
20378
20379 .option forbid_blackhole redirect boolean false
20380 .cindex "restricting access to features"
20381 .cindex "filter" "locking out certain features"
20382 If this option is true, the &':blackhole:'& item may not appear in a
20383 redirection list.
20384
20385
20386 .option forbid_exim_filter redirect boolean false
20387 .cindex "restricting access to features"
20388 .cindex "filter" "locking out certain features"
20389 If this option is set true, only Sieve filters are permitted when
20390 &%allow_filter%& is true.
20391
20392
20393
20394
20395 .option forbid_file redirect boolean false
20396 .cindex "restricting access to features"
20397 .cindex "delivery" "to file; forbidding"
20398 .cindex "filter" "locking out certain features"
20399 .cindex "Sieve filter" "forbidding delivery to a file"
20400 .cindex "Sieve filter" "&""keep""& facility; disabling"
20401 If this option is true, this router may not generate a new address that
20402 specifies delivery to a local file or directory, either from a filter or from a
20403 conventional forward file. This option is forced to be true if &%one_time%& is
20404 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20405 locks out the Sieve's &"keep"& facility.
20406
20407
20408 .option forbid_filter_dlfunc redirect boolean false
20409 .cindex "restricting access to features"
20410 .cindex "filter" "locking out certain features"
20411 If this option is true, string expansions in Exim filters are not allowed to
20412 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20413 functions.
20414
20415 .option forbid_filter_existstest redirect boolean false
20416 .cindex "restricting access to features"
20417 .cindex "filter" "locking out certain features"
20418 .cindex "expansion" "statting a file"
20419 If this option is true, string expansions in Exim filters are not allowed to
20420 make use of the &%exists%& condition or the &%stat%& expansion item.
20421
20422 .option forbid_filter_logwrite redirect boolean false
20423 .cindex "restricting access to features"
20424 .cindex "filter" "locking out certain features"
20425 If this option is true, use of the logging facility in Exim filters is not
20426 permitted. Logging is in any case available only if the filter is being run
20427 under some unprivileged uid (which is normally the case for ordinary users'
20428 &_.forward_& files).
20429
20430
20431 .option forbid_filter_lookup redirect boolean false
20432 .cindex "restricting access to features"
20433 .cindex "filter" "locking out certain features"
20434 If this option is true, string expansions in Exim filter files are not allowed
20435 to make use of &%lookup%& items.
20436
20437
20438 .option forbid_filter_perl redirect boolean false
20439 .cindex "restricting access to features"
20440 .cindex "filter" "locking out certain features"
20441 This option has an effect only if Exim is built with embedded Perl support. If
20442 it is true, string expansions in Exim filter files are not allowed to make use
20443 of the embedded Perl support.
20444
20445
20446 .option forbid_filter_readfile redirect boolean false
20447 .cindex "restricting access to features"
20448 .cindex "filter" "locking out certain features"
20449 If this option is true, string expansions in Exim filter files are not allowed
20450 to make use of &%readfile%& items.
20451
20452
20453 .option forbid_filter_readsocket redirect boolean false
20454 .cindex "restricting access to features"
20455 .cindex "filter" "locking out certain features"
20456 If this option is true, string expansions in Exim filter files are not allowed
20457 to make use of &%readsocket%& items.
20458
20459
20460 .option forbid_filter_reply redirect boolean false
20461 .cindex "restricting access to features"
20462 .cindex "filter" "locking out certain features"
20463 If this option is true, this router may not generate an automatic reply
20464 message. Automatic replies can be generated only from Exim or Sieve filter
20465 files, not from traditional forward files. This option is forced to be true if
20466 &%one_time%& is set.
20467
20468
20469 .option forbid_filter_run redirect boolean false
20470 .cindex "restricting access to features"
20471 .cindex "filter" "locking out certain features"
20472 If this option is true, string expansions in Exim filter files are not allowed
20473 to make use of &%run%& items.
20474
20475
20476 .option forbid_include redirect boolean false
20477 .cindex "restricting access to features"
20478 .cindex "filter" "locking out certain features"
20479 If this option is true, items of the form
20480 .code
20481 :include:<path name>
20482 .endd
20483 are not permitted in non-filter redirection lists.
20484
20485
20486 .option forbid_pipe redirect boolean false
20487 .cindex "restricting access to features"
20488 .cindex "filter" "locking out certain features"
20489 .cindex "delivery" "to pipe; forbidding"
20490 If this option is true, this router may not generate a new address which
20491 specifies delivery to a pipe, either from an Exim filter or from a conventional
20492 forward file. This option is forced to be true if &%one_time%& is set.
20493
20494
20495 .option forbid_sieve_filter redirect boolean false
20496 .cindex "restricting access to features"
20497 .cindex "filter" "locking out certain features"
20498 If this option is set true, only Exim filters are permitted when
20499 &%allow_filter%& is true.
20500
20501
20502 .cindex "SMTP" "error codes"
20503 .option forbid_smtp_code redirect boolean false
20504 If this option is set true, any SMTP error codes that are present at the start
20505 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20506 the default codes (451 and 550, respectively) are always used.
20507
20508
20509
20510
20511 .option hide_child_in_errmsg redirect boolean false
20512 .cindex "bounce message" "redirection details; suppressing"
20513 If this option is true, it prevents Exim from quoting a child address if it
20514 generates a bounce or delay message for it. Instead it says &"an address
20515 generated from <&'the top level address'&>"&. Of course, this applies only to
20516 bounces generated locally. If a message is forwarded to another host, &'its'&
20517 bounce may well quote the generated address.
20518
20519
20520 .option ignore_eacces redirect boolean false
20521 .cindex "EACCES"
20522 If this option is set and an attempt to open a redirection file yields the
20523 EACCES error (permission denied), the &(redirect)& router behaves as if the
20524 file did not exist.
20525
20526
20527 .option ignore_enotdir redirect boolean false
20528 .cindex "ENOTDIR"
20529 If this option is set and an attempt to open a redirection file yields the
20530 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20531 router behaves as if the file did not exist.
20532
20533 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20534 router that has the &%file%& option set discovers that the file does not exist
20535 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20536 against unmounted NFS directories. If the parent can not be statted, delivery
20537 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20538 is set, because that option tells Exim to ignore &"something on the path is not
20539 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20540 that some operating systems give ENOENT where others give ENOTDIR.
20541
20542
20543
20544 .option include_directory redirect string unset
20545 If this option is set, the path names of any &':include:'& items in a
20546 redirection list must start with this directory.
20547
20548
20549 .option modemask redirect "octal integer" 022
20550 This specifies mode bits which must not be set for a file specified by the
20551 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20552
20553
20554 .option one_time redirect boolean false
20555 .cindex "one-time aliasing/forwarding expansion"
20556 .cindex "alias file" "one-time expansion"
20557 .cindex "forward file" "one-time expansion"
20558 .cindex "mailing lists" "one-time expansion"
20559 .cindex "address redirection" "one-time expansion"
20560 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20561 files each time it tries to deliver a message causes a problem when one or more
20562 of the generated addresses fails be delivered at the first attempt. The problem
20563 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20564 but of what happens when the redirection list changes during the time that the
20565 message is on Exim's queue. This is particularly true in the case of mailing
20566 lists, where new subscribers might receive copies of messages that were posted
20567 before they subscribed.
20568
20569 If &%one_time%& is set and any addresses generated by the router fail to
20570 deliver at the first attempt, the failing addresses are added to the message as
20571 &"top level"& addresses, and the parent address that generated them is marked
20572 &"delivered"&. Thus, redirection does not happen again at the next delivery
20573 attempt.
20574
20575 &*Warning 1*&: Any header line addition or removal that is specified by this
20576 router would be lost if delivery did not succeed at the first attempt. For this
20577 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20578 permitted when &%one_time%& is set.
20579
20580 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20581 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20582 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20583
20584 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20585 &%one_time%&.
20586
20587 The original top-level address is remembered with each of the generated
20588 addresses, and is output in any log messages. However, any intermediate parent
20589 addresses are not recorded. This makes a difference to the log only if
20590 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20591 typically be used for mailing lists, where there is normally just one level of
20592 expansion.
20593
20594
20595 .option owners redirect "string list" unset
20596 .cindex "ownership" "alias file"
20597 .cindex "ownership" "forward file"
20598 .cindex "alias file" "ownership"
20599 .cindex "forward file" "ownership"
20600 This specifies a list of permitted owners for the file specified by &%file%&.
20601 This list is in addition to the local user when &%check_local_user%& is set.
20602 See &%check_owner%& above.
20603
20604
20605 .option owngroups redirect "string list" unset
20606 This specifies a list of permitted groups for the file specified by &%file%&.
20607 The list is in addition to the local user's primary group when
20608 &%check_local_user%& is set. See &%check_group%& above.
20609
20610
20611 .option pipe_transport redirect string&!! unset
20612 .vindex "&$address_pipe$&"
20613 A &(redirect)& router sets up a direct delivery to a pipe when a string
20614 starting with a vertical bar character is specified as a new &"address"&. The
20615 transport used is specified by this option, which, after expansion, must be the
20616 name of a configured transport. This should normally be a &(pipe)& transport.
20617 When the transport is run, the pipe command is in &$address_pipe$&.
20618
20619
20620 .option qualify_domain redirect string&!! unset
20621 .vindex "&$qualify_recipient$&"
20622 If this option is set, and an unqualified address (one without a domain) is
20623 generated, and that address would normally be qualified by the global setting
20624 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20625 expanding this string. If the expansion fails, the router declines. If you want
20626 to revert to the default, you can have the expansion generate
20627 &$qualify_recipient$&.
20628
20629 This option applies to all unqualified addresses generated by Exim filters,
20630 but for traditional &_.forward_& files, it applies only to addresses that are
20631 not preceded by a backslash. Sieve filters cannot generate unqualified
20632 addresses.
20633
20634 .option qualify_preserve_domain redirect boolean false
20635 .cindex "domain" "in redirection; preserving"
20636 .cindex "preserving domain in redirection"
20637 .cindex "address redirection" "domain; preserving"
20638 If this option is set, the router's local &%qualify_domain%& option must not be
20639 set (a configuration error occurs if it is). If an unqualified address (one
20640 without a domain) is generated, it is qualified with the domain of the parent
20641 address (the immediately preceding ancestor) instead of the global
20642 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20643 this applies whether or not the address is preceded by a backslash.
20644
20645
20646 .option repeat_use redirect boolean true
20647 If this option is set false, the router is skipped for a child address that has
20648 any ancestor that was routed by this router. This test happens before any of
20649 the other preconditions are tested. Exim's default anti-looping rules skip
20650 only when the ancestor is the same as the current address. See also
20651 &%check_ancestor%& above and the generic &%redirect_router%& option.
20652
20653
20654 .option reply_transport redirect string&!! unset
20655 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20656 &%vacation%& command is used in a filter file. The transport used is specified
20657 by this option, which, after expansion, must be the name of a configured
20658 transport. This should normally be an &(autoreply)& transport. Other transports
20659 are unlikely to do anything sensible or useful.
20660
20661
20662 .option rewrite redirect boolean true
20663 .cindex "address redirection" "disabling rewriting"
20664 If this option is set false, addresses generated by the router are not
20665 subject to address rewriting. Otherwise, they are treated like new addresses
20666 and are rewritten according to the global rewriting rules.
20667
20668
20669 .option sieve_subaddress redirect string&!! unset
20670 The value of this option is passed to a Sieve filter to specify the
20671 :subaddress part of an address.
20672
20673 .option sieve_useraddress redirect string&!! unset
20674 The value of this option is passed to a Sieve filter to specify the :user part
20675 of an address. However, if it is unset, the entire original local part
20676 (including any prefix or suffix) is used for :user.
20677
20678
20679 .option sieve_vacation_directory redirect string&!! unset
20680 .cindex "Sieve filter" "vacation directory"
20681 To enable the &"vacation"& extension for Sieve filters, you must set
20682 &%sieve_vacation_directory%& to the directory where vacation databases are held
20683 (do not put anything else in that directory), and ensure that the
20684 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20685 needs their own directory; Exim will create it if necessary.
20686
20687
20688
20689 .option skip_syntax_errors redirect boolean false
20690 .cindex "forward file" "broken"
20691 .cindex "address redirection" "broken files"
20692 .cindex "alias file" "broken"
20693 .cindex "broken alias or forward files"
20694 .cindex "ignoring faulty addresses"
20695 .cindex "skipping faulty addresses"
20696 .cindex "error" "skipping bad syntax"
20697 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20698 non-filter redirection data are skipped, and each failing address is logged. If
20699 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20700 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20701 are expanded and placed at the head of the error message generated by
20702 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20703 be the same address as the generic &%errors_to%& option. The
20704 &%skip_syntax_errors%& option is often used when handling mailing lists.
20705
20706 If all the addresses in a redirection list are skipped because of syntax
20707 errors, the router declines to handle the original address, and it is passed to
20708 the following routers.
20709
20710 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20711 error in the filter causes filtering to be abandoned without any action being
20712 taken. The incident is logged, and the router declines to handle the address,
20713 so it is passed to the following routers.
20714
20715 .cindex "Sieve filter" "syntax errors in"
20716 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20717 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20718 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20719
20720 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20721 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20722 option, used with an address that does not get redirected, can be used to
20723 notify users of these errors, by means of a router like this:
20724 .code
20725 userforward:
20726   driver = redirect
20727   allow_filter
20728   check_local_user
20729   file = $home/.forward
20730   file_transport = address_file
20731   pipe_transport = address_pipe
20732   reply_transport = address_reply
20733   no_verify
20734   skip_syntax_errors
20735   syntax_errors_to = real-$local_part@$domain
20736   syntax_errors_text = \
20737    This is an automatically generated message. An error has\n\
20738    been found in your .forward file. Details of the error are\n\
20739    reported below. While this error persists, you will receive\n\
20740    a copy of this message for every message that is addressed\n\
20741    to you. If your .forward file is a filter file, or if it is\n\
20742    a non-filter file containing no valid forwarding addresses,\n\
20743    a copy of each incoming message will be put in your normal\n\
20744    mailbox. If a non-filter file contains at least one valid\n\
20745    forwarding address, forwarding to the valid addresses will\n\
20746    happen, and those will be the only deliveries that occur.
20747 .endd
20748 You also need a router to ensure that local addresses that are prefixed by
20749 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20750 put this immediately before the &(userforward)& router:
20751 .code
20752 real_localuser:
20753   driver = accept
20754   check_local_user
20755   local_part_prefix = real-
20756   transport = local_delivery
20757 .endd
20758 For security, it would probably be a good idea to restrict the use of this
20759 router to locally-generated messages, using a condition such as this:
20760 .code
20761   condition = ${if match {$sender_host_address}\
20762                          {\N^(|127\.0\.0\.1)$\N}}
20763 .endd
20764
20765
20766 .option syntax_errors_text redirect string&!! unset
20767 See &%skip_syntax_errors%& above.
20768
20769
20770 .option syntax_errors_to redirect string unset
20771 See &%skip_syntax_errors%& above.
20772 .ecindex IIDredrou1
20773 .ecindex IIDredrou2
20774
20775
20776
20777
20778
20779
20780 . ////////////////////////////////////////////////////////////////////////////
20781 . ////////////////////////////////////////////////////////////////////////////
20782
20783 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20784          "Environment for local transports"
20785 .scindex IIDenvlotra1 "local transports" "environment for"
20786 .scindex IIDenvlotra2 "environment" "local transports"
20787 .scindex IIDenvlotra3 "transport" "local; environment for"
20788 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20789 transport can be thought of as similar to a pipe.) Exim always runs transports
20790 in subprocesses, under specified uids and gids. Typical deliveries to local
20791 mailboxes run under the uid and gid of the local user.
20792
20793 Exim also sets a specific current directory while running the transport; for
20794 some transports a home directory setting is also relevant. The &(pipe)&
20795 transport is the only one that sets up environment variables; see section
20796 &<<SECTpipeenv>>& for details.
20797
20798 The values used for the uid, gid, and the directories may come from several
20799 different places. In many cases, the router that handles the address associates
20800 settings with that address as a result of its &%check_local_user%&, &%group%&,
20801 or &%user%& options. However, values may also be given in the transport's own
20802 configuration, and these override anything that comes from the router.
20803
20804
20805
20806 .section "Concurrent deliveries" "SECID131"
20807 .cindex "concurrent deliveries"
20808 .cindex "simultaneous deliveries"
20809 If two different messages for the same local recipient arrive more or less
20810 simultaneously, the two delivery processes are likely to run concurrently. When
20811 the &(appendfile)& transport is used to write to a file, Exim applies locking
20812 rules to stop concurrent processes from writing to the same file at the same
20813 time.
20814
20815 However, when you use a &(pipe)& transport, it is up to you to arrange any
20816 locking that is needed. Here is a silly example:
20817 .code
20818 my_transport:
20819   driver = pipe
20820   command = /bin/sh -c 'cat >>/some/file'
20821 .endd
20822 This is supposed to write the message at the end of the file. However, if two
20823 messages arrive at the same time, the file will be scrambled. You can use the
20824 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20825 file using the same algorithm that Exim itself uses.
20826
20827
20828
20829
20830 .section "Uids and gids" "SECTenvuidgid"
20831 .cindex "local transports" "uid and gid"
20832 .cindex "transport" "local; uid and gid"
20833 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20834 overrides any group that the router set in the address, even if &%user%& is not
20835 set for the transport. This makes it possible, for example, to run local mail
20836 delivery under the uid of the recipient (set by the router), but in a special
20837 group (set by the transport). For example:
20838 .code
20839 # Routers ...
20840 # User/group are set by check_local_user in this router
20841 local_users:
20842   driver = accept
20843   check_local_user
20844   transport = group_delivery
20845
20846 # Transports ...
20847 # This transport overrides the group
20848 group_delivery:
20849   driver = appendfile
20850   file = /var/spool/mail/$local_part
20851   group = mail
20852 .endd
20853 If &%user%& is set for a transport, its value overrides what is set in the
20854 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20855 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20856 set.
20857
20858 .oindex "&%initgroups%&"
20859 When the uid is taken from the transport's configuration, the &[initgroups()]&
20860 function is called for the groups associated with that uid if the
20861 &%initgroups%& option is set for the transport. When the uid is not specified
20862 by the transport, but is associated with the address by a router, the option
20863 for calling &[initgroups()]& is taken from the router configuration.
20864
20865 .cindex "&(pipe)& transport" "uid for"
20866 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20867 is set and &%user%& is not set, the uid of the process that called Exim to
20868 receive the message is used, and if &%group%& is not set, the corresponding
20869 original gid is also used.
20870
20871 This is the detailed preference order for obtaining a gid; the first of the
20872 following that is set is used:
20873
20874 .ilist
20875 A &%group%& setting of the transport;
20876 .next
20877 A &%group%& setting of the router;
20878 .next
20879 A gid associated with a user setting of the router, either as a result of
20880 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20881 .next
20882 The group associated with a non-numeric &%user%& setting of the transport;
20883 .next
20884 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20885 the uid is the creator's uid;
20886 .next
20887 The Exim gid if the Exim uid is being used as a default.
20888 .endlist
20889
20890 If, for example, the user is specified numerically on the router and there are
20891 no group settings, no gid is available. In this situation, an error occurs.
20892 This is different for the uid, for which there always is an ultimate default.
20893 The first of the following that is set is used:
20894
20895 .ilist
20896 A &%user%& setting of the transport;
20897 .next
20898 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20899 .next
20900 A &%user%& setting of the router;
20901 .next
20902 A &%check_local_user%& setting of the router;
20903 .next
20904 The Exim uid.
20905 .endlist
20906
20907 Of course, an error will still occur if the uid that is chosen is on the
20908 &%never_users%& list.
20909
20910
20911
20912
20913
20914 .section "Current and home directories" "SECID132"
20915 .cindex "current directory for local transport"
20916 .cindex "home directory" "for local transport"
20917 .cindex "transport" "local; home directory for"
20918 .cindex "transport" "local; current directory for"
20919 Routers may set current and home directories for local transports by means of
20920 the &%transport_current_directory%& and &%transport_home_directory%& options.
20921 However, if the transport's &%current_directory%& or &%home_directory%& options
20922 are set, they override the router's values. In detail, the home directory
20923 for a local transport is taken from the first of these values that is set:
20924
20925 .ilist
20926 The &%home_directory%& option on the transport;
20927 .next
20928 The &%transport_home_directory%& option on the router;
20929 .next
20930 The password data if &%check_local_user%& is set on the router;
20931 .next
20932 The &%router_home_directory%& option on the router.
20933 .endlist
20934
20935 The current directory is taken from the first of these values that is set:
20936
20937 .ilist
20938 The &%current_directory%& option on the transport;
20939 .next
20940 The &%transport_current_directory%& option on the router.
20941 .endlist
20942
20943
20944 If neither the router nor the transport sets a current directory, Exim uses the
20945 value of the home directory, if it is set. Otherwise it sets the current
20946 directory to &_/_& before running a local transport.
20947
20948
20949
20950 .section "Expansion variables derived from the address" "SECID133"
20951 .vindex "&$domain$&"
20952 .vindex "&$local_part$&"
20953 .vindex "&$original_domain$&"
20954 Normally a local delivery is handling a single address, and in that case the
20955 variables such as &$domain$& and &$local_part$& are set during local
20956 deliveries. However, in some circumstances more than one address may be handled
20957 at once (for example, while writing batch SMTP for onward transmission by some
20958 other means). In this case, the variables associated with the local part are
20959 never set, &$domain$& is set only if all the addresses have the same domain,
20960 and &$original_domain$& is never set.
20961 .ecindex IIDenvlotra1
20962 .ecindex IIDenvlotra2
20963 .ecindex IIDenvlotra3
20964
20965
20966
20967
20968
20969
20970
20971 . ////////////////////////////////////////////////////////////////////////////
20972 . ////////////////////////////////////////////////////////////////////////////
20973
20974 .chapter "Generic options for transports" "CHAPtransportgeneric"
20975 .scindex IIDgenoptra1 "generic options" "transport"
20976 .scindex IIDgenoptra2 "options" "generic; for transports"
20977 .scindex IIDgenoptra3 "transport" "generic options for"
20978 The following generic options apply to all transports:
20979
20980
20981 .option body_only transports boolean false
20982 .cindex "transport" "body only"
20983 .cindex "message" "transporting body only"
20984 .cindex "body of message" "transporting"
20985 If this option is set, the message's headers are not transported. It is
20986 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20987 or &(pipe)& transports, the settings of &%message_prefix%& and
20988 &%message_suffix%& should be checked, because this option does not
20989 automatically suppress them.
20990
20991
20992 .option current_directory transports string&!! unset
20993 .cindex "transport" "current directory for"
20994 This specifies the current directory that is to be set while running the
20995 transport, overriding any value that may have been set by the router.
20996 If the expansion fails for any reason, including forced failure, an error is
20997 logged, and delivery is deferred.
20998
20999
21000 .option disable_logging transports boolean false
21001 If this option is set true, nothing is logged for any
21002 deliveries by the transport or for any
21003 transport errors. You should not set this option unless you really, really know
21004 what you are doing.
21005
21006
21007 .option debug_print transports string&!! unset
21008 .cindex "testing" "variables in drivers"
21009 If this option is set and debugging is enabled (see the &%-d%& command line
21010 option), the string is expanded and included in the debugging output when the
21011 transport is run.
21012 If expansion of the string fails, the error message is written to the debugging
21013 output, and Exim carries on processing.
21014 This facility is provided to help with checking out the values of variables and
21015 so on when debugging driver configurations. For example, if a &%headers_add%&
21016 option is not working properly, &%debug_print%& could be used to output the
21017 variables it references. A newline is added to the text if it does not end with
21018 one.
21019 The variables &$transport_name$& and &$router_name$& contain the name of the
21020 transport and the router that called it.
21021
21022 .option delivery_date_add transports boolean false
21023 .cindex "&'Delivery-date:'& header line"
21024 If this option is true, a &'Delivery-date:'& header is added to the message.
21025 This gives the actual time the delivery was made. As this is not a standard
21026 header, Exim has a configuration option (&%delivery_date_remove%&) which
21027 requests its removal from incoming messages, so that delivered messages can
21028 safely be resent to other recipients.
21029
21030
21031 .option driver transports string unset
21032 This specifies which of the available transport drivers is to be used.
21033 There is no default, and this option must be set for every transport.
21034
21035
21036 .option envelope_to_add transports boolean false
21037 .cindex "&'Envelope-to:'& header line"
21038 If this option is true, an &'Envelope-to:'& header is added to the message.
21039 This gives the original address(es) in the incoming envelope that caused this
21040 delivery to happen. More than one address may be present if the transport is
21041 configured to handle several addresses at once, or if more than one original
21042 address was redirected to the same final address. As this is not a standard
21043 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21044 its removal from incoming messages, so that delivered messages can safely be
21045 resent to other recipients.
21046
21047
21048 .option event_action transports string&!! unset
21049 .cindex events
21050 This option declares a string to be expanded for Exim's events mechanism.
21051 For details see chapter &<<CHAPevents>>&.
21052
21053
21054 .option group transports string&!! "Exim group"
21055 .cindex "transport" "group; specifying"
21056 This option specifies a gid for running the transport process, overriding any
21057 value that the router supplies, and also overriding any value associated with
21058 &%user%& (see below).
21059
21060
21061 .option headers_add transports list&!! unset
21062 .cindex "header lines" "adding in transport"
21063 .cindex "transport" "header lines; adding"
21064 This option specifies a list of text headers,
21065 newline-separated (by default, changeable in the usual way),
21066 which are (separately) expanded and added to the header
21067 portion of a message as it is transported, as described in section
21068 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21069 routers. If the result of the expansion is an empty string, or if the expansion
21070 is forced to fail, no action is taken. Other expansion failures are treated as
21071 errors and cause the delivery to be deferred.
21072
21073 Unlike most options, &%headers_add%& can be specified multiple times
21074 for a transport; all listed headers are added.
21075
21076
21077 .option headers_only transports boolean false
21078 .cindex "transport" "header lines only"
21079 .cindex "message" "transporting headers only"
21080 .cindex "header lines" "transporting"
21081 If this option is set, the message's body is not transported. It is mutually
21082 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21083 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21084 checked, since this option does not automatically suppress them.
21085
21086
21087 .option headers_remove transports list&!! unset
21088 .cindex "header lines" "removing"
21089 .cindex "transport" "header lines; removing"
21090 This option specifies a list of header names,
21091 colon-separated (by default, changeable in the usual way);
21092 these headers are omitted from the message as it is transported, as described
21093 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21094 routers.
21095 Each list item is separately expanded.
21096 If the result of the expansion is an empty string, or if the expansion
21097 is forced to fail, no action is taken. Other expansion failures are treated as
21098 errors and cause the delivery to be deferred.
21099
21100 Unlike most options, &%headers_remove%& can be specified multiple times
21101 for a transport; all listed headers are removed.
21102
21103 &*Warning*&: Because of the separate expansion of the list items,
21104 items that contain a list separator must have it doubled.
21105 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21106
21107
21108
21109 .option headers_rewrite transports string unset
21110 .cindex "transport" "header lines; rewriting"
21111 .cindex "rewriting" "at transport time"
21112 This option allows addresses in header lines to be rewritten at transport time,
21113 that is, as the message is being copied to its destination. The contents of the
21114 option are a colon-separated list of rewriting rules. Each rule is in exactly
21115 the same form as one of the general rewriting rules that are applied when a
21116 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21117 example,
21118 .code
21119 headers_rewrite = a@b c@d f : \
21120                   x@y w@z
21121 .endd
21122 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21123 &'w@z'& in all address-bearing header lines. The rules are applied to the
21124 header lines just before they are written out at transport time, so they affect
21125 only those copies of the message that pass through the transport. However, only
21126 the message's original header lines, and any that were added by a system
21127 filter, are rewritten. If a router or transport adds header lines, they are not
21128 affected by this option. These rewriting rules are &'not'& applied to the
21129 envelope. You can change the return path using &%return_path%&, but you cannot
21130 change envelope recipients at this time.
21131
21132
21133 .option home_directory transports string&!! unset
21134 .cindex "transport" "home directory for"
21135 .vindex "&$home$&"
21136 This option specifies a home directory setting for a local transport,
21137 overriding any value that may be set by the router. The home directory is
21138 placed in &$home$& while expanding the transport's private options. It is also
21139 used as the current directory if no current directory is set by the
21140 &%current_directory%& option on the transport or the
21141 &%transport_current_directory%& option on the router. If the expansion fails
21142 for any reason, including forced failure, an error is logged, and delivery is
21143 deferred.
21144
21145
21146 .option initgroups transports boolean false
21147 .cindex "additional groups"
21148 .cindex "groups" "additional"
21149 .cindex "transport" "group; additional"
21150 If this option is true and the uid for the delivery process is provided by the
21151 transport, the &[initgroups()]& function is called when running the transport
21152 to ensure that any additional groups associated with the uid are set up.
21153
21154
21155 .option max_parallel transports integer&!! unset
21156 .cindex limit "transport parallelism"
21157 .cindex transport "parallel processes"
21158 .cindex transport "concurrency limit"
21159 .cindex "delivery" "parallelism for transport"
21160 If this option is set and expands to an integer greater than zero
21161 it limits the number of concurrent runs of the transport.
21162 The control does not apply to shadow transports.
21163
21164 .cindex "hints database" "transport concurrency control"
21165 Exim implements this control by means of a hints database in which a record is
21166 incremented whenever a transport process is being created. The record
21167 is decremented and possibly removed when the process terminates.
21168 Obviously there is scope for
21169 records to get left lying around if there is a system or program crash. To
21170 guard against this, Exim ignores any records that are more than six hours old.
21171
21172 If you use this option, you should also arrange to delete the
21173 relevant hints database whenever your system reboots. The names of the files
21174 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21175 may be one or two files, depending on the type of DBM in use. The same files
21176 are used for ETRN and smtp transport serialization.
21177
21178
21179 .option message_size_limit transports string&!! 0
21180 .cindex "limit" "message size per transport"
21181 .cindex "size" "of message, limit"
21182 .cindex "transport" "message size; limiting"
21183 This option controls the size of messages passed through the transport. It is
21184 expanded before use; the result of the expansion must be a sequence of decimal
21185 digits, optionally followed by K or M. If the expansion fails for any reason,
21186 including forced failure, or if the result is not of the required form,
21187 delivery is deferred. If the value is greater than zero and the size of a
21188 message exceeds this limit, the address is failed. If there is any chance that
21189 the resulting bounce message could be routed to the same transport, you should
21190 ensure that &%return_size_limit%& is less than the transport's
21191 &%message_size_limit%&, as otherwise the bounce message will fail to get
21192 delivered.
21193
21194
21195
21196 .option rcpt_include_affixes transports boolean false
21197 .cindex "prefix" "for local part, including in envelope"
21198 .cindex "suffix for local part" "including in envelope"
21199 .cindex "local part" "prefix"
21200 .cindex "local part" "suffix"
21201 When this option is false (the default), and an address that has had any
21202 affixes (prefixes or suffixes) removed from the local part is delivered by any
21203 form of SMTP or LMTP, the affixes are not included. For example, if a router
21204 that contains
21205 .code
21206 local_part_prefix = *-
21207 .endd
21208 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21209 is delivered with
21210 .code
21211 RCPT TO:<xyz@some.domain>
21212 .endd
21213 This is also the case when an ACL-time callout is being used to verify a
21214 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21215 whole local part is included in the RCPT command. This option applies to BSMTP
21216 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21217 &(lmtp)& and &(smtp)& transports.
21218
21219
21220 .option retry_use_local_part transports boolean "see below"
21221 .cindex "hints database" "retry keys"
21222 When a delivery suffers a temporary failure, a retry record is created
21223 in Exim's hints database. For remote deliveries, the key for the retry record
21224 is based on the name and/or IP address of the failing remote host. For local
21225 deliveries, the key is normally the entire address, including both the local
21226 part and the domain. This is suitable for most common cases of local delivery
21227 temporary failure &-- for example, exceeding a mailbox quota should delay only
21228 deliveries to that mailbox, not to the whole domain.
21229
21230 However, in some special cases you may want to treat a temporary local delivery
21231 as a failure associated with the domain, and not with a particular local part.
21232 (For example, if you are storing all mail for some domain in files.) You can do
21233 this by setting &%retry_use_local_part%& false.
21234
21235 For all the local transports, its default value is true. For remote transports,
21236 the default value is false for tidiness, but changing the value has no effect
21237 on a remote transport in the current implementation.
21238
21239
21240 .option return_path transports string&!! unset
21241 .cindex "envelope sender"
21242 .cindex "transport" "return path; changing"
21243 .cindex "return path" "changing in transport"
21244 If this option is set, the string is expanded at transport time and replaces
21245 the existing return path (envelope sender) value in the copy of the message
21246 that is being delivered. An empty return path is permitted. This feature is
21247 designed for remote deliveries, where the value of this option is used in the
21248 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21249 only effect is to change the address that is placed in the &'Return-path:'&
21250 header line, if one is added to the message (see the next option).
21251
21252 &*Note:*& A changed return path is not logged unless you add
21253 &%return_path_on_delivery%& to the log selector.
21254
21255 .vindex "&$return_path$&"
21256 The expansion can refer to the existing value via &$return_path$&. This is
21257 either the message's envelope sender, or an address set by the
21258 &%errors_to%& option on a router. If the expansion is forced to fail, no
21259 replacement occurs; if it fails for another reason, delivery is deferred. This
21260 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21261 section &<<SECTverp>>&.
21262
21263 &*Note*&: If a delivery error is detected locally, including the case when a
21264 remote server rejects a message at SMTP time, the bounce message is not sent to
21265 the value of this option. It is sent to the previously set errors address.
21266 This defaults to the incoming sender address, but can be changed by setting
21267 &%errors_to%& in a router.
21268
21269
21270
21271 .option return_path_add transports boolean false
21272 .cindex "&'Return-path:'& header line"
21273 If this option is true, a &'Return-path:'& header is added to the message.
21274 Although the return path is normally available in the prefix line of BSD
21275 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21276 have easy access to it.
21277
21278 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21279 the delivery SMTP server makes the final delivery"&. This implies that this
21280 header should not be present in incoming messages. Exim has a configuration
21281 option, &%return_path_remove%&, which requests removal of this header from
21282 incoming messages, so that delivered messages can safely be resent to other
21283 recipients.
21284
21285
21286 .option shadow_condition transports string&!! unset
21287 See &%shadow_transport%& below.
21288
21289
21290 .option shadow_transport transports string unset
21291 .cindex "shadow transport"
21292 .cindex "transport" "shadow"
21293 A local transport may set the &%shadow_transport%& option to the name of
21294 another local transport. Shadow remote transports are not supported.
21295
21296 Whenever a delivery to the main transport succeeds, and either
21297 &%shadow_condition%& is unset, or its expansion does not result in the empty
21298 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21299 passed to the shadow transport, with the same delivery address or addresses. If
21300 expansion fails, no action is taken except that non-forced expansion failures
21301 cause a log line to be written.
21302
21303 The result of the shadow transport is discarded and does not affect the
21304 subsequent processing of the message. Only a single level of shadowing is
21305 provided; the &%shadow_transport%& option is ignored on any transport when it
21306 is running as a shadow. Options concerned with output from pipes are also
21307 ignored. The log line for the successful delivery has an item added on the end,
21308 of the form
21309 .code
21310 ST=<shadow transport name>
21311 .endd
21312 If the shadow transport did not succeed, the error message is put in
21313 parentheses afterwards. Shadow transports can be used for a number of different
21314 purposes, including keeping more detailed log information than Exim normally
21315 provides, and implementing automatic acknowledgment policies based on message
21316 headers that some sites insist on.
21317
21318
21319 .option transport_filter transports string&!! unset
21320 .cindex "transport" "filter"
21321 .cindex "filter" "transport filter"
21322 This option sets up a filtering (in the Unix shell sense) process for messages
21323 at transport time. It should not be confused with mail filtering as set up by
21324 individual users or via a system filter.
21325 If unset, or expanding to an empty string, no filtering is done.
21326
21327 When the message is about to be written out, the command specified by
21328 &%transport_filter%& is started up in a separate, parallel process, and
21329 the entire message, including the header lines, is passed to it on its standard
21330 input (this in fact is done from a third process, to avoid deadlock). The
21331 command must be specified as an absolute path.
21332
21333 The lines of the message that are written to the transport filter are
21334 terminated by newline (&"\n"&). The message is passed to the filter before any
21335 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21336 lines beginning with a dot, and also before any processing implied by the
21337 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21338 &(pipe)& transports.
21339
21340 The standard error for the filter process is set to the same destination as its
21341 standard output; this is read and written to the message's ultimate
21342 destination. The process that writes the message to the filter, the
21343 filter itself, and the original process that reads the result and delivers it
21344 are all run in parallel, like a shell pipeline.
21345
21346 The filter can perform any transformations it likes, but of course should take
21347 care not to break RFC 2822 syntax. Exim does not check the result, except to
21348 test for a final newline when SMTP is in use. All messages transmitted over
21349 SMTP must end with a newline, so Exim supplies one if it is missing.
21350
21351 .cindex "content scanning" "per user"
21352 A transport filter can be used to provide content-scanning on a per-user basis
21353 at delivery time if the only required effect of the scan is to modify the
21354 message. For example, a content scan could insert a new header line containing
21355 a spam score. This could be interpreted by a filter in the user's MUA. It is
21356 not possible to discard a message at this stage.
21357
21358 .cindex "SMTP" "SIZE"
21359 A problem might arise if the filter increases the size of a message that is
21360 being sent down an SMTP connection. If the receiving SMTP server has indicated
21361 support for the SIZE parameter, Exim will have sent the size of the message
21362 at the start of the SMTP session. If what is actually sent is substantially
21363 more, the server might reject the message. This can be worked round by setting
21364 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21365 additions to the message, or to disable the use of SIZE altogether.
21366
21367 .vindex "&$pipe_addresses$&"
21368 The value of the &%transport_filter%& option is the command string for starting
21369 the filter, which is run directly from Exim, not under a shell. The string is
21370 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21371 Exim breaks it up into arguments and then expands each argument separately (see
21372 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21373 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21374 of arguments, one for each address that applies to this delivery. (This isn't
21375 an ideal name for this feature here, but as it was already implemented for the
21376 &(pipe)& transport, it seemed sensible not to change it.)
21377
21378 .vindex "&$host$&"
21379 .vindex "&$host_address$&"
21380 The expansion variables &$host$& and &$host_address$& are available when the
21381 transport is a remote one. They contain the name and IP address of the host to
21382 which the message is being sent. For example:
21383 .code
21384 transport_filter = /some/directory/transport-filter.pl \
21385   $host $host_address $sender_address $pipe_addresses
21386 .endd
21387
21388 Two problems arise if you want to use more complicated expansion items to
21389 generate transport filter commands, both of which due to the fact that the
21390 command is split up &'before'& expansion.
21391 .ilist
21392 If an expansion item contains white space, you must quote it, so that it is all
21393 part of the same command item. If the entire option setting is one such
21394 expansion item, you have to take care what kind of quoting you use. For
21395 example:
21396 .code
21397 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21398 .endd
21399 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21400 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21401 stripped by Exim when it read the option's value. When the value is used, if
21402 the single quotes were missing, the line would be split into two items,
21403 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21404 Exim tried to expand the first one.
21405 .next
21406 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21407 expansion cannot generate multiple arguments, or a command name followed by
21408 arguments. Consider this example:
21409 .code
21410 transport_filter = ${lookup{$host}lsearch{/a/file}\
21411                     {$value}{/bin/cat}}
21412 .endd
21413 The result of the lookup is interpreted as the name of the command, even
21414 if it contains white space. The simplest way round this is to use a shell:
21415 .code
21416 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21417                                {$value}{/bin/cat}}
21418 .endd
21419 .endlist
21420
21421 The filter process is run under the same uid and gid as the normal delivery.
21422 For remote deliveries this is the Exim uid/gid by default. The command should
21423 normally yield a zero return code. Transport filters are not supposed to fail.
21424 A non-zero code is taken to mean that the transport filter encountered some
21425 serious problem. Delivery of the message is deferred; the message remains on
21426 the queue and is tried again later. It is not possible to cause a message to be
21427 bounced from a transport filter.
21428
21429 If a transport filter is set on an autoreply transport, the original message is
21430 passed through the filter as it is being copied into the newly generated
21431 message, which happens if the &%return_message%& option is set.
21432
21433
21434 .option transport_filter_timeout transports time 5m
21435 .cindex "transport" "filter, timeout"
21436 When Exim is reading the output of a transport filter, it applies a timeout
21437 that can be set by this option. Exceeding the timeout is normally treated as a
21438 temporary delivery failure. However, if a transport filter is used with a
21439 &(pipe)& transport, a timeout in the transport filter is treated in the same
21440 way as a timeout in the pipe command itself. By default, a timeout is a hard
21441 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21442 becomes a temporary error.
21443
21444
21445 .option user transports string&!! "Exim user"
21446 .cindex "uid (user id)" "local delivery"
21447 .cindex "transport" "user, specifying"
21448 This option specifies the user under whose uid the delivery process is to be
21449 run, overriding any uid that may have been set by the router. If the user is
21450 given as a name, the uid is looked up from the password data, and the
21451 associated group is taken as the value of the gid to be used if the &%group%&
21452 option is not set.
21453
21454 For deliveries that use local transports, a user and group are normally
21455 specified explicitly or implicitly (for example, as a result of
21456 &%check_local_user%&) by the router or transport.
21457
21458 .cindex "hints database" "access by remote transport"
21459 For remote transports, you should leave this option unset unless you really are
21460 sure you know what you are doing. When a remote transport is running, it needs
21461 to be able to access Exim's hints databases, because each host may have its own
21462 retry data.
21463 .ecindex IIDgenoptra1
21464 .ecindex IIDgenoptra2
21465 .ecindex IIDgenoptra3
21466
21467
21468
21469
21470
21471
21472 . ////////////////////////////////////////////////////////////////////////////
21473 . ////////////////////////////////////////////////////////////////////////////
21474
21475 .chapter "Address batching in local transports" "CHAPbatching" &&&
21476          "Address batching"
21477 .cindex "transport" "local; address batching in"
21478 The only remote transport (&(smtp)&) is normally configured to handle more than
21479 one address at a time, so that when several addresses are routed to the same
21480 remote host, just one copy of the message is sent. Local transports, however,
21481 normally handle one address at a time. That is, a separate instance of the
21482 transport is run for each address that is routed to the transport. A separate
21483 copy of the message is delivered each time.
21484
21485 .cindex "batched local delivery"
21486 .oindex "&%batch_max%&"
21487 .oindex "&%batch_id%&"
21488 In special cases, it may be desirable to handle several addresses at once in a
21489 local transport, for example:
21490
21491 .ilist
21492 In an &(appendfile)& transport, when storing messages in files for later
21493 delivery by some other means, a single copy of the message with multiple
21494 recipients saves space.
21495 .next
21496 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21497 a single copy saves time, and is the normal way LMTP is expected to work.
21498 .next
21499 In a &(pipe)& transport, when passing the message
21500 to a scanner program or
21501 to some other delivery mechanism such as UUCP, multiple recipients may be
21502 acceptable.
21503 .endlist
21504
21505 These three local transports all have the same options for controlling multiple
21506 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21507 repeating the information for each transport, these options are described here.
21508
21509 The &%batch_max%& option specifies the maximum number of addresses that can be
21510 delivered together in a single run of the transport. Its default value is one
21511 (no batching). When more than one address is routed to a transport that has a
21512 &%batch_max%& value greater than one, the addresses are delivered in a batch
21513 (that is, in a single run of the transport with multiple recipients), subject
21514 to certain conditions:
21515
21516 .ilist
21517 .vindex "&$local_part$&"
21518 If any of the transport's options contain a reference to &$local_part$&, no
21519 batching is possible.
21520 .next
21521 .vindex "&$domain$&"
21522 If any of the transport's options contain a reference to &$domain$&, only
21523 addresses with the same domain are batched.
21524 .next
21525 .cindex "customizing" "batching condition"
21526 If &%batch_id%& is set, it is expanded for each address, and only those
21527 addresses with the same expanded value are batched. This allows you to specify
21528 customized batching conditions. Failure of the expansion for any reason,
21529 including forced failure, disables batching, but it does not stop the delivery
21530 from taking place.
21531 .next
21532 Batched addresses must also have the same errors address (where to send
21533 delivery errors), the same header additions and removals, the same user and
21534 group for the transport, and if a host list is present, the first host must
21535 be the same.
21536 .endlist
21537
21538 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21539 both when the file or pipe command is specified in the transport, and when it
21540 is specified by a &(redirect)& router, but all the batched addresses must of
21541 course be routed to the same file or pipe command. These two transports have an
21542 option called &%use_bsmtp%&, which causes them to deliver the message in
21543 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21544 &%check_string%& and &%escape_string%& options are forced to the values
21545 .code
21546 check_string = "."
21547 escape_string = ".."
21548 .endd
21549 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21550 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21551 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21552
21553 .cindex "&'Envelope-to:'& header line"
21554 If the generic &%envelope_to_add%& option is set for a batching transport, the
21555 &'Envelope-to:'& header that is added to the message contains all the addresses
21556 that are being processed together. If you are using a batching &(appendfile)&
21557 transport without &%use_bsmtp%&, the only way to preserve the recipient
21558 addresses is to set the &%envelope_to_add%& option.
21559
21560 .cindex "&(pipe)& transport" "with multiple addresses"
21561 .vindex "&$pipe_addresses$&"
21562 If you are using a &(pipe)& transport without BSMTP, and setting the
21563 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21564 the command. This is not a true variable; it is a bit of magic that causes each
21565 of the recipient addresses to be inserted into the command as a separate
21566 argument. This provides a way of accessing all the addresses that are being
21567 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21568 are specified by a &(redirect)& router.
21569
21570
21571
21572
21573 . ////////////////////////////////////////////////////////////////////////////
21574 . ////////////////////////////////////////////////////////////////////////////
21575
21576 .chapter "The appendfile transport" "CHAPappendfile"
21577 .scindex IIDapptra1 "&(appendfile)& transport"
21578 .scindex IIDapptra2 "transports" "&(appendfile)&"
21579 .cindex "directory creation"
21580 .cindex "creating directories"
21581 The &(appendfile)& transport delivers a message by appending it to an existing
21582 file, or by creating an entirely new file in a specified directory. Single
21583 files to which messages are appended can be in the traditional Unix mailbox
21584 format, or optionally in the MBX format supported by the Pine MUA and
21585 University of Washington IMAP daemon, &'inter alia'&. When each message is
21586 being delivered as a separate file, &"maildir"& format can optionally be used
21587 to give added protection against failures that happen part-way through the
21588 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21589 supported. For all file formats, Exim attempts to create as many levels of
21590 directory as necessary, provided that &%create_directory%& is set.
21591
21592 The code for the optional formats is not included in the Exim binary by
21593 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21594 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21595 included.
21596
21597 .cindex "quota" "system"
21598 Exim recognizes system quota errors, and generates an appropriate message. Exim
21599 also supports its own quota control within the transport, for use when the
21600 system facility is unavailable or cannot be used for some reason.
21601
21602 If there is an error while appending to a file (for example, quota exceeded or
21603 partition filled), Exim attempts to reset the file's length and last
21604 modification time back to what they were before. If there is an error while
21605 creating an entirely new file, the new file is removed.
21606
21607 Before appending to a file, a number of security checks are made, and the
21608 file is locked. A detailed description is given below, after the list of
21609 private options.
21610
21611 The &(appendfile)& transport is most commonly used for local deliveries to
21612 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21613 putting messages into files for remote delivery by some means other than Exim.
21614 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21615 option).
21616
21617
21618
21619 .section "The file and directory options" "SECTfildiropt"
21620 The &%file%& option specifies a single file, to which the message is appended;
21621 the &%directory%& option specifies a directory, in which a new file containing
21622 the message is created. Only one of these two options can be set, and for
21623 normal deliveries to mailboxes, one of them &'must'& be set.
21624
21625 .vindex "&$address_file$&"
21626 .vindex "&$local_part$&"
21627 However, &(appendfile)& is also used for delivering messages to files or
21628 directories whose names (or parts of names) are obtained from alias,
21629 forwarding, or filtering operations (for example, a &%save%& command in a
21630 user's Exim filter). When such a transport is running, &$local_part$& contains
21631 the local part that was aliased or forwarded, and &$address_file$& contains the
21632 name (or partial name) of the file or directory generated by the redirection
21633 operation. There are two cases:
21634
21635 .ilist
21636 If neither &%file%& nor &%directory%& is set, the redirection operation
21637 must specify an absolute path (one that begins with &`/`&). This is the most
21638 common case when users with local accounts use filtering to sort mail into
21639 different folders. See for example, the &(address_file)& transport in the
21640 default configuration. If the path ends with a slash, it is assumed to be the
21641 name of a directory. A delivery to a directory can also be forced by setting
21642 &%maildir_format%& or &%mailstore_format%&.
21643 .next
21644 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21645 used to determine the file or directory name for the delivery. Normally, the
21646 contents of &$address_file$& are used in some way in the string expansion.
21647 .endlist
21648
21649
21650 .cindex "Sieve filter" "configuring &(appendfile)&"
21651 .cindex "Sieve filter" "relative mailbox path handling"
21652 As an example of the second case, consider an environment where users do not
21653 have home directories. They may be permitted to use Exim filter commands of the
21654 form:
21655 .code
21656 save folder23
21657 .endd
21658 or Sieve filter commands of the form:
21659 .code
21660 require "fileinto";
21661 fileinto "folder23";
21662 .endd
21663 In this situation, the expansion of &%file%& or &%directory%& in the transport
21664 must transform the relative path into an appropriate absolute file name. In the
21665 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21666 is used as a result of a &"keep"& action in the filter. This example shows one
21667 way of handling this requirement:
21668 .code
21669 file = ${if eq{$address_file}{inbox} \
21670             {/var/mail/$local_part} \
21671             {${if eq{${substr_0_1:$address_file}}{/} \
21672                   {$address_file} \
21673                   {$home/mail/$address_file} \
21674             }} \
21675        }
21676 .endd
21677 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21678 location, absolute paths are used without change, and other folders are in the
21679 &_mail_& directory within the home directory.
21680
21681 &*Note 1*&: While processing an Exim filter, a relative path such as
21682 &_folder23_& is turned into an absolute path if a home directory is known to
21683 the router. In particular, this is the case if &%check_local_user%& is set. If
21684 you want to prevent this happening at routing time, you can set
21685 &%router_home_directory%& empty. This forces the router to pass the relative
21686 path to the transport.
21687
21688 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21689 the &%file%& or &%directory%& option is still used if it is set.
21690
21691
21692
21693
21694 .section "Private options for appendfile" "SECID134"
21695 .cindex "options" "&(appendfile)& transport"
21696
21697
21698
21699 .option allow_fifo appendfile boolean false
21700 .cindex "fifo (named pipe)"
21701 .cindex "named pipe (fifo)"
21702 .cindex "pipe" "named (fifo)"
21703 Setting this option permits delivery to named pipes (FIFOs) as well as to
21704 regular files. If no process is reading the named pipe at delivery time, the
21705 delivery is deferred.
21706
21707
21708 .option allow_symlink appendfile boolean false
21709 .cindex "symbolic link" "to mailbox"
21710 .cindex "mailbox" "symbolic link"
21711 By default, &(appendfile)& will not deliver if the path name for the file is
21712 that of a symbolic link. Setting this option relaxes that constraint, but there
21713 are security issues involved in the use of symbolic links. Be sure you know
21714 what you are doing if you set this. Details of exactly what this option affects
21715 are included in the discussion which follows this list of options.
21716
21717
21718 .option batch_id appendfile string&!! unset
21719 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21720 However, batching is automatically disabled for &(appendfile)& deliveries that
21721 happen as a result of forwarding or aliasing or other redirection directly to a
21722 file.
21723
21724
21725 .option batch_max appendfile integer 1
21726 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21727
21728
21729 .option check_group appendfile boolean false
21730 When this option is set, the group owner of the file defined by the &%file%&
21731 option is checked to see that it is the same as the group under which the
21732 delivery process is running. The default setting is false because the default
21733 file mode is 0600, which means that the group is irrelevant.
21734
21735
21736 .option check_owner appendfile boolean true
21737 When this option is set, the owner of the file defined by the &%file%& option
21738 is checked to ensure that it is the same as the user under which the delivery
21739 process is running.
21740
21741
21742 .option check_string appendfile string "see below"
21743 .cindex "&""From""& line"
21744 As &(appendfile)& writes the message, the start of each line is tested for
21745 matching &%check_string%&, and if it does, the initial matching characters are
21746 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21747 a literal string, not a regular expression, and the case of any letters it
21748 contains is significant.
21749
21750 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21751 are forced to &"."& and &".."& respectively, and any settings in the
21752 configuration are ignored. Otherwise, they default to &"From&~"& and
21753 &">From&~"& when the &%file%& option is set, and unset when any of the
21754 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21755
21756 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21757 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21758 &"From&~"& indicates the start of a new message. All four options need changing
21759 if another format is used. For example, to deliver to mailboxes in MMDF format:
21760 .cindex "MMDF format mailbox"
21761 .cindex "mailbox" "MMDF format"
21762 .code
21763 check_string = "\1\1\1\1\n"
21764 escape_string = "\1\1\1\1 \n"
21765 message_prefix = "\1\1\1\1\n"
21766 message_suffix = "\1\1\1\1\n"
21767 .endd
21768 .option create_directory appendfile boolean true
21769 .cindex "directory creation"
21770 When this option is true, Exim attempts to create any missing superior
21771 directories for the file that it is about to write. A created directory's mode
21772 is given by the &%directory_mode%& option.
21773
21774 The group ownership of a newly created directory is highly dependent on the
21775 operating system (and possibly the file system) that is being used. For
21776 example, in Solaris, if the parent directory has the setgid bit set, its group
21777 is propagated to the child; if not, the currently set group is used. However,
21778 in FreeBSD, the parent's group is always used.
21779
21780
21781
21782 .option create_file appendfile string anywhere
21783 This option constrains the location of files and directories that are created
21784 by this transport. It applies to files defined by the &%file%& option and
21785 directories defined by the &%directory%& option. In the case of maildir
21786 delivery, it applies to the top level directory, not the maildir directories
21787 beneath.
21788
21789 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21790 &"belowhome"&. In the second and third cases, a home directory must have been
21791 set for the transport. This option is not useful when an explicit file name is
21792 given for normal mailbox deliveries. It is intended for the case when file
21793 names are generated from users' &_.forward_& files. These are usually handled
21794 by an &(appendfile)& transport called &%address_file%&. See also
21795 &%file_must_exist%&.
21796
21797
21798 .option directory appendfile string&!! unset
21799 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21800 or &%directory%& must be set, unless the delivery is the direct result of a
21801 redirection (see section &<<SECTfildiropt>>&).
21802
21803 When &%directory%& is set, the string is expanded, and the message is delivered
21804 into a new file or files in or below the given directory, instead of being
21805 appended to a single mailbox file. A number of different formats are provided
21806 (see &%maildir_format%& and &%mailstore_format%&), and see section
21807 &<<SECTopdir>>& for further details of this form of delivery.
21808
21809
21810 .option directory_file appendfile string&!! "see below"
21811 .cindex "base62"
21812 .vindex "&$inode$&"
21813 When &%directory%& is set, but neither &%maildir_format%& nor
21814 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21815 whose name is obtained by expanding this string. The default value is:
21816 .code
21817 q${base62:$tod_epoch}-$inode
21818 .endd
21819 This generates a unique name from the current time, in base 62 form, and the
21820 inode of the file. The variable &$inode$& is available only when expanding this
21821 option.
21822
21823
21824 .option directory_mode appendfile "octal integer" 0700
21825 If &(appendfile)& creates any directories as a result of the
21826 &%create_directory%& option, their mode is specified by this option.
21827
21828
21829 .option escape_string appendfile string "see description"
21830 See &%check_string%& above.
21831
21832
21833 .option file appendfile string&!! unset
21834 This option is mutually exclusive with the &%directory%& option, but one of
21835 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21836 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21837 specifies a single file, to which the message is appended. One or more of
21838 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21839 &%file%&.
21840
21841 .cindex "NFS" "lock file"
21842 .cindex "locking files"
21843 .cindex "lock files"
21844 If you are using more than one host to deliver over NFS into the same
21845 mailboxes, you should always use lock files.
21846
21847 The string value is expanded for each delivery, and must yield an absolute
21848 path. The most common settings of this option are variations on one of these
21849 examples:
21850 .code
21851 file = /var/spool/mail/$local_part
21852 file = /home/$local_part/inbox
21853 file = $home/inbox
21854 .endd
21855 .cindex "&""sticky""& bit"
21856 In the first example, all deliveries are done into the same directory. If Exim
21857 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21858 create a file in the directory, so the &"sticky"& bit must be turned on for
21859 deliveries to be possible, or alternatively the &%group%& option can be used to
21860 run the delivery under a group id which has write access to the directory.
21861
21862
21863
21864 .option file_format appendfile string unset
21865 .cindex "file" "mailbox; checking existing format"
21866 This option requests the transport to check the format of an existing file
21867 before adding to it. The check consists of matching a specific string at the
21868 start of the file. The value of the option consists of an even number of
21869 colon-separated strings. The first of each pair is the test string, and the
21870 second is the name of a transport. If the transport associated with a matched
21871 string is not the current transport, control is passed over to the other
21872 transport. For example, suppose the standard &(local_delivery)& transport has
21873 this added to it:
21874 .code
21875 file_format = "From       : local_delivery :\
21876                \1\1\1\1\n : local_mmdf_delivery"
21877 .endd
21878 Mailboxes that begin with &"From"& are still handled by this transport, but if
21879 a mailbox begins with four binary ones followed by a newline, control is passed
21880 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21881 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21882 is assumed to match the current transport. If the start of a mailbox doesn't
21883 match any string, or if the transport named for a given string is not defined,
21884 delivery is deferred.
21885
21886
21887 .option file_must_exist appendfile boolean false
21888 If this option is true, the file specified by the &%file%& option must exist.
21889 A temporary error occurs if it does not, causing delivery to be deferred.
21890 If this option is false, the file is created if it does not exist.
21891
21892
21893 .option lock_fcntl_timeout appendfile time 0s
21894 .cindex "timeout" "mailbox locking"
21895 .cindex "mailbox" "locking, blocking and non-blocking"
21896 .cindex "locking files"
21897 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21898 when locking an open mailbox file. If the call fails, the delivery process
21899 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21900 Non-blocking calls are used so that the file is not kept open during the wait
21901 for the lock; the reason for this is to make it as safe as possible for
21902 deliveries over NFS in the case when processes might be accessing an NFS
21903 mailbox without using a lock file. This should not be done, but
21904 misunderstandings and hence misconfigurations are not unknown.
21905
21906 On a busy system, however, the performance of a non-blocking lock approach is
21907 not as good as using a blocking lock with a timeout. In this case, the waiting
21908 is done inside the system call, and Exim's delivery process acquires the lock
21909 and can proceed as soon as the previous lock holder releases it.
21910
21911 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21912 timeout, are used. There may still be some retrying: the maximum number of
21913 retries is
21914 .code
21915 (lock_retries * lock_interval) / lock_fcntl_timeout
21916 .endd
21917 rounded up to the next whole number. In other words, the total time during
21918 which &(appendfile)& is trying to get a lock is roughly the same, unless
21919 &%lock_fcntl_timeout%& is set very large.
21920
21921 You should consider setting this option if you are getting a lot of delayed
21922 local deliveries because of errors of the form
21923 .code
21924 failed to lock mailbox /some/file (fcntl)
21925 .endd
21926
21927 .option lock_flock_timeout appendfile time 0s
21928 This timeout applies to file locking when using &[flock()]& (see
21929 &%use_flock%&); the timeout operates in a similar manner to
21930 &%lock_fcntl_timeout%&.
21931
21932
21933 .option lock_interval appendfile time 3s
21934 This specifies the time to wait between attempts to lock the file. See below
21935 for details of locking.
21936
21937
21938 .option lock_retries appendfile integer 10
21939 This specifies the maximum number of attempts to lock the file. A value of zero
21940 is treated as 1. See below for details of locking.
21941
21942
21943 .option lockfile_mode appendfile "octal integer" 0600
21944 This specifies the mode of the created lock file, when a lock file is being
21945 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21946
21947
21948 .option lockfile_timeout appendfile time 30m
21949 .cindex "timeout" "mailbox locking"
21950 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21951 exists and is older than this value, it is assumed to have been left behind by
21952 accident, and Exim attempts to remove it.
21953
21954
21955 .option mailbox_filecount appendfile string&!! unset
21956 .cindex "mailbox" "specifying size of"
21957 .cindex "size" "of mailbox"
21958 If this option is set, it is expanded, and the result is taken as the current
21959 number of files in the mailbox. It must be a decimal number, optionally
21960 followed by K or M. This provides a way of obtaining this information from an
21961 external source that maintains the data.
21962
21963
21964 .option mailbox_size appendfile string&!! unset
21965 .cindex "mailbox" "specifying size of"
21966 .cindex "size" "of mailbox"
21967 If this option is set, it is expanded, and the result is taken as the current
21968 size the mailbox. It must be a decimal number, optionally followed by K or M.
21969 This provides a way of obtaining this information from an external source that
21970 maintains the data. This is likely to be helpful for maildir deliveries where
21971 it is computationally expensive to compute the size of a mailbox.
21972
21973
21974
21975 .option maildir_format appendfile boolean false
21976 .cindex "maildir format" "specifying"
21977 If this option is set with the &%directory%& option, the delivery is into a new
21978 file, in the &"maildir"& format that is used by other mail software. When the
21979 transport is activated directly from a &(redirect)& router (for example, the
21980 &(address_file)& transport in the default configuration), setting
21981 &%maildir_format%& causes the path received from the router to be treated as a
21982 directory, whether or not it ends with &`/`&. This option is available only if
21983 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21984 &<<SECTmaildirdelivery>>& below for further details.
21985
21986
21987 .option maildir_quota_directory_regex appendfile string "See below"
21988 .cindex "maildir format" "quota; directories included in"
21989 .cindex "quota" "maildir; directories included in"
21990 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21991 a regular expression for specifying directories, relative to the quota
21992 directory (see &%quota_directory%&), that should be included in the quota
21993 calculation. The default value is:
21994 .code
21995 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21996 .endd
21997 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21998 (directories whose names begin with a dot). If you want to exclude the
21999 &_Trash_&
22000 folder from the count (as some sites do), you need to change this setting to
22001 .code
22002 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22003 .endd
22004 This uses a negative lookahead in the regular expression to exclude the
22005 directory whose name is &_.Trash_&. When a directory is excluded from quota
22006 calculations, quota processing is bypassed for any messages that are delivered
22007 directly into that directory.
22008
22009
22010 .option maildir_retries appendfile integer 10
22011 This option specifies the number of times to retry when writing a file in
22012 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22013
22014
22015 .option maildir_tag appendfile string&!! unset
22016 This option applies only to deliveries in maildir format, and is described in
22017 section &<<SECTmaildirdelivery>>& below.
22018
22019
22020 .option maildir_use_size_file appendfile&!! boolean false
22021 .cindex "maildir format" "&_maildirsize_& file"
22022 The result of string expansion for this option must be a valid boolean value.
22023 If it is true, it enables support for &_maildirsize_& files. Exim
22024 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22025 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22026 value is zero. See &%maildir_quota_directory_regex%& above and section
22027 &<<SECTmaildirdelivery>>& below for further details.
22028
22029 .option maildirfolder_create_regex appendfile string unset
22030 .cindex "maildir format" "&_maildirfolder_& file"
22031 .cindex "&_maildirfolder_&, creating"
22032 The value of this option is a regular expression. If it is unset, it has no
22033 effect. Otherwise, before a maildir delivery takes place, the pattern is
22034 matched against the name of the maildir directory, that is, the directory
22035 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22036 delivery. If there is a match, Exim checks for the existence of a file called
22037 &_maildirfolder_& in the directory, and creates it if it does not exist.
22038 See section &<<SECTmaildirdelivery>>& for more details.
22039
22040
22041 .option mailstore_format appendfile boolean false
22042 .cindex "mailstore format" "specifying"
22043 If this option is set with the &%directory%& option, the delivery is into two
22044 new files in  &"mailstore"& format. The option is available only if
22045 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22046 below for further details.
22047
22048
22049 .option mailstore_prefix appendfile string&!! unset
22050 This option applies only to deliveries in mailstore format, and is described in
22051 section &<<SECTopdir>>& below.
22052
22053
22054 .option mailstore_suffix appendfile string&!! unset
22055 This option applies only to deliveries in mailstore format, and is described in
22056 section &<<SECTopdir>>& below.
22057
22058
22059 .option mbx_format appendfile boolean false
22060 .cindex "locking files"
22061 .cindex "file" "locking"
22062 .cindex "file" "MBX format"
22063 .cindex "MBX format, specifying"
22064 This option is available only if Exim has been compiled with SUPPORT_MBX
22065 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22066 the message is appended to the mailbox file in MBX format instead of
22067 traditional Unix format. This format is supported by Pine4 and its associated
22068 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22069
22070 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22071 automatically changed by the use of &%mbx_format%&. They should normally be set
22072 empty when using MBX format, so this option almost always appears in this
22073 combination:
22074 .code
22075 mbx_format = true
22076 message_prefix =
22077 message_suffix =
22078 .endd
22079 If none of the locking options are mentioned in the configuration,
22080 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22081 is possible to specify the other kinds of locking with &%mbx_format%&, but
22082 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22083 interworks with &'c-client'&, providing for shared access to the mailbox. It
22084 should not be used if any program that does not use this form of locking is
22085 going to access the mailbox, nor should it be used if the mailbox file is NFS
22086 mounted, because it works only when the mailbox is accessed from a single host.
22087
22088 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22089 the standard version of &'c-client'&, because as long as it has a mailbox open
22090 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22091 append messages to it.
22092
22093
22094 .option message_prefix appendfile string&!! "see below"
22095 .cindex "&""From""& line"
22096 The string specified here is expanded and output at the start of every message.
22097 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22098 in which case it is:
22099 .code
22100 message_prefix = "From ${if def:return_path{$return_path}\
22101   {MAILER-DAEMON}} $tod_bsdinbox\n"
22102 .endd
22103 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22104 &`\n`& to &`\r\n`& in &%message_prefix%&.
22105
22106 .option message_suffix appendfile string&!! "see below"
22107 The string specified here is expanded and output at the end of every message.
22108 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22109 in which case it is a single newline character. The suffix can be suppressed by
22110 setting
22111 .code
22112 message_suffix =
22113 .endd
22114 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22115 &`\n`& to &`\r\n`& in &%message_suffix%&.
22116
22117 .option mode appendfile "octal integer" 0600
22118 If the output file is created, it is given this mode. If it already exists and
22119 has wider permissions, they are reduced to this mode. If it has narrower
22120 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22121 if the delivery is the result of a &%save%& command in a filter file specifying
22122 a particular mode, the mode of the output file is always forced to take that
22123 value, and this option is ignored.
22124
22125
22126 .option mode_fail_narrower appendfile boolean true
22127 This option applies in the case when an existing mailbox file has a narrower
22128 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22129 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22130 continues with the delivery attempt, using the existing mode of the file.
22131
22132
22133 .option notify_comsat appendfile boolean false
22134 If this option is true, the &'comsat'& daemon is notified after every
22135 successful delivery to a user mailbox. This is the daemon that notifies logged
22136 on users about incoming mail.
22137
22138
22139 .option quota appendfile string&!! unset
22140 .cindex "quota" "imposed by Exim"
22141 This option imposes a limit on the size of the file to which Exim is appending,
22142 or to the total space used in the directory tree when the &%directory%& option
22143 is set. In the latter case, computation of the space used is expensive, because
22144 all the files in the directory (and any sub-directories) have to be
22145 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22146 &%maildir_use_size_file%& for ways to avoid this in environments where users
22147 have no shell access to their mailboxes).
22148
22149 As there is no interlock against two simultaneous deliveries into a
22150 multi-file mailbox, it is possible for the quota to be overrun in this case.
22151 For single-file mailboxes, of course, an interlock is a necessity.
22152
22153 A file's size is taken as its &'used'& value. Because of blocking effects, this
22154 may be a lot less than the actual amount of disk space allocated to the file.
22155 If the sizes of a number of files are being added up, the rounding effect can
22156 become quite noticeable, especially on systems that have large block sizes.
22157 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22158 the obvious value which users understand most easily.
22159
22160 The value of the option is expanded, and must then be a numerical value
22161 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22162 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22163 and further option modifiers. If Exim is running on a system with
22164 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22165 be handled.
22166
22167 The option modifier &%no_check%& can be used to force delivery even if the over
22168 quota condition is met. The quota gets updated as usual.
22169
22170 &*Note*&: A value of zero is interpreted as &"no quota"&.
22171
22172 The expansion happens while Exim is running as root, before it changes uid for
22173 the delivery. This means that files that are inaccessible to the end user can
22174 be used to hold quota values that are looked up in the expansion. When delivery
22175 fails because this quota is exceeded, the handling of the error is as for
22176 system quota failures.
22177
22178 By default, Exim's quota checking mimics system quotas, and restricts the
22179 mailbox to the specified maximum size, though the value is not accurate to the
22180 last byte, owing to separator lines and additional headers that may get added
22181 during message delivery. When a mailbox is nearly full, large messages may get
22182 refused even though small ones are accepted, because the size of the current
22183 message is added to the quota when the check is made. This behaviour can be
22184 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22185 for exceeding the quota does not include the current message. Thus, deliveries
22186 continue until the quota has been exceeded; thereafter, no further messages are
22187 delivered. See also &%quota_warn_threshold%&.
22188
22189
22190 .option quota_directory appendfile string&!! unset
22191 This option defines the directory to check for quota purposes when delivering
22192 into individual files. The default is the delivery directory, or, if a file
22193 called &_maildirfolder_& exists in a maildir directory, the parent of the
22194 delivery directory.
22195
22196
22197 .option quota_filecount appendfile string&!! 0
22198 This option applies when the &%directory%& option is set. It limits the total
22199 number of files in the directory (compare the inode limit in system quotas). It
22200 can only be used if &%quota%& is also set. The value is expanded; an expansion
22201 failure causes delivery to be deferred. A value of zero is interpreted as
22202 &"no quota"&.
22203
22204 The option modifier &%no_check%& can be used to force delivery even if the over
22205 quota condition is met. The quota gets updated as usual.
22206
22207 .option quota_is_inclusive appendfile boolean true
22208 See &%quota%& above.
22209
22210
22211 .option quota_size_regex appendfile string unset
22212 This option applies when one of the delivery modes that writes a separate file
22213 for each message is being used. When Exim wants to find the size of one of
22214 these files in order to test the quota, it first checks &%quota_size_regex%&.
22215 If this is set to a regular expression that matches the file name, and it
22216 captures one string, that string is interpreted as a representation of the
22217 file's size. The value of &%quota_size_regex%& is not expanded.
22218
22219 This feature is useful only when users have no shell access to their mailboxes
22220 &-- otherwise they could defeat the quota simply by renaming the files. This
22221 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22222 the file length to the file name. For example:
22223 .code
22224 maildir_tag = ,S=$message_size
22225 quota_size_regex = ,S=(\d+)
22226 .endd
22227 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22228 number of lines in the message.
22229
22230 The regular expression should not assume that the length is at the end of the
22231 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22232 sometimes add other information onto the ends of message file names.
22233
22234 Section &<<SECID136>>& contains further information.
22235
22236
22237 .option quota_warn_message appendfile string&!! "see below"
22238 See below for the use of this option. If it is not set when
22239 &%quota_warn_threshold%& is set, it defaults to
22240 .code
22241 quota_warn_message = "\
22242   To: $local_part@$domain\n\
22243   Subject: Your mailbox\n\n\
22244   This message is automatically created \
22245   by mail delivery software.\n\n\
22246   The size of your mailbox has exceeded \
22247   a warning threshold that is\n\
22248   set by the system administrator.\n"
22249 .endd
22250
22251
22252 .option quota_warn_threshold appendfile string&!! 0
22253 .cindex "quota" "warning threshold"
22254 .cindex "mailbox" "size warning"
22255 .cindex "size" "of mailbox"
22256 This option is expanded in the same way as &%quota%& (see above). If the
22257 resulting value is greater than zero, and delivery of the message causes the
22258 size of the file or total space in the directory tree to cross the given
22259 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22260 may be specified as a percentage of it by following the value with a percent
22261 sign. For example:
22262 .code
22263 quota = 10M
22264 quota_warn_threshold = 75%
22265 .endd
22266 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22267 percent sign is ignored.
22268
22269 The warning message itself is specified by the &%quota_warn_message%& option,
22270 and it must start with a &'To:'& header line containing the recipient(s) of the
22271 warning message. These do not necessarily have to include the recipient(s) of
22272 the original message. A &'Subject:'& line should also normally be supplied. You
22273 can include any other header lines that you want. If you do not include a
22274 &'From:'& line, the default is:
22275 .code
22276 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22277 .endd
22278 .oindex &%errors_reply_to%&
22279 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22280 option.
22281
22282 The &%quota%& option does not have to be set in order to use this option; they
22283 are independent of one another except when the threshold is specified as a
22284 percentage.
22285
22286
22287 .option use_bsmtp appendfile boolean false
22288 .cindex "envelope sender"
22289 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22290 format, with the envelope sender and recipient(s) included as SMTP commands. If
22291 you want to include a leading HELO command with such messages, you can do
22292 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22293 for details of batch SMTP.
22294
22295
22296 .option use_crlf appendfile boolean false
22297 .cindex "carriage return"
22298 .cindex "linefeed"
22299 This option causes lines to be terminated with the two-character CRLF sequence
22300 (carriage return, linefeed) instead of just a linefeed character. In the case
22301 of batched SMTP, the byte sequence written to the file is then an exact image
22302 of what would be sent down a real SMTP connection.
22303
22304 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22305 (which are used to supply the traditional &"From&~"& and blank line separators
22306 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22307 carriage return characters if these are needed. In cases where these options
22308 have non-empty defaults, the values end with a single linefeed, so they must be
22309 changed to end with &`\r\n`& if &%use_crlf%& is set.
22310
22311
22312 .option use_fcntl_lock appendfile boolean "see below"
22313 This option controls the use of the &[fcntl()]& function to lock a file for
22314 exclusive use when a message is being appended. It is set by default unless
22315 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22316 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22317 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22318
22319
22320 .option use_flock_lock appendfile boolean false
22321 This option is provided to support the use of &[flock()]& for file locking, for
22322 the few situations where it is needed. Most modern operating systems support
22323 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22324 each other. Exim uses &[fcntl()]& locking by default.
22325
22326 This option is required only if you are using an operating system where
22327 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22328 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22329 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22330
22331 .cindex "Solaris" "&[flock()]& support"
22332 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22333 have it (and some, I think, provide a not quite right version built on top of
22334 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22335 the ability to use it, and any attempt to do so will cause a configuration
22336 error.
22337
22338 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22339 is just being mapped onto &[fcntl()]& by the OS).
22340
22341
22342 .option use_lockfile appendfile boolean "see below"
22343 If this option is turned off, Exim does not attempt to create a lock file when
22344 appending to a mailbox file. In this situation, the only locking is by
22345 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22346 sure that every MUA that is ever going to look at your users' mailboxes uses
22347 &[fcntl()]& rather than a lock file, and even then only when you are not
22348 delivering over NFS from more than one host.
22349
22350 .cindex "NFS" "lock file"
22351 In order to append to an NFS file safely from more than one host, it is
22352 necessary to take out a lock &'before'& opening the file, and the lock file
22353 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22354 file corruption.
22355
22356 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22357 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22358 except when &%mbx_format%& is set.
22359
22360
22361 .option use_mbx_lock appendfile boolean "see below"
22362 This option is available only if Exim has been compiled with SUPPORT_MBX
22363 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22364 locking rules be used. It is set by default if &%mbx_format%& is set and none
22365 of the locking options are mentioned in the configuration. The locking rules
22366 are the same as are used by the &'c-client'& library that underlies Pine and
22367 the IMAP4 and POP daemons that come with it (see the discussion below). The
22368 rules allow for shared access to the mailbox. However, this kind of locking
22369 does not work when the mailbox is NFS mounted.
22370
22371 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22372 &%use_flock_lock%& to control what kind of locking is used in implementing the
22373 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22374 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22375
22376
22377
22378
22379 .section "Operational details for appending" "SECTopappend"
22380 .cindex "appending to a file"
22381 .cindex "file" "appending"
22382 Before appending to a file, the following preparations are made:
22383
22384 .ilist
22385 If the name of the file is &_/dev/null_&, no action is taken, and a success
22386 return is given.
22387
22388 .next
22389 .cindex "directory creation"
22390 If any directories on the file's path are missing, Exim creates them if the
22391 &%create_directory%& option is set. A created directory's mode is given by the
22392 &%directory_mode%& option.
22393
22394 .next
22395 If &%file_format%& is set, the format of an existing file is checked. If this
22396 indicates that a different transport should be used, control is passed to that
22397 transport.
22398
22399 .next
22400 .cindex "file" "locking"
22401 .cindex "locking files"
22402 .cindex "NFS" "lock file"
22403 If &%use_lockfile%& is set, a lock file is built in a way that will work
22404 reliably over NFS, as follows:
22405
22406 .olist
22407 Create a &"hitching post"& file whose name is that of the lock file with the
22408 current time, primary host name, and process id added, by opening for writing
22409 as a new file. If this fails with an access error, delivery is deferred.
22410 .next
22411 Close the hitching post file, and hard link it to the lock file name.
22412 .next
22413 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22414 Unlink the hitching post name.
22415 .next
22416 Otherwise, use &[stat()]& to get information about the hitching post file, and
22417 then unlink hitching post name. If the number of links is exactly two, creation
22418 of the lock file succeeded but something (for example, an NFS server crash and
22419 restart) caused this fact not to be communicated to the &[link()]& call.
22420 .next
22421 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22422 up to &%lock_retries%& times. However, since any program that writes to a
22423 mailbox should complete its task very quickly, it is reasonable to time out old
22424 lock files that are normally the result of user agent and system crashes. If an
22425 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22426 it before trying again.
22427 .endlist olist
22428
22429 .next
22430 A call is made to &[lstat()]& to discover whether the main file exists, and if
22431 so, what its characteristics are. If &[lstat()]& fails for any reason other
22432 than non-existence, delivery is deferred.
22433
22434 .next
22435 .cindex "symbolic link" "to mailbox"
22436 .cindex "mailbox" "symbolic link"
22437 If the file does exist and is a symbolic link, delivery is deferred, unless the
22438 &%allow_symlink%& option is set, in which case the ownership of the link is
22439 checked, and then &[stat()]& is called to find out about the real file, which
22440 is then subjected to the checks below. The check on the top-level link
22441 ownership prevents one user creating a link for another's mailbox in a sticky
22442 directory, though allowing symbolic links in this case is definitely not a good
22443 idea. If there is a chain of symbolic links, the intermediate ones are not
22444 checked.
22445
22446 .next
22447 If the file already exists but is not a regular file, or if the file's owner
22448 and group (if the group is being checked &-- see &%check_group%& above) are
22449 different from the user and group under which the delivery is running,
22450 delivery is deferred.
22451
22452 .next
22453 If the file's permissions are more generous than specified, they are reduced.
22454 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22455 is set false, in which case the delivery is tried using the existing
22456 permissions.
22457
22458 .next
22459 The file's inode number is saved, and the file is then opened for appending.
22460 If this fails because the file has vanished, &(appendfile)& behaves as if it
22461 hadn't existed (see below). For any other failures, delivery is deferred.
22462
22463 .next
22464 If the file is opened successfully, check that the inode number hasn't
22465 changed, that it is still a regular file, and that the owner and permissions
22466 have not changed. If anything is wrong, defer delivery and freeze the message.
22467
22468 .next
22469 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22470 option is set. Otherwise, check that the file is being created in a permitted
22471 directory if the &%create_file%& option is set (deferring on failure), and then
22472 open for writing as a new file, with the O_EXCL and O_CREAT options,
22473 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22474 set). In this case, which can happen if the link points to a non-existent file,
22475 the file is opened for writing using O_CREAT but not O_EXCL, because
22476 that prevents link following.
22477
22478 .next
22479 .cindex "loop" "while file testing"
22480 If opening fails because the file exists, obey the tests given above for
22481 existing files. However, to avoid looping in a situation where the file is
22482 being continuously created and destroyed, the exists/not-exists loop is broken
22483 after 10 repetitions, and the message is then frozen.
22484
22485 .next
22486 If opening fails with any other error, defer delivery.
22487
22488 .next
22489 .cindex "file" "locking"
22490 .cindex "locking files"
22491 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22492 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22493 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22494 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22495 file, and an exclusive lock on the file whose name is
22496 .code
22497 /tmp/.<device-number>.<inode-number>
22498 .endd
22499 using the device and inode numbers of the open mailbox file, in accordance with
22500 the MBX locking rules. This file is created with a mode that is specified by
22501 the &%lockfile_mode%& option.
22502
22503 If Exim fails to lock the file, there are two possible courses of action,
22504 depending on the value of the locking timeout. This is obtained from
22505 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22506
22507 If the timeout value is zero, the file is closed, Exim waits for
22508 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22509 to lock it again. This happens up to &%lock_retries%& times, after which the
22510 delivery is deferred.
22511
22512 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22513 &[flock()]& are used (with the given timeout), so there has already been some
22514 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22515 immediately. It retries up to
22516 .code
22517 (lock_retries * lock_interval) / <timeout>
22518 .endd
22519 times (rounded up).
22520 .endlist
22521
22522 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22523 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22524
22525
22526 .section "Operational details for delivery to a new file" "SECTopdir"
22527 .cindex "delivery" "to single file"
22528 .cindex "&""From""& line"
22529 When the &%directory%& option is set instead of &%file%&, each message is
22530 delivered into a newly-created file or set of files. When &(appendfile)& is
22531 activated directly from a &(redirect)& router, neither &%file%& nor
22532 &%directory%& is normally set, because the path for delivery is supplied by the
22533 router. (See for example, the &(address_file)& transport in the default
22534 configuration.) In this case, delivery is to a new file if either the path name
22535 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22536
22537 No locking is required while writing the message to a new file, so the various
22538 locking options of the transport are ignored. The &"From"& line that by default
22539 separates messages in a single file is not normally needed, nor is the escaping
22540 of message lines that start with &"From"&, and there is no need to ensure a
22541 newline at the end of each message. Consequently, the default values for
22542 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22543 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22544
22545 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22546 the files in the delivery directory by default. However, you can specify a
22547 different directory by setting &%quota_directory%&. Also, for maildir
22548 deliveries (see below) the &_maildirfolder_& convention is honoured.
22549
22550
22551 .cindex "maildir format"
22552 .cindex "mailstore format"
22553 There are three different ways in which delivery to individual files can be
22554 done, controlled by the settings of the &%maildir_format%& and
22555 &%mailstore_format%& options. Note that code to support maildir or mailstore
22556 formats is not included in the binary unless SUPPORT_MAILDIR or
22557 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22558
22559 .cindex "directory creation"
22560 In all three cases an attempt is made to create the directory and any necessary
22561 sub-directories if they do not exist, provided that the &%create_directory%&
22562 option is set (the default). The location of a created directory can be
22563 constrained by setting &%create_file%&. A created directory's mode is given by
22564 the &%directory_mode%& option. If creation fails, or if the
22565 &%create_directory%& option is not set when creation is required, delivery is
22566 deferred.
22567
22568
22569
22570 .section "Maildir delivery" "SECTmaildirdelivery"
22571 .cindex "maildir format" "description of"
22572 If the &%maildir_format%& option is true, Exim delivers each message by writing
22573 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22574 directory that is defined by the &%directory%& option (the &"delivery
22575 directory"&). If the delivery is successful, the file is renamed into the
22576 &_new_& subdirectory.
22577
22578 In the file name, <&'stime'&> is the current time of day in seconds, and
22579 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22580 Exim checks that the time-of-day clock has moved on by at least one microsecond
22581 before terminating the delivery process. This guarantees uniqueness for the
22582 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22583 opening it. If any response other than ENOENT (does not exist) is given,
22584 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22585
22586 Before Exim carries out a maildir delivery, it ensures that subdirectories
22587 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22588 do not exist, Exim tries to create them and any superior directories in their
22589 path, subject to the &%create_directory%& and &%create_file%& options. If the
22590 &%maildirfolder_create_regex%& option is set, and the regular expression it
22591 contains matches the delivery directory, Exim also ensures that a file called
22592 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22593 &_maildirfolder_& file cannot be created, delivery is deferred.
22594
22595 These features make it possible to use Exim to create all the necessary files
22596 and directories in a maildir mailbox, including subdirectories for maildir++
22597 folders. Consider this example:
22598 .code
22599 maildir_format = true
22600 directory = /var/mail/$local_part\
22601            ${if eq{$local_part_suffix}{}{}\
22602            {/.${substr_1:$local_part_suffix}}}
22603 maildirfolder_create_regex = /\.[^/]+$
22604 .endd
22605 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22606 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22607 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22608 not match this name, so Exim will not look for or create the file
22609 &_/var/mail/pimbo/maildirfolder_&, though it will create
22610 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22611
22612 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22613 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22614 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22615 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22616 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22617
22618 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22619 not inadvertently match the toplevel maildir directory, because a
22620 &_maildirfolder_& file at top level would completely break quota calculations.
22621
22622 .cindex "quota" "in maildir delivery"
22623 .cindex "maildir++"
22624 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22625 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22626 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22627 Exim assumes the directory is a maildir++ folder directory, which is one level
22628 down from the user's top level mailbox directory. This causes it to start at
22629 the parent directory instead of the current directory when calculating the
22630 amount of space used.
22631
22632 One problem with delivering into a multi-file mailbox is that it is
22633 computationally expensive to compute the size of the mailbox for quota
22634 checking. Various approaches have been taken to reduce the amount of work
22635 needed. The next two sections describe two of them. A third alternative is to
22636 use some external process for maintaining the size data, and use the expansion
22637 of the &%mailbox_size%& option as a way of importing it into Exim.
22638
22639
22640
22641
22642 .section "Using tags to record message sizes" "SECID135"
22643 If &%maildir_tag%& is set, the string is expanded for each delivery.
22644 When the maildir file is renamed into the &_new_& sub-directory, the
22645 tag is added to its name. However, if adding the tag takes the length of the
22646 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22647 the tag is dropped and the maildir file is created with no tag.
22648
22649
22650 .vindex "&$message_size$&"
22651 Tags can be used to encode the size of files in their names; see
22652 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22653 happens after the message has been written. The value of the &$message_size$&
22654 variable is set to the number of bytes actually written. If the expansion is
22655 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22656 be deferred. The expanded tag may contain any printing characters except &"/"&.
22657 Non-printing characters in the string are ignored; if the resulting string is
22658 empty, it is ignored. If it starts with an alphanumeric character, a leading
22659 colon is inserted; this default has not proven to be the path that popular
22660 maildir implementations have chosen (but changing it in Exim would break
22661 backwards compatibility).
22662
22663 For one common implementation, you might set:
22664 .code
22665 maildir_tag = ,S=${message_size}
22666 .endd
22667 but you should check the documentation of the other software to be sure.
22668
22669 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22670 as this allows Exim to extract the size from your tag, instead of having to
22671 &[stat()]& each message file.
22672
22673
22674 .section "Using a maildirsize file" "SECID136"
22675 .cindex "quota" "in maildir delivery"
22676 .cindex "maildir format" "&_maildirsize_& file"
22677 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22678 storing quota and message size information in a file called &_maildirsize_&
22679 within the toplevel maildir directory. If this file does not exist, Exim
22680 creates it, setting the quota from the &%quota%& option of the transport. If
22681 the maildir directory itself does not exist, it is created before any attempt
22682 to write a &_maildirsize_& file.
22683
22684 The &_maildirsize_& file is used to hold information about the sizes of
22685 messages in the maildir, thus speeding up quota calculations. The quota value
22686 in the file is just a cache; if the quota is changed in the transport, the new
22687 value overrides the cached value when the next message is delivered. The cache
22688 is maintained for the benefit of other programs that access the maildir and
22689 need to know the quota.
22690
22691 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22692 file is maintained (with a zero quota setting), but no quota is imposed.
22693
22694 A regular expression is available for controlling which directories in the
22695 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22696 See the description of the &%maildir_quota_directory_regex%& option above for
22697 details.
22698
22699
22700 .section "Mailstore delivery" "SECID137"
22701 .cindex "mailstore format" "description of"
22702 If the &%mailstore_format%& option is true, each message is written as two
22703 files in the given directory. A unique base name is constructed from the
22704 message id and the current delivery process, and the files that are written use
22705 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22706 contains the message's envelope, and the &_.msg_& file contains the message
22707 itself. The base name is placed in the variable &$mailstore_basename$&.
22708
22709 During delivery, the envelope is first written to a file with the suffix
22710 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22711 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22712 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22713 file before accessing either of them. An alternative approach is to wait for
22714 the absence of a &_.tmp_& file.
22715
22716 The envelope file starts with any text defined by the &%mailstore_prefix%&
22717 option, expanded and terminated by a newline if there isn't one. Then follows
22718 the sender address on one line, then all the recipient addresses, one per line.
22719 There can be more than one recipient only if the &%batch_max%& option is set
22720 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22721 appended to the file, followed by a newline if it does not end with one.
22722
22723 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22724 failure, it is ignored. Other expansion errors are treated as serious
22725 configuration errors, and delivery is deferred. The variable
22726 &$mailstore_basename$& is available for use during these expansions.
22727
22728
22729 .section "Non-special new file delivery" "SECID138"
22730 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22731 file is created directly in the named directory. For example, when delivering
22732 messages into files in batched SMTP format for later delivery to some host (see
22733 section &<<SECTbatchSMTP>>&), a setting such as
22734 .code
22735 directory = /var/bsmtp/$host
22736 .endd
22737 might be used. A message is written to a file with a temporary name, which is
22738 then renamed when the delivery is complete. The final name is obtained by
22739 expanding the contents of the &%directory_file%& option.
22740 .ecindex IIDapptra1
22741 .ecindex IIDapptra2
22742
22743
22744
22745
22746
22747
22748 . ////////////////////////////////////////////////////////////////////////////
22749 . ////////////////////////////////////////////////////////////////////////////
22750
22751 .chapter "The autoreply transport" "CHID8"
22752 .scindex IIDauttra1 "transports" "&(autoreply)&"
22753 .scindex IIDauttra2 "&(autoreply)& transport"
22754 The &(autoreply)& transport is not a true transport in that it does not cause
22755 the message to be transmitted. Instead, it generates a new mail message as an
22756 automatic reply to the incoming message. &'References:'& and
22757 &'Auto-Submitted:'& header lines are included. These are constructed according
22758 to the rules in RFCs 2822 and 3834, respectively.
22759
22760 If the router that passes the message to this transport does not have the
22761 &%unseen%& option set, the original message (for the current recipient) is not
22762 delivered anywhere. However, when the &%unseen%& option is set on the router
22763 that passes the message to this transport, routing of the address continues, so
22764 another router can set up a normal message delivery.
22765
22766
22767 The &(autoreply)& transport is usually run as the result of mail filtering, a
22768 &"vacation"& message being the standard example. However, it can also be run
22769 directly from a router like any other transport. To reduce the possibility of
22770 message cascades, messages created by the &(autoreply)& transport always have
22771 empty envelope sender addresses, like bounce messages.
22772
22773 The parameters of the message to be sent can be specified in the configuration
22774 by options described below. However, these are used only when the address
22775 passed to the transport does not contain its own reply information. When the
22776 transport is run as a consequence of a
22777 &%mail%&
22778 or &%vacation%& command in a filter file, the parameters of the message are
22779 supplied by the filter, and passed with the address. The transport's options
22780 that define the message are then ignored (so they are not usually set in this
22781 case). The message is specified entirely by the filter or by the transport; it
22782 is never built from a mixture of options. However, the &%file_optional%&,
22783 &%mode%&, and &%return_message%& options apply in all cases.
22784
22785 &(Autoreply)& is implemented as a local transport. When used as a result of a
22786 command in a user's filter file, &(autoreply)& normally runs under the uid and
22787 gid of the user, and with appropriate current and home directories (see chapter
22788 &<<CHAPenvironment>>&).
22789
22790 There is a subtle difference between routing a message to a &(pipe)& transport
22791 that generates some text to be returned to the sender, and routing it to an
22792 &(autoreply)& transport. This difference is noticeable only if more than one
22793 address from the same message is so handled. In the case of a pipe, the
22794 separate outputs from the different addresses are gathered up and returned to
22795 the sender in a single message, whereas if &(autoreply)& is used, a separate
22796 message is generated for each address that is passed to it.
22797
22798 Non-printing characters are not permitted in the header lines generated for the
22799 message that &(autoreply)& creates, with the exception of newlines that are
22800 immediately followed by white space. If any non-printing characters are found,
22801 the transport defers.
22802 Whether characters with the top bit set count as printing characters or not is
22803 controlled by the &%print_topbitchars%& global option.
22804
22805 If any of the generic options for manipulating headers (for example,
22806 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22807 of the original message that is included in the generated message when
22808 &%return_message%& is set. They do not apply to the generated message itself.
22809
22810 .vindex "&$sender_address$&"
22811 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22812 the message, indicating that there were no recipients, it does not treat this
22813 as an error. This means that autoreplies sent to &$sender_address$& when this
22814 is empty (because the incoming message is a bounce message) do not cause
22815 problems. They are just discarded.
22816
22817
22818
22819 .section "Private options for autoreply" "SECID139"
22820 .cindex "options" "&(autoreply)& transport"
22821
22822 .option bcc autoreply string&!! unset
22823 This specifies the addresses that are to receive &"blind carbon copies"& of the
22824 message when the message is specified by the transport.
22825
22826
22827 .option cc autoreply string&!! unset
22828 This specifies recipients of the message and the contents of the &'Cc:'& header
22829 when the message is specified by the transport.
22830
22831
22832 .option file autoreply string&!! unset
22833 The contents of the file are sent as the body of the message when the message
22834 is specified by the transport. If both &%file%& and &%text%& are set, the text
22835 string comes first.
22836
22837
22838 .option file_expand autoreply boolean false
22839 If this is set, the contents of the file named by the &%file%& option are
22840 subjected to string expansion as they are added to the message.
22841
22842
22843 .option file_optional autoreply boolean false
22844 If this option is true, no error is generated if the file named by the &%file%&
22845 option or passed with the address does not exist or cannot be read.
22846
22847
22848 .option from autoreply string&!! unset
22849 This specifies the contents of the &'From:'& header when the message is
22850 specified by the transport.
22851
22852
22853 .option headers autoreply string&!! unset
22854 This specifies additional RFC 2822 headers that are to be added to the message
22855 when the message is specified by the transport. Several can be given by using
22856 &"\n"& to separate them. There is no check on the format.
22857
22858
22859 .option log autoreply string&!! unset
22860 This option names a file in which a record of every message sent is logged when
22861 the message is specified by the transport.
22862
22863
22864 .option mode autoreply "octal integer" 0600
22865 If either the log file or the &"once"& file has to be created, this mode is
22866 used.
22867
22868
22869 .option never_mail autoreply "address list&!!" unset
22870 If any run of the transport creates a message with a recipient that matches any
22871 item in the list, that recipient is quietly discarded. If all recipients are
22872 discarded, no message is created. This applies both when the recipients are
22873 generated by a filter and when they are specified in the transport.
22874
22875
22876
22877 .option once autoreply string&!! unset
22878 This option names a file or DBM database in which a record of each &'To:'&
22879 recipient is kept when the message is specified by the transport. &*Note*&:
22880 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22881
22882 If &%once%& is unset, or is set to an empty string, the message is always sent.
22883 By default, if &%once%& is set to a non-empty file name, the message
22884 is not sent if a potential recipient is already listed in the database.
22885 However, if the &%once_repeat%& option specifies a time greater than zero, the
22886 message is sent if that much time has elapsed since a message was last sent to
22887 this recipient. A setting of zero time for &%once_repeat%& (the default)
22888 prevents a message from being sent a second time &-- in this case, zero means
22889 infinity.
22890
22891 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22892 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22893 greater than zero, it changes the way Exim implements the &%once%& option.
22894 Instead of using a DBM file to record every recipient it sends to, it uses a
22895 regular file, whose size will never get larger than the given value.
22896
22897 In the file, Exim keeps a linear list of recipient addresses and the times at
22898 which they were sent messages. If the file is full when a new address needs to
22899 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22900 means that a given recipient may receive multiple messages, but at
22901 unpredictable intervals that depend on the rate of turnover of addresses in the
22902 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22903
22904
22905 .option once_file_size autoreply integer 0
22906 See &%once%& above.
22907
22908
22909 .option once_repeat autoreply time&!! 0s
22910 See &%once%& above.
22911 After expansion, the value of this option must be a valid time value.
22912
22913
22914 .option reply_to autoreply string&!! unset
22915 This specifies the contents of the &'Reply-To:'& header when the message is
22916 specified by the transport.
22917
22918
22919 .option return_message autoreply boolean false
22920 If this is set, a copy of the original message is returned with the new
22921 message, subject to the maximum size set in the &%return_size_limit%& global
22922 configuration option.
22923
22924
22925 .option subject autoreply string&!! unset
22926 This specifies the contents of the &'Subject:'& header when the message is
22927 specified by the transport. It is tempting to quote the original subject in
22928 automatic responses. For example:
22929 .code
22930 subject = Re: $h_subject:
22931 .endd
22932 There is a danger in doing this, however. It may allow a third party to
22933 subscribe your users to an opt-in mailing list, provided that the list accepts
22934 bounce messages as subscription confirmations. Well-managed lists require a
22935 non-bounce message to confirm a subscription, so the danger is relatively
22936 small.
22937
22938
22939
22940 .option text autoreply string&!! unset
22941 This specifies a single string to be used as the body of the message when the
22942 message is specified by the transport. If both &%text%& and &%file%& are set,
22943 the text comes first.
22944
22945
22946 .option to autoreply string&!! unset
22947 This specifies recipients of the message and the contents of the &'To:'& header
22948 when the message is specified by the transport.
22949 .ecindex IIDauttra1
22950 .ecindex IIDauttra2
22951
22952
22953
22954
22955 . ////////////////////////////////////////////////////////////////////////////
22956 . ////////////////////////////////////////////////////////////////////////////
22957
22958 .chapter "The lmtp transport" "CHAPLMTP"
22959 .cindex "transports" "&(lmtp)&"
22960 .cindex "&(lmtp)& transport"
22961 .cindex "LMTP" "over a pipe"
22962 .cindex "LMTP" "over a socket"
22963 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22964 specified command
22965 or by interacting with a Unix domain socket.
22966 This transport is something of a cross between the &(pipe)& and &(smtp)&
22967 transports. Exim also has support for using LMTP over TCP/IP; this is
22968 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22969 to be of minority interest, the default build-time configure in &_src/EDITME_&
22970 has it commented out. You need to ensure that
22971 .code
22972 TRANSPORT_LMTP=yes
22973 .endd
22974 .cindex "options" "&(lmtp)& transport"
22975 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22976 included in the Exim binary. The private options of the &(lmtp)& transport are
22977 as follows:
22978
22979 .option batch_id lmtp string&!! unset
22980 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22981
22982
22983 .option batch_max lmtp integer 1
22984 This limits the number of addresses that can be handled in a single delivery.
22985 Most LMTP servers can handle several addresses at once, so it is normally a
22986 good idea to increase this value. See the description of local delivery
22987 batching in chapter &<<CHAPbatching>>&.
22988
22989
22990 .option command lmtp string&!! unset
22991 This option must be set if &%socket%& is not set. The string is a command which
22992 is run in a separate process. It is split up into a command name and list of
22993 arguments, each of which is separately expanded (so expansion cannot change the
22994 number of arguments). The command is run directly, not via a shell. The message
22995 is passed to the new process using the standard input and output to operate the
22996 LMTP protocol.
22997
22998 .option ignore_quota lmtp boolean false
22999 .cindex "LMTP" "ignoring quota errors"
23000 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23001 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23002 in its response to the LHLO command.
23003
23004 .option socket lmtp string&!! unset
23005 This option must be set if &%command%& is not set. The result of expansion must
23006 be the name of a Unix domain socket. The transport connects to the socket and
23007 delivers the message to it using the LMTP protocol.
23008
23009
23010 .option timeout lmtp time 5m
23011 The transport is aborted if the created process or Unix domain socket does not
23012 respond to LMTP commands or message input within this timeout. Delivery
23013 is deferred, and will be tried again later. Here is an example of a typical
23014 LMTP transport:
23015 .code
23016 lmtp:
23017   driver = lmtp
23018   command = /some/local/lmtp/delivery/program
23019   batch_max = 20
23020   user = exim
23021 .endd
23022 This delivers up to 20 addresses at a time, in a mixture of domains if
23023 necessary, running as the user &'exim'&.
23024
23025
23026
23027 . ////////////////////////////////////////////////////////////////////////////
23028 . ////////////////////////////////////////////////////////////////////////////
23029
23030 .chapter "The pipe transport" "CHAPpipetransport"
23031 .scindex IIDpiptra1 "transports" "&(pipe)&"
23032 .scindex IIDpiptra2 "&(pipe)& transport"
23033 The &(pipe)& transport is used to deliver messages via a pipe to a command
23034 running in another process. One example is the use of &(pipe)& as a
23035 pseudo-remote transport for passing messages to some other delivery mechanism
23036 (such as UUCP). Another is the use by individual users to automatically process
23037 their incoming messages. The &(pipe)& transport can be used in one of the
23038 following ways:
23039
23040 .ilist
23041 .vindex "&$local_part$&"
23042 A router routes one address to a transport in the normal way, and the
23043 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23044 contains the local part of the address (as usual), and the command that is run
23045 is specified by the &%command%& option on the transport.
23046 .next
23047 .vindex "&$pipe_addresses$&"
23048 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23049 transport can handle more than one address in a single run. In this case, when
23050 more than one address is routed to the transport, &$local_part$& is not set
23051 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23052 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23053 that are routed to the transport.
23054 .next
23055 .vindex "&$address_pipe$&"
23056 A router redirects an address directly to a pipe command (for example, from an
23057 alias or forward file). In this case, &$address_pipe$& contains the text of the
23058 pipe command, and the &%command%& option on the transport is ignored unless
23059 &%force_command%& is set. If only one address is being transported
23060 (&%batch_max%& is not greater than one, or only one address was redirected to
23061 this pipe command), &$local_part$& contains the local part that was redirected.
23062 .endlist
23063
23064
23065 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23066 deliver messages over pipes using the LMTP interactive protocol. This is
23067 implemented by the &(lmtp)& transport.
23068
23069 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23070 &_.forward_& file, the command runs under the uid and gid of that user. In
23071 other cases, the uid and gid have to be specified explicitly, either on the
23072 transport or on the router that handles the address. Current and &"home"&
23073 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23074 details of the local delivery environment and chapter &<<CHAPbatching>>&
23075 for a discussion of local delivery batching.
23076
23077
23078 .section "Concurrent delivery" "SECID140"
23079 If two messages arrive at almost the same time, and both are routed to a pipe
23080 delivery, the two pipe transports may be run concurrently. You must ensure that
23081 any pipe commands you set up are robust against this happening. If the commands
23082 write to a file, the &%exim_lock%& utility might be of use.
23083 Alternatively the &%max_parallel%& option could be used with a value
23084 of "1" to enforce serialization.
23085
23086
23087
23088
23089 .section "Returned status and data" "SECID141"
23090 .cindex "&(pipe)& transport" "returned data"
23091 If the command exits with a non-zero return code, the delivery is deemed to
23092 have failed, unless either the &%ignore_status%& option is set (in which case
23093 the return code is treated as zero), or the return code is one of those listed
23094 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23095 later"&. In this case, delivery is deferred. Details of a permanent failure are
23096 logged, but are not included in the bounce message, which merely contains
23097 &"local delivery failed"&.
23098
23099 If the command exits on a signal and the &%freeze_signal%& option is set then
23100 the message will be frozen in the queue. If that option is not set, a bounce
23101 will be sent as normal.
23102
23103 If the return code is greater than 128 and the command being run is a shell
23104 script, it normally means that the script was terminated by a signal whose
23105 value is the return code minus 128. The &%freeze_signal%& option does not
23106 apply in this case.
23107
23108 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23109 return code is set to 127. This is the value that a shell returns if it is
23110 asked to run a non-existent command. The wording for the log line suggests that
23111 a non-existent command may be the problem.
23112
23113 The &%return_output%& option can affect the result of a pipe delivery. If it is
23114 set and the command produces any output on its standard output or standard
23115 error streams, the command is considered to have failed, even if it gave a zero
23116 return code or if &%ignore_status%& is set. The output from the command is
23117 included as part of the bounce message. The &%return_fail_output%& option is
23118 similar, except that output is returned only when the command exits with a
23119 failure return code, that is, a value other than zero or a code that matches
23120 &%temp_errors%&.
23121
23122
23123
23124 .section "How the command is run" "SECThowcommandrun"
23125 .cindex "&(pipe)& transport" "path for command"
23126 The command line is (by default) broken down into a command name and arguments
23127 by the &(pipe)& transport itself. The &%allow_commands%& and
23128 &%restrict_to_path%& options can be used to restrict the commands that may be
23129 run.
23130
23131 .cindex "quoting" "in pipe command"
23132 Unquoted arguments are delimited by white space. If an argument appears in
23133 double quotes, backslash is interpreted as an escape character in the usual
23134 way. If an argument appears in single quotes, no escaping is done.
23135
23136 String expansion is applied to the command line except when it comes from a
23137 traditional &_.forward_& file (commands from a filter file are expanded). The
23138 expansion is applied to each argument in turn rather than to the whole line.
23139 For this reason, any string expansion item that contains white space must be
23140 quoted so as to be contained within a single argument. A setting such as
23141 .code
23142 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23143 .endd
23144 will not work, because the expansion item gets split between several
23145 arguments. You have to write
23146 .code
23147 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23148 .endd
23149 to ensure that it is all in one argument. The expansion is done in this way,
23150 argument by argument, so that the number of arguments cannot be changed as a
23151 result of expansion, and quotes or backslashes in inserted variables do not
23152 interact with external quoting. However, this leads to problems if you want to
23153 generate multiple arguments (or the command name plus arguments) from a single
23154 expansion. In this situation, the simplest solution is to use a shell. For
23155 example:
23156 .code
23157 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23158 .endd
23159
23160 .cindex "transport" "filter"
23161 .cindex "filter" "transport filter"
23162 .vindex "&$pipe_addresses$&"
23163 Special handling takes place when an argument consists of precisely the text
23164 &`$pipe_addresses`&. This is not a general expansion variable; the only
23165 place this string is recognized is when it appears as an argument for a pipe or
23166 transport filter command. It causes each address that is being handled to be
23167 inserted in the argument list at that point &'as a separate argument'&. This
23168 avoids any problems with spaces or shell metacharacters, and is of use when a
23169 &(pipe)& transport is handling groups of addresses in a batch.
23170
23171 If &%force_command%& is enabled on the transport, Special handling takes place
23172 for an argument that consists of precisely the text &`$address_pipe`&.  It
23173 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23174 argument is inserted in the argument list at that point
23175 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23176 the only item in the argument; in fact, if it were then &%force_command%&
23177 should behave as a no-op.  Rather, it should be used to adjust the command
23178 run while preserving the argument vector separation.
23179
23180 After splitting up into arguments and expansion, the resulting command is run
23181 in a subprocess directly from the transport, &'not'& under a shell. The
23182 message that is being delivered is supplied on the standard input, and the
23183 standard output and standard error are both connected to a single pipe that is
23184 read by Exim. The &%max_output%& option controls how much output the command
23185 may produce, and the &%return_output%& and &%return_fail_output%& options
23186 control what is done with it.
23187
23188 Not running the command under a shell (by default) lessens the security risks
23189 in cases when a command from a user's filter file is built out of data that was
23190 taken from an incoming message. If a shell is required, it can of course be
23191 explicitly specified as the command to be run. However, there are circumstances
23192 where existing commands (for example, in &_.forward_& files) expect to be run
23193 under a shell and cannot easily be modified. To allow for these cases, there is
23194 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23195 works. Instead of breaking up the command line as just described, it expands it
23196 as a single string and passes the result to &_/bin/sh_&. The
23197 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23198 with &%use_shell%&, and the whole mechanism is inherently less secure.
23199
23200
23201
23202 .section "Environment variables" "SECTpipeenv"
23203 .cindex "&(pipe)& transport" "environment for command"
23204 .cindex "environment" "&(pipe)& transport"
23205 The environment variables listed below are set up when the command is invoked.
23206 This list is a compromise for maximum compatibility with other MTAs. Note that
23207 the &%environment%& option can be used to add additional variables to this
23208 environment. The environment for the &(pipe)& transport is not subject
23209 to the &%add_environment%& and &%keep_environment%& main config options.
23210 .display
23211 &`DOMAIN            `&   the domain of the address
23212 &`HOME              `&   the home directory, if set
23213 &`HOST              `&   the host name when called from a router (see below)
23214 &`LOCAL_PART        `&   see below
23215 &`LOCAL_PART_PREFIX `&   see below
23216 &`LOCAL_PART_SUFFIX `&   see below
23217 &`LOGNAME           `&   see below
23218 &`MESSAGE_ID        `&   Exim's local ID for the message
23219 &`PATH              `&   as specified by the &%path%& option below
23220 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23221 &`RECIPIENT         `&   the complete recipient address
23222 &`SENDER            `&   the sender of the message (empty if a bounce)
23223 &`SHELL             `&   &`/bin/sh`&
23224 &`TZ                `&   the value of the &%timezone%& option, if set
23225 &`USER              `&   see below
23226 .endd
23227 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23228 router, LOCAL_PART is set to the local part of the address. When it is
23229 called as a result of a forward or alias expansion, LOCAL_PART is set to
23230 the local part of the address that was expanded. In both cases, any affixes are
23231 removed from the local part, and made available in LOCAL_PART_PREFIX and
23232 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23233 same value as LOCAL_PART for compatibility with other MTAs.
23234
23235 .cindex "HOST"
23236 HOST is set only when a &(pipe)& transport is called from a router that
23237 associates hosts with an address, typically when using &(pipe)& as a
23238 pseudo-remote transport. HOST is set to the first host name specified by
23239 the router.
23240
23241 .cindex "HOME"
23242 If the transport's generic &%home_directory%& option is set, its value is used
23243 for the HOME environment variable. Otherwise, a home directory may be set
23244 by the router's &%transport_home_directory%& option, which defaults to the
23245 user's home directory if &%check_local_user%& is set.
23246
23247
23248 .section "Private options for pipe" "SECID142"
23249 .cindex "options" "&(pipe)& transport"
23250
23251
23252
23253 .option allow_commands pipe "string list&!!" unset
23254 .cindex "&(pipe)& transport" "permitted commands"
23255 The string is expanded, and is then interpreted as a colon-separated list of
23256 permitted commands. If &%restrict_to_path%& is not set, the only commands
23257 permitted are those in the &%allow_commands%& list. They need not be absolute
23258 paths; the &%path%& option is still used for relative paths. If
23259 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23260 in the &%allow_commands%& list, or a name without any slashes that is found on
23261 the path. In other words, if neither &%allow_commands%& nor
23262 &%restrict_to_path%& is set, there is no restriction on the command, but
23263 otherwise only commands that are permitted by one or the other are allowed. For
23264 example, if
23265 .code
23266 allow_commands = /usr/bin/vacation
23267 .endd
23268 and &%restrict_to_path%& is not set, the only permitted command is
23269 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23270 &%use_shell%& is set.
23271
23272
23273 .option batch_id pipe string&!! unset
23274 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23275
23276
23277 .option batch_max pipe integer 1
23278 This limits the number of addresses that can be handled in a single delivery.
23279 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23280
23281
23282 .option check_string pipe string unset
23283 As &(pipe)& writes the message, the start of each line is tested for matching
23284 &%check_string%&, and if it does, the initial matching characters are replaced
23285 by the contents of &%escape_string%&, provided both are set. The value of
23286 &%check_string%& is a literal string, not a regular expression, and the case of
23287 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23288 of &%check_string%& and &%escape_string%& are forced to values that implement
23289 the SMTP escaping protocol. Any settings made in the configuration file are
23290 ignored.
23291
23292
23293 .option command pipe string&!! unset
23294 This option need not be set when &(pipe)& is being used to deliver to pipes
23295 obtained directly from address redirections. In other cases, the option must be
23296 set, to provide a command to be run. It need not yield an absolute path (see
23297 the &%path%& option below). The command is split up into separate arguments by
23298 Exim, and each argument is separately expanded, as described in section
23299 &<<SECThowcommandrun>>& above.
23300
23301
23302 .option environment pipe string&!! unset
23303 .cindex "&(pipe)& transport" "environment for command"
23304 .cindex "environment" "&(pipe)& transport"
23305 This option is used to add additional variables to the environment in which the
23306 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23307 a string which is expanded, and then interpreted as a colon-separated list of
23308 environment settings of the form <&'name'&>=<&'value'&>.
23309
23310
23311 .option escape_string pipe string unset
23312 See &%check_string%& above.
23313
23314
23315 .option freeze_exec_fail pipe boolean false
23316 .cindex "exec failure"
23317 .cindex "failure of exec"
23318 .cindex "&(pipe)& transport" "failure of exec"
23319 Failure to exec the command in a pipe transport is by default treated like
23320 any other failure while running the command. However, if &%freeze_exec_fail%&
23321 is set, failure to exec is treated specially, and causes the message to be
23322 frozen, whatever the setting of &%ignore_status%&.
23323
23324
23325 .option freeze_signal pipe boolean false
23326 .cindex "signal exit"
23327 .cindex "&(pipe)& transport", "signal exit"
23328 Normally if the process run by a command in a pipe transport exits on a signal,
23329 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23330 frozen in Exim's queue instead.
23331
23332
23333 .option force_command pipe boolean false
23334 .cindex "force command"
23335 .cindex "&(pipe)& transport", "force command"
23336 Normally when a router redirects an address directly to a pipe command
23337 the &%command%& option on the transport is ignored.  If &%force_command%&
23338 is set, the &%command%& option will used. This is especially
23339 useful for forcing a wrapper or additional argument to be added to the
23340 command. For example:
23341 .code
23342 command = /usr/bin/remote_exec myhost -- $address_pipe
23343 force_command
23344 .endd
23345
23346 Note that &$address_pipe$& is handled specially in &%command%& when
23347 &%force_command%& is set, expanding out to the original argument vector as
23348 separate items, similarly to a Unix shell &`"$@"`& construct.
23349
23350
23351 .option ignore_status pipe boolean false
23352 If this option is true, the status returned by the subprocess that is set up to
23353 run the command is ignored, and Exim behaves as if zero had been returned.
23354 Otherwise, a non-zero status or termination by signal causes an error return
23355 from the transport unless the status value is one of those listed in
23356 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23357
23358 &*Note*&: This option does not apply to timeouts, which do not return a status.
23359 See the &%timeout_defer%& option for how timeouts are handled.
23360
23361
23362 .option log_defer_output pipe boolean false
23363 .cindex "&(pipe)& transport" "logging output"
23364 If this option is set, and the status returned by the command is
23365 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23366 and any output was produced on stdout or stderr, the first line of it is
23367 written to the main log.
23368
23369
23370 .option log_fail_output pipe boolean false
23371 If this option is set, and the command returns any output on stdout or
23372 stderr, and also ends with a return code that is neither zero nor one of
23373 the return codes listed in &%temp_errors%& (that is, the delivery
23374 failed), the first line of output is written to the main log. This
23375 option and &%log_output%& are mutually exclusive.  Only one of them may
23376 be set.
23377
23378
23379 .option log_output pipe boolean false
23380 If this option is set and the command returns any output on stdout or
23381 stderr, the first line of output is written to the main log, whatever
23382 the return code. This option and &%log_fail_output%& are mutually
23383 exclusive. Only one of them may be set.
23384
23385
23386 .option max_output pipe integer 20K
23387 This specifies the maximum amount of output that the command may produce on its
23388 standard output and standard error file combined. If the limit is exceeded, the
23389 process running the command is killed. This is intended as a safety measure to
23390 catch runaway processes. The limit is applied independently of the settings of
23391 the options that control what is done with such output (for example,
23392 &%return_output%&). Because of buffering effects, the amount of output may
23393 exceed the limit by a small amount before Exim notices.
23394
23395
23396 .option message_prefix pipe string&!! "see below"
23397 The string specified here is expanded and output at the start of every message.
23398 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23399 .code
23400 message_prefix = \
23401   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23402   ${tod_bsdinbox}\n
23403 .endd
23404 .cindex "Cyrus"
23405 .cindex "&%tmail%&"
23406 .cindex "&""From""& line"
23407 This is required by the commonly used &_/usr/bin/vacation_& program.
23408 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23409 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23410 setting
23411 .code
23412 message_prefix =
23413 .endd
23414 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23415 &`\n`& to &`\r\n`& in &%message_prefix%&.
23416
23417
23418 .option message_suffix pipe string&!! "see below"
23419 The string specified here is expanded and output at the end of every message.
23420 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23421 The suffix can be suppressed by setting
23422 .code
23423 message_suffix =
23424 .endd
23425 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23426 &`\n`& to &`\r\n`& in &%message_suffix%&.
23427
23428
23429 .option path pipe string&!! "/bin:/usr/bin"
23430 This option is expanded and
23431 specifies the string that is set up in the PATH environment
23432 variable of the subprocess.
23433 If the &%command%& option does not yield an absolute path name, the command is
23434 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23435 apply to a command specified as a transport filter.
23436
23437
23438 .option permit_coredump pipe boolean false
23439 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23440 a core-dump of a pipe command, enable this command.  This enables core-dumps
23441 during delivery and affects both the Exim binary and the pipe command run.
23442 It is recommended that this option remain off unless and until you have a need
23443 for it and that this only be enabled when needed, as the risk of excessive
23444 resource consumption can be quite high.  Note also that Exim is typically
23445 installed as a setuid binary and most operating systems will inhibit coredumps
23446 of these by default, so further OS-specific action may be required.
23447
23448
23449 .option pipe_as_creator pipe boolean false
23450 .cindex "uid (user id)" "local delivery"
23451 If the generic &%user%& option is not set and this option is true, the delivery
23452 process is run under the uid that was in force when Exim was originally called
23453 to accept the message. If the group id is not otherwise set (via the generic
23454 &%group%& option), the gid that was in force when Exim was originally called to
23455 accept the message is used.
23456
23457
23458 .option restrict_to_path pipe boolean false
23459 When this option is set, any command name not listed in &%allow_commands%& must
23460 contain no slashes. The command is searched for only in the directories listed
23461 in the &%path%& option. This option is intended for use in the case when a pipe
23462 command has been generated from a user's &_.forward_& file. This is usually
23463 handled by a &(pipe)& transport called &%address_pipe%&.
23464
23465
23466 .option return_fail_output pipe boolean false
23467 If this option is true, and the command produced any output and ended with a
23468 return code other than zero or one of the codes listed in &%temp_errors%& (that
23469 is, the delivery failed), the output is returned in the bounce message.
23470 However, if the message has a null sender (that is, it is itself a bounce
23471 message), output from the command is discarded. This option and
23472 &%return_output%& are mutually exclusive. Only one of them may be set.
23473
23474
23475
23476 .option return_output pipe boolean false
23477 If this option is true, and the command produced any output, the delivery is
23478 deemed to have failed whatever the return code from the command, and the output
23479 is returned in the bounce message. Otherwise, the output is just discarded.
23480 However, if the message has a null sender (that is, it is a bounce message),
23481 output from the command is always discarded, whatever the setting of this
23482 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23483 of them may be set.
23484
23485
23486
23487 .option temp_errors pipe "string list" "see below"
23488 .cindex "&(pipe)& transport" "temporary failure"
23489 This option contains either a colon-separated list of numbers, or a single
23490 asterisk. If &%ignore_status%& is false
23491 and &%return_output%& is not set,
23492 and the command exits with a non-zero return code, the failure is treated as
23493 temporary and the delivery is deferred if the return code matches one of the
23494 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23495 codes are treated as permanent errors. The default setting contains the codes
23496 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23497 compiled on a system that does not define these macros, it assumes values of 75
23498 and 73, respectively.
23499
23500
23501 .option timeout pipe time 1h
23502 If the command fails to complete within this time, it is killed. This normally
23503 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23504 specifies no timeout. In order to ensure that any subprocesses created by the
23505 command are also killed, Exim makes the initial process a process group leader,
23506 and kills the whole process group on a timeout. However, this can be defeated
23507 if one of the processes starts a new process group.
23508
23509 .option timeout_defer pipe boolean false
23510 A timeout in a &(pipe)& transport, either in the command that the transport
23511 runs, or in a transport filter that is associated with it, is by default
23512 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23513 is set true, both kinds of timeout become temporary errors, causing the
23514 delivery to be deferred.
23515
23516 .option umask pipe "octal integer" 022
23517 This specifies the umask setting for the subprocess that runs the command.
23518
23519
23520 .option use_bsmtp pipe boolean false
23521 .cindex "envelope sender"
23522 If this option is set true, the &(pipe)& transport writes messages in &"batch
23523 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23524 commands. If you want to include a leading HELO command with such messages,
23525 you can do so by setting the &%message_prefix%& option. See section
23526 &<<SECTbatchSMTP>>& for details of batch SMTP.
23527
23528 .option use_classresources pipe boolean false
23529 .cindex "class resources (BSD)"
23530 This option is available only when Exim is running on FreeBSD, NetBSD, or
23531 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23532 resource limits when a &(pipe)& transport is run to perform a delivery. The
23533 limits for the uid under which the pipe is to run are obtained from the login
23534 class database.
23535
23536
23537 .option use_crlf pipe boolean false
23538 .cindex "carriage return"
23539 .cindex "linefeed"
23540 This option causes lines to be terminated with the two-character CRLF sequence
23541 (carriage return, linefeed) instead of just a linefeed character. In the case
23542 of batched SMTP, the byte sequence written to the pipe is then an exact image
23543 of what would be sent down a real SMTP connection.
23544
23545 The contents of the &%message_prefix%& and &%message_suffix%& options are
23546 written verbatim, so must contain their own carriage return characters if these
23547 are needed. When &%use_bsmtp%& is not set, the default values for both
23548 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23549 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23550
23551
23552 .option use_shell pipe boolean false
23553 .vindex "&$pipe_addresses$&"
23554 If this option is set, it causes the command to be passed to &_/bin/sh_&
23555 instead of being run directly from the transport, as described in section
23556 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23557 where the command is expected to be run under a shell and cannot easily be
23558 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23559 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23560 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23561 its &%-c%& option.
23562
23563
23564
23565 .section "Using an external local delivery agent" "SECID143"
23566 .cindex "local delivery" "using an external agent"
23567 .cindex "&'procmail'&"
23568 .cindex "external local delivery"
23569 .cindex "delivery" "&'procmail'&"
23570 .cindex "delivery" "by external agent"
23571 The &(pipe)& transport can be used to pass all messages that require local
23572 delivery to a separate local delivery agent such as &%procmail%&. When doing
23573 this, care must be taken to ensure that the pipe is run under an appropriate
23574 uid and gid. In some configurations one wants this to be a uid that is trusted
23575 by the delivery agent to supply the correct sender of the message. It may be
23576 necessary to recompile or reconfigure the delivery agent so that it trusts an
23577 appropriate user. The following is an example transport and router
23578 configuration for &%procmail%&:
23579 .code
23580 # transport
23581 procmail_pipe:
23582   driver = pipe
23583   command = /usr/local/bin/procmail -d $local_part
23584   return_path_add
23585   delivery_date_add
23586   envelope_to_add
23587   check_string = "From "
23588   escape_string = ">From "
23589   umask = 077
23590   user = $local_part
23591   group = mail
23592
23593 # router
23594 procmail:
23595   driver = accept
23596   check_local_user
23597   transport = procmail_pipe
23598 .endd
23599 In this example, the pipe is run as the local user, but with the group set to
23600 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23601 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23602 user to supply a correct sender address. If you do not specify either a
23603 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23604 home directory is the user's home directory by default.
23605
23606 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23607 .code
23608 IFS=" "
23609 .endd
23610 as shown in some &%procmail%& documentation, because Exim does not by default
23611 use a shell to run pipe commands.
23612
23613 .cindex "Cyrus"
23614 The next example shows a transport and a router for a system where local
23615 deliveries are handled by the Cyrus IMAP server.
23616 .code
23617 # transport
23618 local_delivery_cyrus:
23619   driver = pipe
23620   command = /usr/cyrus/bin/deliver \
23621             -m ${substr_1:$local_part_suffix} -- $local_part
23622   user = cyrus
23623   group = mail
23624   return_output
23625   log_output
23626   message_prefix =
23627   message_suffix =
23628
23629 # router
23630 local_user_cyrus:
23631   driver = accept
23632   check_local_user
23633   local_part_suffix = .*
23634   transport = local_delivery_cyrus
23635 .endd
23636 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23637 &%return_output%& to cause any text written by Cyrus to be returned to the
23638 sender.
23639 .ecindex IIDpiptra1
23640 .ecindex IIDpiptra2
23641
23642
23643 . ////////////////////////////////////////////////////////////////////////////
23644 . ////////////////////////////////////////////////////////////////////////////
23645
23646 .chapter "The smtp transport" "CHAPsmtptrans"
23647 .scindex IIDsmttra1 "transports" "&(smtp)&"
23648 .scindex IIDsmttra2 "&(smtp)& transport"
23649 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23650 or LMTP protocol. The list of hosts to try can either be taken from the address
23651 that is being processed (having been set up by the router), or specified
23652 explicitly for the transport. Timeout and retry processing (see chapter
23653 &<<CHAPretry>>&) is applied to each IP address independently.
23654
23655
23656 .section "Multiple messages on a single connection" "SECID144"
23657 The sending of multiple messages over a single TCP/IP connection can arise in
23658 two ways:
23659
23660 .ilist
23661 If a message contains more than &%max_rcpt%& (see below) addresses that are
23662 routed to the same host, more than one copy of the message has to be sent to
23663 that host. In this situation, multiple copies may be sent in a single run of
23664 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23665 does when it has too many addresses to send in one message also depends on the
23666 value of the global &%remote_max_parallel%& option. Details are given in
23667 section &<<SECToutSMTPTCP>>&.)
23668 .next
23669 .cindex "hints database" "remembering routing"
23670 When a message has been successfully delivered over a TCP/IP connection, Exim
23671 looks in its hints database to see if there are any other messages awaiting a
23672 connection to the same host. If there are, a new delivery process is started
23673 for one of them, and the current TCP/IP connection is passed on to it. The new
23674 process may in turn send multiple copies and possibly create yet another
23675 process.
23676 .endlist
23677
23678
23679 For each copy sent over the same TCP/IP connection, a sequence counter is
23680 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23681 no further messages are sent over that connection.
23682
23683
23684
23685 .section "Use of the $host and $host_address variables" "SECID145"
23686 .vindex "&$host$&"
23687 .vindex "&$host_address$&"
23688 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23689 &$host_address$& are the name and IP address of the first host on the host list
23690 passed by the router. However, when the transport is about to connect to a
23691 specific host, and while it is connected to that host, &$host$& and
23692 &$host_address$& are set to the values for that host. These are the values
23693 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23694 &%serialize_hosts%&, and the various TLS options are expanded.
23695
23696
23697 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23698 .vindex &$tls_bits$&
23699 .vindex &$tls_cipher$&
23700 .vindex &$tls_peerdn$&
23701 .vindex &$tls_sni$&
23702 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23703 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23704 are the values that were set when the message was received.
23705 These are the values that are used for options that are expanded before any
23706 SMTP connections are made. Just before each connection is made, these four
23707 variables are emptied. If TLS is subsequently started, they are set to the
23708 appropriate values for the outgoing connection, and these are the values that
23709 are in force when any authenticators are run and when the
23710 &%authenticated_sender%& option is expanded.
23711
23712 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23713 and will be removed in a future release.
23714
23715
23716 .section "Private options for smtp" "SECID146"
23717 .cindex "options" "&(smtp)& transport"
23718 The private options of the &(smtp)& transport are as follows:
23719
23720
23721 .option address_retry_include_sender smtp boolean true
23722 .cindex "4&'xx'& responses" "retrying after"
23723 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23724 is the combination of sender and recipient that is delayed in subsequent queue
23725 runs until the retry time is reached. You can delay the recipient without
23726 reference to the sender (which is what earlier versions of Exim did), by
23727 setting &%address_retry_include_sender%& false. However, this can lead to
23728 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23729
23730 .option allow_localhost smtp boolean false
23731 .cindex "local host" "sending to"
23732 .cindex "fallback" "hosts specified on transport"
23733 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23734 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23735 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23736 the delivery anyway. This should be used only in special cases when the
23737 configuration ensures that no looping will result (for example, a differently
23738 configured Exim is listening on the port to which the message is sent).
23739
23740
23741 .option authenticated_sender smtp string&!! unset
23742 .cindex "Cyrus"
23743 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23744 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23745 overriding any existing authenticated sender value. If the string expansion is
23746 forced to fail, the option is ignored. Other expansion failures cause delivery
23747 to be deferred. If the result of expansion is an empty string, that is also
23748 ignored.
23749
23750 The expansion happens after the outgoing connection has been made and TLS
23751 started, if required. This means that the &$host$&, &$host_address$&,
23752 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23753 particular connection.
23754
23755 If the SMTP session is not authenticated, the expansion of
23756 &%authenticated_sender%& still happens (and can cause the delivery to be
23757 deferred if it fails), but no AUTH= item is added to MAIL commands
23758 unless &%authenticated_sender_force%& is true.
23759
23760 This option allows you to use the &(smtp)& transport in LMTP mode to
23761 deliver mail to Cyrus IMAP and provide the proper local part as the
23762 &"authenticated sender"&, via a setting such as:
23763 .code
23764 authenticated_sender = $local_part
23765 .endd
23766 This removes the need for IMAP subfolders to be assigned special ACLs to
23767 allow direct delivery to those subfolders.
23768
23769 Because of expected uses such as that just described for Cyrus (when no
23770 domain is involved), there is no checking on the syntax of the provided
23771 value.
23772
23773
23774 .option authenticated_sender_force smtp boolean false
23775 If this option is set true, the &%authenticated_sender%& option's value
23776 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23777 authenticated as a client.
23778
23779
23780 .option command_timeout smtp time 5m
23781 This sets a timeout for receiving a response to an SMTP command that has been
23782 sent out. It is also used when waiting for the initial banner line from the
23783 remote host. Its value must not be zero.
23784
23785
23786 .option connect_timeout smtp time 5m
23787 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23788 to a remote host. A setting of zero allows the system timeout (typically
23789 several minutes) to act. To have any effect, the value of this option must be
23790 less than the system timeout. However, it has been observed that on some
23791 systems there is no system timeout, which is why the default value for this
23792 option is 5 minutes, a value recommended by RFC 1123.
23793
23794
23795 .option connection_max_messages smtp integer 500
23796 .cindex "SMTP" "passed connection"
23797 .cindex "SMTP" "multiple deliveries"
23798 .cindex "multiple SMTP deliveries"
23799 This controls the maximum number of separate message deliveries that are sent
23800 over a single TCP/IP connection. If the value is zero, there is no limit.
23801 For testing purposes, this value can be overridden by the &%-oB%& command line
23802 option.
23803
23804
23805 .option data_timeout smtp time 5m
23806 This sets a timeout for the transmission of each block in the data portion of
23807 the message. As a result, the overall timeout for a message depends on the size
23808 of the message. Its value must not be zero. See also &%final_timeout%&.
23809
23810
23811 .option dkim_domain smtp string list&!! unset
23812 .option dkim_selector smtp string&!! unset
23813 .option dkim_private_key smtp string&!! unset
23814 .option dkim_canon smtp string&!! unset
23815 .option dkim_strict smtp string&!! unset
23816 .option dkim_sign_headers smtp string&!! "per RFC"
23817 .option dkim_hash smtp string&!! sha256
23818 .option dkim_identity smtp string&!! unset
23819 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
23820
23821
23822 .option delay_after_cutoff smtp boolean true
23823 This option controls what happens when all remote IP addresses for a given
23824 domain have been inaccessible for so long that they have passed their retry
23825 cutoff times.
23826
23827 In the default state, if the next retry time has not been reached for any of
23828 them, the address is bounced without trying any deliveries. In other words,
23829 Exim delays retrying an IP address after the final cutoff time until a new
23830 retry time is reached, and can therefore bounce an address without ever trying
23831 a delivery, when machines have been down for a long time. Some people are
23832 unhappy at this prospect, so...
23833
23834 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23835 addresses are past their final cutoff time, Exim tries to deliver to those
23836 IP addresses that have not been tried since the message arrived. If there are
23837 none, of if they all fail, the address is bounced. In other words, it does not
23838 delay when a new message arrives, but immediately tries those expired IP
23839 addresses that haven't been tried since the message arrived. If there is a
23840 continuous stream of messages for the dead hosts, unsetting
23841 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23842 to them.
23843
23844
23845 .option dns_qualify_single smtp boolean true
23846 If the &%hosts%& or &%fallback_hosts%& option is being used,
23847 and the &%gethostbyname%& option is false,
23848 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23849 in chapter &<<CHAPdnslookup>>& for more details.
23850
23851
23852 .option dns_search_parents smtp boolean false
23853 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23854 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23855 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23856 details.
23857
23858
23859 .option dnssec_request_domains smtp "domain list&!!" unset
23860 .cindex "MX record" "security"
23861 .cindex "DNSSEC" "MX lookup"
23862 .cindex "security" "MX lookup"
23863 .cindex "DNS" "DNSSEC"
23864 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23865 the dnssec request bit set.
23866 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23867
23868
23869
23870 .option dnssec_require_domains smtp "domain list&!!" unset
23871 .cindex "MX record" "security"
23872 .cindex "DNSSEC" "MX lookup"
23873 .cindex "security" "MX lookup"
23874 .cindex "DNS" "DNSSEC"
23875 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23876 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23877 (AD bit) set will be ignored and logged as a host-lookup failure.
23878 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23879
23880
23881
23882 .option dscp smtp string&!! unset
23883 .cindex "DCSP" "outbound"
23884 This option causes the DSCP value associated with a socket to be set to one
23885 of a number of fixed strings or to numeric value.
23886 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23887 Common values include &`throughput`&, &`mincost`&, and on newer systems
23888 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23889
23890 The outbound packets from Exim will be marked with this value in the header
23891 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23892 that these values will have any effect, not be stripped by networking
23893 equipment, or do much of anything without cooperation with your Network
23894 Engineer and those of all network operators between the source and destination.
23895
23896
23897 .option fallback_hosts smtp "string list" unset
23898 .cindex "fallback" "hosts specified on transport"
23899 String expansion is not applied to this option. The argument must be a
23900 colon-separated list of host names or IP addresses, optionally also including
23901 port numbers, though the separator can be changed, as described in section
23902 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23903 item in a &%route_list%& setting for the &(manualroute)& router, as described
23904 in section &<<SECTformatonehostitem>>&.
23905
23906 Fallback hosts can also be specified on routers, which associate them with the
23907 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23908 &%fallback_hosts%& specified on the transport is used only if the address does
23909 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23910 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23911 However, &%hosts_randomize%& does apply to fallback host lists.
23912
23913 If Exim is unable to deliver to any of the hosts for a particular address, and
23914 the errors are not permanent rejections, the address is put on a separate
23915 transport queue with its host list replaced by the fallback hosts, unless the
23916 address was routed via MX records and the current host was in the original MX
23917 list. In that situation, the fallback host list is not used.
23918
23919 Once normal deliveries are complete, the fallback queue is delivered by
23920 re-running the same transports with the new host lists. If several failing
23921 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23922 copy of the message is sent.
23923
23924 The resolution of the host names on the fallback list is controlled by the
23925 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23926 both to cases when the host list comes with the address and when it is taken
23927 from &%hosts%&. This option provides a &"use a smart host only if delivery
23928 fails"& facility.
23929
23930
23931 .option final_timeout smtp time 10m
23932 This is the timeout that applies while waiting for the response to the final
23933 line containing just &"."& that terminates a message. Its value must not be
23934 zero.
23935
23936 .option gethostbyname smtp boolean false
23937 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23938 being used, names are looked up using &[gethostbyname()]&
23939 (or &[getipnodebyname()]& when available)
23940 instead of using the DNS. Of course, that function may in fact use the DNS, but
23941 it may also consult other sources of information such as &_/etc/hosts_&.
23942
23943 .option gnutls_compat_mode smtp boolean unset
23944 This option controls whether GnuTLS is used in compatibility mode in an Exim
23945 server. This reduces security slightly, but improves interworking with older
23946 implementations of TLS.
23947
23948 .option helo_data smtp string&!! "see below"
23949 .cindex "HELO" "argument, setting"
23950 .cindex "EHLO" "argument, setting"
23951 .cindex "LHLO argument setting"
23952 The value of this option is expanded after a connection to a another host has
23953 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23954 command that starts the outgoing SMTP or LMTP session. The default value of the
23955 option is:
23956 .code
23957 $primary_hostname
23958 .endd
23959 During the expansion, the variables &$host$& and &$host_address$& are set to
23960 the identity of the remote host, and the variables &$sending_ip_address$& and
23961 &$sending_port$& are set to the local IP address and port number that are being
23962 used. These variables can be used to generate different values for different
23963 servers or different local IP addresses. For example, if you want the string
23964 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23965 interface address, you could use this:
23966 .code
23967 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23968   {$primary_hostname}}
23969 .endd
23970 The use of &%helo_data%& applies both to sending messages and when doing
23971 callouts.
23972
23973 .option hosts smtp "string list&!!" unset
23974 Hosts are associated with an address by a router such as &(dnslookup)&, which
23975 finds the hosts by looking up the address domain in the DNS, or by
23976 &(manualroute)&, which has lists of hosts in its configuration. However,
23977 email addresses can be passed to the &(smtp)& transport by any router, and not
23978 all of them can provide an associated list of hosts.
23979
23980 The &%hosts%& option specifies a list of hosts to be used if the address being
23981 processed does not have any hosts associated with it. The hosts specified by
23982 &%hosts%& are also used, whether or not the address has its own hosts, if
23983 &%hosts_override%& is set.
23984
23985 The string is first expanded, before being interpreted as a colon-separated
23986 list of host names or IP addresses, possibly including port numbers. The
23987 separator may be changed to something other than colon, as described in section
23988 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23989 item in a &%route_list%& setting for the &(manualroute)& router, as described
23990 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23991 of the &(manualroute)& router is not available here.
23992
23993 If the expansion fails, delivery is deferred. Unless the failure was caused by
23994 the inability to complete a lookup, the error is logged to the panic log as
23995 well as the main log. Host names are looked up either by searching directly for
23996 address records in the DNS or by calling &[gethostbyname()]& (or
23997 &[getipnodebyname()]& when available), depending on the setting of the
23998 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23999 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24000 address are used.
24001
24002 During delivery, the hosts are tried in order, subject to their retry status,
24003 unless &%hosts_randomize%& is set.
24004
24005
24006 .option hosts_avoid_esmtp smtp "host list&!!" unset
24007 .cindex "ESMTP, avoiding use of"
24008 .cindex "HELO" "forcing use of"
24009 .cindex "EHLO" "avoiding use of"
24010 .cindex "PIPELINING" "avoiding the use of"
24011 This option is for use with broken hosts that announce ESMTP facilities (for
24012 example, PIPELINING) and then fail to implement them properly. When a host
24013 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24014 start of the SMTP session. This means that it cannot use any of the ESMTP
24015 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24016
24017
24018 .option hosts_avoid_pipelining smtp "host list&!!" unset
24019 .cindex "PIPELINING" "avoiding the use of"
24020 Exim will not use the SMTP PIPELINING extension when delivering to any host
24021 that matches this list, even if the server host advertises PIPELINING support.
24022
24023
24024 .option hosts_avoid_tls smtp "host list&!!" unset
24025 .cindex "TLS" "avoiding for certain hosts"
24026 Exim will not try to start a TLS session when delivering to any host that
24027 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24028
24029 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24030 .cindex "TLS" "avoiding for certain hosts"
24031 Exim will not try to start a TLS session for a verify callout,
24032 or when delivering in cutthrough mode,
24033 to any host that matches this list.
24034
24035
24036 .option hosts_max_try smtp integer 5
24037 .cindex "host" "maximum number to try"
24038 .cindex "limit" "number of hosts tried"
24039 .cindex "limit" "number of MX tried"
24040 .cindex "MX record" "maximum tried"
24041 This option limits the number of IP addresses that are tried for any one
24042 delivery in cases where there are temporary delivery errors. Section
24043 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24044
24045
24046 .option hosts_max_try_hardlimit smtp integer 50
24047 This is an additional check on the maximum number of IP addresses that Exim
24048 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24049 why it exists.
24050
24051
24052
24053 .option hosts_nopass_tls smtp "host list&!!" unset
24054 .cindex "TLS" "passing connection"
24055 .cindex "multiple SMTP deliveries"
24056 .cindex "TLS" "multiple message deliveries"
24057 For any host that matches this list, a connection on which a TLS session has
24058 been started will not be passed to a new delivery process for sending another
24059 message on the same connection. See section &<<SECTmulmessam>>& for an
24060 explanation of when this might be needed.
24061
24062 .new
24063 .option hosts_noproxy_tls smtp "host list&!!" *
24064 .cindex "TLS" "passing connection"
24065 .cindex "multiple SMTP deliveries"
24066 .cindex "TLS" "multiple message deliveries"
24067 For any host that matches this list, a TLS session which has
24068 been started will not be passed to a new delivery process for sending another
24069 message on the same session.
24070
24071 The traditional implementation closes down TLS and re-starts it in the new
24072 process, on the same open TCP connection, for each successive message
24073 sent.  If permitted by this option a pipe to to the new process is set up
24074 instead, and the original process maintains the TLS connection and proxies
24075 the SMTP connection from and to the new process and any subsequents.
24076 The new process has no access to TLS information, so cannot include it in
24077 logging.
24078 .wen
24079
24080
24081
24082 .option hosts_override smtp boolean false
24083 If this option is set and the &%hosts%& option is also set, any hosts that are
24084 attached to the address are ignored, and instead the hosts specified by the
24085 &%hosts%& option are always used. This option does not apply to
24086 &%fallback_hosts%&.
24087
24088
24089 .option hosts_randomize smtp boolean false
24090 .cindex "randomized host list"
24091 .cindex "host" "list of; randomized"
24092 .cindex "fallback" "randomized hosts"
24093 If this option is set, and either the list of hosts is taken from the
24094 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24095 were not obtained from MX records (this includes fallback hosts from the
24096 router), and were not randomized by the router, the order of trying the hosts
24097 is randomized each time the transport runs. Randomizing the order of a host
24098 list can be used to do crude load sharing.
24099
24100 When &%hosts_randomize%& is true, a host list may be split into groups whose
24101 order is separately randomized. This makes it possible to set up MX-like
24102 behaviour. The boundaries between groups are indicated by an item that is just
24103 &`+`& in the host list. For example:
24104 .code
24105 hosts = host1:host2:host3:+:host4:host5
24106 .endd
24107 The order of the first three hosts and the order of the last two hosts is
24108 randomized for each use, but the first three always end up before the last two.
24109 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24110
24111 .option hosts_require_auth smtp "host list&!!" unset
24112 .cindex "authentication" "required by client"
24113 This option provides a list of servers for which authentication must succeed
24114 before Exim will try to transfer a message. If authentication fails for
24115 servers which are not in this list, Exim tries to send unauthenticated. If
24116 authentication fails for one of these servers, delivery is deferred. This
24117 temporary error is detectable in the retry rules, so it can be turned into a
24118 hard failure if required. See also &%hosts_try_auth%&, and chapter
24119 &<<CHAPSMTPAUTH>>& for details of authentication.
24120
24121
24122 .option hosts_request_ocsp smtp "host list&!!" *
24123 .cindex "TLS" "requiring for certain servers"
24124 Exim will request a Certificate Status on a
24125 TLS session for any host that matches this list.
24126 &%tls_verify_certificates%& should also be set for the transport.
24127
24128 .option hosts_require_ocsp smtp "host list&!!" unset
24129 .cindex "TLS" "requiring for certain servers"
24130 Exim will request, and check for a valid Certificate Status being given, on a
24131 TLS session for any host that matches this list.
24132 &%tls_verify_certificates%& should also be set for the transport.
24133
24134 .option hosts_require_tls smtp "host list&!!" unset
24135 .cindex "TLS" "requiring for certain servers"
24136 Exim will insist on using a TLS session when delivering to any host that
24137 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24138 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24139 incoming messages, use an appropriate ACL.
24140
24141 .option hosts_try_auth smtp "host list&!!" unset
24142 .cindex "authentication" "optional in client"
24143 This option provides a list of servers to which, provided they announce
24144 authentication support, Exim will attempt to authenticate as a client when it
24145 connects. If authentication fails, Exim will try to transfer the message
24146 unauthenticated. See also &%hosts_require_auth%&, and chapter
24147 &<<CHAPSMTPAUTH>>& for details of authentication.
24148
24149 .option hosts_try_chunking smtp "host list&!!" *
24150 .cindex CHUNKING "enabling, in client"
24151 .cindex BDAT "SMTP command"
24152 .cindex "RFC 3030" "CHUNKING"
24153 This option provides a list of servers to which, provided they announce
24154 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24155 BDAT will not be used in conjunction with a transport filter.
24156
24157 .option hosts_try_fastopen smtp "host list&!!" unset
24158 .cindex "fast open, TCP" "enabling, in client"
24159 .cindex "TCP Fast Open" "enabling, in client"
24160 .cindex "RFC 7413" "TCP Fast Open"
24161 This option provides a list of servers to which, provided
24162 the facility is supported by this system, Exim will attempt to
24163 perform a TCP Fast Open.
24164 No data is sent on the SYN segment but, if the remote server also
24165 supports the facility, it can send its SMTP banner immediately after
24166 the SYN,ACK segment.  This can save up to one round-trip time.
24167
24168 The facility is only active for previously-contacted servers,
24169 as the initiator must present a cookie in the SYN segment.
24170
24171 On (at least some) current Linux distributions the facility must be enabled
24172 in the kernel by the sysadmin before the support is usable.
24173 There is no option for control of the server side; if the system supports
24174 it it is always enebled.  Note that legthy operations in the connect ACL,
24175 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24176
24177 .option hosts_try_prdr smtp "host list&!!" *
24178 .cindex "PRDR" "enabling, optional in client"
24179 This option provides a list of servers to which, provided they announce
24180 PRDR support, Exim will attempt to negotiate PRDR
24181 for multi-recipient messages.
24182 The option can usually be left as default.
24183
24184 .option interface smtp "string list&!!" unset
24185 .cindex "bind IP address"
24186 .cindex "IP address" "binding"
24187 .vindex "&$host$&"
24188 .vindex "&$host_address$&"
24189 This option specifies which interface to bind to when making an outgoing SMTP
24190 call. The value is an IP address, not an interface name such as
24191 &`eth0`&. Do not confuse this with the interface address that was used when a
24192 message was received, which is in &$received_ip_address$&, formerly known as
24193 &$interface_address$&. The name was changed to minimize confusion with the
24194 outgoing interface address. There is no variable that contains an outgoing
24195 interface address because, unless it is set by this option, its value is
24196 unknown.
24197
24198 During the expansion of the &%interface%& option the variables &$host$& and
24199 &$host_address$& refer to the host to which a connection is about to be made
24200 during the expansion of the string. Forced expansion failure, or an empty
24201 string result causes the option to be ignored. Otherwise, after expansion, the
24202 string must be a list of IP addresses, colon-separated by default, but the
24203 separator can be changed in the usual way. For example:
24204 .code
24205 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24206 .endd
24207 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24208 connection. If none of them are the correct type, the option is ignored. If
24209 &%interface%& is not set, or is ignored, the system's IP functions choose which
24210 interface to use if the host has more than one.
24211
24212
24213 .option keepalive smtp boolean true
24214 .cindex "keepalive" "on outgoing connection"
24215 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24216 connections. When set, it causes the kernel to probe idle connections
24217 periodically, by sending packets with &"old"& sequence numbers. The other end
24218 of the connection should send a acknowledgment if the connection is still okay
24219 or a reset if the connection has been aborted. The reason for doing this is
24220 that it has the beneficial effect of freeing up certain types of connection
24221 that can get stuck when the remote host is disconnected without tidying up the
24222 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24223 unreachable hosts.
24224
24225
24226 .option lmtp_ignore_quota smtp boolean false
24227 .cindex "LMTP" "ignoring quota errors"
24228 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24229 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24230 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24231
24232 .option max_rcpt smtp integer 100
24233 .cindex "RCPT" "maximum number of outgoing"
24234 This option limits the number of RCPT commands that are sent in a single
24235 SMTP message transaction. Each set of addresses is treated independently, and
24236 so can cause parallel connections to the same host if &%remote_max_parallel%&
24237 permits this.
24238
24239
24240 .option multi_domain smtp boolean&!! true
24241 .vindex "&$domain$&"
24242 When this option is set, the &(smtp)& transport can handle a number of
24243 addresses containing a mixture of different domains provided they all resolve
24244 to the same list of hosts. Turning the option off restricts the transport to
24245 handling only one domain at a time. This is useful if you want to use
24246 &$domain$& in an expansion for the transport, because it is set only when there
24247 is a single domain involved in a remote delivery.
24248
24249 It is expanded per-address and can depend on any of
24250 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24251 &$host$&, &$host_address$& and &$host_port$&.
24252
24253 .option port smtp string&!! "see below"
24254 .cindex "port" "sending TCP/IP"
24255 .cindex "TCP/IP" "setting outgoing port"
24256 This option specifies the TCP/IP port on the server to which Exim connects.
24257 &*Note:*& Do not confuse this with the port that was used when a message was
24258 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24259 The name was changed to minimize confusion with the outgoing port. There is no
24260 variable that contains an outgoing port.
24261
24262 If the value of this option begins with a digit it is taken as a port number;
24263 otherwise it is looked up using &[getservbyname()]&. The default value is
24264 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24265 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24266 is deferred.
24267
24268
24269
24270 .option protocol smtp string smtp
24271 .cindex "LMTP" "over TCP/IP"
24272 .cindex "ssmtp protocol" "outbound"
24273 .cindex "TLS" "SSL-on-connect outbound"
24274 .vindex "&$port$&"
24275 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24276 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24277 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24278 deliveries into closed message stores. Exim also has support for running LMTP
24279 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24280
24281 If this option is set to &"smtps"&, the default value for the &%port%& option
24282 changes to &"smtps"&, and the transport initiates TLS immediately after
24283 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24284 The Internet standards bodies strongly discourage use of this mode.
24285
24286
24287 .option retry_include_ip_address smtp boolean&!! true
24288 Exim normally includes both the host name and the IP address in the key it
24289 constructs for indexing retry data after a temporary delivery failure. This
24290 means that when one of several IP addresses for a host is failing, it gets
24291 tried periodically (controlled by the retry rules), but use of the other IP
24292 addresses is not affected.
24293
24294 However, in some dialup environments hosts are assigned a different IP address
24295 each time they connect. In this situation the use of the IP address as part of
24296 the retry key leads to undesirable behaviour. Setting this option false causes
24297 Exim to use only the host name.
24298 Since it is expanded it can be made to depend on the host or domain.
24299
24300
24301 .option serialize_hosts smtp "host list&!!" unset
24302 .cindex "serializing connections"
24303 .cindex "host" "serializing connections"
24304 Because Exim operates in a distributed manner, if several messages for the same
24305 host arrive at around the same time, more than one simultaneous connection to
24306 the remote host can occur. This is not usually a problem except when there is a
24307 slow link between the hosts. In that situation it may be helpful to restrict
24308 Exim to one connection at a time. This can be done by setting
24309 &%serialize_hosts%& to match the relevant hosts.
24310
24311 .cindex "hints database" "serializing deliveries to a host"
24312 Exim implements serialization by means of a hints database in which a record is
24313 written whenever a process connects to one of the restricted hosts. The record
24314 is deleted when the connection is completed. Obviously there is scope for
24315 records to get left lying around if there is a system or program crash. To
24316 guard against this, Exim ignores any records that are more than six hours old.
24317
24318 If you set up this kind of serialization, you should also arrange to delete the
24319 relevant hints database whenever your system reboots. The names of the files
24320 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24321 may be one or two files, depending on the type of DBM in use. The same files
24322 are used for ETRN serialization.
24323
24324 See also the &%max_parallel%& generic transport option.
24325
24326
24327 .option size_addition smtp integer 1024
24328 .cindex "SMTP" "SIZE"
24329 .cindex "message" "size issue for transport filter"
24330 .cindex "size" "of message"
24331 .cindex "transport" "filter"
24332 .cindex "filter" "transport filter"
24333 If a remote SMTP server indicates that it supports the SIZE option of the
24334 MAIL command, Exim uses this to pass over the message size at the start of
24335 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24336 sends, to allow for headers and other text that may be added during delivery by
24337 configuration options or in a transport filter. It may be necessary to increase
24338 this if a lot of text is added to messages.
24339
24340 Alternatively, if the value of &%size_addition%& is set negative, it disables
24341 the use of the SIZE option altogether.
24342
24343
24344 .option socks_proxy smtp string&!! unset
24345 .cindex proxy SOCKS
24346 This option enables use of SOCKS proxies for connections made by the
24347 transport.  For details see section &<<SECTproxySOCKS>>&.
24348
24349
24350 .option tls_certificate smtp string&!! unset
24351 .cindex "TLS" "client certificate, location of"
24352 .cindex "certificate" "client, location of"
24353 .vindex "&$host$&"
24354 .vindex "&$host_address$&"
24355 The value of this option must be the absolute path to a file which contains the
24356 client's certificate, for possible use when sending a message over an encrypted
24357 connection. The values of &$host$& and &$host_address$& are set to the name and
24358 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24359 details of TLS.
24360
24361 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24362 certificate when sending messages as a client. The global option of the same
24363 name specifies the certificate for Exim as a server; it is not automatically
24364 assumed that the same certificate should be used when Exim is operating as a
24365 client.
24366
24367
24368 .option tls_crl smtp string&!! unset
24369 .cindex "TLS" "client certificate revocation list"
24370 .cindex "certificate" "revocation list for client"
24371 This option specifies a certificate revocation list. The expanded value must
24372 be the name of a file that contains a CRL in PEM format.
24373
24374
24375 .option tls_dh_min_bits smtp integer 1024
24376 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24377 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24378 key agreement is negotiated, the server will provide a large prime number
24379 for use.  This option establishes the minimum acceptable size of that number.
24380 If the parameter offered by the server is too small, then the TLS handshake
24381 will fail.
24382
24383 Only supported when using GnuTLS.
24384
24385
24386 .option tls_privatekey smtp string&!! unset
24387 .cindex "TLS" "client private key, location of"
24388 .vindex "&$host$&"
24389 .vindex "&$host_address$&"
24390 The value of this option must be the absolute path to a file which contains the
24391 client's private key. This is used when sending a message over an encrypted
24392 connection using a client certificate. The values of &$host$& and
24393 &$host_address$& are set to the name and address of the server during the
24394 expansion. If this option is unset, or the expansion is forced to fail, or the
24395 result is an empty string, the private key is assumed to be in the same file as
24396 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24397
24398
24399 .option tls_require_ciphers smtp string&!! unset
24400 .cindex "TLS" "requiring specific ciphers"
24401 .cindex "cipher" "requiring specific"
24402 .vindex "&$host$&"
24403 .vindex "&$host_address$&"
24404 The value of this option must be a list of permitted cipher suites, for use
24405 when setting up an outgoing encrypted connection. (There is a global option of
24406 the same name for controlling incoming connections.) The values of &$host$& and
24407 &$host_address$& are set to the name and address of the server during the
24408 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24409 is used in different ways by OpenSSL and GnuTLS (see sections
24410 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24411 ciphers is a preference order.
24412
24413
24414
24415 .option tls_sni smtp string&!! unset
24416 .cindex "TLS" "Server Name Indication"
24417 .vindex "&$tls_sni$&"
24418 If this option is set then it sets the $tls_out_sni variable and causes any
24419 TLS session to pass this value as the Server Name Indication extension to
24420 the remote side, which can be used by the remote side to select an appropriate
24421 certificate and private key for the session.
24422
24423 See &<<SECTtlssni>>& for more information.
24424
24425 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24426 TLS extensions.
24427
24428
24429
24430
24431 .option tls_tempfail_tryclear smtp boolean true
24432 .cindex "4&'xx'& responses" "to STARTTLS"
24433 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24434 setting up a TLS session, this option determines whether or not Exim should try
24435 to deliver the message unencrypted. If it is set false, delivery to the
24436 current host is deferred; if there are other hosts, they are tried. If this
24437 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24438 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24439 TLS negotiation fails, Exim closes the current connection (because it is in an
24440 unknown state), opens a new one to the same host, and then tries the delivery
24441 in clear.
24442
24443
24444 .option tls_try_verify_hosts smtp "host list&!!" *
24445 .cindex "TLS" "server certificate verification"
24446 .cindex "certificate" "verification of server"
24447 This option gives a list of hosts for which, on encrypted connections,
24448 certificate verification will be tried but need not succeed.
24449 The &%tls_verify_certificates%& option must also be set.
24450 Note that unless the host is in this list
24451 TLS connections will be denied to hosts using self-signed certificates
24452 when &%tls_verify_certificates%& is matched.
24453 The &$tls_out_certificate_verified$& variable is set when
24454 certificate verification succeeds.
24455
24456
24457 .option tls_verify_cert_hostnames smtp "host list&!!" *
24458 .cindex "TLS" "server certificate hostname verification"
24459 .cindex "certificate" "verification of server"
24460 This option give a list of hosts for which,
24461 while verifying the server certificate,
24462 checks will be included on the host name
24463 (note that this will generally be the result of a DNS MX lookup)
24464 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24465 limited to being the initial component of a 3-or-more component FQDN.
24466
24467 There is no equivalent checking on client certificates.
24468
24469
24470 .option tls_verify_certificates smtp string&!! system
24471 .cindex "TLS" "server certificate verification"
24472 .cindex "certificate" "verification of server"
24473 .vindex "&$host$&"
24474 .vindex "&$host_address$&"
24475 The value of this option must be either the
24476 word "system"
24477 or the absolute path to
24478 a file or directory containing permitted certificates for servers,
24479 for use when setting up an encrypted connection.
24480
24481 The "system" value for the option will use a location compiled into the SSL library.
24482 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24483 is taken as empty and an explicit location
24484 must be specified.
24485
24486 The use of a directory for the option value is not available for GnuTLS versions
24487 preceding 3.3.6 and a single file must be used.
24488
24489 With OpenSSL the certificates specified
24490 explicitly
24491 either by file or directory
24492 are added to those given by the system default location.
24493
24494 The values of &$host$& and
24495 &$host_address$& are set to the name and address of the server during the
24496 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24497
24498 For back-compatibility,
24499 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24500 (a single-colon empty list counts as being set)
24501 and certificate verification fails the TLS connection is closed.
24502
24503
24504 .option tls_verify_hosts smtp "host list&!!" unset
24505 .cindex "TLS" "server certificate verification"
24506 .cindex "certificate" "verification of server"
24507 This option gives a list of hosts for which, on encrypted connections,
24508 certificate verification must succeed.
24509 The &%tls_verify_certificates%& option must also be set.
24510 If both this option and &%tls_try_verify_hosts%& are unset
24511 operation is as if this option selected all hosts.
24512
24513
24514
24515
24516 .section "How the limits for the number of hosts to try are used" &&&
24517          "SECTvalhosmax"
24518 .cindex "host" "maximum number to try"
24519 .cindex "limit" "hosts; maximum number tried"
24520 There are two options that are concerned with the number of hosts that are
24521 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24522 &%hosts_max_try_hardlimit%&.
24523
24524
24525 The &%hosts_max_try%& option limits the number of hosts that are tried
24526 for a single delivery. However, despite the term &"host"& in its name, the
24527 option actually applies to each IP address independently. In other words, a
24528 multihomed host is treated as several independent hosts, just as it is for
24529 retrying.
24530
24531 Many of the larger ISPs have multiple MX records which often point to
24532 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24533 created as a result of routing one of these domains.
24534
24535 Trying every single IP address on such a long list does not seem sensible; if
24536 several at the top of the list fail, it is reasonable to assume there is some
24537 problem that is likely to affect all of them. Roughly speaking, the value of
24538 &%hosts_max_try%& is the maximum number that are tried before deferring the
24539 delivery. However, the logic cannot be quite that simple.
24540
24541 Firstly, IP addresses that are skipped because their retry times have not
24542 arrived do not count, and in addition, addresses that are past their retry
24543 limits are also not counted, even when they are tried. This means that when
24544 some IP addresses are past their retry limits, more than the value of
24545 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24546 that all IP addresses are considered before timing out an email address (but
24547 see below for an exception).
24548
24549 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24550 list to see if there is a subsequent host with a different (higher valued) MX.
24551 If there is, that host is considered next, and the current IP address is used
24552 but not counted. This behaviour helps in the case of a domain with a retry rule
24553 that hardly ever delays any hosts, as is now explained:
24554
24555 Consider the case of a long list of hosts with one MX value, and a few with a
24556 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24557 hosts at the top of the list are tried at first. With the default retry rule,
24558 which specifies increasing retry times, the higher MX hosts are eventually
24559 tried when those at the top of the list are skipped because they have not
24560 reached their retry times.
24561
24562 However, it is common practice to put a fixed short retry time on domains for
24563 large ISPs, on the grounds that their servers are rarely down for very long.
24564 Unfortunately, these are exactly the domains that tend to resolve to long lists
24565 of hosts. The short retry time means that the lowest MX hosts are tried every
24566 time. The attempts may be in a different order because of random sorting, but
24567 without the special MX check, the higher MX hosts would never be tried until
24568 all the lower MX hosts had timed out (which might be several days), because
24569 there are always some lower MX hosts that have reached their retry times. With
24570 the special check, Exim considers at least one IP address from each MX value at
24571 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24572 reached.
24573
24574 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24575 particular, Exim normally eventually tries all the IP addresses before timing
24576 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24577 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24578 been set up with hundreds of IP addresses for some domains. It can
24579 take a very long time indeed for an address to time out in these cases.
24580
24581 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24582 Exim never tries more than this number of IP addresses; if it hits this limit
24583 and they are all timed out, the email address is bounced, even though not all
24584 possible IP addresses have been tried.
24585 .ecindex IIDsmttra1
24586 .ecindex IIDsmttra2
24587
24588
24589
24590
24591
24592 . ////////////////////////////////////////////////////////////////////////////
24593 . ////////////////////////////////////////////////////////////////////////////
24594
24595 .chapter "Address rewriting" "CHAPrewrite"
24596 .scindex IIDaddrew "rewriting" "addresses"
24597 There are some circumstances in which Exim automatically rewrites domains in
24598 addresses. The two most common are when an address is given without a domain
24599 (referred to as an &"unqualified address"&) or when an address contains an
24600 abbreviated domain that is expanded by DNS lookup.
24601
24602 Unqualified envelope addresses are accepted only for locally submitted
24603 messages, or for messages that are received from hosts matching
24604 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24605 appropriate. Unqualified addresses in header lines are qualified if they are in
24606 locally submitted messages, or messages from hosts that are permitted to send
24607 unqualified envelope addresses. Otherwise, unqualified addresses in header
24608 lines are neither qualified nor rewritten.
24609
24610 One situation in which Exim does &'not'& automatically rewrite a domain is
24611 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24612 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24613 do this. The new RFCs do not contain this suggestion.
24614
24615
24616 .section "Explicitly configured address rewriting" "SECID147"
24617 This chapter describes the rewriting rules that can be used in the
24618 main rewrite section of the configuration file, and also in the generic
24619 &%headers_rewrite%& option that can be set on any transport.
24620
24621 Some people believe that configured address rewriting is a Mortal Sin.
24622 Others believe that life is not possible without it. Exim provides the
24623 facility; you do not have to use it.
24624
24625 The main rewriting rules that appear in the &"rewrite"& section of the
24626 configuration file are applied to addresses in incoming messages, both envelope
24627 addresses and addresses in header lines. Each rule specifies the types of
24628 address to which it applies.
24629
24630 Whether or not addresses in header lines are rewritten depends on the origin of
24631 the headers and the type of rewriting. Global rewriting, that is, rewriting
24632 rules from the rewrite section of the configuration file, is applied only to
24633 those headers that were received with the message. Header lines that are added
24634 by ACLs or by a system filter or by individual routers or transports (which
24635 are specific to individual recipient addresses) are not rewritten by the global
24636 rules.
24637
24638 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24639 applies all headers except those added by routers and transports. That is, as
24640 well as the headers that were received with the message, it also applies to
24641 headers that were added by an ACL or a system filter.
24642
24643
24644 In general, rewriting addresses from your own system or domain has some
24645 legitimacy. Rewriting other addresses should be done only with great care and
24646 in special circumstances. The author of Exim believes that rewriting should be
24647 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24648 Although it can sometimes be used as a routing tool, this is very strongly
24649 discouraged.
24650
24651 There are two commonly encountered circumstances where rewriting is used, as
24652 illustrated by these examples:
24653
24654 .ilist
24655 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24656 exchange mail with each other behind a firewall, but there is only a single
24657 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24658 &'hitch.fict.example'& when sending mail off-site.
24659 .next
24660 A host rewrites the local parts of its own users so that, for example,
24661 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24662 .endlist
24663
24664
24665
24666 .section "When does rewriting happen?" "SECID148"
24667 .cindex "rewriting" "timing of"
24668 .cindex "&ACL;" "rewriting addresses in"
24669 Configured address rewriting can take place at several different stages of a
24670 message's processing.
24671
24672 .vindex "&$sender_address$&"
24673 At the start of an ACL for MAIL, the sender address may have been rewritten
24674 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24675 ordinary rewrite rules have yet been applied. If, however, the sender address
24676 is verified in the ACL, it is rewritten before verification, and remains
24677 rewritten thereafter. The subsequent value of &$sender_address$& is the
24678 rewritten address. This also applies if sender verification happens in a
24679 RCPT ACL. Otherwise, when the sender address is not verified, it is
24680 rewritten as soon as a message's header lines have been received.
24681
24682 .vindex "&$domain$&"
24683 .vindex "&$local_part$&"
24684 Similarly, at the start of an ACL for RCPT, the current recipient's address
24685 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24686 rewrite rules have yet been applied to it. However, the behaviour is different
24687 from the sender address when a recipient is verified. The address is rewritten
24688 for the verification, but the rewriting is not remembered at this stage. The
24689 value of &$local_part$& and &$domain$& after verification are always the same
24690 as they were before (that is, they contain the unrewritten &-- except for
24691 SMTP-time rewriting &-- address).
24692
24693 As soon as a message's header lines have been received, all the envelope
24694 recipient addresses are permanently rewritten, and rewriting is also applied to
24695 the addresses in the header lines (if configured). This happens before adding
24696 any header lines that were specified in MAIL or RCPT ACLs, and
24697 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24698 before the DATA ACL and &[local_scan()]& functions are run.
24699
24700 When an address is being routed, either for delivery or for verification,
24701 rewriting is applied immediately to child addresses that are generated by
24702 redirection, unless &%no_rewrite%& is set on the router.
24703
24704 .cindex "envelope sender" "rewriting at transport time"
24705 .cindex "rewriting" "at transport time"
24706 .cindex "header lines" "rewriting at transport time"
24707 At transport time, additional rewriting of addresses in header lines can be
24708 specified by setting the generic &%headers_rewrite%& option on a transport.
24709 This option contains rules that are identical in form to those in the rewrite
24710 section of the configuration file. They are applied to the original message
24711 header lines and any that were added by ACLs or a system filter. They are not
24712 applied to header lines that are added by routers or the transport.
24713
24714 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24715 transport option. However, it is not possible to rewrite envelope recipients at
24716 transport time.
24717
24718
24719
24720
24721 .section "Testing the rewriting rules that apply on input" "SECID149"
24722 .cindex "rewriting" "testing"
24723 .cindex "testing" "rewriting"
24724 Exim's input rewriting configuration appears in a part of the run time
24725 configuration file headed by &"begin rewrite"&. It can be tested by the
24726 &%-brw%& command line option. This takes an address (which can be a full RFC
24727 2822 address) as its argument. The output is a list of how the address would be
24728 transformed by the rewriting rules for each of the different places it might
24729 appear in an incoming message, that is, for each different header and for the
24730 envelope sender and recipient fields. For example,
24731 .code
24732 exim -brw ph10@exim.workshop.example
24733 .endd
24734 might produce the output
24735 .code
24736 sender: Philip.Hazel@exim.workshop.example
24737 from: Philip.Hazel@exim.workshop.example
24738 to: ph10@exim.workshop.example
24739 cc: ph10@exim.workshop.example
24740 bcc: ph10@exim.workshop.example
24741 reply-to: Philip.Hazel@exim.workshop.example
24742 env-from: Philip.Hazel@exim.workshop.example
24743 env-to: ph10@exim.workshop.example
24744 .endd
24745 which shows that rewriting has been set up for that address when used in any of
24746 the source fields, but not when it appears as a recipient address. At the
24747 present time, there is no equivalent way of testing rewriting rules that are
24748 set for a particular transport.
24749
24750
24751 .section "Rewriting rules" "SECID150"
24752 .cindex "rewriting" "rules"
24753 The rewrite section of the configuration file consists of lines of rewriting
24754 rules in the form
24755 .display
24756 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24757 .endd
24758 Rewriting rules that are specified for the &%headers_rewrite%& generic
24759 transport option are given as a colon-separated list. Each item in the list
24760 takes the same form as a line in the main rewriting configuration (except that
24761 any colons must be doubled, of course).
24762
24763 The formats of source patterns and replacement strings are described below.
24764 Each is terminated by white space, unless enclosed in double quotes, in which
24765 case normal quoting conventions apply inside the quotes. The flags are single
24766 characters which may appear in any order. Spaces and tabs between them are
24767 ignored.
24768
24769 For each address that could potentially be rewritten, the rules are scanned in
24770 order, and replacements for the address from earlier rules can themselves be
24771 replaced by later rules (but see the &"q"& and &"R"& flags).
24772
24773 The order in which addresses are rewritten is undefined, may change between
24774 releases, and must not be relied on, with one exception: when a message is
24775 received, the envelope sender is always rewritten first, before any header
24776 lines are rewritten. For example, the replacement string for a rewrite of an
24777 address in &'To:'& must not assume that the message's address in &'From:'& has
24778 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24779 that the envelope sender has already been rewritten.
24780
24781 .vindex "&$domain$&"
24782 .vindex "&$local_part$&"
24783 The variables &$local_part$& and &$domain$& can be used in the replacement
24784 string to refer to the address that is being rewritten. Note that lookup-driven
24785 rewriting can be done by a rule of the form
24786 .code
24787 *@*   ${lookup ...
24788 .endd
24789 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24790 refer to the address that is being rewritten.
24791
24792
24793 .section "Rewriting patterns" "SECID151"
24794 .cindex "rewriting" "patterns"
24795 .cindex "address list" "in a rewriting pattern"
24796 The source pattern in a rewriting rule is any item which may appear in an
24797 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24798 single-item address list, which means that it is expanded before being tested
24799 against the address. As always, if you use a regular expression as a pattern,
24800 you must take care to escape dollar and backslash characters, or use the &`\N`&
24801 facility to suppress string expansion within the regular expression.
24802
24803 Domains in patterns should be given in lower case. Local parts in patterns are
24804 case-sensitive. If you want to do case-insensitive matching of local parts, you
24805 can use a regular expression that starts with &`^(?i)`&.
24806
24807 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24808 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24809 depending on the type of match which occurred. These can be used in the
24810 replacement string to insert portions of the incoming address. &$0$& always
24811 refers to the complete incoming address. When a regular expression is used, the
24812 numerical variables are set from its capturing subexpressions. For other types
24813 of pattern they are set as follows:
24814
24815 .ilist
24816 If a local part or domain starts with an asterisk, the numerical variables
24817 refer to the character strings matched by asterisks, with &$1$& associated with
24818 the first asterisk, and &$2$& with the second, if present. For example, if the
24819 pattern
24820 .code
24821 *queen@*.fict.example
24822 .endd
24823 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24824 .code
24825 $0 = hearts-queen@wonderland.fict.example
24826 $1 = hearts-
24827 $2 = wonderland
24828 .endd
24829 Note that if the local part does not start with an asterisk, but the domain
24830 does, it is &$1$& that contains the wild part of the domain.
24831
24832 .next
24833 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24834 of the domain are placed in the next available numerical variables. Suppose,
24835 for example, that the address &'foo@bar.baz.example'& is processed by a
24836 rewriting rule of the form
24837 .display
24838 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24839 .endd
24840 and the key in the file that matches the domain is &`*.baz.example`&. Then
24841 .code
24842 $1 = foo
24843 $2 = bar
24844 $3 = baz.example
24845 .endd
24846 If the address &'foo@baz.example'& is looked up, this matches the same
24847 wildcard file entry, and in this case &$2$& is set to the empty string, but
24848 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24849 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24850 whole domain. For non-partial domain lookups, no numerical variables are set.
24851 .endlist
24852
24853
24854 .section "Rewriting replacements" "SECID152"
24855 .cindex "rewriting" "replacements"
24856 If the replacement string for a rule is a single asterisk, addresses that
24857 match the pattern and the flags are &'not'& rewritten, and no subsequent
24858 rewriting rules are scanned. For example,
24859 .code
24860 hatta@lookingglass.fict.example  *  f
24861 .endd
24862 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24863 &'From:'& headers.
24864
24865 .vindex "&$domain$&"
24866 .vindex "&$local_part$&"
24867 If the replacement string is not a single asterisk, it is expanded, and must
24868 yield a fully qualified address. Within the expansion, the variables
24869 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24870 Any letters they contain retain their original case &-- they are not lower
24871 cased. The numerical variables are set up according to the type of pattern that
24872 matched the address, as described above. If the expansion is forced to fail by
24873 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24874 current rule is abandoned, but subsequent rules may take effect. Any other
24875 expansion failure causes the entire rewriting operation to be abandoned, and an
24876 entry written to the panic log.
24877
24878
24879
24880 .section "Rewriting flags" "SECID153"
24881 There are three different kinds of flag that may appear on rewriting rules:
24882
24883 .ilist
24884 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24885 c, f, h, r, s, t.
24886 .next
24887 A flag that specifies rewriting at SMTP time: S.
24888 .next
24889 Flags that control the rewriting process: Q, q, R, w.
24890 .endlist
24891
24892 For rules that are part of the &%headers_rewrite%& generic transport option,
24893 E, F, T, and S are not permitted.
24894
24895
24896
24897 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24898          "SECID154"
24899 .cindex "rewriting" "flags"
24900 If none of the following flag letters, nor the &"S"& flag (see section
24901 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24902 and to both the sender and recipient fields of the envelope, whereas a
24903 transport-time rewriting rule just applies to all headers. Otherwise, the
24904 rewriting rule is skipped unless the relevant addresses are being processed.
24905 .display
24906 &`E`&       rewrite all envelope fields
24907 &`F`&       rewrite the envelope From field
24908 &`T`&       rewrite the envelope To field
24909 &`b`&       rewrite the &'Bcc:'& header
24910 &`c`&       rewrite the &'Cc:'& header
24911 &`f`&       rewrite the &'From:'& header
24912 &`h`&       rewrite all headers
24913 &`r`&       rewrite the &'Reply-To:'& header
24914 &`s`&       rewrite the &'Sender:'& header
24915 &`t`&       rewrite the &'To:'& header
24916 .endd
24917 "All headers" means all of the headers listed above that can be selected
24918 individually, plus their &'Resent-'& versions. It does not include
24919 other headers such as &'Subject:'& etc.
24920
24921 You should be particularly careful about rewriting &'Sender:'& headers, and
24922 restrict this to special known cases in your own domains.
24923
24924
24925 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24926 .cindex "SMTP" "rewriting malformed addresses"
24927 .cindex "RCPT" "rewriting argument of"
24928 .cindex "MAIL" "rewriting argument of"
24929 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24930 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24931 before any other processing; even before syntax checking. The pattern is
24932 required to be a regular expression, and it is matched against the whole of the
24933 data for the command, including any surrounding angle brackets.
24934
24935 .vindex "&$domain$&"
24936 .vindex "&$local_part$&"
24937 This form of rewrite rule allows for the handling of addresses that are not
24938 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24939 input). Because the input is not required to be a syntactically valid address,
24940 the variables &$local_part$& and &$domain$& are not available during the
24941 expansion of the replacement string. The result of rewriting replaces the
24942 original address in the MAIL or RCPT command.
24943
24944
24945 .section "Flags controlling the rewriting process" "SECID155"
24946 There are four flags which control the way the rewriting process works. These
24947 take effect only when a rule is invoked, that is, when the address is of the
24948 correct type (matches the flags) and matches the pattern:
24949
24950 .ilist
24951 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24952 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24953 absence of &"Q"& the rewritten address must always include a domain.
24954 .next
24955 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24956 even if no rewriting actually takes place because of a &"fail"& in the
24957 expansion. The &"q"& flag is not effective if the address is of the wrong type
24958 (does not match the flags) or does not match the pattern.
24959 .next
24960 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24961 address, up to ten times. It can be combined with the &"q"& flag, to stop
24962 rewriting once it fails to match (after at least one successful rewrite).
24963 .next
24964 .cindex "rewriting" "whole addresses"
24965 When an address in a header is rewritten, the rewriting normally applies only
24966 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24967 left unchanged. For example, rewriting might change
24968 .code
24969 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24970 .endd
24971 into
24972 .code
24973 From: Ford Prefect <prefectf@hitch.fict.example>
24974 .endd
24975 .cindex "RFC 2047"
24976 Sometimes there is a need to replace the whole address item, and this can be
24977 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24978 causes an address in a header line to be rewritten, the entire address is
24979 replaced, not just the working part. The replacement must be a complete RFC
24980 2822 address, including the angle brackets if necessary. If text outside angle
24981 brackets contains a character whose value is greater than 126 or less than 32
24982 (except for tab), the text is encoded according to RFC 2047. The character set
24983 is taken from &%headers_charset%&, which gets its default at build time.
24984
24985 When the &"w"& flag is set on a rule that causes an envelope address to be
24986 rewritten, all but the working part of the replacement address is discarded.
24987 .endlist
24988
24989
24990 .section "Rewriting examples" "SECID156"
24991 Here is an example of the two common rewriting paradigms:
24992 .code
24993 *@*.hitch.fict.example  $1@hitch.fict.example
24994 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24995                      {$value}fail}@hitch.fict.example bctfrF
24996 .endd
24997 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24998 the string expansion to fail if the lookup does not succeed. In this context it
24999 has the effect of leaving the original address unchanged, but Exim goes on to
25000 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25001 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25002 explicitly, which would cause the rewritten address to be the same as before,
25003 at the cost of a small bit of processing. Not supplying either of these is an
25004 error, since the rewritten address would then contain no local part.
25005
25006 The first example above replaces the domain with a superior, more general
25007 domain. This may not be desirable for certain local parts. If the rule
25008 .code
25009 root@*.hitch.fict.example  *
25010 .endd
25011 were inserted before the first rule, rewriting would be suppressed for the
25012 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25013
25014 Rewriting can be made conditional on a number of tests, by making use of
25015 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25016 messages that originate outside the local host:
25017 .code
25018 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25019                          {$1@hitch.fict.example}fail}"
25020 .endd
25021 The replacement string is quoted in this example because it contains white
25022 space.
25023
25024 .cindex "rewriting" "bang paths"
25025 .cindex "bang paths" "rewriting"
25026 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25027 an address it treats it as an unqualified local part which it qualifies with
25028 the local qualification domain (if the source of the message is local or if the
25029 remote host is permitted to send unqualified addresses). Rewriting can
25030 sometimes be used to handle simple bang paths with a fixed number of
25031 components. For example, the rule
25032 .code
25033 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25034 .endd
25035 rewrites a two-component bang path &'host.name!user'& as the domain address
25036 &'user@host.name'&. However, there is a security implication in using this as
25037 a global rewriting rule for envelope addresses. It can provide a backdoor
25038 method for using your system as a relay, because the incoming addresses appear
25039 to be local. If the bang path addresses are received via SMTP, it is safer to
25040 use the &"S"& flag to rewrite them as they are received, so that relay checking
25041 can be done on the rewritten addresses.
25042 .ecindex IIDaddrew
25043
25044
25045
25046
25047
25048 . ////////////////////////////////////////////////////////////////////////////
25049 . ////////////////////////////////////////////////////////////////////////////
25050
25051 .chapter "Retry configuration" "CHAPretry"
25052 .scindex IIDretconf1 "retry" "configuration, description of"
25053 .scindex IIDregconf2 "configuration file" "retry section"
25054 The &"retry"& section of the runtime configuration file contains a list of
25055 retry rules that control how often Exim tries to deliver messages that cannot
25056 be delivered at the first attempt. If there are no retry rules (the section is
25057 empty or not present), there are no retries. In this situation, temporary
25058 errors are treated as permanent. The default configuration contains a single,
25059 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25060 line option can be used to test which retry rule will be used for a given
25061 address, domain and error.
25062
25063 The most common cause of retries is temporary failure to deliver to a remote
25064 host because the host is down, or inaccessible because of a network problem.
25065 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25066 address) basis, not on a per-message basis. Thus, if one message has recently
25067 been delayed, delivery of a new message to the same host is not immediately
25068 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25069 log selector is set, the message
25070 .cindex "retry" "time not reached"
25071 &"retry time not reached"& is written to the main log whenever a delivery is
25072 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25073 the handling of errors during remote deliveries.
25074
25075 Retry processing applies to routing as well as to delivering, except as covered
25076 in the next paragraph. The retry rules do not distinguish between these
25077 actions. It is not possible, for example, to specify different behaviour for
25078 failures to route the domain &'snark.fict.example'& and failures to deliver to
25079 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25080 added complication, so did not implement it. However, although they share the
25081 same retry rule, the actual retry times for routing and transporting a given
25082 domain are maintained independently.
25083
25084 When a delivery is not part of a queue run (typically an immediate delivery on
25085 receipt of a message), the routers are always run, and local deliveries are
25086 always attempted, even if retry times are set for them. This makes for better
25087 behaviour if one particular message is causing problems (for example, causing
25088 quota overflow, or provoking an error in a filter file). If such a delivery
25089 suffers a temporary failure, the retry data is updated as normal, and
25090 subsequent delivery attempts from queue runs occur only when the retry time for
25091 the local address is reached.
25092
25093 .section "Changing retry rules" "SECID157"
25094 If you change the retry rules in your configuration, you should consider
25095 whether or not to delete the retry data that is stored in Exim's spool area in
25096 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25097 always safe; that is why they are called &"hints"&.
25098
25099 The hints retry data contains suggested retry times based on the previous
25100 rules. In the case of a long-running problem with a remote host, it might
25101 record the fact that the host has timed out. If your new rules increase the
25102 timeout time for such a host, you should definitely remove the old retry data
25103 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25104 messages that it should now be retaining.
25105
25106
25107
25108 .section "Format of retry rules" "SECID158"
25109 .cindex "retry" "rules"
25110 Each retry rule occupies one line and consists of three or four parts,
25111 separated by white space: a pattern, an error name, an optional list of sender
25112 addresses, and a list of retry parameters. The pattern and sender lists must be
25113 enclosed in double quotes if they contain white space. The rules are searched
25114 in order until one is found where the pattern, error name, and sender list (if
25115 present) match the failing host or address, the error that occurred, and the
25116 message's sender, respectively.
25117
25118
25119 The pattern is any single item that may appear in an address list (see section
25120 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25121 which means that it is expanded before being tested against the address that
25122 has been delayed. A negated address list item is permitted. Address
25123 list processing treats a plain domain name as if it were preceded by &"*@"&,
25124 which makes it possible for many retry rules to start with just a domain. For
25125 example,
25126 .code
25127 lookingglass.fict.example        *  F,24h,30m;
25128 .endd
25129 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25130 whereas
25131 .code
25132 alice@lookingglass.fict.example  *  F,24h,30m;
25133 .endd
25134 applies only to temporary failures involving the local part &%alice%&.
25135 In practice, almost all rules start with a domain name pattern without a local
25136 part.
25137
25138 .cindex "regular expressions" "in retry rules"
25139 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25140 must match a complete address, not just a domain, because that is how regular
25141 expressions work in address lists.
25142 .display
25143 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25144 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25145 .endd
25146
25147
25148 .section "Choosing which retry rule to use for address errors" "SECID159"
25149 When Exim is looking for a retry rule after a routing attempt has failed (for
25150 example, after a DNS timeout), each line in the retry configuration is tested
25151 against the complete address only if &%retry_use_local_part%& is set for the
25152 router. Otherwise, only the domain is used, except when matching against a
25153 regular expression, when the local part of the address is replaced with &"*"&.
25154 A domain on its own can match a domain pattern, or a pattern that starts with
25155 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25156 &%check_local_user%& is true, and false for other routers.
25157
25158 Similarly, when Exim is looking for a retry rule after a local delivery has
25159 failed (for example, after a mailbox full error), each line in the retry
25160 configuration is tested against the complete address only if
25161 &%retry_use_local_part%& is set for the transport (it defaults true for all
25162 local transports).
25163
25164 .cindex "4&'xx'& responses" "retry rules for"
25165 However, when Exim is looking for a retry rule after a remote delivery attempt
25166 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25167 whole address is always used as the key when searching the retry rules. The
25168 rule that is found is used to create a retry time for the combination of the
25169 failing address and the message's sender. It is the combination of sender and
25170 recipient that is delayed in subsequent queue runs until its retry time is
25171 reached. You can delay the recipient without regard to the sender by setting
25172 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25173 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25174 commands.
25175
25176
25177
25178 .section "Choosing which retry rule to use for host and message errors" &&&
25179          "SECID160"
25180 For a temporary error that is not related to an individual address (for
25181 example, a connection timeout), each line in the retry configuration is checked
25182 twice. First, the name of the remote host is used as a domain name (preceded by
25183 &"*@"& when matching a regular expression). If this does not match the line,
25184 the domain from the email address is tried in a similar fashion. For example,
25185 suppose the MX records for &'a.b.c.example'& are
25186 .code
25187 a.b.c.example  MX  5  x.y.z.example
25188                MX  6  p.q.r.example
25189                MX  7  m.n.o.example
25190 .endd
25191 and the retry rules are
25192 .code
25193 p.q.r.example    *      F,24h,30m;
25194 a.b.c.example    *      F,4d,45m;
25195 .endd
25196 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25197 first rule matches neither the host nor the domain, so Exim looks at the second
25198 rule. This does not match the host, but it does match the domain, so it is used
25199 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25200 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25201 first retry rule is used, because it matches the host.
25202
25203 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25204 first rule to determine retry times, but for all the other hosts for the domain
25205 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25206 routing to &'a.b.c.example'& suffers a temporary failure.
25207
25208 &*Note*&: The host name is used when matching the patterns, not its IP address.
25209 However, if a message is routed directly to an IP address without the use of a
25210 host name, for example, if a &(manualroute)& router contains a setting such as:
25211 .code
25212 route_list = *.a.example  192.168.34.23
25213 .endd
25214 then the &"host name"& that is used when searching for a retry rule is the
25215 textual form of the IP address.
25216
25217 .section "Retry rules for specific errors" "SECID161"
25218 .cindex "retry" "specific errors; specifying"
25219 The second field in a retry rule is the name of a particular error, or an
25220 asterisk, which matches any error. The errors that can be tested for are:
25221
25222 .vlist
25223 .vitem &%auth_failed%&
25224 Authentication failed when trying to send to a host in the
25225 &%hosts_require_auth%& list in an &(smtp)& transport.
25226
25227 .vitem &%data_4xx%&
25228 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25229 after the command, or after sending the message's data.
25230
25231 .vitem &%mail_4xx%&
25232 A 4&'xx'& error was received for an outgoing MAIL command.
25233
25234 .vitem &%rcpt_4xx%&
25235 A 4&'xx'& error was received for an outgoing RCPT command.
25236 .endlist
25237
25238 For the three 4&'xx'& errors, either the first or both of the x's can be given
25239 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25240 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25241 and have retries every ten minutes with a one-hour timeout, you could set up a
25242 retry rule of this form:
25243 .code
25244 the.domain.name  rcpt_452   F,1h,10m
25245 .endd
25246 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25247 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25248
25249 .vlist
25250 .vitem &%lost_connection%&
25251 A server unexpectedly closed the SMTP connection. There may, of course,
25252 legitimate reasons for this (host died, network died), but if it repeats a lot
25253 for the same host, it indicates something odd.
25254
25255 .vitem &%lookup%&
25256 A DNS lookup for a host failed.
25257 Note that a &%dnslookup%& router will need to have matched
25258 its &%fail_defer_domains%& option for this retry type to be usable.
25259 Also note that a &%manualroute%& router will probably need
25260 its &%host_find_failed%& option set to &%defer%&.
25261
25262 .vitem &%refused_MX%&
25263 A connection to a host obtained from an MX record was refused.
25264
25265 .vitem &%refused_A%&
25266 A connection to a host not obtained from an MX record was refused.
25267
25268 .vitem &%refused%&
25269 A connection was refused.
25270
25271 .vitem &%timeout_connect_MX%&
25272 A connection attempt to a host obtained from an MX record timed out.
25273
25274 .vitem &%timeout_connect_A%&
25275 A connection attempt to a host not obtained from an MX record timed out.
25276
25277 .vitem &%timeout_connect%&
25278 A connection attempt timed out.
25279
25280 .vitem &%timeout_MX%&
25281 There was a timeout while connecting or during an SMTP session with a host
25282 obtained from an MX record.
25283
25284 .vitem &%timeout_A%&
25285 There was a timeout while connecting or during an SMTP session with a host not
25286 obtained from an MX record.
25287
25288 .vitem &%timeout%&
25289 There was a timeout while connecting or during an SMTP session.
25290
25291 .vitem &%tls_required%&
25292 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25293 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25294 to STARTTLS, or there was a problem setting up the TLS connection.
25295
25296 .vitem &%quota%&
25297 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25298 transport.
25299
25300 .vitem &%quota_%&<&'time'&>
25301 .cindex "quota" "error testing in retry rule"
25302 .cindex "retry" "quota error testing"
25303 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25304 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25305 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25306 for four days.
25307 .endlist
25308
25309 .cindex "mailbox" "time of last read"
25310 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25311 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25312 it should be based on the last time that the user accessed the mailbox.
25313 However, it is not always possible to determine this. Exim uses the following
25314 heuristic rules:
25315
25316 .ilist
25317 If the mailbox is a single file, the time of last access (the &"atime"&) is
25318 used. As no new messages are being delivered (because the mailbox is over
25319 quota), Exim does not access the file, so this is the time of last user access.
25320 .next
25321 .cindex "maildir format" "time of last read"
25322 For a maildir delivery, the time of last modification of the &_new_&
25323 subdirectory is used. As the mailbox is over quota, no new files are created in
25324 the &_new_& subdirectory, because no new messages are being delivered. Any
25325 change to the &_new_& subdirectory is therefore assumed to be the result of an
25326 MUA moving a new message to the &_cur_& directory when it is first read. The
25327 time that is used is therefore the last time that the user read a new message.
25328 .next
25329 For other kinds of multi-file mailbox, the time of last access cannot be
25330 obtained, so a retry rule that uses this type of error field is never matched.
25331 .endlist
25332
25333 The quota errors apply both to system-enforced quotas and to Exim's own quota
25334 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25335 when a local delivery is deferred because a partition is full (the ENOSPC
25336 error).
25337
25338
25339
25340 .section "Retry rules for specified senders" "SECID162"
25341 .cindex "retry" "rules; sender-specific"
25342 You can specify retry rules that apply only when the failing message has a
25343 specific sender. In particular, this can be used to define retry rules that
25344 apply only to bounce messages. The third item in a retry rule can be of this
25345 form:
25346 .display
25347 &`senders=`&<&'address list'&>
25348 .endd
25349 The retry timings themselves are then the fourth item. For example:
25350 .code
25351 *   rcpt_4xx   senders=:   F,1h,30m
25352 .endd
25353 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25354 host. If the address list contains white space, it must be enclosed in quotes.
25355 For example:
25356 .code
25357 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25358 .endd
25359 &*Warning*&: This facility can be unhelpful if it is used for host errors
25360 (which do not depend on the recipient). The reason is that the sender is used
25361 only to match the retry rule. Once the rule has been found for a host error,
25362 its contents are used to set a retry time for the host, and this will apply to
25363 all messages, not just those with specific senders.
25364
25365 When testing retry rules using &%-brt%&, you can supply a sender using the
25366 &%-f%& command line option, like this:
25367 .code
25368 exim -f "" -brt user@dom.ain
25369 .endd
25370 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25371 list is never matched.
25372
25373
25374
25375
25376
25377 .section "Retry parameters" "SECID163"
25378 .cindex "retry" "parameters in rules"
25379 The third (or fourth, if a senders list is present) field in a retry rule is a
25380 sequence of retry parameter sets, separated by semicolons. Each set consists of
25381 .display
25382 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25383 .endd
25384 The letter identifies the algorithm for computing a new retry time; the cutoff
25385 time is the time beyond which this algorithm no longer applies, and the
25386 arguments vary the algorithm's action. The cutoff time is measured from the
25387 time that the first failure for the domain (combined with the local part if
25388 relevant) was detected, not from the time the message was received.
25389
25390 .cindex "retry" "algorithms"
25391 .cindex "retry" "fixed intervals"
25392 .cindex "retry" "increasing intervals"
25393 .cindex "retry" "random intervals"
25394 The available algorithms are:
25395
25396 .ilist
25397 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25398 the interval.
25399 .next
25400 &'G'&: retry at geometrically increasing intervals. The first argument
25401 specifies a starting value for the interval, and the second a multiplier, which
25402 is used to increase the size of the interval at each retry.
25403 .next
25404 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25405 retry, the previous interval is multiplied by the factor in order to get a
25406 maximum for the next interval. The minimum interval is the first argument of
25407 the parameter, and an actual interval is chosen randomly between them. Such a
25408 rule has been found to be helpful in cluster configurations when all the
25409 members of the cluster restart at once, and may therefore synchronize their
25410 queue processing times.
25411 .endlist
25412
25413 When computing the next retry time, the algorithm definitions are scanned in
25414 order until one whose cutoff time has not yet passed is reached. This is then
25415 used to compute a new retry time that is later than the current time. In the
25416 case of fixed interval retries, this simply means adding the interval to the
25417 current time. For geometrically increasing intervals, retry intervals are
25418 computed from the rule's parameters until one that is greater than the previous
25419 interval is found. The main configuration variable
25420 .cindex "limit" "retry interval"
25421 .cindex "retry" "interval, maximum"
25422 .oindex "&%retry_interval_max%&"
25423 &%retry_interval_max%& limits the maximum interval between retries. It
25424 cannot be set greater than &`24h`&, which is its default value.
25425
25426 A single remote domain may have a number of hosts associated with it, and each
25427 host may have more than one IP address. Retry algorithms are selected on the
25428 basis of the domain name, but are applied to each IP address independently. If,
25429 for example, a host has two IP addresses and one is unusable, Exim will
25430 generate retry times for it and will not try to use it until its next retry
25431 time comes. Thus the good IP address is likely to be tried first most of the
25432 time.
25433
25434 .cindex "hints database" "use for retrying"
25435 Retry times are hints rather than promises. Exim does not make any attempt to
25436 run deliveries exactly at the computed times. Instead, a queue runner process
25437 starts delivery processes for delayed messages periodically, and these attempt
25438 new deliveries only for those addresses that have passed their next retry time.
25439 If a new message arrives for a deferred address, an immediate delivery attempt
25440 occurs only if the address has passed its retry time. In the absence of new
25441 messages, the minimum time between retries is the interval between queue runner
25442 processes. There is not much point in setting retry times of five minutes if
25443 your queue runners happen only once an hour, unless there are a significant
25444 number of incoming messages (which might be the case on a system that is
25445 sending everything to a smart host, for example).
25446
25447 The data in the retry hints database can be inspected by using the
25448 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25449 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25450 &'exinext'& utility script can be used to find out what the next retry times
25451 are for the hosts associated with a particular mail domain, and also for local
25452 deliveries that have been deferred.
25453
25454
25455 .section "Retry rule examples" "SECID164"
25456 Here are some example retry rules:
25457 .code
25458 alice@wonderland.fict.example quota_5d  F,7d,3h
25459 wonderland.fict.example       quota_5d
25460 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25461 lookingglass.fict.example     *         F,24h,30m;
25462 *                 refused_A   F,2h,20m;
25463 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25464 .endd
25465 The first rule sets up special handling for mail to
25466 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25467 mailbox has not been read for at least 5 days. Retries continue every three
25468 hours for 7 days. The second rule handles over-quota errors for all other local
25469 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25470 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25471 fail are bounced immediately if the mailbox has not been read for at least 5
25472 days.
25473
25474 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25475 happen every 15 minutes for an hour, then with geometrically increasing
25476 intervals until two days have passed since a delivery first failed. After the
25477 first hour there is a delay of one hour, then two hours, then four hours, and
25478 so on (this is a rather extreme example).
25479
25480 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25481 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25482 all other domains, with special action for connection refusal from hosts that
25483 were not obtained from an MX record.
25484
25485 The final rule in a retry configuration should always have asterisks in the
25486 first two fields so as to provide a general catch-all for any addresses that do
25487 not have their own special handling. This example tries every 15 minutes for 2
25488 hours, then with intervals starting at one hour and increasing by a factor of
25489 1.5 up to 16 hours, then every 8 hours up to 5 days.
25490
25491
25492
25493 .section "Timeout of retry data" "SECID165"
25494 .cindex "timeout" "of retry data"
25495 .oindex "&%retry_data_expire%&"
25496 .cindex "hints database" "data expiry"
25497 .cindex "retry" "timeout of data"
25498 Exim timestamps the data that it writes to its retry hints database. When it
25499 consults the data during a delivery it ignores any that is older than the value
25500 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25501 been tried for 7 days, Exim will try to deliver to it immediately a message
25502 arrives, and if that fails, it will calculate a retry time as if it were
25503 failing for the first time.
25504
25505 This improves the behaviour for messages routed to rarely-used hosts such as MX
25506 backups. If such a host was down at one time, and happens to be down again when
25507 Exim tries a month later, using the old retry data would imply that it had been
25508 down all the time, which is not a justified assumption.
25509
25510 If a host really is permanently dead, this behaviour causes a burst of retries
25511 every now and again, but only if messages routed to it are rare. If there is a
25512 message at least once every 7 days the retry data never expires.
25513
25514
25515
25516
25517 .section "Long-term failures" "SECID166"
25518 .cindex "delivery failure, long-term"
25519 .cindex "retry" "after long-term failure"
25520 Special processing happens when an email address has been failing for so long
25521 that the cutoff time for the last algorithm is reached. For example, using the
25522 default retry rule:
25523 .code
25524 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25525 .endd
25526 the cutoff time is four days. Reaching the retry cutoff is independent of how
25527 long any specific message has been failing; it is the length of continuous
25528 failure for the recipient address that counts.
25529
25530 When the cutoff time is reached for a local delivery, or for all the IP
25531 addresses associated with a remote delivery, a subsequent delivery failure
25532 causes Exim to give up on the address, and a bounce message is generated.
25533 In order to cater for new messages that use the failing address, a next retry
25534 time is still computed from the final algorithm, and is used as follows:
25535
25536 For local deliveries, one delivery attempt is always made for any subsequent
25537 messages. If this delivery fails, the address fails immediately. The
25538 post-cutoff retry time is not used.
25539
25540 If the delivery is remote, there are two possibilities, controlled by the
25541 .oindex "&%delay_after_cutoff%&"
25542 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25543 default. Until the post-cutoff retry time for one of the IP addresses is
25544 reached, the failing email address is bounced immediately, without a delivery
25545 attempt taking place. After that time, one new delivery attempt is made to
25546 those IP addresses that are past their retry times, and if that still fails,
25547 the address is bounced and new retry times are computed.
25548
25549 In other words, when all the hosts for a given email address have been failing
25550 for a long time, Exim bounces rather then defers until one of the hosts' retry
25551 times is reached. Then it tries once, and bounces if that attempt fails. This
25552 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25553 to a broken destination, but if the host does recover, Exim will eventually
25554 notice.
25555
25556 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25557 addresses are past their final cutoff time, Exim tries to deliver to those IP
25558 addresses that have not been tried since the message arrived. If there are
25559 no suitable IP addresses, or if they all fail, the address is bounced. In other
25560 words, it does not delay when a new message arrives, but tries the expired
25561 addresses immediately, unless they have been tried since the message arrived.
25562 If there is a continuous stream of messages for the failing domains, setting
25563 &%delay_after_cutoff%& false means that there will be many more attempts to
25564 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25565 true.
25566
25567 .section "Deliveries that work intermittently" "SECID167"
25568 .cindex "retry" "intermittently working deliveries"
25569 Some additional logic is needed to cope with cases where a host is
25570 intermittently available, or when a message has some attribute that prevents
25571 its delivery when others to the same address get through. In this situation,
25572 because some messages are successfully delivered, the &"retry clock"& for the
25573 host or address keeps getting reset by the successful deliveries, and so
25574 failing messages remain on the queue for ever because the cutoff time is never
25575 reached.
25576
25577 Two exceptional actions are applied to prevent this happening. The first
25578 applies to errors that are related to a message rather than a remote host.
25579 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25580 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25581 commands, and quota failures. For this type of error, if a message's arrival
25582 time is earlier than the &"first failed"& time for the error, the earlier time
25583 is used when scanning the retry rules to decide when to try next and when to
25584 time out the address.
25585
25586 The exceptional second action applies in all cases. If a message has been on
25587 the queue for longer than the cutoff time of any applicable retry rule for a
25588 given address, a delivery is attempted for that address, even if it is not yet
25589 time, and if this delivery fails, the address is timed out. A new retry time is
25590 not computed in this case, so that other messages for the same address are
25591 considered immediately.
25592 .ecindex IIDretconf1
25593 .ecindex IIDregconf2
25594
25595
25596
25597
25598
25599
25600 . ////////////////////////////////////////////////////////////////////////////
25601 . ////////////////////////////////////////////////////////////////////////////
25602
25603 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25604 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25605 .scindex IIDauthconf2 "authentication"
25606 The &"authenticators"& section of Exim's run time configuration is concerned
25607 with SMTP authentication. This facility is an extension to the SMTP protocol,
25608 described in RFC 2554, which allows a client SMTP host to authenticate itself
25609 to a server. This is a common way for a server to recognize clients that are
25610 permitted to use it as a relay. SMTP authentication is not of relevance to the
25611 transfer of mail between servers that have no managerial connection with each
25612 other.
25613
25614 .cindex "AUTH" "description of"
25615 Very briefly, the way SMTP authentication works is as follows:
25616
25617 .ilist
25618 The server advertises a number of authentication &'mechanisms'& in response to
25619 the client's EHLO command.
25620 .next
25621 The client issues an AUTH command, naming a specific mechanism. The command
25622 may, optionally, contain some authentication data.
25623 .next
25624 The server may issue one or more &'challenges'&, to which the client must send
25625 appropriate responses. In simple authentication mechanisms, the challenges are
25626 just prompts for user names and passwords. The server does not have to issue
25627 any challenges &-- in some mechanisms the relevant data may all be transmitted
25628 with the AUTH command.
25629 .next
25630 The server either accepts or denies authentication.
25631 .next
25632 If authentication succeeds, the client may optionally make use of the AUTH
25633 option on the MAIL command to pass an authenticated sender in subsequent
25634 mail transactions. Authentication lasts for the remainder of the SMTP
25635 connection.
25636 .next
25637 If authentication fails, the client may give up, or it may try a different
25638 authentication mechanism, or it may try transferring mail over the
25639 unauthenticated connection.
25640 .endlist
25641
25642 If you are setting up a client, and want to know which authentication
25643 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25644 SMTP port) on the server, and issue an EHLO command. The response to this
25645 includes the list of supported mechanisms. For example:
25646 .display
25647 &`$ `&&*&`telnet server.example 25`&*&
25648 &`Trying 192.168.34.25...`&
25649 &`Connected to server.example.`&
25650 &`Escape character is &#x0027;^]&#x0027;.`&
25651 &`220 server.example ESMTP Exim 4.20 ...`&
25652 &*&`ehlo client.example`&*&
25653 &`250-server.example Hello client.example [10.8.4.5]`&
25654 &`250-SIZE 52428800`&
25655 &`250-PIPELINING`&
25656 &`250-AUTH PLAIN`&
25657 &`250 HELP`&
25658 .endd
25659 The second-last line of this example output shows that the server supports
25660 authentication using the PLAIN mechanism. In Exim, the different authentication
25661 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25662 routers and transports, which authenticators are included in the binary is
25663 controlled by build-time definitions. The following are currently available,
25664 included by setting
25665 .code
25666 AUTH_CRAM_MD5=yes
25667 AUTH_CYRUS_SASL=yes
25668 AUTH_DOVECOT=yes
25669 AUTH_GSASL=yes
25670 AUTH_HEIMDAL_GSSAPI=yes
25671 AUTH_PLAINTEXT=yes
25672 AUTH_SPA=yes
25673 AUTH_TLS=yes
25674 .endd
25675 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25676 authentication mechanism (RFC 2195), and the second provides an interface to
25677 the Cyrus SASL authentication library.
25678 The third is an interface to Dovecot's authentication system, delegating the
25679 work via a socket interface.
25680 The fourth provides an interface to the GNU SASL authentication library, which
25681 provides mechanisms but typically not data sources.
25682 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25683 supporting setting a server keytab.
25684 The sixth can be configured to support
25685 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25686 not formally documented, but used by several MUAs. The seventh authenticator
25687 supports Microsoft's &'Secure Password Authentication'& mechanism.
25688 The eighth is an Exim authenticator but not an SMTP one;
25689 instead it can use information from a TLS negotiation.
25690
25691 The authenticators are configured using the same syntax as other drivers (see
25692 section &<<SECTfordricon>>&). If no authenticators are required, no
25693 authentication section need be present in the configuration file. Each
25694 authenticator can in principle have both server and client functions. When Exim
25695 is receiving SMTP mail, it is acting as a server; when it is sending out
25696 messages over SMTP, it is acting as a client. Authenticator configuration
25697 options are provided for use in both these circumstances.
25698
25699 To make it clear which options apply to which situation, the prefixes
25700 &%server_%& and &%client_%& are used on option names that are specific to
25701 either the server or the client function, respectively. Server and client
25702 functions are disabled if none of their options are set. If an authenticator is
25703 to be used for both server and client functions, a single definition, using
25704 both sets of options, is required. For example:
25705 .code
25706 cram:
25707   driver = cram_md5
25708   public_name = CRAM-MD5
25709   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25710   client_name = ph10
25711   client_secret = secret2
25712 .endd
25713 The &%server_%& option is used when Exim is acting as a server, and the
25714 &%client_%& options when it is acting as a client.
25715
25716 Descriptions of the individual authenticators are given in subsequent chapters.
25717 The remainder of this chapter covers the generic options for the
25718 authenticators, followed by general discussion of the way authentication works
25719 in Exim.
25720
25721 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25722 per-mechanism basis.  Please read carefully to determine which variables hold
25723 account labels such as usercodes and which hold passwords or other
25724 authenticating data.
25725
25726 Note that some mechanisms support two different identifiers for accounts: the
25727 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25728 and &'authz'& are commonly encountered.  The American spelling is standard here.
25729 Conceptually, authentication data such as passwords are tied to the identifier
25730 used to authenticate; servers may have rules to permit one user to act as a
25731 second user, so that after login the session is treated as though that second
25732 user had logged in.  That second user is the &'authorization id'&.  A robust
25733 configuration might confirm that the &'authz'& field is empty or matches the
25734 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25735 as verified data, the &'authz'& as an unverified request which the server might
25736 choose to honour.
25737
25738 A &'realm'& is a text string, typically a domain name, presented by a server
25739 to a client to help it select an account and credentials to use.  In some
25740 mechanisms, the client and server provably agree on the realm, but clients
25741 typically can not treat the realm as secure data to be blindly trusted.
25742
25743
25744
25745 .section "Generic options for authenticators" "SECID168"
25746 .cindex "authentication" "generic options"
25747 .cindex "options" "generic; for authenticators"
25748
25749 .option client_condition authenticators string&!! unset
25750 When Exim is authenticating as a client, it skips any authenticator whose
25751 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25752 used, for example, to skip plain text authenticators when the connection is not
25753 encrypted by a setting such as:
25754 .code
25755 client_condition = ${if !eq{$tls_out_cipher}{}}
25756 .endd
25757
25758
25759 .option client_set_id authenticators string&!! unset
25760 When client authentication succeeds, this condition is expanded; the
25761 result is used in the log lines for outbound messages.
25762 Typically it will be the user name used for authentication.
25763
25764
25765 .option driver authenticators string unset
25766 This option must always be set. It specifies which of the available
25767 authenticators is to be used.
25768
25769
25770 .option public_name authenticators string unset
25771 This option specifies the name of the authentication mechanism that the driver
25772 implements, and by which it is known to the outside world. These names should
25773 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25774 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25775 defaults to the driver's instance name.
25776
25777
25778 .option server_advertise_condition authenticators string&!! unset
25779 When a server is about to advertise an authentication mechanism, the condition
25780 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25781 mechanism is not advertised.
25782 If the expansion fails, the mechanism is not advertised. If the failure was not
25783 forced, and was not caused by a lookup defer, the incident is logged.
25784 See section &<<SECTauthexiser>>& below for further discussion.
25785
25786
25787 .option server_condition authenticators string&!! unset
25788 This option must be set for a &%plaintext%& server authenticator, where it
25789 is used directly to control authentication. See section &<<SECTplainserver>>&
25790 for details.
25791
25792 For the &(gsasl)& authenticator, this option is required for various
25793 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25794
25795 For the other authenticators, &%server_condition%& can be used as an additional
25796 authentication or authorization mechanism that is applied after the other
25797 authenticator conditions succeed. If it is set, it is expanded when the
25798 authenticator would otherwise return a success code. If the expansion is forced
25799 to fail, authentication fails. Any other expansion failure causes a temporary
25800 error code to be returned. If the result of a successful expansion is an empty
25801 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25802 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25803 other result, a temporary error code is returned, with the expanded string as
25804 the error text.
25805
25806
25807 .option server_debug_print authenticators string&!! unset
25808 If this option is set and authentication debugging is enabled (see the &%-d%&
25809 command line option), the string is expanded and included in the debugging
25810 output when the authenticator is run as a server. This can help with checking
25811 out the values of variables.
25812 If expansion of the string fails, the error message is written to the debugging
25813 output, and Exim carries on processing.
25814
25815
25816 .option server_set_id authenticators string&!! unset
25817 .vindex "&$authenticated_id$&"
25818 When an Exim server successfully authenticates a client, this string is
25819 expanded using data from the authentication, and preserved for any incoming
25820 messages in the variable &$authenticated_id$&. It is also included in the log
25821 lines for incoming messages. For example, a user/password authenticator
25822 configuration might preserve the user name that was used to authenticate, and
25823 refer to it subsequently during delivery of the message.
25824 If expansion fails, the option is ignored.
25825
25826
25827 .option server_mail_auth_condition authenticators string&!! unset
25828 This option allows a server to discard authenticated sender addresses supplied
25829 as part of MAIL commands in SMTP connections that are authenticated by the
25830 driver on which &%server_mail_auth_condition%& is set. The option is not used
25831 as part of the authentication process; instead its (unexpanded) value is
25832 remembered for later use.
25833 How it is used is described in the following section.
25834
25835
25836
25837
25838
25839 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25840 .cindex "authentication" "sender; authenticated"
25841 .cindex "AUTH" "on MAIL command"
25842 When a client supplied an AUTH= item on a MAIL command, Exim applies
25843 the following checks before accepting it as the authenticated sender of the
25844 message:
25845
25846 .ilist
25847 If the connection is not using extended SMTP (that is, HELO was used rather
25848 than EHLO), the use of AUTH= is a syntax error.
25849 .next
25850 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25851 .next
25852 .vindex "&$authenticated_sender$&"
25853 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25854 running, the value of &$authenticated_sender$& is set to the value obtained
25855 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25856 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25857 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25858 given for the MAIL command.
25859 .next
25860 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25861 is accepted and placed in &$authenticated_sender$& only if the client has
25862 authenticated.
25863 .next
25864 If the AUTH= value was accepted by either of the two previous rules, and
25865 the client has authenticated, and the authenticator has a setting for the
25866 &%server_mail_auth_condition%&, the condition is checked at this point. The
25867 valued that was saved from the authenticator is expanded. If the expansion
25868 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25869 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25870 the value of &$authenticated_sender$& is retained and passed on with the
25871 message.
25872 .endlist
25873
25874
25875 When &$authenticated_sender$& is set for a message, it is passed on to other
25876 hosts to which Exim authenticates as a client. Do not confuse this value with
25877 &$authenticated_id$&, which is a string obtained from the authentication
25878 process, and which is not usually a complete email address.
25879
25880 .vindex "&$sender_address$&"
25881 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25882 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25883 therefore make use of &$authenticated_sender$&. The converse is not true: the
25884 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25885 ACL is run.
25886
25887
25888
25889 .section "Authentication on an Exim server" "SECTauthexiser"
25890 .cindex "authentication" "on an Exim server"
25891 When Exim receives an EHLO command, it advertises the public names of those
25892 authenticators that are configured as servers, subject to the following
25893 conditions:
25894
25895 .ilist
25896 The client host must match &%auth_advertise_hosts%& (default *).
25897 .next
25898 It the &%server_advertise_condition%& option is set, its expansion must not
25899 yield the empty string, &"0"&, &"no"&, or &"false"&.
25900 .endlist
25901
25902 The order in which the authenticators are defined controls the order in which
25903 the mechanisms are advertised.
25904
25905 Some mail clients (for example, some versions of Netscape) require the user to
25906 provide a name and password for authentication whenever AUTH is advertised,
25907 even though authentication may not in fact be needed (for example, Exim may be
25908 set up to allow unconditional relaying from the client by an IP address check).
25909 You can make such clients more friendly by not advertising AUTH to them.
25910 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25911 that runs for RCPT) to relay without authentication, you should set
25912 .code
25913 auth_advertise_hosts = ! 10.9.8.0/24
25914 .endd
25915 so that no authentication mechanisms are advertised to them.
25916
25917 The &%server_advertise_condition%& controls the advertisement of individual
25918 authentication mechanisms. For example, it can be used to restrict the
25919 advertisement of a particular mechanism to encrypted connections, by a setting
25920 such as:
25921 .code
25922 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25923 .endd
25924 .vindex "&$tls_in_cipher$&"
25925 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25926 yields &"yes"&, which allows the advertisement to happen.
25927
25928 When an Exim server receives an AUTH command from a client, it rejects it
25929 immediately if AUTH was not advertised in response to an earlier EHLO
25930 command. This is the case if
25931
25932 .ilist
25933 The client host does not match &%auth_advertise_hosts%&; or
25934 .next
25935 No authenticators are configured with server options; or
25936 .next
25937 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25938 server authenticators.
25939 .endlist
25940
25941
25942 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25943 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25944 AUTH is accepted from any client host.
25945
25946 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25947 server authentication mechanism that was advertised in response to EHLO and
25948 that matches the one named in the AUTH command. If it finds one, it runs
25949 the appropriate authentication protocol, and authentication either succeeds or
25950 fails. If there is no matching advertised mechanism, the AUTH command is
25951 rejected with a 504 error.
25952
25953 .vindex "&$received_protocol$&"
25954 .vindex "&$sender_host_authenticated$&"
25955 When a message is received from an authenticated host, the value of
25956 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25957 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25958 public name) of the authenticator driver that successfully authenticated the
25959 client from which the message was received. This variable is empty if there was
25960 no successful authentication.
25961
25962
25963
25964
25965 .section "Testing server authentication" "SECID169"
25966 .cindex "authentication" "testing a server"
25967 .cindex "AUTH" "testing a server"
25968 .cindex "base64 encoding" "creating authentication test data"
25969 Exim's &%-bh%& option can be useful for testing server authentication
25970 configurations. The data for the AUTH command has to be sent using base64
25971 encoding. A quick way to produce such data for testing is the following Perl
25972 script:
25973 .code
25974 use MIME::Base64;
25975 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25976 .endd
25977 .cindex "binary zero" "in authentication data"
25978 This interprets its argument as a Perl string, and then encodes it. The
25979 interpretation as a Perl string allows binary zeros, which are required for
25980 some kinds of authentication, to be included in the data. For example, a
25981 command line to run this script on such data might be
25982 .code
25983 encode '\0user\0password'
25984 .endd
25985 Note the use of single quotes to prevent the shell interpreting the
25986 backslashes, so that they can be interpreted by Perl to specify characters
25987 whose code value is zero.
25988
25989 &*Warning 1*&: If either of the user or password strings starts with an octal
25990 digit, you must use three zeros instead of one after the leading backslash. If
25991 you do not, the octal digit that starts your string will be incorrectly
25992 interpreted as part of the code for the first character.
25993
25994 &*Warning 2*&: If there are characters in the strings that Perl interprets
25995 specially, you must use a Perl escape to prevent them being misinterpreted. For
25996 example, a command such as
25997 .code
25998 encode '\0user@domain.com\0pas$$word'
25999 .endd
26000 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26001
26002 If you have the &%mimencode%& command installed, another way to do produce
26003 base64-encoded strings is to run the command
26004 .code
26005 echo -e -n `\0user\0password' | mimencode
26006 .endd
26007 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26008 in the argument, and the &%-n%& option specifies no newline at the end of its
26009 output. However, not all versions of &%echo%& recognize these options, so you
26010 should check your version before relying on this suggestion.
26011
26012
26013
26014 .section "Authentication by an Exim client" "SECID170"
26015 .cindex "authentication" "on an Exim client"
26016 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26017 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26018 announces support for authentication, and the host matches an entry in either
26019 of these options, Exim (as a client) tries to authenticate as follows:
26020
26021 .ilist
26022 For each authenticator that is configured as a client, in the order in which
26023 they are defined in the configuration, it searches the authentication
26024 mechanisms announced by the server for one whose name matches the public name
26025 of the authenticator.
26026 .next
26027 .vindex "&$host$&"
26028 .vindex "&$host_address$&"
26029 When it finds one that matches, it runs the authenticator's client code. The
26030 variables &$host$& and &$host_address$& are available for any string expansions
26031 that the client might do. They are set to the server's name and IP address. If
26032 any expansion is forced to fail, the authentication attempt is abandoned, and
26033 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26034 delivery to be deferred.
26035 .next
26036 If the result of the authentication attempt is a temporary error or a timeout,
26037 Exim abandons trying to send the message to the host for the moment. It will
26038 try again later. If there are any backup hosts available, they are tried in the
26039 usual way.
26040 .next
26041 If the response to authentication is a permanent error (5&'xx'& code), Exim
26042 carries on searching the list of authenticators and tries another one if
26043 possible. If all authentication attempts give permanent errors, or if there are
26044 no attempts because no mechanisms match (or option expansions force failure),
26045 what happens depends on whether the host matches &%hosts_require_auth%& or
26046 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26047 delivery is deferred. The error can be detected in the retry rules, and thereby
26048 turned into a permanent error if you wish. In the second case, Exim tries to
26049 deliver the message unauthenticated.
26050 .endlist
26051
26052 Note that the hostlist test for whether to do authentication can be
26053 confused if name-IP lookups change between the time the peer is decided
26054 on and the transport running.  For example, with a manualroute
26055 router given a host name, and DNS "round-robin" use by that name: if
26056 the local resolver cache times out between the router and the transport
26057 running, the transport may get an IP for the name for its authentication
26058 check which does not match the connection peer IP.
26059 No authentication will then be done, despite the names being identical.
26060
26061 For such cases use a separate transport which always authenticates.
26062
26063 .cindex "AUTH" "on MAIL command"
26064 When Exim has authenticated itself to a remote server, it adds the AUTH
26065 parameter to the MAIL commands it sends, if it has an authenticated sender for
26066 the message. If the message came from a remote host, the authenticated sender
26067 is the one that was receiving on an incoming MAIL command, provided that the
26068 incoming connection was authenticated and the &%server_mail_auth%& condition
26069 allowed the authenticated sender to be retained. If a local process calls Exim
26070 to send a message, the sender address that is built from the login name and
26071 &%qualify_domain%& is treated as authenticated. However, if the
26072 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26073 the authenticated sender that was received with the message.
26074 .ecindex IIDauthconf1
26075 .ecindex IIDauthconf2
26076
26077
26078
26079
26080
26081
26082 . ////////////////////////////////////////////////////////////////////////////
26083 . ////////////////////////////////////////////////////////////////////////////
26084
26085 .chapter "The plaintext authenticator" "CHAPplaintext"
26086 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26087 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26088 The &(plaintext)& authenticator can be configured to support the PLAIN and
26089 LOGIN authentication mechanisms, both of which transfer authentication data as
26090 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26091 security risk; you are strongly advised to insist on the use of SMTP encryption
26092 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26093 use unencrypted plain text, you should not use the same passwords for SMTP
26094 connections as you do for login accounts.
26095
26096 .section "Plaintext options" "SECID171"
26097 .cindex "options" "&(plaintext)& authenticator (server)"
26098 When configured as a server, &(plaintext)& uses the following options:
26099
26100 .option server_condition authenticators string&!! unset
26101 This is actually a global authentication option, but it must be set in order to
26102 configure the &(plaintext)& driver as a server. Its use is described below.
26103
26104 .option server_prompts plaintext string&!! unset
26105 The contents of this option, after expansion, must be a colon-separated list of
26106 prompt strings. If expansion fails, a temporary authentication rejection is
26107 given.
26108
26109 .section "Using plaintext in a server" "SECTplainserver"
26110 .cindex "AUTH" "in &(plaintext)& authenticator"
26111 .cindex "binary zero" "in &(plaintext)& authenticator"
26112 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26113         "in &(plaintext)& authenticator"
26114 .vindex "&$auth1$&, &$auth2$&, etc"
26115 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26116
26117 When running as a server, &(plaintext)& performs the authentication test by
26118 expanding a string. The data sent by the client with the AUTH command, or in
26119 response to subsequent prompts, is base64 encoded, and so may contain any byte
26120 values when decoded. If any data is supplied with the command, it is treated as
26121 a list of strings, separated by NULs (binary zeros), the first three of which
26122 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26123 (neither LOGIN nor PLAIN uses more than three strings).
26124
26125 For compatibility with previous releases of Exim, the values are also placed in
26126 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26127 variables for this purpose is now deprecated, as it can lead to confusion in
26128 string expansions that also use them for other things.
26129
26130 If there are more strings in &%server_prompts%& than the number of strings
26131 supplied with the AUTH command, the remaining prompts are used to obtain more
26132 data. Each response from the client may be a list of NUL-separated strings.
26133
26134 .vindex "&$authenticated_id$&"
26135 Once a sufficient number of data strings have been received,
26136 &%server_condition%& is expanded. If the expansion is forced to fail,
26137 authentication fails. Any other expansion failure causes a temporary error code
26138 to be returned. If the result of a successful expansion is an empty string,
26139 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26140 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26141 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26142 For any other result, a temporary error code is returned, with the expanded
26143 string as the error text
26144
26145 &*Warning*&: If you use a lookup in the expansion to find the user's
26146 password, be sure to make the authentication fail if the user is unknown.
26147 There are good and bad examples at the end of the next section.
26148
26149
26150
26151 .section "The PLAIN authentication mechanism" "SECID172"
26152 .cindex "PLAIN authentication mechanism"
26153 .cindex "authentication" "PLAIN mechanism"
26154 .cindex "binary zero" "in &(plaintext)& authenticator"
26155 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26156 sent as one item of data (that is, one combined string containing two NUL
26157 separators). The data is sent either as part of the AUTH command, or
26158 subsequently in response to an empty prompt from the server.
26159
26160 The second and third strings are a user name and a corresponding password.
26161 Using a single fixed user name and password as an example, this could be
26162 configured as follows:
26163 .code
26164 fixed_plain:
26165   driver = plaintext
26166   public_name = PLAIN
26167   server_prompts = :
26168   server_condition = \
26169     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26170   server_set_id = $auth2
26171 .endd
26172 Note that the default result strings from &%if%& (&"true"& or an empty string)
26173 are exactly what we want here, so they need not be specified. Obviously, if the
26174 password contains expansion-significant characters such as dollar, backslash,
26175 or closing brace, they have to be escaped.
26176
26177 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26178 the end of a string list are ignored). If all the data comes as part of the
26179 AUTH command, as is commonly the case, the prompt is not used. This
26180 authenticator is advertised in the response to EHLO as
26181 .code
26182 250-AUTH PLAIN
26183 .endd
26184 and a client host can authenticate itself by sending the command
26185 .code
26186 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26187 .endd
26188 As this contains three strings (more than the number of prompts), no further
26189 data is required from the client. Alternatively, the client may just send
26190 .code
26191 AUTH PLAIN
26192 .endd
26193 to initiate authentication, in which case the server replies with an empty
26194 prompt. The client must respond with the combined data string.
26195
26196 The data string is base64 encoded, as required by the RFC. This example,
26197 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26198 represents a zero byte. This is split up into three strings, the first of which
26199 is empty. The &%server_condition%& option in the authenticator checks that the
26200 second two are &`username`& and &`mysecret`& respectively.
26201
26202 Having just one fixed user name and password, as in this example, is not very
26203 realistic, though for a small organization with only a handful of
26204 authenticating clients it could make sense.
26205
26206 A more sophisticated instance of this authenticator could use the user name in
26207 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26208 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26209 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26210 This is an incorrect example:
26211 .code
26212 server_condition = \
26213   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26214 .endd
26215 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26216 which it then compares to the supplied password (&$auth3$&). Why is this example
26217 incorrect? It works fine for existing users, but consider what happens if a
26218 non-existent user name is given. The lookup fails, but as no success/failure
26219 strings are given for the lookup, it yields an empty string. Thus, to defeat
26220 the authentication, all a client has to do is to supply a non-existent user
26221 name and an empty password. The correct way of writing this test is:
26222 .code
26223 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26224   {${if eq{$value}{$auth3}}} {false}}
26225 .endd
26226 In this case, if the lookup succeeds, the result is checked; if the lookup
26227 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26228 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26229 always fails if its second argument is empty. However, the second way of
26230 writing the test makes the logic clearer.
26231
26232
26233 .section "The LOGIN authentication mechanism" "SECID173"
26234 .cindex "LOGIN authentication mechanism"
26235 .cindex "authentication" "LOGIN mechanism"
26236 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26237 in a number of programs. No data is sent with the AUTH command. Instead, a
26238 user name and password are supplied separately, in response to prompts. The
26239 plaintext authenticator can be configured to support this as in this example:
26240 .code
26241 fixed_login:
26242   driver = plaintext
26243   public_name = LOGIN
26244   server_prompts = User Name : Password
26245   server_condition = \
26246     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26247   server_set_id = $auth1
26248 .endd
26249 Because of the way plaintext operates, this authenticator accepts data supplied
26250 with the AUTH command (in contravention of the specification of LOGIN), but
26251 if the client does not supply it (as is the case for LOGIN clients), the prompt
26252 strings are used to obtain two data items.
26253
26254 Some clients are very particular about the precise text of the prompts. For
26255 example, Outlook Express is reported to recognize only &"Username:"& and
26256 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26257 strings. It uses the &%ldapauth%& expansion condition to check the user
26258 name and password by binding to an LDAP server:
26259 .code
26260 login:
26261   driver = plaintext
26262   public_name = LOGIN
26263   server_prompts = Username:: : Password::
26264   server_condition = ${if and{{ \
26265     !eq{}{$auth1} }{ \
26266     ldapauth{\
26267       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26268       pass=${quote:$auth2} \
26269       ldap://ldap.example.org/} }} }
26270   server_set_id = uid=$auth1,ou=people,o=example.org
26271 .endd
26272 We have to check that the username is not empty before using it, because LDAP
26273 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26274 operator to correctly quote the DN for authentication. However, the basic
26275 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26276 correct one to use for the password, because quoting is needed only to make
26277 the password conform to the Exim syntax. At the LDAP level, the password is an
26278 uninterpreted string.
26279
26280
26281 .section "Support for different kinds of authentication" "SECID174"
26282 A number of string expansion features are provided for the purpose of
26283 interfacing to different ways of user authentication. These include checking
26284 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26285 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26286 &<<SECTexpcond>>&.
26287
26288
26289
26290
26291 .section "Using plaintext in a client" "SECID175"
26292 .cindex "options" "&(plaintext)& authenticator (client)"
26293 The &(plaintext)& authenticator has two client options:
26294
26295 .option client_ignore_invalid_base64 plaintext boolean false
26296 If the client receives a server prompt that is not a valid base64 string,
26297 authentication is abandoned by default. However, if this option is set true,
26298 the error in the challenge is ignored and the client sends the response as
26299 usual.
26300
26301 .option client_send plaintext string&!! unset
26302 The string is a colon-separated list of authentication data strings. Each
26303 string is independently expanded before being sent to the server. The first
26304 string is sent with the AUTH command; any more strings are sent in response
26305 to prompts from the server. Before each string is expanded, the value of the
26306 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26307 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26308 way. Thus, the prompt that is received in response to sending the first string
26309 (with the AUTH command) can be used in the expansion of the second string, and
26310 so on. If an invalid base64 string is received when
26311 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26312 &$auth$&<&'n'&> variable.
26313
26314 &*Note*&: You cannot use expansion to create multiple strings, because
26315 splitting takes priority and happens first.
26316
26317 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26318 the data, further processing is applied to each string before it is sent. If
26319 there are any single circumflex characters in the string, they are converted to
26320 NULs. Should an actual circumflex be required as data, it must be doubled in
26321 the string.
26322
26323 This is an example of a client configuration that implements the PLAIN
26324 authentication mechanism with a fixed user name and password:
26325 .code
26326 fixed_plain:
26327   driver = plaintext
26328   public_name = PLAIN
26329   client_send = ^username^mysecret
26330 .endd
26331 The lack of colons means that the entire text is sent with the AUTH
26332 command, with the circumflex characters converted to NULs. A similar example
26333 that uses the LOGIN mechanism is:
26334 .code
26335 fixed_login:
26336   driver = plaintext
26337   public_name = LOGIN
26338   client_send = : username : mysecret
26339 .endd
26340 The initial colon means that the first string is empty, so no data is sent with
26341 the AUTH command itself. The remaining strings are sent in response to
26342 prompts.
26343 .ecindex IIDplaiauth1
26344 .ecindex IIDplaiauth2
26345
26346
26347
26348
26349 . ////////////////////////////////////////////////////////////////////////////
26350 . ////////////////////////////////////////////////////////////////////////////
26351
26352 .chapter "The cram_md5 authenticator" "CHID9"
26353 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26354 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26355 .cindex "CRAM-MD5 authentication mechanism"
26356 .cindex "authentication" "CRAM-MD5 mechanism"
26357 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26358 sends a challenge string to the client, and the response consists of a user
26359 name and the CRAM-MD5 digest of the challenge string combined with a secret
26360 string (password) which is known to both server and client. Thus, the secret
26361 is not sent over the network as plain text, which makes this authenticator more
26362 secure than &(plaintext)&. However, the downside is that the secret has to be
26363 available in plain text at either end.
26364
26365
26366 .section "Using cram_md5 as a server" "SECID176"
26367 .cindex "options" "&(cram_md5)& authenticator (server)"
26368 This authenticator has one server option, which must be set to configure the
26369 authenticator as a server:
26370
26371 .option server_secret cram_md5 string&!! unset
26372 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26373 When the server receives the client's response, the user name is placed in
26374 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26375 obtain the password for that user. The server then computes the CRAM-MD5 digest
26376 that the client should have sent, and checks that it received the correct
26377 string. If the expansion of &%server_secret%& is forced to fail, authentication
26378 fails. If the expansion fails for some other reason, a temporary error code is
26379 returned to the client.
26380
26381 For compatibility with previous releases of Exim, the user name is also placed
26382 in &$1$&. However, the use of this variables for this purpose is now
26383 deprecated, as it can lead to confusion in string expansions that also use
26384 numeric variables for other things.
26385
26386 For example, the following authenticator checks that the user name given by the
26387 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26388 user name, authentication fails.
26389 .code
26390 fixed_cram:
26391   driver = cram_md5
26392   public_name = CRAM-MD5
26393   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26394   server_set_id = $auth1
26395 .endd
26396 .vindex "&$authenticated_id$&"
26397 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26398 name in &$authenticated_id$&. A more typical configuration might look up the
26399 secret string in a file, using the user name as the key. For example:
26400 .code
26401 lookup_cram:
26402   driver = cram_md5
26403   public_name = CRAM-MD5
26404   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26405                   {$value}fail}
26406   server_set_id = $auth1
26407 .endd
26408 Note that this expansion explicitly forces failure if the lookup fails
26409 because &$auth1$& contains an unknown user name.
26410
26411 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26412 using the relevant libraries, you need to know the realm to specify in the
26413 lookup and then ask for the &"userPassword"& attribute for that user in that
26414 realm, with:
26415 .code
26416 cyrusless_crammd5:
26417   driver = cram_md5
26418   public_name = CRAM-MD5
26419   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26420                   dbmjz{/etc/sasldb2}{$value}fail}
26421   server_set_id = $auth1
26422 .endd
26423
26424 .section "Using cram_md5 as a client" "SECID177"
26425 .cindex "options" "&(cram_md5)& authenticator (client)"
26426 When used as a client, the &(cram_md5)& authenticator has two options:
26427
26428
26429
26430 .option client_name cram_md5 string&!! "the primary host name"
26431 This string is expanded, and the result used as the user name data when
26432 computing the response to the server's challenge.
26433
26434
26435 .option client_secret cram_md5 string&!! unset
26436 This option must be set for the authenticator to work as a client. Its value is
26437 expanded and the result used as the secret string when computing the response.
26438
26439
26440 .vindex "&$host$&"
26441 .vindex "&$host_address$&"
26442 Different user names and secrets can be used for different servers by referring
26443 to &$host$& or &$host_address$& in the options. Forced failure of either
26444 expansion string is treated as an indication that this authenticator is not
26445 prepared to handle this case. Exim moves on to the next configured client
26446 authenticator. Any other expansion failure causes Exim to give up trying to
26447 send the message to the current server.
26448
26449 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26450 strings, is:
26451 .code
26452 fixed_cram:
26453   driver = cram_md5
26454   public_name = CRAM-MD5
26455   client_name = ph10
26456   client_secret = secret
26457 .endd
26458 .ecindex IIDcramauth1
26459 .ecindex IIDcramauth2
26460
26461
26462
26463 . ////////////////////////////////////////////////////////////////////////////
26464 . ////////////////////////////////////////////////////////////////////////////
26465
26466 .chapter "The cyrus_sasl authenticator" "CHID10"
26467 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26468 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26469 .cindex "Cyrus" "SASL library"
26470 .cindex "Kerberos"
26471 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26472 Digital Ltd (&url(http://www.aldigital.co.uk)).
26473
26474 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26475 library implementation of the RFC 2222 (&"Simple Authentication and Security
26476 Layer"&). This library supports a number of authentication mechanisms,
26477 including PLAIN and LOGIN, but also several others that Exim does not support
26478 directly. In particular, there is support for Kerberos authentication.
26479
26480 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26481 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26482 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26483 name of the driver to determine which mechanism to support.
26484
26485 Where access to some kind of secret file is required, for example in GSSAPI
26486 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26487 user, and that the Cyrus SASL library has no way of escalating privileges
26488 by default. You may also find you need to set environment variables,
26489 depending on the driver you are using.
26490
26491 The application name provided by Exim is &"exim"&, so various SASL options may
26492 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26493 Kerberos, note that because of limitations in the GSSAPI interface,
26494 changing the server keytab might need to be communicated down to the Kerberos
26495 layer independently. The mechanism for doing so is dependent upon the Kerberos
26496 implementation.
26497
26498 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26499 may be set to point to an alternative keytab file. Exim will pass this
26500 variable through from its own inherited environment when started as root or the
26501 Exim user. The keytab file needs to be readable by the Exim user.
26502 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26503 environment variable.  In practice, for those releases, the Cyrus authenticator
26504 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26505 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26506
26507
26508 .section "Using cyrus_sasl as a server" "SECID178"
26509 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26510 (on a successful authentication) into &$auth1$&. For compatibility with
26511 previous releases of Exim, the username is also placed in &$1$&. However, the
26512 use of this variable for this purpose is now deprecated, as it can lead to
26513 confusion in string expansions that also use numeric variables for other
26514 things.
26515
26516
26517 .option server_hostname cyrus_sasl string&!! "see below"
26518 This option selects the hostname that is used when communicating with the
26519 library. The default value is &`$primary_hostname`&. It is up to the underlying
26520 SASL plug-in what it does with this data.
26521
26522
26523 .option server_mech cyrus_sasl string "see below"
26524 This option selects the authentication mechanism this driver should use. The
26525 default is the value of the generic &%public_name%& option. This option allows
26526 you to use a different underlying mechanism from the advertised name. For
26527 example:
26528 .code
26529 sasl:
26530   driver = cyrus_sasl
26531   public_name = X-ANYTHING
26532   server_mech = CRAM-MD5
26533   server_set_id = $auth1
26534 .endd
26535
26536 .option server_realm cyrus_sasl string&!! unset
26537 This specifies the SASL realm that the server claims to be in.
26538
26539
26540 .option server_service cyrus_sasl string &`smtp`&
26541 This is the SASL service that the server claims to implement.
26542
26543
26544 For straightforward cases, you do not need to set any of the authenticator's
26545 private options. All you need to do is to specify an appropriate mechanism as
26546 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26547 PLAIN, you could have two authenticators as follows:
26548 .code
26549 sasl_cram_md5:
26550   driver = cyrus_sasl
26551   public_name = CRAM-MD5
26552   server_set_id = $auth1
26553
26554 sasl_plain:
26555   driver = cyrus_sasl
26556   public_name = PLAIN
26557   server_set_id = $auth2
26558 .endd
26559 Cyrus SASL does implement the LOGIN authentication method, even though it is
26560 not a standard method. It is disabled by default in the source distribution,
26561 but it is present in many binary distributions.
26562 .ecindex IIDcyrauth1
26563 .ecindex IIDcyrauth2
26564
26565
26566
26567
26568 . ////////////////////////////////////////////////////////////////////////////
26569 . ////////////////////////////////////////////////////////////////////////////
26570 .chapter "The dovecot authenticator" "CHAPdovecot"
26571 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26572 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26573 This authenticator is an interface to the authentication facility of the
26574 Dovecot POP/IMAP server, which can support a number of authentication methods.
26575 Note that Dovecot must be configured to use auth-client not auth-userdb.
26576 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26577 to use the same mechanisms for SMTP authentication. This is a server
26578 authenticator only. There is only one option:
26579
26580 .option server_socket dovecot string unset
26581
26582 This option must specify the socket that is the interface to Dovecot
26583 authentication. The &%public_name%& option must specify an authentication
26584 mechanism that Dovecot is configured to support. You can have several
26585 authenticators for different mechanisms. For example:
26586 .code
26587 dovecot_plain:
26588   driver = dovecot
26589   public_name = PLAIN
26590   server_socket = /var/run/dovecot/auth-client
26591   server_set_id = $auth1
26592
26593 dovecot_ntlm:
26594   driver = dovecot
26595   public_name = NTLM
26596   server_socket = /var/run/dovecot/auth-client
26597   server_set_id = $auth1
26598 .endd
26599 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26600 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26601 option is passed in the Dovecot authentication command. If, for a TLS
26602 connection, a client certificate has been verified, the &"valid-client-cert"&
26603 option is passed. When authentication succeeds, the identity of the user
26604 who authenticated is placed in &$auth1$&.
26605 .ecindex IIDdcotauth1
26606 .ecindex IIDdcotauth2
26607
26608
26609 . ////////////////////////////////////////////////////////////////////////////
26610 . ////////////////////////////////////////////////////////////////////////////
26611 .chapter "The gsasl authenticator" "CHAPgsasl"
26612 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26613 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26614 .cindex "authentication" "GNU SASL"
26615 .cindex "authentication" "SASL"
26616 .cindex "authentication" "EXTERNAL"
26617 .cindex "authentication" "ANONYMOUS"
26618 .cindex "authentication" "PLAIN"
26619 .cindex "authentication" "LOGIN"
26620 .cindex "authentication" "DIGEST-MD5"
26621 .cindex "authentication" "CRAM-MD5"
26622 .cindex "authentication" "SCRAM-SHA-1"
26623 The &(gsasl)& authenticator provides server integration for the GNU SASL
26624 library and the mechanisms it provides.  This is new as of the 4.80 release
26625 and there are a few areas where the library does not let Exim smoothly
26626 scale to handle future authentication mechanisms, so no guarantee can be
26627 made that any particular new authentication mechanism will be supported
26628 without code changes in Exim.
26629
26630
26631 .option server_channelbinding gsasl boolean false
26632 Some authentication mechanisms are able to use external context at both ends
26633 of the session to bind the authentication to that context, and fail the
26634 authentication process if that context differs.  Specifically, some TLS
26635 ciphersuites can provide identifying information about the cryptographic
26636 context.
26637
26638 This means that certificate identity and verification becomes a non-issue,
26639 as a man-in-the-middle attack will cause the correct client and server to
26640 see different identifiers and authentication will fail.
26641
26642 This is currently only supported when using the GnuTLS library.  This is
26643 only usable by mechanisms which support "channel binding"; at time of
26644 writing, that's the SCRAM family.
26645
26646 This defaults off to ensure smooth upgrade across Exim releases, in case
26647 this option causes some clients to start failing.  Some future release
26648 of Exim may switch the default to be true.
26649
26650
26651 .option server_hostname gsasl string&!! "see below"
26652 This option selects the hostname that is used when communicating with the
26653 library. The default value is &`$primary_hostname`&.
26654 Some mechanisms will use this data.
26655
26656
26657 .option server_mech gsasl string "see below"
26658 This option selects the authentication mechanism this driver should use. The
26659 default is the value of the generic &%public_name%& option. This option allows
26660 you to use a different underlying mechanism from the advertised name. For
26661 example:
26662 .code
26663 sasl:
26664   driver = gsasl
26665   public_name = X-ANYTHING
26666   server_mech = CRAM-MD5
26667   server_set_id = $auth1
26668 .endd
26669
26670
26671 .option server_password gsasl string&!! unset
26672 Various mechanisms need access to the cleartext password on the server, so
26673 that proof-of-possession can be demonstrated on the wire, without sending
26674 the password itself.
26675
26676 The data available for lookup varies per mechanism.
26677 In all cases, &$auth1$& is set to the &'authentication id'&.
26678 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26679 if available, else the empty string.
26680 The &$auth3$& variable will always be the &'realm'& if available,
26681 else the empty string.
26682
26683 A forced failure will cause authentication to defer.
26684
26685 If using this option, it may make sense to set the &%server_condition%&
26686 option to be simply "true".
26687
26688
26689 .option server_realm gsasl string&!! unset
26690 This specifies the SASL realm that the server claims to be in.
26691 Some mechanisms will use this data.
26692
26693
26694 .option server_scram_iter gsasl string&!! unset
26695 This option provides data for the SCRAM family of mechanisms.
26696 &$auth1$& is not available at evaluation time.
26697 (This may change, as we receive feedback on use)
26698
26699
26700 .option server_scram_salt gsasl string&!! unset
26701 This option provides data for the SCRAM family of mechanisms.
26702 &$auth1$& is not available at evaluation time.
26703 (This may change, as we receive feedback on use)
26704
26705
26706 .option server_service gsasl string &`smtp`&
26707 This is the SASL service that the server claims to implement.
26708 Some mechanisms will use this data.
26709
26710
26711 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26712 .vindex "&$auth1$&, &$auth2$&, etc"
26713 These may be set when evaluating specific options, as detailed above.
26714 They will also be set when evaluating &%server_condition%&.
26715
26716 Unless otherwise stated below, the &(gsasl)& integration will use the following
26717 meanings for these variables:
26718
26719 .ilist
26720 .vindex "&$auth1$&"
26721 &$auth1$&: the &'authentication id'&
26722 .next
26723 .vindex "&$auth2$&"
26724 &$auth2$&: the &'authorization id'&
26725 .next
26726 .vindex "&$auth3$&"
26727 &$auth3$&: the &'realm'&
26728 .endlist
26729
26730 On a per-mechanism basis:
26731
26732 .ilist
26733 .cindex "authentication" "EXTERNAL"
26734 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26735 the &%server_condition%& option must be present.
26736 .next
26737 .cindex "authentication" "ANONYMOUS"
26738 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26739 the &%server_condition%& option must be present.
26740 .next
26741 .cindex "authentication" "GSSAPI"
26742 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26743 &$auth2$& will be set to the &'authorization id'&,
26744 the &%server_condition%& option must be present.
26745 .endlist
26746
26747 An &'anonymous token'& is something passed along as an unauthenticated
26748 identifier; this is analogous to FTP anonymous authentication passing an
26749 email address, or software-identifier@, as the "password".
26750
26751
26752 An example showing the password having the realm specified in the callback
26753 and demonstrating a Cyrus SASL to GSASL migration approach is:
26754 .code
26755 gsasl_cyrusless_crammd5:
26756   driver = gsasl
26757   public_name = CRAM-MD5
26758   server_realm = imap.example.org
26759   server_password = ${lookup{$auth1:$auth3:userPassword}\
26760                     dbmjz{/etc/sasldb2}{$value}fail}
26761   server_set_id = ${quote:$auth1}
26762   server_condition = yes
26763 .endd
26764
26765
26766 . ////////////////////////////////////////////////////////////////////////////
26767 . ////////////////////////////////////////////////////////////////////////////
26768
26769 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26770 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26771 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26772 .cindex "authentication" "GSSAPI"
26773 .cindex "authentication" "Kerberos"
26774 The &(heimdal_gssapi)& authenticator provides server integration for the
26775 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26776 reliably.
26777
26778 .option server_hostname heimdal_gssapi string&!! "see below"
26779 This option selects the hostname that is used, with &%server_service%&,
26780 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26781 identifier.  The default value is &`$primary_hostname`&.
26782
26783 .option server_keytab heimdal_gssapi string&!! unset
26784 If set, then Heimdal will not use the system default keytab (typically
26785 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26786 The value should be a pathname, with no &"file:"& prefix.
26787
26788 .option server_service heimdal_gssapi string&!! "smtp"
26789 This option specifies the service identifier used, in conjunction with
26790 &%server_hostname%&, for building the identifier for finding credentials
26791 from the keytab.
26792
26793
26794 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26795 Beware that these variables will typically include a realm, thus will appear
26796 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26797 not verified, so a malicious client can set it to anything.
26798
26799 The &$auth1$& field should be safely trustable as a value from the Key
26800 Distribution Center.  Note that these are not quite email addresses.
26801 Each identifier is for a role, and so the left-hand-side may include a
26802 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26803
26804 .vindex "&$auth1$&, &$auth2$&, etc"
26805 .ilist
26806 .vindex "&$auth1$&"
26807 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26808 .next
26809 .vindex "&$auth2$&"
26810 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26811 authentication.  If that was empty, this will also be set to the
26812 GSS Display Name.
26813 .endlist
26814
26815
26816 . ////////////////////////////////////////////////////////////////////////////
26817 . ////////////////////////////////////////////////////////////////////////////
26818
26819 .chapter "The spa authenticator" "CHAPspa"
26820 .scindex IIDspaauth1 "&(spa)& authenticator"
26821 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26822 .cindex "authentication" "Microsoft Secure Password"
26823 .cindex "authentication" "NTLM"
26824 .cindex "Microsoft Secure Password Authentication"
26825 .cindex "NTLM authentication"
26826 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26827 Password Authentication'& mechanism,
26828 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26829 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26830 taken from the Samba project (&url(http://www.samba.org)). The code for the
26831 server side was subsequently contributed by Tom Kistner. The mechanism works as
26832 follows:
26833
26834 .ilist
26835 After the AUTH command has been accepted, the client sends an SPA
26836 authentication request based on the user name and optional domain.
26837 .next
26838 The server sends back a challenge.
26839 .next
26840 The client builds a challenge response which makes use of the user's password
26841 and sends it to the server, which then accepts or rejects it.
26842 .endlist
26843
26844 Encryption is used to protect the password in transit.
26845
26846
26847
26848 .section "Using spa as a server" "SECID179"
26849 .cindex "options" "&(spa)& authenticator (server)"
26850 The &(spa)& authenticator has just one server option:
26851
26852 .option server_password spa string&!! unset
26853 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26854 This option is expanded, and the result must be the cleartext password for the
26855 authenticating user, whose name is at this point in &$auth1$&. For
26856 compatibility with previous releases of Exim, the user name is also placed in
26857 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26858 it can lead to confusion in string expansions that also use numeric variables
26859 for other things. For example:
26860 .code
26861 spa:
26862   driver = spa
26863   public_name = NTLM
26864   server_password = \
26865     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26866 .endd
26867 If the expansion is forced to fail, authentication fails. Any other expansion
26868 failure causes a temporary error code to be returned.
26869
26870
26871
26872
26873
26874 .section "Using spa as a client" "SECID180"
26875 .cindex "options" "&(spa)& authenticator (client)"
26876 The &(spa)& authenticator has the following client options:
26877
26878
26879
26880 .option client_domain spa string&!! unset
26881 This option specifies an optional domain for the authentication.
26882
26883
26884 .option client_password spa string&!! unset
26885 This option specifies the user's password, and must be set.
26886
26887
26888 .option client_username spa string&!! unset
26889 This option specifies the user name, and must be set. Here is an example of a
26890 configuration of this authenticator for use with the mail servers at
26891 &'msn.com'&:
26892 .code
26893 msn:
26894   driver = spa
26895   public_name = MSN
26896   client_username = msn/msn_username
26897   client_password = msn_plaintext_password
26898   client_domain = DOMAIN_OR_UNSET
26899 .endd
26900 .ecindex IIDspaauth1
26901 .ecindex IIDspaauth2
26902
26903
26904
26905
26906
26907 . ////////////////////////////////////////////////////////////////////////////
26908 . ////////////////////////////////////////////////////////////////////////////
26909
26910 .chapter "The tls authenticator" "CHAPtlsauth"
26911 .scindex IIDtlsauth1 "&(tls)& authenticator"
26912 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26913 .cindex "authentication" "Client Certificate"
26914 .cindex "authentication" "X509"
26915 .cindex "Certificate-based authentication"
26916 The &(tls)& authenticator provides server support for
26917 authentication based on client certificates.
26918
26919 It is not an SMTP authentication mechanism and is not
26920 advertised by the server as part of the SMTP EHLO response.
26921 It is an Exim authenticator in the sense that it affects
26922 the protocol element of the log line, can be tested for
26923 by the &%authenticated%& ACL condition, and can set
26924 the &$authenticated_id$& variable.
26925
26926 The client must present a verifiable certificate,
26927 for which it must have been requested via the
26928 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26929 (see &<<CHAPTLS>>&).
26930
26931 If an authenticator of this type is configured it is
26932 run before any SMTP-level communication is done,
26933 and can authenticate the connection.
26934 If it does, SMTP authentication is not offered.
26935
26936 A maximum of one authenticator of this type may be present.
26937
26938
26939 .cindex "options" "&(tls)& authenticator (server)"
26940 The &(tls)& authenticator has three server options:
26941
26942 .option server_param1 tls string&!! unset
26943 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26944 This option is expanded after the TLS negotiation and
26945 the result is placed in &$auth1$&.
26946 If the expansion is forced to fail, authentication fails. Any other expansion
26947 failure causes a temporary error code to be returned.
26948
26949 .option server_param2 tls string&!! unset
26950 .option server_param3 tls string&!! unset
26951 As above, for &$auth2$& and &$auth3$&.
26952
26953 &%server_param1%& may also be spelled &%server_param%&.
26954
26955
26956 Example:
26957 .code
26958 tls:
26959   driver = tls
26960   server_param1 =     ${certextract {subj_altname,mail,>:} \
26961                                     {$tls_in_peercert}}
26962   server_condition =  ${if forany {$auth1} \
26963                             {!= {0} \
26964                                 {${lookup ldap{ldap:///\
26965                          mailname=${quote_ldap_dn:${lc:$item}},\
26966                          ou=users,LDAP_DC?mailid} {$value}{0} \
26967                        }    }   } }
26968   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26969 .endd
26970 This accepts a client certificate that is verifiable against any
26971 of your configured trust-anchors
26972 (which usually means the full set of public CAs)
26973 and which has a SAN with a good account name.
26974 Note that the client cert is on the wire in-clear, including the SAN,
26975 whereas a plaintext SMTP AUTH done inside TLS is not.
26976
26977 . An alternative might use
26978 . .code
26979 .   server_param1 = ${sha256:$tls_in_peercert}
26980 . .endd
26981 . to require one of a set of specific certs that define a given account
26982 . (the verification is still required, but mostly irrelevant).
26983 . This would help for per-device use.
26984 .
26985 . However, for the future we really need support for checking a
26986 . user cert in LDAP - which probably wants a base-64 DER.
26987
26988 .ecindex IIDtlsauth1
26989 .ecindex IIDtlsauth2
26990
26991
26992 Note that because authentication is traditionally an SMTP operation,
26993 the &%authenticated%& ACL condition cannot be used in
26994 a connect- or helo-ACL.
26995
26996
26997
26998 . ////////////////////////////////////////////////////////////////////////////
26999 . ////////////////////////////////////////////////////////////////////////////
27000
27001 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27002          "Encrypted SMTP connections"
27003 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27004 .scindex IIDencsmtp2 "SMTP" "encryption"
27005 .cindex "TLS" "on SMTP connection"
27006 .cindex "OpenSSL"
27007 .cindex "GnuTLS"
27008 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27009 Sockets Layer), is implemented by making use of the OpenSSL library or the
27010 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27011 cryptographic code in the Exim distribution itself for implementing TLS. In
27012 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27013 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27014 You also need to understand the basic concepts of encryption at a managerial
27015 level, and in particular, the way that public keys, private keys, and
27016 certificates are used.
27017
27018 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27019 connection is established, the client issues a STARTTLS command. If the
27020 server accepts this, the client and the server negotiate an encryption
27021 mechanism. If the negotiation succeeds, the data that subsequently passes
27022 between them is encrypted.
27023
27024 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27025 and if so, what cipher suite is in use, whether the client supplied a
27026 certificate, and whether or not that certificate was verified. This makes it
27027 possible for an Exim server to deny or accept certain commands based on the
27028 encryption state.
27029
27030 &*Warning*&: Certain types of firewall and certain anti-virus products can
27031 disrupt TLS connections. You need to turn off SMTP scanning for these products
27032 in order to get TLS to work.
27033
27034
27035
27036 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
27037          "SECID284"
27038 .cindex "ssmtp protocol"
27039 .cindex "smtps protocol"
27040 .cindex "SMTP" "ssmtp protocol"
27041 .cindex "SMTP" "smtps protocol"
27042 Early implementations of encrypted SMTP used a different TCP port from normal
27043 SMTP, and expected an encryption negotiation to start immediately, instead of
27044 waiting for a STARTTLS command from the client using the standard SMTP
27045 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
27046 allocated for this purpose.
27047
27048 This approach was abandoned when encrypted SMTP was standardized, but there are
27049 still some legacy clients that use it. Exim supports these clients by means of
27050 the &%tls_on_connect_ports%& global option. Its value must be a list of port
27051 numbers; the most common use is expected to be:
27052 .code
27053 tls_on_connect_ports = 465
27054 .endd
27055 The port numbers specified by this option apply to all SMTP connections, both
27056 via the daemon and via &'inetd'&. You still need to specify all the ports that
27057 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27058 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27059 an extra port &-- rather, it specifies different behaviour on a port that is
27060 defined elsewhere.
27061
27062 There is also a &%-tls-on-connect%& command line option. This overrides
27063 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
27064
27065
27066
27067
27068
27069
27070 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27071 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27072 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27073 followed later, when the first versions of GnuTLS were released. To build Exim
27074 to use GnuTLS, you need to set
27075 .code
27076 USE_GNUTLS=yes
27077 .endd
27078 in Local/Makefile, in addition to
27079 .code
27080 SUPPORT_TLS=yes
27081 .endd
27082 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27083 include files and libraries for GnuTLS can be found.
27084
27085 There are some differences in usage when using GnuTLS instead of OpenSSL:
27086
27087 .ilist
27088 The &%tls_verify_certificates%& option
27089 cannot be the path of a directory
27090 for GnuTLS versions before 3.3.6
27091 (for later versions, or OpenSSL, it can be either).
27092 .next
27093 The default value for &%tls_dhparam%& differs for historical reasons.
27094 .next
27095 .vindex "&$tls_in_peerdn$&"
27096 .vindex "&$tls_out_peerdn$&"
27097 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27098 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27099 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27100 .next
27101 OpenSSL identifies cipher suites using hyphens as separators, for example:
27102 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27103 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27104 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27105 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27106 to handle its own older variants) when processing lists of cipher suites in the
27107 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27108 option).
27109 .next
27110 The &%tls_require_ciphers%& options operate differently, as described in the
27111 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27112 .next
27113 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27114 When using OpenSSL, this option is ignored.
27115 (If an API is found to let OpenSSL be configured in this way,
27116 let the Exim Maintainers know and we'll likely use it).
27117 .next
27118 Some other recently added features may only be available in one or the other.
27119 This should be documented with the feature.  If the documentation does not
27120 explicitly state that the feature is infeasible in the other TLS
27121 implementation, then patches are welcome.
27122 .endlist
27123
27124
27125 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27126 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27127 an explicit path; if the latter, then the text about generation still applies,
27128 but not the chosen filename.
27129 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27130 See the documentation of &%tls_dhparam%& for more information.
27131
27132 GnuTLS uses D-H parameters that may take a substantial amount of time
27133 to compute. It is unreasonable to re-compute them for every TLS session.
27134 Therefore, Exim keeps this data in a file in its spool directory, called
27135 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27136 of bits requested.
27137 The file is owned by the Exim user and is readable only by
27138 its owner. Every Exim process that start up GnuTLS reads the D-H
27139 parameters from this file. If the file does not exist, the first Exim process
27140 that needs it computes the data and writes it to a temporary file which is
27141 renamed once it is complete. It does not matter if several Exim processes do
27142 this simultaneously (apart from wasting a few resources). Once a file is in
27143 place, new Exim processes immediately start using it.
27144
27145 For maximum security, the parameters that are stored in this file should be
27146 recalculated periodically, the frequency depending on your paranoia level.
27147 If you are avoiding using the fixed D-H primes published in RFCs, then you
27148 are concerned about some advanced attacks and will wish to do this; if you do
27149 not regenerate then you might as well stick to the standard primes.
27150
27151 Arranging this is easy in principle; just delete the file when you want new
27152 values to be computed. However, there may be a problem. The calculation of new
27153 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27154 If the system is not very active, &_/dev/random_& may delay returning data
27155 until enough randomness (entropy) is available. This may cause Exim to hang for
27156 a substantial amount of time, causing timeouts on incoming connections.
27157
27158 The solution is to generate the parameters externally to Exim. They are stored
27159 in &_gnutls-params-N_& in PEM format, which means that they can be
27160 generated externally using the &(certtool)& command that is part of GnuTLS.
27161
27162 To replace the parameters with new ones, instead of deleting the file
27163 and letting Exim re-create it, you can generate new parameters using
27164 &(certtool)& and, when this has been done, replace Exim's cache file by
27165 renaming. The relevant commands are something like this:
27166 .code
27167 # ls
27168 [ look for file; assume gnutls-params-2236 is the most recent ]
27169 # rm -f new-params
27170 # touch new-params
27171 # chown exim:exim new-params
27172 # chmod 0600 new-params
27173 # certtool --generate-dh-params --bits 2236 >>new-params
27174 # openssl dhparam -noout -text -in new-params | head
27175 [ check the first line, make sure it's not more than 2236;
27176   if it is, then go back to the start ("rm") and repeat
27177   until the size generated is at most the size requested ]
27178 # chmod 0400 new-params
27179 # mv new-params gnutls-params-2236
27180 .endd
27181 If Exim never has to generate the parameters itself, the possibility of
27182 stalling is removed.
27183
27184 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27185 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27186 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27187 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27188 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27189 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27190 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27191 which applies to all D-H usage, client or server.  If the value returned by
27192 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27193 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27194 limit, which is still much higher than Exim historically used.
27195
27196 The filename and bits used will change as the GnuTLS maintainers change the
27197 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27198 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27199 2432 bits, while NSS is limited to 2236 bits.
27200
27201 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27202 increase the chance of the generated prime actually being within acceptable
27203 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27204 procedure above.  There is no sane procedure available to Exim to double-check
27205 the size of the generated prime, so it might still be too large.
27206
27207
27208 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27209 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27210 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27211 There is a function in the OpenSSL library that can be passed a list of cipher
27212 suites before the cipher negotiation takes place. This specifies which ciphers
27213 are acceptable. The list is colon separated and may contain names like
27214 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27215 directly to this function call.
27216 Many systems will install the OpenSSL manual-pages, so you may have
27217 &'ciphers(1)'& available to you.
27218 The following quotation from the OpenSSL
27219 documentation specifies what forms of item are allowed in the cipher string:
27220
27221 .ilist
27222 It can consist of a single cipher suite such as RC4-SHA.
27223 .next
27224 It can represent a list of cipher suites containing a certain algorithm,
27225 or cipher suites of a certain type. For example SHA1 represents all
27226 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27227 SSL v3 algorithms.
27228 .next
27229 Lists of cipher suites can be combined in a single cipher string using
27230 the + character. This is used as a logical and operation. For example
27231 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27232 algorithms.
27233 .endlist
27234
27235 Each cipher string can be optionally preceded by one of the characters &`!`&,
27236 &`-`& or &`+`&.
27237 .ilist
27238 If &`!`& is used, the ciphers are permanently deleted from the list. The
27239 ciphers deleted can never reappear in the list even if they are explicitly
27240 stated.
27241 .next
27242 If &`-`& is used, the ciphers are deleted from the list, but some or all
27243 of the ciphers can be added again by later options.
27244 .next
27245 If &`+`& is used, the ciphers are moved to the end of the list. This
27246 option does not add any new ciphers; it just moves matching existing ones.
27247 .endlist
27248
27249 If none of these characters is present, the string is interpreted as
27250 a list of ciphers to be appended to the current preference list. If the list
27251 includes any ciphers already present they will be ignored: that is, they will
27252 not be moved to the end of the list.
27253 .endlist
27254
27255 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27256 string:
27257 .code
27258 # note single-quotes to get ! past any shell history expansion
27259 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27260 .endd
27261
27262 This example will let the library defaults be permitted on the MX port, where
27263 there's probably no identity verification anyway, but ups the ante on the
27264 submission ports where the administrator might have some influence on the
27265 choice of clients used:
27266 .code
27267 # OpenSSL variant; see man ciphers(1)
27268 tls_require_ciphers = ${if =={$received_port}{25}\
27269                            {DEFAULT}\
27270                            {HIGH:!MD5:!SHA1}}
27271 .endd
27272
27273
27274
27275 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27276          "SECTreqciphgnu"
27277 .cindex "GnuTLS" "specifying parameters for"
27278 .cindex "TLS" "specifying ciphers (GnuTLS)"
27279 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27280 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27281 .cindex "TLS" "specifying protocols (GnuTLS)"
27282 .cindex "TLS" "specifying priority string (GnuTLS)"
27283 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27284 The GnuTLS library allows the caller to provide a "priority string", documented
27285 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27286 ciphersuite specification in OpenSSL.
27287
27288 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27289 and controls both protocols and ciphers.
27290
27291 The &%tls_require_ciphers%& option is available both as an global option,
27292 controlling how Exim behaves as a server, and also as an option of the
27293 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27294 the value is string expanded.  The resulting string is not an Exim list and
27295 the string is given to the GnuTLS library, so that Exim does not need to be
27296 aware of future feature enhancements of GnuTLS.
27297
27298 Documentation of the strings accepted may be found in the GnuTLS manual, under
27299 "Priority strings".  This is online as
27300 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27301 but beware that this relates to GnuTLS 3, which may be newer than the version
27302 installed on your system.  If you are using GnuTLS 3,
27303 then the example code
27304 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27305 on that site can be used to test a given string.
27306
27307 For example:
27308 .code
27309 # Disable older versions of protocols
27310 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27311 .endd
27312
27313 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27314 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27315 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27316
27317 This example will let the library defaults be permitted on the MX port, where
27318 there's probably no identity verification anyway, and lowers security further
27319 by increasing compatibility; but this ups the ante on the submission ports
27320 where the administrator might have some influence on the choice of clients
27321 used:
27322 .code
27323 # GnuTLS variant
27324 tls_require_ciphers = ${if =={$received_port}{25}\
27325                            {NORMAL:%COMPAT}\
27326                            {SECURE128}}
27327 .endd
27328
27329
27330 .section "Configuring an Exim server to use TLS" "SECID182"
27331 .cindex "TLS" "configuring an Exim server"
27332 When Exim has been built with TLS support, it advertises the availability of
27333 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27334 but not to any others. The default value of this option is *, which means
27335 that STARTTLS is alway advertised.  Set it to blank to never advertise;
27336 this is reasonble for systems that want to use TLS only as a client.
27337
27338 If STARTTLS is to be used you
27339 need to set some other options in order to make TLS available.
27340
27341 If a client issues a STARTTLS command and there is some configuration
27342 problem in the server, the command is rejected with a 454 error. If the client
27343 persists in trying to issue SMTP commands, all except QUIT are rejected
27344 with the error
27345 .code
27346 554 Security failure
27347 .endd
27348 If a STARTTLS command is issued within an existing TLS session, it is
27349 rejected with a 554 error code.
27350
27351 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27352 must be set to match some hosts. The default is * which matches all hosts.
27353
27354 If this is all you do, TLS encryption will be enabled but not authentication -
27355 meaning that the peer has no assurance it is actually you he is talking to.
27356 You gain protection from a passive sniffer listening on the wire but not
27357 from someone able to intercept the communication.
27358
27359 Further protection requires some further configuration at the server end.
27360
27361 It is rumoured that all existing clients that support TLS/SSL use RSA
27362 encryption. To make this work you need to set, in the server,
27363 .code
27364 tls_certificate = /some/file/name
27365 tls_privatekey = /some/file/name
27366 .endd
27367 These options are, in fact, expanded strings, so you can make them depend on
27368 the identity of the client that is connected if you wish. The first file
27369 contains the server's X509 certificate, and the second contains the private key
27370 that goes with it. These files need to be
27371 PEM format and readable by the Exim user, and must
27372 always be given as full path names.
27373 The key must not be password-protected.
27374 They can be the same file if both the
27375 certificate and the key are contained within it. If &%tls_privatekey%& is not
27376 set, or if its expansion is forced to fail or results in an empty string, this
27377 is assumed to be the case. The certificate file may also contain intermediate
27378 certificates that need to be sent to the client to enable it to authenticate
27379 the server's certificate.
27380
27381 If you do not understand about certificates and keys, please try to find a
27382 source of this background information, which is not Exim-specific. (There are a
27383 few comments below in section &<<SECTcerandall>>&.)
27384
27385 &*Note*&: These options do not apply when Exim is operating as a client &--
27386 they apply only in the case of a server. If you need to use a certificate in an
27387 Exim client, you must set the options of the same names in an &(smtp)&
27388 transport.
27389
27390 With just these options, an Exim server will be able to use TLS. It does not
27391 require the client to have a certificate (but see below for how to insist on
27392 this). There is one other option that may be needed in other situations. If
27393 .code
27394 tls_dhparam = /some/file/name
27395 .endd
27396 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27397 with the parameters contained in the file.
27398 Set this to &`none`& to disable use of DH entirely, by making no prime
27399 available:
27400 .code
27401 tls_dhparam = none
27402 .endd
27403 This may also be set to a string identifying a standard prime to be used for
27404 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27405 used is &`ike23`&.  There are a few standard primes available, see the
27406 documentation for &%tls_dhparam%& for the complete list.
27407
27408 See the command
27409 .code
27410 openssl dhparam
27411 .endd
27412 for a way of generating file data.
27413
27414 The strings supplied for these three options are expanded every time a client
27415 host connects. It is therefore possible to use different certificates and keys
27416 for different hosts, if you so wish, by making use of the client's IP address
27417 in &$sender_host_address$& to control the expansion. If a string expansion is
27418 forced to fail, Exim behaves as if the option is not set.
27419
27420 .cindex "cipher" "logging"
27421 .cindex "log" "TLS cipher"
27422 .vindex "&$tls_in_cipher$&"
27423 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27424 an incoming TLS connection. It is included in the &'Received:'& header of an
27425 incoming message (by default &-- you can, of course, change this), and it is
27426 also included in the log line that records a message's arrival, keyed by
27427 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27428 condition can be used to test for specific cipher suites in ACLs.
27429
27430 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27431 can check the name of the cipher suite and vary their actions accordingly. The
27432 cipher suite names vary, depending on which TLS library is being used. For
27433 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27434 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27435 documentation for more details.
27436
27437 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27438 (again depending on the &%tls_cipher%& log selector).
27439
27440
27441 .section "Requesting and verifying client certificates" "SECID183"
27442 .cindex "certificate" "verification of client"
27443 .cindex "TLS" "client certificate verification"
27444 If you want an Exim server to request a certificate when negotiating a TLS
27445 session with a client, you must set either &%tls_verify_hosts%& or
27446 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27447 apply to all TLS connections. For any host that matches one of these options,
27448 Exim requests a certificate as part of the setup of the TLS session. The
27449 contents of the certificate are verified by comparing it with a list of
27450 expected certificates.
27451 These may be the system default set (depending on library version),
27452 an explicit file or,
27453 depending on library version, a directory, identified by
27454 &%tls_verify_certificates%&.
27455
27456 A file can contain multiple certificates, concatenated end to end. If a
27457 directory is used
27458 (OpenSSL only),
27459 each certificate must be in a separate file, with a name (or a symbolic link)
27460 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27461 certificate. You can compute the relevant hash by running the command
27462 .code
27463 openssl x509 -hash -noout -in /cert/file
27464 .endd
27465 where &_/cert/file_& contains a single certificate.
27466
27467 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27468 what happens if the client does not supply a certificate, or if the certificate
27469 does not match any of the certificates in the collection named by
27470 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27471 attempt to set up a TLS session is aborted, and the incoming connection is
27472 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27473 session continues. ACLs that run for subsequent SMTP commands can detect the
27474 fact that no certificate was verified, and vary their actions accordingly. For
27475 example, you can insist on a certificate before accepting a message for
27476 relaying, but not when the message is destined for local delivery.
27477
27478 .vindex "&$tls_in_peerdn$&"
27479 When a client supplies a certificate (whether it verifies or not), the value of
27480 the Distinguished Name of the certificate is made available in the variable
27481 &$tls_in_peerdn$& during subsequent processing of the message.
27482
27483 .cindex "log" "distinguished name"
27484 Because it is often a long text string, it is not included in the log line or
27485 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27486 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27487 &%received_header_text%& to change the &'Received:'& header. When no
27488 certificate is supplied, &$tls_in_peerdn$& is empty.
27489
27490
27491 .section "Revoked certificates" "SECID184"
27492 .cindex "TLS" "revoked certificates"
27493 .cindex "revocation list"
27494 .cindex "certificate" "revocation list"
27495 .cindex "OCSP" "stapling"
27496 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27497 certificates are revoked. If you have such a list, you can pass it to an Exim
27498 server using the global option called &%tls_crl%& and to an Exim client using
27499 an identically named option for the &(smtp)& transport. In each case, the value
27500 of the option is expanded and must then be the name of a file that contains a
27501 CRL in PEM format.
27502 The downside is that clients have to periodically re-download a potentially huge
27503 file from every certificate authority they know of.
27504
27505 The way with most moving parts at query time is Online Certificate
27506 Status Protocol (OCSP), where the client verifies the certificate
27507 against an OCSP server run by the CA.  This lets the CA track all
27508 usage of the certs.  It requires running software with access to the
27509 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27510 is based on HTTP and can be proxied accordingly.
27511
27512 The only widespread OCSP server implementation (known to this writer)
27513 comes as part of OpenSSL and aborts on an invalid request, such as
27514 connecting to the port and then disconnecting.  This requires
27515 re-entering the passphrase each time some random client does this.
27516
27517 The third way is OCSP Stapling; in this, the server using a certificate
27518 issued by the CA periodically requests an OCSP proof of validity from
27519 the OCSP server, then serves it up inline as part of the TLS
27520 negotiation.   This approach adds no extra round trips, does not let the
27521 CA track users, scales well with number of certs issued by the CA and is
27522 resilient to temporary OCSP server failures, as long as the server
27523 starts retrying to fetch an OCSP proof some time before its current
27524 proof expires.  The downside is that it requires server support.
27525
27526 Unless Exim is built with the support disabled,
27527 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27528 support for OCSP stapling is included.
27529
27530 There is a global option called &%tls_ocsp_file%&.
27531 The file specified therein is expected to be in DER format, and contain
27532 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27533 option will be re-expanded for SNI, if the &%tls_certificate%& option
27534 contains &`tls_in_sni`&, as per other TLS options.
27535
27536 Exim does not at this time implement any support for fetching a new OCSP
27537 proof.  The burden is on the administrator to handle this, outside of
27538 Exim.  The file specified should be replaced atomically, so that the
27539 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27540 on each connection, so a new file will be handled transparently on the
27541 next connection.
27542
27543 When built with OpenSSL Exim will check for a valid next update timestamp
27544 in the OCSP proof; if not present, or if the proof has expired, it will be
27545 ignored.
27546
27547 For the client to be able to verify the stapled OCSP the server must
27548 also supply, in its stapled information, any intermediate
27549 certificates for the chain leading to the OCSP proof from the signer
27550 of the server certificate.  There may be zero or one such. These
27551 intermediate certificates should be added to the server OCSP stapling
27552 file named by &%tls_ocsp_file%&.
27553
27554 Note that the proof only covers the terminal server certificate,
27555 not any of the chain from CA to it.
27556
27557 There is no current way to staple a proof for a client certificate.
27558
27559 .code
27560   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27561   OCSP server is supplied.  The server URL may be included in the
27562   server certificate, if the CA is helpful.
27563
27564   One failure mode seen was the OCSP Signer cert expiring before the end
27565   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27566   noted this as invalid overall, but the re-fetch script did not.
27567 .endd
27568
27569
27570
27571
27572 .section "Configuring an Exim client to use TLS" "SECID185"
27573 .cindex "cipher" "logging"
27574 .cindex "log" "TLS cipher"
27575 .cindex "log" "distinguished name"
27576 .cindex "TLS" "configuring an Exim client"
27577 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27578 deliveries as well as to incoming, the latter one causing logging of the
27579 server certificate's DN. The remaining client configuration for TLS is all
27580 within the &(smtp)& transport.
27581
27582 It is not necessary to set any options to have TLS work in the &(smtp)&
27583 transport. If Exim is built with TLS support, and TLS is advertised by a
27584 server, the &(smtp)& transport always tries to start a TLS session. However,
27585 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27586 transport) to a list of server hosts for which TLS should not be used.
27587
27588 If you do not want Exim to attempt to send messages unencrypted when an attempt
27589 to set up an encrypted connection fails in any way, you can set
27590 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27591 those hosts, delivery is always deferred if an encrypted connection cannot be
27592 set up. If there are any other hosts for the address, they are tried in the
27593 usual way.
27594
27595 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27596 the message unencrypted. It always does this if the response to STARTTLS is
27597 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27598 session after a success response code, what happens is controlled by the
27599 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27600 delivery to this host is deferred, and other hosts (if available) are tried. If
27601 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27602 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27603 negotiation fails, Exim closes the current connection (because it is in an
27604 unknown state), opens a new one to the same host, and then tries the delivery
27605 unencrypted.
27606
27607 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27608 transport provide the client with a certificate, which is passed to the server
27609 if it requests it. If the server is Exim, it will request a certificate only if
27610 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27611
27612 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27613 specifies a collection of expected server certificates.
27614 These may be the system default set (depending on library version),
27615 a file or,
27616 depending on library version, a directory,
27617 must name a file or,
27618 for OpenSSL only (not GnuTLS), a directory.
27619 The client verifies the server's certificate
27620 against this collection, taking into account any revoked certificates that are
27621 in the list defined by &%tls_crl%&.
27622 Failure to verify fails the TLS connection unless either of the
27623 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27624
27625 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27626 certificate verification to the listed servers.  Verification either must
27627 or need not succeed respectively.
27628
27629 The &(smtp)& transport has two OCSP-related options:
27630 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27631 is requested and required for the connection to proceed.  The default
27632 value is empty.
27633 &%hosts_request_ocsp%&; a host-list for which (additionally)
27634 a Certificate Status is requested (but not necessarily verified).  The default
27635 value is "*" meaning that requests are made unless configured
27636 otherwise.
27637
27638 The host(s) should also be in &%hosts_require_tls%&, and
27639 &%tls_verify_certificates%& configured for the transport,
27640 for OCSP to be relevant.
27641
27642 If
27643 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27644 list of permitted cipher suites. If either of these checks fails, delivery to
27645 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27646 alternative hosts, if any.
27647
27648  &*Note*&:
27649 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27650 is operating as a client. Exim does not assume that a server certificate (set
27651 by the global options of the same name) should also be used when operating as a
27652 client.
27653
27654 .vindex "&$host$&"
27655 .vindex "&$host_address$&"
27656 All the TLS options in the &(smtp)& transport are expanded before use, with
27657 &$host$& and &$host_address$& containing the name and address of the server to
27658 which the client is connected. Forced failure of an expansion causes Exim to
27659 behave as if the relevant option were unset.
27660
27661 .vindex &$tls_out_bits$&
27662 .vindex &$tls_out_cipher$&
27663 .vindex &$tls_out_peerdn$&
27664 .vindex &$tls_out_sni$&
27665 Before an SMTP connection is established, the
27666 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27667 variables are emptied. (Until the first connection, they contain the values
27668 that were set when the message was received.) If STARTTLS is subsequently
27669 successfully obeyed, these variables are set to the relevant values for the
27670 outgoing connection.
27671
27672
27673
27674 .section "Use of TLS Server Name Indication" "SECTtlssni"
27675 .cindex "TLS" "Server Name Indication"
27676 .vindex "&$tls_in_sni$&"
27677 .oindex "&%tls_in_sni%&"
27678 With TLS1.0 or above, there is an extension mechanism by which extra
27679 information can be included at various points in the protocol.  One of these
27680 extensions, documented in RFC 6066 (and before that RFC 4366) is
27681 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27682 client in the initial handshake, so that the server can examine the servername
27683 within and possibly choose to use different certificates and keys (and more)
27684 for this session.
27685
27686 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27687 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27688 address.
27689
27690 With SMTP to MX, there are the same problems here as in choosing the identity
27691 against which to validate a certificate: you can't rely on insecure DNS to
27692 provide the identity which you then cryptographically verify.  So this will
27693 be of limited use in that environment.
27694
27695 With SMTP to Submission, there is a well-defined hostname which clients are
27696 connecting to and can validate certificates against.  Thus clients &*can*&
27697 choose to include this information in the TLS negotiation.  If this becomes
27698 wide-spread, then hosters can choose to present different certificates to
27699 different clients.  Or even negotiate different cipher suites.
27700
27701 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27702 if not empty, will be sent on a TLS session as part of the handshake.  There's
27703 nothing more to it.  Choosing a sensible value not derived insecurely is the
27704 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27705 for the lifetime of the client connection (including during authentication).
27706
27707 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27708 received from a client.
27709 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27710
27711 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27712 option (prior to expansion) then the following options will be re-expanded
27713 during TLS session handshake, to permit alternative values to be chosen:
27714
27715 .ilist
27716 .vindex "&%tls_certificate%&"
27717 &%tls_certificate%&
27718 .next
27719 .vindex "&%tls_crl%&"
27720 &%tls_crl%&
27721 .next
27722 .vindex "&%tls_privatekey%&"
27723 &%tls_privatekey%&
27724 .next
27725 .vindex "&%tls_verify_certificates%&"
27726 &%tls_verify_certificates%&
27727 .next
27728 .vindex "&%tls_ocsp_file%&"
27729 &%tls_ocsp_file%&
27730 .endlist
27731
27732 Great care should be taken to deal with matters of case, various injection
27733 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27734 can always be referenced; it is important to remember that &$tls_in_sni$& is
27735 arbitrary unverified data provided prior to authentication.
27736 Further, the initial certificate is loaded before SNI is arrived, so
27737 an expansion for &%tls_certificate%& must have a default which is used
27738 when &$tls_in_sni$& is empty.
27739
27740 The Exim developers are proceeding cautiously and so far no other TLS options
27741 are re-expanded.
27742
27743 When Exim is built against OpenSSL, OpenSSL must have been built with support
27744 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27745 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27746 see &`-servername`& in the output, then OpenSSL has support.
27747
27748 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27749 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27750 built, then you have SNI support).
27751
27752
27753
27754 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27755          "SECTmulmessam"
27756 .cindex "multiple SMTP deliveries with TLS"
27757 .cindex "TLS" "multiple message deliveries"
27758 .new
27759 Exim sends multiple messages down the same TCP/IP connection by starting up
27760 an entirely new delivery process for each message, passing the socket from
27761 one process to the next. This implementation does not fit well with the use
27762 of TLS, because there is quite a lot of state information associated with a TLS
27763 connection, not just a socket identification. Passing all the state information
27764 to a new process is not feasible. Consequently, for sending using TLS Exim
27765 starts an additional proxy process for handling the encryption, piping the
27766 unencrypted data stream from and to the delivery processes.
27767
27768 An older mode of operation can be enabled on a per-host basis by the
27769 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
27770 this list the proxy process descibed above is not used; instead Exim
27771 .wen
27772 shuts down an existing TLS session being run by the delivery process
27773 before passing the socket to a new process. The new process may then
27774 try to start a new TLS session, and if successful, may try to re-authenticate
27775 if AUTH is in use, before sending the next message.
27776
27777 The RFC is not clear as to whether or not an SMTP session continues in clear
27778 after TLS has been shut down, or whether TLS may be restarted again later, as
27779 just described. However, if the server is Exim, this shutdown and
27780 reinitialization works. It is not known which (if any) other servers operate
27781 successfully if the client closes a TLS session and continues with unencrypted
27782 SMTP, but there are certainly some that do not work. For such servers, Exim
27783 should not pass the socket to another process, because the failure of the
27784 subsequent attempt to use it would cause Exim to record a temporary host error,
27785 and delay other deliveries to that host.
27786
27787 To test for this case, Exim sends an EHLO command to the server after
27788 closing down the TLS session. If this fails in any way, the connection is
27789 closed instead of being passed to a new delivery process, but no retry
27790 information is recorded.
27791
27792 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27793 &(smtp)& transport to match those hosts for which Exim should not pass
27794 connections to new processes if TLS has been used.
27795
27796
27797
27798
27799 .section "Certificates and all that" "SECTcerandall"
27800 .cindex "certificate" "references to discussion"
27801 In order to understand fully how TLS works, you need to know about
27802 certificates, certificate signing, and certificate authorities. This is not the
27803 place to give a tutorial, especially as I do not know very much about it
27804 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27805 to Apache, currently at
27806 .display
27807 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27808 .endd
27809 Other parts of the &'modssl'& documentation are also helpful, and have
27810 links to further files.
27811 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27812 0-201-61598-3), contains both introductory and more in-depth descriptions.
27813 Some sample programs taken from the book are available from
27814 .display
27815 &url(http://www.rtfm.com/openssl-examples/)
27816 .endd
27817
27818
27819 .section "Certificate chains" "SECID186"
27820 The file named by &%tls_certificate%& may contain more than one
27821 certificate. This is useful in the case where the certificate that is being
27822 sent is validated by an intermediate certificate which the other end does
27823 not have. Multiple certificates must be in the correct order in the file.
27824 First the host's certificate itself, then the first intermediate
27825 certificate to validate the issuer of the host certificate, then the next
27826 intermediate certificate to validate the issuer of the first intermediate
27827 certificate, and so on, until finally (optionally) the root certificate.
27828 The root certificate must already be trusted by the recipient for
27829 validation to succeed, of course, but if it's not preinstalled, sending the
27830 root certificate along with the rest makes it available for the user to
27831 install if the receiving end is a client MUA that can interact with a user.
27832
27833 Note that certificates using MD5 are unlikely to work on today's Internet;
27834 even if your libraries allow loading them for use in Exim when acting as a
27835 server, increasingly clients will not accept such certificates.  The error
27836 diagnostics in such a case can be frustratingly vague.
27837
27838
27839
27840 .section "Self-signed certificates" "SECID187"
27841 .cindex "certificate" "self-signed"
27842 You can create a self-signed certificate using the &'req'& command provided
27843 with OpenSSL, like this:
27844 . ==== Do not shorten the duration here without reading and considering
27845 . ==== the text below.  Please leave it at 9999 days.
27846 .code
27847 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27848             -days 9999 -nodes
27849 .endd
27850 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27851 delimited and so can be identified independently. The &%-days%& option
27852 specifies a period for which the certificate is valid. The &%-nodes%& option is
27853 important: if you do not set it, the key is encrypted with a passphrase
27854 that you are prompted for, and any use that is made of the key causes more
27855 prompting for the passphrase. This is not helpful if you are going to use
27856 this certificate and key in an MTA, where prompting is not possible.
27857
27858 . ==== I expect to still be working 26 years from now.  The less technical
27859 . ==== debt I create, in terms of storing up trouble for my later years, the
27860 . ==== happier I will be then.  We really have reached the point where we
27861 . ==== should start, at the very least, provoking thought and making folks
27862 . ==== pause before proceeding, instead of leaving all the fixes until two
27863 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27864 . ==== -pdp, 2012
27865 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27866 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27867 the above command might produce a date in the past.  Think carefully about
27868 the lifetime of the systems you're deploying, and either reduce the duration
27869 of the certificate or reconsider your platform deployment.  (At time of
27870 writing, reducing the duration is the most likely choice, but the inexorable
27871 progression of time takes us steadily towards an era where this will not
27872 be a sensible resolution).
27873
27874 A self-signed certificate made in this way is sufficient for testing, and
27875 may be adequate for all your requirements if you are mainly interested in
27876 encrypting transfers, and not in secure identification.
27877
27878 However, many clients require that the certificate presented by the server be a
27879 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27880 certificate. In this situation, the self-signed certificate described above
27881 must be installed on the client host as a trusted root &'certification
27882 authority'& (CA), and the certificate used by Exim must be a user certificate
27883 signed with that self-signed certificate.
27884
27885 For information on creating self-signed CA certificates and using them to sign
27886 user certificates, see the &'General implementation overview'& chapter of the
27887 Open-source PKI book, available online at
27888 &url(http://ospkibook.sourceforge.net/).
27889 .ecindex IIDencsmtp1
27890 .ecindex IIDencsmtp2
27891
27892
27893
27894 . ////////////////////////////////////////////////////////////////////////////
27895 . ////////////////////////////////////////////////////////////////////////////
27896
27897 .chapter "Access control lists" "CHAPACL"
27898 .scindex IIDacl "&ACL;" "description"
27899 .cindex "control of incoming mail"
27900 .cindex "message" "controlling incoming"
27901 .cindex "policy control" "access control lists"
27902 Access Control Lists (ACLs) are defined in a separate section of the run time
27903 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27904 name, terminated by a colon. Here is a complete ACL section that contains just
27905 one very small ACL:
27906 .code
27907 begin acl
27908 small_acl:
27909   accept   hosts = one.host.only
27910 .endd
27911 You can have as many lists as you like in the ACL section, and the order in
27912 which they appear does not matter. The lists are self-terminating.
27913
27914 The majority of ACLs are used to control Exim's behaviour when it receives
27915 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27916 when a local process submits a message using SMTP by specifying the &%-bs%&
27917 option. The most common use is for controlling which recipients are accepted
27918 in incoming messages. In addition, you can define an ACL that is used to check
27919 local non-SMTP messages. The default configuration file contains an example of
27920 a realistic ACL for checking RCPT commands. This is discussed in chapter
27921 &<<CHAPdefconfil>>&.
27922
27923
27924 .section "Testing ACLs" "SECID188"
27925 The &%-bh%& command line option provides a way of testing your ACL
27926 configuration locally by running a fake SMTP session with which you interact.
27927
27928
27929 .section "Specifying when ACLs are used" "SECID189"
27930 .cindex "&ACL;" "options for specifying"
27931 In order to cause an ACL to be used, you have to name it in one of the relevant
27932 options in the main part of the configuration. These options are:
27933 .cindex "AUTH" "ACL for"
27934 .cindex "DATA" "ACLs for"
27935 .cindex "ETRN" "ACL for"
27936 .cindex "EXPN" "ACL for"
27937 .cindex "HELO" "ACL for"
27938 .cindex "EHLO" "ACL for"
27939 .cindex "DKIM" "ACL for"
27940 .cindex "MAIL" "ACL for"
27941 .cindex "QUIT, ACL for"
27942 .cindex "RCPT" "ACL for"
27943 .cindex "STARTTLS, ACL for"
27944 .cindex "VRFY" "ACL for"
27945 .cindex "SMTP" "connection, ACL for"
27946 .cindex "non-SMTP messages" "ACLs for"
27947 .cindex "MIME content scanning" "ACL for"
27948 .cindex "PRDR" "ACL for"
27949
27950 .table2 140pt
27951 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27952 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27953 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27954 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27955 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27956 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27957 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27958 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27959 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27960 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27961 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27962 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27963 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27964 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27965 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27966 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27967 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27968 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27969 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27970 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27971 .endtable
27972
27973 For example, if you set
27974 .code
27975 acl_smtp_rcpt = small_acl
27976 .endd
27977 the little ACL defined above is used whenever Exim receives a RCPT command
27978 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27979 done when RCPT commands arrive. A rejection of RCPT should cause the
27980 sending MTA to give up on the recipient address contained in the RCPT
27981 command, whereas rejection at other times may cause the client MTA to keep on
27982 trying to deliver the message. It is therefore recommended that you do as much
27983 testing as possible at RCPT time.
27984
27985
27986 .section "The non-SMTP ACLs" "SECID190"
27987 .cindex "non-SMTP messages" "ACLs for"
27988 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27989 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27990 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27991 the state of the SMTP connection such as encryption and authentication) are not
27992 relevant and are forbidden in these ACLs. However, the sender and recipients
27993 are known, so the &%senders%& and &%sender_domains%& conditions and the
27994 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27995 &$authenticated_sender$& are also available. You can specify added header lines
27996 in any of these ACLs.
27997
27998 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27999 non-SMTP message, before any of the message has been read. (This is the
28000 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
28001 batched SMTP input, it runs after the DATA command has been reached. The
28002 result of this ACL is ignored; it cannot be used to reject a message. If you
28003 really need to, you could set a value in an ACL variable here and reject based
28004 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
28005 controls, and in particular, it can be used to set
28006 .code
28007 control = suppress_local_fixups
28008 .endd
28009 This cannot be used in the other non-SMTP ACLs because by the time they are
28010 run, it is too late.
28011
28012 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
28013 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28014
28015 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
28016 kind of rejection is treated as permanent, because there is no way of sending a
28017 temporary error for these kinds of message.
28018
28019
28020 .section "The SMTP connect ACL" "SECID191"
28021 .cindex "SMTP" "connection, ACL for"
28022 .oindex &%smtp_banner%&
28023 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
28024 session, after the test specified by &%host_reject_connection%& (which is now
28025 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
28026 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
28027 the message override the banner message that is otherwise specified by the
28028 &%smtp_banner%& option.
28029
28030
28031 .section "The EHLO/HELO ACL" "SECID192"
28032 .cindex "EHLO" "ACL for"
28033 .cindex "HELO" "ACL for"
28034 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28035 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28036 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28037 Note that a client may issue more than one EHLO or HELO command in an SMTP
28038 session, and indeed is required to issue a new EHLO or HELO after successfully
28039 setting up encryption following a STARTTLS command.
28040
28041 Note also that a deny neither forces the client to go away nor means that
28042 mail will be refused on the connection.  Consider checking for
28043 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28044
28045 If the command is accepted by an &%accept%& verb that has a &%message%&
28046 modifier, the message may not contain more than one line (it will be truncated
28047 at the first newline and a panic logged if it does). Such a message cannot
28048 affect the EHLO options that are listed on the second and subsequent lines of
28049 an EHLO response.
28050
28051
28052 .section "The DATA ACLs" "SECID193"
28053 .cindex "DATA" "ACLs for"
28054 Two ACLs are associated with the DATA command, because it is two-stage
28055 command, with two responses being sent to the client.
28056 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28057 is obeyed. This gives you control after all the RCPT commands, but before
28058 the message itself is received. It offers the opportunity to give a negative
28059 response to the DATA command before the data is transmitted. Header lines
28060 added by MAIL or RCPT ACLs are not visible at this time, but any that
28061 are defined here are visible when the &%acl_smtp_data%& ACL is run.
28062
28063 You cannot test the contents of the message, for example, to verify addresses
28064 in the headers, at RCPT time or when the DATA command is received. Such
28065 tests have to appear in the ACL that is run after the message itself has been
28066 received, before the final response to the DATA command is sent. This is
28067 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
28068 associated with the DATA command.
28069
28070 .cindex CHUNKING "BDAT command"
28071 .cindex BDAT "SMTP command"
28072 .cindex "RFC 3030" CHUNKING
28073 If CHUNKING was advertised and a BDAT command sequence is received,
28074 the &%acl_smtp_predata%& ACL is not run.
28075 . XXX why not?  It should be possible, for the first BDAT.
28076 The &%acl_smtp_data%& is run after the last BDAT command and all of
28077 the data specified is received.
28078
28079 For both of these ACLs, it is not possible to reject individual recipients. An
28080 error response rejects the entire message. Unfortunately, it is known that some
28081 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
28082 before or after the data) correctly &-- they keep the message on their queues
28083 and try again later, but that is their problem, though it does waste some of
28084 your resources.
28085
28086 The &%acl_smtp_data%& ACL is run after
28087 the &%acl_smtp_data_prdr%&,
28088 the &%acl_smtp_dkim%&
28089 and the &%acl_smtp_mime%& ACLs.
28090
28091 .section "The SMTP DKIM ACL" "SECTDKIMACL"
28092 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
28093 enabled (which is the default).
28094
28095 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
28096 received, and is executed for each DKIM signature found in a message.  If not
28097 otherwise specified, the default action is to accept.
28098
28099 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
28100
28101 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
28102
28103
28104 .section "The SMTP MIME ACL" "SECID194"
28105 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
28106 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28107
28108 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28109
28110
28111 .section "The SMTP PRDR ACL" "SECTPRDRACL"
28112 .cindex "PRDR" "ACL for"
28113 .oindex "&%prdr_enable%&"
28114 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
28115 with PRDR support enabled (which is the default).
28116 It becomes active only when the PRDR feature is negotiated between
28117 client and server for a message, and more than one recipient
28118 has been accepted.
28119
28120 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28121 has been received, and is executed once for each recipient of the message
28122 with &$local_part$& and &$domain$& valid.
28123 The test may accept, defer or deny for individual recipients.
28124 The &%acl_smtp_data%& will still be called after this ACL and
28125 can reject the message overall, even if this ACL has accepted it
28126 for some or all recipients.
28127
28128 PRDR may be used to support per-user content filtering.  Without it
28129 one must defer any recipient after the first that has a different
28130 content-filter configuration.  With PRDR, the RCPT-time check
28131 .cindex "PRDR" "variable for"
28132 for this can be disabled when the variable &$prdr_requested$&
28133 is &"yes"&.
28134 Any required difference in behaviour of the main DATA-time
28135 ACL should however depend on the PRDR-time ACL having run, as Exim
28136 will avoid doing so in some situations (e.g.  single-recipient mails).
28137
28138 See also the &%prdr_enable%& global option
28139 and the &%hosts_try_prdr%& smtp transport option.
28140
28141 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28142 If the ACL is not defined, processing completes as if
28143 the feature was not requested by the client.
28144
28145 .section "The QUIT ACL" "SECTQUITACL"
28146 .cindex "QUIT, ACL for"
28147 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28148 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28149 does not in fact control any access.
28150 For this reason, it may only accept
28151 or warn as its final result.
28152
28153 This ACL can be used for tasks such as custom logging at the end of an SMTP
28154 session. For example, you can use ACL variables in other ACLs to count
28155 messages, recipients, etc., and log the totals at QUIT time using one or
28156 more &%logwrite%& modifiers on a &%warn%& verb.
28157
28158 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28159 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28160
28161 You do not need to have a final &%accept%&, but if you do, you can use a
28162 &%message%& modifier to specify custom text that is sent as part of the 221
28163 response to QUIT.
28164
28165 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28166 failure (for example, failure to open a log file, or when Exim is bombing out
28167 because it has detected an unrecoverable error), all SMTP commands from the
28168 client are given temporary error responses until QUIT is received or the
28169 connection is closed. In these special cases, the QUIT ACL does not run.
28170
28171
28172 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28173 .vindex &$acl_smtp_notquit$&
28174 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28175 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28176 trouble, such as being unable to write to its log files, this ACL is not run,
28177 because it might try to do things (such as write to log files) that make the
28178 situation even worse.
28179
28180 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28181 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28182 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28183 and &%warn%&.
28184
28185 .vindex &$smtp_notquit_reason$&
28186 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28187 to a string that indicates the reason for the termination of the SMTP
28188 connection. The possible values are:
28189 .table2
28190 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28191 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28192 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28193 .irow &`connection-lost`&          "The SMTP connection has been lost"
28194 .irow &`data-timeout`&             "Timeout while reading message data"
28195 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28196 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28197 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28198 .irow &`synchronization-error`&    "SMTP synchronization error"
28199 .irow &`tls-failed`&               "TLS failed to start"
28200 .endtable
28201 In most cases when an SMTP connection is closed without having received QUIT,
28202 Exim sends an SMTP response message before actually closing the connection.
28203 With the exception of the &`acl-drop`& case, the default message can be
28204 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28205 &%drop%& verb in another ACL, it is the message from the other ACL that is
28206 used.
28207
28208
28209 .section "Finding an ACL to use" "SECID195"
28210 .cindex "&ACL;" "finding which to use"
28211 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28212 you can use different ACLs in different circumstances. For example,
28213 .code
28214 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28215                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28216 .endd
28217 In the default configuration file there are some example settings for
28218 providing an RFC 4409 message submission service on port 587 and a
28219 non-standard &"smtps"& service on port 465. You can use a string
28220 expansion like this to choose an ACL for MUAs on these ports which is
28221 more appropriate for this purpose than the default ACL on port 25.
28222
28223 The expanded string does not have to be the name of an ACL in the
28224 configuration file; there are other possibilities. Having expanded the
28225 string, Exim searches for an ACL as follows:
28226
28227 .ilist
28228 If the string begins with a slash, Exim uses it as a file name, and reads its
28229 contents as an ACL. The lines are processed in the same way as lines in the
28230 Exim configuration file. In particular, continuation lines are supported, blank
28231 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28232 If the file does not exist or cannot be read, an error occurs (typically
28233 causing a temporary failure of whatever caused the ACL to be run). For example:
28234 .code
28235 acl_smtp_data = /etc/acls/\
28236   ${lookup{$sender_host_address}lsearch\
28237   {/etc/acllist}{$value}{default}}
28238 .endd
28239 This looks up an ACL file to use on the basis of the host's IP address, falling
28240 back to a default if the lookup fails. If an ACL is successfully read from a
28241 file, it is retained in memory for the duration of the Exim process, so that it
28242 can be re-used without having to re-read the file.
28243 .next
28244 If the string does not start with a slash, and does not contain any spaces,
28245 Exim searches the ACL section of the configuration for an ACL whose name
28246 matches the string.
28247 .next
28248 If no named ACL is found, or if the string contains spaces, Exim parses
28249 the string as an inline ACL. This can save typing in cases where you just
28250 want to have something like
28251 .code
28252 acl_smtp_vrfy = accept
28253 .endd
28254 in order to allow free use of the VRFY command. Such a string may contain
28255 newlines; it is processed in the same way as an ACL that is read from a file.
28256 .endlist
28257
28258
28259
28260
28261 .section "ACL return codes" "SECID196"
28262 .cindex "&ACL;" "return codes"
28263 Except for the QUIT ACL, which does not affect the SMTP return code (see
28264 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28265 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28266 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28267 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28268 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28269 This also causes a 4&'xx'& return code.
28270
28271 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28272 &"deny"&, because there is no mechanism for passing temporary errors to the
28273 submitters of non-SMTP messages.
28274
28275
28276 ACLs that are relevant to message reception may also return &"discard"&. This
28277 has the effect of &"accept"&, but causes either the entire message or an
28278 individual recipient address to be discarded. In other words, it is a
28279 blackholing facility. Use it with care.
28280
28281 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28282 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28283 RCPT ACL is to discard just the one recipient address. If there are no
28284 recipients left when the message's data is received, the DATA ACL is not
28285 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28286 remaining recipients. The &"discard"& return is not permitted for the
28287 &%acl_smtp_predata%& ACL.
28288
28289 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28290 is done on the address and the result determines the SMTP response.
28291
28292
28293 .cindex "&[local_scan()]& function" "when all recipients discarded"
28294 The &[local_scan()]& function is always run, even if there are no remaining
28295 recipients; it may create new recipients.
28296
28297
28298
28299 .section "Unset ACL options" "SECID197"
28300 .cindex "&ACL;" "unset options"
28301 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28302 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28303 not defined at all. For any defined ACL, the default action when control
28304 reaches the end of the ACL statements is &"deny"&.
28305
28306 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28307 these two are ACLs that are used only for their side effects. They cannot be
28308 used to accept or reject anything.
28309
28310 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28311 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28312 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28313 when the ACL is not defined is &"accept"&.
28314
28315 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28316 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28317 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28318 messages over an SMTP connection. For an example, see the ACL in the default
28319 configuration file.
28320
28321
28322
28323
28324 .section "Data for message ACLs" "SECID198"
28325 .cindex "&ACL;" "data for message ACL"
28326 .vindex &$domain$&
28327 .vindex &$local_part$&
28328 .vindex &$sender_address$&
28329 .vindex &$sender_host_address$&
28330 .vindex &$smtp_command$&
28331 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28332 that contain information about the host and the message's sender (for example,
28333 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28334 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28335 &$local_part$& are set from the argument address. The entire SMTP command
28336 is available in &$smtp_command$&.
28337
28338 When an ACL for the AUTH parameter of MAIL is running, the variables that
28339 contain information about the host are set, but &$sender_address$& is not yet
28340 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28341 how it is used.
28342
28343 .vindex "&$message_size$&"
28344 The &$message_size$& variable is set to the value of the SIZE parameter on
28345 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28346 that parameter is not given. The value is updated to the true message size by
28347 the time the final DATA ACL is run (after the message data has been
28348 received).
28349
28350 .vindex "&$rcpt_count$&"
28351 .vindex "&$recipients_count$&"
28352 The &$rcpt_count$& variable increases by one for each RCPT command received.
28353 The &$recipients_count$& variable increases by one each time a RCPT command is
28354 accepted, so while an ACL for RCPT is being processed, it contains the number
28355 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28356 &$rcpt_count$& contains the total number of RCPT commands, and
28357 &$recipients_count$& contains the total number of accepted recipients.
28358
28359
28360
28361
28362
28363 .section "Data for non-message ACLs" "SECTdatfornon"
28364 .cindex "&ACL;" "data for non-message ACL"
28365 .vindex &$smtp_command_argument$&
28366 .vindex &$smtp_command$&
28367 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28368 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28369 and the entire SMTP command is available in &$smtp_command$&.
28370 These variables can be tested using a &%condition%& condition. For example,
28371 here is an ACL for use with AUTH, which insists that either the session is
28372 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28373 does not permit authentication methods that use cleartext passwords on
28374 unencrypted connections.
28375 .code
28376 acl_check_auth:
28377   accept encrypted = *
28378   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28379                      {CRAM-MD5}}
28380   deny   message   = TLS encryption or CRAM-MD5 required
28381 .endd
28382 (Another way of applying this restriction is to arrange for the authenticators
28383 that use cleartext passwords not to be advertised when the connection is not
28384 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28385 option to do this.)
28386
28387
28388
28389 .section "Format of an ACL" "SECID199"
28390 .cindex "&ACL;" "format of"
28391 .cindex "&ACL;" "verbs, definition of"
28392 An individual ACL consists of a number of statements. Each statement starts
28393 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28394 Modifiers can change the way the verb operates, define error and log messages,
28395 set variables, insert delays, and vary the processing of accepted messages.
28396
28397 If all the conditions are met, the verb is obeyed. The same condition may be
28398 used (with different arguments) more than once in the same statement. This
28399 provides a means of specifying an &"and"& conjunction between conditions. For
28400 example:
28401 .code
28402 deny  dnslists = list1.example
28403       dnslists = list2.example
28404 .endd
28405 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28406 the conditions and modifiers when it reaches a condition that fails. What
28407 happens then depends on the verb (and in one case, on a special modifier). Not
28408 all the conditions make sense at every testing point. For example, you cannot
28409 test a sender address in the ACL that is run for a VRFY command.
28410
28411
28412 .section "ACL verbs" "SECID200"
28413 The ACL verbs are as follows:
28414
28415 .ilist
28416 .cindex "&%accept%& ACL verb"
28417 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28418 of the conditions are not met, what happens depends on whether &%endpass%&
28419 appears among the conditions (for syntax see below). If the failing condition
28420 is before &%endpass%&, control is passed to the next ACL statement; if it is
28421 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28422 check a RCPT command:
28423 .code
28424 accept domains = +local_domains
28425        endpass
28426        verify = recipient
28427 .endd
28428 If the recipient domain does not match the &%domains%& condition, control
28429 passes to the next statement. If it does match, the recipient is verified, and
28430 the command is accepted if verification succeeds. However, if verification
28431 fails, the ACL yields &"deny"&, because the failing condition is after
28432 &%endpass%&.
28433
28434 The &%endpass%& feature has turned out to be confusing to many people, so its
28435 use is not recommended nowadays. It is always possible to rewrite an ACL so
28436 that &%endpass%& is not needed, and it is no longer used in the default
28437 configuration.
28438
28439 .cindex "&%message%& ACL modifier" "with &%accept%&"
28440 If a &%message%& modifier appears on an &%accept%& statement, its action
28441 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28442 (when an &%accept%& verb either accepts or passes control to the next
28443 statement), &%message%& can be used to vary the message that is sent when an
28444 SMTP command is accepted. For example, in a RCPT ACL you could have:
28445 .display
28446 &`accept  `&<&'some conditions'&>
28447 &`        message = OK, I will allow you through today`&
28448 .endd
28449 You can specify an SMTP response code, optionally followed by an &"extended
28450 response code"& at the start of the message, but the first digit must be the
28451 same as would be sent by default, which is 2 for an &%accept%& verb.
28452
28453 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28454 an error message that is used when access is denied. This behaviour is retained
28455 for backward compatibility, but current &"best practice"& is to avoid the use
28456 of &%endpass%&.
28457
28458
28459 .next
28460 .cindex "&%defer%& ACL verb"
28461 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28462 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28463 &%defer%& is the same as &%deny%&, because there is no way of sending a
28464 temporary error. For a RCPT command, &%defer%& is much the same as using a
28465 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28466 be used in any ACL, and even for a recipient it might be a simpler approach.
28467
28468
28469 .next
28470 .cindex "&%deny%& ACL verb"
28471 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28472 the conditions are not met, control is passed to the next ACL statement. For
28473 example,
28474 .code
28475 deny dnslists = blackholes.mail-abuse.org
28476 .endd
28477 rejects commands from hosts that are on a DNS black list.
28478
28479
28480 .next
28481 .cindex "&%discard%& ACL verb"
28482 &%discard%&: This verb behaves like &%accept%&, except that it returns
28483 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28484 that are concerned with receiving messages. When all the conditions are true,
28485 the sending entity receives a &"success"& response. However, &%discard%& causes
28486 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28487 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28488 message's recipients are discarded. Recipients that are discarded before DATA
28489 do not appear in the log line when the &%received_recipients%& log selector is set.
28490
28491 If the &%log_message%& modifier is set when &%discard%& operates,
28492 its contents are added to the line that is automatically written to the log.
28493 The &%message%& modifier operates exactly as it does for &%accept%&.
28494
28495
28496 .next
28497 .cindex "&%drop%& ACL verb"
28498 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28499 forcibly closed after the 5&'xx'& error message has been sent. For example:
28500 .code
28501 drop   message   = I don't take more than 20 RCPTs
28502        condition = ${if > {$rcpt_count}{20}}
28503 .endd
28504 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28505 The connection is always dropped after sending a 550 response.
28506
28507 .next
28508 .cindex "&%require%& ACL verb"
28509 &%require%&: If all the conditions are met, control is passed to the next ACL
28510 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28511 example, when checking a RCPT command,
28512 .code
28513 require message = Sender did not verify
28514         verify  = sender
28515 .endd
28516 passes control to subsequent statements only if the message's sender can be
28517 verified. Otherwise, it rejects the command. Note the positioning of the
28518 &%message%& modifier, before the &%verify%& condition. The reason for this is
28519 discussed in section &<<SECTcondmodproc>>&.
28520
28521 .next
28522 .cindex "&%warn%& ACL verb"
28523 &%warn%&: If all the conditions are true, a line specified by the
28524 &%log_message%& modifier is written to Exim's main log. Control always passes
28525 to the next ACL statement. If any condition is false, the log line is not
28526 written. If an identical log line is requested several times in the same
28527 message, only one copy is actually written to the log. If you want to force
28528 duplicates to be written, use the &%logwrite%& modifier instead.
28529
28530 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28531 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28532 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28533 first failing condition. There is more about adding header lines in section
28534 &<<SECTaddheadacl>>&.
28535
28536 If any condition on a &%warn%& statement cannot be completed (that is, there is
28537 some sort of defer), the log line specified by &%log_message%& is not written.
28538 This does not include the case of a forced failure from a lookup, which
28539 is considered to be a successful completion. After a defer, no further
28540 conditions or modifiers in the &%warn%& statement are processed. The incident
28541 is logged, and the ACL continues to be processed, from the next statement
28542 onwards.
28543
28544
28545 .vindex "&$acl_verify_message$&"
28546 When one of the &%warn%& conditions is an address verification that fails, the
28547 text of the verification failure message is in &$acl_verify_message$&. If you
28548 want this logged, you must set it up explicitly. For example:
28549 .code
28550 warn   !verify = sender
28551        log_message = sender verify failed: $acl_verify_message
28552 .endd
28553 .endlist
28554
28555 At the end of each ACL there is an implicit unconditional &%deny%&.
28556
28557 As you can see from the examples above, the conditions and modifiers are
28558 written one to a line, with the first one on the same line as the verb, and
28559 subsequent ones on following lines. If you have a very long condition, you can
28560 continue it onto several physical lines by the usual backslash continuation
28561 mechanism. It is conventional to align the conditions vertically.
28562
28563
28564
28565 .section "ACL variables" "SECTaclvariables"
28566 .cindex "&ACL;" "variables"
28567 There are some special variables that can be set during ACL processing. They
28568 can be used to pass information between different ACLs, different invocations
28569 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28570 transports, and filters that are used to deliver a message. The names of these
28571 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28572 an underscore, but the remainder of the name can be any sequence of
28573 alphanumeric characters and underscores that you choose. There is no limit on
28574 the number of ACL variables. The two sets act as follows:
28575 .ilist
28576 The values of those variables whose names begin with &$acl_c$& persist
28577 throughout an SMTP connection. They are never reset. Thus, a value that is set
28578 while receiving one message is still available when receiving the next message
28579 on the same SMTP connection.
28580 .next
28581 The values of those variables whose names begin with &$acl_m$& persist only
28582 while a message is being received. They are reset afterwards. They are also
28583 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28584 .endlist
28585
28586 When a message is accepted, the current values of all the ACL variables are
28587 preserved with the message and are subsequently made available at delivery
28588 time. The ACL variables are set by a modifier called &%set%&. For example:
28589 .code
28590 accept hosts = whatever
28591        set acl_m4 = some value
28592 accept authenticated = *
28593        set acl_c_auth = yes
28594 .endd
28595 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28596 be set. If you want to set a variable without taking any action, you can use a
28597 &%warn%& verb without any other modifiers or conditions.
28598
28599 .oindex &%strict_acl_vars%&
28600 What happens if a syntactically valid but undefined ACL variable is
28601 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28602 false (the default), an empty string is substituted; if it is true, an
28603 error is generated.
28604
28605 Versions of Exim before 4.64 have a limited set of numbered variables, but
28606 their names are compatible, so there is no problem with upgrading.
28607
28608
28609 .section "Condition and modifier processing" "SECTcondmodproc"
28610 .cindex "&ACL;" "conditions; processing"
28611 .cindex "&ACL;" "modifiers; processing"
28612 An exclamation mark preceding a condition negates its result. For example:
28613 .code
28614 deny   domains = *.dom.example
28615       !verify  = recipient
28616 .endd
28617 causes the ACL to return &"deny"& if the recipient domain ends in
28618 &'dom.example'& and the recipient address cannot be verified. Sometimes
28619 negation can be used on the right-hand side of a condition. For example, these
28620 two statements are equivalent:
28621 .code
28622 deny  hosts = !192.168.3.4
28623 deny !hosts =  192.168.3.4
28624 .endd
28625 However, for many conditions (&%verify%& being a good example), only left-hand
28626 side negation of the whole condition is possible.
28627
28628 The arguments of conditions and modifiers are expanded. A forced failure
28629 of an expansion causes a condition to be ignored, that is, it behaves as if the
28630 condition is true. Consider these two statements:
28631 .code
28632 accept  senders = ${lookup{$host_name}lsearch\
28633                   {/some/file}{$value}fail}
28634 accept  senders = ${lookup{$host_name}lsearch\
28635                   {/some/file}{$value}{}}
28636 .endd
28637 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28638 the returned list is searched, but if the lookup fails the behaviour is
28639 different in the two cases. The &%fail%& in the first statement causes the
28640 condition to be ignored, leaving no further conditions. The &%accept%& verb
28641 therefore succeeds. The second statement, however, generates an empty list when
28642 the lookup fails. No sender can match an empty list, so the condition fails,
28643 and therefore the &%accept%& also fails.
28644
28645 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28646 specify actions that are taken as the conditions for a statement are checked;
28647 others specify text for messages that are used when access is denied or a
28648 warning is generated. The &%control%& modifier affects the way an incoming
28649 message is handled.
28650
28651 The positioning of the modifiers in an ACL statement is important, because the
28652 processing of a verb ceases as soon as its outcome is known. Only those
28653 modifiers that have already been encountered will take effect. For example,
28654 consider this use of the &%message%& modifier:
28655 .code
28656 require message = Can't verify sender
28657         verify  = sender
28658         message = Can't verify recipient
28659         verify  = recipient
28660         message = This message cannot be used
28661 .endd
28662 If sender verification fails, Exim knows that the result of the statement is
28663 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28664 so its text is used as the error message. If sender verification succeeds, but
28665 recipient verification fails, the second message is used. If recipient
28666 verification succeeds, the third message becomes &"current"&, but is never used
28667 because there are no more conditions to cause failure.
28668
28669 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28670 modifier that is used, because all the conditions must be true for rejection to
28671 happen. Specifying more than one &%message%& modifier does not make sense, and
28672 the message can even be specified after all the conditions. For example:
28673 .code
28674 deny   hosts = ...
28675       !senders = *@my.domain.example
28676        message = Invalid sender from client host
28677 .endd
28678 The &"deny"& result does not happen until the end of the statement is reached,
28679 by which time Exim has set up the message.
28680
28681
28682
28683 .section "ACL modifiers" "SECTACLmodi"
28684 .cindex "&ACL;" "modifiers; list of"
28685 The ACL modifiers are as follows:
28686
28687 .vlist
28688 .vitem &*add_header*&&~=&~<&'text'&>
28689 This modifier specifies one or more header lines that are to be added to an
28690 incoming message, assuming, of course, that the message is ultimately
28691 accepted. For details, see section &<<SECTaddheadacl>>&.
28692
28693 .vitem &*continue*&&~=&~<&'text'&>
28694 .cindex "&%continue%& ACL modifier"
28695 .cindex "database" "updating in ACL"
28696 This modifier does nothing of itself, and processing of the ACL always
28697 continues with the next condition or modifier. The value of &%continue%& is in
28698 the side effects of expanding its argument. Typically this could be used to
28699 update a database. It is really just a syntactic tidiness, to avoid having to
28700 write rather ugly lines like this:
28701 .display
28702 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28703 .endd
28704 Instead, all you need is
28705 .display
28706 &`continue = `&<&'some expansion'&>
28707 .endd
28708
28709 .vitem &*control*&&~=&~<&'text'&>
28710 .cindex "&%control%& ACL modifier"
28711 This modifier affects the subsequent processing of the SMTP connection or of an
28712 incoming message that is accepted. The effect of the first type of control
28713 lasts for the duration of the connection, whereas the effect of the second type
28714 lasts only until the current message has been received. The message-specific
28715 controls always apply to the whole message, not to individual recipients,
28716 even if the &%control%& modifier appears in a RCPT ACL.
28717
28718 As there are now quite a few controls that can be applied, they are described
28719 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28720 in several different ways. For example:
28721
28722 . ==== As this is a nested list, any displays it contains must be indented
28723 . ==== as otherwise they are too far to the left. That comment applies only
28724 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28725 . ==== way.
28726
28727 .ilist
28728 It can be at the end of an &%accept%& statement:
28729 .code
28730     accept  ...some conditions
28731             control = queue_only
28732 .endd
28733 In this case, the control is applied when this statement yields &"accept"&, in
28734 other words, when the conditions are all true.
28735
28736 .next
28737 It can be in the middle of an &%accept%& statement:
28738 .code
28739     accept  ...some conditions...
28740             control = queue_only
28741             ...some more conditions...
28742 .endd
28743 If the first set of conditions are true, the control is applied, even if the
28744 statement does not accept because one of the second set of conditions is false.
28745 In this case, some subsequent statement must yield &"accept"& for the control
28746 to be relevant.
28747
28748 .next
28749 It can be used with &%warn%& to apply the control, leaving the
28750 decision about accepting or denying to a subsequent verb. For
28751 example:
28752 .code
28753     warn    ...some conditions...
28754             control = freeze
28755     accept  ...
28756 .endd
28757 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28758 &%logwrite%&, so it does not add anything to the message and does not write a
28759 log entry.
28760
28761 .next
28762 If you want to apply a control unconditionally, you can use it with a
28763 &%require%& verb. For example:
28764 .code
28765     require  control = no_multiline_responses
28766 .endd
28767 .endlist
28768
28769 .vitem &*delay*&&~=&~<&'time'&>
28770 .cindex "&%delay%& ACL modifier"
28771 .oindex "&%-bh%&"
28772 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28773 the time interval before proceeding. However, when testing Exim using the
28774 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28775 output instead). The time is given in the usual Exim notation, and the delay
28776 happens as soon as the modifier is processed. In an SMTP session, pending
28777 output is flushed before the delay is imposed.
28778
28779 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28780 example:
28781 .code
28782 deny    ...some conditions...
28783         delay = 30s
28784 .endd
28785 The delay happens if all the conditions are true, before the statement returns
28786 &"deny"&. Compare this with:
28787 .code
28788 deny    delay = 30s
28789         ...some conditions...
28790 .endd
28791 which waits for 30s before processing the conditions. The &%delay%& modifier
28792 can also be used with &%warn%& and together with &%control%&:
28793 .code
28794 warn    ...some conditions...
28795         delay = 2m
28796         control = freeze
28797 accept  ...
28798 .endd
28799
28800 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28801 responses to several commands are no longer buffered and sent in one packet (as
28802 they would normally be) because all output is flushed before imposing the
28803 delay. This optimization is disabled so that a number of small delays do not
28804 appear to the client as one large aggregated delay that might provoke an
28805 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28806 using a &%control%& modifier to set &%no_delay_flush%&.
28807
28808
28809 .vitem &*endpass*&
28810 .cindex "&%endpass%& ACL modifier"
28811 This modifier, which has no argument, is recognized only in &%accept%& and
28812 &%discard%& statements. It marks the boundary between the conditions whose
28813 failure causes control to pass to the next statement, and the conditions whose
28814 failure causes the ACL to return &"deny"&. This concept has proved to be
28815 confusing to some people, so the use of &%endpass%& is no longer recommended as
28816 &"best practice"&. See the description of &%accept%& above for more details.
28817
28818
28819 .vitem &*log_message*&&~=&~<&'text'&>
28820 .cindex "&%log_message%& ACL modifier"
28821 This modifier sets up a message that is used as part of the log message if the
28822 ACL denies access or a &%warn%& statement's conditions are true. For example:
28823 .code
28824 require log_message = wrong cipher suite $tls_in_cipher
28825         encrypted   = DES-CBC3-SHA
28826 .endd
28827 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28828 example:
28829 .display
28830 &`discard `&<&'some conditions'&>
28831 &`        log_message = Discarded $local_part@$domain because...`&
28832 .endd
28833 When access is denied, &%log_message%& adds to any underlying error message
28834 that may exist because of a condition failure. For example, while verifying a
28835 recipient address, a &':fail:'& redirection might have already set up a
28836 message.
28837
28838 The message may be defined before the conditions to which it applies, because
28839 the string expansion does not happen until Exim decides that access is to be
28840 denied. This means that any variables that are set by the condition are
28841 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28842 variables are set after a DNS black list lookup succeeds. If the expansion of
28843 &%log_message%& fails, or if the result is an empty string, the modifier is
28844 ignored.
28845
28846 .vindex "&$acl_verify_message$&"
28847 If you want to use a &%warn%& statement to log the result of an address
28848 verification, you can use &$acl_verify_message$& to include the verification
28849 error message.
28850
28851 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28852 the start of the logged message. If the same warning log message is requested
28853 more than once while receiving  a single email message, only one copy is
28854 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28855 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28856 is logged for a successful &%warn%& statement.
28857
28858 If &%log_message%& is not present and there is no underlying error message (for
28859 example, from the failure of address verification), but &%message%& is present,
28860 the &%message%& text is used for logging rejections. However, if any text for
28861 logging contains newlines, only the first line is logged. In the absence of
28862 both &%log_message%& and &%message%&, a default built-in message is used for
28863 logging rejections.
28864
28865
28866 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28867 .cindex "&%log_reject_target%& ACL modifier"
28868 .cindex "logging in ACL" "specifying which log"
28869 This modifier makes it possible to specify which logs are used for messages
28870 about ACL rejections. Its argument is a colon-separated list of words that can
28871 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28872 may be empty, in which case a rejection is not logged at all. For example, this
28873 ACL fragment writes no logging information when access is denied:
28874 .display
28875 &`deny `&<&'some conditions'&>
28876 &`     log_reject_target =`&
28877 .endd
28878 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28879 permanent and temporary rejections. Its effect lasts for the rest of the
28880 current ACL.
28881
28882
28883 .vitem &*logwrite*&&~=&~<&'text'&>
28884 .cindex "&%logwrite%& ACL modifier"
28885 .cindex "logging in ACL" "immediate"
28886 This modifier writes a message to a log file as soon as it is encountered when
28887 processing an ACL. (Compare &%log_message%&, which, except in the case of
28888 &%warn%& and &%discard%&, is used only if the ACL statement denies
28889 access.) The &%logwrite%& modifier can be used to log special incidents in
28890 ACLs. For example:
28891 .display
28892 &`accept `&<&'some special conditions'&>
28893 &`       control  = freeze`&
28894 &`       logwrite = froze message because ...`&
28895 .endd
28896 By default, the message is written to the main log. However, it may begin
28897 with a colon, followed by a comma-separated list of log names, and then
28898 another colon, to specify exactly which logs are to be written. For
28899 example:
28900 .code
28901 logwrite = :main,reject: text for main and reject logs
28902 logwrite = :panic: text for panic log only
28903 .endd
28904
28905
28906 .vitem &*message*&&~=&~<&'text'&>
28907 .cindex "&%message%& ACL modifier"
28908 This modifier sets up a text string that is expanded and used as a response
28909 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28910 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28911 there is some complication if &%endpass%& is involved; see the description of
28912 &%accept%& for details.)
28913
28914 The expansion of the message happens at the time Exim decides that the ACL is
28915 to end, not at the time it processes &%message%&. If the expansion fails, or
28916 generates an empty string, the modifier is ignored. Here is an example where
28917 &%message%& must be specified first, because the ACL ends with a rejection if
28918 the &%hosts%& condition fails:
28919 .code
28920 require  message = Host not recognized
28921          hosts = 10.0.0.0/8
28922 .endd
28923 (Once a condition has failed, no further conditions or modifiers are
28924 processed.)
28925
28926 .cindex "SMTP" "error codes"
28927 .oindex "&%smtp_banner%&
28928 For ACLs that are triggered by SMTP commands, the message is returned as part
28929 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28930 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28931 is accepted. In the case of the connect ACL, accepting with a message modifier
28932 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28933 accept message may not contain more than one line (otherwise it will be
28934 truncated at the first newline and a panic logged), and it cannot affect the
28935 EHLO options.
28936
28937 When SMTP is involved, the message may begin with an overriding response code,
28938 consisting of three digits optionally followed by an &"extended response code"&
28939 of the form &'n.n.n'&, each code being followed by a space. For example:
28940 .code
28941 deny  message = 599 1.2.3 Host not welcome
28942       hosts = 192.168.34.0/24
28943 .endd
28944 The first digit of the supplied response code must be the same as would be sent
28945 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28946 access, but for the predata ACL, note that the default success code is 354, not
28947 2&'xx'&.
28948
28949 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28950 the message modifier cannot override the 221 response code.
28951
28952 The text in a &%message%& modifier is literal; any quotes are taken as
28953 literals, but because the string is expanded, backslash escapes are processed
28954 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28955 response.
28956
28957 .vindex "&$acl_verify_message$&"
28958 For ACLs that are called by an &%acl =%& ACL condition, the message is
28959 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28960
28961 If &%message%& is used on a statement that verifies an address, the message
28962 specified overrides any message that is generated by the verification process.
28963 However, the original message is available in the variable
28964 &$acl_verify_message$&, so you can incorporate it into your message if you
28965 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28966 routers to be passed back as part of the SMTP response, you should either not
28967 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28968
28969 For compatibility with previous releases of Exim, a &%message%& modifier that
28970 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28971 modifier, but this usage is now deprecated. However, &%message%& acts only when
28972 all the conditions are true, wherever it appears in an ACL command, whereas
28973 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28974 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28975 effect.
28976
28977
28978 .vitem &*queue*&&~=&~<&'text'&>
28979 This modifier specifies the use of a named queue for spool files
28980 for the message.
28981 It can only be used before the message is received (i.e. not in
28982 the DATA ACL).
28983 This could be used, for example, for known high-volume burst sources
28984 of traffic, or for quarantine of messages.
28985 Separate queue-runner processes will be needed for named queues.
28986 If the text after expansion is empty, the default queue is used.
28987
28988
28989 .vitem &*remove_header*&&~=&~<&'text'&>
28990 This modifier specifies one or more header names in a colon-separated list
28991  that are to be removed from an incoming message, assuming, of course, that
28992 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28993
28994
28995 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28996 .cindex "&%set%& ACL modifier"
28997 This modifier puts a value into one of the ACL variables (see section
28998 &<<SECTaclvariables>>&).
28999
29000
29001 .vitem &*udpsend*&&~=&~<&'parameters'&>
29002 This modifier sends a UDP packet, for purposes such as statistics
29003 collection or behaviour monitoring. The parameters are expanded, and
29004 the result of the expansion must be a colon-separated list consisting
29005 of a destination server, port number, and the packet contents. The
29006 server can be specified as a host name or IPv4 or IPv6 address. The
29007 separator can be changed with the usual angle bracket syntax. For
29008 example, you might want to collect information on which hosts connect
29009 when:
29010 .code
29011 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
29012              $tod_zulu $sender_host_address
29013 .endd
29014 .endlist
29015
29016
29017
29018
29019 .section "Use of the control modifier" "SECTcontrols"
29020 .cindex "&%control%& ACL modifier"
29021 The &%control%& modifier supports the following settings:
29022
29023 .vlist
29024 .vitem &*control&~=&~allow_auth_unadvertised*&
29025 This modifier allows a client host to use the SMTP AUTH command even when it
29026 has not been advertised in response to EHLO. Furthermore, because there are
29027 apparently some really broken clients that do this, Exim will accept AUTH after
29028 HELO (rather than EHLO) when this control is set. It should be used only if you
29029 really need it, and you should limit its use to those broken clients that do
29030 not work without it. For example:
29031 .code
29032 warn hosts   = 192.168.34.25
29033      control = allow_auth_unadvertised
29034 .endd
29035 Normally, when an Exim server receives an AUTH command, it checks the name of
29036 the authentication mechanism that is given in the command to ensure that it
29037 matches an advertised mechanism. When this control is set, the check that a
29038 mechanism has been advertised is bypassed. Any configured mechanism can be used
29039 by the client. This control is permitted only in the connection and HELO ACLs.
29040
29041
29042 .vitem &*control&~=&~caseful_local_part*& &&&
29043        &*control&~=&~caselower_local_part*&
29044 .cindex "&ACL;" "case of local part in"
29045 .cindex "case of local parts"
29046 .vindex "&$local_part$&"
29047 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29048 (that is, during RCPT processing). By default, the contents of &$local_part$&
29049 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29050 any uppercase letters in the original local part are restored in &$local_part$&
29051 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29052 is encountered.
29053
29054 These controls affect only the current recipient. Moreover, they apply only to
29055 local part handling that takes place directly in the ACL (for example, as a key
29056 in lookups). If a test to verify the recipient is obeyed, the case-related
29057 handling of the local part during the verification is controlled by the router
29058 configuration (see the &%caseful_local_part%& generic router option).
29059
29060 This facility could be used, for example, to add a spam score to local parts
29061 containing upper case letters. For example, using &$acl_m4$& to accumulate the
29062 spam score:
29063 .code
29064 warn  control = caseful_local_part
29065       set acl_m4 = ${eval:\
29066                      $acl_m4 + \
29067                      ${if match{$local_part}{[A-Z]}{1}{0}}\
29068                     }
29069       control = caselower_local_part
29070 .endd
29071 Notice that we put back the lower cased version afterwards, assuming that
29072 is what is wanted for subsequent tests.
29073
29074
29075 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
29076 .cindex "&ACL;" "cutthrough routing"
29077 .cindex "cutthrough" "requesting"
29078 This option requests delivery be attempted while the item is being received.
29079
29080 The option is usable in the RCPT ACL.
29081 If enabled for a message received via smtp and routed to an smtp transport,
29082 and only one transport, interface, destination host and port combination
29083 is used for all recipients of the message,
29084 then the delivery connection is made while the receiving connection is open
29085 and data is copied from one to the other.
29086
29087 An attempt to set this option for any recipient but the first
29088 for a mail will be quietly ignored.
29089 If a recipient-verify callout
29090 (with use_sender)
29091 connection is subsequently
29092 requested in the same ACL it is held open and used for
29093 any subsequent recipients and the data,
29094 otherwise one is made after the initial RCPT ACL completes.
29095
29096 Note that routers are used in verify mode,
29097 and cannot depend on content of received headers.
29098 Note also that headers cannot be
29099 modified by any of the post-data ACLs (DATA, MIME and DKIM).
29100 Headers may be modified by routers (subject to the above) and transports.
29101 .new
29102 The Received-By: header is generated as soon as the body reception starts,
29103 rather than the traditional time after the full message is received;
29104 this will affect the timestamp.
29105 .wen
29106
29107 All the usual ACLs are called; if one results in the message being
29108 rejected, all effort spent in delivery (including the costs on
29109 the ultimate destination) will be wasted.
29110 Note that in the case of data-time ACLs this includes the entire
29111 message body.
29112
29113 Cutthrough delivery is not supported via transport-filters or when DKIM signing
29114 of outgoing messages is done, because it sends data to the ultimate destination
29115 before the entire message has been received from the source.
29116 It is not supported for messages received with the SMTP PRDR
29117 or CHUNKING
29118 options in use.
29119
29120 Should the ultimate destination system positively accept or reject the mail,
29121 a corresponding indication is given to the source system and nothing is queued.
29122 If the item is successfully delivered in cutthrough mode
29123 the delivery log lines are tagged with ">>" rather than "=>" and appear
29124 before the acceptance "<=" line.
29125
29126 If there is a temporary error the item is queued for later delivery in the
29127 usual fashion.
29128 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29129 to the control; the default value is &"spool"& and the alternate value
29130 &"pass"& copies an SMTP defer response from the target back to the initiator
29131 and does not queue the message.
29132 Note that this is independent of any recipient verify conditions in the ACL.
29133
29134 Delivery in this mode avoids the generation of a bounce mail to a
29135 (possibly faked)
29136 sender when the destination system is doing content-scan based rejection.
29137
29138
29139 .vitem &*control&~=&~debug/*&<&'options'&>
29140 .cindex "&ACL;" "enabling debug logging"
29141 .cindex "debugging" "enabling from an ACL"
29142 This control turns on debug logging, almost as though Exim had been invoked
29143 with &`-d`&, with the output going to a new logfile in the usual logs directory,
29144 by default called &'debuglog'&.
29145 The filename can be adjusted with the &'tag'& option, which
29146 may access any variables already defined.  The logging may be adjusted with
29147 the &'opts'& option, which takes the same values as the &`-d`& command-line
29148 option.
29149 Logging started this way may be stopped, and the file removed,
29150 with the &'kill'& option.
29151 Some examples (which depend on variables that don't exist in all
29152 contexts):
29153 .code
29154       control = debug
29155       control = debug/tag=.$sender_host_address
29156       control = debug/opts=+expand+acl
29157       control = debug/tag=.$message_exim_id/opts=+expand
29158       control = debug/kill
29159 .endd
29160
29161
29162 .vitem &*control&~=&~dkim_disable_verify*&
29163 .cindex "disable DKIM verify"
29164 .cindex "DKIM" "disable verify"
29165 This control turns off DKIM verification processing entirely.  For details on
29166 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
29167
29168
29169 .vitem &*control&~=&~dscp/*&<&'value'&>
29170 .cindex "&ACL;" "setting DSCP value"
29171 .cindex "DSCP" "inbound"
29172 This option causes the DSCP value associated with the socket for the inbound
29173 connection to be adjusted to a given value, given as one of a number of fixed
29174 strings or to numeric value.
29175 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29176 Common values include &`throughput`&, &`mincost`&, and on newer systems
29177 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29178
29179 The outbound packets from Exim will be marked with this value in the header
29180 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29181 that these values will have any effect, not be stripped by networking
29182 equipment, or do much of anything without cooperation with your Network
29183 Engineer and those of all network operators between the source and destination.
29184
29185
29186 .vitem &*control&~=&~enforce_sync*& &&&
29187        &*control&~=&~no_enforce_sync*&
29188 .cindex "SMTP" "synchronization checking"
29189 .cindex "synchronization checking in SMTP"
29190 These controls make it possible to be selective about when SMTP synchronization
29191 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29192 state of the switch (it is true by default). See the description of this option
29193 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29194
29195 The effect of these two controls lasts for the remainder of the SMTP
29196 connection. They can appear in any ACL except the one for the non-SMTP
29197 messages. The most straightforward place to put them is in the ACL defined by
29198 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29199 before the first synchronization check. The expected use is to turn off the
29200 synchronization checks for badly-behaved hosts that you nevertheless need to
29201 work with.
29202
29203
29204 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29205 .cindex "fake defer"
29206 .cindex "defer, fake"
29207 This control works in exactly the same way as &%fakereject%& (described below)
29208 except that it causes an SMTP 450 response after the message data instead of a
29209 550 response. You must take care when using &%fakedefer%& because it causes the
29210 messages to be duplicated when the sender retries. Therefore, you should not
29211 use &%fakedefer%& if the message is to be delivered normally.
29212
29213 .vitem &*control&~=&~fakereject/*&<&'message'&>
29214 .cindex "fake rejection"
29215 .cindex "rejection, fake"
29216 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29217 words, only when an SMTP message is being received. If Exim accepts the
29218 message, instead the final 250 response, a 550 rejection message is sent.
29219 However, Exim proceeds to deliver the message as normal. The control applies
29220 only to the current message, not to any subsequent ones that may be received in
29221 the same SMTP connection.
29222
29223 The text for the 550 response is taken from the &%control%& modifier. If no
29224 message is supplied, the following is used:
29225 .code
29226 550-Your message has been rejected but is being
29227 550-kept for evaluation.
29228 550-If it was a legitimate message, it may still be
29229 550 delivered to the target recipient(s).
29230 .endd
29231 This facility should be used with extreme caution.
29232
29233 .vitem &*control&~=&~freeze*&
29234 .cindex "frozen messages" "forcing in ACL"
29235 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29236 other words, only when a message is being received. If the message is accepted,
29237 it is placed on Exim's queue and frozen. The control applies only to the
29238 current message, not to any subsequent ones that may be received in the same
29239 SMTP connection.
29240
29241 This modifier can optionally be followed by &`/no_tell`&. If the global option
29242 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29243 is told about the freezing), provided all the &*control=freeze*& modifiers that
29244 are obeyed for the current message have the &`/no_tell`& option.
29245
29246 .vitem &*control&~=&~no_delay_flush*&
29247 .cindex "SMTP" "output flushing, disabling for delay"
29248 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29249 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29250 use. This control, as long as it is encountered before the &%delay%& modifier,
29251 disables such output flushing.
29252
29253 .vitem &*control&~=&~no_callout_flush*&
29254 .cindex "SMTP" "output flushing, disabling for callout"
29255 Exim normally flushes SMTP output before performing a callout in an ACL, to
29256 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29257 use. This control, as long as it is encountered before the &%verify%& condition
29258 that causes the callout, disables such output flushing.
29259
29260 .vitem &*control&~=&~no_mbox_unspool*&
29261 This control is available when Exim is compiled with the content scanning
29262 extension. Content scanning may require a copy of the current message, or parts
29263 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29264 or spam scanner. Normally, such copies are deleted when they are no longer
29265 needed. If this control is set, the copies are not deleted. The control applies
29266 only to the current message, not to any subsequent ones that may be received in
29267 the same SMTP connection. It is provided for debugging purposes and is unlikely
29268 to be useful in production.
29269
29270 .vitem &*control&~=&~no_multiline_responses*&
29271 .cindex "multiline responses, suppressing"
29272 This control is permitted for any ACL except the one for non-SMTP messages.
29273 It seems that there are broken clients in use that cannot handle multiline
29274 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29275
29276 If this control is set, multiline SMTP responses from ACL rejections are
29277 suppressed. One way of doing this would have been to put out these responses as
29278 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29279 (&"use multiline responses for more"& it says &-- ha!), and some of the
29280 responses might get close to that. So this facility, which is after all only a
29281 sop to broken clients, is implemented by doing two very easy things:
29282
29283 .ilist
29284 Extra information that is normally output as part of a rejection caused by
29285 sender verification failure is omitted. Only the final line (typically &"sender
29286 verification failed"&) is sent.
29287 .next
29288 If a &%message%& modifier supplies a multiline response, only the first
29289 line is output.
29290 .endlist
29291
29292 The setting of the switch can, of course, be made conditional on the
29293 calling host. Its effect lasts until the end of the SMTP connection.
29294
29295 .vitem &*control&~=&~no_pipelining*&
29296 .cindex "PIPELINING" "suppressing advertising"
29297 This control turns off the advertising of the PIPELINING extension to SMTP in
29298 the current session. To be useful, it must be obeyed before Exim sends its
29299 response to an EHLO command. Therefore, it should normally appear in an ACL
29300 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29301 &%pipelining_advertise_hosts%&.
29302
29303 .vitem &*control&~=&~queue_only*&
29304 .oindex "&%queue_only%&"
29305 .cindex "queueing incoming messages"
29306 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29307 other words, only when a message is being received. If the message is accepted,
29308 it is placed on Exim's queue and left there for delivery by a subsequent queue
29309 runner. No immediate delivery process is started. In other words, it has the
29310 effect as the &%queue_only%& global option. However, the control applies only
29311 to the current message, not to any subsequent ones that may be received in the
29312 same SMTP connection.
29313
29314 .vitem &*control&~=&~submission/*&<&'options'&>
29315 .cindex "message" "submission"
29316 .cindex "submission mode"
29317 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29318 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29319 the current message is a submission from a local MUA. In this case, Exim
29320 operates in &"submission mode"&, and applies certain fixups to the message if
29321 necessary. For example, it adds a &'Date:'& header line if one is not present.
29322 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29323 late (the message has already been created).
29324
29325 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29326 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29327 submission mode; the available options for this control are described there.
29328 The control applies only to the current message, not to any subsequent ones
29329 that may be received in the same SMTP connection.
29330
29331 .vitem &*control&~=&~suppress_local_fixups*&
29332 .cindex "submission fixups, suppressing"
29333 This control applies to locally submitted (non TCP/IP) messages, and is the
29334 complement of &`control = submission`&. It disables the fixups that are
29335 normally applied to locally-submitted messages. Specifically:
29336
29337 .ilist
29338 Any &'Sender:'& header line is left alone (in this respect, it is a
29339 dynamic version of &%local_sender_retain%&).
29340 .next
29341 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29342 .next
29343 There is no check that &'From:'& corresponds to the actual sender.
29344 .endlist ilist
29345
29346 This control may be useful when a remotely-originated message is accepted,
29347 passed to some scanning program, and then re-submitted for delivery. It can be
29348 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29349 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29350 data is read.
29351
29352 &*Note:*& This control applies only to the current message, not to any others
29353 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29354
29355 .vitem &*control&~=&~utf8_downconvert*&
29356 This control enables conversion of UTF-8 in message addresses
29357 to a-label form.
29358 For details see section &<<SECTi18nMTA>>&.
29359 .endlist vlist
29360
29361
29362 .section "Summary of message fixup control" "SECTsummesfix"
29363 All four possibilities for message fixups can be specified:
29364
29365 .ilist
29366 Locally submitted, fixups applied: the default.
29367 .next
29368 Locally submitted, no fixups applied: use
29369 &`control = suppress_local_fixups`&.
29370 .next
29371 Remotely submitted, no fixups applied: the default.
29372 .next
29373 Remotely submitted, fixups applied: use &`control = submission`&.
29374 .endlist
29375
29376
29377
29378 .section "Adding header lines in ACLs" "SECTaddheadacl"
29379 .cindex "header lines" "adding in an ACL"
29380 .cindex "header lines" "position of added lines"
29381 .cindex "&%add_header%& ACL modifier"
29382 The &%add_header%& modifier can be used to add one or more extra header lines
29383 to an incoming message, as in this example:
29384 .code
29385 warn dnslists = sbl.spamhaus.org : \
29386                 dialup.mail-abuse.org
29387      add_header = X-blacklisted-at: $dnslist_domain
29388 .endd
29389 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29390 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29391 receiving a message). The message must ultimately be accepted for
29392 &%add_header%& to have any significant effect. You can use &%add_header%& with
29393 any ACL verb, including &%deny%& (though this is potentially useful only in a
29394 RCPT ACL).
29395
29396 Headers will not be added to the message if the modifier is used in
29397 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29398
29399 Leading and trailing newlines are removed from
29400 the data for the &%add_header%& modifier; if it then
29401 contains one or more newlines that
29402 are not followed by a space or a tab, it is assumed to contain multiple header
29403 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29404 front of any line that is not a valid header line.
29405
29406 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29407 They are added to the message before processing the DATA and MIME ACLs.
29408 However, if an identical header line is requested more than once, only one copy
29409 is actually added to the message. Further header lines may be accumulated
29410 during the DATA and MIME ACLs, after which they are added to the message, again
29411 with duplicates suppressed. Thus, it is possible to add two identical header
29412 lines to an SMTP message, but only if one is added before DATA and one after.
29413 In the case of non-SMTP messages, new headers are accumulated during the
29414 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29415 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29416 are included in the entry that is written to the reject log.
29417
29418 .cindex "header lines" "added; visibility of"
29419 Header lines are not visible in string expansions
29420 of message headers
29421 until they are added to the
29422 message. It follows that header lines defined in the MAIL, RCPT, and predata
29423 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29424 header lines that are added by the DATA or MIME ACLs are not visible in those
29425 ACLs. Because of this restriction, you cannot use header lines as a way of
29426 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29427 this, you can use ACL variables, as described in section
29428 &<<SECTaclvariables>>&.
29429
29430 The list of headers yet to be added is given by the &%$headers_added%& variable.
29431
29432 The &%add_header%& modifier acts immediately as it is encountered during the
29433 processing of an ACL. Notice the difference between these two cases:
29434 .display
29435 &`accept add_header = ADDED: some text`&
29436 &`       `&<&'some condition'&>
29437
29438 &`accept `&<&'some condition'&>
29439 &`       add_header = ADDED: some text`&
29440 .endd
29441 In the first case, the header line is always added, whether or not the
29442 condition is true. In the second case, the header line is added only if the
29443 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29444 ACL statement. All those that are encountered before a condition fails are
29445 honoured.
29446
29447 .cindex "&%warn%& ACL verb"
29448 For compatibility with previous versions of Exim, a &%message%& modifier for a
29449 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29450 effect only if all the conditions are true, even if it appears before some of
29451 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29452 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29453 are present on a &%warn%& verb, both are processed according to their
29454 specifications.
29455
29456 By default, new header lines are added to a message at the end of the existing
29457 header lines. However, you can specify that any particular header line should
29458 be added right at the start (before all the &'Received:'& lines), immediately
29459 after the first block of &'Received:'& lines, or immediately before any line
29460 that is not a &'Received:'& or &'Resent-something:'& header.
29461
29462 This is done by specifying &":at_start:"&, &":after_received:"&, or
29463 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29464 header line, respectively. (Header text cannot start with a colon, as there has
29465 to be a header name first.) For example:
29466 .code
29467 warn add_header = \
29468        :after_received:X-My-Header: something or other...
29469 .endd
29470 If more than one header line is supplied in a single &%add_header%& modifier,
29471 each one is treated independently and can therefore be placed differently. If
29472 you add more than one line at the start, or after the Received: block, they end
29473 up in reverse order.
29474
29475 &*Warning*&: This facility currently applies only to header lines that are
29476 added in an ACL. It does NOT work for header lines that are added in a
29477 system filter or in a router or transport.
29478
29479
29480
29481 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29482 .cindex "header lines" "removing in an ACL"
29483 .cindex "header lines" "position of removed lines"
29484 .cindex "&%remove_header%& ACL modifier"
29485 The &%remove_header%& modifier can be used to remove one or more header lines
29486 from an incoming message, as in this example:
29487 .code
29488 warn   message        = Remove internal headers
29489        remove_header  = x-route-mail1 : x-route-mail2
29490 .endd
29491 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29492 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29493 receiving a message). The message must ultimately be accepted for
29494 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29495 with any ACL verb, including &%deny%&, though this is really not useful for
29496 any verb that doesn't result in a delivered message.
29497
29498 Headers will not be removed from the message if the modifier is used in
29499 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29500
29501 More than one header can be removed at the same time by using a colon separated
29502 list of header names. The header matching is case insensitive. Wildcards are
29503 not permitted, nor is list expansion performed, so you cannot use hostlists to
29504 create a list of headers, however both connection and message variable expansion
29505 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29506 .code
29507 warn   hosts           = +internal_hosts
29508        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29509 warn   message         = Remove internal headers
29510        remove_header   = $acl_c_ihdrs
29511 .endd
29512 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29513 They are removed from the message before processing the DATA and MIME ACLs.
29514 There is no harm in attempting to remove the same header twice nor is removing
29515 a non-existent header. Further header lines to be removed may be accumulated
29516 during the DATA and MIME ACLs, after which they are removed from the message,
29517 if present. In the case of non-SMTP messages, headers to be removed are
29518 accumulated during the non-SMTP ACLs, and are removed from the message after
29519 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29520 ACL, there really is no effect because there is no logging of what headers
29521 would have been removed.
29522
29523 .cindex "header lines" "removed; visibility of"
29524 Header lines are not visible in string expansions until the DATA phase when it
29525 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29526 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29527 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29528 this restriction, you cannot use header lines as a way of controlling data
29529 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29530 you should instead use ACL variables, as described in section
29531 &<<SECTaclvariables>>&.
29532
29533 The &%remove_header%& modifier acts immediately as it is encountered during the
29534 processing of an ACL. Notice the difference between these two cases:
29535 .display
29536 &`accept remove_header = X-Internal`&
29537 &`       `&<&'some condition'&>
29538
29539 &`accept `&<&'some condition'&>
29540 &`       remove_header = X-Internal`&
29541 .endd
29542 In the first case, the header line is always removed, whether or not the
29543 condition is true. In the second case, the header line is removed only if the
29544 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29545 same ACL statement. All those that are encountered before a condition fails
29546 are honoured.
29547
29548 &*Warning*&: This facility currently applies only to header lines that are
29549 present during ACL processing. It does NOT remove header lines that are added
29550 in a system filter or in a router or transport.
29551
29552
29553
29554
29555 .section "ACL conditions" "SECTaclconditions"
29556 .cindex "&ACL;" "conditions; list of"
29557 Some of the conditions listed in this section are available only when Exim is
29558 compiled with the content-scanning extension. They are included here briefly
29559 for completeness. More detailed descriptions can be found in the discussion on
29560 content scanning in chapter &<<CHAPexiscan>>&.
29561
29562 Not all conditions are relevant in all circumstances. For example, testing
29563 senders and recipients does not make sense in an ACL that is being run as the
29564 result of the arrival of an ETRN command, and checks on message headers can be
29565 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29566 can use the same condition (with different parameters) more than once in the
29567 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29568 The conditions are as follows:
29569
29570
29571 .vlist
29572 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29573 .cindex "&ACL;" "nested"
29574 .cindex "&ACL;" "indirect"
29575 .cindex "&ACL;" "arguments"
29576 .cindex "&%acl%& ACL condition"
29577 The possible values of the argument are the same as for the
29578 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29579 &"accept"& the condition is true; if it returns &"deny"& the condition is
29580 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29581 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29582 condition false. This means that further processing of the &%warn%& verb
29583 ceases, but processing of the ACL continues.
29584
29585 If the argument is a named ACL, up to nine space-separated optional values
29586 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29587 and $acl_narg is set to the count of values.
29588 Previous values of these variables are restored after the call returns.
29589 The name and values are expanded separately.
29590 Note that spaces in complex expansions which are used as arguments
29591 will act as argument separators.
29592
29593 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29594 the connection is dropped. If it returns &"discard"&, the verb must be
29595 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29596 conditions are tested.
29597
29598 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29599 loops. This condition allows you to use different ACLs in different
29600 circumstances. For example, different ACLs can be used to handle RCPT commands
29601 for different local users or different local domains.
29602
29603 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29604 .cindex "&%authenticated%& ACL condition"
29605 .cindex "authentication" "ACL checking"
29606 .cindex "&ACL;" "testing for authentication"
29607 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29608 the name of the authenticator is tested against the list. To test for
29609 authentication by any authenticator, you can set
29610 .code
29611 authenticated = *
29612 .endd
29613
29614 .vitem &*condition&~=&~*&<&'string'&>
29615 .cindex "&%condition%& ACL condition"
29616 .cindex "customizing" "ACL condition"
29617 .cindex "&ACL;" "customized test"
29618 .cindex "&ACL;" "testing, customized"
29619 This feature allows you to make up custom conditions. If the result of
29620 expanding the string is an empty string, the number zero, or one of the strings
29621 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29622 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29623 any other value, some error is assumed to have occurred, and the ACL returns
29624 &"defer"&. However, if the expansion is forced to fail, the condition is
29625 ignored. The effect is to treat it as true, whether it is positive or
29626 negative.
29627
29628 .vitem &*decode&~=&~*&<&'location'&>
29629 .cindex "&%decode%& ACL condition"
29630 This condition is available only when Exim is compiled with the
29631 content-scanning extension, and it is allowed only in the ACL defined by
29632 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29633 If all goes well, the condition is true. It is false only if there are
29634 problems such as a syntax error or a memory shortage. For more details, see
29635 chapter &<<CHAPexiscan>>&.
29636
29637 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29638 .cindex "&%dnslists%& ACL condition"
29639 .cindex "DNS list" "in ACL"
29640 .cindex "black list (DNS)"
29641 .cindex "&ACL;" "testing a DNS list"
29642 This condition checks for entries in DNS black lists. These are also known as
29643 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29644 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29645 different variants of this condition to describe briefly here. See sections
29646 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29647
29648 .vitem &*domains&~=&~*&<&'domain&~list'&>
29649 .cindex "&%domains%& ACL condition"
29650 .cindex "domain" "ACL checking"
29651 .cindex "&ACL;" "testing a recipient domain"
29652 .vindex "&$domain_data$&"
29653 This condition is relevant only after a RCPT command. It checks that the domain
29654 of the recipient address is in the domain list. If percent-hack processing is
29655 enabled, it is done before this test is done. If the check succeeds with a
29656 lookup, the result of the lookup is placed in &$domain_data$& until the next
29657 &%domains%& test.
29658
29659 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29660 use &%domains%& in a DATA ACL.
29661
29662
29663 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29664 .cindex "&%encrypted%& ACL condition"
29665 .cindex "encryption" "checking in an ACL"
29666 .cindex "&ACL;" "testing for encryption"
29667 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29668 name of the cipher suite in use is tested against the list. To test for
29669 encryption without testing for any specific cipher suite(s), set
29670 .code
29671 encrypted = *
29672 .endd
29673
29674
29675 .vitem &*hosts&~=&~*&<&'host&~list'&>
29676 .cindex "&%hosts%& ACL condition"
29677 .cindex "host" "ACL checking"
29678 .cindex "&ACL;" "testing the client host"
29679 This condition tests that the calling host matches the host list. If you have
29680 name lookups or wildcarded host names and IP addresses in the same host list,
29681 you should normally put the IP addresses first. For example, you could have:
29682 .code
29683 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29684 .endd
29685 The lookup in this example uses the host name for its key. This is implied by
29686 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29687 and it wouldn't matter which way round you had these two items.)
29688
29689 The reason for the problem with host names lies in the left-to-right way that
29690 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29691 but when it reaches an item that requires a host name, it fails if it cannot
29692 find a host name to compare with the pattern. If the above list is given in the
29693 opposite order, the &%accept%& statement fails for a host whose name cannot be
29694 found, even if its IP address is 10.9.8.7.
29695
29696 If you really do want to do the name check first, and still recognize the IP
29697 address even if the name lookup fails, you can rewrite the ACL like this:
29698 .code
29699 accept hosts = dbm;/etc/friendly/hosts
29700 accept hosts = 10.9.8.7
29701 .endd
29702 The default action on failing to find the host name is to assume that the host
29703 is not in the list, so the first &%accept%& statement fails. The second
29704 statement can then check the IP address.
29705
29706 .vindex "&$host_data$&"
29707 If a &%hosts%& condition is satisfied by means of a lookup, the result
29708 of the lookup is made available in the &$host_data$& variable. This
29709 allows you, for example, to set up a statement like this:
29710 .code
29711 deny  hosts = net-lsearch;/some/file
29712 message = $host_data
29713 .endd
29714 which gives a custom error message for each denied host.
29715
29716 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29717 .cindex "&%local_parts%& ACL condition"
29718 .cindex "local part" "ACL checking"
29719 .cindex "&ACL;" "testing a local part"
29720 .vindex "&$local_part_data$&"
29721 This condition is relevant only after a RCPT command. It checks that the local
29722 part of the recipient address is in the list. If percent-hack processing is
29723 enabled, it is done before this test. If the check succeeds with a lookup, the
29724 result of the lookup is placed in &$local_part_data$&, which remains set until
29725 the next &%local_parts%& test.
29726
29727 .vitem &*malware&~=&~*&<&'option'&>
29728 .cindex "&%malware%& ACL condition"
29729 .cindex "&ACL;" "virus scanning"
29730 .cindex "&ACL;" "scanning for viruses"
29731 This condition is available only when Exim is compiled with the
29732 content-scanning extension. It causes the incoming message to be scanned for
29733 viruses. For details, see chapter &<<CHAPexiscan>>&.
29734
29735 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29736 .cindex "&%mime_regex%& ACL condition"
29737 .cindex "&ACL;" "testing by regex matching"
29738 This condition is available only when Exim is compiled with the
29739 content-scanning extension, and it is allowed only in the ACL defined by
29740 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29741 with any of the regular expressions. For details, see chapter
29742 &<<CHAPexiscan>>&.
29743
29744 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29745 .cindex "rate limiting"
29746 This condition can be used to limit the rate at which a user or host submits
29747 messages. Details are given in section &<<SECTratelimiting>>&.
29748
29749 .vitem &*recipients&~=&~*&<&'address&~list'&>
29750 .cindex "&%recipients%& ACL condition"
29751 .cindex "recipient" "ACL checking"
29752 .cindex "&ACL;" "testing a recipient"
29753 This condition is relevant only after a RCPT command. It checks the entire
29754 recipient address against a list of recipients.
29755
29756 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29757 .cindex "&%regex%& ACL condition"
29758 .cindex "&ACL;" "testing by regex matching"
29759 This condition is available only when Exim is compiled with the
29760 content-scanning extension, and is available only in the DATA, MIME, and
29761 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29762 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29763
29764 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29765 .cindex "&%sender_domains%& ACL condition"
29766 .cindex "sender" "ACL checking"
29767 .cindex "&ACL;" "testing a sender domain"
29768 .vindex "&$domain$&"
29769 .vindex "&$sender_address_domain$&"
29770 This condition tests the domain of the sender of the message against the given
29771 domain list. &*Note*&: The domain of the sender address is in
29772 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29773 of this condition. This is an exception to the general rule for testing domain
29774 lists. It is done this way so that, if this condition is used in an ACL for a
29775 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29776 influence the sender checking.
29777
29778 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29779 relaying, because sender addresses are easily, and commonly, forged.
29780
29781 .vitem &*senders&~=&~*&<&'address&~list'&>
29782 .cindex "&%senders%& ACL condition"
29783 .cindex "sender" "ACL checking"
29784 .cindex "&ACL;" "testing a sender"
29785 This condition tests the sender of the message against the given list. To test
29786 for a bounce message, which has an empty sender, set
29787 .code
29788 senders = :
29789 .endd
29790 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29791 relaying, because sender addresses are easily, and commonly, forged.
29792
29793 .vitem &*spam&~=&~*&<&'username'&>
29794 .cindex "&%spam%& ACL condition"
29795 .cindex "&ACL;" "scanning for spam"
29796 This condition is available only when Exim is compiled with the
29797 content-scanning extension. It causes the incoming message to be scanned by
29798 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29799
29800 .vitem &*verify&~=&~certificate*&
29801 .cindex "&%verify%& ACL condition"
29802 .cindex "TLS" "client certificate verification"
29803 .cindex "certificate" "verification of client"
29804 .cindex "&ACL;" "certificate verification"
29805 .cindex "&ACL;" "testing a TLS certificate"
29806 This condition is true in an SMTP session if the session is encrypted, and a
29807 certificate was received from the client, and the certificate was verified. The
29808 server requests a certificate only if the client matches &%tls_verify_hosts%&
29809 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29810
29811 .vitem &*verify&~=&~csa*&
29812 .cindex "CSA verification"
29813 This condition checks whether the sending host (the client) is authorized to
29814 send email. Details of how this works are given in section
29815 &<<SECTverifyCSA>>&.
29816
29817 .vitem &*verify&~=&~header_names_ascii*&
29818 .cindex "&%verify%& ACL condition"
29819 .cindex "&ACL;" "verifying header names only ASCII"
29820 .cindex "header lines" "verifying header names only ASCII"
29821 .cindex "verifying" "header names only ASCII"
29822 This condition is relevant only in an ACL that is run after a message has been
29823 received, that is, in an ACL specified by &%acl_smtp_data%& or
29824 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29825 there are no non-ASCII characters, also excluding control characters.  The
29826 allowable characters are decimal ASCII values 33 through 126.
29827
29828 Exim itself will handle headers with non-ASCII characters, but it can cause
29829 problems for downstream applications, so this option will allow their
29830 detection and rejection in the DATA ACL's.
29831
29832 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29833 .cindex "&%verify%& ACL condition"
29834 .cindex "&ACL;" "verifying sender in the header"
29835 .cindex "header lines" "verifying the sender in"
29836 .cindex "sender" "verifying in header"
29837 .cindex "verifying" "sender in header"
29838 This condition is relevant only in an ACL that is run after a message has been
29839 received, that is, in an ACL specified by &%acl_smtp_data%& or
29840 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29841 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29842 is loosely thought of as a &"sender"& address (hence the name of the test).
29843 However, an address that appears in one of these headers need not be an address
29844 that accepts bounce messages; only sender addresses in envelopes are required
29845 to accept bounces. Therefore, if you use the callout option on this check, you
29846 might want to arrange for a non-empty address in the MAIL command.
29847
29848 Details of address verification and the options are given later, starting at
29849 section &<<SECTaddressverification>>& (callouts are described in section
29850 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29851 condition to restrict it to bounce messages only:
29852 .code
29853 deny    senders = :
29854         message = A valid sender header is required for bounces
29855        !verify  = header_sender
29856 .endd
29857
29858 .vitem &*verify&~=&~header_syntax*&
29859 .cindex "&%verify%& ACL condition"
29860 .cindex "&ACL;" "verifying header syntax"
29861 .cindex "header lines" "verifying syntax"
29862 .cindex "verifying" "header syntax"
29863 This condition is relevant only in an ACL that is run after a message has been
29864 received, that is, in an ACL specified by &%acl_smtp_data%& or
29865 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29866 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29867 and &'Bcc:'&), returning true if there are no problems.
29868 Unqualified addresses (local parts without domains) are
29869 permitted only in locally generated messages and from hosts that match
29870 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29871 appropriate.
29872
29873 Note that this condition is a syntax check only. However, a common spamming
29874 ploy used to be to send syntactically invalid headers such as
29875 .code
29876 To: @
29877 .endd
29878 and this condition can be used to reject such messages, though they are not as
29879 common as they used to be.
29880
29881 .vitem &*verify&~=&~helo*&
29882 .cindex "&%verify%& ACL condition"
29883 .cindex "&ACL;" "verifying HELO/EHLO"
29884 .cindex "HELO" "verifying"
29885 .cindex "EHLO" "verifying"
29886 .cindex "verifying" "EHLO"
29887 .cindex "verifying" "HELO"
29888 This condition is true if a HELO or EHLO command has been received from the
29889 client host, and its contents have been verified. If there has been no previous
29890 attempt to verify the HELO/EHLO contents, it is carried out when this
29891 condition is encountered. See the description of the &%helo_verify_hosts%& and
29892 &%helo_try_verify_hosts%& options for details of how to request verification
29893 independently of this condition.
29894
29895 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29896 option), this condition is always true.
29897
29898
29899 .vitem &*verify&~=&~not_blind*&
29900 .cindex "verifying" "not blind"
29901 .cindex "bcc recipients, verifying none"
29902 This condition checks that there are no blind (bcc) recipients in the message.
29903 Every envelope recipient must appear either in a &'To:'& header line or in a
29904 &'Cc:'& header line for this condition to be true. Local parts are checked
29905 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29906 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29907 used only in a DATA or non-SMTP ACL.
29908
29909 There are, of course, many legitimate messages that make use of blind (bcc)
29910 recipients. This check should not be used on its own for blocking messages.
29911
29912
29913 .vitem &*verify&~=&~recipient/*&<&'options'&>
29914 .cindex "&%verify%& ACL condition"
29915 .cindex "&ACL;" "verifying recipient"
29916 .cindex "recipient" "verifying"
29917 .cindex "verifying" "recipient"
29918 .vindex "&$address_data$&"
29919 This condition is relevant only after a RCPT command. It verifies the current
29920 recipient. Details of address verification are given later, starting at section
29921 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29922 of &$address_data$& is the last value that was set while routing the address.
29923 This applies even if the verification fails. When an address that is being
29924 verified is redirected to a single address, verification continues with the new
29925 address, and in that case, the subsequent value of &$address_data$& is the
29926 value for the child address.
29927
29928 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29929 .cindex "&%verify%& ACL condition"
29930 .cindex "&ACL;" "verifying host reverse lookup"
29931 .cindex "host" "verifying reverse lookup"
29932 This condition ensures that a verified host name has been looked up from the IP
29933 address of the client host. (This may have happened already if the host name
29934 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29935 Verification ensures that the host name obtained from a reverse DNS lookup, or
29936 one of its aliases, does, when it is itself looked up in the DNS, yield the
29937 original IP address.
29938
29939 There is one possible option, &`defer_ok`&.  If this is present and a
29940 DNS operation returns a temporary error, the verify condition succeeds.
29941
29942 If this condition is used for a locally generated message (that is, when there
29943 is no client host involved), it always succeeds.
29944
29945 .vitem &*verify&~=&~sender/*&<&'options'&>
29946 .cindex "&%verify%& ACL condition"
29947 .cindex "&ACL;" "verifying sender"
29948 .cindex "sender" "verifying"
29949 .cindex "verifying" "sender"
29950 This condition is relevant only after a MAIL or RCPT command, or after a
29951 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29952 the message's sender is empty (that is, this is a bounce message), the
29953 condition is true. Otherwise, the sender address is verified.
29954
29955 .vindex "&$address_data$&"
29956 .vindex "&$sender_address_data$&"
29957 If there is data in the &$address_data$& variable at the end of routing, its
29958 value is placed in &$sender_address_data$& at the end of verification. This
29959 value can be used in subsequent conditions and modifiers in the same ACL
29960 statement. It does not persist after the end of the current statement. If you
29961 want to preserve the value for longer, you can save it in an ACL variable.
29962
29963 Details of verification are given later, starting at section
29964 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29965 to avoid doing it more than once per message.
29966
29967 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29968 .cindex "&%verify%& ACL condition"
29969 This is a variation of the previous option, in which a modified address is
29970 verified as a sender.
29971
29972 Note that '/' is legal in local-parts; if the address may have such
29973 (eg. is generated from the received message)
29974 they must be protected from the options parsing by doubling:
29975 .code
29976 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
29977 .endd
29978 .endlist
29979
29980
29981
29982 .section "Using DNS lists" "SECTmorednslists"
29983 .cindex "DNS list" "in ACL"
29984 .cindex "black list (DNS)"
29985 .cindex "&ACL;" "testing a DNS list"
29986 In its simplest form, the &%dnslists%& condition tests whether the calling host
29987 is on at least one of a number of DNS lists by looking up the inverted IP
29988 address in one or more DNS domains. (Note that DNS list domains are not mail
29989 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29990 special options instead.) For example, if the calling host's IP
29991 address is 192.168.62.43, and the ACL statement is
29992 .code
29993 deny dnslists = blackholes.mail-abuse.org : \
29994                 dialups.mail-abuse.org
29995 .endd
29996 the following records are looked up:
29997 .code
29998 43.62.168.192.blackholes.mail-abuse.org
29999 43.62.168.192.dialups.mail-abuse.org
30000 .endd
30001 As soon as Exim finds an existing DNS record, processing of the list stops.
30002 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
30003 to test that a host is on more than one list (an &"and"& conjunction), you can
30004 use two separate conditions:
30005 .code
30006 deny dnslists = blackholes.mail-abuse.org
30007      dnslists = dialups.mail-abuse.org
30008 .endd
30009 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
30010 behaves as if the host does not match the list item, that is, as if the DNS
30011 record does not exist. If there are further items in the DNS list, they are
30012 processed.
30013
30014 This is usually the required action when &%dnslists%& is used with &%deny%&
30015 (which is the most common usage), because it prevents a DNS failure from
30016 blocking mail. However, you can change this behaviour by putting one of the
30017 following special items in the list:
30018 .display
30019 &`+include_unknown `&   behave as if the item is on the list
30020 &`+exclude_unknown `&   behave as if the item is not on the list (default)
30021 &`+defer_unknown   `&   give a temporary error
30022 .endd
30023 .cindex "&`+include_unknown`&"
30024 .cindex "&`+exclude_unknown`&"
30025 .cindex "&`+defer_unknown`&"
30026 Each of these applies to any subsequent items on the list. For example:
30027 .code
30028 deny dnslists = +defer_unknown : foo.bar.example
30029 .endd
30030 Testing the list of domains stops as soon as a match is found. If you want to
30031 warn for one list and block for another, you can use two different statements:
30032 .code
30033 deny  dnslists = blackholes.mail-abuse.org
30034 warn  message  = X-Warn: sending host is on dialups list
30035       dnslists = dialups.mail-abuse.org
30036 .endd
30037 .cindex caching "of dns lookup"
30038 .cindex DNS TTL
30039 DNS list lookups are cached by Exim for the duration of the SMTP session
30040 (but limited by the DNS return TTL value),
30041 so a lookup based on the IP address is done at most once for any incoming
30042 connection (assuming long-enough TTL).
30043 Exim does not share information between multiple incoming
30044 connections (but your local name server cache should be active).
30045
30046
30047
30048 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30049 .cindex "DNS list" "keyed by explicit IP address"
30050 By default, the IP address that is used in a DNS list lookup is the IP address
30051 of the calling host. However, you can specify another IP address by listing it
30052 after the domain name, introduced by a slash. For example:
30053 .code
30054 deny dnslists = black.list.tld/192.168.1.2
30055 .endd
30056 This feature is not very helpful with explicit IP addresses; it is intended for
30057 use with IP addresses that are looked up, for example, the IP addresses of the
30058 MX hosts or nameservers of an email sender address. For an example, see section
30059 &<<SECTmulkeyfor>>& below.
30060
30061
30062
30063
30064 .section "DNS lists keyed on domain names" "SECID202"
30065 .cindex "DNS list" "keyed by domain name"
30066 There are some lists that are keyed on domain names rather than inverted IP
30067 addresses (see for example the &'domain based zones'& link at
30068 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
30069 with these lists. You can change the name that is looked up in a DNS list by
30070 listing it after the domain name, introduced by a slash. For example,
30071 .code
30072 deny  message  = Sender's domain is listed at $dnslist_domain
30073       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
30074 .endd
30075 This particular example is useful only in ACLs that are obeyed after the
30076 RCPT or DATA commands, when a sender address is available. If (for
30077 example) the message's sender is &'user@tld.example'& the name that is looked
30078 up by this example is
30079 .code
30080 tld.example.dsn.rfc-ignorant.org
30081 .endd
30082 A single &%dnslists%& condition can contain entries for both names and IP
30083 addresses. For example:
30084 .code
30085 deny dnslists = sbl.spamhaus.org : \
30086                 dsn.rfc-ignorant.org/$sender_address_domain
30087 .endd
30088 The first item checks the sending host's IP address; the second checks a domain
30089 name. The whole condition is true if either of the DNS lookups succeeds.
30090
30091
30092
30093
30094 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
30095 .cindex "DNS list" "multiple keys for"
30096 The syntax described above for looking up explicitly-defined values (either
30097 names or IP addresses) in a DNS blacklist is a simplification. After the domain
30098 name for the DNS list, what follows the slash can in fact be a list of items.
30099 As with all lists in Exim, the default separator is a colon. However, because
30100 this is a sublist within the list of DNS blacklist domains, it is necessary
30101 either to double the separators like this:
30102 .code
30103 dnslists = black.list.tld/name.1::name.2
30104 .endd
30105 or to change the separator character, like this:
30106 .code
30107 dnslists = black.list.tld/<;name.1;name.2
30108 .endd
30109 If an item in the list is an IP address, it is inverted before the DNS
30110 blacklist domain is appended. If it is not an IP address, no inversion
30111 occurs. Consider this condition:
30112 .code
30113 dnslists = black.list.tld/<;192.168.1.2;a.domain
30114 .endd
30115 The DNS lookups that occur are:
30116 .code
30117 2.1.168.192.black.list.tld
30118 a.domain.black.list.tld
30119 .endd
30120 Once a DNS record has been found (that matches a specific IP return
30121 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30122 are done. If there is a temporary DNS error, the rest of the sublist of domains
30123 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30124 only if no other DNS lookup in this sublist succeeds. In other words, a
30125 successful lookup for any of the items in the sublist overrides a temporary
30126 error for a previous item.
30127
30128 The ability to supply a list of items after the slash is in some sense just a
30129 syntactic convenience. These two examples have the same effect:
30130 .code
30131 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30132 dnslists = black.list.tld/a.domain::b.domain
30133 .endd
30134 However, when the data for the list is obtained from a lookup, the second form
30135 is usually much more convenient. Consider this example:
30136 .code
30137 deny message  = The mail servers for the domain \
30138                 $sender_address_domain \
30139                 are listed at $dnslist_domain ($dnslist_value); \
30140                 see $dnslist_text.
30141      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30142                                    ${lookup dnsdb {>|mxh=\
30143                                    $sender_address_domain} }} }
30144 .endd
30145 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30146 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30147 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30148 of expanding the condition might be something like this:
30149 .code
30150 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30151 .endd
30152 Thus, this example checks whether or not the IP addresses of the sender
30153 domain's mail servers are on the Spamhaus black list.
30154
30155 The key that was used for a successful DNS list lookup is put into the variable
30156 &$dnslist_matched$& (see section &<<SECID204>>&).
30157
30158
30159
30160
30161 .section "Data returned by DNS lists" "SECID203"
30162 .cindex "DNS list" "data returned from"
30163 DNS lists are constructed using address records in the DNS. The original RBL
30164 just used the address 127.0.0.1 on the right hand side of each record, but the
30165 RBL+ list and some other lists use a number of values with different meanings.
30166 The values used on the RBL+ list are:
30167 .display
30168 127.1.0.1  RBL
30169 127.1.0.2  DUL
30170 127.1.0.3  DUL and RBL
30171 127.1.0.4  RSS
30172 127.1.0.5  RSS and RBL
30173 127.1.0.6  RSS and DUL
30174 127.1.0.7  RSS and DUL and RBL
30175 .endd
30176 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30177 different values. Some DNS lists may return more than one address record;
30178 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30179
30180
30181 .section "Variables set from DNS lists" "SECID204"
30182 .cindex "expansion" "variables, set from DNS list"
30183 .cindex "DNS list" "variables set from"
30184 .vindex "&$dnslist_domain$&"
30185 .vindex "&$dnslist_matched$&"
30186 .vindex "&$dnslist_text$&"
30187 .vindex "&$dnslist_value$&"
30188 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30189 the name of the overall domain that matched (for example,
30190 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30191 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30192 the DNS record. When the key is an IP address, it is not reversed in
30193 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30194 cases, for example:
30195 .code
30196 deny dnslists = spamhaus.example
30197 .endd
30198 the key is also available in another variable (in this case,
30199 &$sender_host_address$&). In more complicated cases, however, this is not true.
30200 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30201 might generate a dnslists lookup like this:
30202 .code
30203 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30204 .endd
30205 If this condition succeeds, the value in &$dnslist_matched$& might be
30206 &`192.168.6.7`& (for example).
30207
30208 If more than one address record is returned by the DNS lookup, all the IP
30209 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30210 The variable &$dnslist_text$& contains the contents of any associated TXT
30211 record. For lists such as RBL+ the TXT record for a merged entry is often not
30212 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30213 information.
30214
30215 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30216 &-- although these appear before the condition in the ACL, they are not
30217 expanded until after it has failed. For example:
30218 .code
30219 deny    hosts = !+local_networks
30220         message = $sender_host_address is listed \
30221                   at $dnslist_domain
30222         dnslists = rbl-plus.mail-abuse.example
30223 .endd
30224
30225
30226
30227 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30228 .cindex "DNS list" "matching specific returned data"
30229 You can add an equals sign and an IP address after a &%dnslists%& domain name
30230 in order to restrict its action to DNS records with a matching right hand side.
30231 For example,
30232 .code
30233 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30234 .endd
30235 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30236 any address record is considered to be a match. For the moment, we assume
30237 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30238 describes how multiple records are handled.
30239
30240 More than one IP address may be given for checking, using a comma as a
30241 separator. These are alternatives &-- if any one of them matches, the
30242 &%dnslists%& condition is true. For example:
30243 .code
30244 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30245 .endd
30246 If you want to specify a constraining address list and also specify names or IP
30247 addresses to be looked up, the constraining address list must be specified
30248 first. For example:
30249 .code
30250 deny dnslists = dsn.rfc-ignorant.org\
30251                 =127.0.0.2/$sender_address_domain
30252 .endd
30253
30254 If the character &`&&`& is used instead of &`=`&, the comparison for each
30255 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30256 In other words, the listed addresses are used as bit masks. The comparison is
30257 true if all the bits in the mask are present in the address that is being
30258 tested. For example:
30259 .code
30260 dnslists = a.b.c&0.0.0.3
30261 .endd
30262 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30263 want to test whether one bit or another bit is present (as opposed to both
30264 being present), you must use multiple values. For example:
30265 .code
30266 dnslists = a.b.c&0.0.0.1,0.0.0.2
30267 .endd
30268 matches if the final component of the address is an odd number or two times
30269 an odd number.
30270
30271
30272
30273 .section "Negated DNS matching conditions" "SECID205"
30274 You can supply a negative list of IP addresses as part of a &%dnslists%&
30275 condition. Whereas
30276 .code
30277 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30278 .endd
30279 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30280 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30281 .code
30282 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30283 .endd
30284 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30285 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30286 words, the result of the test is inverted if an exclamation mark appears before
30287 the &`=`& (or the &`&&`&) sign.
30288
30289 &*Note*&: This kind of negation is not the same as negation in a domain,
30290 host, or address list (which is why the syntax is different).
30291
30292 If you are using just one list, the negation syntax does not gain you much. The
30293 previous example is precisely equivalent to
30294 .code
30295 deny  dnslists = a.b.c
30296      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30297 .endd
30298 However, if you are using multiple lists, the negation syntax is clearer.
30299 Consider this example:
30300 .code
30301 deny  dnslists = sbl.spamhaus.org : \
30302                  list.dsbl.org : \
30303                  dnsbl.njabl.org!=127.0.0.3 : \
30304                  relays.ordb.org
30305 .endd
30306 Using only positive lists, this would have to be:
30307 .code
30308 deny  dnslists = sbl.spamhaus.org : \
30309                  list.dsbl.org
30310 deny  dnslists = dnsbl.njabl.org
30311      !dnslists = dnsbl.njabl.org=127.0.0.3
30312 deny  dnslists = relays.ordb.org
30313 .endd
30314 which is less clear, and harder to maintain.
30315
30316
30317
30318
30319 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30320 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30321 thereby providing more than one IP address. When an item in a &%dnslists%& list
30322 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30323 the match to specific results from the DNS lookup, there are two ways in which
30324 the checking can be handled. For example, consider the condition:
30325 .code
30326 dnslists = a.b.c=127.0.0.1
30327 .endd
30328 What happens if the DNS lookup for the incoming IP address yields both
30329 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30330 condition true because at least one given value was found, or is it false
30331 because at least one of the found values was not listed? And how does this
30332 affect negated conditions? Both possibilities are provided for with the help of
30333 additional separators &`==`& and &`=&&`&.
30334
30335 .ilist
30336 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30337 IP addresses matches one of the listed addresses. For the example above, the
30338 condition is true because 127.0.0.1 matches.
30339 .next
30340 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30341 looked up IP addresses matches one of the listed addresses. If the condition is
30342 changed to:
30343 .code
30344 dnslists = a.b.c==127.0.0.1
30345 .endd
30346 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30347 false because 127.0.0.2 is not listed. You would need to have:
30348 .code
30349 dnslists = a.b.c==127.0.0.1,127.0.0.2
30350 .endd
30351 for the condition to be true.
30352 .endlist
30353
30354 When &`!`& is used to negate IP address matching, it inverts the result, giving
30355 the precise opposite of the behaviour above. Thus:
30356 .ilist
30357 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30358 addresses matches one of the listed addresses. Consider:
30359 .code
30360 dnslists = a.b.c!&0.0.0.1
30361 .endd
30362 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30363 false because 127.0.0.1 matches.
30364 .next
30365 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30366 looked up IP address that does not match. Consider:
30367 .code
30368 dnslists = a.b.c!=&0.0.0.1
30369 .endd
30370 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30371 true, because 127.0.0.2 does not match. You would need to have:
30372 .code
30373 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30374 .endd
30375 for the condition to be false.
30376 .endlist
30377 When the DNS lookup yields only a single IP address, there is no difference
30378 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30379
30380
30381
30382
30383 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30384 .cindex "DNS list" "information from merged"
30385 When the facility for restricting the matching IP values in a DNS list is used,
30386 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30387 the true reason for rejection. This happens when lists are merged and the IP
30388 address in the A record is used to distinguish them; unfortunately there is
30389 only one TXT record. One way round this is not to use merged lists, but that
30390 can be inefficient because it requires multiple DNS lookups where one would do
30391 in the vast majority of cases when the host of interest is not on any of the
30392 lists.
30393
30394 A less inefficient way of solving this problem is available. If
30395 two domain names, comma-separated, are given, the second is used first to
30396 do an initial check, making use of any IP value restrictions that are set.
30397 If there is a match, the first domain is used, without any IP value
30398 restrictions, to get the TXT record. As a byproduct of this, there is also
30399 a check that the IP being tested is indeed on the first list. The first
30400 domain is the one that is put in &$dnslist_domain$&. For example:
30401 .code
30402 reject message  = \
30403          rejected because $sender_host_address is blacklisted \
30404          at $dnslist_domain\n$dnslist_text
30405        dnslists = \
30406          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30407          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30408 .endd
30409 For the first blacklist item, this starts by doing a lookup in
30410 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30411 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30412 value, and as long as something is found, it looks for the corresponding TXT
30413 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30414 The second blacklist item is processed similarly.
30415
30416 If you are interested in more than one merged list, the same list must be
30417 given several times, but because the results of the DNS lookups are cached,
30418 the DNS calls themselves are not repeated. For example:
30419 .code
30420 reject dnslists = \
30421          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30422          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30423          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30424          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30425 .endd
30426 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30427 values matches (or if no record is found), this is the only lookup that is
30428 done. Only if there is a match is one of the more specific lists consulted.
30429
30430
30431
30432 .section "DNS lists and IPv6" "SECTmorednslistslast"
30433 .cindex "IPv6" "DNS black lists"
30434 .cindex "DNS list" "IPv6 usage"
30435 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30436 nibble by nibble. For example, if the calling host's IP address is
30437 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30438 .code
30439 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30440   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30441 .endd
30442 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30443 lists contain wildcard records, intended for IPv4, that interact badly with
30444 IPv6. For example, the DNS entry
30445 .code
30446 *.3.some.list.example.    A    127.0.0.1
30447 .endd
30448 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30449 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30450
30451 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30452 &%condition%& condition, as in this example:
30453 .code
30454 deny   condition = ${if isip4{$sender_host_address}}
30455        dnslists  = some.list.example
30456 .endd
30457
30458 If an explicit key is being used for a DNS lookup and it may be an IPv6
30459 address you should specify alternate list separators for both the outer
30460 (DNS list name) list and inner (lookup keys) list:
30461 .code
30462        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30463 .endd
30464
30465 .section "Rate limiting incoming messages" "SECTratelimiting"
30466 .cindex "rate limiting" "client sending"
30467 .cindex "limiting client sending rates"
30468 .oindex "&%smtp_ratelimit_*%&"
30469 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30470 which clients can send email. This is more powerful than the
30471 &%smtp_ratelimit_*%& options, because those options control the rate of
30472 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30473 works across all connections (concurrent and sequential) from the same client
30474 host. The syntax of the &%ratelimit%& condition is:
30475 .display
30476 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30477 .endd
30478 If the average client sending rate is less than &'m'& messages per time
30479 period &'p'& then the condition is false; otherwise it is true.
30480
30481 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30482 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30483 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30484 of &'p'&.
30485
30486 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30487 time interval, for example, &`8h`& for eight hours. A larger time constant
30488 means that it takes Exim longer to forget a client's past behaviour. The
30489 parameter &'m'& is the maximum number of messages that a client is permitted to
30490 send in each time interval. It also specifies the number of messages permitted
30491 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30492 constant, you can allow a client to send more messages in a burst without
30493 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30494 both small, messages must be sent at an even rate.
30495
30496 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30497 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30498 when deploying the &%ratelimit%& ACL condition. The script prints usage
30499 instructions when it is run with no arguments.
30500
30501 The key is used to look up the data for calculating the client's average
30502 sending rate. This data is stored in Exim's spool directory, alongside the
30503 retry and other hints databases. The default key is &$sender_host_address$&,
30504 which means Exim computes the sending rate of each client host IP address.
30505 By changing the key you can change how Exim identifies clients for the purpose
30506 of ratelimiting. For example, to limit the sending rate of each authenticated
30507 user, independent of the computer they are sending from, set the key to
30508 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30509 example, &$authenticated_id$& is only meaningful if the client has
30510 authenticated (which you can check with the &%authenticated%& ACL condition).
30511
30512 The lookup key does not have to identify clients: If you want to limit the
30513 rate at which a recipient receives messages, you can use the key
30514 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30515 ACL.
30516
30517 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30518 specifies what Exim measures the rate of, for example messages or recipients
30519 or bytes. You can adjust the measurement using the &%unique=%& and/or
30520 &%count=%& options. You can also control when Exim updates the recorded rate
30521 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30522 separated by a slash, like the other parameters. They may appear in any order.
30523
30524 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30525 any options that alter the meaning of the stored data. The limit &'m'& is not
30526 stored, so you can alter the configured maximum rate and Exim will still
30527 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30528 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30529 behaviour. The lookup key is not affected by changes to the update mode and
30530 the &%count=%& option.
30531
30532
30533 .section "Ratelimit options for what is being measured" "ratoptmea"
30534 .cindex "rate limiting" "per_* options"
30535 The &%per_conn%& option limits the client's connection rate. It is not
30536 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30537 &%acl_not_smtp_start%& ACLs.
30538
30539 The &%per_mail%& option limits the client's rate of sending messages. This is
30540 the default if none of the &%per_*%& options is specified. It can be used in
30541 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30542 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30543
30544 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30545 the same ACLs as the &%per_mail%& option, though it is best to use this option
30546 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30547 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30548 in its MAIL command, which may be inaccurate or completely missing. You can
30549 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30550 in kilobytes, megabytes, or gigabytes, respectively.
30551
30552 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30553 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30554 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30555 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30556 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30557 in either case the rate limiting engine will see a message with many
30558 recipients as a large high-speed burst.
30559
30560 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30561 number of different recipients that the client has sent messages to in the
30562 last time period. That is, if the client repeatedly sends messages to the same
30563 recipient, its measured rate is not increased. This option can only be used in
30564 &%acl_smtp_rcpt%&.
30565
30566 The &%per_cmd%& option causes Exim to recompute the rate every time the
30567 condition is processed. This can be used to limit the rate of any SMTP
30568 command. If it is used in multiple ACLs it can limit the aggregate rate of
30569 multiple different commands.
30570
30571 The &%count=%& option can be used to alter how much Exim adds to the client's
30572 measured rate. For example, the &%per_byte%& option is equivalent to
30573 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30574 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30575 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30576
30577 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30578
30579
30580 .section "Ratelimit update modes" "ratoptupd"
30581 .cindex "rate limiting" "reading data without updating"
30582 You can specify one of three options with the &%ratelimit%& condition to
30583 control when its database is updated. This section describes the &%readonly%&
30584 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30585
30586 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30587 previously-computed rate to check against the limit.
30588
30589 For example, you can test the client's sending rate and deny it access (when
30590 it is too fast) in the connect ACL. If the client passes this check then it
30591 can go on to send a message, in which case its recorded rate will be updated
30592 in the MAIL ACL. Subsequent connections from the same client will check this
30593 new rate.
30594 .code
30595 acl_check_connect:
30596  deny ratelimit = 100 / 5m / readonly
30597     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30598                   (max $sender_rate_limit)
30599 # ...
30600 acl_check_mail:
30601  warn ratelimit = 100 / 5m / strict
30602     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30603                   (max $sender_rate_limit)
30604 .endd
30605
30606 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30607 processing a message then it may increase the client's measured rate more than
30608 it should. For example, this will happen if you check the &%per_rcpt%& option
30609 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30610 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30611 multiple update problems by using the &%readonly%& option on later ratelimit
30612 checks.
30613
30614 The &%per_*%& options described above do not make sense in some ACLs. If you
30615 use a &%per_*%& option in an ACL where it is not normally permitted then the
30616 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30617 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30618 next section) so you must specify the &%readonly%& option explicitly.
30619
30620
30621 .section "Ratelimit options for handling fast clients" "ratoptfast"
30622 .cindex "rate limiting" "strict and leaky modes"
30623 If a client's average rate is greater than the maximum, the rate limiting
30624 engine can react in two possible ways, depending on the presence of the
30625 &%strict%& or &%leaky%& update modes. This is independent of the other
30626 counter-measures (such as rejecting the message) that may be specified by the
30627 rest of the ACL.
30628
30629 The &%leaky%& (default) option means that the client's recorded rate is not
30630 updated if it is above the limit. The effect of this is that Exim measures the
30631 client's average rate of successfully sent email, which cannot be greater than
30632 the maximum allowed. If the client is over the limit it may suffer some
30633 counter-measures (as specified in the ACL), but it will still be able to send
30634 email at the configured maximum rate, whatever the rate of its attempts. This
30635 is generally the better choice if you have clients that retry automatically.
30636 For example, it does not prevent a sender with an over-aggressive retry rate
30637 from getting any email through.
30638
30639 The &%strict%& option means that the client's recorded rate is always
30640 updated. The effect of this is that Exim measures the client's average rate
30641 of attempts to send email, which can be much higher than the maximum it is
30642 actually allowed. If the client is over the limit it may be subjected to
30643 counter-measures by the ACL. It must slow down and allow sufficient time to
30644 pass that its computed rate falls below the maximum before it can send email
30645 again. The time (the number of smoothing periods) it must wait and not
30646 attempt to send mail can be calculated with this formula:
30647 .code
30648         ln(peakrate/maxrate)
30649 .endd
30650
30651
30652 .section "Limiting the rate of different events" "ratoptuniq"
30653 .cindex "rate limiting" "counting unique events"
30654 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30655 rate of different events. For example, the &%per_addr%& option uses this
30656 mechanism to count the number of different recipients that the client has
30657 sent messages to in the last time period; it is equivalent to
30658 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30659 measure the rate that a client uses different sender addresses with the
30660 options &`per_mail/unique=$sender_address`&.
30661
30662 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30663 has seen for that key. The whole set is thrown away when it is older than the
30664 rate smoothing period &'p'&, so each different event is counted at most once
30665 per period. In the &%leaky%& update mode, an event that causes the client to
30666 go over the limit is not added to the set, in the same way that the client's
30667 recorded rate is not updated in the same situation.
30668
30669 When you combine the &%unique=%& and &%readonly%& options, the specific
30670 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30671 rate.
30672
30673 The &%unique=%& mechanism needs more space in the ratelimit database than the
30674 other &%ratelimit%& options in order to store the event set. The number of
30675 unique values is potentially as large as the rate limit, so the extra space
30676 required increases with larger limits.
30677
30678 The uniqueification is not perfect: there is a small probability that Exim
30679 will think a new event has happened before. If the sender's rate is less than
30680 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30681 the measured rate can go above the limit, in which case Exim may under-count
30682 events by a significant margin. Fortunately, if the rate is high enough (2.7
30683 times the limit) that the false positive rate goes above 9%, then Exim will
30684 throw away the over-full event set before the measured rate falls below the
30685 limit. Therefore the only harm should be that exceptionally high sending rates
30686 are logged incorrectly; any countermeasures you configure will be as effective
30687 as intended.
30688
30689
30690 .section "Using rate limiting" "useratlim"
30691 Exim's other ACL facilities are used to define what counter-measures are taken
30692 when the rate limit is exceeded. This might be anything from logging a warning
30693 (for example, while measuring existing sending rates in order to define
30694 policy), through time delays to slow down fast senders, up to rejecting the
30695 message. For example:
30696 .code
30697 # Log all senders' rates
30698 warn ratelimit = 0 / 1h / strict
30699      log_message = Sender rate $sender_rate / $sender_rate_period
30700
30701 # Slow down fast senders; note the need to truncate $sender_rate
30702 # at the decimal point.
30703 warn ratelimit = 100 / 1h / per_rcpt / strict
30704      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30705                    $sender_rate_limit }s
30706
30707 # Keep authenticated users under control
30708 deny authenticated = *
30709      ratelimit = 100 / 1d / strict / $authenticated_id
30710
30711 # System-wide rate limit
30712 defer message = Sorry, too busy. Try again later.
30713      ratelimit = 10 / 1s / $primary_hostname
30714
30715 # Restrict incoming rate from each host, with a default
30716 # set using a macro and special cases looked up in a table.
30717 defer message = Sender rate exceeds $sender_rate_limit \
30718                messages per $sender_rate_period
30719      ratelimit = ${lookup {$sender_host_address} \
30720                    cdb {DB/ratelimits.cdb} \
30721                    {$value} {RATELIMIT} }
30722 .endd
30723 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30724 especially with the &%per_rcpt%& option, you may suffer from a performance
30725 bottleneck caused by locking on the ratelimit hints database. Apart from
30726 making your ACLs less complicated, you can reduce the problem by using a
30727 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30728 this means that Exim will lose its hints data after a reboot (including retry
30729 hints, the callout cache, and ratelimit data).
30730
30731
30732
30733 .section "Address verification" "SECTaddressverification"
30734 .cindex "verifying address" "options for"
30735 .cindex "policy control" "address verification"
30736 Several of the &%verify%& conditions described in section
30737 &<<SECTaclconditions>>& cause addresses to be verified. Section
30738 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30739 The verification conditions can be followed by options that modify the
30740 verification process. The options are separated from the keyword and from each
30741 other by slashes, and some of them contain parameters. For example:
30742 .code
30743 verify = sender/callout
30744 verify = recipient/defer_ok/callout=10s,defer_ok
30745 .endd
30746 The first stage of address verification, which always happens, is to run the
30747 address through the routers, in &"verify mode"&. Routers can detect the
30748 difference between verification and routing for delivery, and their actions can
30749 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30750 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30751 The available options are as follows:
30752
30753 .ilist
30754 If the &%callout%& option is specified, successful routing to one or more
30755 remote hosts is followed by a &"callout"& to those hosts as an additional
30756 check. Callouts and their sub-options are discussed in the next section.
30757 .next
30758 If there is a defer error while doing verification routing, the ACL
30759 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30760 options, the condition is forced to be true instead. Note that this is a main
30761 verification option as well as a suboption for callouts.
30762 .next
30763 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30764 discusses the reporting of sender address verification failures.
30765 .next
30766 The &%success_on_redirect%& option causes verification always to succeed
30767 immediately after a successful redirection. By default, if a redirection
30768 generates just one address, that address is also verified. See further
30769 discussion in section &<<SECTredirwhilveri>>&.
30770 .endlist
30771
30772 .cindex "verifying address" "differentiating failures"
30773 .vindex "&$recipient_verify_failure$&"
30774 .vindex "&$sender_verify_failure$&"
30775 .vindex "&$acl_verify_message$&"
30776 After an address verification failure, &$acl_verify_message$& contains the
30777 error message that is associated with the failure. It can be preserved by
30778 coding like this:
30779 .code
30780 warn  !verify = sender
30781        set acl_m0 = $acl_verify_message
30782 .endd
30783 If you are writing your own custom rejection message or log message when
30784 denying access, you can use this variable to include information about the
30785 verification failure.
30786
30787 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30788 appropriate) contains one of the following words:
30789
30790 .ilist
30791 &%qualify%&: The address was unqualified (no domain), and the message
30792 was neither local nor came from an exempted host.
30793 .next
30794 &%route%&: Routing failed.
30795 .next
30796 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30797 occurred at or before the MAIL command (that is, on initial
30798 connection, HELO, or MAIL).
30799 .next
30800 &%recipient%&: The RCPT command in a callout was rejected.
30801 .next
30802 &%postmaster%&: The postmaster check in a callout was rejected.
30803 .endlist
30804
30805 The main use of these variables is expected to be to distinguish between
30806 rejections of MAIL and rejections of RCPT in callouts.
30807
30808
30809
30810
30811 .section "Callout verification" "SECTcallver"
30812 .cindex "verifying address" "by callout"
30813 .cindex "callout" "verification"
30814 .cindex "SMTP" "callout verification"
30815 For non-local addresses, routing verifies the domain, but is unable to do any
30816 checking of the local part. There are situations where some means of verifying
30817 the local part is desirable. One way this can be done is to make an SMTP
30818 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30819 a subsequent host for a recipient address, to see if the host accepts the
30820 address. We use the term &'callout'& to cover both cases. Note that for a
30821 sender address, the callback is not to the client host that is trying to
30822 deliver the message, but to one of the hosts that accepts incoming mail for the
30823 sender's domain.
30824
30825 Exim does not do callouts by default. If you want them to happen, you must
30826 request them by setting appropriate options on the &%verify%& condition, as
30827 described below. This facility should be used with care, because it can add a
30828 lot of resource usage to the cost of verifying an address. However, Exim does
30829 cache the results of callouts, which helps to reduce the cost. Details of
30830 caching are in section &<<SECTcallvercache>>&.
30831
30832 Recipient callouts are usually used only between hosts that are controlled by
30833 the same administration. For example, a corporate gateway host could use
30834 callouts to check for valid recipients on an internal mailserver. A successful
30835 callout does not guarantee that a real delivery to the address would succeed;
30836 on the other hand, a failing callout does guarantee that a delivery would fail.
30837
30838 If the &%callout%& option is present on a condition that verifies an address, a
30839 second stage of verification occurs if the address is successfully routed to
30840 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30841 &(manualroute)& router, where the router specifies the hosts. However, if a
30842 router that does not set up hosts routes to an &(smtp)& transport with a
30843 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30844 &%hosts_override%& set, its hosts are always used, whether or not the router
30845 supplies a host list.
30846 Callouts are only supported on &(smtp)& transports.
30847
30848 The port that is used is taken from the transport, if it is specified and is a
30849 remote transport. (For routers that do verification only, no transport need be
30850 specified.) Otherwise, the default SMTP port is used. If a remote transport
30851 specifies an outgoing interface, this is used; otherwise the interface is not
30852 specified. Likewise, the text that is used for the HELO command is taken from
30853 the transport's &%helo_data%& option; if there is no transport, the value of
30854 &$smtp_active_hostname$& is used.
30855
30856 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30857 test whether a bounce message could be delivered to the sender address. The
30858 following SMTP commands are sent:
30859 .display
30860 &`HELO `&<&'local host name'&>
30861 &`MAIL FROM:<>`&
30862 &`RCPT TO:`&<&'the address to be tested'&>
30863 &`QUIT`&
30864 .endd
30865 LHLO is used instead of HELO if the transport's &%protocol%& option is
30866 set to &"lmtp"&.
30867
30868 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30869 settings.
30870
30871 A recipient callout check is similar. By default, it also uses an empty address
30872 for the sender. This default is chosen because most hosts do not make use of
30873 the sender address when verifying a recipient. Using the same address means
30874 that a single cache entry can be used for each recipient. Some sites, however,
30875 do make use of the sender address when verifying. These are catered for by the
30876 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30877
30878 If the response to the RCPT command is a 2&'xx'& code, the verification
30879 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30880 Exim tries the next host, if any. If there is a problem with all the remote
30881 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30882 &%callout%& option is given, in which case the condition is forced to succeed.
30883
30884 .cindex "SMTP" "output flushing, disabling for callout"
30885 A callout may take a little time. For this reason, Exim normally flushes SMTP
30886 output before performing a callout in an ACL, to avoid unexpected timeouts in
30887 clients when the SMTP PIPELINING extension is in use. The flushing can be
30888 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30889
30890
30891
30892
30893 .section "Additional parameters for callouts" "CALLaddparcall"
30894 .cindex "callout" "additional parameters for"
30895 The &%callout%& option can be followed by an equals sign and a number of
30896 optional parameters, separated by commas. For example:
30897 .code
30898 verify = recipient/callout=10s,defer_ok
30899 .endd
30900 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30901 separate verify options, is retained for backwards compatibility, but is now
30902 deprecated. The additional parameters for &%callout%& are as follows:
30903
30904
30905 .vlist
30906 .vitem <&'a&~time&~interval'&>
30907 .cindex "callout" "timeout, specifying"
30908 This specifies the timeout that applies for the callout attempt to each host.
30909 For example:
30910 .code
30911 verify = sender/callout=5s
30912 .endd
30913 The default is 30 seconds. The timeout is used for each response from the
30914 remote host. It is also used for the initial connection, unless overridden by
30915 the &%connect%& parameter.
30916
30917
30918 .vitem &*connect&~=&~*&<&'time&~interval'&>
30919 .cindex "callout" "connection timeout, specifying"
30920 This parameter makes it possible to set a different (usually smaller) timeout
30921 for making the SMTP connection. For example:
30922 .code
30923 verify = sender/callout=5s,connect=1s
30924 .endd
30925 If not specified, this timeout defaults to the general timeout value.
30926
30927 .vitem &*defer_ok*&
30928 .cindex "callout" "defer, action on"
30929 When this parameter is present, failure to contact any host, or any other kind
30930 of temporary error, is treated as success by the ACL. However, the cache is not
30931 updated in this circumstance.
30932
30933 .vitem &*fullpostmaster*&
30934 .cindex "callout" "full postmaster check"
30935 This operates like the &%postmaster%& option (see below), but if the check for
30936 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30937 accordance with the specification in RFC 2821. The RFC states that the
30938 unqualified address &'postmaster'& should be accepted.
30939
30940
30941 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30942 .cindex "callout" "sender when verifying header"
30943 When verifying addresses in header lines using the &%header_sender%&
30944 verification option, Exim behaves by default as if the addresses are envelope
30945 sender addresses from a message. Callout verification therefore tests to see
30946 whether a bounce message could be delivered, by using an empty address in the
30947 MAIL command. However, it is arguable that these addresses might never be used
30948 as envelope senders, and could therefore justifiably reject bounce messages
30949 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30950 address to use in the MAIL command. For example:
30951 .code
30952 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30953 .endd
30954 This parameter is available only for the &%header_sender%& verification option.
30955
30956
30957 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30958 .cindex "callout" "overall timeout, specifying"
30959 This parameter sets an overall timeout for performing a callout verification.
30960 For example:
30961 .code
30962 verify = sender/callout=5s,maxwait=30s
30963 .endd
30964 This timeout defaults to four times the callout timeout for individual SMTP
30965 commands. The overall timeout applies when there is more than one host that can
30966 be tried. The timeout is checked before trying the next host. This prevents
30967 very long delays if there are a large number of hosts and all are timing out
30968 (for example, when network connections are timing out).
30969
30970
30971 .vitem &*no_cache*&
30972 .cindex "callout" "cache, suppressing"
30973 .cindex "caching callout, suppressing"
30974 When this parameter is given, the callout cache is neither read nor updated.
30975
30976 .vitem &*postmaster*&
30977 .cindex "callout" "postmaster; checking"
30978 When this parameter is set, a successful callout check is followed by a similar
30979 check for the local part &'postmaster'& at the same domain. If this address is
30980 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30981 the postmaster check is recorded in a cache record; if it is a failure, this is
30982 used to fail subsequent callouts for the domain without a connection being
30983 made, until the cache record expires.
30984
30985 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30986 The postmaster check uses an empty sender in the MAIL command by default.
30987 You can use this parameter to do a postmaster check using a different address.
30988 For example:
30989 .code
30990 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30991 .endd
30992 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30993 one overrides. The &%postmaster%& parameter is equivalent to this example:
30994 .code
30995 require  verify = sender/callout=postmaster_mailfrom=
30996 .endd
30997 &*Warning*&: The caching arrangements for postmaster checking do not take
30998 account of the sender address. It is assumed that either the empty address or
30999 a fixed non-empty address will be used. All that Exim remembers is that the
31000 postmaster check for the domain succeeded or failed.
31001
31002
31003 .vitem &*random*&
31004 .cindex "callout" "&""random""& check"
31005 When this parameter is set, before doing the normal callout check, Exim does a
31006 check for a &"random"& local part at the same domain. The local part is not
31007 really random &-- it is defined by the expansion of the option
31008 &%callout_random_local_part%&, which defaults to
31009 .code
31010 $primary_hostname-$tod_epoch-testing
31011 .endd
31012 The idea here is to try to determine whether the remote host accepts all local
31013 parts without checking. If it does, there is no point in doing callouts for
31014 specific local parts. If the &"random"& check succeeds, the result is saved in
31015 a cache record, and used to force the current and subsequent callout checks to
31016 succeed without a connection being made, until the cache record expires.
31017
31018 .vitem &*use_postmaster*&
31019 .cindex "callout" "sender for recipient check"
31020 This parameter applies to recipient callouts only. For example:
31021 .code
31022 deny  !verify = recipient/callout=use_postmaster
31023 .endd
31024 .vindex "&$qualify_domain$&"
31025 It causes a non-empty postmaster address to be used in the MAIL command when
31026 performing the callout for the recipient, and also for a &"random"& check if
31027 that is configured. The local part of the address is &`postmaster`& and the
31028 domain is the contents of &$qualify_domain$&.
31029
31030 .vitem &*use_sender*&
31031 This option applies to recipient callouts only. For example:
31032 .code
31033 require  verify = recipient/callout=use_sender
31034 .endd
31035 It causes the message's actual sender address to be used in the MAIL
31036 command when performing the callout, instead of an empty address. There is no
31037 need to use this option unless you know that the called hosts make use of the
31038 sender when checking recipients. If used indiscriminately, it reduces the
31039 usefulness of callout caching.
31040
31041 .new
31042 .vitem &*hold*&
31043 This option applies to recipient callouts only. For example:
31044 .code
31045 require  verify = recipient/callout=use_sender,hold
31046 .endd
31047 It causes the connection to be helod open and used for any further recipients
31048 and for eventual delivery (should that be done quickly).
31049 Doing this saves on TCP and SMTP startup costs, and TLS costs also
31050 when that is used for the connections.
31051 The advantage is only gained if there are no callout cache hits
31052 (which could be enforced by the no_cache option),
31053 if the use_sender option is used,
31054 if neither the random nor the use_postmaster option is used,
31055 and if no other callouts intervene.
31056 .wen
31057 .endlist
31058
31059 If you use any of the parameters that set a non-empty sender for the MAIL
31060 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
31061 &%use_sender%&), you should think about possible loops. Recipient checking is
31062 usually done between two hosts that are under the same management, and the host
31063 that receives the callouts is not normally configured to do callouts itself.
31064 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
31065 these circumstances.
31066
31067 However, if you use a non-empty sender address for a callout to an arbitrary
31068 host, there is the likelihood that the remote host will itself initiate a
31069 callout check back to your host. As it is checking what appears to be a message
31070 sender, it is likely to use an empty address in MAIL, thus avoiding a
31071 callout loop. However, to be on the safe side it would be best to set up your
31072 own ACLs so that they do not do sender verification checks when the recipient
31073 is the address you use for header sender or postmaster callout checking.
31074
31075 Another issue to think about when using non-empty senders for callouts is
31076 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
31077 by the sender/recipient combination; thus, for any given recipient, many more
31078 actual callouts are performed than when an empty sender or postmaster is used.
31079
31080
31081
31082
31083 .section "Callout caching" "SECTcallvercache"
31084 .cindex "hints database" "callout cache"
31085 .cindex "callout" "cache, description of"
31086 .cindex "caching" "callout"
31087 Exim caches the results of callouts in order to reduce the amount of resources
31088 used, unless you specify the &%no_cache%& parameter with the &%callout%&
31089 option. A hints database called &"callout"& is used for the cache. Two
31090 different record types are used: one records the result of a callout check for
31091 a specific address, and the other records information that applies to the
31092 entire domain (for example, that it accepts the local part &'postmaster'&).
31093
31094 When an original callout fails, a detailed SMTP error message is given about
31095 the failure. However, for subsequent failures use the cache data, this message
31096 is not available.
31097
31098 The expiry times for negative and positive address cache records are
31099 independent, and can be set by the global options &%callout_negative_expire%&
31100 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
31101
31102 If a host gives a negative response to an SMTP connection, or rejects any
31103 commands up to and including
31104 .code
31105 MAIL FROM:<>
31106 .endd
31107 (but not including the MAIL command with a non-empty address),
31108 any callout attempt is bound to fail. Exim remembers such failures in a
31109 domain cache record, which it uses to fail callouts for the domain without
31110 making new connections, until the domain record times out. There are two
31111 separate expiry times for domain cache records:
31112 &%callout_domain_negative_expire%& (default 3h) and
31113 &%callout_domain_positive_expire%& (default 7d).
31114
31115 Domain records expire when the negative expiry time is reached if callouts
31116 cannot be made for the domain, or if the postmaster check failed.
31117 Otherwise, they expire when the positive expiry time is reached. This
31118 ensures that, for example, a host that stops accepting &"random"& local parts
31119 will eventually be noticed.
31120
31121 The callout caching mechanism is based on the domain of the address that is
31122 being tested. If the domain routes to several hosts, it is assumed that their
31123 behaviour will be the same.
31124
31125
31126
31127 .section "Sender address verification reporting" "SECTsenaddver"
31128 .cindex "verifying" "suppressing error details"
31129 See section &<<SECTaddressverification>>& for a general discussion of
31130 verification. When sender verification fails in an ACL, the details of the
31131 failure are given as additional output lines before the 550 response to the
31132 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31133 you might see:
31134 .code
31135 MAIL FROM:<xyz@abc.example>
31136 250 OK
31137 RCPT TO:<pqr@def.example>
31138 550-Verification failed for <xyz@abc.example>
31139 550-Called:   192.168.34.43
31140 550-Sent:     RCPT TO:<xyz@abc.example>
31141 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31142 550 Sender verification failed
31143 .endd
31144 If more than one RCPT command fails in the same way, the details are given
31145 only for the first of them. However, some administrators do not want to send
31146 out this much information. You can suppress the details by adding
31147 &`/no_details`& to the ACL statement that requests sender verification. For
31148 example:
31149 .code
31150 verify = sender/no_details
31151 .endd
31152
31153 .section "Redirection while verifying" "SECTredirwhilveri"
31154 .cindex "verifying" "redirection while"
31155 .cindex "address redirection" "while verifying"
31156 A dilemma arises when a local address is redirected by aliasing or forwarding
31157 during verification: should the generated addresses themselves be verified,
31158 or should the successful expansion of the original address be enough to verify
31159 it? By default, Exim takes the following pragmatic approach:
31160
31161 .ilist
31162 When an incoming address is redirected to just one child address, verification
31163 continues with the child address, and if that fails to verify, the original
31164 verification also fails.
31165 .next
31166 When an incoming address is redirected to more than one child address,
31167 verification does not continue. A success result is returned.
31168 .endlist
31169
31170 This seems the most reasonable behaviour for the common use of aliasing as a
31171 way of redirecting different local parts to the same mailbox. It means, for
31172 example, that a pair of alias entries of the form
31173 .code
31174 A.Wol:   aw123
31175 aw123:   :fail: Gone away, no forwarding address
31176 .endd
31177 work as expected, with both local parts causing verification failure. When a
31178 redirection generates more than one address, the behaviour is more like a
31179 mailing list, where the existence of the alias itself is sufficient for
31180 verification to succeed.
31181
31182 It is possible, however, to change the default behaviour so that all successful
31183 redirections count as successful verifications, however many new addresses are
31184 generated. This is specified by the &%success_on_redirect%& verification
31185 option. For example:
31186 .code
31187 require verify = recipient/success_on_redirect/callout=10s
31188 .endd
31189 In this example, verification succeeds if a router generates a new address, and
31190 the callout does not occur, because no address was routed to a remote host.
31191
31192 When verification is being tested via the &%-bv%& option, the treatment of
31193 redirections is as just described, unless the &%-v%& or any debugging option is
31194 also specified. In that case, full verification is done for every generated
31195 address and a report is output for each of them.
31196
31197
31198
31199 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31200 .cindex "CSA" "verifying"
31201 Client SMTP Authorization is a system that allows a site to advertise
31202 which machines are and are not permitted to send email. This is done by placing
31203 special SRV records in the DNS; these are looked up using the client's HELO
31204 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31205 Authorization checks in Exim are performed by the ACL condition:
31206 .code
31207 verify = csa
31208 .endd
31209 This fails if the client is not authorized. If there is a DNS problem, or if no
31210 valid CSA SRV record is found, or if the client is authorized, the condition
31211 succeeds. These three cases can be distinguished using the expansion variable
31212 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31213 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31214 be likely to cause problems for legitimate email.
31215
31216 The error messages produced by the CSA code include slightly more
31217 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31218 looking up the CSA SRV record, or problems looking up the CSA target
31219 address record. There are four reasons for &$csa_status$& being &"fail"&:
31220
31221 .ilist
31222 The client's host name is explicitly not authorized.
31223 .next
31224 The client's IP address does not match any of the CSA target IP addresses.
31225 .next
31226 The client's host name is authorized but it has no valid target IP addresses
31227 (for example, the target's addresses are IPv6 and the client is using IPv4).
31228 .next
31229 The client's host name has no CSA SRV record but a parent domain has asserted
31230 that all subdomains must be explicitly authorized.
31231 .endlist
31232
31233 The &%csa%& verification condition can take an argument which is the domain to
31234 use for the DNS query. The default is:
31235 .code
31236 verify = csa/$sender_helo_name
31237 .endd
31238 This implementation includes an extension to CSA. If the query domain
31239 is an address literal such as [192.0.2.95], or if it is a bare IP
31240 address, Exim searches for CSA SRV records in the reverse DNS as if
31241 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31242 meaningful to say:
31243 .code
31244 verify = csa/$sender_host_address
31245 .endd
31246 In fact, this is the check that Exim performs if the client does not say HELO.
31247 This extension can be turned off by setting the main configuration option
31248 &%dns_csa_use_reverse%& to be false.
31249
31250 If a CSA SRV record is not found for the domain itself, a search
31251 is performed through its parent domains for a record which might be
31252 making assertions about subdomains. The maximum depth of this search is limited
31253 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31254 default. Exim does not look for CSA SRV records in a top level domain, so the
31255 default settings handle HELO domains as long as seven
31256 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31257 of legitimate HELO domains.
31258
31259 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31260 direct SRV lookups, this is not sufficient because of the extra parent domain
31261 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31262 addresses into lookups in the reverse DNS space. The result of a successful
31263 lookup such as:
31264 .code
31265 ${lookup dnsdb {csa=$sender_helo_name}}
31266 .endd
31267 has two space-separated fields: an authorization code and a target host name.
31268 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31269 authorization required but absent, or &"?"& for unknown.
31270
31271
31272
31273
31274 .section "Bounce address tag validation" "SECTverifyPRVS"
31275 .cindex "BATV, verifying"
31276 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31277 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31278 Genuine incoming bounce messages should therefore always be addressed to
31279 recipients that have a valid tag. This scheme is a way of detecting unwanted
31280 bounce messages caused by sender address forgeries (often called &"collateral
31281 spam"&), because the recipients of such messages do not include valid tags.
31282
31283 There are two expansion items to help with the implementation of the BATV
31284 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31285 the original envelope sender address by using a simple key to add a hash of the
31286 address and some time-based randomizing information. The &%prvs%& expansion
31287 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31288 The syntax of these expansion items is described in section
31289 &<<SECTexpansionitems>>&.
31290
31291 As an example, suppose the secret per-address keys are stored in an MySQL
31292 database. A query to look up the key for an address could be defined as a macro
31293 like this:
31294 .code
31295 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31296                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31297                 }{$value}}
31298 .endd
31299 Suppose also that the senders who make use of BATV are defined by an address
31300 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31301 use this:
31302 .code
31303 # Bounces: drop unsigned addresses for BATV senders
31304 deny message = This address does not send an unsigned reverse path
31305      senders = :
31306      recipients = +batv_senders
31307
31308 # Bounces: In case of prvs-signed address, check signature.
31309 deny message = Invalid reverse path signature.
31310      senders = :
31311      condition  = ${prvscheck {$local_part@$domain}\
31312                   {PRVSCHECK_SQL}{1}}
31313      !condition = $prvscheck_result
31314 .endd
31315 The first statement rejects recipients for bounce messages that are addressed
31316 to plain BATV sender addresses, because it is known that BATV senders do not
31317 send out messages with plain sender addresses. The second statement rejects
31318 recipients that are prvs-signed, but with invalid signatures (either because
31319 the key is wrong, or the signature has timed out).
31320
31321 A non-prvs-signed address is not rejected by the second statement, because the
31322 &%prvscheck%& expansion yields an empty string if its first argument is not a
31323 prvs-signed address, thus causing the &%condition%& condition to be false. If
31324 the first argument is a syntactically valid prvs-signed address, the yield is
31325 the third string (in this case &"1"&), whether or not the cryptographic and
31326 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31327 of the checks (empty for failure, &"1"& for success).
31328
31329 There is one more issue you must consider when implementing prvs-signing:
31330 you have to ensure that the routers accept prvs-signed addresses and
31331 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31332 router to remove the signature with a configuration along these lines:
31333 .code
31334 batv_redirect:
31335   driver = redirect
31336   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31337 .endd
31338 This works because, if the third argument of &%prvscheck%& is empty, the result
31339 of the expansion of a prvs-signed address is the decoded value of the original
31340 address. This router should probably be the first of your routers that handles
31341 local addresses.
31342
31343 To create BATV-signed addresses in the first place, a transport of this form
31344 can be used:
31345 .code
31346 external_smtp_batv:
31347   driver = smtp
31348   return_path = ${prvs {$return_path} \
31349                        {${lookup mysql{SELECT \
31350                        secret FROM batv_prvs WHERE \
31351                        sender='${quote_mysql:$sender_address}'} \
31352                        {$value}fail}}}
31353 .endd
31354 If no key can be found for the existing return path, no signing takes place.
31355
31356
31357
31358 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31359 .cindex "&ACL;" "relay control"
31360 .cindex "relaying" "control by ACL"
31361 .cindex "policy control" "relay control"
31362 An MTA is said to &'relay'& a message if it receives it from some host and
31363 delivers it directly to another host as a result of a remote address contained
31364 within it. Redirecting a local address via an alias or forward file and then
31365 passing the message on to another host is not relaying,
31366 .cindex "&""percent hack""&"
31367 but a redirection as a result of the &"percent hack"& is.
31368
31369 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31370 A host which is acting as a gateway or an MX backup is concerned with incoming
31371 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31372 a host which is acting as a smart host for a number of clients is concerned
31373 with outgoing relaying from those clients to the Internet at large. Often the
31374 same host is fulfilling both functions,
31375 . ///
31376 . as illustrated in the diagram below,
31377 . ///
31378 but in principle these two kinds of relaying are entirely independent. What is
31379 not wanted is the transmission of mail from arbitrary remote hosts through your
31380 system to arbitrary domains.
31381
31382
31383 You can implement relay control by means of suitable statements in the ACL that
31384 runs for each RCPT command. For convenience, it is often easiest to use
31385 Exim's named list facility to define the domains and hosts involved. For
31386 example, suppose you want to do the following:
31387
31388 .ilist
31389 Deliver a number of domains to mailboxes on the local host (or process them
31390 locally in some other way). Let's say these are &'my.dom1.example'& and
31391 &'my.dom2.example'&.
31392 .next
31393 Relay mail for a number of other domains for which you are the secondary MX.
31394 These might be &'friend1.example'& and &'friend2.example'&.
31395 .next
31396 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31397 Suppose your LAN is 192.168.45.0/24.
31398 .endlist
31399
31400
31401 In the main part of the configuration, you put the following definitions:
31402 .code
31403 domainlist local_domains    = my.dom1.example : my.dom2.example
31404 domainlist relay_to_domains = friend1.example : friend2.example
31405 hostlist   relay_from_hosts = 192.168.45.0/24
31406 .endd
31407 Now you can use these definitions in the ACL that is run for every RCPT
31408 command:
31409 .code
31410 acl_check_rcpt:
31411   accept domains = +local_domains : +relay_to_domains
31412   accept hosts   = +relay_from_hosts
31413 .endd
31414 The first statement accepts any RCPT command that contains an address in
31415 the local or relay domains. For any other domain, control passes to the second
31416 statement, which accepts the command only if it comes from one of the relay
31417 hosts. In practice, you will probably want to make your ACL more sophisticated
31418 than this, for example, by including sender and recipient verification. The
31419 default configuration includes a more comprehensive example, which is described
31420 in chapter &<<CHAPdefconfil>>&.
31421
31422
31423
31424 .section "Checking a relay configuration" "SECTcheralcon"
31425 .cindex "relaying" "checking control of"
31426 You can check the relay characteristics of your configuration in the same way
31427 that you can test any ACL behaviour for an incoming SMTP connection, by using
31428 the &%-bh%& option to run a fake SMTP session with which you interact.
31429 .ecindex IIDacl
31430
31431
31432
31433 . ////////////////////////////////////////////////////////////////////////////
31434 . ////////////////////////////////////////////////////////////////////////////
31435
31436 .chapter "Content scanning at ACL time" "CHAPexiscan"
31437 .scindex IIDcosca "content scanning" "at ACL time"
31438 The extension of Exim to include content scanning at ACL time, formerly known
31439 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31440 was integrated into the main source for Exim release 4.50, and Tom continues to
31441 maintain it. Most of the wording of this chapter is taken from Tom's
31442 specification.
31443
31444 It is also possible to scan the content of messages at other times. The
31445 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31446 scanning after all the ACLs have run. A transport filter can be used to scan
31447 messages at delivery time (see the &%transport_filter%& option, described in
31448 chapter &<<CHAPtransportgeneric>>&).
31449
31450 If you want to include the ACL-time content-scanning features when you compile
31451 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31452 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31453
31454 .ilist
31455 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31456 for all MIME parts for SMTP and non-SMTP messages, respectively.
31457 .next
31458 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31459 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31460 run at the end of message reception (the &%acl_smtp_data%& ACL).
31461 .next
31462 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31463 of messages, or parts of messages, for debugging purposes.
31464 .next
31465 Additional expansion variables that are set in the new ACL and by the new
31466 conditions.
31467 .next
31468 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31469 .endlist
31470
31471 Content-scanning is continually evolving, and new features are still being
31472 added. While such features are still unstable and liable to incompatible
31473 changes, they are made available in Exim by setting options whose names begin
31474 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31475 this manual. You can find out about them by reading the file called
31476 &_doc/experimental.txt_&.
31477
31478 All the content-scanning facilities work on a MBOX copy of the message that is
31479 temporarily created in a file called:
31480 .display
31481 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31482 .endd
31483 The &_.eml_& extension is a friendly hint to virus scanners that they can
31484 expect an MBOX-like structure inside that file. The file is created when the
31485 first content scanning facility is called. Subsequent calls to content
31486 scanning conditions open the same file again. The directory is recursively
31487 removed when the &%acl_smtp_data%& ACL has finished running, unless
31488 .code
31489 control = no_mbox_unspool
31490 .endd
31491 has been encountered. When the MIME ACL decodes files, they are put into the
31492 same directory by default.
31493
31494
31495
31496 .section "Scanning for viruses" "SECTscanvirus"
31497 .cindex "virus scanning"
31498 .cindex "content scanning" "for viruses"
31499 .cindex "content scanning" "the &%malware%& condition"
31500 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31501 It supports a &"generic"& interface to scanners called via the shell, and
31502 specialized interfaces for &"daemon"& type virus scanners, which are resident
31503 in memory and thus are much faster.
31504
31505 A timeout of 2 minutes is applied to a scanner call (by default);
31506 if it expires then a defer action is taken.
31507
31508 .oindex "&%av_scanner%&"
31509 You can set the &%av_scanner%& option in the main part of the configuration
31510 to specify which scanner to use, together with any additional options that
31511 are needed. The basic syntax is as follows:
31512 .display
31513 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31514 .endd
31515 If you do not set &%av_scanner%&, it defaults to
31516 .code
31517 av_scanner = sophie:/var/run/sophie
31518 .endd
31519 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31520 before use.
31521 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31522 The following scanner types are supported in this release:
31523
31524 .vlist
31525 .vitem &%avast%&
31526 .cindex "virus scanners" "avast"
31527 This is the scanner daemon of Avast. It has been tested with Avast Core
31528 Security (currently at version 1.1.7).
31529 You can get a trial version at &url(http://www.avast.com) or for Linux
31530 at &url(http://www.avast.com/linux-server-antivirus).
31531 This scanner type takes one option,
31532 which can be either a full path to a UNIX socket,
31533 or host and port specifiers separated by white space.
31534 The host may be a name or an IP address; the port is either a
31535 single number or a pair of numbers with a dash between.
31536 Any further options are given, on separate lines,
31537 to the daemon as options before the main scan command.
31538 For example:
31539 .code
31540 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31541 av_scanner = avast:192.168.2.22 5036
31542 .endd
31543 If you omit the argument, the default path
31544 &_/var/run/avast/scan.sock_&
31545 is used.
31546 If you use a remote host,
31547 you need to make Exim's spool directory available to it,
31548 as the scanner is passed a file path, not file contents.
31549 For information about available commands and their options you may use
31550 .code
31551 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31552     FLAGS
31553     SENSITIVITY
31554     PACK
31555 .endd
31556
31557
31558 .vitem &%aveserver%&
31559 .cindex "virus scanners" "Kaspersky"
31560 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31561 at &url(http://www.kaspersky.com). This scanner type takes one option,
31562 which is the path to the daemon's UNIX socket. The default is shown in this
31563 example:
31564 .code
31565 av_scanner = aveserver:/var/run/aveserver
31566 .endd
31567
31568
31569 .vitem &%clamd%&
31570 .cindex "virus scanners" "clamd"
31571 This daemon-type scanner is GPL and free. You can get it at
31572 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31573 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31574 in the MIME ACL. This is no longer believed to be necessary.
31575
31576 The options are a list of server specifiers, which may be
31577 a UNIX socket specification,
31578 a TCP socket specification,
31579 or a (global) option.
31580
31581 A socket specification consists of a space-separated list.
31582 For a Unix socket the first element is a full path for the socket,
31583 for a TCP socket the first element is the IP address
31584 and the second a port number,
31585 Any further elements are per-server (non-global) options.
31586 These per-server options are supported:
31587 .code
31588 retry=<timespec>        Retry on connect fail
31589 .endd
31590
31591 The &`retry`& option specifies a time after which a single retry for
31592 a failed connect is made.  The default is to not retry.
31593
31594 If a Unix socket file is specified, only one server is supported.
31595
31596 Examples:
31597 .code
31598 av_scanner = clamd:/opt/clamd/socket
31599 av_scanner = clamd:192.0.2.3 1234
31600 av_scanner = clamd:192.0.2.3 1234:local
31601 av_scanner = clamd:192.0.2.3 1234 retry=10s
31602 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31603 .endd
31604 If the value of av_scanner points to a UNIX socket file or contains the
31605 &`local`&
31606 option, then the ClamAV interface will pass a filename containing the data
31607 to be scanned, which will should normally result in less I/O happening and be
31608 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31609 Exim does not assume that there is a common filesystem with the remote host.
31610 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31611 you be running a version of ClamAV prior to 0.95.
31612
31613 The final example shows that multiple TCP targets can be specified.  Exim will
31614 randomly use one for each incoming email (i.e. it load balances them).  Note
31615 that only TCP targets may be used if specifying a list of scanners; a UNIX
31616 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31617 unavailable, Exim will try the remaining one(s) until it finds one that works.
31618 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31619 not keep track of scanner state between multiple messages, and the scanner
31620 selection is random, so the message will get logged in the mainlog for each
31621 email that the down scanner gets chosen first (message wrapped to be readable):
31622 .code
31623 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31624    clamd: connection to localhost, port 3310 failed
31625    (Connection refused)
31626 .endd
31627
31628 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31629 contributing the code for this scanner.
31630
31631 .vitem &%cmdline%&
31632 .cindex "virus scanners" "command line interface"
31633 This is the keyword for the generic command line scanner interface. It can be
31634 used to attach virus scanners that are invoked from the shell. This scanner
31635 type takes 3 mandatory options:
31636
31637 .olist
31638 The full path and name of the scanner binary, with all command line options,
31639 and a placeholder (&`%s`&) for the directory to scan.
31640
31641 .next
31642 A regular expression to match against the STDOUT and STDERR output of the
31643 virus scanner. If the expression matches, a virus was found. You must make
31644 absolutely sure that this expression matches on &"virus found"&. This is called
31645 the &"trigger"& expression.
31646
31647 .next
31648 Another regular expression, containing exactly one pair of parentheses, to
31649 match the name of the virus found in the scanners output. This is called the
31650 &"name"& expression.
31651 .endlist olist
31652
31653 For example, Sophos Sweep reports a virus on a line like this:
31654 .code
31655 Virus 'W32/Magistr-B' found in file ./those.bat
31656 .endd
31657 For the trigger expression, we can match the phrase &"found in file"&. For the
31658 name expression, we want to extract the W32/Magistr-B string, so we can match
31659 for the single quotes left and right of it. Altogether, this makes the
31660 configuration setting:
31661 .code
31662 av_scanner = cmdline:\
31663              /path/to/sweep -ss -all -rec -archive %s:\
31664              found in file:'(.+)'
31665 .endd
31666 .vitem &%drweb%&
31667 .cindex "virus scanners" "DrWeb"
31668 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31669 takes one option,
31670 either a full path to a UNIX socket,
31671 or host and port specifiers separated by white space.
31672 The host may be a name or an IP address; the port is either a
31673 single number or a pair of numbers with a dash between.
31674 For example:
31675 .code
31676 av_scanner = drweb:/var/run/drwebd.sock
31677 av_scanner = drweb:192.168.2.20 31337
31678 .endd
31679 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31680 is used. Thanks to Alex Miller for contributing the code for this scanner.
31681
31682 .vitem &%f-protd%&
31683 .cindex "virus scanners" "f-protd"
31684 The f-protd scanner is accessed via HTTP over TCP.
31685 One argument is taken, being a space-separated hostname and port number
31686 (or port-range).
31687 For example:
31688 .code
31689 av_scanner = f-protd:localhost 10200-10204
31690 .endd
31691 If you omit the argument, the default values show above are used.
31692
31693 .new
31694 .vitem &%f-prot6d%&
31695 .cindex "virus scanners" "f-prot6d"
31696 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
31697 One argument is taken, being a space-separated hostname and port number.
31698 For example:
31699 .code
31700 av_scanner = f-prot6d:localhost 10200
31701 .endd
31702 If you omit the argument, the default values show above are used.
31703 .wen
31704
31705 .vitem &%fsecure%&
31706 .cindex "virus scanners" "F-Secure"
31707 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31708 argument which is the path to a UNIX socket. For example:
31709 .code
31710 av_scanner = fsecure:/path/to/.fsav
31711 .endd
31712 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31713 Thelmen for contributing the code for this scanner.
31714
31715 .vitem &%kavdaemon%&
31716 .cindex "virus scanners" "Kaspersky"
31717 This is the scanner daemon of Kaspersky Version 4. This version of the
31718 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31719 scanner type takes one option, which is the path to the daemon's UNIX socket.
31720 For example:
31721 .code
31722 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31723 .endd
31724 The default path is &_/var/run/AvpCtl_&.
31725
31726 .vitem &%mksd%&
31727 .cindex "virus scanners" "mksd"
31728 This is a daemon type scanner that is aimed mainly at Polish users, though some
31729 parts of documentation are now available in English. You can get it at
31730 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31731 the maximum number of processes used simultaneously to scan the attachments,
31732 provided that mksd has
31733 been run with at least the same number of child processes. For example:
31734 .code
31735 av_scanner = mksd:2
31736 .endd
31737 You can safely omit this option (the default value is 1).
31738
31739 .vitem &%sock%&
31740 .cindex "virus scanners" "simple socket-connected"
31741 This is a general-purpose way of talking to simple scanner daemons
31742 running on the local machine.
31743 There are four options:
31744 an address (which may be an IP address and port, or the path of a Unix socket),
31745 a commandline to send (may include a single %s which will be replaced with
31746 the path to the mail file to be scanned),
31747 an RE to trigger on from the returned data,
31748 and an RE to extract malware_name from the returned data.
31749 For example:
31750 .code
31751 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
31752 .endd
31753 .new
31754 Note that surrounding whitespace is stripped from each option, meaning
31755 there is no way to specify a trailing newline.
31756 The socket specifier and both regular-expressions are required.
31757 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
31758 specify an empty element to get this.
31759 .wen
31760
31761 .vitem &%sophie%&
31762 .cindex "virus scanners" "Sophos and Sophie"
31763 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31764 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31765 for this scanner type is the path to the UNIX socket that Sophie uses for
31766 client communication. For example:
31767 .code
31768 av_scanner = sophie:/tmp/sophie
31769 .endd
31770 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31771 the option.
31772 .endlist
31773
31774 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31775 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31776 ACL.
31777
31778 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31779 makes it possible to use different scanners. See further below for an example.
31780 The &%malware%& condition caches its results, so when you use it multiple times
31781 for the same message, the actual scanning process is only carried out once.
31782 However, using expandable items in &%av_scanner%& disables this caching, in
31783 which case each use of the &%malware%& condition causes a new scan of the
31784 message.
31785
31786 The &%malware%& condition takes a right-hand argument that is expanded before
31787 use and taken as a list, slash-separated by default.
31788 The first element can then be one of
31789
31790 .ilist
31791 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31792 The condition succeeds if a virus was found, and fail otherwise. This is the
31793 recommended usage.
31794 .next
31795 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31796 the condition fails immediately.
31797 .next
31798 A regular expression, in which case the message is scanned for viruses. The
31799 condition succeeds if a virus is found and its name matches the regular
31800 expression. This allows you to take special actions on certain types of virus.
31801 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31802 unless the separator is changed (in the usual way).
31803 .endlist
31804
31805 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31806 messages even if there is a problem with the virus scanner.
31807 Otherwise, such a problem causes the ACL to defer.
31808
31809 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31810 specify a non-default timeout.  The default is two minutes.
31811 For example:
31812 .code
31813 malware = * / defer_ok / tmo=10s
31814 .endd
31815 A timeout causes the ACL to defer.
31816
31817 .vindex "&$callout_address$&"
31818 When a connection is made to the scanner the expansion variable &$callout_address$&
31819 is set to record the actual address used.
31820
31821 .vindex "&$malware_name$&"
31822 When a virus is found, the condition sets up an expansion variable called
31823 &$malware_name$& that contains the name of the virus. You can use it in a
31824 &%message%& modifier that specifies the error returned to the sender, and/or in
31825 logging data.
31826
31827 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31828 imposed by your anti-virus scanner.
31829
31830 Here is a very simple scanning example:
31831 .code
31832 deny message = This message contains malware ($malware_name)
31833      malware = *
31834 .endd
31835 The next example accepts messages when there is a problem with the scanner:
31836 .code
31837 deny message = This message contains malware ($malware_name)
31838      malware = */defer_ok
31839 .endd
31840 The next example shows how to use an ACL variable to scan with both sophie and
31841 aveserver. It assumes you have set:
31842 .code
31843 av_scanner = $acl_m0
31844 .endd
31845 in the main Exim configuration.
31846 .code
31847 deny message = This message contains malware ($malware_name)
31848      set acl_m0 = sophie
31849      malware = *
31850
31851 deny message = This message contains malware ($malware_name)
31852      set acl_m0 = aveserver
31853      malware = *
31854 .endd
31855
31856
31857 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31858 .cindex "content scanning" "for spam"
31859 .cindex "spam scanning"
31860 .cindex "SpamAssassin"
31861 .cindex "Rspamd"
31862 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31863 score and a report for the message.
31864 Support is also provided for Rspamd.
31865
31866 For more information about installation and configuration of SpamAssassin or
31867 Rspamd refer to their respective websites at
31868 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31869
31870 SpamAssassin can be installed with CPAN by running:
31871 .code
31872 perl -MCPAN -e 'install Mail::SpamAssassin'
31873 .endd
31874 SpamAssassin has its own set of configuration files. Please review its
31875 documentation to see how you can tweak it. The default installation should work
31876 nicely, however.
31877
31878 .oindex "&%spamd_address%&"
31879 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31880 intend to use an instance running on the local host you do not need to set
31881 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31882 you must set the &%spamd_address%& option in the global part of the Exim
31883 configuration as follows (example):
31884 .code
31885 spamd_address = 192.168.99.45 387
31886 .endd
31887 The SpamAssassin protocol relies on a TCP half-close from the client.
31888 If your SpamAssassin client side is running a Linux system with an
31889 iptables firewall, consider setting
31890 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
31891 timeout, Exim uses when waiting for a response from the SpamAssassin
31892 server (currently defaulting to 120s).  With a lower value the Linux
31893 connection tracking may consider your half-closed connection as dead too
31894 soon.
31895
31896
31897 To use Rspamd (which by default listens on all local addresses
31898 on TCP port 11333)
31899 you should add &%variant=rspamd%& after the address/port pair, for example:
31900 .code
31901 spamd_address = 127.0.0.1 11333 variant=rspamd
31902 .endd
31903
31904 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31905 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31906 file name instead of an address/port pair:
31907 .code
31908 spamd_address = /var/run/spamd_socket
31909 .endd
31910 You can have multiple &%spamd%& servers to improve scalability. These can
31911 reside on other hardware reachable over the network. To specify multiple
31912 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31913 option, separated with colons (the separator can be changed in the usual way):
31914 .code
31915 spamd_address = 192.168.2.10 783 : \
31916                 192.168.2.11 783 : \
31917                 192.168.2.12 783
31918 .endd
31919 Up to 32 &%spamd%& servers are supported.
31920 When a server fails to respond to the connection attempt, all other
31921 servers are tried until one succeeds. If no server responds, the &%spam%&
31922 condition defers.
31923
31924 Unix and TCP socket specifications may be mixed in any order.
31925 Each element of the list is a list itself, space-separated by default
31926 and changeable in the usual way; take care to not double the separator.
31927
31928 For TCP socket specifications a host name or IP (v4 or v6, but
31929 subject to list-separator quoting rules) address can be used,
31930 and the port can be one or a dash-separated pair.
31931 In the latter case, the range is tried in strict order.
31932
31933 Elements after the first for Unix sockets, or second for TCP socket,
31934 are options.
31935 The supported options are:
31936 .code
31937 pri=<priority>      Selection priority
31938 weight=<value>      Selection bias
31939 time=<start>-<end>  Use only between these times of day
31940 retry=<timespec>    Retry on connect fail
31941 tmo=<timespec>      Connection time limit
31942 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31943 .endd
31944
31945 The &`pri`& option specifies a priority for the server within the list,
31946 higher values being tried first.
31947 The default priority is 1.
31948
31949 The &`weight`& option specifies a selection bias.
31950 Within a priority set
31951 servers are queried in a random fashion, weighted by this value.
31952 The default value for selection bias is 1.
31953
31954 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31955 in the local time zone; each element being one or more digits.
31956 Either the seconds or both minutes and seconds, plus the leading &`.`&
31957 characters, may be omitted and will be taken as zero.
31958
31959 Timeout specifications for the &`retry`& and &`tmo`& options
31960 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31961
31962 The &`tmo`& option specifies an overall timeout for communication.
31963 The default value is two minutes.
31964
31965 The &`retry`& option specifies a time after which a single retry for
31966 a failed connect is made.
31967 The default is to not retry.
31968
31969 The &%spamd_address%& variable is expanded before use if it starts with
31970 a dollar sign. In this case, the expansion may return a string that is
31971 used as the list so that multiple spamd servers can be the result of an
31972 expansion.
31973
31974 .vindex "&$callout_address$&"
31975 When a connection is made to the server the expansion variable &$callout_address$&
31976 is set to record the actual address used.
31977
31978 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31979 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31980 .code
31981 deny message = This message was classified as SPAM
31982      spam = joe
31983 .endd
31984 The right-hand side of the &%spam%& condition specifies a name. This is
31985 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31986 to scan using a specific profile, but rather use the SpamAssassin system-wide
31987 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31988 Rspamd does not use this setting. However, you must put something on the
31989 right-hand side.
31990
31991 The name allows you to use per-domain or per-user antispam profiles in
31992 principle, but this is not straightforward in practice, because a message may
31993 have multiple recipients, not necessarily all in the same domain. Because the
31994 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31995 read the contents of the message, the variables &$local_part$& and &$domain$&
31996 are not set.
31997 Careful enforcement of single-recipient messages
31998 (e.g. by responding with defer in the recipient ACL for all recipients
31999 after the first),
32000 or the use of PRDR,
32001 .cindex "PRDR" "use for per-user SpamAssassin profiles"
32002 are needed to use this feature.
32003
32004 The right-hand side of the &%spam%& condition is expanded before being used, so
32005 you can put lookups or conditions there. When the right-hand side evaluates to
32006 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
32007
32008
32009 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
32010 large ones may cause significant performance degradation. As most spam messages
32011 are quite small, it is recommended that you do not scan the big ones. For
32012 example:
32013 .code
32014 deny message = This message was classified as SPAM
32015      condition = ${if < {$message_size}{10K}}
32016      spam = nobody
32017 .endd
32018
32019 The &%spam%& condition returns true if the threshold specified in the user's
32020 SpamAssassin profile has been matched or exceeded. If you want to use the
32021 &%spam%& condition for its side effects (see the variables below), you can make
32022 it always return &"true"& by appending &`:true`& to the username.
32023
32024 .cindex "spam scanning" "returned variables"
32025 When the &%spam%& condition is run, it sets up a number of expansion
32026 variables.
32027 Except for &$spam_report$&,
32028 these variables are saved with the received message so are
32029 available for use at delivery time.
32030
32031 .vlist
32032 .vitem &$spam_score$&
32033 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
32034 for inclusion in log or reject messages.
32035
32036 .vitem &$spam_score_int$&
32037 The spam score of the message, multiplied by ten, as an integer value. For
32038 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
32039 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
32040 The integer value is useful for numeric comparisons in conditions.
32041
32042 .vitem &$spam_bar$&
32043 A string consisting of a number of &"+"& or &"-"& characters, representing the
32044 integer part of the spam score value. A spam score of 4.4 would have a
32045 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
32046 headers, since MUAs can match on such strings. The maximum length of the
32047 spam bar is 50 characters.
32048
32049 .vitem &$spam_report$&
32050 A multiline text table, containing the full SpamAssassin report for the
32051 message. Useful for inclusion in headers or reject messages.
32052 This variable is only usable in a DATA-time ACL.
32053 Beware that SpamAssassin may return non-ASCII characters, especially
32054 when running in country-specific locales, which are not legal
32055 unencoded in headers.
32056
32057 .vitem &$spam_action$&
32058 For SpamAssassin either 'reject' or 'no action' depending on the
32059 spam score versus threshold.
32060 For Rspamd, the recommended action.
32061
32062 .endlist
32063
32064 The &%spam%& condition caches its results unless expansion in
32065 spamd_address was used. If you call it again with the same user name, it
32066 does not scan again, but rather returns the same values as before.
32067
32068 The &%spam%& condition returns DEFER if there is any error while running
32069 the message through SpamAssassin or if the expansion of spamd_address
32070 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
32071 statement block), append &`/defer_ok`& to the right-hand side of the
32072 spam condition, like this:
32073 .code
32074 deny message = This message was classified as SPAM
32075      spam    = joe/defer_ok
32076 .endd
32077 This causes messages to be accepted even if there is a problem with &%spamd%&.
32078
32079 Here is a longer, commented example of the use of the &%spam%&
32080 condition:
32081 .code
32082 # put headers in all messages (no matter if spam or not)
32083 warn  spam = nobody:true
32084       add_header = X-Spam-Score: $spam_score ($spam_bar)
32085       add_header = X-Spam-Report: $spam_report
32086
32087 # add second subject line with *SPAM* marker when message
32088 # is over threshold
32089 warn  spam = nobody
32090       add_header = Subject: *SPAM* $h_Subject:
32091
32092 # reject spam at high scores (> 12)
32093 deny  message = This message scored $spam_score spam points.
32094       spam = nobody:true
32095       condition = ${if >{$spam_score_int}{120}{1}{0}}
32096 .endd
32097
32098
32099
32100 .section "Scanning MIME parts" "SECTscanmimepart"
32101 .cindex "content scanning" "MIME parts"
32102 .cindex "MIME content scanning"
32103 .oindex "&%acl_smtp_mime%&"
32104 .oindex "&%acl_not_smtp_mime%&"
32105 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
32106 each MIME part of an SMTP message, including multipart types, in the sequence
32107 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
32108 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
32109 options may both refer to the same ACL if you want the same processing in both
32110 cases.
32111
32112 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
32113 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
32114 the case of a non-SMTP message. However, a MIME ACL is called only if the
32115 message contains a &'Content-Type:'& header line. When a call to a MIME
32116 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
32117 result code is sent to the client. In the case of an SMTP message, the
32118 &%acl_smtp_data%& ACL is not called when this happens.
32119
32120 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
32121 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
32122 condition to match against the raw MIME part. You can also use the
32123 &%mime_regex%& condition to match against the decoded MIME part (see section
32124 &<<SECTscanregex>>&).
32125
32126 At the start of a MIME ACL, a number of variables are set from the header
32127 information for the relevant MIME part. These are described below. The contents
32128 of the MIME part are not by default decoded into a disk file except for MIME
32129 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
32130 part into a disk file, you can use the &%decode%& condition. The general
32131 syntax is:
32132 .display
32133 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
32134 .endd
32135 The right hand side is expanded before use. After expansion,
32136 the value can be:
32137
32138 .olist
32139 &"0"& or &"false"&, in which case no decoding is done.
32140 .next
32141 The string &"default"&. In that case, the file is put in the temporary
32142 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32143 a sequential file name consisting of the message id and a sequence number. The
32144 full path and name is available in &$mime_decoded_filename$& after decoding.
32145 .next
32146 A full path name starting with a slash. If the full name is an existing
32147 directory, it is used as a replacement for the default directory. The filename
32148 is then sequentially assigned. If the path does not exist, it is used as
32149 the full path and file name.
32150 .next
32151 If the string does not start with a slash, it is used as the
32152 filename, and the default path is then used.
32153 .endlist
32154 The &%decode%& condition normally succeeds. It is only false for syntax
32155 errors or unusual circumstances such as memory shortages. You can easily decode
32156 a file with its original, proposed filename using
32157 .code
32158 decode = $mime_filename
32159 .endd
32160 However, you should keep in mind that &$mime_filename$& might contain
32161 anything. If you place files outside of the default path, they are not
32162 automatically unlinked.
32163
32164 For RFC822 attachments (these are messages attached to messages, with a
32165 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32166 as for the primary message, only that the &$mime_is_rfc822$& expansion
32167 variable is set (see below). Attached messages are always decoded to disk
32168 before being checked, and the files are unlinked once the check is done.
32169
32170 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32171 used to match regular expressions against raw and decoded MIME parts,
32172 respectively. They are described in section &<<SECTscanregex>>&.
32173
32174 .cindex "MIME content scanning" "returned variables"
32175 The following list describes all expansion variables that are
32176 available in the MIME ACL:
32177
32178 .vlist
32179 .vitem &$mime_boundary$&
32180 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32181 have a boundary string, which is stored in this variable. If the current part
32182 has no boundary parameter in the &'Content-Type:'& header, this variable
32183 contains the empty string.
32184
32185 .vitem &$mime_charset$&
32186 This variable contains the character set identifier, if one was found in the
32187 &'Content-Type:'& header. Examples for charset identifiers are:
32188 .code
32189 us-ascii
32190 gb2312 (Chinese)
32191 iso-8859-1
32192 .endd
32193 Please note that this value is not normalized, so you should do matches
32194 case-insensitively.
32195
32196 .vitem &$mime_content_description$&
32197 This variable contains the normalized content of the &'Content-Description:'&
32198 header. It can contain a human-readable description of the parts content. Some
32199 implementations repeat the filename for attachments here, but they are usually
32200 only used for display purposes.
32201
32202 .vitem &$mime_content_disposition$&
32203 This variable contains the normalized content of the &'Content-Disposition:'&
32204 header. You can expect strings like &"attachment"& or &"inline"& here.
32205
32206 .vitem &$mime_content_id$&
32207 This variable contains the normalized content of the &'Content-ID:'& header.
32208 This is a unique ID that can be used to reference a part from another part.
32209
32210 .vitem &$mime_content_size$&
32211 This variable is set only after the &%decode%& modifier (see above) has been
32212 successfully run. It contains the size of the decoded part in kilobytes. The
32213 size is always rounded up to full kilobytes, so only a completely empty part
32214 has a &$mime_content_size$& of zero.
32215
32216 .vitem &$mime_content_transfer_encoding$&
32217 This variable contains the normalized content of the
32218 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32219 type. Typical values are &"base64"& and &"quoted-printable"&.
32220
32221 .vitem &$mime_content_type$&
32222 If the MIME part has a &'Content-Type:'& header, this variable contains its
32223 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32224 are some examples of popular MIME types, as they may appear in this variable:
32225 .code
32226 text/plain
32227 text/html
32228 application/octet-stream
32229 image/jpeg
32230 audio/midi
32231 .endd
32232 If the MIME part has no &'Content-Type:'& header, this variable contains the
32233 empty string.
32234
32235 .vitem &$mime_decoded_filename$&
32236 This variable is set only after the &%decode%& modifier (see above) has been
32237 successfully run. It contains the full path and file name of the file
32238 containing the decoded data.
32239 .endlist
32240
32241 .cindex "RFC 2047"
32242 .vlist
32243 .vitem &$mime_filename$&
32244 This is perhaps the most important of the MIME variables. It contains a
32245 proposed filename for an attachment, if one was found in either the
32246 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32247 RFC2047
32248 or RFC2231
32249 decoded, but no additional sanity checks are done.
32250  If no filename was
32251 found, this variable contains the empty string.
32252
32253 .vitem &$mime_is_coverletter$&
32254 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32255 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32256 content in the cover letter, while not restricting attachments at all.
32257
32258 The variable contains 1 (true) for a MIME part believed to be part of the
32259 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32260 follows:
32261
32262 .olist
32263 The outermost MIME part of a message is always a cover letter.
32264
32265 .next
32266 If a multipart/alternative or multipart/related MIME part is a cover letter,
32267 so are all MIME subparts within that multipart.
32268
32269 .next
32270 If any other multipart is a cover letter, the first subpart is a cover letter,
32271 and the rest are attachments.
32272
32273 .next
32274 All parts contained within an attachment multipart are attachments.
32275 .endlist olist
32276
32277 As an example, the following will ban &"HTML mail"& (including that sent with
32278 alternative plain text), while allowing HTML files to be attached. HTML
32279 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
32280 .code
32281 deny message = HTML mail is not accepted here
32282 !condition = $mime_is_rfc822
32283 condition = $mime_is_coverletter
32284 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32285 .endd
32286 .vitem &$mime_is_multipart$&
32287 This variable has the value 1 (true) when the current part has the main type
32288 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32289 Since multipart entities only serve as containers for other parts, you may not
32290 want to carry out specific actions on them.
32291
32292 .vitem &$mime_is_rfc822$&
32293 This variable has the value 1 (true) if the current part is not a part of the
32294 checked message itself, but part of an attached message. Attached message
32295 decoding is fully recursive.
32296
32297 .vitem &$mime_part_count$&
32298 This variable is a counter that is raised for each processed MIME part. It
32299 starts at zero for the very first part (which is usually a multipart). The
32300 counter is per-message, so it is reset when processing RFC822 attachments (see
32301 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32302 complete, so you can use it in the DATA ACL to determine the number of MIME
32303 parts of a message. For non-MIME messages, this variable contains the value -1.
32304 .endlist
32305
32306
32307
32308 .section "Scanning with regular expressions" "SECTscanregex"
32309 .cindex "content scanning" "with regular expressions"
32310 .cindex "regular expressions" "content scanning with"
32311 You can specify your own custom regular expression matches on the full body of
32312 the message, or on individual MIME parts.
32313
32314 The &%regex%& condition takes one or more regular expressions as arguments and
32315 matches them against the full message (when called in the DATA ACL) or a raw
32316 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32317 linewise, with a maximum line length of 32K characters. That means you cannot
32318 have multiline matches with the &%regex%& condition.
32319
32320 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32321 to 32K of decoded content (the whole content at once, not linewise). If the
32322 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32323 is decoded automatically when &%mime_regex%& is executed (using default path
32324 and filename values). If the decoded data is larger than  32K, only the first
32325 32K characters are checked.
32326
32327 The regular expressions are passed as a colon-separated list. To include a
32328 literal colon, you must double it. Since the whole right-hand side string is
32329 expanded before being used, you must also escape dollar signs and backslashes
32330 with more backslashes, or use the &`\N`& facility to disable expansion.
32331 Here is a simple example that contains two regular expressions:
32332 .code
32333 deny message = contains blacklisted regex ($regex_match_string)
32334      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32335 .endd
32336 The conditions returns true if any one of the regular expressions matches. The
32337 &$regex_match_string$& expansion variable is then set up and contains the
32338 matching regular expression.
32339 The expansion variables &$regex1$& &$regex2$& etc
32340 are set to any substrings captured by the regular expression.
32341
32342 &*Warning*&: With large messages, these conditions can be fairly
32343 CPU-intensive.
32344
32345 .ecindex IIDcosca
32346
32347
32348
32349
32350 . ////////////////////////////////////////////////////////////////////////////
32351 . ////////////////////////////////////////////////////////////////////////////
32352
32353 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32354          "Local scan function"
32355 .scindex IIDlosca "&[local_scan()]& function" "description of"
32356 .cindex "customizing" "input scan using C function"
32357 .cindex "policy control" "by local scan function"
32358 In these days of email worms, viruses, and ever-increasing spam, some sites
32359 want to apply a lot of checking to messages before accepting them.
32360
32361 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32362 passing messages to external virus and spam scanning software. You can also do
32363 a certain amount in Exim itself through string expansions and the &%condition%&
32364 condition in the ACL that runs after the SMTP DATA command or the ACL for
32365 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32366
32367 To allow for further customization to a site's own requirements, there is the
32368 possibility of linking Exim with a private message scanning function, written
32369 in C. If you want to run code that is written in something other than C, you
32370 can of course use a little C stub to call it.
32371
32372 The local scan function is run once for every incoming message, at the point
32373 when Exim is just about to accept the message.
32374 It can therefore be used to control non-SMTP messages from local processes as
32375 well as messages arriving via SMTP.
32376
32377 Exim applies a timeout to calls of the local scan function, and there is an
32378 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32379 Zero means &"no timeout"&.
32380 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32381 before calling the local scan function, so that the most common types of crash
32382 are caught. If the timeout is exceeded or one of those signals is caught, the
32383 incoming message is rejected with a temporary error if it is an SMTP message.
32384 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32385 code. The incident is logged on the main and reject logs.
32386
32387
32388
32389 .section "Building Exim to use a local scan function" "SECID207"
32390 .cindex "&[local_scan()]& function" "building Exim to use"
32391 To make use of the local scan function feature, you must tell Exim where your
32392 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32393 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32394 directory, so you might set
32395 .code
32396 LOCAL_SCAN_SOURCE=Local/local_scan.c
32397 .endd
32398 for example. The function must be called &[local_scan()]&. It is called by
32399 Exim after it has received a message, when the success return code is about to
32400 be sent. This is after all the ACLs have been run. The return code from your
32401 function controls whether the message is actually accepted or not. There is a
32402 commented template function (that just accepts the message) in the file
32403 _src/local_scan.c_.
32404
32405 If you want to make use of Exim's run time configuration file to set options
32406 for your &[local_scan()]& function, you must also set
32407 .code
32408 LOCAL_SCAN_HAS_OPTIONS=yes
32409 .endd
32410 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32411
32412
32413
32414
32415 .section "API for local_scan()" "SECTapiforloc"
32416 .cindex "&[local_scan()]& function" "API description"
32417 You must include this line near the start of your code:
32418 .code
32419 #include "local_scan.h"
32420 .endd
32421 This header file defines a number of variables and other values, and the
32422 prototype for the function itself. Exim is coded to use unsigned char values
32423 almost exclusively, and one of the things this header defines is a shorthand
32424 for &`unsigned char`& called &`uschar`&.
32425 It also contains the following macro definitions, to simplify casting character
32426 strings and pointers to character strings:
32427 .code
32428 #define CS   (char *)
32429 #define CCS  (const char *)
32430 #define CSS  (char **)
32431 #define US   (unsigned char *)
32432 #define CUS  (const unsigned char *)
32433 #define USS  (unsigned char **)
32434 .endd
32435 The function prototype for &[local_scan()]& is:
32436 .code
32437 extern int local_scan(int fd, uschar **return_text);
32438 .endd
32439 The arguments are as follows:
32440
32441 .ilist
32442 &%fd%& is a file descriptor for the file that contains the body of the message
32443 (the -D file). The file is open for reading and writing, but updating it is not
32444 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32445
32446 The descriptor is positioned at character 19 of the file, which is the first
32447 character of the body itself, because the first 19 characters are the message
32448 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32449 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32450 case this changes in some future version.
32451 .next
32452 &%return_text%& is an address which you can use to return a pointer to a text
32453 string at the end of the function. The value it points to on entry is NULL.
32454 .endlist
32455
32456 The function must return an &%int%& value which is one of the following macros:
32457
32458 .vlist
32459 .vitem &`LOCAL_SCAN_ACCEPT`&
32460 .vindex "&$local_scan_data$&"
32461 The message is accepted. If you pass back a string of text, it is saved with
32462 the message, and made available in the variable &$local_scan_data$&. No
32463 newlines are permitted (if there are any, they are turned into spaces) and the
32464 maximum length of text is 1000 characters.
32465
32466 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32467 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32468 queued without immediate delivery, and is frozen.
32469
32470 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32471 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32472 queued without immediate delivery.
32473
32474 .vitem &`LOCAL_SCAN_REJECT`&
32475 The message is rejected; the returned text is used as an error message which is
32476 passed back to the sender and which is also logged. Newlines are permitted &--
32477 they cause a multiline response for SMTP rejections, but are converted to
32478 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32479 used.
32480
32481 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32482 The message is temporarily rejected; the returned text is used as an error
32483 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32484 problem"& is used.
32485
32486 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32487 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32488 message is not written to the reject log. It has the effect of unsetting the
32489 &%rejected_header%& log selector for just this rejection. If
32490 &%rejected_header%& is already unset (see the discussion of the
32491 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32492 same as LOCAL_SCAN_REJECT.
32493
32494 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32495 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32496 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32497 .endlist
32498
32499 If the message is not being received by interactive SMTP, rejections are
32500 reported by writing to &%stderr%& or by sending an email, as configured by the
32501 &%-oe%& command line options.
32502
32503
32504
32505 .section "Configuration options for local_scan()" "SECTconoptloc"
32506 .cindex "&[local_scan()]& function" "configuration options"
32507 It is possible to have option settings in the main configuration file
32508 that set values in static variables in the &[local_scan()]& module. If you
32509 want to do this, you must have the line
32510 .code
32511 LOCAL_SCAN_HAS_OPTIONS=yes
32512 .endd
32513 in your &_Local/Makefile_& when you build Exim. (This line is in
32514 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32515 file, you must define static variables to hold the option values, and a table
32516 to define them.
32517
32518 The table must be a vector called &%local_scan_options%&, of type
32519 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32520 and a pointer to the variable that holds the value. The entries must appear in
32521 alphabetical order. Following &%local_scan_options%& you must also define a
32522 variable called &%local_scan_options_count%& that contains the number of
32523 entries in the table. Here is a short example, showing two kinds of option:
32524 .code
32525 static int my_integer_option = 42;
32526 static uschar *my_string_option = US"a default string";
32527
32528 optionlist local_scan_options[] = {
32529   { "my_integer", opt_int,       &my_integer_option },
32530   { "my_string",  opt_stringptr, &my_string_option }
32531 };
32532
32533 int local_scan_options_count =
32534   sizeof(local_scan_options)/sizeof(optionlist);
32535 .endd
32536 The values of the variables can now be changed from Exim's runtime
32537 configuration file by including a local scan section as in this example:
32538 .code
32539 begin local_scan
32540 my_integer = 99
32541 my_string = some string of text...
32542 .endd
32543 The available types of option data are as follows:
32544
32545 .vlist
32546 .vitem &*opt_bool*&
32547 This specifies a boolean (true/false) option. The address should point to a
32548 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32549 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32550 whether such a variable has been set at all, you can initialize it to
32551 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32552 values.)
32553
32554 .vitem &*opt_fixed*&
32555 This specifies a fixed point number, such as is used for load averages.
32556 The address should point to a variable of type &`int`&. The value is stored
32557 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32558
32559 .vitem &*opt_int*&
32560 This specifies an integer; the address should point to a variable of type
32561 &`int`&. The value may be specified in any of the integer formats accepted by
32562 Exim.
32563
32564 .vitem &*opt_mkint*&
32565 This is the same as &%opt_int%&, except that when such a value is output in a
32566 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32567 printed with the suffix K or M.
32568
32569 .vitem &*opt_octint*&
32570 This also specifies an integer, but the value is always interpreted as an
32571 octal integer, whether or not it starts with the digit zero, and it is
32572 always output in octal.
32573
32574 .vitem &*opt_stringptr*&
32575 This specifies a string value; the address must be a pointer to a
32576 variable that points to a string (for example, of type &`uschar *`&).
32577
32578 .vitem &*opt_time*&
32579 This specifies a time interval value. The address must point to a variable of
32580 type &`int`&. The value that is placed there is a number of seconds.
32581 .endlist
32582
32583 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32584 out the values of all the &[local_scan()]& options.
32585
32586
32587
32588 .section "Available Exim variables" "SECID208"
32589 .cindex "&[local_scan()]& function" "available Exim variables"
32590 The header &_local_scan.h_& gives you access to a number of C variables. These
32591 are the only ones that are guaranteed to be maintained from release to release.
32592 Note, however, that you can obtain the value of any Exim expansion variable,
32593 including &$recipients$&, by calling &'expand_string()'&. The exported
32594 C variables are as follows:
32595
32596 .vlist
32597 .vitem &*int&~body_linecount*&
32598 This variable contains the number of lines in the message's body.
32599 .new
32600 It is not valid if the &%spool_files_wireformat%& option is used.
32601 .wen
32602
32603 .vitem &*int&~body_zerocount*&
32604 This variable contains the number of binary zero bytes in the message's body.
32605 .new
32606 It is not valid if the &%spool_files_wireformat%& option is used.
32607 .wen
32608
32609 .vitem &*unsigned&~int&~debug_selector*&
32610 This variable is set to zero when no debugging is taking place. Otherwise, it
32611 is a bitmap of debugging selectors. Two bits are identified for use in
32612 &[local_scan()]&; they are defined as macros:
32613
32614 .ilist
32615 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32616 testing option that is not privileged &-- any caller may set it. All the
32617 other selector bits can be set only by admin users.
32618
32619 .next
32620 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32621 by the &`+local_scan`& debug selector. It is not included in the default set
32622 of debugging bits.
32623 .endlist ilist
32624
32625 Thus, to write to the debugging output only when &`+local_scan`& has been
32626 selected, you should use code like this:
32627 .code
32628 if ((debug_selector & D_local_scan) != 0)
32629   debug_printf("xxx", ...);
32630 .endd
32631 .vitem &*uschar&~*expand_string_message*&
32632 After a failing call to &'expand_string()'& (returned value NULL), the
32633 variable &%expand_string_message%& contains the error message, zero-terminated.
32634
32635 .vitem &*header_line&~*header_list*&
32636 A pointer to a chain of header lines. The &%header_line%& structure is
32637 discussed below.
32638
32639 .vitem &*header_line&~*header_last*&
32640 A pointer to the last of the header lines.
32641
32642 .vitem &*uschar&~*headers_charset*&
32643 The value of the &%headers_charset%& configuration option.
32644
32645 .vitem &*BOOL&~host_checking*&
32646 This variable is TRUE during a host checking session that is initiated by the
32647 &%-bh%& command line option.
32648
32649 .vitem &*uschar&~*interface_address*&
32650 The IP address of the interface that received the message, as a string. This
32651 is NULL for locally submitted messages.
32652
32653 .vitem &*int&~interface_port*&
32654 The port on which this message was received. When testing with the &%-bh%&
32655 command line option, the value of this variable is -1 unless a port has been
32656 specified via the &%-oMi%& option.
32657
32658 .vitem &*uschar&~*message_id*&
32659 This variable contains Exim's message id for the incoming message (the value of
32660 &$message_exim_id$&) as a zero-terminated string.
32661
32662 .vitem &*uschar&~*received_protocol*&
32663 The name of the protocol by which the message was received.
32664
32665 .vitem &*int&~recipients_count*&
32666 The number of accepted recipients.
32667
32668 .vitem &*recipient_item&~*recipients_list*&
32669 .cindex "recipient" "adding in local scan"
32670 .cindex "recipient" "removing in local scan"
32671 The list of accepted recipients, held in a vector of length
32672 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32673 can add additional recipients by calling &'receive_add_recipient()'& (see
32674 below). You can delete recipients by removing them from the vector and
32675 adjusting the value in &%recipients_count%&. In particular, by setting
32676 &%recipients_count%& to zero you remove all recipients. If you then return the
32677 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32678 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32679 and then call &'receive_add_recipient()'& as often as needed.
32680
32681 .vitem &*uschar&~*sender_address*&
32682 The envelope sender address. For bounce messages this is the empty string.
32683
32684 .vitem &*uschar&~*sender_host_address*&
32685 The IP address of the sending host, as a string. This is NULL for
32686 locally-submitted messages.
32687
32688 .vitem &*uschar&~*sender_host_authenticated*&
32689 The name of the authentication mechanism that was used, or NULL if the message
32690 was not received over an authenticated SMTP connection.
32691
32692 .vitem &*uschar&~*sender_host_name*&
32693 The name of the sending host, if known.
32694
32695 .vitem &*int&~sender_host_port*&
32696 The port on the sending host.
32697
32698 .vitem &*BOOL&~smtp_input*&
32699 This variable is TRUE for all SMTP input, including BSMTP.
32700
32701 .vitem &*BOOL&~smtp_batched_input*&
32702 This variable is TRUE for BSMTP input.
32703
32704 .vitem &*int&~store_pool*&
32705 The contents of this variable control which pool of memory is used for new
32706 requests. See section &<<SECTmemhanloc>>& for details.
32707 .endlist
32708
32709
32710 .section "Structure of header lines" "SECID209"
32711 The &%header_line%& structure contains the members listed below.
32712 You can add additional header lines by calling the &'header_add()'& function
32713 (see below). You can cause header lines to be ignored (deleted) by setting
32714 their type to *.
32715
32716
32717 .vlist
32718 .vitem &*struct&~header_line&~*next*&
32719 A pointer to the next header line, or NULL for the last line.
32720
32721 .vitem &*int&~type*&
32722 A code identifying certain headers that Exim recognizes. The codes are printing
32723 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32724 Notice in particular that any header line whose type is * is not transmitted
32725 with the message. This flagging is used for header lines that have been
32726 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32727 lines.) Effectively, * means &"deleted"&.
32728
32729 .vitem &*int&~slen*&
32730 The number of characters in the header line, including the terminating and any
32731 internal newlines.
32732
32733 .vitem &*uschar&~*text*&
32734 A pointer to the text of the header. It always ends with a newline, followed by
32735 a zero byte. Internal newlines are preserved.
32736 .endlist
32737
32738
32739
32740 .section "Structure of recipient items" "SECID210"
32741 The &%recipient_item%& structure contains these members:
32742
32743 .vlist
32744 .vitem &*uschar&~*address*&
32745 This is a pointer to the recipient address as it was received.
32746
32747 .vitem &*int&~pno*&
32748 This is used in later Exim processing when top level addresses are created by
32749 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32750 and must always contain -1 at this stage.
32751
32752 .vitem &*uschar&~*errors_to*&
32753 If this value is not NULL, bounce messages caused by failing to deliver to the
32754 recipient are sent to the address it contains. In other words, it overrides the
32755 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32756 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32757 an unqualified address, Exim qualifies it using the domain from
32758 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32759 is NULL for all recipients.
32760 .endlist
32761
32762
32763
32764 .section "Available Exim functions" "SECID211"
32765 .cindex "&[local_scan()]& function" "available Exim functions"
32766 The header &_local_scan.h_& gives you access to a number of Exim functions.
32767 These are the only ones that are guaranteed to be maintained from release to
32768 release:
32769
32770 .vlist
32771 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32772        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32773
32774 This function creates a child process that runs the command specified by
32775 &%argv%&. The environment for the process is specified by &%envp%&, which can
32776 be NULL if no environment variables are to be passed. A new umask is supplied
32777 for the process in &%newumask%&.
32778
32779 Pipes to the standard input and output of the new process are set up
32780 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32781 standard error is cloned to the standard output. If there are any file
32782 descriptors &"in the way"& in the new process, they are closed. If the final
32783 argument is TRUE, the new process is made into a process group leader.
32784
32785 The function returns the pid of the new process, or -1 if things go wrong.
32786
32787 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32788 This function waits for a child process to terminate, or for a timeout (in
32789 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32790 return value is as follows:
32791
32792 .ilist
32793 >= 0
32794
32795 The process terminated by a normal exit and the value is the process
32796 ending status.
32797
32798 .next
32799 < 0 and > &--256
32800
32801 The process was terminated by a signal and the value is the negation of the
32802 signal number.
32803
32804 .next
32805 &--256
32806
32807 The process timed out.
32808 .next
32809 &--257
32810
32811 The was some other error in wait(); &%errno%& is still set.
32812 .endlist
32813
32814 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32815 This function provide you with a means of submitting a new message to
32816 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32817 want, but this packages it all up for you.) The function creates a pipe,
32818 forks a subprocess that is running
32819 .code
32820 exim -t -oem -oi -f <>
32821 .endd
32822 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32823 that is connected to the standard input. The yield of the function is the PID
32824 of the subprocess. You can then write a message to the file descriptor, with
32825 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32826
32827 When you have finished, call &'child_close()'& to wait for the process to
32828 finish and to collect its ending status. A timeout value of zero is usually
32829 fine in this circumstance. Unless you have made a mistake with the recipient
32830 addresses, you should get a return code of zero.
32831
32832
32833 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32834        *sender_authentication)*&
32835 This function is a more sophisticated version of &'child_open()'&. The command
32836 that it runs is:
32837 .display
32838 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32839 .endd
32840 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32841
32842
32843 .vitem &*void&~debug_printf(char&~*,&~...)*&
32844 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32845 output is written to the standard error stream. If no debugging is selected,
32846 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32847 conditional on the &`local_scan`& debug selector by coding like this:
32848 .code
32849 if ((debug_selector & D_local_scan) != 0)
32850   debug_printf("xxx", ...);
32851 .endd
32852
32853 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32854 This is an interface to Exim's string expansion code. The return value is the
32855 expanded string, or NULL if there was an expansion failure.
32856 The C variable &%expand_string_message%& contains an error message after an
32857 expansion failure. If expansion does not change the string, the return value is
32858 the pointer to the input string. Otherwise, the return value points to a new
32859 block of memory that was obtained by a call to &'store_get()'&. See section
32860 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32861
32862 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32863 This function allows you to an add additional header line at the end of the
32864 existing ones. The first argument is the type, and should normally be a space
32865 character. The second argument is a format string and any number of
32866 substitution arguments as for &[sprintf()]&. You may include internal newlines
32867 if you want, and you must ensure that the string ends with a newline.
32868
32869 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32870         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32871 This function adds a new header line at a specified point in the header
32872 chain. The header itself is specified as for &'header_add()'&.
32873
32874 If &%name%& is NULL, the new header is added at the end of the chain if
32875 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32876 NULL, the header lines are searched for the first non-deleted header that
32877 matches the name. If one is found, the new header is added before it if
32878 &%after%& is false. If &%after%& is true, the new header is added after the
32879 found header and any adjacent subsequent ones with the same name (even if
32880 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32881 option controls where the header is added. If it is true, addition is at the
32882 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32883 headers, or at the top if there are no &'Received:'& headers, you could use
32884 .code
32885 header_add_at_position(TRUE, US"Received", TRUE,
32886   ' ', "X-xxx: ...");
32887 .endd
32888 Normally, there is always at least one non-deleted &'Received:'& header, but
32889 there may not be if &%received_header_text%& expands to an empty string.
32890
32891
32892 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32893 This function removes header lines. If &%occurrence%& is zero or negative, all
32894 occurrences of the header are removed. If occurrence is greater than zero, that
32895 particular instance of the header is removed. If no header(s) can be found that
32896 match the specification, the function does nothing.
32897
32898
32899 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32900         int&~length,&~BOOL&~notdel)*&"
32901 This function tests whether the given header has the given name. It is not just
32902 a string comparison, because white space is permitted between the name and the
32903 colon. If the &%notdel%& argument is true, a false return is forced for all
32904 &"deleted"& headers; otherwise they are not treated specially. For example:
32905 .code
32906 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32907 .endd
32908 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32909 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32910 This function base64-encodes a string, which is passed by address and length.
32911 The text may contain bytes of any value, including zero. The result is passed
32912 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32913 zero-terminated.
32914
32915 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32916 This function decodes a base64-encoded string. Its arguments are a
32917 zero-terminated base64-encoded string and the address of a variable that is set
32918 to point to the result, which is in dynamic memory. The length of the decoded
32919 string is the yield of the function. If the input is invalid base64 data, the
32920 yield is -1. A zero byte is added to the end of the output string to make it
32921 easy to interpret as a C string (assuming it contains no zeros of its own). The
32922 added zero byte is not included in the returned count.
32923
32924 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32925 This function checks for a match in a domain list. Domains are always
32926 matched caselessly. The return value is one of the following:
32927 .display
32928 &`OK     `& match succeeded
32929 &`FAIL   `& match failed
32930 &`DEFER  `& match deferred
32931 .endd
32932 DEFER is usually caused by some kind of lookup defer, such as the
32933 inability to contact a database.
32934
32935 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32936         BOOL&~caseless)*&"
32937 This function checks for a match in a local part list. The third argument
32938 controls case-sensitivity. The return values are as for
32939 &'lss_match_domain()'&.
32940
32941 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32942         BOOL&~caseless)*&"
32943 This function checks for a match in an address list. The third argument
32944 controls the case-sensitivity of the local part match. The domain is always
32945 matched caselessly. The return values are as for &'lss_match_domain()'&.
32946
32947 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32948         uschar&~*list)*&"
32949 This function checks for a match in a host list. The most common usage is
32950 expected to be
32951 .code
32952 lss_match_host(sender_host_name, sender_host_address, ...)
32953 .endd
32954 .vindex "&$sender_host_address$&"
32955 An empty address field matches an empty item in the host list. If the host name
32956 is NULL, the name corresponding to &$sender_host_address$& is automatically
32957 looked up if a host name is required to match an item in the list. The return
32958 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32959 returns ERROR in the case when it had to look up a host name, but the lookup
32960 failed.
32961
32962 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32963         *format,&~...)*&"
32964 This function writes to Exim's log files. The first argument should be zero (it
32965 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32966 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32967 them. It specifies to which log or logs the message is written. The remaining
32968 arguments are a format and relevant insertion arguments. The string should not
32969 contain any newlines, not even at the end.
32970
32971
32972 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32973 This function adds an additional recipient to the message. The first argument
32974 is the recipient address. If it is unqualified (has no domain), it is qualified
32975 with the &%qualify_recipient%& domain. The second argument must always be -1.
32976
32977 This function does not allow you to specify a private &%errors_to%& address (as
32978 described with the structure of &%recipient_item%& above), because it pre-dates
32979 the addition of that field to the structure. However, it is easy to add such a
32980 value afterwards. For example:
32981 .code
32982  receive_add_recipient(US"monitor@mydom.example", -1);
32983  recipients_list[recipients_count-1].errors_to =
32984    US"postmaster@mydom.example";
32985 .endd
32986
32987 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32988 This is a convenience function to remove a named recipient from the list of
32989 recipients. It returns true if a recipient was removed, and false if no
32990 matching recipient could be found. The argument must be a complete email
32991 address.
32992 .endlist
32993
32994
32995 .cindex "RFC 2047"
32996 .vlist
32997 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32998   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32999 This function decodes strings that are encoded according to RFC 2047. Typically
33000 these are the contents of header lines. First, each &"encoded word"& is decoded
33001 from the Q or B encoding into a byte-string. Then, if provided with the name of
33002 a charset encoding, and if the &[iconv()]& function is available, an attempt is
33003 made  to translate the result to the named character set. If this fails, the
33004 binary string is returned with an error message.
33005
33006 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
33007 maximum MIME word length is enforced. The third argument is the target
33008 encoding, or NULL if no translation is wanted.
33009
33010 .cindex "binary zero" "in RFC 2047 decoding"
33011 .cindex "RFC 2047" "binary zero in"
33012 If a binary zero is encountered in the decoded string, it is replaced by the
33013 contents of the &%zeroval%& argument. For use with Exim headers, the value must
33014 not be 0 because header lines are handled as zero-terminated strings.
33015
33016 The function returns the result of processing the string, zero-terminated; if
33017 &%lenptr%& is not NULL, the length of the result is set in the variable to
33018 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
33019
33020 If an error is encountered, the function returns NULL and uses the &%error%&
33021 argument to return an error message. The variable pointed to by &%error%& is
33022 set to NULL if there is no error; it may be set non-NULL even when the function
33023 returns a non-NULL value if decoding was successful, but there was a problem
33024 with translation.
33025
33026
33027 .vitem &*int&~smtp_fflush(void)*&
33028 This function is used in conjunction with &'smtp_printf()'&, as described
33029 below.
33030
33031 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33032 The arguments of this function are like &[printf()]&; it writes to the SMTP
33033 output stream. You should use this function only when there is an SMTP output
33034 stream, that is, when the incoming message is being received via interactive
33035 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33036 is FALSE. If you want to test for an incoming message from another host (as
33037 opposed to a local process that used the &%-bs%& command line option), you can
33038 test the value of &%sender_host_address%&, which is non-NULL when a remote host
33039 is involved.
33040
33041 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
33042 output function, so it can be used for all forms of SMTP connection.
33043
33044 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
33045 must start with an appropriate response code: 550 if you are going to return
33046 LOCAL_SCAN_REJECT, 451 if you are going to return
33047 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
33048 initial lines of a multi-line response, the code must be followed by a hyphen
33049 to indicate that the line is not the final response line. You must also ensure
33050 that the lines you write terminate with CRLF. For example:
33051 .code
33052 smtp_printf("550-this is some extra info\r\n");
33053 return LOCAL_SCAN_REJECT;
33054 .endd
33055 Note that you can also create multi-line responses by including newlines in
33056 the data returned via the &%return_text%& argument. The added value of using
33057 &'smtp_printf()'& is that, for instance, you could introduce delays between
33058 multiple output lines.
33059
33060 The &'smtp_printf()'& function does not return any error indication, because it
33061 does not automatically flush pending output, and therefore does not test
33062 the state of the stream. (In the main code of Exim, flushing and error
33063 detection is done when Exim is ready for the next SMTP input command.) If
33064 you want to flush the output and check for an error (for example, the
33065 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
33066 arguments. It flushes the output stream, and returns a non-zero value if there
33067 is an error.
33068
33069 .vitem &*void&~*store_get(int)*&
33070 This function accesses Exim's internal store (memory) manager. It gets a new
33071 chunk of memory whose size is given by the argument. Exim bombs out if it ever
33072 runs out of memory. See the next section for a discussion of memory handling.
33073
33074 .vitem &*void&~*store_get_perm(int)*&
33075 This function is like &'store_get()'&, but it always gets memory from the
33076 permanent pool. See the next section for a discussion of memory handling.
33077
33078 .vitem &*uschar&~*string_copy(uschar&~*string)*&
33079 See below.
33080
33081 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
33082 See below.
33083
33084 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
33085 These three functions create strings using Exim's dynamic memory facilities.
33086 The first makes a copy of an entire string. The second copies up to a maximum
33087 number of characters, indicated by the second argument. The third uses a format
33088 and insertion arguments to create a new string. In each case, the result is a
33089 pointer to a new string in the current memory pool. See the next section for
33090 more discussion.
33091 .endlist
33092
33093
33094
33095 .section "More about Exim's memory handling" "SECTmemhanloc"
33096 .cindex "&[local_scan()]& function" "memory handling"
33097 No function is provided for freeing memory, because that is never needed.
33098 The dynamic memory that Exim uses when receiving a message is automatically
33099 recycled if another message is received by the same process (this applies only
33100 to incoming SMTP connections &-- other input methods can supply only one
33101 message at a time). After receiving the last message, a reception process
33102 terminates.
33103
33104 Because it is recycled, the normal dynamic memory cannot be used for holding
33105 data that must be preserved over a number of incoming messages on the same SMTP
33106 connection. However, Exim in fact uses two pools of dynamic memory; the second
33107 one is not recycled, and can be used for this purpose.
33108
33109 If you want to allocate memory that remains available for subsequent messages
33110 in the same SMTP connection, you should set
33111 .code
33112 store_pool = POOL_PERM
33113 .endd
33114 before calling the function that does the allocation. There is no need to
33115 restore the value if you do not need to; however, if you do want to revert to
33116 the normal pool, you can either restore the previous value of &%store_pool%& or
33117 set it explicitly to POOL_MAIN.
33118
33119 The pool setting applies to all functions that get dynamic memory, including
33120 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
33121 There is also a convenience function called &'store_get_perm()'& that gets a
33122 block of memory from the permanent pool while preserving the value of
33123 &%store_pool%&.
33124 .ecindex IIDlosca
33125
33126
33127
33128
33129 . ////////////////////////////////////////////////////////////////////////////
33130 . ////////////////////////////////////////////////////////////////////////////
33131
33132 .chapter "System-wide message filtering" "CHAPsystemfilter"
33133 .scindex IIDsysfil1 "filter" "system filter"
33134 .scindex IIDsysfil2 "filtering all mail"
33135 .scindex IIDsysfil3 "system filter"
33136 The previous chapters (on ACLs and the local scan function) describe checks
33137 that can be applied to messages before they are accepted by a host. There is
33138 also a mechanism for checking messages once they have been received, but before
33139 they are delivered. This is called the &'system filter'&.
33140
33141 The system filter operates in a similar manner to users' filter files, but it
33142 is run just once per message (however many recipients the message has).
33143 It should not normally be used as a substitute for routing, because &%deliver%&
33144 commands in a system router provide new envelope recipient addresses.
33145 The system filter must be an Exim filter. It cannot be a Sieve filter.
33146
33147 The system filter is run at the start of a delivery attempt, before any routing
33148 is done. If a message fails to be completely delivered at the first attempt,
33149 the system filter is run again at the start of every retry.
33150 If you want your filter to do something only once per message, you can make use
33151 of the &%first_delivery%& condition in an &%if%& command in the filter to
33152 prevent it happening on retries.
33153
33154 .vindex "&$domain$&"
33155 .vindex "&$local_part$&"
33156 &*Warning*&: Because the system filter runs just once, variables that are
33157 specific to individual recipient addresses, such as &$local_part$& and
33158 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33159 you want to run a centrally-specified filter for each recipient address
33160 independently, you can do so by setting up a suitable &(redirect)& router, as
33161 described in section &<<SECTperaddfil>>& below.
33162
33163
33164 .section "Specifying a system filter" "SECID212"
33165 .cindex "uid (user id)" "system filter"
33166 .cindex "gid (group id)" "system filter"
33167 The name of the file that contains the system filter must be specified by
33168 setting &%system_filter%&. If you want the filter to run under a uid and gid
33169 other than root, you must also set &%system_filter_user%& and
33170 &%system_filter_group%& as appropriate. For example:
33171 .code
33172 system_filter = /etc/mail/exim.filter
33173 system_filter_user = exim
33174 .endd
33175 If a system filter generates any deliveries directly to files or pipes (via the
33176 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33177 specified by setting &%system_filter_file_transport%& and
33178 &%system_filter_pipe_transport%&, respectively. Similarly,
33179 &%system_filter_reply_transport%& must be set to handle any messages generated
33180 by the &%reply%& command.
33181
33182
33183 .section "Testing a system filter" "SECID213"
33184 You can run simple tests of a system filter in the same way as for a user
33185 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33186 are permitted only in system filters are recognized.
33187
33188 If you want to test the combined effect of a system filter and a user filter,
33189 you can use both &%-bF%& and &%-bf%& on the same command line.
33190
33191
33192
33193 .section "Contents of a system filter" "SECID214"
33194 The language used to specify system filters is the same as for users' filter
33195 files. It is described in the separate end-user document &'Exim's interface to
33196 mail filtering'&. However, there are some additional features that are
33197 available only in system filters; these are described in subsequent sections.
33198 If they are encountered in a user's filter file or when testing with &%-bf%&,
33199 they cause errors.
33200
33201 .cindex "frozen messages" "manual thaw; testing in filter"
33202 There are two special conditions which, though available in users' filter
33203 files, are designed for use in system filters. The condition &%first_delivery%&
33204 is true only for the first attempt at delivering a message, and
33205 &%manually_thawed%& is true only if the message has been frozen, and
33206 subsequently thawed by an admin user. An explicit forced delivery counts as a
33207 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33208
33209 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33210 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33211 succeed, it will not be tried again.
33212 If you want Exim to retry an unseen delivery until it succeeds, you should
33213 arrange to set it up every time the filter runs.
33214
33215 When a system filter finishes running, the values of the variables &$n0$& &--
33216 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33217 users' filter files. Thus a system filter can, for example, set up &"scores"&
33218 to which users' filter files can refer.
33219
33220
33221
33222 .section "Additional variable for system filters" "SECID215"
33223 .vindex "&$recipients$&"
33224 The expansion variable &$recipients$&, containing a list of all the recipients
33225 of the message (separated by commas and white space), is available in system
33226 filters. It is not available in users' filters for privacy reasons.
33227
33228
33229
33230 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33231 .cindex "freezing messages"
33232 .cindex "message" "freezing"
33233 .cindex "message" "forced failure"
33234 .cindex "&%fail%&" "in system filter"
33235 .cindex "&%freeze%& in system filter"
33236 .cindex "&%defer%& in system filter"
33237 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33238 always available in system filters, but are not normally enabled in users'
33239 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33240 for the &(redirect)& router.) These commands can optionally be followed by the
33241 word &%text%& and a string containing an error message, for example:
33242 .code
33243 fail text "this message looks like spam to me"
33244 .endd
33245 The keyword &%text%& is optional if the next character is a double quote.
33246
33247 The &%defer%& command defers delivery of the original recipients of the
33248 message. The &%fail%& command causes all the original recipients to be failed,
33249 and a bounce message to be created. The &%freeze%& command suspends all
33250 delivery attempts for the original recipients. In all cases, any new deliveries
33251 that are specified by the filter are attempted as normal after the filter has
33252 run.
33253
33254 The &%freeze%& command is ignored if the message has been manually unfrozen and
33255 not manually frozen since. This means that automatic freezing by a system
33256 filter can be used as a way of checking out suspicious messages. If a message
33257 is found to be all right, manually unfreezing it allows it to be delivered.
33258
33259 .cindex "log" "&%fail%& command log line"
33260 .cindex "&%fail%&" "log line; reducing"
33261 The text given with a fail command is used as part of the bounce message as
33262 well as being written to the log. If the message is quite long, this can fill
33263 up a lot of log space when such failures are common. To reduce the size of the
33264 log message, Exim interprets the text in a special way if it starts with the
33265 two characters &`<<`& and contains &`>>`& later. The text between these two
33266 strings is written to the log, and the rest of the text is used in the bounce
33267 message. For example:
33268 .code
33269 fail "<<filter test 1>>Your message is rejected \
33270      because it contains attachments that we are \
33271      not prepared to receive."
33272 .endd
33273
33274 .cindex "loop" "caused by &%fail%&"
33275 Take great care with the &%fail%& command when basing the decision to fail on
33276 the contents of the message, because the bounce message will of course include
33277 the contents of the original message and will therefore trigger the &%fail%&
33278 command again (causing a mail loop) unless steps are taken to prevent this.
33279 Testing the &%error_message%& condition is one way to prevent this. You could
33280 use, for example
33281 .code
33282 if $message_body contains "this is spam" and not error_message
33283 then fail text "spam is not wanted here" endif
33284 .endd
33285 though of course that might let through unwanted bounce messages. The
33286 alternative is clever checking of the body and/or headers to detect bounces
33287 generated by the filter.
33288
33289 The interpretation of a system filter file ceases after a
33290 &%defer%&,
33291 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33292 set up earlier in the filter file are honoured, so you can use a sequence such
33293 as
33294 .code
33295 mail ...
33296 freeze
33297 .endd
33298 to send a specified message when the system filter is freezing (or deferring or
33299 failing) a message. The normal deliveries for the message do not, of course,
33300 take place.
33301
33302
33303
33304 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33305 .cindex "header lines" "adding; in system filter"
33306 .cindex "header lines" "removing; in system filter"
33307 .cindex "filter" "header lines; adding/removing"
33308 Two filter commands that are available only in system filters are:
33309 .code
33310 headers add <string>
33311 headers remove <string>
33312 .endd
33313 The argument for the &%headers add%& is a string that is expanded and then
33314 added to the end of the message's headers. It is the responsibility of the
33315 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33316 space is ignored, and if the string is otherwise empty, or if the expansion is
33317 forced to fail, the command has no effect.
33318
33319 You can use &"\n"& within the string, followed by white space, to specify
33320 continued header lines. More than one header may be added in one command by
33321 including &"\n"& within the string without any following white space. For
33322 example:
33323 .code
33324 headers add "X-header-1: ....\n  \
33325              continuation of X-header-1 ...\n\
33326              X-header-2: ...."
33327 .endd
33328 Note that the header line continuation white space after the first newline must
33329 be placed before the backslash that continues the input string, because white
33330 space after input continuations is ignored.
33331
33332 The argument for &%headers remove%& is a colon-separated list of header names.
33333 This command applies only to those headers that are stored with the message;
33334 those that are added at delivery time (such as &'Envelope-To:'& and
33335 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33336 header with the same name, they are all removed.
33337
33338 The &%headers%& command in a system filter makes an immediate change to the set
33339 of header lines that was received with the message (with possible additions
33340 from ACL processing). Subsequent commands in the system filter operate on the
33341 modified set, which also forms the basis for subsequent message delivery.
33342 Unless further modified during routing or transporting, this set of headers is
33343 used for all recipients of the message.
33344
33345 During routing and transporting, the variables that refer to the contents of
33346 header lines refer only to those lines that are in this set. Thus, header lines
33347 that are added by a system filter are visible to users' filter files and to all
33348 routers and transports. This contrasts with the manipulation of header lines by
33349 routers and transports, which is not immediate, but which instead is saved up
33350 until the message is actually being written (see section
33351 &<<SECTheadersaddrem>>&).
33352
33353 If the message is not delivered at the first attempt, header lines that were
33354 added by the system filter are stored with the message, and so are still
33355 present at the next delivery attempt. Header lines that were removed are still
33356 present, but marked &"deleted"& so that they are not transported with the
33357 message. For this reason, it is usual to make the &%headers%& command
33358 conditional on &%first_delivery%& so that the set of header lines is not
33359 modified more than once.
33360
33361 Because header modification in a system filter acts immediately, you have to
33362 use an indirect approach if you want to modify the contents of a header line.
33363 For example:
33364 .code
33365 headers add "Old-Subject: $h_subject:"
33366 headers remove "Subject"
33367 headers add "Subject: new subject (was: $h_old-subject:)"
33368 headers remove "Old-Subject"
33369 .endd
33370
33371
33372
33373 .section "Setting an errors address in a system filter" "SECID217"
33374 .cindex "envelope sender"
33375 In a system filter, if a &%deliver%& command is followed by
33376 .code
33377 errors_to <some address>
33378 .endd
33379 in order to change the envelope sender (and hence the error reporting) for that
33380 delivery, any address may be specified. (In a user filter, only the current
33381 user's address can be set.) For example, if some mail is being monitored, you
33382 might use
33383 .code
33384 unseen deliver monitor@spying.example errors_to root@local.example
33385 .endd
33386 to take a copy which would not be sent back to the normal error reporting
33387 address if its delivery failed.
33388
33389
33390
33391 .section "Per-address filtering" "SECTperaddfil"
33392 .vindex "&$domain$&"
33393 .vindex "&$local_part$&"
33394 In contrast to the system filter, which is run just once per message for each
33395 delivery attempt, it is also possible to set up a system-wide filtering
33396 operation that runs once for each recipient address. In this case, variables
33397 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33398 filter file could be made dependent on them. This is an example of a router
33399 which implements such a filter:
33400 .code
33401 central_filter:
33402   check_local_user
33403   driver = redirect
33404   domains = +local_domains
33405   file = /central/filters/$local_part
33406   no_verify
33407   allow_filter
33408   allow_freeze
33409 .endd
33410 The filter is run in a separate process under its own uid. Therefore, either
33411 &%check_local_user%& must be set (as above), in which case the filter is run as
33412 the local user, or the &%user%& option must be used to specify which user to
33413 use. If both are set, &%user%& overrides.
33414
33415 Care should be taken to ensure that none of the commands in the filter file
33416 specify a significant delivery if the message is to go on to be delivered to
33417 its intended recipient. The router will not then claim to have dealt with the
33418 address, so it will be passed on to subsequent routers to be delivered in the
33419 normal way.
33420 .ecindex IIDsysfil1
33421 .ecindex IIDsysfil2
33422 .ecindex IIDsysfil3
33423
33424
33425
33426
33427
33428
33429 . ////////////////////////////////////////////////////////////////////////////
33430 . ////////////////////////////////////////////////////////////////////////////
33431
33432 .chapter "Message processing" "CHAPmsgproc"
33433 .scindex IIDmesproc "message" "general processing"
33434 Exim performs various transformations on the sender and recipient addresses of
33435 all messages that it handles, and also on the messages' header lines. Some of
33436 these are optional and configurable, while others always take place. All of
33437 this processing, except rewriting as a result of routing, and the addition or
33438 removal of header lines while delivering, happens when a message is received,
33439 before it is placed on Exim's queue.
33440
33441 Some of the automatic processing takes place by default only for
33442 &"locally-originated"& messages. This adjective is used to describe messages
33443 that are not received over TCP/IP, but instead are passed to an Exim process on
33444 its standard input. This includes the interactive &"local SMTP"& case that is
33445 set up by the &%-bs%& command line option.
33446
33447 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33448 or ::1) are not considered to be locally-originated. Exim does not treat the
33449 loopback interface specially in any way.
33450
33451 If you want the loopback interface to be treated specially, you must ensure
33452 that there are appropriate entries in your ACLs.
33453
33454
33455
33456
33457 .section "Submission mode for non-local messages" "SECTsubmodnon"
33458 .cindex "message" "submission"
33459 .cindex "submission mode"
33460 Processing that happens automatically for locally-originated messages (unless
33461 &%suppress_local_fixups%& is set) can also be requested for messages that are
33462 received over TCP/IP. The term &"submission mode"& is used to describe this
33463 state. Submission mode is set by the modifier
33464 .code
33465 control = submission
33466 .endd
33467 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33468 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33469 a local submission, and is normally used when the source of the message is
33470 known to be an MUA running on a client host (as opposed to an MTA). For
33471 example, to set submission mode for messages originating on the IPv4 loopback
33472 interface, you could include the following in the MAIL ACL:
33473 .code
33474 warn  hosts = 127.0.0.1
33475       control = submission
33476 .endd
33477 .cindex "&%sender_retain%& submission option"
33478 There are some options that can be used when setting submission mode. A slash
33479 is used to separate options. For example:
33480 .code
33481 control = submission/sender_retain
33482 .endd
33483 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33484 true and &%local_from_check%& false for the current incoming message. The first
33485 of these allows an existing &'Sender:'& header in the message to remain, and
33486 the second suppresses the check to ensure that &'From:'& matches the
33487 authenticated sender. With this setting, Exim still fixes up messages by adding
33488 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33489 attempt to check sender authenticity in header lines.
33490
33491 When &%sender_retain%& is not set, a submission mode setting may specify a
33492 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33493 example:
33494 .code
33495 control = submission/domain=some.domain
33496 .endd
33497 The domain may be empty. How this value is used is described in sections
33498 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33499 that allows you to specify the user's full name for inclusion in a created
33500 &'Sender:'& or &'From:'& header line. For example:
33501 .code
33502 accept authenticated = *
33503        control = submission/domain=wonderland.example/\
33504                             name=${lookup {$authenticated_id} \
33505                                    lsearch {/etc/exim/namelist}}
33506 .endd
33507 Because the name may contain any characters, including slashes, the &%name%&
33508 option must be given last. The remainder of the string is used as the name. For
33509 the example above, if &_/etc/exim/namelist_& contains:
33510 .code
33511 bigegg:  Humpty Dumpty
33512 .endd
33513 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33514 line would be:
33515 .code
33516 Sender: Humpty Dumpty <bigegg@wonderland.example>
33517 .endd
33518 .cindex "return path" "in submission mode"
33519 By default, submission mode forces the return path to the same address as is
33520 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33521 specified, the return path is also left unchanged.
33522
33523 &*Note*&: The changes caused by submission mode take effect after the predata
33524 ACL. This means that any sender checks performed before the fix-ups use the
33525 untrusted sender address specified by the user, not the trusted sender address
33526 specified by submission mode. Although this might be slightly unexpected, it
33527 does mean that you can configure ACL checks to spot that a user is trying to
33528 spoof another's address.
33529
33530 .section "Line endings" "SECTlineendings"
33531 .cindex "line endings"
33532 .cindex "carriage return"
33533 .cindex "linefeed"
33534 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33535 linefeed) is the line ending for messages transmitted over the Internet using
33536 SMTP over TCP/IP. However, within individual operating systems, different
33537 conventions are used. For example, Unix-like systems use just LF, but others
33538 use CRLF or just CR.
33539
33540 Exim was designed for Unix-like systems, and internally, it stores messages
33541 using the system's convention of a single LF as a line terminator. When
33542 receiving a message, all line endings are translated to this standard format.
33543 Originally, it was thought that programs that passed messages directly to an
33544 MTA within an operating system would use that system's convention. Experience
33545 has shown that this is not the case; for example, there are Unix applications
33546 that use CRLF in this circumstance. For this reason, and for compatibility with
33547 other MTAs, the way Exim handles line endings for all messages is now as
33548 follows:
33549
33550 .ilist
33551 LF not preceded by CR is treated as a line ending.
33552 .next
33553 CR is treated as a line ending; if it is immediately followed by LF, the LF
33554 is ignored.
33555 .next
33556 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33557 nor a local message in the state where a line containing only a dot is a
33558 terminator.
33559 .next
33560 If a bare CR is encountered within a header line, an extra space is added after
33561 the line terminator so as not to end the header line. The reasoning behind this
33562 is that bare CRs in header lines are most likely either to be mistakes, or
33563 people trying to play silly games.
33564 .next
33565 If the first header line received in a message ends with CRLF, a subsequent
33566 bare LF in a header line is treated in the same way as a bare CR in a header
33567 line.
33568 .endlist
33569
33570
33571
33572
33573
33574 .section "Unqualified addresses" "SECID218"
33575 .cindex "unqualified addresses"
33576 .cindex "address" "qualification"
33577 By default, Exim expects every envelope address it receives from an external
33578 host to be fully qualified. Unqualified addresses cause negative responses to
33579 SMTP commands. However, because SMTP is used as a means of transporting
33580 messages from MUAs running on personal workstations, there is sometimes a
33581 requirement to accept unqualified addresses from specific hosts or IP networks.
33582
33583 Exim has two options that separately control which hosts may send unqualified
33584 sender or recipient addresses in SMTP commands, namely
33585 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33586 cases, if an unqualified address is accepted, it is qualified by adding the
33587 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33588
33589 .oindex "&%qualify_domain%&"
33590 .oindex "&%qualify_recipient%&"
33591 Unqualified addresses in header lines are automatically qualified for messages
33592 that are locally originated, unless the &%-bnq%& option is given on the command
33593 line. For messages received over SMTP, unqualified addresses in header lines
33594 are qualified only if unqualified addresses are permitted in SMTP commands. In
33595 other words, such qualification is also controlled by
33596 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33597
33598
33599
33600
33601 .section "The UUCP From line" "SECID219"
33602 .cindex "&""From""& line"
33603 .cindex "UUCP" "&""From""& line"
33604 .cindex "sender" "address"
33605 .oindex "&%uucp_from_pattern%&"
33606 .oindex "&%uucp_from_sender%&"
33607 .cindex "envelope sender"
33608 .cindex "Sendmail compatibility" "&""From""& line"
33609 Messages that have come from UUCP (and some other applications) often begin
33610 with a line containing the envelope sender and a timestamp, following the word
33611 &"From"&. Examples of two common formats are:
33612 .code
33613 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33614 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33615 .endd
33616 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33617 Exim recognizes such lines at the start of messages that are submitted to it
33618 via the command line (that is, on the standard input). It does not recognize
33619 such lines in incoming SMTP messages, unless the sending host matches
33620 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33621 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33622 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33623 default value matches the two common cases shown above and puts the address
33624 that follows &"From"& into &$1$&.
33625
33626 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33627 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33628 a trusted user, the message's sender address is constructed by expanding the
33629 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33630 then parsed as an RFC 2822 address. If there is no domain, the local part is
33631 qualified with &%qualify_domain%& unless it is the empty string. However, if
33632 the command line &%-f%& option is used, it overrides the &"From"& line.
33633
33634 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33635 sender address is not changed. This is also the case for incoming SMTP messages
33636 that are permitted to contain &"From"& lines.
33637
33638 Only one &"From"& line is recognized. If there is more than one, the second is
33639 treated as a data line that starts the body of the message, as it is not valid
33640 as a header line. This also happens if a &"From"& line is present in an
33641 incoming SMTP message from a source that is not permitted to send them.
33642
33643
33644
33645 .section "Resent- header lines" "SECID220"
33646 .cindex "&%Resent-%& header lines"
33647 .cindex "header lines" "Resent-"
33648 RFC 2822 makes provision for sets of header lines starting with the string
33649 &`Resent-`& to be added to a message when it is resent by the original
33650 recipient to somebody else. These headers are &'Resent-Date:'&,
33651 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33652 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33653
33654 .blockquote
33655 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33656 processing of replies or other such automatic actions on messages.'&
33657 .endblockquote
33658
33659 This leaves things a bit vague as far as other processing actions such as
33660 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33661 follows:
33662
33663 .ilist
33664 A &'Resent-From:'& line that just contains the login id of the submitting user
33665 is automatically rewritten in the same way as &'From:'& (see below).
33666 .next
33667 If there's a rewriting rule for a particular header line, it is also applied to
33668 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33669 &'From:'& also rewrites &'Resent-From:'&.
33670 .next
33671 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33672 also removed.
33673 .next
33674 For a locally-submitted message,
33675 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33676 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33677 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33678 included in log lines in this case.
33679 .next
33680 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33681 &%Resent-%& header lines are present.
33682 .endlist
33683
33684
33685
33686
33687 .section "The Auto-Submitted: header line" "SECID221"
33688 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33689 includes the header line:
33690 .code
33691 Auto-Submitted: auto-replied
33692 .endd
33693
33694 .section "The Bcc: header line" "SECID222"
33695 .cindex "&'Bcc:'& header line"
33696 If Exim is called with the &%-t%& option, to take recipient addresses from a
33697 message's header, it removes any &'Bcc:'& header line that may exist (after
33698 extracting its addresses). If &%-t%& is not present on the command line, any
33699 existing &'Bcc:'& is not removed.
33700
33701
33702 .section "The Date: header line" "SECID223"
33703 .cindex "&'Date:'& header line"
33704 .cindex "header lines" "Date:"
33705 If a locally-generated or submission-mode message has no &'Date:'& header line,
33706 Exim adds one, using the current date and time, unless the
33707 &%suppress_local_fixups%& control has been specified.
33708
33709 .section "The Delivery-date: header line" "SECID224"
33710 .cindex "&'Delivery-date:'& header line"
33711 .oindex "&%delivery_date_remove%&"
33712 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33713 set. Exim can be configured to add them to the final delivery of messages. (See
33714 the generic &%delivery_date_add%& transport option.) They should not be present
33715 in messages in transit. If the &%delivery_date_remove%& configuration option is
33716 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33717 messages.
33718
33719
33720 .section "The Envelope-to: header line" "SECID225"
33721 .cindex "&'Envelope-to:'& header line"
33722 .cindex "header lines" "Envelope-to:"
33723 .oindex "&%envelope_to_remove%&"
33724 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33725 Exim can be configured to add them to the final delivery of messages. (See the
33726 generic &%envelope_to_add%& transport option.) They should not be present in
33727 messages in transit. If the &%envelope_to_remove%& configuration option is set
33728 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33729 messages.
33730
33731
33732 .section "The From: header line" "SECTthefrohea"
33733 .cindex "&'From:'& header line"
33734 .cindex "header lines" "From:"
33735 .cindex "Sendmail compatibility" "&""From""& line"
33736 .cindex "message" "submission"
33737 .cindex "submission mode"
33738 If a submission-mode message does not contain a &'From:'& header line, Exim
33739 adds one if either of the following conditions is true:
33740
33741 .ilist
33742 The envelope sender address is not empty (that is, this is not a bounce
33743 message). The added header line copies the envelope sender address.
33744 .next
33745 .vindex "&$authenticated_id$&"
33746 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33747 .olist
33748 .vindex "&$qualify_domain$&"
33749 If no domain is specified by the submission control, the local part is
33750 &$authenticated_id$& and the domain is &$qualify_domain$&.
33751 .next
33752 If a non-empty domain is specified by the submission control, the local
33753 part is &$authenticated_id$&, and the domain is the specified domain.
33754 .next
33755 If an empty domain is specified by the submission control,
33756 &$authenticated_id$& is assumed to be the complete address.
33757 .endlist
33758 .endlist
33759
33760 A non-empty envelope sender takes precedence.
33761
33762 If a locally-generated incoming message does not contain a &'From:'& header
33763 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33764 containing the sender's address. The calling user's login name and full name
33765 are used to construct the address, as described in section &<<SECTconstr>>&.
33766 They are obtained from the password data by calling &[getpwuid()]& (but see the
33767 &%unknown_login%& configuration option). The address is qualified with
33768 &%qualify_domain%&.
33769
33770 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33771 &'From:'& header line containing just the unqualified login name of the calling
33772 user, this is replaced by an address containing the user's login name and full
33773 name as described in section &<<SECTconstr>>&.
33774
33775
33776 .section "The Message-ID: header line" "SECID226"
33777 .cindex "&'Message-ID:'& header line"
33778 .cindex "header lines" "Message-ID:"
33779 .cindex "message" "submission"
33780 .oindex "&%message_id_header_text%&"
33781 If a locally-generated or submission-mode incoming message does not contain a
33782 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33783 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33784 to the message. If there are any &'Resent-:'& headers in the message, it
33785 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33786 message id, preceded by the letter E to ensure it starts with a letter, and
33787 followed by @ and the primary host name. Additional information can be included
33788 in this header line by setting the &%message_id_header_text%& and/or
33789 &%message_id_header_domain%& options.
33790
33791
33792 .section "The Received: header line" "SECID227"
33793 .cindex "&'Received:'& header line"
33794 .cindex "header lines" "Received:"
33795 A &'Received:'& header line is added at the start of every message. The
33796 contents are defined by the &%received_header_text%& configuration option, and
33797 Exim automatically adds a semicolon and a timestamp to the configured string.
33798
33799 The &'Received:'& header is generated as soon as the message's header lines
33800 have been received. At this stage, the timestamp in the &'Received:'& header
33801 line is the time that the message started to be received. This is the value
33802 that is seen by the DATA ACL and by the &[local_scan()]& function.
33803
33804 Once a message is accepted, the timestamp in the &'Received:'& header line is
33805 changed to the time of acceptance, which is (apart from a small delay while the
33806 -H spool file is written) the earliest time at which delivery could start.
33807
33808
33809 .section "The References: header line" "SECID228"
33810 .cindex "&'References:'& header line"
33811 .cindex "header lines" "References:"
33812 Messages created by the &(autoreply)& transport include a &'References:'&
33813 header line. This is constructed according to the rules that are described in
33814 section 3.64 of RFC 2822 (which states that replies should contain such a
33815 header line), and section 3.14 of RFC 3834 (which states that automatic
33816 responses are not different in this respect). However, because some mail
33817 processing software does not cope well with very long header lines, no more
33818 than 12 message IDs are copied from the &'References:'& header line in the
33819 incoming message. If there are more than 12, the first one and then the final
33820 11 are copied, before adding the message ID of the incoming message.
33821
33822
33823
33824 .section "The Return-path: header line" "SECID229"
33825 .cindex "&'Return-path:'& header line"
33826 .cindex "header lines" "Return-path:"
33827 .oindex "&%return_path_remove%&"
33828 &'Return-path:'& header lines are defined as something an MTA may insert when
33829 it does the final delivery of messages. (See the generic &%return_path_add%&
33830 transport option.) Therefore, they should not be present in messages in
33831 transit. If the &%return_path_remove%& configuration option is set (the
33832 default), Exim removes &'Return-path:'& header lines from incoming messages.
33833
33834
33835
33836 .section "The Sender: header line" "SECTthesenhea"
33837 .cindex "&'Sender:'& header line"
33838 .cindex "message" "submission"
33839 .cindex "header lines" "Sender:"
33840 For a locally-originated message from an untrusted user, Exim may remove an
33841 existing &'Sender:'& header line, and it may add a new one. You can modify
33842 these actions by setting the &%local_sender_retain%& option true, the
33843 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33844 control setting.
33845
33846 When a local message is received from an untrusted user and
33847 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33848 control has not been set, a check is made to see if the address given in the
33849 &'From:'& header line is the correct (local) sender of the message. The address
33850 that is expected has the login name as the local part and the value of
33851 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33852 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33853 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33854 line is added to the message.
33855
33856 If you set &%local_from_check%& false, this checking does not occur. However,
33857 the removal of an existing &'Sender:'& line still happens, unless you also set
33858 &%local_sender_retain%& to be true. It is not possible to set both of these
33859 options true at the same time.
33860
33861 .cindex "submission mode"
33862 By default, no processing of &'Sender:'& header lines is done for messages
33863 received over TCP/IP or for messages submitted by trusted users. However, when
33864 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33865 not specified on the submission control, the following processing takes place:
33866
33867 .vindex "&$authenticated_id$&"
33868 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33869 authenticated, and &$authenticated_id$& is not empty, a sender address is
33870 created as follows:
33871
33872 .ilist
33873 .vindex "&$qualify_domain$&"
33874 If no domain is specified by the submission control, the local part is
33875 &$authenticated_id$& and the domain is &$qualify_domain$&.
33876 .next
33877 If a non-empty domain is specified by the submission control, the local part
33878 is &$authenticated_id$&, and the domain is the specified domain.
33879 .next
33880 If an empty domain is specified by the submission control,
33881 &$authenticated_id$& is assumed to be the complete address.
33882 .endlist
33883
33884 This address is compared with the address in the &'From:'& header line. If they
33885 are different, a &'Sender:'& header line containing the created address is
33886 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33887 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33888
33889 .cindex "return path" "created from &'Sender:'&"
33890 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33891 the message (the envelope sender address) is changed to be the same address,
33892 except in the case of submission mode when &%sender_retain%& is specified.
33893
33894
33895
33896 .section "Adding and removing header lines in routers and transports" &&&
33897          "SECTheadersaddrem"
33898 .cindex "header lines" "adding; in router or transport"
33899 .cindex "header lines" "removing; in router or transport"
33900 When a message is delivered, the addition and removal of header lines can be
33901 specified in a system filter, or on any of the routers and transports that
33902 process the message. Section &<<SECTaddremheasys>>& contains details about
33903 modifying headers in a system filter. Header lines can also be added in an ACL
33904 as a message is received (see section &<<SECTaddheadacl>>&).
33905
33906 In contrast to what happens in a system filter, header modifications that are
33907 specified on routers and transports apply only to the particular recipient
33908 addresses that are being processed by those routers and transports. These
33909 changes do not actually take place until a copy of the message is being
33910 transported. Therefore, they do not affect the basic set of header lines, and
33911 they do not affect the values of the variables that refer to header lines.
33912
33913 &*Note*&: In particular, this means that any expansions in the configuration of
33914 the transport cannot refer to the modified header lines, because such
33915 expansions all occur before the message is actually transported.
33916
33917 For both routers and transports, the argument of a &%headers_add%&
33918 option must be in the form of one or more RFC 2822 header lines, separated by
33919 newlines (coded as &"\n"&). For example:
33920 .code
33921 headers_add = X-added-header: added by $primary_hostname\n\
33922               X-added-second: another added header line
33923 .endd
33924 Exim does not check the syntax of these added header lines.
33925
33926 Multiple &%headers_add%& options for a single router or transport can be
33927 specified; the values will append to a single list of header lines.
33928 Each header-line is separately expanded.
33929
33930 The argument of a &%headers_remove%& option must consist of a colon-separated
33931 list of header names. This is confusing, because header names themselves are
33932 often terminated by colons. In this case, the colons are the list separators,
33933 not part of the names. For example:
33934 .code
33935 headers_remove = return-receipt-to:acknowledge-to
33936 .endd
33937
33938 Multiple &%headers_remove%& options for a single router or transport can be
33939 specified; the arguments will append to a single header-names list.
33940 Each item is separately expanded.
33941 Note that colons in complex expansions which are used to
33942 form all or part of a &%headers_remove%& list
33943 will act as list separators.
33944
33945 When &%headers_add%& or &%headers_remove%& is specified on a router,
33946 items are expanded at routing time,
33947 and then associated with all addresses that are
33948 accepted by that router, and also with any new addresses that it generates. If
33949 an address passes through several routers as a result of aliasing or
33950 forwarding, the changes are cumulative.
33951
33952 .oindex "&%unseen%&"
33953 However, this does not apply to multiple routers that result from the use of
33954 the &%unseen%& option. Any header modifications that were specified by the
33955 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33956
33957 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33958 settings cannot be delivered together in a batch, so a transport is always
33959 dealing with a set of addresses that have the same header-processing
33960 requirements.
33961
33962 The transport starts by writing the original set of header lines that arrived
33963 with the message, possibly modified by the system filter. As it writes out
33964 these lines, it consults the list of header names that were attached to the
33965 recipient address(es) by &%headers_remove%& options in routers, and it also
33966 consults the transport's own &%headers_remove%& option. Header lines whose
33967 names are on either of these lists are not written out. If there are multiple
33968 instances of any listed header, they are all skipped.
33969
33970 After the remaining original header lines have been written, new header
33971 lines that were specified by routers' &%headers_add%& options are written, in
33972 the order in which they were attached to the address. These are followed by any
33973 header lines specified by the transport's &%headers_add%& option.
33974
33975 This way of handling header line modifications in routers and transports has
33976 the following consequences:
33977
33978 .ilist
33979 The original set of header lines, possibly modified by the system filter,
33980 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33981 to it, at all times.
33982 .next
33983 Header lines that are added by a router's
33984 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33985 expansion syntax in subsequent routers or the transport.
33986 .next
33987 Conversely, header lines that are specified for removal by &%headers_remove%&
33988 in a router remain visible to subsequent routers and the transport.
33989 .next
33990 Headers added to an address by &%headers_add%& in a router cannot be removed by
33991 a later router or by a transport.
33992 .next
33993 An added header can refer to the contents of an original header that is to be
33994 removed, even it has the same name as the added header. For example:
33995 .code
33996 headers_remove = subject
33997 headers_add = Subject: new subject (was: $h_subject:)
33998 .endd
33999 .endlist
34000
34001 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
34002 for a &(redirect)& router that has the &%one_time%& option set.
34003
34004
34005
34006
34007
34008 .section "Constructed addresses" "SECTconstr"
34009 .cindex "address" "constructed"
34010 .cindex "constructed address"
34011 When Exim constructs a sender address for a locally-generated message, it uses
34012 the form
34013 .display
34014 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
34015 .endd
34016 For example:
34017 .code
34018 Zaphod Beeblebrox <zaphod@end.univ.example>
34019 .endd
34020 The user name is obtained from the &%-F%& command line option if set, or
34021 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
34022 &"gecos"& field from the password entry. If the &"gecos"& field contains an
34023 ampersand character, this is replaced by the login name with the first letter
34024 upper cased, as is conventional in a number of operating systems. See the
34025 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
34026 The &%unknown_username%& option can be used to specify user names in cases when
34027 there is no password file entry.
34028
34029 .cindex "RFC 2047"
34030 In all cases, the user name is made to conform to RFC 2822 by quoting all or
34031 parts of it if necessary. In addition, if it contains any non-printing
34032 characters, it is encoded as described in RFC 2047, which defines a way of
34033 including non-ASCII characters in header lines. The value of the
34034 &%headers_charset%& option specifies the name of the encoding that is used (the
34035 characters are assumed to be in this encoding). The setting of
34036 &%print_topbitchars%& controls whether characters with the top bit set (that
34037 is, with codes greater than 127) count as printing characters or not.
34038
34039
34040
34041 .section "Case of local parts" "SECID230"
34042 .cindex "case of local parts"
34043 .cindex "local part" "case of"
34044 RFC 2822 states that the case of letters in the local parts of addresses cannot
34045 be assumed to be non-significant. Exim preserves the case of local parts of
34046 addresses, but by default it uses a lower-cased form when it is routing,
34047 because on most Unix systems, usernames are in lower case and case-insensitive
34048 routing is required. However, any particular router can be made to use the
34049 original case for local parts by setting the &%caseful_local_part%& generic
34050 router option.
34051
34052 .cindex "mixed-case login names"
34053 If you must have mixed-case user names on your system, the best way to proceed,
34054 assuming you want case-independent handling of incoming email, is to set up
34055 your first router to convert incoming local parts in your domains to the
34056 correct case by means of a file lookup. For example:
34057 .code
34058 correct_case:
34059   driver = redirect
34060   domains = +local_domains
34061   data = ${lookup{$local_part}cdb\
34062               {/etc/usercased.cdb}{$value}fail}\
34063               @$domain
34064 .endd
34065 For this router, the local part is forced to lower case by the default action
34066 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
34067 up a new local part in the correct case. If you then set &%caseful_local_part%&
34068 on any subsequent routers which process your domains, they will operate on
34069 local parts with the correct case in a case-sensitive manner.
34070
34071
34072
34073 .section "Dots in local parts" "SECID231"
34074 .cindex "dot" "in local part"
34075 .cindex "local part" "dots in"
34076 RFC 2822 forbids empty components in local parts. That is, an unquoted local
34077 part may not begin or end with a dot, nor have two consecutive dots in the
34078 middle. However, it seems that many MTAs do not enforce this, so Exim permits
34079 empty components for compatibility.
34080
34081
34082
34083 .section "Rewriting addresses" "SECID232"
34084 .cindex "rewriting" "addresses"
34085 Rewriting of sender and recipient addresses, and addresses in headers, can
34086 happen automatically, or as the result of configuration options, as described
34087 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
34088 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
34089
34090 Automatic rewriting includes qualification, as mentioned above. The other case
34091 in which it can happen is when an incomplete non-local domain is given. The
34092 routing process may cause this to be expanded into the full domain name. For
34093 example, a header such as
34094 .code
34095 To: hare@teaparty
34096 .endd
34097 might get rewritten as
34098 .code
34099 To: hare@teaparty.wonderland.fict.example
34100 .endd
34101 Rewriting as a result of routing is the one kind of message processing that
34102 does not happen at input time, as it cannot be done until the address has
34103 been routed.
34104
34105 Strictly, one should not do &'any'& deliveries of a message until all its
34106 addresses have been routed, in case any of the headers get changed as a
34107 result of routing. However, doing this in practice would hold up many
34108 deliveries for unreasonable amounts of time, just because one address could not
34109 immediately be routed. Exim therefore does not delay other deliveries when
34110 routing of one or more addresses is deferred.
34111 .ecindex IIDmesproc
34112
34113
34114
34115 . ////////////////////////////////////////////////////////////////////////////
34116 . ////////////////////////////////////////////////////////////////////////////
34117
34118 .chapter "SMTP processing" "CHAPSMTP"
34119 .scindex IIDsmtpproc1 "SMTP" "processing details"
34120 .scindex IIDsmtpproc2 "LMTP" "processing details"
34121 Exim supports a number of different ways of using the SMTP protocol, and its
34122 LMTP variant, which is an interactive protocol for transferring messages into a
34123 closed mail store application. This chapter contains details of how SMTP is
34124 processed. For incoming mail, the following are available:
34125
34126 .ilist
34127 SMTP over TCP/IP (Exim daemon or &'inetd'&);
34128 .next
34129 SMTP over the standard input and output (the &%-bs%& option);
34130 .next
34131 Batched SMTP on the standard input (the &%-bS%& option).
34132 .endlist
34133
34134 For mail delivery, the following are available:
34135
34136 .ilist
34137 SMTP over TCP/IP (the &(smtp)& transport);
34138 .next
34139 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
34140 &"lmtp"&);
34141 .next
34142 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34143 transport);
34144 .next
34145 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34146 the &%use_bsmtp%& option set).
34147 .endlist
34148
34149 &'Batched SMTP'& is the name for a process in which batches of messages are
34150 stored in or read from files (or pipes), in a format in which SMTP commands are
34151 used to contain the envelope information.
34152
34153
34154
34155 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34156 .cindex "SMTP" "outgoing over TCP/IP"
34157 .cindex "outgoing SMTP over TCP/IP"
34158 .cindex "LMTP" "over TCP/IP"
34159 .cindex "outgoing LMTP over TCP/IP"
34160 .cindex "EHLO"
34161 .cindex "HELO"
34162 .cindex "SIZE option on MAIL command"
34163 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34164 The &%protocol%& option selects which protocol is to be used, but the actual
34165 processing is the same in both cases.
34166
34167 If, in response to its EHLO command, Exim is told that the SIZE
34168 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34169 command. The value of <&'n'&> is the message size plus the value of the
34170 &%size_addition%& option (default 1024) to allow for additions to the message
34171 such as per-transport header lines, or changes made in a
34172 .cindex "transport" "filter"
34173 .cindex "filter" "transport filter"
34174 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34175 suppressed.
34176
34177 If the remote server advertises support for PIPELINING, Exim uses the
34178 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34179 required for the transaction.
34180
34181 If the remote server advertises support for the STARTTLS command, and Exim
34182 was built to support TLS encryption, it tries to start a TLS session unless the
34183 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34184 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34185 is called for verification.
34186
34187 If the remote server advertises support for the AUTH command, Exim scans
34188 the authenticators configuration for any suitable client settings, as described
34189 in chapter &<<CHAPSMTPAUTH>>&.
34190
34191 .cindex "carriage return"
34192 .cindex "linefeed"
34193 Responses from the remote host are supposed to be terminated by CR followed by
34194 LF. However, there are known to be hosts that do not send CR characters, so in
34195 order to be able to interwork with such hosts, Exim treats LF on its own as a
34196 line terminator.
34197
34198 If a message contains a number of different addresses, all those with the same
34199 characteristics (for example, the same envelope sender) that resolve to the
34200 same set of hosts, in the same order, are sent in a single SMTP transaction,
34201 even if they are for different domains, unless there are more than the setting
34202 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34203 they are split into groups containing no more than &%max_rcpt%&s addresses
34204 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34205 in parallel sessions. The order of hosts with identical MX values is not
34206 significant when checking whether addresses can be batched in this way.
34207
34208 When the &(smtp)& transport suffers a temporary failure that is not
34209 message-related, Exim updates its transport-specific database, which contains
34210 records indexed by host name that remember which messages are waiting for each
34211 particular host. It also updates the retry database with new retry times.
34212
34213 .cindex "hints database" "retry keys"
34214 Exim's retry hints are based on host name plus IP address, so if one address of
34215 a multi-homed host is broken, it will soon be skipped most of the time.
34216 See the next section for more detail about error handling.
34217
34218 .cindex "SMTP" "passed connection"
34219 .cindex "SMTP" "batching over TCP/IP"
34220 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34221 looks in the hints database for the transport to see if there are any queued
34222 messages waiting for the host to which it is connected. If it finds one, it
34223 creates a new Exim process using the &%-MC%& option (which can only be used by
34224 a process running as root or the Exim user) and passes the TCP/IP socket to it
34225 so that it can deliver another message using the same socket. The new process
34226 does only those deliveries that are routed to the connected host, and may in
34227 turn pass the socket on to a third process, and so on.
34228
34229 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34230 limit the number of messages sent down a single TCP/IP connection.
34231
34232 .cindex "asterisk" "after IP address"
34233 The second and subsequent messages delivered down an existing connection are
34234 identified in the main log by the addition of an asterisk after the closing
34235 square bracket of the IP address.
34236
34237
34238
34239
34240 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34241 .cindex "error" "in outgoing SMTP"
34242 .cindex "SMTP" "errors in outgoing"
34243 .cindex "host" "error"
34244 Three different kinds of error are recognized for outgoing SMTP: host errors,
34245 message errors, and recipient errors.
34246
34247 .vlist
34248 .vitem "&*Host errors*&"
34249 A host error is not associated with a particular message or with a
34250 particular recipient of a message. The host errors are:
34251
34252 .ilist
34253 Connection refused or timed out,
34254 .next
34255 Any error response code on connection,
34256 .next
34257 Any error response code to EHLO or HELO,
34258 .next
34259 Loss of connection at any time, except after &"."&,
34260 .next
34261 I/O errors at any time,
34262 .next
34263 Timeouts during the session, other than in response to MAIL, RCPT or
34264 the &"."& at the end of the data.
34265 .endlist ilist
34266
34267 For a host error, a permanent error response on connection, or in response to
34268 EHLO, causes all addresses routed to the host to be failed. Any other host
34269 error causes all addresses to be deferred, and retry data to be created for the
34270 host. It is not tried again, for any message, until its retry time arrives. If
34271 the current set of addresses are not all delivered in this run (to some
34272 alternative host), the message is added to the list of those waiting for this
34273 host, so if it is still undelivered when a subsequent successful delivery is
34274 made to the host, it will be sent down the same SMTP connection.
34275
34276 .vitem "&*Message errors*&"
34277 .cindex "message" "error"
34278 A message error is associated with a particular message when sent to a
34279 particular host, but not with a particular recipient of the message. The
34280 message errors are:
34281
34282 .ilist
34283 Any error response code to MAIL, DATA, or the &"."& that terminates
34284 the data,
34285 .next
34286 Timeout after MAIL,
34287 .next
34288 Timeout or loss of connection after the &"."& that terminates the data. A
34289 timeout after the DATA command itself is treated as a host error, as is loss of
34290 connection at any other time.
34291 .endlist ilist
34292
34293 For a message error, a permanent error response (5&'xx'&) causes all addresses
34294 to be failed, and a delivery error report to be returned to the sender. A
34295 temporary error response (4&'xx'&), or one of the timeouts, causes all
34296 addresses to be deferred. Retry data is not created for the host, but instead,
34297 a retry record for the combination of host plus message id is created. The
34298 message is not added to the list of those waiting for this host. This ensures
34299 that the failing message will not be sent to this host again until the retry
34300 time arrives. However, other messages that are routed to the host are not
34301 affected, so if it is some property of the message that is causing the error,
34302 it will not stop the delivery of other mail.
34303
34304 If the remote host specified support for the SIZE parameter in its response
34305 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34306 over-large message will cause a message error because the error arrives as a
34307 response to MAIL.
34308
34309 .vitem "&*Recipient errors*&"
34310 .cindex "recipient" "error"
34311 A recipient error is associated with a particular recipient of a message. The
34312 recipient errors are:
34313
34314 .ilist
34315 Any error response to RCPT,
34316 .next
34317 Timeout after RCPT.
34318 .endlist
34319
34320 For a recipient error, a permanent error response (5&'xx'&) causes the
34321 recipient address to be failed, and a bounce message to be returned to the
34322 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34323 address to be deferred, and routing retry data to be created for it. This is
34324 used to delay processing of the address in subsequent queue runs, until its
34325 routing retry time arrives. This applies to all messages, but because it
34326 operates only in queue runs, one attempt will be made to deliver a new message
34327 to the failing address before the delay starts to operate. This ensures that,
34328 if the failure is really related to the message rather than the recipient
34329 (&"message too big for this recipient"& is a possible example), other messages
34330 have a chance of getting delivered. If a delivery to the address does succeed,
34331 the retry information gets cleared, so all stuck messages get tried again, and
34332 the retry clock is reset.
34333
34334 The message is not added to the list of those waiting for this host. Use of the
34335 host for other messages is unaffected, and except in the case of a timeout,
34336 other recipients are processed independently, and may be successfully delivered
34337 in the current SMTP session. After a timeout it is of course impossible to
34338 proceed with the session, so all addresses get deferred. However, those other
34339 than the one that failed do not suffer any subsequent retry delays. Therefore,
34340 if one recipient is causing trouble, the others have a chance of getting
34341 through when a subsequent delivery attempt occurs before the failing
34342 recipient's retry time.
34343 .endlist
34344
34345 In all cases, if there are other hosts (or IP addresses) available for the
34346 current set of addresses (for example, from multiple MX records), they are
34347 tried in this run for any undelivered addresses, subject of course to their
34348 own retry data. In other words, recipient error retry data does not take effect
34349 until the next delivery attempt.
34350
34351 Some hosts have been observed to give temporary error responses to every
34352 MAIL command at certain times (&"insufficient space"& has been seen). It
34353 would be nice if such circumstances could be recognized, and defer data for the
34354 host itself created, but this is not possible within the current Exim design.
34355 What actually happens is that retry data for every (host, message) combination
34356 is created.
34357
34358 The reason that timeouts after MAIL and RCPT are treated specially is that
34359 these can sometimes arise as a result of the remote host's verification
34360 procedures. Exim makes this assumption, and treats them as if a temporary error
34361 response had been received. A timeout after &"."& is treated specially because
34362 it is known that some broken implementations fail to recognize the end of the
34363 message if the last character of the last line is a binary zero. Thus, it is
34364 helpful to treat this case as a message error.
34365
34366 Timeouts at other times are treated as host errors, assuming a problem with the
34367 host, or the connection to it. If a timeout after MAIL, RCPT,
34368 or &"."& is really a connection problem, the assumption is that at the next try
34369 the timeout is likely to occur at some other point in the dialogue, causing it
34370 then to be treated as a host error.
34371
34372 There is experimental evidence that some MTAs drop the connection after the
34373 terminating &"."& if they do not like the contents of the message for some
34374 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34375 should be given. That is why Exim treats this case as a message rather than a
34376 host error, in order not to delay other messages to the same host.
34377
34378
34379
34380
34381 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34382 .cindex "SMTP" "incoming over TCP/IP"
34383 .cindex "incoming SMTP over TCP/IP"
34384 .cindex "inetd"
34385 .cindex "daemon"
34386 Incoming SMTP messages can be accepted in one of two ways: by running a
34387 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34388 &_/etc/inetd.conf_& should be like this:
34389 .code
34390 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34391 .endd
34392 Exim distinguishes between this case and the case of a locally running user
34393 agent using the &%-bs%& option by checking whether or not the standard input is
34394 a socket. When it is, either the port must be privileged (less than 1024), or
34395 the caller must be root or the Exim user. If any other user passes a socket
34396 with an unprivileged port number, Exim prints a message on the standard error
34397 stream and exits with an error code.
34398
34399 By default, Exim does not make a log entry when a remote host connects or
34400 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34401 unexpected. It can be made to write such log entries by setting the
34402 &%smtp_connection%& log selector.
34403
34404 .cindex "carriage return"
34405 .cindex "linefeed"
34406 Commands from the remote host are supposed to be terminated by CR followed by
34407 LF. However, there are known to be hosts that do not send CR characters. In
34408 order to be able to interwork with such hosts, Exim treats LF on its own as a
34409 line terminator.
34410 Furthermore, because common code is used for receiving messages from all
34411 sources, a CR on its own is also interpreted as a line terminator. However, the
34412 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34413
34414 .cindex "EHLO" "invalid data"
34415 .cindex "HELO" "invalid data"
34416 One area that sometimes gives rise to problems concerns the EHLO or
34417 HELO commands. Some clients send syntactically invalid versions of these
34418 commands, which Exim rejects by default. (This is nothing to do with verifying
34419 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34420 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34421 match the broken hosts that send invalid commands.
34422
34423 .cindex "SIZE option on MAIL command"
34424 .cindex "MAIL" "SIZE option"
34425 The amount of disk space available is checked whenever SIZE is received on
34426 a MAIL command, independently of whether &%message_size_limit%& or
34427 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34428 false. A temporary error is given if there is not enough space. If
34429 &%check_spool_space%& is set, the check is for that amount of space plus the
34430 value given with SIZE, that is, it checks that the addition of the incoming
34431 message will not reduce the space below the threshold.
34432
34433 When a message is successfully received, Exim includes the local message id in
34434 its response to the final &"."& that terminates the data. If the remote host
34435 logs this text it can help with tracing what has happened to a message.
34436
34437 The Exim daemon can limit the number of simultaneous incoming connections it is
34438 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34439 number of simultaneous incoming connections from a single remote host (see the
34440 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34441 rejected using the SMTP temporary error code 421.
34442
34443 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34444 subprocess has finished, as this can get lost at busy times. Instead, it looks
34445 for completed subprocesses every time it wakes up. Provided there are other
34446 things happening (new incoming calls, starts of queue runs), completed
34447 processes will be noticed and tidied away. On very quiet systems you may
34448 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34449 it will be noticed when the daemon next wakes up.
34450
34451 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34452 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34453 high system load &-- for details see the &%smtp_accept_reserve%&,
34454 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34455 applies in both the daemon and &'inetd'& cases.
34456
34457 Exim normally starts a delivery process for each message received, though this
34458 can be varied by means of the &%-odq%& command line option and the
34459 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34460 number of simultaneously running delivery processes started in this way from
34461 SMTP input can be limited by the &%smtp_accept_queue%& and
34462 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34463 subsequently received messages are just put on the input queue without starting
34464 a delivery process.
34465
34466 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34467 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34468 started up from the &'inetd'& daemon, because in that case each connection is
34469 handled by an entirely independent Exim process. Control by load average is,
34470 however, available with &'inetd'&.
34471
34472 Exim can be configured to verify addresses in incoming SMTP commands as they
34473 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34474 to rewrite addresses at this time &-- before any syntax checking is done. See
34475 section &<<SECTrewriteS>>&.
34476
34477 Exim can also be configured to limit the rate at which a client host submits
34478 MAIL and RCPT commands in a single SMTP session. See the
34479 &%smtp_ratelimit_hosts%& option.
34480
34481
34482
34483 .section "Unrecognized SMTP commands" "SECID234"
34484 .cindex "SMTP" "unrecognized commands"
34485 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34486 commands during a single SMTP connection, it drops the connection after sending
34487 the error response to the last command. The default value for
34488 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34489 abuse that subvert web servers into making connections to SMTP ports; in these
34490 circumstances, a number of non-SMTP lines are sent first.
34491
34492
34493 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34494 .cindex "SMTP" "syntax errors"
34495 .cindex "SMTP" "protocol errors"
34496 A syntax error is detected if an SMTP command is recognized, but there is
34497 something syntactically wrong with its data, for example, a malformed email
34498 address in a RCPT command. Protocol errors include invalid command
34499 sequencing such as RCPT before MAIL. If Exim receives more than
34500 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34501 drops the connection after sending the error response to the last command. The
34502 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34503 broken clients that loop sending bad commands (yes, it has been seen).
34504
34505
34506
34507 .section "Use of non-mail SMTP commands" "SECID236"
34508 .cindex "SMTP" "non-mail commands"
34509 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34510 DATA. Exim counts such commands, and drops the connection if there are too
34511 many of them in a single SMTP session. This action catches some
34512 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34513 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34514 defines what &"too many"& means. Its default value is 10.
34515
34516 When a new message is expected, one occurrence of RSET is not counted. This
34517 allows a client to send one RSET between messages (this is not necessary,
34518 but some clients do it). Exim also allows one uncounted occurrence of HELO
34519 or EHLO, and one occurrence of STARTTLS between messages. After
34520 starting up a TLS session, another EHLO is expected, and so it too is not
34521 counted.
34522
34523 The first occurrence of AUTH in a connection, or immediately following
34524 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34525 RCPT, DATA, and QUIT are counted.
34526
34527 You can control which hosts are subject to the limit set by
34528 &%smtp_accept_max_nonmail%& by setting
34529 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34530 the limit apply to all hosts. This option means that you can exclude any
34531 specific badly-behaved hosts that you have to live with.
34532
34533
34534
34535
34536 .section "The VRFY and EXPN commands" "SECID237"
34537 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34538 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34539 appropriate) in order to decide whether the command should be accepted or not.
34540
34541 .cindex "VRFY" "processing"
34542 When no ACL is defined for VRFY, or if it rejects without
34543 setting an explicit response code, the command is accepted
34544 (with a 252 SMTP response code)
34545 in order to support awkward clients that do a VRFY before every RCPT.
34546 When VRFY is accepted, it runs exactly the same code as when Exim is
34547 called with the &%-bv%& option, and returns 250/451/550
34548 SMTP response codes.
34549
34550 .cindex "EXPN" "processing"
34551 If no ACL for EXPN is defined, the command is rejected.
34552 When EXPN is accepted, a single-level expansion of the address is done.
34553 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34554 than a verification (the &%-bv%& option). If an unqualified local part is given
34555 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34556 of VRFY and EXPN commands are logged on the main and reject logs, and
34557 VRFY verification failures are logged on the main log for consistency with
34558 RCPT failures.
34559
34560
34561
34562 .section "The ETRN command" "SECTETRN"
34563 .cindex "ETRN" "processing"
34564 RFC 1985 describes an SMTP command called ETRN that is designed to
34565 overcome the security problems of the TURN command (which has fallen into
34566 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34567 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34568 should be accepted or not. If no ACL is defined, the command is rejected.
34569
34570 The ETRN command is concerned with &"releasing"& messages that are awaiting
34571 delivery to certain hosts. As Exim does not organize its message queue by host,
34572 the only form of ETRN that is supported by default is the one where the
34573 text starts with the &"#"& prefix, in which case the remainder of the text is
34574 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34575 the &%-R%& option to happen, with the remainder of the ETRN text as its
34576 argument. For example,
34577 .code
34578 ETRN #brigadoon
34579 .endd
34580 runs the command
34581 .code
34582 exim -R brigadoon
34583 .endd
34584 which causes a delivery attempt on all messages with undelivered addresses
34585 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34586 default), Exim prevents the simultaneous execution of more than one queue run
34587 for the same argument string as a result of an ETRN command. This stops
34588 a misbehaving client from starting more than one queue runner at once.
34589
34590 .cindex "hints database" "ETRN serialization"
34591 Exim implements the serialization by means of a hints database in which a
34592 record is written whenever a process is started by ETRN, and deleted when
34593 the process completes. However, Exim does not keep the SMTP session waiting for
34594 the ETRN process to complete. Once ETRN is accepted, the client is sent
34595 a &"success"& return code. Obviously there is scope for hints records to get
34596 left lying around if there is a system or program crash. To guard against this,
34597 Exim ignores any records that are more than six hours old.
34598
34599 .oindex "&%smtp_etrn_command%&"
34600 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34601 used. This specifies a command that is run whenever ETRN is received,
34602 whatever the form of its argument. For
34603 example:
34604 .code
34605 smtp_etrn_command = /etc/etrn_command $domain \
34606                     $sender_host_address
34607 .endd
34608 .vindex "&$domain$&"
34609 The string is split up into arguments which are independently expanded. The
34610 expansion variable &$domain$& is set to the argument of the ETRN command,
34611 and no syntax checking is done on the contents of this argument. Exim does not
34612 wait for the command to complete, so its status code is not checked. Exim runs
34613 under its own uid and gid when receiving incoming SMTP, so it is not possible
34614 for it to change them before running the command.
34615
34616
34617
34618 .section "Incoming local SMTP" "SECID238"
34619 .cindex "SMTP" "local incoming"
34620 Some user agents use SMTP to pass messages to their local MTA using the
34621 standard input and output, as opposed to passing the envelope on the command
34622 line and writing the message to the standard input. This is supported by the
34623 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34624 messages over TCP/IP (including the use of ACLs), except that the envelope
34625 sender given in a MAIL command is ignored unless the caller is trusted. In
34626 an ACL you can detect this form of SMTP input by testing for an empty host
34627 identification. It is common to have this as the first line in the ACL that
34628 runs for RCPT commands:
34629 .code
34630 accept hosts = :
34631 .endd
34632 This accepts SMTP messages from local processes without doing any other tests.
34633
34634
34635
34636 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34637 .cindex "SMTP" "batched outgoing"
34638 .cindex "batched SMTP output"
34639 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34640 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34641 be output in BSMTP format. No SMTP responses are possible for this form of
34642 delivery. All it is doing is using SMTP commands as a way of transmitting the
34643 envelope along with the message.
34644
34645 The message is written to the file or pipe preceded by the SMTP commands
34646 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34647 the message that start with a dot have an extra dot added. The SMTP command
34648 HELO is not normally used. If it is required, the &%message_prefix%& option
34649 can be used to specify it.
34650
34651 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34652 one recipient address at a time by default. However, you can arrange for them
34653 to handle several addresses at once by setting the &%batch_max%& option. When
34654 this is done for BSMTP, messages may contain multiple RCPT commands. See
34655 chapter &<<CHAPbatching>>& for more details.
34656
34657 .vindex "&$host$&"
34658 When one or more addresses are routed to a BSMTP transport by a router that
34659 sets up a host list, the name of the first host on the list is available to the
34660 transport in the variable &$host$&. Here is an example of such a transport and
34661 router:
34662 .code
34663 begin routers
34664 route_append:
34665   driver = manualroute
34666   transport = smtp_appendfile
34667   route_list = domain.example  batch.host.example
34668
34669 begin transports
34670 smtp_appendfile:
34671   driver = appendfile
34672   directory = /var/bsmtp/$host
34673   batch_max = 1000
34674   use_bsmtp
34675   user = exim
34676 .endd
34677 This causes messages addressed to &'domain.example'& to be written in BSMTP
34678 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34679 message (unless there are more than 1000 recipients).
34680
34681
34682
34683 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34684 .cindex "SMTP" "batched incoming"
34685 .cindex "batched SMTP input"
34686 The &%-bS%& command line option causes Exim to accept one or more messages by
34687 reading SMTP on the standard input, but to generate no responses. If the caller
34688 is trusted, the senders in the MAIL commands are believed; otherwise the
34689 sender is always the caller of Exim. Unqualified senders and receivers are not
34690 rejected (there seems little point) but instead just get qualified. HELO
34691 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34692 as NOOP; QUIT quits.
34693
34694 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34695 ACL is run in the same way as for non-SMTP local input.
34696
34697 If an error is detected while reading a message, including a missing &"."& at
34698 the end, Exim gives up immediately. It writes details of the error to the
34699 standard output in a stylized way that the calling program should be able to
34700 make some use of automatically, for example:
34701 .code
34702 554 Unexpected end of file
34703 Transaction started in line 10
34704 Error detected in line 14
34705 .endd
34706 It writes a more verbose version, for human consumption, to the standard error
34707 file, for example:
34708 .code
34709 An error was detected while processing a file of BSMTP input.
34710 The error message was:
34711
34712 501 '>' missing at end of address
34713
34714 The SMTP transaction started in line 10.
34715 The error was detected in line 12.
34716 The SMTP command at fault was:
34717
34718 rcpt to:<malformed@in.com.plete
34719
34720 1 previous message was successfully processed.
34721 The rest of the batch was abandoned.
34722 .endd
34723 The return code from Exim is zero only if there were no errors. It is 1 if some
34724 messages were accepted before an error was detected, and 2 if no messages were
34725 accepted.
34726 .ecindex IIDsmtpproc1
34727 .ecindex IIDsmtpproc2
34728
34729
34730
34731 . ////////////////////////////////////////////////////////////////////////////
34732 . ////////////////////////////////////////////////////////////////////////////
34733
34734 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34735          "Customizing messages"
34736 When a message fails to be delivered, or remains on the queue for more than a
34737 configured amount of time, Exim sends a message to the original sender, or
34738 to an alternative configured address. The text of these messages is built into
34739 the code of Exim, but it is possible to change it, either by adding a single
34740 string, or by replacing each of the paragraphs by text supplied in a file.
34741
34742 The &'From:'& and &'To:'& header lines are automatically generated; you can
34743 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34744 option. Exim also adds the line
34745 .code
34746 Auto-Submitted: auto-generated
34747 .endd
34748 to all warning and bounce messages,
34749
34750
34751 .section "Customizing bounce messages" "SECID239"
34752 .cindex "customizing" "bounce message"
34753 .cindex "bounce message" "customizing"
34754 If &%bounce_message_text%& is set, its contents are included in the default
34755 message immediately after &"This message was created automatically by mail
34756 delivery software."& The string is not expanded. It is not used if
34757 &%bounce_message_file%& is set.
34758
34759 When &%bounce_message_file%& is set, it must point to a template file for
34760 constructing error messages. The file consists of a series of text items,
34761 separated by lines consisting of exactly four asterisks. If the file cannot be
34762 opened, default text is used and a message is written to the main and panic
34763 logs. If any text item in the file is empty, default text is used for that
34764 item.
34765
34766 .vindex "&$bounce_recipient$&"
34767 .vindex "&$bounce_return_size_limit$&"
34768 Each item of text that is read from the file is expanded, and there are two
34769 expansion variables which can be of use here: &$bounce_recipient$& is set to
34770 the recipient of an error message while it is being created, and
34771 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34772 option, rounded to a whole number.
34773
34774 The items must appear in the file in the following order:
34775
34776 .ilist
34777 The first item is included in the headers, and should include at least a
34778 &'Subject:'& header. Exim does not check the syntax of these headers.
34779 .next
34780 The second item forms the start of the error message. After it, Exim lists the
34781 failing addresses with their error messages.
34782 .next
34783 The third item is used to introduce any text from pipe transports that is to be
34784 returned to the sender. It is omitted if there is no such text.
34785 .next
34786 The fourth, fifth and sixth items will be ignored and may be empty.
34787 The fields exist for back-compatibility
34788 .endlist
34789
34790 The default state (&%bounce_message_file%& unset) is equivalent to the
34791 following file, in which the sixth item is empty. The &'Subject:'& and some
34792 other lines have been split in order to fit them on the page:
34793 .code
34794 Subject: Mail delivery failed
34795   ${if eq{$sender_address}{$bounce_recipient}
34796   {: returning message to sender}}
34797 ****
34798 This message was created automatically by mail delivery software.
34799
34800 A message ${if eq{$sender_address}{$bounce_recipient}
34801   {that you sent }{sent by
34802
34803 <$sender_address>
34804
34805 }}could not be delivered to all of its recipients.
34806 This is a permanent error. The following address(es) failed:
34807 ****
34808 The following text was generated during the delivery attempt(s):
34809 ****
34810 ------ This is a copy of the message, including all the headers.
34811   ------
34812 ****
34813 ------ The body of the message is $message_size characters long;
34814   only the first
34815 ------ $bounce_return_size_limit or so are included here.
34816 ****
34817 .endd
34818 .section "Customizing warning messages" "SECTcustwarn"
34819 .cindex "customizing" "warning message"
34820 .cindex "warning of delay" "customizing the message"
34821 The option &%warn_message_file%& can be pointed at a template file for use when
34822 warnings about message delays are created. In this case there are only three
34823 text sections:
34824
34825 .ilist
34826 The first item is included in the headers, and should include at least a
34827 &'Subject:'& header. Exim does not check the syntax of these headers.
34828 .next
34829 The second item forms the start of the warning message. After it, Exim lists
34830 the delayed addresses.
34831 .next
34832 The third item then ends the message.
34833 .endlist
34834
34835 The default state is equivalent to the following file, except that some lines
34836 have been split here, in order to fit them on the page:
34837 .code
34838 Subject: Warning: message $message_exim_id delayed
34839   $warn_message_delay
34840 ****
34841 This message was created automatically by mail delivery software.
34842
34843 A message ${if eq{$sender_address}{$warn_message_recipients}
34844 {that you sent }{sent by
34845
34846 <$sender_address>
34847
34848 }}has not been delivered to all of its recipients after
34849 more than $warn_message_delay on the queue on $primary_hostname.
34850
34851 The message identifier is:     $message_exim_id
34852 The subject of the message is: $h_subject
34853 The date of the message is:    $h_date
34854
34855 The following address(es) have not yet been delivered:
34856 ****
34857 No action is required on your part. Delivery attempts will
34858 continue for some time, and this warning may be repeated at
34859 intervals if the message remains undelivered. Eventually the
34860 mail delivery software will give up, and when that happens,
34861 the message will be returned to you.
34862 .endd
34863 .vindex "&$warn_message_delay$&"
34864 .vindex "&$warn_message_recipients$&"
34865 However, in the default state the subject and date lines are omitted if no
34866 appropriate headers exist. During the expansion of this file,
34867 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34868 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34869 of recipients for the warning message. There may be more than one if there are
34870 multiple addresses with different &%errors_to%& settings on the routers that
34871 handled them.
34872
34873
34874
34875
34876 . ////////////////////////////////////////////////////////////////////////////
34877 . ////////////////////////////////////////////////////////////////////////////
34878
34879 .chapter "Some common configuration settings" "CHAPcomconreq"
34880 This chapter discusses some configuration settings that seem to be fairly
34881 common. More examples and discussion can be found in the Exim book.
34882
34883
34884
34885 .section "Sending mail to a smart host" "SECID240"
34886 .cindex "smart host" "example router"
34887 If you want to send all mail for non-local domains to a &"smart host"&, you
34888 should replace the default &(dnslookup)& router with a router which does the
34889 routing explicitly:
34890 .code
34891 send_to_smart_host:
34892   driver = manualroute
34893   route_list = !+local_domains smart.host.name
34894   transport = remote_smtp
34895 .endd
34896 You can use the smart host's IP address instead of the name if you wish.
34897 If you are using Exim only to submit messages to a smart host, and not for
34898 receiving incoming messages, you can arrange for it to do the submission
34899 synchronously by setting the &%mua_wrapper%& option (see chapter
34900 &<<CHAPnonqueueing>>&).
34901
34902
34903
34904
34905 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34906 .cindex "mailing lists"
34907 Exim can be used to run simple mailing lists, but for large and/or complicated
34908 requirements, the use of additional specialized mailing list software such as
34909 Majordomo or Mailman is recommended.
34910
34911 The &(redirect)& router can be used to handle mailing lists where each list
34912 is maintained in a separate file, which can therefore be managed by an
34913 independent manager. The &%domains%& router option can be used to run these
34914 lists in a separate domain from normal mail. For example:
34915 .code
34916 lists:
34917   driver = redirect
34918   domains = lists.example
34919   file = /usr/lists/$local_part
34920   forbid_pipe
34921   forbid_file
34922   errors_to = $local_part-request@lists.example
34923   no_more
34924 .endd
34925 This router is skipped for domains other than &'lists.example'&. For addresses
34926 in that domain, it looks for a file that matches the local part. If there is no
34927 such file, the router declines, but because &%no_more%& is set, no subsequent
34928 routers are tried, and so the whole delivery fails.
34929
34930 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34931 expanded into a file name or a pipe delivery, which is usually inappropriate in
34932 a mailing list.
34933
34934 .oindex "&%errors_to%&"
34935 The &%errors_to%& option specifies that any delivery errors caused by addresses
34936 taken from a mailing list are to be sent to the given address rather than the
34937 original sender of the message. However, before acting on this, Exim verifies
34938 the error address, and ignores it if verification fails.
34939
34940 For example, using the configuration above, mail sent to
34941 &'dicts@lists.example'& is passed on to those addresses contained in
34942 &_/usr/lists/dicts_&, with error reports directed to
34943 &'dicts-request@lists.example'&, provided that this address can be verified.
34944 There could be a file called &_/usr/lists/dicts-request_& containing
34945 the address(es) of this particular list's manager(s), but other approaches,
34946 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34947 or &%local_part_suffix%& options) to handle addresses of the form
34948 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34949
34950
34951
34952 .section "Syntax errors in mailing lists" "SECID241"
34953 .cindex "mailing lists" "syntax errors in"
34954 If an entry in redirection data contains a syntax error, Exim normally defers
34955 delivery of the original address. That means that a syntax error in a mailing
34956 list holds up all deliveries to the list. This may not be appropriate when a
34957 list is being maintained automatically from data supplied by users, and the
34958 addresses are not rigorously checked.
34959
34960 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34961 entries that fail to parse, noting the incident in the log. If in addition
34962 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34963 whenever a broken address is skipped. It is usually appropriate to set
34964 &%syntax_errors_to%& to the same address as &%errors_to%&.
34965
34966
34967
34968 .section "Re-expansion of mailing lists" "SECID242"
34969 .cindex "mailing lists" "re-expansion of"
34970 Exim remembers every individual address to which a message has been delivered,
34971 in order to avoid duplication, but it normally stores only the original
34972 recipient addresses with a message. If all the deliveries to a mailing list
34973 cannot be done at the first attempt, the mailing list is re-expanded when the
34974 delivery is next tried. This means that alterations to the list are taken into
34975 account at each delivery attempt, so addresses that have been added to
34976 the list since the message arrived will therefore receive a copy of the
34977 message, even though it pre-dates their subscription.
34978
34979 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34980 on the &(redirect)& router. If this is done, any addresses generated by the
34981 router that fail to deliver at the first attempt are added to the message as
34982 &"top level"& addresses, and the parent address that generated them is marked
34983 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34984 subsequent delivery attempts. The disadvantage of this is that if any of the
34985 failing addresses are incorrect, correcting them in the file has no effect on
34986 pre-existing messages.
34987
34988 The original top-level address is remembered with each of the generated
34989 addresses, and is output in any log messages. However, any intermediate parent
34990 addresses are not recorded. This makes a difference to the log only if the
34991 &%all_parents%& selector is set, but for mailing lists there is normally only
34992 one level of expansion anyway.
34993
34994
34995
34996 .section "Closed mailing lists" "SECID243"
34997 .cindex "mailing lists" "closed"
34998 The examples so far have assumed open mailing lists, to which anybody may
34999 send mail. It is also possible to set up closed lists, where mail is accepted
35000 from specified senders only. This is done by making use of the generic
35001 &%senders%& option to restrict the router that handles the list.
35002
35003 The following example uses the same file as a list of recipients and as a list
35004 of permitted senders. It requires three routers:
35005 .code
35006 lists_request:
35007   driver = redirect
35008   domains = lists.example
35009   local_part_suffix = -request
35010   file = /usr/lists/$local_part$local_part_suffix
35011   no_more
35012
35013 lists_post:
35014   driver = redirect
35015   domains = lists.example
35016   senders = ${if exists {/usr/lists/$local_part}\
35017              {lsearch;/usr/lists/$local_part}{*}}
35018   file = /usr/lists/$local_part
35019   forbid_pipe
35020   forbid_file
35021   errors_to = $local_part-request@lists.example
35022   no_more
35023
35024 lists_closed:
35025   driver = redirect
35026   domains = lists.example
35027   allow_fail
35028   data = :fail: $local_part@lists.example is a closed mailing list
35029 .endd
35030 All three routers have the same &%domains%& setting, so for any other domains,
35031 they are all skipped. The first router runs only if the local part ends in
35032 &%-request%&. It handles messages to the list manager(s) by means of an open
35033 mailing list.
35034
35035 The second router runs only if the &%senders%& precondition is satisfied. It
35036 checks for the existence of a list that corresponds to the local part, and then
35037 checks that the sender is on the list by means of a linear search. It is
35038 necessary to check for the existence of the file before trying to search it,
35039 because otherwise Exim thinks there is a configuration error. If the file does
35040 not exist, the expansion of &%senders%& is *, which matches all senders. This
35041 means that the router runs, but because there is no list, declines, and
35042 &%no_more%& ensures that no further routers are run. The address fails with an
35043 &"unrouteable address"& error.
35044
35045 The third router runs only if the second router is skipped, which happens when
35046 a mailing list exists, but the sender is not on it. This router forcibly fails
35047 the address, giving a suitable error message.
35048
35049
35050
35051
35052 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
35053 .cindex "VERP"
35054 .cindex "Variable Envelope Return Paths"
35055 .cindex "envelope sender"
35056 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
35057 are a way of helping mailing list administrators discover which subscription
35058 address is the cause of a particular delivery failure. The idea is to encode
35059 the original recipient address in the outgoing envelope sender address, so that
35060 if the message is forwarded by another host and then subsequently bounces, the
35061 original recipient can be extracted from the recipient address of the bounce.
35062
35063 .oindex &%errors_to%&
35064 .oindex &%return_path%&
35065 Envelope sender addresses can be modified by Exim using two different
35066 facilities: the &%errors_to%& option on a router (as shown in previous mailing
35067 list examples), or the &%return_path%& option on a transport. The second of
35068 these is effective only if the message is successfully delivered to another
35069 host; it is not used for errors detected on the local host (see the description
35070 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
35071 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
35072 .code
35073 verp_smtp:
35074   driver = smtp
35075   max_rcpt = 1
35076   return_path = \
35077     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35078       {$1-request+$local_part=$domain@your.dom.example}fail}
35079 .endd
35080 This has the effect of rewriting the return path (envelope sender) on outgoing
35081 SMTP messages, if the local part of the original return path ends in
35082 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
35083 local part and domain of the recipient into the return path. Suppose, for
35084 example, that a message whose return path has been set to
35085 &'somelist-request@your.dom.example'& is sent to
35086 &'subscriber@other.dom.example'&. In the transport, the return path is
35087 rewritten as
35088 .code
35089 somelist-request+subscriber=other.dom.example@your.dom.example
35090 .endd
35091 .vindex "&$local_part$&"
35092 For this to work, you must tell Exim to send multiple copies of messages that
35093 have more than one recipient, so that each copy has just one recipient. This is
35094 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
35095 might be sent to several different recipients in the same domain, in which case
35096 &$local_part$& is not available in the transport, because it is not unique.
35097
35098 Unless your host is doing nothing but mailing list deliveries, you should
35099 probably use a separate transport for the VERP deliveries, so as not to use
35100 extra resources in making one-per-recipient copies for other deliveries. This
35101 can easily be done by expanding the &%transport%& option in the router:
35102 .code
35103 dnslookup:
35104   driver = dnslookup
35105   domains = ! +local_domains
35106   transport = \
35107     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35108       {verp_smtp}{remote_smtp}}
35109   no_more
35110 .endd
35111 If you want to change the return path using &%errors_to%& in a router instead
35112 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
35113 routers that handle mailing list addresses. This will ensure that all delivery
35114 errors, including those detected on the local host, are sent to the VERP
35115 address.
35116
35117 On a host that does no local deliveries and has no manual routing, only the
35118 &(dnslookup)& router needs to be changed. A special transport is not needed for
35119 SMTP deliveries. Every mailing list recipient has its own return path value,
35120 and so Exim must hand them to the transport one at a time. Here is an example
35121 of a &(dnslookup)& router that implements VERP:
35122 .code
35123 verp_dnslookup:
35124   driver = dnslookup
35125   domains = ! +local_domains
35126   transport = remote_smtp
35127   errors_to = \
35128     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
35129      {$1-request+$local_part=$domain@your.dom.example}fail}
35130   no_more
35131 .endd
35132 Before you start sending out messages with VERPed return paths, you must also
35133 configure Exim to accept the bounce messages that come back to those paths.
35134 Typically this is done by setting a &%local_part_suffix%& option for a
35135 router, and using this to route the messages to wherever you want to handle
35136 them.
35137
35138 The overhead incurred in using VERP depends very much on the size of the
35139 message, the number of recipient addresses that resolve to the same remote
35140 host, and the speed of the connection over which the message is being sent. If
35141 a lot of addresses resolve to the same host and the connection is slow, sending
35142 a separate copy of the message for each address may take substantially longer
35143 than sending a single copy with many recipients (for which VERP cannot be
35144 used).
35145
35146
35147
35148
35149
35150
35151 .section "Virtual domains" "SECTvirtualdomains"
35152 .cindex "virtual domains"
35153 .cindex "domain" "virtual"
35154 The phrase &'virtual domain'& is unfortunately used with two rather different
35155 meanings:
35156
35157 .ilist
35158 A domain for which there are no real mailboxes; all valid local parts are
35159 aliases for other email addresses. Common examples are organizational
35160 top-level domains and &"vanity"& domains.
35161 .next
35162 One of a number of independent domains that are all handled by the same host,
35163 with mailboxes on that host, but where the mailbox owners do not necessarily
35164 have login accounts on that host.
35165 .endlist
35166
35167 The first usage is probably more common, and does seem more &"virtual"& than
35168 the second. This kind of domain can be handled in Exim with a straightforward
35169 aliasing router. One approach is to create a separate alias file for each
35170 virtual domain. Exim can test for the existence of the alias file to determine
35171 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35172 to a router of this form:
35173 .code
35174 virtual:
35175   driver = redirect
35176   domains = dsearch;/etc/mail/virtual
35177   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35178   no_more
35179 .endd
35180 The &%domains%& option specifies that the router is to be skipped, unless there
35181 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35182 domain that is being processed. When the router runs, it looks up the local
35183 part in the file to find a new address (or list of addresses). The &%no_more%&
35184 setting ensures that if the lookup fails (leading to &%data%& being an empty
35185 string), Exim gives up on the address without trying any subsequent routers.
35186
35187 This one router can handle all the virtual domains because the alias file names
35188 follow a fixed pattern. Permissions can be arranged so that appropriate people
35189 can edit the different alias files. A successful aliasing operation results in
35190 a new envelope recipient address, which is then routed from scratch.
35191
35192 The other kind of &"virtual"& domain can also be handled in a straightforward
35193 way. One approach is to create a file for each domain containing a list of
35194 valid local parts, and use it in a router like this:
35195 .code
35196 my_domains:
35197   driver = accept
35198   domains = dsearch;/etc/mail/domains
35199   local_parts = lsearch;/etc/mail/domains/$domain
35200   transport = my_mailboxes
35201 .endd
35202 The address is accepted if there is a file for the domain, and the local part
35203 can be found in the file. The &%domains%& option is used to check for the
35204 file's existence because &%domains%& is tested before the &%local_parts%&
35205 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35206 because that option is tested after &%local_parts%&. The transport is as
35207 follows:
35208 .code
35209 my_mailboxes:
35210   driver = appendfile
35211   file = /var/mail/$domain/$local_part
35212   user = mail
35213 .endd
35214 This uses a directory of mailboxes for each domain. The &%user%& setting is
35215 required, to specify which uid is to be used for writing to the mailboxes.
35216
35217 The configuration shown here is just one example of how you might support this
35218 requirement. There are many other ways this kind of configuration can be set
35219 up, for example, by using a database instead of separate files to hold all the
35220 information about the domains.
35221
35222
35223
35224 .section "Multiple user mailboxes" "SECTmulbox"
35225 .cindex "multiple mailboxes"
35226 .cindex "mailbox" "multiple"
35227 .cindex "local part" "prefix"
35228 .cindex "local part" "suffix"
35229 Heavy email users often want to operate with multiple mailboxes, into which
35230 incoming mail is automatically sorted. A popular way of handling this is to
35231 allow users to use multiple sender addresses, so that replies can easily be
35232 identified. Users are permitted to add prefixes or suffixes to their local
35233 parts for this purpose. The wildcard facility of the generic router options
35234 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35235 example, consider this router:
35236 .code
35237 userforward:
35238   driver = redirect
35239   check_local_user
35240   file = $home/.forward
35241   local_part_suffix = -*
35242   local_part_suffix_optional
35243   allow_filter
35244 .endd
35245 .vindex "&$local_part_suffix$&"
35246 It runs a user's &_.forward_& file for all local parts of the form
35247 &'username-*'&. Within the filter file the user can distinguish different
35248 cases by testing the variable &$local_part_suffix$&. For example:
35249 .code
35250 if $local_part_suffix contains -special then
35251 save /home/$local_part/Mail/special
35252 endif
35253 .endd
35254 If the filter file does not exist, or does not deal with such addresses, they
35255 fall through to subsequent routers, and, assuming no subsequent use of the
35256 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35257 control over which suffixes are valid.
35258
35259 Alternatively, a suffix can be used to trigger the use of a different
35260 &_.forward_& file &-- which is the way a similar facility is implemented in
35261 another MTA:
35262 .code
35263 userforward:
35264   driver = redirect
35265   check_local_user
35266   file = $home/.forward$local_part_suffix
35267   local_part_suffix = -*
35268   local_part_suffix_optional
35269   allow_filter
35270 .endd
35271 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35272 example, &_.forward-special_& is used. Once again, if the appropriate file
35273 does not exist, or does not deal with the address, it is passed on to
35274 subsequent routers, which could, if required, look for an unqualified
35275 &_.forward_& file to use as a default.
35276
35277
35278
35279 .section "Simplified vacation processing" "SECID244"
35280 .cindex "vacation processing"
35281 The traditional way of running the &'vacation'& program is for a user to set up
35282 a pipe command in a &_.forward_& file
35283 (see section &<<SECTspecitredli>>& for syntax details).
35284 This is prone to error by inexperienced users. There are two features of Exim
35285 that can be used to make this process simpler for users:
35286
35287 .ilist
35288 A local part prefix such as &"vacation-"& can be specified on a router which
35289 can cause the message to be delivered directly to the &'vacation'& program, or
35290 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35291 &_.forward_& file are then much simpler. For example:
35292 .code
35293 spqr, vacation-spqr
35294 .endd
35295 .next
35296 The &%require_files%& generic router option can be used to trigger a
35297 vacation delivery by checking for the existence of a certain file in the
35298 user's home directory. The &%unseen%& generic option should also be used, to
35299 ensure that the original delivery also proceeds. In this case, all the user has
35300 to do is to create a file called, say, &_.vacation_&, containing a vacation
35301 message.
35302 .endlist
35303
35304 Another advantage of both these methods is that they both work even when the
35305 use of arbitrary pipes by users is locked out.
35306
35307
35308
35309 .section "Taking copies of mail" "SECID245"
35310 .cindex "message" "copying every"
35311 Some installations have policies that require archive copies of all messages to
35312 be made. A single copy of each message can easily be taken by an appropriate
35313 command in a system filter, which could, for example, use a different file for
35314 each day's messages.
35315
35316 There is also a shadow transport mechanism that can be used to take copies of
35317 messages that are successfully delivered by local transports, one copy per
35318 delivery. This could be used, &'inter alia'&, to implement automatic
35319 notification of delivery by sites that insist on doing such things.
35320
35321
35322
35323 .section "Intermittently connected hosts" "SECID246"
35324 .cindex "intermittently connected hosts"
35325 It has become quite common (because it is cheaper) for hosts to connect to the
35326 Internet periodically rather than remain connected all the time. The normal
35327 arrangement is that mail for such hosts accumulates on a system that is
35328 permanently connected.
35329
35330 Exim was designed for use on permanently connected hosts, and so it is not
35331 particularly well-suited to use in an intermittently connected environment.
35332 Nevertheless there are some features that can be used.
35333
35334
35335 .section "Exim on the upstream server host" "SECID247"
35336 It is tempting to arrange for incoming mail for the intermittently connected
35337 host to remain on Exim's queue until the client connects. However, this
35338 approach does not scale very well. Two different kinds of waiting message are
35339 being mixed up in the same queue &-- those that cannot be delivered because of
35340 some temporary problem, and those that are waiting for their destination host
35341 to connect. This makes it hard to manage the queue, as well as wasting
35342 resources, because each queue runner scans the entire queue.
35343
35344 A better approach is to separate off those messages that are waiting for an
35345 intermittently connected host. This can be done by delivering these messages
35346 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35347 format, from where they are transmitted by other software when their
35348 destination connects. This makes it easy to collect all the mail for one host
35349 in a single directory, and to apply local timeout rules on a per-message basis
35350 if required.
35351
35352 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35353 you are doing this, you should configure Exim with a long retry period for the
35354 intermittent host. For example:
35355 .code
35356 cheshire.wonderland.fict.example    *   F,5d,24h
35357 .endd
35358 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35359 which messages it has queued up for that host. Once the intermittent host comes
35360 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35361 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35362 causes all the queued up messages to be delivered, often down a single SMTP
35363 connection. While the host remains connected, any new messages get delivered
35364 immediately.
35365
35366 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35367 issued with a different IP address each time it connects, Exim's retry
35368 mechanisms on the holding host get confused, because the IP address is normally
35369 used as part of the key string for holding retry information. This can be
35370 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35371 Since this has disadvantages for permanently connected hosts, it is best to
35372 arrange a separate transport for the intermittently connected ones.
35373
35374
35375
35376 .section "Exim on the intermittently connected client host" "SECID248"
35377 The value of &%smtp_accept_queue_per_connection%& should probably be
35378 increased, or even set to zero (that is, disabled) on the intermittently
35379 connected host, so that all incoming messages down a single connection get
35380 delivered immediately.
35381
35382 .cindex "SMTP" "passed connection"
35383 .cindex "SMTP" "multiple deliveries"
35384 .cindex "multiple SMTP deliveries"
35385 Mail waiting to be sent from an intermittently connected host will probably
35386 not have been routed, because without a connection DNS lookups are not
35387 possible. This means that if a normal queue run is done at connection time,
35388 each message is likely to be sent in a separate SMTP session. This can be
35389 avoided by starting the queue run with a command line option beginning with
35390 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35391 first pass, routing is done but no deliveries take place. The second pass is a
35392 normal queue run; since all the messages have been previously routed, those
35393 destined for the same host are likely to get sent as multiple deliveries in a
35394 single SMTP connection.
35395
35396
35397
35398 . ////////////////////////////////////////////////////////////////////////////
35399 . ////////////////////////////////////////////////////////////////////////////
35400
35401 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35402          "Exim as a non-queueing client"
35403 .cindex "client, non-queueing"
35404 .cindex "smart host" "suppressing queueing"
35405 On a personal computer, it is a common requirement for all
35406 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35407 configured to operate that way, for all the popular operating systems.
35408 However, there are some MUAs for Unix-like systems that cannot be so
35409 configured: they submit messages using the command line interface of
35410 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35411 messages this way.
35412
35413 If the personal computer runs continuously, there is no problem, because it can
35414 run a conventional MTA that handles delivery to the smart host, and deal with
35415 any delays via its queueing mechanism. However, if the computer does not run
35416 continuously or runs different operating systems at different times, queueing
35417 email is not desirable.
35418
35419 There is therefore a requirement for something that can provide the
35420 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35421 any queueing or retrying facilities. Furthermore, the delivery to the smart
35422 host should be synchronous, so that if it fails, the sending MUA is immediately
35423 informed. In other words, we want something that extends an MUA that submits
35424 to a local MTA via the command line so that it behaves like one that submits
35425 to a remote smart host using TCP/SMTP.
35426
35427 There are a number of applications (for example, there is one called &'ssmtp'&)
35428 that do this job. However, people have found them to be lacking in various
35429 ways. For instance, you might want to allow aliasing and forwarding to be done
35430 before sending a message to the smart host.
35431
35432 Exim already had the necessary infrastructure for doing this job. Just a few
35433 tweaks were needed to make it behave as required, though it is somewhat of an
35434 overkill to use a fully-featured MTA for this purpose.
35435
35436 .oindex "&%mua_wrapper%&"
35437 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35438 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35439 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35440 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35441 compatible router and transport configuration. Typically there will be just one
35442 router and one transport, sending everything to a smart host.
35443
35444 When run in MUA wrapping mode, the behaviour of Exim changes in the
35445 following ways:
35446
35447 .ilist
35448 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35449 In other words, the only way to submit messages is via the command line.
35450 .next
35451 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35452 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35453 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35454 does not finish until the delivery attempt is complete. If the delivery is
35455 successful, a zero return code is given.
35456 .next
35457 Address redirection is permitted, but the final routing for all addresses must
35458 be to the same remote transport, and to the same list of hosts. Furthermore,
35459 the return address (envelope sender) must be the same for all recipients, as
35460 must any added or deleted header lines. In other words, it must be possible to
35461 deliver the message in a single SMTP transaction, however many recipients there
35462 are.
35463 .next
35464 If these conditions are not met, or if routing any address results in a
35465 failure or defer status, or if Exim is unable to deliver all the recipients
35466 successfully to one of the smart hosts, delivery of the entire message fails.
35467 .next
35468 Because no queueing is allowed, all failures are treated as permanent; there
35469 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35470 smart host. Furthermore, because only a single yes/no response can be given to
35471 the caller, it is not possible to deliver to some recipients and not others. If
35472 there is an error (temporary or permanent) for any recipient, all are failed.
35473 .next
35474 If more than one smart host is listed, Exim will try another host after a
35475 connection failure or a timeout, in the normal way. However, if this kind of
35476 failure happens for all the hosts, the delivery fails.
35477 .next
35478 When delivery fails, an error message is written to the standard error stream
35479 (as well as to Exim's log), and Exim exits to the caller with a return code
35480 value 1. The message is expunged from Exim's spool files. No bounce messages
35481 are ever generated.
35482 .next
35483 No retry data is maintained, and any retry rules are ignored.
35484 .next
35485 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35486 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35487 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35488 .endlist
35489
35490 The overall effect is that Exim makes a single synchronous attempt to deliver
35491 the message, failing if there is any kind of problem. Because no local
35492 deliveries are done and no daemon can be run, Exim does not need root
35493 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35494 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35495 the advantages and disadvantages of running without root privilege.
35496
35497
35498
35499
35500 . ////////////////////////////////////////////////////////////////////////////
35501 . ////////////////////////////////////////////////////////////////////////////
35502
35503 .chapter "Log files" "CHAPlog"
35504 .scindex IIDloggen "log" "general description"
35505 .cindex "log" "types of"
35506 Exim writes three different logs, referred to as the main log, the reject log,
35507 and the panic log:
35508
35509 .ilist
35510 .cindex "main log"
35511 The main log records the arrival of each message and each delivery in a single
35512 line in each case. The format is as compact as possible, in an attempt to keep
35513 down the size of log files. Two-character flag sequences make it easy to pick
35514 out these lines. A number of other events are recorded in the main log. Some of
35515 them are optional, in which case the &%log_selector%& option controls whether
35516 they are included or not. A Perl script called &'eximstats'&, which does simple
35517 analysis of main log files, is provided in the Exim distribution (see section
35518 &<<SECTmailstat>>&).
35519 .next
35520 .cindex "reject log"
35521 The reject log records information from messages that are rejected as a result
35522 of a configuration option (that is, for policy reasons).
35523 The first line of each rejection is a copy of the line that is also written to
35524 the main log. Then, if the message's header has been read at the time the log
35525 is written, its contents are written to this log. Only the original header
35526 lines are available; header lines added by ACLs are not logged. You can use the
35527 reject log to check that your policy controls are working correctly; on a busy
35528 host this may be easier than scanning the main log for rejection messages. You
35529 can suppress the writing of the reject log by setting &%write_rejectlog%&
35530 false.
35531 .next
35532 .cindex "panic log"
35533 .cindex "system log"
35534 When certain serious errors occur, Exim writes entries to its panic log. If the
35535 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35536 are usually written to the main log as well, but can get lost amid the mass of
35537 other entries. The panic log should be empty under normal circumstances. It is
35538 therefore a good idea to check it (or to have a &'cron'& script check it)
35539 regularly, in order to become aware of any problems. When Exim cannot open its
35540 panic log, it tries as a last resort to write to the system log (syslog). This
35541 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35542 message itself is written at priority LOG_CRIT.
35543 .endlist
35544
35545 Every log line starts with a timestamp, in the format shown in the following
35546 example. Note that many of the examples shown in this chapter are line-wrapped.
35547 In the log file, this would be all on one line:
35548 .code
35549 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35550   by QUIT
35551 .endd
35552 By default, the timestamps are in the local timezone. There are two
35553 ways of changing this:
35554
35555 .ilist
35556 You can set the &%timezone%& option to a different time zone; in particular, if
35557 you set
35558 .code
35559 timezone = UTC
35560 .endd
35561 the timestamps will be in UTC (aka GMT).
35562 .next
35563 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35564 example:
35565 .code
35566 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35567 .endd
35568 .endlist
35569
35570 .cindex "log" "process ids in"
35571 .cindex "pid (process id)" "in log lines"
35572 Exim does not include its process id in log lines by default, but you can
35573 request that it does so by specifying the &`pid`& log selector (see section
35574 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35575 brackets, immediately after the time and date.
35576
35577
35578
35579
35580 .section "Where the logs are written" "SECTwhelogwri"
35581 .cindex "log" "destination"
35582 .cindex "log" "to file"
35583 .cindex "log" "to syslog"
35584 .cindex "syslog"
35585 The logs may be written to local files, or to syslog, or both. However, it
35586 should be noted that many syslog implementations use UDP as a transport, and
35587 are therefore unreliable in the sense that messages are not guaranteed to
35588 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35589 It has also been reported that on large log files (tens of megabytes) you may
35590 need to tweak syslog to prevent it syncing the file with each write &-- on
35591 Linux this has been seen to make syslog take 90% plus of CPU time.
35592
35593 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35594 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35595 configuration. This latter string is expanded, so it can contain, for example,
35596 references to the host name:
35597 .code
35598 log_file_path = /var/log/$primary_hostname/exim_%slog
35599 .endd
35600 It is generally advisable, however, to set the string in &_Local/Makefile_&
35601 rather than at run time, because then the setting is available right from the
35602 start of Exim's execution. Otherwise, if there's something it wants to log
35603 before it has read the configuration file (for example, an error in the
35604 configuration file) it will not use the path you want, and may not be able to
35605 log at all.
35606
35607 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35608 list, currently limited to at most two items. This is one option where the
35609 facility for changing a list separator may not be used. The list must always be
35610 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35611 otherwise the item must either be an absolute path, containing &`%s`& at the
35612 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35613 implying the use of a default path.
35614
35615 When Exim encounters an empty item in the list, it searches the list defined by
35616 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35617 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35618 mean &"use the path specified at build time"&. It no such item exists, log
35619 files are written in the &_log_& subdirectory of the spool directory. This is
35620 equivalent to the setting:
35621 .code
35622 log_file_path = $spool_directory/log/%slog
35623 .endd
35624 If you do not specify anything at build time or run time,
35625 or if you unset the option at run time (i.e. &`log_file_path = `&),
35626 that is where the logs are written.
35627
35628 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35629 are in use &-- see section &<<SECTdatlogfil>>& below.
35630
35631 Here are some examples of possible settings:
35632 .display
35633 &`LOG_FILE_PATH=syslog                    `& syslog only
35634 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35635 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35636 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35637 .endd
35638 If there are more than two paths in the list, the first is used and a panic
35639 error is logged.
35640
35641
35642
35643 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35644 .cindex "log" "cycling local files"
35645 .cindex "cycling logs"
35646 .cindex "&'exicyclog'&"
35647 .cindex "log" "local files; writing to"
35648 Some operating systems provide centralized and standardized methods for cycling
35649 log files. For those that do not, a utility script called &'exicyclog'& is
35650 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35651 main and reject logs each time it is called. The maximum number of old logs to
35652 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35653
35654 An Exim delivery process opens the main log when it first needs to write to it,
35655 and it keeps the file open in case subsequent entries are required &-- for
35656 example, if a number of different deliveries are being done for the same
35657 message. However, remote SMTP deliveries can take a long time, and this means
35658 that the file may be kept open long after it is renamed if &'exicyclog'& or
35659 something similar is being used to rename log files on a regular basis. To
35660 ensure that a switch of log files is noticed as soon as possible, Exim calls
35661 &[stat()]& on the main log's name before reusing an open file, and if the file
35662 does not exist, or its inode has changed, the old file is closed and Exim
35663 tries to open the main log from scratch. Thus, an old log file may remain open
35664 for quite some time, but no Exim processes should write to it once it has been
35665 renamed.
35666
35667
35668
35669 .section "Datestamped log files" "SECTdatlogfil"
35670 .cindex "log" "datestamped files"
35671 Instead of cycling the main and reject log files by renaming them
35672 periodically, some sites like to use files whose names contain a datestamp,
35673 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35674 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35675 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35676 point where the datestamp is required. For example:
35677 .code
35678 log_file_path = /var/spool/exim/log/%slog-%D
35679 log_file_path = /var/log/exim-%s-%D.log
35680 log_file_path = /var/spool/exim/log/%D-%slog
35681 log_file_path = /var/log/exim/%s.%M
35682 .endd
35683 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35684 examples of names generated by the above examples:
35685 .code
35686 /var/spool/exim/log/mainlog-20021225
35687 /var/log/exim-reject-20021225.log
35688 /var/spool/exim/log/20021225-mainlog
35689 /var/log/exim/main.200212
35690 .endd
35691 When this form of log file is specified, Exim automatically switches to new
35692 files at midnight. It does not make any attempt to compress old logs; you
35693 will need to write your own script if you require this. You should not
35694 run &'exicyclog'& with this form of logging.
35695
35696 The location of the panic log is also determined by &%log_file_path%&, but it
35697 is not datestamped, because rotation of the panic log does not make sense.
35698 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35699 the string. In addition, if it immediately follows a slash, a following
35700 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35701 character is removed. Thus, the four examples above would give these panic
35702 log names:
35703 .code
35704 /var/spool/exim/log/paniclog
35705 /var/log/exim-panic.log
35706 /var/spool/exim/log/paniclog
35707 /var/log/exim/panic
35708 .endd
35709
35710
35711 .section "Logging to syslog" "SECID249"
35712 .cindex "log" "syslog; writing to"
35713 The use of syslog does not change what Exim logs or the format of its messages,
35714 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35715 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35716 that, the same strings are written to syslog as to log files. The syslog
35717 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35718 by default, but you can change these by setting the &%syslog_facility%& and
35719 &%syslog_processname%& options, respectively. If Exim was compiled with
35720 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35721 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35722 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35723 the time and host name to each line.
35724 The three log streams are mapped onto syslog priorities as follows:
35725
35726 .ilist
35727 &'mainlog'& is mapped to LOG_INFO
35728 .next
35729 &'rejectlog'& is mapped to LOG_NOTICE
35730 .next
35731 &'paniclog'& is mapped to LOG_ALERT
35732 .endlist
35733
35734 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35735 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35736 these are routed by syslog to the same place. You can suppress this duplication
35737 by setting &%syslog_duplication%& false.
35738
35739 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35740 entries contain multiple lines when headers are included. To cope with both
35741 these cases, entries written to syslog are split into separate &[syslog()]&
35742 calls at each internal newline, and also after a maximum of
35743 870 data characters. (This allows for a total syslog line length of 1024, when
35744 additions such as timestamps are added.) If you are running a syslog
35745 replacement that can handle lines longer than the 1024 characters allowed by
35746 RFC 3164, you should set
35747 .code
35748 SYSLOG_LONG_LINES=yes
35749 .endd
35750 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35751 lines, but it still splits at internal newlines in &'reject'& log entries.
35752
35753 To make it easy to re-assemble split lines later, each component of a split
35754 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35755 where <&'n'&> is the component number and <&'m'&> is the total number of
35756 components in the entry. The / delimiter is used when the line was split
35757 because it was too long; if it was split because of an internal newline, the \
35758 delimiter is used. For example, supposing the length limit to be 50 instead of
35759 870, the following would be the result of a typical rejection message to
35760 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35761 name, and pid as added by syslog:
35762 .code
35763 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35764 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35765 [3/5]  when scanning for sender: missing or malformed lo
35766 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35767 [5/5] mple>)
35768 .endd
35769 The same error might cause the following lines to be written to &"rejectlog"&
35770 (LOG_NOTICE):
35771 .code
35772 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35773 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35774 [3/18] er when scanning for sender: missing or malformed
35775 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35776 [5\18] .example>)
35777 [6\18] Recipients: ph10@some.domain.cam.example
35778 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35779 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35780 [9\18]        id 16RdAL-0006pc-00
35781 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35782 [11\18] 09:43 +0100
35783 [12\18] F From: <>
35784 [13\18]   Subject: this is a test header
35785 [18\18]   X-something: this is another header
35786 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35787 [16\18] le>
35788 [17\18] B Bcc:
35789 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35790 .endd
35791 Log lines that are neither too long nor contain newlines are written to syslog
35792 without modification.
35793
35794 If only syslog is being used, the Exim monitor is unable to provide a log tail
35795 display, unless syslog is routing &'mainlog'& to a file on the local host and
35796 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35797 where it is.
35798
35799
35800
35801 .section "Log line flags" "SECID250"
35802 One line is written to the main log for each message received, and for each
35803 successful, unsuccessful, and delayed delivery. These lines can readily be
35804 picked out by the distinctive two-character flags that immediately follow the
35805 timestamp. The flags are:
35806 .display
35807 &`<=`&     message arrival
35808 &`(=`&     message fakereject
35809 &`=>`&     normal message delivery
35810 &`->`&     additional address in same delivery
35811 &`>>`&     cutthrough message delivery
35812 &`*>`&     delivery suppressed by &%-N%&
35813 &`**`&     delivery failed; address bounced
35814 &`==`&     delivery deferred; temporary problem
35815 .endd
35816
35817
35818 .section "Logging message reception" "SECID251"
35819 .cindex "log" "reception line"
35820 The format of the single-line entry in the main log that is written for every
35821 message received is shown in the basic example below, which is split over
35822 several lines in order to fit it on the page:
35823 .code
35824 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35825   H=mailer.fict.example [192.168.123.123] U=exim
35826   P=smtp S=5678 id=<incoming message id>
35827 .endd
35828 The address immediately following &"<="& is the envelope sender address. A
35829 bounce message is shown with the sender address &"<>"&, and if it is locally
35830 generated, this is followed by an item of the form
35831 .code
35832 R=<message id>
35833 .endd
35834 which is a reference to the message that caused the bounce to be sent.
35835
35836 .cindex "HELO"
35837 .cindex "EHLO"
35838 For messages from other hosts, the H and U fields identify the remote host and
35839 record the RFC 1413 identity of the user that sent the message, if one was
35840 received. The number given in square brackets is the IP address of the sending
35841 host. If there is a single, unparenthesized  host name in the H field, as
35842 above, it has been verified to correspond to the IP address (see the
35843 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35844 by the remote host in the SMTP HELO or EHLO command, and has not been
35845 verified. If verification yields a different name to that given for HELO or
35846 EHLO, the verified name appears first, followed by the HELO or EHLO
35847 name in parentheses.
35848
35849 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35850 without brackets, in the HELO or EHLO command, leading to entries in
35851 the log containing text like these examples:
35852 .code
35853 H=(10.21.32.43) [192.168.8.34]
35854 H=([10.21.32.43]) [192.168.8.34]
35855 .endd
35856 This can be confusing. Only the final address in square brackets can be relied
35857 on.
35858
35859 For locally generated messages (that is, messages not received over TCP/IP),
35860 the H field is omitted, and the U field contains the login name of the caller
35861 of Exim.
35862
35863 .cindex "authentication" "logging"
35864 .cindex "AUTH" "logging"
35865 For all messages, the P field specifies the protocol used to receive the
35866 message. This is the value that is stored in &$received_protocol$&. In the case
35867 of incoming SMTP messages, the value indicates whether or not any SMTP
35868 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35869 session was encrypted, there is an additional X field that records the cipher
35870 suite that was used.
35871
35872 .cindex log protocol
35873 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35874 hosts that have authenticated themselves using the SMTP AUTH command. The first
35875 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35876 there is an additional item A= followed by the name of the authenticator that
35877 was used. If an authenticated identification was set up by the authenticator's
35878 &%server_set_id%& option, this is logged too, separated by a colon from the
35879 authenticator name.
35880
35881 .cindex "size" "of message"
35882 The id field records the existing message id, if present. The size of the
35883 received message is given by the S field. When the message is delivered,
35884 headers may be removed or added, so that the size of delivered copies of the
35885 message may not correspond with this value (and indeed may be different to each
35886 other).
35887
35888 The &%log_selector%& option can be used to request the logging of additional
35889 data when a message is received. See section &<<SECTlogselector>>& below.
35890
35891
35892
35893 .section "Logging deliveries" "SECID252"
35894 .cindex "log" "delivery line"
35895 The format of the single-line entry in the main log that is written for every
35896 delivery is shown in one of the examples below, for local and remote
35897 deliveries, respectively. Each example has been split into multiple lines in order
35898 to fit it on the page:
35899 .code
35900 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35901   <marv@hitch.fict.example> R=localuser T=local_delivery
35902 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35903   monk@holistic.fict.example R=dnslookup T=remote_smtp
35904   H=holistic.fict.example [192.168.234.234]
35905 .endd
35906 For ordinary local deliveries, the original address is given in angle brackets
35907 after the final delivery address, which might be a pipe or a file. If
35908 intermediate address(es) exist between the original and the final address, the
35909 last of these is given in parentheses after the final address. The R and T
35910 fields record the router and transport that were used to process the address.
35911
35912 If SMTP AUTH was used for the delivery there is an additional item A=
35913 followed by the name of the authenticator that was used.
35914 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35915 option, this is logged too, separated by a colon from the authenticator name.
35916
35917 If a shadow transport was run after a successful local delivery, the log line
35918 for the successful delivery has an item added on the end, of the form
35919 .display
35920 &`ST=<`&&'shadow transport name'&&`>`&
35921 .endd
35922 If the shadow transport did not succeed, the error message is put in
35923 parentheses afterwards.
35924
35925 .cindex "asterisk" "after IP address"
35926 When more than one address is included in a single delivery (for example, two
35927 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35928 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35929 down a single SMTP connection, an asterisk follows the IP address in the log
35930 lines for the second and subsequent messages.
35931 .new
35932 When two or more messages are delivered down a single TLS connection, the
35933 DNS and some TLS-related information logged for the first message delivered
35934 will not be present in the log lines for the second and subsequent messages.
35935 TLS cipher information is still available.
35936 .wen
35937
35938 .cindex "delivery" "cutthrough; logging"
35939 .cindex "cutthrough" "logging"
35940 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35941 line precedes the reception line, since cutthrough waits for a possible
35942 rejection from the destination in case it can reject the sourced item.
35943
35944 The generation of a reply message by a filter file gets logged as a
35945 &"delivery"& to the addressee, preceded by &">"&.
35946
35947 The &%log_selector%& option can be used to request the logging of additional
35948 data when a message is delivered. See section &<<SECTlogselector>>& below.
35949
35950
35951 .section "Discarded deliveries" "SECID253"
35952 .cindex "discarded messages"
35953 .cindex "message" "discarded"
35954 .cindex "delivery" "discarded; logging"
35955 When a message is discarded as a result of the command &"seen finish"& being
35956 obeyed in a filter file which generates no deliveries, a log entry of the form
35957 .code
35958 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35959   <low.club@bridge.example> R=userforward
35960 .endd
35961 is written, to record why no deliveries are logged. When a message is discarded
35962 because it is aliased to &":blackhole:"& the log line is like this:
35963 .code
35964 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35965   <hole@nowhere.example> R=blackhole_router
35966 .endd
35967
35968
35969 .section "Deferred deliveries" "SECID254"
35970 When a delivery is deferred, a line of the following form is logged:
35971 .code
35972 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35973   R=dnslookup T=smtp defer (146): Connection refused
35974 .endd
35975 In the case of remote deliveries, the error is the one that was given for the
35976 last IP address that was tried. Details of individual SMTP failures are also
35977 written to the log, so the above line would be preceded by something like
35978 .code
35979 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35980   mail1.endrest.example [192.168.239.239]: Connection refused
35981 .endd
35982 When a deferred address is skipped because its retry time has not been reached,
35983 a message is written to the log, but this can be suppressed by setting an
35984 appropriate value in &%log_selector%&.
35985
35986
35987
35988 .section "Delivery failures" "SECID255"
35989 .cindex "delivery" "failure; logging"
35990 If a delivery fails because an address cannot be routed, a line of the
35991 following form is logged:
35992 .code
35993 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35994   <jim@trek99.example>: unknown mail domain
35995 .endd
35996 If a delivery fails at transport time, the router and transport are shown, and
35997 the response from the remote host is included, as in this example:
35998 .code
35999 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
36000   R=dnslookup T=remote_smtp: SMTP error from remote mailer
36001   after pipelined RCPT TO:<ace400@pb.example>: host
36002   pbmail3.py.example [192.168.63.111]: 553 5.3.0
36003   <ace400@pb.example>...Addressee unknown
36004 .endd
36005 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
36006 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
36007 disabling PIPELINING. The log lines for all forms of delivery failure are
36008 flagged with &`**`&.
36009
36010
36011
36012 .section "Fake deliveries" "SECID256"
36013 .cindex "delivery" "fake; logging"
36014 If a delivery does not actually take place because the &%-N%& option has been
36015 used to suppress it, a normal delivery line is written to the log, except that
36016 &"=>"& is replaced by &"*>"&.
36017
36018
36019
36020 .section "Completion" "SECID257"
36021 A line of the form
36022 .code
36023 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
36024 .endd
36025 is written to the main log when a message is about to be removed from the spool
36026 at the end of its processing.
36027
36028
36029
36030
36031 .section "Summary of Fields in Log Lines" "SECID258"
36032 .cindex "log" "summary of fields"
36033 A summary of the field identifiers that are used in log lines is shown in
36034 the following table:
36035 .display
36036 &`A   `&        authenticator name (and optional id and sender)
36037 &`C   `&        SMTP confirmation on delivery
36038 &`    `&        command list for &"no mail in SMTP session"&
36039 &`CV  `&        certificate verification status
36040 &`D   `&        duration of &"no mail in SMTP session"&
36041 &`DN  `&        distinguished name from peer certificate
36042 &`DS  `&        DNSSEC secured lookups
36043 &`DT  `&        on &`=>`& lines: time taken for a delivery
36044 &`F   `&        sender address (on delivery lines)
36045 &`H   `&        host name and IP address
36046 &`I   `&        local interface used
36047 &`K   `&        CHUNKING extension used
36048 &`id  `&        message id for incoming message
36049 &`M8S `&        8BITMIME status for incoming message
36050 &`P   `&        on &`<=`& lines: protocol used
36051 &`    `&        on &`=>`& and &`**`& lines: return path
36052 &`PRDR`&        PRDR extension used
36053 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
36054 &`Q   `&        alternate queue name
36055 &`QT  `&        on &`=>`& lines: time spent on queue so far
36056 &`    `&        on &"Completed"& lines: time spent on queue
36057 &`R   `&        on &`<=`& lines: reference for local bounce
36058 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
36059 &`S   `&        size of message in bytes
36060 &`SNI `&        server name indication from TLS client hello
36061 &`ST  `&        shadow transport name
36062 &`T   `&        on &`<=`& lines: message subject (topic)
36063 &`TFO `&        connection took advantage of TCP Fast Open
36064 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
36065 &`U   `&        local user or RFC 1413 identity
36066 &`X   `&        TLS cipher suite
36067 .endd
36068
36069
36070 .section "Other log entries" "SECID259"
36071 Various other types of log entry are written from time to time. Most should be
36072 self-explanatory. Among the more common are:
36073
36074 .ilist
36075 .cindex "retry" "time not reached"
36076 &'retry time not reached'&&~&~An address previously suffered a temporary error
36077 during routing or local delivery, and the time to retry has not yet arrived.
36078 This message is not written to an individual message log file unless it happens
36079 during the first delivery attempt.
36080 .next
36081 &'retry time not reached for any host'&&~&~An address previously suffered
36082 temporary errors during remote delivery, and the retry time has not yet arrived
36083 for any of the hosts to which it is routed.
36084 .next
36085 .cindex "spool directory" "file locked"
36086 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
36087 some other Exim process is already working on the message. This can be quite
36088 common if queue running processes are started at frequent intervals. The
36089 &'exiwhat'& utility script can be used to find out what Exim processes are
36090 doing.
36091 .next
36092 .cindex "error" "ignored"
36093 &'error ignored'&&~&~There are several circumstances that give rise to this
36094 message:
36095 .olist
36096 Exim failed to deliver a bounce message whose age was greater than
36097 &%ignore_bounce_errors_after%&. The bounce was discarded.
36098 .next
36099 A filter file set up a delivery using the &"noerror"& option, and the delivery
36100 failed. The delivery was discarded.
36101 .next
36102 A delivery set up by a router configured with
36103 . ==== As this is a nested list, any displays it contains must be indented
36104 . ==== as otherwise they are too far to the left.
36105 .code
36106     errors_to = <>
36107 .endd
36108 failed. The delivery was discarded.
36109 .endlist olist
36110 .endlist ilist
36111
36112
36113
36114
36115
36116 .section "Reducing or increasing what is logged" "SECTlogselector"
36117 .cindex "log" "selectors"
36118 By setting the &%log_selector%& global option, you can disable some of Exim's
36119 default logging, or you can request additional logging. The value of
36120 &%log_selector%& is made up of names preceded by plus or minus characters. For
36121 example:
36122 .code
36123 log_selector = +arguments -retry_defer
36124 .endd
36125 The list of optional log items is in the following table, with the default
36126 selection marked by asterisks:
36127 .display
36128 &` 8bitmime                   `&  received 8BITMIME status
36129 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
36130 &` address_rewrite            `&  address rewriting
36131 &` all_parents                `&  all parents in => lines
36132 &` arguments                  `&  command line arguments
36133 &`*connection_reject          `&  connection rejections
36134 &`*delay_delivery             `&  immediate delivery delayed
36135 &` deliver_time               `&  time taken to perform delivery
36136 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
36137 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
36138 &` dnssec                     `&  DNSSEC secured lookups
36139 &`*etrn                       `&  ETRN commands
36140 &`*host_lookup_failed         `&  as it says
36141 &` ident_timeout              `&  timeout for ident connection
36142 &` incoming_interface         `&  local interface on <= and => lines
36143 &` incoming_port              `&  remote port on <= lines
36144 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36145 &` millisec                   `&  millisecond timestamps and QT,DT,D times
36146 &` outgoing_interface         `&  local interface on => lines
36147 &` outgoing_port              `&  add remote port to => lines
36148 &`*queue_run                  `&  start and end queue runs
36149 &` queue_time                 `&  time on queue for one recipient
36150 &` queue_time_overall         `&  time on queue for whole message
36151 &` pid                        `&  Exim process id
36152 &` proxy                      `&  proxy address on <= and => lines
36153 &` received_recipients        `&  recipients on <= lines
36154 &` received_sender            `&  sender on <= lines
36155 &`*rejected_header            `&  header contents on reject log
36156 &`*retry_defer                `&  &"retry time not reached"&
36157 &` return_path_on_delivery    `&  put return path on => and ** lines
36158 &` sender_on_delivery         `&  add sender to => lines
36159 &`*sender_verify_fail         `&  sender verification failures
36160 &`*size_reject                `&  rejection because too big
36161 &`*skip_delivery              `&  delivery skipped in a queue run
36162 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36163 &` smtp_connection            `&  incoming SMTP connections
36164 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36165 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36166 &` smtp_no_mail               `&  session with no MAIL commands
36167 &` smtp_protocol_error        `&  SMTP protocol errors
36168 &` smtp_syntax_error          `&  SMTP syntax errors
36169 &` subject                    `&  contents of &'Subject:'& on <= lines
36170 &`*tls_certificate_verified   `&  certificate verification status
36171 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36172 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36173 &` tls_sni                    `&  TLS SNI on <= lines
36174 &` unknown_in_list            `&  DNS lookup failed in list match
36175
36176 &` all                        `&  all of the above
36177 .endd
36178 See also the &%slow_lookup_log%& main configuration option,
36179 section &<<SECID99>>&
36180
36181 More details on each of these items follows:
36182
36183 .ilist
36184 .cindex "8BITMIME"
36185 .cindex "log" "8BITMIME"
36186 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36187 which may help in tracking down interoperability issues with ancient MTAs
36188 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36189 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36190 &`7BIT`& and &`8BITMIME`& respectively.
36191 .next
36192 .cindex "&%warn%& ACL verb" "log when skipping"
36193 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36194 its conditions cannot be evaluated, a log line to this effect is written if
36195 this log selector is set.
36196 .next
36197 .cindex "log" "rewriting"
36198 .cindex "rewriting" "logging"
36199 &%address_rewrite%&: This applies both to global rewrites and per-transport
36200 rewrites, but not to rewrites in filters run as an unprivileged user (because
36201 such users cannot access the log).
36202 .next
36203 .cindex "log" "full parentage"
36204 &%all_parents%&: Normally only the original and final addresses are logged on
36205 delivery lines; with this selector, intermediate parents are given in
36206 parentheses between them.
36207 .next
36208 .cindex "log" "Exim arguments"
36209 .cindex "Exim arguments, logging"
36210 &%arguments%&: This causes Exim to write the arguments with which it was called
36211 to the main log, preceded by the current working directory. This is a debugging
36212 feature, added to make it easier to find out how certain MUAs call
36213 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36214 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36215 that are empty or that contain white space are quoted. Non-printing characters
36216 are shown as escape sequences. This facility cannot log unrecognized arguments,
36217 because the arguments are checked before the configuration file is read. The
36218 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36219 between the caller and Exim.
36220 .next
36221 .cindex "log" "connection rejections"
36222 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36223 connection is rejected, for whatever reason.
36224 .next
36225 .cindex "log" "delayed delivery"
36226 .cindex "delayed delivery, logging"
36227 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36228 started for an incoming message because the load is too high or too many
36229 messages were received on one connection. Logging does not occur if no delivery
36230 process is started because &%queue_only%& is set or &%-odq%& was used.
36231 .next
36232 .cindex "log" "delivery duration"
36233 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36234 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36235 If millisecond logging is enabled, short times will be shown with greater
36236 precision, eg. &`DT=0.304`&.
36237 .next
36238 .cindex "log" "message size on delivery"
36239 .cindex "size" "of message"
36240 &%delivery_size%&: For each delivery, the size of message delivered is added to
36241 the &"=>"& line, tagged with S=.
36242 .next
36243 .cindex "log" "dnslist defer"
36244 .cindex "DNS list" "logging defer"
36245 .cindex "black list (DNS)"
36246 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36247 DNS black list suffers a temporary error.
36248 .next
36249 .cindex log dnssec
36250 .cindex dnssec logging
36251 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36252 dns lookups gave secure results a tag of DS is added.
36253 For acceptance this covers the reverse and forward lookups for host name verification.
36254 It does not cover helo-name verification.
36255 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36256 .next
36257 .cindex "log" "ETRN commands"
36258 .cindex "ETRN" "logging"
36259 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36260 is run to determine whether or not it is actually accepted. An invalid ETRN
36261 command, or one received within a message transaction is not logged by this
36262 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36263 .next
36264 .cindex "log" "host lookup failure"
36265 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36266 any addresses, or when a lookup of an IP address fails to find a host name, a
36267 log line is written. This logging does not apply to direct DNS lookups when
36268 routing email addresses, but it does apply to &"byname"& lookups.
36269 .next
36270 .cindex "log" "ident timeout"
36271 .cindex "RFC 1413" "logging timeout"
36272 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36273 client's ident port times out.
36274 .next
36275 .cindex "log" "incoming interface"
36276 .cindex "log" "local interface"
36277 .cindex "log" "local address and port"
36278 .cindex "TCP/IP" "logging local address and port"
36279 .cindex "interface" "logging"
36280 &%incoming_interface%&: The interface on which a message was received is added
36281 to the &"<="& line as an IP address in square brackets, tagged by I= and
36282 followed by a colon and the port number. The local interface and port are also
36283 added to other SMTP log lines, for example &"SMTP connection from"&, to
36284 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36285 The latter can be disabled by turning off the &%outgoing_interface%& option.
36286 .next
36287 .cindex log "incoming proxy address"
36288 .cindex proxy "logging proxy address"
36289 .cindex "TCP/IP" "logging proxy address"
36290 &%proxy%&: The internal (closest to the system running Exim) IP address
36291 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36292 on a proxied connection
36293 or the &"=>"& line for a message delivered on a proxied connection.
36294 See &<<SECTproxyInbound>>& for more information.
36295 .next
36296 .cindex "log" "incoming remote port"
36297 .cindex "port" "logging remote"
36298 .cindex "TCP/IP" "logging incoming remote port"
36299 .vindex "&$sender_fullhost$&"
36300 .vindex "&$sender_rcvhost$&"
36301 &%incoming_port%&: The remote port number from which a message was received is
36302 added to log entries and &'Received:'& header lines, following the IP address
36303 in square brackets, and separated from it by a colon. This is implemented by
36304 changing the value that is put in the &$sender_fullhost$& and
36305 &$sender_rcvhost$& variables. Recording the remote port number has become more
36306 important with the widening use of NAT (see RFC 2505).
36307 .next
36308 .cindex "log" "dropped connection"
36309 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36310 connection is unexpectedly dropped.
36311 .next
36312 .new
36313 .cindex "log" "millisecond timestamps"
36314 .cindex millisecond logging
36315 .cindex timstamps "millisecond, in logs"
36316 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
36317 appended to the seconds value.
36318 .wen
36319 .next
36320 .cindex "log" "outgoing interface"
36321 .cindex "log" "local interface"
36322 .cindex "log" "local address and port"
36323 .cindex "TCP/IP" "logging local address and port"
36324 .cindex "interface" "logging"
36325 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36326 interface on which a message was sent is added to delivery lines as an I= tag
36327 followed by IP address in square brackets. You can disable this by turning
36328 off the &%outgoing_interface%& option.
36329 .next
36330 .cindex "log" "outgoing remote port"
36331 .cindex "port" "logging outgoint remote"
36332 .cindex "TCP/IP" "logging outgoing remote port"
36333 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36334 containing => tags) following the IP address.
36335 The local port is also added if &%incoming_interface%& and
36336 &%outgoing_interface%& are both enabled.
36337 This option is not included in the default setting, because for most ordinary
36338 configurations, the remote port number is always 25 (the SMTP port), and the
36339 local port is a random ephemeral port.
36340 .next
36341 .cindex "log" "process ids in"
36342 .cindex "pid (process id)" "in log lines"
36343 &%pid%&: The current process id is added to every log line, in square brackets,
36344 immediately after the time and date.
36345 .next
36346 .cindex "log" "queue run"
36347 .cindex "queue runner" "logging"
36348 &%queue_run%&: The start and end of every queue run are logged.
36349 .next
36350 .cindex "log" "queue time"
36351 &%queue_time%&: The amount of time the message has been in the queue on the
36352 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36353 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36354 includes reception time as well as the delivery time for the current address.
36355 This means that it may be longer than the difference between the arrival and
36356 delivery log line times, because the arrival log line is not written until the
36357 message has been successfully received.
36358 If millisecond logging is enabled, short times will be shown with greater
36359 precision, eg. &`QT=1.578s`&.
36360 .next
36361 &%queue_time_overall%&: The amount of time the message has been in the queue on
36362 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36363 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36364 message, so it includes reception time as well as the total delivery time.
36365 .next
36366 .cindex "log" "recipients"
36367 &%received_recipients%&: The recipients of a message are listed in the main log
36368 as soon as the message is received. The list appears at the end of the log line
36369 that is written when a message is received, preceded by the word &"for"&. The
36370 addresses are listed after they have been qualified, but before any rewriting
36371 has taken place.
36372 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36373 in the list.
36374 .next
36375 .cindex "log" "sender reception"
36376 &%received_sender%&: The unrewritten original sender of a message is added to
36377 the end of the log line that records the message's arrival, after the word
36378 &"from"& (before the recipients if &%received_recipients%& is also set).
36379 .next
36380 .cindex "log" "header lines for rejection"
36381 &%rejected_header%&: If a message's header has been received at the time a
36382 rejection is written to the reject log, the complete header is added to the
36383 log. Header logging can be turned off individually for messages that are
36384 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36385 .next
36386 .cindex "log" "retry defer"
36387 &%retry_defer%&: A log line is written if a delivery is deferred because a
36388 retry time has not yet been reached. However, this &"retry time not reached"&
36389 message is always omitted from individual message logs after the first delivery
36390 attempt.
36391 .next
36392 .cindex "log" "return path"
36393 &%return_path_on_delivery%&: The return path that is being transmitted with
36394 the message is included in delivery and bounce lines, using the tag P=.
36395 This is omitted if no delivery actually happens, for example, if routing fails,
36396 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36397 .next
36398 .cindex "log" "sender on delivery"
36399 &%sender_on_delivery%&: The message's sender address is added to every delivery
36400 and bounce line, tagged by F= (for &"from"&).
36401 This is the original sender that was received with the message; it is not
36402 necessarily the same as the outgoing return path.
36403 .next
36404 .cindex "log" "sender verify failure"
36405 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36406 gives details of a sender verification failure is not written. Log lines for
36407 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36408 detail is lost.
36409 .next
36410 .cindex "log" "size rejection"
36411 &%size_reject%&: A log line is written whenever a message is rejected because
36412 it is too big.
36413 .next
36414 .cindex "log" "frozen messages; skipped"
36415 .cindex "frozen messages" "logging skipping"
36416 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36417 queue run because it is frozen or because another process is already delivering
36418 it.
36419 .cindex "&""spool file is locked""&"
36420 The message that is written is &"spool file is locked"&.
36421 .next
36422 .cindex "log" "smtp confirmation"
36423 .cindex "SMTP" "logging confirmation"
36424 .cindex "LMTP" "logging confirmation"
36425 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36426 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36427 A number of MTAs (including Exim) return an identifying string in this
36428 response.
36429 .next
36430 .cindex "log" "SMTP connections"
36431 .cindex "SMTP" "logging connections"
36432 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36433 established or closed, unless the connection is from a host that matches
36434 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36435 only when the closure is unexpected.) This applies to connections from local
36436 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36437 dropped in the middle of a message, a log line is always written, whether or
36438 not this selector is set, but otherwise nothing is written at the start and end
36439 of connections unless this selector is enabled.
36440
36441 For TCP/IP connections to an Exim daemon, the current number of connections is
36442 included in the log message for each new connection, but note that the count is
36443 reset if the daemon is restarted.
36444 Also, because connections are closed (and the closure is logged) in
36445 subprocesses, the count may not include connections that have been closed but
36446 whose termination the daemon has not yet noticed. Thus, while it is possible to
36447 match up the opening and closing of connections in the log, the value of the
36448 logged counts may not be entirely accurate.
36449 .next
36450 .cindex "log" "SMTP transaction; incomplete"
36451 .cindex "SMTP" "logging incomplete transactions"
36452 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36453 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36454 and the message sender plus any accepted recipients are included in the log
36455 line. This can provide evidence of dictionary attacks.
36456 .next
36457 .cindex "log" "non-MAIL SMTP sessions"
36458 .cindex "MAIL" "logging session without"
36459 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36460 connection terminates without having issued a MAIL command. This includes both
36461 the case when the connection is dropped, and the case when QUIT is used. It
36462 does not include cases where the connection is rejected right at the start (by
36463 an ACL, or because there are too many connections, or whatever). These cases
36464 already have their own log lines.
36465
36466 The log line that is written contains the identity of the client in the usual
36467 way, followed by D= and a time, which records the duration of the connection.
36468 If the connection was authenticated, this fact is logged exactly as it is for
36469 an incoming message, with an A= item. If the connection was encrypted, CV=,
36470 DN=, and X= items may appear as they do for an incoming message, controlled by
36471 the same logging options.
36472
36473 Finally, if any SMTP commands were issued during the connection, a C= item
36474 is added to the line, listing the commands that were used. For example,
36475 .code
36476 C=EHLO,QUIT
36477 .endd
36478 shows that the client issued QUIT straight after EHLO. If there were fewer
36479 than 20 commands, they are all listed. If there were more than 20 commands,
36480 the last 20 are listed, preceded by &"..."&. However, with the default
36481 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36482 have been aborted before 20 non-mail commands are processed.
36483 .next
36484 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36485 colon-separated, is appended to the A= item for a message arrival or delivery
36486 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36487 was accepted or used.
36488 .next
36489 .cindex "log" "SMTP protocol error"
36490 .cindex "SMTP" "logging protocol error"
36491 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36492 encountered. Exim does not have perfect detection of all protocol errors
36493 because of transmission delays and the use of pipelining. If PIPELINING has
36494 been advertised to a client, an Exim server assumes that the client will use
36495 it, and therefore it does not count &"expected"& errors (for example, RCPT
36496 received after rejecting MAIL) as protocol errors.
36497 .next
36498 .cindex "SMTP" "logging syntax errors"
36499 .cindex "SMTP" "syntax errors; logging"
36500 .cindex "SMTP" "unknown command; logging"
36501 .cindex "log" "unknown SMTP command"
36502 .cindex "log" "SMTP syntax error"
36503 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36504 encountered. An unrecognized command is treated as a syntax error. For an
36505 external connection, the host identity is given; for an internal connection
36506 using &%-bs%& the sender identification (normally the calling user) is given.
36507 .next
36508 .cindex "log" "subject"
36509 .cindex "subject, logging"
36510 &%subject%&: The subject of the message is added to the arrival log line,
36511 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36512 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36513 specifies whether characters with values greater than 127 should be logged
36514 unchanged, or whether they should be rendered as escape sequences.
36515 .next
36516 .cindex "log" "certificate verification"
36517 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36518 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36519 verified, and &`CV=no`& if not.
36520 .next
36521 .cindex "log" "TLS cipher"
36522 .cindex "TLS" "logging cipher"
36523 &%tls_cipher%&: When a message is sent or received over an encrypted
36524 connection, the cipher suite used is added to the log line, preceded by X=.
36525 .next
36526 .cindex "log" "TLS peer DN"
36527 .cindex "TLS" "logging peer DN"
36528 &%tls_peerdn%&: When a message is sent or received over an encrypted
36529 connection, and a certificate is supplied by the remote host, the peer DN is
36530 added to the log line, preceded by DN=.
36531 .next
36532 .cindex "log" "TLS SNI"
36533 .cindex "TLS" "logging SNI"
36534 &%tls_sni%&: When a message is received over an encrypted connection, and
36535 the remote host provided the Server Name Indication extension, the SNI is
36536 added to the log line, preceded by SNI=.
36537 .next
36538 .cindex "log" "DNS failure in list"
36539 &%unknown_in_list%&: This setting causes a log entry to be written when the
36540 result of a list match is failure because a DNS lookup failed.
36541 .endlist
36542
36543
36544 .section "Message log" "SECID260"
36545 .cindex "message" "log file for"
36546 .cindex "log" "message log; description of"
36547 .cindex "&_msglog_& directory"
36548 .oindex "&%preserve_message_logs%&"
36549 In addition to the general log files, Exim writes a log file for each message
36550 that it handles. The names of these per-message logs are the message ids, and
36551 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36552 message log contains copies of the log lines that apply to the message. This
36553 makes it easier to inspect the status of an individual message without having
36554 to search the main log. A message log is deleted when processing of the message
36555 is complete, unless &%preserve_message_logs%& is set, but this should be used
36556 only with great care because they can fill up your disk very quickly.
36557
36558 On a heavily loaded system, it may be desirable to disable the use of
36559 per-message logs, in order to reduce disk I/O. This can be done by setting the
36560 &%message_logs%& option false.
36561 .ecindex IIDloggen
36562
36563
36564
36565
36566 . ////////////////////////////////////////////////////////////////////////////
36567 . ////////////////////////////////////////////////////////////////////////////
36568
36569 .chapter "Exim utilities" "CHAPutils"
36570 .scindex IIDutils "utilities"
36571 A number of utility scripts and programs are supplied with Exim and are
36572 described in this chapter. There is also the Exim Monitor, which is covered in
36573 the next chapter. The utilities described here are:
36574
36575 .itable none 0 0 3  7* left  15* left  40* left
36576 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36577   "list what Exim processes are doing"
36578 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36579 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36580 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36581 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36582                                                 various criteria"
36583 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36584 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36585   "extract statistics from the log"
36586 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36587   "check address acceptance from given IP"
36588 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36589 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36590 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36591 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36592 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36593 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36594 .endtable
36595
36596 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36597 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36598 &url(http://duncanthrax.net/exilog/) for details.
36599
36600
36601
36602
36603 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36604 .cindex "&'exiwhat'&"
36605 .cindex "process, querying"
36606 .cindex "SIGUSR1"
36607 On operating systems that can restart a system call after receiving a signal
36608 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36609 a line describing what it is doing to the file &_exim-process.info_& in the
36610 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36611 processes it can find, having first emptied the file. It then waits for one
36612 second to allow the Exim processes to react before displaying the results. In
36613 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36614 send the signal to the Exim processes, so it is normally run as root.
36615
36616 &*Warning*&: This is not an efficient process. It is intended for occasional
36617 use by system administrators. It is not sensible, for example, to set up a
36618 script that sends SIGUSR1 signals to Exim processes at short intervals.
36619
36620
36621 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36622 varies in different operating systems. Not only are different options used,
36623 but the format of the output is different. For this reason, there are some
36624 system configuration options that configure exactly how &'exiwhat'& works. If
36625 it doesn't seem to be working for you, check the following compile-time
36626 options:
36627 .display
36628 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36629 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36630 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36631 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36632 .endd
36633 An example of typical output from &'exiwhat'& is
36634 .code
36635 164 daemon: -q1h, listening on port 25
36636 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36637 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36638   [10.19.42.42] (editor@ref.example)
36639 10592 handling incoming call from [192.168.243.242]
36640 10628 accepting a local non-SMTP message
36641 .endd
36642 The first number in the output line is the process number. The third line has
36643 been split here, in order to fit it on the page.
36644
36645
36646
36647 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36648 .cindex "&'exiqgrep'&"
36649 .cindex "queue" "grepping"
36650 This utility is a Perl script contributed by Matt Hubbard. It runs
36651 .code
36652 exim -bpu
36653 .endd
36654 or (in case &*-a*& switch is specified)
36655 .code
36656 exim -bp
36657 .endd
36658 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36659 contain alternate exim configuration the queue management might be using.
36660
36661 to obtain a queue listing, and then greps the output to select messages
36662 that match given criteria. The following selection options are available:
36663
36664 .vlist
36665 .vitem &*-f*&&~<&'regex'&>
36666 Match the sender address using a case-insensitive search. The field that is
36667 tested is enclosed in angle brackets, so you can test for bounce messages with
36668 .code
36669 exiqgrep -f '^<>$'
36670 .endd
36671 .vitem &*-r*&&~<&'regex'&>
36672 Match a recipient address using a case-insensitive search. The field that is
36673 tested is not enclosed in angle brackets.
36674
36675 .vitem &*-s*&&~<&'regex'&>
36676 Match against the size field.
36677
36678 .vitem &*-y*&&~<&'seconds'&>
36679 Match messages that are younger than the given time.
36680
36681 .vitem &*-o*&&~<&'seconds'&>
36682 Match messages that are older than the given time.
36683
36684 .vitem &*-z*&
36685 Match only frozen messages.
36686
36687 .vitem &*-x*&
36688 Match only non-frozen messages.
36689 .endlist
36690
36691 The following options control the format of the output:
36692
36693 .vlist
36694 .vitem &*-c*&
36695 Display only the count of matching messages.
36696
36697 .vitem &*-l*&
36698 Long format &-- display the full message information as output by Exim. This is
36699 the default.
36700
36701 .vitem &*-i*&
36702 Display message ids only.
36703
36704 .vitem &*-b*&
36705 Brief format &-- one line per message.
36706
36707 .vitem &*-R*&
36708 Display messages in reverse order.
36709
36710 .vitem &*-a*&
36711 Include delivered recipients in queue listing.
36712 .endlist
36713
36714 There is one more option, &%-h%&, which outputs a list of options.
36715
36716
36717
36718 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36719 .cindex "&'exiqsumm'&"
36720 .cindex "queue" "summary"
36721 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36722 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36723 running a command such as
36724 .code
36725 exim -bp | exiqsumm
36726 .endd
36727 The output consists of one line for each domain that has messages waiting for
36728 it, as in the following example:
36729 .code
36730 3   2322   74m   66m  msn.com.example
36731 .endd
36732 Each line lists the number of pending deliveries for a domain, their total
36733 volume, and the length of time that the oldest and the newest messages have
36734 been waiting. Note that the number of pending deliveries is greater than the
36735 number of messages when messages have more than one recipient.
36736
36737 A summary line is output at the end. By default the output is sorted on the
36738 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36739 the output to be sorted by oldest message and by count of messages,
36740 respectively. There are also three options that split the messages for each
36741 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36742 separates frozen messages, and &%-s%& separates messages according to their
36743 sender.
36744
36745 The output of &'exim -bp'& contains the original addresses in the message, so
36746 this also applies to the output from &'exiqsumm'&. No domains from addresses
36747 generated by aliasing or forwarding are included (unless the &%one_time%&
36748 option of the &(redirect)& router has been used to convert them into &"top
36749 level"& addresses).
36750
36751
36752
36753
36754 .section "Extracting specific information from the log (exigrep)" &&&
36755          "SECTextspeinf"
36756 .cindex "&'exigrep'&"
36757 .cindex "log" "extracts; grepping for"
36758 The &'exigrep'& utility is a Perl script that searches one or more main log
36759 files for entries that match a given pattern. When it finds a match, it
36760 extracts all the log entries for the relevant message, not just those that
36761 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36762 given message, or all mail for a given user, or for a given host, for example.
36763 The input files can be in Exim log format or syslog format.
36764 If a matching log line is not associated with a specific message, it is
36765 included in &'exigrep'&'s output without any additional lines. The usage is:
36766 .display
36767 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36768 .endd
36769 If no log file names are given on the command line, the standard input is read.
36770
36771 The &%-t%& argument specifies a number of seconds. It adds an additional
36772 condition for message selection. Messages that are complete are shown only if
36773 they spent more than <&'n'&> seconds on the queue.
36774
36775 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36776 makes it case-sensitive. This may give a performance improvement when searching
36777 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36778 option; with &%-I%& they do not. In both cases it is possible to change the
36779 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36780
36781 The &%-l%& option means &"literal"&, that is, treat all characters in the
36782 pattern as standing for themselves. Otherwise the pattern must be a Perl
36783 regular expression.
36784
36785 The &%-v%& option inverts the matching condition. That is, a line is selected
36786 if it does &'not'& match the pattern.
36787
36788 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36789 that are generated as a result/response to a message that &'exigrep'& matched
36790 normally.
36791
36792 Example of &%-M%&:
36793 user_a sends a message to user_b, which generates a bounce back to user_b. If
36794 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36795 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36796 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36797 when searching for &"user_a"& will show both messages since the bounce is
36798 &"related"& to or a &"result"& of the first message that was found by the
36799 search term.
36800
36801 If the location of a &'zcat'& command is known from the definition of
36802 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36803 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36804 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36805 autodetection of some well known compression extensions.
36806
36807
36808 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36809 .cindex "&'exipick'&"
36810 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36811 lists messages from the queue according to a variety of criteria. For details
36812 of &'exipick'&'s facilities, run &'exipick'& with
36813 the &%--help%& option.
36814
36815
36816 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36817 .cindex "log" "cycling local files"
36818 .cindex "cycling logs"
36819 .cindex "&'exicyclog'&"
36820 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36821 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36822 you are using log files with datestamps in their names (see section
36823 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36824 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36825 There are two command line options for &'exicyclog'&:
36826 .ilist
36827 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36828 default that is set when Exim is built. The default default is 10.
36829 .next
36830 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36831 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36832 overriding the script's default, which is to find the setting from Exim's
36833 configuration.
36834 .endlist
36835
36836 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36837 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36838 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36839 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36840 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36841 logs are handled similarly.
36842
36843 If the limit is greater than 99, the script uses 3-digit numbers such as
36844 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36845 to one that is greater, or &'vice versa'&, you will have to fix the names of
36846 any existing log files.
36847
36848 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36849 the end are deleted. All files with numbers greater than 01 are compressed,
36850 using a compression command which is configured by the COMPRESS_COMMAND
36851 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36852 root &%crontab%& entry of the form
36853 .code
36854 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36855 .endd
36856 assuming you have used the name &"exim"& for the Exim user. You can run
36857 &'exicyclog'& as root if you wish, but there is no need.
36858
36859
36860
36861 .section "Mail statistics (eximstats)" "SECTmailstat"
36862 .cindex "statistics"
36863 .cindex "&'eximstats'&"
36864 A Perl script called &'eximstats'& is provided for extracting statistical
36865 information from log files. The output is either plain text, or HTML.
36866 Exim log files are also supported by the &'Lire'& system produced by the
36867 LogReport Foundation &url(http://www.logreport.org).
36868
36869 The &'eximstats'& script has been hacked about quite a bit over time. The
36870 latest version is the result of some extensive revision by Steve Campbell. A
36871 lot of information is given by default, but there are options for suppressing
36872 various parts of it. Following any options, the arguments to the script are a
36873 list of files, which should be main log files. For example:
36874 .code
36875 eximstats -nr /var/spool/exim/log/mainlog.01
36876 .endd
36877 By default, &'eximstats'& extracts information about the number and volume of
36878 messages received from or delivered to various hosts. The information is sorted
36879 both by message count and by volume, and the top fifty hosts in each category
36880 are listed on the standard output. Similar information, based on email
36881 addresses or domains instead of hosts can be requested by means of various
36882 options. For messages delivered and received locally, similar statistics are
36883 also produced per user.
36884
36885 The output also includes total counts and statistics about delivery errors, and
36886 histograms showing the number of messages received and deliveries made in each
36887 hour of the day. A delivery with more than one address in its envelope (for
36888 example, an SMTP transaction with more than one RCPT command) is counted
36889 as a single delivery by &'eximstats'&.
36890
36891 Though normally more deliveries than receipts are reported (as messages may
36892 have multiple recipients), it is possible for &'eximstats'& to report more
36893 messages received than delivered, even though the queue is empty at the start
36894 and end of the period in question. If an incoming message contains no valid
36895 recipients, no deliveries are recorded for it. A bounce message is handled as
36896 an entirely separate message.
36897
36898 &'eximstats'& always outputs a grand total summary giving the volume and number
36899 of messages received and deliveries made, and the number of hosts involved in
36900 each case. It also outputs the number of messages that were delayed (that is,
36901 not completely delivered at the first attempt), and the number that had at
36902 least one address that failed.
36903
36904 The remainder of the output is in sections that can be independently disabled
36905 or modified by various options. It consists of a summary of deliveries by
36906 transport, histograms of messages received and delivered per time interval
36907 (default per hour), information about the time messages spent on the queue,
36908 a list of relayed messages, lists of the top fifty sending hosts, local
36909 senders, destination hosts, and destination local users by count and by volume,
36910 and a list of delivery errors that occurred.
36911
36912 The relay information lists messages that were actually relayed, that is, they
36913 came from a remote host and were directly delivered to some other remote host,
36914 without being processed (for example, for aliasing or forwarding) locally.
36915
36916 There are quite a few options for &'eximstats'& to control exactly what it
36917 outputs. These are documented in the Perl script itself, and can be extracted
36918 by running the command &(perldoc)& on the script. For example:
36919 .code
36920 perldoc /usr/exim/bin/eximstats
36921 .endd
36922
36923 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36924 .cindex "&'exim_checkaccess'&"
36925 .cindex "policy control" "checking access"
36926 .cindex "checking access"
36927 The &%-bh%& command line argument allows you to run a fake SMTP session with
36928 debugging output, in order to check what Exim is doing when it is applying
36929 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36930 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36931 sometimes you just want to answer the question &"Does this address have
36932 access?"& without bothering with any further details.
36933
36934 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36935 two arguments, an IP address and an email address:
36936 .code
36937 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36938 .endd
36939 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36940 given email address would be accepted in a RCPT command in a TCP/IP
36941 connection from the host with the given IP address. The output of the utility
36942 is either the word &"accepted"&, or the SMTP error response, for example:
36943 .code
36944 Rejected:
36945 550 Relay not permitted
36946 .endd
36947 When running this test, the utility uses &`<>`& as the envelope sender address
36948 for the MAIL command, but you can change this by providing additional
36949 options. These are passed directly to the Exim command. For example, to specify
36950 that the test is to be run with the sender address &'himself@there.example'&
36951 you can use:
36952 .code
36953 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36954                  -f himself@there.example
36955 .endd
36956 Note that these additional Exim command line items must be given after the two
36957 mandatory arguments.
36958
36959 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36960 while running its checks. You can run checks that include callouts by using
36961 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36962
36963
36964
36965 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36966 .cindex "DBM" "building dbm files"
36967 .cindex "building DBM files"
36968 .cindex "&'exim_dbmbuild'&"
36969 .cindex "lower casing"
36970 .cindex "binary zero" "in lookup key"
36971 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36972 the format used by the &(lsearch)& lookup (see section
36973 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36974 names as keys and the remainder of the information as data. The lower-casing
36975 can be prevented by calling the program with the &%-nolc%& option.
36976
36977 A terminating zero is included as part of the key string. This is expected by
36978 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36979 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36980 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36981 files.
36982
36983 The program requires two arguments: the name of the input file (which can be a
36984 single hyphen to indicate the standard input), and the name of the output file.
36985 It creates the output under a temporary name, and then renames it if all went
36986 well.
36987
36988 .cindex "USE_DB"
36989 If the native DB interface is in use (USE_DB is set in a compile-time
36990 configuration file &-- this is common in free versions of Unix) the two file
36991 names must be different, because in this mode the Berkeley DB functions create
36992 a single output file using exactly the name given. For example,
36993 .code
36994 exim_dbmbuild /etc/aliases /etc/aliases.db
36995 .endd
36996 reads the system alias file and creates a DBM version of it in
36997 &_/etc/aliases.db_&.
36998
36999 In systems that use the &'ndbm'& routines (mostly proprietary versions of
37000 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
37001 environment, the suffixes are added to the second argument of
37002 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
37003 when the Berkeley functions are used in compatibility mode (though this is not
37004 recommended), because in that case it adds a &_.db_& suffix to the file name.
37005
37006 If a duplicate key is encountered, the program outputs a warning, and when it
37007 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
37008 option is used. By default, only the first of a set of duplicates is used &--
37009 this makes it compatible with &(lsearch)& lookups. There is an option
37010 &%-lastdup%& which causes it to use the data for the last duplicate instead.
37011 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
37012 &%stderr%&. For other errors, where it doesn't actually make a new file, the
37013 return code is 2.
37014
37015
37016
37017
37018 .section "Finding individual retry times (exinext)" "SECTfinindret"
37019 .cindex "retry" "times"
37020 .cindex "&'exinext'&"
37021 A utility called &'exinext'& (mostly a Perl script) provides the ability to
37022 fish specific information out of the retry database. Given a mail domain (or a
37023 complete address), it looks up the hosts for that domain, and outputs any retry
37024 information for the hosts or for the domain. At present, the retry information
37025 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
37026 output. For example:
37027 .code
37028 $ exinext piglet@milne.fict.example
37029 kanga.milne.example:192.168.8.1 error 146: Connection refused
37030   first failed: 21-Feb-1996 14:57:34
37031   last tried:   21-Feb-1996 14:57:34
37032   next try at:  21-Feb-1996 15:02:34
37033 roo.milne.example:192.168.8.3 error 146: Connection refused
37034   first failed: 20-Jan-1996 13:12:08
37035   last tried:   21-Feb-1996 11:42:03
37036   next try at:  21-Feb-1996 19:42:03
37037   past final cutoff time
37038 .endd
37039 You can also give &'exinext'& a local part, without a domain, and it
37040 will give any retry information for that local part in your default domain.
37041 A message id can be used to obtain retry information pertaining to a specific
37042 message. This exists only when an attempt to deliver a message to a remote host
37043 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
37044 &'exinext'& is not particularly efficient, but then it is not expected to be
37045 run very often.
37046
37047 The &'exinext'& utility calls Exim to find out information such as the location
37048 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
37049 passed on to the &'exim'& commands. The first specifies an alternate Exim
37050 configuration file, and the second sets macros for use within the configuration
37051 file. These features are mainly to help in testing, but might also be useful in
37052 environments where more than one configuration file is in use.
37053
37054
37055
37056 .section "Hints database maintenance" "SECThindatmai"
37057 .cindex "hints database" "maintenance"
37058 .cindex "maintaining Exim's hints database"
37059 Three utility programs are provided for maintaining the DBM files that Exim
37060 uses to contain its delivery hint information. Each program requires two
37061 arguments. The first specifies the name of Exim's spool directory, and the
37062 second is the name of the database it is to operate on. These are as follows:
37063
37064 .ilist
37065 &'retry'&: the database of retry information
37066 .next
37067 &'wait-'&<&'transport name'&>: databases of information about messages waiting
37068 for remote hosts
37069 .next
37070 &'callout'&: the callout cache
37071 .next
37072 &'ratelimit'&: the data for implementing the ratelimit ACL condition
37073 .next
37074 &'misc'&: other hints data
37075 .endlist
37076
37077 The &'misc'& database is used for
37078
37079 .ilist
37080 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
37081 .next
37082 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
37083 &(smtp)& transport)
37084 .next
37085 Limiting the concurrency of specific transports (when &%max_parallel%& is set
37086 in a transport)
37087 .endlist
37088
37089
37090
37091 .section "exim_dumpdb" "SECID261"
37092 .cindex "&'exim_dumpdb'&"
37093 The entire contents of a database are written to the standard output by the
37094 &'exim_dumpdb'& program, which has no options or arguments other than the
37095 spool and database names. For example, to dump the retry database:
37096 .code
37097 exim_dumpdb /var/spool/exim retry
37098 .endd
37099 Two lines of output are produced for each entry:
37100 .code
37101 T:mail.ref.example:192.168.242.242 146 77 Connection refused
37102 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
37103 .endd
37104 The first item on the first line is the key of the record. It starts with one
37105 of the letters R, or T, depending on whether it refers to a routing or
37106 transport retry. For a local delivery, the next part is the local address; for
37107 a remote delivery it is the name of the remote host, followed by its failing IP
37108 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
37109 transport). If the remote port is not the standard one (port 25), it is added
37110 to the IP address. Then there follows an error code, an additional error code,
37111 and a textual description of the error.
37112
37113 The three times on the second line are the time of first failure, the time of
37114 the last delivery attempt, and the computed time for the next attempt. The line
37115 ends with an asterisk if the cutoff time for the last retry rule has been
37116 exceeded.
37117
37118 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
37119 consists of a host name followed by a list of ids for messages that are or were
37120 waiting to be delivered to that host. If there are a very large number for any
37121 one host, continuation records, with a sequence number added to the host name,
37122 may be seen. The data in these records is often out of date, because a message
37123 may be routed to several alternative hosts, and Exim makes no effort to keep
37124 cross-references.
37125
37126
37127
37128 .section "exim_tidydb" "SECID262"
37129 .cindex "&'exim_tidydb'&"
37130 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
37131 database. If run with no options, it removes all records that are more than 30
37132 days old. The age is calculated from the date and time that the record was last
37133 updated. Note that, in the case of the retry database, it is &'not'& the time
37134 since the first delivery failure. Information about a host that has been down
37135 for more than 30 days will remain in the database, provided that the record is
37136 updated sufficiently often.
37137
37138 The cutoff date can be altered by means of the &%-t%& option, which must be
37139 followed by a time. For example, to remove all records older than a week from
37140 the retry database:
37141 .code
37142 exim_tidydb -t 7d /var/spool/exim retry
37143 .endd
37144 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
37145 message ids. In the former these appear as data in records keyed by host &--
37146 they were messages that were waiting for that host &-- and in the latter they
37147 are the keys for retry information for messages that have suffered certain
37148 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
37149 message ids in database records are those of messages that are still on the
37150 queue. Message ids for messages that no longer exist are removed from
37151 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
37152 For the &'retry'& database, records whose keys are non-existent message ids are
37153 removed. The &'exim_tidydb'& utility outputs comments on the standard output
37154 whenever it removes information from the database.
37155
37156 Certain records are automatically removed by Exim when they are no longer
37157 needed, but others are not. For example, if all the MX hosts for a domain are
37158 down, a retry record is created for each one. If the primary MX host comes back
37159 first, its record is removed when Exim successfully delivers to it, but the
37160 records for the others remain because Exim has not tried to use those hosts.
37161
37162 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37163 hints databases. You should do this at a quiet time of day, because it requires
37164 a database to be locked (and therefore inaccessible to Exim) while it does its
37165 work. Removing records from a DBM file does not normally make the file smaller,
37166 but all the common DBM libraries are able to re-use the space that is released.
37167 After an initial phase of increasing in size, the databases normally reach a
37168 point at which they no longer get any bigger, as long as they are regularly
37169 tidied.
37170
37171 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37172 databases is likely to keep on increasing.
37173
37174
37175
37176
37177 .section "exim_fixdb" "SECID263"
37178 .cindex "&'exim_fixdb'&"
37179 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37180 Its main use is for testing Exim, but it might also be occasionally useful for
37181 getting round problems in a live system. It has no options, and its interface
37182 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37183 key of a database record can then be entered, and the data for that record is
37184 displayed.
37185
37186 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37187 except the &'retry'& database, that is the only operation that can be carried
37188 out. For the &'retry'& database, each field is output preceded by a number, and
37189 data for individual fields can be changed by typing the field number followed
37190 by new data, for example:
37191 .code
37192 > 4 951102:1000
37193 .endd
37194 resets the time of the next delivery attempt. Time values are given as a
37195 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37196 used as optional separators.
37197
37198
37199
37200
37201 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37202 .cindex "mailbox" "maintenance"
37203 .cindex "&'exim_lock'&"
37204 .cindex "locking mailboxes"
37205 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37206 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37207 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37208 a user agent while investigating a problem. The utility requires the name of
37209 the file as its first argument. If the locking is successful, the second
37210 argument is run as a command (using C's &[system()]& function); if there is no
37211 second argument, the value of the SHELL environment variable is used; if this
37212 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37213 is unlocked and the utility ends. The following options are available:
37214
37215 .vlist
37216 .vitem &%-fcntl%&
37217 Use &[fcntl()]& locking on the open mailbox.
37218
37219 .vitem &%-flock%&
37220 Use &[flock()]& locking on the open mailbox, provided the operating system
37221 supports it.
37222
37223 .vitem &%-interval%&
37224 This must be followed by a number, which is a number of seconds; it sets the
37225 interval to sleep between retries (default 3).
37226
37227 .vitem &%-lockfile%&
37228 Create a lock file before opening the mailbox.
37229
37230 .vitem &%-mbx%&
37231 Lock the mailbox using MBX rules.
37232
37233 .vitem &%-q%&
37234 Suppress verification output.
37235
37236 .vitem &%-retries%&
37237 This must be followed by a number; it sets the number of times to try to get
37238 the lock (default 10).
37239
37240 .vitem &%-restore_time%&
37241 This option causes &%exim_lock%& to restore the modified and read times to the
37242 locked file before exiting. This allows you to access a locked mailbox (for
37243 example, to take a backup copy) without disturbing the times that the user
37244 subsequently sees.
37245
37246 .vitem &%-timeout%&
37247 This must be followed by a number, which is a number of seconds; it sets a
37248 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37249 default), a non-blocking call is used.
37250
37251 .vitem &%-v%&
37252 Generate verbose output.
37253 .endlist
37254
37255 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37256 default is to create a lock file and also to use &[fcntl()]& locking on the
37257 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37258 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37259 requires that the directory containing the file be writeable. Locking by lock
37260 file does not last for ever; Exim assumes that a lock file is expired if it is
37261 more than 30 minutes old.
37262
37263 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37264 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37265 to be taken out on the open mailbox, and an exclusive lock on the file
37266 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37267 number of the mailbox file. When the locking is released, if an exclusive lock
37268 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37269
37270 The default output contains verification of the locking that takes place. The
37271 &%-v%& option causes some additional information to be given. The &%-q%& option
37272 suppresses all output except error messages.
37273
37274 A command such as
37275 .code
37276 exim_lock /var/spool/mail/spqr
37277 .endd
37278 runs an interactive shell while the file is locked, whereas
37279 .display
37280 &`exim_lock -q /var/spool/mail/spqr <<End`&
37281 <&'some commands'&>
37282 &`End`&
37283 .endd
37284 runs a specific non-interactive sequence of commands while the file is locked,
37285 suppressing all verification output. A single command can be run by a command
37286 such as
37287 .code
37288 exim_lock -q /var/spool/mail/spqr \
37289   "cp /var/spool/mail/spqr /some/where"
37290 .endd
37291 Note that if a command is supplied, it must be entirely contained within the
37292 second argument &-- hence the quotes.
37293 .ecindex IIDutils
37294
37295
37296 . ////////////////////////////////////////////////////////////////////////////
37297 . ////////////////////////////////////////////////////////////////////////////
37298
37299 .chapter "The Exim monitor" "CHAPeximon"
37300 .scindex IIDeximon "Exim monitor" "description"
37301 .cindex "X-windows"
37302 .cindex "&'eximon'&"
37303 .cindex "Local/eximon.conf"
37304 .cindex "&_exim_monitor/EDITME_&"
37305 The Exim monitor is an application which displays in an X window information
37306 about the state of Exim's queue and what Exim is doing. An admin user can
37307 perform certain operations on messages from this GUI interface; however all
37308 such facilities are also available from the command line, and indeed, the
37309 monitor itself makes use of the command line to perform any actions requested.
37310
37311
37312
37313 .section "Running the monitor" "SECID264"
37314 The monitor is started by running the script called &'eximon'&. This is a shell
37315 script that sets up a number of environment variables, and then runs the
37316 binary called &_eximon.bin_&. The default appearance of the monitor window can
37317 be changed by editing the &_Local/eximon.conf_& file created by editing
37318 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37319 parameters are for.
37320
37321 The parameters that get built into the &'eximon'& script can be overridden for
37322 a particular invocation by setting up environment variables of the same names,
37323 preceded by &`EXIMON_`&. For example, a shell command such as
37324 .code
37325 EXIMON_LOG_DEPTH=400 eximon
37326 .endd
37327 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37328 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37329 overrides the Exim log file configuration. This makes it possible to have
37330 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37331 syslog messages are routed to a file on the local host.
37332
37333 X resources can be used to change the appearance of the window in the normal
37334 way. For example, a resource setting of the form
37335 .code
37336 Eximon*background: gray94
37337 .endd
37338 changes the colour of the background to light grey rather than white. The
37339 stripcharts are drawn with both the data lines and the reference lines in
37340 black. This means that the reference lines are not visible when on top of the
37341 data. However, their colour can be changed by setting a resource called
37342 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37343 For example, if your X server is running Unix, you could set up lighter
37344 reference lines in the stripcharts by obeying
37345 .code
37346 xrdb -merge <<End
37347 Eximon*highlight: gray
37348 End
37349 .endd
37350 .cindex "admin user"
37351 In order to see the contents of messages on the queue, and to operate on them,
37352 &'eximon'& must either be run as root or by an admin user.
37353
37354 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37355 contain X11 resource parameters interpreted by the X11 library.  In addition,
37356 if the first parameter starts with the string "gdb" then it is removed and the
37357 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37358 versioned variants of gdb can be invoked).
37359
37360 The monitor's window is divided into three parts. The first contains one or
37361 more stripcharts and two action buttons, the second contains a &"tail"& of the
37362 main log file, and the third is a display of the queue of messages awaiting
37363 delivery, with two more action buttons. The following sections describe these
37364 different parts of the display.
37365
37366
37367
37368
37369 .section "The stripcharts" "SECID265"
37370 .cindex "stripchart"
37371 The first stripchart is always a count of messages on the queue. Its name can
37372 be configured by setting QUEUE_STRIPCHART_NAME in the
37373 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37374 configuration script by regular expression matches on log file entries, making
37375 it possible to display, for example, counts of messages delivered to certain
37376 hosts or using certain transports. The supplied defaults display counts of
37377 received and delivered messages, and of local and SMTP deliveries. The default
37378 period between stripchart updates is one minute; this can be adjusted by a
37379 parameter in the &_Local/eximon.conf_& file.
37380
37381 The stripchart displays rescale themselves automatically as the value they are
37382 displaying changes. There are always 10 horizontal lines in each chart; the
37383 title string indicates the value of each division when it is greater than one.
37384 For example, &"x2"& means that each division represents a value of 2.
37385
37386 It is also possible to have a stripchart which shows the percentage fullness of
37387 a particular disk partition, which is useful when local deliveries are confined
37388 to a single partition.
37389
37390 .cindex "&%statvfs%& function"
37391 This relies on the availability of the &[statvfs()]& function or equivalent in
37392 the operating system. Most, but not all versions of Unix that support Exim have
37393 this. For this particular stripchart, the top of the chart always represents
37394 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37395 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37396 &_Local/eximon.conf_& file.
37397
37398
37399
37400
37401 .section "Main action buttons" "SECID266"
37402 .cindex "size" "of monitor window"
37403 .cindex "Exim monitor" "window size"
37404 .cindex "window size"
37405 Below the stripcharts there is an action button for quitting the monitor. Next
37406 to this is another button marked &"Size"&. They are placed here so that
37407 shrinking the window to its default minimum size leaves just the queue count
37408 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37409 the window to expand to its maximum size, unless it is already at the maximum,
37410 in which case it is reduced to its minimum.
37411
37412 When expanding to the maximum, if the window cannot be fully seen where it
37413 currently is, it is moved back to where it was the last time it was at full
37414 size. When it is expanding from its minimum size, the old position is
37415 remembered, and next time it is reduced to the minimum it is moved back there.
37416
37417 The idea is that you can keep a reduced window just showing one or two
37418 stripcharts at a convenient place on your screen, easily expand it to show
37419 the full window when required, and just as easily put it back to what it was.
37420 The idea is copied from what the &'twm'& window manager does for its
37421 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37422 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37423
37424 Normally, the monitor starts up with the window at its full size, but it can be
37425 built so that it starts up with the window at its smallest size, by setting
37426 START_SMALL=yes in &_Local/eximon.conf_&.
37427
37428
37429
37430 .section "The log display" "SECID267"
37431 .cindex "log" "tail of; in monitor"
37432 The second section of the window is an area in which a display of the tail of
37433 the main log is maintained.
37434 To save space on the screen, the timestamp on each log line is shortened by
37435 removing the date and, if &%log_timezone%& is set, the timezone.
37436 The log tail is not available when the only destination for logging data is
37437 syslog, unless the syslog lines are routed to a local file whose name is passed
37438 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37439
37440 The log sub-window has a scroll bar at its lefthand side which can be used to
37441 move back to look at earlier text, and the up and down arrow keys also have a
37442 scrolling effect. The amount of log that is kept depends on the setting of
37443 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37444 to use. When this is full, the earlier 50% of data is discarded &-- this is
37445 much more efficient than throwing it away line by line. The sub-window also has
37446 a horizontal scroll bar for accessing the ends of long log lines. This is the
37447 only means of horizontal scrolling; the right and left arrow keys are not
37448 available. Text can be cut from this part of the window using the mouse in the
37449 normal way. The size of this subwindow is controlled by parameters in the
37450 configuration file &_Local/eximon.conf_&.
37451
37452 Searches of the text in the log window can be carried out by means of the ^R
37453 and ^S keystrokes, which default to a reverse and a forward search,
37454 respectively. The search covers only the text that is displayed in the window.
37455 It cannot go further back up the log.
37456
37457 The point from which the search starts is indicated by a caret marker. This is
37458 normally at the end of the text in the window, but can be positioned explicitly
37459 by pointing and clicking with the left mouse button, and is moved automatically
37460 by a successful search. If new text arrives in the window when it is scrolled
37461 back, the caret remains where it is, but if the window is not scrolled back,
37462 the caret is moved to the end of the new text.
37463
37464 Pressing ^R or ^S pops up a window into which the search text can be typed.
37465 There are buttons for selecting forward or reverse searching, for carrying out
37466 the search, and for cancelling. If the &"Search"& button is pressed, the search
37467 happens and the window remains so that further searches can be done. If the
37468 &"Return"& key is pressed, a single search is done and the window is closed. If
37469 ^C is typed the search is cancelled.
37470
37471 The searching facility is implemented using the facilities of the Athena text
37472 widget. By default this pops up a window containing both &"search"& and
37473 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37474 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37475 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37476 provided version of &%TextPop%& when the remaining parts of the text widget
37477 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37478 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37479 on these systems, at the expense of having unwanted items in the search popup
37480 window.
37481
37482
37483
37484 .section "The queue display" "SECID268"
37485 .cindex "queue" "display in monitor"
37486 The bottom section of the monitor window contains a list of all messages that
37487 are on the queue, which includes those currently being received or delivered,
37488 as well as those awaiting delivery. The size of this subwindow is controlled by
37489 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37490 at which it is updated is controlled by another parameter in the same file &--
37491 the default is 5 minutes, since queue scans can be quite expensive. However,
37492 there is an &"Update"& action button just above the display which can be used
37493 to force an update of the queue display at any time.
37494
37495 When a host is down for some time, a lot of pending mail can build up for it,
37496 and this can make it hard to deal with other messages on the queue. To help
37497 with this situation there is a button next to &"Update"& called &"Hide"&. If
37498 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37499 type anything in here and press &"Return"&, the text is added to a chain of
37500 such texts, and if every undelivered address in a message matches at least one
37501 of the texts, the message is not displayed.
37502
37503 If there is an address that does not match any of the texts, all the addresses
37504 are displayed as normal. The matching happens on the ends of addresses so, for
37505 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37506 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37507 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37508 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37509 a hide request is automatically cancelled after one hour.
37510
37511 While the dialogue box is displayed, you can't press any buttons or do anything
37512 else to the monitor window. For this reason, if you want to cut text from the
37513 queue display to use in the dialogue box, you have to do the cutting before
37514 pressing the &"Hide"& button.
37515
37516 The queue display contains, for each unhidden queued message, the length of
37517 time it has been on the queue, the size of the message, the message id, the
37518 message sender, and the first undelivered recipient, all on one line. If it is
37519 a bounce message, the sender is shown as &"<>"&. If there is more than one
37520 recipient to which the message has not yet been delivered, subsequent ones are
37521 listed on additional lines, up to a maximum configured number, following which
37522 an ellipsis is displayed. Recipients that have already received the message are
37523 not shown.
37524
37525 .cindex "frozen messages" "display"
37526 If a message is frozen, an asterisk is displayed at the left-hand side.
37527
37528 The queue display has a vertical scroll bar, and can also be scrolled by means
37529 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37530 The text searching facilities, as described above for the log window, are also
37531 available, but the caret is always moved to the end of the text when the queue
37532 display is updated.
37533
37534
37535
37536 .section "The queue menu" "SECID269"
37537 .cindex "queue" "menu in monitor"
37538 If the &%shift%& key is held down and the left button is clicked when the mouse
37539 pointer is over the text for any message, an action menu pops up, and the first
37540 line of the queue display for the message is highlighted. This does not affect
37541 any selected text.
37542
37543 If you want to use some other event for popping up the menu, you can set the
37544 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37545 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37546 value set in this parameter is a standard X event description. For example, to
37547 run eximon using &%ctrl%& rather than &%shift%& you could use
37548 .code
37549 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37550 .endd
37551 The title of the menu is the message id, and it contains entries which act as
37552 follows:
37553
37554 .ilist
37555 &'message log'&: The contents of the message log for the message are displayed
37556 in a new text window.
37557 .next
37558 &'headers'&: Information from the spool file that contains the envelope
37559 information and headers is displayed in a new text window. See chapter
37560 &<<CHAPspool>>& for a description of the format of spool files.
37561 .next
37562 &'body'&: The contents of the spool file containing the body of the message are
37563 displayed in a new text window. There is a default limit of 20,000 bytes to the
37564 amount of data displayed. This can be changed by setting the BODY_MAX
37565 option at compile time, or the EXIMON_BODY_MAX option at run time.
37566 .next
37567 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37568 delivery of the message. This causes an automatic thaw if the message is
37569 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37570 a new text window. The delivery is run in a separate process, to avoid holding
37571 up the monitor while the delivery proceeds.
37572 .next
37573 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37574 that the message be frozen.
37575 .next
37576 .cindex "thawing messages"
37577 .cindex "unfreezing messages"
37578 .cindex "frozen messages" "thawing"
37579 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37580 that the message be thawed.
37581 .next
37582 .cindex "delivery" "forcing failure"
37583 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37584 that Exim gives up trying to deliver the message. A bounce message is generated
37585 for any remaining undelivered addresses.
37586 .next
37587 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37588 that the message be deleted from the system without generating a bounce
37589 message.
37590 .next
37591 &'add recipient'&: A dialog box is displayed into which a recipient address can
37592 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37593 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37594 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37595 causes a call to Exim to be made using the &%-Mar%& option to request that an
37596 additional recipient be added to the message, unless the entry box is empty, in
37597 which case no action is taken.
37598 .next
37599 &'mark delivered'&: A dialog box is displayed into which a recipient address
37600 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37601 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37602 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37603 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37604 recipient address as already delivered, unless the entry box is empty, in which
37605 case no action is taken.
37606 .next
37607 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37608 mark all recipient addresses as already delivered.
37609 .next
37610 &'edit sender'&: A dialog box is displayed initialized with the current
37611 sender's address. Pressing RETURN causes a call to Exim to be made using the
37612 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37613 in which case no action is taken. If you want to set an empty sender (as in
37614 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37615 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37616 the address is qualified with that domain.
37617 .endlist
37618
37619 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37620 other cases when a call to Exim is made, if there is any output from Exim (in
37621 particular, if the command fails) a window containing the command and the
37622 output is displayed. Otherwise, the results of the action are normally apparent
37623 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37624 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37625 if no output is generated.
37626
37627 The queue display is automatically updated for actions such as freezing and
37628 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37629 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37630 force an update of the display after one of these actions.
37631
37632 In any text window that is displayed as result of a menu action, the normal
37633 cut-and-paste facility is available, and searching can be carried out using ^R
37634 and ^S, as described above for the log tail window.
37635 .ecindex IIDeximon
37636
37637
37638
37639
37640
37641 . ////////////////////////////////////////////////////////////////////////////
37642 . ////////////////////////////////////////////////////////////////////////////
37643
37644 .chapter "Security considerations" "CHAPsecurity"
37645 .scindex IIDsecurcon "security" "discussion of"
37646 This chapter discusses a number of issues concerned with security, some of
37647 which are also covered in other parts of this manual.
37648
37649 For reasons that this author does not understand, some people have promoted
37650 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37651 existence of this chapter in the documentation. However, the intent of the
37652 chapter is simply to describe the way Exim works in relation to certain
37653 security concerns, not to make any specific claims about the effectiveness of
37654 its security as compared with other MTAs.
37655
37656 What follows is a description of the way Exim is supposed to be. Best efforts
37657 have been made to try to ensure that the code agrees with the theory, but an
37658 absence of bugs can never be guaranteed. Any that are reported will get fixed
37659 as soon as possible.
37660
37661
37662 .section "Building a more &""hardened""& Exim" "SECID286"
37663 .cindex "security" "build-time features"
37664 There are a number of build-time options that can be set in &_Local/Makefile_&
37665 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37666 Exim administrator who does not have the root password, or by someone who has
37667 penetrated the Exim (but not the root) account. These options are as follows:
37668
37669 .ilist
37670 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37671 start of any file names used with the &%-C%& option. When it is set, these file
37672 names are also not allowed to contain the sequence &"/../"&. (However, if the
37673 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37674 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37675 default setting for &%ALT_CONFIG_PREFIX%&.
37676
37677 If the permitted configuration files are confined to a directory to
37678 which only root has access, this guards against someone who has broken
37679 into the Exim account from running a privileged Exim with an arbitrary
37680 configuration file, and using it to break into other accounts.
37681 .next
37682
37683 If a non-trusted configuration file (i.e. not the default configuration file
37684 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37685 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37686 the next item), then root privilege is retained only if the caller of Exim is
37687 root. This locks out the possibility of testing a configuration using &%-C%&
37688 right through message reception and delivery, even if the caller is root. The
37689 reception works, but by that time, Exim is running as the Exim user, so when
37690 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37691 privilege to be lost. However, root can test reception and delivery using two
37692 separate commands.
37693
37694 .next
37695 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37696 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37697 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37698 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37699 the restrictive side.  Requiring build-time selection of safe macros is onerous
37700 but this option is intended solely as a transition mechanism to permit
37701 previously-working configurations to continue to work after release 4.73.
37702 .next
37703 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37704 is disabled.
37705 .next
37706 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37707 never to be used for any deliveries. This is like the &%never_users%& runtime
37708 option, but it cannot be overridden; the runtime option adds additional users
37709 to the list. The default setting is &"root"&; this prevents a non-root user who
37710 is permitted to modify the runtime file from using Exim as a way to get root.
37711 .endlist
37712
37713
37714
37715 .section "Root privilege" "SECID270"
37716 .cindex "setuid"
37717 .cindex "root privilege"
37718 The Exim binary is normally setuid to root, which means that it gains root
37719 privilege (runs as root) when it starts execution. In some special cases (for
37720 example, when the daemon is not in use and there are no local deliveries), it
37721 may be possible to run Exim setuid to some user other than root. This is
37722 discussed in the next section. However, in most installations, root privilege
37723 is required for two things:
37724
37725 .ilist
37726 To set up a socket connected to the standard SMTP port (25) when initialising
37727 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37728 not required.
37729 .next
37730 To be able to change uid and gid in order to read users' &_.forward_& files and
37731 perform local deliveries as the receiving user or as specified in the
37732 configuration.
37733 .endlist
37734
37735 It is not necessary to be root to do any of the other things Exim does, such as
37736 receiving messages and delivering them externally over SMTP, and it is
37737 obviously more secure if Exim does not run as root except when necessary.
37738 For this reason, a user and group for Exim to use must be defined in
37739 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37740 group"&. Their values can be changed by the run time configuration, though this
37741 is not recommended. Often a user called &'exim'& is used, but some sites use
37742 &'mail'& or another user name altogether.
37743
37744 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37745 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37746 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37747
37748 After a new Exim process has interpreted its command line options, it changes
37749 uid and gid in the following cases:
37750
37751 .ilist
37752 .oindex "&%-C%&"
37753 .oindex "&%-D%&"
37754 If the &%-C%& option is used to specify an alternate configuration file, or if
37755 the &%-D%& option is used to define macro values for the configuration, and the
37756 calling process is not running as root, the uid and gid are changed to those of
37757 the calling process.
37758 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37759 option may not be used at all.
37760 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37761 can be supplied if the calling process is running as root, the Exim run-time
37762 user or CONFIGURE_OWNER, if defined.
37763 .next
37764 .oindex "&%-be%&"
37765 .oindex "&%-bf%&"
37766 .oindex "&%-bF%&"
37767 If the expansion test option (&%-be%&) or one of the filter testing options
37768 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37769 calling process.
37770 .next
37771 If the process is not a daemon process or a queue runner process or a delivery
37772 process or a process for testing address routing (started with &%-bt%&), the
37773 uid and gid are changed to the Exim user and group. This means that Exim always
37774 runs under its own uid and gid when receiving messages. This also applies when
37775 testing address verification
37776 .oindex "&%-bv%&"
37777 .oindex "&%-bh%&"
37778 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37779 option).
37780 .next
37781 For a daemon, queue runner, delivery, or address testing process, the uid
37782 remains as root at this stage, but the gid is changed to the Exim group.
37783 .endlist
37784
37785 The processes that initially retain root privilege behave as follows:
37786
37787 .ilist
37788 A daemon process changes the gid to the Exim group and the uid to the Exim
37789 user after setting up one or more listening sockets. The &[initgroups()]&
37790 function is called, so that if the Exim user is in any additional groups, they
37791 will be used during message reception.
37792 .next
37793 A queue runner process retains root privilege throughout its execution. Its
37794 job is to fork a controlled sequence of delivery processes.
37795 .next
37796 A delivery process retains root privilege throughout most of its execution,
37797 but any actual deliveries (that is, the transports themselves) are run in
37798 subprocesses which always change to a non-root uid and gid. For local
37799 deliveries this is typically the uid and gid of the owner of the mailbox; for
37800 remote deliveries, the Exim uid and gid are used. Once all the delivery
37801 subprocesses have been run, a delivery process changes to the Exim uid and gid
37802 while doing post-delivery tidying up such as updating the retry database and
37803 generating bounce and warning messages.
37804
37805 While the recipient addresses in a message are being routed, the delivery
37806 process runs as root. However, if a user's filter file has to be processed,
37807 this is done in a subprocess that runs under the individual user's uid and
37808 gid. A system filter is run as root unless &%system_filter_user%& is set.
37809 .next
37810 A process that is testing addresses (the &%-bt%& option) runs as root so that
37811 the routing is done in the same environment as a message delivery.
37812 .endlist
37813
37814
37815
37816
37817 .section "Running Exim without privilege" "SECTrunexiwitpri"
37818 .cindex "privilege, running without"
37819 .cindex "unprivileged running"
37820 .cindex "root privilege" "running without"
37821 Some installations like to run Exim in an unprivileged state for more of its
37822 operation, for added security. Support for this mode of operation is provided
37823 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37824 gid are changed to the Exim user and group at the start of a delivery process
37825 (and also queue runner and address testing processes). This means that address
37826 routing is no longer run as root, and the deliveries themselves cannot change
37827 to any other uid.
37828
37829 .cindex SIGHUP
37830 .cindex "daemon" "restarting"
37831 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37832 that the daemon can still be started in the usual way, and it can respond
37833 correctly to SIGHUP because the re-invocation regains root privilege.
37834
37835 An alternative approach is to make Exim setuid to the Exim user and also setgid
37836 to the Exim group. If you do this, the daemon must be started from a root
37837 process. (Calling Exim from a root process makes it behave in the way it does
37838 when it is setuid root.) However, the daemon cannot restart itself after a
37839 SIGHUP signal because it cannot regain privilege.
37840
37841 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37842 stops Exim from trying to re-invoke itself to do a delivery after a message has
37843 been received. Such a re-invocation is a waste of resources because it has no
37844 effect.
37845
37846 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37847 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37848 to the Exim user seems a clean approach, but there is one complication:
37849
37850 In this style of operation, Exim is running with the real uid and gid set to
37851 those of the calling process, and the effective uid/gid set to Exim's values.
37852 Ideally, any association with the calling process' uid/gid should be dropped,
37853 that is, the real uid/gid should be reset to the effective values so as to
37854 discard any privileges that the caller may have. While some operating systems
37855 have a function that permits this action for a non-root effective uid, quite a
37856 number of them do not. Because of this lack of standardization, Exim does not
37857 address this problem at this time.
37858
37859 For this reason, the recommended approach for &"mostly unprivileged"& running
37860 is to keep the Exim binary setuid to root, and to set
37861 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37862 be used in the most straightforward way.
37863
37864 If you configure Exim not to run delivery processes as root, there are a
37865 number of restrictions on what you can do:
37866
37867 .ilist
37868 You can deliver only as the Exim user/group. You should  explicitly use the
37869 &%user%& and &%group%& options to override routers or local transports that
37870 normally deliver as the recipient. This makes sure that configurations that
37871 work in this mode function the same way in normal mode. Any implicit or
37872 explicit specification of another user causes an error.
37873 .next
37874 Use of &_.forward_& files is severely restricted, such that it is usually
37875 not worthwhile to include them in the configuration.
37876 .next
37877 Users who wish to use &_.forward_& would have to make their home directory and
37878 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37879 and their equivalents in Exim filters, cannot be used. While they could be
37880 enabled in the Exim user's name, that would be insecure and not very useful.
37881 .next
37882 Unless the local user mailboxes are all owned by the Exim user (possible in
37883 some POP3 or IMAP-only environments):
37884
37885 .olist
37886 They must be owned by the Exim group and be writeable by that group. This
37887 implies you must set &%mode%& in the appendfile configuration, as well as the
37888 mode of the mailbox files themselves.
37889 .next
37890 You must set &%no_check_owner%&, since most or all of the files will not be
37891 owned by the Exim user.
37892 .next
37893 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37894 on a newly created mailbox when unprivileged. This also implies that new
37895 mailboxes need to be created manually.
37896 .endlist olist
37897 .endlist ilist
37898
37899
37900 These restrictions severely restrict what can be done in local deliveries.
37901 However, there are no restrictions on remote deliveries. If you are running a
37902 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37903 gives more security at essentially no cost.
37904
37905 If you are using the &%mua_wrapper%& facility (see chapter
37906 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37907
37908
37909
37910
37911 .section "Delivering to local files" "SECID271"
37912 Full details of the checks applied by &(appendfile)& before it writes to a file
37913 are given in chapter &<<CHAPappendfile>>&.
37914
37915
37916
37917 .section "Running local commands" "SECTsecconslocalcmds"
37918 .cindex "security" "local commands"
37919 .cindex "security" "command injection attacks"
37920 There are a number of ways in which an administrator can configure Exim to run
37921 commands based upon received, untrustworthy, data. Further, in some
37922 configurations a user who can control a &_.forward_& file can also arrange to
37923 run commands. Configuration to check includes, but is not limited to:
37924
37925 .ilist
37926 Use of &%use_shell%& in the pipe transport: various forms of shell command
37927 injection may be possible with this option present. It is dangerous and should
37928 be used only with considerable caution. Consider constraints which whitelist
37929 allowed characters in a variable which is to be used in a pipe transport that
37930 has &%use_shell%& enabled.
37931 .next
37932 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37933 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37934 &_.forward_& files in a redirect router. If Exim is running on a central mail
37935 hub to which ordinary users do not have shell access, but home directories are
37936 NFS mounted (for instance) then administrators should review the list of these
37937 forbid options available, and should bear in mind that the options that may
37938 need forbidding can change as new features are added between releases.
37939 .next
37940 The &%${run...}%& expansion item does not use a shell by default, but
37941 administrators can configure use of &_/bin/sh_& as part of the command.
37942 Such invocations should be viewed with prejudicial suspicion.
37943 .next
37944 Administrators who use embedded Perl are advised to explore how Perl's
37945 taint checking might apply to their usage.
37946 .next
37947 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37948 administrators are well advised to view its use with suspicion, in case (for
37949 instance) it allows a local-part to contain embedded Exim directives.
37950 .next
37951 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37952 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37953 each can reference arbitrary lists and files, rather than just being a list
37954 of opaque strings.
37955 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37956 real-world security vulnerabilities caused by its use with untrustworthy data
37957 injected in, for SQL injection attacks.
37958 Consider the use of the &%inlisti%& expansion condition instead.
37959 .endlist
37960
37961
37962
37963
37964 .section "Trust in configuration data" "SECTsecconfdata"
37965 .cindex "security" "data sources"
37966 .cindex "security" "regular expressions"
37967 .cindex "regular expressions" "security"
37968 .cindex "PCRE" "security"
37969 If configuration data for Exim can come from untrustworthy sources, there
37970 are some issues to be aware of:
37971
37972 .ilist
37973 Use of &%${expand...}%& may provide a path for shell injection attacks.
37974 .next
37975 Letting untrusted data provide a regular expression is unwise.
37976 .next
37977 Using &%${match...}%& to apply a fixed regular expression against untrusted
37978 data may result in pathological behaviour within PCRE.  Be aware of what
37979 "backtracking" means and consider options for being more strict with a regular
37980 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37981 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37982 possessive quantifiers or just not using regular expressions against untrusted
37983 data.
37984 .next
37985 It can be important to correctly use &%${quote:...}%&,
37986 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37987 items to ensure that data is correctly constructed.
37988 .next
37989 Some lookups might return multiple results, even though normal usage is only
37990 expected to yield one result.
37991 .endlist
37992
37993
37994
37995
37996 .section "IPv4 source routing" "SECID272"
37997 .cindex "source routing" "in IP packets"
37998 .cindex "IP source routing"
37999 Many operating systems suppress IP source-routed packets in the kernel, but
38000 some cannot be made to do this, so Exim does its own check. It logs incoming
38001 IPv4 source-routed TCP calls, and then drops them. Things are all different in
38002 IPv6. No special checking is currently done.
38003
38004
38005
38006 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
38007 Support for these SMTP commands is disabled by default. If required, they can
38008 be enabled by defining suitable ACLs.
38009
38010
38011
38012
38013 .section "Privileged users" "SECID274"
38014 .cindex "trusted users"
38015 .cindex "admin user"
38016 .cindex "privileged user"
38017 .cindex "user" "trusted"
38018 .cindex "user" "admin"
38019 Exim recognizes two sets of users with special privileges. Trusted users are
38020 able to submit new messages to Exim locally, but supply their own sender
38021 addresses and information about a sending host. For other users submitting
38022 local messages, Exim sets up the sender address from the uid, and doesn't
38023 permit a remote host to be specified.
38024
38025 .oindex "&%-f%&"
38026 However, an untrusted user is permitted to use the &%-f%& command line option
38027 in the special form &%-f <>%& to indicate that a delivery failure for the
38028 message should not cause an error report. This affects the message's envelope,
38029 but it does not affect the &'Sender:'& header. Untrusted users may also be
38030 permitted to use specific forms of address with the &%-f%& option by setting
38031 the &%untrusted_set_sender%& option.
38032
38033 Trusted users are used to run processes that receive mail messages from some
38034 other mail domain and pass them on to Exim for delivery either locally, or over
38035 the Internet. Exim trusts a caller that is running as root, as the Exim user,
38036 as any user listed in the &%trusted_users%& configuration option, or under any
38037 group listed in the &%trusted_groups%& option.
38038
38039 Admin users are permitted to do things to the messages on Exim's queue. They
38040 can freeze or thaw messages, cause them to be returned to their senders, remove
38041 them entirely, or modify them in various ways. In addition, admin users can run
38042 the Exim monitor and see all the information it is capable of providing, which
38043 includes the contents of files on the spool.
38044
38045 .oindex "&%-M%&"
38046 .oindex "&%-q%&"
38047 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
38048 delivery of messages on its queue is restricted to admin users. This
38049 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
38050 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
38051 queue is also restricted to admin users. This restriction can be relaxed by
38052 setting &%no_queue_list_requires_admin%&.
38053
38054 Exim recognizes an admin user if the calling process is running as root or as
38055 the Exim user or if any of the groups associated with the calling process is
38056 the Exim group. It is not necessary actually to be running under the Exim
38057 group. However, if admin users who are not root or the Exim user are to access
38058 the contents of files on the spool via the Exim monitor (which runs
38059 unprivileged), Exim must be built to allow group read access to its spool
38060 files.
38061
38062 .new
38063 By default, regular users are trusted to perform basic testing and
38064 introspection commands, as themselves.  This setting can be tightened by
38065 setting the &%commandline_checks_require_admin%& option.
38066 This affects most of the checking options,
38067 such as &%-be%& and anything else &%-b*%&.
38068 .wen
38069
38070
38071 .section "Spool files" "SECID275"
38072 .cindex "spool directory" "files"
38073 Exim's spool directory and everything it contains is owned by the Exim user and
38074 set to the Exim group. The mode for spool files is defined in the
38075 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
38076 any user who is a member of the Exim group can access these files.
38077
38078
38079
38080 .section "Use of argv[0]" "SECID276"
38081 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
38082 of specific strings, Exim assumes certain options. For example, calling Exim
38083 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
38084 to calling it with the option &%-bS%&. There are no security implications in
38085 this.
38086
38087
38088
38089 .section "Use of %f formatting" "SECID277"
38090 The only use made of &"%f"& by Exim is in formatting load average values. These
38091 are actually stored in integer variables as 1000 times the load average.
38092 Consequently, their range is limited and so therefore is the length of the
38093 converted output.
38094
38095
38096
38097 .section "Embedded Exim path" "SECID278"
38098 Exim uses its own path name, which is embedded in the code, only when it needs
38099 to re-exec in order to regain root privilege. Therefore, it is not root when it
38100 does so. If some bug allowed the path to get overwritten, it would lead to an
38101 arbitrary program's being run as exim, not as root.
38102
38103
38104
38105 .section "Dynamic module directory" "SECTdynmoddir"
38106 Any dynamically loadable modules must be installed into the directory
38107 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
38108 loading it.
38109
38110
38111 .section "Use of sprintf()" "SECID279"
38112 .cindex "&[sprintf()]&"
38113 A large number of occurrences of &"sprintf"& in the code are actually calls to
38114 &'string_sprintf()'&, a function that returns the result in malloc'd store.
38115 The intermediate formatting is done into a large fixed buffer by a function
38116 that runs through the format string itself, and checks the length of each
38117 conversion before performing it, thus preventing buffer overruns.
38118
38119 The remaining uses of &[sprintf()]& happen in controlled circumstances where
38120 the output buffer is known to be sufficiently long to contain the converted
38121 string.
38122
38123
38124
38125 .section "Use of debug_printf() and log_write()" "SECID280"
38126 Arbitrary strings are passed to both these functions, but they do their
38127 formatting by calling the function &'string_vformat()'&, which runs through
38128 the format string itself, and checks the length of each conversion.
38129
38130
38131
38132 .section "Use of strcat() and strcpy()" "SECID281"
38133 These are used only in cases where the output buffer is known to be large
38134 enough to hold the result.
38135 .ecindex IIDsecurcon
38136
38137
38138
38139
38140 . ////////////////////////////////////////////////////////////////////////////
38141 . ////////////////////////////////////////////////////////////////////////////
38142
38143 .chapter "Format of spool files" "CHAPspool"
38144 .scindex IIDforspo1 "format" "spool files"
38145 .scindex IIDforspo2 "spool directory" "format of files"
38146 .scindex IIDforspo3 "spool files" "format of"
38147 .cindex "spool files" "editing"
38148 A message on Exim's queue consists of two files, whose names are the message id
38149 followed by -D and -H, respectively. The data portion of the message is kept in
38150 the -D file on its own. The message's envelope, status, and headers are all
38151 kept in the -H file, whose format is described in this chapter. Each of these
38152 two files contains the final component of its own name as its first line. This
38153 is insurance against disk crashes where the directory is lost but the files
38154 themselves are recoverable.
38155
38156 Some people are tempted into editing -D files in order to modify messages. You
38157 need to be extremely careful if you do this; it is not recommended and you are
38158 on your own if you do it. Here are some of the pitfalls:
38159
38160 .ilist
38161 You must ensure that Exim does not try to deliver the message while you are
38162 fiddling with it. The safest way is to take out a write lock on the -D file,
38163 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38164 place, the lock will be retained. If you write a new file and rename it, the
38165 lock will be lost at the instant of rename.
38166 .next
38167 .vindex "&$body_linecount$&"
38168 If you change the number of lines in the file, the value of
38169 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38170 cause incomplete transmission of messages or undeliverable messages.
38171 .next
38172 If the message is in MIME format, you must take care not to break it.
38173 .next
38174 If the message is cryptographically signed, any change will invalidate the
38175 signature.
38176 .endlist
38177 All in all, modifying -D files is fraught with danger.
38178
38179 Files whose names end with -J may also be seen in the &_input_& directory (or
38180 its subdirectories when &%split_spool_directory%& is set). These are journal
38181 files, used to record addresses to which the message has been delivered during
38182 the course of a delivery attempt. If there are still undelivered recipients at
38183 the end, the -H file is updated, and the -J file is deleted. If, however, there
38184 is some kind of crash (for example, a power outage) before this happens, the -J
38185 file remains in existence. When Exim next processes the message, it notices the
38186 -J file and uses it to update the -H file before starting the next delivery
38187 attempt.
38188
38189 .new
38190 Files whose names end with -K or .eml may also be seen in the spool.
38191 These are temporaries used for DKIM or malware processing, when that is used.
38192 They should be tidied up by normal operations; any old ones are probably
38193 relics of crashes and can be removed.
38194 .wen
38195
38196 .section "Format of the -H file" "SECID282"
38197 .cindex "uid (user id)" "in spool file"
38198 .cindex "gid (group id)" "in spool file"
38199 The second line of the -H file contains the login name for the uid of the
38200 process that called Exim to read the message, followed by the numerical uid and
38201 gid. For a locally generated message, this is normally the user who sent the
38202 message. For a message received over TCP/IP via the daemon, it is
38203 normally the Exim user.
38204
38205 The third line of the file contains the address of the message's sender as
38206 transmitted in the envelope, contained in angle brackets. The sender address is
38207 empty for bounce messages. For incoming SMTP mail, the sender address is given
38208 in the MAIL command. For locally generated mail, the sender address is
38209 created by Exim from the login name of the current user and the configured
38210 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38211 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38212 &"<>"& or an address that matches &%untrusted_set_senders%&.
38213
38214 The fourth line contains two numbers. The first is the time that the message
38215 was received, in the conventional Unix form &-- the number of seconds since the
38216 start of the epoch. The second number is a count of the number of messages
38217 warning of delayed delivery that have been sent to the sender.
38218
38219 There follow a number of lines starting with a hyphen. These can appear in any
38220 order, and are omitted when not relevant:
38221
38222 .vlist
38223 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38224 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38225 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38226 recognized, to provide backward compatibility. In the old format, a line of
38227 this form is present for every ACL variable that is not empty. The number
38228 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38229 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38230 the data string for the variable. The string itself starts at the beginning of
38231 the next line, and is followed by a newline character. It may contain internal
38232 newlines.
38233
38234 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38235 A line of this form is present for every ACL connection variable that is
38236 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38237 The length is the length of the data string for the variable. The string itself
38238 starts at the beginning of the next line, and is followed by a newline
38239 character. It may contain internal newlines.
38240
38241 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38242 A line of this form is present for every ACL message variable that is defined.
38243 Note that there is a space between &%-aclm%& and the rest of the name. The
38244 length is the length of the data string for the variable. The string itself
38245 starts at the beginning of the next line, and is followed by a newline
38246 character. It may contain internal newlines.
38247
38248 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38249 This is present if, when the message was received over SMTP, the value of
38250 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38251
38252 .vitem &%-allow_unqualified_recipient%&
38253 This is present if unqualified recipient addresses are permitted in header
38254 lines (to stop such addresses from being qualified if rewriting occurs at
38255 transport time). Local messages that were input using &%-bnq%& and remote
38256 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38257
38258 .vitem &%-allow_unqualified_sender%&
38259 This is present if unqualified sender addresses are permitted in header lines
38260 (to stop such addresses from being qualified if rewriting occurs at transport
38261 time). Local messages that were input using &%-bnq%& and remote messages from
38262 hosts that match &%sender_unqualified_hosts%& set this flag.
38263
38264 .vitem "&%-auth_id%&&~<&'text'&>"
38265 The id information for a message received on an authenticated SMTP connection
38266 &-- the value of the &$authenticated_id$& variable.
38267
38268 .vitem "&%-auth_sender%&&~<&'address'&>"
38269 The address of an authenticated sender &-- the value of the
38270 &$authenticated_sender$& variable.
38271
38272 .vitem "&%-body_linecount%&&~<&'number'&>"
38273 This records the number of lines in the body of the message, and is
38274 present unless &%-spool_file_wireformat%& is.
38275
38276 .vitem "&%-body_zerocount%&&~<&'number'&>"
38277 This records the number of binary zero bytes in the body of the message, and is
38278 present if the number is greater than zero.
38279
38280 .vitem &%-deliver_firsttime%&
38281 This is written when a new message is first added to the spool. When the spool
38282 file is updated after a deferral, it is omitted.
38283
38284 .vitem "&%-frozen%&&~<&'time'&>"
38285 .cindex "frozen messages" "spool data"
38286 The message is frozen, and the freezing happened at <&'time'&>.
38287
38288 .vitem "&%-helo_name%&&~<&'text'&>"
38289 This records the host name as specified by a remote host in a HELO or EHLO
38290 command.
38291
38292 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38293 This records the IP address of the host from which the message was received and
38294 the remote port number that was used. It is omitted for locally generated
38295 messages.
38296
38297 .vitem "&%-host_auth%&&~<&'text'&>"
38298 If the message was received on an authenticated SMTP connection, this records
38299 the name of the authenticator &-- the value of the
38300 &$sender_host_authenticated$& variable.
38301
38302 .vitem &%-host_lookup_failed%&
38303 This is present if an attempt to look up the sending host's name from its IP
38304 address failed. It corresponds to the &$host_lookup_failed$& variable.
38305
38306 .vitem "&%-host_name%&&~<&'text'&>"
38307 .cindex "reverse DNS lookup"
38308 .cindex "DNS" "reverse lookup"
38309 This records the name of the remote host from which the message was received,
38310 if the host name was looked up from the IP address when the message was being
38311 received. It is not present if no reverse lookup was done.
38312
38313 .vitem "&%-ident%&&~<&'text'&>"
38314 For locally submitted messages, this records the login of the originating user,
38315 unless it was a trusted user and the &%-oMt%& option was used to specify an
38316 ident value. For messages received over TCP/IP, this records the ident string
38317 supplied by the remote host, if any.
38318
38319 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38320 This records the IP address of the local interface and the port number through
38321 which a message was received from a remote host. It is omitted for locally
38322 generated messages.
38323
38324 .vitem &%-local%&
38325 The message is from a local sender.
38326
38327 .vitem &%-localerror%&
38328 The message is a locally-generated bounce message.
38329
38330 .vitem "&%-local_scan%&&~<&'string'&>"
38331 This records the data string that was returned by the &[local_scan()]& function
38332 when the message was received &-- the value of the &$local_scan_data$&
38333 variable. It is omitted if no data was returned.
38334
38335 .vitem &%-manual_thaw%&
38336 The message was frozen but has been thawed manually, that is, by an explicit
38337 Exim command rather than via the auto-thaw process.
38338
38339 .vitem &%-N%&
38340 A testing delivery process was started using the &%-N%& option to suppress any
38341 actual deliveries, but delivery was deferred. At any further delivery attempts,
38342 &%-N%& is assumed.
38343
38344 .vitem &%-received_protocol%&
38345 This records the value of the &$received_protocol$& variable, which contains
38346 the name of the protocol by which the message was received.
38347
38348 .vitem &%-sender_set_untrusted%&
38349 The envelope sender of this message was set by an untrusted local caller (used
38350 to ensure that the caller is displayed in queue listings).
38351
38352 .vitem "&%-spam_score_int%&&~<&'number'&>"
38353 If a message was scanned by SpamAssassin, this is present. It records the value
38354 of &$spam_score_int$&.
38355
38356 .new
38357 .vitem &%-spool_file_wireformat%&
38358 The -D file for this message is in wire-format (for ESMTP CHUNKING)
38359 rather than Unix-format.
38360 The line-ending is CRLF rather than newline.
38361 There is still, however, no leading-dot-stuffing.
38362 .wen
38363
38364 .vitem &%-tls_certificate_verified%&
38365 A TLS certificate was received from the client that sent this message, and the
38366 certificate was verified by the server.
38367
38368 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38369 When the message was received over an encrypted connection, this records the
38370 name of the cipher suite that was used.
38371
38372 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38373 When the message was received over an encrypted connection, and a certificate
38374 was received from the client, this records the Distinguished Name from that
38375 certificate.
38376 .endlist
38377
38378 Following the options there is a list of those addresses to which the message
38379 is not to be delivered. This set of addresses is initialized from the command
38380 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38381 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38382 the address is added to this set. The addresses are kept internally as a
38383 balanced binary tree, and it is a representation of that tree which is written
38384 to the spool file. If an address is expanded via an alias or forward file, the
38385 original address is added to the tree when deliveries to all its child
38386 addresses are complete.
38387
38388 If the tree is empty, there is a single line in the spool file containing just
38389 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38390 Y or N, followed by an address. The address is the value for the node of the
38391 tree, and the letters indicate whether the node has a left branch and/or a
38392 right branch attached to it, respectively. If branches exist, they immediately
38393 follow. Here is an example of a three-node tree:
38394 .code
38395 YY darcy@austen.fict.example
38396 NN alice@wonderland.fict.example
38397 NN editor@thesaurus.ref.example
38398 .endd
38399 After the non-recipients tree, there is a list of the message's recipients.
38400 This is a simple list, preceded by a count. It includes all the original
38401 recipients of the message, including those to whom the message has already been
38402 delivered. In the simplest case, the list contains one address per line. For
38403 example:
38404 .code
38405 4
38406 editor@thesaurus.ref.example
38407 darcy@austen.fict.example
38408 rdo@foundation
38409 alice@wonderland.fict.example
38410 .endd
38411 However, when a child address has been added to the top-level addresses as a
38412 result of the use of the &%one_time%& option on a &(redirect)& router, each
38413 line is of the following form:
38414 .display
38415 <&'top-level address'&> <&'errors_to address'&> &&&
38416   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38417 .endd
38418 The 01 flag bit indicates the presence of the three other fields that follow
38419 the top-level address. Other bits may be used in future to support additional
38420 fields. The <&'parent number'&> is the offset in the recipients list of the
38421 original parent of the &"one time"& address. The first two fields are the
38422 envelope sender that is associated with this address and its length. If the
38423 length is zero, there is no special envelope sender (there are then two space
38424 characters in the line). A non-empty field can arise from a &(redirect)& router
38425 that has an &%errors_to%& setting.
38426
38427
38428 A blank line separates the envelope and status information from the headers
38429 which follow. A header may occupy several lines of the file, and to save effort
38430 when reading it in, each header is preceded by a number and an identifying
38431 character. The number is the number of characters in the header, including any
38432 embedded newlines and the terminating newline. The character is one of the
38433 following:
38434
38435 .table2 50pt
38436 .row <&'blank'&>         "header in which Exim has no special interest"
38437 .row &`B`&               "&'Bcc:'& header"
38438 .row &`C`&               "&'Cc:'& header"
38439 .row &`F`&               "&'From:'& header"
38440 .row &`I`&               "&'Message-id:'& header"
38441 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38442 .row &`R`&               "&'Reply-To:'& header"
38443 .row &`S`&               "&'Sender:'& header"
38444 .row &`T`&               "&'To:'& header"
38445 .row &`*`&               "replaced or deleted header"
38446 .endtable
38447
38448 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38449 purposes. They are not transmitted when the message is delivered. Here is a
38450 typical set of headers:
38451 .code
38452 111P Received: by hobbit.fict.example with local (Exim 4.00)
38453 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38454 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38455 038* X-rewrote-sender: bb@hobbit.fict.example
38456 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38457 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38458 099* To: alice@wonderland.fict.example, rdo@foundation,
38459 darcy@austen.fict.example, editor@thesaurus.ref.example
38460 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38461 darcy@austen.fict.example, editor@thesaurus.ref.example
38462 038  Date: Fri, 11 May 2001 10:28:59 +0100
38463 .endd
38464 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38465 &'To:'& header have been rewritten, the last one because routing expanded the
38466 unqualified domain &'foundation'&.
38467 .ecindex IIDforspo1
38468 .ecindex IIDforspo2
38469 .ecindex IIDforspo3
38470
38471 .new
38472 .section "Format of the -D file" "SECID282a"
38473 The data file is traditionally in Unix-standard format: lines are ended with
38474 an ASCII newline character.
38475 However, when the &%spool_wireformat%& main option is used some -D files
38476 can have an alternate format.
38477 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
38478 The -D file lines (not including the first name-component line) are
38479 suitable for direct copying to the wire when transmitting using the
38480 ESMTP CHUNKING option, meaning lower processing overhead.
38481 Lines are terminated with an ASCII CRLF pair.
38482 There is no dot-stuffing (and no dot-termination).
38483 .wen
38484
38485 . ////////////////////////////////////////////////////////////////////////////
38486 . ////////////////////////////////////////////////////////////////////////////
38487
38488 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38489          "DKIM Support"
38490 .cindex "DKIM"
38491
38492 DKIM is a mechanism by which messages sent by some entity can be provably
38493 linked to a domain which that entity controls.  It permits reputation to
38494 be tracked on a per-domain basis, rather than merely upon source IP address.
38495 DKIM is documented in RFC 4871.
38496
38497 DKIM support is compiled into Exim by default if TLS support is present.
38498 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38499
38500 Exim's DKIM implementation allows for
38501 .olist
38502 Signing outgoing messages: This function is implemented in the SMTP transport.
38503 It can co-exist with all other Exim features
38504 (including transport filters)
38505 except cutthrough delivery.
38506 .next
38507 Verifying signatures in incoming messages: This is implemented by an additional
38508 ACL (acl_smtp_dkim), which can be called several times per message, with
38509 different signature contexts.
38510 .endlist
38511
38512 In typical Exim style, the verification implementation does not include any
38513 default "policy". Instead it enables you to build your own policy using
38514 Exim's standard controls.
38515
38516 Please note that verification of DKIM signatures in incoming mail is turned
38517 on by default for logging purposes. For each signature in incoming email,
38518 exim will log a line displaying the most important signature details, and the
38519 signature status. Here is an example (with line-breaks added for clarity):
38520 .code
38521 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38522     d=facebookmail.com s=q1-2009b
38523     c=relaxed/relaxed a=rsa-sha1
38524     i=@facebookmail.com t=1252484542 [verification succeeded]
38525 .endd
38526 You might want to turn off DKIM verification processing entirely for internal
38527 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38528 control modifier. This should typically be done in the RCPT ACL, at points
38529 where you accept mail from relay sources (internal hosts or authenticated
38530 senders).
38531
38532
38533 .section "Signing outgoing messages" "SECDKIMSIGN"
38534 .cindex "DKIM" "signing"
38535
38536 Signing is enabled by setting private options on the SMTP transport.
38537 These options take (expandable) strings as arguments.
38538
38539 .option dkim_domain smtp string list&!! unset
38540 The domain(s) you want to sign with.
38541 .new
38542 After expansion, this can be a list.
38543 Each element in turn is put into the &%$dkim_domain%& expansion variable
38544 while expanding the remaining signing options.
38545 .wen
38546 If it is empty after expansion, DKIM signing is not done.
38547
38548 .option dkim_selector smtp string list&!! unset
38549 This sets the key selector string.
38550 .new
38551 After expansion, which can use &$dkim_domain$&, this can be a list.
38552 Each element in turn is put in the expansion
38553 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38554 option along with &%$dkim_domain%&.
38555 If the option is empty after expansion, DKIM signing is not done for this domain.
38556 .wen
38557
38558 .option dkim_private_key smtp string&!! unset
38559 This sets the private key to use.
38560 You can use the &%$dkim_domain%& and
38561 &%$dkim_selector%& expansion variables to determine the private key to use.
38562 The result can either
38563 .ilist
38564 be a valid RSA private key in ASCII armor, including line breaks.
38565 .next
38566 start with a slash, in which case it is treated as a file that contains
38567 the private key.
38568 .next
38569 be "0", "false" or the empty string, in which case the message will not
38570 be signed. This case will not result in an error, even if &%dkim_strict%&
38571 is set.
38572 .endlist
38573 If the option is empty after expansion, DKIM signing is not done.
38574
38575 .new
38576 .option dkim_hash smtp string&!! sha256
38577 Can be set alternatively to &"sha1"& to use an alternate hash
38578 method.  Note that sha1 is now condidered insecure, and deprecated.
38579
38580 .option dkim_identity smtp string&!! unset
38581 If set after expansion, the value is used to set an "i=" tag in
38582 the signing header.  The DKIM standards restrict the permissible
38583 syntax of this optional tag to a mail address, with possibly-empty
38584 local part, an @, and a domain identical to or subdomain of the "d="
38585 tag value.  Note that Exim does not check the value.
38586 .wen
38587
38588 .option dkim_canon smtp string&!! unset
38589 This option sets the canonicalization method used when signing a message.
38590 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38591 The option defaults to "relaxed" when unset. Note: the current implementation
38592 only supports using the same canonicalization method for both headers and body.
38593
38594 .option dkim_strict smtp string&!! unset
38595 This  option  defines  how  Exim  behaves  when  signing a message that
38596 should be signed fails for some reason.  When the expansion evaluates to
38597 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38598 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38599 variables here.
38600
38601 .option dkim_sign_headers smtp string&!! "see below"
38602 If set, this option must expand to a colon-separated
38603 list of header names.
38604 .new
38605 Headers with these names, or the absence or such a header, will be included
38606 in the message signature.
38607 When unspecified, the header names listed in RFC4871 will be used,
38608 whether or not each header is present in the message.
38609 The default list is available for the expansion in the macro
38610 "_DKIM_SIGN_HEADERS".
38611 .wen
38612
38613
38614 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38615 .cindex "DKIM" "verification"
38616
38617 Verification of DKIM signatures in SMTP incoming email is implemented via the
38618 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38619 syntactically(!) correct signature in the incoming message.
38620 A missing ACL definition defaults to accept.
38621 If any ACL call does not accept, the message is not accepted.
38622 If a cutthrough delivery was in progress for the message, that is
38623 summarily dropped (having wasted the transmission effort).
38624
38625 To evaluate the signature in the ACL a large number of expansion variables
38626 containing the signature status and its details are set up during the
38627 runtime of the ACL.
38628
38629 Calling the ACL only for existing signatures is not sufficient to build
38630 more advanced policies. For that reason, the global option
38631 &%dkim_verify_signers%&, and a global expansion variable
38632 &%$dkim_signers%& exist.
38633
38634 The global option &%dkim_verify_signers%& can be set to a colon-separated
38635 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38636 called. It is expanded when the message has been received. At this point,
38637 the expansion variable &%$dkim_signers%& already contains a colon-separated
38638 list of signer domains and identities for the message. When
38639 &%dkim_verify_signers%& is not specified in the main configuration,
38640 it defaults as:
38641 .code
38642 dkim_verify_signers = $dkim_signers
38643 .endd
38644 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38645 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38646 call the ACL for known domains or identities. This would be achieved as follows:
38647 .code
38648 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38649 .endd
38650 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38651 and "ebay.com", plus all domains and identities that have signatures in the message.
38652 You can also be more creative in constructing your policy. For example:
38653 .code
38654 dkim_verify_signers = $sender_address_domain:$dkim_signers
38655 .endd
38656
38657 If a domain or identity is listed several times in the (expanded) value of
38658 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38659
38660
38661 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38662 available (from most to least important):
38663
38664
38665 .vlist
38666 .vitem &%$dkim_cur_signer%&
38667 The signer that is being evaluated in this ACL run. This can be a domain or
38668 an identity. This is one of the list items from the expanded main option
38669 &%dkim_verify_signers%& (see above).
38670
38671 .vitem &%$dkim_verify_status%&
38672 A string describing the general status of the signature. One of
38673 .ilist
38674 &%none%&: There is no signature in the message for the current domain or
38675 identity (as reflected by &%$dkim_cur_signer%&).
38676 .next
38677 &%invalid%&: The signature could not be verified due to a processing error.
38678 More detail is available in &%$dkim_verify_reason%&.
38679 .next
38680 &%fail%&: Verification of the signature failed.  More detail is
38681 available in &%$dkim_verify_reason%&.
38682 .next
38683 &%pass%&: The signature passed verification. It is valid.
38684 .endlist
38685
38686 .vitem &%$dkim_verify_reason%&
38687 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38688 "fail" or "invalid". One of
38689 .ilist
38690 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38691 key for the domain could not be retrieved. This may be a temporary problem.
38692 .next
38693 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38694 record for the domain is syntactically invalid.
38695 .next
38696 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38697 body hash does not match the one specified in the signature header. This
38698 means that the message body was modified in transit.
38699 .next
38700 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38701 could not be verified. This may mean that headers were modified,
38702 re-written or otherwise changed in a way which is incompatible with
38703 DKIM verification. It may of course also mean that the signature is forged.
38704 .endlist
38705
38706 .vitem &%$dkim_domain%&
38707 The signing domain. IMPORTANT: This variable is only populated if there is
38708 an actual signature in the message for the current domain or identity (as
38709 reflected by &%$dkim_cur_signer%&).
38710
38711 .vitem &%$dkim_identity%&
38712 The signing identity, if present. IMPORTANT: This variable is only populated
38713 if there is an actual signature in the message for the current domain or
38714 identity (as reflected by &%$dkim_cur_signer%&).
38715
38716 .vitem &%$dkim_selector%&
38717 The key record selector string.
38718
38719 .vitem &%$dkim_algo%&
38720 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38721
38722 .vitem &%$dkim_canon_body%&
38723 The body canonicalization method. One of 'relaxed' or 'simple'.
38724
38725 .vitem &%$dkim_canon_headers%&
38726 The header canonicalization method. One of 'relaxed' or 'simple'.
38727
38728 .vitem &%$dkim_copiedheaders%&
38729 A transcript of headers and their values which are included in the signature
38730 (copied from the 'z=' tag of the signature).
38731 Note that RFC6376 requires that verification fail if the From: header is
38732 not included in the signature.  Exim does not enforce this; sites wishing
38733 strict enforcement should code the check explicitly.
38734
38735 .vitem &%$dkim_bodylength%&
38736 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38737 limit was set by the signer, "9999999999999" is returned. This makes sure
38738 that this variable always expands to an integer value.
38739
38740 .vitem &%$dkim_created%&
38741 UNIX timestamp reflecting the date and time when the signature was created.
38742 When this was not specified by the signer, "0" is returned.
38743
38744 .vitem &%$dkim_expires%&
38745 UNIX timestamp reflecting the date and time when the signer wants the
38746 signature to be treated as "expired". When this was not specified by the
38747 signer, "9999999999999" is returned. This makes it possible to do useful
38748 integer size comparisons against this value.
38749
38750 .vitem &%$dkim_headernames%&
38751 A colon-separated list of names of headers included in the signature.
38752
38753 .vitem &%$dkim_key_testing%&
38754 "1" if the key record has the "testing" flag set, "0" if not.
38755
38756 .vitem &%$dkim_key_nosubdomains%&
38757 "1" if the key record forbids subdomaining, "0" otherwise.
38758
38759 .vitem &%$dkim_key_srvtype%&
38760 Service type (tag s=) from the key record. Defaults to "*" if not specified
38761 in the key record.
38762
38763 .vitem &%$dkim_key_granularity%&
38764 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38765 in the key record.
38766
38767 .vitem &%$dkim_key_notes%&
38768 Notes from the key record (tag n=).
38769
38770 .vitem &%$dkim_key_length%&
38771 Number of bits in the key.
38772 .endlist
38773
38774 In addition, two ACL conditions are provided:
38775
38776 .vlist
38777 .vitem &%dkim_signers%&
38778 ACL condition that checks a colon-separated list of domains or identities
38779 for a match against the domain or identity that the ACL is currently verifying
38780 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38781 verb to a group of domains or identities. For example:
38782
38783 .code
38784 # Warn when Mail purportedly from GMail has no gmail signature
38785 warn log_message = GMail sender without gmail.com DKIM signature
38786      sender_domains = gmail.com
38787      dkim_signers = gmail.com
38788      dkim_status = none
38789 .endd
38790
38791 Note that the above does not check for a total lack of DKIM signing;
38792 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38793
38794 .vitem &%dkim_status%&
38795 ACL condition that checks a colon-separated list of possible DKIM verification
38796 results against the actual result of verification. This is typically used
38797 to restrict an ACL verb to a list of verification outcomes, for example:
38798
38799 .code
38800 deny message = Mail from Paypal with invalid/missing signature
38801      sender_domains = paypal.com:paypal.de
38802      dkim_signers = paypal.com:paypal.de
38803      dkim_status = none:invalid:fail
38804 .endd
38805
38806 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38807 see the documentation of the &%$dkim_verify_status%& expansion variable above
38808 for more information of what they mean.
38809 .endlist
38810
38811 . ////////////////////////////////////////////////////////////////////////////
38812 . ////////////////////////////////////////////////////////////////////////////
38813
38814 .chapter "Proxies" "CHAPproxies" &&&
38815          "Proxy support"
38816 .cindex "proxy support"
38817 .cindex "proxy" "access via"
38818
38819 A proxy is an intermediate system through which communication is passed.
38820 Proxies may provide a security, availability or load-distribution function.
38821
38822
38823 .section "Inbound proxies" SECTproxyInbound
38824 .cindex proxy inbound
38825 .cindex proxy "server side"
38826 .cindex proxy "Proxy protocol"
38827 .cindex "Proxy protocol" proxy
38828
38829 Exim has support for receiving inbound SMTP connections via a proxy
38830 that uses &"Proxy Protocol"& to speak to it.
38831 To include this support, include &"SUPPORT_PROXY=yes"&
38832 in Local/Makefile.
38833
38834 It was built on specifications from:
38835 (&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)).
38836 That URL was revised in May 2014 to version 2 spec:
38837 (&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)).
38838
38839 The purpose of this facility is so that an application load balancer,
38840 such as HAProxy, can sit in front of several Exim servers
38841 to distribute load.
38842 Exim uses the local protocol communication with the proxy to obtain
38843 the remote SMTP system IP address and port information.
38844 There is no logging if a host passes or
38845 fails Proxy Protocol negotiation, but it can easily be determined and
38846 recorded in an ACL (example is below).
38847
38848 Use of a proxy is enabled by setting the &%hosts_proxy%&
38849 main configuration option to a hostlist; connections from these
38850 hosts will use Proxy Protocol.
38851 Exim supports both version 1 and version 2 of the Proxy Protocol and
38852 automatically determines which version is in use.
38853
38854 The Proxy Protocol header is the first data received on a TCP connection
38855 and is inserted before any TLS-on-connect handshake from the client; Exim
38856 negotiates TLS between Exim-as-server and the remote client, not between
38857 Exim and the proxy server.
38858
38859 The following expansion variables are usable
38860 (&"internal"& and &"external"& here refer to the interfaces
38861 of the proxy):
38862 .display
38863 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38864 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38865 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
38866 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
38867 &'proxy_session            '& boolean: SMTP connection via proxy
38868 .endd
38869 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38870 there was a protocol error.
38871
38872 Since the real connections are all coming from the proxy, and the
38873 per host connection tracking is done before Proxy Protocol is
38874 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38875 handle all of the parallel volume you expect per inbound proxy.
38876 With the option set so high, you lose the ability
38877 to protect your server from many connections from one IP.
38878 In order to prevent your server from overload, you
38879 need to add a per connection ratelimit to your connect ACL.
38880 A possible solution is:
38881 .display
38882   # Set max number of connections per host
38883   LIMIT   = 5
38884   # Or do some kind of IP lookup in a flat file or database
38885   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38886
38887   defer   message        = Too many connections from this IP right now
38888           ratelimit      = LIMIT / 5s / per_conn / strict
38889 .endd
38890
38891
38892
38893 .section "Outbound proxies" SECTproxySOCKS
38894 .cindex proxy outbound
38895 .cindex proxy "client side"
38896 .cindex proxy SOCKS
38897 .cindex SOCKS proxy
38898 Exim has support for sending outbound SMTP via a proxy
38899 using a protocol called SOCKS5 (defined by RFC1928).
38900 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38901 Local/Makefile.
38902
38903 Use of a proxy is enabled by setting the &%socks_proxy%& option
38904 on an smtp transport.
38905 The option value is expanded and should then be a list
38906 (colon-separated by default) of proxy specifiers.
38907 Each proxy specifier is a list
38908 (space-separated by default) where the initial element
38909 is an IP address and any subsequent elements are options.
38910
38911 Options are a string <name>=<value>.
38912 The list of options is in the following table:
38913 .display
38914 &'auth   '& authentication method
38915 &'name   '& authentication username
38916 &'pass   '& authentication password
38917 &'port   '& tcp port
38918 &'tmo    '& connection timeout
38919 &'pri    '& priority
38920 &'weight '& selection bias
38921 .endd
38922
38923 More details on each of these options follows:
38924
38925 .ilist
38926 .cindex authentication "to proxy"
38927 .cindex proxy authentication
38928 &%auth%&: Either &"none"& (default) or &"name"&.
38929 Using &"name"& selects username/password authentication per RFC 1929
38930 for access to the proxy.
38931 Default is &"none"&.
38932 .next
38933 &%name%&: sets the username for the &"name"& authentication method.
38934 Default is empty.
38935 .next
38936 &%pass%&: sets the password for the &"name"& authentication method.
38937 Default is empty.
38938 .next
38939 &%port%&: the TCP port number to use for the connection to the proxy.
38940 Default is 1080.
38941 .next
38942 &%tmo%&: sets a connection timeout in seconds for this proxy.
38943 Default is 5.
38944 .next
38945 &%pri%&: specifies a priority for the proxy within the list,
38946 higher values being tried first.
38947 The default priority is 1.
38948 .next
38949 &%weight%&: specifies a selection bias.
38950 Within a priority set servers are queried in a random fashion,
38951 weighted by this value.
38952 The default value for selection bias is 1.
38953 .endlist
38954
38955 Proxies from the list are tried according to their priority
38956 and weight settings until one responds.  The timeout for the
38957 overall connection applies to the set of proxied attempts.
38958
38959 .section Logging SECTproxyLog
38960 To log the (local) IP of a proxy in the incoming or delivery logline,
38961 add &"+proxy"& to the &%log_selector%& option.
38962 This will add a component tagged with &"PRX="& to the line.
38963
38964 . ////////////////////////////////////////////////////////////////////////////
38965 . ////////////////////////////////////////////////////////////////////////////
38966
38967 .chapter "Internationalisation" "CHAPi18n" &&&
38968          "Internationalisation""
38969 .cindex internationalisation "email address"
38970 .cindex EAI
38971 .cindex i18n
38972 .cindex UTF-8 "mail name handling"
38973
38974 Exim has support for Internationalised mail names.
38975 To include this it must be built with SUPPORT_I18N and the libidn library.
38976 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38977
38978 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
38979 instead of it) then IDNA2008 is supported; this adds an extra library
38980 requirement, upon libidn2.
38981
38982 .section "MTA operations" SECTi18nMTA
38983 .cindex SMTPUTF8 "ESMTP option"
38984 The main configuration option &%smtputf8_advertise_hosts%& specifies
38985 a host list.  If this matches the sending host and
38986 accept_8bitmime is true (the default) then the ESMTP option
38987 SMTPUTF8 will be advertised.
38988
38989 If the sender specifies the SMTPUTF8 option on a MAIL command
38990 international handling for the message is enabled and
38991 the expansion variable &$message_smtputf8$& will have value TRUE.
38992
38993 The option &%allow_utf8_domains%& is set to true for this
38994 message. All DNS lookups are converted to a-label form
38995 whatever the setting of &%allow_utf8_domains%&
38996 when Exim is built with SUPPORT_I18N.
38997
38998 Both localparts and domain are maintained as the original
38999 UTF-8 form internally; any comparison or regular-expression use will
39000 require appropriate care.  Filenames created, eg. by
39001 the appendfile transport, will have UTF-8 names.
39002
39003 HELO names sent by the smtp transport will have any UTF-8
39004 components expanded to a-label form,
39005 and any certificate name checks will be done using the a-label
39006 form of the name.
39007
39008 .cindex log protocol
39009 .cindex SMTPUTF8 logging
39010 Log lines and Received-by: header lines will acquire a "utf8"
39011 prefix on the protocol element, eg. utf8esmtp.
39012
39013 The following expansion operators can be used:
39014 .code
39015 ${utf8_domain_to_alabel:str}
39016 ${utf8_domain_from_alabel:str}
39017 ${utf8_localpart_to_alabel:str}
39018 ${utf8_localpart_from_alabel:str}
39019 .endd
39020
39021 ACLs may use the following modifier:
39022 .display
39023 control = utf8_downconvert
39024 control = utf8_downconvert/<value>
39025 .endd
39026 This sets a flag requiring that addresses are converted to
39027 a-label form before smtp delivery, for use in a
39028 Message Submission Agent context.
39029 If a value is appended it may be:
39030 .display
39031 &`1  `& (default) mandatory downconversion
39032 &`0  `& no downconversion
39033 &`-1 `& if SMTPUTF8 not supported by destination host
39034 .endd
39035
39036 If mua_wrapper is set, the utf8_downconvert control
39037 is initially set to -1.
39038
39039
39040 There is no explicit support for VRFY and EXPN.
39041 Configurations supporting these should inspect
39042 &$smtp_command_argument$& for an SMTPUTF8 argument.
39043
39044 There is no support for LMTP on Unix sockets.
39045 Using the "lmtp" protocol option on an smtp transport,
39046 for LMTP over TCP, should work as expected.
39047
39048 There is no support for DSN unitext handling,
39049 and no provision for converting logging from or to UTF-8.
39050
39051
39052
39053 .section "MDA operations" SECTi18nMDA
39054 To aid in constructing names suitable for IMAP folders
39055 the following expansion operator can be used:
39056 .code
39057 ${imapfolder {<string>} {<sep>} {<specials>}}
39058 .endd
39059
39060 The string is converted from the charset specified by
39061 the "headers charset" command (in a filter file)
39062 or &%headers_charset%& main configuration option (otherwise),
39063 to the
39064 modified UTF-7 encoding specified by RFC 2060,
39065 with the following exception: All occurences of <sep>
39066 (which has to be a single character)
39067 are replaced with periods ("."), and all periods and slashes that are not
39068 <sep> and are not in the <specials> string are BASE64 encoded.
39069
39070 The third argument can be omitted, defaulting to an empty string.
39071 The second argument can be omitted, defaulting to "/".
39072
39073 This is the encoding used by Courier for Maildir names on disk, and followed
39074 by many other IMAP servers.
39075
39076 Examples:
39077 .display
39078 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
39079 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
39080 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
39081 .endd
39082
39083 Note that the source charset setting is vital, and also that characters
39084 must be representable in UTF-16.
39085
39086
39087 . ////////////////////////////////////////////////////////////////////////////
39088 . ////////////////////////////////////////////////////////////////////////////
39089
39090 .chapter "Events" "CHAPevents" &&&
39091          "Events"
39092 .cindex events
39093
39094 The events mechanism in Exim can be used to intercept processing at a number
39095 of points.  It was originally invented to give a way to do customised logging
39096 actions (for example, to a database) but can also be used to modify some
39097 processing actions.
39098
39099 Most installations will never need to use Events.
39100 The support can be left out of a build by defining DISABLE_EVENT=yes
39101 in &_Local/Makefile_&.
39102
39103 There are two major classes of events: main and transport.
39104 The main configuration option &%event_action%& controls reception events;
39105 a transport option &%event_action%& controls delivery events.
39106
39107 Both options are a string which is expanded when the event fires.
39108 An example might look like:
39109 .cindex logging custom
39110 .code
39111 event_action = ${if eq {msg:delivery}{$event_name} \
39112 {${lookup pgsql {SELECT * FROM record_Delivery( \
39113     '${quote_pgsql:$sender_address_domain}',\
39114     '${quote_pgsql:${lc:$sender_address_local_part}}', \
39115     '${quote_pgsql:$domain}', \
39116     '${quote_pgsql:${lc:$local_part}}', \
39117     '${quote_pgsql:$host_address}', \
39118     '${quote_pgsql:${lc:$host}}', \
39119     '${quote_pgsql:$message_exim_id}')}} \
39120 } {}}
39121 .endd
39122
39123 Events have names which correspond to the point in process at which they fire.
39124 The name is placed in the variable &$event_name$& and the event action
39125 expansion must check this, as it will be called for every possible event type.
39126
39127 The current list of events is:
39128 .display
39129 &`msg:complete           after    main       `& per message
39130 &`msg:delivery           after    transport  `& per recipient
39131 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
39132 &`msg:rcpt:defer         after    transport  `& per recipient
39133 &`msg:host:defer         after    transport  `& per attempt
39134 &`msg:fail:delivery      after    transport  `& per recipient
39135 &`msg:fail:internal      after    main       `& per recipient
39136 &`tcp:connect            before   transport  `& per connection
39137 &`tcp:close              after    transport  `& per connection
39138 &`tls:cert               before   both       `& per certificate in verification chain
39139 &`smtp:connect           after    transport  `& per connection
39140 .endd
39141 New event types may be added in future.
39142
39143 The event name is a colon-separated list, defining the type of
39144 event in a tree of possibilities.  It may be used as a list
39145 or just matched on as a whole.  There will be no spaces in the name.
39146
39147 The second column in the table above describes whether the event fires
39148 before or after the action is associates with.  Those which fire before
39149 can be used to affect that action (more on this below).
39150
39151 .new
39152 The third column in the table above says what section of the configumration
39153 should define the event action.
39154 .wen
39155
39156 An additional variable, &$event_data$&, is filled with information varying
39157 with the event type:
39158 .display
39159 &`msg:delivery         `& smtp confirmation message
39160 &`msg:rcpt:host:defer  `& error string
39161 &`msg:rcpt:defer       `& error string
39162 &`msg:host:defer       `& error string
39163 &`tls:cert             `& verification chain depth
39164 &`smtp:connect         `& smtp banner
39165 .endd
39166
39167 The :defer events populate one extra variable: &$event_defer_errno$&.
39168
39169 For complex operations an ACL expansion can be used in &%event_action%&
39170 however due to the multiple contexts that Exim operates in during
39171 the course of its processing:
39172 .ilist
39173 variables set in transport events will not be visible outside that
39174 transport call
39175 .next
39176 acl_m variables in a server context are lost on a new connection,
39177 and after smtp helo/ehlo/mail/starttls/rset commands
39178 .endlist
39179 Using an ACL expansion with the logwrite modifier can be
39180 a useful way of writing to the main log.
39181
39182 The expansion of the event_action option should normally
39183 return an empty string.  Should it return anything else the
39184 following will be forced:
39185 .display
39186 &`msg:delivery     `&  (ignored)
39187 &`msg:host:defer   `&  (ignored)
39188 &`msg:fail:delivery`&  (ignored)
39189 &`tcp:connect      `&  do not connect
39190 &`tcp:close        `&  (ignored)
39191 &`tls:cert         `&  refuse verification
39192 &`smtp:connect     `&  close connection
39193 .endd
39194 No other use is made of the result string.
39195
39196 For a tcp:connect event, if the connection is being made to a proxy
39197 then the address and port variables will be that of the proxy and not
39198 the target system.
39199
39200 For tls:cert events, if GnuTLS is in use this will trigger only per
39201 chain element received on the connection.
39202 For OpenSSL it will trigger for every chain element including those
39203 loaded locally.
39204
39205 . ////////////////////////////////////////////////////////////////////////////
39206 . ////////////////////////////////////////////////////////////////////////////
39207
39208 .chapter "Adding new drivers or lookup types" "CHID13" &&&
39209          "Adding drivers or lookups"
39210 .cindex "adding drivers"
39211 .cindex "new drivers, adding"
39212 .cindex "drivers" "adding new"
39213 The following actions have to be taken in order to add a new router, transport,
39214 authenticator, or lookup type to Exim:
39215
39216 .olist
39217 Choose a name for the driver or lookup type that does not conflict with any
39218 existing name; I will use &"newdriver"& in what follows.
39219 .next
39220 Add to &_src/EDITME_& the line:
39221 .display
39222 <&'type'&>&`_NEWDRIVER=yes`&
39223 .endd
39224 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
39225 code is not to be included in the binary by default, comment this line out. You
39226 should also add any relevant comments about the driver or lookup type.
39227 .next
39228 Add to &_src/config.h.defaults_& the line:
39229 .code
39230 #define <type>_NEWDRIVER
39231 .endd
39232 .next
39233 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
39234 and create a table entry as is done for all the other drivers and lookup types.
39235 .next
39236 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
39237 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
39238 Add your &`NEWDRIVER`& to that list.
39239 As long as the dynamic module would be named &_newdriver.so_&, you can use the
39240 simple form that most lookups have.
39241 .next
39242 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
39243 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
39244 driver or lookup type and add it to the definition of OBJ.
39245 .next
39246 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
39247 &_src_&.
39248 .next
39249 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
39250 as for other drivers and lookups.
39251 .endlist
39252
39253 Then all you need to do is write the code! A good way to start is to make a
39254 proforma by copying an existing module of the same type, globally changing all
39255 occurrences of the name, and cutting out most of the code. Note that any
39256 options you create must be listed in alphabetical order, because the tables are
39257 searched using a binary chop procedure.
39258
39259 There is a &_README_& file in each of the sub-directories of &_src_& describing
39260 the interface that is expected.
39261
39262
39263
39264
39265 . ////////////////////////////////////////////////////////////////////////////
39266 . ////////////////////////////////////////////////////////////////////////////
39267
39268 . /////////////////////////////////////////////////////////////////////////////
39269 . These lines are processing instructions for the Simple DocBook Processor that
39270 . Philip Hazel has developed as a less cumbersome way of making PostScript and
39271 . PDFs than using xmlto and fop. They will be ignored by all other XML
39272 . processors.
39273 . /////////////////////////////////////////////////////////////////////////////
39274
39275 .literal xml
39276 <?sdop
39277   format="newpage"
39278   foot_right_recto="&chaptertitle;"
39279   foot_right_verso="&chaptertitle;"
39280 ?>
39281 .literal off
39282
39283 .makeindex "Options index"   "option"
39284 .makeindex "Variables index" "variable"
39285 .makeindex "Concept index"   "concept"
39286
39287
39288 . /////////////////////////////////////////////////////////////////////////////
39289 . /////////////////////////////////////////////////////////////////////////////