aab8c00d5ba8968d5072669ed23516a195d0c7f5
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printing and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generate the outermost <book> element that wraps then entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.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
1671
1672 .section "PCRE library" "SECTpcre"
1673 .cindex "PCRE library"
1674 Exim no longer has an embedded PCRE library as the vast majority of
1675 modern systems include PCRE as a system library, although you may need
1676 to install the PCRE or PCRE development package for your operating
1677 system. If your system has a normal PCRE installation the Exim build
1678 process will need no further configuration. If the library or the
1679 headers are in an unusual location you will need to either set the PCRE_LIBS
1680 and INCLUDE directives appropriately,
1681 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1682 If your operating system has no
1683 PCRE support then you will need to obtain and build the current PCRE
1684 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1685 More information on PCRE is available at &url(http://www.pcre.org/).
1686
1687 .section "DBM libraries" "SECTdb"
1688 .cindex "DBM libraries" "discussion of"
1689 .cindex "hints database" "DBM files used for"
1690 Even if you do not use any DBM files in your configuration, Exim still needs a
1691 DBM library in order to operate, because it uses indexed files for its hints
1692 databases. Unfortunately, there are a number of DBM libraries in existence, and
1693 different operating systems often have different ones installed.
1694
1695 .cindex "Solaris" "DBM library for"
1696 .cindex "IRIX, DBM library for"
1697 .cindex "BSD, DBM library for"
1698 .cindex "Linux, DBM library for"
1699 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1700 Linux distribution, the DBM configuration should happen automatically, and you
1701 may be able to ignore this section. Otherwise, you may have to learn more than
1702 you would like about DBM libraries from what follows.
1703
1704 .cindex "&'ndbm'& DBM library"
1705 Licensed versions of Unix normally contain a library of DBM functions operating
1706 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1707 versions of Unix seem to vary in what they contain as standard. In particular,
1708 some early versions of Linux have no default DBM library, and different
1709 distributors have chosen to bundle different libraries with their packaged
1710 versions. However, the more recent releases seem to have standardized on the
1711 Berkeley DB library.
1712
1713 Different DBM libraries have different conventions for naming the files they
1714 use. When a program opens a file called &_dbmfile_&, there are several
1715 possibilities:
1716
1717 .olist
1718 A traditional &'ndbm'& implementation, such as that supplied as part of
1719 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1720 .next
1721 .cindex "&'gdbm'& DBM library"
1722 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1723 compatibility interface it makes two different hard links to it with names
1724 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1725 file name is used unmodified.
1726 .next
1727 .cindex "Berkeley DB library"
1728 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1729 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1730 programmer exactly the same as the traditional &'ndbm'& implementation.
1731 .next
1732 If the Berkeley package is used in its native mode, it operates on a single
1733 file called &_dbmfile_&; the programmer's interface is somewhat different to
1734 the traditional &'ndbm'& interface.
1735 .next
1736 To complicate things further, there are several very different versions of the
1737 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1738 2.&'x'& and 3.&'x'& were current for a while, but the latest versions are now
1739 numbered 4.&'x'&. Maintenance of some of the earlier releases has ceased. All
1740 versions of Berkeley DB can be obtained from
1741 &url(http://www.sleepycat.com/).
1742 .next
1743 .cindex "&'tdb'& DBM library"
1744 Yet another DBM library, called &'tdb'&, is available from
1745 &url(http://download.sourceforge.net/tdb). It has its own interface, and also
1746 operates on a single file.
1747 .endlist
1748
1749 .cindex "USE_DB"
1750 .cindex "DBM libraries" "configuration for building"
1751 Exim and its utilities can be compiled to use any of these interfaces. In order
1752 to use any version of the Berkeley DB package in native mode, you must set
1753 USE_DB in an appropriate configuration file (typically
1754 &_Local/Makefile_&). For example:
1755 .code
1756 USE_DB=yes
1757 .endd
1758 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1759 error is diagnosed if you set more than one of these.
1760
1761 At the lowest level, the build-time configuration sets none of these options,
1762 thereby assuming an interface of type (1). However, some operating system
1763 configuration files (for example, those for the BSD operating systems and
1764 Linux) assume type (4) by setting USE_DB as their default, and the
1765 configuration files for Cygwin set USE_GDBM. Anything you set in
1766 &_Local/Makefile_&, however, overrides these system defaults.
1767
1768 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1769 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1770 in one of these lines:
1771 .code
1772 DBMLIB = -ldb
1773 DBMLIB = -ltdb
1774 .endd
1775 Settings like that will work if the DBM library is installed in the standard
1776 place. Sometimes it is not, and the library's header file may also not be in
1777 the default path. You may need to set INCLUDE to specify where the header
1778 file is, and to specify the path to the library more fully in DBMLIB, as in
1779 this example:
1780 .code
1781 INCLUDE=-I/usr/local/include/db-4.1
1782 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1783 .endd
1784 There is further detailed discussion about the various DBM libraries in the
1785 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1786
1787
1788
1789 .section "Pre-building configuration" "SECID25"
1790 .cindex "building Exim" "pre-building configuration"
1791 .cindex "configuration for building Exim"
1792 .cindex "&_Local/Makefile_&"
1793 .cindex "&_src/EDITME_&"
1794 Before building Exim, a local configuration file that specifies options
1795 independent of any operating system has to be created with the name
1796 &_Local/Makefile_&. A template for this file is supplied as the file
1797 &_src/EDITME_&, and it contains full descriptions of all the option settings
1798 therein. These descriptions are therefore not repeated here. If you are
1799 building Exim for the first time, the simplest thing to do is to copy
1800 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1801
1802 There are three settings that you must supply, because Exim will not build
1803 without them. They are the location of the run time configuration file
1804 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1805 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1806 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1807 a colon-separated list of file names; Exim uses the first of them that exists.
1808
1809 There are a few other parameters that can be specified either at build time or
1810 at run time, to enable the same binary to be used on a number of different
1811 machines. However, if the locations of Exim's spool directory and log file
1812 directory (if not within the spool directory) are fixed, it is recommended that
1813 you specify them in &_Local/Makefile_& instead of at run time, so that errors
1814 detected early in Exim's execution (such as a malformed configuration file) can
1815 be logged.
1816
1817 .cindex "content scanning" "specifying at build time"
1818 Exim's interfaces for calling virus and spam scanning software directly from
1819 access control lists are not compiled by default. If you want to include these
1820 facilities, you need to set
1821 .code
1822 WITH_CONTENT_SCAN=yes
1823 .endd
1824 in your &_Local/Makefile_&. For details of the facilities themselves, see
1825 chapter &<<CHAPexiscan>>&.
1826
1827
1828 .cindex "&_Local/eximon.conf_&"
1829 .cindex "&_exim_monitor/EDITME_&"
1830 If you are going to build the Exim monitor, a similar configuration process is
1831 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1832 your installation and saved under the name &_Local/eximon.conf_&. If you are
1833 happy with the default settings described in &_exim_monitor/EDITME_&,
1834 &_Local/eximon.conf_& can be empty, but it must exist.
1835
1836 This is all the configuration that is needed in straightforward cases for known
1837 operating systems. However, the building process is set up so that it is easy
1838 to override options that are set by default or by operating-system-specific
1839 configuration files, for example to change the name of the C compiler, which
1840 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1841 do this.
1842
1843
1844
1845 .section "Support for iconv()" "SECID26"
1846 .cindex "&[iconv()]& support"
1847 .cindex "RFC 2047"
1848 The contents of header lines in messages may be encoded according to the rules
1849 described RFC 2047. This makes it possible to transmit characters that are not
1850 in the ASCII character set, and to label them as being in a particular
1851 character set. When Exim is inspecting header lines by means of the &%$h_%&
1852 mechanism, it decodes them, and translates them into a specified character set
1853 (default is set at build time). The translation is possible only if the operating system
1854 supports the &[iconv()]& function.
1855
1856 However, some of the operating systems that supply &[iconv()]& do not support
1857 very many conversions. The GNU &%libiconv%& library (available from
1858 &url(http://www.gnu.org/software/libiconv/)) can be installed on such
1859 systems to remedy this deficiency, as well as on systems that do not supply
1860 &[iconv()]& at all. After installing &%libiconv%&, you should add
1861 .code
1862 HAVE_ICONV=yes
1863 .endd
1864 to your &_Local/Makefile_& and rebuild Exim.
1865
1866
1867
1868 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1869 .cindex "TLS" "including support for TLS"
1870 .cindex "encryption" "including support for"
1871 .cindex "SUPPORT_TLS"
1872 .cindex "OpenSSL" "building Exim with"
1873 .cindex "GnuTLS" "building Exim with"
1874 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1875 command as per RFC 2487. It can also support legacy clients that expect to
1876 start a TLS session immediately on connection to a non-standard port (see the
1877 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1878 line option).
1879
1880 If you want to build Exim with TLS support, you must first install either the
1881 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1882 implementing SSL.
1883
1884 If OpenSSL is installed, you should set
1885 .code
1886 SUPPORT_TLS=yes
1887 TLS_LIBS=-lssl -lcrypto
1888 .endd
1889 in &_Local/Makefile_&. You may also need to specify the locations of the
1890 OpenSSL library and include files. For example:
1891 .code
1892 SUPPORT_TLS=yes
1893 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1894 TLS_INCLUDE=-I/usr/local/openssl/include/
1895 .endd
1896 .cindex "pkg-config" "OpenSSL"
1897 If you have &'pkg-config'& available, then instead you can just use:
1898 .code
1899 SUPPORT_TLS=yes
1900 USE_OPENSSL_PC=openssl
1901 .endd
1902 .cindex "USE_GNUTLS"
1903 If GnuTLS is installed, you should set
1904 .code
1905 SUPPORT_TLS=yes
1906 USE_GNUTLS=yes
1907 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1908 .endd
1909 in &_Local/Makefile_&, and again you may need to specify the locations of the
1910 library and include files. For example:
1911 .code
1912 SUPPORT_TLS=yes
1913 USE_GNUTLS=yes
1914 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1915 TLS_INCLUDE=-I/usr/gnu/include
1916 .endd
1917 .cindex "pkg-config" "GnuTLS"
1918 If you have &'pkg-config'& available, then instead you can just use:
1919 .code
1920 SUPPORT_TLS=yes
1921 USE_GNUTLS=yes
1922 USE_GNUTLS_PC=gnutls
1923 .endd
1924
1925 You do not need to set TLS_INCLUDE if the relevant directory is already
1926 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1927 given in chapter &<<CHAPTLS>>&.
1928
1929
1930
1931
1932 .section "Use of tcpwrappers" "SECID27"
1933
1934 .cindex "tcpwrappers, building Exim to support"
1935 .cindex "USE_TCP_WRAPPERS"
1936 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1937 .cindex "tcp_wrappers_daemon_name"
1938 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1939 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1940 alternative to Exim's own checking facilities for installations that are
1941 already making use of &'tcpwrappers'& for other purposes. To do this, you
1942 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1943 &_tcpd.h_& to be available at compile time, and also ensure that the library
1944 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1945 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1946 you might have
1947 .code
1948 USE_TCP_WRAPPERS=yes
1949 CFLAGS=-O -I/usr/local/include
1950 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1951 .endd
1952 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1953 files is &"exim"&. For example, the line
1954 .code
1955 exim : LOCAL  192.168.1.  .friendly.domain.example
1956 .endd
1957 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1958 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1959 All other connections are denied. The daemon name used by &'tcpwrappers'&
1960 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1961 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1962 configure file. Consult the &'tcpwrappers'& documentation for
1963 further details.
1964
1965
1966 .section "Including support for IPv6" "SECID28"
1967 .cindex "IPv6" "including support for"
1968 Exim contains code for use on systems that have IPv6 support. Setting
1969 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1970 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1971 where the IPv6 support is not fully integrated into the normal include and
1972 library files.
1973
1974 Two different types of DNS record for handling IPv6 addresses have been
1975 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1976 currently seen as the mainstream. Another record type called A6 was proposed
1977 as better than AAAA because it had more flexibility. However, it was felt to be
1978 over-complex, and its status was reduced to &"experimental"&.
1979 Exim used to
1980 have a compile option for including A6 record support but this has now been
1981 withdrawn.
1982
1983
1984
1985 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
1986 .cindex "lookup modules"
1987 .cindex "dynamic modules"
1988 .cindex ".so building"
1989 On some platforms, Exim supports not compiling all lookup types directly into
1990 the main binary, instead putting some into external modules which can be loaded
1991 on demand.
1992 This permits packagers to build Exim with support for lookups with extensive
1993 library dependencies without requiring all users to install all of those
1994 dependencies.
1995 Most, but not all, lookup types can be built this way.
1996
1997 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
1998 installed; Exim will only load modules from that directory, as a security
1999 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2000 for your OS; see &_OS/Makefile-Linux_& for an example.
2001 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2002 see &_src/EDITME_& for details.
2003
2004 Then, for each module to be loaded dynamically, define the relevant
2005 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2006 For example, this will build in lsearch but load sqlite and mysql support
2007 on demand:
2008 .code
2009 LOOKUP_LSEARCH=yes
2010 LOOKUP_SQLITE=2
2011 LOOKUP_MYSQL=2
2012 .endd
2013
2014
2015 .section "The building process" "SECID29"
2016 .cindex "build directory"
2017 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2018 created, run &'make'& at the top level. It determines the architecture and
2019 operating system types, and creates a build directory if one does not exist.
2020 For example, on a Sun system running Solaris 8, the directory
2021 &_build-SunOS5-5.8-sparc_& is created.
2022 .cindex "symbolic link" "to source files"
2023 Symbolic links to relevant source files are installed in the build directory.
2024
2025 If this is the first time &'make'& has been run, it calls a script that builds
2026 a make file inside the build directory, using the configuration files from the
2027 &_Local_& directory. The new make file is then passed to another instance of
2028 &'make'&. This does the real work, building a number of utility scripts, and
2029 then compiling and linking the binaries for the Exim monitor (if configured), a
2030 number of utility programs, and finally Exim itself. The command &`make
2031 makefile`& can be used to force a rebuild of the make file in the build
2032 directory, should this ever be necessary.
2033
2034 If you have problems building Exim, check for any comments there may be in the
2035 &_README_& file concerning your operating system, and also take a look at the
2036 FAQ, where some common problems are covered.
2037
2038
2039
2040 .section 'Output from &"make"&' "SECID283"
2041 The output produced by the &'make'& process for compile lines is often very
2042 unreadable, because these lines can be very long. For this reason, the normal
2043 output is suppressed by default, and instead output similar to that which
2044 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2045 each module that is being compiled or linked. However, it is still possible to
2046 get the full output, by calling &'make'& like this:
2047 .code
2048 FULLECHO='' make -e
2049 .endd
2050 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2051 command reflection in &'make'&. When you ask for the full output, it is
2052 given in addition to the short output.
2053
2054
2055
2056 .section "Overriding build-time options for Exim" "SECToverride"
2057 .cindex "build-time options, overriding"
2058 The main make file that is created at the beginning of the building process
2059 consists of the concatenation of a number of files which set configuration
2060 values, followed by a fixed set of &'make'& instructions. If a value is set
2061 more than once, the last setting overrides any previous ones. This provides a
2062 convenient way of overriding defaults. The files that are concatenated are, in
2063 order:
2064 .display
2065 &_OS/Makefile-Default_&
2066 &_OS/Makefile-_&<&'ostype'&>
2067 &_Local/Makefile_&
2068 &_Local/Makefile-_&<&'ostype'&>
2069 &_Local/Makefile-_&<&'archtype'&>
2070 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2071 &_OS/Makefile-Base_&
2072 .endd
2073 .cindex "&_Local/Makefile_&"
2074 .cindex "building Exim" "operating system type"
2075 .cindex "building Exim" "architecture type"
2076 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2077 architecture type. &_Local/Makefile_& is required to exist, and the building
2078 process fails if it is absent. The other three &_Local_& files are optional,
2079 and are often not needed.
2080
2081 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2082 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2083 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2084 values are used, thereby providing a means of forcing particular settings.
2085 Otherwise, the scripts try to get values from the &%uname%& command. If this
2086 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2087 of &'ad hoc'& transformations are then applied, to produce the standard names
2088 that Exim expects. You can run these scripts directly from the shell in order
2089 to find out what values are being used on your system.
2090
2091
2092 &_OS/Makefile-Default_& contains comments about the variables that are set
2093 therein. Some (but not all) are mentioned below. If there is something that
2094 needs changing, review the contents of this file and the contents of the make
2095 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2096 default values are.
2097
2098
2099 .cindex "building Exim" "overriding default settings"
2100 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2101 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2102 need to change the original files. Instead, you should make the changes by
2103 putting the new values in an appropriate &_Local_& file. For example,
2104 .cindex "Tru64-Unix build-time settings"
2105 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2106 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2107 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2108 called with the option &%-std1%&, to make it recognize some of the features of
2109 Standard C that Exim uses. (Most other compilers recognize Standard C by
2110 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2111 containing the lines
2112 .code
2113 CC=cc
2114 CFLAGS=-std1
2115 .endd
2116 If you are compiling for just one operating system, it may be easier to put
2117 these lines directly into &_Local/Makefile_&.
2118
2119 Keeping all your local configuration settings separate from the distributed
2120 files makes it easy to transfer them to new versions of Exim simply by copying
2121 the contents of the &_Local_& directory.
2122
2123
2124 .cindex "NIS lookup type" "including support for"
2125 .cindex "NIS+ lookup type" "including support for"
2126 .cindex "LDAP" "including support for"
2127 .cindex "lookup" "inclusion in binary"
2128 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2129 lookup, but not all systems have these components installed, so the default is
2130 not to include the relevant code in the binary. All the different kinds of file
2131 and database lookup that Exim supports are implemented as separate code modules
2132 which are included only if the relevant compile-time options are set. In the
2133 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2134 .code
2135 LOOKUP_LDAP=yes
2136 LOOKUP_NIS=yes
2137 LOOKUP_NISPLUS=yes
2138 .endd
2139 and similar settings apply to the other lookup types. They are all listed in
2140 &_src/EDITME_&. In many cases the relevant include files and interface
2141 libraries need to be installed before compiling Exim.
2142 .cindex "cdb" "including support for"
2143 However, there are some optional lookup types (such as cdb) for which
2144 the code is entirely contained within Exim, and no external include
2145 files or libraries are required. When a lookup type is not included in the
2146 binary, attempts to configure Exim to use it cause run time configuration
2147 errors.
2148
2149 .cindex "pkg-config" "lookups"
2150 .cindex "pkg-config" "authenticators"
2151 Many systems now use a tool called &'pkg-config'& to encapsulate information
2152 about how to compile against a library; Exim has some initial support for
2153 being able to use pkg-config for lookups and authenticators.  For any given
2154 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2155 variable with the &`_PC`& suffix in the name and assign as the value the
2156 name of the package to be queried.  The results of querying via the
2157 &'pkg-config'& command will be added to the appropriate Makefile variables
2158 with &`+=`& directives, so your version of &'make'& will need to support that
2159 syntax.  For instance:
2160 .code
2161 LOOKUP_SQLITE=yes
2162 LOOKUP_SQLITE_PC=sqlite3
2163 AUTH_GSASL=yes
2164 AUTH_GSASL_PC=libgsasl
2165 AUTH_HEIMDAL_GSSAPI=yes
2166 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2167 .endd
2168
2169 .cindex "Perl" "including support for"
2170 Exim can be linked with an embedded Perl interpreter, allowing Perl
2171 subroutines to be called during string expansion. To enable this facility,
2172 .code
2173 EXIM_PERL=perl.o
2174 .endd
2175 must be defined in &_Local/Makefile_&. Details of this facility are given in
2176 chapter &<<CHAPperl>>&.
2177
2178 .cindex "X11 libraries, location of"
2179 The location of the X11 libraries is something that varies a lot between
2180 operating systems, and there may be different versions of X11 to cope
2181 with. Exim itself makes no use of X11, but if you are compiling the Exim
2182 monitor, the X11 libraries must be available.
2183 The following three variables are set in &_OS/Makefile-Default_&:
2184 .code
2185 X11=/usr/X11R6
2186 XINCLUDE=-I$(X11)/include
2187 XLFLAGS=-L$(X11)/lib
2188 .endd
2189 These are overridden in some of the operating-system configuration files. For
2190 example, in &_OS/Makefile-SunOS5_& there is
2191 .code
2192 X11=/usr/openwin
2193 XINCLUDE=-I$(X11)/include
2194 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2195 .endd
2196 If you need to override the default setting for your operating system, place a
2197 definition of all three of these variables into your
2198 &_Local/Makefile-<ostype>_& file.
2199
2200 .cindex "EXTRALIBS"
2201 If you need to add any extra libraries to the link steps, these can be put in a
2202 variable called EXTRALIBS, which appears in all the link commands, but by
2203 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2204 command for linking the main Exim binary, and not for any associated utilities.
2205
2206 .cindex "DBM libraries" "configuration for building"
2207 There is also DBMLIB, which appears in the link commands for binaries that
2208 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2209 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2210 binary, and which can be used, for example, to include additional X11
2211 libraries.
2212
2213 .cindex "configuration file" "editing"
2214 The make file copes with rebuilding Exim correctly if any of the configuration
2215 files are edited. However, if an optional configuration file is deleted, it is
2216 necessary to touch the associated non-optional file (that is,
2217 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2218
2219
2220 .section "OS-specific header files" "SECID30"
2221 .cindex "&_os.h_&"
2222 .cindex "building Exim" "OS-specific C header files"
2223 The &_OS_& directory contains a number of files with names of the form
2224 &_os.h-<ostype>_&. These are system-specific C header files that should not
2225 normally need to be changed. There is a list of macro settings that are
2226 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2227 are porting Exim to a new operating system.
2228
2229
2230
2231 .section "Overriding build-time options for the monitor" "SECID31"
2232 .cindex "building Eximon"
2233 A similar process is used for overriding things when building the Exim monitor,
2234 where the files that are involved are
2235 .display
2236 &_OS/eximon.conf-Default_&
2237 &_OS/eximon.conf-_&<&'ostype'&>
2238 &_Local/eximon.conf_&
2239 &_Local/eximon.conf-_&<&'ostype'&>
2240 &_Local/eximon.conf-_&<&'archtype'&>
2241 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2242 .endd
2243 .cindex "&_Local/eximon.conf_&"
2244 As with Exim itself, the final three files need not exist, and in this case the
2245 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2246 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2247 variables of the same name, preceded by EXIMON_. For example, setting
2248 EXIMON_LOG_DEPTH in the environment overrides the value of
2249 LOG_DEPTH at run time.
2250 .ecindex IIDbuex
2251
2252
2253 .section "Installing Exim binaries and scripts" "SECID32"
2254 .cindex "installing Exim"
2255 .cindex "BIN_DIRECTORY"
2256 The command &`make install`& runs the &(exim_install)& script with no
2257 arguments. The script copies binaries and utility scripts into the directory
2258 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2259 .cindex "setuid" "installing Exim with"
2260 The install script copies files only if they are newer than the files they are
2261 going to replace. The Exim binary is required to be owned by root and have the
2262 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2263 install`& as root so that it can set up the Exim binary in this way. However, in
2264 some special situations (for example, if a host is doing no local deliveries)
2265 it may be possible to run Exim without making the binary setuid root (see
2266 chapter &<<CHAPsecurity>>& for details).
2267
2268 .cindex "CONFIGURE_FILE"
2269 Exim's run time configuration file is named by the CONFIGURE_FILE setting
2270 in &_Local/Makefile_&. If this names a single file, and the file does not
2271 exist, the default configuration file &_src/configure.default_& is copied there
2272 by the installation script. If a run time configuration file already exists, it
2273 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2274 alternative files, no default is installed.
2275
2276 .cindex "system aliases file"
2277 .cindex "&_/etc/aliases_&"
2278 One change is made to the default configuration file when it is installed: the
2279 default configuration contains a router that references a system aliases file.
2280 The path to this file is set to the value specified by
2281 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2282 If the system aliases file does not exist, the installation script creates it,
2283 and outputs a comment to the user.
2284
2285 The created file contains no aliases, but it does contain comments about the
2286 aliases a site should normally have. Mail aliases have traditionally been
2287 kept in &_/etc/aliases_&. However, some operating systems are now using
2288 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2289 Exim's configuration if necessary.
2290
2291 The default configuration uses the local host's name as the only local domain,
2292 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2293 running as the local user. System aliases and &_.forward_& files in users' home
2294 directories are supported, but no NIS or NIS+ support is configured. Domains
2295 other than the name of the local host are routed using the DNS, with delivery
2296 over SMTP.
2297
2298 It is possible to install Exim for special purposes (such as building a binary
2299 distribution) in a private part of the file system. You can do this by a
2300 command such as
2301 .code
2302 make DESTDIR=/some/directory/ install
2303 .endd
2304 This has the effect of pre-pending the specified directory to all the file
2305 paths, except the name of the system aliases file that appears in the default
2306 configuration. (If a default alias file is created, its name &'is'& modified.)
2307 For backwards compatibility, ROOT is used if DESTDIR is not set,
2308 but this usage is deprecated.
2309
2310 .cindex "installing Exim" "what is not installed"
2311 Running &'make install'& does not copy the Exim 4 conversion script
2312 &'convert4r4'&. You will probably run this only once if you are
2313 upgrading from Exim 3. None of the documentation files in the &_doc_&
2314 directory are copied, except for the info files when you have set
2315 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2316
2317 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2318 to their names. The Exim binary itself, however, is handled differently. It is
2319 installed under a name that includes the version number and the compile number,
2320 for example &_exim-&version()-1_&. The script then arranges for a symbolic link
2321 called &_exim_& to point to the binary. If you are updating a previous version
2322 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2323 from the directory (as seen by other processes).
2324
2325 .cindex "installing Exim" "testing the script"
2326 If you want to see what the &'make install'& will do before running it for
2327 real, you can pass the &%-n%& option to the installation script by this
2328 command:
2329 .code
2330 make INSTALL_ARG=-n install
2331 .endd
2332 The contents of the variable INSTALL_ARG are passed to the installation
2333 script. You do not need to be root to run this test. Alternatively, you can run
2334 the installation script directly, but this must be from within the build
2335 directory. For example, from the top-level Exim directory you could use this
2336 command:
2337 .code
2338 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2339 .endd
2340 .cindex "installing Exim" "install script options"
2341 There are two other options that can be supplied to the installation script.
2342
2343 .ilist
2344 &%-no_chown%& bypasses the call to change the owner of the installed binary
2345 to root, and the call to make it a setuid binary.
2346 .next
2347 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2348 installed binary.
2349 .endlist
2350
2351 INSTALL_ARG can be used to pass these options to the script. For example:
2352 .code
2353 make INSTALL_ARG=-no_symlink install
2354 .endd
2355 The installation script can also be given arguments specifying which files are
2356 to be copied. For example, to install just the Exim binary, and nothing else,
2357 without creating the symbolic link, you could use:
2358 .code
2359 make INSTALL_ARG='-no_symlink exim' install
2360 .endd
2361
2362
2363
2364 .section "Installing info documentation" "SECTinsinfdoc"
2365 .cindex "installing Exim" "&'info'& documentation"
2366 Not all systems use the GNU &'info'& system for documentation, and for this
2367 reason, the Texinfo source of Exim's documentation is not included in the main
2368 distribution. Instead it is available separately from the ftp site (see section
2369 &<<SECTavail>>&).
2370
2371 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2372 source of the documentation is found in the source tree, running &`make
2373 install`& automatically builds the info files and installs them.
2374
2375
2376
2377 .section "Setting up the spool directory" "SECID33"
2378 .cindex "spool directory" "creating"
2379 When it starts up, Exim tries to create its spool directory if it does not
2380 exist. The Exim uid and gid are used for the owner and group of the spool
2381 directory. Sub-directories are automatically created in the spool directory as
2382 necessary.
2383
2384
2385
2386
2387 .section "Testing" "SECID34"
2388 .cindex "testing" "installation"
2389 Having installed Exim, you can check that the run time configuration file is
2390 syntactically valid by running the following command, which assumes that the
2391 Exim binary directory is within your PATH environment variable:
2392 .code
2393 exim -bV
2394 .endd
2395 If there are any errors in the configuration file, Exim outputs error messages.
2396 Otherwise it outputs the version number and build date,
2397 the DBM library that is being used, and information about which drivers and
2398 other optional code modules are included in the binary.
2399 Some simple routing tests can be done by using the address testing option. For
2400 example,
2401 .display
2402 &`exim -bt`& <&'local username'&>
2403 .endd
2404 should verify that it recognizes a local mailbox, and
2405 .display
2406 &`exim -bt`& <&'remote address'&>
2407 .endd
2408 a remote one. Then try getting it to deliver mail, both locally and remotely.
2409 This can be done by passing messages directly to Exim, without going through a
2410 user agent. For example:
2411 .code
2412 exim -v postmaster@your.domain.example
2413 From: user@your.domain.example
2414 To: postmaster@your.domain.example
2415 Subject: Testing Exim
2416
2417 This is a test message.
2418 ^D
2419 .endd
2420 The &%-v%& option causes Exim to output some verification of what it is doing.
2421 In this case you should see copies of three log lines, one for the message's
2422 arrival, one for its delivery, and one containing &"Completed"&.
2423
2424 .cindex "delivery" "problems with"
2425 If you encounter problems, look at Exim's log files (&'mainlog'& and
2426 &'paniclog'&) to see if there is any relevant information there. Another source
2427 of information is running Exim with debugging turned on, by specifying the
2428 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2429 with debugging turned on by a command of the form
2430 .display
2431 &`exim -d -M`& <&'exim-message-id'&>
2432 .endd
2433 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2434 produces rather a lot of output, but you can cut this down to specific areas.
2435 For example, if you use &%-d-all+route%& only the debugging information
2436 relevant to routing is included. (See the &%-d%& option in chapter
2437 &<<CHAPcommandline>>& for more details.)
2438
2439 .cindex '&"sticky"& bit'
2440 .cindex "lock files"
2441 One specific problem that has shown up on some sites is the inability to do
2442 local deliveries into a shared mailbox directory, because it does not have the
2443 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2444 writing to a mailbox file, and if it cannot create the lock file, the delivery
2445 is deferred. You can get round this either by setting the &"sticky bit"& on the
2446 directory, or by setting a specific group for local deliveries and allowing
2447 that group to create files in the directory (see the comments above the
2448 &(local_delivery)& transport in the default configuration file). Another
2449 approach is to configure Exim not to use lock files, but just to rely on
2450 &[fcntl()]& locking instead. However, you should do this only if all user
2451 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2452 see chapter &<<CHAPappendfile>>&.
2453
2454 One thing that cannot be tested on a system that is already running an MTA is
2455 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2456 &%-oX%& option can be used to run an Exim daemon that listens on some other
2457 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2458 &'exim_checkaccess'& utility can be used to check out policy controls on
2459 incoming SMTP mail.
2460
2461 Testing a new version on a system that is already running Exim can most easily
2462 be done by building a binary with a different CONFIGURE_FILE setting. From
2463 within the run time configuration, all other file and directory names
2464 that Exim uses can be altered, in order to keep it entirely clear of the
2465 production version.
2466
2467
2468 .section "Replacing another MTA with Exim" "SECID35"
2469 .cindex "replacing another MTA"
2470 Building and installing Exim for the first time does not of itself put it in
2471 general use. The name by which the system's MTA is called by mail user agents
2472 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2473 operating system), and it is necessary to make this name point to the &'exim'&
2474 binary in order to get the user agents to pass messages to Exim. This is
2475 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2476 or &_/usr/lib/sendmail_&
2477 .cindex "symbolic link" "to &'exim'& binary"
2478 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2479 privilege and executable status from the old MTA. It is then necessary to stop
2480 and restart the mailer daemon, if one is running.
2481
2482 .cindex "FreeBSD, MTA indirection"
2483 .cindex "&_/etc/mail/mailer.conf_&"
2484 Some operating systems have introduced alternative ways of switching MTAs. For
2485 example, if you are running FreeBSD, you need to edit the file
2486 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2487 described. A typical example of the contents of this file for running Exim is
2488 as follows:
2489 .code
2490 sendmail            /usr/exim/bin/exim
2491 send-mail           /usr/exim/bin/exim
2492 mailq               /usr/exim/bin/exim -bp
2493 newaliases          /usr/bin/true
2494 .endd
2495 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2496 your Exim installation is &"live"&. Check it by sending a message from your
2497 favourite user agent.
2498
2499 You should consider what to tell your users about the change of MTA. Exim may
2500 have different capabilities to what was previously running, and there are
2501 various operational differences such as the text of messages produced by
2502 command line options and in bounce messages. If you allow your users to make
2503 use of Exim's filtering capabilities, you should make the document entitled
2504 &'Exim's interface to mail filtering'& available to them.
2505
2506
2507
2508 .section "Upgrading Exim" "SECID36"
2509 .cindex "upgrading Exim"
2510 If you are already running Exim on your host, building and installing a new
2511 version automatically makes it available to MUAs, or any other programs that
2512 call the MTA directly. However, if you are running an Exim daemon, you do need
2513 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2514 new binary. You do not need to stop processing mail in order to install a new
2515 version of Exim. The install script does not modify an existing runtime
2516 configuration file.
2517
2518
2519
2520
2521 .section "Stopping the Exim daemon on Solaris" "SECID37"
2522 .cindex "Solaris" "stopping Exim on"
2523 The standard command for stopping the mailer daemon on Solaris is
2524 .code
2525 /etc/init.d/sendmail stop
2526 .endd
2527 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2528 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2529 for the text &"sendmail"&; this is not present because the actual program name
2530 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2531 solution is to replace the line that finds the process id with something like
2532 .code
2533 pid=`cat /var/spool/exim/exim-daemon.pid`
2534 .endd
2535 to obtain the daemon's pid directly from the file that Exim saves it in.
2536
2537 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2538 still be received from local processes, and if automatic delivery is configured
2539 (the normal case), deliveries will still occur.
2540
2541
2542
2543
2544 . ////////////////////////////////////////////////////////////////////////////
2545 . ////////////////////////////////////////////////////////////////////////////
2546
2547 .chapter "The Exim command line" "CHAPcommandline"
2548 .scindex IIDclo1 "command line" "options"
2549 .scindex IIDclo2 "options" "command line"
2550 Exim's command line takes the standard Unix form of a sequence of options,
2551 each starting with a hyphen character, followed by a number of arguments. The
2552 options are compatible with the main options of Sendmail, and there are also
2553 some additional options, some of which are compatible with Smail 3. Certain
2554 combinations of options do not make sense, and provoke an error if used.
2555 The form of the arguments depends on which options are set.
2556
2557
2558 .section "Setting options by program name" "SECID38"
2559 .cindex "&'mailq'&"
2560 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2561 were present before any other options.
2562 The &%-bp%& option requests a listing of the contents of the mail queue on the
2563 standard output.
2564 This feature is for compatibility with some systems that contain a command of
2565 that name in one of the standard libraries, symbolically linked to
2566 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2567
2568 .cindex "&'rsmtp'&"
2569 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2570 were present before any other options, for compatibility with Smail. The
2571 &%-bS%& option is used for reading in a number of messages in batched SMTP
2572 format.
2573
2574 .cindex "&'rmail'&"
2575 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2576 &%-oee%& options were present before any other options, for compatibility with
2577 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2578
2579 .cindex "&'runq'&"
2580 .cindex "queue runner"
2581 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2582 were present before any other options, for compatibility with Smail. The &%-q%&
2583 option causes a single queue runner process to be started.
2584
2585 .cindex "&'newaliases'&"
2586 .cindex "alias file" "building"
2587 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2588 If Exim is called under the name &'newaliases'& it behaves as if the option
2589 &%-bi%& were present before any other options, for compatibility with Sendmail.
2590 This option is used for rebuilding Sendmail's alias file. Exim does not have
2591 the concept of a single alias file, but can be configured to run a given
2592 command if called with the &%-bi%& option.
2593
2594
2595 .section "Trusted and admin users" "SECTtrustedadmin"
2596 Some Exim options are available only to &'trusted users'& and others are
2597 available only to &'admin users'&. In the description below, the phrases &"Exim
2598 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2599 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2600 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2601
2602 .ilist
2603 .cindex "trusted users" "definition of"
2604 .cindex "user" "trusted definition of"
2605 The trusted users are root, the Exim user, any user listed in the
2606 &%trusted_users%& configuration option, and any user whose current group or any
2607 supplementary group is one of those listed in the &%trusted_groups%&
2608 configuration option. Note that the Exim group is not automatically trusted.
2609
2610 .cindex '&"From"& line'
2611 .cindex "envelope sender"
2612 Trusted users are always permitted to use the &%-f%& option or a leading
2613 &"From&~"& line to specify the envelope sender of a message that is passed to
2614 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2615 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2616 users to set envelope senders.
2617
2618 .cindex "&'From:'& header line"
2619 .cindex "&'Sender:'& header line"
2620 .cindex "header lines" "From:"
2621 .cindex "header lines" "Sender:"
2622 For a trusted user, there is never any check on the contents of the &'From:'&
2623 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2624 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2625
2626 Trusted users may also specify a host name, host address, interface address,
2627 protocol name, ident value, and authentication data when submitting a message
2628 locally. Thus, they are able to insert messages into Exim's queue locally that
2629 have the characteristics of messages received from a remote host. Untrusted
2630 users may in some circumstances use &%-f%&, but can never set the other values
2631 that are available to trusted users.
2632 .next
2633 .cindex "user" "admin definition of"
2634 .cindex "admin user" "definition of"
2635 The admin users are root, the Exim user, and any user that is a member of the
2636 Exim group or of any group listed in the &%admin_groups%& configuration option.
2637 The current group does not have to be one of these groups.
2638
2639 Admin users are permitted to list the queue, and to carry out certain
2640 operations on messages, for example, to force delivery failures. It is also
2641 necessary to be an admin user in order to see the full information provided by
2642 the Exim monitor, and full debugging output.
2643
2644 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2645 Exim to attempt delivery of messages on its queue is restricted to admin users.
2646 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2647 option false (that is, specifying &%no_prod_requires_admin%&).
2648
2649 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2650 is restricted to admin users unless &%queue_list_requires_admin%& is set
2651 false.
2652 .endlist
2653
2654
2655 &*Warning*&: If you configure your system so that admin users are able to
2656 edit Exim's configuration file, you are giving those users an easy way of
2657 getting root. There is further discussion of this issue at the start of chapter
2658 &<<CHAPconf>>&.
2659
2660
2661
2662
2663 .section "Command line options" "SECID39"
2664 Exim's command line options are described in alphabetical order below. If none
2665 of the options that specifies a specific action (such as starting the daemon or
2666 a queue runner, or testing an address, or receiving a message in a specific
2667 format, or listing the queue) are present, and there is at least one argument
2668 on the command line, &%-bm%& (accept a local message on the standard input,
2669 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2670 outputs a brief message about itself and exits.
2671
2672 . ////////////////////////////////////////////////////////////////////////////
2673 . Insert a stylized XML comment here, to identify the start of the command line
2674 . options. This is for the benefit of the Perl script that automatically
2675 . creates a man page for the options.
2676 . ////////////////////////////////////////////////////////////////////////////
2677
2678 .literal xml
2679 <!-- === Start of command line options === -->
2680 .literal off
2681
2682
2683 .vlist
2684 .vitem &%--%&
2685 .oindex "--"
2686 .cindex "options" "command line; terminating"
2687 This is a pseudo-option whose only purpose is to terminate the options and
2688 therefore to cause subsequent command line items to be treated as arguments
2689 rather than options, even if they begin with hyphens.
2690
2691 .vitem &%--help%&
2692 .oindex "&%--help%&"
2693 This option causes Exim to output a few sentences stating what it is.
2694 The same output is generated if the Exim binary is called with no options and
2695 no arguments.
2696
2697 .vitem &%--version%&
2698 .oindex "&%--version%&"
2699 This option is an alias for &%-bV%& and causes version information to be
2700 displayed.
2701
2702 .vitem &%-Ac%& &&&
2703        &%-Am%&
2704 .oindex "&%-Ac%&"
2705 .oindex "&%-Am%&"
2706 These options are used by Sendmail for selecting configuration files and are
2707 ignored by Exim.
2708
2709 .vitem &%-B%&<&'type'&>
2710 .oindex "&%-B%&"
2711 .cindex "8-bit characters"
2712 .cindex "Sendmail compatibility" "8-bit characters"
2713 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2714 clean; it ignores this option.
2715
2716 .vitem &%-bd%&
2717 .oindex "&%-bd%&"
2718 .cindex "daemon"
2719 .cindex "SMTP" "listener"
2720 .cindex "queue runner"
2721 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2722 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2723 that the daemon should also initiate periodic queue runs.
2724
2725 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2726 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2727 disconnect from the controlling terminal. When running this way, it can be
2728 stopped by pressing ctrl-C.
2729
2730 By default, Exim listens for incoming connections to the standard SMTP port on
2731 all the host's running interfaces. However, it is possible to listen on other
2732 ports, on multiple ports, and only on specific interfaces. Chapter
2733 &<<CHAPinterfaces>>& contains a description of the options that control this.
2734
2735 When a listening daemon
2736 .cindex "daemon" "process id (pid)"
2737 .cindex "pid (process id)" "of daemon"
2738 is started without the use of &%-oX%& (that is, without overriding the normal
2739 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2740 in Exim's spool directory. This location can be overridden by setting
2741 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2742 running as root.
2743
2744 When &%-oX%& is used on the command line to start a listening daemon, the
2745 process id is not written to the normal pid file path. However, &%-oP%& can be
2746 used to specify a path on the command line if a pid file is required.
2747
2748 The SIGHUP signal
2749 .cindex "SIGHUP"
2750 .cindex "daemon" "restarting"
2751 can be used to cause the daemon to re-execute itself. This should be done
2752 whenever Exim's configuration file, or any file that is incorporated into it by
2753 means of the &%.include%& facility, is changed, and also whenever a new version
2754 of Exim is installed. It is not necessary to do this when other files that are
2755 referenced from the configuration (for example, alias files) are changed,
2756 because these are reread each time they are used.
2757
2758 .vitem &%-bdf%&
2759 .oindex "&%-bdf%&"
2760 This option has the same effect as &%-bd%& except that it never disconnects
2761 from the controlling terminal, even when no debugging is specified.
2762
2763 .vitem &%-be%&
2764 .oindex "&%-be%&"
2765 .cindex "testing" "string expansion"
2766 .cindex "expansion" "testing"
2767 Run Exim in expansion testing mode. Exim discards its root privilege, to
2768 prevent ordinary users from using this mode to read otherwise inaccessible
2769 files. If no arguments are given, Exim runs interactively, prompting for lines
2770 of data. Otherwise, it processes each argument in turn.
2771
2772 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2773 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2774 used without command line arguments. If successful, it uses the &[readline()]&
2775 function, which provides extensive line-editing facilities, for reading the
2776 test data. A line history is supported.
2777
2778 Long expansion expressions can be split over several lines by using backslash
2779 continuations. As in Exim's run time configuration, white space at the start of
2780 continuation lines is ignored. Each argument or data line is passed through the
2781 string expansion mechanism, and the result is output. Variable values from the
2782 configuration file (for example, &$qualify_domain$&) are available, but no
2783 message-specific values (such as &$message_exim_id$&) are set, because no message
2784 is being processed (but see &%-bem%& and &%-Mset%&).
2785
2786 &*Note*&: If you use this mechanism to test lookups, and you change the data
2787 files or databases you are using, you must exit and restart Exim before trying
2788 the same lookup again. Otherwise, because each Exim process caches the results
2789 of lookups, you will just get the same result as before.
2790
2791 .vitem &%-bem%&&~<&'filename'&>
2792 .oindex "&%-bem%&"
2793 .cindex "testing" "string expansion"
2794 .cindex "expansion" "testing"
2795 This option operates like &%-be%& except that it must be followed by the name
2796 of a file. For example:
2797 .code
2798 exim -bem /tmp/testmessage
2799 .endd
2800 The file is read as a message (as if receiving a locally-submitted non-SMTP
2801 message) before any of the test expansions are done. Thus, message-specific
2802 variables such as &$message_size$& and &$header_from:$& are available. However,
2803 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2804 recipients are read from the headers in the normal way, and are shown in the
2805 &$recipients$& variable. Note that recipients cannot be given on the command
2806 line, because further arguments are taken as strings to expand (just like
2807 &%-be%&).
2808
2809 .vitem &%-bF%&&~<&'filename'&>
2810 .oindex "&%-bF%&"
2811 .cindex "system filter" "testing"
2812 .cindex "testing" "system filter"
2813 This option is the same as &%-bf%& except that it assumes that the filter being
2814 tested is a system filter. The additional commands that are available only in
2815 system filters are recognized.
2816
2817 .vitem &%-bf%&&~<&'filename'&>
2818 .oindex "&%-bf%&"
2819 .cindex "filter" "testing"
2820 .cindex "testing" "filter file"
2821 .cindex "forward file" "testing"
2822 .cindex "testing" "forward file"
2823 .cindex "Sieve filter" "testing"
2824 This option runs Exim in user filter testing mode; the file is the filter file
2825 to be tested, and a test message must be supplied on the standard input. If
2826 there are no message-dependent tests in the filter, an empty file can be
2827 supplied.
2828
2829 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2830 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2831 filter and a user filter in the same run. For example:
2832 .code
2833 exim -bF /system/filter -bf /user/filter </test/message
2834 .endd
2835 This is helpful when the system filter adds header lines or sets filter
2836 variables that are used by the user filter.
2837
2838 If the test filter file does not begin with one of the special lines
2839 .code
2840 # Exim filter
2841 # Sieve filter
2842 .endd
2843 it is taken to be a normal &_.forward_& file, and is tested for validity under
2844 that interpretation. See sections &<<SECTitenonfilred>>& to
2845 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2846 redirection lists.
2847
2848 The result of an Exim command that uses &%-bf%&, provided no errors are
2849 detected, is a list of the actions that Exim would try to take if presented
2850 with the message for real. More details of filter testing are given in the
2851 separate document entitled &'Exim's interfaces to mail filtering'&.
2852
2853 When testing a filter file,
2854 .cindex "&""From""& line"
2855 .cindex "envelope sender"
2856 .oindex "&%-f%&" "for filter testing"
2857 the envelope sender can be set by the &%-f%& option,
2858 or by a &"From&~"& line at the start of the test message. Various parameters
2859 that would normally be taken from the envelope recipient address of the message
2860 can be set by means of additional command line options (see the next four
2861 options).
2862
2863 .vitem &%-bfd%&&~<&'domain'&>
2864 .oindex "&%-bfd%&"
2865 .vindex "&$qualify_domain$&"
2866 This sets the domain of the recipient address when a filter file is being
2867 tested by means of the &%-bf%& option. The default is the value of
2868 &$qualify_domain$&.
2869
2870 .vitem &%-bfl%&&~<&'local&~part'&>
2871 .oindex "&%-bfl%&"
2872 This sets the local part of the recipient address when a filter file is being
2873 tested by means of the &%-bf%& option. The default is the username of the
2874 process that calls Exim. A local part should be specified with any prefix or
2875 suffix stripped, because that is how it appears to the filter when a message is
2876 actually being delivered.
2877
2878 .vitem &%-bfp%&&~<&'prefix'&>
2879 .oindex "&%-bfp%&"
2880 This sets the prefix of the local part of the recipient address when a filter
2881 file is being tested by means of the &%-bf%& option. The default is an empty
2882 prefix.
2883
2884 .vitem &%-bfs%&&~<&'suffix'&>
2885 .oindex "&%-bfs%&"
2886 This sets the suffix of the local part of the recipient address when a filter
2887 file is being tested by means of the &%-bf%& option. The default is an empty
2888 suffix.
2889
2890 .vitem &%-bh%&&~<&'IP&~address'&>
2891 .oindex "&%-bh%&"
2892 .cindex "testing" "incoming SMTP"
2893 .cindex "SMTP" "testing incoming"
2894 .cindex "testing" "relay control"
2895 .cindex "relaying" "testing configuration"
2896 .cindex "policy control" "testing"
2897 .cindex "debugging" "&%-bh%& option"
2898 This option runs a fake SMTP session as if from the given IP address, using the
2899 standard input and output. The IP address may include a port number at the end,
2900 after a full stop. For example:
2901 .code
2902 exim -bh 10.9.8.7.1234
2903 exim -bh fe80::a00:20ff:fe86:a061.5678
2904 .endd
2905 When an IPv6 address is given, it is converted into canonical form. In the case
2906 of the second example above, the value of &$sender_host_address$& after
2907 conversion to the canonical form is
2908 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2909
2910 Comments as to what is going on are written to the standard error file. These
2911 include lines beginning with &"LOG"& for anything that would have been logged.
2912 This facility is provided for testing configuration options for incoming
2913 messages, to make sure they implement the required policy. For example, you can
2914 test your relay controls using &%-bh%&.
2915
2916 &*Warning 1*&:
2917 .cindex "RFC 1413"
2918 You can test features of the configuration that rely on ident (RFC 1413)
2919 information by using the &%-oMt%& option. However, Exim cannot actually perform
2920 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2921 connection.
2922
2923 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2924 are also skipped when testing using &%-bh%&. If you want these callouts to
2925 occur, use &%-bhc%& instead.
2926
2927 Messages supplied during the testing session are discarded, and nothing is
2928 written to any of the real log files. There may be pauses when DNS (and other)
2929 lookups are taking place, and of course these may time out. The &%-oMi%& option
2930 can be used to specify a specific IP interface and port if this is important,
2931 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2932 session were authenticated.
2933
2934 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2935 output just states whether a given recipient address from a given host is
2936 acceptable or not. See section &<<SECTcheckaccess>>&.
2937
2938 Features such as authentication and encryption, where the client input is not
2939 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2940 specialized SMTP test program such as
2941 &url(http://jetmore.org/john/code/#swaks,swaks).
2942
2943 .vitem &%-bhc%&&~<&'IP&~address'&>
2944 .oindex "&%-bhc%&"
2945 This option operates in the same way as &%-bh%&, except that address
2946 verification callouts are performed if required. This includes consulting and
2947 updating the callout cache database.
2948
2949 .vitem &%-bi%&
2950 .oindex "&%-bi%&"
2951 .cindex "alias file" "building"
2952 .cindex "building alias file"
2953 .cindex "Sendmail compatibility" "&%-bi%& option"
2954 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2955 Exim does not have the concept of a single alias file, and so it cannot mimic
2956 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2957 tend to appear in various scripts such as NIS make files, so the option must be
2958 recognized.
2959
2960 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2961 configuration option is run, under the uid and gid of the caller of Exim. If
2962 the &%-oA%& option is used, its value is passed to the command as an argument.
2963 The command set by &%bi_command%& may not contain arguments. The command can
2964 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2965 if this is required. If the &%bi_command%& option is not set, calling Exim with
2966 &%-bi%& is a no-op.
2967
2968 . // Keep :help first, then the rest in alphabetical order
2969 .vitem &%-bI:help%&
2970 .oindex "&%-bI:help%&"
2971 .cindex "querying exim information"
2972 We shall provide various options starting &`-bI:`& for querying Exim for
2973 information.  The output of many of these will be intended for machine
2974 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
2975 synopsis of supported options beginning &`-bI:`&.  Use of any of these
2976 options shall cause Exim to exit after producing the requested output.
2977
2978 .vitem &%-bI:dscp%&
2979 .oindex "&%-bI:dscp%&"
2980 .cindex "DSCP" "values"
2981 This option causes Exim to emit an alphabetically sorted list of all
2982 recognised DSCP names.
2983
2984 .vitem &%-bI:sieve%&
2985 .oindex "&%-bI:sieve%&"
2986 .cindex "Sieve filter" "capabilities"
2987 This option causes Exim to emit an alphabetically sorted list of all supported
2988 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
2989 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
2990 &`SIEVE`& capability response line.  As the precise list may depend upon
2991 compile-time build options, which this option will adapt to, this is the only
2992 way to guarantee a correct response.
2993
2994 .vitem &%-bm%&
2995 .oindex "&%-bm%&"
2996 .cindex "local message reception"
2997 This option runs an Exim receiving process that accepts an incoming,
2998 locally-generated message on the standard input. The recipients are given as the
2999 command arguments (except when &%-t%& is also present &-- see below). Each
3000 argument can be a comma-separated list of RFC 2822 addresses. This is the
3001 default option for selecting the overall action of an Exim call; it is assumed
3002 if no other conflicting option is present.
3003
3004 If any addresses in the message are unqualified (have no domain), they are
3005 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3006 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3007 suppressing this for special cases.
3008
3009 Policy checks on the contents of local messages can be enforced by means of
3010 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3011
3012 .cindex "return code" "for &%-bm%&"
3013 The return code is zero if the message is successfully accepted. Otherwise, the
3014 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3015
3016 The format
3017 .cindex "message" "format"
3018 .cindex "format" "message"
3019 .cindex "&""From""& line"
3020 .cindex "UUCP" "&""From""& line"
3021 .cindex "Sendmail compatibility" "&""From""& line"
3022 of the message must be as defined in RFC 2822, except that, for
3023 compatibility with Sendmail and Smail, a line in one of the forms
3024 .code
3025 From sender Fri Jan  5 12:55 GMT 1997
3026 From sender Fri, 5 Jan 97 12:55:01
3027 .endd
3028 (with the weekday optional, and possibly with additional text after the date)
3029 is permitted to appear at the start of the message. There appears to be no
3030 authoritative specification of the format of this line. Exim recognizes it by
3031 matching against the regular expression defined by the &%uucp_from_pattern%&
3032 option, which can be changed if necessary.
3033
3034 .oindex "&%-f%&" "overriding &""From""& line"
3035 The specified sender is treated as if it were given as the argument to the
3036 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3037 preference to the address taken from the message. The caller of Exim must be a
3038 trusted user for the sender of a message to be set in this way.
3039
3040 .vitem &%-bmalware%&&~<&'filename'&>
3041 .oindex "&%-bmalware%&"
3042 .cindex "testing", "malware"
3043 .cindex "malware scan test"
3044 This debugging option causes Exim to scan the given file or directory
3045 (depending on the used scanner interface),
3046 using the malware scanning framework.  The option of &%av_scanner%& influences
3047 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3048 the expansion should have defaults which apply to this invocation.  ACLs are
3049 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3050 will never be populated and &%-bmalware%& will fail.
3051
3052 Exim will have changed working directory before resolving the filename, so
3053 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3054 user when it tries to open the file, rather than as the invoking user.
3055 This option requires admin privileges.
3056
3057 The &%-bmalware%& option will not be extended to be more generally useful,
3058 there are better tools for file-scanning.  This option exists to help
3059 administrators verify their Exim and AV scanner configuration.
3060
3061 .vitem &%-bnq%&
3062 .oindex "&%-bnq%&"
3063 .cindex "address qualification, suppressing"
3064 By default, Exim automatically qualifies unqualified addresses (those
3065 without domains) that appear in messages that are submitted locally (that
3066 is, not over TCP/IP). This qualification applies both to addresses in
3067 envelopes, and addresses in header lines. Sender addresses are qualified using
3068 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3069 defaults to the value of &%qualify_domain%&).
3070
3071 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3072 being used to re-submit messages that originally came from remote hosts after
3073 content scanning, you probably do not want to qualify unqualified addresses in
3074 header lines. (Such lines will be present only if you have not enabled a header
3075 syntax check in the appropriate ACL.)
3076
3077 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3078 messages that originate on the local host. When this is used, unqualified
3079 addresses in the envelope provoke errors (causing message rejection) and
3080 unqualified addresses in header lines are left alone.
3081
3082
3083 .vitem &%-bP%&
3084 .oindex "&%-bP%&"
3085 .cindex "configuration options" "extracting"
3086 .cindex "options" "configuration &-- extracting"
3087 If this option is given with no arguments, it causes the values of all Exim's
3088 main configuration options to be written to the standard output. The values
3089 of one or more specific options can be requested by giving their names as
3090 arguments, for example:
3091 .code
3092 exim -bP qualify_domain hold_domains
3093 .endd
3094 .cindex "hiding configuration option values"
3095 .cindex "configuration options" "hiding value of"
3096 .cindex "options" "hiding value of"
3097 However, any option setting that is preceded by the word &"hide"& in the
3098 configuration file is not shown in full, except to an admin user. For other
3099 users, the output is as in this example:
3100 .code
3101 mysql_servers = <value not displayable>
3102 .endd
3103 If &%config%& is given as an argument, the config is
3104 output, as it was parsed, any include file resolved, any comment removed.
3105
3106 If &%config_file%& is given as an argument, the name of the run time
3107 configuration file is output. (&%configure_file%& works too, for
3108 backward compatibility.)
3109 If a list of configuration files was supplied, the value that is output here
3110 is the name of the file that was actually used.
3111
3112 .cindex "options" "hiding name of"
3113 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3114 name will not be output.
3115
3116 .cindex "daemon" "process id (pid)"
3117 .cindex "pid (process id)" "of daemon"
3118 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3119 directories where log files and daemon pid files are written are output,
3120 respectively. If these values are unset, log files are written in a
3121 sub-directory of the spool directory called &%log%&, and the pid file is
3122 written directly into the spool directory.
3123
3124 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3125 .code
3126 exim -bP +local_domains
3127 .endd
3128 it searches for a matching named list of any type (domain, host, address, or
3129 local part) and outputs what it finds.
3130
3131 .cindex "options" "router &-- extracting"
3132 .cindex "options" "transport &-- extracting"
3133 .cindex "options" "authenticator &-- extracting"
3134 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3135 followed by the name of an appropriate driver instance, the option settings for
3136 that driver are output. For example:
3137 .code
3138 exim -bP transport local_delivery
3139 .endd
3140 The generic driver options are output first, followed by the driver's private
3141 options. A list of the names of drivers of a particular type can be obtained by
3142 using one of the words &%router_list%&, &%transport_list%&, or
3143 &%authenticator_list%&, and a complete list of all drivers with their option
3144 settings can be obtained by using &%routers%&, &%transports%&, or
3145 &%authenticators%&.
3146
3147 .cindex "environment"
3148 If &%environment%& is given as an argument, the set of environment
3149 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3150 variables.
3151
3152 .cindex "options" "macro &-- extracting"
3153 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3154 are available, similarly to the drivers.  Because macros are sometimes used
3155 for storing passwords, this option is restricted.
3156 The output format is one item per line.
3157
3158 .vitem &%-bp%&
3159 .oindex "&%-bp%&"
3160 .cindex "queue" "listing messages on"
3161 .cindex "listing" "messages on the queue"
3162 This option requests a listing of the contents of the mail queue on the
3163 standard output. If the &%-bp%& option is followed by a list of message ids,
3164 just those messages are listed. By default, this option can be used only by an
3165 admin user. However, the &%queue_list_requires_admin%& option can be set false
3166 to allow any user to see the queue.
3167
3168 Each message on the queue is displayed as in the following example:
3169 .code
3170 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3171           red.king@looking-glass.fict.example
3172           <other addresses>
3173 .endd
3174 .cindex "message" "size in queue listing"
3175 .cindex "size" "of message"
3176 The first line contains the length of time the message has been on the queue
3177 (in this case 25 minutes), the size of the message (2.9K), the unique local
3178 identifier for the message, and the message sender, as contained in the
3179 envelope. For bounce messages, the sender address is empty, and appears as
3180 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3181 the default sender address, the user's login name is shown in parentheses
3182 before the sender address.
3183
3184 .cindex "frozen messages" "in queue listing"
3185 If the message is frozen (attempts to deliver it are suspended) then the text
3186 &"*** frozen ***"& is displayed at the end of this line.
3187
3188 The recipients of the message (taken from the envelope, not the headers) are
3189 displayed on subsequent lines. Those addresses to which the message has already
3190 been delivered are marked with the letter D. If an original address gets
3191 expanded into several addresses via an alias or forward file, the original is
3192 displayed with a D only when deliveries for all of its child addresses are
3193 complete.
3194
3195
3196 .vitem &%-bpa%&
3197 .oindex "&%-bpa%&"
3198 This option operates like &%-bp%&, but in addition it shows delivered addresses
3199 that were generated from the original top level address(es) in each message by
3200 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3201 of just &"D"&.
3202
3203
3204 .vitem &%-bpc%&
3205 .oindex "&%-bpc%&"
3206 .cindex "queue" "count of messages on"
3207 This option counts the number of messages on the queue, and writes the total
3208 to the standard output. It is restricted to admin users, unless
3209 &%queue_list_requires_admin%& is set false.
3210
3211
3212 .vitem &%-bpr%&
3213 .oindex "&%-bpr%&"
3214 This option operates like &%-bp%&, but the output is not sorted into
3215 chronological order of message arrival. This can speed it up when there are
3216 lots of messages on the queue, and is particularly useful if the output is
3217 going to be post-processed in a way that doesn't need the sorting.
3218
3219 .vitem &%-bpra%&
3220 .oindex "&%-bpra%&"
3221 This option is a combination of &%-bpr%& and &%-bpa%&.
3222
3223 .vitem &%-bpru%&
3224 .oindex "&%-bpru%&"
3225 This option is a combination of &%-bpr%& and &%-bpu%&.
3226
3227
3228 .vitem &%-bpu%&
3229 .oindex "&%-bpu%&"
3230 This option operates like &%-bp%& but shows only undelivered top-level
3231 addresses for each message displayed. Addresses generated by aliasing or
3232 forwarding are not shown, unless the message was deferred after processing by a
3233 router with the &%one_time%& option set.
3234
3235
3236 .vitem &%-brt%&
3237 .oindex "&%-brt%&"
3238 .cindex "testing" "retry configuration"
3239 .cindex "retry" "configuration testing"
3240 This option is for testing retry rules, and it must be followed by up to three
3241 arguments. It causes Exim to look for a retry rule that matches the values
3242 and to write it to the standard output. For example:
3243 .code
3244 exim -brt bach.comp.mus.example
3245 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3246 .endd
3247 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3248 argument, which is required, can be a complete address in the form
3249 &'local_part@domain'&, or it can be just a domain name. If the second argument
3250 contains a dot, it is interpreted as an optional second domain name; if no
3251 retry rule is found for the first argument, the second is tried. This ties in
3252 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3253 rule is found that matches the host, one that matches the mail domain is
3254 sought. Finally, an argument that is the name of a specific delivery error, as
3255 used in setting up retry rules, can be given. For example:
3256 .code
3257 exim -brt haydn.comp.mus.example quota_3d
3258 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3259 .endd
3260
3261 .vitem &%-brw%&
3262 .oindex "&%-brw%&"
3263 .cindex "testing" "rewriting"
3264 .cindex "rewriting" "testing"
3265 This option is for testing address rewriting rules, and it must be followed by
3266 a single argument, consisting of either a local part without a domain, or a
3267 complete address with a fully qualified domain. Exim outputs how this address
3268 would be rewritten for each possible place it might appear. See chapter
3269 &<<CHAPrewrite>>& for further details.
3270
3271 .vitem &%-bS%&
3272 .oindex "&%-bS%&"
3273 .cindex "SMTP" "batched incoming"
3274 .cindex "batched SMTP input"
3275 This option is used for batched SMTP input, which is an alternative interface
3276 for non-interactive local message submission. A number of messages can be
3277 submitted in a single run. However, despite its name, this is not really SMTP
3278 input. Exim reads each message's envelope from SMTP commands on the standard
3279 input, but generates no responses. If the caller is trusted, or
3280 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3281 believed; otherwise the sender is always the caller of Exim.
3282
3283 The message itself is read from the standard input, in SMTP format (leading
3284 dots doubled), terminated by a line containing just a single dot. An error is
3285 provoked if the terminating dot is missing. A further message may then follow.
3286
3287 As for other local message submissions, the contents of incoming batch SMTP
3288 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3289 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3290 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3291
3292 Some other SMTP commands are recognized in the input. HELO and EHLO act
3293 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3294 QUIT quits, ignoring the rest of the standard input.
3295
3296 .cindex "return code" "for &%-bS%&"
3297 If any error is encountered, reports are written to the standard output and
3298 error streams, and Exim gives up immediately. The return code is 0 if no error
3299 was detected; it is 1 if one or more messages were accepted before the error
3300 was detected; otherwise it is 2.
3301
3302 More details of input using batched SMTP are given in section
3303 &<<SECTincomingbatchedSMTP>>&.
3304
3305 .vitem &%-bs%&
3306 .oindex "&%-bs%&"
3307 .cindex "SMTP" "local input"
3308 .cindex "local SMTP input"
3309 This option causes Exim to accept one or more messages by reading SMTP commands
3310 on the standard input, and producing SMTP replies on the standard output. SMTP
3311 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3312 Some user agents use this interface as a way of passing locally-generated
3313 messages to the MTA.
3314
3315 In
3316 .cindex "sender" "source of"
3317 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3318 set, the senders of messages are taken from the SMTP MAIL commands.
3319 Otherwise the content of these commands is ignored and the sender is set up as
3320 the calling user. Unqualified addresses are automatically qualified using
3321 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3322 &%-bnq%& option is used.
3323
3324 .cindex "inetd"
3325 The
3326 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3327 using a listening daemon. Exim can distinguish the two cases by checking
3328 whether the standard input is a TCP/IP socket. When Exim is called from
3329 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3330 above concerning senders and qualification do not apply. In this situation,
3331 Exim behaves in exactly the same way as it does when receiving a message via
3332 the listening daemon.
3333
3334 .vitem &%-bt%&
3335 .oindex "&%-bt%&"
3336 .cindex "testing" "addresses"
3337 .cindex "address" "testing"
3338 This option runs Exim in address testing mode, in which each argument is taken
3339 as a recipient address to be tested for deliverability. The results are
3340 written to the standard output. If a test fails, and the caller is not an admin
3341 user, no details of the failure are output, because these might contain
3342 sensitive information such as usernames and passwords for database lookups.
3343
3344 If no arguments are given, Exim runs in an interactive manner, prompting with a
3345 right angle bracket for addresses to be tested.
3346
3347 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3348 &[readline()]& function, because it is running as &'root'& and there are
3349 security issues.
3350
3351 Each address is handled as if it were the recipient address of a message
3352 (compare the &%-bv%& option). It is passed to the routers and the result is
3353 written to the standard output. However, any router that has
3354 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3355 genuine routing tests if your first router passes everything to a scanner
3356 program.
3357
3358 .cindex "return code" "for &%-bt%&"
3359 The return code is 2 if any address failed outright; it is 1 if no address
3360 failed outright but at least one could not be resolved for some reason. Return
3361 code 0 is given only when all addresses succeed.
3362
3363 .cindex "duplicate addresses"
3364 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3365 addresses after routing is complete, so that only one delivery takes place.
3366 This does not happen when testing with &%-bt%&; the full results of routing are
3367 always shown.
3368
3369 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3370 routers in the configuration makes any tests on the sender address of a
3371 message,
3372 .oindex "&%-f%&" "for address testing"
3373 you can use the &%-f%& option to set an appropriate sender when running
3374 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3375 default qualifying domain. However, if you have set up (for example) routers
3376 whose behaviour depends on the contents of an incoming message, you cannot test
3377 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3378 doing such tests.
3379
3380 .vitem &%-bV%&
3381 .oindex "&%-bV%&"
3382 .cindex "version number of Exim"
3383 This option causes Exim to write the current version number, compilation
3384 number, and compilation date of the &'exim'& binary to the standard output.
3385 It also lists the DBM library that is being used, the optional modules (such as
3386 specific lookup types), the drivers that are included in the binary, and the
3387 name of the run time configuration file that is in use.
3388
3389 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3390 configuration file. However, this is a static check only. It cannot check
3391 values that are to be expanded. For example, although a misspelt ACL verb is
3392 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3393 alone to discover (for example) all the typos in the configuration; some
3394 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3395 dynamic testing facilities.
3396
3397 .vitem &%-bv%&
3398 .oindex "&%-bv%&"
3399 .cindex "verifying address" "using &%-bv%&"
3400 .cindex "address" "verification"
3401 This option runs Exim in address verification mode, in which each argument is
3402 taken as a recipient address to be verified by the routers. (This does
3403 not involve any verification callouts). During normal operation, verification
3404 happens mostly as a consequence processing a &%verify%& condition in an ACL
3405 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3406 including callouts, see the &%-bh%& and &%-bhc%& options.
3407
3408 If verification fails, and the caller is not an admin user, no details of the
3409 failure are output, because these might contain sensitive information such as
3410 usernames and passwords for database lookups.
3411
3412 If no arguments are given, Exim runs in an interactive manner, prompting with a
3413 right angle bracket for addresses to be verified.
3414
3415 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3416 &[readline()]& function, because it is running as &'exim'& and there are
3417 security issues.
3418
3419 Verification differs from address testing (the &%-bt%& option) in that routers
3420 that have &%no_verify%& set are skipped, and if the address is accepted by a
3421 router that has &%fail_verify%& set, verification fails. The address is
3422 verified as a recipient if &%-bv%& is used; to test verification for a sender
3423 address, &%-bvs%& should be used.
3424
3425 If the &%-v%& option is not set, the output consists of a single line for each
3426 address, stating whether it was verified or not, and giving a reason in the
3427 latter case. Without &%-v%&, generating more than one address by redirection
3428 causes verification to end successfully, without considering the generated
3429 addresses. However, if just one address is generated, processing continues,
3430 and the generated address must verify successfully for the overall verification
3431 to succeed.
3432
3433 When &%-v%& is set, more details are given of how the address has been handled,
3434 and in the case of address redirection, all the generated addresses are also
3435 considered. Verification may succeed for some and fail for others.
3436
3437 The
3438 .cindex "return code" "for &%-bv%&"
3439 return code is 2 if any address failed outright; it is 1 if no address
3440 failed outright but at least one could not be resolved for some reason. Return
3441 code 0 is given only when all addresses succeed.
3442
3443 If any of the routers in the configuration makes any tests on the sender
3444 address of a message, you should use the &%-f%& option to set an appropriate
3445 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3446 calling user at the default qualifying domain.
3447
3448 .vitem &%-bvs%&
3449 .oindex "&%-bvs%&"
3450 This option acts like &%-bv%&, but verifies the address as a sender rather
3451 than a recipient address. This affects any rewriting and qualification that
3452 might happen.
3453
3454 .vitem &%-bw%&
3455 .oindex "&%-bw%&"
3456 .cindex "daemon"
3457 .cindex "inetd"
3458 .cindex "inetd" "wait mode"
3459 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3460 similarly to the &%-bd%& option.  All port specifications on the command-line
3461 and in the configuration file are ignored.  Queue-running may not be specified.
3462
3463 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3464 listening for connections.  This permits the system to start up and have
3465 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3466 each port only when the first connection is received.
3467
3468 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3469 which the daemon will exit, which should cause inetd to listen once more.
3470
3471 .vitem &%-C%&&~<&'filelist'&>
3472 .oindex "&%-C%&"
3473 .cindex "configuration file" "alternate"
3474 .cindex "CONFIGURE_FILE"
3475 .cindex "alternate configuration file"
3476 This option causes Exim to find the run time configuration file from the given
3477 list instead of from the list specified by the CONFIGURE_FILE
3478 compile-time setting. Usually, the list will consist of just a single file
3479 name, but it can be a colon-separated list of names. In this case, the first
3480 file that exists is used. Failure to open an existing file stops Exim from
3481 proceeding any further along the list, and an error is generated.
3482
3483 When this option is used by a caller other than root, and the list is different
3484 from the compiled-in list, Exim gives up its root privilege immediately, and
3485 runs with the real and effective uid and gid set to those of the caller.
3486 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3487 file contains a list of full pathnames, one per line, for configuration files
3488 which are trusted. Root privilege is retained for any configuration file so
3489 listed, as long as the caller is the Exim user (or the user specified in the
3490 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3491 not writeable by inappropriate users or groups.
3492
3493 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3494 configuration using &%-C%& right through message reception and delivery,
3495 even if the caller is root. The reception works, but by that time, Exim is
3496 running as the Exim user, so when it re-executes to regain privilege for the
3497 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3498 test reception and delivery using two separate commands (one to put a message
3499 on the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3500
3501 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3502 prefix string with which any file named in a &%-C%& command line option
3503 must start. In addition, the file name must not contain the sequence &`/../`&.
3504 However, if the value of the &%-C%& option is identical to the value of
3505 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3506 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3507 unset, any file name can be used with &%-C%&.
3508
3509 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3510 to a directory to which only root has access. This prevents someone who has
3511 broken into the Exim account from running a privileged Exim with an arbitrary
3512 configuration file.
3513
3514 The &%-C%& facility is useful for ensuring that configuration files are
3515 syntactically correct, but cannot be used for test deliveries, unless the
3516 caller is privileged, or unless it is an exotic configuration that does not
3517 require privilege. No check is made on the owner or group of the files
3518 specified by this option.
3519
3520
3521 .vitem &%-D%&<&'macro'&>=<&'value'&>
3522 .oindex "&%-D%&"
3523 .cindex "macro" "setting on command line"
3524 This option can be used to override macro definitions in the configuration file
3525 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3526 unprivileged caller, it causes Exim to give up its root privilege.
3527 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3528 completely disabled, and its use causes an immediate error exit.
3529
3530 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3531 colon-separated list of macros which are considered safe and, if &%-D%& only
3532 supplies macros from this list, and the values are acceptable, then Exim will
3533 not give up root privilege if the caller is root, the Exim run-time user, or
3534 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3535 to be removed in the future.  Acceptable values for the macros satisfy the
3536 regexp: &`^[A-Za-z0-9_/.-]*$`&
3537
3538 The entire option (including equals sign if present) must all be within one
3539 command line item. &%-D%& can be used to set the value of a macro to the empty
3540 string, in which case the equals sign is optional. These two commands are
3541 synonymous:
3542 .code
3543 exim -DABC  ...
3544 exim -DABC= ...
3545 .endd
3546 To include spaces in a macro definition item, quotes must be used. If you use
3547 quotes, spaces are permitted around the macro name and the equals sign. For
3548 example:
3549 .code
3550 exim '-D ABC = something' ...
3551 .endd
3552 &%-D%& may be repeated up to 10 times on a command line.
3553 Only macro names up to 22 letters long can be set.
3554
3555
3556 .vitem &%-d%&<&'debug&~options'&>
3557 .oindex "&%-d%&"
3558 .cindex "debugging" "list of selectors"
3559 .cindex "debugging" "&%-d%& option"
3560 This option causes debugging information to be written to the standard
3561 error stream. It is restricted to admin users because debugging output may show
3562 database queries that contain password information. Also, the details of users'
3563 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3564 writes an error message to the standard error stream and exits with a non-zero
3565 return code.
3566
3567 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3568 standard debugging data is output. This can be reduced, or increased to include
3569 some more rarely needed information, by directly following &%-d%& with a string
3570 made up of names preceded by plus or minus characters. These add or remove sets
3571 of debugging data, respectively. For example, &%-d+filter%& adds filter
3572 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3573 no spaces are allowed in the debug setting. The available debugging categories
3574 are:
3575 .display
3576 &`acl            `& ACL interpretation
3577 &`auth           `& authenticators
3578 &`deliver        `& general delivery logic
3579 &`dns            `& DNS lookups (see also resolver)
3580 &`dnsbl          `& DNS black list (aka RBL) code
3581 &`exec           `& arguments for &[execv()]& calls
3582 &`expand         `& detailed debugging for string expansions
3583 &`filter         `& filter handling
3584 &`hints_lookup   `& hints data lookups
3585 &`host_lookup    `& all types of name-to-IP address handling
3586 &`ident          `& ident lookup
3587 &`interface      `& lists of local interfaces
3588 &`lists          `& matching things in lists
3589 &`load           `& system load checks
3590 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3591                     &<<CHAPlocalscan>>&)
3592 &`lookup         `& general lookup code and all lookups
3593 &`memory         `& memory handling
3594 &`pid            `& add pid to debug output lines
3595 &`process_info   `& setting info for the process log
3596 &`queue_run      `& queue runs
3597 &`receive        `& general message reception logic
3598 &`resolver       `& turn on the DNS resolver's debugging output
3599 &`retry          `& retry handling
3600 &`rewrite        `& address rewriting
3601 &`route          `& address routing
3602 &`timestamp      `& add timestamp to debug output lines
3603 &`tls            `& TLS logic
3604 &`transport      `& transports
3605 &`uid            `& changes of uid/gid and looking up uid/gid
3606 &`verify         `& address verification logic
3607 &`all            `& almost all of the above (see below), and also &%-v%&
3608 .endd
3609 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3610 for &`-all`&. The reason for this is that &`+all`& is something that people
3611 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3612 is included, an awful lot of output that is very rarely of interest is
3613 generated, so it now has to be explicitly requested. However, &`-all`& does
3614 turn everything off.
3615
3616 .cindex "resolver, debugging output"
3617 .cindex "DNS resolver, debugging output"
3618 The &`resolver`& option produces output only if the DNS resolver was compiled
3619 with DEBUG enabled. This is not the case in some operating systems. Also,
3620 unfortunately, debugging output from the DNS resolver is written to stdout
3621 rather than stderr.
3622
3623 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3624 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3625 However, the &`pid`& selector is forced when debugging is turned on for a
3626 daemon, which then passes it on to any re-executed Exims. Exim also
3627 automatically adds the pid to debug lines when several remote deliveries are
3628 run in parallel.
3629
3630 The &`timestamp`& selector causes the current time to be inserted at the start
3631 of all debug output lines. This can be useful when trying to track down delays
3632 in processing.
3633
3634 If the &%debug_print%& option is set in any driver, it produces output whenever
3635 any debugging is selected, or if &%-v%& is used.
3636
3637 .vitem &%-dd%&<&'debug&~options'&>
3638 .oindex "&%-dd%&"
3639 This option behaves exactly like &%-d%& except when used on a command that
3640 starts a daemon process. In that case, debugging is turned off for the
3641 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3642 behaviour of the daemon without creating as much output as full debugging does.
3643
3644 .vitem &%-dropcr%&
3645 .oindex "&%-dropcr%&"
3646 This is an obsolete option that is now a no-op. It used to affect the way Exim
3647 handled CR and LF characters in incoming messages. What happens now is
3648 described in section &<<SECTlineendings>>&.
3649
3650 .vitem &%-E%&
3651 .oindex "&%-E%&"
3652 .cindex "bounce message" "generating"
3653 This option specifies that an incoming message is a locally-generated delivery
3654 failure report. It is used internally by Exim when handling delivery failures
3655 and is not intended for external use. Its only effect is to stop Exim
3656 generating certain messages to the postmaster, as otherwise message cascades
3657 could occur in some situations. As part of the same option, a message id may
3658 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3659 new message contains the id, following &"R="&, as a cross-reference.
3660
3661 .vitem &%-e%&&'x'&
3662 .oindex "&%-e%&&'x'&"
3663 There are a number of Sendmail options starting with &%-oe%& which seem to be
3664 called by various programs without the leading &%o%& in the option. For
3665 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3666 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3667
3668 .vitem &%-F%&&~<&'string'&>
3669 .oindex "&%-F%&"
3670 .cindex "sender" "name"
3671 .cindex "name" "of sender"
3672 This option sets the sender's full name for use when a locally-generated
3673 message is being accepted. In the absence of this option, the user's &'gecos'&
3674 entry from the password data is used. As users are generally permitted to alter
3675 their &'gecos'& entries, no security considerations are involved. White space
3676 between &%-F%& and the <&'string'&> is optional.
3677
3678 .vitem &%-f%&&~<&'address'&>
3679 .oindex "&%-f%&"
3680 .cindex "sender" "address"
3681 .cindex "address" "sender"
3682 .cindex "trusted users"
3683 .cindex "envelope sender"
3684 .cindex "user" "trusted"
3685 This option sets the address of the envelope sender of a locally-generated
3686 message (also known as the return path). The option can normally be used only
3687 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3688 users to use it.
3689
3690 Processes running as root or the Exim user are always trusted. Other
3691 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3692 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3693 of a local message is set to the caller's login name at the default qualify
3694 domain.
3695
3696 There is one exception to the restriction on the use of &%-f%&: an empty sender
3697 can be specified by any user, trusted or not, to create a message that can
3698 never provoke a bounce. An empty sender can be specified either as an empty
3699 string, or as a pair of angle brackets with nothing between them, as in these
3700 examples of shell commands:
3701 .code
3702 exim -f '<>' user@domain
3703 exim -f "" user@domain
3704 .endd
3705 In addition, the use of &%-f%& is not restricted when testing a filter file
3706 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3707 &%-bv%& options.
3708
3709 Allowing untrusted users to change the sender address does not of itself make
3710 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3711 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3712 though this can be overridden by setting &%no_local_from_check%&.
3713
3714 White
3715 .cindex "&""From""& line"
3716 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3717 given as two arguments or one combined argument). The sender of a
3718 locally-generated message can also be set (when permitted) by an initial
3719 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3720 if &%-f%& is also present, it overrides &"From&~"&.
3721
3722 .vitem &%-G%&
3723 .oindex "&%-G%&"
3724 .cindex "submission fixups, suppressing (command-line)"
3725 This option is equivalent to an ACL applying:
3726 .code
3727 control = suppress_local_fixups
3728 .endd
3729 for every message received.  Note that Sendmail will complain about such
3730 bad formatting, where Exim silently just does not fix it up.  This may change
3731 in future.
3732
3733 As this affects audit information, the caller must be a trusted user to use
3734 this option.
3735
3736 .vitem &%-h%&&~<&'number'&>
3737 .oindex "&%-h%&"
3738 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3739 This option is accepted for compatibility with Sendmail, but has no effect. (In
3740 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3741 headers.)
3742
3743 .vitem &%-i%&
3744 .oindex "&%-i%&"
3745 .cindex "Solaris" "&'mail'& command"
3746 .cindex "dot" "in incoming non-SMTP message"
3747 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3748 line by itself should not terminate an incoming, non-SMTP message. I can find
3749 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3750 command in Solaris 2.4 uses it. See also &%-ti%&.
3751
3752 .vitem &%-L%&&~<&'tag'&>
3753 .oindex "&%-L%&"
3754 .cindex "syslog" "process name; set with flag"
3755 This option is equivalent to setting &%syslog_processname%& in the config
3756 file and setting &%log_file_path%& to &`syslog`&.
3757 Its use is restricted to administrators.  The configuration file has to be
3758 read and parsed, to determine access rights, before this is set and takes
3759 effect, so early configuration file errors will not honour this flag.
3760
3761 The tag should not be longer than 32 characters.
3762
3763 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3764 .oindex "&%-M%&"
3765 .cindex "forcing delivery"
3766 .cindex "delivery" "forcing attempt"
3767 .cindex "frozen messages" "forcing delivery"
3768 This option requests Exim to run a delivery attempt on each message in turn. If
3769 any of the messages are frozen, they are automatically thawed before the
3770 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3771 and &%hold_domains%& are ignored.
3772
3773 Retry
3774 .cindex "hints database" "overriding retry hints"
3775 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3776 the normal retry time has not yet been reached. This option requires the caller
3777 to be an admin user. However, there is an option called &%prod_requires_admin%&
3778 which can be set false to relax this restriction (and also the same requirement
3779 for the &%-q%&, &%-R%&, and &%-S%& options).
3780
3781 The deliveries happen synchronously, that is, the original Exim process does
3782 not terminate until all the delivery attempts have finished. No output is
3783 produced unless there is a serious error. If you want to see what is happening,
3784 use the &%-v%& option as well, or inspect Exim's main log.
3785
3786 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3787 .oindex "&%-Mar%&"
3788 .cindex "message" "adding recipients"
3789 .cindex "recipient" "adding"
3790 This option requests Exim to add the addresses to the list of recipients of the
3791 message (&"ar"& for &"add recipients"&). The first argument must be a message
3792 id, and the remaining ones must be email addresses. However, if the message is
3793 active (in the middle of a delivery attempt), it is not altered. This option
3794 can be used only by an admin user.
3795
3796 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3797         &~<&'message&~id'&>"
3798 .oindex "&%-MC%&"
3799 .cindex "SMTP" "passed connection"
3800 .cindex "SMTP" "multiple deliveries"
3801 .cindex "multiple SMTP deliveries"
3802 This option is not intended for use by external callers. It is used internally
3803 by Exim to invoke another instance of itself to deliver a waiting message using
3804 an existing SMTP connection, which is passed as the standard input. Details are
3805 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3806 must be root or the Exim user in order to use it.
3807
3808 .vitem &%-MCA%&
3809 .oindex "&%-MCA%&"
3810 This option is not intended for use by external callers. It is used internally
3811 by Exim in conjunction with the &%-MC%& option. It signifies that the
3812 connection to the remote host has been authenticated.
3813
3814 .vitem &%-MCD%&
3815 .oindex "&%-MCD%&"
3816 This option is not intended for use by external callers. It is used internally
3817 by Exim in conjunction with the &%-MC%& option. It signifies that the
3818 remote host supports the ESMTP &_DSN_& extension.
3819
3820 .vitem &%-MCG%&&~<&'queue&~name'&>
3821 .oindex "&%-MCG%&"
3822 This option is not intended for use by external callers. It is used internally
3823 by Exim in conjunction with the &%-MC%& option. It signifies that an
3824 alternate queue is used, named by the following argument.
3825
3826 .vitem &%-MCK%&
3827 .oindex "&%-MCK%&"
3828 This option is not intended for use by external callers. It is used internally
3829 by Exim in conjunction with the &%-MC%& option. It signifies that an
3830 remote host supports the ESMTP &_CHUNKING_& extension.
3831
3832 .vitem &%-MCP%&
3833 .oindex "&%-MCP%&"
3834 This option is not intended for use by external callers. It is used internally
3835 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3836 which Exim is connected supports pipelining.
3837
3838 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3839 .oindex "&%-MCQ%&"
3840 This option is not intended for use by external callers. It is used internally
3841 by Exim in conjunction with the &%-MC%& option when the original delivery was
3842 started by a queue runner. It passes on the process id of the queue runner,
3843 together with the file descriptor number of an open pipe. Closure of the pipe
3844 signals the final completion of the sequence of processes that are passing
3845 messages through the same SMTP connection.
3846
3847 .vitem &%-MCS%&
3848 .oindex "&%-MCS%&"
3849 This option is not intended for use by external callers. It is used internally
3850 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3851 SMTP SIZE option should be used on messages delivered down the existing
3852 connection.
3853
3854 .vitem &%-MCT%&
3855 .oindex "&%-MCT%&"
3856 This option is not intended for use by external callers. It is used internally
3857 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3858 host to which Exim is connected supports TLS encryption.
3859
3860 .new
3861 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3862 .oindex "&%-MCt%&"
3863 This option is not intended for use by external callers. It is used internally
3864 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3865 connection is being proxied by a parent process for handling TLS encryption.
3866 The arguments give the local address and port being proxied, and the TLS cipher.
3867 .wen
3868
3869 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3870 .oindex "&%-Mc%&"
3871 .cindex "hints database" "not overridden by &%-Mc%&"
3872 .cindex "delivery" "manually started &-- not forced"
3873 This option requests Exim to run a delivery attempt on each message in turn,
3874 but unlike the &%-M%& option, it does check for retry hints, and respects any
3875 that are found. This option is not very useful to external callers. It is
3876 provided mainly for internal use by Exim when it needs to re-invoke itself in
3877 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3878 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3879 respects retry times and other options such as &%hold_domains%& that are
3880 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3881 If you want to run a specific delivery as if in a queue run, you should use
3882 &%-q%& with a message id argument. A distinction between queue run deliveries
3883 and other deliveries is made in one or two places.
3884
3885 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3886 .oindex "&%-Mes%&"
3887 .cindex "message" "changing sender"
3888 .cindex "sender" "changing"
3889 This option requests Exim to change the sender address in the message to the
3890 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3891 &"edit sender"&). There must be exactly two arguments. The first argument must
3892 be a message id, and the second one an email address. However, if the message
3893 is active (in the middle of a delivery attempt), its status is not altered.
3894 This option can be used only by an admin user.
3895
3896 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3897 .oindex "&%-Mf%&"
3898 .cindex "freezing messages"
3899 .cindex "message" "manually freezing"
3900 This option requests Exim to mark each listed message as &"frozen"&. This
3901 prevents any delivery attempts taking place until the message is &"thawed"&,
3902 either manually or as a result of the &%auto_thaw%& configuration option.
3903 However, if any of the messages are active (in the middle of a delivery
3904 attempt), their status is not altered. This option can be used only by an admin
3905 user.
3906
3907 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3908 .oindex "&%-Mg%&"
3909 .cindex "giving up on messages"
3910 .cindex "message" "abandoning delivery attempts"
3911 .cindex "delivery" "abandoning further attempts"
3912 This option requests Exim to give up trying to deliver the listed messages,
3913 including any that are frozen. However, if any of the messages are active,
3914 their status is not altered. For non-bounce messages, a delivery error message
3915 is sent to the sender, containing the text &"cancelled by administrator"&.
3916 Bounce messages are just discarded. This option can be used only by an admin
3917 user.
3918
3919 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3920 .oindex "&%-Mmad%&"
3921 .cindex "delivery" "cancelling all"
3922 This option requests Exim to mark all the recipient addresses in the messages
3923 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3924 message is active (in the middle of a delivery attempt), its status is not
3925 altered. This option can be used only by an admin user.
3926
3927 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3928 .oindex "&%-Mmd%&"
3929 .cindex "delivery" "cancelling by address"
3930 .cindex "recipient" "removing"
3931 .cindex "removing recipients"
3932 This option requests Exim to mark the given addresses as already delivered
3933 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3934 the remaining ones must be email addresses. These are matched to recipient
3935 addresses in the message in a case-sensitive manner. If the message is active
3936 (in the middle of a delivery attempt), its status is not altered. This option
3937 can be used only by an admin user.
3938
3939 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3940 .oindex "&%-Mrm%&"
3941 .cindex "removing messages"
3942 .cindex "abandoning mail"
3943 .cindex "message" "manually discarding"
3944 This option requests Exim to remove the given messages from the queue. No
3945 bounce messages are sent; each message is simply forgotten. However, if any of
3946 the messages are active, their status is not altered. This option can be used
3947 only by an admin user or by the user who originally caused the message to be
3948 placed on the queue.
3949
3950 .vitem &%-Mset%&&~<&'message&~id'&>
3951 .oindex "&%-Mset%&
3952 .cindex "testing" "string expansion"
3953 .cindex "expansion" "testing"
3954 This option is useful only in conjunction with &%-be%& (that is, when testing
3955 string expansions). Exim loads the given message from its spool before doing
3956 the test expansions, thus setting message-specific variables such as
3957 &$message_size$& and the header variables. The &$recipients$& variable is made
3958 available. This feature is provided to make it easier to test expansions that
3959 make use of these variables. However, this option can be used only by an admin
3960 user. See also &%-bem%&.
3961
3962 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3963 .oindex "&%-Mt%&"
3964 .cindex "thawing messages"
3965 .cindex "unfreezing messages"
3966 .cindex "frozen messages" "thawing"
3967 .cindex "message" "thawing frozen"
3968 This option requests Exim to &"thaw"& any of the listed messages that are
3969 &"frozen"&, so that delivery attempts can resume. However, if any of the
3970 messages are active, their status is not altered. This option can be used only
3971 by an admin user.
3972
3973 .vitem &%-Mvb%&&~<&'message&~id'&>
3974 .oindex "&%-Mvb%&"
3975 .cindex "listing" "message body"
3976 .cindex "message" "listing body of"
3977 This option causes the contents of the message body (-D) spool file to be
3978 written to the standard output. This option can be used only by an admin user.
3979
3980 .vitem &%-Mvc%&&~<&'message&~id'&>
3981 .oindex "&%-Mvc%&"
3982 .cindex "message" "listing in RFC 2822 format"
3983 .cindex "listing" "message in RFC 2822 format"
3984 This option causes a copy of the complete message (header lines plus body) to
3985 be written to the standard output in RFC 2822 format. This option can be used
3986 only by an admin user.
3987
3988 .vitem &%-Mvh%&&~<&'message&~id'&>
3989 .oindex "&%-Mvh%&"
3990 .cindex "listing" "message headers"
3991 .cindex "header lines" "listing"
3992 .cindex "message" "listing header lines"
3993 This option causes the contents of the message headers (-H) spool file to be
3994 written to the standard output. This option can be used only by an admin user.
3995
3996 .vitem &%-Mvl%&&~<&'message&~id'&>
3997 .oindex "&%-Mvl%&"
3998 .cindex "listing" "message log"
3999 .cindex "message" "listing message log"
4000 This option causes the contents of the message log spool file to be written to
4001 the standard output. This option can be used only by an admin user.
4002
4003 .vitem &%-m%&
4004 .oindex "&%-m%&"
4005 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4006 treats it that way too.
4007
4008 .vitem &%-N%&
4009 .oindex "&%-N%&"
4010 .cindex "debugging" "&%-N%& option"
4011 .cindex "debugging" "suppressing delivery"
4012 This is a debugging option that inhibits delivery of a message at the transport
4013 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4014 it just doesn't actually transport the message, but instead behaves as if it
4015 had successfully done so. However, it does not make any updates to the retry
4016 database, and the log entries for deliveries are flagged with &"*>"& rather
4017 than &"=>"&.
4018
4019 Because &%-N%& discards any message to which it applies, only root or the Exim
4020 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4021 words, an ordinary user can use it only when supplying an incoming message to
4022 which it will apply. Although transportation never fails when &%-N%& is set, an
4023 address may be deferred because of a configuration problem on a transport, or a
4024 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4025 the message, and applies to any subsequent delivery attempts that may happen
4026 for that message.
4027
4028 .vitem &%-n%&
4029 .oindex "&%-n%&"
4030 This option is interpreted by Sendmail to mean &"no aliasing"&.
4031 For normal modes of operation, it is ignored by Exim.
4032 When combined with &%-bP%& it makes the output more terse (suppresses
4033 option names, environment values and config pretty printing).
4034
4035 .vitem &%-O%&&~<&'data'&>
4036 .oindex "&%-O%&"
4037 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4038 Exim.
4039
4040 .vitem &%-oA%&&~<&'file&~name'&>
4041 .oindex "&%-oA%&"
4042 .cindex "Sendmail compatibility" "&%-oA%& option"
4043 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4044 alternative alias file name. Exim handles &%-bi%& differently; see the
4045 description above.
4046
4047 .vitem &%-oB%&&~<&'n'&>
4048 .oindex "&%-oB%&"
4049 .cindex "SMTP" "passed connection"
4050 .cindex "SMTP" "multiple deliveries"
4051 .cindex "multiple SMTP deliveries"
4052 This is a debugging option which limits the maximum number of messages that can
4053 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4054 transport. If <&'n'&> is omitted, the limit is set to 1.
4055
4056 .vitem &%-odb%&
4057 .oindex "&%-odb%&"
4058 .cindex "background delivery"
4059 .cindex "delivery" "in the background"
4060 This option applies to all modes in which Exim accepts incoming messages,
4061 including the listening daemon. It requests &"background"& delivery of such
4062 messages, which means that the accepting process automatically starts a
4063 delivery process for each message received, but does not wait for the delivery
4064 processes to finish.
4065
4066 When all the messages have been received, the reception process exits,
4067 leaving the delivery processes to finish in their own time. The standard output
4068 and error streams are closed at the start of each delivery process.
4069 This is the default action if none of the &%-od%& options are present.
4070
4071 If one of the queueing options in the configuration file
4072 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4073 overrides it if &%queue_only_override%& is set true, which is the default
4074 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4075
4076 .vitem &%-odf%&
4077 .oindex "&%-odf%&"
4078 .cindex "foreground delivery"
4079 .cindex "delivery" "in the foreground"
4080 This option requests &"foreground"& (synchronous) delivery when Exim has
4081 accepted a locally-generated message. (For the daemon it is exactly the same as
4082 &%-odb%&.) A delivery process is automatically started to deliver the message,
4083 and Exim waits for it to complete before proceeding.
4084
4085 The original Exim reception process does not finish until the delivery
4086 process for the final message has ended. The standard error stream is left open
4087 during deliveries.
4088
4089 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4090 false and one of the queueing options in the configuration file is in effect.
4091
4092 If there is a temporary delivery error during foreground delivery, the
4093 message is left on the queue for later delivery, and the original reception
4094 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4095 restricted configuration that never queues messages.
4096
4097
4098 .vitem &%-odi%&
4099 .oindex "&%-odi%&"
4100 This option is synonymous with &%-odf%&. It is provided for compatibility with
4101 Sendmail.
4102
4103 .vitem &%-odq%&
4104 .oindex "&%-odq%&"
4105 .cindex "non-immediate delivery"
4106 .cindex "delivery" "suppressing immediate"
4107 .cindex "queueing incoming messages"
4108 This option applies to all modes in which Exim accepts incoming messages,
4109 including the listening daemon. It specifies that the accepting process should
4110 not automatically start a delivery process for each message received. Messages
4111 are placed on the queue, and remain there until a subsequent queue runner
4112 process encounters them. There are several configuration options (such as
4113 &%queue_only%&) that can be used to queue incoming messages under certain
4114 conditions. This option overrides all of them and also &%-odqs%&. It always
4115 forces queueing.
4116
4117 .vitem &%-odqs%&
4118 .oindex "&%-odqs%&"
4119 .cindex "SMTP" "delaying delivery"
4120 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4121 However, like &%-odb%& and &%-odi%&, this option has no effect if
4122 &%queue_only_override%& is false and one of the queueing options in the
4123 configuration file is in effect.
4124
4125 When &%-odqs%& does operate, a delivery process is started for each incoming
4126 message, in the background by default, but in the foreground if &%-odi%& is
4127 also present. The recipient addresses are routed, and local deliveries are done
4128 in the normal way. However, if any SMTP deliveries are required, they are not
4129 done at this time, so the message remains on the queue until a subsequent queue
4130 runner process encounters it. Because routing was done, Exim knows which
4131 messages are waiting for which hosts, and so a number of messages for the same
4132 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4133 configuration option has the same effect for specific domains. See also the
4134 &%-qq%& option.
4135
4136 .vitem &%-oee%&
4137 .oindex "&%-oee%&"
4138 .cindex "error" "reporting"
4139 If an error is detected while a non-SMTP message is being received (for
4140 example, a malformed address), the error is reported to the sender in a mail
4141 message.
4142
4143 .cindex "return code" "for &%-oee%&"
4144 Provided
4145 this error message is successfully sent, the Exim receiving process
4146 exits with a return code of zero. If not, the return code is 2 if the problem
4147 is that the original message has no recipients, or 1 for any other error.
4148 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4149
4150 .vitem &%-oem%&
4151 .oindex "&%-oem%&"
4152 .cindex "error" "reporting"
4153 .cindex "return code" "for &%-oem%&"
4154 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4155 return code, whether or not the error message was successfully sent.
4156 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4157
4158 .vitem &%-oep%&
4159 .oindex "&%-oep%&"
4160 .cindex "error" "reporting"
4161 If an error is detected while a non-SMTP message is being received, the
4162 error is reported by writing a message to the standard error file (stderr).
4163 .cindex "return code" "for &%-oep%&"
4164 The return code is 1 for all errors.
4165
4166 .vitem &%-oeq%&
4167 .oindex "&%-oeq%&"
4168 .cindex "error" "reporting"
4169 This option is supported for compatibility with Sendmail, but has the same
4170 effect as &%-oep%&.
4171
4172 .vitem &%-oew%&
4173 .oindex "&%-oew%&"
4174 .cindex "error" "reporting"
4175 This option is supported for compatibility with Sendmail, but has the same
4176 effect as &%-oem%&.
4177
4178 .vitem &%-oi%&
4179 .oindex "&%-oi%&"
4180 .cindex "dot" "in incoming non-SMTP message"
4181 This option, which has the same effect as &%-i%&, specifies that a dot on a
4182 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4183 single dot does terminate, though Exim does no special processing for other
4184 lines that start with a dot. This option is set by default if Exim is called as
4185 &'rmail'&. See also &%-ti%&.
4186
4187 .vitem &%-oitrue%&
4188 .oindex "&%-oitrue%&"
4189 This option is treated as synonymous with &%-oi%&.
4190
4191 .vitem &%-oMa%&&~<&'host&~address'&>
4192 .oindex "&%-oMa%&"
4193 .cindex "sender" "host address, specifying for local message"
4194 A number of options starting with &%-oM%& can be used to set values associated
4195 with remote hosts on locally-submitted messages (that is, messages not received
4196 over TCP/IP). These options can be used by any caller in conjunction with the
4197 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4198 other circumstances, they are ignored unless the caller is trusted.
4199
4200 The &%-oMa%& option sets the sender host address. This may include a port
4201 number at the end, after a full stop (period). For example:
4202 .code
4203 exim -bs -oMa 10.9.8.7.1234
4204 .endd
4205 An alternative syntax is to enclose the IP address in square brackets,
4206 followed by a colon and the port number:
4207 .code
4208 exim -bs -oMa [10.9.8.7]:1234
4209 .endd
4210 The IP address is placed in the &$sender_host_address$& variable, and the
4211 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4212 are present on the command line, the sender host IP address is taken from
4213 whichever one is last.
4214
4215 .vitem &%-oMaa%&&~<&'name'&>
4216 .oindex "&%-oMaa%&"
4217 .cindex "authentication" "name, specifying for local message"
4218 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4219 option sets the value of &$sender_host_authenticated$& (the authenticator
4220 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4221 This option can be used with &%-bh%& and &%-bs%& to set up an
4222 authenticated SMTP session without actually using the SMTP AUTH command.
4223
4224 .vitem &%-oMai%&&~<&'string'&>
4225 .oindex "&%-oMai%&"
4226 .cindex "authentication" "id, specifying for local message"
4227 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4228 option sets the value of &$authenticated_id$& (the id that was authenticated).
4229 This overrides the default value (the caller's login id, except with &%-bh%&,
4230 where there is no default) for messages from local sources. See chapter
4231 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4232
4233 .vitem &%-oMas%&&~<&'address'&>
4234 .oindex "&%-oMas%&"
4235 .cindex "authentication" "sender, specifying for local message"
4236 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4237 option sets the authenticated sender value in &$authenticated_sender$&. It
4238 overrides the sender address that is created from the caller's login id for
4239 messages from local sources, except when &%-bh%& is used, when there is no
4240 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4241 specified on a MAIL command overrides this value. See chapter
4242 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4243
4244 .vitem &%-oMi%&&~<&'interface&~address'&>
4245 .oindex "&%-oMi%&"
4246 .cindex "interface" "address, specifying for local message"
4247 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4248 option sets the IP interface address value. A port number may be included,
4249 using the same syntax as for &%-oMa%&. The interface address is placed in
4250 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4251
4252 .vitem &%-oMm%&&~<&'message&~reference'&>
4253 .oindex "&%-oMm%&"
4254 .cindex "message reference" "message reference, specifying for local message"
4255 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4256 option sets the message reference, e.g. message-id, and is logged during
4257 delivery. This is useful when some kind of audit trail is required to tie
4258 messages together. The format of the message reference is checked and will
4259 abort if the format is invalid. The option will only be accepted if exim is
4260 running in trusted mode, not as any regular user.
4261
4262 The best example of a message reference is when Exim sends a bounce message.
4263 The message reference is the message-id of the original message for which Exim
4264 is sending the bounce.
4265
4266 .vitem &%-oMr%&&~<&'protocol&~name'&>
4267 .oindex "&%-oMr%&"
4268 .cindex "protocol, specifying for local message"
4269 .vindex "&$received_protocol$&"
4270 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4271 option sets the received protocol value that is stored in
4272 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4273 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4274 SMTP protocol names (see the description of &$received_protocol$& in section
4275 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4276 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4277 be set by &%-oMr%&. Repeated use of this option is not supported.
4278
4279 .vitem &%-oMs%&&~<&'host&~name'&>
4280 .oindex "&%-oMs%&"
4281 .cindex "sender" "host name, specifying for local message"
4282 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4283 option sets the sender host name in &$sender_host_name$&. When this option is
4284 present, Exim does not attempt to look up a host name from an IP address; it
4285 uses the name it is given.
4286
4287 .vitem &%-oMt%&&~<&'ident&~string'&>
4288 .oindex "&%-oMt%&"
4289 .cindex "sender" "ident string, specifying for local message"
4290 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4291 option sets the sender ident value in &$sender_ident$&. The default setting for
4292 local callers is the login id of the calling process, except when &%-bh%& is
4293 used, when there is no default.
4294
4295 .vitem &%-om%&
4296 .oindex "&%-om%&"
4297 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4298 In Sendmail, this option means &"me too"&, indicating that the sender of a
4299 message should receive a copy of the message if the sender appears in an alias
4300 expansion. Exim always does this, so the option does nothing.
4301
4302 .vitem &%-oo%&
4303 .oindex "&%-oo%&"
4304 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4305 This option is ignored. In Sendmail it specifies &"old style headers"&,
4306 whatever that means.
4307
4308 .vitem &%-oP%&&~<&'path'&>
4309 .oindex "&%-oP%&"
4310 .cindex "pid (process id)" "of daemon"
4311 .cindex "daemon" "process id (pid)"
4312 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4313 value. The option specifies the file to which the process id of the daemon is
4314 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4315 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4316 because in those cases, the normal pid file is not used.
4317
4318 .vitem &%-or%&&~<&'time'&>
4319 .oindex "&%-or%&"
4320 .cindex "timeout" "for non-SMTP input"
4321 This option sets a timeout value for incoming non-SMTP messages. If it is not
4322 set, Exim will wait forever for the standard input. The value can also be set
4323 by the &%receive_timeout%& option. The format used for specifying times is
4324 described in section &<<SECTtimeformat>>&.
4325
4326 .vitem &%-os%&&~<&'time'&>
4327 .oindex "&%-os%&"
4328 .cindex "timeout" "for SMTP input"
4329 .cindex "SMTP" "input timeout"
4330 This option sets a timeout value for incoming SMTP messages. The timeout
4331 applies to each SMTP command and block of data. The value can also be set by
4332 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4333 for specifying times is described in section &<<SECTtimeformat>>&.
4334
4335 .vitem &%-ov%&
4336 .oindex "&%-ov%&"
4337 This option has exactly the same effect as &%-v%&.
4338
4339 .vitem &%-oX%&&~<&'number&~or&~string'&>
4340 .oindex "&%-oX%&"
4341 .cindex "TCP/IP" "setting listening ports"
4342 .cindex "TCP/IP" "setting listening interfaces"
4343 .cindex "port" "receiving TCP/IP"
4344 This option is relevant only when the &%-bd%& (start listening daemon) option
4345 is also given. It controls which ports and interfaces the daemon uses. Details
4346 of the syntax, and how it interacts with configuration file options, are given
4347 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4348 file is written unless &%-oP%& is also present to specify a pid file name.
4349
4350 .vitem &%-pd%&
4351 .oindex "&%-pd%&"
4352 .cindex "Perl" "starting the interpreter"
4353 This option applies when an embedded Perl interpreter is linked with Exim (see
4354 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4355 option, forcing the starting of the interpreter to be delayed until it is
4356 needed.
4357
4358 .vitem &%-ps%&
4359 .oindex "&%-ps%&"
4360 .cindex "Perl" "starting the interpreter"
4361 This option applies when an embedded Perl interpreter is linked with Exim (see
4362 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4363 option, forcing the starting of the interpreter to occur as soon as Exim is
4364 started.
4365
4366 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4367 .oindex "&%-p%&"
4368 For compatibility with Sendmail, this option is equivalent to
4369 .display
4370 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4371 .endd
4372 It sets the incoming protocol and host name (for trusted callers). The
4373 host name and its colon can be omitted when only the protocol is to be set.
4374 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4375 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4376 or &`s`& using this option (but that does not seem a real limitation).
4377 Repeated use of this option is not supported.
4378
4379 .vitem &%-q%&
4380 .oindex "&%-q%&"
4381 .cindex "queue runner" "starting manually"
4382 This option is normally restricted to admin users. However, there is a
4383 configuration option called &%prod_requires_admin%& which can be set false to
4384 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4385 and &%-S%& options).
4386
4387 .cindex "queue runner" "description of operation"
4388 If other commandline options do not specify an action,
4389 the &%-q%& option starts one queue runner process. This scans the queue of
4390 waiting messages, and runs a delivery process for each one in turn. It waits
4391 for each delivery process to finish before starting the next one. A delivery
4392 process may not actually do any deliveries if the retry times for the addresses
4393 have not been reached. Use &%-qf%& (see below) if you want to override this.
4394
4395 If
4396 .cindex "SMTP" "passed connection"
4397 .cindex "SMTP" "multiple deliveries"
4398 .cindex "multiple SMTP deliveries"
4399 the delivery process spawns other processes to deliver other messages down
4400 passed SMTP connections, the queue runner waits for these to finish before
4401 proceeding.
4402
4403 When all the queued messages have been considered, the original queue runner
4404 process terminates. In other words, a single pass is made over the waiting
4405 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4406 this to be repeated periodically.
4407
4408 Exim processes the waiting messages in an unpredictable order. It isn't very
4409 random, but it is likely to be different each time, which is all that matters.
4410 If one particular message screws up a remote MTA, other messages to the same
4411 MTA have a chance of getting through if they get tried first.
4412
4413 It is possible to cause the messages to be processed in lexical message id
4414 order, which is essentially the order in which they arrived, by setting the
4415 &%queue_run_in_order%& option, but this is not recommended for normal use.
4416
4417 .vitem &%-q%&<&'qflags'&>
4418 The &%-q%& option may be followed by one or more flag letters that change its
4419 behaviour. They are all optional, but if more than one is present, they must
4420 appear in the correct order. Each flag is described in a separate item below.
4421
4422 .vitem &%-qq...%&
4423 .oindex "&%-qq%&"
4424 .cindex "queue" "double scanning"
4425 .cindex "queue" "routing"
4426 .cindex "routing" "whole queue before delivery"
4427 An option starting with &%-qq%& requests a two-stage queue run. In the first
4428 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4429 every domain. Addresses are routed, local deliveries happen, but no remote
4430 transports are run.
4431
4432 .cindex "hints database" "remembering routing"
4433 The hints database that remembers which messages are waiting for specific hosts
4434 is updated, as if delivery to those hosts had been deferred. After this is
4435 complete, a second, normal queue scan happens, with routing and delivery taking
4436 place as normal. Messages that are routed to the same host should mostly be
4437 delivered down a single SMTP
4438 .cindex "SMTP" "passed connection"
4439 .cindex "SMTP" "multiple deliveries"
4440 .cindex "multiple SMTP deliveries"
4441 connection because of the hints that were set up during the first queue scan.
4442 This option may be useful for hosts that are connected to the Internet
4443 intermittently.
4444
4445 .vitem &%-q[q]i...%&
4446 .oindex "&%-qi%&"
4447 .cindex "queue" "initial delivery"
4448 If the &'i'& flag is present, the queue runner runs delivery processes only for
4449 those messages that haven't previously been tried. (&'i'& stands for &"initial
4450 delivery"&.) This can be helpful if you are putting messages on the queue using
4451 &%-odq%& and want a queue runner just to process the new messages.
4452
4453 .vitem &%-q[q][i]f...%&
4454 .oindex "&%-qf%&"
4455 .cindex "queue" "forcing delivery"
4456 .cindex "delivery" "forcing in queue run"
4457 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4458 message, whereas without &'f'& only those non-frozen addresses that have passed
4459 their retry times are tried.
4460
4461 .vitem &%-q[q][i]ff...%&
4462 .oindex "&%-qff%&"
4463 .cindex "frozen messages" "forcing delivery"
4464 If &'ff'& is present, a delivery attempt is forced for every message, whether
4465 frozen or not.
4466
4467 .vitem &%-q[q][i][f[f]]l%&
4468 .oindex "&%-ql%&"
4469 .cindex "queue" "local deliveries only"
4470 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4471 be done. If a message requires any remote deliveries, it remains on the queue
4472 for later delivery.
4473
4474 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4475 .oindex "&%-qG%&"
4476 .cindex queue named
4477 .cindex "named queues"
4478 .cindex "queue" "delivering specific messages"
4479 If the &'G'& flag and a name is present, the queue runner operates on the
4480 queue with the given name rather than the default queue.
4481 The name should not contain a &'/'& character.
4482 For a periodic queue run (see below)
4483 append to the name a slash and a time value.
4484
4485 If other commandline options specify an action, a &'-qG<name>'& option
4486 will specify a queue to operate on.
4487 For example:
4488 .code
4489 exim -bp -qGquarantine
4490 mailq -qGquarantine
4491 exim -qGoffpeak -Rf @special.domain.example
4492 .endd
4493
4494 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4495 When scanning the queue, Exim can be made to skip over messages whose ids are
4496 lexically less than a given value by following the &%-q%& option with a
4497 starting message id. For example:
4498 .code
4499 exim -q 0t5C6f-0000c8-00
4500 .endd
4501 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4502 second message id is given, messages whose ids are lexically greater than it
4503 are also skipped. If the same id is given twice, for example,
4504 .code
4505 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4506 .endd
4507 just one delivery process is started, for that message. This differs from
4508 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4509 that it counts as a delivery from a queue run. Note that the selection
4510 mechanism does not affect the order in which the messages are scanned. There
4511 are also other ways of selecting specific sets of messages for delivery in a
4512 queue run &-- see &%-R%& and &%-S%&.
4513
4514 .vitem &%-q%&<&'qflags'&><&'time'&>
4515 .cindex "queue runner" "starting periodically"
4516 .cindex "periodic queue running"
4517 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4518 starting a queue runner process at intervals specified by the given time value
4519 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4520 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4521 single daemon process handles both functions. A common way of starting up a
4522 combined daemon at system boot time is to use a command such as
4523 .code
4524 /usr/exim/bin/exim -bd -q30m
4525 .endd
4526 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4527 process every 30 minutes.
4528
4529 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4530 pid file is written unless one is explicitly requested by the &%-oP%& option.
4531
4532 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4533 .oindex "&%-qR%&"
4534 This option is synonymous with &%-R%&. It is provided for Sendmail
4535 compatibility.
4536
4537 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4538 .oindex "&%-qS%&"
4539 This option is synonymous with &%-S%&.
4540
4541 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4542 .oindex "&%-R%&"
4543 .cindex "queue runner" "for specific recipients"
4544 .cindex "delivery" "to given domain"
4545 .cindex "domain" "delivery to"
4546 The <&'rsflags'&> may be empty, in which case the white space before the string
4547 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4548 which are the possible values for <&'rsflags'&>. White space is required if
4549 <&'rsflags'&> is not empty.
4550
4551 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4552 perform a single queue run, except that, when scanning the messages on the
4553 queue, Exim processes only those that have at least one undelivered recipient
4554 address containing the given string, which is checked in a case-independent
4555 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4556 regular expression; otherwise it is a literal string.
4557
4558 If you want to do periodic queue runs for messages with specific recipients,
4559 you can combine &%-R%& with &%-q%& and a time value. For example:
4560 .code
4561 exim -q25m -R @special.domain.example
4562 .endd
4563 This example does a queue run for messages with recipients in the given domain
4564 every 25 minutes. Any additional flags that are specified with &%-q%& are
4565 applied to each queue run.
4566
4567 Once a message is selected for delivery by this mechanism, all its addresses
4568 are processed. For the first selected message, Exim overrides any retry
4569 information and forces a delivery attempt for each undelivered address. This
4570 means that if delivery of any address in the first message is successful, any
4571 existing retry information is deleted, and so delivery attempts for that
4572 address in subsequently selected messages (which are processed without forcing)
4573 will run. However, if delivery of any address does not succeed, the retry
4574 information is updated, and in subsequently selected messages, the failing
4575 address will be skipped.
4576
4577 .cindex "frozen messages" "forcing delivery"
4578 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4579 all selected messages, not just the first; frozen messages are included when
4580 &'ff'& is present.
4581
4582 The &%-R%& option makes it straightforward to initiate delivery of all messages
4583 to a given domain after a host has been down for some time. When the SMTP
4584 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4585 effect is to run Exim with the &%-R%& option, but it can be configured to run
4586 an arbitrary command instead.
4587
4588 .vitem &%-r%&
4589 .oindex "&%-r%&"
4590 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4591
4592 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4593 .oindex "&%-S%&"
4594 .cindex "delivery" "from given sender"
4595 .cindex "queue runner" "for specific senders"
4596 This option acts like &%-R%& except that it checks the string against each
4597 message's sender instead of against the recipients. If &%-R%& is also set, both
4598 conditions must be met for a message to be selected. If either of the options
4599 has &'f'& or &'ff'& in its flags, the associated action is taken.
4600
4601 .vitem &%-Tqt%&&~<&'times'&>
4602 .oindex "&%-Tqt%&"
4603 This is an option that is exclusively for use by the Exim testing suite. It is not
4604 recognized when Exim is run normally. It allows for the setting up of explicit
4605 &"queue times"& so that various warning/retry features can be tested.
4606
4607 .vitem &%-t%&
4608 .oindex "&%-t%&"
4609 .cindex "recipient" "extracting from header lines"
4610 .cindex "&'Bcc:'& header line"
4611 .cindex "&'Cc:'& header line"
4612 .cindex "&'To:'& header line"
4613 When Exim is receiving a locally-generated, non-SMTP message on its standard
4614 input, the &%-t%& option causes the recipients of the message to be obtained
4615 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4616 from the command arguments. The addresses are extracted before any rewriting
4617 takes place and the &'Bcc:'& header line, if present, is then removed.
4618
4619 .cindex "Sendmail compatibility" "&%-t%& option"
4620 If the command has any arguments, they specify addresses to which the message
4621 is &'not'& to be delivered. That is, the argument addresses are removed from
4622 the recipients list obtained from the headers. This is compatible with Smail 3
4623 and in accordance with the documented behaviour of several versions of
4624 Sendmail, as described in man pages on a number of operating systems (e.g.
4625 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4626 argument addresses to those obtained from the headers, and the O'Reilly
4627 Sendmail book documents it that way. Exim can be made to add argument addresses
4628 instead of subtracting them by setting the option
4629 &%extract_addresses_remove_arguments%& false.
4630
4631 .cindex "&%Resent-%& header lines" "with &%-t%&"
4632 If there are any &%Resent-%& header lines in the message, Exim extracts
4633 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4634 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4635 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4636 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4637
4638 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4639 message is resent several times). The RFC also specifies that they should be
4640 added at the front of the message, and separated by &'Received:'& lines. It is
4641 not at all clear how &%-t%& should operate in the present of multiple sets,
4642 nor indeed exactly what constitutes a &"set"&.
4643 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4644 are often added at the end of the header, and if a message is resent more than
4645 once, it is common for the original set of &%Resent-%& headers to be renamed as
4646 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4647
4648 .vitem &%-ti%&
4649 .oindex "&%-ti%&"
4650 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4651 compatibility with Sendmail.
4652
4653 .vitem &%-tls-on-connect%&
4654 .oindex "&%-tls-on-connect%&"
4655 .cindex "TLS" "use without STARTTLS"
4656 .cindex "TLS" "automatic start"
4657 This option is available when Exim is compiled with TLS support. It forces all
4658 incoming SMTP connections to behave as if the incoming port is listed in the
4659 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4660 &<<CHAPTLS>>& for further details.
4661
4662
4663 .vitem &%-U%&
4664 .oindex "&%-U%&"
4665 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4666 Sendmail uses this option for &"initial message submission"&, and its
4667 documentation states that in future releases, it may complain about
4668 syntactically invalid messages rather than fixing them when this flag is not
4669 set. Exim ignores this option.
4670
4671 .vitem &%-v%&
4672 .oindex "&%-v%&"
4673 This option causes Exim to write information to the standard error stream,
4674 describing what it is doing. In particular, it shows the log lines for
4675 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4676 dialogue is shown. Some of the log lines shown may not actually be written to
4677 the log if the setting of &%log_selector%& discards them. Any relevant
4678 selectors are shown with each log line. If none are shown, the logging is
4679 unconditional.
4680
4681 .vitem &%-x%&
4682 .oindex "&%-x%&"
4683 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4684 National Language Support extended characters in the body of the mail item"&).
4685 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4686 this option.
4687
4688 .vitem &%-X%&&~<&'logfile'&>
4689 .oindex "&%-X%&"
4690 This option is interpreted by Sendmail to cause debug information to be sent
4691 to the named file.  It is ignored by Exim.
4692
4693 .vitem &%-z%&&~<&'log-line'&>
4694 .oindex "&%-z%&"
4695 This option writes its argument to Exim's logfile.
4696 Use is restricted to administrators; the intent is for operational notes.
4697 Quotes should be used to maintain a multi-word item as a single argument,
4698 under most shells.
4699 .endlist
4700
4701 .ecindex IIDclo1
4702 .ecindex IIDclo2
4703
4704
4705 . ////////////////////////////////////////////////////////////////////////////
4706 . Insert a stylized DocBook comment here, to identify the end of the command
4707 . line options. This is for the benefit of the Perl script that automatically
4708 . creates a man page for the options.
4709 . ////////////////////////////////////////////////////////////////////////////
4710
4711 .literal xml
4712 <!-- === End of command line options === -->
4713 .literal off
4714
4715
4716
4717
4718
4719 . ////////////////////////////////////////////////////////////////////////////
4720 . ////////////////////////////////////////////////////////////////////////////
4721
4722
4723 .chapter "The Exim run time configuration file" "CHAPconf" &&&
4724          "The runtime configuration file"
4725
4726 .cindex "run time configuration"
4727 .cindex "configuration file" "general description"
4728 .cindex "CONFIGURE_FILE"
4729 .cindex "configuration file" "errors in"
4730 .cindex "error" "in configuration file"
4731 .cindex "return code" "for bad configuration"
4732 Exim uses a single run time configuration file that is read whenever an Exim
4733 binary is executed. Note that in normal operation, this happens frequently,
4734 because Exim is designed to operate in a distributed manner, without central
4735 control.
4736
4737 If a syntax error is detected while reading the configuration file, Exim
4738 writes a message on the standard error, and exits with a non-zero return code.
4739 The message is also written to the panic log. &*Note*&: Only simple syntax
4740 errors can be detected at this time. The values of any expanded options are
4741 not checked until the expansion happens, even when the expansion does not
4742 actually alter the string.
4743
4744 The name of the configuration file is compiled into the binary for security
4745 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4746 most configurations, this specifies a single file. However, it is permitted to
4747 give a colon-separated list of file names, in which case Exim uses the first
4748 existing file in the list.
4749
4750 .cindex "EXIM_USER"
4751 .cindex "EXIM_GROUP"
4752 .cindex "CONFIGURE_OWNER"
4753 .cindex "CONFIGURE_GROUP"
4754 .cindex "configuration file" "ownership"
4755 .cindex "ownership" "configuration file"
4756 The run time configuration file must be owned by root or by the user that is
4757 specified at compile time by the CONFIGURE_OWNER option (if set). The
4758 configuration file must not be world-writeable, or group-writeable unless its
4759 group is the root group or the one specified at compile time by the
4760 CONFIGURE_GROUP option.
4761
4762 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4763 to root, anybody who is able to edit the run time configuration file has an
4764 easy way to run commands as root. If you specify a user or group in the
4765 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4766 who are members of that group will trivially be able to obtain root privileges.
4767
4768 Up to Exim version 4.72, the run time configuration file was also permitted to
4769 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4770 since it offered a simple privilege escalation for any attacker who managed to
4771 compromise the Exim user account.
4772
4773 A default configuration file, which will work correctly in simple situations,
4774 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4775 defines just one file name, the installation process copies the default
4776 configuration to a new file of that name if it did not previously exist. If
4777 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4778 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4779 configuration.
4780
4781
4782
4783 .section "Using a different configuration file" "SECID40"
4784 .cindex "configuration file" "alternate"
4785 A one-off alternate configuration can be specified by the &%-C%& command line
4786 option, which may specify a single file or a list of files. However, when
4787 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4788 unless the argument for &%-C%& is identical to the built-in value from
4789 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4790 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4791 is useful mainly for checking the syntax of configuration files before
4792 installing them. No owner or group checks are done on a configuration file
4793 specified by &%-C%&, if root privilege has been dropped.
4794
4795 Even the Exim user is not trusted to specify an arbitrary configuration file
4796 with the &%-C%& option to be used with root privileges, unless that file is
4797 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4798 testing a configuration using &%-C%& right through message reception and
4799 delivery, even if the caller is root. The reception works, but by that time,
4800 Exim is running as the Exim user, so when it re-execs to regain privilege for
4801 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4802 can test reception and delivery using two separate commands (one to put a
4803 message on the queue, using &%-odq%&, and another to do the delivery, using
4804 &%-M%&).
4805
4806 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4807 prefix string with which any file named in a &%-C%& command line option must
4808 start. In addition, the file name must not contain the sequence &"&`/../`&"&.
4809 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any file
4810 name can be used with &%-C%&.
4811
4812 One-off changes to a configuration can be specified by the &%-D%& command line
4813 option, which defines and overrides values for macros used inside the
4814 configuration file. However, like &%-C%&, the use of this option by a
4815 non-privileged user causes Exim to discard its root privilege.
4816 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4817 completely disabled, and its use causes an immediate error exit.
4818
4819 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4820 to declare certain macro names trusted, such that root privilege will not
4821 necessarily be discarded.
4822 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4823 considered safe and, if &%-D%& only supplies macros from this list, and the
4824 values are acceptable, then Exim will not give up root privilege if the caller
4825 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4826 transition mechanism and is expected to be removed in the future.  Acceptable
4827 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4828
4829 Some sites may wish to use the same Exim binary on different machines that
4830 share a file system, but to use different configuration files on each machine.
4831 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4832 looks for a file whose name is the configuration file name followed by a dot
4833 and the machine's node name, as obtained from the &[uname()]& function. If this
4834 file does not exist, the standard name is tried. This processing occurs for
4835 each file name in the list given by CONFIGURE_FILE or &%-C%&.
4836
4837 In some esoteric situations different versions of Exim may be run under
4838 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4839 help with this. See the comments in &_src/EDITME_& for details.
4840
4841
4842
4843 .section "Configuration file format" "SECTconffilfor"
4844 .cindex "configuration file" "format of"
4845 .cindex "format" "configuration file"
4846 Exim's configuration file is divided into a number of different parts. General
4847 option settings must always appear at the start of the file. The other parts
4848 are all optional, and may appear in any order. Each part other than the first
4849 is introduced by the word &"begin"& followed by at least one literal
4850 space, and the name of the part. The optional parts are:
4851
4852 .ilist
4853 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4854 &<<CHAPACL>>&).
4855 .next
4856 .cindex "AUTH" "configuration"
4857 &'authenticators'&: Configuration settings for the authenticator drivers. These
4858 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4859 .next
4860 &'routers'&: Configuration settings for the router drivers. Routers process
4861 addresses and determine how the message is to be delivered (see chapters
4862 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4863 .next
4864 &'transports'&: Configuration settings for the transport drivers. Transports
4865 define mechanisms for copying messages to destinations (see chapters
4866 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4867 .next
4868 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4869 If there is no retry section, or if it is empty (that is, no retry rules are
4870 defined), Exim will not retry deliveries. In this situation, temporary errors
4871 are treated the same as permanent errors. Retry rules are discussed in chapter
4872 &<<CHAPretry>>&.
4873 .next
4874 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4875 when new addresses are generated during delivery. Rewriting is discussed in
4876 chapter &<<CHAPrewrite>>&.
4877 .next
4878 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4879 want to use this feature, you must set
4880 .code
4881 LOCAL_SCAN_HAS_OPTIONS=yes
4882 .endd
4883 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4884 facility are given in chapter &<<CHAPlocalscan>>&.
4885 .endlist
4886
4887 .cindex "configuration file" "leading white space in"
4888 .cindex "configuration file" "trailing white space in"
4889 .cindex "white space" "in configuration file"
4890 Leading and trailing white space in configuration lines is always ignored.
4891
4892 Blank lines in the file, and lines starting with a # character (ignoring
4893 leading white space) are treated as comments and are ignored. &*Note*&: A
4894 # character other than at the beginning of a line is not treated specially,
4895 and does not introduce a comment.
4896
4897 Any non-comment line can be continued by ending it with a backslash. Note that
4898 the general rule for white space means that trailing white space after the
4899 backslash and leading white space at the start of continuation
4900 lines is ignored. Comment lines beginning with # (but not empty lines) may
4901 appear in the middle of a sequence of continuation lines.
4902
4903 A convenient way to create a configuration file is to start from the
4904 default, which is supplied in &_src/configure.default_&, and add, delete, or
4905 change settings as required.
4906
4907 The ACLs, retry rules, and rewriting rules have their own syntax which is
4908 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4909 respectively. The other parts of the configuration file have some syntactic
4910 items in common, and these are described below, from section &<<SECTcos>>&
4911 onwards. Before that, the inclusion, macro, and conditional facilities are
4912 described.
4913
4914
4915
4916 .section "File inclusions in the configuration file" "SECID41"
4917 .cindex "inclusions in configuration file"
4918 .cindex "configuration file" "including other files"
4919 .cindex "&`.include`& in configuration file"
4920 .cindex "&`.include_if_exists`& in configuration file"
4921 You can include other files inside Exim's run time configuration file by
4922 using this syntax:
4923 .display
4924 &`.include`& <&'file name'&>
4925 &`.include_if_exists`& <&'file name'&>
4926 .endd
4927 on a line by itself. Double quotes round the file name are optional. If you use
4928 the first form, a configuration error occurs if the file does not exist; the
4929 second form does nothing for non-existent files.
4930 The first form allows a relative name. It is resolved relative to
4931 the directory of the including file. For the second form an absolute file
4932 name is required.
4933
4934 Includes may be nested to any depth, but remember that Exim reads its
4935 configuration file often, so it is a good idea to keep them to a minimum.
4936 If you change the contents of an included file, you must HUP the daemon,
4937 because an included file is read only when the configuration itself is read.
4938
4939 The processing of inclusions happens early, at a physical line level, so, like
4940 comment lines, an inclusion can be used in the middle of an option setting,
4941 for example:
4942 .code
4943 hosts_lookup = a.b.c \
4944                .include /some/file
4945 .endd
4946 Include processing happens after macro processing (see below). Its effect is to
4947 process the lines of the included file as if they occurred inline where the
4948 inclusion appears.
4949
4950
4951
4952 .section "Macros in the configuration file" "SECTmacrodefs"
4953 .cindex "macro" "description of"
4954 .cindex "configuration file" "macros"
4955 If a line in the main part of the configuration (that is, before the first
4956 &"begin"& line) begins with an upper case letter, it is taken as a macro
4957 definition, and must be of the form
4958 .display
4959 <&'name'&> = <&'rest of line'&>
4960 .endd
4961 The name must consist of letters, digits, and underscores, and need not all be
4962 in upper case, though that is recommended. The rest of the line, including any
4963 continuations, is the replacement text, and has leading and trailing white
4964 space removed. Quotes are not removed. The replacement text can never end with
4965 a backslash character, but this doesn't seem to be a serious limitation.
4966
4967 Macros may also be defined between router, transport, authenticator, or ACL
4968 definitions. They may not, however, be defined within an individual driver or
4969 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
4970
4971 .section "Macro substitution" "SECID42"
4972 Once a macro is defined, all subsequent lines in the file (and any included
4973 files) are scanned for the macro name; if there are several macros, the line is
4974 scanned for each in turn, in the order in which the macros are defined. The
4975 replacement text is not re-scanned for the current macro, though it is scanned
4976 for subsequently defined macros. For this reason, a macro name may not contain
4977 the name of a previously defined macro as a substring. You could, for example,
4978 define
4979 .display
4980 &`ABCD_XYZ = `&<&'something'&>
4981 &`ABCD = `&<&'something else'&>
4982 .endd
4983 but putting the definitions in the opposite order would provoke a configuration
4984 error. Macro expansion is applied to individual physical lines from the file,
4985 before checking for line continuation or file inclusion (see above). If a line
4986 consists solely of a macro name, and the expansion of the macro is empty, the
4987 line is ignored. A macro at the start of a line may turn the line into a
4988 comment line or a &`.include`& line.
4989
4990
4991 .section "Redefining macros" "SECID43"
4992 Once defined, the value of a macro can be redefined later in the configuration
4993 (or in an included file). Redefinition is specified by using &'=='& instead of
4994 &'='&. For example:
4995 .code
4996 MAC =  initial value
4997 ...
4998 MAC == updated value
4999 .endd
5000 Redefinition does not alter the order in which the macros are applied to the
5001 subsequent lines of the configuration file. It is still the same order in which
5002 the macros were originally defined. All that changes is the macro's value.
5003 Redefinition makes it possible to accumulate values. For example:
5004 .code
5005 MAC =  initial value
5006 ...
5007 MAC == MAC and something added
5008 .endd
5009 This can be helpful in situations where the configuration file is built
5010 from a number of other files.
5011
5012 .section "Overriding macro values" "SECID44"
5013 The values set for macros in the configuration file can be overridden by the
5014 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5015 used, unless called by root or the Exim user. A definition on the command line
5016 using the &%-D%& option causes all definitions and redefinitions within the
5017 file to be ignored.
5018
5019
5020
5021 .section "Example of macro usage" "SECID45"
5022 As an example of macro usage, consider a configuration where aliases are looked
5023 up in a MySQL database. It helps to keep the file less cluttered if long
5024 strings such as SQL statements are defined separately as macros, for example:
5025 .code
5026 ALIAS_QUERY = select mailbox from user where \
5027               login='${quote_mysql:$local_part}';
5028 .endd
5029 This can then be used in a &(redirect)& router setting like this:
5030 .code
5031 data = ${lookup mysql{ALIAS_QUERY}}
5032 .endd
5033 In earlier versions of Exim macros were sometimes used for domain, host, or
5034 address lists. In Exim 4 these are handled better by named lists &-- see
5035 section &<<SECTnamedlists>>&.
5036
5037
5038 .section "Builtin macros" "SECTbuiltinmacros"
5039 Exim defines some macros depending on facilities available, which may
5040 differ due to build-time definitions and from one release to another.
5041 All of these macros start with an underscore.
5042 They can be used to conditionally include parts of a configuration
5043 (see below).
5044
5045 The following classes of macros are defined:
5046 .display
5047 &` _HAVE_*                    `&  build-time defines
5048 &` _DRIVER_ROUTER_*           `&  router drivers
5049 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5050 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5051 &` _OPT_MAIN_*                `&  main config options
5052 &` _OPT_ROUTERS_*             `&  generic router options
5053 &` _OPT_TRANSPORTS_*          `&  generic transport options
5054 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5055 &` _OPT_ROUTER_*_*            `&  private router options
5056 &` _OPT_TRANSPORT_*_*         `&  private transport options
5057 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5058 .endd
5059
5060 Use an &"exim -bP macros"& command to get the list of macros.
5061
5062
5063 .section "Conditional skips in the configuration file" "SECID46"
5064 .cindex "configuration file" "conditional skips"
5065 .cindex "&`.ifdef`&"
5066 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5067 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5068 portions of the configuration file. The processing happens whenever the file is
5069 read (that is, when an Exim binary starts to run).
5070
5071 The implementation is very simple. Instances of the first four directives must
5072 be followed by text that includes the names of one or macros. The condition
5073 that is tested is whether or not any macro substitution has taken place in the
5074 line. Thus:
5075 .code
5076 .ifdef AAA
5077 message_size_limit = 50M
5078 .else
5079 message_size_limit = 100M
5080 .endif
5081 .endd
5082 sets a message size limit of 50M if the macro &`AAA`& is defined
5083 (or &`A`& or &`AA`&), and 100M
5084 otherwise. If there is more than one macro named on the line, the condition
5085 is true if any of them are defined. That is, it is an &"or"& condition. To
5086 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5087
5088 Although you can use a macro expansion to generate one of these directives,
5089 it is not very useful, because the condition &"there was a macro substitution
5090 in this line"& will always be true.
5091
5092 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5093 to clarify complicated nestings.
5094
5095
5096
5097 .section "Common option syntax" "SECTcos"
5098 .cindex "common option syntax"
5099 .cindex "syntax of common options"
5100 .cindex "configuration file" "common option syntax"
5101 For the main set of options, driver options, and &[local_scan()]& options,
5102 each setting is on a line by itself, and starts with a name consisting of
5103 lower-case letters and underscores. Many options require a data value, and in
5104 these cases the name must be followed by an equals sign (with optional white
5105 space) and then the value. For example:
5106 .code
5107 qualify_domain = mydomain.example.com
5108 .endd
5109 .cindex "hiding configuration option values"
5110 .cindex "configuration options" "hiding value of"
5111 .cindex "options" "hiding value of"
5112 Some option settings may contain sensitive data, for example, passwords for
5113 accessing databases. To stop non-admin users from using the &%-bP%& command
5114 line option to read these values, you can precede the option settings with the
5115 word &"hide"&. For example:
5116 .code
5117 hide mysql_servers = localhost/users/admin/secret-password
5118 .endd
5119 For non-admin users, such options are displayed like this:
5120 .code
5121 mysql_servers = <value not displayable>
5122 .endd
5123 If &"hide"& is used on a driver option, it hides the value of that option on
5124 all instances of the same driver.
5125
5126 The following sections describe the syntax used for the different data types
5127 that are found in option settings.
5128
5129
5130 .section "Boolean options" "SECID47"
5131 .cindex "format" "boolean"
5132 .cindex "boolean configuration values"
5133 .oindex "&%no_%&&'xxx'&"
5134 .oindex "&%not_%&&'xxx'&"
5135 Options whose type is given as boolean are on/off switches. There are two
5136 different ways of specifying such options: with and without a data value. If
5137 the option name is specified on its own without data, the switch is turned on;
5138 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5139 boolean options may be followed by an equals sign and one of the words
5140 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5141 the following two settings have exactly the same effect:
5142 .code
5143 queue_only
5144 queue_only = true
5145 .endd
5146 The following two lines also have the same (opposite) effect:
5147 .code
5148 no_queue_only
5149 queue_only = false
5150 .endd
5151 You can use whichever syntax you prefer.
5152
5153
5154
5155
5156 .section "Integer values" "SECID48"
5157 .cindex "integer configuration values"
5158 .cindex "format" "integer"
5159 If an option's type is given as &"integer"&, the value can be given in decimal,
5160 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5161 number is assumed. Otherwise, it is treated as an octal number unless it starts
5162 with the characters &"0x"&, in which case the remainder is interpreted as a
5163 hexadecimal number.
5164
5165 If an integer value is followed by the letter K, it is multiplied by 1024; if
5166 it is followed by the letter M, it is multiplied by 1024x1024;
5167 if by the letter G, 1024x1024x1024.
5168 When the values
5169 of integer option settings are output, values which are an exact multiple of
5170 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5171 and M. The printing style is independent of the actual input format that was
5172 used.
5173
5174
5175 .section "Octal integer values" "SECID49"
5176 .cindex "integer format"
5177 .cindex "format" "octal integer"
5178 If an option's type is given as &"octal integer"&, its value is always
5179 interpreted as an octal number, whether or not it starts with the digit zero.
5180 Such options are always output in octal.
5181
5182
5183 .section "Fixed point numbers" "SECID50"
5184 .cindex "fixed point configuration values"
5185 .cindex "format" "fixed point"
5186 If an option's type is given as &"fixed-point"&, its value must be a decimal
5187 integer, optionally followed by a decimal point and up to three further digits.
5188
5189
5190
5191 .section "Time intervals" "SECTtimeformat"
5192 .cindex "time interval" "specifying in configuration"
5193 .cindex "format" "time interval"
5194 A time interval is specified as a sequence of numbers, each followed by one of
5195 the following letters, with no intervening white space:
5196
5197 .table2 30pt
5198 .irow &%s%& seconds
5199 .irow &%m%& minutes
5200 .irow &%h%& hours
5201 .irow &%d%& days
5202 .irow &%w%& weeks
5203 .endtable
5204
5205 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5206 intervals are output in the same format. Exim does not restrict the values; it
5207 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5208
5209
5210
5211 .section "String values" "SECTstrings"
5212 .cindex "string" "format of configuration values"
5213 .cindex "format" "string"
5214 If an option's type is specified as &"string"&, the value can be specified with
5215 or without double-quotes. If it does not start with a double-quote, the value
5216 consists of the remainder of the line plus any continuation lines, starting at
5217 the first character after any leading white space, with trailing white space
5218 removed, and with no interpretation of the characters in the string. Because
5219 Exim removes comment lines (those beginning with #) at an early stage, they can
5220 appear in the middle of a multi-line string. The following two settings are
5221 therefore equivalent:
5222 .code
5223 trusted_users = uucp:mail
5224 trusted_users = uucp:\
5225                 # This comment line is ignored
5226                 mail
5227 .endd
5228 .cindex "string" "quoted"
5229 .cindex "escape characters in quoted strings"
5230 If a string does start with a double-quote, it must end with a closing
5231 double-quote, and any backslash characters other than those used for line
5232 continuation are interpreted as escape characters, as follows:
5233
5234 .table2 100pt
5235 .irow &`\\`&                     "single backslash"
5236 .irow &`\n`&                     "newline"
5237 .irow &`\r`&                     "carriage return"
5238 .irow &`\t`&                     "tab"
5239 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5240 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5241                                    character"
5242 .endtable
5243
5244 If a backslash is followed by some other character, including a double-quote
5245 character, that character replaces the pair.
5246
5247 Quoting is necessary only if you want to make use of the backslash escapes to
5248 insert special characters, or if you need to specify a value with leading or
5249 trailing spaces. These cases are rare, so quoting is almost never needed in
5250 current versions of Exim. In versions of Exim before 3.14, quoting was required
5251 in order to continue lines, so you may come across older configuration files
5252 and examples that apparently quote unnecessarily.
5253
5254
5255 .section "Expanded strings" "SECID51"
5256 .cindex "expansion" "definition of"
5257 Some strings in the configuration file are subjected to &'string expansion'&,
5258 by which means various parts of the string may be changed according to the
5259 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5260 is as just described; in particular, the handling of backslashes in quoted
5261 strings is done as part of the input process, before expansion takes place.
5262 However, backslash is also an escape character for the expander, so any
5263 backslashes that are required for that reason must be doubled if they are
5264 within a quoted configuration string.
5265
5266
5267 .section "User and group names" "SECID52"
5268 .cindex "user name" "format of"
5269 .cindex "format" "user name"
5270 .cindex "groups" "name format"
5271 .cindex "format" "group name"
5272 User and group names are specified as strings, using the syntax described
5273 above, but the strings are interpreted specially. A user or group name must
5274 either consist entirely of digits, or be a name that can be looked up using the
5275 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5276
5277
5278 .section "List construction" "SECTlistconstruct"
5279 .cindex "list" "syntax of in configuration"
5280 .cindex "format" "list item in configuration"
5281 .cindex "string" "list, definition of"
5282 The data for some configuration options is a list of items, with colon as the
5283 default separator. Many of these options are shown with type &"string list"& in
5284 the descriptions later in this document. Others are listed as &"domain list"&,
5285 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5286 are all the same; however, those other than &"string list"& are subject to
5287 particular kinds of interpretation, as described in chapter
5288 &<<CHAPdomhosaddlists>>&.
5289
5290 In all these cases, the entire list is treated as a single string as far as the
5291 input syntax is concerned. The &%trusted_users%& setting in section
5292 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5293 in a list, it must be entered as two colons. Leading and trailing white space
5294 on each item in a list is ignored. This makes it possible to include items that
5295 start with a colon, and in particular, certain forms of IPv6 address. For
5296 example, the list
5297 .code
5298 local_interfaces = 127.0.0.1 : ::::1
5299 .endd
5300 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5301
5302 &*Note*&: Although leading and trailing white space is ignored in individual
5303 list items, it is not ignored when parsing the list. The space after the first
5304 colon in the example above is necessary. If it were not there, the list would
5305 be interpreted as the two items 127.0.0.1:: and 1.
5306
5307 .section "Changing list separators" "SECTlistsepchange"
5308 .cindex "list separator" "changing"
5309 .cindex "IPv6" "addresses in lists"
5310 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5311 introduced to allow the separator character to be changed. If a list begins
5312 with a left angle bracket, followed by any punctuation character, that
5313 character is used instead of colon as the list separator. For example, the list
5314 above can be rewritten to use a semicolon separator like this:
5315 .code
5316 local_interfaces = <; 127.0.0.1 ; ::1
5317 .endd
5318 This facility applies to all lists, with the exception of the list in
5319 &%log_file_path%&. It is recommended that the use of non-colon separators be
5320 confined to circumstances where they really are needed.
5321
5322 .cindex "list separator" "newline as"
5323 .cindex "newline" "as list separator"
5324 It is also possible to use newline and other control characters (those with
5325 code values less than 32, plus DEL) as separators in lists. Such separators
5326 must be provided literally at the time the list is processed. For options that
5327 are string-expanded, you can write the separator using a normal escape
5328 sequence. This will be processed by the expander before the string is
5329 interpreted as a list. For example, if a newline-separated list of domains is
5330 generated by a lookup, you can process it directly by a line such as this:
5331 .code
5332 domains = <\n ${lookup mysql{.....}}
5333 .endd
5334 This avoids having to change the list separator in such data. You are unlikely
5335 to want to use a control character as a separator in an option that is not
5336 expanded, because the value is literal text. However, it can be done by giving
5337 the value in quotes. For example:
5338 .code
5339 local_interfaces = "<\n 127.0.0.1 \n ::1"
5340 .endd
5341 Unlike printing character separators, which can be included in list items by
5342 doubling, it is not possible to include a control character as data when it is
5343 set as the separator. Two such characters in succession are interpreted as
5344 enclosing an empty list item.
5345
5346
5347
5348 .section "Empty items in lists" "SECTempitelis"
5349 .cindex "list" "empty item in"
5350 An empty item at the end of a list is always ignored. In other words, trailing
5351 separator characters are ignored. Thus, the list in
5352 .code
5353 senders = user@domain :
5354 .endd
5355 contains only a single item. If you want to include an empty string as one item
5356 in a list, it must not be the last item. For example, this list contains three
5357 items, the second of which is empty:
5358 .code
5359 senders = user1@domain : : user2@domain
5360 .endd
5361 &*Note*&: There must be white space between the two colons, as otherwise they
5362 are interpreted as representing a single colon data character (and the list
5363 would then contain just one item). If you want to specify a list that contains
5364 just one, empty item, you can do it as in this example:
5365 .code
5366 senders = :
5367 .endd
5368 In this case, the first item is empty, and the second is discarded because it
5369 is at the end of the list.
5370
5371
5372
5373
5374 .section "Format of driver configurations" "SECTfordricon"
5375 .cindex "drivers" "configuration format"
5376 There are separate parts in the configuration for defining routers, transports,
5377 and authenticators. In each part, you are defining a number of driver
5378 instances, each with its own set of options. Each driver instance is defined by
5379 a sequence of lines like this:
5380 .display
5381 <&'instance name'&>:
5382   <&'option'&>
5383   ...
5384   <&'option'&>
5385 .endd
5386 In the following example, the instance name is &(localuser)&, and it is
5387 followed by three options settings:
5388 .code
5389 localuser:
5390   driver = accept
5391   check_local_user
5392   transport = local_delivery
5393 .endd
5394 For each driver instance, you specify which Exim code module it uses &-- by the
5395 setting of the &%driver%& option &-- and (optionally) some configuration
5396 settings. For example, in the case of transports, if you want a transport to
5397 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5398 a local file you would use the &(appendfile)& driver. Each of the drivers is
5399 described in detail in its own separate chapter later in this manual.
5400
5401 You can have several routers, transports, or authenticators that are based on
5402 the same underlying driver (each must have a different instance name).
5403
5404 The order in which routers are defined is important, because addresses are
5405 passed to individual routers one by one, in order. The order in which
5406 transports are defined does not matter at all. The order in which
5407 authenticators are defined is used only when Exim, as a client, is searching
5408 them to find one that matches an authentication mechanism offered by the
5409 server.
5410
5411 .cindex "generic options"
5412 .cindex "options" "generic &-- definition of"
5413 Within a driver instance definition, there are two kinds of option: &'generic'&
5414 and &'private'&. The generic options are those that apply to all drivers of the
5415 same type (that is, all routers, all transports or all authenticators). The
5416 &%driver%& option is a generic option that must appear in every definition.
5417 .cindex "private options"
5418 The private options are special for each driver, and none need appear, because
5419 they all have default values.
5420
5421 The options may appear in any order, except that the &%driver%& option must
5422 precede any private options, since these depend on the particular driver. For
5423 this reason, it is recommended that &%driver%& always be the first option.
5424
5425 Driver instance names, which are used for reference in log entries and
5426 elsewhere, can be any sequence of letters, digits, and underscores (starting
5427 with a letter) and must be unique among drivers of the same type. A router and
5428 a transport (for example) can each have the same name, but no two router
5429 instances can have the same name. The name of a driver instance should not be
5430 confused with the name of the underlying driver module. For example, the
5431 configuration lines:
5432 .code
5433 remote_smtp:
5434   driver = smtp
5435 .endd
5436 create an instance of the &(smtp)& transport driver whose name is
5437 &(remote_smtp)&. The same driver code can be used more than once, with
5438 different instance names and different option settings each time. A second
5439 instance of the &(smtp)& transport, with different options, might be defined
5440 thus:
5441 .code
5442 special_smtp:
5443   driver = smtp
5444   port = 1234
5445   command_timeout = 10s
5446 .endd
5447 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5448 these transport instances from routers, and these names would appear in log
5449 lines.
5450
5451 Comment lines may be present in the middle of driver specifications. The full
5452 list of option settings for any particular driver instance, including all the
5453 defaulted values, can be extracted by making use of the &%-bP%& command line
5454 option.
5455
5456
5457
5458
5459
5460
5461 . ////////////////////////////////////////////////////////////////////////////
5462 . ////////////////////////////////////////////////////////////////////////////
5463
5464 .chapter "The default configuration file" "CHAPdefconfil"
5465 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5466 .cindex "default" "configuration file &""walk through""&"
5467 The default configuration file supplied with Exim as &_src/configure.default_&
5468 is sufficient for a host with simple mail requirements. As an introduction to
5469 the way Exim is configured, this chapter &"walks through"& the default
5470 configuration, giving brief explanations of the settings. Detailed descriptions
5471 of the options are given in subsequent chapters. The default configuration file
5472 itself contains extensive comments about ways you might want to modify the
5473 initial settings. However, note that there are many options that are not
5474 mentioned at all in the default configuration.
5475
5476
5477
5478 .section "Main configuration settings" "SECTdefconfmain"
5479 The main (global) configuration option settings must always come first in the
5480 file. The first thing you'll see in the file, after some initial comments, is
5481 the line
5482 .code
5483 # primary_hostname =
5484 .endd
5485 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5486 to know the official, fully qualified name of your host, and this is where you
5487 can specify it. However, in most cases you do not need to set this option. When
5488 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5489
5490 The first three non-comment configuration lines are as follows:
5491 .code
5492 domainlist local_domains    = @
5493 domainlist relay_to_domains =
5494 hostlist   relay_from_hosts = 127.0.0.1
5495 .endd
5496 These are not, in fact, option settings. They are definitions of two named
5497 domain lists and one named host list. Exim allows you to give names to lists of
5498 domains, hosts, and email addresses, in order to make it easier to manage the
5499 configuration file (see section &<<SECTnamedlists>>&).
5500
5501 The first line defines a domain list called &'local_domains'&; this is used
5502 later in the configuration to identify domains that are to be delivered
5503 on the local host.
5504
5505 .cindex "@ in a domain list"
5506 There is just one item in this list, the string &"@"&. This is a special form
5507 of entry which means &"the name of the local host"&. Thus, if the local host is
5508 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5509 be delivered locally. Because the local host's name is referenced indirectly,
5510 the same configuration file can be used on different hosts.
5511
5512 The second line defines a domain list called &'relay_to_domains'&, but the
5513 list itself is empty. Later in the configuration we will come to the part that
5514 controls mail relaying through the local host; it allows relaying to any
5515 domains in this list. By default, therefore, no relaying on the basis of a mail
5516 domain is permitted.
5517
5518 The third line defines a host list called &'relay_from_hosts'&. This list is
5519 used later in the configuration to permit relaying from any host or IP address
5520 that matches the list. The default contains just the IP address of the IPv4
5521 loopback interface, which means that processes on the local host are able to
5522 submit mail for relaying by sending it over TCP/IP to that interface. No other
5523 hosts are permitted to submit messages for relaying.
5524
5525 Just to be sure there's no misunderstanding: at this point in the configuration
5526 we aren't actually setting up any controls. We are just defining some domains
5527 and hosts that will be used in the controls that are specified later.
5528
5529 The next two configuration lines are genuine option settings:
5530 .code
5531 acl_smtp_rcpt = acl_check_rcpt
5532 acl_smtp_data = acl_check_data
5533 .endd
5534 These options specify &'Access Control Lists'& (ACLs) that are to be used
5535 during an incoming SMTP session for every recipient of a message (every RCPT
5536 command), and after the contents of the message have been received,
5537 respectively. The names of the lists are &'acl_check_rcpt'& and
5538 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5539 section of the configuration. The RCPT ACL controls which recipients are
5540 accepted for an incoming message &-- if a configuration does not provide an ACL
5541 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5542 contents of a message to be checked.
5543
5544 Two commented-out option settings are next:
5545 .code
5546 # av_scanner = clamd:/tmp/clamd
5547 # spamd_address = 127.0.0.1 783
5548 .endd
5549 These are example settings that can be used when Exim is compiled with the
5550 content-scanning extension. The first specifies the interface to the virus
5551 scanner, and the second specifies the interface to SpamAssassin. Further
5552 details are given in chapter &<<CHAPexiscan>>&.
5553
5554 Three more commented-out option settings follow:
5555 .code
5556 # tls_advertise_hosts = *
5557 # tls_certificate = /etc/ssl/exim.crt
5558 # tls_privatekey = /etc/ssl/exim.pem
5559 .endd
5560 These are example settings that can be used when Exim is compiled with
5561 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5562 first one specifies the list of clients that are allowed to use TLS when
5563 connecting to this server; in this case the wildcard means all clients. The
5564 other options specify where Exim should find its TLS certificate and private
5565 key, which together prove the server's identity to any clients that connect.
5566 More details are given in chapter &<<CHAPTLS>>&.
5567
5568 Another two commented-out option settings follow:
5569 .code
5570 # daemon_smtp_ports = 25 : 465 : 587
5571 # tls_on_connect_ports = 465
5572 .endd
5573 .cindex "port" "465 and 587"
5574 .cindex "port" "for message submission"
5575 .cindex "message" "submission, ports for"
5576 .cindex "ssmtp protocol"
5577 .cindex "smtps protocol"
5578 .cindex "SMTP" "ssmtp protocol"
5579 .cindex "SMTP" "smtps protocol"
5580 These options provide better support for roaming users who wish to use this
5581 server for message submission. They are not much use unless you have turned on
5582 TLS (as described in the previous paragraph) and authentication (about which
5583 more in section &<<SECTdefconfauth>>&). The usual SMTP port 25 is often blocked
5584 on end-user networks, so RFC 4409 specifies that message submission should use
5585 port 587 instead. However some software (notably Microsoft Outlook) cannot be
5586 configured to use port 587 correctly, so these settings also enable the
5587 non-standard &"smtps"& (aka &"ssmtp"&) port 465 (see section
5588 &<<SECTsupobssmt>>&).
5589
5590 Two more commented-out options settings follow:
5591 .code
5592 # qualify_domain =
5593 # qualify_recipient =
5594 .endd
5595 The first of these specifies a domain that Exim uses when it constructs a
5596 complete email address from a local login name. This is often needed when Exim
5597 receives a message from a local process. If you do not set &%qualify_domain%&,
5598 the value of &%primary_hostname%& is used. If you set both of these options,
5599 you can have different qualification domains for sender and recipient
5600 addresses. If you set only the first one, its value is used in both cases.
5601
5602 .cindex "domain literal" "recognizing format"
5603 The following line must be uncommented if you want Exim to recognize
5604 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5605 (an IP address within square brackets) instead of a named domain.
5606 .code
5607 # allow_domain_literals
5608 .endd
5609 The RFCs still require this form, but many people think that in the modern
5610 Internet it makes little sense to permit mail to be sent to specific hosts by
5611 quoting their IP addresses. This ancient format has been used by people who
5612 try to abuse hosts by using them for unwanted relaying. However, some
5613 people believe there are circumstances (for example, messages addressed to
5614 &'postmaster'&) where domain literals are still useful.
5615
5616 The next configuration line is a kind of trigger guard:
5617 .code
5618 never_users = root
5619 .endd
5620 It specifies that no delivery must ever be run as the root user. The normal
5621 convention is to set up &'root'& as an alias for the system administrator. This
5622 setting is a guard against slips in the configuration.
5623 The list of users specified by &%never_users%& is not, however, the complete
5624 list; the build-time configuration in &_Local/Makefile_& has an option called
5625 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5626 contents of &%never_users%& are added to this list. By default
5627 FIXED_NEVER_USERS also specifies root.
5628
5629 When a remote host connects to Exim in order to send mail, the only information
5630 Exim has about the host's identity is its IP address. The next configuration
5631 line,
5632 .code
5633 host_lookup = *
5634 .endd
5635 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5636 in order to get a host name. This improves the quality of the logging
5637 information, but if you feel it is too expensive, you can remove it entirely,
5638 or restrict the lookup to hosts on &"nearby"& networks.
5639 Note that it is not always possible to find a host name from an IP address,
5640 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5641 unreachable.
5642
5643 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5644 1413 (hence their names):
5645 .code
5646 rfc1413_hosts = *
5647 rfc1413_query_timeout = 0s
5648 .endd
5649 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5650 Few hosts offer RFC1413 service these days; calls have to be
5651 terminated by a timeout and this needlessly delays the startup
5652 of an incoming SMTP connection.
5653 If you have hosts for which you trust RFC1413 and need this
5654 information, you can change this.
5655
5656 This line enables an efficiency SMTP option.  It is negotiated by clients
5657 and not expected to cause problems but can be disabled if needed.
5658 .code
5659 prdr_enable = true
5660 .endd
5661
5662 When Exim receives messages over SMTP connections, it expects all addresses to
5663 be fully qualified with a domain, as required by the SMTP definition. However,
5664 if you are running a server to which simple clients submit messages, you may
5665 find that they send unqualified addresses. The two commented-out options:
5666 .code
5667 # sender_unqualified_hosts =
5668 # recipient_unqualified_hosts =
5669 .endd
5670 show how you can specify hosts that are permitted to send unqualified sender
5671 and recipient addresses, respectively.
5672
5673 The &%log_selector%& option is used to increase the detail of logging
5674 over the default:
5675 .code
5676 log_selector = +smtp_protocol_error +smtp_syntax_error \
5677                +tls_certificate_verified
5678 .endd
5679
5680 The &%percent_hack_domains%& option is also commented out:
5681 .code
5682 # percent_hack_domains =
5683 .endd
5684 It provides a list of domains for which the &"percent hack"& is to operate.
5685 This is an almost obsolete form of explicit email routing. If you do not know
5686 anything about it, you can safely ignore this topic.
5687
5688 The next two settings in the main part of the default configuration are
5689 concerned with messages that have been &"frozen"& on Exim's queue. When a
5690 message is frozen, Exim no longer continues to try to deliver it. Freezing
5691 occurs when a bounce message encounters a permanent failure because the sender
5692 address of the original message that caused the bounce is invalid, so the
5693 bounce cannot be delivered. This is probably the most common case, but there
5694 are also other conditions that cause freezing, and frozen messages are not
5695 always bounce messages.
5696 .code
5697 ignore_bounce_errors_after = 2d
5698 timeout_frozen_after = 7d
5699 .endd
5700 The first of these options specifies that failing bounce messages are to be
5701 discarded after 2 days on the queue. The second specifies that any frozen
5702 message (whether a bounce message or not) is to be timed out (and discarded)
5703 after a week. In this configuration, the first setting ensures that no failing
5704 bounce message ever lasts a week.
5705
5706 Exim queues it's messages in a spool directory. If you expect to have
5707 large queues, you may consider using this option. It splits the spool
5708 directory into subdirectories to avoid file system degradation from
5709 many files in a single directory, resulting in better performance.
5710 Manual manipulation of queued messages becomes more complex (though fortunately
5711 not often needed).
5712 .code
5713 # split_spool_directory = true
5714 .endd
5715
5716 In an ideal world everybody follows the standards. For non-ASCII
5717 messages RFC 2047 is a standard, allowing a maximum line length of 76
5718 characters. Exim adheres that standard and won't process messages which
5719 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5720 In particular, the Exim maintainers have had multiple reports of
5721 problems from Russian administrators of issues until they disable this
5722 check, because of some popular, yet buggy, mail composition software.
5723 .code
5724 # check_rfc2047_length = false
5725 .endd
5726
5727 If you need to be strictly RFC compliant you may wish to disable the
5728 8BITMIME advertisement. Use this, if you exchange mails with systems
5729 that are not 8-bit clean.
5730 .code
5731 # accept_8bitmime = false
5732 .endd
5733
5734 Libraries you use may depend on specific environment settings.  This
5735 imposes a security risk (e.g. PATH). There are two lists:
5736 &%keep_environment%& for the variables to import as they are, and
5737 &%add_environment%& for variables we want to set to a fixed value.
5738 Note that TZ is handled separately, by the $%timezone%$ runtime
5739 option and by the TIMEZONE_DEFAULT buildtime option.
5740 .code
5741 # keep_environment = ^LDAP
5742 # add_environment = PATH=/usr/bin::/bin
5743 .endd
5744
5745
5746 .section "ACL configuration" "SECID54"
5747 .cindex "default" "ACLs"
5748 .cindex "&ACL;" "default configuration"
5749 In the default configuration, the ACL section follows the main configuration.
5750 It starts with the line
5751 .code
5752 begin acl
5753 .endd
5754 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5755 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5756 and &%acl_smtp_data%& above.
5757
5758 .cindex "RCPT" "ACL for"
5759 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5760 RCPT command specifies one of the message's recipients. The ACL statements
5761 are considered in order, until the recipient address is either accepted or
5762 rejected. The RCPT command is then accepted or rejected, according to the
5763 result of the ACL processing.
5764 .code
5765 acl_check_rcpt:
5766 .endd
5767 This line, consisting of a name terminated by a colon, marks the start of the
5768 ACL, and names it.
5769 .code
5770 accept  hosts = :
5771 .endd
5772 This ACL statement accepts the recipient if the sending host matches the list.
5773 But what does that strange list mean? It doesn't actually contain any host
5774 names or IP addresses. The presence of the colon puts an empty item in the
5775 list; Exim matches this only if the incoming message did not come from a remote
5776 host, because in that case, the remote hostname is empty. The colon is
5777 important. Without it, the list itself is empty, and can never match anything.
5778
5779 What this statement is doing is to accept unconditionally all recipients in
5780 messages that are submitted by SMTP from local processes using the standard
5781 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5782 manner.
5783 .code
5784 deny    message       = Restricted characters in address
5785         domains       = +local_domains
5786         local_parts   = ^[.] : ^.*[@%!/|]
5787
5788 deny    message       = Restricted characters in address
5789         domains       = !+local_domains
5790         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5791 .endd
5792 These statements are concerned with local parts that contain any of the
5793 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5794 Although these characters are entirely legal in local parts (in the case of
5795 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5796 in Internet mail addresses.
5797
5798 The first three have in the past been associated with explicitly routed
5799 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5800 option). Addresses containing these characters are regularly tried by spammers
5801 in an attempt to bypass relaying restrictions, and also by open relay testing
5802 programs. Unless you really need them it is safest to reject these characters
5803 at this early stage. This configuration is heavy-handed in rejecting these
5804 characters for all messages it accepts from remote hosts. This is a deliberate
5805 policy of being as safe as possible.
5806
5807 The first rule above is stricter, and is applied to messages that are addressed
5808 to one of the local domains handled by this host. This is implemented by the
5809 first condition, which restricts it to domains that are listed in the
5810 &'local_domains'& domain list. The &"+"& character is used to indicate a
5811 reference to a named list. In this configuration, there is just one domain in
5812 &'local_domains'&, but in general there may be many.
5813
5814 The second condition on the first statement uses two regular expressions to
5815 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5816 or &"|"&. If you have local accounts that include these characters, you will
5817 have to modify this rule.
5818
5819 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5820 allows them because they have been encountered in practice. (Consider the
5821 common convention of local parts constructed as
5822 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5823 the author of Exim, who has no second initial.) However, a local part starting
5824 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5825 file name (for example, for a mailing list). This is also true for local parts
5826 that contain slashes. A pipe symbol can also be troublesome if the local part
5827 is incorporated unthinkingly into a shell command line.
5828
5829 The second rule above applies to all other domains, and is less strict. This
5830 allows your own users to send outgoing messages to sites that use slashes
5831 and vertical bars in their local parts. It blocks local parts that begin
5832 with a dot, slash, or vertical bar, but allows these characters within the
5833 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5834 and &"!"& is blocked, as before. The motivation here is to prevent your users
5835 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5836 .code
5837 accept  local_parts   = postmaster
5838         domains       = +local_domains
5839 .endd
5840 This statement, which has two conditions, accepts an incoming address if the
5841 local part is &'postmaster'& and the domain is one of those listed in the
5842 &'local_domains'& domain list. The &"+"& character is used to indicate a
5843 reference to a named list. In this configuration, there is just one domain in
5844 &'local_domains'&, but in general there may be many.
5845
5846 The presence of this statement means that mail to postmaster is never blocked
5847 by any of the subsequent tests. This can be helpful while sorting out problems
5848 in cases where the subsequent tests are incorrectly denying access.
5849 .code
5850 require verify        = sender
5851 .endd
5852 This statement requires the sender address to be verified before any subsequent
5853 ACL statement can be used. If verification fails, the incoming recipient
5854 address is refused. Verification consists of trying to route the address, to
5855 see if a bounce message could be delivered to it. In the case of remote
5856 addresses, basic verification checks only the domain, but &'callouts'& can be
5857 used for more verification if required. Section &<<SECTaddressverification>>&
5858 discusses the details of address verification.
5859 .code
5860 accept  hosts         = +relay_from_hosts
5861         control       = submission
5862 .endd
5863 This statement accepts the address if the message is coming from one of the
5864 hosts that are defined as being allowed to relay through this host. Recipient
5865 verification is omitted here, because in many cases the clients are dumb MUAs
5866 that do not cope well with SMTP error responses. For the same reason, the
5867 second line specifies &"submission mode"& for messages that are accepted. This
5868 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5869 messages that are deficient in some way, for example, because they lack a
5870 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5871 probably add recipient verification here, and disable submission mode.
5872 .code
5873 accept  authenticated = *
5874         control       = submission
5875 .endd
5876 This statement accepts the address if the client host has authenticated itself.
5877 Submission mode is again specified, on the grounds that such messages are most
5878 likely to come from MUAs. The default configuration does not define any
5879 authenticators, though it does include some nearly complete commented-out
5880 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5881 fact authenticate until you complete the authenticator definitions.
5882 .code
5883 require message = relay not permitted
5884         domains = +local_domains : +relay_to_domains
5885 .endd
5886 This statement rejects the address if its domain is neither a local domain nor
5887 one of the domains for which this host is a relay.
5888 .code
5889 require verify = recipient
5890 .endd
5891 This statement requires the recipient address to be verified; if verification
5892 fails, the address is rejected.
5893 .code
5894 # deny    message     = rejected because $sender_host_address \
5895 #                       is in a black list at $dnslist_domain\n\
5896 #                       $dnslist_text
5897 #         dnslists    = black.list.example
5898 #
5899 # warn    dnslists    = black.list.example
5900 #         add_header  = X-Warning: $sender_host_address is in \
5901 #                       a black list at $dnslist_domain
5902 #         log_message = found in $dnslist_domain
5903 .endd
5904 These commented-out lines are examples of how you could configure Exim to check
5905 sending hosts against a DNS black list. The first statement rejects messages
5906 from blacklisted hosts, whereas the second just inserts a warning header
5907 line.
5908 .code
5909 # require verify = csa
5910 .endd
5911 This commented-out line is an example of how you could turn on client SMTP
5912 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5913 records.
5914 .code
5915 accept
5916 .endd
5917 The final statement in the first ACL unconditionally accepts any recipient
5918 address that has successfully passed all the previous tests.
5919 .code
5920 acl_check_data:
5921 .endd
5922 This line marks the start of the second ACL, and names it. Most of the contents
5923 of this ACL are commented out:
5924 .code
5925 # deny    malware   = *
5926 #         message   = This message contains a virus \
5927 #                     ($malware_name).
5928 .endd
5929 These lines are examples of how to arrange for messages to be scanned for
5930 viruses when Exim has been compiled with the content-scanning extension, and a
5931 suitable virus scanner is installed. If the message is found to contain a
5932 virus, it is rejected with the given custom error message.
5933 .code
5934 # warn    spam      = nobody
5935 #         message   = X-Spam_score: $spam_score\n\
5936 #                     X-Spam_score_int: $spam_score_int\n\
5937 #                     X-Spam_bar: $spam_bar\n\
5938 #                     X-Spam_report: $spam_report
5939 .endd
5940 These lines are an example of how to arrange for messages to be scanned by
5941 SpamAssassin when Exim has been compiled with the content-scanning extension,
5942 and SpamAssassin has been installed. The SpamAssassin check is run with
5943 &`nobody`& as its user parameter, and the results are added to the message as a
5944 series of extra header line. In this case, the message is not rejected,
5945 whatever the spam score.
5946 .code
5947 accept
5948 .endd
5949 This final line in the DATA ACL accepts the message unconditionally.
5950
5951
5952 .section "Router configuration" "SECID55"
5953 .cindex "default" "routers"
5954 .cindex "routers" "default"
5955 The router configuration comes next in the default configuration, introduced
5956 by the line
5957 .code
5958 begin routers
5959 .endd
5960 Routers are the modules in Exim that make decisions about where to send
5961 messages. An address is passed to each router in turn, until it is either
5962 accepted, or failed. This means that the order in which you define the routers
5963 matters. Each router is fully described in its own chapter later in this
5964 manual. Here we give only brief overviews.
5965 .code
5966 # domain_literal:
5967 #   driver = ipliteral
5968 #   domains = !+local_domains
5969 #   transport = remote_smtp
5970 .endd
5971 .cindex "domain literal" "default router"
5972 This router is commented out because the majority of sites do not want to
5973 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
5974 you uncomment this router, you also need to uncomment the setting of
5975 &%allow_domain_literals%& in the main part of the configuration.
5976 .code
5977 dnslookup:
5978   driver = dnslookup
5979   domains = ! +local_domains
5980   transport = remote_smtp
5981   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
5982   no_more
5983 .endd
5984 The first uncommented router handles addresses that do not involve any local
5985 domains. This is specified by the line
5986 .code
5987 domains = ! +local_domains
5988 .endd
5989 The &%domains%& option lists the domains to which this router applies, but the
5990 exclamation mark is a negation sign, so the router is used only for domains
5991 that are not in the domain list called &'local_domains'& (which was defined at
5992 the start of the configuration). The plus sign before &'local_domains'&
5993 indicates that it is referring to a named list. Addresses in other domains are
5994 passed on to the following routers.
5995
5996 The name of the router driver is &(dnslookup)&,
5997 and is specified by the &%driver%& option. Do not be confused by the fact that
5998 the name of this router instance is the same as the name of the driver. The
5999 instance name is arbitrary, but the name set in the &%driver%& option must be
6000 one of the driver modules that is in the Exim binary.
6001
6002 The &(dnslookup)& router routes addresses by looking up their domains in the
6003 DNS in order to obtain a list of hosts to which the address is routed. If the
6004 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6005 specified by the &%transport%& option. If the router does not find the domain
6006 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6007 the address fails and is bounced.
6008
6009 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6010 be entirely ignored. This option is present because a number of cases have been
6011 encountered where MX records in the DNS point to host names
6012 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6013 Completely ignoring these IP addresses causes Exim to fail to route the
6014 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6015 continue to try to deliver the message periodically until the address timed
6016 out.
6017 .code
6018 system_aliases:
6019   driver = redirect
6020   allow_fail
6021   allow_defer
6022   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6023 # user = exim
6024   file_transport = address_file
6025   pipe_transport = address_pipe
6026 .endd
6027 Control reaches this and subsequent routers only for addresses in the local
6028 domains. This router checks to see whether the local part is defined as an
6029 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6030 data that it looks up from that file. If no data is found for the local part,
6031 the value of the &%data%& option is empty, causing the address to be passed to
6032 the next router.
6033
6034 &_/etc/aliases_& is a conventional name for the system aliases file that is
6035 often used. That is why it is referenced by from the default configuration
6036 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6037 &_Local/Makefile_& before building Exim.
6038 .code
6039 userforward:
6040   driver = redirect
6041   check_local_user
6042 # local_part_suffix = +* : -*
6043 # local_part_suffix_optional
6044   file = $home/.forward
6045 # allow_filter
6046   no_verify
6047   no_expn
6048   check_ancestor
6049   file_transport = address_file
6050   pipe_transport = address_pipe
6051   reply_transport = address_reply
6052 .endd
6053 This is the most complicated router in the default configuration. It is another
6054 redirection router, but this time it is looking for forwarding data set up by
6055 individual users. The &%check_local_user%& setting specifies a check that the
6056 local part of the address is the login name of a local user. If it is not, the
6057 router is skipped. The two commented options that follow &%check_local_user%&,
6058 namely:
6059 .code
6060 # local_part_suffix = +* : -*
6061 # local_part_suffix_optional
6062 .endd
6063 .vindex "&$local_part_suffix$&"
6064 show how you can specify the recognition of local part suffixes. If the first
6065 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6066 by any sequence of characters, is removed from the local part and placed in the
6067 variable &$local_part_suffix$&. The second suffix option specifies that the
6068 presence of a suffix in the local part is optional. When a suffix is present,
6069 the check for a local login uses the local part with the suffix removed.
6070
6071 When a local user account is found, the file called &_.forward_& in the user's
6072 home directory is consulted. If it does not exist, or is empty, the router
6073 declines. Otherwise, the contents of &_.forward_& are interpreted as
6074 redirection data (see chapter &<<CHAPredirect>>& for more details).
6075
6076 .cindex "Sieve filter" "enabling in default router"
6077 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6078 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6079 is commented out by default), the contents of the file are interpreted as a set
6080 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6081 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6082 separate document entitled &'Exim's interfaces to mail filtering'&.
6083
6084 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6085 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6086 There are two reasons for doing this:
6087
6088 .olist
6089 Whether or not a local user has a &_.forward_& file is not really relevant when
6090 checking an address for validity; it makes sense not to waste resources doing
6091 unnecessary work.
6092 .next
6093 More importantly, when Exim is verifying addresses or handling an EXPN
6094 command during an SMTP session, it is running as the Exim user, not as root.
6095 The group is the Exim group, and no additional groups are set up.
6096 It may therefore not be possible for Exim to read users' &_.forward_& files at
6097 this time.
6098 .endlist
6099
6100 The setting of &%check_ancestor%& prevents the router from generating a new
6101 address that is the same as any previous address that was redirected. (This
6102 works round a problem concerning a bad interaction between aliasing and
6103 forwarding &-- see section &<<SECTredlocmai>>&).
6104
6105 The final three option settings specify the transports that are to be used when
6106 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6107 auto-reply, respectively. For example, if a &_.forward_& file contains
6108 .code
6109 a.nother@elsewhere.example, /home/spqr/archive
6110 .endd
6111 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6112 transport.
6113 .code
6114 localuser:
6115   driver = accept
6116   check_local_user
6117 # local_part_suffix = +* : -*
6118 # local_part_suffix_optional
6119   transport = local_delivery
6120 .endd
6121 The final router sets up delivery into local mailboxes, provided that the local
6122 part is the name of a local login, by accepting the address and assigning it to
6123 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6124 routers, so the address is bounced. The commented suffix settings fulfil the
6125 same purpose as they do for the &(userforward)& router.
6126
6127
6128 .section "Transport configuration" "SECID56"
6129 .cindex "default" "transports"
6130 .cindex "transports" "default"
6131 Transports define mechanisms for actually delivering messages. They operate
6132 only when referenced from routers, so the order in which they are defined does
6133 not matter. The transports section of the configuration starts with
6134 .code
6135 begin transports
6136 .endd
6137 One remote transport and four local transports are defined.
6138 .code
6139 remote_smtp:
6140   driver = smtp
6141   hosts_try_prdr = *
6142 .endd
6143 This transport is used for delivering messages over SMTP connections.
6144 The list of remote hosts comes from the router.
6145 The &%hosts_try_prdr%& option enables an efficiency SMTP option.
6146 It is negotiated between client and server
6147 and not expected to cause problems but can be disabled if needed.
6148 All other options are defaulted.
6149 .code
6150 local_delivery:
6151   driver = appendfile
6152   file = /var/mail/$local_part
6153   delivery_date_add
6154   envelope_to_add
6155   return_path_add
6156 # group = mail
6157 # mode = 0660
6158 .endd
6159 This &(appendfile)& transport is used for local delivery to user mailboxes in
6160 traditional BSD mailbox format. By default it runs under the uid and gid of the
6161 local user, which requires the sticky bit to be set on the &_/var/mail_&
6162 directory. Some systems use the alternative approach of running mail deliveries
6163 under a particular group instead of using the sticky bit. The commented options
6164 show how this can be done.
6165
6166 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6167 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6168 similarly-named options above.
6169 .code
6170 address_pipe:
6171   driver = pipe
6172   return_output
6173 .endd
6174 This transport is used for handling deliveries to pipes that are generated by
6175 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6176 option specifies that any output on stdout or stderr generated by the pipe is to
6177 be returned to the sender.
6178 .code
6179 address_file:
6180   driver = appendfile
6181   delivery_date_add
6182   envelope_to_add
6183   return_path_add
6184 .endd
6185 This transport is used for handling deliveries to files that are generated by
6186 redirection. The name of the file is not specified in this instance of
6187 &(appendfile)&, because it comes from the &(redirect)& router.
6188 .code
6189 address_reply:
6190   driver = autoreply
6191 .endd
6192 This transport is used for handling automatic replies generated by users'
6193 filter files.
6194
6195
6196
6197 .section "Default retry rule" "SECID57"
6198 .cindex "retry" "default rule"
6199 .cindex "default" "retry rule"
6200 The retry section of the configuration file contains rules which affect the way
6201 Exim retries deliveries that cannot be completed at the first attempt. It is
6202 introduced by the line
6203 .code
6204 begin retry
6205 .endd
6206 In the default configuration, there is just one rule, which applies to all
6207 errors:
6208 .code
6209 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6210 .endd
6211 This causes any temporarily failing address to be retried every 15 minutes for
6212 2 hours, then at intervals starting at one hour and increasing by a factor of
6213 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6214 is not delivered after 4 days of temporary failure, it is bounced. The time is
6215 measured from first failure, not from the time the message was received.
6216
6217 If the retry section is removed from the configuration, or is empty (that is,
6218 if no retry rules are defined), Exim will not retry deliveries. This turns
6219 temporary errors into permanent errors.
6220
6221
6222 .section "Rewriting configuration" "SECID58"
6223 The rewriting section of the configuration, introduced by
6224 .code
6225 begin rewrite
6226 .endd
6227 contains rules for rewriting addresses in messages as they arrive. There are no
6228 rewriting rules in the default configuration file.
6229
6230
6231
6232 .section "Authenticators configuration" "SECTdefconfauth"
6233 .cindex "AUTH" "configuration"
6234 The authenticators section of the configuration, introduced by
6235 .code
6236 begin authenticators
6237 .endd
6238 defines mechanisms for the use of the SMTP AUTH command. The default
6239 configuration file contains two commented-out example authenticators
6240 which support plaintext username/password authentication using the
6241 standard PLAIN mechanism and the traditional but non-standard LOGIN
6242 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6243 to support most MUA software.
6244
6245 The example PLAIN authenticator looks like this:
6246 .code
6247 #PLAIN:
6248 #  driver                  = plaintext
6249 #  server_set_id           = $auth2
6250 #  server_prompts          = :
6251 #  server_condition        = Authentication is not yet configured
6252 #  server_advertise_condition = ${if def:tls_in_cipher }
6253 .endd
6254 And the example LOGIN authenticator looks like this:
6255 .code
6256 #LOGIN:
6257 #  driver                  = plaintext
6258 #  server_set_id           = $auth1
6259 #  server_prompts          = <| Username: | Password:
6260 #  server_condition        = Authentication is not yet configured
6261 #  server_advertise_condition = ${if def:tls_in_cipher }
6262 .endd
6263
6264 The &%server_set_id%& option makes Exim remember the authenticated username
6265 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6266 &%server_prompts%& option configures the &(plaintext)& authenticator so
6267 that it implements the details of the specific authentication mechanism,
6268 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6269 when Exim offers authentication to clients; in the examples, this is only
6270 when TLS or SSL has been started, so to enable the authenticators you also
6271 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6272
6273 The &%server_condition%& setting defines how to verify that the username and
6274 password are correct. In the examples it just produces an error message.
6275 To make the authenticators work, you can use a string expansion
6276 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6277
6278 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6279 usercode and password are in different positions.
6280 Chapter &<<CHAPplaintext>>& covers both.
6281
6282 .ecindex IIDconfiwal
6283
6284
6285
6286 . ////////////////////////////////////////////////////////////////////////////
6287 . ////////////////////////////////////////////////////////////////////////////
6288
6289 .chapter "Regular expressions" "CHAPregexp"
6290
6291 .cindex "regular expressions" "library"
6292 .cindex "PCRE"
6293 Exim supports the use of regular expressions in many of its options. It
6294 uses the PCRE regular expression library; this provides regular expression
6295 matching that is compatible with Perl 5. The syntax and semantics of
6296 regular expressions is discussed in
6297 online Perl manpages, in
6298 many Perl reference books, and also in
6299 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6300 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6301
6302 The documentation for the syntax and semantics of the regular expressions that
6303 are supported by PCRE is included in the PCRE distribution, and no further
6304 description is included here. The PCRE functions are called from Exim using
6305 the default option settings (that is, with no PCRE options set), except that
6306 the PCRE_CASELESS option is set when the matching is required to be
6307 case-insensitive.
6308
6309 In most cases, when a regular expression is required in an Exim configuration,
6310 it has to start with a circumflex, in order to distinguish it from plain text
6311 or an &"ends with"& wildcard. In this example of a configuration setting, the
6312 second item in the colon-separated list is a regular expression.
6313 .code
6314 domains = a.b.c : ^\\d{3} : *.y.z : ...
6315 .endd
6316 The doubling of the backslash is required because of string expansion that
6317 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6318 of this issue, and a way of avoiding the need for doubling backslashes. The
6319 regular expression that is eventually used in this example contains just one
6320 backslash. The circumflex is included in the regular expression, and has the
6321 normal effect of &"anchoring"& it to the start of the string that is being
6322 matched.
6323
6324 There are, however, two cases where a circumflex is not required for the
6325 recognition of a regular expression: these are the &%match%& condition in a
6326 string expansion, and the &%matches%& condition in an Exim filter file. In
6327 these cases, the relevant string is always treated as a regular expression; if
6328 it does not start with a circumflex, the expression is not anchored, and can
6329 match anywhere in the subject string.
6330
6331 In all cases, if you want a regular expression to match at the end of a string,
6332 you must code the $ metacharacter to indicate this. For example:
6333 .code
6334 domains = ^\\d{3}\\.example
6335 .endd
6336 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6337 You need to use:
6338 .code
6339 domains = ^\\d{3}\\.example\$
6340 .endd
6341 if you want &'example'& to be the top-level domain. The backslash before the
6342 $ is needed because string expansion also interprets dollar characters.
6343
6344
6345
6346 . ////////////////////////////////////////////////////////////////////////////
6347 . ////////////////////////////////////////////////////////////////////////////
6348
6349 .chapter "File and database lookups" "CHAPfdlookup"
6350 .scindex IIDfidalo1 "file" "lookups"
6351 .scindex IIDfidalo2 "database" "lookups"
6352 .cindex "lookup" "description of"
6353 Exim can be configured to look up data in files or databases as it processes
6354 messages. Two different kinds of syntax are used:
6355
6356 .olist
6357 A string that is to be expanded may contain explicit lookup requests. These
6358 cause parts of the string to be replaced by data that is obtained from the
6359 lookup. Lookups of this type are conditional expansion items. Different results
6360 can be defined for the cases of lookup success and failure. See chapter
6361 &<<CHAPexpand>>&, where string expansions are described in detail.
6362 The key for the lookup is specified as part of the string expansion.
6363 .next
6364 Lists of domains, hosts, and email addresses can contain lookup requests as a
6365 way of avoiding excessively long linear lists. In this case, the data that is
6366 returned by the lookup is often (but not always) discarded; whether the lookup
6367 succeeds or fails is what really counts. These kinds of list are described in
6368 chapter &<<CHAPdomhosaddlists>>&.
6369 The key for the lookup is given by the context in which the list is expanded.
6370 .endlist
6371
6372 String expansions, lists, and lookups interact with each other in such a way
6373 that there is no order in which to describe any one of them that does not
6374 involve references to the others. Each of these three chapters makes more sense
6375 if you have read the other two first. If you are reading this for the first
6376 time, be aware that some of it will make a lot more sense after you have read
6377 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6378
6379 .section "Examples of different lookup syntax" "SECID60"
6380 It is easy to confuse the two different kinds of lookup, especially as the
6381 lists that may contain the second kind are always expanded before being
6382 processed as lists. Therefore, they may also contain lookups of the first kind.
6383 Be careful to distinguish between the following two examples:
6384 .code
6385 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6386 domains = lsearch;/some/file
6387 .endd
6388 The first uses a string expansion, the result of which must be a domain list.
6389 No strings have been specified for a successful or a failing lookup; the
6390 defaults in this case are the looked-up data and an empty string, respectively.
6391 The expansion takes place before the string is processed as a list, and the
6392 file that is searched could contain lines like this:
6393 .code
6394 192.168.3.4: domain1:domain2:...
6395 192.168.1.9: domain3:domain4:...
6396 .endd
6397 When the lookup succeeds, the result of the expansion is a list of domains (and
6398 possibly other types of item that are allowed in domain lists).
6399
6400 In the second example, the lookup is a single item in a domain list. It causes
6401 Exim to use a lookup to see if the domain that is being processed can be found
6402 in the file. The file could contains lines like this:
6403 .code
6404 domain1:
6405 domain2:
6406 .endd
6407 Any data that follows the keys is not relevant when checking that the domain
6408 matches the list item.
6409
6410 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6411 Consider a file containing lines like this:
6412 .code
6413 192.168.5.6: lsearch;/another/file
6414 .endd
6415 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6416 first &%domains%& setting above generates the second setting, which therefore
6417 causes a second lookup to occur.
6418
6419 The rest of this chapter describes the different lookup types that are
6420 available. Any of them can be used in any part of the configuration where a
6421 lookup is permitted.
6422
6423
6424 .section "Lookup types" "SECID61"
6425 .cindex "lookup" "types of"
6426 .cindex "single-key lookup" "definition of"
6427 Two different types of data lookup are implemented:
6428
6429 .ilist
6430 The &'single-key'& type requires the specification of a file in which to look,
6431 and a single key to search for. The key must be a non-empty string for the
6432 lookup to succeed. The lookup type determines how the file is searched.
6433 .next
6434 .cindex "query-style lookup" "definition of"
6435 The &'query-style'& type accepts a generalized database query. No particular
6436 key value is assumed by Exim for query-style lookups. You can use whichever
6437 Exim variables you need to construct the database query.
6438 .endlist
6439
6440 The code for each lookup type is in a separate source file that is included in
6441 the binary of Exim only if the corresponding compile-time option is set. The
6442 default settings in &_src/EDITME_& are:
6443 .code
6444 LOOKUP_DBM=yes
6445 LOOKUP_LSEARCH=yes
6446 .endd
6447 which means that only linear searching and DBM lookups are included by default.
6448 For some types of lookup (e.g. SQL databases), you need to install appropriate
6449 libraries and header files before building Exim.
6450
6451
6452
6453
6454 .section "Single-key lookup types" "SECTsinglekeylookups"
6455 .cindex "lookup" "single-key types"
6456 .cindex "single-key lookup" "list of types"
6457 The following single-key lookup types are implemented:
6458
6459 .ilist
6460 .cindex "cdb" "description of"
6461 .cindex "lookup" "cdb"
6462 .cindex "binary zero" "in lookup key"
6463 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6464 string without a terminating binary zero. The cdb format is designed for
6465 indexed files that are read frequently and never updated, except by total
6466 re-creation. As such, it is particularly suitable for large files containing
6467 aliases or other indexed data referenced by an MTA. Information about cdb can
6468 be found in several places:
6469 .display
6470 &url(http://www.pobox.com/~djb/cdb.html)
6471 &url(ftp://ftp.corpit.ru/pub/tinycdb/)
6472 &url(http://packages.debian.org/stable/utils/freecdb.html)
6473 .endd
6474 A cdb distribution is not needed in order to build Exim with cdb support,
6475 because the code for reading cdb files is included directly in Exim itself.
6476 However, no means of building or testing cdb files is provided with Exim, so
6477 you need to obtain a cdb distribution in order to do this.
6478 .next
6479 .cindex "DBM" "lookup type"
6480 .cindex "lookup" "dbm"
6481 .cindex "binary zero" "in lookup key"
6482 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6483 DBM file by looking up the record with the given key. A terminating binary
6484 zero is included in the key that is passed to the DBM library. See section
6485 &<<SECTdb>>& for a discussion of DBM libraries.
6486
6487 .cindex "Berkeley DB library" "file format"
6488 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6489 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6490 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6491 the DB_UNKNOWN option. This enables it to handle any of the types of database
6492 that the library supports, and can be useful for accessing DBM files created by
6493 other applications. (For earlier DB versions, DB_HASH is always used.)
6494 .next
6495 .cindex "lookup" "dbmjz"
6496 .cindex "lookup" "dbm &-- embedded NULs"
6497 .cindex "sasldb2"
6498 .cindex "dbmjz lookup type"
6499 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6500 interpreted as an Exim list; the elements of the list are joined together with
6501 ASCII NUL characters to form the lookup key.  An example usage would be to
6502 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6503 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6504 &(cram_md5)& authenticator.
6505 .next
6506 .cindex "lookup" "dbmnz"
6507 .cindex "lookup" "dbm &-- terminating zero"
6508 .cindex "binary zero" "in lookup key"
6509 .cindex "Courier"
6510 .cindex "&_/etc/userdbshadow.dat_&"
6511 .cindex "dbmnz lookup type"
6512 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6513 is not included in the key that is passed to the DBM library. You may need this
6514 if you want to look up data in files that are created by or shared with some
6515 other application that does not use terminating zeros. For example, you need to
6516 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6517 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6518 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6519 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6520 .next
6521 .cindex "lookup" "dsearch"
6522 .cindex "dsearch lookup type"
6523 &(dsearch)&: The given file must be a directory; this is searched for an entry
6524 whose name is the key by calling the &[lstat()]& function. The key may not
6525 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6526 the lookup is the name of the entry, which may be a file, directory,
6527 symbolic link, or any other kind of directory entry. An example of how this
6528 lookup can be used to support virtual domains is given in section
6529 &<<SECTvirtualdomains>>&.
6530 .next
6531 .cindex "lookup" "iplsearch"
6532 .cindex "iplsearch lookup type"
6533 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6534 terminated by a colon or white space or the end of the line. The keys in the
6535 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6536 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6537 being interpreted as a key terminator. For example:
6538 .code
6539 1.2.3.4:           data for 1.2.3.4
6540 192.168.0.0/16:    data for 192.168.0.0/16
6541 "abcd::cdab":      data for abcd::cdab
6542 "abcd:abcd::/32"   data for abcd:abcd::/32
6543 .endd
6544 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6545 file is searched linearly, using the CIDR masks where present, until a matching
6546 key is found. The first key that matches is used; there is no attempt to find a
6547 &"best"& match. Apart from the way the keys are matched, the processing for
6548 &(iplsearch)& is the same as for &(lsearch)&.
6549
6550 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6551 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6552 lookup types support only literal keys.
6553
6554 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6555 the implicit key is the host's IP address rather than its name (see section
6556 &<<SECThoslispatsikey>>&).
6557 .next
6558 .cindex "linear search"
6559 .cindex "lookup" "lsearch"
6560 .cindex "lsearch lookup type"
6561 .cindex "case sensitivity" "in lsearch lookup"
6562 &(lsearch)&: The given file is a text file that is searched linearly for a
6563 line beginning with the search key, terminated by a colon or white space or the
6564 end of the line. The search is case-insensitive; that is, upper and lower case
6565 letters are treated as the same. The first occurrence of the key that is found
6566 in the file is used.
6567
6568 White space between the key and the colon is permitted. The remainder of the
6569 line, with leading and trailing white space removed, is the data. This can be
6570 continued onto subsequent lines by starting them with any amount of white
6571 space, but only a single space character is included in the data at such a
6572 junction. If the data begins with a colon, the key must be terminated by a
6573 colon, for example:
6574 .code
6575 baduser:  :fail:
6576 .endd
6577 Empty lines and lines beginning with # are ignored, even if they occur in the
6578 middle of an item. This is the traditional textual format of alias files. Note
6579 that the keys in an &(lsearch)& file are literal strings. There is no
6580 wildcarding of any kind.
6581
6582 .cindex "lookup" "lsearch &-- colons in keys"
6583 .cindex "white space" "in lsearch key"
6584 In most &(lsearch)& files, keys are not required to contain colons or #
6585 characters, or white space. However, if you need this feature, it is available.
6586 If a key begins with a doublequote character, it is terminated only by a
6587 matching quote (or end of line), and the normal escaping rules apply to its
6588 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6589 quoted keys (exactly as for unquoted keys). There is no special handling of
6590 quotes for the data part of an &(lsearch)& line.
6591
6592 .next
6593 .cindex "NIS lookup type"
6594 .cindex "lookup" "NIS"
6595 .cindex "binary zero" "in lookup key"
6596 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6597 the given key, without a terminating binary zero. There is a variant called
6598 &(nis0)& which does include the terminating binary zero in the key. This is
6599 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6600 aliases; the full map names must be used.
6601
6602 .next
6603 .cindex "wildlsearch lookup type"
6604 .cindex "lookup" "wildlsearch"
6605 .cindex "nwildlsearch lookup type"
6606 .cindex "lookup" "nwildlsearch"
6607 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6608 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6609 the file may be wildcarded. The difference between these two lookup types is
6610 that for &(wildlsearch)&, each key in the file is string-expanded before being
6611 used, whereas for &(nwildlsearch)&, no expansion takes place.
6612
6613 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6614 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6615 file that are regular expressions can be made case-sensitive by the use of
6616 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6617
6618 . ==== As this is a nested list, any displays it contains must be indented
6619 . ==== as otherwise they are too far to the left.
6620
6621 .olist
6622 The string may begin with an asterisk to mean &"ends with"&. For example:
6623 .code
6624     *.a.b.c       data for anything.a.b.c
6625     *fish         data for anythingfish
6626 .endd
6627 .next
6628 The string may begin with a circumflex to indicate a regular expression. For
6629 example, for &(wildlsearch)&:
6630 .code
6631     ^\N\d+\.a\.b\N    data for <digits>.a.b
6632 .endd
6633 Note the use of &`\N`& to disable expansion of the contents of the regular
6634 expression. If you are using &(nwildlsearch)&, where the keys are not
6635 string-expanded, the equivalent entry is:
6636 .code
6637     ^\d+\.a\.b        data for <digits>.a.b
6638 .endd
6639 The case-insensitive flag is set at the start of compiling the regular
6640 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6641 For example, to make the entire pattern case-sensitive:
6642 .code
6643     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6644 .endd
6645
6646 If the regular expression contains white space or colon characters, you must
6647 either quote it (see &(lsearch)& above), or represent these characters in other
6648 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6649 colon. This may be easier than quoting, because if you quote, you have to
6650 escape all the backslashes inside the quotes.
6651
6652 &*Note*&: It is not possible to capture substrings in a regular expression
6653 match for later use, because the results of all lookups are cached. If a lookup
6654 is repeated, the result is taken from the cache, and no actual pattern matching
6655 takes place. The values of all the numeric variables are unset after a
6656 &((n)wildlsearch)& match.
6657
6658 .next
6659 Although I cannot see it being of much use, the general matching function that
6660 is used to implement &((n)wildlsearch)& means that the string may begin with a
6661 lookup name terminated by a semicolon, and followed by lookup data. For
6662 example:
6663 .code
6664     cdb;/some/file  data for keys that match the file
6665 .endd
6666 The data that is obtained from the nested lookup is discarded.
6667 .endlist olist
6668
6669 Keys that do not match any of these patterns are interpreted literally. The
6670 continuation rules for the data are the same as for &(lsearch)&, and keys may
6671 be followed by optional colons.
6672
6673 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6674 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6675 lookup types support only literal keys.
6676 .endlist ilist
6677
6678
6679 .section "Query-style lookup types" "SECTquerystylelookups"
6680 .cindex "lookup" "query-style types"
6681 .cindex "query-style lookup" "list of types"
6682 The supported query-style lookup types are listed below. Further details about
6683 many of them are given in later sections.
6684
6685 .ilist
6686 .cindex "DNS" "as a lookup type"
6687 .cindex "lookup" "DNS"
6688 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6689 are given in the supplied query. The resulting data is the contents of the
6690 records. See section &<<SECTdnsdb>>&.
6691 .next
6692 .cindex "InterBase lookup type"
6693 .cindex "lookup" "InterBase"
6694 &(ibase)&: This does a lookup in an InterBase database.
6695 .next
6696 .cindex "LDAP" "lookup type"
6697 .cindex "lookup" "LDAP"
6698 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6699 returns attributes from a single entry. There is a variant called &(ldapm)&
6700 that permits values from multiple entries to be returned. A third variant
6701 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6702 any attribute values. See section &<<SECTldap>>&.
6703 .next
6704 .cindex "MySQL" "lookup type"
6705 .cindex "lookup" "MySQL"
6706 &(mysql)&: The format of the query is an SQL statement that is passed to a
6707 MySQL database. See section &<<SECTsql>>&.
6708 .next
6709 .cindex "NIS+ lookup type"
6710 .cindex "lookup" "NIS+"
6711 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6712 the field to be returned. See section &<<SECTnisplus>>&.
6713 .next
6714 .cindex "Oracle" "lookup type"
6715 .cindex "lookup" "Oracle"
6716 &(oracle)&: The format of the query is an SQL statement that is passed to an
6717 Oracle database. See section &<<SECTsql>>&.
6718 .next
6719 .cindex "lookup" "passwd"
6720 .cindex "passwd lookup type"
6721 .cindex "&_/etc/passwd_&"
6722 &(passwd)& is a query-style lookup with queries that are just user names. The
6723 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6724 success, the result string is the same as you would get from an &(lsearch)&
6725 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6726 password value. For example:
6727 .code
6728 *:42:42:King Rat:/home/kr:/bin/bash
6729 .endd
6730 .next
6731 .cindex "PostgreSQL lookup type"
6732 .cindex "lookup" "PostgreSQL"
6733 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6734 PostgreSQL database. See section &<<SECTsql>>&.
6735
6736 .next
6737 .cindex "Redis lookup type"
6738 .cindex lookup Redis
6739 &(redis)&: The format of the query is either a simple get or simple set,
6740 passed to a Redis database. See section &<<SECTsql>>&.
6741
6742 .next
6743 .cindex "sqlite lookup type"
6744 .cindex "lookup" "sqlite"
6745 &(sqlite)&: The format of the query is a file name followed by an SQL statement
6746 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6747
6748 .next
6749 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6750 not likely to be useful in normal operation.
6751 .next
6752 .cindex "whoson lookup type"
6753 .cindex "lookup" "whoson"
6754 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6755 allows a server to check whether a particular (dynamically allocated) IP
6756 address is currently allocated to a known (trusted) user and, optionally, to
6757 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6758 at one time for &"POP before SMTP"& authentication, but that approach has been
6759 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6760 &"POP before SMTP"& checking using ACL statements such as
6761 .code
6762 require condition = \
6763   ${lookup whoson {$sender_host_address}{yes}{no}}
6764 .endd
6765 The query consists of a single IP address. The value returned is the name of
6766 the authenticated user, which is stored in the variable &$value$&. However, in
6767 this example, the data in &$value$& is not used; the result of the lookup is
6768 one of the fixed strings &"yes"& or &"no"&.
6769 .endlist
6770
6771
6772
6773 .section "Temporary errors in lookups" "SECID63"
6774 .cindex "lookup" "temporary error in"
6775 Lookup functions can return temporary error codes if the lookup cannot be
6776 completed. For example, an SQL or LDAP database might be unavailable. For this
6777 reason, it is not advisable to use a lookup that might do this for critical
6778 options such as a list of local domains.
6779
6780 When a lookup cannot be completed in a router or transport, delivery
6781 of the message (to the relevant address) is deferred, as for any other
6782 temporary error. In other circumstances Exim may assume the lookup has failed,
6783 or may give up altogether.
6784
6785
6786
6787 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
6788 .cindex "wildcard lookups"
6789 .cindex "lookup" "default values"
6790 .cindex "lookup" "wildcard"
6791 .cindex "lookup" "* added to type"
6792 .cindex "default" "in single-key lookups"
6793 In this context, a &"default value"& is a value specified by the administrator
6794 that is to be used if a lookup fails.
6795
6796 &*Note:*& This section applies only to single-key lookups. For query-style
6797 lookups, the facilities of the query language must be used. An attempt to
6798 specify a default for a query-style lookup provokes an error.
6799
6800 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
6801 and the initial lookup fails, the key &"*"& is looked up in the file to
6802 provide a default value. See also the section on partial matching below.
6803
6804 .cindex "*@ with single-key lookup"
6805 .cindex "lookup" "*@ added to type"
6806 .cindex "alias file" "per-domain default"
6807 Alternatively, if &"*@"& is added to a single-key lookup type (for example
6808 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
6809 character, a second lookup is done with everything before the last @ replaced
6810 by *. This makes it possible to provide per-domain defaults in alias files
6811 that include the domains in the keys. If the second lookup fails (or doesn't
6812 take place because there is no @ in the key), &"*"& is looked up.
6813 For example, a &(redirect)& router might contain:
6814 .code
6815 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
6816 .endd
6817 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
6818 looks up these keys, in this order:
6819 .code
6820 jane@eyre.example
6821 *@eyre.example
6822 *
6823 .endd
6824 The data is taken from whichever key it finds first. &*Note*&: In an
6825 &(lsearch)& file, this does not mean the first of these keys in the file. A
6826 complete scan is done for each key, and only if it is not found at all does
6827 Exim move on to try the next key.
6828
6829
6830
6831 .section "Partial matching in single-key lookups" "SECTpartiallookup"
6832 .cindex "partial matching"
6833 .cindex "wildcard lookups"
6834 .cindex "lookup" "partial matching"
6835 .cindex "lookup" "wildcard"
6836 .cindex "asterisk" "in search type"
6837 The normal operation of a single-key lookup is to search the file for an exact
6838 match with the given key. However, in a number of situations where domains are
6839 being looked up, it is useful to be able to do partial matching. In this case,
6840 information in the file that has a key starting with &"*."& is matched by any
6841 domain that ends with the components that follow the full stop. For example, if
6842 a key in a DBM file is
6843 .code
6844 *.dates.fict.example
6845 .endd
6846 then when partial matching is enabled this is matched by (amongst others)
6847 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
6848 by &'dates.fict.example'&, if that does not appear as a separate key in the
6849 file.
6850
6851 &*Note*&: Partial matching is not available for query-style lookups. It is
6852 also not available for any lookup items in address lists (see section
6853 &<<SECTaddresslist>>&).
6854
6855 Partial matching is implemented by doing a series of separate lookups using
6856 keys constructed by modifying the original subject key. This means that it can
6857 be used with any of the single-key lookup types, provided that
6858 partial matching keys
6859 beginning with a special prefix (default &"*."&) are included in the data file.
6860 Keys in the file that do not begin with the prefix are matched only by
6861 unmodified subject keys when partial matching is in use.
6862
6863 Partial matching is requested by adding the string &"partial-"& to the front of
6864 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
6865 is done, the subject key is first looked up unmodified; if that fails, &"*."&
6866 is added at the start of the subject key, and it is looked up again. If that
6867 fails, further lookups are tried with dot-separated components removed from the
6868 start of the subject key, one-by-one, and &"*."& added on the front of what
6869 remains.
6870
6871 A minimum number of two non-* components are required. This can be adjusted
6872 by including a number before the hyphen in the search type. For example,
6873 &%partial3-lsearch%& specifies a minimum of three non-* components in the
6874 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
6875 subject key is &'2250.dates.fict.example'& then the following keys are looked
6876 up when the minimum number of non-* components is two:
6877 .code
6878 2250.dates.fict.example
6879 *.2250.dates.fict.example
6880 *.dates.fict.example
6881 *.fict.example
6882 .endd
6883 As soon as one key in the sequence is successfully looked up, the lookup
6884 finishes.
6885
6886 .cindex "lookup" "partial matching &-- changing prefix"
6887 .cindex "prefix" "for partial matching"
6888 The use of &"*."& as the partial matching prefix is a default that can be
6889 changed. The motivation for this feature is to allow Exim to operate with file
6890 formats that are used by other MTAs. A different prefix can be supplied in
6891 parentheses instead of the hyphen after &"partial"&. For example:
6892 .code
6893 domains = partial(.)lsearch;/some/file
6894 .endd
6895 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
6896 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
6897 components is unchanged). The prefix may consist of any punctuation characters
6898 other than a closing parenthesis. It may be empty, for example:
6899 .code
6900 domains = partial1()cdb;/some/file
6901 .endd
6902 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
6903 &`a.b.c`&, &`b.c`&, and &`c`&.
6904
6905 If &"partial0"& is specified, what happens at the end (when the lookup with
6906 just one non-wild component has failed, and the original key is shortened right
6907 down to the null string) depends on the prefix:
6908
6909 .ilist
6910 If the prefix has zero length, the whole lookup fails.
6911 .next
6912 If the prefix has length 1, a lookup for just the prefix is done. For
6913 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
6914 .next
6915 Otherwise, if the prefix ends in a dot, the dot is removed, and the
6916 remainder is looked up. With the default prefix, therefore, the final lookup is
6917 for &"*"& on its own.
6918 .next
6919 Otherwise, the whole prefix is looked up.
6920 .endlist
6921
6922
6923 If the search type ends in &"*"& or &"*@"& (see section
6924 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
6925 this implies happens after all partial lookups have failed. If &"partial0"& is
6926 specified, adding &"*"& to the search type has no effect with the default
6927 prefix, because the &"*"& key is already included in the sequence of partial
6928 lookups. However, there might be a use for lookup types such as
6929 &"partial0(.)lsearch*"&.
6930
6931 The use of &"*"& in lookup partial matching differs from its use as a wildcard
6932 in domain lists and the like. Partial matching works only in terms of
6933 dot-separated components; a key such as &`*fict.example`&
6934 in a database file is useless, because the asterisk in a partial matching
6935 subject key is always followed by a dot.
6936
6937
6938
6939
6940 .section "Lookup caching" "SECID64"
6941 .cindex "lookup" "caching"
6942 .cindex "caching" "lookup data"
6943 Exim caches all lookup results in order to avoid needless repetition of
6944 lookups. However, because (apart from the daemon) Exim operates as a collection
6945 of independent, short-lived processes, this caching applies only within a
6946 single Exim process. There is no inter-process lookup caching facility.
6947
6948 For single-key lookups, Exim keeps the relevant files open in case there is
6949 another lookup that needs them. In some types of configuration this can lead to
6950 many files being kept open for messages with many recipients. To avoid hitting
6951 the operating system limit on the number of simultaneously open files, Exim
6952 closes the least recently used file when it needs to open more files than its
6953 own internal limit, which can be changed via the &%lookup_open_max%& option.
6954
6955 The single-key lookup files are closed and the lookup caches are flushed at
6956 strategic points during delivery &-- for example, after all routing is
6957 complete.
6958
6959
6960
6961
6962 .section "Quoting lookup data" "SECID65"
6963 .cindex "lookup" "quoting"
6964 .cindex "quoting" "in lookups"
6965 When data from an incoming message is included in a query-style lookup, there
6966 is the possibility of special characters in the data messing up the syntax of
6967 the query. For example, a NIS+ query that contains
6968 .code
6969 [name=$local_part]
6970 .endd
6971 will be broken if the local part happens to contain a closing square bracket.
6972 For NIS+, data can be enclosed in double quotes like this:
6973 .code
6974 [name="$local_part"]
6975 .endd
6976 but this still leaves the problem of a double quote in the data. The rule for
6977 NIS+ is that double quotes must be doubled. Other lookup types have different
6978 rules, and to cope with the differing requirements, an expansion operator
6979 of the following form is provided:
6980 .code
6981 ${quote_<lookup-type>:<string>}
6982 .endd
6983 For example, the safest way to write the NIS+ query is
6984 .code
6985 [name="${quote_nisplus:$local_part}"]
6986 .endd
6987 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
6988 operator can be used for all lookup types, but has no effect for single-key
6989 lookups, since no quoting is ever needed in their key strings.
6990
6991
6992
6993
6994 .section "More about dnsdb" "SECTdnsdb"
6995 .cindex "dnsdb lookup"
6996 .cindex "lookup" "dnsdb"
6997 .cindex "DNS" "as a lookup type"
6998 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
6999 of a record type and a domain name, separated by an equals sign. For example,
7000 an expansion string could contain:
7001 .code
7002 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7003 .endd
7004 If the lookup succeeds, the result is placed in &$value$&, which in this case
7005 is used on its own as the result. If the lookup does not succeed, the
7006 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7007 &<<SECTforexpfai>>& for an explanation of what this means.
7008
7009 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7010 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7011 If no type is given, TXT is assumed.
7012
7013 For any record type, if multiple records are found, the data is returned as a
7014 concatenation, with newline as the default separator. The order, of course,
7015 depends on the DNS resolver. You can specify a different separator character
7016 between multiple records by putting a right angle-bracket followed immediately
7017 by the new separator at the start of the query. For example:
7018 .code
7019 ${lookup dnsdb{>: a=host1.example}}
7020 .endd
7021 It is permitted to specify a space as the separator character. Further
7022 white space is ignored.
7023 For lookup types that return multiple fields per record,
7024 an alternate field separator can be specified using a comma after the main
7025 separator character, followed immediately by the field separator.
7026
7027 .cindex "PTR record" "in &(dnsdb)& lookup"
7028 When the type is PTR,
7029 the data can be an IP address, written as normal; inversion and the addition of
7030 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7031 .code
7032 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7033 .endd
7034 If the data for a PTR record is not a syntactically valid IP address, it is not
7035 altered and nothing is added.
7036
7037 .cindex "MX record" "in &(dnsdb)& lookup"
7038 .cindex "SRV record" "in &(dnsdb)& lookup"
7039 For an MX lookup, both the preference value and the host name are returned for
7040 each record, separated by a space. For an SRV lookup, the priority, weight,
7041 port, and host name are returned for each record, separated by spaces.
7042 The field separator can be modified as above.
7043
7044 .cindex "TXT record" "in &(dnsdb)& lookup"
7045 .cindex "SPF record" "in &(dnsdb)& lookup"
7046 For TXT records with multiple items of data, only the first item is returned,
7047 unless a field separator is specified.
7048 To concatenate items without a separator, use a semicolon instead.
7049 For SPF records the
7050 default behaviour is to concatenate multiple items without using a separator.
7051 .code
7052 ${lookup dnsdb{>\n,: txt=a.b.example}}
7053 ${lookup dnsdb{>\n; txt=a.b.example}}
7054 ${lookup dnsdb{spf=example.org}}
7055 .endd
7056 It is permitted to specify a space as the separator character. Further
7057 white space is ignored.
7058
7059 .cindex "SOA record" "in &(dnsdb)& lookup"
7060 For an SOA lookup, while no result is obtained the lookup is redone with
7061 successively more leading components dropped from the given domain.
7062 Only the primary-nameserver field is returned unless a field separator is
7063 specified.
7064 .code
7065 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7066 .endd
7067
7068 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7069 .cindex "dnsdb modifiers"
7070 .cindex "modifiers" "dnsdb"
7071 .cindex "options" "dnsdb"
7072 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7073 each followed by a comma,
7074 that may appear before the record type.
7075
7076 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7077 temporary DNS error for any of them, the behaviour is controlled by
7078 a defer-option modifier.
7079 The possible keywords are
7080 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7081 With &"strict"& behaviour, any temporary DNS error causes the
7082 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7083 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7084 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7085 error causes the whole lookup to defer only if none of the other lookups
7086 succeed. The default is &"lax"&, so the following lookups are equivalent:
7087 .code
7088 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7089 ${lookup dnsdb{a=one.host.com:two.host.com}}
7090 .endd
7091 Thus, in the default case, as long as at least one of the DNS lookups
7092 yields some data, the lookup succeeds.
7093
7094 .cindex "DNSSEC" "dns lookup"
7095 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7096 The possible keywords are
7097 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7098 With &"strict"& or &"lax"& DNSSEC information is requested
7099 with the lookup.
7100 With &"strict"& a response from the DNS resolver that
7101 is not labelled as authenticated data
7102 is treated as equivalent to a temporary DNS error.
7103 The default is &"never"&.
7104
7105 See also the &$lookup_dnssec_authenticated$& variable.
7106
7107 .cindex timeout "dns lookup"
7108 .cindex "DNS" timeout
7109 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7110 The form is &"retrans_VAL"& where VAL is an Exim time specification
7111 (e.g. &"5s"&).
7112 The default value is set by the main configuration option &%dns_retrans%&.
7113
7114 Retries for the dnsdb lookup can be controlled by a retry modifier.
7115 The form if &"retry_VAL"& where VAL is an integer.
7116 The default count is set by the main configuration option &%dns_retry%&.
7117
7118 .cindex caching "of dns lookup"
7119 .cindex TTL "of dns lookup"
7120 .cindex DNS TTL
7121 Dnsdb lookup results are cached within a single process (and its children).
7122 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7123 value of the set of returned DNS records.
7124
7125
7126 .section "Pseudo dnsdb record types" "SECID66"
7127 .cindex "MX record" "in &(dnsdb)& lookup"
7128 By default, both the preference value and the host name are returned for
7129 each MX record, separated by a space. If you want only host names, you can use
7130 the pseudo-type MXH:
7131 .code
7132 ${lookup dnsdb{mxh=a.b.example}}
7133 .endd
7134 In this case, the preference values are omitted, and just the host names are
7135 returned.
7136
7137 .cindex "name server for enclosing domain"
7138 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7139 records on the given domain, but if none are found, it removes the first
7140 component of the domain name, and tries again. This process continues until NS
7141 records are found or there are no more components left (or there is a DNS
7142 error). In other words, it may return the name servers for a top-level domain,
7143 but it never returns the root name servers. If there are no NS records for the
7144 top-level domain, the lookup fails. Consider these examples:
7145 .code
7146 ${lookup dnsdb{zns=xxx.quercite.com}}
7147 ${lookup dnsdb{zns=xxx.edu}}
7148 .endd
7149 Assuming that in each case there are no NS records for the full domain name,
7150 the first returns the name servers for &%quercite.com%&, and the second returns
7151 the name servers for &%edu%&.
7152
7153 You should be careful about how you use this lookup because, unless the
7154 top-level domain does not exist, the lookup always returns some host names. The
7155 sort of use to which this might be put is for seeing if the name servers for a
7156 given domain are on a blacklist. You can probably assume that the name servers
7157 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7158 such a list.
7159
7160 .cindex "CSA" "in &(dnsdb)& lookup"
7161 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7162 records according to the CSA rules, which are described in section
7163 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7164 not sufficient because of the extra parent domain search behaviour of CSA. The
7165 result of a successful lookup such as:
7166 .code
7167 ${lookup dnsdb {csa=$sender_helo_name}}
7168 .endd
7169 has two space-separated fields: an authorization code and a target host name.
7170 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7171 authorization required but absent, or &"?"& for unknown.
7172
7173 .cindex "A+" "in &(dnsdb)& lookup"
7174 The pseudo-type A+ performs an AAAA
7175 and then an A lookup.  All results are returned; defer processing
7176 (see below) is handled separately for each lookup.  Example:
7177 .code
7178 ${lookup dnsdb {>; a+=$sender_helo_name}}
7179 .endd
7180
7181
7182 .section "Multiple dnsdb lookups" "SECID67"
7183 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7184 However, you can specify a list of domains or IP addresses in a single
7185 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7186 the default separator, but with the ability to change this. For example:
7187 .code
7188 ${lookup dnsdb{one.domain.com:two.domain.com}}
7189 ${lookup dnsdb{a=one.host.com:two.host.com}}
7190 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7191 .endd
7192 In order to retain backwards compatibility, there is one special case: if
7193 the lookup type is PTR and no change of separator is specified, Exim looks
7194 to see if the rest of the string is precisely one IPv6 address. In this
7195 case, it does not treat it as a list.
7196
7197 The data from each lookup is concatenated, with newline separators by default,
7198 in the same way that multiple DNS records for a single item are handled. A
7199 different separator can be specified, as described above.
7200
7201
7202
7203
7204 .section "More about LDAP" "SECTldap"
7205 .cindex "LDAP" "lookup, more about"
7206 .cindex "lookup" "LDAP"
7207 .cindex "Solaris" "LDAP"
7208 The original LDAP implementation came from the University of Michigan; this has
7209 become &"Open LDAP"&, and there are now two different releases. Another
7210 implementation comes from Netscape, and Solaris 7 and subsequent releases
7211 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7212 the lookup function level, their error handling is different. For this reason
7213 it is necessary to set a compile-time variable when building Exim with LDAP, to
7214 indicate which LDAP library is in use. One of the following should appear in
7215 your &_Local/Makefile_&:
7216 .code
7217 LDAP_LIB_TYPE=UMICHIGAN
7218 LDAP_LIB_TYPE=OPENLDAP1
7219 LDAP_LIB_TYPE=OPENLDAP2
7220 LDAP_LIB_TYPE=NETSCAPE
7221 LDAP_LIB_TYPE=SOLARIS
7222 .endd
7223 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7224 same interface as the University of Michigan version.
7225
7226 There are three LDAP lookup types in Exim. These behave slightly differently in
7227 the way they handle the results of a query:
7228
7229 .ilist
7230 &(ldap)& requires the result to contain just one entry; if there are more, it
7231 gives an error.
7232 .next
7233 &(ldapdn)& also requires the result to contain just one entry, but it is the
7234 Distinguished Name that is returned rather than any attribute values.
7235 .next
7236 &(ldapm)& permits the result to contain more than one entry; the attributes
7237 from all of them are returned.
7238 .endlist
7239
7240
7241 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7242 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7243 the data returned by a successful lookup is described in the next section.
7244 First we explain how LDAP queries are coded.
7245
7246
7247 .section "Format of LDAP queries" "SECTforldaque"
7248 .cindex "LDAP" "query format"
7249 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7250 the configuration of a &(redirect)& router one might have this setting:
7251 .code
7252 data = ${lookup ldap \
7253   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7254   c=UK?mailbox?base?}}
7255 .endd
7256 .cindex "LDAP" "with TLS"
7257 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7258 secure (encrypted) LDAP connections. The second of these ensures that an
7259 encrypted TLS connection is used.
7260
7261 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7262 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7263 See the &%ldap_start_tls%& option.
7264
7265 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7266 controlled. Every part of the TLS configuration can be configured by settings in
7267 &_exim.conf_&. Depending on the version of the client libraries installed on
7268 your system, some of the initialization may have required setting options in
7269 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7270 certificates. This revealed a nuance where the current UID that exim was
7271 running as could affect which config files it read. With Exim 4.83, these
7272 methods become optional, only taking effect if not specifically set in
7273 &_exim.conf_&.
7274
7275
7276 .section "LDAP quoting" "SECID68"
7277 .cindex "LDAP" "quoting"
7278 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7279 and the second because the LDAP query is represented as a URL. Furthermore,
7280 within an LDAP query, two different kinds of quoting are required. For this
7281 reason, there are two different LDAP-specific quoting operators.
7282
7283 The &%quote_ldap%& operator is designed for use on strings that are part of
7284 filter specifications. Conceptually, it first does the following conversions on
7285 the string:
7286 .code
7287 *   =>   \2A
7288 (   =>   \28
7289 )   =>   \29
7290 \   =>   \5C
7291 .endd
7292 in accordance with RFC 2254. The resulting string is then quoted according
7293 to the rules for URLs, that is, all non-alphanumeric characters except
7294 .code
7295 ! $ ' - . _ ( ) * +
7296 .endd
7297 are converted to their hex values, preceded by a percent sign. For example:
7298 .code
7299 ${quote_ldap: a(bc)*, a<yz>; }
7300 .endd
7301 yields
7302 .code
7303 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7304 .endd
7305 Removing the URL quoting, this is (with a leading and a trailing space):
7306 .code
7307 a\28bc\29\2A, a<yz>;
7308 .endd
7309 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7310 base DN specifications in queries. Conceptually, it first converts the string
7311 by inserting a backslash in front of any of the following characters:
7312 .code
7313 , + " \ < > ;
7314 .endd
7315 It also inserts a backslash before any leading spaces or # characters, and
7316 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7317 is then quoted according to the rules for URLs. For example:
7318 .code
7319 ${quote_ldap_dn: a(bc)*, a<yz>; }
7320 .endd
7321 yields
7322 .code
7323 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7324 .endd
7325 Removing the URL quoting, this is (with a trailing space):
7326 .code
7327 \ a(bc)*\, a\<yz\>\;\
7328 .endd
7329 There are some further comments about quoting in the section on LDAP
7330 authentication below.
7331
7332
7333 .section "LDAP connections" "SECID69"
7334 .cindex "LDAP" "connections"
7335 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7336 is in use, via a Unix domain socket. The example given above does not specify
7337 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7338 by starting it with
7339 .code
7340 ldap://<hostname>:<port>/...
7341 .endd
7342 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7343 used. When no server is specified in a query, a list of default servers is
7344 taken from the &%ldap_default_servers%& configuration option. This supplies a
7345 colon-separated list of servers which are tried in turn until one successfully
7346 handles a query, or there is a serious error. Successful handling either
7347 returns the requested data, or indicates that it does not exist. Serious errors
7348 are syntactical, or multiple values when only a single value is expected.
7349 Errors which cause the next server to be tried are connection failures, bind
7350 failures, and timeouts.
7351
7352 For each server name in the list, a port number can be given. The standard way
7353 of specifying a host and port is to use a colon separator (RFC 1738). Because
7354 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7355 doubled. For example
7356 .code
7357 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7358 .endd
7359 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7360 to the LDAP library with no server name, and the library's default (normally
7361 the local host) is used.
7362
7363 If you are using the OpenLDAP library, you can connect to an LDAP server using
7364 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7365 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7366 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7367 not available.
7368
7369 For this type of connection, instead of a host name for the server, a pathname
7370 for the socket is required, and the port number is not relevant. The pathname
7371 can be specified either as an item in &%ldap_default_servers%&, or inline in
7372 the query. In the former case, you can have settings such as
7373 .code
7374 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7375 .endd
7376 When the pathname is given in the query, you have to escape the slashes as
7377 &`%2F`& to fit in with the LDAP URL syntax. For example:
7378 .code
7379 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7380 .endd
7381 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7382 a pathname, it uses the Unix domain socket code, even if the query actually
7383 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7384 socket connection. This behaviour means that you can use a setting of
7385 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7386 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7387 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7388 backup host.
7389
7390 If an explicit &`ldapi`& type is given in a query when a host name is
7391 specified, an error is diagnosed. However, if there are more items in
7392 &%ldap_default_servers%&, they are tried. In other words:
7393
7394 .ilist
7395 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7396 interface.
7397 .next
7398 Using &`ldapi`& with a host name causes an error.
7399 .endlist
7400
7401
7402 Using &`ldapi`& with no host or path in the query, and no setting of
7403 &%ldap_default_servers%&, does whatever the library does by default.
7404
7405
7406
7407 .section "LDAP authentication and control information" "SECID70"
7408 .cindex "LDAP" "authentication"
7409 The LDAP URL syntax provides no way of passing authentication and other control
7410 information to the server. To make this possible, the URL in an LDAP query may
7411 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7412 spaces. If a value contains spaces it must be enclosed in double quotes, and
7413 when double quotes are used, backslash is interpreted in the usual way inside
7414 them. The following names are recognized:
7415 .display
7416 &`DEREFERENCE`&  set the dereferencing parameter
7417 &`NETTIME    `&  set a timeout for a network operation
7418 &`USER       `&  set the DN, for authenticating the LDAP bind
7419 &`PASS       `&  set the password, likewise
7420 &`REFERRALS  `&  set the referrals parameter
7421 &`SERVERS    `&  set alternate server list for this query only
7422 &`SIZE       `&  set the limit for the number of entries returned
7423 &`TIME       `&  set the maximum waiting time for a query
7424 .endd
7425 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7426 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7427 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7428 library from trying to follow referrals issued by the LDAP server.
7429
7430 .cindex LDAP timeout
7431 .cindex timeout "LDAP lookup"
7432 The name CONNECT is an obsolete name for NETTIME, retained for
7433 backwards compatibility. This timeout (specified as a number of seconds) is
7434 enforced from the client end for operations that can be carried out over a
7435 network. Specifically, it applies to network connections and calls to the
7436 &'ldap_result()'& function. If the value is greater than zero, it is used if
7437 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7438 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7439 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7440 Netscape SDK; for OpenLDAP no action is taken.
7441
7442 The TIME parameter (also a number of seconds) is passed to the server to
7443 set a server-side limit on the time taken to complete a search.
7444
7445 The SERVERS parameter allows you to specify an alternate list of ldap servers
7446 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7447 default list of ldap servers, and a single lookup can specify a single ldap
7448 server to use.  But when you need to do a lookup with a list of servers that is
7449 different than the default list (maybe different order, maybe a completely
7450 different set of servers), the SERVERS parameter allows you to specify this
7451 alternate list (colon-separated).
7452
7453 Here is an example of an LDAP query in an Exim lookup that uses some of these
7454 values. This is a single line, folded to fit on the page:
7455 .code
7456 ${lookup ldap
7457   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7458   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7459   {$value}fail}
7460 .endd
7461 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7462 any of the auxiliary data. Exim configuration settings that include lookups
7463 which contain password information should be preceded by &"hide"& to prevent
7464 non-admin users from using the &%-bP%& option to see their values.
7465
7466 The auxiliary data items may be given in any order. The default is no
7467 connection timeout (the system timeout is used), no user or password, no limit
7468 on the number of entries returned, and no time limit on queries.
7469
7470 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7471 removes any URL quoting that it may contain before passing it LDAP. Apparently
7472 some libraries do this for themselves, but some do not. Removing the URL
7473 quoting has two advantages:
7474
7475 .ilist
7476 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7477 DNs as with DNs inside actual queries.
7478 .next
7479 It permits spaces inside USER= DNs.
7480 .endlist
7481
7482 For example, a setting such as
7483 .code
7484 USER=cn=${quote_ldap_dn:$1}
7485 .endd
7486 should work even if &$1$& contains spaces.
7487
7488 Expanded data for the PASS= value should be quoted using the &%quote%&
7489 expansion operator, rather than the LDAP quote operators. The only reason this
7490 field needs quoting is to ensure that it conforms to the Exim syntax, which
7491 does not allow unquoted spaces. For example:
7492 .code
7493 PASS=${quote:$3}
7494 .endd
7495 The LDAP authentication mechanism can be used to check passwords as part of
7496 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7497 &<<CHAPexpand>>&.
7498
7499
7500
7501 .section "Format of data returned by LDAP" "SECID71"
7502 .cindex "LDAP" "returned data formats"
7503 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7504 as a sequence of values, for example
7505 .code
7506 cn=manager,o=University of Cambridge,c=UK
7507 .endd
7508 The &(ldap)& lookup type generates an error if more than one entry matches the
7509 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7510 the result between the data from different entries. It is possible for multiple
7511 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7512 you know that whatever values are returned all came from a single entry in the
7513 directory.
7514
7515 In the common case where you specify a single attribute in your LDAP query, the
7516 result is not quoted, and does not contain the attribute name. If the attribute
7517 has multiple values, they are separated by commas. Any comma that is
7518 part of an attribute's value is doubled.
7519
7520 If you specify multiple attributes, the result contains space-separated, quoted
7521 strings, each preceded by the attribute name and an equals sign. Within the
7522 quotes, the quote character, backslash, and newline are escaped with
7523 backslashes, and commas are used to separate multiple values for the attribute.
7524 Any commas in attribute values are doubled
7525 (permitting treatment of the values as a comma-separated list).
7526 Apart from the escaping, the string within quotes takes the same form as the
7527 output when a single attribute is requested. Specifying no attributes is the
7528 same as specifying all of an entry's attributes.
7529
7530 Here are some examples of the output format. The first line of each pair is an
7531 LDAP query, and the second is the data that is returned. The attribute called
7532 &%attr1%& has two values, one of them with an embedded comma, whereas
7533 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7534 (they have SUP &%attr%& in their schema definitions).
7535
7536 .code
7537 ldap:///o=base?attr1?sub?(uid=fred)
7538 value1.1,value1,,2
7539
7540 ldap:///o=base?attr2?sub?(uid=fred)
7541 value two
7542
7543 ldap:///o=base?attr?sub?(uid=fred)
7544 value1.1,value1,,2,value two
7545
7546 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7547 attr1="value1.1,value1,,2" attr2="value two"
7548
7549 ldap:///o=base??sub?(uid=fred)
7550 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7551 .endd
7552 You can
7553 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7554 results of LDAP lookups.
7555 The &%extract%& operator in string expansions can be used to pick out
7556 individual fields from data that consists of &'key'&=&'value'& pairs.
7557 The &%listextract%& operator should be used to pick out individual values
7558 of attributes, even when only a single value is expected.
7559 The doubling of embedded commas allows you to use the returned data as a
7560 comma separated list (using the "<," syntax for changing the input list separator).
7561
7562
7563
7564
7565 .section "More about NIS+" "SECTnisplus"
7566 .cindex "NIS+ lookup type"
7567 .cindex "lookup" "NIS+"
7568 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7569 and field name. If this is given, the result of a successful query is the
7570 contents of the named field; otherwise the result consists of a concatenation
7571 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7572 values containing spaces are quoted. For example, the query
7573 .code
7574 [name=mg1456],passwd.org_dir
7575 .endd
7576 might return the string
7577 .code
7578 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7579 home=/home/mg1456 shell=/bin/bash shadow=""
7580 .endd
7581 (split over two lines here to fit on the page), whereas
7582 .code
7583 [name=mg1456],passwd.org_dir:gcos
7584 .endd
7585 would just return
7586 .code
7587 Martin Guerre
7588 .endd
7589 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7590 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7591 operator is to double any quote characters within the text.
7592
7593
7594
7595 .section "SQL lookups" "SECTsql"
7596 .cindex "SQL lookup types"
7597 .cindex "MySQL" "lookup type"
7598 .cindex "PostgreSQL lookup type"
7599 .cindex "lookup" "MySQL"
7600 .cindex "lookup" "PostgreSQL"
7601 .cindex "Oracle" "lookup type"
7602 .cindex "lookup" "Oracle"
7603 .cindex "InterBase lookup type"
7604 .cindex "lookup" "InterBase"
7605 .cindex "Redis lookup type"
7606 .cindex lookup Redis
7607 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7608 and SQLite
7609 databases. Queries for these databases contain SQL statements, so an example
7610 might be
7611 .code
7612 ${lookup mysql{select mailbox from users where id='userx'}\
7613   {$value}fail}
7614 .endd
7615 If the result of the query contains more than one field, the data for each
7616 field in the row is returned, preceded by its name, so the result of
7617 .code
7618 ${lookup pgsql{select home,name from users where id='userx'}\
7619   {$value}}
7620 .endd
7621 might be
7622 .code
7623 home=/home/userx name="Mister X"
7624 .endd
7625 Empty values and values containing spaces are double quoted, with embedded
7626 quotes escaped by a backslash. If the result of the query contains just one
7627 field, the value is passed back verbatim, without a field name, for example:
7628 .code
7629 Mister X
7630 .endd
7631 If the result of the query yields more than one row, it is all concatenated,
7632 with a newline between the data for each row.
7633
7634
7635 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7636 .cindex "MySQL" "lookup type"
7637 .cindex "PostgreSQL lookup type"
7638 .cindex "lookup" "MySQL"
7639 .cindex "lookup" "PostgreSQL"
7640 .cindex "Oracle" "lookup type"
7641 .cindex "lookup" "Oracle"
7642 .cindex "InterBase lookup type"
7643 .cindex "lookup" "InterBase"
7644 .cindex "Redis lookup type"
7645 .cindex lookup Redis
7646 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7647 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7648 or &%redis_servers%&
7649 option (as appropriate) must be set to a colon-separated list of server
7650 information.
7651 (For MySQL and PostgreSQL, the global option need not be set if all
7652 queries contain their own server information &-- see section
7653 &<<SECTspeserque>>&.)
7654 For all but Redis
7655 each item in the list is a slash-separated list of four
7656 items: host name, database name, user name, and password. In the case of
7657 Oracle, the host name field is used for the &"service name"&, and the database
7658 name field is not used and should be empty. For example:
7659 .code
7660 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7661 .endd
7662 Because password data is sensitive, you should always precede the setting with
7663 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7664 option. Here is an example where two MySQL servers are listed:
7665 .code
7666 hide mysql_servers = localhost/users/root/secret:\
7667                      otherhost/users/root/othersecret
7668 .endd
7669 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7670 because this is a colon-separated list, the colon has to be doubled. For each
7671 query, these parameter groups are tried in order until a connection is made and
7672 a query is successfully processed. The result of a query may be that no data is
7673 found, but that is still a successful query. In other words, the list of
7674 servers provides a backup facility, not a list of different places to look.
7675
7676 For Redis the global option need not be specified if all queries contain their
7677 own server information &-- see section &<<SECTspeserque>>&.
7678 If specified, the option must be set to a colon-separated list of server
7679 information.
7680 Each item in the list is a slash-separated list of three items:
7681 host, database number, and password.
7682 .olist
7683 The host is required and may be either an IPv4 address and optional
7684 port number (separated by a colon, which needs doubling due to the
7685 higher-level list), or a Unix socket pathname enclosed in parentheses
7686 .next
7687 The database number is optional; if present that number is selected in the backend
7688 .next
7689 The password is optional; if present it is used to authenticate to the backend
7690 .endlist
7691
7692 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7693 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7694 respectively, and the characters single-quote, double-quote, and backslash
7695 itself are escaped with backslashes.
7696
7697 The &%quote_redis%& expansion operator
7698 escapes whitespace and backslash characters with a backslash.
7699
7700 .section "Specifying the server in the query" "SECTspeserque"
7701 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7702 it is possible to specify a list of servers with an individual query. This is
7703 done by starting the query with
7704 .display
7705 &`servers=`&&'server1:server2:server3:...'&&`;`&
7706 .endd
7707 Each item in the list may take one of two forms:
7708 .olist
7709 If it contains no slashes it is assumed to be just a host name. The appropriate
7710 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7711 of the same name, and the remaining parameters (database, user, password) are
7712 taken from there.
7713 .next
7714 If it contains any slashes, it is taken as a complete parameter set.
7715 .endlist
7716 The list of servers is used in exactly the same way as the global list.
7717 Once a connection to a server has happened and a query has been
7718 successfully executed, processing of the lookup ceases.
7719
7720 This feature is intended for use in master/slave situations where updates
7721 are occurring and you want to update the master rather than a slave. If the
7722 master is in the list as a backup for reading, you might have a global setting
7723 like this:
7724 .code
7725 mysql_servers = slave1/db/name/pw:\
7726                 slave2/db/name/pw:\
7727                 master/db/name/pw
7728 .endd
7729 In an updating lookup, you could then write:
7730 .code
7731 ${lookup mysql{servers=master; UPDATE ...} }
7732 .endd
7733 That query would then be sent only to the master server. If, on the other hand,
7734 the master is not to be used for reading, and so is not present in the global
7735 option, you can still update it by a query of this form:
7736 .code
7737 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7738 .endd
7739
7740
7741 .section "Special MySQL features" "SECID73"
7742 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7743 causes a connection to the server on the local host by means of a Unix domain
7744 socket. An alternate socket can be specified in parentheses.
7745 An option group name for MySQL option files can be specified in square brackets;
7746 the default value is &"exim"&.
7747 The full syntax of each item in &%mysql_servers%& is:
7748 .display
7749 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7750   <&'database'&>/<&'user'&>/<&'password'&>
7751 .endd
7752 Any of the four sub-parts of the first field can be omitted. For normal use on
7753 the local host it can be left blank or set to just &"localhost"&.
7754
7755 No database need be supplied &-- but if it is absent here, it must be given in
7756 the queries.
7757
7758 If a MySQL query is issued that does not request any data (an insert, update,
7759 or delete command), the result of the lookup is the number of rows affected.
7760
7761 &*Warning*&: This can be misleading. If an update does not actually change
7762 anything (for example, setting a field to the value it already has), the result
7763 is zero because no rows are affected.
7764
7765
7766 .section "Special PostgreSQL features" "SECID74"
7767 PostgreSQL lookups can also use Unix domain socket connections to the database.
7768 This is usually faster and costs less CPU time than a TCP/IP connection.
7769 However it can be used only if the mail server runs on the same machine as the
7770 database server. A configuration line for PostgreSQL via Unix domain sockets
7771 looks like this:
7772 .code
7773 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7774 .endd
7775 In other words, instead of supplying a host name, a path to the socket is
7776 given. The path name is enclosed in parentheses so that its slashes aren't
7777 visually confused with the delimiters for the other server parameters.
7778
7779 If a PostgreSQL query is issued that does not request any data (an insert,
7780 update, or delete command), the result of the lookup is the number of rows
7781 affected.
7782
7783 .section "More about SQLite" "SECTsqlite"
7784 .cindex "lookup" "SQLite"
7785 .cindex "sqlite lookup type"
7786 SQLite is different to the other SQL lookups because a file name is required in
7787 addition to the SQL query. An SQLite database is a single file, and there is no
7788 daemon as in the other SQL databases. The interface to Exim requires the name
7789 of the file, as an absolute path, to be given at the start of the query. It is
7790 separated from the query by white space. This means that the path name cannot
7791 contain white space. Here is a lookup expansion example:
7792 .code
7793 ${lookup sqlite {/some/thing/sqlitedb \
7794   select name from aliases where id='userx';}}
7795 .endd
7796 In a list, the syntax is similar. For example:
7797 .code
7798 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
7799    select * from relays where ip='$sender_host_address';
7800 .endd
7801 The only character affected by the &%quote_sqlite%& operator is a single
7802 quote, which it doubles.
7803
7804 .cindex timeout SQLite
7805 .cindex sqlite "lookup timeout"
7806 The SQLite library handles multiple simultaneous accesses to the database
7807 internally. Multiple readers are permitted, but only one process can
7808 update at once. Attempts to access the database while it is being updated
7809 are rejected after a timeout period, during which the SQLite library
7810 waits for the lock to be released. In Exim, the default timeout is set
7811 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
7812 option.
7813
7814 .section "More about Redis" "SECTredis"
7815 .cindex "lookup" "Redis"
7816 .cindex "redis lookup type"
7817 Redis is a non-SQL database. Commands are simple get and set.
7818 Examples:
7819 .code
7820 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
7821 ${lookup redis{get keyname}}
7822 .endd
7823
7824 .ecindex IIDfidalo1
7825 .ecindex IIDfidalo2
7826
7827
7828 . ////////////////////////////////////////////////////////////////////////////
7829 . ////////////////////////////////////////////////////////////////////////////
7830
7831 .chapter "Domain, host, address, and local part lists" &&&
7832          "CHAPdomhosaddlists" &&&
7833          "Domain, host, and address lists"
7834 .scindex IIDdohoadli "lists of domains; hosts; etc."
7835 A number of Exim configuration options contain lists of domains, hosts,
7836 email addresses, or local parts. For example, the &%hold_domains%& option
7837 contains a list of domains whose delivery is currently suspended. These lists
7838 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
7839 arguments to expansion conditions such as &%match_domain%&.
7840
7841 Each item in one of these lists is a pattern to be matched against a domain,
7842 host, email address, or local part, respectively. In the sections below, the
7843 different types of pattern for each case are described, but first we cover some
7844 general facilities that apply to all four kinds of list.
7845
7846 Note that other parts of Exim use a &'string list'& which does not
7847 support all the complexity available in
7848 domain, host, address and local part lists.
7849
7850
7851
7852 .section "Expansion of lists" "SECTlistexpand"
7853 .cindex "expansion" "of lists"
7854 Each list is expanded as a single string before it is used.
7855
7856 &'Exception: the router headers_remove option, where list-item
7857 splitting is done before string-expansion.'&
7858
7859 The result of
7860 expansion must be a list, possibly containing empty items, which is split up
7861 into separate items for matching. By default, colon is the separator character,
7862 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
7863 &<<SECTempitelis>>& for details of the list syntax; the second of these
7864 discusses the way to specify empty list items.
7865
7866
7867 If the string expansion is forced to fail, Exim behaves as if the item it is
7868 testing (domain, host, address, or local part) is not in the list. Other
7869 expansion failures cause temporary errors.
7870
7871 If an item in a list is a regular expression, backslashes, dollars and possibly
7872 other special characters in the expression must be protected against
7873 misinterpretation by the string expander. The easiest way to do this is to use
7874 the &`\N`& expansion feature to indicate that the contents of the regular
7875 expression should not be expanded. For example, in an ACL you might have:
7876 .code
7877 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
7878                ${lookup{$domain}lsearch{/badsenders/bydomain}}
7879 .endd
7880 The first item is a regular expression that is protected from expansion by
7881 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
7882 senders based on the receiving domain.
7883
7884
7885
7886
7887 .section "Negated items in lists" "SECID76"
7888 .cindex "list" "negation"
7889 .cindex "negation" "in lists"
7890 Items in a list may be positive or negative. Negative items are indicated by a
7891 leading exclamation mark, which may be followed by optional white space. A list
7892 defines a set of items (domains, etc). When Exim processes one of these lists,
7893 it is trying to find out whether a domain, host, address, or local part
7894 (respectively) is in the set that is defined by the list. It works like this:
7895
7896 The list is scanned from left to right. If a positive item is matched, the
7897 subject that is being checked is in the set; if a negative item is matched, the
7898 subject is not in the set. If the end of the list is reached without the
7899 subject having matched any of the patterns, it is in the set if the last item
7900 was a negative one, but not if it was a positive one. For example, the list in
7901 .code
7902 domainlist relay_to_domains = !a.b.c : *.b.c
7903 .endd
7904 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
7905 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
7906 list is positive. However, if the setting were
7907 .code
7908 domainlist relay_to_domains = !a.b.c
7909 .endd
7910 then all domains other than &'a.b.c'& would match because the last item in the
7911 list is negative. In other words, a list that ends with a negative item behaves
7912 as if it had an extra item &`:*`& on the end.
7913
7914 Another way of thinking about positive and negative items in lists is to read
7915 the connector as &"or"& after a positive item and as &"and"& after a negative
7916 item.
7917
7918
7919
7920 .section "File names in lists" "SECTfilnamlis"
7921 .cindex "list" "file name in"
7922 If an item in a domain, host, address, or local part list is an absolute file
7923 name (beginning with a slash character), each line of the file is read and
7924 processed as if it were an independent item in the list, except that further
7925 file names are not allowed,
7926 and no expansion of the data from the file takes place.
7927 Empty lines in the file are ignored, and the file may also contain comment
7928 lines:
7929
7930 .ilist
7931 For domain and host lists, if a # character appears anywhere in a line of the
7932 file, it and all following characters are ignored.
7933 .next
7934 Because local parts may legitimately contain # characters, a comment in an
7935 address list or local part list file is recognized only if # is preceded by
7936 white space or the start of the line. For example:
7937 .code
7938 not#comment@x.y.z   # but this is a comment
7939 .endd
7940 .endlist
7941
7942 Putting a file name in a list has the same effect as inserting each line of the
7943 file as an item in the list (blank lines and comments excepted). However, there
7944 is one important difference: the file is read each time the list is processed,
7945 so if its contents vary over time, Exim's behaviour changes.
7946
7947 If a file name is preceded by an exclamation mark, the sense of any match
7948 within the file is inverted. For example, if
7949 .code
7950 hold_domains = !/etc/nohold-domains
7951 .endd
7952 and the file contains the lines
7953 .code
7954 !a.b.c
7955 *.b.c
7956 .endd
7957 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
7958 any domain matching &`*.b.c`& is not.
7959
7960
7961
7962 .section "An lsearch file is not an out-of-line list" "SECID77"
7963 As will be described in the sections that follow, lookups can be used in lists
7964 to provide indexed methods of checking list membership. There has been some
7965 confusion about the way &(lsearch)& lookups work in lists. Because
7966 an &(lsearch)& file contains plain text and is scanned sequentially, it is
7967 sometimes thought that it is allowed to contain wild cards and other kinds of
7968 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
7969 always fixed strings, just as for any other single-key lookup type.
7970
7971 If you want to use a file to contain wild-card patterns that form part of a
7972 list, just give the file name on its own, without a search type, as described
7973 in the previous section. You could also use the &(wildlsearch)& or
7974 &(nwildlsearch)&, but there is no advantage in doing this.
7975
7976
7977
7978
7979 .section "Named lists" "SECTnamedlists"
7980 .cindex "named lists"
7981 .cindex "list" "named"
7982 A list of domains, hosts, email addresses, or local parts can be given a name
7983 which is then used to refer to the list elsewhere in the configuration. This is
7984 particularly convenient if the same list is required in several different
7985 places. It also allows lists to be given meaningful names, which can improve
7986 the readability of the configuration. For example, it is conventional to define
7987 a domain list called &'local_domains'& for all the domains that are handled
7988 locally on a host, using a configuration line such as
7989 .code
7990 domainlist local_domains = localhost:my.dom.example
7991 .endd
7992 Named lists are referenced by giving their name preceded by a plus sign, so,
7993 for example, a router that is intended to handle local domains would be
7994 configured with the line
7995 .code
7996 domains = +local_domains
7997 .endd
7998 The first router in a configuration is often one that handles all domains
7999 except the local ones, using a configuration with a negated item like this:
8000 .code
8001 dnslookup:
8002   driver = dnslookup
8003   domains = ! +local_domains
8004   transport = remote_smtp
8005   no_more
8006 .endd
8007 The four kinds of named list are created by configuration lines starting with
8008 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8009 respectively. Then there follows the name that you are defining, followed by an
8010 equals sign and the list itself. For example:
8011 .code
8012 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8013 addresslist bad_senders = cdb;/etc/badsenders
8014 .endd
8015 A named list may refer to other named lists:
8016 .code
8017 domainlist  dom1 = first.example : second.example
8018 domainlist  dom2 = +dom1 : third.example
8019 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8020 .endd
8021 &*Warning*&: If the last item in a referenced list is a negative one, the
8022 effect may not be what you intended, because the negation does not propagate
8023 out to the higher level. For example, consider:
8024 .code
8025 domainlist  dom1 = !a.b
8026 domainlist  dom2 = +dom1 : *.b
8027 .endd
8028 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8029 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8030 means it matches the second list as well. The effect is not the same as
8031 .code
8032 domainlist  dom2 = !a.b : *.b
8033 .endd
8034 where &'x.y'& does not match. It's best to avoid negation altogether in
8035 referenced lists if you can.
8036
8037 Named lists may have a performance advantage. When Exim is routing an
8038 address or checking an incoming message, it caches the result of tests on named
8039 lists. So, if you have a setting such as
8040 .code
8041 domains = +local_domains
8042 .endd
8043 on several of your routers
8044 or in several ACL statements,
8045 the actual test is done only for the first one. However, the caching works only
8046 if there are no expansions within the list itself or any sublists that it
8047 references. In other words, caching happens only for lists that are known to be
8048 the same each time they are referenced.
8049
8050 By default, there may be up to 16 named lists of each type. This limit can be
8051 extended by changing a compile-time variable. The use of domain and host lists
8052 is recommended for concepts such as local domains, relay domains, and relay
8053 hosts. The default configuration is set up like this.
8054
8055
8056
8057 .section "Named lists compared with macros" "SECID78"
8058 .cindex "list" "named compared with macro"
8059 .cindex "macro" "compared with named list"
8060 At first sight, named lists might seem to be no different from macros in the
8061 configuration file. However, macros are just textual substitutions. If you
8062 write
8063 .code
8064 ALIST = host1 : host2
8065 auth_advertise_hosts = !ALIST
8066 .endd
8067 it probably won't do what you want, because that is exactly the same as
8068 .code
8069 auth_advertise_hosts = !host1 : host2
8070 .endd
8071 Notice that the second host name is not negated. However, if you use a host
8072 list, and write
8073 .code
8074 hostlist alist = host1 : host2
8075 auth_advertise_hosts = ! +alist
8076 .endd
8077 the negation applies to the whole list, and so that is equivalent to
8078 .code
8079 auth_advertise_hosts = !host1 : !host2
8080 .endd
8081
8082
8083 .section "Named list caching" "SECID79"
8084 .cindex "list" "caching of named"
8085 .cindex "caching" "named lists"
8086 While processing a message, Exim caches the result of checking a named list if
8087 it is sure that the list is the same each time. In practice, this means that
8088 the cache operates only if the list contains no $ characters, which guarantees
8089 that it will not change when it is expanded. Sometimes, however, you may have
8090 an expanded list that you know will be the same each time within a given
8091 message. For example:
8092 .code
8093 domainlist special_domains = \
8094            ${lookup{$sender_host_address}cdb{/some/file}}
8095 .endd
8096 This provides a list of domains that depends only on the sending host's IP
8097 address. If this domain list is referenced a number of times (for example,
8098 in several ACL lines, or in several routers) the result of the check is not
8099 cached by default, because Exim does not know that it is going to be the
8100 same list each time.
8101
8102 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8103 cache the result anyway. For example:
8104 .code
8105 domainlist_cache special_domains = ${lookup{...
8106 .endd
8107 If you do this, you should be absolutely sure that caching is going to do
8108 the right thing in all cases. When in doubt, leave it out.
8109
8110
8111
8112 .section "Domain lists" "SECTdomainlist"
8113 .cindex "domain list" "patterns for"
8114 .cindex "list" "domain list"
8115 Domain lists contain patterns that are to be matched against a mail domain.
8116 The following types of item may appear in domain lists:
8117
8118 .ilist
8119 .cindex "primary host name"
8120 .cindex "host name" "matched in domain list"
8121 .oindex "&%primary_hostname%&"
8122 .cindex "domain list" "matching primary host name"
8123 .cindex "@ in a domain list"
8124 If a pattern consists of a single @ character, it matches the local host name,
8125 as set by the &%primary_hostname%& option (or defaulted). This makes it
8126 possible to use the same configuration file on several different hosts that
8127 differ only in their names.
8128 .next
8129 .cindex "@[] in a domain list"
8130 .cindex "domain list" "matching local IP interfaces"
8131 .cindex "domain literal"
8132 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8133 in square brackets (as in an email address that contains a domain literal), but
8134 only if that IP address is recognized as local for email routing purposes. The
8135 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8136 control which of a host's several IP addresses are treated as local.
8137 In today's Internet, the use of domain literals is controversial.
8138 .next
8139 .cindex "@mx_any"
8140 .cindex "@mx_primary"
8141 .cindex "@mx_secondary"
8142 .cindex "domain list" "matching MX pointers to local host"
8143 If a pattern consists of the string &`@mx_any`& it matches any domain that
8144 has an MX record pointing to the local host or to any host that is listed in
8145 .oindex "&%hosts_treat_as_local%&"
8146 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8147 are similar, except that the first matches only when a primary MX target is the
8148 local host, and the second only when no primary MX target is the local host,
8149 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8150 preference value &-- there may of course be more than one of them.
8151
8152 The MX lookup that takes place when matching a pattern of this type is
8153 performed with the resolver options for widening names turned off. Thus, for
8154 example, a single-component domain will &'not'& be expanded by adding the
8155 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8156 options of the &(dnslookup)& router for a discussion of domain widening.
8157
8158 Sometimes you may want to ignore certain IP addresses when using one of these
8159 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8160 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8161 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8162 on a router). For example:
8163 .code
8164 domains = @mx_any/ignore=127.0.0.1
8165 .endd
8166 This example matches any domain that has an MX record pointing to one of
8167 the local host's IP addresses other than 127.0.0.1.
8168
8169 The list of IP addresses is in fact processed by the same code that processes
8170 host lists, so it may contain CIDR-coded network specifications and it may also
8171 contain negative items.
8172
8173 Because the list of IP addresses is a sublist within a domain list, you have to
8174 be careful about delimiters if there is more than one address. Like any other
8175 list, the default delimiter can be changed. Thus, you might have:
8176 .code
8177 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8178           an.other.domain : ...
8179 .endd
8180 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8181 involved, it is easiest to change the delimiter for the main list as well:
8182 .code
8183 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8184           an.other.domain ? ...
8185 .endd
8186 .next
8187 .cindex "asterisk" "in domain list"
8188 .cindex "domain list" "asterisk in"
8189 .cindex "domain list" "matching &""ends with""&"
8190 If a pattern starts with an asterisk, the remaining characters of the pattern
8191 are compared with the terminating characters of the domain. The use of &"*"& in
8192 domain lists differs from its use in partial matching lookups. In a domain
8193 list, the character following the asterisk need not be a dot, whereas partial
8194 matching works only in terms of dot-separated components. For example, a domain
8195 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8196 &'cipher.key.ex'&.
8197
8198 .next
8199 .cindex "regular expressions" "in domain list"
8200 .cindex "domain list" "matching regular expression"
8201 If a pattern starts with a circumflex character, it is treated as a regular
8202 expression, and matched against the domain using a regular expression matching
8203 function. The circumflex is treated as part of the regular expression.
8204 Email domains are case-independent, so this regular expression match is by
8205 default case-independent, but you can make it case-dependent by starting it
8206 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8207 are given in chapter &<<CHAPregexp>>&.
8208
8209 &*Warning*&: Because domain lists are expanded before being processed, you
8210 must escape any backslash and dollar characters in the regular expression, or
8211 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8212 it is not to be expanded (unless you really do want to build a regular
8213 expression by expansion, of course).
8214 .next
8215 .cindex "lookup" "in domain list"
8216 .cindex "domain list" "matching by lookup"
8217 If a pattern starts with the name of a single-key lookup type followed by a
8218 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8219 must be a file name in a suitable format for the lookup type. For example, for
8220 &"cdb;"& it must be an absolute path:
8221 .code
8222 domains = cdb;/etc/mail/local_domains.cdb
8223 .endd
8224 The appropriate type of lookup is done on the file using the domain name as the
8225 key. In most cases, the data that is looked up is not used; Exim is interested
8226 only in whether or not the key is present in the file. However, when a lookup
8227 is used for the &%domains%& option on a router
8228 or a &%domains%& condition in an ACL statement, the data is preserved in the
8229 &$domain_data$& variable and can be referred to in other router options or
8230 other statements in the same ACL.
8231
8232 .next
8233 Any of the single-key lookup type names may be preceded by
8234 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8235 .code
8236 domains = partial-dbm;/partial/domains
8237 .endd
8238 This causes partial matching logic to be invoked; a description of how this
8239 works is given in section &<<SECTpartiallookup>>&.
8240
8241 .next
8242 .cindex "asterisk" "in lookup type"
8243 Any of the single-key lookup types may be followed by an asterisk. This causes
8244 a default lookup for a key consisting of a single asterisk to be done if the
8245 original lookup fails. This is not a useful feature when using a domain list to
8246 select particular domains (because any domain would match), but it might have
8247 value if the result of the lookup is being used via the &$domain_data$&
8248 expansion variable.
8249 .next
8250 If the pattern starts with the name of a query-style lookup type followed by a
8251 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8252 pattern must be an appropriate query for the lookup type, as described in
8253 chapter &<<CHAPfdlookup>>&. For example:
8254 .code
8255 hold_domains = mysql;select domain from holdlist \
8256   where domain = '${quote_mysql:$domain}';
8257 .endd
8258 In most cases, the data that is looked up is not used (so for an SQL query, for
8259 example, it doesn't matter what field you select). Exim is interested only in
8260 whether or not the query succeeds. However, when a lookup is used for the
8261 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8262 variable and can be referred to in other options.
8263 .next
8264 .cindex "domain list" "matching literal domain name"
8265 If none of the above cases apply, a caseless textual comparison is made
8266 between the pattern and the domain.
8267 .endlist
8268
8269 Here is an example that uses several different kinds of pattern:
8270 .code
8271 domainlist funny_domains = \
8272   @ : \
8273   lib.unseen.edu : \
8274   *.foundation.fict.example : \
8275   \N^[1-2]\d{3}\.fict\.example$\N : \
8276   partial-dbm;/opt/data/penguin/book : \
8277   nis;domains.byname : \
8278   nisplus;[name=$domain,status=local],domains.org_dir
8279 .endd
8280 There are obvious processing trade-offs among the various matching modes. Using
8281 an asterisk is faster than a regular expression, and listing a few names
8282 explicitly probably is too. The use of a file or database lookup is expensive,
8283 but may be the only option if hundreds of names are required. Because the
8284 patterns are tested in order, it makes sense to put the most commonly matched
8285 patterns earlier.
8286
8287
8288
8289 .section "Host lists" "SECThostlist"
8290 .cindex "host list" "patterns in"
8291 .cindex "list" "host list"
8292 Host lists are used to control what remote hosts are allowed to do. For
8293 example, some hosts may be allowed to use the local host as a relay, and some
8294 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8295 two different ways, by name or by IP address. In a host list, some types of
8296 pattern are matched to a host name, and some are matched to an IP address.
8297 You need to be particularly careful with this when single-key lookups are
8298 involved, to ensure that the right value is being used as the key.
8299
8300
8301 .section "Special host list patterns" "SECID80"
8302 .cindex "empty item in hosts list"
8303 .cindex "host list" "empty string in"
8304 If a host list item is the empty string, it matches only when no remote host is
8305 involved. This is the case when a message is being received from a local
8306 process using SMTP on the standard input, that is, when a TCP/IP connection is
8307 not used.
8308
8309 .cindex "asterisk" "in host list"
8310 The special pattern &"*"& in a host list matches any host or no host. Neither
8311 the IP address nor the name is actually inspected.
8312
8313
8314
8315 .section "Host list patterns that match by IP address" "SECThoslispatip"
8316 .cindex "host list" "matching IP addresses"
8317 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8318 the incoming address actually appears in the IPv6 host as
8319 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8320 list, it is converted into a traditional IPv4 address first. (Not all operating
8321 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8322 concerns.)
8323
8324 The following types of pattern in a host list check the remote host by
8325 inspecting its IP address:
8326
8327 .ilist
8328 If the pattern is a plain domain name (not a regular expression, not starting
8329 with *, not a lookup of any kind), Exim calls the operating system function
8330 to find the associated IP address(es). Exim uses the newer
8331 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8332 This typically causes a forward DNS lookup of the name. The result is compared
8333 with the IP address of the subject host.
8334
8335 If there is a temporary problem (such as a DNS timeout) with the host name
8336 lookup, a temporary error occurs. For example, if the list is being used in an
8337 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8338 temporary SMTP error code. If no IP address can be found for the host name,
8339 what happens is described in section &<<SECTbehipnot>>& below.
8340
8341 .next
8342 .cindex "@ in a host list"
8343 If the pattern is &"@"&, the primary host name is substituted and used as a
8344 domain name, as just described.
8345
8346 .next
8347 If the pattern is an IP address, it is matched against the IP address of the
8348 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8349 IPv6 addresses can be given in colon-separated format, but the colons have to
8350 be doubled so as not to be taken as item separators when the default list
8351 separator is used. IPv6 addresses are recognized even when Exim is compiled
8352 without IPv6 support. This means that if they appear in a host list on an
8353 IPv4-only host, Exim will not treat them as host names. They are just addresses
8354 that can never match a client host.
8355
8356 .next
8357 .cindex "@[] in a host list"
8358 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8359 the local host. For example, if the local host is an IPv4 host with one
8360 interface address 10.45.23.56, these two ACL statements have the same effect:
8361 .code
8362 accept hosts = 127.0.0.1 : 10.45.23.56
8363 accept hosts = @[]
8364 .endd
8365 .next
8366 .cindex "CIDR notation"
8367 If the pattern is an IP address followed by a slash and a mask length (for
8368 example 10.11.42.0/24), it is matched against the IP address of the subject
8369 host under the given mask. This allows, an entire network of hosts to be
8370 included (or excluded) by a single item. The mask uses CIDR notation; it
8371 specifies the number of address bits that must match, starting from the most
8372 significant end of the address.
8373
8374 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8375 of a range of addresses. It is the number of bits in the network portion of the
8376 address. The above example specifies a 24-bit netmask, so it matches all 256
8377 addresses in the 10.11.42.0 network. An item such as
8378 .code
8379 192.168.23.236/31
8380 .endd
8381 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8382 32 for an IPv4 address is the same as no mask at all; just a single address
8383 matches.
8384
8385 Here is another example which shows an IPv4 and an IPv6 network:
8386 .code
8387 recipient_unqualified_hosts = 192.168.0.0/16: \
8388                               3ffe::ffff::836f::::/48
8389 .endd
8390 The doubling of list separator characters applies only when these items
8391 appear inline in a host list. It is not required when indirecting via a file.
8392 For example:
8393 .code
8394 recipient_unqualified_hosts = /opt/exim/unqualnets
8395 .endd
8396 could make use of a file containing
8397 .code
8398 172.16.0.0/12
8399 3ffe:ffff:836f::/48
8400 .endd
8401 to have exactly the same effect as the previous example. When listing IPv6
8402 addresses inline, it is usually more convenient to use the facility for
8403 changing separator characters. This list contains the same two networks:
8404 .code
8405 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8406                                  3ffe:ffff:836f::/48
8407 .endd
8408 The separator is changed to semicolon by the leading &"<;"& at the start of the
8409 list.
8410 .endlist
8411
8412
8413
8414 .section "Host list patterns for single-key lookups by host address" &&&
8415          "SECThoslispatsikey"
8416 .cindex "host list" "lookup of IP address"
8417 When a host is to be identified by a single-key lookup of its complete IP
8418 address, the pattern takes this form:
8419 .display
8420 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8421 .endd
8422 For example:
8423 .code
8424 hosts_lookup = net-cdb;/hosts-by-ip.db
8425 .endd
8426 The text form of the IP address of the subject host is used as the lookup key.
8427 IPv6 addresses are converted to an unabbreviated form, using lower case
8428 letters, with dots as separators because colon is the key terminator in
8429 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8430 quoting the keys, but this is a facility that was added later.] The data
8431 returned by the lookup is not used.
8432
8433 .cindex "IP address" "masking"
8434 .cindex "host list" "masked IP address"
8435 Single-key lookups can also be performed using masked IP addresses, using
8436 patterns of this form:
8437 .display
8438 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8439 .endd
8440 For example:
8441 .code
8442 net24-dbm;/networks.db
8443 .endd
8444 The IP address of the subject host is masked using <&'number'&> as the mask
8445 length. A textual string is constructed from the masked value, followed by the
8446 mask, and this is used as the lookup key. For example, if the host's IP address
8447 is 192.168.34.6, the key that is looked up for the above example is
8448 &"192.168.34.0/24"&.
8449
8450 When an IPv6 address is converted to a string, dots are normally used instead
8451 of colons, so that keys in &(lsearch)& files need not contain colons (which
8452 terminate &(lsearch)& keys). This was implemented some time before the ability
8453 to quote keys was made available in &(lsearch)& files. However, the more
8454 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8455 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8456 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8457 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8458 addresses are always used.
8459
8460 Ideally, it would be nice to tidy up this anomalous situation by changing to
8461 colons in all cases, given that quoting is now available for &(lsearch)&.
8462 However, this would be an incompatible change that might break some existing
8463 configurations.
8464
8465 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8466 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8467 the former case the key strings include the mask value, whereas in the latter
8468 case the IP address is used on its own.
8469
8470
8471
8472 .section "Host list patterns that match by host name" "SECThoslispatnam"
8473 .cindex "host" "lookup failures"
8474 .cindex "unknown host name"
8475 .cindex "host list" "matching host name"
8476 There are several types of pattern that require Exim to know the name of the
8477 remote host. These are either wildcard patterns or lookups by name. (If a
8478 complete hostname is given without any wildcarding, it is used to find an IP
8479 address to match against, as described in section &<<SECThoslispatip>>&
8480 above.)
8481
8482 If the remote host name is not already known when Exim encounters one of these
8483 patterns, it has to be found from the IP address.
8484 Although many sites on the Internet are conscientious about maintaining reverse
8485 DNS data for their hosts, there are also many that do not do this.
8486 Consequently, a name cannot always be found, and this may lead to unwanted
8487 effects. Take care when configuring host lists with wildcarded name patterns.
8488 Consider what will happen if a name cannot be found.
8489
8490 Because of the problems of determining host names from IP addresses, matching
8491 against host names is not as common as matching against IP addresses.
8492
8493 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8494 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8495 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8496 are done can be changed by setting the &%host_lookup_order%& option. For
8497 security, once Exim has found one or more names, it looks up the IP addresses
8498 for these names and compares them with the IP address that it started with.
8499 Only those names whose IP addresses match are accepted. Any other names are
8500 discarded. If no names are left, Exim behaves as if the host name cannot be
8501 found. In the most common case there is only one name and one IP address.
8502
8503 There are some options that control what happens if a host name cannot be
8504 found. These are described in section &<<SECTbehipnot>>& below.
8505
8506 .cindex "host" "alias for"
8507 .cindex "alias for host"
8508 As a result of aliasing, hosts may have more than one name. When processing any
8509 of the following types of pattern, all the host's names are checked:
8510
8511 .ilist
8512 .cindex "asterisk" "in host list"
8513 If a pattern starts with &"*"& the remainder of the item must match the end of
8514 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8515 &'.b.c'&. This special simple form is provided because this is a very common
8516 requirement. Other kinds of wildcarding require the use of a regular
8517 expression.
8518 .next
8519 .cindex "regular expressions" "in host list"
8520 .cindex "host list" "regular expression in"
8521 If the item starts with &"^"& it is taken to be a regular expression which is
8522 matched against the host name. Host names are case-independent, so this regular
8523 expression match is by default case-independent, but you can make it
8524 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8525 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8526 example,
8527 .code
8528 ^(a|b)\.c\.d$
8529 .endd
8530 is a regular expression that matches either of the two hosts &'a.c.d'& or
8531 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8532 that backslash and dollar characters are not misinterpreted as part of the
8533 string expansion. The simplest way to do this is to use &`\N`& to mark that
8534 part of the string as non-expandable. For example:
8535 .code
8536 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8537 .endd
8538 &*Warning*&: If you want to match a complete host name, you must include the
8539 &`$`& terminating metacharacter in the regular expression, as in the above
8540 example. Without it, a match at the start of the host name is all that is
8541 required.
8542 .endlist
8543
8544
8545
8546
8547 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8548 .cindex "host" "lookup failures, permanent"
8549 While processing a host list, Exim may need to look up an IP address from a
8550 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8551 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8552 behaviour when it fails to find the information it is seeking is the same.
8553
8554 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8555 apply to temporary DNS errors, whose handling is described in the next section.
8556
8557 .cindex "&`+include_unknown`&"
8558 .cindex "&`+ignore_unknown`&"
8559 Exim parses a host list from left to right. If it encounters a permanent
8560 lookup failure in any item in the host list before it has found a match,
8561 Exim treats it as a failure and the default behavior is as if the host
8562 does not match the list. This may not always be what you want to happen.
8563 To change Exim's behaviour, the special items &`+include_unknown`& or
8564 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8565 not recognized in an indirected file).
8566
8567 .ilist
8568 If any item that follows &`+include_unknown`& requires information that
8569 cannot found, Exim behaves as if the host does match the list. For example,
8570 .code
8571 host_reject_connection = +include_unknown:*.enemy.ex
8572 .endd
8573 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8574 any hosts whose name it cannot find.
8575
8576 .next
8577 If any item that follows &`+ignore_unknown`& requires information that cannot
8578 be found, Exim ignores that item and proceeds to the rest of the list. For
8579 example:
8580 .code
8581 accept hosts = +ignore_unknown : friend.example : \
8582                192.168.4.5
8583 .endd
8584 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8585 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8586 name can be found for 192.168.4.5, it is rejected.
8587 .endlist
8588
8589 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8590 list. The effect of each one lasts until the next, or until the end of the
8591 list.
8592
8593 .section "Mixing wildcarded host names and addresses in host lists" &&&
8594          "SECTmixwilhos"
8595 .cindex "host list" "mixing names and addresses in"
8596
8597 This section explains the host/ip processing logic with the same concepts
8598 as the previous section, but specifically addresses what happens when a
8599 wildcarded hostname is one of the items in the hostlist.
8600
8601 .ilist
8602 If you have name lookups or wildcarded host names and
8603 IP addresses in the same host list, you should normally put the IP
8604 addresses first. For example, in an ACL you could have:
8605 .code
8606 accept hosts = 10.9.8.7 : *.friend.example
8607 .endd
8608 The reason you normally would order it this way lies in the
8609 left-to-right way that Exim processes lists.  It can test IP addresses
8610 without doing any DNS lookups, but when it reaches an item that requires
8611 a host name, it fails if it cannot find a host name to compare with the
8612 pattern. If the above list is given in the opposite order, the
8613 &%accept%& statement fails for a host whose name cannot be found, even
8614 if its IP address is 10.9.8.7.
8615
8616 .next
8617 If you really do want to do the name check first, and still recognize the IP
8618 address, you can rewrite the ACL like this:
8619 .code
8620 accept hosts = *.friend.example
8621 accept hosts = 10.9.8.7
8622 .endd
8623 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8624 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8625 &`+ignore_unknown`&, which was discussed in depth in the first example in
8626 this section.
8627 .endlist
8628
8629
8630 .section "Temporary DNS errors when looking up host information" &&&
8631          "SECTtemdnserr"
8632 .cindex "host" "lookup failures, temporary"
8633 .cindex "&`+include_defer`&"
8634 .cindex "&`+ignore_defer`&"
8635 A temporary DNS lookup failure normally causes a defer action (except when
8636 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8637 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8638 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8639 section. These options should be used with care, probably only in non-critical
8640 host lists such as whitelists.
8641
8642
8643
8644 .section "Host list patterns for single-key lookups by host name" &&&
8645          "SECThoslispatnamsk"
8646 .cindex "unknown host name"
8647 .cindex "host list" "matching host name"
8648 If a pattern is of the form
8649 .display
8650 <&'single-key-search-type'&>;<&'search-data'&>
8651 .endd
8652 for example
8653 .code
8654 dbm;/host/accept/list
8655 .endd
8656 a single-key lookup is performed, using the host name as its key. If the
8657 lookup succeeds, the host matches the item. The actual data that is looked up
8658 is not used.
8659
8660 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8661 keys in the file, not IP addresses. If you want to do lookups based on IP
8662 addresses, you must precede the search type with &"net-"& (see section
8663 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8664 two items in the same list, one doing an address lookup and one doing a name
8665 lookup, both using the same file.
8666
8667
8668
8669 .section "Host list patterns for query-style lookups" "SECID81"
8670 If a pattern is of the form
8671 .display
8672 <&'query-style-search-type'&>;<&'query'&>
8673 .endd
8674 the query is obeyed, and if it succeeds, the host matches the item. The actual
8675 data that is looked up is not used. The variables &$sender_host_address$& and
8676 &$sender_host_name$& can be used in the query. For example:
8677 .code
8678 hosts_lookup = pgsql;\
8679   select ip from hostlist where ip='$sender_host_address'
8680 .endd
8681 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8682 can use the &%sg%& expansion item to change this if you need to. If you want to
8683 use masked IP addresses in database queries, you can use the &%mask%& expansion
8684 operator.
8685
8686 If the query contains a reference to &$sender_host_name$&, Exim automatically
8687 looks up the host name if it has not already done so. (See section
8688 &<<SECThoslispatnam>>& for comments on finding host names.)
8689
8690 Historical note: prior to release 4.30, Exim would always attempt to find a
8691 host name before running the query, unless the search type was preceded by
8692 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8693 still recognized for query-style lookups, but its presence or absence has no
8694 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8695 See section &<<SECThoslispatsikey>>&.)
8696
8697
8698
8699
8700
8701 .section "Address lists" "SECTaddresslist"
8702 .cindex "list" "address list"
8703 .cindex "address list" "empty item"
8704 .cindex "address list" "patterns"
8705 Address lists contain patterns that are matched against mail addresses. There
8706 is one special case to be considered: the sender address of a bounce message is
8707 always empty. You can test for this by providing an empty item in an address
8708 list. For example, you can set up a router to process bounce messages by
8709 using this option setting:
8710 .code
8711 senders = :
8712 .endd
8713 The presence of the colon creates an empty item. If you do not provide any
8714 data, the list is empty and matches nothing. The empty sender can also be
8715 detected by a regular expression that matches an empty string,
8716 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8717
8718 Non-empty items in an address list can be straightforward email addresses. For
8719 example:
8720 .code
8721 senders = jbc@askone.example : hs@anacreon.example
8722 .endd
8723 A certain amount of wildcarding is permitted. If a pattern contains an @
8724 character, but is not a regular expression and does not begin with a
8725 semicolon-terminated lookup type (described below), the local part of the
8726 subject address is compared with the local part of the pattern, which may start
8727 with an asterisk. If the local parts match, the domain is checked in exactly
8728 the same way as for a pattern in a domain list. For example, the domain can be
8729 wildcarded, refer to a named list, or be a lookup:
8730 .code
8731 deny senders = *@*.spamming.site:\
8732                *@+hostile_domains:\
8733                bozo@partial-lsearch;/list/of/dodgy/sites:\
8734                *@dbm;/bad/domains.db
8735 .endd
8736 .cindex "local part" "starting with !"
8737 .cindex "address list" "local part starting with !"
8738 If a local part that begins with an exclamation mark is required, it has to be
8739 specified using a regular expression, because otherwise the exclamation mark is
8740 treated as a sign of negation, as is standard in lists.
8741
8742 If a non-empty pattern that is not a regular expression or a lookup does not
8743 contain an @ character, it is matched against the domain part of the subject
8744 address. The only two formats that are recognized this way are a literal
8745 domain, or a domain pattern that starts with *. In both these cases, the effect
8746 is the same as if &`*@`& preceded the pattern. For example:
8747 .code
8748 deny senders = enemy.domain : *.enemy.domain
8749 .endd
8750
8751 The following kinds of more complicated address list pattern can match any
8752 address, including the empty address that is characteristic of bounce message
8753 senders:
8754
8755 .ilist
8756 .cindex "regular expressions" "in address list"
8757 .cindex "address list" "regular expression in"
8758 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8759 done against the complete address, with the pattern as the regular expression.
8760 You must take care that backslash and dollar characters are not misinterpreted
8761 as part of the string expansion. The simplest way to do this is to use &`\N`&
8762 to mark that part of the string as non-expandable. For example:
8763 .code
8764 deny senders = \N^.*this.*@example\.com$\N : \
8765                \N^\d{8}.+@spamhaus.example$\N : ...
8766 .endd
8767 The &`\N`& sequences are removed by the expansion, so these items do indeed
8768 start with &"^"& by the time they are being interpreted as address patterns.
8769
8770 .next
8771 .cindex "address list" "lookup for complete address"
8772 Complete addresses can be looked up by using a pattern that starts with a
8773 lookup type terminated by a semicolon, followed by the data for the lookup. For
8774 example:
8775 .code
8776 deny senders = cdb;/etc/blocked.senders : \
8777   mysql;select address from blocked where \
8778   address='${quote_mysql:$sender_address}'
8779 .endd
8780 Both query-style and single-key lookup types can be used. For a single-key
8781 lookup type, Exim uses the complete address as the key. However, empty keys are
8782 not supported for single-key lookups, so a match against the empty address
8783 always fails. This restriction does not apply to query-style lookups.
8784
8785 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
8786 cannot be used, and is ignored if specified, with an entry being written to the
8787 panic log.
8788 .cindex "*@ with single-key lookup"
8789 However, you can configure lookup defaults, as described in section
8790 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
8791 default. For example, with this lookup:
8792 .code
8793 accept senders = lsearch*@;/some/file
8794 .endd
8795 the file could contains lines like this:
8796 .code
8797 user1@domain1.example
8798 *@domain2.example
8799 .endd
8800 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
8801 that are tried is:
8802 .code
8803 nimrod@jaeger.example
8804 *@jaeger.example
8805 *
8806 .endd
8807 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
8808 would mean that every address matches, thus rendering the test useless.
8809
8810 &*Warning 2*&: Do not confuse these two kinds of item:
8811 .code
8812 deny recipients = dbm*@;/some/file
8813 deny recipients = *@dbm;/some/file
8814 .endd
8815 The first does a whole address lookup, with defaulting, as just described,
8816 because it starts with a lookup type. The second matches the local part and
8817 domain independently, as described in a bullet point below.
8818 .endlist
8819
8820
8821 The following kinds of address list pattern can match only non-empty addresses.
8822 If the subject address is empty, a match against any of these pattern types
8823 always fails.
8824
8825
8826 .ilist
8827 .cindex "@@ with single-key lookup"
8828 .cindex "address list" "@@ lookup type"
8829 .cindex "address list" "split local part and domain"
8830 If a pattern starts with &"@@"& followed by a single-key lookup item
8831 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
8832 split into a local part and a domain. The domain is looked up in the file. If
8833 it is not found, there is no match. If it is found, the data that is looked up
8834 from the file is treated as a colon-separated list of local part patterns, each
8835 of which is matched against the subject local part in turn.
8836
8837 .cindex "asterisk" "in address list"
8838 The lookup may be a partial one, and/or one involving a search for a default
8839 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
8840 patterns that are looked up can be regular expressions or begin with &"*"&, or
8841 even be further lookups. They may also be independently negated. For example,
8842 with
8843 .code
8844 deny senders = @@dbm;/etc/reject-by-domain
8845 .endd
8846 the data from which the DBM file is built could contain lines like
8847 .code
8848 baddomain.com:  !postmaster : *
8849 .endd
8850 to reject all senders except &%postmaster%& from that domain.
8851
8852 .cindex "local part" "starting with !"
8853 If a local part that actually begins with an exclamation mark is required, it
8854 has to be specified using a regular expression. In &(lsearch)& files, an entry
8855 may be split over several lines by indenting the second and subsequent lines,
8856 but the separating colon must still be included at line breaks. White space
8857 surrounding the colons is ignored. For example:
8858 .code
8859 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
8860   spammer3 : spammer4
8861 .endd
8862 As in all colon-separated lists in Exim, a colon can be included in an item by
8863 doubling.
8864
8865 If the last item in the list starts with a right angle-bracket, the remainder
8866 of the item is taken as a new key to look up in order to obtain a continuation
8867 list of local parts. The new key can be any sequence of characters. Thus one
8868 might have entries like
8869 .code
8870 aol.com: spammer1 : spammer 2 : >*
8871 xyz.com: spammer3 : >*
8872 *:       ^\d{8}$
8873 .endd
8874 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
8875 local parts for all domains, in addition to the specific local parts listed for
8876 each domain. Of course, using this feature costs another lookup each time a
8877 chain is followed, but the effort needed to maintain the data is reduced.
8878
8879 .cindex "loop" "in lookups"
8880 It is possible to construct loops using this facility, and in order to catch
8881 them, the chains may be no more than fifty items long.
8882
8883 .next
8884 The @@<&'lookup'&> style of item can also be used with a query-style
8885 lookup, but in this case, the chaining facility is not available. The lookup
8886 can only return a single list of local parts.
8887 .endlist
8888
8889 &*Warning*&: There is an important difference between the address list items
8890 in these two examples:
8891 .code
8892 senders = +my_list
8893 senders = *@+my_list
8894 .endd
8895 In the first one, &`my_list`& is a named address list, whereas in the second
8896 example it is a named domain list.
8897
8898
8899
8900
8901 .section "Case of letters in address lists" "SECTcasletadd"
8902 .cindex "case of local parts"
8903 .cindex "address list" "case forcing"
8904 .cindex "case forcing in address lists"
8905 Domains in email addresses are always handled caselessly, but for local parts
8906 case may be significant on some systems (see &%caseful_local_part%& for how
8907 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
8908 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
8909 blocking lists should be done in a case-independent manner. Since most address
8910 lists in Exim are used for this kind of control, Exim attempts to do this by
8911 default.
8912
8913 The domain portion of an address is always lowercased before matching it to an
8914 address list. The local part is lowercased by default, and any string
8915 comparisons that take place are done caselessly. This means that the data in
8916 the address list itself, in files included as plain file names, and in any file
8917 that is looked up using the &"@@"& mechanism, can be in any case. However, the
8918 keys in files that are looked up by a search type other than &(lsearch)& (which
8919 works caselessly) must be in lower case, because these lookups are not
8920 case-independent.
8921
8922 .cindex "&`+caseful`&"
8923 To allow for the possibility of caseful address list matching, if an item in
8924 an address list is the string &"+caseful"&, the original case of the local
8925 part is restored for any comparisons that follow, and string comparisons are no
8926 longer case-independent. This does not affect the domain, which remains in
8927 lower case. However, although independent matches on the domain alone are still
8928 performed caselessly, regular expressions that match against an entire address
8929 become case-sensitive after &"+caseful"& has been seen.
8930
8931
8932
8933 .section "Local part lists" "SECTlocparlis"
8934 .cindex "list" "local part list"
8935 .cindex "local part" "list"
8936 Case-sensitivity in local part lists is handled in the same way as for address
8937 lists, as just described. The &"+caseful"& item can be used if required. In a
8938 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
8939 set false, the subject is lowercased and the matching is initially
8940 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
8941 matching in the local part list, but not elsewhere in the router. If
8942 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
8943 option is case-sensitive from the start.
8944
8945 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
8946 comments are handled in the same way as address lists &-- they are recognized
8947 only if the # is preceded by white space or the start of the line.
8948 Otherwise, local part lists are matched in the same way as domain lists, except
8949 that the special items that refer to the local host (&`@`&, &`@[]`&,
8950 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
8951 Refer to section &<<SECTdomainlist>>& for details of the other available item
8952 types.
8953 .ecindex IIDdohoadli
8954
8955
8956
8957
8958 . ////////////////////////////////////////////////////////////////////////////
8959 . ////////////////////////////////////////////////////////////////////////////
8960
8961 .chapter "String expansions" "CHAPexpand"
8962 .scindex IIDstrexp "expansion" "of strings"
8963 Many strings in Exim's run time configuration are expanded before use. Some of
8964 them are expanded every time they are used; others are expanded only once.
8965
8966 When a string is being expanded it is copied verbatim from left to right except
8967 when a dollar or backslash character is encountered. A dollar specifies the
8968 start of a portion of the string that is interpreted and replaced as described
8969 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
8970 escape character, as described in the following section.
8971
8972 Whether a string is expanded depends upon the context.  Usually this is solely
8973 dependent upon the option for which a value is sought; in this documentation,
8974 options for which string expansion is performed are marked with &dagger; after
8975 the data type.  ACL rules always expand strings.  A couple of expansion
8976 conditions do not expand some of the brace-delimited branches, for security
8977 reasons.
8978
8979
8980
8981 .section "Literal text in expanded strings" "SECTlittext"
8982 .cindex "expansion" "including literal text"
8983 An uninterpreted dollar can be included in an expanded string by putting a
8984 backslash in front of it. A backslash can be used to prevent any special
8985 character being treated specially in an expansion, including backslash itself.
8986 If the string appears in quotes in the configuration file, two backslashes are
8987 required because the quotes themselves cause interpretation of backslashes when
8988 the string is read in (see section &<<SECTstrings>>&).
8989
8990 .cindex "expansion" "non-expandable substrings"
8991 A portion of the string can specified as non-expandable by placing it between
8992 two occurrences of &`\N`&. This is particularly useful for protecting regular
8993 expressions, which often contain backslashes and dollar signs. For example:
8994 .code
8995 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
8996 .endd
8997 On encountering the first &`\N`&, the expander copies subsequent characters
8998 without interpretation until it reaches the next &`\N`& or the end of the
8999 string.
9000
9001
9002
9003 .section "Character escape sequences in expanded strings" "SECID82"
9004 .cindex "expansion" "escape sequences"
9005 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9006 expanded string is recognized as an escape sequence for the character newline,
9007 carriage return, or tab, respectively. A backslash followed by up to three
9008 octal digits is recognized as an octal encoding for a single character, and a
9009 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9010 encoding.
9011
9012 These escape sequences are also recognized in quoted strings when they are read
9013 in. Their interpretation in expansions as well is useful for unquoted strings,
9014 and for other cases such as looked-up strings that are then expanded.
9015
9016
9017 .section "Testing string expansions" "SECID83"
9018 .cindex "expansion" "testing"
9019 .cindex "testing" "string expansion"
9020 .oindex "&%-be%&"
9021 Many expansions can be tested by calling Exim with the &%-be%& option. This
9022 takes the command arguments, or lines from the standard input if there are no
9023 arguments, runs them through the string expansion code, and writes the results
9024 to the standard output. Variables based on configuration values are set up, but
9025 since no message is being processed, variables such as &$local_part$& have no
9026 value. Nevertheless the &%-be%& option can be useful for checking out file and
9027 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9028 and &%nhash%&.
9029
9030 Exim gives up its root privilege when it is called with the &%-be%& option, and
9031 instead runs under the uid and gid it was called with, to prevent users from
9032 using &%-be%& for reading files to which they do not have access.
9033
9034 .oindex "&%-bem%&"
9035 If you want to test expansions that include variables whose values are taken
9036 from a message, there are two other options that can be used. The &%-bem%&
9037 option is like &%-be%& except that it is followed by a file name. The file is
9038 read as a message before doing the test expansions. For example:
9039 .code
9040 exim -bem /tmp/test.message '$h_subject:'
9041 .endd
9042 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9043 Exim message identifier. For example:
9044 .code
9045 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9046 .endd
9047 This loads the message from Exim's spool before doing the test expansions, and
9048 is therefore restricted to admin users.
9049
9050
9051 .section "Forced expansion failure" "SECTforexpfai"
9052 .cindex "expansion" "forced failure"
9053 A number of expansions that are described in the following section have
9054 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9055 (which are sometimes called &"curly brackets"&). Which of the two strings is
9056 used depends on some condition that is evaluated as part of the expansion. If,
9057 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9058 the entire string expansion fails in a way that can be detected by the code
9059 that requested the expansion. This is called &"forced expansion failure"&, and
9060 its consequences depend on the circumstances. In some cases it is no different
9061 from any other expansion failure, but in others a different action may be
9062 taken. Such variations are mentioned in the documentation of the option that is
9063 being expanded.
9064
9065
9066
9067
9068 .section "Expansion items" "SECTexpansionitems"
9069 The following items are recognized in expanded strings. White space may be used
9070 between sub-items that are keywords or substrings enclosed in braces inside an
9071 outer set of braces, to improve readability. &*Warning*&: Within braces,
9072 white space is significant.
9073
9074 .vlist
9075 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9076 .cindex "expansion" "variables"
9077 Substitute the contents of the named variable, for example:
9078 .code
9079 $local_part
9080 ${domain}
9081 .endd
9082 The second form can be used to separate the name from subsequent alphanumeric
9083 characters. This form (using braces) is available only for variables; it does
9084 &'not'& apply to message headers. The names of the variables are given in
9085 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9086 given, the expansion fails.
9087
9088 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9089 .cindex "expansion" "operators"
9090 The string is first itself expanded, and then the operation specified by
9091 <&'op'&> is applied to it. For example:
9092 .code
9093 ${lc:$local_part}
9094 .endd
9095 The string starts with the first character after the colon, which may be
9096 leading white space. A list of operators is given in section &<<SECTexpop>>&
9097 below. The operator notation is used for simple expansion items that have just
9098 one argument, because it reduces the number of braces and therefore makes the
9099 string easier to understand.
9100
9101 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9102 This item inserts &"basic"& header lines. It is described with the &%header%&
9103 expansion item below.
9104
9105
9106 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9107 .cindex "expansion" "calling an acl"
9108 .cindex "&%acl%&" "call from expansion"
9109 The name and zero to nine argument strings are first expanded separately.  The expanded
9110 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9111 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9112 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9113 and may use the variables; if another acl expansion is used the values
9114 are restored after it returns.  If the ACL sets
9115 a value using a "message =" modifier and returns accept or deny, the value becomes
9116 the result of the expansion.
9117 If no message is set and the ACL returns accept or deny
9118 the expansion result is an empty string.
9119 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9120
9121
9122 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9123        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9124 .cindex "expansion" "extracting certificate fields"
9125 .cindex "&%certextract%&" "certificate fields"
9126 .cindex "certificate" "extracting fields"
9127 The <&'certificate'&> must be a variable of type certificate.
9128 The field name is expanded and used to retrieve the relevant field from
9129 the certificate.  Supported fields are:
9130 .display
9131 &`version        `&
9132 &`serial_number  `&
9133 &`subject        `& RFC4514 DN
9134 &`issuer         `& RFC4514 DN
9135 &`notbefore      `& time
9136 &`notafter       `& time
9137 &`sig_algorithm  `&
9138 &`signature      `&
9139 &`subj_altname   `& tagged list
9140 &`ocsp_uri       `& list
9141 &`crl_uri        `& list
9142 .endd
9143 If the field is found,
9144 <&'string2'&> is expanded, and replaces the whole item;
9145 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9146 variable &$value$& contains the value that has been extracted. Afterwards, it
9147 is restored to any previous value it might have had.
9148
9149 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9150 key is not found. If {<&'string2'&>} is also omitted, the value that was
9151 extracted is used.
9152
9153 Some field names take optional modifiers, appended and separated by commas.
9154
9155 The field selectors marked as "RFC4514" above
9156 output a Distinguished Name string which is
9157 not quite
9158 parseable by Exim as a comma-separated tagged list
9159 (the exceptions being elements containing commas).
9160 RDN elements of a single type may be selected by
9161 a modifier of the type label; if so the expansion
9162 result is a list (newline-separated by default).
9163 The separator may be changed by another modifier of
9164 a right angle-bracket followed immediately by the new separator.
9165 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9166
9167 The field selectors marked as "time" above
9168 take an optional modifier of "int"
9169 for which the result is the number of seconds since epoch.
9170 Otherwise the result is a human-readable string
9171 in the timezone selected by the main "timezone" option.
9172
9173 The field selectors marked as "list" above return a list,
9174 newline-separated by default,
9175 (embedded separator characters in elements are doubled).
9176 The separator may be changed by a modifier of
9177 a right angle-bracket followed immediately by the new separator.
9178
9179 The field selectors marked as "tagged" above
9180 prefix each list element with a type string and an equals sign.
9181 Elements of only one type may be selected by a modifier
9182 which is one of "dns", "uri" or "mail";
9183 if so the element tags are omitted.
9184
9185 If not otherwise noted field values are presented in human-readable form.
9186
9187 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9188        {*&<&'arg'&>&*}...}*&"
9189 .cindex &%dlfunc%&
9190 This expansion dynamically loads and then calls a locally-written C function.
9191 This functionality is available only if Exim is compiled with
9192 .code
9193 EXPAND_DLFUNC=yes
9194 .endd
9195 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9196 object so that it doesn't reload the same object file in the same Exim process
9197 (but of course Exim does start new processes frequently).
9198
9199 There may be from zero to eight arguments to the function. When compiling
9200 a local function that is to be called in this way, &_local_scan.h_& should be
9201 included. The Exim variables and functions that are defined by that API
9202 are also available for dynamically loaded functions. The function itself
9203 must have the following type:
9204 .code
9205 int dlfunction(uschar **yield, int argc, uschar *argv[])
9206 .endd
9207 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9208 function should return one of the following values:
9209
9210 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9211 into the expanded string that is being built.
9212
9213 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9214 from &'yield'&, if it is set.
9215
9216 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9217 taken from &'yield'& if it is set.
9218
9219 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9220
9221 When compiling a function that is to be used in this way with gcc,
9222 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9223 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9224
9225
9226 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9227 .cindex "expansion" "extracting value from environment"
9228 .cindex "environment" "values from"
9229 The key is first expanded separately, and leading and trailing white space
9230 removed.
9231 This is then searched for as a name in the environment.
9232 If a variable is found then its value is placed in &$value$&
9233 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9234
9235 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9236 appear, for example:
9237 .code
9238 ${env{USER}{$value} fail }
9239 .endd
9240 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9241 {<&'string1'&>} must be present for &"fail"& to be recognized.
9242
9243 If {<&'string2'&>} is omitted an empty string is substituted on
9244 search failure.
9245 If {<&'string1'&>} is omitted the search result is substituted on
9246 search success.
9247
9248 The environment is adjusted by the &%keep_environment%& and
9249 &%add_environment%& main section options.
9250
9251
9252 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9253        {*&<&'string3'&>&*}}*&"
9254 .cindex "expansion" "extracting substrings by key"
9255 .cindex "&%extract%&" "substrings by key"
9256 The key and <&'string1'&> are first expanded separately. Leading and trailing
9257 white space is removed from the key (but not from any of the strings). The key
9258 must not be empty and must not consist entirely of digits.
9259 The expanded <&'string1'&> must be of the form:
9260 .display
9261 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9262 .endd
9263 .vindex "&$value$&"
9264 where the equals signs and spaces (but not both) are optional. If any of the
9265 values contain white space, they must be enclosed in double quotes, and any
9266 values that are enclosed in double quotes are subject to escape processing as
9267 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9268 for the value that corresponds to the key. The search is case-insensitive. If
9269 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9270 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9271 variable &$value$& contains the value that has been extracted. Afterwards, it
9272 is restored to any previous value it might have had.
9273
9274 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9275 key is not found. If {<&'string2'&>} is also omitted, the value that was
9276 extracted is used. Thus, for example, these two expansions are identical, and
9277 yield &"2001"&:
9278 .code
9279 ${extract{gid}{uid=1984 gid=2001}}
9280 ${extract{gid}{uid=1984 gid=2001}{$value}}
9281 .endd
9282 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9283 appear, for example:
9284 .code
9285 ${extract{Z}{A=... B=...}{$value} fail }
9286 .endd
9287 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9288 {<&'string2'&>} must be present for &"fail"& to be recognized.
9289
9290
9291 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9292         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9293 .cindex "expansion" "extracting substrings by number"
9294 .cindex "&%extract%&" "substrings by number"
9295 The <&'number'&> argument must consist entirely of decimal digits,
9296 apart from leading and trailing white space, which is ignored.
9297 This is what distinguishes this form of &%extract%& from the previous kind. It
9298 behaves in the same way, except that, instead of extracting a named field, it
9299 extracts from <&'string1'&> the field whose number is given as the first
9300 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9301 <&'string3'&> as before.
9302
9303 The fields in the string are separated by any one of the characters in the
9304 separator string. These may include space or tab characters.
9305 The first field is numbered one. If the number is negative, the fields are
9306 counted from the end of the string, with the rightmost one numbered -1. If the
9307 number given is zero, the entire string is returned. If the modulus of the
9308 number is greater than the number of fields in the string, the result is the
9309 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9310 provided. For example:
9311 .code
9312 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9313 .endd
9314 yields &"42"&, and
9315 .code
9316 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9317 .endd
9318 yields &"99"&. Two successive separators mean that the field between them is
9319 empty (for example, the fifth field above).
9320
9321
9322 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9323 .cindex "list" "selecting by condition"
9324 .cindex "expansion" "selecting from list by condition"
9325 .vindex "&$item$&"
9326 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9327 default, but the separator can be changed in the usual way. For each item
9328 in this list, its value is place in &$item$&, and then the condition is
9329 evaluated. If the condition is true, &$item$& is added to the output as an
9330 item in a new list; if the condition is false, the item is discarded. The
9331 separator used for the output list is the same as the one used for the
9332 input, but a separator setting is not included in the output. For example:
9333 .code
9334 ${filter{a:b:c}{!eq{$item}{b}}
9335 .endd
9336 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9337 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9338
9339
9340 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9341 .cindex "hash function" "textual"
9342 .cindex "expansion" "textual hash"
9343 This is a textual hashing function, and was the first to be implemented in
9344 early versions of Exim. In current releases, there are other hashing functions
9345 (numeric, MD5, and SHA-1), which are described below.
9346
9347 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9348 <&'n'&>. If you are using fixed values for these numbers, that is, if
9349 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9350 use the simpler operator notation that avoids some of the braces:
9351 .code
9352 ${hash_<n>_<m>:<string>}
9353 .endd
9354 The second number is optional (in both notations). If <&'n'&> is greater than
9355 or equal to the length of the string, the expansion item returns the string.
9356 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9357 function to the string. The new string consists of characters taken from the
9358 first <&'m'&> characters of the string
9359 .code
9360 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9361 .endd
9362 If <&'m'&> is not present the value 26 is used, so that only lower case
9363 letters appear. For example:
9364 .display
9365 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9366 &`$hash{5}{monty}}           `&   yields  &`monty`&
9367 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9368 .endd
9369
9370 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9371         &*$h_*&<&'header&~name'&>&*:*&" &&&
9372        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9373         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9374        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9375         &*$rh_*&<&'header&~name'&>&*:*&"
9376 .cindex "expansion" "header insertion"
9377 .vindex "&$header_$&"
9378 .vindex "&$bheader_$&"
9379 .vindex "&$rheader_$&"
9380 .cindex "header lines" "in expansion strings"
9381 .cindex "header lines" "character sets"
9382 .cindex "header lines" "decoding"
9383 Substitute the contents of the named message header line, for example
9384 .code
9385 $header_reply-to:
9386 .endd
9387 The newline that terminates a header line is not included in the expansion, but
9388 internal newlines (caused by splitting the header line over several physical
9389 lines) may be present.
9390
9391 The difference between &%rheader%&, &%bheader%&, and &%header%& is in the way
9392 the data in the header line is interpreted.
9393
9394 .ilist
9395 .cindex "white space" "in header lines"
9396 &%rheader%& gives the original &"raw"& content of the header line, with no
9397 processing at all, and without the removal of leading and trailing white space.
9398
9399 .next
9400 .cindex "base64 encoding" "in header lines"
9401 &%bheader%& removes leading and trailing white space, and then decodes base64
9402 or quoted-printable MIME &"words"& within the header text, but does no
9403 character set translation. If decoding of what looks superficially like a MIME
9404 &"word"& fails, the raw string is returned. If decoding
9405 .cindex "binary zero" "in header line"
9406 produces a binary zero character, it is replaced by a question mark &-- this is
9407 what Exim does for binary zeros that are actually received in header lines.
9408
9409 .next
9410 &%header%& tries to translate the string as decoded by &%bheader%& to a
9411 standard character set. This is an attempt to produce the same string as would
9412 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9413 returned. Translation is attempted only on operating systems that support the
9414 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9415 a system Makefile or in &_Local/Makefile_&.
9416 .endlist ilist
9417
9418 In a filter file, the target character set for &%header%& can be specified by a
9419 command of the following form:
9420 .code
9421 headers charset "UTF-8"
9422 .endd
9423 This command affects all references to &$h_$& (or &$header_$&) expansions in
9424 subsequently obeyed filter commands. In the absence of this command, the target
9425 character set in a filter is taken from the setting of the &%headers_charset%&
9426 option in the runtime configuration. The value of this option defaults to the
9427 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9428 ISO-8859-1.
9429
9430 Header names follow the syntax of RFC 2822, which states that they may contain
9431 any printing characters except space and colon. Consequently, curly brackets
9432 &'do not'& terminate header names, and should not be used to enclose them as
9433 if they were variables. Attempting to do so causes a syntax error.
9434
9435 Only header lines that are common to all copies of a message are visible to
9436 this mechanism. These are the original header lines that are received with the
9437 message, and any that are added by an ACL statement or by a system
9438 filter. Header lines that are added to a particular copy of a message by a
9439 router or transport are not accessible.
9440
9441 For incoming SMTP messages, no header lines are visible in
9442 ACLs that are obeyed before the data phase completes,
9443 because the header structure is not set up until the message is received.
9444 They are visible in DKIM, PRDR and DATA ACLs.
9445 Header lines that are added in a RCPT ACL (for example)
9446 are saved until the message's incoming header lines are available, at which
9447 point they are added.
9448 When any of the above ACLs ar
9449 running, however, header lines added by earlier ACLs are visible.
9450
9451 Upper case and lower case letters are synonymous in header names. If the
9452 following character is white space, the terminating colon may be omitted, but
9453 this is not recommended, because you may then forget it when it is needed. When
9454 white space terminates the header name, this white space is included in the
9455 expanded string.  If the message does not contain the given header, the
9456 expansion item is replaced by an empty string. (See the &%def%& condition in
9457 section &<<SECTexpcond>>& for a means of testing for the existence of a
9458 header.)
9459
9460 If there is more than one header with the same name, they are all concatenated
9461 to form the substitution string, up to a maximum length of 64K. Unless
9462 &%rheader%& is being used, leading and trailing white space is removed from
9463 each header before concatenation, and a completely empty header is ignored. A
9464 newline character is then inserted between non-empty headers, but there is no
9465 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9466 those headers that contain lists of addresses, a comma is also inserted at the
9467 junctions between headers. This does not happen for the &%rheader%& expansion.
9468
9469
9470 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9471 .cindex "expansion" "hmac hashing"
9472 .cindex &%hmac%&
9473 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9474 shared secret and some text into a message authentication code, as specified in
9475 RFC 2104. This differs from &`${md5:secret_text...}`& or
9476 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9477 cryptographic hash, allowing for authentication that is not possible with MD5
9478 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9479 present. For example:
9480 .code
9481 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9482 .endd
9483 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9484 produces:
9485 .code
9486 dd97e3ba5d1a61b5006108f8c8252953
9487 .endd
9488 As an example of how this might be used, you might put in the main part of
9489 an Exim configuration:
9490 .code
9491 SPAMSCAN_SECRET=cohgheeLei2thahw
9492 .endd
9493 In a router or a transport you could then have:
9494 .code
9495 headers_add = \
9496   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9497   ${hmac{md5}{SPAMSCAN_SECRET}\
9498   {${primary_hostname},${message_exim_id},$h_message-id:}}
9499 .endd
9500 Then given a message, you can check where it was scanned by looking at the
9501 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9502 this header line is authentic by recomputing the authentication code from the
9503 host name, message ID and the &'Message-id:'& header line. This can be done
9504 using Exim's &%-be%& option, or by other means, for example by using the
9505 &'hmac_md5_hex()'& function in Perl.
9506
9507
9508 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9509 .cindex "expansion" "conditional"
9510 .cindex "&%if%&, expansion item"
9511 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9512 item; otherwise <&'string2'&> is used. The available conditions are described
9513 in section &<<SECTexpcond>>& below. For example:
9514 .code
9515 ${if eq {$local_part}{postmaster} {yes}{no} }
9516 .endd
9517 The second string need not be present; if it is not and the condition is not
9518 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9519 be present instead of the second string (without any curly brackets). In this
9520 case, the expansion is forced to fail if the condition is not true (see section
9521 &<<SECTforexpfai>>&).
9522
9523 If both strings are omitted, the result is the string &`true`& if the condition
9524 is true, and the empty string if the condition is false. This makes it less
9525 cumbersome to write custom ACL and router conditions. For example, instead of
9526 .code
9527 condition = ${if >{$acl_m4}{3}{true}{false}}
9528 .endd
9529 you can use
9530 .code
9531 condition = ${if >{$acl_m4}{3}}
9532 .endd
9533
9534
9535
9536 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9537 .cindex expansion "imap folder"
9538 .cindex "&%imapfolder%& expansion item"
9539 This item converts a (possibly multilevel, or with non-ASCII characters)
9540 folder specification to a Maildir name for filesystem use.
9541 For information on internationalisation support see &<<SECTi18nMDA>>&.
9542
9543
9544
9545 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9546 .cindex "expansion" "string truncation"
9547 .cindex "&%length%& expansion item"
9548 The &%length%& item is used to extract the initial portion of a string. Both
9549 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9550 you are using a fixed value for the number, that is, if <&'string1'&> does not
9551 change when expanded, you can use the simpler operator notation that avoids
9552 some of the braces:
9553 .code
9554 ${length_<n>:<string>}
9555 .endd
9556 The result of this item is either the first <&'n'&> characters or the whole
9557 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9558 &%strlen%&, which gives the length of a string.
9559
9560
9561 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9562         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9563 .cindex "expansion" "extracting list elements by number"
9564 .cindex "&%listextract%&" "extract list elements by number"
9565 .cindex "list" "extracting elements by number"
9566 The <&'number'&> argument must consist entirely of decimal digits,
9567 apart from an optional leading minus,
9568 and leading and trailing white space (which is ignored).
9569
9570 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9571 default, but the separator can be changed in the usual way.
9572
9573 The first field of the list is numbered one.
9574 If the number is negative, the fields are
9575 counted from the end of the list, with the rightmost one numbered -1.
9576 The numbered element of the list is extracted and placed in &$value$&,
9577 then <&'string2'&> is expanded as the result.
9578
9579 If the modulus of the
9580 number is zero or greater than the number of fields in the string,
9581 the result is the expansion of <&'string3'&>.
9582
9583 For example:
9584 .code
9585 ${listextract{2}{x:42:99}}
9586 .endd
9587 yields &"42"&, and
9588 .code
9589 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9590 .endd
9591 yields &"result: 42"&.
9592
9593 If {<&'string3'&>} is omitted, an empty string is used for string3.
9594 If {<&'string2'&>} is also omitted, the value that was
9595 extracted is used.
9596 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9597
9598
9599 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9600         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9601 This is the first of one of two different types of lookup item, which are both
9602 described in the next item.
9603
9604 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9605         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9606 .cindex "expansion" "lookup in"
9607 .cindex "file" "lookups"
9608 .cindex "lookup" "in expanded string"
9609 The two forms of lookup item specify data lookups in files and databases, as
9610 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9611 lookups, and the second is used for query-style lookups. The <&'key'&>,
9612 <&'file'&>, and <&'query'&> strings are expanded before use.
9613
9614 If there is any white space in a lookup item which is part of a filter command,
9615 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9616 other place where white space is significant, the lookup item must be enclosed
9617 in double quotes. The use of data lookups in users' filter files may be locked
9618 out by the system administrator.
9619
9620 .vindex "&$value$&"
9621 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9622 During its expansion, the variable &$value$& contains the data returned by the
9623 lookup. Afterwards it reverts to the value it had previously (at the outer
9624 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9625 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9626 string on failure. If <&'string2'&> is provided, it can itself be a nested
9627 lookup, thus providing a mechanism for looking up a default value when the
9628 original lookup fails.
9629
9630 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9631 data for the outer lookup while the parameters of the second lookup are
9632 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9633 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9634 appear, and in this case, if the lookup fails, the entire expansion is forced
9635 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9636 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9637 successful lookup, and nothing in the case of failure.
9638
9639 For single-key lookups, the string &"partial"& is permitted to precede the
9640 search type in order to do partial matching, and * or *@ may follow a search
9641 type to request default lookups if the key does not match (see sections
9642 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9643
9644 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9645 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9646 and non-wild parts of the key during the expansion of the replacement text.
9647 They return to their previous values at the end of the lookup item.
9648
9649 This example looks up the postmaster alias in the conventional alias file:
9650 .code
9651 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9652 .endd
9653 This example uses NIS+ to look up the full name of the user corresponding to
9654 the local part of an address, forcing the expansion to fail if it is not found:
9655 .code
9656 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9657   {$value}fail}
9658 .endd
9659
9660
9661 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9662 .cindex "expansion" "list creation"
9663 .vindex "&$item$&"
9664 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9665 default, but the separator can be changed in the usual way. For each item
9666 in this list, its value is place in &$item$&, and then <&'string2'&> is
9667 expanded and added to the output as an item in a new list. The separator used
9668 for the output list is the same as the one used for the input, but a separator
9669 setting is not included in the output. For example:
9670 .code
9671 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9672 .endd
9673 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9674 value of &$item$& is restored to what it was before. See also the &*filter*&
9675 and &*reduce*& expansion items.
9676
9677 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9678 .cindex "expansion" "numeric hash"
9679 .cindex "hash function" "numeric"
9680 The three strings are expanded; the first two must yield numbers. Call them
9681 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9682 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
9683 can use the simpler operator notation that avoids some of the braces:
9684 .code
9685 ${nhash_<n>_<m>:<string>}
9686 .endd
9687 The second number is optional (in both notations). If there is only one number,
9688 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
9689 processed by a div/mod hash function that returns two numbers, separated by a
9690 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
9691 example,
9692 .code
9693 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
9694 .endd
9695 returns the string &"6/33"&.
9696
9697
9698
9699 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
9700 .cindex "Perl" "use in expanded string"
9701 .cindex "expansion" "calling Perl from"
9702 This item is available only if Exim has been built to include an embedded Perl
9703 interpreter. The subroutine name and the arguments are first separately
9704 expanded, and then the Perl subroutine is called with those arguments. No
9705 additional arguments need be given; the maximum number permitted, including the
9706 name of the subroutine, is nine.
9707
9708 The return value of the subroutine is inserted into the expanded string, unless
9709 the return value is &%undef%&. In that case, the expansion fails in the same
9710 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
9711 Whatever you return is evaluated in a scalar context. For example, if you
9712 return the name of a Perl vector, the return value is the size of the vector,
9713 not its contents.
9714
9715 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
9716 with the error message that was passed to &%die%&. More details of the embedded
9717 Perl facility are given in chapter &<<CHAPperl>>&.
9718
9719 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
9720 out the use of this expansion item in filter files.
9721
9722
9723 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
9724 .cindex "&%prvs%& expansion item"
9725 The first argument is a complete email address and the second is secret
9726 keystring. The third argument, specifying a key number, is optional. If absent,
9727 it defaults to 0. The result of the expansion is a prvs-signed email address,
9728 to be typically used with the &%return_path%& option on an &(smtp)& transport
9729 as part of a bounce address tag validation (BATV) scheme. For more discussion
9730 and an example, see section &<<SECTverifyPRVS>>&.
9731
9732 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
9733         {*&<&'string'&>&*}}*&"
9734 .cindex "&%prvscheck%& expansion item"
9735 This expansion item is the complement of the &%prvs%& item. It is used for
9736 checking prvs-signed addresses. If the expansion of the first argument does not
9737 yield a syntactically valid prvs-signed address, the whole item expands to the
9738 empty string. When the first argument does expand to a syntactically valid
9739 prvs-signed address, the second argument is expanded, with the prvs-decoded
9740 version of the address and the key number extracted from the address in the
9741 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
9742
9743 These two variables can be used in the expansion of the second argument to
9744 retrieve the secret. The validity of the prvs-signed address is then checked
9745 against the secret. The result is stored in the variable &$prvscheck_result$&,
9746 which is empty for failure or &"1"& for success.
9747
9748 The third argument is optional; if it is missing, it defaults to an empty
9749 string. This argument is now expanded. If the result is an empty string, the
9750 result of the expansion is the decoded version of the address. This is the case
9751 whether or not the signature was valid. Otherwise, the result of the expansion
9752 is the expansion of the third argument.
9753
9754 All three variables can be used in the expansion of the third argument.
9755 However, once the expansion is complete, only &$prvscheck_result$& remains set.
9756 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
9757
9758 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
9759 .cindex "expansion" "inserting an entire file"
9760 .cindex "file" "inserting into expansion"
9761 .cindex "&%readfile%& expansion item"
9762 The file name and end-of-line string are first expanded separately. The file is
9763 then read, and its contents replace the entire item. All newline characters in
9764 the file are replaced by the end-of-line string if it is present. Otherwise,
9765 newlines are left in the string.
9766 String expansion is not applied to the contents of the file. If you want this,
9767 you must wrap the item in an &%expand%& operator. If the file cannot be read,
9768 the string expansion fails.
9769
9770 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
9771 locks out the use of this expansion item in filter files.
9772
9773
9774
9775 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
9776         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
9777 .cindex "expansion" "inserting from a socket"
9778 .cindex "socket, use of in expansion"
9779 .cindex "&%readsocket%& expansion item"
9780 This item inserts data from a Unix domain or TCP socket into the expanded
9781 string. The minimal way of using it uses just two arguments, as in these
9782 examples:
9783 .code
9784 ${readsocket{/socket/name}{request string}}
9785 ${readsocket{inet:some.host:1234}{request string}}
9786 .endd
9787 For a Unix domain socket, the first substring must be the path to the socket.
9788 For an Internet socket, the first substring must contain &`inet:`& followed by
9789 a host name or IP address, followed by a colon and a port, which can be a
9790 number or the name of a TCP port in &_/etc/services_&. An IP address may
9791 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
9792 example:
9793 .code
9794 ${readsocket{inet:[::1]:1234}{request string}}
9795 .endd
9796 Only a single host name may be given, but if looking it up yields more than
9797 one IP address, they are each tried in turn until a connection is made. For
9798 both kinds of socket, Exim makes a connection, writes the request string
9799 unless it is an empty string; and no terminating NUL is ever sent)
9800 and reads from the socket until an end-of-file
9801 is read. A timeout of 5 seconds is applied. Additional, optional arguments
9802 extend what can be done. Firstly, you can vary the timeout. For example:
9803 .code
9804 ${readsocket{/socket/name}{request string}{3s}}
9805 .endd
9806 The third argument is a list of options, of which the first element is the timeout
9807 and must be present if the argument is given.
9808 Further elements are options of form &'name=value'&.
9809 One option type is currently recognised, defining whether (the default)
9810 or not a shutdown is done on the connection after sending the request.
9811 Example, to not do so (preferred, eg. by some webservers):
9812 .code
9813 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
9814 .endd
9815 A fourth argument allows you to change any newlines that are in the data
9816 that is read, in the same way as for &%readfile%& (see above). This example
9817 turns them into spaces:
9818 .code
9819 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
9820 .endd
9821 As with all expansions, the substrings are expanded before the processing
9822 happens. Errors in these sub-expansions cause the expansion to fail. In
9823 addition, the following errors can occur:
9824
9825 .ilist
9826 Failure to create a socket file descriptor;
9827 .next
9828 Failure to connect the socket;
9829 .next
9830 Failure to write the request string;
9831 .next
9832 Timeout on reading from the socket.
9833 .endlist
9834
9835 By default, any of these errors causes the expansion to fail. However, if
9836 you supply a fifth substring, it is expanded and used when any of the above
9837 errors occurs. For example:
9838 .code
9839 ${readsocket{/socket/name}{request string}{3s}{\n}\
9840   {socket failure}}
9841 .endd
9842 You can test for the existence of a Unix domain socket by wrapping this
9843 expansion in &`${if exists`&, but there is a race condition between that test
9844 and the actual opening of the socket, so it is safer to use the fifth argument
9845 if you want to be absolutely sure of avoiding an expansion error for a
9846 non-existent Unix domain socket, or a failure to connect to an Internet socket.
9847
9848 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
9849 locks out the use of this expansion item in filter files.
9850
9851
9852 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9853 .cindex "expansion" "reducing a list to a scalar"
9854 .cindex "list" "reducing to a scalar"
9855 .vindex "&$value$&"
9856 .vindex "&$item$&"
9857 This operation reduces a list to a single, scalar string. After expansion,
9858 <&'string1'&> is interpreted as a list, colon-separated by default, but the
9859 separator can be changed in the usual way. Then <&'string2'&> is expanded and
9860 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
9861 list is assigned to &$item$& in turn, and <&'string3'&> is expanded for each of
9862 them. The result of that expansion is assigned to &$value$& before the next
9863 iteration. When the end of the list is reached, the final value of &$value$& is
9864 added to the expansion output. The &*reduce*& expansion item can be used in a
9865 number of ways. For example, to add up a list of numbers:
9866 .code
9867 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
9868 .endd
9869 The result of that expansion would be &`6`&. The maximum of a list of numbers
9870 can be found:
9871 .code
9872 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
9873 .endd
9874 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
9875 restored to what they were before. See also the &*filter*& and &*map*&
9876 expansion items.
9877
9878 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
9879 This item inserts &"raw"& header lines. It is described with the &%header%&
9880 expansion item above.
9881
9882 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
9883         {*&<&'string2'&>&*}}*&"
9884 .cindex "expansion" "running a command"
9885 .cindex "&%run%& expansion item"
9886 The command and its arguments are first expanded as one string. The string is
9887 split apart into individual arguments by spaces, and then the command is run
9888 in a separate process, but under the same uid and gid.  As in other command
9889 executions from Exim, a shell is not used by default. If the command requires
9890 a shell, you must explicitly code it.
9891
9892 Since the arguments are split by spaces, when there is a variable expansion
9893 which has an empty result, it will cause the situation that the argument will
9894 simply be omitted when the program is actually executed by Exim. If the
9895 script/program requires a specific number of arguments and the expanded
9896 variable could possibly result in this empty expansion, the variable must be
9897 quoted. This is more difficult if the expanded variable itself could result
9898 in a string containing quotes, because it would interfere with the quotes
9899 around the command arguments. A possible guard against this is to wrap the
9900 variable in the &%sg%& operator to change any quote marks to some other
9901 character.
9902
9903 The standard input for the command exists, but is empty. The standard output
9904 and standard error are set to the same file descriptor.
9905 .cindex "return code" "from &%run%& expansion"
9906 .vindex "&$value$&"
9907 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
9908 and replaces the entire item; during this expansion, the standard output/error
9909 from the command is in the variable &$value$&. If the command fails,
9910 <&'string2'&>, if present, is expanded and used. Once again, during the
9911 expansion, the standard output/error from the command is in the variable
9912 &$value$&.
9913
9914 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
9915 can be the word &"fail"& (not in braces) to force expansion failure if the
9916 command does not succeed. If both strings are omitted, the result is contents
9917 of the standard output/error on success, and nothing on failure.
9918
9919 .vindex "&$run_in_acl$&"
9920 The standard output/error of the command is put in the variable &$value$&.
9921 In this ACL example, the output of a command is logged for the admin to
9922 troubleshoot:
9923 .code
9924 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
9925       log_message  = Output of id: $value
9926 .endd
9927 If the command requires shell idioms, such as the > redirect operator, the
9928 shell must be invoked directly, such as with:
9929 .code
9930 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
9931 .endd
9932
9933 .vindex "&$runrc$&"
9934 The return code from the command is put in the variable &$runrc$&, and this
9935 remains set afterwards, so in a filter file you can do things like this:
9936 .code
9937 if "${run{x y z}{}}$runrc" is 1 then ...
9938   elif $runrc is 2 then ...
9939   ...
9940 endif
9941 .endd
9942 If execution of the command fails (for example, the command does not exist),
9943 the return code is 127 &-- the same code that shells use for non-existent
9944 commands.
9945
9946 &*Warning*&: In a router or transport, you cannot assume the order in which
9947 option values are expanded, except for those preconditions whose order of
9948 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
9949 by the expansion of one option, and use it in another.
9950
9951 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
9952 out the use of this expansion item in filter files.
9953
9954
9955 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
9956 .cindex "expansion" "string substitution"
9957 .cindex "&%sg%& expansion item"
9958 This item works like Perl's substitution operator (s) with the global (/g)
9959 option; hence its name. However, unlike the Perl equivalent, Exim does not
9960 modify the subject string; instead it returns the modified string for insertion
9961 into the overall expansion. The item takes three arguments: the subject string,
9962 a regular expression, and a substitution string. For example:
9963 .code
9964 ${sg{abcdefabcdef}{abc}{xyz}}
9965 .endd
9966 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
9967 if any $ or \ characters are required in the regular expression or in the
9968 substitution string, they have to be escaped. For example:
9969 .code
9970 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
9971 .endd
9972 yields &"defabc"&, and
9973 .code
9974 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
9975 .endd
9976 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
9977 the regular expression from string expansion.
9978
9979
9980
9981 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
9982 .cindex sorting "a list"
9983 .cindex list sorting
9984 .cindex expansion "list sorting"
9985 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9986 default, but the separator can be changed in the usual way.
9987 The <&'comparator'&> argument is interpreted as the operator
9988 of a two-argument expansion condition.
9989 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
9990 The comparison should return true when applied to two values
9991 if the first value should sort before the second value.
9992 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
9993 the element being placed in &$item$&,
9994 to give values for comparison.
9995
9996 The item result is a sorted list,
9997 with the original list separator,
9998 of the list elements (in full) of the original.
9999
10000 Examples:
10001 .code
10002 ${sort{3:2:1:4}{<}{$item}}
10003 .endd
10004 sorts a list of numbers, and
10005 .code
10006 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10007 .endd
10008 will sort an MX lookup into priority order.
10009
10010
10011 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10012 .cindex "&%substr%& expansion item"
10013 .cindex "substring extraction"
10014 .cindex "expansion" "substring extraction"
10015 The three strings are expanded; the first two must yield numbers. Call them
10016 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10017 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10018 can use the simpler operator notation that avoids some of the braces:
10019 .code
10020 ${substr_<n>_<m>:<string>}
10021 .endd
10022 The second number is optional (in both notations).
10023 If it is absent in the simpler format, the preceding underscore must also be
10024 omitted.
10025
10026 The &%substr%& item can be used to extract more general substrings than
10027 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10028 length required. For example
10029 .code
10030 ${substr{3}{2}{$local_part}}
10031 .endd
10032 If the starting offset is greater than the string length the result is the
10033 null string; if the length plus starting offset is greater than the string
10034 length, the result is the right-hand part of the string, starting from the
10035 given offset. The first character in the string has offset zero.
10036
10037 The &%substr%& expansion item can take negative offset values to count
10038 from the right-hand end of its operand. The last character is offset -1, the
10039 second-last is offset -2, and so on. Thus, for example,
10040 .code
10041 ${substr{-5}{2}{1234567}}
10042 .endd
10043 yields &"34"&. If the absolute value of a negative offset is greater than the
10044 length of the string, the substring starts at the beginning of the string, and
10045 the length is reduced by the amount of overshoot. Thus, for example,
10046 .code
10047 ${substr{-5}{2}{12}}
10048 .endd
10049 yields an empty string, but
10050 .code
10051 ${substr{-3}{2}{12}}
10052 .endd
10053 yields &"1"&.
10054
10055 When the second number is omitted from &%substr%&, the remainder of the string
10056 is taken if the offset is positive. If it is negative, all characters in the
10057 string preceding the offset point are taken. For example, an offset of -1 and
10058 no length, as in these semantically identical examples:
10059 .code
10060 ${substr_-1:abcde}
10061 ${substr{-1}{abcde}}
10062 .endd
10063 yields all but the last character of the string, that is, &"abcd"&.
10064
10065
10066
10067 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10068         {*&<&'replacements'&>&*}}*&"
10069 .cindex "expansion" "character translation"
10070 .cindex "&%tr%& expansion item"
10071 This item does single-character translation on its subject string. The second
10072 argument is a list of characters to be translated in the subject string. Each
10073 matching character is replaced by the corresponding character from the
10074 replacement list. For example
10075 .code
10076 ${tr{abcdea}{ac}{13}}
10077 .endd
10078 yields &`1b3de1`&. If there are duplicates in the second character string, the
10079 last occurrence is used. If the third string is shorter than the second, its
10080 last character is replicated. However, if it is empty, no translation takes
10081 place.
10082 .endlist
10083
10084
10085
10086 .section "Expansion operators" "SECTexpop"
10087 .cindex "expansion" "operators"
10088 For expansion items that perform transformations on a single argument string,
10089 the &"operator"& notation is used because it is simpler and uses fewer braces.
10090 The substring is first expanded before the operation is applied to it. The
10091 following operations can be performed:
10092
10093 .vlist
10094 .vitem &*${address:*&<&'string'&>&*}*&
10095 .cindex "expansion" "RFC 2822 address handling"
10096 .cindex "&%address%& expansion item"
10097 The string is interpreted as an RFC 2822 address, as it might appear in a
10098 header line, and the effective address is extracted from it. If the string does
10099 not parse successfully, the result is empty.
10100
10101
10102 .vitem &*${addresses:*&<&'string'&>&*}*&
10103 .cindex "expansion" "RFC 2822 address handling"
10104 .cindex "&%addresses%& expansion item"
10105 The string (after expansion) is interpreted as a list of addresses in RFC
10106 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10107 operative address (&'local-part@domain'&) is extracted from each item, and the
10108 result of the expansion is a colon-separated list, with appropriate
10109 doubling of colons should any happen to be present in the email addresses.
10110 Syntactically invalid RFC2822 address items are omitted from the output.
10111
10112 It is possible to specify a character other than colon for the output
10113 separator by starting the string with > followed by the new separator
10114 character. For example:
10115 .code
10116 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10117 .endd
10118 expands to &`ceo@up.stairs&&sec@base.ment`&. Compare the &*address*& (singular)
10119 expansion item, which extracts the working address from a single RFC2822
10120 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10121 processing lists.
10122
10123 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10124 a strict interpretation of header line formatting.  Exim parses the bare,
10125 unquoted portion of an email address and if it finds a comma, treats it as an
10126 email address separator. For the example header line:
10127 .code
10128 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10129 .endd
10130 The first example below demonstrates that Q-encoded email addresses are parsed
10131 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10132 It does not see the comma because it's still encoded as "=2C".  The second
10133 example below is passed the contents of &`$header_from:`&, meaning it gets
10134 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10135 The third example shows that the presence of a comma is skipped when it is
10136 quoted.
10137 .code
10138 # exim -be '${addresses:From: \
10139 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10140 user@example.com
10141 # exim -be '${addresses:From: Last, First <user@example.com>}'
10142 Last:user@example.com
10143 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10144 user@example.com
10145 .endd
10146
10147 .vitem &*${base32:*&<&'digits'&>&*}*&
10148 .cindex "&%base32%& expansion item"
10149 .cindex "expansion" "conversion to base 32"
10150 The string must consist entirely of decimal digits. The number is converted to
10151 base 32 and output as a (empty, for zero) string of characters.
10152 Only lowercase letters are used.
10153
10154 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10155 .cindex "&%base32d%& expansion item"
10156 .cindex "expansion" "conversion to base 32"
10157 The string must consist entirely of base-32 digits.
10158 The number is converted to decimal and output as a string.
10159
10160 .vitem &*${base62:*&<&'digits'&>&*}*&
10161 .cindex "&%base62%& expansion item"
10162 .cindex "expansion" "conversion to base 62"
10163 The string must consist entirely of decimal digits. The number is converted to
10164 base 62 and output as a string of six characters, including leading zeros. In
10165 the few operating environments where Exim uses base 36 instead of base 62 for
10166 its message identifiers (because those systems do not have case-sensitive file
10167 names), base 36 is used by this operator, despite its name. &*Note*&: Just to
10168 be absolutely clear: this is &'not'& base64 encoding.
10169
10170 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10171 .cindex "&%base62d%& expansion item"
10172 .cindex "expansion" "conversion to base 62"
10173 The string must consist entirely of base-62 digits, or, in operating
10174 environments where Exim uses base 36 instead of base 62 for its message
10175 identifiers, base-36 digits. The number is converted to decimal and output as a
10176 string.
10177
10178 .vitem &*${base64:*&<&'string'&>&*}*&
10179 .cindex "expansion" "base64 encoding"
10180 .cindex "base64 encoding" "in string expansion"
10181 .cindex "&%base64%& expansion item"
10182 .cindex certificate "base64 of DER"
10183 This operator converts a string into one that is base64 encoded.
10184
10185 If the string is a single variable of type certificate,
10186 returns the base64 encoding of the DER form of the certificate.
10187
10188
10189 .vitem &*${base64d:*&<&'string'&>&*}*&
10190 .cindex "expansion" "base64 decoding"
10191 .cindex "base64 decoding" "in string expansion"
10192 .cindex "&%base64d%& expansion item"
10193 This operator converts a base64-encoded string into the un-coded form.
10194
10195
10196 .vitem &*${domain:*&<&'string'&>&*}*&
10197 .cindex "domain" "extraction"
10198 .cindex "expansion" "domain extraction"
10199 The string is interpreted as an RFC 2822 address and the domain is extracted
10200 from it. If the string does not parse successfully, the result is empty.
10201
10202
10203 .vitem &*${escape:*&<&'string'&>&*}*&
10204 .cindex "expansion" "escaping non-printing characters"
10205 .cindex "&%escape%& expansion item"
10206 If the string contains any non-printing characters, they are converted to
10207 escape sequences starting with a backslash. Whether characters with the most
10208 significant bit set (so-called &"8-bit characters"&) count as printing or not
10209 is controlled by the &%print_topbitchars%& option.
10210
10211 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10212 .cindex "expansion" "escaping 8-bit characters"
10213 .cindex "&%escape8bit%& expansion item"
10214 If the string contains and characters with the most significant bit set,
10215 they are converted to escape sequences starting with a backslash.
10216 Backslashes and DEL characters are also converted.
10217
10218
10219 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10220 .cindex "expansion" "expression evaluation"
10221 .cindex "expansion" "arithmetic expression"
10222 .cindex "&%eval%& expansion item"
10223 These items supports simple arithmetic and bitwise logical operations in
10224 expansion strings. The string (after expansion) must be a conventional
10225 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10226 logical operators, and parentheses. All operations are carried out using
10227 integer arithmetic. The operator priorities are as follows (the same as in the
10228 C programming language):
10229 .table2 70pt 300pt
10230 .irow &'highest:'& "not (~), negate (-)"
10231 .irow ""   "multiply (*), divide (/), remainder (%)"
10232 .irow ""   "plus (+), minus (-)"
10233 .irow ""   "shift-left (<<), shift-right (>>)"
10234 .irow ""   "and (&&)"
10235 .irow ""   "xor (^)"
10236 .irow &'lowest:'&  "or (|)"
10237 .endtable
10238 Binary operators with the same priority are evaluated from left to right. White
10239 space is permitted before or after operators.
10240
10241 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10242 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10243 decimal, even if they start with a leading zero; hexadecimal numbers are not
10244 permitted. This can be useful when processing numbers extracted from dates or
10245 times, which often do have leading zeros.
10246
10247 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10248 or 1024*1024*1024,
10249 respectively. Negative numbers are supported. The result of the computation is
10250 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10251
10252 .display
10253 &`${eval:1+1}            `&  yields 2
10254 &`${eval:1+2*3}          `&  yields 7
10255 &`${eval:(1+2)*3}        `&  yields 9
10256 &`${eval:2+42%5}         `&  yields 4
10257 &`${eval:0xc&amp;5}          `&  yields 4
10258 &`${eval:0xc|5}          `&  yields 13
10259 &`${eval:0xc^5}          `&  yields 9
10260 &`${eval:0xc>>1}         `&  yields 6
10261 &`${eval:0xc<<1}         `&  yields 24
10262 &`${eval:~255&amp;0x1234}    `&  yields 4608
10263 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10264 .endd
10265
10266 As a more realistic example, in an ACL you might have
10267 .code
10268 deny   message = Too many bad recipients
10269        condition =                    \
10270          ${if and {                   \
10271            {>{$rcpt_count}{10}}       \
10272            {                          \
10273            <                          \
10274              {$recipients_count}      \
10275              {${eval:$rcpt_count/2}}  \
10276            }                          \
10277          }{yes}{no}}
10278 .endd
10279 The condition is true if there have been more than 10 RCPT commands and
10280 fewer than half of them have resulted in a valid recipient.
10281
10282
10283 .vitem &*${expand:*&<&'string'&>&*}*&
10284 .cindex "expansion" "re-expansion of substring"
10285 The &%expand%& operator causes a string to be expanded for a second time. For
10286 example,
10287 .code
10288 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10289 .endd
10290 first looks up a string in a file while expanding the operand for &%expand%&,
10291 and then re-expands what it has found.
10292
10293
10294 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10295 .cindex "Unicode"
10296 .cindex "UTF-8" "conversion from"
10297 .cindex "expansion" "UTF-8 conversion"
10298 .cindex "&%from_utf8%& expansion item"
10299 The world is slowly moving towards Unicode, although there are no standards for
10300 email yet. However, other applications (including some databases) are starting
10301 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10302 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10303 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10304 the result is an undefined sequence of bytes.
10305
10306 Unicode code points with values less than 256 are compatible with ASCII and
10307 ISO-8859-1 (also known as Latin-1).
10308 For example, character 169 is the copyright symbol in both cases, though the
10309 way it is encoded is different. In UTF-8, more than one byte is needed for
10310 characters with code values greater than 127, whereas ISO-8859-1 is a
10311 single-byte encoding (but thereby limited to 256 characters). This makes
10312 translation from UTF-8 to ISO-8859-1 straightforward.
10313
10314
10315 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10316 .cindex "hash function" "textual"
10317 .cindex "expansion" "textual hash"
10318 The &%hash%& operator is a simpler interface to the hashing function that can
10319 be used when the two parameters are fixed numbers (as opposed to strings that
10320 change when expanded). The effect is the same as
10321 .code
10322 ${hash{<n>}{<m>}{<string>}}
10323 .endd
10324 See the description of the general &%hash%& item above for details. The
10325 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10326
10327
10328
10329 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10330 .cindex "base64 encoding" "conversion from hex"
10331 .cindex "expansion" "hex to base64"
10332 .cindex "&%hex2b64%& expansion item"
10333 This operator converts a hex string into one that is base64 encoded. This can
10334 be useful for processing the output of the MD5 and SHA-1 hashing functions.
10335
10336
10337
10338 .vitem &*${hexquote:*&<&'string'&>&*}*&
10339 .cindex "quoting" "hex-encoded unprintable characters"
10340 .cindex "&%hexquote%& expansion item"
10341 This operator converts non-printable characters in a string into a hex
10342 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10343 as is, and other byte values are converted to &`\xNN`&, for example a
10344 byte value 127 is converted to &`\x7f`&.
10345
10346
10347 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10348 .cindex "&%ipv6denorm%& expansion item"
10349 .cindex "IP address" normalisation
10350 This expands an IPv6 address to a full eight-element colon-separated set
10351 of hex digits including leading zeroes.
10352 A trailing ipv4-style dotted-decimal set is converted to hex.
10353 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10354
10355 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10356 .cindex "&%ipv6norm%& expansion item"
10357 .cindex "IP address" normalisation
10358 .cindex "IP address" "canonical form"
10359 This converts an IPv6 address to canonical form.
10360 Leading zeroes of groups are omitted, and the longest
10361 set of zero-valued groups is replaced with a double colon.
10362 A trailing ipv4-style dotted-decimal set is converted to hex.
10363 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10364
10365
10366 .vitem &*${lc:*&<&'string'&>&*}*&
10367 .cindex "case forcing in strings"
10368 .cindex "string" "case forcing"
10369 .cindex "lower casing"
10370 .cindex "expansion" "case forcing"
10371 .cindex "&%lc%& expansion item"
10372 This forces the letters in the string into lower-case, for example:
10373 .code
10374 ${lc:$local_part}
10375 .endd
10376
10377 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10378 .cindex "expansion" "string truncation"
10379 .cindex "&%length%& expansion item"
10380 The &%length%& operator is a simpler interface to the &%length%& function that
10381 can be used when the parameter is a fixed number (as opposed to a string that
10382 changes when expanded). The effect is the same as
10383 .code
10384 ${length{<number>}{<string>}}
10385 .endd
10386 See the description of the general &%length%& item above for details. Note that
10387 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10388 when &%length%& is used as an operator.
10389
10390
10391 .vitem &*${listcount:*&<&'string'&>&*}*&
10392 .cindex "expansion" "list item count"
10393 .cindex "list" "item count"
10394 .cindex "list" "count of items"
10395 .cindex "&%listcount%& expansion item"
10396 The string is interpreted as a list and the number of items is returned.
10397
10398
10399 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10400 .cindex "expansion" "named list"
10401 .cindex "&%listnamed%& expansion item"
10402 The name is interpreted as a named list and the content of the list is returned,
10403 expanding any referenced lists, re-quoting as needed for colon-separation.
10404 If the optional type is given it must be one of "a", "d", "h" or "l"
10405 and selects address-, domain-, host- or localpart- lists to search among respectively.
10406 Otherwise all types are searched in an undefined order and the first
10407 matching list is returned.
10408
10409
10410 .vitem &*${local_part:*&<&'string'&>&*}*&
10411 .cindex "expansion" "local part extraction"
10412 .cindex "&%local_part%& expansion item"
10413 The string is interpreted as an RFC 2822 address and the local part is
10414 extracted from it. If the string does not parse successfully, the result is
10415 empty.
10416
10417
10418 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10419 .cindex "masked IP address"
10420 .cindex "IP address" "masking"
10421 .cindex "CIDR notation"
10422 .cindex "expansion" "IP address masking"
10423 .cindex "&%mask%& expansion item"
10424 If the form of the string to be operated on is not an IP address followed by a
10425 slash and an integer (that is, a network address in CIDR notation), the
10426 expansion fails. Otherwise, this operator converts the IP address to binary,
10427 masks off the least significant bits according to the bit count, and converts
10428 the result back to text, with mask appended. For example,
10429 .code
10430 ${mask:10.111.131.206/28}
10431 .endd
10432 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10433 be mostly used for looking up masked addresses in files, the result for an IPv6
10434 address uses dots to separate components instead of colons, because colon
10435 terminates a key string in lsearch files. So, for example,
10436 .code
10437 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10438 .endd
10439 returns the string
10440 .code
10441 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10442 .endd
10443 Letters in IPv6 addresses are always output in lower case.
10444
10445
10446 .vitem &*${md5:*&<&'string'&>&*}*&
10447 .cindex "MD5 hash"
10448 .cindex "expansion" "MD5 hash"
10449 .cindex certificate fingerprint
10450 .cindex "&%md5%& expansion item"
10451 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10452 as a 32-digit hexadecimal number, in which any letters are in lower case.
10453
10454 If the string is a single variable of type certificate,
10455 returns the MD5 hash fingerprint of the certificate.
10456
10457
10458 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10459 .cindex "expansion" "numeric hash"
10460 .cindex "hash function" "numeric"
10461 The &%nhash%& operator is a simpler interface to the numeric hashing function
10462 that can be used when the two parameters are fixed numbers (as opposed to
10463 strings that change when expanded). The effect is the same as
10464 .code
10465 ${nhash{<n>}{<m>}{<string>}}
10466 .endd
10467 See the description of the general &%nhash%& item above for details.
10468
10469
10470 .vitem &*${quote:*&<&'string'&>&*}*&
10471 .cindex "quoting" "in string expansions"
10472 .cindex "expansion" "quoting"
10473 .cindex "&%quote%& expansion item"
10474 The &%quote%& operator puts its argument into double quotes if it
10475 is an empty string or
10476 contains anything other than letters, digits, underscores, dots, and hyphens.
10477 Any occurrences of double quotes and backslashes are escaped with a backslash.
10478 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10479 respectively For example,
10480 .code
10481 ${quote:ab"*"cd}
10482 .endd
10483 becomes
10484 .code
10485 "ab\"*\"cd"
10486 .endd
10487 The place where this is useful is when the argument is a substitution from a
10488 variable or a message header.
10489
10490 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10491 .cindex "&%quote_local_part%& expansion item"
10492 This operator is like &%quote%&, except that it quotes the string only if
10493 required to do so by the rules of RFC 2822 for quoting local parts. For
10494 example, a plus sign would not cause quoting (but it would for &%quote%&).
10495 If you are creating a new email address from the contents of &$local_part$&
10496 (or any other unknown data), you should always use this operator.
10497
10498
10499 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10500 .cindex "quoting" "lookup-specific"
10501 This operator applies lookup-specific quoting rules to the string. Each
10502 query-style lookup type has its own quoting rules which are described with
10503 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10504 .code
10505 ${quote_ldap:two * two}
10506 .endd
10507 returns
10508 .code
10509 two%20%5C2A%20two
10510 .endd
10511 For single-key lookup types, no quoting is ever necessary and this operator
10512 yields an unchanged string.
10513
10514
10515 .vitem &*${randint:*&<&'n'&>&*}*&
10516 .cindex "random number"
10517 This operator returns a somewhat random number which is less than the
10518 supplied number and is at least 0.  The quality of this randomness depends
10519 on how Exim was built; the values are not suitable for keying material.
10520 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10521 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10522 for versions of GnuTLS with that function.
10523 Otherwise, the implementation may be arc4random(), random() seeded by
10524 srandomdev() or srandom(), or a custom implementation even weaker than
10525 random().
10526
10527
10528 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10529 .cindex "expansion" "IP address"
10530 This operator reverses an IP address; for IPv4 addresses, the result is in
10531 dotted-quad decimal form, while for IPv6 addresses the result is in
10532 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10533 for DNS.  For example,
10534 .code
10535 ${reverse_ip:192.0.2.4}
10536 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10537 .endd
10538 returns
10539 .code
10540 4.2.0.192
10541 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
10542 .endd
10543
10544
10545 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10546 .cindex "expansion" "RFC 2047"
10547 .cindex "RFC 2047" "expansion operator"
10548 .cindex "&%rfc2047%& expansion item"
10549 This operator encodes text according to the rules of RFC 2047. This is an
10550 encoding that is used in header lines to encode non-ASCII characters. It is
10551 assumed that the input string is in the encoding specified by the
10552 &%headers_charset%& option, which gets its default at build time. If the string
10553 contains only characters in the range 33&--126, and no instances of the
10554 characters
10555 .code
10556 ? = ( ) < > @ , ; : \ " . [ ] _
10557 .endd
10558 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10559 string, using as many &"encoded words"& as necessary to encode all the
10560 characters.
10561
10562
10563 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10564 .cindex "expansion" "RFC 2047"
10565 .cindex "RFC 2047" "decoding"
10566 .cindex "&%rfc2047d%& expansion item"
10567 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10568 bytes are replaced by question marks. Characters are converted into the
10569 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10570 not recognized unless &%check_rfc2047_length%& is set false.
10571
10572 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10573 access a header line, RFC 2047 decoding is done automatically. You do not need
10574 to use this operator as well.
10575
10576
10577
10578 .vitem &*${rxquote:*&<&'string'&>&*}*&
10579 .cindex "quoting" "in regular expressions"
10580 .cindex "regular expressions" "quoting"
10581 .cindex "&%rxquote%& expansion item"
10582 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10583 characters in its argument. This is useful when substituting the values of
10584 variables or headers inside regular expressions.
10585
10586
10587 .vitem &*${sha1:*&<&'string'&>&*}*&
10588 .cindex "SHA-1 hash"
10589 .cindex "expansion" "SHA-1 hashing"
10590 .cindex certificate fingerprint
10591 .cindex "&%sha1%& expansion item"
10592 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10593 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10594
10595 If the string is a single variable of type certificate,
10596 returns the SHA-1 hash fingerprint of the certificate.
10597
10598
10599 .vitem &*${sha256:*&<&'string'&>&*}*&
10600 .cindex "SHA-256 hash"
10601 .cindex certificate fingerprint
10602 .cindex "expansion" "SHA-256 hashing"
10603 .cindex "&%sha256%& expansion item"
10604 The &%sha256%& operator computes the SHA-256 hash value of the string
10605 and returns
10606 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10607
10608 If the string is a single variable of type certificate,
10609 returns the SHA-256 hash fingerprint of the certificate.
10610
10611
10612 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10613        &*${sha3_<n>:*&<&'string'&>&*}*&
10614 .cindex "SHA3 hash"
10615 .cindex "expansion" "SHA3 hashing"
10616 .cindex "&%sha3%& expansion item"
10617 The &%sha3%& operator computes the SHA3-256 hash value of the string
10618 and returns
10619 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10620
10621 If a number is appended, separated by an underbar, it specifies
10622 the output length.  Values of 224, 256, 384 and 512 are accepted;
10623 with 256 being the default.
10624
10625 The &%sha3%& expansion item is only supported if Exim has been
10626 compiled with GnuTLS 3.5.0 or later.
10627
10628
10629 .vitem &*${stat:*&<&'string'&>&*}*&
10630 .cindex "expansion" "statting a file"
10631 .cindex "file" "extracting characteristics"
10632 .cindex "&%stat%& expansion item"
10633 The string, after expansion, must be a file path. A call to the &[stat()]&
10634 function is made for this path. If &[stat()]& fails, an error occurs and the
10635 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10636 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10637 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10638 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10639 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10640 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10641 can extract individual fields using the &%extract%& expansion item.
10642
10643 The use of the &%stat%& expansion in users' filter files can be locked out by
10644 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
10645 systems for files larger than 2GB.
10646
10647 .vitem &*${str2b64:*&<&'string'&>&*}*&
10648 .cindex "&%str2b64%& expansion item"
10649 Now deprecated, a synonym for the &%base64%& expansion operator.
10650
10651
10652
10653 .vitem &*${strlen:*&<&'string'&>&*}*&
10654 .cindex "expansion" "string length"
10655 .cindex "string" "length in expansion"
10656 .cindex "&%strlen%& expansion item"
10657 The item is replace by the length of the expanded string, expressed as a
10658 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
10659
10660
10661 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
10662 .cindex "&%substr%& expansion item"
10663 .cindex "substring extraction"
10664 .cindex "expansion" "substring expansion"
10665 The &%substr%& operator is a simpler interface to the &%substr%& function that
10666 can be used when the two parameters are fixed numbers (as opposed to strings
10667 that change when expanded). The effect is the same as
10668 .code
10669 ${substr{<start>}{<length>}{<string>}}
10670 .endd
10671 See the description of the general &%substr%& item above for details. The
10672 abbreviation &%s%& can be used when &%substr%& is used as an operator.
10673
10674 .vitem &*${time_eval:*&<&'string'&>&*}*&
10675 .cindex "&%time_eval%& expansion item"
10676 .cindex "time interval" "decoding"
10677 This item converts an Exim time interval such as &`2d4h5m`& into a number of
10678 seconds.
10679
10680 .vitem &*${time_interval:*&<&'string'&>&*}*&
10681 .cindex "&%time_interval%& expansion item"
10682 .cindex "time interval" "formatting"
10683 The argument (after sub-expansion) must be a sequence of decimal digits that
10684 represents an interval of time as a number of seconds. It is converted into a
10685 number of larger units and output in Exim's normal time format, for example,
10686 &`1w3d4h2m6s`&.
10687
10688 .vitem &*${uc:*&<&'string'&>&*}*&
10689 .cindex "case forcing in strings"
10690 .cindex "string" "case forcing"
10691 .cindex "upper casing"
10692 .cindex "expansion" "case forcing"
10693 .cindex "&%uc%& expansion item"
10694 This forces the letters in the string into upper-case.
10695
10696 .vitem &*${utf8clean:*&<&'string'&>&*}*&
10697 .cindex "correction of invalid utf-8 sequences in strings"
10698 .cindex "utf-8" "utf-8 sequences"
10699 .cindex "incorrect utf-8"
10700 .cindex "expansion" "utf-8 forcing"
10701 .cindex "&%utf8clean%& expansion item"
10702 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
10703
10704 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
10705        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
10706        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
10707        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
10708 .cindex expansion UTF-8
10709 .cindex UTF-8 expansion
10710 .cindex EAI
10711 .cindex internationalisation
10712 .cindex "&%utf8_domain_to_alabel%& expansion item"
10713 .cindex "&%utf8_domain_from_alabel%& expansion item"
10714 .cindex "&%utf8_localpart_to_alabel%& expansion item"
10715 .cindex "&%utf8_localpart_from_alabel%& expansion item"
10716 These convert EAI mail name components between UTF-8 and a-label forms.
10717 For information on internationalisation support see &<<SECTi18nMTA>>&.
10718 .endlist
10719
10720
10721
10722
10723
10724
10725 .section "Expansion conditions" "SECTexpcond"
10726 .scindex IIDexpcond "expansion" "conditions"
10727 The following conditions are available for testing by the &%${if%& construct
10728 while expanding strings:
10729
10730 .vlist
10731 .vitem &*!*&<&'condition'&>
10732 .cindex "expansion" "negating a condition"
10733 .cindex "negation" "in expansion condition"
10734 Preceding any condition with an exclamation mark negates the result of the
10735 condition.
10736
10737 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10738 .cindex "numeric comparison"
10739 .cindex "expansion" "numeric comparison"
10740 There are a number of symbolic operators for doing numeric comparisons. They
10741 are:
10742 .display
10743 &`=   `&   equal
10744 &`==  `&   equal
10745 &`>   `&   greater
10746 &`>=  `&   greater or equal
10747 &`<   `&   less
10748 &`<=  `&   less or equal
10749 .endd
10750 For example:
10751 .code
10752 ${if >{$message_size}{10M} ...
10753 .endd
10754 Note that the general negation operator provides for inequality testing. The
10755 two strings must take the form of optionally signed decimal integers,
10756 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
10757 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
10758 As a special case, the numerical value of an empty string is taken as
10759 zero.
10760
10761 In all cases, a relative comparator OP is testing if <&'string1'&> OP
10762 <&'string2'&>; the above example is checking if &$message_size$& is larger than
10763 10M, not if 10M is larger than &$message_size$&.
10764
10765
10766 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
10767         {*&<&'arg2'&>&*}...}*&
10768 .cindex "expansion" "calling an acl"
10769 .cindex "&%acl%&" "expansion condition"
10770 The name and zero to nine argument strings are first expanded separately.  The expanded
10771 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
10772 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
10773 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
10774 and may use the variables; if another acl expansion is used the values
10775 are restored after it returns.  If the ACL sets
10776 a value using a "message =" modifier the variable $value becomes
10777 the result of the expansion, otherwise it is empty.
10778 If the ACL returns accept the condition is true; if deny, false.
10779 If the ACL returns defer the result is a forced-fail.
10780
10781 .vitem &*bool&~{*&<&'string'&>&*}*&
10782 .cindex "expansion" "boolean parsing"
10783 .cindex "&%bool%& expansion condition"
10784 This condition turns a string holding a true or false representation into
10785 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
10786 (case-insensitively); also integer numbers map to true if non-zero,
10787 false if zero.
10788 An empty string is treated as false.
10789 Leading and trailing whitespace is ignored;
10790 thus a string consisting only of whitespace is false.
10791 All other string values will result in expansion failure.
10792
10793 When combined with ACL variables, this expansion condition will let you
10794 make decisions in one place and act on those decisions in another place.
10795 For example:
10796 .code
10797 ${if bool{$acl_m_privileged_sender} ...
10798 .endd
10799
10800
10801 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
10802 .cindex "expansion" "boolean parsing"
10803 .cindex "&%bool_lax%& expansion condition"
10804 Like &%bool%&, this condition turns a string into a boolean state.  But
10805 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
10806 loose definition that the Router &%condition%& option uses.  The empty string
10807 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
10808 true.  Leading and trailing whitespace is ignored.
10809
10810 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
10811
10812 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10813 .cindex "expansion" "encrypted comparison"
10814 .cindex "encrypted strings, comparing"
10815 .cindex "&%crypteq%& expansion condition"
10816 This condition is included in the Exim binary if it is built to support any
10817 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
10818 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
10819 included in the binary.
10820
10821 The &%crypteq%& condition has two arguments. The first is encrypted and
10822 compared against the second, which is already encrypted. The second string may
10823 be in the LDAP form for storing encrypted strings, which starts with the
10824 encryption type in curly brackets, followed by the data. If the second string
10825 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
10826 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
10827 Typically this will be a field from a password file. An example of an encrypted
10828 string in LDAP form is:
10829 .code
10830 {md5}CY9rzUYh03PK3k6DJie09g==
10831 .endd
10832 If such a string appears directly in an expansion, the curly brackets have to
10833 be quoted, because they are part of the expansion syntax. For example:
10834 .code
10835 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
10836 .endd
10837 The following encryption types (whose names are matched case-independently) are
10838 supported:
10839
10840 .ilist
10841 .cindex "MD5 hash"
10842 .cindex "base64 encoding" "in encrypted password"
10843 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
10844 printable characters to compare with the remainder of the second string. If the
10845 length of the comparison string is 24, Exim assumes that it is base64 encoded
10846 (as in the above example). If the length is 32, Exim assumes that it is a
10847 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
10848 comparison fails.
10849
10850 .next
10851 .cindex "SHA-1 hash"
10852 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
10853 printable characters to compare with the remainder of the second string. If the
10854 length of the comparison string is 28, Exim assumes that it is base64 encoded.
10855 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
10856 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
10857
10858 .next
10859 .cindex "&[crypt()]&"
10860 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
10861 only the first eight characters of the password. However, in modern operating
10862 systems this is no longer true, and in many cases the entire password is used,
10863 whatever its length.
10864
10865 .next
10866 .cindex "&[crypt16()]&"
10867 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
10868 use up to 16 characters of the password in some operating systems. Again, in
10869 modern operating systems, more characters may be used.
10870 .endlist
10871 Exim has its own version of &[crypt16()]&, which is just a double call to
10872 &[crypt()]&. For operating systems that have their own version, setting
10873 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
10874 operating system version instead of its own. This option is set by default in
10875 the OS-dependent &_Makefile_& for those operating systems that are known to
10876 support &[crypt16()]&.
10877
10878 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
10879 it was not using the same algorithm as some operating systems' versions. It
10880 turns out that as well as &[crypt16()]& there is a function called
10881 &[bigcrypt()]& in some operating systems. This may or may not use the same
10882 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
10883
10884 However, since there is now a move away from the traditional &[crypt()]&
10885 functions towards using SHA1 and other algorithms, tidying up this area of
10886 Exim is seen as very low priority.
10887
10888 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
10889 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
10890 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
10891 default is &`{crypt}`&. Whatever the default, you can always use either
10892 function by specifying it explicitly in curly brackets.
10893
10894 .vitem &*def:*&<&'variable&~name'&>
10895 .cindex "expansion" "checking for empty variable"
10896 .cindex "&%def%& expansion condition"
10897 The &%def%& condition must be followed by the name of one of the expansion
10898 variables defined in section &<<SECTexpvar>>&. The condition is true if the
10899 variable does not contain the empty string. For example:
10900 .code
10901 ${if def:sender_ident {from $sender_ident}}
10902 .endd
10903 Note that the variable name is given without a leading &%$%& character. If the
10904 variable does not exist, the expansion fails.
10905
10906 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
10907         &~&*def:h_*&<&'header&~name'&>&*:*&"
10908 .cindex "expansion" "checking header line existence"
10909 This condition is true if a message is being processed and the named header
10910 exists in the message. For example,
10911 .code
10912 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
10913 .endd
10914 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
10915 the header name must be terminated by a colon if white space does not follow.
10916
10917 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10918        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10919 .cindex "string" "comparison"
10920 .cindex "expansion" "string comparison"
10921 .cindex "&%eq%& expansion condition"
10922 .cindex "&%eqi%& expansion condition"
10923 The two substrings are first expanded. The condition is true if the two
10924 resulting strings are identical. For &%eq%& the comparison includes the case of
10925 letters, whereas for &%eqi%& the comparison is case-independent.
10926
10927 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
10928 .cindex "expansion" "file existence test"
10929 .cindex "file" "existence test"
10930 .cindex "&%exists%&, expansion condition"
10931 The substring is first expanded and then interpreted as an absolute path. The
10932 condition is true if the named file (or directory) exists. The existence test
10933 is done by calling the &[stat()]& function. The use of the &%exists%& test in
10934 users' filter files may be locked out by the system administrator.
10935
10936 .vitem &*first_delivery*&
10937 .cindex "delivery" "first"
10938 .cindex "first delivery"
10939 .cindex "expansion" "first delivery test"
10940 .cindex "&%first_delivery%& expansion condition"
10941 This condition, which has no data, is true during a message's first delivery
10942 attempt. It is false during any subsequent delivery attempts.
10943
10944
10945 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
10946        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
10947 .cindex "list" "iterative conditions"
10948 .cindex "expansion" "&*forall*& condition"
10949 .cindex "expansion" "&*forany*& condition"
10950 .vindex "&$item$&"
10951 These conditions iterate over a list. The first argument is expanded to form
10952 the list. By default, the list separator is a colon, but it can be changed by
10953 the normal method. The second argument is interpreted as a condition that is to
10954 be applied to each item in the list in turn. During the interpretation of the
10955 condition, the current list item is placed in a variable called &$item$&.
10956 .ilist
10957 For &*forany*&, interpretation stops if the condition is true for any item, and
10958 the result of the whole condition is true. If the condition is false for all
10959 items in the list, the overall condition is false.
10960 .next
10961 For &*forall*&, interpretation stops if the condition is false for any item,
10962 and the result of the whole condition is false. If the condition is true for
10963 all items in the list, the overall condition is true.
10964 .endlist
10965 Note that negation of &*forany*& means that the condition must be false for all
10966 items for the overall condition to succeed, and negation of &*forall*& means
10967 that the condition must be false for at least one item. In this example, the
10968 list separator is changed to a comma:
10969 .code
10970 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
10971 .endd
10972 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
10973 being processed, to enable these expansion items to be nested.
10974
10975 To scan a named list, expand it with the &*listnamed*& operator.
10976
10977
10978 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10979        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10980 .cindex "string" "comparison"
10981 .cindex "expansion" "string comparison"
10982 .cindex "&%ge%& expansion condition"
10983 .cindex "&%gei%& expansion condition"
10984 The two substrings are first expanded. The condition is true if the first
10985 string is lexically greater than or equal to the second string. For &%ge%& the
10986 comparison includes the case of letters, whereas for &%gei%& the comparison is
10987 case-independent.
10988
10989 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
10990        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
10991 .cindex "string" "comparison"
10992 .cindex "expansion" "string comparison"
10993 .cindex "&%gt%& expansion condition"
10994 .cindex "&%gti%& expansion condition"
10995 The two substrings are first expanded. The condition is true if the first
10996 string is lexically greater than the second string. For &%gt%& the comparison
10997 includes the case of letters, whereas for &%gti%& the comparison is
10998 case-independent.
10999
11000 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11001        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11002 .cindex "string" "comparison"
11003 .cindex "list" "iterative conditions"
11004 Both strings are expanded; the second string is treated as a list of simple
11005 strings; if the first string is a member of the second, then the condition
11006 is true.
11007
11008 These are simpler to use versions of the more powerful &*forany*& condition.
11009 Examples, and the &*forany*& equivalents:
11010 .code
11011 ${if inlist{needle}{foo:needle:bar}}
11012   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11013 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11014   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11015 .endd
11016
11017 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11018        &*isip4&~{*&<&'string'&>&*}*& &&&
11019        &*isip6&~{*&<&'string'&>&*}*&
11020 .cindex "IP address" "testing string format"
11021 .cindex "string" "testing for IP address"
11022 .cindex "&%isip%& expansion condition"
11023 .cindex "&%isip4%& expansion condition"
11024 .cindex "&%isip6%& expansion condition"
11025 The substring is first expanded, and then tested to see if it has the form of
11026 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11027 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11028
11029 For an IPv4 address, the test is for four dot-separated components, each of
11030 which consists of from one to three digits. For an IPv6 address, up to eight
11031 colon-separated components are permitted, each containing from one to four
11032 hexadecimal digits. There may be fewer than eight components if an empty
11033 component (adjacent colons) is present. Only one empty component is permitted.
11034
11035 .new
11036 &*Note*&: The checks used to be just on the form of the address; actual numerical
11037 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11038 check.
11039 This is no longer the case.
11040 .wen
11041
11042 The main use of these tests is to distinguish between IP addresses and
11043 host names, or between IPv4 and IPv6 addresses. For example, you could use
11044 .code
11045 ${if isip4{$sender_host_address}...
11046 .endd
11047 to test which IP version an incoming SMTP connection is using.
11048
11049 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11050 .cindex "LDAP" "use for authentication"
11051 .cindex "expansion" "LDAP authentication test"
11052 .cindex "&%ldapauth%& expansion condition"
11053 This condition supports user authentication using LDAP. See section
11054 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11055 queries. For this use, the query must contain a user name and password. The
11056 query itself is not used, and can be empty. The condition is true if the
11057 password is not empty, and the user name and password are accepted by the LDAP
11058 server. An empty password is rejected without calling LDAP because LDAP binds
11059 with an empty password are considered anonymous regardless of the username, and
11060 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11061 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11062 this can be used.
11063
11064
11065 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11066        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11067 .cindex "string" "comparison"
11068 .cindex "expansion" "string comparison"
11069 .cindex "&%le%& expansion condition"
11070 .cindex "&%lei%& expansion condition"
11071 The two substrings are first expanded. The condition is true if the first
11072 string is lexically less than or equal to the second string. For &%le%& the
11073 comparison includes the case of letters, whereas for &%lei%& the comparison is
11074 case-independent.
11075
11076 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11077        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11078 .cindex "string" "comparison"
11079 .cindex "expansion" "string comparison"
11080 .cindex "&%lt%& expansion condition"
11081 .cindex "&%lti%& expansion condition"
11082 The two substrings are first expanded. The condition is true if the first
11083 string is lexically less than the second string. For &%lt%& the comparison
11084 includes the case of letters, whereas for &%lti%& the comparison is
11085 case-independent.
11086
11087
11088 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11089 .cindex "expansion" "regular expression comparison"
11090 .cindex "regular expressions" "match in expanded string"
11091 .cindex "&%match%& expansion condition"
11092 The two substrings are first expanded. The second is then treated as a regular
11093 expression and applied to the first. Because of the pre-expansion, if the
11094 regular expression contains dollar, or backslash characters, they must be
11095 escaped. Care must also be taken if the regular expression contains braces
11096 (curly brackets). A closing brace must be escaped so that it is not taken as a
11097 premature termination of <&'string2'&>. The easiest approach is to use the
11098 &`\N`& feature to disable expansion of the regular expression.
11099 For example,
11100 .code
11101 ${if match {$local_part}{\N^\d{3}\N} ...
11102 .endd
11103 If the whole expansion string is in double quotes, further escaping of
11104 backslashes is also required.
11105
11106 The condition is true if the regular expression match succeeds.
11107 The regular expression is not required to begin with a circumflex
11108 metacharacter, but if there is no circumflex, the expression is not anchored,
11109 and it may match anywhere in the subject, not just at the start. If you want
11110 the pattern to match at the end of the subject, you must include the &`$`&
11111 metacharacter at an appropriate point.
11112
11113 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11114 At the start of an &%if%& expansion the values of the numeric variable
11115 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11116 succeeds causes them to be reset to the substrings of that condition and they
11117 will have these values during the expansion of the success string. At the end
11118 of the &%if%& expansion, the previous values are restored. After testing a
11119 combination of conditions using &%or%&, the subsequent values of the numeric
11120 variables are those of the condition that succeeded.
11121
11122 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11123 .cindex "&%match_address%& expansion condition"
11124 See &*match_local_part*&.
11125
11126 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11127 .cindex "&%match_domain%& expansion condition"
11128 See &*match_local_part*&.
11129
11130 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11131 .cindex "&%match_ip%& expansion condition"
11132 This condition matches an IP address to a list of IP address patterns. It must
11133 be followed by two argument strings. The first (after expansion) must be an IP
11134 address or an empty string. The second (not expanded) is a restricted host
11135 list that can match only an IP address, not a host name. For example:
11136 .code
11137 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11138 .endd
11139 The specific types of host list item that are permitted in the list are:
11140
11141 .ilist
11142 An IP address, optionally with a CIDR mask.
11143 .next
11144 A single asterisk, which matches any IP address.
11145 .next
11146 An empty item, which matches only if the IP address is empty. This could be
11147 useful for testing for a locally submitted message or one from specific hosts
11148 in a single test such as
11149 . ==== As this is a nested list, any displays it contains must be indented
11150 . ==== as otherwise they are too far to the left. This comment applies to
11151 . ==== the use of xmlto plus fop. There's no problem when formatting with
11152 . ==== sdop, with or without the extra indent.
11153 .code
11154   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11155 .endd
11156 where the first item in the list is the empty string.
11157 .next
11158 The item @[] matches any of the local host's interface addresses.
11159 .next
11160 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11161 even if &`net-`& is not specified. There is never any attempt to turn the IP
11162 address into a host name. The most common type of linear search for
11163 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11164 masks. For example:
11165 .code
11166   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11167 .endd
11168 It is of course possible to use other kinds of lookup, and in such a case, you
11169 do need to specify the &`net-`& prefix if you want to specify a specific
11170 address mask, for example:
11171 .code
11172   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11173 .endd
11174 However, unless you are combining a &%match_ip%& condition with others, it is
11175 just as easy to use the fact that a lookup is itself a condition, and write:
11176 .code
11177   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11178 .endd
11179 .endlist ilist
11180
11181 Note that <&'string2'&> is not itself subject to string expansion, unless
11182 Exim was built with the EXPAND_LISTMATCH_RHS option.
11183
11184 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11185
11186 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11187 .cindex "domain list" "in expansion condition"
11188 .cindex "address list" "in expansion condition"
11189 .cindex "local part" "list, in expansion condition"
11190 .cindex "&%match_local_part%& expansion condition"
11191 This condition, together with &%match_address%& and &%match_domain%&, make it
11192 possible to test domain, address, and local part lists within expansions. Each
11193 condition requires two arguments: an item and a list to match. A trivial
11194 example is:
11195 .code
11196 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11197 .endd
11198 In each case, the second argument may contain any of the allowable items for a
11199 list of the appropriate type. Also, because the second argument
11200 is a standard form of list, it is possible to refer to a named list.
11201 Thus, you can use conditions like this:
11202 .code
11203 ${if match_domain{$domain}{+local_domains}{...
11204 .endd
11205 .cindex "&`+caseful`&"
11206 For address lists, the matching starts off caselessly, but the &`+caseful`&
11207 item can be used, as in all address lists, to cause subsequent items to
11208 have their local parts matched casefully. Domains are always matched
11209 caselessly.
11210
11211 Note that <&'string2'&> is not itself subject to string expansion, unless
11212 Exim was built with the EXPAND_LISTMATCH_RHS option.
11213
11214 &*Note*&: Host lists are &'not'& supported in this way. This is because
11215 hosts have two identities: a name and an IP address, and it is not clear
11216 how to specify cleanly how such a test would work. However, IP addresses can be
11217 matched using &%match_ip%&.
11218
11219 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11220 .cindex "PAM authentication"
11221 .cindex "AUTH" "with PAM"
11222 .cindex "Solaris" "PAM support"
11223 .cindex "expansion" "PAM authentication test"
11224 .cindex "&%pam%& expansion condition"
11225 &'Pluggable Authentication Modules'&
11226 (&url(http://www.kernel.org/pub/linux/libs/pam/)) are a facility that is
11227 available in the latest releases of Solaris and in some GNU/Linux
11228 distributions. The Exim support, which is intended for use in conjunction with
11229 the SMTP AUTH command, is available only if Exim is compiled with
11230 .code
11231 SUPPORT_PAM=yes
11232 .endd
11233 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11234 in some releases of GNU/Linux &%-ldl%& is also needed.
11235
11236 The argument string is first expanded, and the result must be a
11237 colon-separated list of strings. Leading and trailing white space is ignored.
11238 The PAM module is initialized with the service name &"exim"& and the user name
11239 taken from the first item in the colon-separated data string (<&'string1'&>).
11240 The remaining items in the data string are passed over in response to requests
11241 from the authentication function. In the simple case there will only be one
11242 request, for a password, so the data consists of just two strings.
11243
11244 There can be problems if any of the strings are permitted to contain colon
11245 characters. In the usual way, these have to be doubled to avoid being taken as
11246 separators. If the data is being inserted from a variable, the &%sg%& expansion
11247 item can be used to double any existing colons. For example, the configuration
11248 of a LOGIN authenticator might contain this setting:
11249 .code
11250 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11251 .endd
11252 For a PLAIN authenticator you could use:
11253 .code
11254 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11255 .endd
11256 In some operating systems, PAM authentication can be done only from a process
11257 running as root. Since Exim is running as the Exim user when receiving
11258 messages, this means that PAM cannot be used directly in those systems.
11259 A patched version of the &'pam_unix'& module that comes with the
11260 Linux PAM package is available from &url(http://www.e-admin.de/pam_exim/).
11261 The patched module allows one special uid/gid combination, in addition to root,
11262 to authenticate. If you build the patched module to allow the Exim user and
11263 group, PAM can then be used from an Exim authenticator.
11264
11265
11266 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11267 .cindex "&'pwcheck'& daemon"
11268 .cindex "Cyrus"
11269 .cindex "expansion" "&'pwcheck'& authentication test"
11270 .cindex "&%pwcheck%& expansion condition"
11271 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11272 This is one way of making it possible for passwords to be checked by a process
11273 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11274 deprecated. Its replacement is &'saslauthd'& (see below).
11275
11276 The pwcheck support is not included in Exim by default. You need to specify
11277 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11278 building Exim. For example:
11279 .code
11280 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11281 .endd
11282 You do not need to install the full Cyrus software suite in order to use
11283 the pwcheck daemon. You can compile and install just the daemon alone
11284 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11285 access to the &_/var/pwcheck_& directory.
11286
11287 The &%pwcheck%& condition takes one argument, which must be the user name and
11288 password, separated by a colon. For example, in a LOGIN authenticator
11289 configuration, you might have this:
11290 .code
11291 server_condition = ${if pwcheck{$auth1:$auth2}}
11292 .endd
11293 Again, for a PLAIN authenticator configuration, this would be:
11294 .code
11295 server_condition = ${if pwcheck{$auth2:$auth3}}
11296 .endd
11297 .vitem &*queue_running*&
11298 .cindex "queue runner" "detecting when delivering from"
11299 .cindex "expansion" "queue runner test"
11300 .cindex "&%queue_running%& expansion condition"
11301 This condition, which has no data, is true during delivery attempts that are
11302 initiated by queue runner processes, and false otherwise.
11303
11304
11305 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11306 .cindex "Radius"
11307 .cindex "expansion" "Radius authentication"
11308 .cindex "&%radius%& expansion condition"
11309 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11310 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11311 the Radius client configuration file in order to build Exim with Radius
11312 support.
11313
11314 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11315 library, using the original API. If you are using release 0.4.0 or later of
11316 this library, you need to set
11317 .code
11318 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11319 .endd
11320 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11321 &%libradius%& library that comes with FreeBSD. To do this, set
11322 .code
11323 RADIUS_LIB_TYPE=RADLIB
11324 .endd
11325 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11326 You may also have to supply a suitable setting in EXTRALIBS so that the
11327 Radius library can be found when Exim is linked.
11328
11329 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11330 Radius client library, which calls the Radius server. The condition is true if
11331 the authentication is successful. For example:
11332 .code
11333 server_condition = ${if radius{<arguments>}}
11334 .endd
11335
11336
11337 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11338         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11339 .cindex "&'saslauthd'& daemon"
11340 .cindex "Cyrus"
11341 .cindex "expansion" "&'saslauthd'& authentication test"
11342 .cindex "&%saslauthd%& expansion condition"
11343 This condition supports user authentication using the Cyrus &'saslauthd'&
11344 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11345 Using this daemon is one way of making it possible for passwords to be checked
11346 by a process that is not running as root.
11347
11348 The saslauthd support is not included in Exim by default. You need to specify
11349 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11350 building Exim. For example:
11351 .code
11352 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11353 .endd
11354 You do not need to install the full Cyrus software suite in order to use
11355 the saslauthd daemon. You can compile and install just the daemon alone
11356 from the Cyrus SASL library.
11357
11358 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11359 two are mandatory. For example:
11360 .code
11361 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11362 .endd
11363 The service and the realm are optional (which is why the arguments are enclosed
11364 in their own set of braces). For details of the meaning of the service and
11365 realm, and how to run the daemon, consult the Cyrus documentation.
11366 .endlist vlist
11367
11368
11369
11370 .section "Combining expansion conditions" "SECID84"
11371 .cindex "expansion" "combining conditions"
11372 Several conditions can be tested at once by combining them using the &%and%&
11373 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11374 conditions on their own, and precede their lists of sub-conditions. Each
11375 sub-condition must be enclosed in braces within the overall braces that contain
11376 the list. No repetition of &%if%& is used.
11377
11378
11379 .vlist
11380 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11381 .cindex "&""or""& expansion condition"
11382 .cindex "expansion" "&""or""& of conditions"
11383 The sub-conditions are evaluated from left to right. The condition is true if
11384 any one of the sub-conditions is true.
11385 For example,
11386 .code
11387 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11388 .endd
11389 When a true sub-condition is found, the following ones are parsed but not
11390 evaluated. If there are several &"match"& sub-conditions the values of the
11391 numeric variables afterwards are taken from the first one that succeeds.
11392
11393 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11394 .cindex "&""and""& expansion condition"
11395 .cindex "expansion" "&""and""& of conditions"
11396 The sub-conditions are evaluated from left to right. The condition is true if
11397 all of the sub-conditions are true. If there are several &"match"&
11398 sub-conditions, the values of the numeric variables afterwards are taken from
11399 the last one. When a false sub-condition is found, the following ones are
11400 parsed but not evaluated.
11401 .endlist
11402 .ecindex IIDexpcond
11403
11404
11405
11406
11407 .section "Expansion variables" "SECTexpvar"
11408 .cindex "expansion" "variables, list of"
11409 This section contains an alphabetical list of all the expansion variables. Some
11410 of them are available only when Exim is compiled with specific options such as
11411 support for TLS or the content scanning extension.
11412
11413 .vlist
11414 .vitem "&$0$&, &$1$&, etc"
11415 .cindex "numerical variables (&$1$& &$2$& etc)"
11416 When a &%match%& expansion condition succeeds, these variables contain the
11417 captured substrings identified by the regular expression during subsequent
11418 processing of the success string of the containing &%if%& expansion item.
11419 In the expansion condition case
11420 they do not retain their values afterwards; in fact, their previous
11421 values are restored at the end of processing an &%if%& item. The numerical
11422 variables may also be set externally by some other matching process which
11423 precedes the expansion of the string. For example, the commands available in
11424 Exim filter files include an &%if%& command with its own regular expression
11425 matching condition.
11426
11427 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11428 Within an acl condition, expansion condition or expansion item
11429 any arguments are copied to these variables,
11430 any unused variables being made empty.
11431
11432 .vitem "&$acl_c...$&"
11433 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11434 can be given any name that starts with &$acl_c$& and is at least six characters
11435 long, but the sixth character must be either a digit or an underscore. For
11436 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11437 variables persist throughout the lifetime of an SMTP connection. They can be
11438 used to pass information between ACLs and between different invocations of the
11439 same ACL. When a message is received, the values of these variables are saved
11440 with the message, and can be accessed by filters, routers, and transports
11441 during subsequent delivery.
11442
11443 .vitem "&$acl_m...$&"
11444 These variables are like the &$acl_c...$& variables, except that their values
11445 are reset after a message has been received. Thus, if several messages are
11446 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11447 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11448 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11449 message is received, the values of these variables are saved with the message,
11450 and can be accessed by filters, routers, and transports during subsequent
11451 delivery.
11452
11453 .vitem &$acl_narg$&
11454 Within an acl condition, expansion condition or expansion item
11455 this variable has the number of arguments.
11456
11457 .vitem &$acl_verify_message$&
11458 .vindex "&$acl_verify_message$&"
11459 After an address verification has failed, this variable contains the failure
11460 message. It retains its value for use in subsequent modifiers. The message can
11461 be preserved by coding like this:
11462 .code
11463 warn !verify = sender
11464      set acl_m0 = $acl_verify_message
11465 .endd
11466 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11467 &%log_message%& modifiers, to include information about the verification
11468 failure.
11469
11470 .vitem &$address_data$&
11471 .vindex "&$address_data$&"
11472 This variable is set by means of the &%address_data%& option in routers. The
11473 value then remains with the address while it is processed by subsequent routers
11474 and eventually a transport. If the transport is handling multiple addresses,
11475 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11476 for more details. &*Note*&: The contents of &$address_data$& are visible in
11477 user filter files.
11478
11479 If &$address_data$& is set when the routers are called from an ACL to verify
11480 a recipient address, the final value is still in the variable for subsequent
11481 conditions and modifiers of the ACL statement. If routing the address caused it
11482 to be redirected to just one address, the child address is also routed as part
11483 of the verification, and in this case the final value of &$address_data$& is
11484 from the child's routing.
11485
11486 If &$address_data$& is set when the routers are called from an ACL to verify a
11487 sender address, the final value is also preserved, but this time in
11488 &$sender_address_data$&, to distinguish it from data from a recipient
11489 address.
11490
11491 In both cases (recipient and sender verification), the value does not persist
11492 after the end of the current ACL statement. If you want to preserve
11493 these values for longer, you can save them in ACL variables.
11494
11495 .vitem &$address_file$&
11496 .vindex "&$address_file$&"
11497 When, as a result of aliasing, forwarding, or filtering, a message is directed
11498 to a specific file, this variable holds the name of the file when the transport
11499 is running. At other times, the variable is empty. For example, using the
11500 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11501 .code
11502 /home/r2d2/savemail
11503 .endd
11504 then when the &(address_file)& transport is running, &$address_file$&
11505 contains the text string &`/home/r2d2/savemail`&.
11506 .cindex "Sieve filter" "value of &$address_file$&"
11507 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11508 then up to the transport configuration to generate an appropriate absolute path
11509 to the relevant file.
11510
11511 .vitem &$address_pipe$&
11512 .vindex "&$address_pipe$&"
11513 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11514 this variable holds the pipe command when the transport is running.
11515
11516 .vitem "&$auth1$& &-- &$auth3$&"
11517 .vindex "&$auth1$&, &$auth2$&, etc"
11518 These variables are used in SMTP authenticators (see chapters
11519 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11520
11521 .vitem &$authenticated_id$&
11522 .cindex "authentication" "id"
11523 .vindex "&$authenticated_id$&"
11524 When a server successfully authenticates a client it may be configured to
11525 preserve some of the authentication information in the variable
11526 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11527 user/password authenticator configuration might preserve the user name for use
11528 in the routers. Note that this is not the same information that is saved in
11529 &$sender_host_authenticated$&.
11530 When a message is submitted locally (that is, not over a TCP connection)
11531 the value of &$authenticated_id$& is normally the login name of the calling
11532 process. However, a trusted user can override this by means of the &%-oMai%&
11533 command line option.
11534
11535 .vitem &$authenticated_fail_id$&
11536 .cindex "authentication" "fail" "id"
11537 .vindex "&$authenticated_fail_id$&"
11538 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11539 will contain the failed authentication id. If more than one authentication
11540 id is attempted, it will contain only the last one. The variable is
11541 available for processing in the ACL's, generally the quit or notquit ACL.
11542 A message to a local recipient could still be accepted without requiring
11543 authentication, which means this variable could also be visible in all of
11544 the ACL's as well.
11545
11546
11547 .vitem &$authenticated_sender$&
11548 .cindex "sender" "authenticated"
11549 .cindex "authentication" "sender"
11550 .cindex "AUTH" "on MAIL command"
11551 .vindex "&$authenticated_sender$&"
11552 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11553 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11554 described in section &<<SECTauthparamail>>&. Unless the data is the string
11555 &"<>"&, it is set as the authenticated sender of the message, and the value is
11556 available during delivery in the &$authenticated_sender$& variable. If the
11557 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11558
11559 .vindex "&$qualify_domain$&"
11560 When a message is submitted locally (that is, not over a TCP connection), the
11561 value of &$authenticated_sender$& is an address constructed from the login
11562 name of the calling process and &$qualify_domain$&, except that a trusted user
11563 can override this by means of the &%-oMas%& command line option.
11564
11565
11566 .vitem &$authentication_failed$&
11567 .cindex "authentication" "failure"
11568 .vindex "&$authentication_failed$&"
11569 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11570 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11571 possible to distinguish between &"did not try to authenticate"&
11572 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11573 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11574 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11575 negative response to an AUTH command, including (for example) an attempt to use
11576 an undefined mechanism.
11577
11578 .vitem &$av_failed$&
11579 .cindex "content scanning" "AV scanner failure"
11580 This variable is available when Exim is compiled with the content-scanning
11581 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11582 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11583 the ACL malware condition.
11584
11585 .vitem &$body_linecount$&
11586 .cindex "message body" "line count"
11587 .cindex "body of message" "line count"
11588 .vindex "&$body_linecount$&"
11589 When a message is being received or delivered, this variable contains the
11590 number of lines in the message's body. See also &$message_linecount$&.
11591
11592 .vitem &$body_zerocount$&
11593 .cindex "message body" "binary zero count"
11594 .cindex "body of message" "binary zero count"
11595 .cindex "binary zero" "in message body"
11596 .vindex "&$body_zerocount$&"
11597 When a message is being received or delivered, this variable contains the
11598 number of binary zero bytes (ASCII NULs) in the message's body.
11599
11600 .vitem &$bounce_recipient$&
11601 .vindex "&$bounce_recipient$&"
11602 This is set to the recipient address of a bounce message while Exim is creating
11603 it. It is useful if a customized bounce message text file is in use (see
11604 chapter &<<CHAPemsgcust>>&).
11605
11606 .vitem &$bounce_return_size_limit$&
11607 .vindex "&$bounce_return_size_limit$&"
11608 This contains the value set in the &%bounce_return_size_limit%& option, rounded
11609 up to a multiple of 1000. It is useful when a customized error message text
11610 file is in use (see chapter &<<CHAPemsgcust>>&).
11611
11612 .vitem &$caller_gid$&
11613 .cindex "gid (group id)" "caller"
11614 .vindex "&$caller_gid$&"
11615 The real group id under which the process that called Exim was running. This is
11616 not the same as the group id of the originator of a message (see
11617 &$originator_gid$&). If Exim re-execs itself, this variable in the new
11618 incarnation normally contains the Exim gid.
11619
11620 .vitem &$caller_uid$&
11621 .cindex "uid (user id)" "caller"
11622 .vindex "&$caller_uid$&"
11623 The real user id under which the process that called Exim was running. This is
11624 not the same as the user id of the originator of a message (see
11625 &$originator_uid$&). If Exim re-execs itself, this variable in the new
11626 incarnation normally contains the Exim uid.
11627
11628 .vitem &$callout_address$&
11629 .vindex "&$callout_address$&"
11630 After a callout for verification, spamd or malware daemon service, the
11631 address that was connected to.
11632
11633 .vitem &$compile_number$&
11634 .vindex "&$compile_number$&"
11635 The building process for Exim keeps a count of the number
11636 of times it has been compiled. This serves to distinguish different
11637 compilations of the same version of the program.
11638
11639 .vitem &$config_dir$&
11640 .vindex "&$config_dir$&"
11641 The directory name of the main configuration file. That is, the content of
11642 &$config_file$& with the last component stripped. The value does not
11643 contain the trailing slash. If &$config_file$& does not contain a slash,
11644 &$config_dir$& is ".".
11645
11646 .vitem &$config_file$&
11647 .vindex "&$config_file$&"
11648 The name of the main configuration file Exim is using.
11649
11650 .vitem &$dkim_cur_signer$& &&&
11651        &$dkim_verify_status$& &&&
11652        &$dkim_verify_reason$& &&&
11653        &$dkim_domain$& &&&
11654        &$dkim_identity$& &&&
11655        &$dkim_selector$& &&&
11656        &$dkim_algo$& &&&
11657        &$dkim_canon_body$& &&&
11658        &$dkim_canon_headers$& &&&
11659        &$dkim_copiedheaders$& &&&
11660        &$dkim_bodylength$& &&&
11661        &$dkim_created$& &&&
11662        &$dkim_expires$& &&&
11663        &$dkim_headernames$& &&&
11664        &$dkim_key_testing$& &&&
11665        &$dkim_key_nosubdomains$& &&&
11666        &$dkim_key_srvtype$& &&&
11667        &$dkim_key_granularity$& &&&
11668        &$dkim_key_notes$& &&&
11669        &$dkim_key_length$&
11670 These variables are only available within the DKIM ACL.
11671 For details see chapter &<<CHAPdkim>>&.
11672
11673 .vitem &$dkim_signers$&
11674 .vindex &$dkim_signers$&
11675 When a message has been received this variable contains
11676 a colon-separated list of signer domains and identities for the message.
11677 For details see chapter &<<CHAPdkim>>&.
11678
11679 .vitem &$dnslist_domain$& &&&
11680        &$dnslist_matched$& &&&
11681        &$dnslist_text$& &&&
11682        &$dnslist_value$&
11683 .vindex "&$dnslist_domain$&"
11684 .vindex "&$dnslist_matched$&"
11685 .vindex "&$dnslist_text$&"
11686 .vindex "&$dnslist_value$&"
11687 .cindex "black list (DNS)"
11688 When a DNS (black) list lookup succeeds, these variables are set to contain
11689 the following data from the lookup: the list's domain name, the key that was
11690 looked up, the contents of any associated TXT record, and the value from the
11691 main A record. See section &<<SECID204>>& for more details.
11692
11693 .vitem &$domain$&
11694 .vindex "&$domain$&"
11695 When an address is being routed, or delivered on its own, this variable
11696 contains the domain. Uppercase letters in the domain are converted into lower
11697 case for &$domain$&.
11698
11699 Global address rewriting happens when a message is received, so the value of
11700 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
11701 is set during user filtering, but not during system filtering, because a
11702 message may have many recipients and the system filter is called just once.
11703
11704 When more than one address is being delivered at once (for example, several
11705 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
11706 have the same domain. Transports can be restricted to handling only one domain
11707 at a time if the value of &$domain$& is required at transport time &-- this is
11708 the default for local transports. For further details of the environment in
11709 which local transports are run, see chapter &<<CHAPenvironment>>&.
11710
11711 .oindex "&%delay_warning_condition%&"
11712 At the end of a delivery, if all deferred addresses have the same domain, it is
11713 set in &$domain$& during the expansion of &%delay_warning_condition%&.
11714
11715 The &$domain$& variable is also used in some other circumstances:
11716
11717 .ilist
11718 When an ACL is running for a RCPT command, &$domain$& contains the domain of
11719 the recipient address. The domain of the &'sender'& address is in
11720 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
11721 normally set during the running of the MAIL ACL. However, if the sender address
11722 is verified with a callout during the MAIL ACL, the sender domain is placed in
11723 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
11724 the &(smtp)& transport.
11725
11726 .next
11727 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11728 &$domain$& contains the domain portion of the address that is being rewritten;
11729 it can be used in the expansion of the replacement address, for example, to
11730 rewrite domains by file lookup.
11731
11732 .next
11733 With one important exception, whenever a domain list is being scanned,
11734 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
11735 a &%sender_domains%& condition in an ACL is being processed, the subject domain
11736 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
11737 that, in a RCPT ACL, the sender domain list can be dependent on the
11738 recipient domain (which is what is in &$domain$& at this time).
11739
11740 .next
11741 .cindex "ETRN" "value of &$domain$&"
11742 .oindex "&%smtp_etrn_command%&"
11743 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
11744 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
11745 .endlist
11746
11747
11748 .vitem &$domain_data$&
11749 .vindex "&$domain_data$&"
11750 When the &%domains%& option on a router matches a domain by
11751 means of a lookup, the data read by the lookup is available during the running
11752 of the router as &$domain_data$&. In addition, if the driver routes the
11753 address to a transport, the value is available in that transport. If the
11754 transport is handling multiple addresses, the value from the first address is
11755 used.
11756
11757 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
11758 domain by means of a lookup. The data read by the lookup is available during
11759 the rest of the ACL statement. In all other situations, this variable expands
11760 to nothing.
11761
11762 .vitem &$exim_gid$&
11763 .vindex "&$exim_gid$&"
11764 This variable contains the numerical value of the Exim group id.
11765
11766 .vitem &$exim_path$&
11767 .vindex "&$exim_path$&"
11768 This variable contains the path to the Exim binary.
11769
11770 .vitem &$exim_uid$&
11771 .vindex "&$exim_uid$&"
11772 This variable contains the numerical value of the Exim user id.
11773
11774 .vitem &$exim_version$&
11775 .vindex "&$exim_version$&"
11776 This variable contains the version string of the Exim build.
11777 The first character is a major version number, currently 4.
11778 Then after a dot, the next group of digits is a minor version number.
11779 There may be other characters following the minor version.
11780
11781 .vitem &$header_$&<&'name'&>
11782 This is not strictly an expansion variable. It is expansion syntax for
11783 inserting the message header line with the given name. Note that the name must
11784 be terminated by colon or white space, because it may contain a wide variety of
11785 characters. Note also that braces must &'not'& be used.
11786
11787 .vitem &$headers_added$&
11788 .vindex "&$headers_added$&"
11789 Within an ACL this variable contains the headers added so far by
11790 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
11791 The headers are a newline-separated list.
11792
11793 .vitem &$home$&
11794 .vindex "&$home$&"
11795 When the &%check_local_user%& option is set for a router, the user's home
11796 directory is placed in &$home$& when the check succeeds. In particular, this
11797 means it is set during the running of users' filter files. A router may also
11798 explicitly set a home directory for use by a transport; this can be overridden
11799 by a setting on the transport itself.
11800
11801 When running a filter test via the &%-bf%& option, &$home$& is set to the value
11802 of the environment variable HOME, which is subject to the
11803 &%keep_environment%& and &%add_environment%& main config options.
11804
11805 .vitem &$host$&
11806 .vindex "&$host$&"
11807 If a router assigns an address to a transport (any transport), and passes a
11808 list of hosts with the address, the value of &$host$& when the transport starts
11809 to run is the name of the first host on the list. Note that this applies both
11810 to local and remote transports.
11811
11812 .cindex "transport" "filter"
11813 .cindex "filter" "transport filter"
11814 For the &(smtp)& transport, if there is more than one host, the value of
11815 &$host$& changes as the transport works its way through the list. In
11816 particular, when the &(smtp)& transport is expanding its options for encryption
11817 using TLS, or for specifying a transport filter (see chapter
11818 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
11819 is connected.
11820
11821 When used in the client part of an authenticator configuration (see chapter
11822 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
11823 client is connected.
11824
11825
11826 .vitem &$host_address$&
11827 .vindex "&$host_address$&"
11828 This variable is set to the remote host's IP address whenever &$host$& is set
11829 for a remote connection. It is also set to the IP address that is being checked
11830 when the &%ignore_target_hosts%& option is being processed.
11831
11832 .vitem &$host_data$&
11833 .vindex "&$host_data$&"
11834 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
11835 result of the lookup is made available in the &$host_data$& variable. This
11836 allows you, for example, to do things like this:
11837 .code
11838 deny  hosts = net-lsearch;/some/file
11839 message = $host_data
11840 .endd
11841 .vitem &$host_lookup_deferred$&
11842 .cindex "host name" "lookup, failure of"
11843 .vindex "&$host_lookup_deferred$&"
11844 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
11845 message comes from a remote host and there is an attempt to look up the host's
11846 name from its IP address, and the attempt is not successful, one of these
11847 variables is set to &"1"&.
11848
11849 .ilist
11850 If the lookup receives a definite negative response (for example, a DNS lookup
11851 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
11852
11853 .next
11854 If there is any kind of problem during the lookup, such that Exim cannot
11855 tell whether or not the host name is defined (for example, a timeout for a DNS
11856 lookup), &$host_lookup_deferred$& is set to &"1"&.
11857 .endlist ilist
11858
11859 Looking up a host's name from its IP address consists of more than just a
11860 single reverse lookup. Exim checks that a forward lookup of at least one of the
11861 names it receives from a reverse lookup yields the original IP address. If this
11862 is not the case, Exim does not accept the looked up name(s), and
11863 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
11864 IP address (for example, the existence of a PTR record in the DNS) is not
11865 sufficient on its own for the success of a host name lookup. If the reverse
11866 lookup succeeds, but there is a lookup problem such as a timeout when checking
11867 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
11868 &"1"&. See also &$sender_host_name$&.
11869
11870 .vitem &$host_lookup_failed$&
11871 .vindex "&$host_lookup_failed$&"
11872 See &$host_lookup_deferred$&.
11873
11874 .vitem &$host_port$&
11875 .vindex "&$host_port$&"
11876 This variable is set to the remote host's TCP port whenever &$host$& is set
11877 for an outbound connection.
11878
11879 .vitem &$initial_cwd$&
11880 .vindex "&$initial_cwd$&
11881 This variable contains the full path name of the initial working
11882 directory of the current Exim process. This may differ from the current
11883 working directory, as Exim changes this to "/" during early startup, and
11884 to &$spool_directory$& later.
11885
11886 .vitem &$inode$&
11887 .vindex "&$inode$&"
11888 The only time this variable is set is while expanding the &%directory_file%&
11889 option in the &(appendfile)& transport. The variable contains the inode number
11890 of the temporary file which is about to be renamed. It can be used to construct
11891 a unique name for the file.
11892
11893 .vitem &$interface_address$&
11894 .vindex "&$interface_address$&"
11895 This is an obsolete name for &$received_ip_address$&.
11896
11897 .vitem &$interface_port$&
11898 .vindex "&$interface_port$&"
11899 This is an obsolete name for &$received_port$&.
11900
11901 .vitem &$item$&
11902 .vindex "&$item$&"
11903 This variable is used during the expansion of &*forall*& and &*forany*&
11904 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
11905 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
11906 empty.
11907
11908 .vitem &$ldap_dn$&
11909 .vindex "&$ldap_dn$&"
11910 This variable, which is available only when Exim is compiled with LDAP support,
11911 contains the DN from the last entry in the most recently successful LDAP
11912 lookup.
11913
11914 .vitem &$load_average$&
11915 .vindex "&$load_average$&"
11916 This variable contains the system load average, multiplied by 1000 so that it
11917 is an integer. For example, if the load average is 0.21, the value of the
11918 variable is 210. The value is recomputed every time the variable is referenced.
11919
11920 .vitem &$local_part$&
11921 .vindex "&$local_part$&"
11922 When an address is being routed, or delivered on its own, this
11923 variable contains the local part. When a number of addresses are being
11924 delivered together (for example, multiple RCPT commands in an SMTP
11925 session), &$local_part$& is not set.
11926
11927 Global address rewriting happens when a message is received, so the value of
11928 &$local_part$& during routing and delivery is the value after rewriting.
11929 &$local_part$& is set during user filtering, but not during system filtering,
11930 because a message may have many recipients and the system filter is called just
11931 once.
11932
11933 .vindex "&$local_part_prefix$&"
11934 .vindex "&$local_part_suffix$&"
11935 If a local part prefix or suffix has been recognized, it is not included in the
11936 value of &$local_part$& during routing and subsequent delivery. The values of
11937 any prefix or suffix are in &$local_part_prefix$& and
11938 &$local_part_suffix$&, respectively.
11939
11940 When a message is being delivered to a file, pipe, or autoreply transport as a
11941 result of aliasing or forwarding, &$local_part$& is set to the local part of
11942 the parent address, not to the file name or command (see &$address_file$& and
11943 &$address_pipe$&).
11944
11945 When an ACL is running for a RCPT command, &$local_part$& contains the
11946 local part of the recipient address.
11947
11948 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
11949 &$local_part$& contains the local part of the address that is being rewritten;
11950 it can be used in the expansion of the replacement address, for example.
11951
11952 In all cases, all quoting is removed from the local part. For example, for both
11953 the addresses
11954 .code
11955 "abc:xyz"@test.example
11956 abc\:xyz@test.example
11957 .endd
11958 the value of &$local_part$& is
11959 .code
11960 abc:xyz
11961 .endd
11962 If you use &$local_part$& to create another address, you should always wrap it
11963 inside a quoting operator. For example, in a &(redirect)& router you could
11964 have:
11965 .code
11966 data = ${quote_local_part:$local_part}@new.domain.example
11967 .endd
11968 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
11969 to process local parts in a case-dependent manner in a router, you can set the
11970 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
11971
11972 .vitem &$local_part_data$&
11973 .vindex "&$local_part_data$&"
11974 When the &%local_parts%& option on a router matches a local part by means of a
11975 lookup, the data read by the lookup is available during the running of the
11976 router as &$local_part_data$&. In addition, if the driver routes the address
11977 to a transport, the value is available in that transport. If the transport is
11978 handling multiple addresses, the value from the first address is used.
11979
11980 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
11981 matches a local part by means of a lookup. The data read by the lookup is
11982 available during the rest of the ACL statement. In all other situations, this
11983 variable expands to nothing.
11984
11985 .vitem &$local_part_prefix$&
11986 .vindex "&$local_part_prefix$&"
11987 When an address is being routed or delivered, and a
11988 specific prefix for the local part was recognized, it is available in this
11989 variable, having been removed from &$local_part$&.
11990
11991 .vitem &$local_part_suffix$&
11992 .vindex "&$local_part_suffix$&"
11993 When an address is being routed or delivered, and a
11994 specific suffix for the local part was recognized, it is available in this
11995 variable, having been removed from &$local_part$&.
11996
11997 .vitem &$local_scan_data$&
11998 .vindex "&$local_scan_data$&"
11999 This variable contains the text returned by the &[local_scan()]& function when
12000 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12001
12002 .vitem &$local_user_gid$&
12003 .vindex "&$local_user_gid$&"
12004 See &$local_user_uid$&.
12005
12006 .vitem &$local_user_uid$&
12007 .vindex "&$local_user_uid$&"
12008 This variable and &$local_user_gid$& are set to the uid and gid after the
12009 &%check_local_user%& router precondition succeeds. This means that their values
12010 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12011 and &%condition%&), for the &%address_data%& expansion, and for any
12012 router-specific expansions. At all other times, the values in these variables
12013 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12014
12015 .vitem &$localhost_number$&
12016 .vindex "&$localhost_number$&"
12017 This contains the expanded value of the
12018 &%localhost_number%& option. The expansion happens after the main options have
12019 been read.
12020
12021 .vitem &$log_inodes$&
12022 .vindex "&$log_inodes$&"
12023 The number of free inodes in the disk partition where Exim's
12024 log files are being written. The value is recalculated whenever the variable is
12025 referenced. If the relevant file system does not have the concept of inodes,
12026 the value of is -1. See also the &%check_log_inodes%& option.
12027
12028 .vitem &$log_space$&
12029 .vindex "&$log_space$&"
12030 The amount of free space (as a number of kilobytes) in the disk
12031 partition where Exim's log files are being written. The value is recalculated
12032 whenever the variable is referenced. If the operating system does not have the
12033 ability to find the amount of free space (only true for experimental systems),
12034 the space value is -1. See also the &%check_log_space%& option.
12035
12036
12037 .vitem &$lookup_dnssec_authenticated$&
12038 .vindex "&$lookup_dnssec_authenticated$&"
12039 This variable is set after a DNS lookup done by
12040 a dnsdb lookup expansion, dnslookup router or smtp transport.
12041 .cindex "DNS" "DNSSEC"
12042 It will be empty if &(DNSSEC)& was not requested,
12043 &"no"& if the result was not labelled as authenticated data
12044 and &"yes"& if it was.
12045 Results that are labelled as authoritative answer that match
12046 the &%dns_trust_aa%& configuration variable count also
12047 as authenticated data.
12048
12049 .vitem &$mailstore_basename$&
12050 .vindex "&$mailstore_basename$&"
12051 This variable is set only when doing deliveries in &"mailstore"& format in the
12052 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12053 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12054 contains the basename of the files that are being written, that is, the name
12055 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12056 variable is empty.
12057
12058 .vitem &$malware_name$&
12059 .vindex "&$malware_name$&"
12060 This variable is available when Exim is compiled with the
12061 content-scanning extension. It is set to the name of the virus that was found
12062 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12063
12064 .vitem &$max_received_linelength$&
12065 .vindex "&$max_received_linelength$&"
12066 .cindex "maximum" "line length"
12067 .cindex "line length" "maximum"
12068 This variable contains the number of bytes in the longest line that was
12069 received as part of the message, not counting the line termination
12070 character(s).
12071 .new
12072 It is not valid if the &%spool_files_wireformat%& option is used.
12073 .wen
12074
12075 .vitem &$message_age$&
12076 .cindex "message" "age of"
12077 .vindex "&$message_age$&"
12078 This variable is set at the start of a delivery attempt to contain the number
12079 of seconds since the message was received. It does not change during a single
12080 delivery attempt.
12081
12082 .vitem &$message_body$&
12083 .cindex "body of message" "expansion variable"
12084 .cindex "message body" "in expansion"
12085 .cindex "binary zero" "in message body"
12086 .vindex "&$message_body$&"
12087 .oindex "&%message_body_visible%&"
12088 This variable contains the initial portion of a message's body while it is
12089 being delivered, and is intended mainly for use in filter files. The maximum
12090 number of characters of the body that are put into the variable is set by the
12091 &%message_body_visible%& configuration option; the default is 500.
12092
12093 .oindex "&%message_body_newlines%&"
12094 By default, newlines are converted into spaces in &$message_body$&, to make it
12095 easier to search for phrases that might be split over a line break. However,
12096 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12097 zeros are always converted into spaces.
12098
12099 .vitem &$message_body_end$&
12100 .cindex "body of message" "expansion variable"
12101 .cindex "message body" "in expansion"
12102 .vindex "&$message_body_end$&"
12103 This variable contains the final portion of a message's
12104 body while it is being delivered. The format and maximum size are as for
12105 &$message_body$&.
12106
12107 .vitem &$message_body_size$&
12108 .cindex "body of message" "size"
12109 .cindex "message body" "size"
12110 .vindex "&$message_body_size$&"
12111 When a message is being delivered, this variable contains the size of the body
12112 in bytes. The count starts from the character after the blank line that
12113 separates the body from the header. Newlines are included in the count. See
12114 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12115
12116 .new
12117 If the spool file is wireformat
12118 (see the &%spool_files_wireformat%& main option)
12119 the CRLF line-terminators are included in the count.
12120 .wen
12121
12122 .vitem &$message_exim_id$&
12123 .vindex "&$message_exim_id$&"
12124 When a message is being received or delivered, this variable contains the
12125 unique message id that is generated and used by Exim to identify the message.
12126 An id is not created for a message until after its header has been successfully
12127 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12128 line; it is the local id that Exim assigns to the message, for example:
12129 &`1BXTIK-0001yO-VA`&.
12130
12131 .vitem &$message_headers$&
12132 .vindex &$message_headers$&
12133 This variable contains a concatenation of all the header lines when a message
12134 is being processed, except for lines added by routers or transports. The header
12135 lines are separated by newline characters. Their contents are decoded in the
12136 same way as a header line that is inserted by &%bheader%&.
12137
12138 .vitem &$message_headers_raw$&
12139 .vindex &$message_headers_raw$&
12140 This variable is like &$message_headers$& except that no processing of the
12141 contents of header lines is done.
12142
12143 .vitem &$message_id$&
12144 This is an old name for &$message_exim_id$&. It is now deprecated.
12145
12146 .vitem &$message_linecount$&
12147 .vindex "&$message_linecount$&"
12148 This variable contains the total number of lines in the header and body of the
12149 message. Compare &$body_linecount$&, which is the count for the body only.
12150 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12151 number of lines received. Before delivery happens (that is, before filters,
12152 routers, and transports run) the count is increased to include the
12153 &'Received:'& header line that Exim standardly adds, and also any other header
12154 lines that are added by ACLs. The blank line that separates the message header
12155 from the body is not counted.
12156
12157 As with the special case of &$message_size$&, during the expansion of the
12158 appendfile transport's maildir_tag option in maildir format, the value of
12159 &$message_linecount$& is the precise size of the number of newlines in the
12160 file that has been written (minus one for the blank line between the
12161 header and the body).
12162
12163 Here is an example of the use of this variable in a DATA ACL:
12164 .code
12165 deny message   = Too many lines in message header
12166      condition = \
12167       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12168 .endd
12169 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12170 message has not yet been received.
12171
12172 .new
12173 This variable is not valid if the &%spool_files_wireformat%& option is used.
12174 .wen
12175
12176 .vitem &$message_size$&
12177 .cindex "size" "of message"
12178 .cindex "message" "size"
12179 .vindex "&$message_size$&"
12180 When a message is being processed, this variable contains its size in bytes. In
12181 most cases, the size includes those headers that were received with the
12182 message, but not those (such as &'Envelope-to:'&) that are added to individual
12183 deliveries as they are written. However, there is one special case: during the
12184 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12185 doing a delivery in maildir format, the value of &$message_size$& is the
12186 precise size of the file that has been written. See also
12187 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12188
12189 .cindex "RCPT" "value of &$message_size$&"
12190 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12191 contains the size supplied on the MAIL command, or -1 if no size was given. The
12192 value may not, of course, be truthful.
12193
12194 .vitem &$mime_$&&'xxx'&
12195 A number of variables whose names start with &$mime$& are
12196 available when Exim is compiled with the content-scanning extension. For
12197 details, see section &<<SECTscanmimepart>>&.
12198
12199 .vitem "&$n0$& &-- &$n9$&"
12200 These variables are counters that can be incremented by means
12201 of the &%add%& command in filter files.
12202
12203 .vitem &$original_domain$&
12204 .vindex "&$domain$&"
12205 .vindex "&$original_domain$&"
12206 When a top-level address is being processed for delivery, this contains the
12207 same value as &$domain$&. However, if a &"child"& address (for example,
12208 generated by an alias, forward, or filter file) is being processed, this
12209 variable contains the domain of the original address (lower cased). This
12210 differs from &$parent_domain$& only when there is more than one level of
12211 aliasing or forwarding. When more than one address is being delivered in a
12212 single transport run, &$original_domain$& is not set.
12213
12214 If a new address is created by means of a &%deliver%& command in a system
12215 filter, it is set up with an artificial &"parent"& address. This has the local
12216 part &'system-filter'& and the default qualify domain.
12217
12218 .vitem &$original_local_part$&
12219 .vindex "&$local_part$&"
12220 .vindex "&$original_local_part$&"
12221 When a top-level address is being processed for delivery, this contains the
12222 same value as &$local_part$&, unless a prefix or suffix was removed from the
12223 local part, because &$original_local_part$& always contains the full local
12224 part. When a &"child"& address (for example, generated by an alias, forward, or
12225 filter file) is being processed, this variable contains the full local part of
12226 the original address.
12227
12228 If the router that did the redirection processed the local part
12229 case-insensitively, the value in &$original_local_part$& is in lower case.
12230 This variable differs from &$parent_local_part$& only when there is more than
12231 one level of aliasing or forwarding. When more than one address is being
12232 delivered in a single transport run, &$original_local_part$& is not set.
12233
12234 If a new address is created by means of a &%deliver%& command in a system
12235 filter, it is set up with an artificial &"parent"& address. This has the local
12236 part &'system-filter'& and the default qualify domain.
12237
12238 .vitem &$originator_gid$&
12239 .cindex "gid (group id)" "of originating user"
12240 .cindex "sender" "gid"
12241 .vindex "&$caller_gid$&"
12242 .vindex "&$originator_gid$&"
12243 This variable contains the value of &$caller_gid$& that was set when the
12244 message was received. For messages received via the command line, this is the
12245 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12246 normally the gid of the Exim user.
12247
12248 .vitem &$originator_uid$&
12249 .cindex "uid (user id)" "of originating user"
12250 .cindex "sender" "uid"
12251 .vindex "&$caller_uid$&"
12252 .vindex "&$originator_uid$&"
12253 The value of &$caller_uid$& that was set when the message was received. For
12254 messages received via the command line, this is the uid of the sending user.
12255 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12256 user.
12257
12258 .vitem &$parent_domain$&
12259 .vindex "&$parent_domain$&"
12260 This variable is similar to &$original_domain$& (see
12261 above), except that it refers to the immediately preceding parent address.
12262
12263 .vitem &$parent_local_part$&
12264 .vindex "&$parent_local_part$&"
12265 This variable is similar to &$original_local_part$&
12266 (see above), except that it refers to the immediately preceding parent address.
12267
12268 .vitem &$pid$&
12269 .cindex "pid (process id)" "of current process"
12270 .vindex "&$pid$&"
12271 This variable contains the current process id.
12272
12273 .vitem &$pipe_addresses$&
12274 .cindex "filter" "transport filter"
12275 .cindex "transport" "filter"
12276 .vindex "&$pipe_addresses$&"
12277 This is not an expansion variable, but is mentioned here because the string
12278 &`$pipe_addresses`& is handled specially in the command specification for the
12279 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12280 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12281 It cannot be used in general expansion strings, and provokes an &"unknown
12282 variable"& error if encountered.
12283
12284 .vitem &$primary_hostname$&
12285 .vindex "&$primary_hostname$&"
12286 This variable contains the value set by &%primary_hostname%& in the
12287 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12288 a single-component name, Exim calls &[gethostbyname()]& (or
12289 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12290 qualified host name. See also &$smtp_active_hostname$&.
12291
12292
12293 .vitem &$proxy_external_address$& &&&
12294        &$proxy_external_port$& &&&
12295        &$proxy_local_address$& &&&
12296        &$proxy_local_port$& &&&
12297        &$proxy_session$&
12298 These variables are only available when built with Proxy Protocol
12299 or SOCKS5 support.
12300 For details see chapter &<<SECTproxyInbound>>&.
12301
12302 .vitem &$prdr_requested$&
12303 .cindex "PRDR" "variable for"
12304 This variable is set to &"yes"& if PRDR was requested by the client for the
12305 current message, otherwise &"no"&.
12306
12307 .vitem &$prvscheck_address$&
12308 This variable is used in conjunction with the &%prvscheck%& expansion item,
12309 which is described in sections &<<SECTexpansionitems>>& and
12310 &<<SECTverifyPRVS>>&.
12311
12312 .vitem &$prvscheck_keynum$&
12313 This variable is used in conjunction with the &%prvscheck%& expansion item,
12314 which is described in sections &<<SECTexpansionitems>>& and
12315 &<<SECTverifyPRVS>>&.
12316
12317 .vitem &$prvscheck_result$&
12318 This variable is used in conjunction with the &%prvscheck%& expansion item,
12319 which is described in sections &<<SECTexpansionitems>>& and
12320 &<<SECTverifyPRVS>>&.
12321
12322 .vitem &$qualify_domain$&
12323 .vindex "&$qualify_domain$&"
12324 The value set for the &%qualify_domain%& option in the configuration file.
12325
12326 .vitem &$qualify_recipient$&
12327 .vindex "&$qualify_recipient$&"
12328 The value set for the &%qualify_recipient%& option in the configuration file,
12329 or if not set, the value of &$qualify_domain$&.
12330
12331 .vitem &$queue_name$&
12332 .vindex &$queue_name$&
12333 .cindex "named queues"
12334 .cindex queues named
12335 The name of the spool queue in use; empty for the default queue.
12336
12337 .vitem &$rcpt_count$&
12338 .vindex "&$rcpt_count$&"
12339 When a message is being received by SMTP, this variable contains the number of
12340 RCPT commands received for the current message. If this variable is used in a
12341 RCPT ACL, its value includes the current command.
12342
12343 .vitem &$rcpt_defer_count$&
12344 .vindex "&$rcpt_defer_count$&"
12345 .cindex "4&'xx'& responses" "count of"
12346 When a message is being received by SMTP, this variable contains the number of
12347 RCPT commands in the current message that have previously been rejected with a
12348 temporary (4&'xx'&) response.
12349
12350 .vitem &$rcpt_fail_count$&
12351 .vindex "&$rcpt_fail_count$&"
12352 When a message is being received by SMTP, this variable contains the number of
12353 RCPT commands in the current message that have previously been rejected with a
12354 permanent (5&'xx'&) response.
12355
12356 .vitem &$received_count$&
12357 .vindex "&$received_count$&"
12358 This variable contains the number of &'Received:'& header lines in the message,
12359 including the one added by Exim (so its value is always greater than zero). It
12360 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12361 delivering.
12362
12363 .vitem &$received_for$&
12364 .vindex "&$received_for$&"
12365 If there is only a single recipient address in an incoming message, this
12366 variable contains that address when the &'Received:'& header line is being
12367 built. The value is copied after recipient rewriting has happened, but before
12368 the &[local_scan()]& function is run.
12369
12370 .vitem &$received_ip_address$&
12371 .vindex "&$received_ip_address$&"
12372 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12373 variable is set to the address of the local IP interface, and &$received_port$&
12374 is set to the local port number. (The remote IP address and port are in
12375 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12376 the port value is -1 unless it has been set using the &%-oMi%& command line
12377 option.
12378
12379 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12380 could be used, for example, to make the file name for a TLS certificate depend
12381 on which interface and/or port is being used for the incoming connection. The
12382 values of &$received_ip_address$& and &$received_port$& are saved with any
12383 messages that are received, thus making these variables available at delivery
12384 time.
12385 For outbound connections see &$sending_ip_address$&.
12386
12387 .vitem &$received_port$&
12388 .vindex "&$received_port$&"
12389 See &$received_ip_address$&.
12390
12391 .vitem &$received_protocol$&
12392 .vindex "&$received_protocol$&"
12393 When a message is being processed, this variable contains the name of the
12394 protocol by which it was received. Most of the names used by Exim are defined
12395 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12396 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12397 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12398 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12399 connection and the client was successfully authenticated.
12400
12401 Exim uses the protocol name &"smtps"& for the case when encryption is
12402 automatically set up on connection without the use of STARTTLS (see
12403 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12404 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12405 where the client initially uses EHLO, sets up an encrypted connection using
12406 STARTTLS, and then uses HELO afterwards.
12407
12408 The &%-oMr%& option provides a way of specifying a custom protocol name for
12409 messages that are injected locally by trusted callers. This is commonly used to
12410 identify messages that are being re-injected after some kind of scanning.
12411
12412 .vitem &$received_time$&
12413 .vindex "&$received_time$&"
12414 This variable contains the date and time when the current message was received,
12415 as a number of seconds since the start of the Unix epoch.
12416
12417 .vitem &$recipient_data$&
12418 .vindex "&$recipient_data$&"
12419 This variable is set after an indexing lookup success in an ACL &%recipients%&
12420 condition. It contains the data from the lookup, and the value remains set
12421 until the next &%recipients%& test. Thus, you can do things like this:
12422 .display
12423 &`require recipients  = cdb*@;/some/file`&
12424 &`deny    `&&'some further test involving'& &`$recipient_data`&
12425 .endd
12426 &*Warning*&: This variable is set only when a lookup is used as an indexing
12427 method in the address list, using the semicolon syntax as in the example above.
12428 The variable is not set for a lookup that is used as part of the string
12429 expansion that all such lists undergo before being interpreted.
12430
12431 .vitem &$recipient_verify_failure$&
12432 .vindex "&$recipient_verify_failure$&"
12433 In an ACL, when a recipient verification fails, this variable contains
12434 information about the failure. It is set to one of the following words:
12435
12436 .ilist
12437 &"qualify"&: The address was unqualified (no domain), and the message
12438 was neither local nor came from an exempted host.
12439
12440 .next
12441 &"route"&: Routing failed.
12442
12443 .next
12444 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12445 or before the MAIL command (that is, on initial connection, HELO, or
12446 MAIL).
12447
12448 .next
12449 &"recipient"&: The RCPT command in a callout was rejected.
12450 .next
12451
12452 &"postmaster"&: The postmaster check in a callout was rejected.
12453 .endlist
12454
12455 The main use of this variable is expected to be to distinguish between
12456 rejections of MAIL and rejections of RCPT.
12457
12458 .vitem &$recipients$&
12459 .vindex "&$recipients$&"
12460 This variable contains a list of envelope recipients for a message. A comma and
12461 a space separate the addresses in the replacement text. However, the variable
12462 is not generally available, to prevent exposure of Bcc recipients in
12463 unprivileged users' filter files. You can use &$recipients$& only in these
12464 cases:
12465
12466 .olist
12467 In a system filter file.
12468 .next
12469 In the ACLs associated with the DATA command and with non-SMTP messages, that
12470 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12471 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12472 &%acl_not_smtp_mime%&.
12473 .next
12474 From within a &[local_scan()]& function.
12475 .endlist
12476
12477
12478 .vitem &$recipients_count$&
12479 .vindex "&$recipients_count$&"
12480 When a message is being processed, this variable contains the number of
12481 envelope recipients that came with the message. Duplicates are not excluded
12482 from the count. While a message is being received over SMTP, the number
12483 increases for each accepted recipient. It can be referenced in an ACL.
12484
12485
12486 .vitem &$regex_match_string$&
12487 .vindex "&$regex_match_string$&"
12488 This variable is set to contain the matching regular expression after a
12489 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12490
12491 .vitem "&$regex1$&, &$regex2$&, etc"
12492 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12493 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12494 these variables contain the
12495 captured substrings identified by the regular expression.
12496
12497
12498 .vitem &$reply_address$&
12499 .vindex "&$reply_address$&"
12500 When a message is being processed, this variable contains the contents of the
12501 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12502 contents of the &'From:'& header line. Apart from the removal of leading
12503 white space, the value is not processed in any way. In particular, no RFC 2047
12504 decoding or character code translation takes place.
12505
12506 .vitem &$return_path$&
12507 .vindex "&$return_path$&"
12508 When a message is being delivered, this variable contains the return path &--
12509 the sender field that will be sent as part of the envelope. It is not enclosed
12510 in <> characters. At the start of routing an address, &$return_path$& has the
12511 same value as &$sender_address$&, but if, for example, an incoming message to a
12512 mailing list has been expanded by a router which specifies a different address
12513 for bounce messages, &$return_path$& subsequently contains the new bounce
12514 address, whereas &$sender_address$& always contains the original sender address
12515 that was received with the message. In other words, &$sender_address$& contains
12516 the incoming envelope sender, and &$return_path$& contains the outgoing
12517 envelope sender.
12518
12519 .vitem &$return_size_limit$&
12520 .vindex "&$return_size_limit$&"
12521 This is an obsolete name for &$bounce_return_size_limit$&.
12522
12523 .vitem &$router_name$&
12524 .cindex "router" "name"
12525 .cindex "name" "of router"
12526 .vindex "&$router_name$&"
12527 During the running of a router this variable contains its name.
12528
12529 .vitem &$runrc$&
12530 .cindex "return code" "from &%run%& expansion"
12531 .vindex "&$runrc$&"
12532 This variable contains the return code from a command that is run by the
12533 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12534 assume the order in which option values are expanded, except for those
12535 preconditions whose order of testing is documented. Therefore, you cannot
12536 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12537 another.
12538
12539 .vitem &$self_hostname$&
12540 .oindex "&%self%&" "value of host name"
12541 .vindex "&$self_hostname$&"
12542 When an address is routed to a supposedly remote host that turns out to be the
12543 local host, what happens is controlled by the &%self%& generic router option.
12544 One of its values causes the address to be passed to another router. When this
12545 happens, &$self_hostname$& is set to the name of the local host that the
12546 original router encountered. In other circumstances its contents are null.
12547
12548 .vitem &$sender_address$&
12549 .vindex "&$sender_address$&"
12550 When a message is being processed, this variable contains the sender's address
12551 that was received in the message's envelope. The case of letters in the address
12552 is retained, in both the local part and the domain. For bounce messages, the
12553 value of this variable is the empty string. See also &$return_path$&.
12554
12555 .vitem &$sender_address_data$&
12556 .vindex "&$address_data$&"
12557 .vindex "&$sender_address_data$&"
12558 If &$address_data$& is set when the routers are called from an ACL to verify a
12559 sender address, the final value is preserved in &$sender_address_data$&, to
12560 distinguish it from data from a recipient address. The value does not persist
12561 after the end of the current ACL statement. If you want to preserve it for
12562 longer, you can save it in an ACL variable.
12563
12564 .vitem &$sender_address_domain$&
12565 .vindex "&$sender_address_domain$&"
12566 The domain portion of &$sender_address$&.
12567
12568 .vitem &$sender_address_local_part$&
12569 .vindex "&$sender_address_local_part$&"
12570 The local part portion of &$sender_address$&.
12571
12572 .vitem &$sender_data$&
12573 .vindex "&$sender_data$&"
12574 This variable is set after a lookup success in an ACL &%senders%& condition or
12575 in a router &%senders%& option. It contains the data from the lookup, and the
12576 value remains set until the next &%senders%& test. Thus, you can do things like
12577 this:
12578 .display
12579 &`require senders      = cdb*@;/some/file`&
12580 &`deny    `&&'some further test involving'& &`$sender_data`&
12581 .endd
12582 &*Warning*&: This variable is set only when a lookup is used as an indexing
12583 method in the address list, using the semicolon syntax as in the example above.
12584 The variable is not set for a lookup that is used as part of the string
12585 expansion that all such lists undergo before being interpreted.
12586
12587 .vitem &$sender_fullhost$&
12588 .vindex "&$sender_fullhost$&"
12589 When a message is received from a remote host, this variable contains the host
12590 name and IP address in a single string. It ends with the IP address in square
12591 brackets, followed by a colon and a port number if the logging of ports is
12592 enabled. The format of the rest of the string depends on whether the host
12593 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12594 looking up its IP address. (Looking up the IP address can be forced by the
12595 &%host_lookup%& option, independent of verification.) A plain host name at the
12596 start of the string is a verified host name; if this is not present,
12597 verification either failed or was not requested. A host name in parentheses is
12598 the argument of a HELO or EHLO command. This is omitted if it is identical to
12599 the verified host name or to the host's IP address in square brackets.
12600
12601 .vitem &$sender_helo_dnssec$&
12602 .vindex "&$sender_helo_dnssec$&"
12603 This boolean variable is true if a successful HELO verification was
12604 .cindex "DNS" "DNSSEC"
12605 done using DNS information the resolver library stated was authenticated data.
12606
12607 .vitem &$sender_helo_name$&
12608 .vindex "&$sender_helo_name$&"
12609 When a message is received from a remote host that has issued a HELO or EHLO
12610 command, the argument of that command is placed in this variable. It is also
12611 set if HELO or EHLO is used when a message is received using SMTP locally via
12612 the &%-bs%& or &%-bS%& options.
12613
12614 .vitem &$sender_host_address$&
12615 .vindex "&$sender_host_address$&"
12616 When a message is received from a remote host using SMTP,
12617 this variable contains that
12618 host's IP address. For locally non-SMTP submitted messages, it is empty.
12619
12620 .vitem &$sender_host_authenticated$&
12621 .vindex "&$sender_host_authenticated$&"
12622 This variable contains the name (not the public name) of the authenticator
12623 driver that successfully authenticated the client from which the message was
12624 received. It is empty if there was no successful authentication. See also
12625 &$authenticated_id$&.
12626
12627 .vitem &$sender_host_dnssec$&
12628 .vindex "&$sender_host_dnssec$&"
12629 If an attempt to populate &$sender_host_name$& has been made
12630 (by reference, &%hosts_lookup%& or
12631 otherwise) then this boolean will have been set true if, and only if, the
12632 resolver library states that both
12633 the reverse and forward DNS were authenticated data.  At all
12634 other times, this variable is false.
12635
12636 .cindex "DNS" "DNSSEC"
12637 It is likely that you will need to coerce DNSSEC support on in the resolver
12638 library, by setting:
12639 .code
12640 dns_dnssec_ok = 1
12641 .endd
12642
12643 Exim does not perform DNSSEC validation itself, instead leaving that to a
12644 validating resolver (e.g. unbound, or bind with suitable configuration).
12645
12646 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
12647 mechanism in the list, then this variable will be false.
12648
12649 This requires that your system resolver library support EDNS0 (and that
12650 DNSSEC flags exist in the system headers).  If the resolver silently drops
12651 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
12652 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
12653
12654
12655 .vitem &$sender_host_name$&
12656 .vindex "&$sender_host_name$&"
12657 When a message is received from a remote host, this variable contains the
12658 host's name as obtained by looking up its IP address. For messages received by
12659 other means, this variable is empty.
12660
12661 .vindex "&$host_lookup_failed$&"
12662 If the host name has not previously been looked up, a reference to
12663 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
12664 A looked up name is accepted only if it leads back to the original IP address
12665 via a forward lookup. If either the reverse or the forward lookup fails to find
12666 any data, or if the forward lookup does not yield the original IP address,
12667 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
12668
12669 .vindex "&$host_lookup_deferred$&"
12670 However, if either of the lookups cannot be completed (for example, there is a
12671 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
12672 &$host_lookup_failed$& remains set to &"0"&.
12673
12674 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
12675 host name again if there is a subsequent reference to &$sender_host_name$&
12676 in the same Exim process, but it does try again if &$host_lookup_deferred$&
12677 is set to &"1"&.
12678
12679 Exim does not automatically look up every calling host's name. If you want
12680 maximum efficiency, you should arrange your configuration so that it avoids
12681 these lookups altogether. The lookup happens only if one or more of the
12682 following are true:
12683
12684 .ilist
12685 A string containing &$sender_host_name$& is expanded.
12686 .next
12687 The calling host matches the list in &%host_lookup%&. In the default
12688 configuration, this option is set to *, so it must be changed if lookups are
12689 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
12690 .next
12691 Exim needs the host name in order to test an item in a host list. The items
12692 that require this are described in sections &<<SECThoslispatnam>>& and
12693 &<<SECThoslispatnamsk>>&.
12694 .next
12695 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
12696 In this case, the host name is required to compare with the name quoted in any
12697 EHLO or HELO commands that the client issues.
12698 .next
12699 The remote host issues a EHLO or HELO command that quotes one of the
12700 domains in &%helo_lookup_domains%&. The default value of this option is
12701 . ==== As this is a nested list, any displays it contains must be indented
12702 . ==== as otherwise they are too far to the left.
12703 .code
12704   helo_lookup_domains = @ : @[]
12705 .endd
12706 which causes a lookup if a remote host (incorrectly) gives the server's name or
12707 IP address in an EHLO or HELO command.
12708 .endlist
12709
12710
12711 .vitem &$sender_host_port$&
12712 .vindex "&$sender_host_port$&"
12713 When a message is received from a remote host, this variable contains the port
12714 number that was used on the remote host.
12715
12716 .vitem &$sender_ident$&
12717 .vindex "&$sender_ident$&"
12718 When a message is received from a remote host, this variable contains the
12719 identification received in response to an RFC 1413 request. When a message has
12720 been received locally, this variable contains the login name of the user that
12721 called Exim.
12722
12723 .vitem &$sender_rate_$&&'xxx'&
12724 A number of variables whose names begin &$sender_rate_$& are set as part of the
12725 &%ratelimit%& ACL condition. Details are given in section
12726 &<<SECTratelimiting>>&.
12727
12728 .vitem &$sender_rcvhost$&
12729 .cindex "DNS" "reverse lookup"
12730 .cindex "reverse DNS lookup"
12731 .vindex "&$sender_rcvhost$&"
12732 This is provided specifically for use in &'Received:'& headers. It starts with
12733 either the verified host name (as obtained from a reverse DNS lookup) or, if
12734 there is no verified host name, the IP address in square brackets. After that
12735 there may be text in parentheses. When the first item is a verified host name,
12736 the first thing in the parentheses is the IP address in square brackets,
12737 followed by a colon and a port number if port logging is enabled. When the
12738 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
12739 the parentheses.
12740
12741 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
12742 was used and its argument was not identical to the real host name or IP
12743 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
12744 all three items are present in the parentheses, a newline and tab are inserted
12745 into the string, to improve the formatting of the &'Received:'& header.
12746
12747 .vitem &$sender_verify_failure$&
12748 .vindex "&$sender_verify_failure$&"
12749 In an ACL, when a sender verification fails, this variable contains information
12750 about the failure. The details are the same as for
12751 &$recipient_verify_failure$&.
12752
12753 .vitem &$sending_ip_address$&
12754 .vindex "&$sending_ip_address$&"
12755 This variable is set whenever an outgoing SMTP connection to another host has
12756 been set up. It contains the IP address of the local interface that is being
12757 used. This is useful if a host that has more than one IP address wants to take
12758 on different personalities depending on which one is being used. For incoming
12759 connections, see &$received_ip_address$&.
12760
12761 .vitem &$sending_port$&
12762 .vindex "&$sending_port$&"
12763 This variable is set whenever an outgoing SMTP connection to another host has
12764 been set up. It contains the local port that is being used. For incoming
12765 connections, see &$received_port$&.
12766
12767 .vitem &$smtp_active_hostname$&
12768 .vindex "&$smtp_active_hostname$&"
12769 During an incoming SMTP session, this variable contains the value of the active
12770 host name, as specified by the &%smtp_active_hostname%& option. The value of
12771 &$smtp_active_hostname$& is saved with any message that is received, so its
12772 value can be consulted during routing and delivery.
12773
12774 .vitem &$smtp_command$&
12775 .vindex "&$smtp_command$&"
12776 During the processing of an incoming SMTP command, this variable contains the
12777 entire command. This makes it possible to distinguish between HELO and EHLO in
12778 the HELO ACL, and also to distinguish between commands such as these:
12779 .code
12780 MAIL FROM:<>
12781 MAIL FROM: <>
12782 .endd
12783 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
12784 command, the address in &$smtp_command$& is the original address before any
12785 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
12786 the address after SMTP-time rewriting.
12787
12788 .vitem &$smtp_command_argument$&
12789 .cindex "SMTP" "command, argument for"
12790 .vindex "&$smtp_command_argument$&"
12791 While an ACL is running to check an SMTP command, this variable contains the
12792 argument, that is, the text that follows the command name, with leading white
12793 space removed. Following the introduction of &$smtp_command$&, this variable is
12794 somewhat redundant, but is retained for backwards compatibility.
12795
12796 .vitem &$smtp_count_at_connection_start$&
12797 .vindex "&$smtp_count_at_connection_start$&"
12798 This variable is set greater than zero only in processes spawned by the Exim
12799 daemon for handling incoming SMTP connections. The name is deliberately long,
12800 in order to emphasize what the contents are. When the daemon accepts a new
12801 connection, it increments this variable. A copy of the variable is passed to
12802 the child process that handles the connection, but its value is fixed, and
12803 never changes. It is only an approximation of how many incoming connections
12804 there actually are, because many other connections may come and go while a
12805 single connection is being processed. When a child process terminates, the
12806 daemon decrements its copy of the variable.
12807
12808 .vitem "&$sn0$& &-- &$sn9$&"
12809 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
12810 that were current at the end of the system filter file. This allows a system
12811 filter file to set values that can be tested in users' filter files. For
12812 example, a system filter could set a value indicating how likely it is that a
12813 message is junk mail.
12814
12815 .vitem &$spam_$&&'xxx'&
12816 A number of variables whose names start with &$spam$& are available when Exim
12817 is compiled with the content-scanning extension. For details, see section
12818 &<<SECTscanspamass>>&.
12819
12820
12821 .vitem &$spool_directory$&
12822 .vindex "&$spool_directory$&"
12823 The name of Exim's spool directory.
12824
12825 .vitem &$spool_inodes$&
12826 .vindex "&$spool_inodes$&"
12827 The number of free inodes in the disk partition where Exim's spool files are
12828 being written. The value is recalculated whenever the variable is referenced.
12829 If the relevant file system does not have the concept of inodes, the value of
12830 is -1. See also the &%check_spool_inodes%& option.
12831
12832 .vitem &$spool_space$&
12833 .vindex "&$spool_space$&"
12834 The amount of free space (as a number of kilobytes) in the disk partition where
12835 Exim's spool files are being written. The value is recalculated whenever the
12836 variable is referenced. If the operating system does not have the ability to
12837 find the amount of free space (only true for experimental systems), the space
12838 value is -1. For example, to check in an ACL that there is at least 50
12839 megabytes free on the spool, you could write:
12840 .code
12841 condition = ${if > {$spool_space}{50000}}
12842 .endd
12843 See also the &%check_spool_space%& option.
12844
12845
12846 .vitem &$thisaddress$&
12847 .vindex "&$thisaddress$&"
12848 This variable is set only during the processing of the &%foranyaddress%&
12849 command in a filter file. Its use is explained in the description of that
12850 command, which can be found in the separate document entitled &'Exim's
12851 interfaces to mail filtering'&.
12852
12853 .vitem &$tls_in_bits$&
12854 .vindex "&$tls_in_bits$&"
12855 Contains an approximation of the TLS cipher's bit-strength
12856 on the inbound connection; the meaning of
12857 this depends upon the TLS implementation used.
12858 If TLS has not been negotiated, the value will be 0.
12859 The value of this is automatically fed into the Cyrus SASL authenticator
12860 when acting as a server, to specify the "external SSF" (a SASL term).
12861
12862 The deprecated &$tls_bits$& variable refers to the inbound side
12863 except when used in the context of an outbound SMTP delivery, when it refers to
12864 the outbound.
12865
12866 .vitem &$tls_out_bits$&
12867 .vindex "&$tls_out_bits$&"
12868 Contains an approximation of the TLS cipher's bit-strength
12869 on an outbound SMTP connection; the meaning of
12870 this depends upon the TLS implementation used.
12871 If TLS has not been negotiated, the value will be 0.
12872
12873 .vitem &$tls_in_ourcert$&
12874 .vindex "&$tls_in_ourcert$&"
12875 .cindex certificate variables
12876 This variable refers to the certificate presented to the peer of an
12877 inbound connection when the message was received.
12878 It is only useful as the argument of a
12879 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12880 or a &%def%& condition.
12881
12882 .vitem &$tls_in_peercert$&
12883 .vindex "&$tls_in_peercert$&"
12884 This variable refers to the certificate presented by the peer of an
12885 inbound connection when the message was received.
12886 It is only useful as the argument of a
12887 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12888 or a &%def%& condition.
12889 If certificate verification fails it may refer to a failing chain element
12890 which is not the leaf.
12891
12892 .vitem &$tls_out_ourcert$&
12893 .vindex "&$tls_out_ourcert$&"
12894 This variable refers to the certificate presented to the peer of an
12895 outbound connection.  It is only useful as the argument of a
12896 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12897 or a &%def%& condition.
12898
12899 .vitem &$tls_out_peercert$&
12900 .vindex "&$tls_out_peercert$&"
12901 This variable refers to the certificate presented by the peer of an
12902 outbound connection.  It is only useful as the argument of a
12903 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
12904 or a &%def%& condition.
12905 If certificate verification fails it may refer to a failing chain element
12906 which is not the leaf.
12907
12908 .vitem &$tls_in_certificate_verified$&
12909 .vindex "&$tls_in_certificate_verified$&"
12910 This variable is set to &"1"& if a TLS certificate was verified when the
12911 message was received, and &"0"& otherwise.
12912
12913 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
12914 except when used in the context of an outbound SMTP delivery, when it refers to
12915 the outbound.
12916
12917 .vitem &$tls_out_certificate_verified$&
12918 .vindex "&$tls_out_certificate_verified$&"
12919 This variable is set to &"1"& if a TLS certificate was verified when an
12920 outbound SMTP connection was made,
12921 and &"0"& otherwise.
12922
12923 .vitem &$tls_in_cipher$&
12924 .vindex "&$tls_in_cipher$&"
12925 .vindex "&$tls_cipher$&"
12926 When a message is received from a remote host over an encrypted SMTP
12927 connection, this variable is set to the cipher suite that was negotiated, for
12928 example DES-CBC3-SHA. In other circumstances, in particular, for message
12929 received over unencrypted connections, the variable is empty. Testing
12930 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
12931 non-encrypted connections during ACL processing.
12932
12933 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
12934 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
12935 becomes the same as &$tls_out_cipher$&.
12936
12937 .vitem &$tls_out_cipher$&
12938 .vindex "&$tls_out_cipher$&"
12939 This variable is
12940 cleared before any outgoing SMTP connection is made,
12941 and then set to the outgoing cipher suite if one is negotiated. See chapter
12942 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
12943 details of the &(smtp)& transport.
12944
12945 .vitem &$tls_in_ocsp$&
12946 .vindex "&$tls_in_ocsp$&"
12947 When a message is received from a remote client connection
12948 the result of any OCSP request from the client is encoded in this variable:
12949 .code
12950 0 OCSP proof was not requested (default value)
12951 1 No response to request
12952 2 Response not verified
12953 3 Verification failed
12954 4 Verification succeeded
12955 .endd
12956
12957 .vitem &$tls_out_ocsp$&
12958 .vindex "&$tls_out_ocsp$&"
12959 When a message is sent to a remote host connection
12960 the result of any OCSP request made is encoded in this variable.
12961 See &$tls_in_ocsp$& for values.
12962
12963 .vitem &$tls_in_peerdn$&
12964 .vindex "&$tls_in_peerdn$&"
12965 .vindex "&$tls_peerdn$&"
12966 .cindex certificate "extracting fields"
12967 When a message is received from a remote host over an encrypted SMTP
12968 connection, and Exim is configured to request a certificate from the client,
12969 the value of the Distinguished Name of the certificate is made available in the
12970 &$tls_in_peerdn$& during subsequent processing.
12971 If certificate verification fails it may refer to a failing chain element
12972 which is not the leaf.
12973
12974 The deprecated &$tls_peerdn$& variable refers to the inbound side
12975 except when used in the context of an outbound SMTP delivery, when it refers to
12976 the outbound.
12977
12978 .vitem &$tls_out_peerdn$&
12979 .vindex "&$tls_out_peerdn$&"
12980 When a message is being delivered to a remote host over an encrypted SMTP
12981 connection, and Exim is configured to request a certificate from the server,
12982 the value of the Distinguished Name of the certificate is made available in the
12983 &$tls_out_peerdn$& during subsequent processing.
12984 If certificate verification fails it may refer to a failing chain element
12985 which is not the leaf.
12986
12987 .vitem &$tls_in_sni$&
12988 .vindex "&$tls_in_sni$&"
12989 .vindex "&$tls_sni$&"
12990 .cindex "TLS" "Server Name Indication"
12991 When a TLS session is being established, if the client sends the Server
12992 Name Indication extension, the value will be placed in this variable.
12993 If the variable appears in &%tls_certificate%& then this option and
12994 some others, described in &<<SECTtlssni>>&,
12995 will be re-expanded early in the TLS session, to permit
12996 a different certificate to be presented (and optionally a different key to be
12997 used) to the client, based upon the value of the SNI extension.
12998
12999 The deprecated &$tls_sni$& variable refers to the inbound side
13000 except when used in the context of an outbound SMTP delivery, when it refers to
13001 the outbound.
13002
13003 .vitem &$tls_out_sni$&
13004 .vindex "&$tls_out_sni$&"
13005 .cindex "TLS" "Server Name Indication"
13006 During outbound
13007 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13008 the transport.
13009
13010 .vitem &$tod_bsdinbox$&
13011 .vindex "&$tod_bsdinbox$&"
13012 The time of day and the date, in the format required for BSD-style mailbox
13013 files, for example: Thu Oct 17 17:14:09 1995.
13014
13015 .vitem &$tod_epoch$&
13016 .vindex "&$tod_epoch$&"
13017 The time and date as a number of seconds since the start of the Unix epoch.
13018
13019 .vitem &$tod_epoch_l$&
13020 .vindex "&$tod_epoch_l$&"
13021 The time and date as a number of microseconds since the start of the Unix epoch.
13022
13023 .vitem &$tod_full$&
13024 .vindex "&$tod_full$&"
13025 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13026 +0100. The timezone is always given as a numerical offset from UTC, with
13027 positive values used for timezones that are ahead (east) of UTC, and negative
13028 values for those that are behind (west).
13029
13030 .vitem &$tod_log$&
13031 .vindex "&$tod_log$&"
13032 The time and date in the format used for writing Exim's log files, for example:
13033 1995-10-12 15:32:29, but without a timezone.
13034
13035 .vitem &$tod_logfile$&
13036 .vindex "&$tod_logfile$&"
13037 This variable contains the date in the format yyyymmdd. This is the format that
13038 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13039 flag.
13040
13041 .vitem &$tod_zone$&
13042 .vindex "&$tod_zone$&"
13043 This variable contains the numerical value of the local timezone, for example:
13044 -0500.
13045
13046 .vitem &$tod_zulu$&
13047 .vindex "&$tod_zulu$&"
13048 This variable contains the UTC date and time in &"Zulu"& format, as specified
13049 by ISO 8601, for example: 20030221154023Z.
13050
13051 .vitem &$transport_name$&
13052 .cindex "transport" "name"
13053 .cindex "name" "of transport"
13054 .vindex "&$transport_name$&"
13055 During the running of a transport, this variable contains its name.
13056
13057 .vitem &$value$&
13058 .vindex "&$value$&"
13059 This variable contains the result of an expansion lookup, extraction operation,
13060 or external command, as described above. It is also used during a
13061 &*reduce*& expansion.
13062
13063 .vitem &$verify_mode$&
13064 .vindex "&$verify_mode$&"
13065 While a router or transport is being run in verify mode or for cutthrough delivery,
13066 contains "S" for sender-verification or "R" for recipient-verification.
13067 Otherwise, empty.
13068
13069 .vitem &$version_number$&
13070 .vindex "&$version_number$&"
13071 The version number of Exim.
13072
13073 .vitem &$warn_message_delay$&
13074 .vindex "&$warn_message_delay$&"
13075 This variable is set only during the creation of a message warning about a
13076 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13077
13078 .vitem &$warn_message_recipients$&
13079 .vindex "&$warn_message_recipients$&"
13080 This variable is set only during the creation of a message warning about a
13081 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13082 .endlist
13083 .ecindex IIDstrexp
13084
13085
13086
13087 . ////////////////////////////////////////////////////////////////////////////
13088 . ////////////////////////////////////////////////////////////////////////////
13089
13090 .chapter "Embedded Perl" "CHAPperl"
13091 .scindex IIDperl "Perl" "calling from Exim"
13092 Exim can be built to include an embedded Perl interpreter. When this is done,
13093 Perl subroutines can be called as part of the string expansion process. To make
13094 use of the Perl support, you need version 5.004 or later of Perl installed on
13095 your system. To include the embedded interpreter in the Exim binary, include
13096 the line
13097 .code
13098 EXIM_PERL = perl.o
13099 .endd
13100 in your &_Local/Makefile_& and then build Exim in the normal way.
13101
13102
13103 .section "Setting up so Perl can be used" "SECID85"
13104 .oindex "&%perl_startup%&"
13105 Access to Perl subroutines is via a global configuration option called
13106 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13107 no &%perl_startup%& option in the Exim configuration file then no Perl
13108 interpreter is started and there is almost no overhead for Exim (since none of
13109 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13110 option then the associated value is taken to be Perl code which is executed in
13111 a newly created Perl interpreter.
13112
13113 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13114 need backslashes before any characters to escape special meanings. The option
13115 should usually be something like
13116 .code
13117 perl_startup = do '/etc/exim.pl'
13118 .endd
13119 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13120 use from Exim. Exim can be configured either to start up a Perl interpreter as
13121 soon as it is entered, or to wait until the first time it is needed. Starting
13122 the interpreter at the beginning ensures that it is done while Exim still has
13123 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13124 fact used in a particular run. Also, note that this does not mean that Exim is
13125 necessarily running as root when Perl is called at a later time. By default,
13126 the interpreter is started only when it is needed, but this can be changed in
13127 two ways:
13128
13129 .ilist
13130 .oindex "&%perl_at_start%&"
13131 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13132 a startup when Exim is entered.
13133 .next
13134 The command line option &%-ps%& also requests a startup when Exim is entered,
13135 overriding the setting of &%perl_at_start%&.
13136 .endlist
13137
13138 There is also a command line option &%-pd%& (for delay) which suppresses the
13139 initial startup, even if &%perl_at_start%& is set.
13140
13141 .ilist
13142 .oindex "&%perl_taintmode%&"
13143 .cindex "Perl" "taintmode"
13144 To provide more security executing Perl code via the embedded Perl
13145 interpreter, the &%perl_taintmode%& option can be set. This enables the
13146 taint mode of the Perl interpreter. You are encouraged to set this
13147 option to a true value. To avoid breaking existing installations, it
13148 defaults to false.
13149
13150
13151 .section "Calling Perl subroutines" "SECID86"
13152 When the configuration file includes a &%perl_startup%& option you can make use
13153 of the string expansion item to call the Perl subroutines that are defined
13154 by the &%perl_startup%& code. The operator is used in any of the following
13155 forms:
13156 .code
13157 ${perl{foo}}
13158 ${perl{foo}{argument}}
13159 ${perl{foo}{argument1}{argument2} ... }
13160 .endd
13161 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13162 arguments may be passed. Passing more than this results in an expansion failure
13163 with an error message of the form
13164 .code
13165 Too many arguments passed to Perl subroutine "foo" (max is 8)
13166 .endd
13167 The return value of the Perl subroutine is evaluated in a scalar context before
13168 it is passed back to Exim to be inserted into the expanded string. If the
13169 return value is &'undef'&, the expansion is forced to fail in the same way as
13170 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13171 by obeying Perl's &%die%& function, the expansion fails with the error message
13172 that was passed to &%die%&.
13173
13174
13175 .section "Calling Exim functions from Perl" "SECID87"
13176 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13177 is available to call back into Exim's string expansion function. For example,
13178 the Perl code
13179 .code
13180 my $lp = Exim::expand_string('$local_part');
13181 .endd
13182 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13183 Note those are single quotes and not double quotes to protect against
13184 &$local_part$& being interpolated as a Perl variable.
13185
13186 If the string expansion is forced to fail by a &"fail"& item, the result of
13187 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13188 expansion string, the Perl call from the original expansion string fails with
13189 an appropriate error message, in the same way as if &%die%& were used.
13190
13191 .cindex "debugging" "from embedded Perl"
13192 .cindex "log" "writing from embedded Perl"
13193 Two other Exim functions are available for use from within Perl code.
13194 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13195 debugging is enabled. If you want a newline at the end, you must supply it.
13196 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13197 timestamp. In this case, you should not supply a terminating newline.
13198
13199
13200 .section "Use of standard output and error by Perl" "SECID88"
13201 .cindex "Perl" "standard output and error"
13202 You should not write to the standard error or output streams from within your
13203 Perl code, as it is not defined how these are set up. In versions of Exim
13204 before 4.50, it is possible for the standard output or error to refer to the
13205 SMTP connection during message reception via the daemon. Writing to this stream
13206 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13207 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13208 avoided, but the output is lost.
13209
13210 .cindex "Perl" "use of &%warn%&"
13211 The Perl &%warn%& statement writes to the standard error stream by default.
13212 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13213 you have no control. When Exim starts up the Perl interpreter, it arranges for
13214 output from the &%warn%& statement to be written to the Exim main log. You can
13215 change this by including appropriate Perl magic somewhere in your Perl code.
13216 For example, to discard &%warn%& output completely, you need this:
13217 .code
13218 $SIG{__WARN__} = sub { };
13219 .endd
13220 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13221 example, the code for the subroutine is empty, so it does nothing, but you can
13222 include any Perl code that you like. The text of the &%warn%& message is passed
13223 as the first subroutine argument.
13224 .ecindex IIDperl
13225
13226
13227 . ////////////////////////////////////////////////////////////////////////////
13228 . ////////////////////////////////////////////////////////////////////////////
13229
13230 .chapter "Starting the daemon and the use of network interfaces" &&&
13231          "CHAPinterfaces" &&&
13232          "Starting the daemon"
13233 .cindex "daemon" "starting"
13234 .cindex "interface" "listening"
13235 .cindex "network interface"
13236 .cindex "interface" "network"
13237 .cindex "IP address" "for listening"
13238 .cindex "daemon" "listening IP addresses"
13239 .cindex "TCP/IP" "setting listening interfaces"
13240 .cindex "TCP/IP" "setting listening ports"
13241 A host that is connected to a TCP/IP network may have one or more physical
13242 hardware network interfaces. Each of these interfaces may be configured as one
13243 or more &"logical"& interfaces, which are the entities that a program actually
13244 works with. Each of these logical interfaces is associated with an IP address.
13245 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13246 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13247 knowledge about the host's interfaces for use in three different circumstances:
13248
13249 .olist
13250 When a listening daemon is started, Exim needs to know which interfaces
13251 and ports to listen on.
13252 .next
13253 When Exim is routing an address, it needs to know which IP addresses
13254 are associated with local interfaces. This is required for the correct
13255 processing of MX lists by removing the local host and others with the
13256 same or higher priority values. Also, Exim needs to detect cases
13257 when an address is routed to an IP address that in fact belongs to the
13258 local host. Unless the &%self%& router option or the &%allow_localhost%&
13259 option of the smtp transport is set (as appropriate), this is treated
13260 as an error situation.
13261 .next
13262 When Exim connects to a remote host, it may need to know which interface to use
13263 for the outgoing connection.
13264 .endlist
13265
13266
13267 Exim's default behaviour is likely to be appropriate in the vast majority
13268 of cases. If your host has only one interface, and you want all its IP
13269 addresses to be treated in the same way, and you are using only the
13270 standard SMTP port, you should not need to take any special action. The
13271 rest of this chapter does not apply to you.
13272
13273 In a more complicated situation you may want to listen only on certain
13274 interfaces, or on different ports, and for this reason there are a number of
13275 options that can be used to influence Exim's behaviour. The rest of this
13276 chapter describes how they operate.
13277
13278 When a message is received over TCP/IP, the interface and port that were
13279 actually used are set in &$received_ip_address$& and &$received_port$&.
13280
13281
13282
13283 .section "Starting a listening daemon" "SECID89"
13284 When a listening daemon is started (by means of the &%-bd%& command line
13285 option), the interfaces and ports on which it listens are controlled by the
13286 following options:
13287
13288 .ilist
13289 &%daemon_smtp_ports%& contains a list of default ports
13290 or service names.
13291 (For backward compatibility, this option can also be specified in the singular.)
13292 .next
13293 &%local_interfaces%& contains list of interface IP addresses on which to
13294 listen. Each item may optionally also specify a port.
13295 .endlist
13296
13297 The default list separator in both cases is a colon, but this can be changed as
13298 described in section &<<SECTlistconstruct>>&. When IPv6 addresses are involved,
13299 it is usually best to change the separator to avoid having to double all the
13300 colons. For example:
13301 .code
13302 local_interfaces = <; 127.0.0.1 ; \
13303                       192.168.23.65 ; \
13304                       ::1 ; \
13305                       3ffe:ffff:836f::fe86:a061
13306 .endd
13307 There are two different formats for specifying a port along with an IP address
13308 in &%local_interfaces%&:
13309
13310 .olist
13311 The port is added onto the address with a dot separator. For example, to listen
13312 on port 1234 on two different IP addresses:
13313 .code
13314 local_interfaces = <; 192.168.23.65.1234 ; \
13315                       3ffe:ffff:836f::fe86:a061.1234
13316 .endd
13317 .next
13318 The IP address is enclosed in square brackets, and the port is added
13319 with a colon separator, for example:
13320 .code
13321 local_interfaces = <; [192.168.23.65]:1234 ; \
13322                       [3ffe:ffff:836f::fe86:a061]:1234
13323 .endd
13324 .endlist
13325
13326 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13327 default setting contains just one port:
13328 .code
13329 daemon_smtp_ports = smtp
13330 .endd
13331 If more than one port is listed, each interface that does not have its own port
13332 specified listens on all of them. Ports that are listed in
13333 &%daemon_smtp_ports%& can be identified either by name (defined in
13334 &_/etc/services_&) or by number. However, when ports are given with individual
13335 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13336
13337
13338
13339 .section "Special IP listening addresses" "SECID90"
13340 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13341 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13342 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13343 instead of setting up separate listening sockets for each interface. The
13344 default value of &%local_interfaces%& is
13345 .code
13346 local_interfaces = 0.0.0.0
13347 .endd
13348 when Exim is built without IPv6 support; otherwise it is:
13349 .code
13350 local_interfaces = <; ::0 ; 0.0.0.0
13351 .endd
13352 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13353
13354
13355
13356 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13357 The &%-oX%& command line option can be used to override the values of
13358 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13359 instance. Another way of doing this would be to use macros and the &%-D%&
13360 option. However, &%-oX%& can be used by any admin user, whereas modification of
13361 the runtime configuration by &%-D%& is allowed only when the caller is root or
13362 exim.
13363
13364 The value of &%-oX%& is a list of items. The default colon separator can be
13365 changed in the usual way if required. If there are any items that do not
13366 contain dots or colons (that is, are not IP addresses), the value of
13367 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13368 items that do contain dots or colons, the value of &%local_interfaces%& is
13369 replaced by those items. Thus, for example,
13370 .code
13371 -oX 1225
13372 .endd
13373 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13374 whereas
13375 .code
13376 -oX 192.168.34.5.1125
13377 .endd
13378 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13379 (However, since &%local_interfaces%& now contains no items without ports, the
13380 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13381
13382
13383
13384 .section "Support for the obsolete SSMTP (or SMTPS) protocol" "SECTsupobssmt"
13385 .cindex "ssmtp protocol"
13386 .cindex "smtps protocol"
13387 .cindex "SMTP" "ssmtp protocol"
13388 .cindex "SMTP" "smtps protocol"
13389 Exim supports the obsolete SSMTP protocol (also known as SMTPS) that was used
13390 before the STARTTLS command was standardized for SMTP. Some legacy clients
13391 still use this protocol. If the &%tls_on_connect_ports%& option is set to a
13392 list of port numbers or service names,
13393 connections to those ports must use SSMTP. The most
13394 common use of this option is expected to be
13395 .code
13396 tls_on_connect_ports = 465
13397 .endd
13398 because 465 is the usual port number used by the legacy clients. There is also
13399 a command line option &%-tls-on-connect%&, which forces all ports to behave in
13400 this way when a daemon is started.
13401
13402 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13403 daemon to listen on those ports. You must still specify them in
13404 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13405 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13406 connections via the daemon.)
13407
13408
13409
13410
13411 .section "IPv6 address scopes" "SECID92"
13412 .cindex "IPv6" "address scopes"
13413 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13414 can, in principle, have the same link-local IPv6 address on different
13415 interfaces. Thus, additional information is needed, over and above the IP
13416 address, to distinguish individual interfaces. A convention of using a
13417 percent sign followed by something (often the interface name) has been
13418 adopted in some cases, leading to addresses like this:
13419 .code
13420 fe80::202:b3ff:fe03:45c1%eth0
13421 .endd
13422 To accommodate this usage, a percent sign followed by an arbitrary string is
13423 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13424 to convert a textual IPv6 address for actual use. This function recognizes the
13425 percent convention in operating systems that support it, and it processes the
13426 address appropriately. Unfortunately, some older libraries have problems with
13427 &[getaddrinfo()]&. If
13428 .code
13429 IPV6_USE_INET_PTON=yes
13430 .endd
13431 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13432 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13433 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13434 function.) Of course, this means that the additional functionality of
13435 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13436
13437 .section "Disabling IPv6" "SECID93"
13438 .cindex "IPv6" "disabling"
13439 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13440 run on a host whose kernel does not support IPv6. The binary will fall back to
13441 using IPv4, but it may waste resources looking up AAAA records, and trying to
13442 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13443 .oindex "&%disable_ipv6%&"
13444 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13445 activities take place. AAAA records are never looked up, and any IPv6 addresses
13446 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13447 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13448 to handle IPv6 literal addresses.
13449
13450 On the other hand, when IPv6 is in use, there may be times when you want to
13451 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13452 option to globally suppress the lookup of AAAA records for specified domains,
13453 and you can use the &%ignore_target_hosts%& generic router option to ignore
13454 IPv6 addresses in an individual router.
13455
13456
13457
13458 .section "Examples of starting a listening daemon" "SECID94"
13459 The default case in an IPv6 environment is
13460 .code
13461 daemon_smtp_ports = smtp
13462 local_interfaces = <; ::0 ; 0.0.0.0
13463 .endd
13464 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13465 Either one or two sockets may be used, depending on the characteristics of
13466 the TCP/IP stack. (This is complicated and messy; for more information,
13467 read the comments in the &_daemon.c_& source file.)
13468
13469 To specify listening on ports 25 and 26 on all interfaces:
13470 .code
13471 daemon_smtp_ports = 25 : 26
13472 .endd
13473 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13474 .code
13475 local_interfaces = <; ::0.25     ; ::0.26 \
13476                       0.0.0.0.25 ; 0.0.0.0.26
13477 .endd
13478 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13479 IPv4 loopback address only:
13480 .code
13481 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13482 .endd
13483 To specify listening on the default port on specific interfaces only:
13484 .code
13485 local_interfaces = 10.0.0.67 : 192.168.34.67
13486 .endd
13487 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13488
13489
13490
13491 .section "Recognizing the local host" "SECTreclocipadd"
13492 The &%local_interfaces%& option is also used when Exim needs to determine
13493 whether or not an IP address refers to the local host. That is, the IP
13494 addresses of all the interfaces on which a daemon is listening are always
13495 treated as local.
13496
13497 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13498 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13499 available interfaces from the operating system, and extracts the relevant
13500 (that is, IPv4 or IPv6) addresses to use for checking.
13501
13502 Some systems set up large numbers of virtual interfaces in order to provide
13503 many virtual web servers. In this situation, you may want to listen for
13504 email on only a few of the available interfaces, but nevertheless treat all
13505 interfaces as local when routing. You can do this by setting
13506 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13507 &"all"& wildcard values. These addresses are recognized as local, but are not
13508 used for listening. Consider this example:
13509 .code
13510 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13511                       192.168.53.235 ; \
13512                       3ffe:2101:12:1:a00:20ff:fe86:a061
13513
13514 extra_local_interfaces = <; ::0 ; 0.0.0.0
13515 .endd
13516 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13517 address, but all available interface addresses are treated as local when
13518 Exim is routing.
13519
13520 In some environments the local host name may be in an MX list, but with an IP
13521 address that is not assigned to any local interface. In other cases it may be
13522 desirable to treat other host names as if they referred to the local host. Both
13523 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13524 This contains host names rather than IP addresses. When a host is referenced
13525 during routing, either via an MX record or directly, it is treated as the local
13526 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13527 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13528
13529
13530
13531 .section "Delivering to a remote host" "SECID95"
13532 Delivery to a remote host is handled by the smtp transport. By default, it
13533 allows the system's TCP/IP functions to choose which interface to use (if
13534 there is more than one) when connecting to a remote host. However, the
13535 &%interface%& option can be set to specify which interface is used. See the
13536 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13537 details.
13538
13539
13540
13541
13542 . ////////////////////////////////////////////////////////////////////////////
13543 . ////////////////////////////////////////////////////////////////////////////
13544
13545 .chapter "Main configuration" "CHAPmainconfig"
13546 .scindex IIDconfima "configuration file" "main section"
13547 .scindex IIDmaiconf "main configuration"
13548 The first part of the run time configuration file contains three types of item:
13549
13550 .ilist
13551 Macro definitions: These lines start with an upper case letter. See section
13552 &<<SECTmacrodefs>>& for details of macro processing.
13553 .next
13554 Named list definitions: These lines start with one of the words &"domainlist"&,
13555 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
13556 section &<<SECTnamedlists>>&.
13557 .next
13558 Main configuration settings: Each setting occupies one line of the file
13559 (with possible continuations). If any setting is preceded by the word
13560 &"hide"&, the &%-bP%& command line option displays its value to admin users
13561 only. See section &<<SECTcos>>& for a description of the syntax of these option
13562 settings.
13563 .endlist
13564
13565 This chapter specifies all the main configuration options, along with their
13566 types and default values. For ease of finding a particular option, they appear
13567 in alphabetical order in section &<<SECTalomo>>& below. However, because there
13568 are now so many options, they are first listed briefly in functional groups, as
13569 an aid to finding the name of the option you are looking for. Some options are
13570 listed in more than one group.
13571
13572 .section "Miscellaneous" "SECID96"
13573 .table2
13574 .row &%bi_command%&                  "to run for &%-bi%& command line option"
13575 .row &%debug_store%&                 "do extra internal checks"
13576 .row &%disable_ipv6%&                "do no IPv6 processing"
13577 .row &%keep_malformed%&              "for broken files &-- should not happen"
13578 .row &%localhost_number%&            "for unique message ids in clusters"
13579 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
13580 .row &%message_body_visible%&        "how much to show in &$message_body$&"
13581 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
13582 .row &%print_topbitchars%&           "top-bit characters are printing"
13583 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
13584 .row &%timezone%&                    "force time zone"
13585 .endtable
13586
13587
13588 .section "Exim parameters" "SECID97"
13589 .table2
13590 .row &%exim_group%&                  "override compiled-in value"
13591 .row &%exim_path%&                   "override compiled-in value"
13592 .row &%exim_user%&                   "override compiled-in value"
13593 .row &%primary_hostname%&            "default from &[uname()]&"
13594 .row &%split_spool_directory%&       "use multiple directories"
13595 .row &%spool_directory%&             "override compiled-in value"
13596 .endtable
13597
13598
13599
13600 .section "Privilege controls" "SECID98"
13601 .table2
13602 .row &%admin_groups%&                "groups that are Exim admin users"
13603 .row &%commandline_checks_require_admin%& "require admin for various checks"
13604 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
13605 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
13606 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
13607 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
13608 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
13609 .row &%never_users%&                 "do not run deliveries as these"
13610 .row &%prod_requires_admin%&         "forced delivery requires admin user"
13611 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
13612 .row &%trusted_groups%&              "groups that are trusted"
13613 .row &%trusted_users%&               "users that are trusted"
13614 .endtable
13615
13616
13617
13618 .section "Logging" "SECID99"
13619 .table2
13620 .row &%event_action%&                "custom logging"
13621 .row &%hosts_connection_nolog%&      "exemption from connect logging"
13622 .row &%log_file_path%&               "override compiled-in value"
13623 .row &%log_selector%&                "set/unset optional logging"
13624 .row &%log_timezone%&                "add timezone to log lines"
13625 .row &%message_logs%&                "create per-message logs"
13626 .row &%preserve_message_logs%&       "after message completion"
13627 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
13628 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
13629 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
13630 .row &%syslog_facility%&             "set syslog &""facility""& field"
13631 .row &%syslog_pid%&                  "pid in syslog lines"
13632 .row &%syslog_processname%&          "set syslog &""ident""& field"
13633 .row &%syslog_timestamp%&            "timestamp syslog lines"
13634 .row &%write_rejectlog%&             "control use of message log"
13635 .endtable
13636
13637
13638
13639 .section "Frozen messages" "SECID100"
13640 .table2
13641 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
13642 .row &%freeze_tell%&                 "send message when freezing"
13643 .row &%move_frozen_messages%&        "to another directory"
13644 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
13645 .endtable
13646
13647
13648
13649 .section "Data lookups" "SECID101"
13650 .table2
13651 .row &%ibase_servers%&               "InterBase servers"
13652 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
13653 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
13654 .row &%ldap_cert_file%&              "client cert file for LDAP"
13655 .row &%ldap_cert_key%&               "client key file for LDAP"
13656 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
13657 .row &%ldap_default_servers%&        "used if no server in query"
13658 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
13659 .row &%ldap_start_tls%&              "require TLS within LDAP"
13660 .row &%ldap_version%&                "set protocol version"
13661 .row &%lookup_open_max%&             "lookup files held open"
13662 .row &%mysql_servers%&               "default MySQL servers"
13663 .row &%oracle_servers%&              "Oracle servers"
13664 .row &%pgsql_servers%&               "default PostgreSQL servers"
13665 .row &%sqlite_lock_timeout%&         "as it says"
13666 .endtable
13667
13668
13669
13670 .section "Message ids" "SECID102"
13671 .table2
13672 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
13673 .row &%message_id_header_text%&      "ditto"
13674 .endtable
13675
13676
13677
13678 .section "Embedded Perl Startup" "SECID103"
13679 .table2
13680 .row &%perl_at_start%&               "always start the interpreter"
13681 .row &%perl_startup%&                "code to obey when starting Perl"
13682 .row &%perl_taintmode%&              "enable taint mode in Perl"
13683 .endtable
13684
13685
13686
13687 .section "Daemon" "SECID104"
13688 .table2
13689 .row &%daemon_smtp_ports%&           "default ports"
13690 .row &%daemon_startup_retries%&      "number of times to retry"
13691 .row &%daemon_startup_sleep%&        "time to sleep between tries"
13692 .row &%extra_local_interfaces%&      "not necessarily listened on"
13693 .row &%local_interfaces%&            "on which to listen, with optional ports"
13694 .row &%pid_file_path%&               "override compiled-in value"
13695 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13696 .endtable
13697
13698
13699
13700 .section "Resource control" "SECID105"
13701 .table2
13702 .row &%check_log_inodes%&            "before accepting a message"
13703 .row &%check_log_space%&             "before accepting a message"
13704 .row &%check_spool_inodes%&          "before accepting a message"
13705 .row &%check_spool_space%&           "before accepting a message"
13706 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
13707 .row &%queue_only_load%&             "queue incoming if load high"
13708 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13709 .row &%queue_run_max%&               "maximum simultaneous queue runners"
13710 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13711 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13712 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13713 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13714 .row &%smtp_accept_max_per_connection%& "messages per connection"
13715 .row &%smtp_accept_max_per_host%&    "connections from one host"
13716 .row &%smtp_accept_queue%&           "queue mail if more connections"
13717 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13718                                            connection"
13719 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13720 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13721 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13722 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
13723 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13724 .endtable
13725
13726
13727
13728 .section "Policy controls" "SECID106"
13729 .table2
13730 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
13731 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
13732 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
13733 .row &%acl_smtp_auth%&               "ACL for AUTH"
13734 .row &%acl_smtp_connect%&            "ACL for connection"
13735 .row &%acl_smtp_data%&               "ACL for DATA"
13736 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
13737 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
13738 .row &%acl_smtp_etrn%&               "ACL for ETRN"
13739 .row &%acl_smtp_expn%&               "ACL for EXPN"
13740 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
13741 .row &%acl_smtp_mail%&               "ACL for MAIL"
13742 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
13743 .row &%acl_smtp_mime%&               "ACL for MIME parts"
13744 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
13745 .row &%acl_smtp_predata%&            "ACL for start of data"
13746 .row &%acl_smtp_quit%&               "ACL for QUIT"
13747 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
13748 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
13749 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
13750 .row &%av_scanner%&                  "specify virus scanner"
13751 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13752                                       words""&"
13753 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
13754 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
13755 .row &%header_maxsize%&              "total size of message header"
13756 .row &%header_line_maxsize%&         "individual header line limit"
13757 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
13758 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
13759 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
13760 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
13761 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
13762 .row &%host_lookup%&                 "host name looked up for these hosts"
13763 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13764 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
13765 .row &%host_reject_connection%&      "reject connection from these hosts"
13766 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
13767 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
13768 .row &%message_size_limit%&          "for all messages"
13769 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13770 .row &%spamd_address%&               "set interface to SpamAssassin"
13771 .row &%strict_acl_vars%&             "object to unset ACL variables"
13772 .endtable
13773
13774
13775
13776 .section "Callout cache" "SECID107"
13777 .table2
13778 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
13779                                          item"
13780 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
13781                                          item"
13782 .row &%callout_negative_expire%&     "timeout for negative address cache item"
13783 .row &%callout_positive_expire%&     "timeout for positive address cache item"
13784 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
13785 .endtable
13786
13787
13788
13789 .section "TLS" "SECID108"
13790 .table2
13791 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
13792 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
13793 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
13794 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13795 .row &%tls_certificate%&             "location of server certificate"
13796 .row &%tls_crl%&                     "certificate revocation list"
13797 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
13798 .row &%tls_dhparam%&                 "DH parameters for server"
13799 .row &%tls_eccurve%&                 "EC curve selection for server"
13800 .row &%tls_ocsp_file%&               "location of server certificate status proof"
13801 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
13802 .row &%tls_privatekey%&              "location of server private key"
13803 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
13804 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
13805 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
13806 .row &%tls_verify_certificates%&     "expected client certificates"
13807 .row &%tls_verify_hosts%&            "insist on client certificate verify"
13808 .endtable
13809
13810
13811
13812 .section "Local user handling" "SECID109"
13813 .table2
13814 .row &%finduser_retries%&            "useful in NIS environments"
13815 .row &%gecos_name%&                  "used when creating &'Sender:'&"
13816 .row &%gecos_pattern%&               "ditto"
13817 .row &%max_username_length%&         "for systems that truncate"
13818 .row &%unknown_login%&               "used when no login name found"
13819 .row &%unknown_username%&            "ditto"
13820 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
13821 .row &%uucp_from_sender%&            "ditto"
13822 .endtable
13823
13824
13825
13826 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
13827 .table2
13828 .row &%header_maxsize%&              "total size of message header"
13829 .row &%header_line_maxsize%&         "individual header line limit"
13830 .row &%message_size_limit%&          "applies to all messages"
13831 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
13832 .row &%received_header_text%&        "expanded to make &'Received:'&"
13833 .row &%received_headers_max%&        "for mail loop detection"
13834 .row &%recipients_max%&              "limit per message"
13835 .row &%recipients_max_reject%&       "permanently reject excess recipients"
13836 .endtable
13837
13838
13839
13840
13841 .section "Non-SMTP incoming messages" "SECID111"
13842 .table2
13843 .row &%receive_timeout%&             "for non-SMTP messages"
13844 .endtable
13845
13846
13847
13848
13849
13850 .section "Incoming SMTP messages" "SECID112"
13851 See also the &'Policy controls'& section above.
13852
13853 .table2
13854 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
13855 .row &%host_lookup%&                 "host name looked up for these hosts"
13856 .row &%host_lookup_order%&           "order of DNS and local name lookups"
13857 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
13858 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
13859 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
13860 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
13861 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
13862 .row &%smtp_accept_max%&             "simultaneous incoming connections"
13863 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
13864 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
13865 .row &%smtp_accept_max_per_connection%& "messages per connection"
13866 .row &%smtp_accept_max_per_host%&    "connections from one host"
13867 .row &%smtp_accept_queue%&           "queue mail if more connections"
13868 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
13869                                            connection"
13870 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
13871 .row &%smtp_active_hostname%&        "host name to use in messages"
13872 .row &%smtp_banner%&                 "text for welcome banner"
13873 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
13874 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
13875 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
13876 .row &%smtp_etrn_command%&           "what to run for ETRN"
13877 .row &%smtp_etrn_serialize%&         "only one at once"
13878 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
13879 .row &%smtp_max_unknown_commands%&   "before dropping connection"
13880 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
13881 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
13882 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
13883 .row &%smtp_receive_timeout%&        "per command or data line"
13884 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
13885 .row &%smtp_return_error_details%&   "give detail on rejections"
13886 .endtable
13887
13888
13889
13890 .section "SMTP extensions" "SECID113"
13891 .table2
13892 .row &%accept_8bitmime%&             "advertise 8BITMIME"
13893 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
13894 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
13895 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
13896 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
13897 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
13898 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
13899 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
13900 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
13901 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
13902 .endtable
13903
13904
13905
13906 .section "Processing messages" "SECID114"
13907 .table2
13908 .row &%allow_domain_literals%&       "recognize domain literal syntax"
13909 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
13910 .row &%allow_utf8_domains%&          "in addresses"
13911 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
13912                                       words""&"
13913 .row &%delivery_date_remove%&        "from incoming messages"
13914 .row &%envelope_to_remove%&          "from incoming messages"
13915 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
13916 .row &%headers_charset%&             "default for translations"
13917 .row &%qualify_domain%&              "default for senders"
13918 .row &%qualify_recipient%&           "default for recipients"
13919 .row &%return_path_remove%&          "from incoming messages"
13920 .row &%strip_excess_angle_brackets%& "in addresses"
13921 .row &%strip_trailing_dot%&          "at end of addresses"
13922 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
13923 .endtable
13924
13925
13926
13927 .section "System filter" "SECID115"
13928 .table2
13929 .row &%system_filter%&               "locate system filter"
13930 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
13931                                             directory"
13932 .row &%system_filter_file_transport%& "transport for delivery to a file"
13933 .row &%system_filter_group%&         "group for filter running"
13934 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
13935 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
13936 .row &%system_filter_user%&          "user for filter running"
13937 .endtable
13938
13939
13940
13941 .section "Routing and delivery" "SECID116"
13942 .table2
13943 .row &%disable_ipv6%&                "do no IPv6 processing"
13944 .row &%dns_again_means_nonexist%&    "for broken domains"
13945 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
13946 .row &%dns_dnssec_ok%&               "parameter for resolver"
13947 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
13948 .row &%dns_retrans%&                 "parameter for resolver"
13949 .row &%dns_retry%&                   "parameter for resolver"
13950 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
13951 .row &%dns_use_edns0%&               "parameter for resolver"
13952 .row &%hold_domains%&                "hold delivery for these domains"
13953 .row &%local_interfaces%&            "for routing checks"
13954 .row &%queue_domains%&               "no immediate delivery for these"
13955 .row &%queue_only%&                  "no immediate delivery at all"
13956 .row &%queue_only_file%&             "no immediate delivery if file exists"
13957 .row &%queue_only_load%&             "no immediate delivery if load is high"
13958 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
13959 .row &%queue_only_override%&         "allow command line to override"
13960 .row &%queue_run_in_order%&          "order of arrival"
13961 .row &%queue_run_max%&               "of simultaneous queue runners"
13962 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
13963 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
13964 .row &%remote_sort_domains%&         "order of remote deliveries"
13965 .row &%retry_data_expire%&           "timeout for retry data"
13966 .row &%retry_interval_max%&          "safety net for retry rules"
13967 .endtable
13968
13969
13970
13971 .section "Bounce and warning messages" "SECID117"
13972 .table2
13973 .row &%bounce_message_file%&         "content of bounce"
13974 .row &%bounce_message_text%&         "content of bounce"
13975 .row &%bounce_return_body%&          "include body if returning message"
13976 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
13977 .row &%bounce_return_message%&       "include original message in bounce"
13978 .row &%bounce_return_size_limit%&    "limit on returned message"
13979 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
13980 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
13981 .row &%errors_copy%&                 "copy bounce messages"
13982 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
13983 .row &%delay_warning%&               "time schedule"
13984 .row &%delay_warning_condition%&     "condition for warning messages"
13985 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
13986 .row &%smtp_return_error_details%&   "give detail on rejections"
13987 .row &%warn_message_file%&           "content of warning message"
13988 .endtable
13989
13990
13991
13992 .section "Alphabetical list of main options" "SECTalomo"
13993 Those options that undergo string expansion before use are marked with
13994 &dagger;.
13995
13996 .option accept_8bitmime main boolean true
13997 .cindex "8BITMIME"
13998 .cindex "8-bit characters"
13999 .cindex "log" "selectors"
14000 .cindex "log" "8BITMIME"
14001 This option causes Exim to send 8BITMIME in its response to an SMTP
14002 EHLO command, and to accept the BODY= parameter on MAIL commands.
14003 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14004 takes no steps to do anything special with messages received by this route.
14005
14006 Historically Exim kept this option off by default, but the maintainers
14007 feel that in today's Internet, this causes more problems than it solves.
14008 It now defaults to true.
14009 A more detailed analysis of the issues is provided by Dan Bernstein:
14010 .display
14011 &url(http://cr.yp.to/smtp/8bitmime.html)
14012 .endd
14013
14014 To log received 8BITMIME status use
14015 .code
14016 log_selector = +8bitmime
14017 .endd
14018
14019 .option acl_not_smtp main string&!! unset
14020 .cindex "&ACL;" "for non-SMTP messages"
14021 .cindex "non-SMTP messages" "ACLs for"
14022 This option defines the ACL that is run when a non-SMTP message has been
14023 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14024 further details.
14025
14026 .option acl_not_smtp_mime main string&!! unset
14027 This option defines the ACL that is run for individual MIME parts of non-SMTP
14028 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14029 SMTP messages.
14030
14031 .option acl_not_smtp_start main string&!! unset
14032 .cindex "&ACL;" "at start of non-SMTP message"
14033 .cindex "non-SMTP messages" "ACLs for"
14034 This option defines the ACL that is run before Exim starts reading a
14035 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14036
14037 .option acl_smtp_auth main string&!! unset
14038 .cindex "&ACL;" "setting up for SMTP commands"
14039 .cindex "AUTH" "ACL for"
14040 This option defines the ACL that is run when an SMTP AUTH command is
14041 received. See chapter &<<CHAPACL>>& for further details.
14042
14043 .option acl_smtp_connect main string&!! unset
14044 .cindex "&ACL;" "on SMTP connection"
14045 This option defines the ACL that is run when an SMTP connection is received.
14046 See chapter &<<CHAPACL>>& for further details.
14047
14048 .option acl_smtp_data main string&!! unset
14049 .cindex "DATA" "ACL for"
14050 This option defines the ACL that is run after an SMTP DATA command has been
14051 processed and the message itself has been received, but before the final
14052 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14053
14054 .option acl_smtp_data_prdr main string&!! accept
14055 .cindex "PRDR" "ACL for"
14056 .cindex "DATA" "PRDR ACL for"
14057 .cindex "&ACL;" "PRDR-related"
14058 .cindex "&ACL;" "per-user data processing"
14059 This option defines the ACL that,
14060 if the PRDR feature has been negotiated,
14061 is run for each recipient after an SMTP DATA command has been
14062 processed and the message itself has been received, but before the
14063 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14064
14065 .option acl_smtp_dkim main string&!! unset
14066 .cindex DKIM "ACL for"
14067 This option defines the ACL that is run for each DKIM signature
14068 (by default, or as specified in the dkim_verify_signers option)
14069 of a received message.
14070 See chapter &<<CHAPdkim>>& for further details.
14071
14072 .option acl_smtp_etrn main string&!! unset
14073 .cindex "ETRN" "ACL for"
14074 This option defines the ACL that is run when an SMTP ETRN command is
14075 received. See chapter &<<CHAPACL>>& for further details.
14076
14077 .option acl_smtp_expn main string&!! unset
14078 .cindex "EXPN" "ACL for"
14079 This option defines the ACL that is run when an SMTP EXPN command is
14080 received. See chapter &<<CHAPACL>>& for further details.
14081
14082 .option acl_smtp_helo main string&!! unset
14083 .cindex "EHLO" "ACL for"
14084 .cindex "HELO" "ACL for"
14085 This option defines the ACL that is run when an SMTP EHLO or HELO
14086 command is received. See chapter &<<CHAPACL>>& for further details.
14087
14088
14089 .option acl_smtp_mail main string&!! unset
14090 .cindex "MAIL" "ACL for"
14091 This option defines the ACL that is run when an SMTP MAIL command is
14092 received. See chapter &<<CHAPACL>>& for further details.
14093
14094 .option acl_smtp_mailauth main string&!! unset
14095 .cindex "AUTH" "on MAIL command"
14096 This option defines the ACL that is run when there is an AUTH parameter on
14097 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14098 &<<CHAPSMTPAUTH>>& for details of authentication.
14099
14100 .option acl_smtp_mime main string&!! unset
14101 .cindex "MIME content scanning" "ACL for"
14102 This option is available when Exim is built with the content-scanning
14103 extension. It defines the ACL that is run for each MIME part in a message. See
14104 section &<<SECTscanmimepart>>& for details.
14105
14106 .option acl_smtp_notquit main string&!! unset
14107 .cindex "not-QUIT, ACL for"
14108 This option defines the ACL that is run when an SMTP session
14109 ends without a QUIT command being received.
14110 See chapter &<<CHAPACL>>& for further details.
14111
14112 .option acl_smtp_predata main string&!! unset
14113 This option defines the ACL that is run when an SMTP DATA command is
14114 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14115 further details.
14116
14117 .option acl_smtp_quit main string&!! unset
14118 .cindex "QUIT, ACL for"
14119 This option defines the ACL that is run when an SMTP QUIT command is
14120 received. See chapter &<<CHAPACL>>& for further details.
14121
14122 .option acl_smtp_rcpt main string&!! unset
14123 .cindex "RCPT" "ACL for"
14124 This option defines the ACL that is run when an SMTP RCPT command is
14125 received. See chapter &<<CHAPACL>>& for further details.
14126
14127 .option acl_smtp_starttls main string&!! unset
14128 .cindex "STARTTLS, ACL for"
14129 This option defines the ACL that is run when an SMTP STARTTLS command is
14130 received. See chapter &<<CHAPACL>>& for further details.
14131
14132 .option acl_smtp_vrfy main string&!! unset
14133 .cindex "VRFY" "ACL for"
14134 This option defines the ACL that is run when an SMTP VRFY command is
14135 received. See chapter &<<CHAPACL>>& for further details.
14136
14137 .option add_environment main "string list" empty
14138 .cindex "environment" "set values"
14139 This option allows to set individual environment variables that the
14140 currently linked libraries and programs in child processes use.
14141 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14142
14143 .option admin_groups main "string list&!!" unset
14144 .cindex "admin user"
14145 This option is expanded just once, at the start of Exim's processing. If the
14146 current group or any of the supplementary groups of an Exim caller is in this
14147 colon-separated list, the caller has admin privileges. If all your system
14148 programmers are in a specific group, for example, you can give them all Exim
14149 admin privileges by putting that group in &%admin_groups%&. However, this does
14150 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14151 To permit this, you have to add individuals to the Exim group.
14152
14153 .option allow_domain_literals main boolean false
14154 .cindex "domain literal"
14155 If this option is set, the RFC 2822 domain literal format is permitted in
14156 email addresses. The option is not set by default, because the domain literal
14157 format is not normally required these days, and few people know about it. It
14158 has, however, been exploited by mail abusers.
14159
14160 Unfortunately, it seems that some DNS black list maintainers are using this
14161 format to report black listing to postmasters. If you want to accept messages
14162 addressed to your hosts by IP address, you need to set
14163 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14164 domains (defined in the named domain list &%local_domains%& in the default
14165 configuration). This &"magic string"& matches the domain literal form of all
14166 the local host's IP addresses.
14167
14168
14169 .option allow_mx_to_ip main boolean false
14170 .cindex "MX record" "pointing to IP address"
14171 It appears that more and more DNS zone administrators are breaking the rules
14172 and putting domain names that look like IP addresses on the right hand side of
14173 MX records. Exim follows the rules and rejects this, giving an error message
14174 that explains the misconfiguration. However, some other MTAs support this
14175 practice, so to avoid &"Why can't Exim do this?"& complaints,
14176 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14177 recommended, except when you have no other choice.
14178
14179 .option allow_utf8_domains main boolean false
14180 .cindex "domain" "UTF-8 characters in"
14181 .cindex "UTF-8" "in domain name"
14182 Lots of discussion is going on about internationalized domain names. One
14183 camp is strongly in favour of just using UTF-8 characters, and it seems
14184 that at least two other MTAs permit this. This option allows Exim users to
14185 experiment if they wish.
14186
14187 If it is set true, Exim's domain parsing function allows valid
14188 UTF-8 multicharacters to appear in domain name components, in addition to
14189 letters, digits, and hyphens. However, just setting this option is not
14190 enough; if you want to look up these domain names in the DNS, you must also
14191 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14192 suitable setting is:
14193 .code
14194 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14195   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14196 .endd
14197 Alternatively, you can just disable this feature by setting
14198 .code
14199 dns_check_names_pattern =
14200 .endd
14201 That is, set the option to an empty string so that no check is done.
14202
14203
14204 .option auth_advertise_hosts main "host list&!!" *
14205 .cindex "authentication" "advertising"
14206 .cindex "AUTH" "advertising"
14207 If any server authentication mechanisms are configured, Exim advertises them in
14208 response to an EHLO command only if the calling host matches this list.
14209 Otherwise, Exim does not advertise AUTH.
14210 Exim does not accept AUTH commands from clients to which it has not
14211 advertised the availability of AUTH. The advertising of individual
14212 authentication mechanisms can be controlled by the use of the
14213 &%server_advertise_condition%& generic authenticator option on the individual
14214 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14215
14216 Certain mail clients (for example, Netscape) require the user to provide a name
14217 and password for authentication if AUTH is advertised, even though it may
14218 not be needed (the host may accept messages from hosts on its local LAN without
14219 authentication, for example). The &%auth_advertise_hosts%& option can be used
14220 to make these clients more friendly by excluding them from the set of hosts to
14221 which Exim advertises AUTH.
14222
14223 .cindex "AUTH" "advertising when encrypted"
14224 If you want to advertise the availability of AUTH only when the connection
14225 is encrypted using TLS, you can make use of the fact that the value of this
14226 option is expanded, with a setting like this:
14227 .code
14228 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14229 .endd
14230 .vindex "&$tls_in_cipher$&"
14231 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14232 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14233 expansion is *, which matches all hosts.
14234
14235
14236 .option auto_thaw main time 0s
14237 .cindex "thawing messages"
14238 .cindex "unfreezing messages"
14239 If this option is set to a time greater than zero, a queue runner will try a
14240 new delivery attempt on any frozen message, other than a bounce message, if
14241 this much time has passed since it was frozen. This may result in the message
14242 being re-frozen if nothing has changed since the last attempt. It is a way of
14243 saying &"keep on trying, even though there are big problems"&.
14244
14245 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14246 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14247 thought to be very useful any more, and its use should probably be avoided.
14248
14249
14250 .option av_scanner main string "see below"
14251 This option is available if Exim is built with the content-scanning extension.
14252 It specifies which anti-virus scanner to use. The default value is:
14253 .code
14254 sophie:/var/run/sophie
14255 .endd
14256 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14257 before use. See section &<<SECTscanvirus>>& for further details.
14258
14259
14260 .option bi_command main string unset
14261 .oindex "&%-bi%&"
14262 This option supplies the name of a command that is run when Exim is called with
14263 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14264 just the command name, it is not a complete command line. If an argument is
14265 required, it must come from the &%-oA%& command line option.
14266
14267
14268 .option bounce_message_file main string unset
14269 .cindex "bounce message" "customizing"
14270 .cindex "customizing" "bounce message"
14271 This option defines a template file containing paragraphs of text to be used
14272 for constructing bounce messages.  Details of the file's contents are given in
14273 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14274
14275
14276 .option bounce_message_text main string unset
14277 When this option is set, its contents are included in the default bounce
14278 message immediately after &"This message was created automatically by mail
14279 delivery software."& It is not used if &%bounce_message_file%& is set.
14280
14281 .option bounce_return_body main boolean true
14282 .cindex "bounce message" "including body"
14283 This option controls whether the body of an incoming message is included in a
14284 bounce message when &%bounce_return_message%& is true. The default setting
14285 causes the entire message, both header and body, to be returned (subject to the
14286 value of &%bounce_return_size_limit%&). If this option is false, only the
14287 message header is included. In the case of a non-SMTP message containing an
14288 error that is detected during reception, only those header lines preceding the
14289 point at which the error was detected are returned.
14290 .cindex "bounce message" "including original"
14291
14292 .option bounce_return_linesize_limit main integer 998
14293 .cindex "size" "of bounce lines, limit"
14294 .cindex "bounce message" "line length limit"
14295 .cindex "limit" "bounce message line length"
14296 This option sets a limit in bytes on the line length of messages
14297 that are returned to senders due to delivery problems,
14298 when &%bounce_return_message%& is true.
14299 The default value corresponds to RFC limits.
14300 If the message being returned has lines longer than this value it is
14301 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14302
14303 The option also applies to bounces returned when an error is detected
14304 during reception of a message.
14305 In this case lines from the original are truncated.
14306
14307 The option does not apply to messages generated by an &(autoreply)& transport.
14308
14309
14310 .option bounce_return_message main boolean true
14311 If this option is set false, none of the original message is included in
14312 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14313 &%bounce_return_body%&.
14314
14315
14316 .option bounce_return_size_limit main integer 100K
14317 .cindex "size" "of bounce, limit"
14318 .cindex "bounce message" "size limit"
14319 .cindex "limit" "bounce message size"
14320 This option sets a limit in bytes on the size of messages that are returned to
14321 senders as part of bounce messages when &%bounce_return_message%& is true. The
14322 limit should be less than the value of the global &%message_size_limit%& and of
14323 any &%message_size_limit%& settings on transports, to allow for the bounce text
14324 that Exim generates. If this option is set to zero there is no limit.
14325
14326 When the body of any message that is to be included in a bounce message is
14327 greater than the limit, it is truncated, and a comment pointing this out is
14328 added at the top. The actual cutoff may be greater than the value given, owing
14329 to the use of buffering for transferring the message in chunks (typically 8K in
14330 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14331 messages.
14332
14333 .option bounce_sender_authentication main string unset
14334 .cindex "bounce message" "sender authentication"
14335 .cindex "authentication" "bounce message"
14336 .cindex "AUTH" "on bounce message"
14337 This option provides an authenticated sender address that is sent with any
14338 bounce messages generated by Exim that are sent over an authenticated SMTP
14339 connection. A typical setting might be:
14340 .code
14341 bounce_sender_authentication = mailer-daemon@my.domain.example
14342 .endd
14343 which would cause bounce messages to be sent using the SMTP command:
14344 .code
14345 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14346 .endd
14347 The value of &%bounce_sender_authentication%& must always be a complete email
14348 address.
14349
14350 .option callout_domain_negative_expire main time 3h
14351 .cindex "caching" "callout timeouts"
14352 .cindex "callout" "caching timeouts"
14353 This option specifies the expiry time for negative callout cache data for a
14354 domain. See section &<<SECTcallver>>& for details of callout verification, and
14355 section &<<SECTcallvercache>>& for details of the caching.
14356
14357
14358 .option callout_domain_positive_expire main time 7d
14359 This option specifies the expiry time for positive callout cache data for a
14360 domain. See section &<<SECTcallver>>& for details of callout verification, and
14361 section &<<SECTcallvercache>>& for details of the caching.
14362
14363
14364 .option callout_negative_expire main time 2h
14365 This option specifies the expiry time for negative callout cache data for an
14366 address. See section &<<SECTcallver>>& for details of callout verification, and
14367 section &<<SECTcallvercache>>& for details of the caching.
14368
14369
14370 .option callout_positive_expire main time 24h
14371 This option specifies the expiry time for positive callout cache data for an
14372 address. See section &<<SECTcallver>>& for details of callout verification, and
14373 section &<<SECTcallvercache>>& for details of the caching.
14374
14375
14376 .option callout_random_local_part main string&!! "see below"
14377 This option defines the &"random"& local part that can be used as part of
14378 callout verification. The default value is
14379 .code
14380 $primary_hostname-$tod_epoch-testing
14381 .endd
14382 See section &<<CALLaddparcall>>& for details of how this value is used.
14383
14384
14385 .option check_log_inodes main integer 100
14386 See &%check_spool_space%& below.
14387
14388
14389 .option check_log_space main integer 10M
14390 See &%check_spool_space%& below.
14391
14392 .oindex "&%check_rfc2047_length%&"
14393 .cindex "RFC 2047" "disabling length check"
14394 .option check_rfc2047_length main boolean true
14395 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14396 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14397 word; strings to be encoded that exceed this length are supposed to use
14398 multiple encoded words. By default, Exim does not recognize encoded words that
14399 exceed the maximum length. However, it seems that some software, in violation
14400 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14401 set false, Exim recognizes encoded words of any length.
14402
14403
14404 .option check_spool_inodes main integer 100
14405 See &%check_spool_space%& below.
14406
14407
14408 .option check_spool_space main integer 10M
14409 .cindex "checking disk space"
14410 .cindex "disk space, checking"
14411 .cindex "spool directory" "checking space"
14412 The four &%check_...%& options allow for checking of disk resources before a
14413 message is accepted.
14414
14415 .vindex "&$log_inodes$&"
14416 .vindex "&$log_space$&"
14417 .vindex "&$spool_inodes$&"
14418 .vindex "&$spool_space$&"
14419 When any of these options are nonzero, they apply to all incoming messages. If you
14420 want to apply different checks to different kinds of message, you can do so by
14421 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14422 &$spool_space$& in an ACL with appropriate additional conditions.
14423
14424
14425 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14426 either value is greater than zero, for example:
14427 .code
14428 check_spool_space = 100M
14429 check_spool_inodes = 100
14430 .endd
14431 The spool partition is the one that contains the directory defined by
14432 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14433 transit.
14434
14435 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14436 files are written if either is greater than zero. These should be set only if
14437 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14438
14439 If there is less space or fewer inodes than requested, Exim refuses to accept
14440 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14441 error response to the MAIL command. If ESMTP is in use and there was a
14442 SIZE parameter on the MAIL command, its value is added to the
14443 &%check_spool_space%& value, and the check is performed even if
14444 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14445
14446 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14447 number of kilobytes (though specified in bytes).
14448 If a non-multiple of 1024 is specified, it is rounded up.
14449
14450 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14451 failure a message is written to stderr and Exim exits with a non-zero code, as
14452 it obviously cannot send an error message of any kind.
14453
14454 There is a slight performance penalty for these checks.
14455 Versions of Exim preceding 4.88 had these disabled by default;
14456 high-rate installations confident they will never run out of resources
14457 may wish to deliberately disable them.
14458
14459 .option chunking_advertise_hosts main "host list&!!" *
14460 .cindex CHUNKING advertisement
14461 .cindex "RFC 3030" "CHUNKING"
14462 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14463 these hosts.
14464 Hosts may use the BDAT command as an alternate to DATA.
14465
14466 .new
14467 .option commandline_checks_require_admin main boolean &`false`&
14468 .cindex "restricting access to features"
14469 This option restricts various basic checking features to require an
14470 administrative user.
14471 This affects most of the &%-b*%& options, such as &%-be%&.
14472 .wen
14473
14474 .option debug_store main boolean &`false`&
14475 .cindex debugging "memory corruption"
14476 .cindex memory debugging
14477 This option, when true, enables extra checking in Exim's internal memory
14478 management.  For use when a memory corruption issue is being investigated,
14479 it should normally be left as default.
14480
14481 .option daemon_smtp_ports main string &`smtp`&
14482 .cindex "port" "for daemon"
14483 .cindex "TCP/IP" "setting listening ports"
14484 This option specifies one or more default SMTP ports on which the Exim daemon
14485 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14486 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14487
14488 .option daemon_startup_retries main integer 9
14489 .cindex "daemon startup, retrying"
14490 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14491 the daemon at startup when it cannot immediately bind a listening socket
14492 (typically because the socket is already in use): &%daemon_startup_retries%&
14493 defines the number of retries after the first failure, and
14494 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14495
14496 .option daemon_startup_sleep main time 30s
14497 See &%daemon_startup_retries%&.
14498
14499 .option delay_warning main "time list" 24h
14500 .cindex "warning of delay"
14501 .cindex "delay warning, specifying"
14502 .cindex "queue" "delay warning"
14503 When a message is delayed, Exim sends a warning message to the sender at
14504 intervals specified by this option. The data is a colon-separated list of times
14505 after which to send warning messages. If the value of the option is an empty
14506 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14507 message has been on the queue for longer than the last time, the last interval
14508 between the times is used to compute subsequent warning times. For example,
14509 with
14510 .code
14511 delay_warning = 4h:8h:24h
14512 .endd
14513 the first message is sent after 4 hours, the second after 8 hours, and
14514 the third one after 24 hours. After that, messages are sent every 16 hours,
14515 because that is the interval between the last two times on the list. If you set
14516 just one time, it specifies the repeat interval. For example, with:
14517 .code
14518 delay_warning = 6h
14519 .endd
14520 messages are repeated every six hours. To stop warnings after a given time, set
14521 a very large time at the end of the list. For example:
14522 .code
14523 delay_warning = 2h:12h:99d
14524 .endd
14525 Note that the option is only evaluated at the time a delivery attempt fails,
14526 which depends on retry and queue-runner configuration.
14527 Typically retries will be configured more frequently than warning messages.
14528
14529 .option delay_warning_condition main string&!! "see below"
14530 .vindex "&$domain$&"
14531 The string is expanded at the time a warning message might be sent. If all the
14532 deferred addresses have the same domain, it is set in &$domain$& during the
14533 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14534 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14535 &"false"& (the comparison being done caselessly) then the warning message is
14536 not sent. The default is:
14537 .code
14538 delay_warning_condition = ${if or {\
14539   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14540   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14541   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14542   } {no}{yes}}
14543 .endd
14544 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14545 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14546 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14547 &"auto-replied"& in an &'Auto-Submitted:'& header.
14548
14549 .option deliver_drop_privilege main boolean false
14550 .cindex "unprivileged delivery"
14551 .cindex "delivery" "unprivileged"
14552 If this option is set true, Exim drops its root privilege at the start of a
14553 delivery process, and runs as the Exim user throughout. This severely restricts
14554 the kinds of local delivery that are possible, but is viable in certain types
14555 of configuration. There is a discussion about the use of root privilege in
14556 chapter &<<CHAPsecurity>>&.
14557
14558 .option deliver_queue_load_max main fixed-point unset
14559 .cindex "load average"
14560 .cindex "queue runner" "abandoning"
14561 When this option is set, a queue run is abandoned if the system load average
14562 becomes greater than the value of the option. The option has no effect on
14563 ancient operating systems on which Exim cannot determine the load average.
14564 See also &%queue_only_load%& and &%smtp_load_reserve%&.
14565
14566
14567 .option delivery_date_remove main boolean true
14568 .cindex "&'Delivery-date:'& header line"
14569 Exim's transports have an option for adding a &'Delivery-date:'& header to a
14570 message when it is delivered, in exactly the same way as &'Return-path:'& is
14571 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
14572 should not be present in incoming messages, and this option causes them to be
14573 removed at the time the message is received, to avoid any problems that might
14574 occur when a delivered message is subsequently sent on to some other recipient.
14575
14576 .option disable_fsync main boolean false
14577 .cindex "&[fsync()]&, disabling"
14578 This option is available only if Exim was built with the compile-time option
14579 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
14580 a runtime configuration generates an &"unknown option"& error. You should not
14581 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
14582 really, really, really understand what you are doing. &'No pre-compiled
14583 distributions of Exim should ever make this option available.'&
14584
14585 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
14586 updated files' data to be written to disc before continuing. Unexpected events
14587 such as crashes and power outages may cause data to be lost or scrambled.
14588 Here be Dragons. &*Beware.*&
14589
14590
14591 .option disable_ipv6 main boolean false
14592 .cindex "IPv6" "disabling"
14593 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
14594 activities take place. AAAA records are never looked up, and any IPv6 addresses
14595 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
14596 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14597 to handle IPv6 literal addresses.
14598
14599
14600 .option dkim_verify_signers main "domain list&!!" $dkim_signers
14601 .cindex DKIM "controlling calls to the ACL"
14602 This option gives a list of DKIM domains for which the DKIM ACL is run.
14603 It is expanded after the message is received; by default it runs
14604 the ACL once for each signature in the message.
14605 See chapter &<<CHAPdkim>>&.
14606
14607
14608 .option dns_again_means_nonexist main "domain list&!!" unset
14609 .cindex "DNS" "&""try again""& response; overriding"
14610 DNS lookups give a &"try again"& response for the DNS errors
14611 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
14612 keep trying to deliver a message, or to give repeated temporary errors to
14613 incoming mail. Sometimes the effect is caused by a badly set up name server and
14614 may persist for a long time. If a domain which exhibits this problem matches
14615 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
14616 This option should be used with care. You can make it apply to reverse lookups
14617 by a setting such as this:
14618 .code
14619 dns_again_means_nonexist = *.in-addr.arpa
14620 .endd
14621 This option applies to all DNS lookups that Exim does. It also applies when the
14622 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
14623 since these are most likely to be caused by DNS lookup problems. The
14624 &(dnslookup)& router has some options of its own for controlling what happens
14625 when lookups for MX or SRV records give temporary errors. These more specific
14626 options are applied after this global option.
14627
14628 .option dns_check_names_pattern main string "see below"
14629 .cindex "DNS" "pre-check of name syntax"
14630 When this option is set to a non-empty string, it causes Exim to check domain
14631 names for characters that are not allowed in host names before handing them to
14632 the DNS resolver, because some resolvers give temporary errors for names that
14633 contain unusual characters. If a domain name contains any unwanted characters,
14634 a &"not found"& result is forced, and the resolver is not called. The check is
14635 done by matching the domain name against a regular expression, which is the
14636 value of this option. The default pattern is
14637 .code
14638 dns_check_names_pattern = \
14639   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
14640 .endd
14641 which permits only letters, digits, slashes, and hyphens in components, but
14642 they must start and end with a letter or digit. Slashes are not, in fact,
14643 permitted in host names, but they are found in certain NS records (which can be
14644 accessed in Exim by using a &%dnsdb%& lookup). If you set
14645 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
14646 empty string.
14647
14648 .option dns_csa_search_limit main integer 5
14649 This option controls the depth of parental searching for CSA SRV records in the
14650 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
14651
14652 .option dns_csa_use_reverse main boolean true
14653 This option controls whether or not an IP address, given as a CSA domain, is
14654 reversed and looked up in the reverse DNS, as described in more detail in
14655 section &<<SECTverifyCSA>>&.
14656
14657
14658 .option dns_dnssec_ok main integer -1
14659 .cindex "DNS" "resolver options"
14660 .cindex "DNS" "DNSSEC"
14661 If this option is set to a non-negative number then Exim will initialise the
14662 DNS resolver library to either use or not use DNSSEC, overriding the system
14663 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
14664
14665 If the resolver library does not support DNSSEC then this option has no effect.
14666
14667
14668 .option dns_ipv4_lookup main "domain list&!!" unset
14669 .cindex "IPv6" "DNS lookup for AAAA records"
14670 .cindex "DNS" "IPv6 lookup for AAAA records"
14671 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
14672 looks for IPv6 address records (AAAA records) as well as IPv4 address records
14673 (A records) when trying to find IP addresses for hosts, unless the host's
14674 domain matches this list.
14675
14676 This is a fudge to help with name servers that give big delays or otherwise do
14677 not work for the AAAA record type. In due course, when the world's name
14678 servers have all been upgraded, there should be no need for this option.
14679
14680
14681 .option dns_retrans main time 0s
14682 .cindex "DNS" "resolver options"
14683 .cindex timeout "dns lookup"
14684 .cindex "DNS" timeout
14685 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
14686 retransmission and retry parameters for DNS lookups. Values of zero (the
14687 defaults) leave the system default settings unchanged. The first value is the
14688 time between retries, and the second is the number of retries. It isn't
14689 totally clear exactly how these settings affect the total time a DNS lookup may
14690 take. I haven't found any documentation about timeouts on DNS lookups; these
14691 parameter values are available in the external resolver interface structure,
14692 but nowhere does it seem to describe how they are used or what you might want
14693 to set in them.
14694 See also the &%slow_lookup_log%& option.
14695
14696
14697 .option dns_retry main integer 0
14698 See &%dns_retrans%& above.
14699
14700
14701 .option dns_trust_aa main "domain list&!!" unset
14702 .cindex "DNS" "resolver options"
14703 .cindex "DNS" "DNSSEC"
14704 If this option is set then lookup results marked with the AA bit
14705 (Authoritative Answer) are trusted the same way as if they were
14706 DNSSEC-verified. The authority section's name of the answer must
14707 match with this expanded domain list.
14708
14709 Use this option only if you talk directly to a resolver that is
14710 authoritative for some zones and does not set the AD (Authentic Data)
14711 bit in the answer. Some DNS servers may have an configuration option to
14712 mark the answers from their own zones as verified (they set the AD bit).
14713 Others do not have this option. It is considered as poor practice using
14714 a resolver that is an authoritative server for some zones.
14715
14716 Use this option only if you really have to (e.g. if you want
14717 to use DANE for remote delivery to a server that is listed in the DNS
14718 zones that your resolver is authoritative for).
14719
14720 If the DNS answer packet has the AA bit set and contains resource record
14721 in the answer section, the name of the first NS record appearing in the
14722 authority section is compared against the list. If the answer packet is
14723 authoritative but the answer section is empty, the name of the first SOA
14724 record in the authoritative section is used instead.
14725
14726 .cindex "DNS" "resolver options"
14727 .option dns_use_edns0 main integer -1
14728 .cindex "DNS" "resolver options"
14729 .cindex "DNS" "EDNS0"
14730 .cindex "DNS" "OpenBSD
14731 If this option is set to a non-negative number then Exim will initialise the
14732 DNS resolver library to either use or not use EDNS0 extensions, overriding
14733 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
14734 on.
14735
14736 If the resolver library does not support EDNS0 then this option has no effect.
14737
14738 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
14739 means that DNSSEC will not work with Exim on that platform either, unless Exim
14740 is linked against an alternative DNS client library.
14741
14742
14743 .option drop_cr main boolean false
14744 This is an obsolete option that is now a no-op. It used to affect the way Exim
14745 handled CR and LF characters in incoming messages. What happens now is
14746 described in section &<<SECTlineendings>>&.
14747
14748 .option dsn_advertise_hosts main "host list&!!" unset
14749 .cindex "bounce messages" "success"
14750 .cindex "DSN" "success"
14751 .cindex "Delivery Status Notification" "success"
14752 DSN extensions (RFC3461) will be advertised in the EHLO message to,
14753 and accepted from, these hosts.
14754 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
14755 and RET and ORCPT options on MAIL FROM commands.
14756 A NOTIFY=SUCCESS option requests success-DSN messages.
14757 A NOTIFY= option with no argument requests that no delay or failure DSNs
14758 are sent.
14759
14760 .option dsn_from main "string&!!" "see below"
14761 .cindex "&'From:'& header line" "in bounces"
14762 .cindex "bounce messages" "&'From:'& line, specifying"
14763 This option can be used to vary the contents of &'From:'& header lines in
14764 bounces and other automatically generated messages (&"Delivery Status
14765 Notifications"& &-- hence the name of the option). The default setting is:
14766 .code
14767 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
14768 .endd
14769 The value is expanded every time it is needed. If the expansion fails, a
14770 panic is logged, and the default value is used.
14771
14772 .option envelope_to_remove main boolean true
14773 .cindex "&'Envelope-to:'& header line"
14774 Exim's transports have an option for adding an &'Envelope-to:'& header to a
14775 message when it is delivered, in exactly the same way as &'Return-path:'& is
14776 handled. &'Envelope-to:'& records the original recipient address from the
14777 message's envelope that caused the delivery to happen. Such headers should not
14778 be present in incoming messages, and this option causes them to be removed at
14779 the time the message is received, to avoid any problems that might occur when a
14780 delivered message is subsequently sent on to some other recipient.
14781
14782
14783 .option errors_copy main "string list&!!" unset
14784 .cindex "bounce message" "copy to other address"
14785 .cindex "copy of bounce message"
14786 Setting this option causes Exim to send bcc copies of bounce messages that it
14787 generates to other addresses. &*Note*&: This does not apply to bounce messages
14788 coming from elsewhere. The value of the option is a colon-separated list of
14789 items. Each item consists of a pattern, terminated by white space, followed by
14790 a comma-separated list of email addresses. If a pattern contains spaces, it
14791 must be enclosed in double quotes.
14792
14793 Each pattern is processed in the same way as a single item in an address list
14794 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
14795 the bounce message, the message is copied to the addresses on the list. The
14796 items are scanned in order, and once a matching one is found, no further items
14797 are examined. For example:
14798 .code
14799 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
14800               rqps@mydomain   hostmaster@mydomain.example,\
14801                               postmaster@mydomain.example
14802 .endd
14803 .vindex "&$domain$&"
14804 .vindex "&$local_part$&"
14805 The address list is expanded before use. The expansion variables &$local_part$&
14806 and &$domain$& are set from the original recipient of the error message, and if
14807 there was any wildcard matching in the pattern, the expansion
14808 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
14809 variables &$0$&, &$1$&, etc. are set in the normal way.
14810
14811
14812 .option errors_reply_to main string unset
14813 .cindex "bounce message" "&'Reply-to:'& in"
14814 By default, Exim's bounce and delivery warning messages contain the header line
14815 .display
14816 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
14817 .endd
14818 .oindex &%quota_warn_message%&
14819 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
14820 A warning message that is generated by the &%quota_warn_message%& option in an
14821 &(appendfile)& transport may contain its own &'From:'& header line that
14822 overrides the default.
14823
14824 Experience shows that people reply to bounce messages. If the
14825 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
14826 and warning messages. For example:
14827 .code
14828 errors_reply_to = postmaster@my.domain.example
14829 .endd
14830 The value of the option is not expanded. It must specify a valid RFC 2822
14831 address. However, if a warning message that is generated by the
14832 &%quota_warn_message%& option in an &(appendfile)& transport contain its
14833 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
14834 not used.
14835
14836
14837 .option event_action main string&!! unset
14838 .cindex events
14839 This option declares a string to be expanded for Exim's events mechanism.
14840 For details see chapter &<<CHAPevents>>&.
14841
14842
14843 .option exim_group main string "compile-time configured"
14844 .cindex "gid (group id)" "Exim's own"
14845 .cindex "Exim group"
14846 This option changes the gid under which Exim runs when it gives up root
14847 privilege. The default value is compiled into the binary. The value of this
14848 option is used only when &%exim_user%& is also set. Unless it consists entirely
14849 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
14850 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
14851 security issues.
14852
14853
14854 .option exim_path main string "see below"
14855 .cindex "Exim binary, path name"
14856 This option specifies the path name of the Exim binary, which is used when Exim
14857 needs to re-exec itself. The default is set up to point to the file &'exim'& in
14858 the directory configured at compile time by the BIN_DIRECTORY setting. It
14859 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
14860 other place.
14861 &*Warning*&: Do not use a macro to define the value of this option, because
14862 you will break those Exim utilities that scan the configuration file to find
14863 where the binary is. (They then use the &%-bP%& option to extract option
14864 settings such as the value of &%spool_directory%&.)
14865
14866
14867 .option exim_user main string "compile-time configured"
14868 .cindex "uid (user id)" "Exim's own"
14869 .cindex "Exim user"
14870 This option changes the uid under which Exim runs when it gives up root
14871 privilege. The default value is compiled into the binary. Ownership of the run
14872 time configuration file and the use of the &%-C%& and &%-D%& command line
14873 options is checked against the values in the binary, not what is set here.
14874
14875 Unless it consists entirely of digits, the string is looked up using
14876 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
14877 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
14878 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
14879
14880
14881 .option extra_local_interfaces main "string list" unset
14882 This option defines network interfaces that are to be considered local when
14883 routing, but which are not used for listening by the daemon. See section
14884 &<<SECTreclocipadd>>& for details.
14885
14886
14887 . Allow this long option name to split; give it unsplit as a fifth argument
14888 . for the automatic .oindex that is generated by .option.
14889
14890 .option "extract_addresses_remove_arguments" main boolean true &&&
14891          extract_addresses_remove_arguments
14892 .oindex "&%-t%&"
14893 .cindex "command line" "addresses with &%-t%&"
14894 .cindex "Sendmail compatibility" "&%-t%& option"
14895 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
14896 are present on the command line when the &%-t%& option is used to build an
14897 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
14898 line addresses are removed from the recipients list. This is also how Smail
14899 behaves. However, other Sendmail documentation (the O'Reilly book) states that
14900 command line addresses are added to those obtained from the header lines. When
14901 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
14902 argument headers. If it is set false, Exim adds rather than removes argument
14903 addresses.
14904
14905
14906 .option finduser_retries main integer 0
14907 .cindex "NIS, retrying user lookups"
14908 On systems running NIS or other schemes in which user and group information is
14909 distributed from a remote system, there can be times when &[getpwnam()]& and
14910 related functions fail, even when given valid data, because things time out.
14911 Unfortunately these failures cannot be distinguished from genuine &"not found"&
14912 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
14913 many extra times to find a user or a group, waiting for one second between
14914 retries.
14915
14916 .cindex "&_/etc/passwd_&" "multiple reading of"
14917 You should not set this option greater than zero if your user information is in
14918 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
14919 search the file multiple times for non-existent users, and also cause delay.
14920
14921
14922
14923 .option freeze_tell main "string list, comma separated" unset
14924 .cindex "freezing messages" "sending a message when freezing"
14925 On encountering certain errors, or when configured to do so in a system filter,
14926 ACL, or special router, Exim freezes a message. This means that no further
14927 delivery attempts take place until an administrator thaws the message, or the
14928 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
14929 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
14930 warning message whenever it freezes something, unless the message it is
14931 freezing is a locally-generated bounce message. (Without this exception there
14932 is the possibility of looping.) The warning message is sent to the addresses
14933 supplied as the comma-separated value of this option. If several of the
14934 message's addresses cause freezing, only a single message is sent. If the
14935 freezing was automatic, the reason(s) for freezing can be found in the message
14936 log. If you configure freezing in a filter or ACL, you must arrange for any
14937 logging that you require.
14938
14939
14940 .option gecos_name main string&!! unset
14941 .cindex "HP-UX"
14942 .cindex "&""gecos""& field, parsing"
14943 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
14944 password file to hold other information in addition to users' real names. Exim
14945 looks up this field for use when it is creating &'Sender:'& or &'From:'&
14946 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
14947 of the field are used unchanged, except that, if an ampersand is encountered,
14948 it is replaced by the user's login name with the first character forced to
14949 upper case, since this is a convention that is observed on many systems.
14950
14951 When these options are set, &%gecos_pattern%& is treated as a regular
14952 expression that is to be applied to the field (again with && replaced by the
14953 login name), and if it matches, &%gecos_name%& is expanded and used as the
14954 user's name.
14955
14956 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
14957 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
14958 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
14959 name terminates at the first comma, the following can be used:
14960 .code
14961 gecos_pattern = ([^,]*)
14962 gecos_name = $1
14963 .endd
14964
14965 .option gecos_pattern main string unset
14966 See &%gecos_name%& above.
14967
14968
14969 .option gnutls_compat_mode main boolean unset
14970 This option controls whether GnuTLS is used in compatibility mode in an Exim
14971 server. This reduces security slightly, but improves interworking with older
14972 implementations of TLS.
14973
14974
14975 option gnutls_allow_auto_pkcs11 main boolean unset
14976 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
14977 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
14978
14979 See
14980 &url(http://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
14981 for documentation.
14982
14983
14984
14985 .option headers_charset main string "see below"
14986 This option sets a default character set for translating from encoded MIME
14987 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
14988 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
14989 ultimate default is ISO-8859-1. For more details see the description of header
14990 insertions in section &<<SECTexpansionitems>>&.
14991
14992
14993
14994 .option header_maxsize main integer "see below"
14995 .cindex "header section" "maximum size of"
14996 .cindex "limit" "size of message header section"
14997 This option controls the overall maximum size of a message's header
14998 section. The default is the value of HEADER_MAXSIZE in
14999 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15000 sections are rejected.
15001
15002
15003 .option header_line_maxsize main integer 0
15004 .cindex "header lines" "maximum size of"
15005 .cindex "limit" "size of one header line"
15006 This option limits the length of any individual header line in a message, after
15007 all the continuations have been joined together. Messages with individual
15008 header lines that are longer than the limit are rejected. The default value of
15009 zero means &"no limit"&.
15010
15011
15012
15013
15014 .option helo_accept_junk_hosts main "host list&!!" unset
15015 .cindex "HELO" "accepting junk data"
15016 .cindex "EHLO" "accepting junk data"
15017 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15018 mail, and gives an error response for invalid data. Unfortunately, there are
15019 some SMTP clients that send syntactic junk. They can be accommodated by setting
15020 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15021 if you want to do semantic checking.
15022 See also &%helo_allow_chars%& for a way of extending the permitted character
15023 set.
15024
15025
15026 .option helo_allow_chars main string unset
15027 .cindex "HELO" "underscores in"
15028 .cindex "EHLO" "underscores in"
15029 .cindex "underscore in EHLO/HELO"
15030 This option can be set to a string of rogue characters that are permitted in
15031 all EHLO and HELO names in addition to the standard letters, digits,
15032 hyphens, and dots. If you really must allow underscores, you can set
15033 .code
15034 helo_allow_chars = _
15035 .endd
15036 Note that the value is one string, not a list.
15037
15038
15039 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15040 .cindex "HELO" "forcing reverse lookup"
15041 .cindex "EHLO" "forcing reverse lookup"
15042 If the domain given by a client in a HELO or EHLO command matches this
15043 list, a reverse lookup is done in order to establish the host's true name. The
15044 default forces a lookup if the client host gives the server's name or any of
15045 its IP addresses (in brackets), something that broken clients have been seen to
15046 do.
15047
15048
15049 .option helo_try_verify_hosts main "host list&!!" unset
15050 .cindex "HELO verifying" "optional"
15051 .cindex "EHLO" "verifying, optional"
15052 By default, Exim just checks the syntax of HELO and EHLO commands (see
15053 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15054 to do more extensive checking of the data supplied by these commands. The ACL
15055 condition &`verify = helo`& is provided to make this possible.
15056 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15057 to force the check to occur. From release 4.53 onwards, this is no longer
15058 necessary. If the check has not been done before &`verify = helo`& is
15059 encountered, it is done at that time. Consequently, this option is obsolete.
15060 Its specification is retained here for backwards compatibility.
15061
15062 When an EHLO or HELO command is received, if the calling host matches
15063 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15064 EHLO command either:
15065
15066 .ilist
15067 is an IP literal matching the calling address of the host, or
15068 .next
15069 .cindex "DNS" "reverse lookup"
15070 .cindex "reverse DNS lookup"
15071 matches the host name that Exim obtains by doing a reverse lookup of the
15072 calling host address, or
15073 .next
15074 when looked up in DNS yields the calling host address.
15075 .endlist
15076
15077 However, the EHLO or HELO command is not rejected if any of the checks
15078 fail. Processing continues, but the result of the check is remembered, and can
15079 be detected later in an ACL by the &`verify = helo`& condition.
15080
15081 If DNS was used for successful verification, the variable
15082 .cindex "DNS" "DNSSEC"
15083 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15084
15085 .option helo_verify_hosts main "host list&!!" unset
15086 .cindex "HELO verifying" "mandatory"
15087 .cindex "EHLO" "verifying, mandatory"
15088 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15089 backwards compatibility. For hosts that match this option, Exim checks the host
15090 name given in the HELO or EHLO in the same way as for
15091 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15092 rejected with a 550 error, and entries are written to the main and reject logs.
15093 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15094 error.
15095
15096 .option hold_domains main "domain list&!!" unset
15097 .cindex "domain" "delaying delivery"
15098 .cindex "delivery" "delaying certain domains"
15099 This option allows mail for particular domains to be held on the queue
15100 manually. The option is overridden if a message delivery is forced with the
15101 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15102 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15103 item in &%hold_domains%&, no routing or delivery for that address is done, and
15104 it is deferred every time the message is looked at.
15105
15106 This option is intended as a temporary operational measure for delaying the
15107 delivery of mail while some problem is being sorted out, or some new
15108 configuration tested. If you just want to delay the processing of some
15109 domains until a queue run occurs, you should use &%queue_domains%& or
15110 &%queue_smtp_domains%&, not &%hold_domains%&.
15111
15112 A setting of &%hold_domains%& does not override Exim's code for removing
15113 messages from the queue if they have been there longer than the longest retry
15114 time in any retry rule. If you want to hold messages for longer than the normal
15115 retry times, insert a dummy retry rule with a long retry time.
15116
15117
15118 .option host_lookup main "host list&!!" unset
15119 .cindex "host name" "lookup, forcing"
15120 Exim does not look up the name of a calling host from its IP address unless it
15121 is required to compare against some host list, or the host matches
15122 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15123 option (which normally contains IP addresses rather than host names). The
15124 default configuration file contains
15125 .code
15126 host_lookup = *
15127 .endd
15128 which causes a lookup to happen for all hosts. If the expense of these lookups
15129 is felt to be too great, the setting can be changed or removed.
15130
15131 After a successful reverse lookup, Exim does a forward lookup on the name it
15132 has obtained, to verify that it yields the IP address that it started with. If
15133 this check fails, Exim behaves as if the name lookup failed.
15134
15135 .vindex "&$host_lookup_failed$&"
15136 .vindex "&$sender_host_name$&"
15137 After any kind of failure, the host name (in &$sender_host_name$&) remains
15138 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15139 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15140 &`verify = reverse_host_lookup`& in ACLs.
15141
15142
15143 .option host_lookup_order main "string list" &`bydns:byaddr`&
15144 This option specifies the order of different lookup methods when Exim is trying
15145 to find a host name from an IP address. The default is to do a DNS lookup
15146 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15147 if that fails. You can change the order of these lookups, or omit one entirely,
15148 if you want.
15149
15150 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15151 multiple PTR records in the DNS and the IP address is not listed in
15152 &_/etc/hosts_&. Different operating systems give different results in this
15153 case. That is why the default tries a DNS lookup first.
15154
15155
15156
15157 .option host_reject_connection main "host list&!!" unset
15158 .cindex "host" "rejecting connections from"
15159 If this option is set, incoming SMTP calls from the hosts listed are rejected
15160 as soon as the connection is made.
15161 This option is obsolete, and retained only for backward compatibility, because
15162 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15163 connections immediately.
15164
15165 The ability to give an immediate rejection (either by this option or using an
15166 ACL) is provided for use in unusual cases. Many hosts will just try again,
15167 sometimes without much delay. Normally, it is better to use an ACL to reject
15168 incoming messages at a later stage, such as after RCPT commands. See
15169 chapter &<<CHAPACL>>&.
15170
15171
15172 .option hosts_connection_nolog main "host list&!!" unset
15173 .cindex "host" "not logging connections from"
15174 This option defines a list of hosts for which connection logging does not
15175 happen, even though the &%smtp_connection%& log selector is set. For example,
15176 you might want not to log SMTP connections from local processes, or from
15177 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15178 the daemon; you should therefore strive to restrict its value to a short inline
15179 list of IP addresses and networks. To disable logging SMTP connections from
15180 local processes, you must create a host list with an empty item. For example:
15181 .code
15182 hosts_connection_nolog = :
15183 .endd
15184 If the &%smtp_connection%& log selector is not set, this option has no effect.
15185
15186
15187
15188 .option hosts_proxy main "host list&!!" unset
15189 .cindex proxy "proxy protocol"
15190 This option enables use of Proxy Protocol proxies for incoming
15191 connections.  For details see section &<<SECTproxyInbound>>&.
15192
15193
15194 .option hosts_treat_as_local main "domain list&!!" unset
15195 .cindex "local host" "domains treated as"
15196 .cindex "host" "treated as local"
15197 If this option is set, any host names that match the domain list are treated as
15198 if they were the local host when Exim is scanning host lists obtained from MX
15199 records
15200 or other sources. Note that the value of this option is a domain list, not a
15201 host list, because it is always used to check host names, not IP addresses.
15202
15203 This option also applies when Exim is matching the special items
15204 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15205 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15206 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15207 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15208 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15209 interfaces and recognizing the local host.
15210
15211
15212 .option ibase_servers main "string list" unset
15213 .cindex "InterBase" "server list"
15214 This option provides a list of InterBase servers and associated connection data,
15215 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15216 The option is available only if Exim has been built with InterBase support.
15217
15218
15219
15220 .option ignore_bounce_errors_after main time 10w
15221 .cindex "bounce message" "discarding"
15222 .cindex "discarding bounce message"
15223 This option affects the processing of bounce messages that cannot be delivered,
15224 that is, those that suffer a permanent delivery failure. (Bounce messages that
15225 suffer temporary delivery failures are of course retried in the usual way.)
15226
15227 After a permanent delivery failure, bounce messages are frozen,
15228 because there is no sender to whom they can be returned. When a frozen bounce
15229 message has been on the queue for more than the given time, it is unfrozen at
15230 the next queue run, and a further delivery is attempted. If delivery fails
15231 again, the bounce message is discarded. This makes it possible to keep failed
15232 bounce messages around for a shorter time than the normal maximum retry time
15233 for frozen messages. For example,
15234 .code
15235 ignore_bounce_errors_after = 12h
15236 .endd
15237 retries failed bounce message deliveries after 12 hours, discarding any further
15238 failures. If the value of this option is set to a zero time period, bounce
15239 failures are discarded immediately. Setting a very long time (as in the default
15240 value) has the effect of disabling this option. For ways of automatically
15241 dealing with other kinds of frozen message, see &%auto_thaw%& and
15242 &%timeout_frozen_after%&.
15243
15244
15245 .option ignore_fromline_hosts main "host list&!!" unset
15246 .cindex "&""From""& line"
15247 .cindex "UUCP" "&""From""& line"
15248 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15249 the headers of a message. By default this is treated as the start of the
15250 message's body, which means that any following headers are not recognized as
15251 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15252 match those hosts that insist on sending it. If the sender is actually a local
15253 process rather than a remote host, and is using &%-bs%& to inject the messages,
15254 &%ignore_fromline_local%& must be set to achieve this effect.
15255
15256
15257 .option ignore_fromline_local main boolean false
15258 See &%ignore_fromline_hosts%& above.
15259
15260 .option keep_environment main "string list" unset
15261 .cindex "environment" "values from"
15262 This option contains a string list of environment variables to keep.
15263 You have to trust these variables or you have to be sure that
15264 these variables do not impose any security risk. Keep in mind that
15265 during the startup phase Exim is running with an effective UID 0 in most
15266 installations. As the default value is an empty list, the default
15267 environment for using libraries, running embedded Perl code, or running
15268 external binaries is empty, and does not not even contain PATH or HOME.
15269
15270 Actually the list is interpreted as a list of patterns
15271 (&<<SECTlistexpand>>&), except that it is not expanded first.
15272
15273 WARNING: Macro substitution is still done first, so having a macro
15274 FOO and having FOO_HOME in your &%keep_environment%& option may have
15275 unexpected results. You may work around this using a regular expression
15276 that does not match the macro name: ^[F]OO_HOME$.
15277
15278 Current versions of Exim issue a warning during startup if you do not mention
15279 &%keep_environment%& in your runtime configuration file and if your
15280 current environment is not empty. Future versions may not issue that warning
15281 anymore.
15282
15283 See the &%add_environment%& main config option for a way to set
15284 environment variables to a fixed value.  The environment for &(pipe)&
15285 transports is handled separately, see section &<<SECTpipeenv>>& for
15286 details.
15287
15288
15289 .option keep_malformed main time 4d
15290 This option specifies the length of time to keep messages whose spool files
15291 have been corrupted in some way. This should, of course, never happen. At the
15292 next attempt to deliver such a message, it gets removed. The incident is
15293 logged.
15294
15295
15296 .option ldap_ca_cert_dir main string unset
15297 .cindex "LDAP", "TLS CA certificate directory"
15298 .cindex certificate "directory for LDAP"
15299 This option indicates which directory contains CA certificates for verifying
15300 a TLS certificate presented by an LDAP server.
15301 While Exim does not provide a default value, your SSL library may.
15302 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15303 and constrained to be a directory.
15304
15305
15306 .option ldap_ca_cert_file main string unset
15307 .cindex "LDAP", "TLS CA certificate file"
15308 .cindex certificate "file for LDAP"
15309 This option indicates which file contains CA certificates for verifying
15310 a TLS certificate presented by an LDAP server.
15311 While Exim does not provide a default value, your SSL library may.
15312 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15313 and constrained to be a file.
15314
15315
15316 .option ldap_cert_file main string unset
15317 .cindex "LDAP" "TLS client certificate file"
15318 .cindex certificate "file for LDAP"
15319 This option indicates which file contains an TLS client certificate which
15320 Exim should present to the LDAP server during TLS negotiation.
15321 Should be used together with &%ldap_cert_key%&.
15322
15323
15324 .option ldap_cert_key main string unset
15325 .cindex "LDAP" "TLS client key file"
15326 .cindex certificate "key for LDAP"
15327 This option indicates which file contains the secret/private key to use
15328 to prove identity to the LDAP server during TLS negotiation.
15329 Should be used together with &%ldap_cert_file%&, which contains the
15330 identity to be proven.
15331
15332
15333 .option ldap_cipher_suite main string unset
15334 .cindex "LDAP" "TLS cipher suite"
15335 This controls the TLS cipher-suite negotiation during TLS negotiation with
15336 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15337 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15338
15339
15340 .option ldap_default_servers main "string list" unset
15341 .cindex "LDAP" "default servers"
15342 This option provides a list of LDAP servers which are tried in turn when an
15343 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15344 details of LDAP queries. This option is available only when Exim has been built
15345 with LDAP support.
15346
15347
15348 .option ldap_require_cert main string unset.
15349 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15350 This should be one of the values "hard", "demand", "allow", "try" or "never".
15351 A value other than one of these is interpreted as "never".
15352 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15353 Although Exim does not set a default, the LDAP library probably defaults
15354 to hard/demand.
15355
15356
15357 .option ldap_start_tls main boolean false
15358 .cindex "LDAP" "whether or not to negotiate TLS"
15359 If set, Exim will attempt to negotiate TLS with the LDAP server when
15360 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15361 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15362 of SSL-on-connect.
15363 In the event of failure to negotiate TLS, the action taken is controlled
15364 by &%ldap_require_cert%&.
15365 This option is ignored for &`ldapi`& connections.
15366
15367
15368 .option ldap_version main integer unset
15369 .cindex "LDAP" "protocol version, forcing"
15370 This option can be used to force Exim to set a specific protocol version for
15371 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15372 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15373 the LDAP headers; otherwise it is 2. This option is available only when Exim
15374 has been built with LDAP support.
15375
15376
15377
15378 .option local_from_check main boolean true
15379 .cindex "&'Sender:'& header line" "disabling addition of"
15380 .cindex "&'From:'& header line" "disabling checking of"
15381 When a message is submitted locally (that is, not over a TCP/IP connection) by
15382 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15383 checks that the &'From:'& header line matches the login of the calling user and
15384 the domain specified by &%qualify_domain%&.
15385
15386 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15387 locally submitted message is automatically qualified by Exim, unless the
15388 &%-bnq%& command line option is used.
15389
15390 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15391 on the local part. If the &'From:'& header line does not match, Exim adds a
15392 &'Sender:'& header with an address constructed from the calling user's login
15393 and the default qualify domain.
15394
15395 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15396 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15397 &'Sender:'& header lines supplied by untrusted users, you must also set
15398 &%local_sender_retain%& to be true.
15399
15400 .cindex "envelope sender"
15401 These options affect only the header lines in the message. The envelope sender
15402 is still forced to be the login id at the qualify domain unless
15403 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15404
15405 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15406 request similar header line checking. See section &<<SECTthesenhea>>&, which
15407 has more details about &'Sender:'& processing.
15408
15409
15410
15411
15412 .option local_from_prefix main string unset
15413 When Exim checks the &'From:'& header line of locally submitted messages for
15414 matching the login id (see &%local_from_check%& above), it can be configured to
15415 ignore certain prefixes and suffixes in the local part of the address. This is
15416 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15417 appropriate lists, in the same form as the &%local_part_prefix%& and
15418 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15419 example, if
15420 .code
15421 local_from_prefix = *-
15422 .endd
15423 is set, a &'From:'& line containing
15424 .code
15425 From: anything-user@your.domain.example
15426 .endd
15427 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15428 matches the actual sender address that is constructed from the login name and
15429 qualify domain.
15430
15431
15432 .option local_from_suffix main string unset
15433 See &%local_from_prefix%& above.
15434
15435
15436 .option local_interfaces main "string list" "see below"
15437 This option controls which network interfaces are used by the daemon for
15438 listening; they are also used to identify the local host when routing. Chapter
15439 &<<CHAPinterfaces>>& contains a full description of this option and the related
15440 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15441 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15442 &%local_interfaces%& is
15443 .code
15444 local_interfaces = 0.0.0.0
15445 .endd
15446 when Exim is built without IPv6 support; otherwise it is
15447 .code
15448 local_interfaces = <; ::0 ; 0.0.0.0
15449 .endd
15450
15451 .option local_scan_timeout main time 5m
15452 .cindex "timeout" "for &[local_scan()]& function"
15453 .cindex "&[local_scan()]& function" "timeout"
15454 This timeout applies to the &[local_scan()]& function (see chapter
15455 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15456 the incoming message is rejected with a temporary error if it is an SMTP
15457 message. For a non-SMTP message, the message is dropped and Exim ends with a
15458 non-zero code. The incident is logged on the main and reject logs.
15459
15460
15461
15462 .option local_sender_retain main boolean false
15463 .cindex "&'Sender:'& header line" "retaining from local submission"
15464 When a message is submitted locally (that is, not over a TCP/IP connection) by
15465 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15466 do not want this to happen, you must set &%local_sender_retain%&, and you must
15467 also set &%local_from_check%& to be false (Exim will complain if you do not).
15468 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15469 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15470
15471
15472
15473
15474 .option localhost_number main string&!! unset
15475 .cindex "host" "locally unique number for"
15476 .cindex "message ids" "with multiple hosts"
15477 .vindex "&$localhost_number$&"
15478 Exim's message ids are normally unique only within the local host. If
15479 uniqueness among a set of hosts is required, each host must set a different
15480 value for the &%localhost_number%& option. The string is expanded immediately
15481 after reading the configuration file (so that a number can be computed from the
15482 host name, for example) and the result of the expansion must be a number in the
15483 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15484 systems). This is available in subsequent string expansions via the variable
15485 &$localhost_number$&. When &%localhost_number is set%&, the final two
15486 characters of the message id, instead of just being a fractional part of the
15487 time, are computed from the time and the local host number as described in
15488 section &<<SECTmessiden>>&.
15489
15490
15491
15492 .option log_file_path main "string list&!!" "set at compile time"
15493 .cindex "log" "file path for"
15494 This option sets the path which is used to determine the names of Exim's log
15495 files, or indicates that logging is to be to syslog, or both. It is expanded
15496 when Exim is entered, so it can, for example, contain a reference to the host
15497 name. If no specific path is set for the log files at compile or run time,
15498 or if the option is unset at run time (i.e.  &`log_file_path = `&)
15499 they are written in a sub-directory called &_log_& in Exim's spool directory.
15500 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15501 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15502 used. If this string is fixed at your installation (contains no expansion
15503 variables) it is recommended that you do not set this option in the
15504 configuration file, but instead supply the path using LOG_FILE_PATH in
15505 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15506 early on &-- in particular, failure to read the configuration file.
15507
15508
15509 .option log_selector main string unset
15510 .cindex "log" "selectors"
15511 This option can be used to reduce or increase the number of things that Exim
15512 writes to its log files. Its argument is made up of names preceded by plus or
15513 minus characters. For example:
15514 .code
15515 log_selector = +arguments -retry_defer
15516 .endd
15517 A list of possible names and what they control is given in the chapter on
15518 logging, in section &<<SECTlogselector>>&.
15519
15520
15521 .option log_timezone main boolean false
15522 .cindex "log" "timezone for entries"
15523 .vindex "&$tod_log$&"
15524 .vindex "&$tod_zone$&"
15525 By default, the timestamps on log lines are in local time without the
15526 timezone. This means that if your timezone changes twice a year, the timestamps
15527 in log lines are ambiguous for an hour when the clocks go back. One way of
15528 avoiding this problem is to set the timezone to UTC. An alternative is to set
15529 &%log_timezone%& true. This turns on the addition of the timezone offset to
15530 timestamps in log lines. Turning on this option can add quite a lot to the size
15531 of log files because each line is extended by 6 characters. Note that the
15532 &$tod_log$& variable contains the log timestamp without the zone, but there is
15533 another variable called &$tod_zone$& that contains just the timezone offset.
15534
15535
15536 .option lookup_open_max main integer 25
15537 .cindex "too many open files"
15538 .cindex "open files, too many"
15539 .cindex "file" "too many open"
15540 .cindex "lookup" "maximum open files"
15541 .cindex "limit" "open files for lookups"
15542 This option limits the number of simultaneously open files for single-key
15543 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
15544 Exim normally keeps these files open during routing, because often the same
15545 file is required several times. If the limit is reached, Exim closes the least
15546 recently used file. Note that if you are using the &'ndbm'& library, it
15547 actually opens two files for each logical DBM database, though it still counts
15548 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
15549 open files"& errors with NDBM, you need to reduce the value of
15550 &%lookup_open_max%&.
15551
15552
15553 .option max_username_length main integer 0
15554 .cindex "length of login name"
15555 .cindex "user name" "maximum length"
15556 .cindex "limit" "user name length"
15557 Some operating systems are broken in that they truncate long arguments to
15558 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
15559 this option is set greater than zero, any attempt to call &[getpwnam()]& with
15560 an argument that is longer behaves as if &[getpwnam()]& failed.
15561
15562
15563 .option message_body_newlines main bool false
15564 .cindex "message body" "newlines in variables"
15565 .cindex "newline" "in message body variables"
15566 .vindex "&$message_body$&"
15567 .vindex "&$message_body_end$&"
15568 By default, newlines in the message body are replaced by spaces when setting
15569 the &$message_body$& and &$message_body_end$& expansion variables. If this
15570 option is set true, this no longer happens.
15571
15572
15573 .option message_body_visible main integer 500
15574 .cindex "body of message" "visible size"
15575 .cindex "message body" "visible size"
15576 .vindex "&$message_body$&"
15577 .vindex "&$message_body_end$&"
15578 This option specifies how much of a message's body is to be included in the
15579 &$message_body$& and &$message_body_end$& expansion variables.
15580
15581
15582 .option message_id_header_domain main string&!! unset
15583 .cindex "&'Message-ID:'& header line"
15584 If this option is set, the string is expanded and used as the right hand side
15585 (domain) of the &'Message-ID:'& header that Exim creates if a
15586 locally-originated incoming message does not have one. &"Locally-originated"&
15587 means &"not received over TCP/IP."&
15588 Otherwise, the primary host name is used.
15589 Only letters, digits, dot and hyphen are accepted; any other characters are
15590 replaced by hyphens. If the expansion is forced to fail, or if the result is an
15591 empty string, the option is ignored.
15592
15593
15594 .option message_id_header_text main string&!! unset
15595 If this variable is set, the string is expanded and used to augment the text of
15596 the &'Message-id:'& header that Exim creates if a locally-originated incoming
15597 message does not have one. The text of this header is required by RFC 2822 to
15598 take the form of an address. By default, Exim uses its internal message id as
15599 the local part, and the primary host name as the domain. If this option is set,
15600 it is expanded, and provided the expansion is not forced to fail, and does not
15601 yield an empty string, the result is inserted into the header immediately
15602 before the @, separated from the internal message id by a dot. Any characters
15603 that are illegal in an address are automatically converted into hyphens. This
15604 means that variables such as &$tod_log$& can be used, because the spaces and
15605 colons will become hyphens.
15606
15607
15608 .option message_logs main boolean true
15609 .cindex "message logs" "disabling"
15610 .cindex "log" "message log; disabling"
15611 If this option is turned off, per-message log files are not created in the
15612 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
15613 Exim, by reducing the number of files involved in handling a message from a
15614 minimum of four (header spool file, body spool file, delivery journal, and
15615 per-message log) to three. The other major I/O activity is Exim's main log,
15616 which is not affected by this option.
15617
15618
15619 .option message_size_limit main string&!! 50M
15620 .cindex "message" "size limit"
15621 .cindex "limit" "message size"
15622 .cindex "size" "of message, limit"
15623 This option limits the maximum size of message that Exim will process. The
15624 value is expanded for each incoming connection so, for example, it can be made
15625 to depend on the IP address of the remote host for messages arriving via
15626 TCP/IP. After expansion, the value must be a sequence of decimal digits,
15627 optionally followed by K or M.
15628
15629 &*Note*&: This limit cannot be made to depend on a message's sender or any
15630 other properties of an individual message, because it has to be advertised in
15631 the server's response to EHLO. String expansion failure causes a temporary
15632 error. A value of zero means no limit, but its use is not recommended. See also
15633 &%bounce_return_size_limit%&.
15634
15635 Incoming SMTP messages are failed with a 552 error if the limit is
15636 exceeded; locally-generated messages either get a stderr message or a delivery
15637 failure message to the sender, depending on the &%-oe%& setting. Rejection of
15638 an oversized message is logged in both the main and the reject logs. See also
15639 the generic transport option &%message_size_limit%&, which limits the size of
15640 message that an individual transport can process.
15641
15642 If you use a virus-scanner and set this option to to a value larger than the
15643 maximum size that your virus-scanner is configured to support, you may get
15644 failures triggered by large mails.  The right size to configure for the
15645 virus-scanner depends upon what data is passed and the options in use but it's
15646 probably safest to just set it to a little larger than this value.  E.g., with a
15647 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
15648 some problems may result.
15649
15650 A value of 0 will disable size limit checking; Exim will still advertise the
15651 SIZE extension in an EHLO response, but without a limit, so as to permit
15652 SMTP clients to still indicate the message size along with the MAIL verb.
15653
15654
15655 .option move_frozen_messages main boolean false
15656 .cindex "frozen messages" "moving"
15657 This option, which is available only if Exim has been built with the setting
15658 .code
15659 SUPPORT_MOVE_FROZEN_MESSAGES=yes
15660 .endd
15661 in &_Local/Makefile_&, causes frozen messages and their message logs to be
15662 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
15663 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
15664 standard utilities for handling such moved messages, and they do not show up in
15665 lists generated by &%-bp%& or by the Exim monitor.
15666
15667
15668 .option mua_wrapper main boolean false
15669 Setting this option true causes Exim to run in a very restrictive mode in which
15670 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
15671 contains a full description of this facility.
15672
15673
15674
15675 .option mysql_servers main "string list" unset
15676 .cindex "MySQL" "server list"
15677 This option provides a list of MySQL servers and associated connection data, to
15678 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
15679 option is available only if Exim has been built with MySQL support.
15680
15681
15682 .option never_users main "string list&!!" unset
15683 This option is expanded just once, at the start of Exim's processing. Local
15684 message deliveries are normally run in processes that are setuid to the
15685 recipient, and remote deliveries are normally run under Exim's own uid and gid.
15686 It is usually desirable to prevent any deliveries from running as root, as a
15687 safety precaution.
15688
15689 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
15690 list of users that must not be used for local deliveries. This list is fixed in
15691 the binary and cannot be overridden by the configuration file. By default, it
15692 contains just the single user name &"root"&. The &%never_users%& runtime option
15693 can be used to add more users to the fixed list.
15694
15695 If a message is to be delivered as one of the users on the fixed list or the
15696 &%never_users%& list, an error occurs, and delivery is deferred. A common
15697 example is
15698 .code
15699 never_users = root:daemon:bin
15700 .endd
15701 Including root is redundant if it is also on the fixed list, but it does no
15702 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
15703 transport driver.
15704
15705
15706 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
15707 .cindex "OpenSSL "compatibility options"
15708 This option allows an administrator to adjust the SSL options applied
15709 by OpenSSL to connections.  It is given as a space-separated list of items,
15710 each one to be +added or -subtracted from the current value.
15711
15712 This option is only available if Exim is built against OpenSSL.  The values
15713 available for this option vary according to the age of your OpenSSL install.
15714 The &"all"& value controls a subset of flags which are available, typically
15715 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
15716 list the values known on your system and Exim should support all the
15717 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
15718 names lose the leading &"SSL_OP_"& and are lower-cased.
15719
15720 Note that adjusting the options can have severe impact upon the security of
15721 SSL as used by Exim.  It is possible to disable safety checks and shoot
15722 yourself in the foot in various unpleasant ways.  This option should not be
15723 adjusted lightly.  An unrecognised item will be detected at startup, by
15724 invoking Exim with the &%-bV%& flag.
15725
15726 The option affects Exim operating both as a server and as a client.
15727
15728 Historical note: prior to release 4.80, Exim defaulted this value to
15729 "+dont_insert_empty_fragments", which may still be needed for compatibility
15730 with some clients, but which lowers security by increasing exposure to
15731 some now infamous attacks.
15732
15733 Examples:
15734 .code
15735 # Make both old MS and old Eudora happy:
15736 openssl_options = -all +microsoft_big_sslv3_buffer \
15737                        +dont_insert_empty_fragments
15738
15739 # Disable older protocol versions:
15740 openssl_options = +no_sslv2 +no_sslv3
15741 .endd
15742
15743 Possible options may include:
15744 .ilist
15745 &`all`&
15746 .next
15747 &`allow_unsafe_legacy_renegotiation`&
15748 .next
15749 &`cipher_server_preference`&
15750 .next
15751 &`dont_insert_empty_fragments`&
15752 .next
15753 &`ephemeral_rsa`&
15754 .next
15755 &`legacy_server_connect`&
15756 .next
15757 &`microsoft_big_sslv3_buffer`&
15758 .next
15759 &`microsoft_sess_id_bug`&
15760 .next
15761 &`msie_sslv2_rsa_padding`&
15762 .next
15763 &`netscape_challenge_bug`&
15764 .next
15765 &`netscape_reuse_cipher_change_bug`&
15766 .next
15767 &`no_compression`&
15768 .next
15769 &`no_session_resumption_on_renegotiation`&
15770 .next
15771 &`no_sslv2`&
15772 .next
15773 &`no_sslv3`&
15774 .next
15775 &`no_ticket`&
15776 .next
15777 &`no_tlsv1`&
15778 .next
15779 &`no_tlsv1_1`&
15780 .next
15781 &`no_tlsv1_2`&
15782 .next
15783 &`safari_ecdhe_ecdsa_bug`&
15784 .next
15785 &`single_dh_use`&
15786 .next
15787 &`single_ecdh_use`&
15788 .next
15789 &`ssleay_080_client_dh_bug`&
15790 .next
15791 &`sslref2_reuse_cert_type_bug`&
15792 .next
15793 &`tls_block_padding_bug`&
15794 .next
15795 &`tls_d5_bug`&
15796 .next
15797 &`tls_rollback_bug`&
15798 .endlist
15799
15800 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
15801 all clients connecting using the MacOS SecureTransport TLS facility prior
15802 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
15803 to negotiate TLS then this option value might help, provided that your OpenSSL
15804 release is new enough to contain this work-around.  This may be a situation
15805 where you have to upgrade OpenSSL to get buggy clients working.
15806
15807
15808 .option oracle_servers main "string list" unset
15809 .cindex "Oracle" "server list"
15810 This option provides a list of Oracle servers and associated connection data,
15811 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
15812 The option is available only if Exim has been built with Oracle support.
15813
15814
15815 .option percent_hack_domains main "domain list&!!" unset
15816 .cindex "&""percent hack""&"
15817 .cindex "source routing" "in email address"
15818 .cindex "address" "source-routed"
15819 The &"percent hack"& is the convention whereby a local part containing a
15820 percent sign is re-interpreted as a new email address, with the percent
15821 replaced by @. This is sometimes called &"source routing"&, though that term is
15822 also applied to RFC 2822 addresses that begin with an @ character. If this
15823 option is set, Exim implements the percent facility for those domains listed,
15824 but no others. This happens before an incoming SMTP address is tested against
15825 an ACL.
15826
15827 &*Warning*&: The &"percent hack"& has often been abused by people who are
15828 trying to get round relaying restrictions. For this reason, it is best avoided
15829 if at all possible. Unfortunately, a number of less security-conscious MTAs
15830 implement it unconditionally. If you are running Exim on a gateway host, and
15831 routing mail through to internal MTAs without processing the local parts, it is
15832 a good idea to reject recipient addresses with percent characters in their
15833 local parts. Exim's default configuration does this.
15834
15835
15836 .option perl_at_start main boolean false
15837 .cindex "Perl"
15838 This option is available only when Exim is built with an embedded Perl
15839 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15840
15841
15842 .option perl_startup main string unset
15843 .cindex "Perl"
15844 This option is available only when Exim is built with an embedded Perl
15845 interpreter. See chapter &<<CHAPperl>>& for details of its use.
15846
15847 .option perl_startup main boolean false
15848 .cindex "Perl"
15849 This Option enables the taint mode of the embedded Perl interpreter.
15850
15851
15852 .option pgsql_servers main "string list" unset
15853 .cindex "PostgreSQL lookup type" "server list"
15854 This option provides a list of PostgreSQL servers and associated connection
15855 data, to be used in conjunction with &(pgsql)& lookups (see section
15856 &<<SECID72>>&). The option is available only if Exim has been built with
15857 PostgreSQL support.
15858
15859
15860 .option pid_file_path main string&!! "set at compile time"
15861 .cindex "daemon" "pid file path"
15862 .cindex "pid file, path for"
15863 This option sets the name of the file to which the Exim daemon writes its
15864 process id. The string is expanded, so it can contain, for example, references
15865 to the host name:
15866 .code
15867 pid_file_path = /var/log/$primary_hostname/exim.pid
15868 .endd
15869 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
15870 spool directory.
15871 The value set by the option can be overridden by the &%-oP%& command line
15872 option. A pid file is not written if a &"non-standard"& daemon is run by means
15873 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
15874
15875
15876 .option pipelining_advertise_hosts main "host list&!!" *
15877 .cindex "PIPELINING" "suppressing advertising"
15878 This option can be used to suppress the advertisement of the SMTP
15879 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
15880 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
15881 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
15882 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
15883 that clients will use it; &"out of order"& commands that are &"expected"& do
15884 not count as protocol errors (see &%smtp_max_synprot_errors%&).
15885
15886
15887 .option prdr_enable main boolean false
15888 .cindex "PRDR" "enabling on server"
15889 This option can be used to enable the Per-Recipient Data Response extension
15890 to SMTP, defined by Eric Hall.
15891 If the option is set, PRDR is advertised by Exim when operating as a server.
15892 If the client requests PRDR, and more than one recipient, for a message
15893 an additional ACL is called for each recipient after the message content
15894 is received.  See section &<<SECTPRDRACL>>&.
15895
15896 .option preserve_message_logs main boolean false
15897 .cindex "message logs" "preserving"
15898 If this option is set, message log files are not deleted when messages are
15899 completed. Instead, they are moved to a sub-directory of the spool directory
15900 called &_msglog.OLD_&, where they remain available for statistical or debugging
15901 purposes. This is a dangerous option to set on systems with any appreciable
15902 volume of mail. Use with care!
15903
15904
15905 .option primary_hostname main string "see below"
15906 .cindex "name" "of local host"
15907 .cindex "host" "name of local"
15908 .cindex "local host" "name of"
15909 .vindex "&$primary_hostname$&"
15910 This specifies the name of the current host. It is used in the default EHLO or
15911 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
15912 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
15913 The value is also used by default in some SMTP response messages from an Exim
15914 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
15915
15916 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
15917 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
15918 contains only one component, Exim passes it to &[gethostbyname()]& (or
15919 &[getipnodebyname()]& when available) in order to obtain the fully qualified
15920 version. The variable &$primary_hostname$& contains the host name, whether set
15921 explicitly by this option, or defaulted.
15922
15923
15924 .option print_topbitchars main boolean false
15925 .cindex "printing characters"
15926 .cindex "8-bit characters"
15927 By default, Exim considers only those characters whose codes lie in the range
15928 32&--126 to be printing characters. In a number of circumstances (for example,
15929 when writing log entries) non-printing characters are converted into escape
15930 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
15931 is set, code values of 128 and above are also considered to be printing
15932 characters.
15933
15934 This option also affects the header syntax checks performed by the
15935 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
15936 the user's full name when constructing From: and Sender: addresses (as
15937 described in section &<<SECTconstr>>&). Setting this option can cause
15938 Exim to generate eight bit message headers that do not conform to the
15939 standards.
15940
15941
15942 .option process_log_path main string unset
15943 .cindex "process log path"
15944 .cindex "log" "process log"
15945 .cindex "&'exiwhat'&"
15946 This option sets the name of the file to which an Exim process writes its
15947 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
15948 utility script. If this option is unset, the file called &_exim-process.info_&
15949 in Exim's spool directory is used. The ability to specify the name explicitly
15950 can be useful in environments where two different Exims are running, using
15951 different spool directories.
15952
15953
15954 .option prod_requires_admin main boolean true
15955 .cindex "restricting access to features"
15956 .oindex "&%-M%&"
15957 .oindex "&%-R%&"
15958 .oindex "&%-q%&"
15959 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
15960 admin user unless &%prod_requires_admin%& is set false. See also
15961 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
15962
15963
15964 .option qualify_domain main string "see below"
15965 .cindex "domain" "for qualifying addresses"
15966 .cindex "address" "qualification"
15967 This option specifies the domain name that is added to any envelope sender
15968 addresses that do not have a domain qualification. It also applies to
15969 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
15970 are accepted by default only for locally-generated messages. Qualification is
15971 also applied to addresses in header lines such as &'From:'& and &'To:'& for
15972 locally-generated messages, unless the &%-bnq%& command line option is used.
15973
15974 Messages from external sources must always contain fully qualified addresses,
15975 unless the sending host matches &%sender_unqualified_hosts%& or
15976 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
15977 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
15978 necessary. Internally, Exim always works with fully qualified envelope
15979 addresses. If &%qualify_domain%& is not set, it defaults to the
15980 &%primary_hostname%& value.
15981
15982
15983 .option qualify_recipient main string "see below"
15984 This option allows you to specify a different domain for qualifying recipient
15985 addresses to the one that is used for senders. See &%qualify_domain%& above.
15986
15987
15988
15989 .option queue_domains main "domain list&!!" unset
15990 .cindex "domain" "specifying non-immediate delivery"
15991 .cindex "queueing incoming messages"
15992 .cindex "message" "queueing certain domains"
15993 This option lists domains for which immediate delivery is not required.
15994 A delivery process is started whenever a message is received, but only those
15995 domains that do not match are processed. All other deliveries wait until the
15996 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
15997
15998
15999 .option queue_list_requires_admin main boolean true
16000 .cindex "restricting access to features"
16001 .oindex "&%-bp%&"
16002 The &%-bp%& command-line option, which lists the messages that are on the
16003 queue, requires the caller to be an admin user unless
16004 &%queue_list_requires_admin%& is set false.
16005 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16006
16007
16008 .option queue_only main boolean false
16009 .cindex "queueing incoming messages"
16010 .cindex "message" "queueing unconditionally"
16011 If &%queue_only%& is set, a delivery process is not automatically started
16012 whenever a message is received. Instead, the message waits on the queue for the
16013 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16014 delivered immediately when certain conditions (such as heavy load) occur.
16015
16016 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16017 and &%-odi%& command line options override &%queue_only%& unless
16018 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16019 &%queue_only_load%&, and &%smtp_accept_queue%&.
16020
16021
16022 .option queue_only_file main string unset
16023 .cindex "queueing incoming messages"
16024 .cindex "message" "queueing by file existence"
16025 This option can be set to a colon-separated list of absolute path names, each
16026 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16027 it tests for the existence of each listed path using a call to &[stat()]&. For
16028 each path that exists, the corresponding queueing option is set.
16029 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16030 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16031 .code
16032 queue_only_file = smtp/some/file
16033 .endd
16034 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16035 &_/some/file_& exists.
16036
16037
16038 .option queue_only_load main fixed-point unset
16039 .cindex "load average"
16040 .cindex "queueing incoming messages"
16041 .cindex "message" "queueing by load"
16042 If the system load average is higher than this value, incoming messages from
16043 all sources are queued, and no automatic deliveries are started. If this
16044 happens during local or remote SMTP input, all subsequent messages received on
16045 the same SMTP connection are queued by default, whatever happens to the load in
16046 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16047 false.
16048
16049 Deliveries will subsequently be performed by queue runner processes. This
16050 option has no effect on ancient operating systems on which Exim cannot
16051 determine the load average. See also &%deliver_queue_load_max%& and
16052 &%smtp_load_reserve%&.
16053
16054
16055 .option queue_only_load_latch main boolean true
16056 .cindex "load average" "re-evaluating per message"
16057 When this option is true (the default), once one message has been queued
16058 because the load average is higher than the value set by &%queue_only_load%&,
16059 all subsequent messages received on the same SMTP connection are also queued.
16060 This is a deliberate choice; even though the load average may fall below the
16061 threshold, it doesn't seem right to deliver later messages on the same
16062 connection when not delivering earlier ones. However, there are special
16063 circumstances such as very long-lived connections from scanning appliances
16064 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16065 should be set false. This causes the value of the load average to be
16066 re-evaluated for each message.
16067
16068
16069 .option queue_only_override main boolean true
16070 .cindex "queueing incoming messages"
16071 When this option is true, the &%-od%&&'x'& command line options override the
16072 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16073 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16074 to override; they are accepted, but ignored.
16075
16076
16077 .option queue_run_in_order main boolean false
16078 .cindex "queue runner" "processing messages in order"
16079 If this option is set, queue runs happen in order of message arrival instead of
16080 in an arbitrary order. For this to happen, a complete list of the entire queue
16081 must be set up before the deliveries start. When the queue is all held in a
16082 single directory (the default), a single list is created for both the ordered
16083 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16084 single list is not created when &%queue_run_in_order%& is false. In this case,
16085 the sub-directories are processed one at a time (in a random order), and this
16086 avoids setting up one huge list for the whole queue. Thus, setting
16087 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16088 when the queue is large, because of the extra work in setting up the single,
16089 large list. In most situations, &%queue_run_in_order%& should not be set.
16090
16091
16092
16093 .option queue_run_max main integer&!! 5
16094 .cindex "queue runner" "maximum number of"
16095 This controls the maximum number of queue runner processes that an Exim daemon
16096 can run simultaneously. This does not mean that it starts them all at once,
16097 but rather that if the maximum number are still running when the time comes to
16098 start another one, it refrains from starting another one. This can happen with
16099 very large queues and/or very sluggish deliveries. This option does not,
16100 however, interlock with other processes, so additional queue runners can be
16101 started by other means, or by killing and restarting the daemon.
16102
16103 Setting this option to zero does not suppress queue runs; rather, it disables
16104 the limit, allowing any number of simultaneous queue runner processes to be
16105 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16106 the daemon's command line.
16107
16108 .cindex queues named
16109 .cindex "named queues"
16110 To set limits for different named queues use
16111 an expansion depending on the &$queue_name$& variable.
16112
16113 .option queue_smtp_domains main "domain list&!!" unset
16114 .cindex "queueing incoming messages"
16115 .cindex "message" "queueing remote deliveries"
16116 When this option is set, a delivery process is started whenever a message is
16117 received, routing is performed, and local deliveries take place.
16118 However, if any SMTP deliveries are required for domains that match
16119 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16120 message waits on the queue for the next queue run. Since routing of the message
16121 has taken place, Exim knows to which remote hosts it must be delivered, and so
16122 when the queue run happens, multiple messages for the same host are delivered
16123 over a single SMTP connection. The &%-odqs%& command line option causes all
16124 SMTP deliveries to be queued in this way, and is equivalent to setting
16125 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16126 &%queue_domains%&.
16127
16128
16129 .option receive_timeout main time 0s
16130 .cindex "timeout" "for non-SMTP input"
16131 This option sets the timeout for accepting a non-SMTP message, that is, the
16132 maximum time that Exim waits when reading a message on the standard input. If
16133 the value is zero, it will wait for ever. This setting is overridden by the
16134 &%-or%& command line option. The timeout for incoming SMTP messages is
16135 controlled by &%smtp_receive_timeout%&.
16136
16137 .option received_header_text main string&!! "see below"
16138 .cindex "customizing" "&'Received:'& header"
16139 .cindex "&'Received:'& header line" "customizing"
16140 This string defines the contents of the &'Received:'& message header that is
16141 added to each message, except for the timestamp, which is automatically added
16142 on at the end (preceded by a semicolon). The string is expanded each time it is
16143 used. If the expansion yields an empty string, no &'Received:'& header line is
16144 added to the message. Otherwise, the string should start with the text
16145 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16146 header lines. The default setting is:
16147
16148 .code
16149 received_header_text = Received: \
16150   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16151   {${if def:sender_ident \
16152   {from ${quote_local_part:$sender_ident} }}\
16153   ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16154   by $primary_hostname \
16155   ${if def:received_protocol {with $received_protocol}} \
16156   ${if def:tls_in_cipher {($tls_in_cipher)\n\t}}\
16157   (Exim $version_number)\n\t\
16158   ${if def:sender_address \
16159   {(envelope-from <$sender_address>)\n\t}}\
16160   id $message_exim_id\
16161   ${if def:received_for {\n\tfor $received_for}}
16162 .endd
16163
16164 The reference to the TLS cipher is omitted when Exim is built without TLS
16165 support. The use of conditional expansions ensures that this works for both
16166 locally generated messages and messages received from remote hosts, giving
16167 header lines such as the following:
16168 .code
16169 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16170 by marley.carol.example with esmtp (Exim 4.00)
16171 (envelope-from <bob@carol.example>)
16172 id 16IOWa-00019l-00
16173 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16174 Received: by scrooge.carol.example with local (Exim 4.00)
16175 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16176 .endd
16177 Until the body of the message has been received, the timestamp is the time when
16178 the message started to be received. Once the body has arrived, and all policy
16179 checks have taken place, the timestamp is updated to the time at which the
16180 message was accepted.
16181
16182
16183 .option received_headers_max main integer 30
16184 .cindex "loop" "prevention"
16185 .cindex "mail loop prevention"
16186 .cindex "&'Received:'& header line" "counting"
16187 When a message is to be delivered, the number of &'Received:'& headers is
16188 counted, and if it is greater than this parameter, a mail loop is assumed to
16189 have occurred, the delivery is abandoned, and an error message is generated.
16190 This applies to both local and remote deliveries.
16191
16192
16193 .option recipient_unqualified_hosts main "host list&!!" unset
16194 .cindex "unqualified addresses"
16195 .cindex "host" "unqualified addresses from"
16196 This option lists those hosts from which Exim is prepared to accept unqualified
16197 recipient addresses in message envelopes. The addresses are made fully
16198 qualified by the addition of the &%qualify_recipient%& value. This option also
16199 affects message header lines. Exim does not reject unqualified recipient
16200 addresses in headers, but it qualifies them only if the message came from a
16201 host that matches &%recipient_unqualified_hosts%&,
16202 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16203 option was not set.
16204
16205
16206 .option recipients_max main integer 0
16207 .cindex "limit" "number of recipients"
16208 .cindex "recipient" "maximum number"
16209 If this option is set greater than zero, it specifies the maximum number of
16210 original recipients for any message. Additional recipients that are generated
16211 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16212 all recipients over the limit; earlier recipients are delivered as normal.
16213 Non-SMTP messages with too many recipients are failed, and no deliveries are
16214 done.
16215
16216 .cindex "RCPT" "maximum number of incoming"
16217 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16218 RCPT commands in a single message.
16219
16220
16221 .option recipients_max_reject main boolean false
16222 If this option is set true, Exim rejects SMTP messages containing too many
16223 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16224 error to the eventual DATA command. Otherwise (the default) it gives a 452
16225 error to the surplus RCPT commands and accepts the message on behalf of the
16226 initial set of recipients. The remote server should then re-send the message
16227 for the remaining recipients at a later time.
16228
16229
16230 .option remote_max_parallel main integer 2
16231 .cindex "delivery" "parallelism for remote"
16232 This option controls parallel delivery of one message to a number of remote
16233 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16234 does all the remote deliveries for a message one by one. Otherwise, if a single
16235 message has to be delivered to more than one remote host, or if several copies
16236 have to be sent to the same remote host, up to &%remote_max_parallel%&
16237 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16238 deliveries are required, the maximum number of processes are started, and as
16239 each one finishes, another is begun. The order of starting processes is the
16240 same as if sequential delivery were being done, and can be controlled by the
16241 &%remote_sort_domains%& option. If parallel delivery takes place while running
16242 with debugging turned on, the debugging output from each delivery process is
16243 tagged with its process id.
16244
16245 This option controls only the maximum number of parallel deliveries for one
16246 message in one Exim delivery process. Because Exim has no central queue
16247 manager, there is no way of controlling the total number of simultaneous
16248 deliveries if the configuration allows a delivery attempt as soon as a message
16249 is received.
16250
16251 .cindex "number of deliveries"
16252 .cindex "delivery" "maximum number of"
16253 If you want to control the total number of deliveries on the system, you
16254 need to set the &%queue_only%& option. This ensures that all incoming messages
16255 are added to the queue without starting a delivery process. Then set up an Exim
16256 daemon to start queue runner processes at appropriate intervals (probably
16257 fairly often, for example, every minute), and limit the total number of queue
16258 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16259 delivers only one message at a time, the maximum number of deliveries that can
16260 then take place at once is &%queue_run_max%& multiplied by
16261 &%remote_max_parallel%&.
16262
16263 If it is purely remote deliveries you want to control, use
16264 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16265 doing the SMTP routing before queueing, so that several messages for the same
16266 host will eventually get delivered down the same connection.
16267
16268
16269 .option remote_sort_domains main "domain list&!!" unset
16270 .cindex "sorting remote deliveries"
16271 .cindex "delivery" "sorting remote"
16272 When there are a number of remote deliveries for a message, they are sorted by
16273 domain into the order given by this list. For example,
16274 .code
16275 remote_sort_domains = *.cam.ac.uk:*.uk
16276 .endd
16277 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16278 then to those in the &%uk%& domain, then to any others.
16279
16280
16281 .option retry_data_expire main time 7d
16282 .cindex "hints database" "data expiry"
16283 This option sets a &"use before"& time on retry information in Exim's hints
16284 database. Any older retry data is ignored. This means that, for example, once a
16285 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16286 past failures.
16287
16288
16289 .option retry_interval_max main time 24h
16290 .cindex "retry" "limit on interval"
16291 .cindex "limit" "on retry interval"
16292 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16293 intervals between delivery attempts for messages that cannot be delivered
16294 straight away. This option sets an overall limit to the length of time between
16295 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16296 the default value.
16297
16298
16299 .option return_path_remove main boolean true
16300 .cindex "&'Return-path:'& header line" "removing"
16301 RFC 2821, section 4.4, states that an SMTP server must insert a
16302 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16303 The &'Return-path:'& header preserves the sender address as received in the
16304 MAIL command. This description implies that this header should not be present
16305 in an incoming message. If &%return_path_remove%& is true, any existing
16306 &'Return-path:'& headers are removed from messages at the time they are
16307 received. Exim's transports have options for adding &'Return-path:'& headers at
16308 the time of delivery. They are normally used only for final local deliveries.
16309
16310
16311 .option return_size_limit main integer 100K
16312 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16313
16314
16315 .option rfc1413_hosts main "host list&!!" @[]
16316 .cindex "RFC 1413"
16317 .cindex "host" "for RFC 1413 calls"
16318 RFC 1413 identification calls are made to any client host which matches
16319 an item in the list.
16320 The default value specifies just this host, being any local interface
16321 for the system.
16322
16323 .option rfc1413_query_timeout main time 0s
16324 .cindex "RFC 1413" "query timeout"
16325 .cindex "timeout" "for RFC 1413 call"
16326 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16327 no RFC 1413 calls are ever made.
16328
16329
16330 .option sender_unqualified_hosts main "host list&!!" unset
16331 .cindex "unqualified addresses"
16332 .cindex "host" "unqualified addresses from"
16333 This option lists those hosts from which Exim is prepared to accept unqualified
16334 sender addresses. The addresses are made fully qualified by the addition of
16335 &%qualify_domain%&. This option also affects message header lines. Exim does
16336 not reject unqualified addresses in headers that contain sender addresses, but
16337 it qualifies them only if the message came from a host that matches
16338 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16339 using TCP/IP), and the &%-bnq%& option was not set.
16340
16341 .option set_environment main "string list" empty
16342 .cindex "environment"
16343 This option allows to set individual environment variables that the
16344 currently linked libraries and programs in child processes use. The
16345 default list is empty,
16346
16347
16348 .option slow_lookup_log main integer 0
16349 .cindex "logging" "slow lookups"
16350 .cindex "dns" "logging slow lookups"
16351 This option controls logging of slow lookups.
16352 If the value is nonzero it is taken as a number of milliseconds
16353 and lookups taking longer than this are logged.
16354 Currently this applies only to DNS lookups.
16355
16356
16357
16358 .option smtp_accept_keepalive main boolean true
16359 .cindex "keepalive" "on incoming connection"
16360 This option controls the setting of the SO_KEEPALIVE option on incoming
16361 TCP/IP socket connections. When set, it causes the kernel to probe idle
16362 connections periodically, by sending packets with &"old"& sequence numbers. The
16363 other end of the connection should send an acknowledgment if the connection is
16364 still okay or a reset if the connection has been aborted. The reason for doing
16365 this is that it has the beneficial effect of freeing up certain types of
16366 connection that can get stuck when the remote host is disconnected without
16367 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16368 hours to detect unreachable hosts.
16369
16370
16371
16372 .option smtp_accept_max main integer 20
16373 .cindex "limit" "incoming SMTP connections"
16374 .cindex "SMTP" "incoming connection count"
16375 .cindex "inetd"
16376 This option specifies the maximum number of simultaneous incoming SMTP calls
16377 that Exim will accept. It applies only to the listening daemon; there is no
16378 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16379 value is set to zero, no limit is applied. However, it is required to be
16380 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16381 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16382
16383 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16384 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16385 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16386 and &%smtp_load_reserve%& are then checked before accepting the connection.
16387
16388
16389 .option smtp_accept_max_nonmail main integer 10
16390 .cindex "limit" "non-mail SMTP commands"
16391 .cindex "SMTP" "limiting non-mail commands"
16392 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16393 the connection if there are too many. This option defines &"too many"&. The
16394 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16395 client looping sending EHLO, for example. The check is applied only if the
16396 client host matches &%smtp_accept_max_nonmail_hosts%&.
16397
16398 When a new message is expected, one occurrence of RSET is not counted. This
16399 allows a client to send one RSET between messages (this is not necessary,
16400 but some clients do it). Exim also allows one uncounted occurrence of HELO
16401 or EHLO, and one occurrence of STARTTLS between messages. After
16402 starting up a TLS session, another EHLO is expected, and so it too is not
16403 counted. The first occurrence of AUTH in a connection, or immediately
16404 following STARTTLS is not counted. Otherwise, all commands other than
16405 MAIL, RCPT, DATA, and QUIT are counted.
16406
16407
16408 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16409 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16410 check by setting this option. The default value makes it apply to all hosts. By
16411 changing the value, you can exclude any badly-behaved hosts that you have to
16412 live with.
16413
16414
16415 . Allow this long option name to split; give it unsplit as a fifth argument
16416 . for the automatic .oindex that is generated by .option.
16417 . We insert " &~&~" which is both pretty nasty visually and results in
16418 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16419 . zero-width-space, which would be nicer visually and results in (at least)
16420 . html that Firefox will split on when it's forced to reflow (rather than
16421 . inserting a horizontal scrollbar).  However, the text is still not
16422 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16423 . the option name to split.
16424
16425 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16426          smtp_accept_max_per_connection
16427 .cindex "SMTP" "limiting incoming message count"
16428 .cindex "limit" "messages per SMTP connection"
16429 The value of this option limits the number of MAIL commands that Exim is
16430 prepared to accept over a single SMTP connection, whether or not each command
16431 results in the transfer of a message. After the limit is reached, a 421
16432 response is given to subsequent MAIL commands. This limit is a safety
16433 precaution against a client that goes mad (incidents of this type have been
16434 seen).
16435
16436
16437 .option smtp_accept_max_per_host main string&!! unset
16438 .cindex "limit" "SMTP connections from one host"
16439 .cindex "host" "limiting SMTP connections from"
16440 This option restricts the number of simultaneous IP connections from a single
16441 host (strictly, from a single IP address) to the Exim daemon. The option is
16442 expanded, to enable different limits to be applied to different hosts by
16443 reference to &$sender_host_address$&. Once the limit is reached, additional
16444 connection attempts from the same host are rejected with error code 421. This
16445 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16446 of zero imposes no limit. If this option is set greater than zero, it is
16447 required that &%smtp_accept_max%& be non-zero.
16448
16449 &*Warning*&: When setting this option you should not use any expansion
16450 constructions that take an appreciable amount of time. The expansion and test
16451 happen in the main daemon loop, in order to reject additional connections
16452 without forking additional processes (otherwise a denial-of-service attack
16453 could cause a vast number or processes to be created). While the daemon is
16454 doing this processing, it cannot accept any other incoming connections.
16455
16456
16457
16458 .option smtp_accept_queue main integer 0
16459 .cindex "SMTP" "incoming connection count"
16460 .cindex "queueing incoming messages"
16461 .cindex "message" "queueing by SMTP connection count"
16462 If the number of simultaneous incoming SMTP connections being handled via the
16463 listening daemon exceeds this value, messages received by SMTP are just placed
16464 on the queue; no delivery processes are started automatically. The count is
16465 fixed at the start of an SMTP connection. It cannot be updated in the
16466 subprocess that receives messages, and so the queueing or not queueing applies
16467 to all messages received in the same connection.
16468
16469 A value of zero implies no limit, and clearly any non-zero value is useful only
16470 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16471 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16472 various &%-od%&&'x'& command line options.
16473
16474
16475 . See the comment on smtp_accept_max_per_connection
16476
16477 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16478          smtp_accept_queue_per_connection
16479 .cindex "queueing incoming messages"
16480 .cindex "message" "queueing by message count"
16481 This option limits the number of delivery processes that Exim starts
16482 automatically when receiving messages via SMTP, whether via the daemon or by
16483 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16484 and the number of messages received in a single SMTP session exceeds this
16485 number, subsequent messages are placed on the queue, but no delivery processes
16486 are started. This helps to limit the number of Exim processes when a server
16487 restarts after downtime and there is a lot of mail waiting for it on other
16488 systems. On large systems, the default should probably be increased, and on
16489 dial-in client systems it should probably be set to zero (that is, disabled).
16490
16491
16492 .option smtp_accept_reserve main integer 0
16493 .cindex "SMTP" "incoming call count"
16494 .cindex "host" "reserved"
16495 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16496 number of SMTP connections that are reserved for connections from the hosts
16497 that are specified in &%smtp_reserve_hosts%&. The value set in
16498 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16499 restricted to this number of connections; the option specifies a minimum number
16500 of connection slots for them, not a maximum. It is a guarantee that this group
16501 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16502 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16503 individual host.
16504
16505 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16506 set to 5, once there are 45 active connections (from any hosts), new
16507 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16508 provided the other criteria for acceptance are met.
16509
16510
16511 .option smtp_active_hostname main string&!! unset
16512 .cindex "host" "name in SMTP responses"
16513 .cindex "SMTP" "host name in responses"
16514 .vindex "&$primary_hostname$&"
16515 This option is provided for multi-homed servers that want to masquerade as
16516 several different hosts. At the start of an incoming SMTP connection, its value
16517 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16518 responses. For example, it is used as domain name in the response to an
16519 incoming HELO or EHLO command.
16520
16521 .vindex "&$smtp_active_hostname$&"
16522 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16523 is saved with any messages that are received. It is therefore available for use
16524 in routers and transports when the message is later delivered.
16525
16526 If this option is unset, or if its expansion is forced to fail, or if the
16527 expansion results in an empty string, the value of &$primary_hostname$& is
16528 used. Other expansion failures cause a message to be written to the main and
16529 panic logs, and the SMTP command receives a temporary error. Typically, the
16530 value of &%smtp_active_hostname%& depends on the incoming interface address.
16531 For example:
16532 .code
16533 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16534   {cox.mydomain}{box.mydomain}}
16535 .endd
16536
16537 Although &$smtp_active_hostname$& is primarily concerned with incoming
16538 messages, it is also used as the default for HELO commands in callout
16539 verification if there is no remote transport from which to obtain a
16540 &%helo_data%& value.
16541
16542 .option smtp_banner main string&!! "see below"
16543 .cindex "SMTP" "welcome banner"
16544 .cindex "banner for SMTP"
16545 .cindex "welcome banner for SMTP"
16546 .cindex "customizing" "SMTP banner"
16547 This string, which is expanded every time it is used, is output as the initial
16548 positive response to an SMTP connection. The default setting is:
16549 .code
16550 smtp_banner = $smtp_active_hostname ESMTP Exim \
16551   $version_number $tod_full
16552 .endd
16553 Failure to expand the string causes a panic error. If you want to create a
16554 multiline response to the initial SMTP connection, use &"\n"& in the string at
16555 appropriate points, but not at the end. Note that the 220 code is not included
16556 in this string. Exim adds it automatically (several times in the case of a
16557 multiline response).
16558
16559
16560 .option smtp_check_spool_space main boolean true
16561 .cindex "checking disk space"
16562 .cindex "disk space, checking"
16563 .cindex "spool directory" "checking space"
16564 When this option is set, if an incoming SMTP session encounters the SIZE
16565 option on a MAIL command, it checks that there is enough space in the
16566 spool directory's partition to accept a message of that size, while still
16567 leaving free the amount specified by &%check_spool_space%& (even if that value
16568 is zero). If there isn't enough space, a temporary error code is returned.
16569
16570
16571 .option smtp_connect_backlog main integer 20
16572 .cindex "connection backlog"
16573 .cindex "SMTP" "connection backlog"
16574 .cindex "backlog of connections"
16575 This option specifies a maximum number of waiting SMTP connections. Exim passes
16576 this value to the TCP/IP system when it sets up its listener. Once this number
16577 of connections are waiting for the daemon's attention, subsequent connection
16578 attempts are refused at the TCP/IP level. At least, that is what the manuals
16579 say; in some circumstances such connection attempts have been observed to time
16580 out instead. For large systems it is probably a good idea to increase the
16581 value (to 50, say). It also gives some protection against denial-of-service
16582 attacks by SYN flooding.
16583
16584
16585 .option smtp_enforce_sync main boolean true
16586 .cindex "SMTP" "synchronization checking"
16587 .cindex "synchronization checking in SMTP"
16588 The SMTP protocol specification requires the client to wait for a response from
16589 the server at certain points in the dialogue. Without PIPELINING these
16590 synchronization points are after every command; with PIPELINING they are
16591 fewer, but they still exist.
16592
16593 Some spamming sites send out a complete set of SMTP commands without waiting
16594 for any response. Exim protects against this by rejecting a message if the
16595 client has sent further input when it should not have. The error response &"554
16596 SMTP synchronization error"& is sent, and the connection is dropped. Testing
16597 for this error cannot be perfect because of transmission delays (unexpected
16598 input may be on its way but not yet received when Exim checks). However, it
16599 does detect many instances.
16600
16601 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
16602 If you want to disable the check selectively (for example, only for certain
16603 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
16604 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
16605
16606
16607
16608 .option smtp_etrn_command main string&!! unset
16609 .cindex "ETRN" "command to be run"
16610 .vindex "&$domain$&"
16611 If this option is set, the given command is run whenever an SMTP ETRN
16612 command is received from a host that is permitted to issue such commands (see
16613 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
16614 are independently expanded. The expansion variable &$domain$& is set to the
16615 argument of the ETRN command, and no syntax checking is done on it. For
16616 example:
16617 .code
16618 smtp_etrn_command = /etc/etrn_command $domain \
16619                     $sender_host_address
16620 .endd
16621 A new process is created to run the command, but Exim does not wait for it to
16622 complete. Consequently, its status cannot be checked. If the command cannot be
16623 run, a line is written to the panic log, but the ETRN caller still receives
16624 a 250 success response. Exim is normally running under its own uid when
16625 receiving SMTP, so it is not possible for it to change the uid before running
16626 the command.
16627
16628
16629 .option smtp_etrn_serialize main boolean true
16630 .cindex "ETRN" "serializing"
16631 When this option is set, it prevents the simultaneous execution of more than
16632 one identical command as a result of ETRN in an SMTP connection. See
16633 section &<<SECTETRN>>& for details.
16634
16635
16636 .option smtp_load_reserve main fixed-point unset
16637 .cindex "load average"
16638 If the system load average ever gets higher than this, incoming SMTP calls are
16639 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
16640 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
16641 the load is over the limit. The option has no effect on ancient operating
16642 systems on which Exim cannot determine the load average. See also
16643 &%deliver_queue_load_max%& and &%queue_only_load%&.
16644
16645
16646
16647 .option smtp_max_synprot_errors main integer 3
16648 .cindex "SMTP" "limiting syntax and protocol errors"
16649 .cindex "limit" "SMTP syntax and protocol errors"
16650 Exim rejects SMTP commands that contain syntax or protocol errors. In
16651 particular, a syntactically invalid email address, as in this command:
16652 .code
16653 RCPT TO:<abc xyz@a.b.c>
16654 .endd
16655 causes immediate rejection of the command, before any other tests are done.
16656 (The ACL cannot be run if there is no valid address to set up for it.) An
16657 example of a protocol error is receiving RCPT before MAIL. If there are
16658 too many syntax or protocol errors in one SMTP session, the connection is
16659 dropped. The limit is set by this option.
16660
16661 .cindex "PIPELINING" "expected errors"
16662 When the PIPELINING extension to SMTP is in use, some protocol errors are
16663 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
16664 Exim assumes that PIPELINING will be used if it advertises it (see
16665 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
16666 not count towards the limit.
16667
16668
16669
16670 .option smtp_max_unknown_commands main integer 3
16671 .cindex "SMTP" "limiting unknown commands"
16672 .cindex "limit" "unknown SMTP commands"
16673 If there are too many unrecognized commands in an incoming SMTP session, an
16674 Exim server drops the connection. This is a defence against some kinds of abuse
16675 that subvert web
16676 clients
16677 into making connections to SMTP ports; in these circumstances, a number of
16678 non-SMTP command lines are sent first.
16679
16680
16681
16682 .option smtp_ratelimit_hosts main "host list&!!" unset
16683 .cindex "SMTP" "rate limiting"
16684 .cindex "limit" "rate of message arrival"
16685 .cindex "RCPT" "rate limiting"
16686 Some sites find it helpful to be able to limit the rate at which certain hosts
16687 can send them messages, and the rate at which an individual message can specify
16688 recipients.
16689
16690 Exim has two rate-limiting facilities. This section describes the older
16691 facility, which can limit rates within a single connection. The newer
16692 &%ratelimit%& ACL condition can limit rates across all connections. See section
16693 &<<SECTratelimiting>>& for details of the newer facility.
16694
16695 When a host matches &%smtp_ratelimit_hosts%&, the values of
16696 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
16697 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
16698 respectively. Each option, if set, must contain a set of four comma-separated
16699 values:
16700
16701 .ilist
16702 A threshold, before which there is no rate limiting.
16703 .next
16704 An initial time delay. Unlike other times in Exim, numbers with decimal
16705 fractional parts are allowed here.
16706 .next
16707 A factor by which to increase the delay each time.
16708 .next
16709 A maximum value for the delay. This should normally be less than 5 minutes,
16710 because after that time, the client is liable to timeout the SMTP command.
16711 .endlist
16712
16713 For example, these settings have been used successfully at the site which
16714 first suggested this feature, for controlling mail from their customers:
16715 .code
16716 smtp_ratelimit_mail = 2,0.5s,1.05,4m
16717 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
16718 .endd
16719 The first setting specifies delays that are applied to MAIL commands after
16720 two have been received over a single connection. The initial delay is 0.5
16721 seconds, increasing by a factor of 1.05 each time. The second setting applies
16722 delays to RCPT commands when more than four occur in a single message.
16723
16724
16725 .option smtp_ratelimit_mail main string unset
16726 See &%smtp_ratelimit_hosts%& above.
16727
16728
16729 .option smtp_ratelimit_rcpt main string unset
16730 See &%smtp_ratelimit_hosts%& above.
16731
16732
16733 .option smtp_receive_timeout main time&!! 5m
16734 .cindex "timeout" "for SMTP input"
16735 .cindex "SMTP" "input timeout"
16736 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
16737 input, including batch SMTP. If a line of input (either an SMTP command or a
16738 data line) is not received within this time, the SMTP connection is dropped and
16739 the message is abandoned.
16740 A line is written to the log containing one of the following messages:
16741 .code
16742 SMTP command timeout on connection from...
16743 SMTP data timeout on connection from...
16744 .endd
16745 The former means that Exim was expecting to read an SMTP command; the latter
16746 means that it was in the DATA phase, reading the contents of a message.
16747
16748 If the first character of the option is a &"$"& the option is
16749 expanded before use and may depend on
16750 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
16751
16752
16753 .oindex "&%-os%&"
16754 The value set by this option can be overridden by the
16755 &%-os%& command-line option. A setting of zero time disables the timeout, but
16756 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
16757 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
16758 timeout is controlled by &%receive_timeout%& and &%-or%&.
16759
16760
16761 .option smtp_reserve_hosts main "host list&!!" unset
16762 This option defines hosts for which SMTP connections are reserved; see
16763 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
16764
16765
16766 .option smtp_return_error_details main boolean false
16767 .cindex "SMTP" "details policy failures"
16768 .cindex "policy control" "rejection, returning details"
16769 In the default state, Exim uses bland messages such as
16770 &"Administrative prohibition"& when it rejects SMTP commands for policy
16771 reasons. Many sysadmins like this because it gives away little information
16772 to spammers. However, some other sysadmins who are applying strict checking
16773 policies want to give out much fuller information about failures. Setting
16774 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
16775 example, instead of &"Administrative prohibition"&, it might give:
16776 .code
16777 550-Rejected after DATA: '>' missing at end of address:
16778 550 failing address in "From" header is: <user@dom.ain
16779 .endd
16780
16781
16782 .option smtputf8_advertise_hosts main "host list&!!" *
16783 .cindex "SMTPUTF8" "advertising"
16784 When Exim is built with support for internationalised mail names,
16785 the availability thereof is advertised in
16786 response to EHLO only to those client hosts that match this option. See
16787 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
16788
16789
16790 .option spamd_address main string "see below"
16791 This option is available when Exim is compiled with the content-scanning
16792 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
16793 The default value is
16794 .code
16795 127.0.0.1 783
16796 .endd
16797 See section &<<SECTscanspamass>>& for more details.
16798
16799
16800
16801 .option split_spool_directory main boolean false
16802 .cindex "multiple spool directories"
16803 .cindex "spool directory" "split"
16804 .cindex "directories, multiple"
16805 If this option is set, it causes Exim to split its input directory into 62
16806 subdirectories, each with a single alphanumeric character as its name. The
16807 sixth character of the message id is used to allocate messages to
16808 subdirectories; this is the least significant base-62 digit of the time of
16809 arrival of the message.
16810
16811 Splitting up the spool in this way may provide better performance on systems
16812 where there are long mail queues, by reducing the number of files in any one
16813 directory. The msglog directory is also split up in a similar way to the input
16814 directory; however, if &%preserve_message_logs%& is set, all old msglog files
16815 are still placed in the single directory &_msglog.OLD_&.
16816
16817 It is not necessary to take any special action for existing messages when
16818 changing &%split_spool_directory%&. Exim notices messages that are in the
16819 &"wrong"& place, and continues to process them. If the option is turned off
16820 after a period of being on, the subdirectories will eventually empty and be
16821 automatically deleted.
16822
16823 When &%split_spool_directory%& is set, the behaviour of queue runner processes
16824 changes. Instead of creating a list of all messages in the queue, and then
16825 trying to deliver each one in turn, it constructs a list of those in one
16826 sub-directory and tries to deliver them, before moving on to the next
16827 sub-directory. The sub-directories are processed in a random order. This
16828 spreads out the scanning of the input directories, and uses less memory. It is
16829 particularly beneficial when there are lots of messages on the queue. However,
16830 if &%queue_run_in_order%& is set, none of this new processing happens. The
16831 entire queue has to be scanned and sorted before any deliveries can start.
16832
16833
16834 .option spool_directory main string&!! "set at compile time"
16835 .cindex "spool directory" "path to"
16836 This defines the directory in which Exim keeps its spool, that is, the messages
16837 it is waiting to deliver. The default value is taken from the compile-time
16838 configuration setting, if there is one. If not, this option must be set. The
16839 string is expanded, so it can contain, for example, a reference to
16840 &$primary_hostname$&.
16841
16842 If the spool directory name is fixed on your installation, it is recommended
16843 that you set it at build time rather than from this option, particularly if the
16844 log files are being written to the spool directory (see &%log_file_path%&).
16845 Otherwise log files cannot be used for errors that are detected early on, such
16846 as failures in the configuration file.
16847
16848 By using this option to override the compiled-in path, it is possible to run
16849 tests of Exim without using the standard spool.
16850
16851 .new
16852 .option spool_wireformat main boolean false
16853 .cindex "spool directory" "file formats"
16854 If this option is set, Exim may for some messages use an alternate format
16855 for data-files in the spool which matches the wire format.
16856 Doing this permits more efficient message reception and transmission.
16857 Currently it is only done for messages received using the EMSTP CHUNKING
16858 option.
16859
16860 The following variables will not have useful values:
16861 .code
16862 $max_received_linelength
16863 $body_linecount
16864 $body_zerocount
16865 .endd
16866
16867 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
16868 and any external programs which are passed a reference to a message data file
16869 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
16870 will need to be aware of the potential different format.
16871
16872 Using any of the ACL conditions noted will negate the reception benefit
16873 (as a Unix-mbox-format file is contructed for them).
16874 The transimssion benefit is maintained.
16875 .wen
16876
16877 .option sqlite_lock_timeout main time 5s
16878 .cindex "sqlite lookup type" "lock timeout"
16879 This option controls the timeout that the &(sqlite)& lookup uses when trying to
16880 access an SQLite database. See section &<<SECTsqlite>>& for more details.
16881
16882 .option strict_acl_vars main boolean false
16883 .cindex "&ACL;" "variables, handling unset"
16884 This option controls what happens if a syntactically valid but undefined ACL
16885 variable is referenced. If it is false (the default), an empty string
16886 is substituted; if it is true, an error is generated. See section
16887 &<<SECTaclvariables>>& for details of ACL variables.
16888
16889 .option strip_excess_angle_brackets main boolean false
16890 .cindex "angle brackets, excess"
16891 If this option is set, redundant pairs of angle brackets round &"route-addr"&
16892 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
16893 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
16894 passed on to another MTA, the excess angle brackets are not passed on. If this
16895 option is not set, multiple pairs of angle brackets cause a syntax error.
16896
16897
16898 .option strip_trailing_dot main boolean false
16899 .cindex "trailing dot on domain"
16900 .cindex "dot" "trailing on domain"
16901 If this option is set, a trailing dot at the end of a domain in an address is
16902 ignored. If this is in the envelope and the message is passed on to another
16903 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
16904 domain causes a syntax error.
16905 However, addresses in header lines are checked only when an ACL requests header
16906 syntax checking.
16907
16908
16909 .option syslog_duplication main boolean true
16910 .cindex "syslog" "duplicate log lines; suppressing"
16911 When Exim is logging to syslog, it writes the log lines for its three
16912 separate logs at different syslog priorities so that they can in principle
16913 be separated on the logging hosts. Some installations do not require this
16914 separation, and in those cases, the duplication of certain log lines is a
16915 nuisance. If &%syslog_duplication%& is set false, only one copy of any
16916 particular log line is written to syslog. For lines that normally go to
16917 both the main log and the reject log, the reject log version (possibly
16918 containing message header lines) is written, at LOG_NOTICE priority.
16919 Lines that normally go to both the main and the panic log are written at
16920 the LOG_ALERT priority.
16921
16922
16923 .option syslog_facility main string unset
16924 .cindex "syslog" "facility; setting"
16925 This option sets the syslog &"facility"& name, used when Exim is logging to
16926 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
16927 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
16928 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
16929 details of Exim's logging.
16930
16931
16932 .option syslog_pid main boolean true
16933 .cindex "syslog" "pid"
16934 If &%syslog_pid%& is set false, the PID on Exim's log lines are
16935 omitted when these lines are sent to syslog. (Syslog normally prefixes
16936 the log lines with the PID of the logging process automatically.) You need
16937 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
16938 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
16939
16940
16941
16942 .option syslog_processname main string &`exim`&
16943 .cindex "syslog" "process name; setting"
16944 This option sets the syslog &"ident"& name, used when Exim is logging to
16945 syslog. The value must be no longer than 32 characters. See chapter
16946 &<<CHAPlog>>& for details of Exim's logging.
16947
16948
16949
16950 .option syslog_timestamp main boolean true
16951 .cindex "syslog" "timestamps"
16952 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
16953 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
16954 details of Exim's logging.
16955
16956
16957 .option system_filter main string&!! unset
16958 .cindex "filter" "system filter"
16959 .cindex "system filter" "specifying"
16960 .cindex "Sieve filter" "not available for system filter"
16961 This option specifies an Exim filter file that is applied to all messages at
16962 the start of each delivery attempt, before any routing is done. System filters
16963 must be Exim filters; they cannot be Sieve filters. If the system filter
16964 generates any deliveries to files or pipes, or any new mail messages, the
16965 appropriate &%system_filter_..._transport%& option(s) must be set, to define
16966 which transports are to be used. Details of this facility are given in chapter
16967 &<<CHAPsystemfilter>>&.
16968 A forced expansion failure results in no filter operation.
16969
16970
16971 .option system_filter_directory_transport main string&!! unset
16972 .vindex "&$address_file$&"
16973 This sets the name of the transport driver that is to be used when the
16974 &%save%& command in a system message filter specifies a path ending in &"/"&,
16975 implying delivery of each message into a separate file in some directory.
16976 During the delivery, the variable &$address_file$& contains the path name.
16977
16978
16979 .option system_filter_file_transport main string&!! unset
16980 .cindex "file" "transport for system filter"
16981 This sets the name of the transport driver that is to be used when the &%save%&
16982 command in a system message filter specifies a path not ending in &"/"&. During
16983 the delivery, the variable &$address_file$& contains the path name.
16984
16985 .option system_filter_group main string unset
16986 .cindex "gid (group id)" "system filter"
16987 This option is used only when &%system_filter_user%& is also set. It sets the
16988 gid under which the system filter is run, overriding any gid that is associated
16989 with the user. The value may be numerical or symbolic.
16990
16991 .option system_filter_pipe_transport main string&!! unset
16992 .cindex "&(pipe)& transport" "for system filter"
16993 .vindex "&$address_pipe$&"
16994 This specifies the transport driver that is to be used when a &%pipe%& command
16995 is used in a system filter. During the delivery, the variable &$address_pipe$&
16996 contains the pipe command.
16997
16998
16999 .option system_filter_reply_transport main string&!! unset
17000 .cindex "&(autoreply)& transport" "for system filter"
17001 This specifies the transport driver that is to be used when a &%mail%& command
17002 is used in a system filter.
17003
17004
17005 .option system_filter_user main string unset
17006 .cindex "uid (user id)" "system filter"
17007 If this option is set to root, the system filter is run in the main Exim
17008 delivery process, as root.  Otherwise, the system filter runs in a separate
17009 process, as the given user, defaulting to the Exim run-time user.
17010 Unless the string consists entirely of digits, it
17011 is looked up in the password data. Failure to find the named user causes a
17012 configuration error. The gid is either taken from the password data, or
17013 specified by &%system_filter_group%&. When the uid is specified numerically,
17014 &%system_filter_group%& is required to be set.
17015
17016 If the system filter generates any pipe, file, or reply deliveries, the uid
17017 under which the filter is run is used when transporting them, unless a
17018 transport option overrides.
17019
17020
17021 .option tcp_nodelay main boolean true
17022 .cindex "daemon" "TCP_NODELAY on sockets"
17023 .cindex "Nagle algorithm"
17024 .cindex "TCP_NODELAY on listening sockets"
17025 If this option is set false, it stops the Exim daemon setting the
17026 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17027 turns off the &"Nagle algorithm"&, which is a way of improving network
17028 performance in interactive (character-by-character) situations. Turning it off
17029 should improve Exim's performance a bit, so that is what happens by default.
17030 However, it appears that some broken clients cannot cope, and time out. Hence
17031 this option. It affects only those sockets that are set up for listening by the
17032 daemon. Sockets created by the smtp transport for delivering mail always set
17033 TCP_NODELAY.
17034
17035
17036 .option timeout_frozen_after main time 0s
17037 .cindex "frozen messages" "timing out"
17038 .cindex "timeout" "frozen messages"
17039 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17040 message of any kind that has been on the queue for longer than the given time
17041 is automatically cancelled at the next queue run. If the frozen message is a
17042 bounce message, it is just discarded; otherwise, a bounce is sent to the
17043 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17044 If you want to timeout frozen bounce messages earlier than other kinds of
17045 frozen message, see &%ignore_bounce_errors_after%&.
17046
17047 &*Note:*& the default value of zero means no timeouts; with this setting,
17048 frozen messages remain on the queue forever (except for any frozen bounce
17049 messages that are released by &%ignore_bounce_errors_after%&).
17050
17051
17052 .option timezone main string unset
17053 .cindex "timezone, setting"
17054 .cindex "environment" "values from"
17055 The value of &%timezone%& is used to set the environment variable TZ while
17056 running Exim (if it is different on entry). This ensures that all timestamps
17057 created by Exim are in the required timezone. If you want all your timestamps
17058 to be in UTC (aka GMT) you should set
17059 .code
17060 timezone = UTC
17061 .endd
17062 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17063 or, if that is not set, from the value of the TZ environment variable when Exim
17064 is built. If &%timezone%& is set to the empty string, either at build or run
17065 time, any existing TZ variable is removed from the environment when Exim
17066 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17067 unfortunately not all, operating systems.
17068
17069
17070 .option tls_advertise_hosts main "host list&!!" *
17071 .cindex "TLS" "advertising"
17072 .cindex "encryption" "on SMTP connection"
17073 .cindex "SMTP" "encrypted connection"
17074 When Exim is built with support for TLS encrypted connections, the availability
17075 of the STARTTLS command to set up an encrypted session is advertised in
17076 response to EHLO only to those client hosts that match this option. See
17077 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17078 Note that the default value requires that a certificate be supplied
17079 using the &%tls_certificate%& option.  If TLS support for incoming connections
17080 is not required the &%tls_advertise_hosts%& option should be set empty.
17081
17082
17083 .option tls_certificate main string&!! unset
17084 .cindex "TLS" "server certificate; location of"
17085 .cindex "certificate" "server, location of"
17086 The value of this option is expanded, and must then be the absolute path to a
17087 file which contains the server's certificates. The server's private key is also
17088 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17089 &<<CHAPTLS>>& for further details.
17090
17091 &*Note*&: The certificates defined by this option are used only when Exim is
17092 receiving incoming messages as a server. If you want to supply certificates for
17093 use when sending messages as a client, you must set the &%tls_certificate%&
17094 option in the relevant &(smtp)& transport.
17095
17096 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17097 if the OpenSSL build supports TLS extensions and the TLS client sends the
17098 Server Name Indication extension, then this option and others documented in
17099 &<<SECTtlssni>>& will be re-expanded.
17100
17101 If this option is unset or empty a fresh self-signed certificate will be
17102 generated for every connection.
17103
17104 .option tls_crl main string&!! unset
17105 .cindex "TLS" "server certificate revocation list"
17106 .cindex "certificate" "revocation list for server"
17107 This option specifies a certificate revocation list. The expanded value must
17108 be the name of a file that contains a CRL in PEM format.
17109
17110 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17111
17112
17113 .option tls_dh_max_bits main integer 2236
17114 .cindex "TLS" "D-H bit count"
17115 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17116 the chosen TLS library.  That value might prove to be too high for
17117 interoperability.  This option provides a maximum clamp on the value
17118 suggested, trading off security for interoperability.
17119
17120 The value must be at least 1024.
17121
17122 The value 2236 was chosen because, at time of adding the option, it was the
17123 hard-coded maximum value supported by the NSS cryptographic library, as used
17124 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17125
17126 If you prefer more security and are willing to break some clients, raise this
17127 number.
17128
17129 Note that the value passed to GnuTLS for *generating* a new prime may be a
17130 little less than this figure, because GnuTLS is inexact and may produce a
17131 larger prime than requested.
17132
17133
17134 .option tls_dhparam main string&!! unset
17135 .cindex "TLS" "D-H parameters for server"
17136 The value of this option is expanded and indicates the source of DH parameters
17137 to be used by Exim.
17138
17139 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17140 local DH parameters*&, which has been supported across all versions of Exim.  The
17141 other specific constants available are a fallback so that even when
17142 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17143
17144 If &%tls_dhparam%& is a filename starting with a &`/`&,
17145 then it names a file from which DH
17146 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17147 PKCS#3 representation of the DH prime.  If the file does not exist, for
17148 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17149 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17150 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17151 and treated as though the &%tls_dhparam%& were set to "none".
17152
17153 If this option expands to the string "none", then no DH parameters will be
17154 loaded by Exim.
17155
17156 If this option expands to the string "historic" and Exim is using GnuTLS, then
17157 Exim will attempt to load a file from inside the spool directory.  If the file
17158 does not exist, Exim will attempt to create it.
17159 See section &<<SECTgnutlsparam>>& for further details.
17160
17161 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17162 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17163
17164 In older versions of Exim the default was the 2048 bit prime described in section
17165 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17166 in IKE is assigned number 23.
17167
17168 Otherwise, the option must expand to the name used by Exim for any of a number
17169 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17170 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17171 the number used by IKE, or "default" which corresponds to
17172 &`exim.dev.20160529.3`&.
17173
17174 The available standard primes are:
17175 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17176 &`ike1`&, &`ike2`&, &`ike5`&,
17177 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17178 &`ike22`&, &`ike23`& and &`ike24`&.
17179
17180 The available additional primes are:
17181 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17182
17183 Some of these will be too small to be accepted by clients.
17184 Some may be too large to be accepted by clients.
17185 The open cryptographic community has suspicions about the integrity of some
17186 of the later IKE values, which led into RFC7919 providing new fixed constants
17187 (the "ffdhe" identifiers).
17188
17189 At this point, all of the "ike" values should be considered obsolete;
17190 they're still in Exim to avoid breaking unusual configurations, but are
17191 candidates for removal the next time we have backwards-incompatible changes.
17192
17193 The TLS protocol does not negotiate an acceptable size for this; clients tend
17194 to hard-drop connections if what is offered by the server is unacceptable,
17195 whether too large or too small, and there's no provision for the client to
17196 tell the server what these constraints are.  Thus, as a server operator, you
17197 need to make an educated guess as to what is most likely to work for your
17198 userbase.
17199
17200 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17201 is most likely to maximise interoperability.  The upper bound comes from
17202 applications using the Mozilla Network Security Services (NSS) library, which
17203 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17204 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17205 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17206 acceptable bound from 1024 to 2048.
17207
17208
17209 .option tls_eccurve main string&!! &`auto`&
17210 .cindex TLS "EC cryptography"
17211 This option selects a EC curve for use by Exim when used with OpenSSL.
17212 It has no effect when Exim is used with GnuTLS.
17213
17214 After expansion it must contain a valid EC curve parameter, such as
17215 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17216 for valid selections.
17217
17218 For OpenSSL versions before (and not including) 1.0.2, the string
17219 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17220 &`auto`& tells the library to choose.
17221
17222 If the option expands to an empty string, no EC curves will be enabled.
17223
17224
17225 .option tls_ocsp_file main string&!! unset
17226 .cindex TLS "certificate status"
17227 .cindex TLS "OCSP proof file"
17228 This option
17229 must if set expand to the absolute path to a file which contains a current
17230 status proof for the server's certificate, as obtained from the
17231 Certificate Authority.
17232
17233 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17234
17235
17236 .option tls_on_connect_ports main "string list" unset
17237 .cindex SSMTP
17238 .cindex SMTPS
17239 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17240 operate the obsolete SSMTP (SMTPS) protocol, where a TLS session is immediately
17241 set up without waiting for the client to issue a STARTTLS command. For
17242 further details, see section &<<SECTsupobssmt>>&.
17243
17244
17245
17246 .option tls_privatekey main string&!! unset
17247 .cindex "TLS" "server private key; location of"
17248 The value of this option is expanded, and must then be the absolute path to a
17249 file which contains the server's private key. If this option is unset, or if
17250 the expansion is forced to fail, or the result is an empty string, the private
17251 key is assumed to be in the same file as the server's certificates. See chapter
17252 &<<CHAPTLS>>& for further details.
17253
17254 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17255
17256
17257 .option tls_remember_esmtp main boolean false
17258 .cindex "TLS" "esmtp state; remembering"
17259 .cindex "TLS" "broken clients"
17260 If this option is set true, Exim violates the RFCs by remembering that it is in
17261 &"esmtp"& state after successfully negotiating a TLS session. This provides
17262 support for broken clients that fail to send a new EHLO after starting a
17263 TLS session.
17264
17265
17266 .option tls_require_ciphers main string&!! unset
17267 .cindex "TLS" "requiring specific ciphers"
17268 .cindex "cipher" "requiring specific"
17269 This option controls which ciphers can be used for incoming TLS connections.
17270 The &(smtp)& transport has an option of the same name for controlling outgoing
17271 connections. This option is expanded for each connection, so can be varied for
17272 different clients if required. The value of this option must be a list of
17273 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17274 in somewhat different ways. If GnuTLS is being used, the client controls the
17275 preference order of the available ciphers. Details are given in sections
17276 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17277
17278
17279 .option tls_try_verify_hosts main "host list&!!" unset
17280 .cindex "TLS" "client certificate verification"
17281 .cindex "certificate" "verification of client"
17282 See &%tls_verify_hosts%& below.
17283
17284
17285 .option tls_verify_certificates main string&!! system
17286 .cindex "TLS" "client certificate verification"
17287 .cindex "certificate" "verification of client"
17288 The value of this option is expanded, and must then be either the
17289 word "system"
17290 or the absolute path to
17291 a file or directory containing permitted certificates for clients that
17292 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17293
17294 The "system" value for the option will use a
17295 system default location compiled into the SSL library.
17296 This is not available for GnuTLS versions preceding 3.0.20,
17297 and will be taken as empty; an explicit location
17298 must be specified.
17299
17300 The use of a directory for the option value is not available for GnuTLS versions
17301 preceding 3.3.6 and a single file must be used.
17302
17303 With OpenSSL the certificates specified
17304 explicitly
17305 either by file or directory
17306 are added to those given by the system default location.
17307
17308 These certificates should be for the certificate authorities trusted, rather
17309 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17310 the value is a file then the certificates are sent by Exim as a server to
17311 connecting clients, defining the list of accepted certificate authorities.
17312 Thus the values defined should be considered public data.  To avoid this,
17313 use the explicit directory version.
17314
17315 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17316
17317 A forced expansion failure or setting to an empty string is equivalent to
17318 being unset.
17319
17320
17321 .option tls_verify_hosts main "host list&!!" unset
17322 .cindex "TLS" "client certificate verification"
17323 .cindex "certificate" "verification of client"
17324 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17325 certificates from clients. The expected certificates are defined by
17326 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17327 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17328 &%tls_verify_certificates%& is not set.
17329
17330 Any client that matches &%tls_verify_hosts%& is constrained by
17331 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17332 present one of the listed certificates. If it does not, the connection is
17333 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17334 the host to use TLS. It can still send SMTP commands through unencrypted
17335 connections. Forcing a client to use TLS has to be done separately using an
17336 ACL to reject inappropriate commands when the connection is not encrypted.
17337
17338 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17339 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17340 certificate and checks it against &%tls_verify_certificates%&, but does not
17341 abort the connection if there is no certificate or if it does not match. This
17342 state can be detected in an ACL, which makes it possible to implement policies
17343 such as &"accept for relay only if a verified certificate has been received,
17344 but accept for local delivery if encrypted, even without a verified
17345 certificate"&.
17346
17347 Client hosts that match neither of these lists are not asked to present
17348 certificates.
17349
17350
17351 .option trusted_groups main "string list&!!" unset
17352 .cindex "trusted groups"
17353 .cindex "groups" "trusted"
17354 This option is expanded just once, at the start of Exim's processing. If this
17355 option is set, any process that is running in one of the listed groups, or
17356 which has one of them as a supplementary group, is trusted. The groups can be
17357 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17358 details of what trusted callers are permitted to do. If neither
17359 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17360 are trusted.
17361
17362 .option trusted_users main "string list&!!" unset
17363 .cindex "trusted users"
17364 .cindex "user" "trusted"
17365 This option is expanded just once, at the start of Exim's processing. If this
17366 option is set, any process that is running as one of the listed users is
17367 trusted. The users can be specified numerically or by name. See section
17368 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17369 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17370 Exim user are trusted.
17371
17372 .option unknown_login main string&!! unset
17373 .cindex "uid (user id)" "unknown caller"
17374 .vindex "&$caller_uid$&"
17375 This is a specialized feature for use in unusual configurations. By default, if
17376 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17377 gives up. The &%unknown_login%& option can be used to set a login name to be
17378 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17379 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17380 is used for the user's real name (gecos field), unless this has been set by the
17381 &%-F%& option.
17382
17383 .option unknown_username main string unset
17384 See &%unknown_login%&.
17385
17386 .option untrusted_set_sender main "address list&!!" unset
17387 .cindex "trusted users"
17388 .cindex "sender" "setting by untrusted user"
17389 .cindex "untrusted user setting sender"
17390 .cindex "user" "untrusted setting sender"
17391 .cindex "envelope sender"
17392 When an untrusted user submits a message to Exim using the standard input, Exim
17393 normally creates an envelope sender address from the user's login and the
17394 default qualification domain. Data from the &%-f%& option (for setting envelope
17395 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17396 is used) is ignored.
17397
17398 However, untrusted users are permitted to set an empty envelope sender address,
17399 to declare that a message should never generate any bounces. For example:
17400 .code
17401 exim -f '<>' user@domain.example
17402 .endd
17403 .vindex "&$sender_ident$&"
17404 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17405 other envelope sender addresses in a controlled way. When it is set, untrusted
17406 users are allowed to set envelope sender addresses that match any of the
17407 patterns in the list. Like all address lists, the string is expanded. The
17408 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17409 users to setting senders that start with their login ids
17410 followed by a hyphen
17411 by a setting like this:
17412 .code
17413 untrusted_set_sender = ^$sender_ident-
17414 .endd
17415 If you want to allow untrusted users to set envelope sender addresses without
17416 restriction, you can use
17417 .code
17418 untrusted_set_sender = *
17419 .endd
17420 The &%untrusted_set_sender%& option applies to all forms of local input, but
17421 only to the setting of the envelope sender. It does not permit untrusted users
17422 to use the other options which trusted user can use to override message
17423 parameters. Furthermore, it does not stop Exim from removing an existing
17424 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17425 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17426 overriding these actions. The handling of the &'Sender:'& header is also
17427 described in section &<<SECTthesenhea>>&.
17428
17429 The log line for a message's arrival shows the envelope sender following
17430 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17431 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17432 envelope sender address, the user's login is shown in parentheses after the
17433 sender address.
17434
17435
17436 .option uucp_from_pattern main string "see below"
17437 .cindex "&""From""& line"
17438 .cindex "UUCP" "&""From""& line"
17439 Some applications that pass messages to an MTA via a command line interface use
17440 an initial line starting with &"From&~"& to pass the envelope sender. In
17441 particular, this is used by UUCP software. Exim recognizes such a line by means
17442 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17443 matches, the sender address is constructed by expanding the contents of
17444 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17445 default pattern recognizes lines in the following two forms:
17446 .code
17447 From ph10 Fri Jan  5 12:35 GMT 1996
17448 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17449 .endd
17450 The pattern can be seen by running
17451 .code
17452 exim -bP uucp_from_pattern
17453 .endd
17454 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17455 year in the second case. The first word after &"From&~"& is matched in the
17456 regular expression by a parenthesized subpattern. The default value for
17457 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17458 (&"ph10"& in the example above) as the message's sender. See also
17459 &%ignore_fromline_hosts%&.
17460
17461
17462 .option uucp_from_sender main string&!! &`$1`&
17463 See &%uucp_from_pattern%& above.
17464
17465
17466 .option warn_message_file main string unset
17467 .cindex "warning of delay" "customizing the message"
17468 .cindex "customizing" "warning message"
17469 This option defines a template file containing paragraphs of text to be used
17470 for constructing the warning message which is sent by Exim when a message has
17471 been on the queue for a specified amount of time, as specified by
17472 &%delay_warning%&. Details of the file's contents are given in chapter
17473 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17474
17475
17476 .option write_rejectlog main boolean true
17477 .cindex "reject log" "disabling"
17478 If this option is set false, Exim no longer writes anything to the reject log.
17479 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17480 .ecindex IIDconfima
17481 .ecindex IIDmaiconf
17482
17483
17484
17485
17486 . ////////////////////////////////////////////////////////////////////////////
17487 . ////////////////////////////////////////////////////////////////////////////
17488
17489 .chapter "Generic options for routers" "CHAProutergeneric"
17490 .scindex IIDgenoprou1 "options" "generic; for routers"
17491 .scindex IIDgenoprou2 "generic options" "router"
17492 This chapter describes the generic options that apply to all routers.
17493 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17494
17495 For a general description of how a router operates, see sections
17496 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17497 which the preconditions are tested. The order of expansion of the options that
17498 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17499 &%headers_remove%&, &%transport%&.
17500
17501
17502
17503 .option address_data routers string&!! unset
17504 .cindex "router" "data attached to address"
17505 The string is expanded just before the router is run, that is, after all the
17506 precondition tests have succeeded. If the expansion is forced to fail, the
17507 router declines, the value of &%address_data%& remains unchanged, and the
17508 &%more%& option controls what happens next. Other expansion failures cause
17509 delivery of the address to be deferred.
17510
17511 .vindex "&$address_data$&"
17512 When the expansion succeeds, the value is retained with the address, and can be
17513 accessed using the variable &$address_data$& in the current router, subsequent
17514 routers, and the eventual transport.
17515
17516 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
17517 that runs a user's filter file, the contents of &$address_data$& are accessible
17518 in the filter. This is not normally a problem, because such data is usually
17519 either not confidential or it &"belongs"& to the current user, but if you do
17520 put confidential data into &$address_data$& you need to remember this point.
17521
17522 Even if the router declines or passes, the value of &$address_data$& remains
17523 with the address, though it can be changed by another &%address_data%& setting
17524 on a subsequent router. If a router generates child addresses, the value of
17525 &$address_data$& propagates to them. This also applies to the special kind of
17526 &"child"& that is generated by a router with the &%unseen%& option.
17527
17528 The idea of &%address_data%& is that you can use it to look up a lot of data
17529 for the address once, and then pick out parts of the data later. For example,
17530 you could use a single LDAP lookup to return a string of the form
17531 .code
17532 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
17533 .endd
17534 In the transport you could pick out the mailbox by a setting such as
17535 .code
17536 file = ${extract{mailbox}{$address_data}}
17537 .endd
17538 This makes the configuration file less messy, and also reduces the number of
17539 lookups (though Exim does cache lookups).
17540
17541 .vindex "&$sender_address_data$&"
17542 .vindex "&$address_data$&"
17543 The &%address_data%& facility is also useful as a means of passing information
17544 from one router to another, and from a router to a transport. In addition, if
17545 &$address_data$& is set by a router when verifying a recipient address from an
17546 ACL, it remains available for use in the rest of the ACL statement. After
17547 verifying a sender, the value is transferred to &$sender_address_data$&.
17548
17549
17550
17551 .option address_test routers&!? boolean true
17552 .oindex "&%-bt%&"
17553 .cindex "router" "skipping when address testing"
17554 If this option is set false, the router is skipped when routing is being tested
17555 by means of the &%-bt%& command line option. This can be a convenience when
17556 your first router sends messages to an external scanner, because it saves you
17557 having to set the &"already scanned"& indicator when testing real address
17558 routing.
17559
17560
17561
17562 .option cannot_route_message routers string&!! unset
17563 .cindex "router" "customizing &""cannot route""& message"
17564 .cindex "customizing" "&""cannot route""& message"
17565 This option specifies a text message that is used when an address cannot be
17566 routed because Exim has run out of routers. The default message is
17567 &"Unrouteable address"&. This option is useful only on routers that have
17568 &%more%& set false, or on the very last router in a configuration, because the
17569 value that is used is taken from the last router that is considered. This
17570 includes a router that is skipped because its preconditions are not met, as
17571 well as a router that declines. For example, using the default configuration,
17572 you could put:
17573 .code
17574 cannot_route_message = Remote domain not found in DNS
17575 .endd
17576 on the first router, which is a &(dnslookup)& router with &%more%& set false,
17577 and
17578 .code
17579 cannot_route_message = Unknown local user
17580 .endd
17581 on the final router that checks for local users. If string expansion fails for
17582 this option, the default message is used. Unless the expansion failure was
17583 explicitly forced, a message about the failure is written to the main and panic
17584 logs, in addition to the normal message about the routing failure.
17585
17586
17587 .option caseful_local_part routers boolean false
17588 .cindex "case of local parts"
17589 .cindex "router" "case of local parts"
17590 By default, routers handle the local parts of addresses in a case-insensitive
17591 manner, though the actual case is preserved for transmission with the message.
17592 If you want the case of letters to be significant in a router, you must set
17593 this option true. For individual router options that contain address or local
17594 part lists (for example, &%local_parts%&), case-sensitive matching can be
17595 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
17596 more details.
17597
17598 .vindex "&$local_part$&"
17599 .vindex "&$original_local_part$&"
17600 .vindex "&$parent_local_part$&"
17601 The value of the &$local_part$& variable is forced to lower case while a
17602 router is running unless &%caseful_local_part%& is set. When a router assigns
17603 an address to a transport, the value of &$local_part$& when the transport runs
17604 is the same as it was in the router. Similarly, when a router generates child
17605 addresses by aliasing or forwarding, the values of &$original_local_part$&
17606 and &$parent_local_part$& are those that were used by the redirecting router.
17607
17608 This option applies to the processing of an address by a router. When a
17609 recipient address is being processed in an ACL, there is a separate &%control%&
17610 modifier that can be used to specify case-sensitive processing within the ACL
17611 (see section &<<SECTcontrols>>&).
17612
17613
17614
17615 .option check_local_user routers&!? boolean false
17616 .cindex "local user, checking in router"
17617 .cindex "router" "checking for local user"
17618 .cindex "&_/etc/passwd_&"
17619 .vindex "&$home$&"
17620 When this option is true, Exim checks that the local part of the recipient
17621 address (with affixes removed if relevant) is the name of an account on the
17622 local system. The check is done by calling the &[getpwnam()]& function rather
17623 than trying to read &_/etc/passwd_& directly. This means that other methods of
17624 holding password data (such as NIS) are supported. If the local part is a local
17625 user, &$home$& is set from the password data, and can be tested in other
17626 preconditions that are evaluated after this one (the order of evaluation is
17627 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
17628 overridden by &%router_home_directory%&. If the local part is not a local user,
17629 the router is skipped.
17630
17631 If you want to check that the local part is either the name of a local user
17632 or matches something else, you cannot combine &%check_local_user%& with a
17633 setting of &%local_parts%&, because that specifies the logical &'and'& of the
17634 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
17635 setting to achieve this. For example:
17636 .code
17637 local_parts = passwd;$local_part : lsearch;/etc/other/users
17638 .endd
17639 Note, however, that the side effects of &%check_local_user%& (such as setting
17640 up a home directory) do not occur when a &(passwd)& lookup is used in a
17641 &%local_parts%& (or any other) precondition.
17642
17643
17644
17645 .option condition routers&!? string&!! unset
17646 .cindex "router" "customized precondition"
17647 This option specifies a general precondition test that has to succeed for the
17648 router to be called. The &%condition%& option is the last precondition to be
17649 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
17650 result is a forced failure, or an empty string, or one of the strings &"0"& or
17651 &"no"& or &"false"& (checked without regard to the case of the letters), the
17652 router is skipped, and the address is offered to the next one.
17653
17654 If the result is any other value, the router is run (as this is the last
17655 precondition to be evaluated, all the other preconditions must be true).
17656
17657 This option is unusual in that multiple &%condition%& options may be present.
17658 All &%condition%& options must succeed.
17659
17660 The &%condition%& option provides a means of applying custom conditions to the
17661 running of routers. Note that in the case of a simple conditional expansion,
17662 the default expansion values are exactly what is wanted. For example:
17663 .code
17664 condition = ${if >{$message_age}{600}}
17665 .endd
17666 Because of the default behaviour of the string expansion, this is equivalent to
17667 .code
17668 condition = ${if >{$message_age}{600}{true}{}}
17669 .endd
17670
17671 A multiple condition example, which succeeds:
17672 .code
17673 condition = ${if >{$message_age}{600}}
17674 condition = ${if !eq{${lc:$local_part}}{postmaster}}
17675 condition = foobar
17676 .endd
17677
17678 If the expansion fails (other than forced failure) delivery is deferred. Some
17679 of the other precondition options are common special cases that could in fact
17680 be specified using &%condition%&.
17681
17682 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
17683 are far older, and use one set of semantics.  ACLs are newer and when
17684 they were created, the ACL &%condition%& process was given far stricter
17685 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
17686 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
17687 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
17688 Router rules processing behavior.
17689
17690 This is best illustrated in an example:
17691 .code
17692 # If used in an ACL condition will fail with a syntax error, but
17693 # in a router condition any extra characters are treated as a string
17694
17695 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
17696 true {yes} {no}}
17697
17698 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
17699  {yes} {no}}
17700 .endd
17701 In each example above, the &%if%& statement actually ends after
17702 &"{google.com}}"&.  Since no true or false braces were defined, the
17703 default &%if%& behavior is to return a boolean true or a null answer
17704 (which evaluates to false). The rest of the line is then treated as a
17705 string. So the first example resulted in the boolean answer &"true"&
17706 with the string &" {yes} {no}}"& appended to it. The second example
17707 resulted in the null output (indicating false) with the string
17708 &" {yes} {no}}"& appended to it.
17709
17710 In fact you can put excess forward braces in too.  In the router
17711 &%condition%&, Exim's parser only looks for &"{"& symbols when they
17712 mean something, like after a &"$"& or when required as part of a
17713 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
17714 string characters.
17715
17716 Thus, in a Router, the above expansion strings will both always evaluate
17717 true, as the result of expansion is a non-empty string which doesn't
17718 match an explicit false value.  This can be tricky to debug.  By
17719 contrast, in an ACL either of those strings will always result in an
17720 expansion error because the result doesn't look sufficiently boolean.
17721
17722
17723 .option debug_print routers string&!! unset
17724 .cindex "testing" "variables in drivers"
17725 If this option is set and debugging is enabled (see the &%-d%& command line
17726 option) or in address-testing mode (see the &%-bt%& command line option),
17727 the string is expanded and included in the debugging output.
17728 If expansion of the string fails, the error message is written to the debugging
17729 output, and Exim carries on processing.
17730 This option is provided to help with checking out the values of variables and
17731 so on when debugging router configurations. For example, if a &%condition%&
17732 option appears not to be working, &%debug_print%& can be used to output the
17733 variables it references. The output happens after checks for &%domains%&,
17734 &%local_parts%&, and &%check_local_user%& but before any other preconditions
17735 are tested. A newline is added to the text if it does not end with one.
17736 The variable &$router_name$& contains the name of the router.
17737
17738
17739
17740 .option disable_logging routers boolean false
17741 If this option is set true, nothing is logged for any routing errors
17742 or for any deliveries caused by this router. You should not set this option
17743 unless you really, really know what you are doing. See also the generic
17744 transport option of the same name.
17745
17746 .option dnssec_request_domains routers "domain list&!!" unset
17747 .cindex "MX record" "security"
17748 .cindex "DNSSEC" "MX lookup"
17749 .cindex "security" "MX lookup"
17750 .cindex "DNS" "DNSSEC"
17751 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
17752 the dnssec request bit set.
17753 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17754
17755 .option dnssec_require_domains routers "domain list&!!" unset
17756 .cindex "MX record" "security"
17757 .cindex "DNSSEC" "MX lookup"
17758 .cindex "security" "MX lookup"
17759 .cindex "DNS" "DNSSEC"
17760 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
17761 the dnssec request bit set.  Any returns not having the Authenticated Data bit
17762 (AD bit) set will be ignored and logged as a host-lookup failure.
17763 This applies to all of the SRV, MX, AAAA, A lookup sequence.
17764
17765
17766 .option domains routers&!? "domain list&!!" unset
17767 .cindex "router" "restricting to specific domains"
17768 .vindex "&$domain_data$&"
17769 If this option is set, the router is skipped unless the current domain matches
17770 the list. If the match is achieved by means of a file lookup, the data that the
17771 lookup returned for the domain is placed in &$domain_data$& for use in string
17772 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
17773 a list of the order in which preconditions are evaluated.
17774
17775
17776
17777 .option driver routers string unset
17778 This option must always be set. It specifies which of the available routers is
17779 to be used.
17780
17781
17782 .option dsn_lasthop routers boolean false
17783 .cindex "DSN" "success"
17784 .cindex "Delivery Status Notification" "success"
17785 If this option is set true, and extended DSN (RFC3461) processing is in effect,
17786 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
17787 instead send a success DSN as if the next hop does not support DSN.
17788 Not effective on redirect routers.
17789
17790
17791
17792 .option errors_to routers string&!! unset
17793 .cindex "envelope sender"
17794 .cindex "router" "changing address for errors"
17795 If a router successfully handles an address, it may assign the address to a
17796 transport for delivery or it may generate child addresses. In both cases, if
17797 there is a delivery problem during later processing, the resulting bounce
17798 message is sent to the address that results from expanding this string,
17799 provided that the address verifies successfully. The &%errors_to%& option is
17800 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
17801
17802 The &%errors_to%& setting associated with an address can be overridden if it
17803 subsequently passes through other routers that have their own &%errors_to%&
17804 settings, or if the message is delivered by a transport with a &%return_path%&
17805 setting.
17806
17807 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
17808 the expansion fails to verify, the errors address associated with the incoming
17809 address is used. At top level, this is the envelope sender. A non-forced
17810 expansion failure causes delivery to be deferred.
17811
17812 If an address for which &%errors_to%& has been set ends up being delivered over
17813 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
17814 any bounces that are generated by other MTAs on the delivery route are also
17815 sent there. You can set &%errors_to%& to the empty string by either of these
17816 settings:
17817 .code
17818 errors_to =
17819 errors_to = ""
17820 .endd
17821 An expansion item that yields an empty string has the same effect. If you do
17822 this, a locally detected delivery error for addresses processed by this router
17823 no longer gives rise to a bounce message; the error is discarded. If the
17824 address is delivered to a remote host, the return path is set to &`<>`&, unless
17825 overridden by the &%return_path%& option on the transport.
17826
17827 .vindex "&$address_data$&"
17828 If for some reason you want to discard local errors, but use a non-empty
17829 MAIL command for remote delivery, you can preserve the original return
17830 path in &$address_data$& in the router, and reinstate it in the transport by
17831 setting &%return_path%&.
17832
17833 The most common use of &%errors_to%& is to direct mailing list bounces to the
17834 manager of the list, as described in section &<<SECTmailinglists>>&, or to
17835 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
17836
17837
17838
17839 .option expn routers&!? boolean true
17840 .cindex "address" "testing"
17841 .cindex "testing" "addresses"
17842 .cindex "EXPN" "router skipping"
17843 .cindex "router" "skipping for EXPN"
17844 If this option is turned off, the router is skipped when testing an address
17845 as a result of processing an SMTP EXPN command. You might, for example,
17846 want to turn it off on a router for users' &_.forward_& files, while leaving it
17847 on for the system alias file.
17848 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
17849 are evaluated.
17850
17851 The use of the SMTP EXPN command is controlled by an ACL (see chapter
17852 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
17853 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
17854
17855
17856
17857 .option fail_verify routers boolean false
17858 .cindex "router" "forcing verification failure"
17859 Setting this option has the effect of setting both &%fail_verify_sender%& and
17860 &%fail_verify_recipient%& to the same value.
17861
17862
17863
17864 .option fail_verify_recipient routers boolean false
17865 If this option is true and an address is accepted by this router when
17866 verifying a recipient, verification fails.
17867
17868
17869
17870 .option fail_verify_sender routers boolean false
17871 If this option is true and an address is accepted by this router when
17872 verifying a sender, verification fails.
17873
17874
17875
17876 .option fallback_hosts routers "string list" unset
17877 .cindex "router" "fallback hosts"
17878 .cindex "fallback" "hosts specified on router"
17879 String expansion is not applied to this option. The argument must be a
17880 colon-separated list of host names or IP addresses. The list separator can be
17881 changed (see section &<<SECTlistconstruct>>&), and a port can be specified with
17882 each name or address. In fact, the format of each item is exactly the same as
17883 defined for the list of hosts in a &(manualroute)& router (see section
17884 &<<SECTformatonehostitem>>&).
17885
17886 If a router queues an address for a remote transport, this host list is
17887 associated with the address, and used instead of the transport's fallback host
17888 list. If &%hosts_randomize%& is set on the transport, the order of the list is
17889 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
17890 transport for further details.
17891
17892
17893 .option group routers string&!! "see below"
17894 .cindex "gid (group id)" "local delivery"
17895 .cindex "local transports" "uid and gid"
17896 .cindex "transport" "local"
17897 .cindex "router" "setting group"
17898 When a router queues an address for a transport, and the transport does not
17899 specify a group, the group given here is used when running the delivery
17900 process.
17901 The group may be specified numerically or by name. If expansion fails, the
17902 error is logged and delivery is deferred.
17903 The default is unset, unless &%check_local_user%& is set, when the default
17904 is taken from the password information. See also &%initgroups%& and &%user%&
17905 and the discussion in chapter &<<CHAPenvironment>>&.
17906
17907
17908
17909 .option headers_add routers list&!! unset
17910 .cindex "header lines" "adding"
17911 .cindex "router" "adding header lines"
17912 This option specifies a list of text headers,
17913 newline-separated (by default, changeable in the usual way),
17914 that is associated with any addresses that are accepted by the router.
17915 Each item is separately expanded, at routing time.  However, this
17916 option has no effect when an address is just being verified. The way in which
17917 the text is used to add header lines at transport time is described in section
17918 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
17919 message is in the process of being transported. This means that references to
17920 header lines in string expansions in the transport's configuration do not
17921 &"see"& the added header lines.
17922
17923 The &%headers_add%& option is expanded after &%errors_to%&, but before
17924 &%headers_remove%& and &%transport%&. If an item is empty, or if
17925 an item expansion is forced to fail, the item has no effect. Other expansion
17926 failures are treated as configuration errors.
17927
17928 Unlike most options, &%headers_add%& can be specified multiple times
17929 for a router; all listed headers are added.
17930
17931 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
17932 router that has the &%one_time%& option set.
17933
17934 .cindex "duplicate addresses"
17935 .oindex "&%unseen%&"
17936 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17937 additions are deleted when the address is passed on to subsequent routers.
17938 For a &%redirect%& router, if a generated address is the same as the incoming
17939 address, this can lead to duplicate addresses with different header
17940 modifications. Exim does not do duplicate deliveries (except, in certain
17941 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
17942 which of the duplicates is discarded, so this ambiguous situation should be
17943 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
17944
17945
17946
17947 .option headers_remove routers list&!! unset
17948 .cindex "header lines" "removing"
17949 .cindex "router" "removing header lines"
17950 This option specifies a list of text headers,
17951 colon-separated (by default, changeable in the usual way),
17952 that is associated with any addresses that are accepted by the router.
17953 Each item is separately expanded, at routing time.  However, this
17954 option has no effect when an address is just being verified. The way in which
17955 the text is used to remove header lines at transport time is described in
17956 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
17957 the message is in the process of being transported. This means that references
17958 to header lines in string expansions in the transport's configuration still
17959 &"see"& the original header lines.
17960
17961 The &%headers_remove%& option is expanded after &%errors_to%& and
17962 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
17963 the item has no effect. Other expansion failures are treated as configuration
17964 errors.
17965
17966 Unlike most options, &%headers_remove%& can be specified multiple times
17967 for a router; all listed headers are removed.
17968
17969 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
17970 router that has the &%one_time%& option set.
17971
17972 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
17973 removal requests are deleted when the address is passed on to subsequent
17974 routers, and this can lead to problems with duplicates -- see the similar
17975 warning for &%headers_add%& above.
17976
17977 &*Warning 3*&: Because of the separate expansion of the list items,
17978 items that contain a list separator must have it doubled.
17979 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
17980
17981
17982
17983 .option ignore_target_hosts routers "host list&!!" unset
17984 .cindex "IP address" "discarding"
17985 .cindex "router" "discarding IP addresses"
17986 Although this option is a host list, it should normally contain IP address
17987 entries rather than names. If any host that is looked up by the router has an
17988 IP address that matches an item in this list, Exim behaves as if that IP
17989 address did not exist. This option allows you to cope with rogue DNS entries
17990 like
17991 .code
17992 remote.domain.example.  A  127.0.0.1
17993 .endd
17994 by setting
17995 .code
17996 ignore_target_hosts = 127.0.0.1
17997 .endd
17998 on the relevant router. If all the hosts found by a &(dnslookup)& router are
17999 discarded in this way, the router declines. In a conventional configuration, an
18000 attempt to mail to such a domain would normally provoke the &"unrouteable
18001 domain"& error, and an attempt to verify an address in the domain would fail.
18002 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18003 router declines if presented with one of the listed addresses.
18004
18005 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18006 means of the first or the second of the following settings, respectively:
18007 .code
18008 ignore_target_hosts = 0.0.0.0/0
18009 ignore_target_hosts = <; 0::0/0
18010 .endd
18011 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18012 in the second line matches all IPv6 addresses.
18013
18014 This option may also be useful for ignoring link-local and site-local IPv6
18015 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18016 is expanded before use as a list, it is possible to make it dependent on the
18017 domain that is being routed.
18018
18019 .vindex "&$host_address$&"
18020 During its expansion, &$host_address$& is set to the IP address that is being
18021 checked.
18022
18023 .option initgroups routers boolean false
18024 .cindex "additional groups"
18025 .cindex "groups" "additional"
18026 .cindex "local transports" "uid and gid"
18027 .cindex "transport" "local"
18028 If the router queues an address for a transport, and this option is true, and
18029 the uid supplied by the router is not overridden by the transport, the
18030 &[initgroups()]& function is called when running the transport to ensure that
18031 any additional groups associated with the uid are set up. See also &%group%&
18032 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18033
18034
18035
18036 .option local_part_prefix routers&!? "string list" unset
18037 .cindex "router" "prefix for local part"
18038 .cindex "prefix" "for local part, used in router"
18039 If this option is set, the router is skipped unless the local part starts with
18040 one of the given strings, or &%local_part_prefix_optional%& is true. See
18041 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18042 evaluated.
18043
18044 The list is scanned from left to right, and the first prefix that matches is
18045 used. A limited form of wildcard is available; if the prefix begins with an
18046 asterisk, it matches the longest possible sequence of arbitrary characters at
18047 the start of the local part. An asterisk should therefore always be followed by
18048 some character that does not occur in normal local parts.
18049 .cindex "multiple mailboxes"
18050 .cindex "mailbox" "multiple"
18051 Wildcarding can be used to set up multiple user mailboxes, as described in
18052 section &<<SECTmulbox>>&.
18053
18054 .vindex "&$local_part$&"
18055 .vindex "&$local_part_prefix$&"
18056 During the testing of the &%local_parts%& option, and while the router is
18057 running, the prefix is removed from the local part, and is available in the
18058 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18059 the router accepts the address, this remains true during subsequent delivery by
18060 a transport. In particular, the local part that is transmitted in the RCPT
18061 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18062 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18063 the relevant transport.
18064
18065 When an address is being verified, &%local_part_prefix%& affects only the
18066 behaviour of the router. If the callout feature of verification is in use, this
18067 means that the full address, including the prefix, will be used during the
18068 callout.
18069
18070 The prefix facility is commonly used to handle local parts of the form
18071 &%owner-something%&. Another common use is to support local parts of the form
18072 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18073 to tell a user their forwarding is broken &-- by placing a router like this one
18074 immediately before the router that handles &_.forward_& files:
18075 .code
18076 real_localuser:
18077   driver = accept
18078   local_part_prefix = real-
18079   check_local_user
18080   transport = local_delivery
18081 .endd
18082 For security, it would probably be a good idea to restrict the use of this
18083 router to locally-generated messages, using a condition such as this:
18084 .code
18085   condition = ${if match {$sender_host_address}\
18086                          {\N^(|127\.0\.0\.1)$\N}}
18087 .endd
18088
18089 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18090 both conditions must be met if not optional. Care must be taken if wildcards
18091 are used in both a prefix and a suffix on the same router. Different
18092 separator characters must be used to avoid ambiguity.
18093
18094
18095 .option local_part_prefix_optional routers boolean false
18096 See &%local_part_prefix%& above.
18097
18098
18099
18100 .option local_part_suffix routers&!? "string list" unset
18101 .cindex "router" "suffix for local part"
18102 .cindex "suffix for local part" "used in router"
18103 This option operates in the same way as &%local_part_prefix%&, except that the
18104 local part must end (rather than start) with the given string, the
18105 &%local_part_suffix_optional%& option determines whether the suffix is
18106 mandatory, and the wildcard * character, if present, must be the last
18107 character of the suffix. This option facility is commonly used to handle local
18108 parts of the form &%something-request%& and multiple user mailboxes of the form
18109 &%username-foo%&.
18110
18111
18112 .option local_part_suffix_optional routers boolean false
18113 See &%local_part_suffix%& above.
18114
18115
18116
18117 .option local_parts routers&!? "local part list&!!" unset
18118 .cindex "router" "restricting to specific local parts"
18119 .cindex "local part" "checking in router"
18120 The router is run only if the local part of the address matches the list.
18121 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18122 are evaluated, and
18123 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18124 string is expanded, it is possible to make it depend on the domain, for
18125 example:
18126 .code
18127 local_parts = dbm;/usr/local/specials/$domain
18128 .endd
18129 .vindex "&$local_part_data$&"
18130 If the match is achieved by a lookup, the data that the lookup returned
18131 for the local part is placed in the variable &$local_part_data$& for use in
18132 expansions of the router's private options. You might use this option, for
18133 example, if you have a large number of local virtual domains, and you want to
18134 send all postmaster mail to the same place without having to set up an alias in
18135 each virtual domain:
18136 .code
18137 postmaster:
18138   driver = redirect
18139   local_parts = postmaster
18140   data = postmaster@real.domain.example
18141 .endd
18142
18143
18144 .option log_as_local routers boolean "see below"
18145 .cindex "log" "delivery line"
18146 .cindex "delivery" "log line format"
18147 Exim has two logging styles for delivery, the idea being to make local
18148 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18149 recipient address is given just as the local part, without a domain. The use of
18150 this style is controlled by this option. It defaults to true for the &(accept)&
18151 router, and false for all the others. This option applies only when a
18152 router assigns an address to a transport. It has no effect on routers that
18153 redirect addresses.
18154
18155
18156
18157 .option more routers boolean&!! true
18158 The result of string expansion for this option must be a valid boolean value,
18159 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18160 result causes an error, and delivery is deferred. If the expansion is forced to
18161 fail, the default value for the option (true) is used. Other failures cause
18162 delivery to be deferred.
18163
18164 If this option is set false, and the router declines to handle the address, no
18165 further routers are tried, routing fails, and the address is bounced.
18166 .oindex "&%self%&"
18167 However, if the router explicitly passes an address to the following router by
18168 means of the setting
18169 .code
18170 self = pass
18171 .endd
18172 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18173 does not affect the behaviour if one of the precondition tests fails. In that
18174 case, the address is always passed to the next router.
18175
18176 Note that &%address_data%& is not considered to be a precondition. If its
18177 expansion is forced to fail, the router declines, and the value of &%more%&
18178 controls what happens next.
18179
18180
18181 .option pass_on_timeout routers boolean false
18182 .cindex "timeout" "of router"
18183 .cindex "router" "timeout"
18184 If a router times out during a host lookup, it normally causes deferral of the
18185 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18186 router, overriding &%no_more%&. This may be helpful for systems that are
18187 intermittently connected to the Internet, or those that want to pass to a smart
18188 host any messages that cannot immediately be delivered.
18189
18190 There are occasional other temporary errors that can occur while doing DNS
18191 lookups. They are treated in the same way as a timeout, and this option
18192 applies to all of them.
18193
18194
18195
18196 .option pass_router routers string unset
18197 .cindex "router" "go to after &""pass""&"
18198 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18199 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18200 routing to continue, and overriding a false setting of &%more%&. When one of
18201 these routers returns &"pass"&, the address is normally handed on to the next
18202 router in sequence. This can be changed by setting &%pass_router%& to the name
18203 of another router. However (unlike &%redirect_router%&) the named router must
18204 be below the current router, to avoid loops. Note that this option applies only
18205 to the special case of &"pass"&. It does not apply when a router returns
18206 &"decline"& because it cannot handle an address.
18207
18208
18209
18210 .option redirect_router routers string unset
18211 .cindex "router" "start at after redirection"
18212 Sometimes an administrator knows that it is pointless to reprocess addresses
18213 generated from alias or forward files with the same router again. For
18214 example, if an alias file translates real names into login ids there is no
18215 point searching the alias file a second time, especially if it is a large file.
18216
18217 The &%redirect_router%& option can be set to the name of any router instance.
18218 It causes the routing of any generated addresses to start at the named router
18219 instead of at the first router. This option has no effect if the router in
18220 which it is set does not generate new addresses.
18221
18222
18223
18224 .option require_files routers&!? "string list&!!" unset
18225 .cindex "file" "requiring for router"
18226 .cindex "router" "requiring file existence"
18227 This option provides a general mechanism for predicating the running of a
18228 router on the existence or non-existence of certain files or directories.
18229 Before running a router, as one of its precondition tests, Exim works its way
18230 through the &%require_files%& list, expanding each item separately.
18231
18232 Because the list is split before expansion, any colons in expansion items must
18233 be doubled, or the facility for using a different list separator must be used.
18234 If any expansion is forced to fail, the item is ignored. Other expansion
18235 failures cause routing of the address to be deferred.
18236
18237 If any expanded string is empty, it is ignored. Otherwise, except as described
18238 below, each string must be a fully qualified file path, optionally preceded by
18239 &"!"&. The paths are passed to the &[stat()]& function to test for the
18240 existence of the files or directories. The router is skipped if any paths not
18241 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18242
18243 .cindex "NFS"
18244 If &[stat()]& cannot determine whether a file exists or not, delivery of
18245 the message is deferred. This can happen when NFS-mounted filesystems are
18246 unavailable.
18247
18248 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18249 options, so you cannot use it to check for the existence of a file in which to
18250 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18251 full list of the order in which preconditions are evaluated.) However, as
18252 these options are all expanded, you can use the &%exists%& expansion condition
18253 to make such tests. The &%require_files%& option is intended for checking files
18254 that the router may be going to use internally, or which are needed by a
18255 transport (for example &_.procmailrc_&).
18256
18257 During delivery, the &[stat()]& function is run as root, but there is a
18258 facility for some checking of the accessibility of a file by another user.
18259 This is not a proper permissions check, but just a &"rough"& check that
18260 operates as follows:
18261
18262 If an item in a &%require_files%& list does not contain any forward slash
18263 characters, it is taken to be the user (and optional group, separated by a
18264 comma) to be checked for subsequent files in the list. If no group is specified
18265 but the user is specified symbolically, the gid associated with the uid is
18266 used. For example:
18267 .code
18268 require_files = mail:/some/file
18269 require_files = $local_part:$home/.procmailrc
18270 .endd
18271 If a user or group name in a &%require_files%& list does not exist, the
18272 &%require_files%& condition fails.
18273
18274 Exim performs the check by scanning along the components of the file path, and
18275 checking the access for the given uid and gid. It checks for &"x"& access on
18276 directories, and &"r"& access on the final file. Note that this means that file
18277 access control lists, if the operating system has them, are ignored.
18278
18279 &*Warning 1*&: When the router is being run to verify addresses for an
18280 incoming SMTP message, Exim is not running as root, but under its own uid. This
18281 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18282 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18283 user is not permitted to read one of the directories on the file's path.
18284
18285 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18286 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18287 without root access. In this case, if a check for access by a particular user
18288 is requested, Exim creates a subprocess that runs as that user, and tries the
18289 check again in that process.
18290
18291 The default action for handling an unresolved EACCES is to consider it to
18292 be caused by a configuration error, and routing is deferred because the
18293 existence or non-existence of the file cannot be determined. However, in some
18294 circumstances it may be desirable to treat this condition as if the file did
18295 not exist. If the file name (or the exclamation mark that precedes the file
18296 name for non-existence) is preceded by a plus sign, the EACCES error is treated
18297 as if the file did not exist. For example:
18298 .code
18299 require_files = +/some/file
18300 .endd
18301 If the router is not an essential part of verification (for example, it
18302 handles users' &_.forward_& files), another solution is to set the &%verify%&
18303 option false so that the router is skipped when verifying.
18304
18305
18306
18307 .option retry_use_local_part routers boolean "see below"
18308 .cindex "hints database" "retry keys"
18309 .cindex "local part" "in retry keys"
18310 When a delivery suffers a temporary routing failure, a retry record is created
18311 in Exim's hints database. For addresses whose routing depends only on the
18312 domain, the key for the retry record should not involve the local part, but for
18313 other addresses, both the domain and the local part should be included.
18314 Usually, remote routing is of the former kind, and local routing is of the
18315 latter kind.
18316
18317 This option controls whether the local part is used to form the key for retry
18318 hints for addresses that suffer temporary errors while being handled by this
18319 router. The default value is true for any router that has &%check_local_user%&
18320 set, and false otherwise. Note that this option does not apply to hints keys
18321 for transport delays; they are controlled by a generic transport option of the
18322 same name.
18323
18324 The setting of &%retry_use_local_part%& applies only to the router on which it
18325 appears. If the router generates child addresses, they are routed
18326 independently; this setting does not become attached to them.
18327
18328
18329
18330 .option router_home_directory routers string&!! unset
18331 .cindex "router" "home directory for"
18332 .cindex "home directory" "for router"
18333 .vindex "&$home$&"
18334 This option sets a home directory for use while the router is running. (Compare
18335 &%transport_home_directory%&, which sets a home directory for later
18336 transporting.) In particular, if used on a &(redirect)& router, this option
18337 sets a value for &$home$& while a filter is running. The value is expanded;
18338 forced expansion failure causes the option to be ignored &-- other failures
18339 cause the router to defer.
18340
18341 Expansion of &%router_home_directory%& happens immediately after the
18342 &%check_local_user%& test (if configured), before any further expansions take
18343 place.
18344 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18345 are evaluated.)
18346 While the router is running, &%router_home_directory%& overrides the value of
18347 &$home$& that came from &%check_local_user%&.
18348
18349 When a router accepts an address and assigns it to a local transport (including
18350 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18351 delivery), the home directory setting for the transport is taken from the first
18352 of these values that is set:
18353
18354 .ilist
18355 The &%home_directory%& option on the transport;
18356 .next
18357 The &%transport_home_directory%& option on the router;
18358 .next
18359 The password data if &%check_local_user%& is set on the router;
18360 .next
18361 The &%router_home_directory%& option on the router.
18362 .endlist
18363
18364 In other words, &%router_home_directory%& overrides the password data for the
18365 router, but not for the transport.
18366
18367
18368
18369 .option self routers string freeze
18370 .cindex "MX record" "pointing to local host"
18371 .cindex "local host" "MX pointing to"
18372 This option applies to those routers that use a recipient address to find a
18373 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18374 and &(manualroute)& routers.
18375 Certain configurations of the &(queryprogram)& router can also specify a list
18376 of remote hosts.
18377 Usually such routers are configured to send the message to a remote host via an
18378 &(smtp)& transport. The &%self%& option specifies what happens when the first
18379 host on the list turns out to be the local host.
18380 The way in which Exim checks for the local host is described in section
18381 &<<SECTreclocipadd>>&.
18382
18383 Normally this situation indicates either an error in Exim's configuration (for
18384 example, the router should be configured not to process this domain), or an
18385 error in the DNS (for example, the MX should not point to this host). For this
18386 reason, the default action is to log the incident, defer the address, and
18387 freeze the message. The following alternatives are provided for use in special
18388 cases:
18389
18390 .vlist
18391 .vitem &%defer%&
18392 Delivery of the message is tried again later, but the message is not frozen.
18393
18394 .vitem "&%reroute%&: <&'domain'&>"
18395 The domain is changed to the given domain, and the address is passed back to
18396 be reprocessed by the routers. No rewriting of headers takes place. This
18397 behaviour is essentially a redirection.
18398
18399 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18400 The domain is changed to the given domain, and the address is passed back to be
18401 reprocessed by the routers. Any headers that contain the original domain are
18402 rewritten.
18403
18404 .vitem &%pass%&
18405 .oindex "&%more%&"
18406 .vindex "&$self_hostname$&"
18407 The router passes the address to the next router, or to the router named in the
18408 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18409 subsequent routing and delivery, the variable &$self_hostname$& contains the
18410 name of the local host that the router encountered. This can be used to
18411 distinguish between different cases for hosts with multiple names. The
18412 combination
18413 .code
18414 self = pass
18415 no_more
18416 .endd
18417 ensures that only those addresses that routed to the local host are passed on.
18418 Without &%no_more%&, addresses that were declined for other reasons would also
18419 be passed to the next router.
18420
18421 .vitem &%fail%&
18422 Delivery fails and an error report is generated.
18423
18424 .vitem &%send%&
18425 .cindex "local host" "sending to"
18426 The anomaly is ignored and the address is queued for the transport. This
18427 setting should be used with extreme caution. For an &(smtp)& transport, it
18428 makes sense only in cases where the program that is listening on the SMTP port
18429 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18430 different configuration file that handles the domain in another way.
18431 .endlist
18432
18433
18434
18435 .option senders routers&!? "address list&!!" unset
18436 .cindex "router" "checking senders"
18437 If this option is set, the router is skipped unless the message's sender
18438 address matches something on the list.
18439 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18440 are evaluated.
18441
18442 There are issues concerning verification when the running of routers is
18443 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18444 setting, it sets the sender to the null string. When using the &%-bt%& option
18445 to check a configuration file, it is necessary also to use the &%-f%& option to
18446 set an appropriate sender. For incoming mail, the sender is unset when
18447 verifying the sender, but is available when verifying any recipients. If the
18448 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18449 matters.
18450
18451
18452 .option translate_ip_address routers string&!! unset
18453 .cindex "IP address" "translating"
18454 .cindex "packet radio"
18455 .cindex "router" "IP address translation"
18456 There exist some rare networking situations (for example, packet radio) where
18457 it is helpful to be able to translate IP addresses generated by normal routing
18458 mechanisms into other IP addresses, thus performing a kind of manual IP
18459 routing. This should be done only if the normal IP routing of the TCP/IP stack
18460 is inadequate or broken. Because this is an extremely uncommon requirement, the
18461 code to support this option is not included in the Exim binary unless
18462 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18463
18464 .vindex "&$host_address$&"
18465 The &%translate_ip_address%& string is expanded for every IP address generated
18466 by the router, with the generated address set in &$host_address$&. If the
18467 expansion is forced to fail, no action is taken.
18468 For any other expansion error, delivery of the message is deferred.
18469 If the result of the expansion is an IP address, that replaces the original
18470 address; otherwise the result is assumed to be a host name &-- this is looked
18471 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18472 produce one or more replacement IP addresses. For example, to subvert all IP
18473 addresses in some specific networks, this could be added to a router:
18474 .code
18475 translate_ip_address = \
18476   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18477     {$value}fail}}
18478 .endd
18479 The file would contain lines like
18480 .code
18481 10.2.3.128/26    some.host
18482 10.8.4.34/26     10.44.8.15
18483 .endd
18484 You should not make use of this facility unless you really understand what you
18485 are doing.
18486
18487
18488
18489 .option transport routers string&!! unset
18490 This option specifies the transport to be used when a router accepts an address
18491 and sets it up for delivery. A transport is never needed if a router is used
18492 only for verification. The value of the option is expanded at routing time,
18493 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18494 and result must be the name of one of the configured transports. If it is not,
18495 delivery is deferred.
18496
18497 The &%transport%& option is not used by the &(redirect)& router, but it does
18498 have some private options that set up transports for pipe and file deliveries
18499 (see chapter &<<CHAPredirect>>&).
18500
18501
18502
18503 .option transport_current_directory routers string&!! unset
18504 .cindex "current directory for local transport"
18505 This option associates a current directory with any address that is routed
18506 to a local transport. This can happen either because a transport is
18507 explicitly configured for the router, or because it generates a delivery to a
18508 file or a pipe. During the delivery process (that is, at transport time), this
18509 option string is expanded and is set as the current directory, unless
18510 overridden by a setting on the transport.
18511 If the expansion fails for any reason, including forced failure, an error is
18512 logged, and delivery is deferred.
18513 See chapter &<<CHAPenvironment>>& for details of the local delivery
18514 environment.
18515
18516
18517
18518
18519 .option transport_home_directory routers string&!! "see below"
18520 .cindex "home directory" "for local transport"
18521 This option associates a home directory with any address that is routed to a
18522 local transport. This can happen either because a transport is explicitly
18523 configured for the router, or because it generates a delivery to a file or a
18524 pipe. During the delivery process (that is, at transport time), the option
18525 string is expanded and is set as the home directory, unless overridden by a
18526 setting of &%home_directory%& on the transport.
18527 If the expansion fails for any reason, including forced failure, an error is
18528 logged, and delivery is deferred.
18529
18530 If the transport does not specify a home directory, and
18531 &%transport_home_directory%& is not set for the router, the home directory for
18532 the transport is taken from the password data if &%check_local_user%& is set for
18533 the router. Otherwise it is taken from &%router_home_directory%& if that option
18534 is set; if not, no home directory is set for the transport.
18535
18536 See chapter &<<CHAPenvironment>>& for further details of the local delivery
18537 environment.
18538
18539
18540
18541
18542 .option unseen routers boolean&!! false
18543 .cindex "router" "carrying on after success"
18544 The result of string expansion for this option must be a valid boolean value,
18545 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18546 result causes an error, and delivery is deferred. If the expansion is forced to
18547 fail, the default value for the option (false) is used. Other failures cause
18548 delivery to be deferred.
18549
18550 When this option is set true, routing does not cease if the router accepts the
18551 address. Instead, a copy of the incoming address is passed to the next router,
18552 overriding a false setting of &%more%&. There is little point in setting
18553 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
18554 the value of &%unseen%& contains expansion items (and therefore, presumably, is
18555 sometimes true and sometimes false).
18556
18557 .cindex "copy of message (&%unseen%& option)"
18558 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
18559 qualifier in filter files. It can be used to cause copies of messages to be
18560 delivered to some other destination, while also carrying out a normal delivery.
18561 In effect, the current address is made into a &"parent"& that has two children
18562 &-- one that is delivered as specified by this router, and a clone that goes on
18563 to be routed further. For this reason, &%unseen%& may not be combined with the
18564 &%one_time%& option in a &(redirect)& router.
18565
18566 &*Warning*&: Header lines added to the address (or specified for removal) by
18567 this router or by previous routers affect the &"unseen"& copy of the message
18568 only. The clone that continues to be processed by further routers starts with
18569 no added headers and none specified for removal. For a &%redirect%& router, if
18570 a generated address is the same as the incoming address, this can lead to
18571 duplicate addresses with different header modifications. Exim does not do
18572 duplicate deliveries (except, in certain circumstances, to pipes -- see section
18573 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
18574 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
18575 &%redirect%& router may be of help.
18576
18577 Unlike the handling of header modifications, any data that was set by the
18578 &%address_data%& option in the current or previous routers &'is'& passed on to
18579 subsequent routers.
18580
18581
18582 .option user routers string&!! "see below"
18583 .cindex "uid (user id)" "local delivery"
18584 .cindex "local transports" "uid and gid"
18585 .cindex "transport" "local"
18586 .cindex "router" "user for filter processing"
18587 .cindex "filter" "user for processing"
18588 When a router queues an address for a transport, and the transport does not
18589 specify a user, the user given here is used when running the delivery process.
18590 The user may be specified numerically or by name. If expansion fails, the
18591 error is logged and delivery is deferred.
18592 This user is also used by the &(redirect)& router when running a filter file.
18593 The default is unset, except when &%check_local_user%& is set. In this case,
18594 the default is taken from the password information. If the user is specified as
18595 a name, and &%group%& is not set, the group associated with the user is used.
18596 See also &%initgroups%& and &%group%& and the discussion in chapter
18597 &<<CHAPenvironment>>&.
18598
18599
18600
18601 .option verify routers&!? boolean true
18602 Setting this option has the effect of setting &%verify_sender%& and
18603 &%verify_recipient%& to the same value.
18604
18605
18606 .option verify_only routers&!? boolean false
18607 .cindex "EXPN" "with &%verify_only%&"
18608 .oindex "&%-bv%&"
18609 .cindex "router" "used only when verifying"
18610 If this option is set, the router is used only when verifying an address,
18611 delivering in cutthrough mode or
18612 testing with the &%-bv%& option, not when actually doing a delivery, testing
18613 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
18614 restricted to verifying only senders or recipients by means of
18615 &%verify_sender%& and &%verify_recipient%&.
18616
18617 &*Warning*&: When the router is being run to verify addresses for an incoming
18618 SMTP message, Exim is not running as root, but under its own uid. If the router
18619 accesses any files, you need to make sure that they are accessible to the Exim
18620 user or group.
18621
18622
18623 .option verify_recipient routers&!? boolean true
18624 If this option is false, the router is skipped when verifying recipient
18625 addresses,
18626 delivering in cutthrough mode
18627 or testing recipient verification using &%-bv%&.
18628 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18629 are evaluated.
18630 See also the &$verify_mode$& variable.
18631
18632
18633 .option verify_sender routers&!? boolean true
18634 If this option is false, the router is skipped when verifying sender addresses
18635 or testing sender verification using &%-bvs%&.
18636 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18637 are evaluated.
18638 See also the &$verify_mode$& variable.
18639 .ecindex IIDgenoprou1
18640 .ecindex IIDgenoprou2
18641
18642
18643
18644
18645
18646
18647 . ////////////////////////////////////////////////////////////////////////////
18648 . ////////////////////////////////////////////////////////////////////////////
18649
18650 .chapter "The accept router" "CHID4"
18651 .cindex "&(accept)& router"
18652 .cindex "routers" "&(accept)&"
18653 The &(accept)& router has no private options of its own. Unless it is being
18654 used purely for verification (see &%verify_only%&) a transport is required to
18655 be defined by the generic &%transport%& option. If the preconditions that are
18656 specified by generic options are met, the router accepts the address and queues
18657 it for the given transport. The most common use of this router is for setting
18658 up deliveries to local mailboxes. For example:
18659 .code
18660 localusers:
18661   driver = accept
18662   domains = mydomain.example
18663   check_local_user
18664   transport = local_delivery
18665 .endd
18666 The &%domains%& condition in this example checks the domain of the address, and
18667 &%check_local_user%& checks that the local part is the login of a local user.
18668 When both preconditions are met, the &(accept)& router runs, and queues the
18669 address for the &(local_delivery)& transport.
18670
18671
18672
18673
18674
18675
18676 . ////////////////////////////////////////////////////////////////////////////
18677 . ////////////////////////////////////////////////////////////////////////////
18678
18679 .chapter "The dnslookup router" "CHAPdnslookup"
18680 .scindex IIDdnsrou1 "&(dnslookup)& router"
18681 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
18682 The &(dnslookup)& router looks up the hosts that handle mail for the
18683 recipient's domain in the DNS. A transport must always be set for this router,
18684 unless &%verify_only%& is set.
18685
18686 If SRV support is configured (see &%check_srv%& below), Exim first searches for
18687 SRV records. If none are found, or if SRV support is not configured,
18688 MX records are looked up. If no MX records exist, address records are sought.
18689 However, &%mx_domains%& can be set to disable the direct use of address
18690 records.
18691
18692 MX records of equal priority are sorted by Exim into a random order. Exim then
18693 looks for address records for the host names obtained from MX or SRV records.
18694 When a host has more than one IP address, they are sorted into a random order,
18695 except that IPv6 addresses are always sorted before IPv4 addresses. If all the
18696 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
18697 generic option, the router declines.
18698
18699 Unless they have the highest priority (lowest MX value), MX records that point
18700 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
18701 are discarded, together with any other MX records of equal or lower priority.
18702
18703 .cindex "MX record" "pointing to local host"
18704 .cindex "local host" "MX pointing to"
18705 .oindex "&%self%&" "in &(dnslookup)& router"
18706 If the host pointed to by the highest priority MX record, or looked up as an
18707 address record, is the local host, or matches &%hosts_treat_as_local%&, what
18708 happens is controlled by the generic &%self%& option.
18709
18710
18711 .section "Problems with DNS lookups" "SECTprowitdnsloo"
18712 There have been problems with DNS servers when SRV records are looked up.
18713 Some misbehaving servers return a DNS error or timeout when a non-existent
18714 SRV record is sought. Similar problems have in the past been reported for
18715 MX records. The global &%dns_again_means_nonexist%& option can help with this
18716 problem, but it is heavy-handed because it is a global option.
18717
18718 For this reason, there are two options, &%srv_fail_domains%& and
18719 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
18720 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
18721 an attempt to look up an SRV or MX record causes one of these results, and the
18722 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
18723 such record"&. In the case of an SRV lookup, this means that the router
18724 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
18725 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
18726 case routing fails.
18727
18728
18729 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
18730 .cindex "&(dnslookup)& router" "declines"
18731 There are a few cases where a &(dnslookup)& router will decline to accept
18732 an address; if such a router is expected to handle "all remaining non-local
18733 domains", then it is important to set &%no_more%&.
18734
18735 The router will defer rather than decline if the domain
18736 is found in the &%fail_defer_domains%& router option.
18737
18738 Reasons for a &(dnslookup)& router to decline currently include:
18739 .ilist
18740 The domain does not exist in DNS
18741 .next
18742 The domain exists but the MX record's host part is just "."; this is a common
18743 convention (borrowed from SRV) used to indicate that there is no such service
18744 for this domain and to not fall back to trying A/AAAA records.
18745 .next
18746 Ditto, but for SRV records, when &%check_srv%& is set on this router.
18747 .next
18748 MX record points to a non-existent host.
18749 .next
18750 MX record points to an IP address and the main section option
18751 &%allow_mx_to_ip%& is not set.
18752 .next
18753 MX records exist and point to valid hosts, but all hosts resolve only to
18754 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
18755 .next
18756 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
18757 &%dns_check_names_pattern%& for handling one variant of this)
18758 .next
18759 &%check_secondary_mx%& is set on this router but the local host can
18760 not be found in the MX records (see below)
18761 .endlist
18762
18763
18764
18765
18766 .section "Private options for dnslookup" "SECID118"
18767 .cindex "options" "&(dnslookup)& router"
18768 The private options for the &(dnslookup)& router are as follows:
18769
18770 .option check_secondary_mx dnslookup boolean false
18771 .cindex "MX record" "checking for secondary"
18772 If this option is set, the router declines unless the local host is found in
18773 (and removed from) the list of hosts obtained by MX lookup. This can be used to
18774 process domains for which the local host is a secondary mail exchanger
18775 differently to other domains. The way in which Exim decides whether a host is
18776 the local host is described in section &<<SECTreclocipadd>>&.
18777
18778
18779 .option check_srv dnslookup string&!! unset
18780 .cindex "SRV record" "enabling use of"
18781 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
18782 addition to MX and address records. The support is disabled by default. To
18783 enable SRV support, set the &%check_srv%& option to the name of the service
18784 required. For example,
18785 .code
18786 check_srv = smtp
18787 .endd
18788 looks for SRV records that refer to the normal smtp service. The option is
18789 expanded, so the service name can vary from message to message or address
18790 to address. This might be helpful if SRV records are being used for a
18791 submission service. If the expansion is forced to fail, the &%check_srv%&
18792 option is ignored, and the router proceeds to look for MX records in the
18793 normal way.
18794
18795 When the expansion succeeds, the router searches first for SRV records for
18796 the given service (it assumes TCP protocol). A single SRV record with a
18797 host name that consists of just a single dot indicates &"no such service for
18798 this domain"&; if this is encountered, the router declines. If other kinds of
18799 SRV record are found, they are used to construct a host list for delivery
18800 according to the rules of RFC 2782. MX records are not sought in this case.
18801
18802 When no SRV records are found, MX records (and address records) are sought in
18803 the traditional way. In other words, SRV records take precedence over MX
18804 records, just as MX records take precedence over address records. Note that
18805 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
18806 defined it. It is apparently believed that MX records are sufficient for email
18807 and that SRV records should not be used for this purpose. However, SRV records
18808 have an additional &"weight"& feature which some people might find useful when
18809 trying to split an SMTP load between hosts of different power.
18810
18811 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
18812 when there is a DNS lookup error.
18813
18814
18815
18816
18817 .option fail_defer_domains dnslookup "domain list&!!" unset
18818 .cindex "MX record" "not found"
18819 DNS lookups for domains matching &%fail_defer_domains%&
18820 which find no matching record will cause the router to defer
18821 rather than the default behaviour of decline.
18822 This maybe be useful for queueing messages for a newly created
18823 domain while the DNS configuration is not ready.
18824 However, it will result in any message with mistyped domains
18825 also being queued.
18826
18827
18828 .option mx_domains dnslookup "domain list&!!" unset
18829 .cindex "MX record" "required to exist"
18830 .cindex "SRV record" "required to exist"
18831 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
18832 record in order to be recognized. (The name of this option could be improved.)
18833 For example, if all the mail hosts in &'fict.example'& are known to have MX
18834 records, except for those in &'discworld.fict.example'&, you could use this
18835 setting:
18836 .code
18837 mx_domains = ! *.discworld.fict.example : *.fict.example
18838 .endd
18839 This specifies that messages addressed to a domain that matches the list but
18840 has no MX record should be bounced immediately instead of being routed using
18841 the address record.
18842
18843
18844 .option mx_fail_domains dnslookup "domain list&!!" unset
18845 If the DNS lookup for MX records for one of the domains in this list causes a
18846 DNS lookup error, Exim behaves as if no MX records were found. See section
18847 &<<SECTprowitdnsloo>>& for more discussion.
18848
18849
18850
18851
18852 .option qualify_single dnslookup boolean true
18853 .cindex "DNS" "resolver options"
18854 .cindex "DNS" "qualifying single-component names"
18855 When this option is true, the resolver option RES_DEFNAMES is set for DNS
18856 lookups. Typically, but not standardly, this causes the resolver to qualify
18857 single-component names with the default domain. For example, on a machine
18858 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
18859 &'thesaurus.ref.example'& inside the resolver. For details of what your
18860 resolver actually does, consult your man pages for &'resolver'& and
18861 &'resolv.conf'&.
18862
18863
18864
18865 .option rewrite_headers dnslookup boolean true
18866 .cindex "rewriting" "header lines"
18867 .cindex "header lines" "rewriting"
18868 If the domain name in the address that is being processed is not fully
18869 qualified, it may be expanded to its full form by a DNS lookup. For example, if
18870 an address is specified as &'dormouse@teaparty'&, the domain might be
18871 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
18872 occur as a result of setting the &%widen_domains%& option. If
18873 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
18874 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
18875 header lines of the message are rewritten with the full domain name.
18876
18877 This option should be turned off only when it is known that no message is
18878 ever going to be sent outside an environment where the abbreviation makes
18879 sense.
18880
18881 When an MX record is looked up in the DNS and matches a wildcard record, name
18882 servers normally return a record containing the name that has been looked up,
18883 making it impossible to detect whether a wildcard was present or not. However,
18884 some name servers have recently been seen to return the wildcard entry. If the
18885 name returned by a DNS lookup begins with an asterisk, it is not used for
18886 header rewriting.
18887
18888
18889 .option same_domain_copy_routing dnslookup boolean false
18890 .cindex "address" "copying routing"
18891 Addresses with the same domain are normally routed by the &(dnslookup)& router
18892 to the same list of hosts. However, this cannot be presumed, because the router
18893 options and preconditions may refer to the local part of the address. By
18894 default, therefore, Exim routes each address in a message independently. DNS
18895 servers run caches, so repeated DNS lookups are not normally expensive, and in
18896 any case, personal messages rarely have more than a few recipients.
18897
18898 If you are running mailing lists with large numbers of subscribers at the same
18899 domain, and you are using a &(dnslookup)& router which is independent of the
18900 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
18901 lookups for identical domains in one message. In this case, when &(dnslookup)&
18902 routes an address to a remote transport, any other unrouted addresses in the
18903 message that have the same domain are automatically given the same routing
18904 without processing them independently,
18905 provided the following conditions are met:
18906
18907 .ilist
18908 No router that processed the address specified &%headers_add%& or
18909 &%headers_remove%&.
18910 .next
18911 The router did not change the address in any way, for example, by &"widening"&
18912 the domain.
18913 .endlist
18914
18915
18916
18917
18918 .option search_parents dnslookup boolean false
18919 .cindex "DNS" "resolver options"
18920 When this option is true, the resolver option RES_DNSRCH is set for DNS
18921 lookups. This is different from the &%qualify_single%& option in that it
18922 applies to domains containing dots. Typically, but not standardly, it causes
18923 the resolver to search for the name in the current domain and in parent
18924 domains. For example, on a machine in the &'fict.example'& domain, if looking
18925 up &'teaparty.wonderland'& failed, the resolver would try
18926 &'teaparty.wonderland.fict.example'&. For details of what your resolver
18927 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
18928
18929 Setting this option true can cause problems in domains that have a wildcard MX
18930 record, because any domain that does not have its own MX record matches the
18931 local wildcard.
18932
18933
18934
18935 .option srv_fail_domains dnslookup "domain list&!!" unset
18936 If the DNS lookup for SRV records for one of the domains in this list causes a
18937 DNS lookup error, Exim behaves as if no SRV records were found. See section
18938 &<<SECTprowitdnsloo>>& for more discussion.
18939
18940
18941
18942
18943 .option widen_domains dnslookup "string list" unset
18944 .cindex "domain" "partial; widening"
18945 If a DNS lookup fails and this option is set, each of its strings in turn is
18946 added onto the end of the domain, and the lookup is tried again. For example,
18947 if
18948 .code
18949 widen_domains = fict.example:ref.example
18950 .endd
18951 is set and a lookup of &'klingon.dictionary'& fails,
18952 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
18953 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
18954 and &%search_parents%& options can cause some widening to be undertaken inside
18955 the DNS resolver. &%widen_domains%& is not applied to sender addresses
18956 when verifying, unless &%rewrite_headers%& is false (not the default).
18957
18958
18959 .section "Effect of qualify_single and search_parents" "SECID119"
18960 When a domain from an envelope recipient is changed by the resolver as a result
18961 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
18962 corresponding address in the message's header lines unless &%rewrite_headers%&
18963 is set false. Exim then re-routes the address, using the full domain.
18964
18965 These two options affect only the DNS lookup that takes place inside the router
18966 for the domain of the address that is being routed. They do not affect lookups
18967 such as that implied by
18968 .code
18969 domains = @mx_any
18970 .endd
18971 that may happen while processing a router precondition before the router is
18972 entered. No widening ever takes place for these lookups.
18973 .ecindex IIDdnsrou1
18974 .ecindex IIDdnsrou2
18975
18976
18977
18978
18979
18980
18981
18982
18983
18984 . ////////////////////////////////////////////////////////////////////////////
18985 . ////////////////////////////////////////////////////////////////////////////
18986
18987 .chapter "The ipliteral router" "CHID5"
18988 .cindex "&(ipliteral)& router"
18989 .cindex "domain literal" "routing"
18990 .cindex "routers" "&(ipliteral)&"
18991 This router has no private options. Unless it is being used purely for
18992 verification (see &%verify_only%&) a transport is required to be defined by the
18993 generic &%transport%& option. The router accepts the address if its domain part
18994 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
18995 router handles the address
18996 .code
18997 root@[192.168.1.1]
18998 .endd
18999 by setting up delivery to the host with that IP address. IPv4 domain literals
19000 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19001 are similar, but the address is preceded by &`ipv6:`&. For example:
19002 .code
19003 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19004 .endd
19005 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19006 grounds that sooner or later somebody will try it.
19007
19008 .oindex "&%self%&" "in &(ipliteral)& router"
19009 If the IP address matches something in &%ignore_target_hosts%&, the router
19010 declines. If an IP literal turns out to refer to the local host, the generic
19011 &%self%& option determines what happens.
19012
19013 The RFCs require support for domain literals; however, their use is
19014 controversial in today's Internet. If you want to use this router, you must
19015 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19016 Exim will not recognize the domain literal syntax in addresses.
19017
19018
19019
19020 . ////////////////////////////////////////////////////////////////////////////
19021 . ////////////////////////////////////////////////////////////////////////////
19022
19023 .chapter "The iplookup router" "CHID6"
19024 .cindex "&(iplookup)& router"
19025 .cindex "routers" "&(iplookup)&"
19026 The &(iplookup)& router was written to fulfil a specific requirement in
19027 Cambridge University (which in fact no longer exists). For this reason, it is
19028 not included in the binary of Exim by default. If you want to include it, you
19029 must set
19030 .code
19031 ROUTER_IPLOOKUP=yes
19032 .endd
19033 in your &_Local/Makefile_& configuration file.
19034
19035 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19036 connection to one or more specific hosts. The host can then return the same or
19037 a different address &-- in effect rewriting the recipient address in the
19038 message's envelope. The new address is then passed on to subsequent routers. If
19039 this process fails, the address can be passed on to other routers, or delivery
19040 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19041 must not be specified for it.
19042
19043 .cindex "options" "&(iplookup)& router"
19044 .option hosts iplookup string unset
19045 This option must be supplied. Its value is a colon-separated list of host
19046 names. The hosts are looked up using &[gethostbyname()]&
19047 (or &[getipnodebyname()]& when available)
19048 and are tried in order until one responds to the query. If none respond, what
19049 happens is controlled by &%optional%&.
19050
19051
19052 .option optional iplookup boolean false
19053 If &%optional%& is true, if no response is obtained from any host, the address
19054 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19055 delivery to the address is deferred.
19056
19057
19058 .option port iplookup integer 0
19059 .cindex "port" "&(iplookup)& router"
19060 This option must be supplied. It specifies the port number for the TCP or UDP
19061 call.
19062
19063
19064 .option protocol iplookup string udp
19065 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19066 protocols is to be used.
19067
19068
19069 .option query iplookup string&!! "see below"
19070 This defines the content of the query that is sent to the remote hosts. The
19071 default value is:
19072 .code
19073 $local_part@$domain $local_part@$domain
19074 .endd
19075 The repetition serves as a way of checking that a response is to the correct
19076 query in the default case (see &%response_pattern%& below).
19077
19078
19079 .option reroute iplookup string&!! unset
19080 If this option is not set, the rerouted address is precisely the byte string
19081 returned by the remote host, up to the first white space, if any. If set, the
19082 string is expanded to form the rerouted address. It can include parts matched
19083 in the response by &%response_pattern%& by means of numeric variables such as
19084 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19085 whether or not a pattern is in use. In all cases, the rerouted address must end
19086 up in the form &'local_part@domain'&.
19087
19088
19089 .option response_pattern iplookup string unset
19090 This option can be set to a regular expression that is applied to the string
19091 returned from the remote host. If the pattern does not match the response, the
19092 router declines. If &%response_pattern%& is not set, no checking of the
19093 response is done, unless the query was defaulted, in which case there is a
19094 check that the text returned after the first white space is the original
19095 address. This checks that the answer that has been received is in response to
19096 the correct question. For example, if the response is just a new domain, the
19097 following could be used:
19098 .code
19099 response_pattern = ^([^@]+)$
19100 reroute = $local_part@$1
19101 .endd
19102
19103 .option timeout iplookup time 5s
19104 This specifies the amount of time to wait for a response from the remote
19105 machine. The same timeout is used for the &[connect()]& function for a TCP
19106 call. It does not apply to UDP.
19107
19108
19109
19110
19111 . ////////////////////////////////////////////////////////////////////////////
19112 . ////////////////////////////////////////////////////////////////////////////
19113
19114 .chapter "The manualroute router" "CHID7"
19115 .scindex IIDmanrou1 "&(manualroute)& router"
19116 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19117 .cindex "domain" "manually routing"
19118 The &(manualroute)& router is so-called because it provides a way of manually
19119 routing an address according to its domain. It is mainly used when you want to
19120 route addresses to remote hosts according to your own rules, bypassing the
19121 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19122 route to local transports, a facility that may be useful if you want to save
19123 messages for dial-in hosts in local files.
19124
19125 The &(manualroute)& router compares a list of domain patterns with the domain
19126 it is trying to route. If there is no match, the router declines. Each pattern
19127 has associated with it a list of hosts and some other optional data, which may
19128 include a transport. The combination of a pattern and its data is called a
19129 &"routing rule"&. For patterns that do not have an associated transport, the
19130 generic &%transport%& option must specify a transport, unless the router is
19131 being used purely for verification (see &%verify_only%&).
19132
19133 .vindex "&$host$&"
19134 In the case of verification, matching the domain pattern is sufficient for the
19135 router to accept the address. When actually routing an address for delivery,
19136 an address that matches a domain pattern is queued for the associated
19137 transport. If the transport is not a local one, a host list must be associated
19138 with the pattern; IP addresses are looked up for the hosts, and these are
19139 passed to the transport along with the mail address. For local transports, a
19140 host list is optional. If it is present, it is passed in &$host$& as a single
19141 text string.
19142
19143 The list of routing rules can be provided as an inline string in
19144 &%route_list%&, or the data can be obtained by looking up the domain in a file
19145 or database by setting &%route_data%&. Only one of these settings may appear in
19146 any one instance of &(manualroute)&. The format of routing rules is described
19147 below, following the list of private options.
19148
19149
19150 .section "Private options for manualroute" "SECTprioptman"
19151
19152 .cindex "options" "&(manualroute)& router"
19153 The private options for the &(manualroute)& router are as follows:
19154
19155 .option host_all_ignored manualroute string defer
19156 See &%host_find_failed%&.
19157
19158 .option host_find_failed manualroute string freeze
19159 This option controls what happens when &(manualroute)& tries to find an IP
19160 address for a host, and the host does not exist. The option can be set to one
19161 of the following values:
19162 .code
19163 decline
19164 defer
19165 fail
19166 freeze
19167 ignore
19168 pass
19169 .endd
19170 The default (&"freeze"&) assumes that this state is a serious configuration
19171 error. The difference between &"pass"& and &"decline"& is that the former
19172 forces the address to be passed to the next router (or the router defined by
19173 &%pass_router%&),
19174 .oindex "&%more%&"
19175 overriding &%no_more%&, whereas the latter passes the address to the next
19176 router only if &%more%& is true.
19177
19178 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19179 cannot be found. If all the hosts in the list are ignored, the behaviour is
19180 controlled by the &%host_all_ignored%& option. This takes the same values
19181 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19182
19183 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19184 state; if a host lookup gets a temporary error, delivery is deferred unless the
19185 generic &%pass_on_timeout%& option is set.
19186
19187
19188 .option hosts_randomize manualroute boolean false
19189 .cindex "randomized host list"
19190 .cindex "host" "list of; randomized"
19191 If this option is set, the order of the items in a host list in a routing rule
19192 is randomized each time the list is used, unless an option in the routing rule
19193 overrides (see below). Randomizing the order of a host list can be used to do
19194 crude load sharing. However, if more than one mail address is routed by the
19195 same router to the same host list, the host lists are considered to be the same
19196 (even though they may be randomized into different orders) for the purpose of
19197 deciding whether to batch the deliveries into a single SMTP transaction.
19198
19199 When &%hosts_randomize%& is true, a host list may be split
19200 into groups whose order is separately randomized. This makes it possible to
19201 set up MX-like behaviour. The boundaries between groups are indicated by an
19202 item that is just &`+`& in the host list. For example:
19203 .code
19204 route_list = * host1:host2:host3:+:host4:host5
19205 .endd
19206 The order of the first three hosts and the order of the last two hosts is
19207 randomized for each use, but the first three always end up before the last two.
19208 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19209 randomized host list is passed to an &(smtp)& transport that also has
19210 &%hosts_randomize set%&, the list is not re-randomized.
19211
19212
19213 .option route_data manualroute string&!! unset
19214 If this option is set, it must expand to yield the data part of a routing rule.
19215 Typically, the expansion string includes a lookup based on the domain. For
19216 example:
19217 .code
19218 route_data = ${lookup{$domain}dbm{/etc/routes}}
19219 .endd
19220 If the expansion is forced to fail, or the result is an empty string, the
19221 router declines. Other kinds of expansion failure cause delivery to be
19222 deferred.
19223
19224
19225 .option route_list manualroute "string list" unset
19226 This string is a list of routing rules, in the form defined below. Note that,
19227 unlike most string lists, the items are separated by semicolons. This is so
19228 that they may contain colon-separated host lists.
19229
19230
19231 .option same_domain_copy_routing manualroute boolean false
19232 .cindex "address" "copying routing"
19233 Addresses with the same domain are normally routed by the &(manualroute)&
19234 router to the same list of hosts. However, this cannot be presumed, because the
19235 router options and preconditions may refer to the local part of the address. By
19236 default, therefore, Exim routes each address in a message independently. DNS
19237 servers run caches, so repeated DNS lookups are not normally expensive, and in
19238 any case, personal messages rarely have more than a few recipients.
19239
19240 If you are running mailing lists with large numbers of subscribers at the same
19241 domain, and you are using a &(manualroute)& router which is independent of the
19242 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19243 lookups for identical domains in one message. In this case, when
19244 &(manualroute)& routes an address to a remote transport, any other unrouted
19245 addresses in the message that have the same domain are automatically given the
19246 same routing without processing them independently. However, this is only done
19247 if &%headers_add%& and &%headers_remove%& are unset.
19248
19249
19250
19251
19252 .section "Routing rules in route_list" "SECID120"
19253 The value of &%route_list%& is a string consisting of a sequence of routing
19254 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19255 entered as two semicolons. Alternatively, the list separator can be changed as
19256 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19257 Empty rules are ignored. The format of each rule is
19258 .display
19259 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19260 .endd
19261 The following example contains two rules, each with a simple domain pattern and
19262 no options:
19263 .code
19264 route_list = \
19265   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19266   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19267 .endd
19268 The three parts of a rule are separated by white space. The pattern and the
19269 list of hosts can be enclosed in quotes if necessary, and if they are, the
19270 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19271 single domain pattern, which is the only mandatory item in the rule. The
19272 pattern is in the same format as one item in a domain list (see section
19273 &<<SECTdomainlist>>&),
19274 except that it may not be the name of an interpolated file.
19275 That is, it may be wildcarded, or a regular expression, or a file or database
19276 lookup (with semicolons doubled, because of the use of semicolon as a separator
19277 in a &%route_list%&).
19278
19279 The rules in &%route_list%& are searched in order until one of the patterns
19280 matches the domain that is being routed. The list of hosts and then options are
19281 then used as described below. If there is no match, the router declines. When
19282 &%route_list%& is set, &%route_data%& must not be set.
19283
19284
19285
19286 .section "Routing rules in route_data" "SECID121"
19287 The use of &%route_list%& is convenient when there are only a small number of
19288 routing rules. For larger numbers, it is easier to use a file or database to
19289 hold the routing information, and use the &%route_data%& option instead.
19290 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19291 Most commonly, &%route_data%& is set as a string that contains an
19292 expansion lookup. For example, suppose we place two routing rules in a file
19293 like this:
19294 .code
19295 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19296 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19297 .endd
19298 This data can be accessed by setting
19299 .code
19300 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19301 .endd
19302 Failure of the lookup results in an empty string, causing the router to
19303 decline. However, you do not have to use a lookup in &%route_data%&. The only
19304 requirement is that the result of expanding the string is a list of hosts,
19305 possibly followed by options, separated by white space. The list of hosts must
19306 be enclosed in quotes if it contains white space.
19307
19308
19309
19310
19311 .section "Format of the list of hosts" "SECID122"
19312 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19313 always separately expanded before use. If the expansion fails, the router
19314 declines. The result of the expansion must be a colon-separated list of names
19315 and/or IP addresses, optionally also including ports. The format of each item
19316 in the list is described in the next section. The list separator can be changed
19317 as described in section &<<SECTlistconstruct>>&.
19318
19319 If the list of hosts was obtained from a &%route_list%& item, the following
19320 variables are set during its expansion:
19321
19322 .ilist
19323 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19324 If the domain was matched against a regular expression, the numeric variables
19325 &$1$&, &$2$&, etc. may be set. For example:
19326 .code
19327 route_list = ^domain(\d+)   host-$1.text.example
19328 .endd
19329 .next
19330 &$0$& is always set to the entire domain.
19331 .next
19332 &$1$& is also set when partial matching is done in a file lookup.
19333
19334 .next
19335 .vindex "&$value$&"
19336 If the pattern that matched the domain was a lookup item, the data that was
19337 looked up is available in the expansion variable &$value$&. For example:
19338 .code
19339 route_list = lsearch;;/some/file.routes  $value
19340 .endd
19341 .endlist
19342
19343 Note the doubling of the semicolon in the pattern that is necessary because
19344 semicolon is the default route list separator.
19345
19346
19347
19348 .section "Format of one host item" "SECTformatonehostitem"
19349 Each item in the list of hosts is either a host name or an IP address,
19350 optionally with an attached port number. When no port is given, an IP address
19351 is not enclosed in brackets. When a port is specified, it overrides the port
19352 specification on the transport. The port is separated from the name or address
19353 by a colon. This leads to some complications:
19354
19355 .ilist
19356 Because colon is the default separator for the list of hosts, either
19357 the colon that specifies a port must be doubled, or the list separator must
19358 be changed. The following two examples have the same effect:
19359 .code
19360 route_list = * "host1.tld::1225 : host2.tld::1226"
19361 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19362 .endd
19363 .next
19364 When IPv6 addresses are involved, it gets worse, because they contain
19365 colons of their own. To make this case easier, it is permitted to
19366 enclose an IP address (either v4 or v6) in square brackets if a port
19367 number follows. For example:
19368 .code
19369 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19370 .endd
19371 .endlist
19372
19373 .section "How the list of hosts is used" "SECThostshowused"
19374 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19375 the hosts is tried, in the order specified, when carrying out the SMTP
19376 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19377 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19378 transport.
19379
19380 Hosts may be listed by name or by IP address. An unadorned name in the list of
19381 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19382 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19383 records in the DNS. For example:
19384 .code
19385 route_list = *  x.y.z:p.q.r/MX:e.f.g
19386 .endd
19387 If this feature is used with a port specifier, the port must come last. For
19388 example:
19389 .code
19390 route_list = *  dom1.tld/mx::1225
19391 .endd
19392 If the &%hosts_randomize%& option is set, the order of the items in the list is
19393 randomized before any lookups are done. Exim then scans the list; for any name
19394 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19395 be an interface on the local host and the item is not the first in the list,
19396 Exim discards it and any subsequent items. If it is the first item, what
19397 happens is controlled by the
19398 .oindex "&%self%&" "in &(manualroute)& router"
19399 &%self%& option of the router.
19400
19401 A name on the list that is followed by &`/MX`& is replaced with the list of
19402 hosts obtained by looking up MX records for the name. This is always a DNS
19403 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19404 below) are not relevant here. The order of these hosts is determined by the
19405 preference values in the MX records, according to the usual rules. Because
19406 randomizing happens before the MX lookup, it does not affect the order that is
19407 defined by MX preferences.
19408
19409 If the local host is present in the sublist obtained from MX records, but is
19410 not the most preferred host in that list, it and any equally or less
19411 preferred hosts are removed before the sublist is inserted into the main list.
19412
19413 If the local host is the most preferred host in the MX list, what happens
19414 depends on where in the original list of hosts the &`/MX`& item appears. If it
19415 is not the first item (that is, there are previous hosts in the main list),
19416 Exim discards this name and any subsequent items in the main list.
19417
19418 If the MX item is first in the list of hosts, and the local host is the
19419 most preferred host, what happens is controlled by the &%self%& option of the
19420 router.
19421
19422 DNS failures when lookup up the MX records are treated in the same way as DNS
19423 failures when looking up IP addresses: &%pass_on_timeout%& and
19424 &%host_find_failed%& are used when relevant.
19425
19426 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19427 whether obtained from an MX lookup or not.
19428
19429
19430
19431 .section "How the options are used" "SECThowoptused"
19432 The options are a sequence of words; in practice no more than three are ever
19433 present. One of the words can be the name of a transport; this overrides the
19434 &%transport%& option on the router for this particular routing rule only. The
19435 other words (if present) control randomization of the list of hosts on a
19436 per-rule basis, and how the IP addresses of the hosts are to be found when
19437 routing to a remote transport. These options are as follows:
19438
19439 .ilist
19440 &%randomize%&: randomize the order of the hosts in this list, overriding the
19441 setting of &%hosts_randomize%& for this routing rule only.
19442 .next
19443 &%no_randomize%&: do not randomize the order of the hosts in this list,
19444 overriding the setting of &%hosts_randomize%& for this routing rule only.
19445 .next
19446 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19447 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19448 also look in &_/etc/hosts_& or other sources of information.
19449 .next
19450 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19451 no address records are found. If there is a temporary DNS error (such as a
19452 timeout), delivery is deferred.
19453 .endlist
19454
19455 For example:
19456 .code
19457 route_list = domain1  host1:host2:host3  randomize bydns;\
19458              domain2  host4:host5
19459 .endd
19460 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19461 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19462 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19463 or &[gethostbyname()]&, and the result of the lookup is the result of that
19464 call.
19465
19466 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19467 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19468 instead of TRY_AGAIN. That is why the default action is to try a DNS
19469 lookup first. Only if that gives a definite &"no such host"& is the local
19470 function called.
19471
19472 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19473 inadvertent constraint that a transport name as an option had to be the last
19474 option specified.
19475
19476
19477
19478 If no IP address for a host can be found, what happens is controlled by the
19479 &%host_find_failed%& option.
19480
19481 .vindex "&$host$&"
19482 When an address is routed to a local transport, IP addresses are not looked up.
19483 The host list is passed to the transport in the &$host$& variable.
19484
19485
19486
19487 .section "Manualroute examples" "SECID123"
19488 In some of the examples that follow, the presence of the &%remote_smtp%&
19489 transport, as defined in the default configuration file, is assumed:
19490
19491 .ilist
19492 .cindex "smart host" "example router"
19493 The &(manualroute)& router can be used to forward all external mail to a
19494 &'smart host'&. If you have set up, in the main part of the configuration, a
19495 named domain list that contains your local domains, for example:
19496 .code
19497 domainlist local_domains = my.domain.example
19498 .endd
19499 You can arrange for all other domains to be routed to a smart host by making
19500 your first router something like this:
19501 .code
19502 smart_route:
19503   driver = manualroute
19504   domains = !+local_domains
19505   transport = remote_smtp
19506   route_list = * smarthost.ref.example
19507 .endd
19508 This causes all non-local addresses to be sent to the single host
19509 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
19510 they are tried in order
19511 (but you can use &%hosts_randomize%& to vary the order each time).
19512 Another way of configuring the same thing is this:
19513 .code
19514 smart_route:
19515   driver = manualroute
19516   transport = remote_smtp
19517   route_list = !+local_domains  smarthost.ref.example
19518 .endd
19519 There is no difference in behaviour between these two routers as they stand.
19520 However, they behave differently if &%no_more%& is added to them. In the first
19521 example, the router is skipped if the domain does not match the &%domains%&
19522 precondition; the following router is always tried. If the router runs, it
19523 always matches the domain and so can never decline. Therefore, &%no_more%&
19524 would have no effect. In the second case, the router is never skipped; it
19525 always runs. However, if it doesn't match the domain, it declines. In this case
19526 &%no_more%& would prevent subsequent routers from running.
19527
19528 .next
19529 .cindex "mail hub example"
19530 A &'mail hub'& is a host which receives mail for a number of domains via MX
19531 records in the DNS and delivers it via its own private routing mechanism. Often
19532 the final destinations are behind a firewall, with the mail hub being the one
19533 machine that can connect to machines both inside and outside the firewall. The
19534 &(manualroute)& router is usually used on a mail hub to route incoming messages
19535 to the correct hosts. For a small number of domains, the routing can be inline,
19536 using the &%route_list%& option, but for a larger number a file or database
19537 lookup is easier to manage.
19538
19539 If the domain names are in fact the names of the machines to which the mail is
19540 to be sent by the mail hub, the configuration can be quite simple. For
19541 example:
19542 .code
19543 hub_route:
19544   driver = manualroute
19545   transport = remote_smtp
19546   route_list = *.rhodes.tvs.example  $domain
19547 .endd
19548 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
19549 whose names are the same as the mail domains. A similar approach can be taken
19550 if the host name can be obtained from the domain name by a string manipulation
19551 that the expansion facilities can handle. Otherwise, a lookup based on the
19552 domain can be used to find the host:
19553 .code
19554 through_firewall:
19555   driver = manualroute
19556   transport = remote_smtp
19557   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
19558 .endd
19559 The result of the lookup must be the name or IP address of the host (or
19560 hosts) to which the address is to be routed. If the lookup fails, the route
19561 data is empty, causing the router to decline. The address then passes to the
19562 next router.
19563
19564 .next
19565 .cindex "batched SMTP output example"
19566 .cindex "SMTP" "batched outgoing; example"
19567 You can use &(manualroute)& to deliver messages to pipes or files in batched
19568 SMTP format for onward transportation by some other means. This is one way of
19569 storing mail for a dial-up host when it is not connected. The route list entry
19570 can be as simple as a single domain name in a configuration like this:
19571 .code
19572 save_in_file:
19573   driver = manualroute
19574   transport = batchsmtp_appendfile
19575   route_list = saved.domain.example
19576 .endd
19577 though often a pattern is used to pick up more than one domain. If there are
19578 several domains or groups of domains with different transport requirements,
19579 different transports can be listed in the routing information:
19580 .code
19581 save_in_file:
19582   driver = manualroute
19583   route_list = \
19584     *.saved.domain1.example  $domain  batch_appendfile; \
19585     *.saved.domain2.example  \
19586       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
19587       batch_pipe
19588 .endd
19589 .vindex "&$domain$&"
19590 .vindex "&$host$&"
19591 The first of these just passes the domain in the &$host$& variable, which
19592 doesn't achieve much (since it is also in &$domain$&), but the second does a
19593 file lookup to find a value to pass, causing the router to decline to handle
19594 the address if the lookup fails.
19595
19596 .next
19597 .cindex "UUCP" "example of router for"
19598 Routing mail directly to UUCP software is a specific case of the use of
19599 &(manualroute)& in a gateway to another mail environment. This is an example of
19600 one way it can be done:
19601 .code
19602 # Transport
19603 uucp:
19604   driver = pipe
19605   user = nobody
19606   command = /usr/local/bin/uux -r - \
19607     ${substr_-5:$host}!rmail ${local_part}
19608   return_fail_output = true
19609
19610 # Router
19611 uucphost:
19612   transport = uucp
19613   driver = manualroute
19614   route_data = \
19615     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
19616 .endd
19617 The file &_/usr/local/exim/uucphosts_& contains entries like
19618 .code
19619 darksite.ethereal.example:           darksite.UUCP
19620 .endd
19621 It can be set up more simply without adding and removing &".UUCP"& but this way
19622 makes clear the distinction between the domain name
19623 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
19624 .endlist
19625 .ecindex IIDmanrou1
19626 .ecindex IIDmanrou2
19627
19628
19629
19630
19631
19632
19633
19634
19635 . ////////////////////////////////////////////////////////////////////////////
19636 . ////////////////////////////////////////////////////////////////////////////
19637
19638 .chapter "The queryprogram router" "CHAPdriverlast"
19639 .scindex IIDquerou1 "&(queryprogram)& router"
19640 .scindex IIDquerou2 "routers" "&(queryprogram)&"
19641 .cindex "routing" "by external program"
19642 The &(queryprogram)& router routes an address by running an external command
19643 and acting on its output. This is an expensive way to route, and is intended
19644 mainly for use in lightly-loaded systems, or for performing experiments.
19645 However, if it is possible to use the precondition options (&%domains%&,
19646 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
19647 be used in special cases, even on a busy host. There are the following private
19648 options:
19649 .cindex "options" "&(queryprogram)& router"
19650
19651 .option command queryprogram string&!! unset
19652 This option must be set. It specifies the command that is to be run. The
19653 command is split up into a command name and arguments, and then each is
19654 expanded separately (exactly as for a &(pipe)& transport, described in chapter
19655 &<<CHAPpipetransport>>&).
19656
19657
19658 .option command_group queryprogram string unset
19659 .cindex "gid (group id)" "in &(queryprogram)& router"
19660 This option specifies a gid to be set when running the command while routing an
19661 address for deliver. It must be set if &%command_user%& specifies a numerical
19662 uid. If it begins with a digit, it is interpreted as the numerical value of the
19663 gid. Otherwise it is looked up using &[getgrnam()]&.
19664
19665
19666 .option command_user queryprogram string unset
19667 .cindex "uid (user id)" "for &(queryprogram)&"
19668 This option must be set. It specifies the uid which is set when running the
19669 command while routing an address for delivery. If the value begins with a digit,
19670 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
19671 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
19672 not set, a value for the gid also.
19673
19674 &*Warning:*& Changing uid and gid is possible only when Exim is running as
19675 root, which it does during a normal delivery in a conventional configuration.
19676 However, when an address is being verified during message reception, Exim is
19677 usually running as the Exim user, not as root. If the &(queryprogram)& router
19678 is called from a non-root process, Exim cannot change uid or gid before running
19679 the command. In this circumstance the command runs under the current uid and
19680 gid.
19681
19682
19683 .option current_directory queryprogram string /
19684 This option specifies an absolute path which is made the current directory
19685 before running the command.
19686
19687
19688 .option timeout queryprogram time 1h
19689 If the command does not complete within the timeout period, its process group
19690 is killed and the message is frozen. A value of zero time specifies no
19691 timeout.
19692
19693
19694 The standard output of the command is connected to a pipe, which is read when
19695 the command terminates. It should consist of a single line of output,
19696 containing up to five fields, separated by white space. The maximum length of
19697 the line is 1023 characters. Longer lines are silently truncated. The first
19698 field is one of the following words (case-insensitive):
19699
19700 .ilist
19701 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
19702 below).
19703 .next
19704 &'Decline'&: the router declines; pass the address to the next router, unless
19705 &%no_more%& is set.
19706 .next
19707 &'Fail'&: routing failed; do not pass the address to any more routers. Any
19708 subsequent text on the line is an error message. If the router is run as part
19709 of address verification during an incoming SMTP message, the message is
19710 included in the SMTP response.
19711 .next
19712 &'Defer'&: routing could not be completed at this time; try again later. Any
19713 subsequent text on the line is an error message which is logged. It is not
19714 included in any SMTP response.
19715 .next
19716 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
19717 .next
19718 &'Pass'&: pass the address to the next router (or the router specified by
19719 &%pass_router%&), overriding &%no_more%&.
19720 .next
19721 &'Redirect'&: the message is redirected. The remainder of the line is a list of
19722 new addresses, which are routed independently, starting with the first router,
19723 or the router specified by &%redirect_router%&, if set.
19724 .endlist
19725
19726 When the first word is &'accept'&, the remainder of the line consists of a
19727 number of keyed data values, as follows (split into two lines here, to fit on
19728 the page):
19729 .code
19730 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
19731 LOOKUP=byname|bydns DATA=<text>
19732 .endd
19733 The data items can be given in any order, and all are optional. If no transport
19734 is included, the transport specified by the generic &%transport%& option is
19735 used. The list of hosts and the lookup type are needed only if the transport is
19736 an &(smtp)& transport that does not itself supply a list of hosts.
19737
19738 The format of the list of hosts is the same as for the &(manualroute)& router.
19739 As well as host names and IP addresses with optional port numbers, as described
19740 in section &<<SECTformatonehostitem>>&, it may contain names followed by
19741 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
19742 (see section &<<SECThostshowused>>&).
19743
19744 If the lookup type is not specified, Exim behaves as follows when trying to
19745 find an IP address for each host: First, a DNS lookup is done. If this yields
19746 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
19747 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
19748 result of the lookup is the result of that call.
19749
19750 .vindex "&$address_data$&"
19751 If the DATA field is set, its value is placed in the &$address_data$&
19752 variable. For example, this return line
19753 .code
19754 accept hosts=x1.y.example:x2.y.example data="rule1"
19755 .endd
19756 routes the address to the default transport, passing a list of two hosts. When
19757 the transport runs, the string &"rule1"& is in &$address_data$&.
19758 .ecindex IIDquerou1
19759 .ecindex IIDquerou2
19760
19761
19762
19763
19764 . ////////////////////////////////////////////////////////////////////////////
19765 . ////////////////////////////////////////////////////////////////////////////
19766
19767 .chapter "The redirect router" "CHAPredirect"
19768 .scindex IIDredrou1 "&(redirect)& router"
19769 .scindex IIDredrou2 "routers" "&(redirect)&"
19770 .cindex "alias file" "in a &(redirect)& router"
19771 .cindex "address redirection" "&(redirect)& router"
19772 The &(redirect)& router handles several kinds of address redirection. Its most
19773 common uses are for resolving local part aliases from a central alias file
19774 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
19775 files, but it has many other potential uses. The incoming address can be
19776 redirected in several different ways:
19777
19778 .ilist
19779 It can be replaced by one or more new addresses which are themselves routed
19780 independently.
19781 .next
19782 It can be routed to be delivered to a given file or directory.
19783 .next
19784 It can be routed to be delivered to a specified pipe command.
19785 .next
19786 It can cause an automatic reply to be generated.
19787 .next
19788 It can be forced to fail, optionally with a custom error message.
19789 .next
19790 It can be temporarily deferred, optionally with a custom message.
19791 .next
19792 It can be discarded.
19793 .endlist
19794
19795 The generic &%transport%& option must not be set for &(redirect)& routers.
19796 However, there are some private options which define transports for delivery to
19797 files and pipes, and for generating autoreplies. See the &%file_transport%&,
19798 &%pipe_transport%& and &%reply_transport%& descriptions below.
19799
19800 If success DSNs have been requested
19801 .cindex "DSN" "success"
19802 .cindex "Delivery Status Notification" "success"
19803 redirection triggers one and the DSN options are not passed any further.
19804
19805
19806
19807 .section "Redirection data" "SECID124"
19808 The router operates by interpreting a text string which it obtains either by
19809 expanding the contents of the &%data%& option, or by reading the entire
19810 contents of a file whose name is given in the &%file%& option. These two
19811 options are mutually exclusive. The first is commonly used for handling system
19812 aliases, in a configuration like this:
19813 .code
19814 system_aliases:
19815   driver = redirect
19816   data = ${lookup{$local_part}lsearch{/etc/aliases}}
19817 .endd
19818 If the lookup fails, the expanded string in this example is empty. When the
19819 expansion of &%data%& results in an empty string, the router declines. A forced
19820 expansion failure also causes the router to decline; other expansion failures
19821 cause delivery to be deferred.
19822
19823 A configuration using &%file%& is commonly used for handling users'
19824 &_.forward_& files, like this:
19825 .code
19826 userforward:
19827   driver = redirect
19828   check_local_user
19829   file = $home/.forward
19830   no_verify
19831 .endd
19832 If the file does not exist, or causes no action to be taken (for example, it is
19833 empty or consists only of comments), the router declines. &*Warning*&: This
19834 is not the case when the file contains syntactically valid items that happen to
19835 yield empty addresses, for example, items containing only RFC 2822 address
19836 comments.
19837
19838
19839
19840 .section "Forward files and address verification" "SECID125"
19841 .cindex "address redirection" "while verifying"
19842 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
19843 &_.forward_& files, as in the example above. There are two reasons for this:
19844
19845 .ilist
19846 When Exim is receiving an incoming SMTP message from a remote host, it is
19847 running under the Exim uid, not as root. Exim is unable to change uid to read
19848 the file as the user, and it may not be able to read it as the Exim user. So in
19849 practice the router may not be able to operate.
19850 .next
19851 However, even when the router can operate, the existence of a &_.forward_& file
19852 is unimportant when verifying an address. What should be checked is whether the
19853 local part is a valid user name or not. Cutting out the redirection processing
19854 saves some resources.
19855 .endlist
19856
19857
19858
19859
19860
19861
19862 .section "Interpreting redirection data" "SECID126"
19863 .cindex "Sieve filter" "specifying in redirection data"
19864 .cindex "filter" "specifying in redirection data"
19865 The contents of the data string, whether obtained from &%data%& or &%file%&,
19866 can be interpreted in two different ways:
19867
19868 .ilist
19869 If the &%allow_filter%& option is set true, and the data begins with the text
19870 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
19871 &'filtering'& instructions in the form of an Exim or Sieve filter file,
19872 respectively. Details of the syntax and semantics of filter files are described
19873 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
19874 document is intended for use by end users.
19875 .next
19876 Otherwise, the data must be a comma-separated list of redirection items, as
19877 described in the next section.
19878 .endlist
19879
19880 When a message is redirected to a file (a &"mail folder"&), the file name given
19881 in a non-filter redirection list must always be an absolute path. A filter may
19882 generate a relative path &-- how this is handled depends on the transport's
19883 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
19884 for the &(appendfile)& transport.
19885
19886
19887
19888 .section "Items in a non-filter redirection list" "SECTitenonfilred"
19889 .cindex "address redirection" "non-filter list items"
19890 When the redirection data is not an Exim or Sieve filter, for example, if it
19891 comes from a conventional alias or forward file, it consists of a list of
19892 addresses, file names, pipe commands, or certain special items (see section
19893 &<<SECTspecitredli>>& below). The special items can be individually enabled or
19894 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
19895 depending on their default values. The items in the list are separated by
19896 commas or newlines.
19897 If a comma is required in an item, the entire item must be enclosed in double
19898 quotes.
19899
19900 Lines starting with a # character are comments, and are ignored, and # may
19901 also appear following a comma, in which case everything between the # and the
19902 next newline character is ignored.
19903
19904 If an item is entirely enclosed in double quotes, these are removed. Otherwise
19905 double quotes are retained because some forms of mail address require their use
19906 (but never to enclose the entire address). In the following description,
19907 &"item"& refers to what remains after any surrounding double quotes have been
19908 removed.
19909
19910 .vindex "&$local_part$&"
19911 &*Warning*&: If you use an Exim expansion to construct a redirection address,
19912 and the expansion contains a reference to &$local_part$&, you should make use
19913 of the &%quote_local_part%& expansion operator, in case the local part contains
19914 special characters. For example, to redirect all mail for the domain
19915 &'obsolete.example'&, retaining the existing local part, you could use this
19916 setting:
19917 .code
19918 data = ${quote_local_part:$local_part}@newdomain.example
19919 .endd
19920
19921
19922 .section "Redirecting to a local mailbox" "SECTredlocmai"
19923 .cindex "routing" "loops in"
19924 .cindex "loop" "while routing, avoidance of"
19925 .cindex "address redirection" "to local mailbox"
19926 A redirection item may safely be the same as the address currently under
19927 consideration. This does not cause a routing loop, because a router is
19928 automatically skipped if any ancestor of the address that is being processed
19929 is the same as the current address and was processed by the current router.
19930 Such an address is therefore passed to the following routers, so it is handled
19931 as if there were no redirection. When making this loop-avoidance test, the
19932 complete local part, including any prefix or suffix, is used.
19933
19934 .cindex "address redirection" "local part without domain"
19935 Specifying the same local part without a domain is a common usage in personal
19936 filter files when the user wants to have messages delivered to the local
19937 mailbox and also forwarded elsewhere. For example, the user whose login is
19938 &'cleo'& might have a &_.forward_& file containing this:
19939 .code
19940 cleo, cleopatra@egypt.example
19941 .endd
19942 .cindex "backslash in alias file"
19943 .cindex "alias file" "backslash in"
19944 For compatibility with other MTAs, such unqualified local parts may be
19945 preceded by &"\"&, but this is not a requirement for loop prevention. However,
19946 it does make a difference if more than one domain is being handled
19947 synonymously.
19948
19949 If an item begins with &"\"& and the rest of the item parses as a valid RFC
19950 2822 address that does not include a domain, the item is qualified using the
19951 domain of the incoming address. In the absence of a leading &"\"&, unqualified
19952 addresses are qualified using the value in &%qualify_recipient%&, but you can
19953 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
19954
19955 Care must be taken if there are alias names for local users.
19956 Consider an MTA handling a single local domain where the system alias file
19957 contains:
19958 .code
19959 Sam.Reman: spqr
19960 .endd
19961 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
19962 messages in the local mailbox, and also forward copies elsewhere. He creates
19963 this forward file:
19964 .code
19965 Sam.Reman, spqr@reme.elsewhere.example
19966 .endd
19967 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
19968 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
19969 second time round, because it has previously routed it,
19970 and the following routers presumably cannot handle the alias. The forward file
19971 should really contain
19972 .code
19973 spqr, spqr@reme.elsewhere.example
19974 .endd
19975 but because this is such a common error, the &%check_ancestor%& option (see
19976 below) exists to provide a way to get round it. This is normally set on a
19977 &(redirect)& router that is handling users' &_.forward_& files.
19978
19979
19980
19981 .section "Special items in redirection lists" "SECTspecitredli"
19982 In addition to addresses, the following types of item may appear in redirection
19983 lists (that is, in non-filter redirection data):
19984
19985 .ilist
19986 .cindex "pipe" "in redirection list"
19987 .cindex "address redirection" "to pipe"
19988 An item is treated as a pipe command if it begins with &"|"& and does not parse
19989 as a valid RFC 2822 address that includes a domain. A transport for running the
19990 command must be specified by the &%pipe_transport%& option.
19991 Normally, either the router or the transport specifies a user and a group under
19992 which to run the delivery. The default is to use the Exim user and group.
19993
19994 Single or double quotes can be used for enclosing the individual arguments of
19995 the pipe command; no interpretation of escapes is done for single quotes. If
19996 the command contains a comma character, it is necessary to put the whole item
19997 in double quotes, for example:
19998 .code
19999 "|/some/command ready,steady,go"
20000 .endd
20001 since items in redirection lists are terminated by commas. Do not, however,
20002 quote just the command. An item such as
20003 .code
20004 |"/some/command ready,steady,go"
20005 .endd
20006 is interpreted as a pipe with a rather strange command name, and no arguments.
20007
20008 Note that the above example assumes that the text comes from a lookup source
20009 of some sort, so that the quotes are part of the data.  If composing a
20010 redirect router with a &%data%& option directly specifying this command, the
20011 quotes will be used by the configuration parser to define the extent of one
20012 string, but will not be passed down into the redirect router itself.  There
20013 are two main approaches to get around this: escape quotes to be part of the
20014 data itself, or avoid using this mechanism and instead create a custom
20015 transport with the &%command%& option set and reference that transport from
20016 an &%accept%& router.
20017
20018 .next
20019 .cindex "file" "in redirection list"
20020 .cindex "address redirection" "to file"
20021 An item is interpreted as a path name if it begins with &"/"& and does not
20022 parse as a valid RFC 2822 address that includes a domain. For example,
20023 .code
20024 /home/world/minbari
20025 .endd
20026 is treated as a file name, but
20027 .code
20028 /s=molari/o=babylon/@x400gate.way
20029 .endd
20030 is treated as an address. For a file name, a transport must be specified using
20031 the &%file_transport%& option. However, if the generated path name ends with a
20032 forward slash character, it is interpreted as a directory name rather than a
20033 file name, and &%directory_transport%& is used instead.
20034
20035 Normally, either the router or the transport specifies a user and a group under
20036 which to run the delivery. The default is to use the Exim user and group.
20037
20038 .cindex "&_/dev/null_&"
20039 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20040 bypassed at a high level, and the log entry shows &"**bypassed**"&
20041 instead of a transport name. In this case the user and group are not used.
20042
20043 .next
20044 .cindex "included address list"
20045 .cindex "address redirection" "included external list"
20046 If an item is of the form
20047 .code
20048 :include:<path name>
20049 .endd
20050 a list of further items is taken from the given file and included at that
20051 point. &*Note*&: Such a file can not be a filter file; it is just an
20052 out-of-line addition to the list. The items in the included list are separated
20053 by commas or newlines and are not subject to expansion. If this is the first
20054 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20055 the alias name. This example is incorrect:
20056 .code
20057 list1    :include:/opt/lists/list1
20058 .endd
20059 It must be given as
20060 .code
20061 list1:   :include:/opt/lists/list1
20062 .endd
20063 .next
20064 .cindex "address redirection" "to black hole"
20065 .cindex "delivery" "discard"
20066 .cindex "delivery" "blackhole"
20067 .cindex "black hole"
20068 .cindex "abandoning mail"
20069 Sometimes you want to throw away mail to a particular local part.  Making the
20070 &%data%& option expand to an empty string does not work, because that causes
20071 the router to decline. Instead, the alias item
20072 .code
20073 :blackhole:
20074 .endd
20075 can be used. It does what its name implies. No delivery is
20076 done, and no error message is generated. This has the same effect as specifying
20077 &_/dev/null_& as a destination, but it can be independently disabled.
20078
20079 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20080 delivery is done for the original local part, even if other redirection items
20081 are present. If you are generating a multi-item list (for example, by reading a
20082 database) and need the ability to provide a no-op item, you must use
20083 &_/dev/null_&.
20084
20085 .next
20086 .cindex "delivery" "forcing failure"
20087 .cindex "delivery" "forcing deferral"
20088 .cindex "failing delivery" "forcing"
20089 .cindex "deferred delivery, forcing"
20090 .cindex "customizing" "failure message"
20091 An attempt to deliver a particular address can be deferred or forced to fail by
20092 redirection items of the form
20093 .code
20094 :defer:
20095 :fail:
20096 .endd
20097 respectively. When a redirection list contains such an item, it applies
20098 to the entire redirection; any other items in the list are ignored. Any
20099 text following &':fail:'& or &':defer:'& is placed in the error text
20100 associated with the failure. For example, an alias file might contain:
20101 .code
20102 X.Employee:  :fail: Gone away, no forwarding address
20103 .endd
20104 In the case of an address that is being verified from an ACL or as the subject
20105 of a
20106 .cindex "VRFY" "error text, display of"
20107 VRFY command, the text is included in the SMTP error response by
20108 default.
20109 .cindex "EXPN" "error text, display of"
20110 The text is not included in the response to an EXPN command. In non-SMTP cases
20111 the text is included in the error message that Exim generates.
20112
20113 .cindex "SMTP" "error codes"
20114 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20115 &':fail:'&. However, if the message starts with three digits followed by a
20116 space, optionally followed by an extended code of the form &'n.n.n'&, also
20117 followed by a space, and the very first digit is the same as the default error
20118 code, the code from the message is used instead. If the very first digit is
20119 incorrect, a panic error is logged, and the default code is used. You can
20120 suppress the use of the supplied code in a redirect router by setting the
20121 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20122 ignored.
20123
20124 .vindex "&$acl_verify_message$&"
20125 In an ACL, an explicitly provided message overrides the default, but the
20126 default message is available in the variable &$acl_verify_message$& and can
20127 therefore be included in a custom message if this is desired.
20128
20129 Normally the error text is the rest of the redirection list &-- a comma does
20130 not terminate it &-- but a newline does act as a terminator. Newlines are not
20131 normally present in alias expansions. In &(lsearch)& lookups they are removed
20132 as part of the continuation process, but they may exist in other kinds of
20133 lookup and in &':include:'& files.
20134
20135 During routing for message delivery (as opposed to verification), a redirection
20136 containing &':fail:'& causes an immediate failure of the incoming address,
20137 whereas &':defer:'& causes the message to remain on the queue so that a
20138 subsequent delivery attempt can happen at a later time. If an address is
20139 deferred for too long, it will ultimately fail, because the normal retry
20140 rules still apply.
20141
20142 .next
20143 .cindex "alias file" "exception to default"
20144 Sometimes it is useful to use a single-key search type with a default (see
20145 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20146 for exceptions to the default. These can be handled by aliasing them to
20147 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20148 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20149 results in an empty redirection list has the same effect.
20150 .endlist
20151
20152
20153 .section "Duplicate addresses" "SECTdupaddr"
20154 .cindex "duplicate addresses"
20155 .cindex "address duplicate, discarding"
20156 .cindex "pipe" "duplicated"
20157 Exim removes duplicate addresses from the list to which it is delivering, so as
20158 to deliver just one copy to each address. This does not apply to deliveries
20159 routed to pipes by different immediate parent addresses, but an indirect
20160 aliasing scheme of the type
20161 .code
20162 pipe:       |/some/command $local_part
20163 localpart1: pipe
20164 localpart2: pipe
20165 .endd
20166 does not work with a message that is addressed to both local parts, because
20167 when the second is aliased to the intermediate local part &"pipe"& it gets
20168 discarded as being the same as a previously handled address. However, a scheme
20169 such as
20170 .code
20171 localpart1: |/some/command $local_part
20172 localpart2: |/some/command $local_part
20173 .endd
20174 does result in two different pipe deliveries, because the immediate parents of
20175 the pipes are distinct.
20176
20177
20178
20179 .section "Repeated redirection expansion" "SECID128"
20180 .cindex "repeated redirection expansion"
20181 .cindex "address redirection" "repeated for each delivery attempt"
20182 When a message cannot be delivered to all of its recipients immediately,
20183 leading to two or more delivery attempts, redirection expansion is carried out
20184 afresh each time for those addresses whose children were not all previously
20185 delivered. If redirection is being used as a mailing list, this can lead to new
20186 members of the list receiving copies of old messages. The &%one_time%& option
20187 can be used to avoid this.
20188
20189
20190 .section "Errors in redirection lists" "SECID129"
20191 .cindex "address redirection" "errors"
20192 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20193 error is skipped, and an entry is written to the main log. This may be useful
20194 for mailing lists that are automatically managed. Otherwise, if an error is
20195 detected while generating the list of new addresses, the original address is
20196 deferred. See also &%syntax_errors_to%&.
20197
20198
20199
20200 .section "Private options for the redirect router" "SECID130"
20201
20202 .cindex "options" "&(redirect)& router"
20203 The private options for the &(redirect)& router are as follows:
20204
20205
20206 .option allow_defer redirect boolean false
20207 Setting this option allows the use of &':defer:'& in non-filter redirection
20208 data, or the &%defer%& command in an Exim filter file.
20209
20210
20211 .option allow_fail redirect boolean false
20212 .cindex "failing delivery" "from filter"
20213 If this option is true, the &':fail:'& item can be used in a redirection list,
20214 and the &%fail%& command may be used in an Exim filter file.
20215
20216
20217 .option allow_filter redirect boolean false
20218 .cindex "filter" "enabling use of"
20219 .cindex "Sieve filter" "enabling use of"
20220 Setting this option allows Exim to interpret redirection data that starts with
20221 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20222 are some features of Exim filter files that some administrators may wish to
20223 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20224
20225 It is also possible to lock out Exim filters or Sieve filters while allowing
20226 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20227
20228
20229 The filter is run using the uid and gid set by the generic &%user%& and
20230 &%group%& options. These take their defaults from the password data if
20231 &%check_local_user%& is set, so in the normal case of users' personal filter
20232 files, the filter is run as the relevant user. When &%allow_filter%& is set
20233 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20234
20235
20236
20237 .option allow_freeze redirect boolean false
20238 .cindex "freezing messages" "allowing in filter"
20239 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20240 This command is more normally encountered in system filters, and is disabled by
20241 default for redirection filters because it isn't something you usually want to
20242 let ordinary users do.
20243
20244
20245
20246 .option check_ancestor redirect boolean false
20247 This option is concerned with handling generated addresses that are the same
20248 as some address in the list of redirection ancestors of the current address.
20249 Although it is turned off by default in the code, it is set in the default
20250 configuration file for handling users' &_.forward_& files. It is recommended
20251 for this use of the &(redirect)& router.
20252
20253 When &%check_ancestor%& is set, if a generated address (including the domain)
20254 is the same as any ancestor of the current address, it is replaced by a copy of
20255 the current address. This helps in the case where local part A is aliased to B,
20256 and B has a &_.forward_& file pointing back to A. For example, within a single
20257 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20258 &_&~jb/.forward_& contains:
20259 .code
20260 \Joe.Bloggs, <other item(s)>
20261 .endd
20262 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20263 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20264 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20265 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20266 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20267 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20268 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20269 original address. See also the &%repeat_use%& option below.
20270
20271
20272 .option check_group redirect boolean "see below"
20273 When the &%file%& option is used, the group owner of the file is checked only
20274 when this option is set. The permitted groups are those listed in the
20275 &%owngroups%& option, together with the user's default group if
20276 &%check_local_user%& is set. If the file has the wrong group, routing is
20277 deferred. The default setting for this option is true if &%check_local_user%&
20278 is set and the &%modemask%& option permits the group write bit, or if the
20279 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20280
20281
20282
20283 .option check_owner redirect boolean "see below"
20284 When the &%file%& option is used, the owner of the file is checked only when
20285 this option is set. If &%check_local_user%& is set, the local user is
20286 permitted; otherwise the owner must be one of those listed in the &%owners%&
20287 option. The default value for this option is true if &%check_local_user%& or
20288 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20289
20290
20291 .option data redirect string&!! unset
20292 This option is mutually exclusive with &%file%&. One or other of them must be
20293 set, but not both. The contents of &%data%& are expanded, and then used as the
20294 list of forwarding items, or as a set of filtering instructions. If the
20295 expansion is forced to fail, or the result is an empty string or a string that
20296 has no effect (consists entirely of comments), the router declines.
20297
20298 When filtering instructions are used, the string must begin with &"#Exim
20299 filter"&, and all comments in the string, including this initial one, must be
20300 terminated with newline characters. For example:
20301 .code
20302 data = #Exim filter\n\
20303        if $h_to: contains Exim then save $home/mail/exim endif
20304 .endd
20305 If you are reading the data from a database where newlines cannot be included,
20306 you can use the &${sg}$& expansion item to turn the escape string of your
20307 choice into a newline.
20308
20309
20310 .option directory_transport redirect string&!! unset
20311 A &(redirect)& router sets up a direct delivery to a directory when a path name
20312 ending with a slash is specified as a new &"address"&. The transport used is
20313 specified by this option, which, after expansion, must be the name of a
20314 configured transport. This should normally be an &(appendfile)& transport.
20315
20316
20317 .option file redirect string&!! unset
20318 This option specifies the name of a file that contains the redirection data. It
20319 is mutually exclusive with the &%data%& option. The string is expanded before
20320 use; if the expansion is forced to fail, the router declines. Other expansion
20321 failures cause delivery to be deferred. The result of a successful expansion
20322 must be an absolute path. The entire file is read and used as the redirection
20323 data. If the data is an empty string or a string that has no effect (consists
20324 entirely of comments), the router declines.
20325
20326 .cindex "NFS" "checking for file existence"
20327 If the attempt to open the file fails with a &"does not exist"& error, Exim
20328 runs a check on the containing directory,
20329 unless &%ignore_enotdir%& is true (see below).
20330 If the directory does not appear to exist, delivery is deferred. This can
20331 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20332 is a mount problem. If the containing directory does exist, but the file does
20333 not, the router declines.
20334
20335
20336 .option file_transport redirect string&!! unset
20337 .vindex "&$address_file$&"
20338 A &(redirect)& router sets up a direct delivery to a file when a path name not
20339 ending in 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. When
20342 it is running, the file name is in &$address_file$&.
20343
20344
20345 .option filter_prepend_home redirect boolean true
20346 When this option is true, if a &(save)& command in an Exim filter specifies a
20347 relative path, and &$home$& is defined, it is automatically prepended to the
20348 relative path. If this option is set false, this action does not happen. The
20349 relative path is then passed to the transport unmodified.
20350
20351
20352 .option forbid_blackhole redirect boolean false
20353 .cindex "restricting access to features"
20354 .cindex "filter" "locking out certain features"
20355 If this option is true, the &':blackhole:'& item may not appear in a
20356 redirection list.
20357
20358
20359 .option forbid_exim_filter redirect boolean false
20360 .cindex "restricting access to features"
20361 .cindex "filter" "locking out certain features"
20362 If this option is set true, only Sieve filters are permitted when
20363 &%allow_filter%& is true.
20364
20365
20366
20367
20368 .option forbid_file redirect boolean false
20369 .cindex "restricting access to features"
20370 .cindex "delivery" "to file; forbidding"
20371 .cindex "filter" "locking out certain features"
20372 .cindex "Sieve filter" "forbidding delivery to a file"
20373 .cindex "Sieve filter" "&""keep""& facility; disabling"
20374 If this option is true, this router may not generate a new address that
20375 specifies delivery to a local file or directory, either from a filter or from a
20376 conventional forward file. This option is forced to be true if &%one_time%& is
20377 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20378 locks out the Sieve's &"keep"& facility.
20379
20380
20381 .option forbid_filter_dlfunc redirect boolean false
20382 .cindex "restricting access to features"
20383 .cindex "filter" "locking out certain features"
20384 If this option is true, string expansions in Exim filters are not allowed to
20385 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20386 functions.
20387
20388 .option forbid_filter_existstest redirect boolean false
20389 .cindex "restricting access to features"
20390 .cindex "filter" "locking out certain features"
20391 .cindex "expansion" "statting a file"
20392 If this option is true, string expansions in Exim filters are not allowed to
20393 make use of the &%exists%& condition or the &%stat%& expansion item.
20394
20395 .option forbid_filter_logwrite redirect boolean false
20396 .cindex "restricting access to features"
20397 .cindex "filter" "locking out certain features"
20398 If this option is true, use of the logging facility in Exim filters is not
20399 permitted. Logging is in any case available only if the filter is being run
20400 under some unprivileged uid (which is normally the case for ordinary users'
20401 &_.forward_& files).
20402
20403
20404 .option forbid_filter_lookup redirect boolean false
20405 .cindex "restricting access to features"
20406 .cindex "filter" "locking out certain features"
20407 If this option is true, string expansions in Exim filter files are not allowed
20408 to make use of &%lookup%& items.
20409
20410
20411 .option forbid_filter_perl redirect boolean false
20412 .cindex "restricting access to features"
20413 .cindex "filter" "locking out certain features"
20414 This option has an effect only if Exim is built with embedded Perl support. If
20415 it is true, string expansions in Exim filter files are not allowed to make use
20416 of the embedded Perl support.
20417
20418
20419 .option forbid_filter_readfile redirect boolean false
20420 .cindex "restricting access to features"
20421 .cindex "filter" "locking out certain features"
20422 If this option is true, string expansions in Exim filter files are not allowed
20423 to make use of &%readfile%& items.
20424
20425
20426 .option forbid_filter_readsocket redirect boolean false
20427 .cindex "restricting access to features"
20428 .cindex "filter" "locking out certain features"
20429 If this option is true, string expansions in Exim filter files are not allowed
20430 to make use of &%readsocket%& items.
20431
20432
20433 .option forbid_filter_reply redirect boolean false
20434 .cindex "restricting access to features"
20435 .cindex "filter" "locking out certain features"
20436 If this option is true, this router may not generate an automatic reply
20437 message. Automatic replies can be generated only from Exim or Sieve filter
20438 files, not from traditional forward files. This option is forced to be true if
20439 &%one_time%& is set.
20440
20441
20442 .option forbid_filter_run redirect boolean false
20443 .cindex "restricting access to features"
20444 .cindex "filter" "locking out certain features"
20445 If this option is true, string expansions in Exim filter files are not allowed
20446 to make use of &%run%& items.
20447
20448
20449 .option forbid_include redirect boolean false
20450 .cindex "restricting access to features"
20451 .cindex "filter" "locking out certain features"
20452 If this option is true, items of the form
20453 .code
20454 :include:<path name>
20455 .endd
20456 are not permitted in non-filter redirection lists.
20457
20458
20459 .option forbid_pipe redirect boolean false
20460 .cindex "restricting access to features"
20461 .cindex "filter" "locking out certain features"
20462 .cindex "delivery" "to pipe; forbidding"
20463 If this option is true, this router may not generate a new address which
20464 specifies delivery to a pipe, either from an Exim filter or from a conventional
20465 forward file. This option is forced to be true if &%one_time%& is set.
20466
20467
20468 .option forbid_sieve_filter redirect boolean false
20469 .cindex "restricting access to features"
20470 .cindex "filter" "locking out certain features"
20471 If this option is set true, only Exim filters are permitted when
20472 &%allow_filter%& is true.
20473
20474
20475 .cindex "SMTP" "error codes"
20476 .option forbid_smtp_code redirect boolean false
20477 If this option is set true, any SMTP error codes that are present at the start
20478 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20479 the default codes (451 and 550, respectively) are always used.
20480
20481
20482
20483
20484 .option hide_child_in_errmsg redirect boolean false
20485 .cindex "bounce message" "redirection details; suppressing"
20486 If this option is true, it prevents Exim from quoting a child address if it
20487 generates a bounce or delay message for it. Instead it says &"an address
20488 generated from <&'the top level address'&>"&. Of course, this applies only to
20489 bounces generated locally. If a message is forwarded to another host, &'its'&
20490 bounce may well quote the generated address.
20491
20492
20493 .option ignore_eacces redirect boolean false
20494 .cindex "EACCES"
20495 If this option is set and an attempt to open a redirection file yields the
20496 EACCES error (permission denied), the &(redirect)& router behaves as if the
20497 file did not exist.
20498
20499
20500 .option ignore_enotdir redirect boolean false
20501 .cindex "ENOTDIR"
20502 If this option is set and an attempt to open a redirection file yields the
20503 ENOTDIR error (something on the path is not a directory), the &(redirect)&
20504 router behaves as if the file did not exist.
20505
20506 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
20507 router that has the &%file%& option set discovers that the file does not exist
20508 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
20509 against unmounted NFS directories. If the parent can not be statted, delivery
20510 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
20511 is set, because that option tells Exim to ignore &"something on the path is not
20512 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
20513 that some operating systems give ENOENT where others give ENOTDIR.
20514
20515
20516
20517 .option include_directory redirect string unset
20518 If this option is set, the path names of any &':include:'& items in a
20519 redirection list must start with this directory.
20520
20521
20522 .option modemask redirect "octal integer" 022
20523 This specifies mode bits which must not be set for a file specified by the
20524 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
20525
20526
20527 .option one_time redirect boolean false
20528 .cindex "one-time aliasing/forwarding expansion"
20529 .cindex "alias file" "one-time expansion"
20530 .cindex "forward file" "one-time expansion"
20531 .cindex "mailing lists" "one-time expansion"
20532 .cindex "address redirection" "one-time expansion"
20533 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
20534 files each time it tries to deliver a message causes a problem when one or more
20535 of the generated addresses fails be delivered at the first attempt. The problem
20536 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
20537 but of what happens when the redirection list changes during the time that the
20538 message is on Exim's queue. This is particularly true in the case of mailing
20539 lists, where new subscribers might receive copies of messages that were posted
20540 before they subscribed.
20541
20542 If &%one_time%& is set and any addresses generated by the router fail to
20543 deliver at the first attempt, the failing addresses are added to the message as
20544 &"top level"& addresses, and the parent address that generated them is marked
20545 &"delivered"&. Thus, redirection does not happen again at the next delivery
20546 attempt.
20547
20548 &*Warning 1*&: Any header line addition or removal that is specified by this
20549 router would be lost if delivery did not succeed at the first attempt. For this
20550 reason, the &%headers_add%& and &%headers_remove%& generic options are not
20551 permitted when &%one_time%& is set.
20552
20553 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
20554 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
20555 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
20556
20557 &*Warning 3*&: The &%unseen%& generic router option may not be set with
20558 &%one_time%&.
20559
20560 The original top-level address is remembered with each of the generated
20561 addresses, and is output in any log messages. However, any intermediate parent
20562 addresses are not recorded. This makes a difference to the log only if
20563 &%all_parents%& log selector is set. It is expected that &%one_time%& will
20564 typically be used for mailing lists, where there is normally just one level of
20565 expansion.
20566
20567
20568 .option owners redirect "string list" unset
20569 .cindex "ownership" "alias file"
20570 .cindex "ownership" "forward file"
20571 .cindex "alias file" "ownership"
20572 .cindex "forward file" "ownership"
20573 This specifies a list of permitted owners for the file specified by &%file%&.
20574 This list is in addition to the local user when &%check_local_user%& is set.
20575 See &%check_owner%& above.
20576
20577
20578 .option owngroups redirect "string list" unset
20579 This specifies a list of permitted groups for the file specified by &%file%&.
20580 The list is in addition to the local user's primary group when
20581 &%check_local_user%& is set. See &%check_group%& above.
20582
20583
20584 .option pipe_transport redirect string&!! unset
20585 .vindex "&$address_pipe$&"
20586 A &(redirect)& router sets up a direct delivery to a pipe when a string
20587 starting with a vertical bar character is specified as a new &"address"&. The
20588 transport used is specified by this option, which, after expansion, must be the
20589 name of a configured transport. This should normally be a &(pipe)& transport.
20590 When the transport is run, the pipe command is in &$address_pipe$&.
20591
20592
20593 .option qualify_domain redirect string&!! unset
20594 .vindex "&$qualify_recipient$&"
20595 If this option is set, and an unqualified address (one without a domain) is
20596 generated, and that address would normally be qualified by the global setting
20597 in &%qualify_recipient%&, it is instead qualified with the domain specified by
20598 expanding this string. If the expansion fails, the router declines. If you want
20599 to revert to the default, you can have the expansion generate
20600 &$qualify_recipient$&.
20601
20602 This option applies to all unqualified addresses generated by Exim filters,
20603 but for traditional &_.forward_& files, it applies only to addresses that are
20604 not preceded by a backslash. Sieve filters cannot generate unqualified
20605 addresses.
20606
20607 .option qualify_preserve_domain redirect boolean false
20608 .cindex "domain" "in redirection; preserving"
20609 .cindex "preserving domain in redirection"
20610 .cindex "address redirection" "domain; preserving"
20611 If this option is set, the router's local &%qualify_domain%& option must not be
20612 set (a configuration error occurs if it is). If an unqualified address (one
20613 without a domain) is generated, it is qualified with the domain of the parent
20614 address (the immediately preceding ancestor) instead of the global
20615 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
20616 this applies whether or not the address is preceded by a backslash.
20617
20618
20619 .option repeat_use redirect boolean true
20620 If this option is set false, the router is skipped for a child address that has
20621 any ancestor that was routed by this router. This test happens before any of
20622 the other preconditions are tested. Exim's default anti-looping rules skip
20623 only when the ancestor is the same as the current address. See also
20624 &%check_ancestor%& above and the generic &%redirect_router%& option.
20625
20626
20627 .option reply_transport redirect string&!! unset
20628 A &(redirect)& router sets up an automatic reply when a &%mail%& or
20629 &%vacation%& command is used in a filter file. The transport used is specified
20630 by this option, which, after expansion, must be the name of a configured
20631 transport. This should normally be an &(autoreply)& transport. Other transports
20632 are unlikely to do anything sensible or useful.
20633
20634
20635 .option rewrite redirect boolean true
20636 .cindex "address redirection" "disabling rewriting"
20637 If this option is set false, addresses generated by the router are not
20638 subject to address rewriting. Otherwise, they are treated like new addresses
20639 and are rewritten according to the global rewriting rules.
20640
20641
20642 .option sieve_subaddress redirect string&!! unset
20643 The value of this option is passed to a Sieve filter to specify the
20644 :subaddress part of an address.
20645
20646 .option sieve_useraddress redirect string&!! unset
20647 The value of this option is passed to a Sieve filter to specify the :user part
20648 of an address. However, if it is unset, the entire original local part
20649 (including any prefix or suffix) is used for :user.
20650
20651
20652 .option sieve_vacation_directory redirect string&!! unset
20653 .cindex "Sieve filter" "vacation directory"
20654 To enable the &"vacation"& extension for Sieve filters, you must set
20655 &%sieve_vacation_directory%& to the directory where vacation databases are held
20656 (do not put anything else in that directory), and ensure that the
20657 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
20658 needs their own directory; Exim will create it if necessary.
20659
20660
20661
20662 .option skip_syntax_errors redirect boolean false
20663 .cindex "forward file" "broken"
20664 .cindex "address redirection" "broken files"
20665 .cindex "alias file" "broken"
20666 .cindex "broken alias or forward files"
20667 .cindex "ignoring faulty addresses"
20668 .cindex "skipping faulty addresses"
20669 .cindex "error" "skipping bad syntax"
20670 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
20671 non-filter redirection data are skipped, and each failing address is logged. If
20672 &%syntax_errors_to%& is set, a message is sent to the address it defines,
20673 giving details of the failures. If &%syntax_errors_text%& is set, its contents
20674 are expanded and placed at the head of the error message generated by
20675 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
20676 be the same address as the generic &%errors_to%& option. The
20677 &%skip_syntax_errors%& option is often used when handling mailing lists.
20678
20679 If all the addresses in a redirection list are skipped because of syntax
20680 errors, the router declines to handle the original address, and it is passed to
20681 the following routers.
20682
20683 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
20684 error in the filter causes filtering to be abandoned without any action being
20685 taken. The incident is logged, and the router declines to handle the address,
20686 so it is passed to the following routers.
20687
20688 .cindex "Sieve filter" "syntax errors in"
20689 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
20690 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
20691 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
20692
20693 &%skip_syntax_errors%& can be used to specify that errors in users' forward
20694 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
20695 option, used with an address that does not get redirected, can be used to
20696 notify users of these errors, by means of a router like this:
20697 .code
20698 userforward:
20699   driver = redirect
20700   allow_filter
20701   check_local_user
20702   file = $home/.forward
20703   file_transport = address_file
20704   pipe_transport = address_pipe
20705   reply_transport = address_reply
20706   no_verify
20707   skip_syntax_errors
20708   syntax_errors_to = real-$local_part@$domain
20709   syntax_errors_text = \
20710    This is an automatically generated message. An error has\n\
20711    been found in your .forward file. Details of the error are\n\
20712    reported below. While this error persists, you will receive\n\
20713    a copy of this message for every message that is addressed\n\
20714    to you. If your .forward file is a filter file, or if it is\n\
20715    a non-filter file containing no valid forwarding addresses,\n\
20716    a copy of each incoming message will be put in your normal\n\
20717    mailbox. If a non-filter file contains at least one valid\n\
20718    forwarding address, forwarding to the valid addresses will\n\
20719    happen, and those will be the only deliveries that occur.
20720 .endd
20721 You also need a router to ensure that local addresses that are prefixed by
20722 &`real-`& are recognized, but not forwarded or filtered. For example, you could
20723 put this immediately before the &(userforward)& router:
20724 .code
20725 real_localuser:
20726   driver = accept
20727   check_local_user
20728   local_part_prefix = real-
20729   transport = local_delivery
20730 .endd
20731 For security, it would probably be a good idea to restrict the use of this
20732 router to locally-generated messages, using a condition such as this:
20733 .code
20734   condition = ${if match {$sender_host_address}\
20735                          {\N^(|127\.0\.0\.1)$\N}}
20736 .endd
20737
20738
20739 .option syntax_errors_text redirect string&!! unset
20740 See &%skip_syntax_errors%& above.
20741
20742
20743 .option syntax_errors_to redirect string unset
20744 See &%skip_syntax_errors%& above.
20745 .ecindex IIDredrou1
20746 .ecindex IIDredrou2
20747
20748
20749
20750
20751
20752
20753 . ////////////////////////////////////////////////////////////////////////////
20754 . ////////////////////////////////////////////////////////////////////////////
20755
20756 .chapter "Environment for running local transports" "CHAPenvironment" &&&
20757          "Environment for local transports"
20758 .scindex IIDenvlotra1 "local transports" "environment for"
20759 .scindex IIDenvlotra2 "environment" "local transports"
20760 .scindex IIDenvlotra3 "transport" "local; environment for"
20761 Local transports handle deliveries to files and pipes. (The &(autoreply)&
20762 transport can be thought of as similar to a pipe.) Exim always runs transports
20763 in subprocesses, under specified uids and gids. Typical deliveries to local
20764 mailboxes run under the uid and gid of the local user.
20765
20766 Exim also sets a specific current directory while running the transport; for
20767 some transports a home directory setting is also relevant. The &(pipe)&
20768 transport is the only one that sets up environment variables; see section
20769 &<<SECTpipeenv>>& for details.
20770
20771 The values used for the uid, gid, and the directories may come from several
20772 different places. In many cases, the router that handles the address associates
20773 settings with that address as a result of its &%check_local_user%&, &%group%&,
20774 or &%user%& options. However, values may also be given in the transport's own
20775 configuration, and these override anything that comes from the router.
20776
20777
20778
20779 .section "Concurrent deliveries" "SECID131"
20780 .cindex "concurrent deliveries"
20781 .cindex "simultaneous deliveries"
20782 If two different messages for the same local recipient arrive more or less
20783 simultaneously, the two delivery processes are likely to run concurrently. When
20784 the &(appendfile)& transport is used to write to a file, Exim applies locking
20785 rules to stop concurrent processes from writing to the same file at the same
20786 time.
20787
20788 However, when you use a &(pipe)& transport, it is up to you to arrange any
20789 locking that is needed. Here is a silly example:
20790 .code
20791 my_transport:
20792   driver = pipe
20793   command = /bin/sh -c 'cat >>/some/file'
20794 .endd
20795 This is supposed to write the message at the end of the file. However, if two
20796 messages arrive at the same time, the file will be scrambled. You can use the
20797 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
20798 file using the same algorithm that Exim itself uses.
20799
20800
20801
20802
20803 .section "Uids and gids" "SECTenvuidgid"
20804 .cindex "local transports" "uid and gid"
20805 .cindex "transport" "local; uid and gid"
20806 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
20807 overrides any group that the router set in the address, even if &%user%& is not
20808 set for the transport. This makes it possible, for example, to run local mail
20809 delivery under the uid of the recipient (set by the router), but in a special
20810 group (set by the transport). For example:
20811 .code
20812 # Routers ...
20813 # User/group are set by check_local_user in this router
20814 local_users:
20815   driver = accept
20816   check_local_user
20817   transport = group_delivery
20818
20819 # Transports ...
20820 # This transport overrides the group
20821 group_delivery:
20822   driver = appendfile
20823   file = /var/spool/mail/$local_part
20824   group = mail
20825 .endd
20826 If &%user%& is set for a transport, its value overrides what is set in the
20827 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
20828 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
20829 set.
20830
20831 .oindex "&%initgroups%&"
20832 When the uid is taken from the transport's configuration, the &[initgroups()]&
20833 function is called for the groups associated with that uid if the
20834 &%initgroups%& option is set for the transport. When the uid is not specified
20835 by the transport, but is associated with the address by a router, the option
20836 for calling &[initgroups()]& is taken from the router configuration.
20837
20838 .cindex "&(pipe)& transport" "uid for"
20839 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
20840 is set and &%user%& is not set, the uid of the process that called Exim to
20841 receive the message is used, and if &%group%& is not set, the corresponding
20842 original gid is also used.
20843
20844 This is the detailed preference order for obtaining a gid; the first of the
20845 following that is set is used:
20846
20847 .ilist
20848 A &%group%& setting of the transport;
20849 .next
20850 A &%group%& setting of the router;
20851 .next
20852 A gid associated with a user setting of the router, either as a result of
20853 &%check_local_user%& or an explicit non-numeric &%user%& setting;
20854 .next
20855 The group associated with a non-numeric &%user%& setting of the transport;
20856 .next
20857 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
20858 the uid is the creator's uid;
20859 .next
20860 The Exim gid if the Exim uid is being used as a default.
20861 .endlist
20862
20863 If, for example, the user is specified numerically on the router and there are
20864 no group settings, no gid is available. In this situation, an error occurs.
20865 This is different for the uid, for which there always is an ultimate default.
20866 The first of the following that is set is used:
20867
20868 .ilist
20869 A &%user%& setting of the transport;
20870 .next
20871 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
20872 .next
20873 A &%user%& setting of the router;
20874 .next
20875 A &%check_local_user%& setting of the router;
20876 .next
20877 The Exim uid.
20878 .endlist
20879
20880 Of course, an error will still occur if the uid that is chosen is on the
20881 &%never_users%& list.
20882
20883
20884
20885
20886
20887 .section "Current and home directories" "SECID132"
20888 .cindex "current directory for local transport"
20889 .cindex "home directory" "for local transport"
20890 .cindex "transport" "local; home directory for"
20891 .cindex "transport" "local; current directory for"
20892 Routers may set current and home directories for local transports by means of
20893 the &%transport_current_directory%& and &%transport_home_directory%& options.
20894 However, if the transport's &%current_directory%& or &%home_directory%& options
20895 are set, they override the router's values. In detail, the home directory
20896 for a local transport is taken from the first of these values that is set:
20897
20898 .ilist
20899 The &%home_directory%& option on the transport;
20900 .next
20901 The &%transport_home_directory%& option on the router;
20902 .next
20903 The password data if &%check_local_user%& is set on the router;
20904 .next
20905 The &%router_home_directory%& option on the router.
20906 .endlist
20907
20908 The current directory is taken from the first of these values that is set:
20909
20910 .ilist
20911 The &%current_directory%& option on the transport;
20912 .next
20913 The &%transport_current_directory%& option on the router.
20914 .endlist
20915
20916
20917 If neither the router nor the transport sets a current directory, Exim uses the
20918 value of the home directory, if it is set. Otherwise it sets the current
20919 directory to &_/_& before running a local transport.
20920
20921
20922
20923 .section "Expansion variables derived from the address" "SECID133"
20924 .vindex "&$domain$&"
20925 .vindex "&$local_part$&"
20926 .vindex "&$original_domain$&"
20927 Normally a local delivery is handling a single address, and in that case the
20928 variables such as &$domain$& and &$local_part$& are set during local
20929 deliveries. However, in some circumstances more than one address may be handled
20930 at once (for example, while writing batch SMTP for onward transmission by some
20931 other means). In this case, the variables associated with the local part are
20932 never set, &$domain$& is set only if all the addresses have the same domain,
20933 and &$original_domain$& is never set.
20934 .ecindex IIDenvlotra1
20935 .ecindex IIDenvlotra2
20936 .ecindex IIDenvlotra3
20937
20938
20939
20940
20941
20942
20943
20944 . ////////////////////////////////////////////////////////////////////////////
20945 . ////////////////////////////////////////////////////////////////////////////
20946
20947 .chapter "Generic options for transports" "CHAPtransportgeneric"
20948 .scindex IIDgenoptra1 "generic options" "transport"
20949 .scindex IIDgenoptra2 "options" "generic; for transports"
20950 .scindex IIDgenoptra3 "transport" "generic options for"
20951 The following generic options apply to all transports:
20952
20953
20954 .option body_only transports boolean false
20955 .cindex "transport" "body only"
20956 .cindex "message" "transporting body only"
20957 .cindex "body of message" "transporting"
20958 If this option is set, the message's headers are not transported. It is
20959 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
20960 or &(pipe)& transports, the settings of &%message_prefix%& and
20961 &%message_suffix%& should be checked, because this option does not
20962 automatically suppress them.
20963
20964
20965 .option current_directory transports string&!! unset
20966 .cindex "transport" "current directory for"
20967 This specifies the current directory that is to be set while running the
20968 transport, overriding any value that may have been set by the router.
20969 If the expansion fails for any reason, including forced failure, an error is
20970 logged, and delivery is deferred.
20971
20972
20973 .option disable_logging transports boolean false
20974 If this option is set true, nothing is logged for any
20975 deliveries by the transport or for any
20976 transport errors. You should not set this option unless you really, really know
20977 what you are doing.
20978
20979
20980 .option debug_print transports string&!! unset
20981 .cindex "testing" "variables in drivers"
20982 If this option is set and debugging is enabled (see the &%-d%& command line
20983 option), the string is expanded and included in the debugging output when the
20984 transport is run.
20985 If expansion of the string fails, the error message is written to the debugging
20986 output, and Exim carries on processing.
20987 This facility is provided to help with checking out the values of variables and
20988 so on when debugging driver configurations. For example, if a &%headers_add%&
20989 option is not working properly, &%debug_print%& could be used to output the
20990 variables it references. A newline is added to the text if it does not end with
20991 one.
20992 The variables &$transport_name$& and &$router_name$& contain the name of the
20993 transport and the router that called it.
20994
20995 .option delivery_date_add transports boolean false
20996 .cindex "&'Delivery-date:'& header line"
20997 If this option is true, a &'Delivery-date:'& header is added to the message.
20998 This gives the actual time the delivery was made. As this is not a standard
20999 header, Exim has a configuration option (&%delivery_date_remove%&) which
21000 requests its removal from incoming messages, so that delivered messages can
21001 safely be resent to other recipients.
21002
21003
21004 .option driver transports string unset
21005 This specifies which of the available transport drivers is to be used.
21006 There is no default, and this option must be set for every transport.
21007
21008
21009 .option envelope_to_add transports boolean false
21010 .cindex "&'Envelope-to:'& header line"
21011 If this option is true, an &'Envelope-to:'& header is added to the message.
21012 This gives the original address(es) in the incoming envelope that caused this
21013 delivery to happen. More than one address may be present if the transport is
21014 configured to handle several addresses at once, or if more than one original
21015 address was redirected to the same final address. As this is not a standard
21016 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21017 its removal from incoming messages, so that delivered messages can safely be
21018 resent to other recipients.
21019
21020
21021 .option event_action transports string&!! unset
21022 .cindex events
21023 This option declares a string to be expanded for Exim's events mechanism.
21024 For details see chapter &<<CHAPevents>>&.
21025
21026
21027 .option group transports string&!! "Exim group"
21028 .cindex "transport" "group; specifying"
21029 This option specifies a gid for running the transport process, overriding any
21030 value that the router supplies, and also overriding any value associated with
21031 &%user%& (see below).
21032
21033
21034 .option headers_add transports list&!! unset
21035 .cindex "header lines" "adding in transport"
21036 .cindex "transport" "header lines; adding"
21037 This option specifies a list of text headers,
21038 newline-separated (by default, changeable in the usual way),
21039 which are (separately) expanded and added to the header
21040 portion of a message as it is transported, as described in section
21041 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21042 routers. If the result of the expansion is an empty string, or if the expansion
21043 is forced to fail, no action is taken. Other expansion failures are treated as
21044 errors and cause the delivery to be deferred.
21045
21046 Unlike most options, &%headers_add%& can be specified multiple times
21047 for a transport; all listed headers are added.
21048
21049
21050 .option headers_only transports boolean false
21051 .cindex "transport" "header lines only"
21052 .cindex "message" "transporting headers only"
21053 .cindex "header lines" "transporting"
21054 If this option is set, the message's body is not transported. It is mutually
21055 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21056 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21057 checked, since this option does not automatically suppress them.
21058
21059
21060 .option headers_remove transports list&!! unset
21061 .cindex "header lines" "removing"
21062 .cindex "transport" "header lines; removing"
21063 This option specifies a list of header names,
21064 colon-separated (by default, changeable in the usual way);
21065 these headers are omitted from the message as it is transported, as described
21066 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21067 routers.
21068 Each list item is separately expanded.
21069 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_remove%& can be specified multiple times
21074 for a transport; all listed headers are removed.
21075
21076 &*Warning*&: Because of the separate expansion of the list items,
21077 items that contain a list separator must have it doubled.
21078 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21079
21080
21081
21082 .option headers_rewrite transports string unset
21083 .cindex "transport" "header lines; rewriting"
21084 .cindex "rewriting" "at transport time"
21085 This option allows addresses in header lines to be rewritten at transport time,
21086 that is, as the message is being copied to its destination. The contents of the
21087 option are a colon-separated list of rewriting rules. Each rule is in exactly
21088 the same form as one of the general rewriting rules that are applied when a
21089 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21090 example,
21091 .code
21092 headers_rewrite = a@b c@d f : \
21093                   x@y w@z
21094 .endd
21095 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21096 &'w@z'& in all address-bearing header lines. The rules are applied to the
21097 header lines just before they are written out at transport time, so they affect
21098 only those copies of the message that pass through the transport. However, only
21099 the message's original header lines, and any that were added by a system
21100 filter, are rewritten. If a router or transport adds header lines, they are not
21101 affected by this option. These rewriting rules are &'not'& applied to the
21102 envelope. You can change the return path using &%return_path%&, but you cannot
21103 change envelope recipients at this time.
21104
21105
21106 .option home_directory transports string&!! unset
21107 .cindex "transport" "home directory for"
21108 .vindex "&$home$&"
21109 This option specifies a home directory setting for a local transport,
21110 overriding any value that may be set by the router. The home directory is
21111 placed in &$home$& while expanding the transport's private options. It is also
21112 used as the current directory if no current directory is set by the
21113 &%current_directory%& option on the transport or the
21114 &%transport_current_directory%& option on the router. If the expansion fails
21115 for any reason, including forced failure, an error is logged, and delivery is
21116 deferred.
21117
21118
21119 .option initgroups transports boolean false
21120 .cindex "additional groups"
21121 .cindex "groups" "additional"
21122 .cindex "transport" "group; additional"
21123 If this option is true and the uid for the delivery process is provided by the
21124 transport, the &[initgroups()]& function is called when running the transport
21125 to ensure that any additional groups associated with the uid are set up.
21126
21127
21128 .option max_parallel transports integer&!! unset
21129 .cindex limit "transport parallelism"
21130 .cindex transport "parallel processes"
21131 .cindex transport "concurrency limit"
21132 .cindex "delivery" "parallelism for transport"
21133 If this option is set and expands to an integer greater than zero
21134 it limits the number of concurrent runs of the transport.
21135 The control does not apply to shadow transports.
21136
21137 .cindex "hints database" "transport concurrency control"
21138 Exim implements this control by means of a hints database in which a record is
21139 incremented whenever a transport process is being created. The record
21140 is decremented and possibly removed when the process terminates.
21141 Obviously there is scope for
21142 records to get left lying around if there is a system or program crash. To
21143 guard against this, Exim ignores any records that are more than six hours old.
21144
21145 If you use this option, you should also arrange to delete the
21146 relevant hints database whenever your system reboots. The names of the files
21147 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21148 may be one or two files, depending on the type of DBM in use. The same files
21149 are used for ETRN and smtp transport serialization.
21150
21151
21152 .option message_size_limit transports string&!! 0
21153 .cindex "limit" "message size per transport"
21154 .cindex "size" "of message, limit"
21155 .cindex "transport" "message size; limiting"
21156 This option controls the size of messages passed through the transport. It is
21157 expanded before use; the result of the expansion must be a sequence of decimal
21158 digits, optionally followed by K or M. If the expansion fails for any reason,
21159 including forced failure, or if the result is not of the required form,
21160 delivery is deferred. If the value is greater than zero and the size of a
21161 message exceeds this limit, the address is failed. If there is any chance that
21162 the resulting bounce message could be routed to the same transport, you should
21163 ensure that &%return_size_limit%& is less than the transport's
21164 &%message_size_limit%&, as otherwise the bounce message will fail to get
21165 delivered.
21166
21167
21168
21169 .option rcpt_include_affixes transports boolean false
21170 .cindex "prefix" "for local part, including in envelope"
21171 .cindex "suffix for local part" "including in envelope"
21172 .cindex "local part" "prefix"
21173 .cindex "local part" "suffix"
21174 When this option is false (the default), and an address that has had any
21175 affixes (prefixes or suffixes) removed from the local part is delivered by any
21176 form of SMTP or LMTP, the affixes are not included. For example, if a router
21177 that contains
21178 .code
21179 local_part_prefix = *-
21180 .endd
21181 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21182 is delivered with
21183 .code
21184 RCPT TO:<xyz@some.domain>
21185 .endd
21186 This is also the case when an ACL-time callout is being used to verify a
21187 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21188 whole local part is included in the RCPT command. This option applies to BSMTP
21189 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21190 &(lmtp)& and &(smtp)& transports.
21191
21192
21193 .option retry_use_local_part transports boolean "see below"
21194 .cindex "hints database" "retry keys"
21195 When a delivery suffers a temporary failure, a retry record is created
21196 in Exim's hints database. For remote deliveries, the key for the retry record
21197 is based on the name and/or IP address of the failing remote host. For local
21198 deliveries, the key is normally the entire address, including both the local
21199 part and the domain. This is suitable for most common cases of local delivery
21200 temporary failure &-- for example, exceeding a mailbox quota should delay only
21201 deliveries to that mailbox, not to the whole domain.
21202
21203 However, in some special cases you may want to treat a temporary local delivery
21204 as a failure associated with the domain, and not with a particular local part.
21205 (For example, if you are storing all mail for some domain in files.) You can do
21206 this by setting &%retry_use_local_part%& false.
21207
21208 For all the local transports, its default value is true. For remote transports,
21209 the default value is false for tidiness, but changing the value has no effect
21210 on a remote transport in the current implementation.
21211
21212
21213 .option return_path transports string&!! unset
21214 .cindex "envelope sender"
21215 .cindex "transport" "return path; changing"
21216 .cindex "return path" "changing in transport"
21217 If this option is set, the string is expanded at transport time and replaces
21218 the existing return path (envelope sender) value in the copy of the message
21219 that is being delivered. An empty return path is permitted. This feature is
21220 designed for remote deliveries, where the value of this option is used in the
21221 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21222 only effect is to change the address that is placed in the &'Return-path:'&
21223 header line, if one is added to the message (see the next option).
21224
21225 &*Note:*& A changed return path is not logged unless you add
21226 &%return_path_on_delivery%& to the log selector.
21227
21228 .vindex "&$return_path$&"
21229 The expansion can refer to the existing value via &$return_path$&. This is
21230 either the message's envelope sender, or an address set by the
21231 &%errors_to%& option on a router. If the expansion is forced to fail, no
21232 replacement occurs; if it fails for another reason, delivery is deferred. This
21233 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21234 section &<<SECTverp>>&.
21235
21236 &*Note*&: If a delivery error is detected locally, including the case when a
21237 remote server rejects a message at SMTP time, the bounce message is not sent to
21238 the value of this option. It is sent to the previously set errors address.
21239 This defaults to the incoming sender address, but can be changed by setting
21240 &%errors_to%& in a router.
21241
21242
21243
21244 .option return_path_add transports boolean false
21245 .cindex "&'Return-path:'& header line"
21246 If this option is true, a &'Return-path:'& header is added to the message.
21247 Although the return path is normally available in the prefix line of BSD
21248 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21249 have easy access to it.
21250
21251 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21252 the delivery SMTP server makes the final delivery"&. This implies that this
21253 header should not be present in incoming messages. Exim has a configuration
21254 option, &%return_path_remove%&, which requests removal of this header from
21255 incoming messages, so that delivered messages can safely be resent to other
21256 recipients.
21257
21258
21259 .option shadow_condition transports string&!! unset
21260 See &%shadow_transport%& below.
21261
21262
21263 .option shadow_transport transports string unset
21264 .cindex "shadow transport"
21265 .cindex "transport" "shadow"
21266 A local transport may set the &%shadow_transport%& option to the name of
21267 another local transport. Shadow remote transports are not supported.
21268
21269 Whenever a delivery to the main transport succeeds, and either
21270 &%shadow_condition%& is unset, or its expansion does not result in the empty
21271 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21272 passed to the shadow transport, with the same delivery address or addresses. If
21273 expansion fails, no action is taken except that non-forced expansion failures
21274 cause a log line to be written.
21275
21276 The result of the shadow transport is discarded and does not affect the
21277 subsequent processing of the message. Only a single level of shadowing is
21278 provided; the &%shadow_transport%& option is ignored on any transport when it
21279 is running as a shadow. Options concerned with output from pipes are also
21280 ignored. The log line for the successful delivery has an item added on the end,
21281 of the form
21282 .code
21283 ST=<shadow transport name>
21284 .endd
21285 If the shadow transport did not succeed, the error message is put in
21286 parentheses afterwards. Shadow transports can be used for a number of different
21287 purposes, including keeping more detailed log information than Exim normally
21288 provides, and implementing automatic acknowledgment policies based on message
21289 headers that some sites insist on.
21290
21291
21292 .option transport_filter transports string&!! unset
21293 .cindex "transport" "filter"
21294 .cindex "filter" "transport filter"
21295 This option sets up a filtering (in the Unix shell sense) process for messages
21296 at transport time. It should not be confused with mail filtering as set up by
21297 individual users or via a system filter.
21298 If unset, or expanding to an empty string, no filtering is done.
21299
21300 When the message is about to be written out, the command specified by
21301 &%transport_filter%& is started up in a separate, parallel process, and
21302 the entire message, including the header lines, is passed to it on its standard
21303 input (this in fact is done from a third process, to avoid deadlock). The
21304 command must be specified as an absolute path.
21305
21306 The lines of the message that are written to the transport filter are
21307 terminated by newline (&"\n"&). The message is passed to the filter before any
21308 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21309 lines beginning with a dot, and also before any processing implied by the
21310 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21311 &(pipe)& transports.
21312
21313 The standard error for the filter process is set to the same destination as its
21314 standard output; this is read and written to the message's ultimate
21315 destination. The process that writes the message to the filter, the
21316 filter itself, and the original process that reads the result and delivers it
21317 are all run in parallel, like a shell pipeline.
21318
21319 The filter can perform any transformations it likes, but of course should take
21320 care not to break RFC 2822 syntax. Exim does not check the result, except to
21321 test for a final newline when SMTP is in use. All messages transmitted over
21322 SMTP must end with a newline, so Exim supplies one if it is missing.
21323
21324 .cindex "content scanning" "per user"
21325 A transport filter can be used to provide content-scanning on a per-user basis
21326 at delivery time if the only required effect of the scan is to modify the
21327 message. For example, a content scan could insert a new header line containing
21328 a spam score. This could be interpreted by a filter in the user's MUA. It is
21329 not possible to discard a message at this stage.
21330
21331 .cindex "SMTP" "SIZE"
21332 A problem might arise if the filter increases the size of a message that is
21333 being sent down an SMTP connection. If the receiving SMTP server has indicated
21334 support for the SIZE parameter, Exim will have sent the size of the message
21335 at the start of the SMTP session. If what is actually sent is substantially
21336 more, the server might reject the message. This can be worked round by setting
21337 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21338 additions to the message, or to disable the use of SIZE altogether.
21339
21340 .vindex "&$pipe_addresses$&"
21341 The value of the &%transport_filter%& option is the command string for starting
21342 the filter, which is run directly from Exim, not under a shell. The string is
21343 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21344 Exim breaks it up into arguments and then expands each argument separately (see
21345 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21346 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21347 of arguments, one for each address that applies to this delivery. (This isn't
21348 an ideal name for this feature here, but as it was already implemented for the
21349 &(pipe)& transport, it seemed sensible not to change it.)
21350
21351 .vindex "&$host$&"
21352 .vindex "&$host_address$&"
21353 The expansion variables &$host$& and &$host_address$& are available when the
21354 transport is a remote one. They contain the name and IP address of the host to
21355 which the message is being sent. For example:
21356 .code
21357 transport_filter = /some/directory/transport-filter.pl \
21358   $host $host_address $sender_address $pipe_addresses
21359 .endd
21360
21361 Two problems arise if you want to use more complicated expansion items to
21362 generate transport filter commands, both of which due to the fact that the
21363 command is split up &'before'& expansion.
21364 .ilist
21365 If an expansion item contains white space, you must quote it, so that it is all
21366 part of the same command item. If the entire option setting is one such
21367 expansion item, you have to take care what kind of quoting you use. For
21368 example:
21369 .code
21370 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21371 .endd
21372 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21373 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21374 stripped by Exim when it read the option's value. When the value is used, if
21375 the single quotes were missing, the line would be split into two items,
21376 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21377 Exim tried to expand the first one.
21378 .next
21379 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21380 expansion cannot generate multiple arguments, or a command name followed by
21381 arguments. Consider this example:
21382 .code
21383 transport_filter = ${lookup{$host}lsearch{/a/file}\
21384                     {$value}{/bin/cat}}
21385 .endd
21386 The result of the lookup is interpreted as the name of the command, even
21387 if it contains white space. The simplest way round this is to use a shell:
21388 .code
21389 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21390                                {$value}{/bin/cat}}
21391 .endd
21392 .endlist
21393
21394 The filter process is run under the same uid and gid as the normal delivery.
21395 For remote deliveries this is the Exim uid/gid by default. The command should
21396 normally yield a zero return code. Transport filters are not supposed to fail.
21397 A non-zero code is taken to mean that the transport filter encountered some
21398 serious problem. Delivery of the message is deferred; the message remains on
21399 the queue and is tried again later. It is not possible to cause a message to be
21400 bounced from a transport filter.
21401
21402 If a transport filter is set on an autoreply transport, the original message is
21403 passed through the filter as it is being copied into the newly generated
21404 message, which happens if the &%return_message%& option is set.
21405
21406
21407 .option transport_filter_timeout transports time 5m
21408 .cindex "transport" "filter, timeout"
21409 When Exim is reading the output of a transport filter, it applies a timeout
21410 that can be set by this option. Exceeding the timeout is normally treated as a
21411 temporary delivery failure. However, if a transport filter is used with a
21412 &(pipe)& transport, a timeout in the transport filter is treated in the same
21413 way as a timeout in the pipe command itself. By default, a timeout is a hard
21414 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21415 becomes a temporary error.
21416
21417
21418 .option user transports string&!! "Exim user"
21419 .cindex "uid (user id)" "local delivery"
21420 .cindex "transport" "user, specifying"
21421 This option specifies the user under whose uid the delivery process is to be
21422 run, overriding any uid that may have been set by the router. If the user is
21423 given as a name, the uid is looked up from the password data, and the
21424 associated group is taken as the value of the gid to be used if the &%group%&
21425 option is not set.
21426
21427 For deliveries that use local transports, a user and group are normally
21428 specified explicitly or implicitly (for example, as a result of
21429 &%check_local_user%&) by the router or transport.
21430
21431 .cindex "hints database" "access by remote transport"
21432 For remote transports, you should leave this option unset unless you really are
21433 sure you know what you are doing. When a remote transport is running, it needs
21434 to be able to access Exim's hints databases, because each host may have its own
21435 retry data.
21436 .ecindex IIDgenoptra1
21437 .ecindex IIDgenoptra2
21438 .ecindex IIDgenoptra3
21439
21440
21441
21442
21443
21444
21445 . ////////////////////////////////////////////////////////////////////////////
21446 . ////////////////////////////////////////////////////////////////////////////
21447
21448 .chapter "Address batching in local transports" "CHAPbatching" &&&
21449          "Address batching"
21450 .cindex "transport" "local; address batching in"
21451 The only remote transport (&(smtp)&) is normally configured to handle more than
21452 one address at a time, so that when several addresses are routed to the same
21453 remote host, just one copy of the message is sent. Local transports, however,
21454 normally handle one address at a time. That is, a separate instance of the
21455 transport is run for each address that is routed to the transport. A separate
21456 copy of the message is delivered each time.
21457
21458 .cindex "batched local delivery"
21459 .oindex "&%batch_max%&"
21460 .oindex "&%batch_id%&"
21461 In special cases, it may be desirable to handle several addresses at once in a
21462 local transport, for example:
21463
21464 .ilist
21465 In an &(appendfile)& transport, when storing messages in files for later
21466 delivery by some other means, a single copy of the message with multiple
21467 recipients saves space.
21468 .next
21469 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21470 a single copy saves time, and is the normal way LMTP is expected to work.
21471 .next
21472 In a &(pipe)& transport, when passing the message
21473 to a scanner program or
21474 to some other delivery mechanism such as UUCP, multiple recipients may be
21475 acceptable.
21476 .endlist
21477
21478 These three local transports all have the same options for controlling multiple
21479 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21480 repeating the information for each transport, these options are described here.
21481
21482 The &%batch_max%& option specifies the maximum number of addresses that can be
21483 delivered together in a single run of the transport. Its default value is one
21484 (no batching). When more than one address is routed to a transport that has a
21485 &%batch_max%& value greater than one, the addresses are delivered in a batch
21486 (that is, in a single run of the transport with multiple recipients), subject
21487 to certain conditions:
21488
21489 .ilist
21490 .vindex "&$local_part$&"
21491 If any of the transport's options contain a reference to &$local_part$&, no
21492 batching is possible.
21493 .next
21494 .vindex "&$domain$&"
21495 If any of the transport's options contain a reference to &$domain$&, only
21496 addresses with the same domain are batched.
21497 .next
21498 .cindex "customizing" "batching condition"
21499 If &%batch_id%& is set, it is expanded for each address, and only those
21500 addresses with the same expanded value are batched. This allows you to specify
21501 customized batching conditions. Failure of the expansion for any reason,
21502 including forced failure, disables batching, but it does not stop the delivery
21503 from taking place.
21504 .next
21505 Batched addresses must also have the same errors address (where to send
21506 delivery errors), the same header additions and removals, the same user and
21507 group for the transport, and if a host list is present, the first host must
21508 be the same.
21509 .endlist
21510
21511 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
21512 both when the file or pipe command is specified in the transport, and when it
21513 is specified by a &(redirect)& router, but all the batched addresses must of
21514 course be routed to the same file or pipe command. These two transports have an
21515 option called &%use_bsmtp%&, which causes them to deliver the message in
21516 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
21517 &%check_string%& and &%escape_string%& options are forced to the values
21518 .code
21519 check_string = "."
21520 escape_string = ".."
21521 .endd
21522 when batched SMTP is in use. A full description of the batch SMTP mechanism is
21523 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
21524 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
21525
21526 .cindex "&'Envelope-to:'& header line"
21527 If the generic &%envelope_to_add%& option is set for a batching transport, the
21528 &'Envelope-to:'& header that is added to the message contains all the addresses
21529 that are being processed together. If you are using a batching &(appendfile)&
21530 transport without &%use_bsmtp%&, the only way to preserve the recipient
21531 addresses is to set the &%envelope_to_add%& option.
21532
21533 .cindex "&(pipe)& transport" "with multiple addresses"
21534 .vindex "&$pipe_addresses$&"
21535 If you are using a &(pipe)& transport without BSMTP, and setting the
21536 transport's &%command%& option, you can include &$pipe_addresses$& as part of
21537 the command. This is not a true variable; it is a bit of magic that causes each
21538 of the recipient addresses to be inserted into the command as a separate
21539 argument. This provides a way of accessing all the addresses that are being
21540 delivered in the batch. &*Note:*& This is not possible for pipe commands that
21541 are specified by a &(redirect)& router.
21542
21543
21544
21545
21546 . ////////////////////////////////////////////////////////////////////////////
21547 . ////////////////////////////////////////////////////////////////////////////
21548
21549 .chapter "The appendfile transport" "CHAPappendfile"
21550 .scindex IIDapptra1 "&(appendfile)& transport"
21551 .scindex IIDapptra2 "transports" "&(appendfile)&"
21552 .cindex "directory creation"
21553 .cindex "creating directories"
21554 The &(appendfile)& transport delivers a message by appending it to an existing
21555 file, or by creating an entirely new file in a specified directory. Single
21556 files to which messages are appended can be in the traditional Unix mailbox
21557 format, or optionally in the MBX format supported by the Pine MUA and
21558 University of Washington IMAP daemon, &'inter alia'&. When each message is
21559 being delivered as a separate file, &"maildir"& format can optionally be used
21560 to give added protection against failures that happen part-way through the
21561 delivery. A third form of separate-file delivery known as &"mailstore"& is also
21562 supported. For all file formats, Exim attempts to create as many levels of
21563 directory as necessary, provided that &%create_directory%& is set.
21564
21565 The code for the optional formats is not included in the Exim binary by
21566 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
21567 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
21568 included.
21569
21570 .cindex "quota" "system"
21571 Exim recognizes system quota errors, and generates an appropriate message. Exim
21572 also supports its own quota control within the transport, for use when the
21573 system facility is unavailable or cannot be used for some reason.
21574
21575 If there is an error while appending to a file (for example, quota exceeded or
21576 partition filled), Exim attempts to reset the file's length and last
21577 modification time back to what they were before. If there is an error while
21578 creating an entirely new file, the new file is removed.
21579
21580 Before appending to a file, a number of security checks are made, and the
21581 file is locked. A detailed description is given below, after the list of
21582 private options.
21583
21584 The &(appendfile)& transport is most commonly used for local deliveries to
21585 users' mailboxes. However, it can also be used as a pseudo-remote transport for
21586 putting messages into files for remote delivery by some means other than Exim.
21587 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
21588 option).
21589
21590
21591
21592 .section "The file and directory options" "SECTfildiropt"
21593 The &%file%& option specifies a single file, to which the message is appended;
21594 the &%directory%& option specifies a directory, in which a new file containing
21595 the message is created. Only one of these two options can be set, and for
21596 normal deliveries to mailboxes, one of them &'must'& be set.
21597
21598 .vindex "&$address_file$&"
21599 .vindex "&$local_part$&"
21600 However, &(appendfile)& is also used for delivering messages to files or
21601 directories whose names (or parts of names) are obtained from alias,
21602 forwarding, or filtering operations (for example, a &%save%& command in a
21603 user's Exim filter). When such a transport is running, &$local_part$& contains
21604 the local part that was aliased or forwarded, and &$address_file$& contains the
21605 name (or partial name) of the file or directory generated by the redirection
21606 operation. There are two cases:
21607
21608 .ilist
21609 If neither &%file%& nor &%directory%& is set, the redirection operation
21610 must specify an absolute path (one that begins with &`/`&). This is the most
21611 common case when users with local accounts use filtering to sort mail into
21612 different folders. See for example, the &(address_file)& transport in the
21613 default configuration. If the path ends with a slash, it is assumed to be the
21614 name of a directory. A delivery to a directory can also be forced by setting
21615 &%maildir_format%& or &%mailstore_format%&.
21616 .next
21617 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
21618 used to determine the file or directory name for the delivery. Normally, the
21619 contents of &$address_file$& are used in some way in the string expansion.
21620 .endlist
21621
21622
21623 .cindex "Sieve filter" "configuring &(appendfile)&"
21624 .cindex "Sieve filter" "relative mailbox path handling"
21625 As an example of the second case, consider an environment where users do not
21626 have home directories. They may be permitted to use Exim filter commands of the
21627 form:
21628 .code
21629 save folder23
21630 .endd
21631 or Sieve filter commands of the form:
21632 .code
21633 require "fileinto";
21634 fileinto "folder23";
21635 .endd
21636 In this situation, the expansion of &%file%& or &%directory%& in the transport
21637 must transform the relative path into an appropriate absolute file name. In the
21638 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
21639 is used as a result of a &"keep"& action in the filter. This example shows one
21640 way of handling this requirement:
21641 .code
21642 file = ${if eq{$address_file}{inbox} \
21643             {/var/mail/$local_part} \
21644             {${if eq{${substr_0_1:$address_file}}{/} \
21645                   {$address_file} \
21646                   {$home/mail/$address_file} \
21647             }} \
21648        }
21649 .endd
21650 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
21651 location, absolute paths are used without change, and other folders are in the
21652 &_mail_& directory within the home directory.
21653
21654 &*Note 1*&: While processing an Exim filter, a relative path such as
21655 &_folder23_& is turned into an absolute path if a home directory is known to
21656 the router. In particular, this is the case if &%check_local_user%& is set. If
21657 you want to prevent this happening at routing time, you can set
21658 &%router_home_directory%& empty. This forces the router to pass the relative
21659 path to the transport.
21660
21661 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
21662 the &%file%& or &%directory%& option is still used if it is set.
21663
21664
21665
21666
21667 .section "Private options for appendfile" "SECID134"
21668 .cindex "options" "&(appendfile)& transport"
21669
21670
21671
21672 .option allow_fifo appendfile boolean false
21673 .cindex "fifo (named pipe)"
21674 .cindex "named pipe (fifo)"
21675 .cindex "pipe" "named (fifo)"
21676 Setting this option permits delivery to named pipes (FIFOs) as well as to
21677 regular files. If no process is reading the named pipe at delivery time, the
21678 delivery is deferred.
21679
21680
21681 .option allow_symlink appendfile boolean false
21682 .cindex "symbolic link" "to mailbox"
21683 .cindex "mailbox" "symbolic link"
21684 By default, &(appendfile)& will not deliver if the path name for the file is
21685 that of a symbolic link. Setting this option relaxes that constraint, but there
21686 are security issues involved in the use of symbolic links. Be sure you know
21687 what you are doing if you set this. Details of exactly what this option affects
21688 are included in the discussion which follows this list of options.
21689
21690
21691 .option batch_id appendfile string&!! unset
21692 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21693 However, batching is automatically disabled for &(appendfile)& deliveries that
21694 happen as a result of forwarding or aliasing or other redirection directly to a
21695 file.
21696
21697
21698 .option batch_max appendfile integer 1
21699 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
21700
21701
21702 .option check_group appendfile boolean false
21703 When this option is set, the group owner of the file defined by the &%file%&
21704 option is checked to see that it is the same as the group under which the
21705 delivery process is running. The default setting is false because the default
21706 file mode is 0600, which means that the group is irrelevant.
21707
21708
21709 .option check_owner appendfile boolean true
21710 When this option is set, the owner of the file defined by the &%file%& option
21711 is checked to ensure that it is the same as the user under which the delivery
21712 process is running.
21713
21714
21715 .option check_string appendfile string "see below"
21716 .cindex "&""From""& line"
21717 As &(appendfile)& writes the message, the start of each line is tested for
21718 matching &%check_string%&, and if it does, the initial matching characters are
21719 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
21720 a literal string, not a regular expression, and the case of any letters it
21721 contains is significant.
21722
21723 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
21724 are forced to &"."& and &".."& respectively, and any settings in the
21725 configuration are ignored. Otherwise, they default to &"From&~"& and
21726 &">From&~"& when the &%file%& option is set, and unset when any of the
21727 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
21728
21729 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
21730 suitable for traditional &"BSD"& mailboxes, where a line beginning with
21731 &"From&~"& indicates the start of a new message. All four options need changing
21732 if another format is used. For example, to deliver to mailboxes in MMDF format:
21733 .cindex "MMDF format mailbox"
21734 .cindex "mailbox" "MMDF format"
21735 .code
21736 check_string = "\1\1\1\1\n"
21737 escape_string = "\1\1\1\1 \n"
21738 message_prefix = "\1\1\1\1\n"
21739 message_suffix = "\1\1\1\1\n"
21740 .endd
21741 .option create_directory appendfile boolean true
21742 .cindex "directory creation"
21743 When this option is true, Exim attempts to create any missing superior
21744 directories for the file that it is about to write. A created directory's mode
21745 is given by the &%directory_mode%& option.
21746
21747 The group ownership of a newly created directory is highly dependent on the
21748 operating system (and possibly the file system) that is being used. For
21749 example, in Solaris, if the parent directory has the setgid bit set, its group
21750 is propagated to the child; if not, the currently set group is used. However,
21751 in FreeBSD, the parent's group is always used.
21752
21753
21754
21755 .option create_file appendfile string anywhere
21756 This option constrains the location of files and directories that are created
21757 by this transport. It applies to files defined by the &%file%& option and
21758 directories defined by the &%directory%& option. In the case of maildir
21759 delivery, it applies to the top level directory, not the maildir directories
21760 beneath.
21761
21762 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
21763 &"belowhome"&. In the second and third cases, a home directory must have been
21764 set for the transport. This option is not useful when an explicit file name is
21765 given for normal mailbox deliveries. It is intended for the case when file
21766 names are generated from users' &_.forward_& files. These are usually handled
21767 by an &(appendfile)& transport called &%address_file%&. See also
21768 &%file_must_exist%&.
21769
21770
21771 .option directory appendfile string&!! unset
21772 This option is mutually exclusive with the &%file%& option, but one of &%file%&
21773 or &%directory%& must be set, unless the delivery is the direct result of a
21774 redirection (see section &<<SECTfildiropt>>&).
21775
21776 When &%directory%& is set, the string is expanded, and the message is delivered
21777 into a new file or files in or below the given directory, instead of being
21778 appended to a single mailbox file. A number of different formats are provided
21779 (see &%maildir_format%& and &%mailstore_format%&), and see section
21780 &<<SECTopdir>>& for further details of this form of delivery.
21781
21782
21783 .option directory_file appendfile string&!! "see below"
21784 .cindex "base62"
21785 .vindex "&$inode$&"
21786 When &%directory%& is set, but neither &%maildir_format%& nor
21787 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
21788 whose name is obtained by expanding this string. The default value is:
21789 .code
21790 q${base62:$tod_epoch}-$inode
21791 .endd
21792 This generates a unique name from the current time, in base 62 form, and the
21793 inode of the file. The variable &$inode$& is available only when expanding this
21794 option.
21795
21796
21797 .option directory_mode appendfile "octal integer" 0700
21798 If &(appendfile)& creates any directories as a result of the
21799 &%create_directory%& option, their mode is specified by this option.
21800
21801
21802 .option escape_string appendfile string "see description"
21803 See &%check_string%& above.
21804
21805
21806 .option file appendfile string&!! unset
21807 This option is mutually exclusive with the &%directory%& option, but one of
21808 &%file%& or &%directory%& must be set, unless the delivery is the direct result
21809 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
21810 specifies a single file, to which the message is appended. One or more of
21811 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
21812 &%file%&.
21813
21814 .cindex "NFS" "lock file"
21815 .cindex "locking files"
21816 .cindex "lock files"
21817 If you are using more than one host to deliver over NFS into the same
21818 mailboxes, you should always use lock files.
21819
21820 The string value is expanded for each delivery, and must yield an absolute
21821 path. The most common settings of this option are variations on one of these
21822 examples:
21823 .code
21824 file = /var/spool/mail/$local_part
21825 file = /home/$local_part/inbox
21826 file = $home/inbox
21827 .endd
21828 .cindex "&""sticky""& bit"
21829 In the first example, all deliveries are done into the same directory. If Exim
21830 is configured to use lock files (see &%use_lockfile%& below) it must be able to
21831 create a file in the directory, so the &"sticky"& bit must be turned on for
21832 deliveries to be possible, or alternatively the &%group%& option can be used to
21833 run the delivery under a group id which has write access to the directory.
21834
21835
21836
21837 .option file_format appendfile string unset
21838 .cindex "file" "mailbox; checking existing format"
21839 This option requests the transport to check the format of an existing file
21840 before adding to it. The check consists of matching a specific string at the
21841 start of the file. The value of the option consists of an even number of
21842 colon-separated strings. The first of each pair is the test string, and the
21843 second is the name of a transport. If the transport associated with a matched
21844 string is not the current transport, control is passed over to the other
21845 transport. For example, suppose the standard &(local_delivery)& transport has
21846 this added to it:
21847 .code
21848 file_format = "From       : local_delivery :\
21849                \1\1\1\1\n : local_mmdf_delivery"
21850 .endd
21851 Mailboxes that begin with &"From"& are still handled by this transport, but if
21852 a mailbox begins with four binary ones followed by a newline, control is passed
21853 to a transport called &%local_mmdf_delivery%&, which presumably is configured
21854 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
21855 is assumed to match the current transport. If the start of a mailbox doesn't
21856 match any string, or if the transport named for a given string is not defined,
21857 delivery is deferred.
21858
21859
21860 .option file_must_exist appendfile boolean false
21861 If this option is true, the file specified by the &%file%& option must exist.
21862 A temporary error occurs if it does not, causing delivery to be deferred.
21863 If this option is false, the file is created if it does not exist.
21864
21865
21866 .option lock_fcntl_timeout appendfile time 0s
21867 .cindex "timeout" "mailbox locking"
21868 .cindex "mailbox" "locking, blocking and non-blocking"
21869 .cindex "locking files"
21870 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
21871 when locking an open mailbox file. If the call fails, the delivery process
21872 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
21873 Non-blocking calls are used so that the file is not kept open during the wait
21874 for the lock; the reason for this is to make it as safe as possible for
21875 deliveries over NFS in the case when processes might be accessing an NFS
21876 mailbox without using a lock file. This should not be done, but
21877 misunderstandings and hence misconfigurations are not unknown.
21878
21879 On a busy system, however, the performance of a non-blocking lock approach is
21880 not as good as using a blocking lock with a timeout. In this case, the waiting
21881 is done inside the system call, and Exim's delivery process acquires the lock
21882 and can proceed as soon as the previous lock holder releases it.
21883
21884 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
21885 timeout, are used. There may still be some retrying: the maximum number of
21886 retries is
21887 .code
21888 (lock_retries * lock_interval) / lock_fcntl_timeout
21889 .endd
21890 rounded up to the next whole number. In other words, the total time during
21891 which &(appendfile)& is trying to get a lock is roughly the same, unless
21892 &%lock_fcntl_timeout%& is set very large.
21893
21894 You should consider setting this option if you are getting a lot of delayed
21895 local deliveries because of errors of the form
21896 .code
21897 failed to lock mailbox /some/file (fcntl)
21898 .endd
21899
21900 .option lock_flock_timeout appendfile time 0s
21901 This timeout applies to file locking when using &[flock()]& (see
21902 &%use_flock%&); the timeout operates in a similar manner to
21903 &%lock_fcntl_timeout%&.
21904
21905
21906 .option lock_interval appendfile time 3s
21907 This specifies the time to wait between attempts to lock the file. See below
21908 for details of locking.
21909
21910
21911 .option lock_retries appendfile integer 10
21912 This specifies the maximum number of attempts to lock the file. A value of zero
21913 is treated as 1. See below for details of locking.
21914
21915
21916 .option lockfile_mode appendfile "octal integer" 0600
21917 This specifies the mode of the created lock file, when a lock file is being
21918 used (see &%use_lockfile%& and &%use_mbx_lock%&).
21919
21920
21921 .option lockfile_timeout appendfile time 30m
21922 .cindex "timeout" "mailbox locking"
21923 When a lock file is being used (see &%use_lockfile%&), if a lock file already
21924 exists and is older than this value, it is assumed to have been left behind by
21925 accident, and Exim attempts to remove it.
21926
21927
21928 .option mailbox_filecount appendfile string&!! unset
21929 .cindex "mailbox" "specifying size of"
21930 .cindex "size" "of mailbox"
21931 If this option is set, it is expanded, and the result is taken as the current
21932 number of files in the mailbox. It must be a decimal number, optionally
21933 followed by K or M. This provides a way of obtaining this information from an
21934 external source that maintains the data.
21935
21936
21937 .option mailbox_size appendfile string&!! unset
21938 .cindex "mailbox" "specifying size of"
21939 .cindex "size" "of mailbox"
21940 If this option is set, it is expanded, and the result is taken as the current
21941 size the mailbox. It must be a decimal number, optionally followed by K or M.
21942 This provides a way of obtaining this information from an external source that
21943 maintains the data. This is likely to be helpful for maildir deliveries where
21944 it is computationally expensive to compute the size of a mailbox.
21945
21946
21947
21948 .option maildir_format appendfile boolean false
21949 .cindex "maildir format" "specifying"
21950 If this option is set with the &%directory%& option, the delivery is into a new
21951 file, in the &"maildir"& format that is used by other mail software. When the
21952 transport is activated directly from a &(redirect)& router (for example, the
21953 &(address_file)& transport in the default configuration), setting
21954 &%maildir_format%& causes the path received from the router to be treated as a
21955 directory, whether or not it ends with &`/`&. This option is available only if
21956 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
21957 &<<SECTmaildirdelivery>>& below for further details.
21958
21959
21960 .option maildir_quota_directory_regex appendfile string "See below"
21961 .cindex "maildir format" "quota; directories included in"
21962 .cindex "quota" "maildir; directories included in"
21963 This option is relevant only when &%maildir_use_size_file%& is set. It defines
21964 a regular expression for specifying directories, relative to the quota
21965 directory (see &%quota_directory%&), that should be included in the quota
21966 calculation. The default value is:
21967 .code
21968 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
21969 .endd
21970 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
21971 (directories whose names begin with a dot). If you want to exclude the
21972 &_Trash_&
21973 folder from the count (as some sites do), you need to change this setting to
21974 .code
21975 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
21976 .endd
21977 This uses a negative lookahead in the regular expression to exclude the
21978 directory whose name is &_.Trash_&. When a directory is excluded from quota
21979 calculations, quota processing is bypassed for any messages that are delivered
21980 directly into that directory.
21981
21982
21983 .option maildir_retries appendfile integer 10
21984 This option specifies the number of times to retry when writing a file in
21985 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
21986
21987
21988 .option maildir_tag appendfile string&!! unset
21989 This option applies only to deliveries in maildir format, and is described in
21990 section &<<SECTmaildirdelivery>>& below.
21991
21992
21993 .option maildir_use_size_file appendfile&!! boolean false
21994 .cindex "maildir format" "&_maildirsize_& file"
21995 The result of string expansion for this option must be a valid boolean value.
21996 If it is true, it enables support for &_maildirsize_& files. Exim
21997 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
21998 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
21999 value is zero. See &%maildir_quota_directory_regex%& above and section
22000 &<<SECTmaildirdelivery>>& below for further details.
22001
22002 .option maildirfolder_create_regex appendfile string unset
22003 .cindex "maildir format" "&_maildirfolder_& file"
22004 .cindex "&_maildirfolder_&, creating"
22005 The value of this option is a regular expression. If it is unset, it has no
22006 effect. Otherwise, before a maildir delivery takes place, the pattern is
22007 matched against the name of the maildir directory, that is, the directory
22008 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22009 delivery. If there is a match, Exim checks for the existence of a file called
22010 &_maildirfolder_& in the directory, and creates it if it does not exist.
22011 See section &<<SECTmaildirdelivery>>& for more details.
22012
22013
22014 .option mailstore_format appendfile boolean false
22015 .cindex "mailstore format" "specifying"
22016 If this option is set with the &%directory%& option, the delivery is into two
22017 new files in  &"mailstore"& format. The option is available only if
22018 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22019 below for further details.
22020
22021
22022 .option mailstore_prefix appendfile string&!! unset
22023 This option applies only to deliveries in mailstore format, and is described in
22024 section &<<SECTopdir>>& below.
22025
22026
22027 .option mailstore_suffix appendfile string&!! unset
22028 This option applies only to deliveries in mailstore format, and is described in
22029 section &<<SECTopdir>>& below.
22030
22031
22032 .option mbx_format appendfile boolean false
22033 .cindex "locking files"
22034 .cindex "file" "locking"
22035 .cindex "file" "MBX format"
22036 .cindex "MBX format, specifying"
22037 This option is available only if Exim has been compiled with SUPPORT_MBX
22038 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22039 the message is appended to the mailbox file in MBX format instead of
22040 traditional Unix format. This format is supported by Pine4 and its associated
22041 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22042
22043 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22044 automatically changed by the use of &%mbx_format%&. They should normally be set
22045 empty when using MBX format, so this option almost always appears in this
22046 combination:
22047 .code
22048 mbx_format = true
22049 message_prefix =
22050 message_suffix =
22051 .endd
22052 If none of the locking options are mentioned in the configuration,
22053 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22054 is possible to specify the other kinds of locking with &%mbx_format%&, but
22055 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22056 interworks with &'c-client'&, providing for shared access to the mailbox. It
22057 should not be used if any program that does not use this form of locking is
22058 going to access the mailbox, nor should it be used if the mailbox file is NFS
22059 mounted, because it works only when the mailbox is accessed from a single host.
22060
22061 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22062 the standard version of &'c-client'&, because as long as it has a mailbox open
22063 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22064 append messages to it.
22065
22066
22067 .option message_prefix appendfile string&!! "see below"
22068 .cindex "&""From""& line"
22069 The string specified here is expanded and output at the start of every message.
22070 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22071 in which case it is:
22072 .code
22073 message_prefix = "From ${if def:return_path{$return_path}\
22074   {MAILER-DAEMON}} $tod_bsdinbox\n"
22075 .endd
22076 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22077 &`\n`& to &`\r\n`& in &%message_prefix%&.
22078
22079 .option message_suffix appendfile string&!! "see below"
22080 The string specified here is expanded and output at the end of every message.
22081 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22082 in which case it is a single newline character. The suffix can be suppressed by
22083 setting
22084 .code
22085 message_suffix =
22086 .endd
22087 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22088 &`\n`& to &`\r\n`& in &%message_suffix%&.
22089
22090 .option mode appendfile "octal integer" 0600
22091 If the output file is created, it is given this mode. If it already exists and
22092 has wider permissions, they are reduced to this mode. If it has narrower
22093 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22094 if the delivery is the result of a &%save%& command in a filter file specifying
22095 a particular mode, the mode of the output file is always forced to take that
22096 value, and this option is ignored.
22097
22098
22099 .option mode_fail_narrower appendfile boolean true
22100 This option applies in the case when an existing mailbox file has a narrower
22101 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22102 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22103 continues with the delivery attempt, using the existing mode of the file.
22104
22105
22106 .option notify_comsat appendfile boolean false
22107 If this option is true, the &'comsat'& daemon is notified after every
22108 successful delivery to a user mailbox. This is the daemon that notifies logged
22109 on users about incoming mail.
22110
22111
22112 .option quota appendfile string&!! unset
22113 .cindex "quota" "imposed by Exim"
22114 This option imposes a limit on the size of the file to which Exim is appending,
22115 or to the total space used in the directory tree when the &%directory%& option
22116 is set. In the latter case, computation of the space used is expensive, because
22117 all the files in the directory (and any sub-directories) have to be
22118 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22119 &%maildir_use_size_file%& for ways to avoid this in environments where users
22120 have no shell access to their mailboxes).
22121
22122 As there is no interlock against two simultaneous deliveries into a
22123 multi-file mailbox, it is possible for the quota to be overrun in this case.
22124 For single-file mailboxes, of course, an interlock is a necessity.
22125
22126 A file's size is taken as its &'used'& value. Because of blocking effects, this
22127 may be a lot less than the actual amount of disk space allocated to the file.
22128 If the sizes of a number of files are being added up, the rounding effect can
22129 become quite noticeable, especially on systems that have large block sizes.
22130 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22131 the obvious value which users understand most easily.
22132
22133 The value of the option is expanded, and must then be a numerical value
22134 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22135 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22136 and further option modifiers. If Exim is running on a system with
22137 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22138 be handled.
22139
22140 The option modifier &%no_check%& can be used to force delivery even if the over
22141 quota condition is met. The quota gets updated as usual.
22142
22143 &*Note*&: A value of zero is interpreted as &"no quota"&.
22144
22145 The expansion happens while Exim is running as root, before it changes uid for
22146 the delivery. This means that files that are inaccessible to the end user can
22147 be used to hold quota values that are looked up in the expansion. When delivery
22148 fails because this quota is exceeded, the handling of the error is as for
22149 system quota failures.
22150
22151 By default, Exim's quota checking mimics system quotas, and restricts the
22152 mailbox to the specified maximum size, though the value is not accurate to the
22153 last byte, owing to separator lines and additional headers that may get added
22154 during message delivery. When a mailbox is nearly full, large messages may get
22155 refused even though small ones are accepted, because the size of the current
22156 message is added to the quota when the check is made. This behaviour can be
22157 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22158 for exceeding the quota does not include the current message. Thus, deliveries
22159 continue until the quota has been exceeded; thereafter, no further messages are
22160 delivered. See also &%quota_warn_threshold%&.
22161
22162
22163 .option quota_directory appendfile string&!! unset
22164 This option defines the directory to check for quota purposes when delivering
22165 into individual files. The default is the delivery directory, or, if a file
22166 called &_maildirfolder_& exists in a maildir directory, the parent of the
22167 delivery directory.
22168
22169
22170 .option quota_filecount appendfile string&!! 0
22171 This option applies when the &%directory%& option is set. It limits the total
22172 number of files in the directory (compare the inode limit in system quotas). It
22173 can only be used if &%quota%& is also set. The value is expanded; an expansion
22174 failure causes delivery to be deferred. A value of zero is interpreted as
22175 &"no quota"&.
22176
22177 The option modifier &%no_check%& can be used to force delivery even if the over
22178 quota condition is met. The quota gets updated as usual.
22179
22180 .option quota_is_inclusive appendfile boolean true
22181 See &%quota%& above.
22182
22183
22184 .option quota_size_regex appendfile string unset
22185 This option applies when one of the delivery modes that writes a separate file
22186 for each message is being used. When Exim wants to find the size of one of
22187 these files in order to test the quota, it first checks &%quota_size_regex%&.
22188 If this is set to a regular expression that matches the file name, and it
22189 captures one string, that string is interpreted as a representation of the
22190 file's size. The value of &%quota_size_regex%& is not expanded.
22191
22192 This feature is useful only when users have no shell access to their mailboxes
22193 &-- otherwise they could defeat the quota simply by renaming the files. This
22194 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22195 the file length to the file name. For example:
22196 .code
22197 maildir_tag = ,S=$message_size
22198 quota_size_regex = ,S=(\d+)
22199 .endd
22200 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22201 number of lines in the message.
22202
22203 The regular expression should not assume that the length is at the end of the
22204 file name (even though &%maildir_tag%& puts it there) because maildir MUAs
22205 sometimes add other information onto the ends of message file names.
22206
22207 Section &<<SECID136>>& contains further information.
22208
22209
22210 .option quota_warn_message appendfile string&!! "see below"
22211 See below for the use of this option. If it is not set when
22212 &%quota_warn_threshold%& is set, it defaults to
22213 .code
22214 quota_warn_message = "\
22215   To: $local_part@$domain\n\
22216   Subject: Your mailbox\n\n\
22217   This message is automatically created \
22218   by mail delivery software.\n\n\
22219   The size of your mailbox has exceeded \
22220   a warning threshold that is\n\
22221   set by the system administrator.\n"
22222 .endd
22223
22224
22225 .option quota_warn_threshold appendfile string&!! 0
22226 .cindex "quota" "warning threshold"
22227 .cindex "mailbox" "size warning"
22228 .cindex "size" "of mailbox"
22229 This option is expanded in the same way as &%quota%& (see above). If the
22230 resulting value is greater than zero, and delivery of the message causes the
22231 size of the file or total space in the directory tree to cross the given
22232 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22233 may be specified as a percentage of it by following the value with a percent
22234 sign. For example:
22235 .code
22236 quota = 10M
22237 quota_warn_threshold = 75%
22238 .endd
22239 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22240 percent sign is ignored.
22241
22242 The warning message itself is specified by the &%quota_warn_message%& option,
22243 and it must start with a &'To:'& header line containing the recipient(s) of the
22244 warning message. These do not necessarily have to include the recipient(s) of
22245 the original message. A &'Subject:'& line should also normally be supplied. You
22246 can include any other header lines that you want. If you do not include a
22247 &'From:'& line, the default is:
22248 .code
22249 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22250 .endd
22251 .oindex &%errors_reply_to%&
22252 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22253 option.
22254
22255 The &%quota%& option does not have to be set in order to use this option; they
22256 are independent of one another except when the threshold is specified as a
22257 percentage.
22258
22259
22260 .option use_bsmtp appendfile boolean false
22261 .cindex "envelope sender"
22262 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22263 format, with the envelope sender and recipient(s) included as SMTP commands. If
22264 you want to include a leading HELO command with such messages, you can do
22265 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22266 for details of batch SMTP.
22267
22268
22269 .option use_crlf appendfile boolean false
22270 .cindex "carriage return"
22271 .cindex "linefeed"
22272 This option causes lines to be terminated with the two-character CRLF sequence
22273 (carriage return, linefeed) instead of just a linefeed character. In the case
22274 of batched SMTP, the byte sequence written to the file is then an exact image
22275 of what would be sent down a real SMTP connection.
22276
22277 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22278 (which are used to supply the traditional &"From&~"& and blank line separators
22279 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22280 carriage return characters if these are needed. In cases where these options
22281 have non-empty defaults, the values end with a single linefeed, so they must be
22282 changed to end with &`\r\n`& if &%use_crlf%& is set.
22283
22284
22285 .option use_fcntl_lock appendfile boolean "see below"
22286 This option controls the use of the &[fcntl()]& function to lock a file for
22287 exclusive use when a message is being appended. It is set by default unless
22288 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22289 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22290 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22291
22292
22293 .option use_flock_lock appendfile boolean false
22294 This option is provided to support the use of &[flock()]& for file locking, for
22295 the few situations where it is needed. Most modern operating systems support
22296 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22297 each other. Exim uses &[fcntl()]& locking by default.
22298
22299 This option is required only if you are using an operating system where
22300 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22301 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22302 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22303
22304 .cindex "Solaris" "&[flock()]& support"
22305 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22306 have it (and some, I think, provide a not quite right version built on top of
22307 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22308 the ability to use it, and any attempt to do so will cause a configuration
22309 error.
22310
22311 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22312 is just being mapped onto &[fcntl()]& by the OS).
22313
22314
22315 .option use_lockfile appendfile boolean "see below"
22316 If this option is turned off, Exim does not attempt to create a lock file when
22317 appending to a mailbox file. In this situation, the only locking is by
22318 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22319 sure that every MUA that is ever going to look at your users' mailboxes uses
22320 &[fcntl()]& rather than a lock file, and even then only when you are not
22321 delivering over NFS from more than one host.
22322
22323 .cindex "NFS" "lock file"
22324 In order to append to an NFS file safely from more than one host, it is
22325 necessary to take out a lock &'before'& opening the file, and the lock file
22326 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22327 file corruption.
22328
22329 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22330 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22331 except when &%mbx_format%& is set.
22332
22333
22334 .option use_mbx_lock appendfile boolean "see below"
22335 This option is available only if Exim has been compiled with SUPPORT_MBX
22336 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22337 locking rules be used. It is set by default if &%mbx_format%& is set and none
22338 of the locking options are mentioned in the configuration. The locking rules
22339 are the same as are used by the &'c-client'& library that underlies Pine and
22340 the IMAP4 and POP daemons that come with it (see the discussion below). The
22341 rules allow for shared access to the mailbox. However, this kind of locking
22342 does not work when the mailbox is NFS mounted.
22343
22344 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22345 &%use_flock_lock%& to control what kind of locking is used in implementing the
22346 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22347 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22348
22349
22350
22351
22352 .section "Operational details for appending" "SECTopappend"
22353 .cindex "appending to a file"
22354 .cindex "file" "appending"
22355 Before appending to a file, the following preparations are made:
22356
22357 .ilist
22358 If the name of the file is &_/dev/null_&, no action is taken, and a success
22359 return is given.
22360
22361 .next
22362 .cindex "directory creation"
22363 If any directories on the file's path are missing, Exim creates them if the
22364 &%create_directory%& option is set. A created directory's mode is given by the
22365 &%directory_mode%& option.
22366
22367 .next
22368 If &%file_format%& is set, the format of an existing file is checked. If this
22369 indicates that a different transport should be used, control is passed to that
22370 transport.
22371
22372 .next
22373 .cindex "file" "locking"
22374 .cindex "locking files"
22375 .cindex "NFS" "lock file"
22376 If &%use_lockfile%& is set, a lock file is built in a way that will work
22377 reliably over NFS, as follows:
22378
22379 .olist
22380 Create a &"hitching post"& file whose name is that of the lock file with the
22381 current time, primary host name, and process id added, by opening for writing
22382 as a new file. If this fails with an access error, delivery is deferred.
22383 .next
22384 Close the hitching post file, and hard link it to the lock file name.
22385 .next
22386 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22387 Unlink the hitching post name.
22388 .next
22389 Otherwise, use &[stat()]& to get information about the hitching post file, and
22390 then unlink hitching post name. If the number of links is exactly two, creation
22391 of the lock file succeeded but something (for example, an NFS server crash and
22392 restart) caused this fact not to be communicated to the &[link()]& call.
22393 .next
22394 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22395 up to &%lock_retries%& times. However, since any program that writes to a
22396 mailbox should complete its task very quickly, it is reasonable to time out old
22397 lock files that are normally the result of user agent and system crashes. If an
22398 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22399 it before trying again.
22400 .endlist olist
22401
22402 .next
22403 A call is made to &[lstat()]& to discover whether the main file exists, and if
22404 so, what its characteristics are. If &[lstat()]& fails for any reason other
22405 than non-existence, delivery is deferred.
22406
22407 .next
22408 .cindex "symbolic link" "to mailbox"
22409 .cindex "mailbox" "symbolic link"
22410 If the file does exist and is a symbolic link, delivery is deferred, unless the
22411 &%allow_symlink%& option is set, in which case the ownership of the link is
22412 checked, and then &[stat()]& is called to find out about the real file, which
22413 is then subjected to the checks below. The check on the top-level link
22414 ownership prevents one user creating a link for another's mailbox in a sticky
22415 directory, though allowing symbolic links in this case is definitely not a good
22416 idea. If there is a chain of symbolic links, the intermediate ones are not
22417 checked.
22418
22419 .next
22420 If the file already exists but is not a regular file, or if the file's owner
22421 and group (if the group is being checked &-- see &%check_group%& above) are
22422 different from the user and group under which the delivery is running,
22423 delivery is deferred.
22424
22425 .next
22426 If the file's permissions are more generous than specified, they are reduced.
22427 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22428 is set false, in which case the delivery is tried using the existing
22429 permissions.
22430
22431 .next
22432 The file's inode number is saved, and the file is then opened for appending.
22433 If this fails because the file has vanished, &(appendfile)& behaves as if it
22434 hadn't existed (see below). For any other failures, delivery is deferred.
22435
22436 .next
22437 If the file is opened successfully, check that the inode number hasn't
22438 changed, that it is still a regular file, and that the owner and permissions
22439 have not changed. If anything is wrong, defer delivery and freeze the message.
22440
22441 .next
22442 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22443 option is set. Otherwise, check that the file is being created in a permitted
22444 directory if the &%create_file%& option is set (deferring on failure), and then
22445 open for writing as a new file, with the O_EXCL and O_CREAT options,
22446 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22447 set). In this case, which can happen if the link points to a non-existent file,
22448 the file is opened for writing using O_CREAT but not O_EXCL, because
22449 that prevents link following.
22450
22451 .next
22452 .cindex "loop" "while file testing"
22453 If opening fails because the file exists, obey the tests given above for
22454 existing files. However, to avoid looping in a situation where the file is
22455 being continuously created and destroyed, the exists/not-exists loop is broken
22456 after 10 repetitions, and the message is then frozen.
22457
22458 .next
22459 If opening fails with any other error, defer delivery.
22460
22461 .next
22462 .cindex "file" "locking"
22463 .cindex "locking files"
22464 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22465 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22466 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22467 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22468 file, and an exclusive lock on the file whose name is
22469 .code
22470 /tmp/.<device-number>.<inode-number>
22471 .endd
22472 using the device and inode numbers of the open mailbox file, in accordance with
22473 the MBX locking rules. This file is created with a mode that is specified by
22474 the &%lockfile_mode%& option.
22475
22476 If Exim fails to lock the file, there are two possible courses of action,
22477 depending on the value of the locking timeout. This is obtained from
22478 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22479
22480 If the timeout value is zero, the file is closed, Exim waits for
22481 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22482 to lock it again. This happens up to &%lock_retries%& times, after which the
22483 delivery is deferred.
22484
22485 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22486 &[flock()]& are used (with the given timeout), so there has already been some
22487 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22488 immediately. It retries up to
22489 .code
22490 (lock_retries * lock_interval) / <timeout>
22491 .endd
22492 times (rounded up).
22493 .endlist
22494
22495 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
22496 and/or &[flock()]& locks) and then deletes the lock file if one was created.
22497
22498
22499 .section "Operational details for delivery to a new file" "SECTopdir"
22500 .cindex "delivery" "to single file"
22501 .cindex "&""From""& line"
22502 When the &%directory%& option is set instead of &%file%&, each message is
22503 delivered into a newly-created file or set of files. When &(appendfile)& is
22504 activated directly from a &(redirect)& router, neither &%file%& nor
22505 &%directory%& is normally set, because the path for delivery is supplied by the
22506 router. (See for example, the &(address_file)& transport in the default
22507 configuration.) In this case, delivery is to a new file if either the path name
22508 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
22509
22510 No locking is required while writing the message to a new file, so the various
22511 locking options of the transport are ignored. The &"From"& line that by default
22512 separates messages in a single file is not normally needed, nor is the escaping
22513 of message lines that start with &"From"&, and there is no need to ensure a
22514 newline at the end of each message. Consequently, the default values for
22515 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
22516 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
22517
22518 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
22519 the files in the delivery directory by default. However, you can specify a
22520 different directory by setting &%quota_directory%&. Also, for maildir
22521 deliveries (see below) the &_maildirfolder_& convention is honoured.
22522
22523
22524 .cindex "maildir format"
22525 .cindex "mailstore format"
22526 There are three different ways in which delivery to individual files can be
22527 done, controlled by the settings of the &%maildir_format%& and
22528 &%mailstore_format%& options. Note that code to support maildir or mailstore
22529 formats is not included in the binary unless SUPPORT_MAILDIR or
22530 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
22531
22532 .cindex "directory creation"
22533 In all three cases an attempt is made to create the directory and any necessary
22534 sub-directories if they do not exist, provided that the &%create_directory%&
22535 option is set (the default). The location of a created directory can be
22536 constrained by setting &%create_file%&. A created directory's mode is given by
22537 the &%directory_mode%& option. If creation fails, or if the
22538 &%create_directory%& option is not set when creation is required, delivery is
22539 deferred.
22540
22541
22542
22543 .section "Maildir delivery" "SECTmaildirdelivery"
22544 .cindex "maildir format" "description of"
22545 If the &%maildir_format%& option is true, Exim delivers each message by writing
22546 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
22547 directory that is defined by the &%directory%& option (the &"delivery
22548 directory"&). If the delivery is successful, the file is renamed into the
22549 &_new_& subdirectory.
22550
22551 In the file name, <&'stime'&> is the current time of day in seconds, and
22552 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
22553 Exim checks that the time-of-day clock has moved on by at least one microsecond
22554 before terminating the delivery process. This guarantees uniqueness for the
22555 file name. However, as a precaution, Exim calls &[stat()]& for the file before
22556 opening it. If any response other than ENOENT (does not exist) is given,
22557 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
22558
22559 Before Exim carries out a maildir delivery, it ensures that subdirectories
22560 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
22561 do not exist, Exim tries to create them and any superior directories in their
22562 path, subject to the &%create_directory%& and &%create_file%& options. If the
22563 &%maildirfolder_create_regex%& option is set, and the regular expression it
22564 contains matches the delivery directory, Exim also ensures that a file called
22565 &_maildirfolder_& exists in the delivery directory. If a missing directory or
22566 &_maildirfolder_& file cannot be created, delivery is deferred.
22567
22568 These features make it possible to use Exim to create all the necessary files
22569 and directories in a maildir mailbox, including subdirectories for maildir++
22570 folders. Consider this example:
22571 .code
22572 maildir_format = true
22573 directory = /var/mail/$local_part\
22574            ${if eq{$local_part_suffix}{}{}\
22575            {/.${substr_1:$local_part_suffix}}}
22576 maildirfolder_create_regex = /\.[^/]+$
22577 .endd
22578 If &$local_part_suffix$& is empty (there was no suffix for the local part),
22579 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
22580 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
22581 not match this name, so Exim will not look for or create the file
22582 &_/var/mail/pimbo/maildirfolder_&, though it will create
22583 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
22584
22585 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
22586 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
22587 does match &%maildirfolder_create_regex%&. In this case, Exim will create
22588 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
22589 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
22590
22591 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
22592 not inadvertently match the toplevel maildir directory, because a
22593 &_maildirfolder_& file at top level would completely break quota calculations.
22594
22595 .cindex "quota" "in maildir delivery"
22596 .cindex "maildir++"
22597 If Exim is required to check a &%quota%& setting before a maildir delivery, and
22598 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
22599 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
22600 Exim assumes the directory is a maildir++ folder directory, which is one level
22601 down from the user's top level mailbox directory. This causes it to start at
22602 the parent directory instead of the current directory when calculating the
22603 amount of space used.
22604
22605 One problem with delivering into a multi-file mailbox is that it is
22606 computationally expensive to compute the size of the mailbox for quota
22607 checking. Various approaches have been taken to reduce the amount of work
22608 needed. The next two sections describe two of them. A third alternative is to
22609 use some external process for maintaining the size data, and use the expansion
22610 of the &%mailbox_size%& option as a way of importing it into Exim.
22611
22612
22613
22614
22615 .section "Using tags to record message sizes" "SECID135"
22616 If &%maildir_tag%& is set, the string is expanded for each delivery.
22617 When the maildir file is renamed into the &_new_& sub-directory, the
22618 tag is added to its name. However, if adding the tag takes the length of the
22619 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
22620 the tag is dropped and the maildir file is created with no tag.
22621
22622
22623 .vindex "&$message_size$&"
22624 Tags can be used to encode the size of files in their names; see
22625 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
22626 happens after the message has been written. The value of the &$message_size$&
22627 variable is set to the number of bytes actually written. If the expansion is
22628 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
22629 be deferred. The expanded tag may contain any printing characters except &"/"&.
22630 Non-printing characters in the string are ignored; if the resulting string is
22631 empty, it is ignored. If it starts with an alphanumeric character, a leading
22632 colon is inserted; this default has not proven to be the path that popular
22633 maildir implementations have chosen (but changing it in Exim would break
22634 backwards compatibility).
22635
22636 For one common implementation, you might set:
22637 .code
22638 maildir_tag = ,S=${message_size}
22639 .endd
22640 but you should check the documentation of the other software to be sure.
22641
22642 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
22643 as this allows Exim to extract the size from your tag, instead of having to
22644 &[stat()]& each message file.
22645
22646
22647 .section "Using a maildirsize file" "SECID136"
22648 .cindex "quota" "in maildir delivery"
22649 .cindex "maildir format" "&_maildirsize_& file"
22650 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
22651 storing quota and message size information in a file called &_maildirsize_&
22652 within the toplevel maildir directory. If this file does not exist, Exim
22653 creates it, setting the quota from the &%quota%& option of the transport. If
22654 the maildir directory itself does not exist, it is created before any attempt
22655 to write a &_maildirsize_& file.
22656
22657 The &_maildirsize_& file is used to hold information about the sizes of
22658 messages in the maildir, thus speeding up quota calculations. The quota value
22659 in the file is just a cache; if the quota is changed in the transport, the new
22660 value overrides the cached value when the next message is delivered. The cache
22661 is maintained for the benefit of other programs that access the maildir and
22662 need to know the quota.
22663
22664 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
22665 file is maintained (with a zero quota setting), but no quota is imposed.
22666
22667 A regular expression is available for controlling which directories in the
22668 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
22669 See the description of the &%maildir_quota_directory_regex%& option above for
22670 details.
22671
22672
22673 .section "Mailstore delivery" "SECID137"
22674 .cindex "mailstore format" "description of"
22675 If the &%mailstore_format%& option is true, each message is written as two
22676 files in the given directory. A unique base name is constructed from the
22677 message id and the current delivery process, and the files that are written use
22678 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
22679 contains the message's envelope, and the &_.msg_& file contains the message
22680 itself. The base name is placed in the variable &$mailstore_basename$&.
22681
22682 During delivery, the envelope is first written to a file with the suffix
22683 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
22684 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
22685 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
22686 file before accessing either of them. An alternative approach is to wait for
22687 the absence of a &_.tmp_& file.
22688
22689 The envelope file starts with any text defined by the &%mailstore_prefix%&
22690 option, expanded and terminated by a newline if there isn't one. Then follows
22691 the sender address on one line, then all the recipient addresses, one per line.
22692 There can be more than one recipient only if the &%batch_max%& option is set
22693 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
22694 appended to the file, followed by a newline if it does not end with one.
22695
22696 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
22697 failure, it is ignored. Other expansion errors are treated as serious
22698 configuration errors, and delivery is deferred. The variable
22699 &$mailstore_basename$& is available for use during these expansions.
22700
22701
22702 .section "Non-special new file delivery" "SECID138"
22703 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
22704 file is created directly in the named directory. For example, when delivering
22705 messages into files in batched SMTP format for later delivery to some host (see
22706 section &<<SECTbatchSMTP>>&), a setting such as
22707 .code
22708 directory = /var/bsmtp/$host
22709 .endd
22710 might be used. A message is written to a file with a temporary name, which is
22711 then renamed when the delivery is complete. The final name is obtained by
22712 expanding the contents of the &%directory_file%& option.
22713 .ecindex IIDapptra1
22714 .ecindex IIDapptra2
22715
22716
22717
22718
22719
22720
22721 . ////////////////////////////////////////////////////////////////////////////
22722 . ////////////////////////////////////////////////////////////////////////////
22723
22724 .chapter "The autoreply transport" "CHID8"
22725 .scindex IIDauttra1 "transports" "&(autoreply)&"
22726 .scindex IIDauttra2 "&(autoreply)& transport"
22727 The &(autoreply)& transport is not a true transport in that it does not cause
22728 the message to be transmitted. Instead, it generates a new mail message as an
22729 automatic reply to the incoming message. &'References:'& and
22730 &'Auto-Submitted:'& header lines are included. These are constructed according
22731 to the rules in RFCs 2822 and 3834, respectively.
22732
22733 If the router that passes the message to this transport does not have the
22734 &%unseen%& option set, the original message (for the current recipient) is not
22735 delivered anywhere. However, when the &%unseen%& option is set on the router
22736 that passes the message to this transport, routing of the address continues, so
22737 another router can set up a normal message delivery.
22738
22739
22740 The &(autoreply)& transport is usually run as the result of mail filtering, a
22741 &"vacation"& message being the standard example. However, it can also be run
22742 directly from a router like any other transport. To reduce the possibility of
22743 message cascades, messages created by the &(autoreply)& transport always have
22744 empty envelope sender addresses, like bounce messages.
22745
22746 The parameters of the message to be sent can be specified in the configuration
22747 by options described below. However, these are used only when the address
22748 passed to the transport does not contain its own reply information. When the
22749 transport is run as a consequence of a
22750 &%mail%&
22751 or &%vacation%& command in a filter file, the parameters of the message are
22752 supplied by the filter, and passed with the address. The transport's options
22753 that define the message are then ignored (so they are not usually set in this
22754 case). The message is specified entirely by the filter or by the transport; it
22755 is never built from a mixture of options. However, the &%file_optional%&,
22756 &%mode%&, and &%return_message%& options apply in all cases.
22757
22758 &(Autoreply)& is implemented as a local transport. When used as a result of a
22759 command in a user's filter file, &(autoreply)& normally runs under the uid and
22760 gid of the user, and with appropriate current and home directories (see chapter
22761 &<<CHAPenvironment>>&).
22762
22763 There is a subtle difference between routing a message to a &(pipe)& transport
22764 that generates some text to be returned to the sender, and routing it to an
22765 &(autoreply)& transport. This difference is noticeable only if more than one
22766 address from the same message is so handled. In the case of a pipe, the
22767 separate outputs from the different addresses are gathered up and returned to
22768 the sender in a single message, whereas if &(autoreply)& is used, a separate
22769 message is generated for each address that is passed to it.
22770
22771 Non-printing characters are not permitted in the header lines generated for the
22772 message that &(autoreply)& creates, with the exception of newlines that are
22773 immediately followed by white space. If any non-printing characters are found,
22774 the transport defers.
22775 Whether characters with the top bit set count as printing characters or not is
22776 controlled by the &%print_topbitchars%& global option.
22777
22778 If any of the generic options for manipulating headers (for example,
22779 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
22780 of the original message that is included in the generated message when
22781 &%return_message%& is set. They do not apply to the generated message itself.
22782
22783 .vindex "&$sender_address$&"
22784 If the &(autoreply)& transport receives return code 2 from Exim when it submits
22785 the message, indicating that there were no recipients, it does not treat this
22786 as an error. This means that autoreplies sent to &$sender_address$& when this
22787 is empty (because the incoming message is a bounce message) do not cause
22788 problems. They are just discarded.
22789
22790
22791
22792 .section "Private options for autoreply" "SECID139"
22793 .cindex "options" "&(autoreply)& transport"
22794
22795 .option bcc autoreply string&!! unset
22796 This specifies the addresses that are to receive &"blind carbon copies"& of the
22797 message when the message is specified by the transport.
22798
22799
22800 .option cc autoreply string&!! unset
22801 This specifies recipients of the message and the contents of the &'Cc:'& header
22802 when the message is specified by the transport.
22803
22804
22805 .option file autoreply string&!! unset
22806 The contents of the file are sent as the body of the message when the message
22807 is specified by the transport. If both &%file%& and &%text%& are set, the text
22808 string comes first.
22809
22810
22811 .option file_expand autoreply boolean false
22812 If this is set, the contents of the file named by the &%file%& option are
22813 subjected to string expansion as they are added to the message.
22814
22815
22816 .option file_optional autoreply boolean false
22817 If this option is true, no error is generated if the file named by the &%file%&
22818 option or passed with the address does not exist or cannot be read.
22819
22820
22821 .option from autoreply string&!! unset
22822 This specifies the contents of the &'From:'& header when the message is
22823 specified by the transport.
22824
22825
22826 .option headers autoreply string&!! unset
22827 This specifies additional RFC 2822 headers that are to be added to the message
22828 when the message is specified by the transport. Several can be given by using
22829 &"\n"& to separate them. There is no check on the format.
22830
22831
22832 .option log autoreply string&!! unset
22833 This option names a file in which a record of every message sent is logged when
22834 the message is specified by the transport.
22835
22836
22837 .option mode autoreply "octal integer" 0600
22838 If either the log file or the &"once"& file has to be created, this mode is
22839 used.
22840
22841
22842 .option never_mail autoreply "address list&!!" unset
22843 If any run of the transport creates a message with a recipient that matches any
22844 item in the list, that recipient is quietly discarded. If all recipients are
22845 discarded, no message is created. This applies both when the recipients are
22846 generated by a filter and when they are specified in the transport.
22847
22848
22849
22850 .option once autoreply string&!! unset
22851 This option names a file or DBM database in which a record of each &'To:'&
22852 recipient is kept when the message is specified by the transport. &*Note*&:
22853 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
22854
22855 If &%once%& is unset, or is set to an empty string, the message is always sent.
22856 By default, if &%once%& is set to a non-empty file name, the message
22857 is not sent if a potential recipient is already listed in the database.
22858 However, if the &%once_repeat%& option specifies a time greater than zero, the
22859 message is sent if that much time has elapsed since a message was last sent to
22860 this recipient. A setting of zero time for &%once_repeat%& (the default)
22861 prevents a message from being sent a second time &-- in this case, zero means
22862 infinity.
22863
22864 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
22865 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
22866 greater than zero, it changes the way Exim implements the &%once%& option.
22867 Instead of using a DBM file to record every recipient it sends to, it uses a
22868 regular file, whose size will never get larger than the given value.
22869
22870 In the file, Exim keeps a linear list of recipient addresses and the times at
22871 which they were sent messages. If the file is full when a new address needs to
22872 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
22873 means that a given recipient may receive multiple messages, but at
22874 unpredictable intervals that depend on the rate of turnover of addresses in the
22875 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
22876
22877
22878 .option once_file_size autoreply integer 0
22879 See &%once%& above.
22880
22881
22882 .option once_repeat autoreply time&!! 0s
22883 See &%once%& above.
22884 After expansion, the value of this option must be a valid time value.
22885
22886
22887 .option reply_to autoreply string&!! unset
22888 This specifies the contents of the &'Reply-To:'& header when the message is
22889 specified by the transport.
22890
22891
22892 .option return_message autoreply boolean false
22893 If this is set, a copy of the original message is returned with the new
22894 message, subject to the maximum size set in the &%return_size_limit%& global
22895 configuration option.
22896
22897
22898 .option subject autoreply string&!! unset
22899 This specifies the contents of the &'Subject:'& header when the message is
22900 specified by the transport. It is tempting to quote the original subject in
22901 automatic responses. For example:
22902 .code
22903 subject = Re: $h_subject:
22904 .endd
22905 There is a danger in doing this, however. It may allow a third party to
22906 subscribe your users to an opt-in mailing list, provided that the list accepts
22907 bounce messages as subscription confirmations. Well-managed lists require a
22908 non-bounce message to confirm a subscription, so the danger is relatively
22909 small.
22910
22911
22912
22913 .option text autoreply string&!! unset
22914 This specifies a single string to be used as the body of the message when the
22915 message is specified by the transport. If both &%text%& and &%file%& are set,
22916 the text comes first.
22917
22918
22919 .option to autoreply string&!! unset
22920 This specifies recipients of the message and the contents of the &'To:'& header
22921 when the message is specified by the transport.
22922 .ecindex IIDauttra1
22923 .ecindex IIDauttra2
22924
22925
22926
22927
22928 . ////////////////////////////////////////////////////////////////////////////
22929 . ////////////////////////////////////////////////////////////////////////////
22930
22931 .chapter "The lmtp transport" "CHAPLMTP"
22932 .cindex "transports" "&(lmtp)&"
22933 .cindex "&(lmtp)& transport"
22934 .cindex "LMTP" "over a pipe"
22935 .cindex "LMTP" "over a socket"
22936 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
22937 specified command
22938 or by interacting with a Unix domain socket.
22939 This transport is something of a cross between the &(pipe)& and &(smtp)&
22940 transports. Exim also has support for using LMTP over TCP/IP; this is
22941 implemented as an option for the &(smtp)& transport. Because LMTP is expected
22942 to be of minority interest, the default build-time configure in &_src/EDITME_&
22943 has it commented out. You need to ensure that
22944 .code
22945 TRANSPORT_LMTP=yes
22946 .endd
22947 .cindex "options" "&(lmtp)& transport"
22948 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
22949 included in the Exim binary. The private options of the &(lmtp)& transport are
22950 as follows:
22951
22952 .option batch_id lmtp string&!! unset
22953 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22954
22955
22956 .option batch_max lmtp integer 1
22957 This limits the number of addresses that can be handled in a single delivery.
22958 Most LMTP servers can handle several addresses at once, so it is normally a
22959 good idea to increase this value. See the description of local delivery
22960 batching in chapter &<<CHAPbatching>>&.
22961
22962
22963 .option command lmtp string&!! unset
22964 This option must be set if &%socket%& is not set. The string is a command which
22965 is run in a separate process. It is split up into a command name and list of
22966 arguments, each of which is separately expanded (so expansion cannot change the
22967 number of arguments). The command is run directly, not via a shell. The message
22968 is passed to the new process using the standard input and output to operate the
22969 LMTP protocol.
22970
22971 .option ignore_quota lmtp boolean false
22972 .cindex "LMTP" "ignoring quota errors"
22973 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
22974 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
22975 in its response to the LHLO command.
22976
22977 .option socket lmtp string&!! unset
22978 This option must be set if &%command%& is not set. The result of expansion must
22979 be the name of a Unix domain socket. The transport connects to the socket and
22980 delivers the message to it using the LMTP protocol.
22981
22982
22983 .option timeout lmtp time 5m
22984 The transport is aborted if the created process or Unix domain socket does not
22985 respond to LMTP commands or message input within this timeout. Delivery
22986 is deferred, and will be tried again later. Here is an example of a typical
22987 LMTP transport:
22988 .code
22989 lmtp:
22990   driver = lmtp
22991   command = /some/local/lmtp/delivery/program
22992   batch_max = 20
22993   user = exim
22994 .endd
22995 This delivers up to 20 addresses at a time, in a mixture of domains if
22996 necessary, running as the user &'exim'&.
22997
22998
22999
23000 . ////////////////////////////////////////////////////////////////////////////
23001 . ////////////////////////////////////////////////////////////////////////////
23002
23003 .chapter "The pipe transport" "CHAPpipetransport"
23004 .scindex IIDpiptra1 "transports" "&(pipe)&"
23005 .scindex IIDpiptra2 "&(pipe)& transport"
23006 The &(pipe)& transport is used to deliver messages via a pipe to a command
23007 running in another process. One example is the use of &(pipe)& as a
23008 pseudo-remote transport for passing messages to some other delivery mechanism
23009 (such as UUCP). Another is the use by individual users to automatically process
23010 their incoming messages. The &(pipe)& transport can be used in one of the
23011 following ways:
23012
23013 .ilist
23014 .vindex "&$local_part$&"
23015 A router routes one address to a transport in the normal way, and the
23016 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23017 contains the local part of the address (as usual), and the command that is run
23018 is specified by the &%command%& option on the transport.
23019 .next
23020 .vindex "&$pipe_addresses$&"
23021 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23022 transport can handle more than one address in a single run. In this case, when
23023 more than one address is routed to the transport, &$local_part$& is not set
23024 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23025 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23026 that are routed to the transport.
23027 .next
23028 .vindex "&$address_pipe$&"
23029 A router redirects an address directly to a pipe command (for example, from an
23030 alias or forward file). In this case, &$address_pipe$& contains the text of the
23031 pipe command, and the &%command%& option on the transport is ignored unless
23032 &%force_command%& is set. If only one address is being transported
23033 (&%batch_max%& is not greater than one, or only one address was redirected to
23034 this pipe command), &$local_part$& contains the local part that was redirected.
23035 .endlist
23036
23037
23038 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23039 deliver messages over pipes using the LMTP interactive protocol. This is
23040 implemented by the &(lmtp)& transport.
23041
23042 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23043 &_.forward_& file, the command runs under the uid and gid of that user. In
23044 other cases, the uid and gid have to be specified explicitly, either on the
23045 transport or on the router that handles the address. Current and &"home"&
23046 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23047 details of the local delivery environment and chapter &<<CHAPbatching>>&
23048 for a discussion of local delivery batching.
23049
23050
23051 .section "Concurrent delivery" "SECID140"
23052 If two messages arrive at almost the same time, and both are routed to a pipe
23053 delivery, the two pipe transports may be run concurrently. You must ensure that
23054 any pipe commands you set up are robust against this happening. If the commands
23055 write to a file, the &%exim_lock%& utility might be of use.
23056 Alternatively the &%max_parallel%& option could be used with a value
23057 of "1" to enforce serialization.
23058
23059
23060
23061
23062 .section "Returned status and data" "SECID141"
23063 .cindex "&(pipe)& transport" "returned data"
23064 If the command exits with a non-zero return code, the delivery is deemed to
23065 have failed, unless either the &%ignore_status%& option is set (in which case
23066 the return code is treated as zero), or the return code is one of those listed
23067 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23068 later"&. In this case, delivery is deferred. Details of a permanent failure are
23069 logged, but are not included in the bounce message, which merely contains
23070 &"local delivery failed"&.
23071
23072 If the command exits on a signal and the &%freeze_signal%& option is set then
23073 the message will be frozen in the queue. If that option is not set, a bounce
23074 will be sent as normal.
23075
23076 If the return code is greater than 128 and the command being run is a shell
23077 script, it normally means that the script was terminated by a signal whose
23078 value is the return code minus 128. The &%freeze_signal%& option does not
23079 apply in this case.
23080
23081 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23082 return code is set to 127. This is the value that a shell returns if it is
23083 asked to run a non-existent command. The wording for the log line suggests that
23084 a non-existent command may be the problem.
23085
23086 The &%return_output%& option can affect the result of a pipe delivery. If it is
23087 set and the command produces any output on its standard output or standard
23088 error streams, the command is considered to have failed, even if it gave a zero
23089 return code or if &%ignore_status%& is set. The output from the command is
23090 included as part of the bounce message. The &%return_fail_output%& option is
23091 similar, except that output is returned only when the command exits with a
23092 failure return code, that is, a value other than zero or a code that matches
23093 &%temp_errors%&.
23094
23095
23096
23097 .section "How the command is run" "SECThowcommandrun"
23098 .cindex "&(pipe)& transport" "path for command"
23099 The command line is (by default) broken down into a command name and arguments
23100 by the &(pipe)& transport itself. The &%allow_commands%& and
23101 &%restrict_to_path%& options can be used to restrict the commands that may be
23102 run.
23103
23104 .cindex "quoting" "in pipe command"
23105 Unquoted arguments are delimited by white space. If an argument appears in
23106 double quotes, backslash is interpreted as an escape character in the usual
23107 way. If an argument appears in single quotes, no escaping is done.
23108
23109 String expansion is applied to the command line except when it comes from a
23110 traditional &_.forward_& file (commands from a filter file are expanded). The
23111 expansion is applied to each argument in turn rather than to the whole line.
23112 For this reason, any string expansion item that contains white space must be
23113 quoted so as to be contained within a single argument. A setting such as
23114 .code
23115 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23116 .endd
23117 will not work, because the expansion item gets split between several
23118 arguments. You have to write
23119 .code
23120 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23121 .endd
23122 to ensure that it is all in one argument. The expansion is done in this way,
23123 argument by argument, so that the number of arguments cannot be changed as a
23124 result of expansion, and quotes or backslashes in inserted variables do not
23125 interact with external quoting. However, this leads to problems if you want to
23126 generate multiple arguments (or the command name plus arguments) from a single
23127 expansion. In this situation, the simplest solution is to use a shell. For
23128 example:
23129 .code
23130 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23131 .endd
23132
23133 .cindex "transport" "filter"
23134 .cindex "filter" "transport filter"
23135 .vindex "&$pipe_addresses$&"
23136 Special handling takes place when an argument consists of precisely the text
23137 &`$pipe_addresses`&. This is not a general expansion variable; the only
23138 place this string is recognized is when it appears as an argument for a pipe or
23139 transport filter command. It causes each address that is being handled to be
23140 inserted in the argument list at that point &'as a separate argument'&. This
23141 avoids any problems with spaces or shell metacharacters, and is of use when a
23142 &(pipe)& transport is handling groups of addresses in a batch.
23143
23144 If &%force_command%& is enabled on the transport, Special handling takes place
23145 for an argument that consists of precisely the text &`$address_pipe`&.  It
23146 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23147 argument is inserted in the argument list at that point
23148 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23149 the only item in the argument; in fact, if it were then &%force_command%&
23150 should behave as a no-op.  Rather, it should be used to adjust the command
23151 run while preserving the argument vector separation.
23152
23153 After splitting up into arguments and expansion, the resulting command is run
23154 in a subprocess directly from the transport, &'not'& under a shell. The
23155 message that is being delivered is supplied on the standard input, and the
23156 standard output and standard error are both connected to a single pipe that is
23157 read by Exim. The &%max_output%& option controls how much output the command
23158 may produce, and the &%return_output%& and &%return_fail_output%& options
23159 control what is done with it.
23160
23161 Not running the command under a shell (by default) lessens the security risks
23162 in cases when a command from a user's filter file is built out of data that was
23163 taken from an incoming message. If a shell is required, it can of course be
23164 explicitly specified as the command to be run. However, there are circumstances
23165 where existing commands (for example, in &_.forward_& files) expect to be run
23166 under a shell and cannot easily be modified. To allow for these cases, there is
23167 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23168 works. Instead of breaking up the command line as just described, it expands it
23169 as a single string and passes the result to &_/bin/sh_&. The
23170 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23171 with &%use_shell%&, and the whole mechanism is inherently less secure.
23172
23173
23174
23175 .section "Environment variables" "SECTpipeenv"
23176 .cindex "&(pipe)& transport" "environment for command"
23177 .cindex "environment" "&(pipe)& transport"
23178 The environment variables listed below are set up when the command is invoked.
23179 This list is a compromise for maximum compatibility with other MTAs. Note that
23180 the &%environment%& option can be used to add additional variables to this
23181 environment. The environment for the &(pipe)& transport is not subject
23182 to the &%add_environment%& and &%keep_environment%& main config options.
23183 .display
23184 &`DOMAIN            `&   the domain of the address
23185 &`HOME              `&   the home directory, if set
23186 &`HOST              `&   the host name when called from a router (see below)
23187 &`LOCAL_PART        `&   see below
23188 &`LOCAL_PART_PREFIX `&   see below
23189 &`LOCAL_PART_SUFFIX `&   see below
23190 &`LOGNAME           `&   see below
23191 &`MESSAGE_ID        `&   Exim's local ID for the message
23192 &`PATH              `&   as specified by the &%path%& option below
23193 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23194 &`RECIPIENT         `&   the complete recipient address
23195 &`SENDER            `&   the sender of the message (empty if a bounce)
23196 &`SHELL             `&   &`/bin/sh`&
23197 &`TZ                `&   the value of the &%timezone%& option, if set
23198 &`USER              `&   see below
23199 .endd
23200 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23201 router, LOCAL_PART is set to the local part of the address. When it is
23202 called as a result of a forward or alias expansion, LOCAL_PART is set to
23203 the local part of the address that was expanded. In both cases, any affixes are
23204 removed from the local part, and made available in LOCAL_PART_PREFIX and
23205 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23206 same value as LOCAL_PART for compatibility with other MTAs.
23207
23208 .cindex "HOST"
23209 HOST is set only when a &(pipe)& transport is called from a router that
23210 associates hosts with an address, typically when using &(pipe)& as a
23211 pseudo-remote transport. HOST is set to the first host name specified by
23212 the router.
23213
23214 .cindex "HOME"
23215 If the transport's generic &%home_directory%& option is set, its value is used
23216 for the HOME environment variable. Otherwise, a home directory may be set
23217 by the router's &%transport_home_directory%& option, which defaults to the
23218 user's home directory if &%check_local_user%& is set.
23219
23220
23221 .section "Private options for pipe" "SECID142"
23222 .cindex "options" "&(pipe)& transport"
23223
23224
23225
23226 .option allow_commands pipe "string list&!!" unset
23227 .cindex "&(pipe)& transport" "permitted commands"
23228 The string is expanded, and is then interpreted as a colon-separated list of
23229 permitted commands. If &%restrict_to_path%& is not set, the only commands
23230 permitted are those in the &%allow_commands%& list. They need not be absolute
23231 paths; the &%path%& option is still used for relative paths. If
23232 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23233 in the &%allow_commands%& list, or a name without any slashes that is found on
23234 the path. In other words, if neither &%allow_commands%& nor
23235 &%restrict_to_path%& is set, there is no restriction on the command, but
23236 otherwise only commands that are permitted by one or the other are allowed. For
23237 example, if
23238 .code
23239 allow_commands = /usr/bin/vacation
23240 .endd
23241 and &%restrict_to_path%& is not set, the only permitted command is
23242 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23243 &%use_shell%& is set.
23244
23245
23246 .option batch_id pipe string&!! unset
23247 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23248
23249
23250 .option batch_max pipe integer 1
23251 This limits the number of addresses that can be handled in a single delivery.
23252 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23253
23254
23255 .option check_string pipe string unset
23256 As &(pipe)& writes the message, the start of each line is tested for matching
23257 &%check_string%&, and if it does, the initial matching characters are replaced
23258 by the contents of &%escape_string%&, provided both are set. The value of
23259 &%check_string%& is a literal string, not a regular expression, and the case of
23260 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23261 of &%check_string%& and &%escape_string%& are forced to values that implement
23262 the SMTP escaping protocol. Any settings made in the configuration file are
23263 ignored.
23264
23265
23266 .option command pipe string&!! unset
23267 This option need not be set when &(pipe)& is being used to deliver to pipes
23268 obtained directly from address redirections. In other cases, the option must be
23269 set, to provide a command to be run. It need not yield an absolute path (see
23270 the &%path%& option below). The command is split up into separate arguments by
23271 Exim, and each argument is separately expanded, as described in section
23272 &<<SECThowcommandrun>>& above.
23273
23274
23275 .option environment pipe string&!! unset
23276 .cindex "&(pipe)& transport" "environment for command"
23277 .cindex "environment" "&(pipe)& transport"
23278 This option is used to add additional variables to the environment in which the
23279 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23280 a string which is expanded, and then interpreted as a colon-separated list of
23281 environment settings of the form <&'name'&>=<&'value'&>.
23282
23283
23284 .option escape_string pipe string unset
23285 See &%check_string%& above.
23286
23287
23288 .option freeze_exec_fail pipe boolean false
23289 .cindex "exec failure"
23290 .cindex "failure of exec"
23291 .cindex "&(pipe)& transport" "failure of exec"
23292 Failure to exec the command in a pipe transport is by default treated like
23293 any other failure while running the command. However, if &%freeze_exec_fail%&
23294 is set, failure to exec is treated specially, and causes the message to be
23295 frozen, whatever the setting of &%ignore_status%&.
23296
23297
23298 .option freeze_signal pipe boolean false
23299 .cindex "signal exit"
23300 .cindex "&(pipe)& transport", "signal exit"
23301 Normally if the process run by a command in a pipe transport exits on a signal,
23302 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23303 frozen in Exim's queue instead.
23304
23305
23306 .option force_command pipe boolean false
23307 .cindex "force command"
23308 .cindex "&(pipe)& transport", "force command"
23309 Normally when a router redirects an address directly to a pipe command
23310 the &%command%& option on the transport is ignored.  If &%force_command%&
23311 is set, the &%command%& option will used. This is especially
23312 useful for forcing a wrapper or additional argument to be added to the
23313 command. For example:
23314 .code
23315 command = /usr/bin/remote_exec myhost -- $address_pipe
23316 force_command
23317 .endd
23318
23319 Note that &$address_pipe$& is handled specially in &%command%& when
23320 &%force_command%& is set, expanding out to the original argument vector as
23321 separate items, similarly to a Unix shell &`"$@"`& construct.
23322
23323
23324 .option ignore_status pipe boolean false
23325 If this option is true, the status returned by the subprocess that is set up to
23326 run the command is ignored, and Exim behaves as if zero had been returned.
23327 Otherwise, a non-zero status or termination by signal causes an error return
23328 from the transport unless the status value is one of those listed in
23329 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23330
23331 &*Note*&: This option does not apply to timeouts, which do not return a status.
23332 See the &%timeout_defer%& option for how timeouts are handled.
23333
23334
23335 .option log_defer_output pipe boolean false
23336 .cindex "&(pipe)& transport" "logging output"
23337 If this option is set, and the status returned by the command is
23338 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23339 and any output was produced on stdout or stderr, the first line of it is
23340 written to the main log.
23341
23342
23343 .option log_fail_output pipe boolean false
23344 If this option is set, and the command returns any output on stdout or
23345 stderr, and also ends with a return code that is neither zero nor one of
23346 the return codes listed in &%temp_errors%& (that is, the delivery
23347 failed), the first line of output is written to the main log. This
23348 option and &%log_output%& are mutually exclusive.  Only one of them may
23349 be set.
23350
23351
23352 .option log_output pipe boolean false
23353 If this option is set and the command returns any output on stdout or
23354 stderr, the first line of output is written to the main log, whatever
23355 the return code. This option and &%log_fail_output%& are mutually
23356 exclusive. Only one of them may be set.
23357
23358
23359 .option max_output pipe integer 20K
23360 This specifies the maximum amount of output that the command may produce on its
23361 standard output and standard error file combined. If the limit is exceeded, the
23362 process running the command is killed. This is intended as a safety measure to
23363 catch runaway processes. The limit is applied independently of the settings of
23364 the options that control what is done with such output (for example,
23365 &%return_output%&). Because of buffering effects, the amount of output may
23366 exceed the limit by a small amount before Exim notices.
23367
23368
23369 .option message_prefix pipe string&!! "see below"
23370 The string specified here is expanded and output at the start of every message.
23371 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23372 .code
23373 message_prefix = \
23374   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23375   ${tod_bsdinbox}\n
23376 .endd
23377 .cindex "Cyrus"
23378 .cindex "&%tmail%&"
23379 .cindex "&""From""& line"
23380 This is required by the commonly used &_/usr/bin/vacation_& program.
23381 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23382 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23383 setting
23384 .code
23385 message_prefix =
23386 .endd
23387 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23388 &`\n`& to &`\r\n`& in &%message_prefix%&.
23389
23390
23391 .option message_suffix pipe string&!! "see below"
23392 The string specified here is expanded and output at the end of every message.
23393 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23394 The suffix can be suppressed by setting
23395 .code
23396 message_suffix =
23397 .endd
23398 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23399 &`\n`& to &`\r\n`& in &%message_suffix%&.
23400
23401
23402 .option path pipe string&!! "/bin:/usr/bin"
23403 This option is expanded and
23404 specifies the string that is set up in the PATH environment
23405 variable of the subprocess.
23406 If the &%command%& option does not yield an absolute path name, the command is
23407 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23408 apply to a command specified as a transport filter.
23409
23410
23411 .option permit_coredump pipe boolean false
23412 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23413 a core-dump of a pipe command, enable this command.  This enables core-dumps
23414 during delivery and affects both the Exim binary and the pipe command run.
23415 It is recommended that this option remain off unless and until you have a need
23416 for it and that this only be enabled when needed, as the risk of excessive
23417 resource consumption can be quite high.  Note also that Exim is typically
23418 installed as a setuid binary and most operating systems will inhibit coredumps
23419 of these by default, so further OS-specific action may be required.
23420
23421
23422 .option pipe_as_creator pipe boolean false
23423 .cindex "uid (user id)" "local delivery"
23424 If the generic &%user%& option is not set and this option is true, the delivery
23425 process is run under the uid that was in force when Exim was originally called
23426 to accept the message. If the group id is not otherwise set (via the generic
23427 &%group%& option), the gid that was in force when Exim was originally called to
23428 accept the message is used.
23429
23430
23431 .option restrict_to_path pipe boolean false
23432 When this option is set, any command name not listed in &%allow_commands%& must
23433 contain no slashes. The command is searched for only in the directories listed
23434 in the &%path%& option. This option is intended for use in the case when a pipe
23435 command has been generated from a user's &_.forward_& file. This is usually
23436 handled by a &(pipe)& transport called &%address_pipe%&.
23437
23438
23439 .option return_fail_output pipe boolean false
23440 If this option is true, and the command produced any output and ended with a
23441 return code other than zero or one of the codes listed in &%temp_errors%& (that
23442 is, the delivery failed), the output is returned in the bounce message.
23443 However, if the message has a null sender (that is, it is itself a bounce
23444 message), output from the command is discarded. This option and
23445 &%return_output%& are mutually exclusive. Only one of them may be set.
23446
23447
23448
23449 .option return_output pipe boolean false
23450 If this option is true, and the command produced any output, the delivery is
23451 deemed to have failed whatever the return code from the command, and the output
23452 is returned in the bounce message. Otherwise, the output is just discarded.
23453 However, if the message has a null sender (that is, it is a bounce message),
23454 output from the command is always discarded, whatever the setting of this
23455 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23456 of them may be set.
23457
23458
23459
23460 .option temp_errors pipe "string list" "see below"
23461 .cindex "&(pipe)& transport" "temporary failure"
23462 This option contains either a colon-separated list of numbers, or a single
23463 asterisk. If &%ignore_status%& is false
23464 and &%return_output%& is not set,
23465 and the command exits with a non-zero return code, the failure is treated as
23466 temporary and the delivery is deferred if the return code matches one of the
23467 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23468 codes are treated as permanent errors. The default setting contains the codes
23469 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23470 compiled on a system that does not define these macros, it assumes values of 75
23471 and 73, respectively.
23472
23473
23474 .option timeout pipe time 1h
23475 If the command fails to complete within this time, it is killed. This normally
23476 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23477 specifies no timeout. In order to ensure that any subprocesses created by the
23478 command are also killed, Exim makes the initial process a process group leader,
23479 and kills the whole process group on a timeout. However, this can be defeated
23480 if one of the processes starts a new process group.
23481
23482 .option timeout_defer pipe boolean false
23483 A timeout in a &(pipe)& transport, either in the command that the transport
23484 runs, or in a transport filter that is associated with it, is by default
23485 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23486 is set true, both kinds of timeout become temporary errors, causing the
23487 delivery to be deferred.
23488
23489 .option umask pipe "octal integer" 022
23490 This specifies the umask setting for the subprocess that runs the command.
23491
23492
23493 .option use_bsmtp pipe boolean false
23494 .cindex "envelope sender"
23495 If this option is set true, the &(pipe)& transport writes messages in &"batch
23496 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
23497 commands. If you want to include a leading HELO command with such messages,
23498 you can do so by setting the &%message_prefix%& option. See section
23499 &<<SECTbatchSMTP>>& for details of batch SMTP.
23500
23501 .option use_classresources pipe boolean false
23502 .cindex "class resources (BSD)"
23503 This option is available only when Exim is running on FreeBSD, NetBSD, or
23504 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
23505 resource limits when a &(pipe)& transport is run to perform a delivery. The
23506 limits for the uid under which the pipe is to run are obtained from the login
23507 class database.
23508
23509
23510 .option use_crlf pipe boolean false
23511 .cindex "carriage return"
23512 .cindex "linefeed"
23513 This option causes lines to be terminated with the two-character CRLF sequence
23514 (carriage return, linefeed) instead of just a linefeed character. In the case
23515 of batched SMTP, the byte sequence written to the pipe is then an exact image
23516 of what would be sent down a real SMTP connection.
23517
23518 The contents of the &%message_prefix%& and &%message_suffix%& options are
23519 written verbatim, so must contain their own carriage return characters if these
23520 are needed. When &%use_bsmtp%& is not set, the default values for both
23521 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
23522 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
23523
23524
23525 .option use_shell pipe boolean false
23526 .vindex "&$pipe_addresses$&"
23527 If this option is set, it causes the command to be passed to &_/bin/sh_&
23528 instead of being run directly from the transport, as described in section
23529 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
23530 where the command is expected to be run under a shell and cannot easily be
23531 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
23532 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
23533 command is expanded as a single string, and handed to &_/bin/sh_& as data for
23534 its &%-c%& option.
23535
23536
23537
23538 .section "Using an external local delivery agent" "SECID143"
23539 .cindex "local delivery" "using an external agent"
23540 .cindex "&'procmail'&"
23541 .cindex "external local delivery"
23542 .cindex "delivery" "&'procmail'&"
23543 .cindex "delivery" "by external agent"
23544 The &(pipe)& transport can be used to pass all messages that require local
23545 delivery to a separate local delivery agent such as &%procmail%&. When doing
23546 this, care must be taken to ensure that the pipe is run under an appropriate
23547 uid and gid. In some configurations one wants this to be a uid that is trusted
23548 by the delivery agent to supply the correct sender of the message. It may be
23549 necessary to recompile or reconfigure the delivery agent so that it trusts an
23550 appropriate user. The following is an example transport and router
23551 configuration for &%procmail%&:
23552 .code
23553 # transport
23554 procmail_pipe:
23555   driver = pipe
23556   command = /usr/local/bin/procmail -d $local_part
23557   return_path_add
23558   delivery_date_add
23559   envelope_to_add
23560   check_string = "From "
23561   escape_string = ">From "
23562   umask = 077
23563   user = $local_part
23564   group = mail
23565
23566 # router
23567 procmail:
23568   driver = accept
23569   check_local_user
23570   transport = procmail_pipe
23571 .endd
23572 In this example, the pipe is run as the local user, but with the group set to
23573 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
23574 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
23575 user to supply a correct sender address. If you do not specify either a
23576 &%group%& or a &%user%& option, the pipe command is run as the local user. The
23577 home directory is the user's home directory by default.
23578
23579 &*Note*&: The command that the pipe transport runs does &'not'& begin with
23580 .code
23581 IFS=" "
23582 .endd
23583 as shown in some &%procmail%& documentation, because Exim does not by default
23584 use a shell to run pipe commands.
23585
23586 .cindex "Cyrus"
23587 The next example shows a transport and a router for a system where local
23588 deliveries are handled by the Cyrus IMAP server.
23589 .code
23590 # transport
23591 local_delivery_cyrus:
23592   driver = pipe
23593   command = /usr/cyrus/bin/deliver \
23594             -m ${substr_1:$local_part_suffix} -- $local_part
23595   user = cyrus
23596   group = mail
23597   return_output
23598   log_output
23599   message_prefix =
23600   message_suffix =
23601
23602 # router
23603 local_user_cyrus:
23604   driver = accept
23605   check_local_user
23606   local_part_suffix = .*
23607   transport = local_delivery_cyrus
23608 .endd
23609 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
23610 &%return_output%& to cause any text written by Cyrus to be returned to the
23611 sender.
23612 .ecindex IIDpiptra1
23613 .ecindex IIDpiptra2
23614
23615
23616 . ////////////////////////////////////////////////////////////////////////////
23617 . ////////////////////////////////////////////////////////////////////////////
23618
23619 .chapter "The smtp transport" "CHAPsmtptrans"
23620 .scindex IIDsmttra1 "transports" "&(smtp)&"
23621 .scindex IIDsmttra2 "&(smtp)& transport"
23622 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
23623 or LMTP protocol. The list of hosts to try can either be taken from the address
23624 that is being processed (having been set up by the router), or specified
23625 explicitly for the transport. Timeout and retry processing (see chapter
23626 &<<CHAPretry>>&) is applied to each IP address independently.
23627
23628
23629 .section "Multiple messages on a single connection" "SECID144"
23630 The sending of multiple messages over a single TCP/IP connection can arise in
23631 two ways:
23632
23633 .ilist
23634 If a message contains more than &%max_rcpt%& (see below) addresses that are
23635 routed to the same host, more than one copy of the message has to be sent to
23636 that host. In this situation, multiple copies may be sent in a single run of
23637 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
23638 does when it has too many addresses to send in one message also depends on the
23639 value of the global &%remote_max_parallel%& option. Details are given in
23640 section &<<SECToutSMTPTCP>>&.)
23641 .next
23642 .cindex "hints database" "remembering routing"
23643 When a message has been successfully delivered over a TCP/IP connection, Exim
23644 looks in its hints database to see if there are any other messages awaiting a
23645 connection to the same host. If there are, a new delivery process is started
23646 for one of them, and the current TCP/IP connection is passed on to it. The new
23647 process may in turn send multiple copies and possibly create yet another
23648 process.
23649 .endlist
23650
23651
23652 For each copy sent over the same TCP/IP connection, a sequence counter is
23653 incremented, and if it ever gets to the value of &%connection_max_messages%&,
23654 no further messages are sent over that connection.
23655
23656
23657
23658 .section "Use of the $host and $host_address variables" "SECID145"
23659 .vindex "&$host$&"
23660 .vindex "&$host_address$&"
23661 At the start of a run of the &(smtp)& transport, the values of &$host$& and
23662 &$host_address$& are the name and IP address of the first host on the host list
23663 passed by the router. However, when the transport is about to connect to a
23664 specific host, and while it is connected to that host, &$host$& and
23665 &$host_address$& are set to the values for that host. These are the values
23666 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
23667 &%serialize_hosts%&, and the various TLS options are expanded.
23668
23669
23670 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
23671 .vindex &$tls_bits$&
23672 .vindex &$tls_cipher$&
23673 .vindex &$tls_peerdn$&
23674 .vindex &$tls_sni$&
23675 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
23676 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
23677 are the values that were set when the message was received.
23678 These are the values that are used for options that are expanded before any
23679 SMTP connections are made. Just before each connection is made, these four
23680 variables are emptied. If TLS is subsequently started, they are set to the
23681 appropriate values for the outgoing connection, and these are the values that
23682 are in force when any authenticators are run and when the
23683 &%authenticated_sender%& option is expanded.
23684
23685 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
23686 and will be removed in a future release.
23687
23688
23689 .section "Private options for smtp" "SECID146"
23690 .cindex "options" "&(smtp)& transport"
23691 The private options of the &(smtp)& transport are as follows:
23692
23693
23694 .option address_retry_include_sender smtp boolean true
23695 .cindex "4&'xx'& responses" "retrying after"
23696 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
23697 is the combination of sender and recipient that is delayed in subsequent queue
23698 runs until the retry time is reached. You can delay the recipient without
23699 reference to the sender (which is what earlier versions of Exim did), by
23700 setting &%address_retry_include_sender%& false. However, this can lead to
23701 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
23702
23703 .option allow_localhost smtp boolean false
23704 .cindex "local host" "sending to"
23705 .cindex "fallback" "hosts specified on transport"
23706 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
23707 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
23708 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
23709 the delivery anyway. This should be used only in special cases when the
23710 configuration ensures that no looping will result (for example, a differently
23711 configured Exim is listening on the port to which the message is sent).
23712
23713
23714 .option authenticated_sender smtp string&!! unset
23715 .cindex "Cyrus"
23716 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
23717 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
23718 overriding any existing authenticated sender value. If the string expansion is
23719 forced to fail, the option is ignored. Other expansion failures cause delivery
23720 to be deferred. If the result of expansion is an empty string, that is also
23721 ignored.
23722
23723 The expansion happens after the outgoing connection has been made and TLS
23724 started, if required. This means that the &$host$&, &$host_address$&,
23725 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
23726 particular connection.
23727
23728 If the SMTP session is not authenticated, the expansion of
23729 &%authenticated_sender%& still happens (and can cause the delivery to be
23730 deferred if it fails), but no AUTH= item is added to MAIL commands
23731 unless &%authenticated_sender_force%& is true.
23732
23733 This option allows you to use the &(smtp)& transport in LMTP mode to
23734 deliver mail to Cyrus IMAP and provide the proper local part as the
23735 &"authenticated sender"&, via a setting such as:
23736 .code
23737 authenticated_sender = $local_part
23738 .endd
23739 This removes the need for IMAP subfolders to be assigned special ACLs to
23740 allow direct delivery to those subfolders.
23741
23742 Because of expected uses such as that just described for Cyrus (when no
23743 domain is involved), there is no checking on the syntax of the provided
23744 value.
23745
23746
23747 .option authenticated_sender_force smtp boolean false
23748 If this option is set true, the &%authenticated_sender%& option's value
23749 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
23750 authenticated as a client.
23751
23752
23753 .option command_timeout smtp time 5m
23754 This sets a timeout for receiving a response to an SMTP command that has been
23755 sent out. It is also used when waiting for the initial banner line from the
23756 remote host. Its value must not be zero.
23757
23758
23759 .option connect_timeout smtp time 5m
23760 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
23761 to a remote host. A setting of zero allows the system timeout (typically
23762 several minutes) to act. To have any effect, the value of this option must be
23763 less than the system timeout. However, it has been observed that on some
23764 systems there is no system timeout, which is why the default value for this
23765 option is 5 minutes, a value recommended by RFC 1123.
23766
23767
23768 .option connection_max_messages smtp integer 500
23769 .cindex "SMTP" "passed connection"
23770 .cindex "SMTP" "multiple deliveries"
23771 .cindex "multiple SMTP deliveries"
23772 This controls the maximum number of separate message deliveries that are sent
23773 over a single TCP/IP connection. If the value is zero, there is no limit.
23774 For testing purposes, this value can be overridden by the &%-oB%& command line
23775 option.
23776
23777
23778 .option data_timeout smtp time 5m
23779 This sets a timeout for the transmission of each block in the data portion of
23780 the message. As a result, the overall timeout for a message depends on the size
23781 of the message. Its value must not be zero. See also &%final_timeout%&.
23782
23783
23784 .option dkim_domain smtp string list&!! unset
23785 .option dkim_selector smtp string&!! unset
23786 .option dkim_private_key smtp string&!! unset
23787 .option dkim_canon smtp string&!! unset
23788 .option dkim_strict smtp string&!! unset
23789 .option dkim_sign_headers smtp string&!! unset
23790 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
23791
23792
23793 .option delay_after_cutoff smtp boolean true
23794 This option controls what happens when all remote IP addresses for a given
23795 domain have been inaccessible for so long that they have passed their retry
23796 cutoff times.
23797
23798 In the default state, if the next retry time has not been reached for any of
23799 them, the address is bounced without trying any deliveries. In other words,
23800 Exim delays retrying an IP address after the final cutoff time until a new
23801 retry time is reached, and can therefore bounce an address without ever trying
23802 a delivery, when machines have been down for a long time. Some people are
23803 unhappy at this prospect, so...
23804
23805 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
23806 addresses are past their final cutoff time, Exim tries to deliver to those
23807 IP addresses that have not been tried since the message arrived. If there are
23808 none, of if they all fail, the address is bounced. In other words, it does not
23809 delay when a new message arrives, but immediately tries those expired IP
23810 addresses that haven't been tried since the message arrived. If there is a
23811 continuous stream of messages for the dead hosts, unsetting
23812 &%delay_after_cutoff%& means that there will be many more attempts to deliver
23813 to them.
23814
23815
23816 .option dns_qualify_single smtp boolean true
23817 If the &%hosts%& or &%fallback_hosts%& option is being used,
23818 and the &%gethostbyname%& option is false,
23819 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
23820 in chapter &<<CHAPdnslookup>>& for more details.
23821
23822
23823 .option dns_search_parents smtp boolean false
23824 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
23825 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
23826 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
23827 details.
23828
23829
23830 .option dnssec_request_domains smtp "domain list&!!" unset
23831 .cindex "MX record" "security"
23832 .cindex "DNSSEC" "MX lookup"
23833 .cindex "security" "MX lookup"
23834 .cindex "DNS" "DNSSEC"
23835 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
23836 the dnssec request bit set.
23837 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23838
23839
23840
23841 .option dnssec_require_domains smtp "domain list&!!" unset
23842 .cindex "MX record" "security"
23843 .cindex "DNSSEC" "MX lookup"
23844 .cindex "security" "MX lookup"
23845 .cindex "DNS" "DNSSEC"
23846 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
23847 the dnssec request bit set.  Any returns not having the Authenticated Data bit
23848 (AD bit) set will be ignored and logged as a host-lookup failure.
23849 This applies to all of the SRV, MX, AAAA, A lookup sequence.
23850
23851
23852
23853 .option dscp smtp string&!! unset
23854 .cindex "DCSP" "outbound"
23855 This option causes the DSCP value associated with a socket to be set to one
23856 of a number of fixed strings or to numeric value.
23857 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
23858 Common values include &`throughput`&, &`mincost`&, and on newer systems
23859 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
23860
23861 The outbound packets from Exim will be marked with this value in the header
23862 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
23863 that these values will have any effect, not be stripped by networking
23864 equipment, or do much of anything without cooperation with your Network
23865 Engineer and those of all network operators between the source and destination.
23866
23867
23868 .option fallback_hosts smtp "string list" unset
23869 .cindex "fallback" "hosts specified on transport"
23870 String expansion is not applied to this option. The argument must be a
23871 colon-separated list of host names or IP addresses, optionally also including
23872 port numbers, though the separator can be changed, as described in section
23873 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23874 item in a &%route_list%& setting for the &(manualroute)& router, as described
23875 in section &<<SECTformatonehostitem>>&.
23876
23877 Fallback hosts can also be specified on routers, which associate them with the
23878 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
23879 &%fallback_hosts%& specified on the transport is used only if the address does
23880 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
23881 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
23882 However, &%hosts_randomize%& does apply to fallback host lists.
23883
23884 If Exim is unable to deliver to any of the hosts for a particular address, and
23885 the errors are not permanent rejections, the address is put on a separate
23886 transport queue with its host list replaced by the fallback hosts, unless the
23887 address was routed via MX records and the current host was in the original MX
23888 list. In that situation, the fallback host list is not used.
23889
23890 Once normal deliveries are complete, the fallback queue is delivered by
23891 re-running the same transports with the new host lists. If several failing
23892 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
23893 copy of the message is sent.
23894
23895 The resolution of the host names on the fallback list is controlled by the
23896 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
23897 both to cases when the host list comes with the address and when it is taken
23898 from &%hosts%&. This option provides a &"use a smart host only if delivery
23899 fails"& facility.
23900
23901
23902 .option final_timeout smtp time 10m
23903 This is the timeout that applies while waiting for the response to the final
23904 line containing just &"."& that terminates a message. Its value must not be
23905 zero.
23906
23907 .option gethostbyname smtp boolean false
23908 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
23909 being used, names are looked up using &[gethostbyname()]&
23910 (or &[getipnodebyname()]& when available)
23911 instead of using the DNS. Of course, that function may in fact use the DNS, but
23912 it may also consult other sources of information such as &_/etc/hosts_&.
23913
23914 .option gnutls_compat_mode smtp boolean unset
23915 This option controls whether GnuTLS is used in compatibility mode in an Exim
23916 server. This reduces security slightly, but improves interworking with older
23917 implementations of TLS.
23918
23919 .option helo_data smtp string&!! "see below"
23920 .cindex "HELO" "argument, setting"
23921 .cindex "EHLO" "argument, setting"
23922 .cindex "LHLO argument setting"
23923 The value of this option is expanded after a connection to a another host has
23924 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
23925 command that starts the outgoing SMTP or LMTP session. The default value of the
23926 option is:
23927 .code
23928 $primary_hostname
23929 .endd
23930 During the expansion, the variables &$host$& and &$host_address$& are set to
23931 the identity of the remote host, and the variables &$sending_ip_address$& and
23932 &$sending_port$& are set to the local IP address and port number that are being
23933 used. These variables can be used to generate different values for different
23934 servers or different local IP addresses. For example, if you want the string
23935 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
23936 interface address, you could use this:
23937 .code
23938 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
23939   {$primary_hostname}}
23940 .endd
23941 The use of &%helo_data%& applies both to sending messages and when doing
23942 callouts.
23943
23944 .option hosts smtp "string list&!!" unset
23945 Hosts are associated with an address by a router such as &(dnslookup)&, which
23946 finds the hosts by looking up the address domain in the DNS, or by
23947 &(manualroute)&, which has lists of hosts in its configuration. However,
23948 email addresses can be passed to the &(smtp)& transport by any router, and not
23949 all of them can provide an associated list of hosts.
23950
23951 The &%hosts%& option specifies a list of hosts to be used if the address being
23952 processed does not have any hosts associated with it. The hosts specified by
23953 &%hosts%& are also used, whether or not the address has its own hosts, if
23954 &%hosts_override%& is set.
23955
23956 The string is first expanded, before being interpreted as a colon-separated
23957 list of host names or IP addresses, possibly including port numbers. The
23958 separator may be changed to something other than colon, as described in section
23959 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
23960 item in a &%route_list%& setting for the &(manualroute)& router, as described
23961 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
23962 of the &(manualroute)& router is not available here.
23963
23964 If the expansion fails, delivery is deferred. Unless the failure was caused by
23965 the inability to complete a lookup, the error is logged to the panic log as
23966 well as the main log. Host names are looked up either by searching directly for
23967 address records in the DNS or by calling &[gethostbyname()]& (or
23968 &[getipnodebyname()]& when available), depending on the setting of the
23969 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
23970 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
23971 address are used.
23972
23973 During delivery, the hosts are tried in order, subject to their retry status,
23974 unless &%hosts_randomize%& is set.
23975
23976
23977 .option hosts_avoid_esmtp smtp "host list&!!" unset
23978 .cindex "ESMTP, avoiding use of"
23979 .cindex "HELO" "forcing use of"
23980 .cindex "EHLO" "avoiding use of"
23981 .cindex "PIPELINING" "avoiding the use of"
23982 This option is for use with broken hosts that announce ESMTP facilities (for
23983 example, PIPELINING) and then fail to implement them properly. When a host
23984 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
23985 start of the SMTP session. This means that it cannot use any of the ESMTP
23986 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
23987
23988
23989 .option hosts_avoid_pipelining smtp "host list&!!" unset
23990 .cindex "PIPELINING" "avoiding the use of"
23991 Exim will not use the SMTP PIPELINING extension when delivering to any host
23992 that matches this list, even if the server host advertises PIPELINING support.
23993
23994
23995 .option hosts_avoid_tls smtp "host list&!!" unset
23996 .cindex "TLS" "avoiding for certain hosts"
23997 Exim will not try to start a TLS session when delivering to any host that
23998 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
23999
24000 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24001 .cindex "TLS" "avoiding for certain hosts"
24002 Exim will not try to start a TLS session for a verify callout,
24003 or when delivering in cutthrough mode,
24004 to any host that matches this list.
24005
24006
24007 .option hosts_max_try smtp integer 5
24008 .cindex "host" "maximum number to try"
24009 .cindex "limit" "number of hosts tried"
24010 .cindex "limit" "number of MX tried"
24011 .cindex "MX record" "maximum tried"
24012 This option limits the number of IP addresses that are tried for any one
24013 delivery in cases where there are temporary delivery errors. Section
24014 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24015
24016
24017 .option hosts_max_try_hardlimit smtp integer 50
24018 This is an additional check on the maximum number of IP addresses that Exim
24019 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24020 why it exists.
24021
24022
24023
24024 .option hosts_nopass_tls smtp "host list&!!" unset
24025 .cindex "TLS" "passing connection"
24026 .cindex "multiple SMTP deliveries"
24027 .cindex "TLS" "multiple message deliveries"
24028 For any host that matches this list, a connection on which a TLS session has
24029 been started will not be passed to a new delivery process for sending another
24030 message on the same connection. See section &<<SECTmulmessam>>& for an
24031 explanation of when this might be needed.
24032
24033 .new
24034 .option hosts_noproxy_tls smtp "host list&!!" *
24035 .cindex "TLS" "passing connection"
24036 .cindex "multiple SMTP deliveries"
24037 .cindex "TLS" "multiple message deliveries"
24038 For any host that matches this list, a TLS session which has
24039 been started will not be passed to a new delivery process for sending another
24040 message on the same session.
24041
24042 The traditional implementation closes down TLS and re-starts it in the new
24043 process, on the same open TCP connection, for each successive message
24044 sent.  If permitted by this option a pipe to to the new process is set up
24045 instead, and the original process maintains the TLS connection and proxies
24046 the SMTP connection from and to the new process and any subsequents.
24047 The new process has no access to TLS information, so cannot include it in
24048 logging.
24049 .wen
24050
24051
24052
24053 .option hosts_override smtp boolean false
24054 If this option is set and the &%hosts%& option is also set, any hosts that are
24055 attached to the address are ignored, and instead the hosts specified by the
24056 &%hosts%& option are always used. This option does not apply to
24057 &%fallback_hosts%&.
24058
24059
24060 .option hosts_randomize smtp boolean false
24061 .cindex "randomized host list"
24062 .cindex "host" "list of; randomized"
24063 .cindex "fallback" "randomized hosts"
24064 If this option is set, and either the list of hosts is taken from the
24065 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24066 were not obtained from MX records (this includes fallback hosts from the
24067 router), and were not randomized by the router, the order of trying the hosts
24068 is randomized each time the transport runs. Randomizing the order of a host
24069 list can be used to do crude load sharing.
24070
24071 When &%hosts_randomize%& is true, a host list may be split into groups whose
24072 order is separately randomized. This makes it possible to set up MX-like
24073 behaviour. The boundaries between groups are indicated by an item that is just
24074 &`+`& in the host list. For example:
24075 .code
24076 hosts = host1:host2:host3:+:host4:host5
24077 .endd
24078 The order of the first three hosts and the order of the last two hosts is
24079 randomized for each use, but the first three always end up before the last two.
24080 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24081
24082 .option hosts_require_auth smtp "host list&!!" unset
24083 .cindex "authentication" "required by client"
24084 This option provides a list of servers for which authentication must succeed
24085 before Exim will try to transfer a message. If authentication fails for
24086 servers which are not in this list, Exim tries to send unauthenticated. If
24087 authentication fails for one of these servers, delivery is deferred. This
24088 temporary error is detectable in the retry rules, so it can be turned into a
24089 hard failure if required. See also &%hosts_try_auth%&, and chapter
24090 &<<CHAPSMTPAUTH>>& for details of authentication.
24091
24092
24093 .option hosts_request_ocsp smtp "host list&!!" *
24094 .cindex "TLS" "requiring for certain servers"
24095 Exim will request a Certificate Status on a
24096 TLS session for any host that matches this list.
24097 &%tls_verify_certificates%& should also be set for the transport.
24098
24099 .option hosts_require_ocsp smtp "host list&!!" unset
24100 .cindex "TLS" "requiring for certain servers"
24101 Exim will request, and check for a valid Certificate Status being given, on a
24102 TLS session for any host that matches this list.
24103 &%tls_verify_certificates%& should also be set for the transport.
24104
24105 .option hosts_require_tls smtp "host list&!!" unset
24106 .cindex "TLS" "requiring for certain servers"
24107 Exim will insist on using a TLS session when delivering to any host that
24108 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24109 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24110 incoming messages, use an appropriate ACL.
24111
24112 .option hosts_try_auth smtp "host list&!!" unset
24113 .cindex "authentication" "optional in client"
24114 This option provides a list of servers to which, provided they announce
24115 authentication support, Exim will attempt to authenticate as a client when it
24116 connects. If authentication fails, Exim will try to transfer the message
24117 unauthenticated. See also &%hosts_require_auth%&, and chapter
24118 &<<CHAPSMTPAUTH>>& for details of authentication.
24119
24120 .option hosts_try_chunking smtp "host list&!!" *
24121 .cindex CHUNKING "enabling, in client"
24122 .cindex BDAT "SMTP command"
24123 .cindex "RFC 3030" "CHUNKING"
24124 This option provides a list of servers to which, provided they announce
24125 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24126 BDAT will not be used in conjunction with a transport filter.
24127
24128 .option hosts_try_fastopen smtp "host list!!" unset
24129 .cindex "fast open, TCP" "enabling, in client"
24130 .cindex "TCP Fast Open" "enabling, in client"
24131 .cindex "RFC 7413" "TCP Fast Open"
24132 This option provides a list of servers to which, provided
24133 the facility is supported by this system, Exim will attempt to
24134 perform a TCP Fast Open.
24135 No data is sent on the SYN segment but, if the remote server also
24136 supports the facility, it can send its SMTP banner immediately after
24137 the SYN,ACK segment.  This can save up to one round-trip time.
24138
24139 The facility is only active for previously-contacted servers,
24140 as the initiator must present a cookie in the SYN segment.
24141
24142 On (at least some) current Linux distributions the facility must be enabled
24143 in the kernel by the sysadmin before the support is usable.
24144
24145 .option hosts_try_prdr smtp "host list&!!" *
24146 .cindex "PRDR" "enabling, optional in client"
24147 This option provides a list of servers to which, provided they announce
24148 PRDR support, Exim will attempt to negotiate PRDR
24149 for multi-recipient messages.
24150 The option can usually be left as default.
24151
24152 .option interface smtp "string list&!!" unset
24153 .cindex "bind IP address"
24154 .cindex "IP address" "binding"
24155 .vindex "&$host$&"
24156 .vindex "&$host_address$&"
24157 This option specifies which interface to bind to when making an outgoing SMTP
24158 call. The value is an IP address, not an interface name such as
24159 &`eth0`&. Do not confuse this with the interface address that was used when a
24160 message was received, which is in &$received_ip_address$&, formerly known as
24161 &$interface_address$&. The name was changed to minimize confusion with the
24162 outgoing interface address. There is no variable that contains an outgoing
24163 interface address because, unless it is set by this option, its value is
24164 unknown.
24165
24166 During the expansion of the &%interface%& option the variables &$host$& and
24167 &$host_address$& refer to the host to which a connection is about to be made
24168 during the expansion of the string. Forced expansion failure, or an empty
24169 string result causes the option to be ignored. Otherwise, after expansion, the
24170 string must be a list of IP addresses, colon-separated by default, but the
24171 separator can be changed in the usual way. For example:
24172 .code
24173 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24174 .endd
24175 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24176 connection. If none of them are the correct type, the option is ignored. If
24177 &%interface%& is not set, or is ignored, the system's IP functions choose which
24178 interface to use if the host has more than one.
24179
24180
24181 .option keepalive smtp boolean true
24182 .cindex "keepalive" "on outgoing connection"
24183 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24184 connections. When set, it causes the kernel to probe idle connections
24185 periodically, by sending packets with &"old"& sequence numbers. The other end
24186 of the connection should send a acknowledgment if the connection is still okay
24187 or a reset if the connection has been aborted. The reason for doing this is
24188 that it has the beneficial effect of freeing up certain types of connection
24189 that can get stuck when the remote host is disconnected without tidying up the
24190 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24191 unreachable hosts.
24192
24193
24194 .option lmtp_ignore_quota smtp boolean false
24195 .cindex "LMTP" "ignoring quota errors"
24196 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24197 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24198 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24199
24200 .option max_rcpt smtp integer 100
24201 .cindex "RCPT" "maximum number of outgoing"
24202 This option limits the number of RCPT commands that are sent in a single
24203 SMTP message transaction. Each set of addresses is treated independently, and
24204 so can cause parallel connections to the same host if &%remote_max_parallel%&
24205 permits this.
24206
24207
24208 .option multi_domain smtp boolean&!! true
24209 .vindex "&$domain$&"
24210 When this option is set, the &(smtp)& transport can handle a number of
24211 addresses containing a mixture of different domains provided they all resolve
24212 to the same list of hosts. Turning the option off restricts the transport to
24213 handling only one domain at a time. This is useful if you want to use
24214 &$domain$& in an expansion for the transport, because it is set only when there
24215 is a single domain involved in a remote delivery.
24216
24217 It is expanded per-address and can depend on any of
24218 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24219 &$host$&, &$host_address$& and &$host_port$&.
24220
24221 .option port smtp string&!! "see below"
24222 .cindex "port" "sending TCP/IP"
24223 .cindex "TCP/IP" "setting outgoing port"
24224 This option specifies the TCP/IP port on the server to which Exim connects.
24225 &*Note:*& Do not confuse this with the port that was used when a message was
24226 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24227 The name was changed to minimize confusion with the outgoing port. There is no
24228 variable that contains an outgoing port.
24229
24230 If the value of this option begins with a digit it is taken as a port number;
24231 otherwise it is looked up using &[getservbyname()]&. The default value is
24232 normally &"smtp"&, but if &%protocol%& is set to &"lmtp"&, the default is
24233 &"lmtp"&. If the expansion fails, or if a port number cannot be found, delivery
24234 is deferred.
24235
24236
24237
24238 .option protocol smtp string smtp
24239 .cindex "LMTP" "over TCP/IP"
24240 .cindex "ssmtp protocol" "outbound"
24241 .cindex "TLS" "SSL-on-connect outbound"
24242 .vindex "&$port$&"
24243 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24244 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24245 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24246 deliveries into closed message stores. Exim also has support for running LMTP
24247 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24248
24249 If this option is set to &"smtps"&, the default value for the &%port%& option
24250 changes to &"smtps"&, and the transport initiates TLS immediately after
24251 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24252 The Internet standards bodies strongly discourage use of this mode.
24253
24254
24255 .option retry_include_ip_address smtp boolean&!! true
24256 Exim normally includes both the host name and the IP address in the key it
24257 constructs for indexing retry data after a temporary delivery failure. This
24258 means that when one of several IP addresses for a host is failing, it gets
24259 tried periodically (controlled by the retry rules), but use of the other IP
24260 addresses is not affected.
24261
24262 However, in some dialup environments hosts are assigned a different IP address
24263 each time they connect. In this situation the use of the IP address as part of
24264 the retry key leads to undesirable behaviour. Setting this option false causes
24265 Exim to use only the host name.
24266 Since it is expanded it can be made to depend on the host or domain.
24267
24268
24269 .option serialize_hosts smtp "host list&!!" unset
24270 .cindex "serializing connections"
24271 .cindex "host" "serializing connections"
24272 Because Exim operates in a distributed manner, if several messages for the same
24273 host arrive at around the same time, more than one simultaneous connection to
24274 the remote host can occur. This is not usually a problem except when there is a
24275 slow link between the hosts. In that situation it may be helpful to restrict
24276 Exim to one connection at a time. This can be done by setting
24277 &%serialize_hosts%& to match the relevant hosts.
24278
24279 .cindex "hints database" "serializing deliveries to a host"
24280 Exim implements serialization by means of a hints database in which a record is
24281 written whenever a process connects to one of the restricted hosts. The record
24282 is deleted when the connection is completed. Obviously there is scope for
24283 records to get left lying around if there is a system or program crash. To
24284 guard against this, Exim ignores any records that are more than six hours old.
24285
24286 If you set up this kind of serialization, you should also arrange to delete the
24287 relevant hints database whenever your system reboots. The names of the files
24288 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24289 may be one or two files, depending on the type of DBM in use. The same files
24290 are used for ETRN serialization.
24291
24292 See also the &%max_parallel%& generic transport option.
24293
24294
24295 .option size_addition smtp integer 1024
24296 .cindex "SMTP" "SIZE"
24297 .cindex "message" "size issue for transport filter"
24298 .cindex "size" "of message"
24299 .cindex "transport" "filter"
24300 .cindex "filter" "transport filter"
24301 If a remote SMTP server indicates that it supports the SIZE option of the
24302 MAIL command, Exim uses this to pass over the message size at the start of
24303 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24304 sends, to allow for headers and other text that may be added during delivery by
24305 configuration options or in a transport filter. It may be necessary to increase
24306 this if a lot of text is added to messages.
24307
24308 Alternatively, if the value of &%size_addition%& is set negative, it disables
24309 the use of the SIZE option altogether.
24310
24311
24312 .option socks_proxy smtp string&!! unset
24313 .cindex proxy SOCKS
24314 This option enables use of SOCKS proxies for connections made by the
24315 transport.  For details see section &<<SECTproxySOCKS>>&.
24316
24317
24318 .option tls_certificate smtp string&!! unset
24319 .cindex "TLS" "client certificate, location of"
24320 .cindex "certificate" "client, location of"
24321 .vindex "&$host$&"
24322 .vindex "&$host_address$&"
24323 The value of this option must be the absolute path to a file which contains the
24324 client's certificate, for possible use when sending a message over an encrypted
24325 connection. The values of &$host$& and &$host_address$& are set to the name and
24326 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24327 details of TLS.
24328
24329 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24330 certificate when sending messages as a client. The global option of the same
24331 name specifies the certificate for Exim as a server; it is not automatically
24332 assumed that the same certificate should be used when Exim is operating as a
24333 client.
24334
24335
24336 .option tls_crl smtp string&!! unset
24337 .cindex "TLS" "client certificate revocation list"
24338 .cindex "certificate" "revocation list for client"
24339 This option specifies a certificate revocation list. The expanded value must
24340 be the name of a file that contains a CRL in PEM format.
24341
24342
24343 .option tls_dh_min_bits smtp integer 1024
24344 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24345 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24346 key agreement is negotiated, the server will provide a large prime number
24347 for use.  This option establishes the minimum acceptable size of that number.
24348 If the parameter offered by the server is too small, then the TLS handshake
24349 will fail.
24350
24351 Only supported when using GnuTLS.
24352
24353
24354 .option tls_privatekey smtp string&!! unset
24355 .cindex "TLS" "client private key, location of"
24356 .vindex "&$host$&"
24357 .vindex "&$host_address$&"
24358 The value of this option must be the absolute path to a file which contains the
24359 client's private key. This is used when sending a message over an encrypted
24360 connection using a client certificate. The values of &$host$& and
24361 &$host_address$& are set to the name and address of the server during the
24362 expansion. If this option is unset, or the expansion is forced to fail, or the
24363 result is an empty string, the private key is assumed to be in the same file as
24364 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24365
24366
24367 .option tls_require_ciphers smtp string&!! unset
24368 .cindex "TLS" "requiring specific ciphers"
24369 .cindex "cipher" "requiring specific"
24370 .vindex "&$host$&"
24371 .vindex "&$host_address$&"
24372 The value of this option must be a list of permitted cipher suites, for use
24373 when setting up an outgoing encrypted connection. (There is a global option of
24374 the same name for controlling incoming connections.) The values of &$host$& and
24375 &$host_address$& are set to the name and address of the server during the
24376 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24377 is used in different ways by OpenSSL and GnuTLS (see sections
24378 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24379 ciphers is a preference order.
24380
24381
24382
24383 .option tls_sni smtp string&!! unset
24384 .cindex "TLS" "Server Name Indication"
24385 .vindex "&$tls_sni$&"
24386 If this option is set then it sets the $tls_out_sni variable and causes any
24387 TLS session to pass this value as the Server Name Indication extension to
24388 the remote side, which can be used by the remote side to select an appropriate
24389 certificate and private key for the session.
24390
24391 See &<<SECTtlssni>>& for more information.
24392
24393 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24394 TLS extensions.
24395
24396
24397
24398
24399 .option tls_tempfail_tryclear smtp boolean true
24400 .cindex "4&'xx'& responses" "to STARTTLS"
24401 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24402 setting up a TLS session, this option determines whether or not Exim should try
24403 to deliver the message unencrypted. If it is set false, delivery to the
24404 current host is deferred; if there are other hosts, they are tried. If this
24405 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24406 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24407 TLS negotiation fails, Exim closes the current connection (because it is in an
24408 unknown state), opens a new one to the same host, and then tries the delivery
24409 in clear.
24410
24411
24412 .option tls_try_verify_hosts smtp "host list&!!" *
24413 .cindex "TLS" "server certificate verification"
24414 .cindex "certificate" "verification of server"
24415 This option gives a list of hosts for which, on encrypted connections,
24416 certificate verification will be tried but need not succeed.
24417 The &%tls_verify_certificates%& option must also be set.
24418 Note that unless the host is in this list
24419 TLS connections will be denied to hosts using self-signed certificates
24420 when &%tls_verify_certificates%& is matched.
24421 The &$tls_out_certificate_verified$& variable is set when
24422 certificate verification succeeds.
24423
24424
24425 .option tls_verify_cert_hostnames smtp "host list&!!" *
24426 .cindex "TLS" "server certificate hostname verification"
24427 .cindex "certificate" "verification of server"
24428 This option give a list of hosts for which,
24429 while verifying the server certificate,
24430 checks will be included on the host name
24431 (note that this will generally be the result of a DNS MX lookup)
24432 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24433 limited to being the initial component of a 3-or-more component FQDN.
24434
24435 There is no equivalent checking on client certificates.
24436
24437
24438 .option tls_verify_certificates smtp string&!! system
24439 .cindex "TLS" "server certificate verification"
24440 .cindex "certificate" "verification of server"
24441 .vindex "&$host$&"
24442 .vindex "&$host_address$&"
24443 The value of this option must be either the
24444 word "system"
24445 or the absolute path to
24446 a file or directory containing permitted certificates for servers,
24447 for use when setting up an encrypted connection.
24448
24449 The "system" value for the option will use a location compiled into the SSL library.
24450 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
24451 is taken as empty and an explicit location
24452 must be specified.
24453
24454 The use of a directory for the option value is not available for GnuTLS versions
24455 preceding 3.3.6 and a single file must be used.
24456
24457 With OpenSSL the certificates specified
24458 explicitly
24459 either by file or directory
24460 are added to those given by the system default location.
24461
24462 The values of &$host$& and
24463 &$host_address$& are set to the name and address of the server during the
24464 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
24465
24466 For back-compatibility,
24467 if neither tls_verify_hosts nor tls_try_verify_hosts are set
24468 (a single-colon empty list counts as being set)
24469 and certificate verification fails the TLS connection is closed.
24470
24471
24472 .option tls_verify_hosts smtp "host list&!!" unset
24473 .cindex "TLS" "server certificate verification"
24474 .cindex "certificate" "verification of server"
24475 This option gives a list of hosts for which, on encrypted connections,
24476 certificate verification must succeed.
24477 The &%tls_verify_certificates%& option must also be set.
24478 If both this option and &%tls_try_verify_hosts%& are unset
24479 operation is as if this option selected all hosts.
24480
24481
24482
24483
24484 .section "How the limits for the number of hosts to try are used" &&&
24485          "SECTvalhosmax"
24486 .cindex "host" "maximum number to try"
24487 .cindex "limit" "hosts; maximum number tried"
24488 There are two options that are concerned with the number of hosts that are
24489 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
24490 &%hosts_max_try_hardlimit%&.
24491
24492
24493 The &%hosts_max_try%& option limits the number of hosts that are tried
24494 for a single delivery. However, despite the term &"host"& in its name, the
24495 option actually applies to each IP address independently. In other words, a
24496 multihomed host is treated as several independent hosts, just as it is for
24497 retrying.
24498
24499 Many of the larger ISPs have multiple MX records which often point to
24500 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
24501 created as a result of routing one of these domains.
24502
24503 Trying every single IP address on such a long list does not seem sensible; if
24504 several at the top of the list fail, it is reasonable to assume there is some
24505 problem that is likely to affect all of them. Roughly speaking, the value of
24506 &%hosts_max_try%& is the maximum number that are tried before deferring the
24507 delivery. However, the logic cannot be quite that simple.
24508
24509 Firstly, IP addresses that are skipped because their retry times have not
24510 arrived do not count, and in addition, addresses that are past their retry
24511 limits are also not counted, even when they are tried. This means that when
24512 some IP addresses are past their retry limits, more than the value of
24513 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
24514 that all IP addresses are considered before timing out an email address (but
24515 see below for an exception).
24516
24517 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
24518 list to see if there is a subsequent host with a different (higher valued) MX.
24519 If there is, that host is considered next, and the current IP address is used
24520 but not counted. This behaviour helps in the case of a domain with a retry rule
24521 that hardly ever delays any hosts, as is now explained:
24522
24523 Consider the case of a long list of hosts with one MX value, and a few with a
24524 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
24525 hosts at the top of the list are tried at first. With the default retry rule,
24526 which specifies increasing retry times, the higher MX hosts are eventually
24527 tried when those at the top of the list are skipped because they have not
24528 reached their retry times.
24529
24530 However, it is common practice to put a fixed short retry time on domains for
24531 large ISPs, on the grounds that their servers are rarely down for very long.
24532 Unfortunately, these are exactly the domains that tend to resolve to long lists
24533 of hosts. The short retry time means that the lowest MX hosts are tried every
24534 time. The attempts may be in a different order because of random sorting, but
24535 without the special MX check, the higher MX hosts would never be tried until
24536 all the lower MX hosts had timed out (which might be several days), because
24537 there are always some lower MX hosts that have reached their retry times. With
24538 the special check, Exim considers at least one IP address from each MX value at
24539 every delivery attempt, even if the &%hosts_max_try%& limit has already been
24540 reached.
24541
24542 The above logic means that &%hosts_max_try%& is not a hard limit, and in
24543 particular, Exim normally eventually tries all the IP addresses before timing
24544 out an email address. When &%hosts_max_try%& was implemented, this seemed a
24545 reasonable thing to do. Recently, however, some lunatic DNS configurations have
24546 been set up with hundreds of IP addresses for some domains. It can
24547 take a very long time indeed for an address to time out in these cases.
24548
24549 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
24550 Exim never tries more than this number of IP addresses; if it hits this limit
24551 and they are all timed out, the email address is bounced, even though not all
24552 possible IP addresses have been tried.
24553 .ecindex IIDsmttra1
24554 .ecindex IIDsmttra2
24555
24556
24557
24558
24559
24560 . ////////////////////////////////////////////////////////////////////////////
24561 . ////////////////////////////////////////////////////////////////////////////
24562
24563 .chapter "Address rewriting" "CHAPrewrite"
24564 .scindex IIDaddrew "rewriting" "addresses"
24565 There are some circumstances in which Exim automatically rewrites domains in
24566 addresses. The two most common are when an address is given without a domain
24567 (referred to as an &"unqualified address"&) or when an address contains an
24568 abbreviated domain that is expanded by DNS lookup.
24569
24570 Unqualified envelope addresses are accepted only for locally submitted
24571 messages, or for messages that are received from hosts matching
24572 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
24573 appropriate. Unqualified addresses in header lines are qualified if they are in
24574 locally submitted messages, or messages from hosts that are permitted to send
24575 unqualified envelope addresses. Otherwise, unqualified addresses in header
24576 lines are neither qualified nor rewritten.
24577
24578 One situation in which Exim does &'not'& automatically rewrite a domain is
24579 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
24580 such a domain should be rewritten using the &"canonical"& name, and some MTAs
24581 do this. The new RFCs do not contain this suggestion.
24582
24583
24584 .section "Explicitly configured address rewriting" "SECID147"
24585 This chapter describes the rewriting rules that can be used in the
24586 main rewrite section of the configuration file, and also in the generic
24587 &%headers_rewrite%& option that can be set on any transport.
24588
24589 Some people believe that configured address rewriting is a Mortal Sin.
24590 Others believe that life is not possible without it. Exim provides the
24591 facility; you do not have to use it.
24592
24593 The main rewriting rules that appear in the &"rewrite"& section of the
24594 configuration file are applied to addresses in incoming messages, both envelope
24595 addresses and addresses in header lines. Each rule specifies the types of
24596 address to which it applies.
24597
24598 Whether or not addresses in header lines are rewritten depends on the origin of
24599 the headers and the type of rewriting. Global rewriting, that is, rewriting
24600 rules from the rewrite section of the configuration file, is applied only to
24601 those headers that were received with the message. Header lines that are added
24602 by ACLs or by a system filter or by individual routers or transports (which
24603 are specific to individual recipient addresses) are not rewritten by the global
24604 rules.
24605
24606 Rewriting at transport time, by means of the &%headers_rewrite%& option,
24607 applies all headers except those added by routers and transports. That is, as
24608 well as the headers that were received with the message, it also applies to
24609 headers that were added by an ACL or a system filter.
24610
24611
24612 In general, rewriting addresses from your own system or domain has some
24613 legitimacy. Rewriting other addresses should be done only with great care and
24614 in special circumstances. The author of Exim believes that rewriting should be
24615 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
24616 Although it can sometimes be used as a routing tool, this is very strongly
24617 discouraged.
24618
24619 There are two commonly encountered circumstances where rewriting is used, as
24620 illustrated by these examples:
24621
24622 .ilist
24623 The company whose domain is &'hitch.fict.example'& has a number of hosts that
24624 exchange mail with each other behind a firewall, but there is only a single
24625 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
24626 &'hitch.fict.example'& when sending mail off-site.
24627 .next
24628 A host rewrites the local parts of its own users so that, for example,
24629 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
24630 .endlist
24631
24632
24633
24634 .section "When does rewriting happen?" "SECID148"
24635 .cindex "rewriting" "timing of"
24636 .cindex "&ACL;" "rewriting addresses in"
24637 Configured address rewriting can take place at several different stages of a
24638 message's processing.
24639
24640 .vindex "&$sender_address$&"
24641 At the start of an ACL for MAIL, the sender address may have been rewritten
24642 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
24643 ordinary rewrite rules have yet been applied. If, however, the sender address
24644 is verified in the ACL, it is rewritten before verification, and remains
24645 rewritten thereafter. The subsequent value of &$sender_address$& is the
24646 rewritten address. This also applies if sender verification happens in a
24647 RCPT ACL. Otherwise, when the sender address is not verified, it is
24648 rewritten as soon as a message's header lines have been received.
24649
24650 .vindex "&$domain$&"
24651 .vindex "&$local_part$&"
24652 Similarly, at the start of an ACL for RCPT, the current recipient's address
24653 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
24654 rewrite rules have yet been applied to it. However, the behaviour is different
24655 from the sender address when a recipient is verified. The address is rewritten
24656 for the verification, but the rewriting is not remembered at this stage. The
24657 value of &$local_part$& and &$domain$& after verification are always the same
24658 as they were before (that is, they contain the unrewritten &-- except for
24659 SMTP-time rewriting &-- address).
24660
24661 As soon as a message's header lines have been received, all the envelope
24662 recipient addresses are permanently rewritten, and rewriting is also applied to
24663 the addresses in the header lines (if configured). This happens before adding
24664 any header lines that were specified in MAIL or RCPT ACLs, and
24665 .cindex "&[local_scan()]& function" "address rewriting; timing of"
24666 before the DATA ACL and &[local_scan()]& functions are run.
24667
24668 When an address is being routed, either for delivery or for verification,
24669 rewriting is applied immediately to child addresses that are generated by
24670 redirection, unless &%no_rewrite%& is set on the router.
24671
24672 .cindex "envelope sender" "rewriting at transport time"
24673 .cindex "rewriting" "at transport time"
24674 .cindex "header lines" "rewriting at transport time"
24675 At transport time, additional rewriting of addresses in header lines can be
24676 specified by setting the generic &%headers_rewrite%& option on a transport.
24677 This option contains rules that are identical in form to those in the rewrite
24678 section of the configuration file. They are applied to the original message
24679 header lines and any that were added by ACLs or a system filter. They are not
24680 applied to header lines that are added by routers or the transport.
24681
24682 The outgoing envelope sender can be rewritten by means of the &%return_path%&
24683 transport option. However, it is not possible to rewrite envelope recipients at
24684 transport time.
24685
24686
24687
24688
24689 .section "Testing the rewriting rules that apply on input" "SECID149"
24690 .cindex "rewriting" "testing"
24691 .cindex "testing" "rewriting"
24692 Exim's input rewriting configuration appears in a part of the run time
24693 configuration file headed by &"begin rewrite"&. It can be tested by the
24694 &%-brw%& command line option. This takes an address (which can be a full RFC
24695 2822 address) as its argument. The output is a list of how the address would be
24696 transformed by the rewriting rules for each of the different places it might
24697 appear in an incoming message, that is, for each different header and for the
24698 envelope sender and recipient fields. For example,
24699 .code
24700 exim -brw ph10@exim.workshop.example
24701 .endd
24702 might produce the output
24703 .code
24704 sender: Philip.Hazel@exim.workshop.example
24705 from: Philip.Hazel@exim.workshop.example
24706 to: ph10@exim.workshop.example
24707 cc: ph10@exim.workshop.example
24708 bcc: ph10@exim.workshop.example
24709 reply-to: Philip.Hazel@exim.workshop.example
24710 env-from: Philip.Hazel@exim.workshop.example
24711 env-to: ph10@exim.workshop.example
24712 .endd
24713 which shows that rewriting has been set up for that address when used in any of
24714 the source fields, but not when it appears as a recipient address. At the
24715 present time, there is no equivalent way of testing rewriting rules that are
24716 set for a particular transport.
24717
24718
24719 .section "Rewriting rules" "SECID150"
24720 .cindex "rewriting" "rules"
24721 The rewrite section of the configuration file consists of lines of rewriting
24722 rules in the form
24723 .display
24724 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
24725 .endd
24726 Rewriting rules that are specified for the &%headers_rewrite%& generic
24727 transport option are given as a colon-separated list. Each item in the list
24728 takes the same form as a line in the main rewriting configuration (except that
24729 any colons must be doubled, of course).
24730
24731 The formats of source patterns and replacement strings are described below.
24732 Each is terminated by white space, unless enclosed in double quotes, in which
24733 case normal quoting conventions apply inside the quotes. The flags are single
24734 characters which may appear in any order. Spaces and tabs between them are
24735 ignored.
24736
24737 For each address that could potentially be rewritten, the rules are scanned in
24738 order, and replacements for the address from earlier rules can themselves be
24739 replaced by later rules (but see the &"q"& and &"R"& flags).
24740
24741 The order in which addresses are rewritten is undefined, may change between
24742 releases, and must not be relied on, with one exception: when a message is
24743 received, the envelope sender is always rewritten first, before any header
24744 lines are rewritten. For example, the replacement string for a rewrite of an
24745 address in &'To:'& must not assume that the message's address in &'From:'& has
24746 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
24747 that the envelope sender has already been rewritten.
24748
24749 .vindex "&$domain$&"
24750 .vindex "&$local_part$&"
24751 The variables &$local_part$& and &$domain$& can be used in the replacement
24752 string to refer to the address that is being rewritten. Note that lookup-driven
24753 rewriting can be done by a rule of the form
24754 .code
24755 *@*   ${lookup ...
24756 .endd
24757 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
24758 refer to the address that is being rewritten.
24759
24760
24761 .section "Rewriting patterns" "SECID151"
24762 .cindex "rewriting" "patterns"
24763 .cindex "address list" "in a rewriting pattern"
24764 The source pattern in a rewriting rule is any item which may appear in an
24765 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
24766 single-item address list, which means that it is expanded before being tested
24767 against the address. As always, if you use a regular expression as a pattern,
24768 you must take care to escape dollar and backslash characters, or use the &`\N`&
24769 facility to suppress string expansion within the regular expression.
24770
24771 Domains in patterns should be given in lower case. Local parts in patterns are
24772 case-sensitive. If you want to do case-insensitive matching of local parts, you
24773 can use a regular expression that starts with &`^(?i)`&.
24774
24775 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
24776 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
24777 depending on the type of match which occurred. These can be used in the
24778 replacement string to insert portions of the incoming address. &$0$& always
24779 refers to the complete incoming address. When a regular expression is used, the
24780 numerical variables are set from its capturing subexpressions. For other types
24781 of pattern they are set as follows:
24782
24783 .ilist
24784 If a local part or domain starts with an asterisk, the numerical variables
24785 refer to the character strings matched by asterisks, with &$1$& associated with
24786 the first asterisk, and &$2$& with the second, if present. For example, if the
24787 pattern
24788 .code
24789 *queen@*.fict.example
24790 .endd
24791 is matched against the address &'hearts-queen@wonderland.fict.example'& then
24792 .code
24793 $0 = hearts-queen@wonderland.fict.example
24794 $1 = hearts-
24795 $2 = wonderland
24796 .endd
24797 Note that if the local part does not start with an asterisk, but the domain
24798 does, it is &$1$& that contains the wild part of the domain.
24799
24800 .next
24801 If the domain part of the pattern is a partial lookup, the wild and fixed parts
24802 of the domain are placed in the next available numerical variables. Suppose,
24803 for example, that the address &'foo@bar.baz.example'& is processed by a
24804 rewriting rule of the form
24805 .display
24806 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
24807 .endd
24808 and the key in the file that matches the domain is &`*.baz.example`&. Then
24809 .code
24810 $1 = foo
24811 $2 = bar
24812 $3 = baz.example
24813 .endd
24814 If the address &'foo@baz.example'& is looked up, this matches the same
24815 wildcard file entry, and in this case &$2$& is set to the empty string, but
24816 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
24817 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
24818 whole domain. For non-partial domain lookups, no numerical variables are set.
24819 .endlist
24820
24821
24822 .section "Rewriting replacements" "SECID152"
24823 .cindex "rewriting" "replacements"
24824 If the replacement string for a rule is a single asterisk, addresses that
24825 match the pattern and the flags are &'not'& rewritten, and no subsequent
24826 rewriting rules are scanned. For example,
24827 .code
24828 hatta@lookingglass.fict.example  *  f
24829 .endd
24830 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
24831 &'From:'& headers.
24832
24833 .vindex "&$domain$&"
24834 .vindex "&$local_part$&"
24835 If the replacement string is not a single asterisk, it is expanded, and must
24836 yield a fully qualified address. Within the expansion, the variables
24837 &$local_part$& and &$domain$& refer to the address that is being rewritten.
24838 Any letters they contain retain their original case &-- they are not lower
24839 cased. The numerical variables are set up according to the type of pattern that
24840 matched the address, as described above. If the expansion is forced to fail by
24841 the presence of &"fail"& in a conditional or lookup item, rewriting by the
24842 current rule is abandoned, but subsequent rules may take effect. Any other
24843 expansion failure causes the entire rewriting operation to be abandoned, and an
24844 entry written to the panic log.
24845
24846
24847
24848 .section "Rewriting flags" "SECID153"
24849 There are three different kinds of flag that may appear on rewriting rules:
24850
24851 .ilist
24852 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
24853 c, f, h, r, s, t.
24854 .next
24855 A flag that specifies rewriting at SMTP time: S.
24856 .next
24857 Flags that control the rewriting process: Q, q, R, w.
24858 .endlist
24859
24860 For rules that are part of the &%headers_rewrite%& generic transport option,
24861 E, F, T, and S are not permitted.
24862
24863
24864
24865 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
24866          "SECID154"
24867 .cindex "rewriting" "flags"
24868 If none of the following flag letters, nor the &"S"& flag (see section
24869 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
24870 and to both the sender and recipient fields of the envelope, whereas a
24871 transport-time rewriting rule just applies to all headers. Otherwise, the
24872 rewriting rule is skipped unless the relevant addresses are being processed.
24873 .display
24874 &`E`&       rewrite all envelope fields
24875 &`F`&       rewrite the envelope From field
24876 &`T`&       rewrite the envelope To field
24877 &`b`&       rewrite the &'Bcc:'& header
24878 &`c`&       rewrite the &'Cc:'& header
24879 &`f`&       rewrite the &'From:'& header
24880 &`h`&       rewrite all headers
24881 &`r`&       rewrite the &'Reply-To:'& header
24882 &`s`&       rewrite the &'Sender:'& header
24883 &`t`&       rewrite the &'To:'& header
24884 .endd
24885 "All headers" means all of the headers listed above that can be selected
24886 individually, plus their &'Resent-'& versions. It does not include
24887 other headers such as &'Subject:'& etc.
24888
24889 You should be particularly careful about rewriting &'Sender:'& headers, and
24890 restrict this to special known cases in your own domains.
24891
24892
24893 .section "The SMTP-time rewriting flag" "SECTrewriteS"
24894 .cindex "SMTP" "rewriting malformed addresses"
24895 .cindex "RCPT" "rewriting argument of"
24896 .cindex "MAIL" "rewriting argument of"
24897 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
24898 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
24899 before any other processing; even before syntax checking. The pattern is
24900 required to be a regular expression, and it is matched against the whole of the
24901 data for the command, including any surrounding angle brackets.
24902
24903 .vindex "&$domain$&"
24904 .vindex "&$local_part$&"
24905 This form of rewrite rule allows for the handling of addresses that are not
24906 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
24907 input). Because the input is not required to be a syntactically valid address,
24908 the variables &$local_part$& and &$domain$& are not available during the
24909 expansion of the replacement string. The result of rewriting replaces the
24910 original address in the MAIL or RCPT command.
24911
24912
24913 .section "Flags controlling the rewriting process" "SECID155"
24914 There are four flags which control the way the rewriting process works. These
24915 take effect only when a rule is invoked, that is, when the address is of the
24916 correct type (matches the flags) and matches the pattern:
24917
24918 .ilist
24919 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
24920 unqualified local part. It is qualified with &%qualify_recipient%&. In the
24921 absence of &"Q"& the rewritten address must always include a domain.
24922 .next
24923 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
24924 even if no rewriting actually takes place because of a &"fail"& in the
24925 expansion. The &"q"& flag is not effective if the address is of the wrong type
24926 (does not match the flags) or does not match the pattern.
24927 .next
24928 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
24929 address, up to ten times. It can be combined with the &"q"& flag, to stop
24930 rewriting once it fails to match (after at least one successful rewrite).
24931 .next
24932 .cindex "rewriting" "whole addresses"
24933 When an address in a header is rewritten, the rewriting normally applies only
24934 to the working part of the address, with any comments and RFC 2822 &"phrase"&
24935 left unchanged. For example, rewriting might change
24936 .code
24937 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
24938 .endd
24939 into
24940 .code
24941 From: Ford Prefect <prefectf@hitch.fict.example>
24942 .endd
24943 .cindex "RFC 2047"
24944 Sometimes there is a need to replace the whole address item, and this can be
24945 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
24946 causes an address in a header line to be rewritten, the entire address is
24947 replaced, not just the working part. The replacement must be a complete RFC
24948 2822 address, including the angle brackets if necessary. If text outside angle
24949 brackets contains a character whose value is greater than 126 or less than 32
24950 (except for tab), the text is encoded according to RFC 2047. The character set
24951 is taken from &%headers_charset%&, which gets its default at build time.
24952
24953 When the &"w"& flag is set on a rule that causes an envelope address to be
24954 rewritten, all but the working part of the replacement address is discarded.
24955 .endlist
24956
24957
24958 .section "Rewriting examples" "SECID156"
24959 Here is an example of the two common rewriting paradigms:
24960 .code
24961 *@*.hitch.fict.example  $1@hitch.fict.example
24962 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
24963                      {$value}fail}@hitch.fict.example bctfrF
24964 .endd
24965 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
24966 the string expansion to fail if the lookup does not succeed. In this context it
24967 has the effect of leaving the original address unchanged, but Exim goes on to
24968 consider subsequent rewriting rules, if any, because the &"q"& flag is not
24969 present in that rule. An alternative to &"fail"& would be to supply &$1$&
24970 explicitly, which would cause the rewritten address to be the same as before,
24971 at the cost of a small bit of processing. Not supplying either of these is an
24972 error, since the rewritten address would then contain no local part.
24973
24974 The first example above replaces the domain with a superior, more general
24975 domain. This may not be desirable for certain local parts. If the rule
24976 .code
24977 root@*.hitch.fict.example  *
24978 .endd
24979 were inserted before the first rule, rewriting would be suppressed for the
24980 local part &'root'& at any domain ending in &'hitch.fict.example'&.
24981
24982 Rewriting can be made conditional on a number of tests, by making use of
24983 &${if$& in the expansion item. For example, to apply a rewriting rule only to
24984 messages that originate outside the local host:
24985 .code
24986 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
24987                          {$1@hitch.fict.example}fail}"
24988 .endd
24989 The replacement string is quoted in this example because it contains white
24990 space.
24991
24992 .cindex "rewriting" "bang paths"
24993 .cindex "bang paths" "rewriting"
24994 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
24995 an address it treats it as an unqualified local part which it qualifies with
24996 the local qualification domain (if the source of the message is local or if the
24997 remote host is permitted to send unqualified addresses). Rewriting can
24998 sometimes be used to handle simple bang paths with a fixed number of
24999 components. For example, the rule
25000 .code
25001 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25002 .endd
25003 rewrites a two-component bang path &'host.name!user'& as the domain address
25004 &'user@host.name'&. However, there is a security implication in using this as
25005 a global rewriting rule for envelope addresses. It can provide a backdoor
25006 method for using your system as a relay, because the incoming addresses appear
25007 to be local. If the bang path addresses are received via SMTP, it is safer to
25008 use the &"S"& flag to rewrite them as they are received, so that relay checking
25009 can be done on the rewritten addresses.
25010 .ecindex IIDaddrew
25011
25012
25013
25014
25015
25016 . ////////////////////////////////////////////////////////////////////////////
25017 . ////////////////////////////////////////////////////////////////////////////
25018
25019 .chapter "Retry configuration" "CHAPretry"
25020 .scindex IIDretconf1 "retry" "configuration, description of"
25021 .scindex IIDregconf2 "configuration file" "retry section"
25022 The &"retry"& section of the runtime configuration file contains a list of
25023 retry rules that control how often Exim tries to deliver messages that cannot
25024 be delivered at the first attempt. If there are no retry rules (the section is
25025 empty or not present), there are no retries. In this situation, temporary
25026 errors are treated as permanent. The default configuration contains a single,
25027 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25028 line option can be used to test which retry rule will be used for a given
25029 address, domain and error.
25030
25031 The most common cause of retries is temporary failure to deliver to a remote
25032 host because the host is down, or inaccessible because of a network problem.
25033 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25034 address) basis, not on a per-message basis. Thus, if one message has recently
25035 been delayed, delivery of a new message to the same host is not immediately
25036 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25037 log selector is set, the message
25038 .cindex "retry" "time not reached"
25039 &"retry time not reached"& is written to the main log whenever a delivery is
25040 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25041 the handling of errors during remote deliveries.
25042
25043 Retry processing applies to routing as well as to delivering, except as covered
25044 in the next paragraph. The retry rules do not distinguish between these
25045 actions. It is not possible, for example, to specify different behaviour for
25046 failures to route the domain &'snark.fict.example'& and failures to deliver to
25047 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25048 added complication, so did not implement it. However, although they share the
25049 same retry rule, the actual retry times for routing and transporting a given
25050 domain are maintained independently.
25051
25052 When a delivery is not part of a queue run (typically an immediate delivery on
25053 receipt of a message), the routers are always run, and local deliveries are
25054 always attempted, even if retry times are set for them. This makes for better
25055 behaviour if one particular message is causing problems (for example, causing
25056 quota overflow, or provoking an error in a filter file). If such a delivery
25057 suffers a temporary failure, the retry data is updated as normal, and
25058 subsequent delivery attempts from queue runs occur only when the retry time for
25059 the local address is reached.
25060
25061 .section "Changing retry rules" "SECID157"
25062 If you change the retry rules in your configuration, you should consider
25063 whether or not to delete the retry data that is stored in Exim's spool area in
25064 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25065 always safe; that is why they are called &"hints"&.
25066
25067 The hints retry data contains suggested retry times based on the previous
25068 rules. In the case of a long-running problem with a remote host, it might
25069 record the fact that the host has timed out. If your new rules increase the
25070 timeout time for such a host, you should definitely remove the old retry data
25071 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25072 messages that it should now be retaining.
25073
25074
25075
25076 .section "Format of retry rules" "SECID158"
25077 .cindex "retry" "rules"
25078 Each retry rule occupies one line and consists of three or four parts,
25079 separated by white space: a pattern, an error name, an optional list of sender
25080 addresses, and a list of retry parameters. The pattern and sender lists must be
25081 enclosed in double quotes if they contain white space. The rules are searched
25082 in order until one is found where the pattern, error name, and sender list (if
25083 present) match the failing host or address, the error that occurred, and the
25084 message's sender, respectively.
25085
25086
25087 The pattern is any single item that may appear in an address list (see section
25088 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25089 which means that it is expanded before being tested against the address that
25090 has been delayed. A negated address list item is permitted. Address
25091 list processing treats a plain domain name as if it were preceded by &"*@"&,
25092 which makes it possible for many retry rules to start with just a domain. For
25093 example,
25094 .code
25095 lookingglass.fict.example        *  F,24h,30m;
25096 .endd
25097 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25098 whereas
25099 .code
25100 alice@lookingglass.fict.example  *  F,24h,30m;
25101 .endd
25102 applies only to temporary failures involving the local part &%alice%&.
25103 In practice, almost all rules start with a domain name pattern without a local
25104 part.
25105
25106 .cindex "regular expressions" "in retry rules"
25107 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25108 must match a complete address, not just a domain, because that is how regular
25109 expressions work in address lists.
25110 .display
25111 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25112 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25113 .endd
25114
25115
25116 .section "Choosing which retry rule to use for address errors" "SECID159"
25117 When Exim is looking for a retry rule after a routing attempt has failed (for
25118 example, after a DNS timeout), each line in the retry configuration is tested
25119 against the complete address only if &%retry_use_local_part%& is set for the
25120 router. Otherwise, only the domain is used, except when matching against a
25121 regular expression, when the local part of the address is replaced with &"*"&.
25122 A domain on its own can match a domain pattern, or a pattern that starts with
25123 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25124 &%check_local_user%& is true, and false for other routers.
25125
25126 Similarly, when Exim is looking for a retry rule after a local delivery has
25127 failed (for example, after a mailbox full error), each line in the retry
25128 configuration is tested against the complete address only if
25129 &%retry_use_local_part%& is set for the transport (it defaults true for all
25130 local transports).
25131
25132 .cindex "4&'xx'& responses" "retry rules for"
25133 However, when Exim is looking for a retry rule after a remote delivery attempt
25134 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25135 whole address is always used as the key when searching the retry rules. The
25136 rule that is found is used to create a retry time for the combination of the
25137 failing address and the message's sender. It is the combination of sender and
25138 recipient that is delayed in subsequent queue runs until its retry time is
25139 reached. You can delay the recipient without regard to the sender by setting
25140 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25141 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25142 commands.
25143
25144
25145
25146 .section "Choosing which retry rule to use for host and message errors" &&&
25147          "SECID160"
25148 For a temporary error that is not related to an individual address (for
25149 example, a connection timeout), each line in the retry configuration is checked
25150 twice. First, the name of the remote host is used as a domain name (preceded by
25151 &"*@"& when matching a regular expression). If this does not match the line,
25152 the domain from the email address is tried in a similar fashion. For example,
25153 suppose the MX records for &'a.b.c.example'& are
25154 .code
25155 a.b.c.example  MX  5  x.y.z.example
25156                MX  6  p.q.r.example
25157                MX  7  m.n.o.example
25158 .endd
25159 and the retry rules are
25160 .code
25161 p.q.r.example    *      F,24h,30m;
25162 a.b.c.example    *      F,4d,45m;
25163 .endd
25164 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25165 first rule matches neither the host nor the domain, so Exim looks at the second
25166 rule. This does not match the host, but it does match the domain, so it is used
25167 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25168 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25169 first retry rule is used, because it matches the host.
25170
25171 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25172 first rule to determine retry times, but for all the other hosts for the domain
25173 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25174 routing to &'a.b.c.example'& suffers a temporary failure.
25175
25176 &*Note*&: The host name is used when matching the patterns, not its IP address.
25177 However, if a message is routed directly to an IP address without the use of a
25178 host name, for example, if a &(manualroute)& router contains a setting such as:
25179 .code
25180 route_list = *.a.example  192.168.34.23
25181 .endd
25182 then the &"host name"& that is used when searching for a retry rule is the
25183 textual form of the IP address.
25184
25185 .section "Retry rules for specific errors" "SECID161"
25186 .cindex "retry" "specific errors; specifying"
25187 The second field in a retry rule is the name of a particular error, or an
25188 asterisk, which matches any error. The errors that can be tested for are:
25189
25190 .vlist
25191 .vitem &%auth_failed%&
25192 Authentication failed when trying to send to a host in the
25193 &%hosts_require_auth%& list in an &(smtp)& transport.
25194
25195 .vitem &%data_4xx%&
25196 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25197 after the command, or after sending the message's data.
25198
25199 .vitem &%mail_4xx%&
25200 A 4&'xx'& error was received for an outgoing MAIL command.
25201
25202 .vitem &%rcpt_4xx%&
25203 A 4&'xx'& error was received for an outgoing RCPT command.
25204 .endlist
25205
25206 For the three 4&'xx'& errors, either the first or both of the x's can be given
25207 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25208 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25209 and have retries every ten minutes with a one-hour timeout, you could set up a
25210 retry rule of this form:
25211 .code
25212 the.domain.name  rcpt_452   F,1h,10m
25213 .endd
25214 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25215 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25216
25217 .vlist
25218 .vitem &%lost_connection%&
25219 A server unexpectedly closed the SMTP connection. There may, of course,
25220 legitimate reasons for this (host died, network died), but if it repeats a lot
25221 for the same host, it indicates something odd.
25222
25223 .vitem &%lookup%&
25224 A DNS lookup for a host failed.
25225 Note that a &%dnslookup%& router will need to have matched
25226 its &%fail_defer_domains%& option for this retry type to be usable.
25227 Also note that a &%manualroute%& router will probably need
25228 its &%host_find_failed%& option set to &%defer%&.
25229
25230 .vitem &%refused_MX%&
25231 A connection to a host obtained from an MX record was refused.
25232
25233 .vitem &%refused_A%&
25234 A connection to a host not obtained from an MX record was refused.
25235
25236 .vitem &%refused%&
25237 A connection was refused.
25238
25239 .vitem &%timeout_connect_MX%&
25240 A connection attempt to a host obtained from an MX record timed out.
25241
25242 .vitem &%timeout_connect_A%&
25243 A connection attempt to a host not obtained from an MX record timed out.
25244
25245 .vitem &%timeout_connect%&
25246 A connection attempt timed out.
25247
25248 .vitem &%timeout_MX%&
25249 There was a timeout while connecting or during an SMTP session with a host
25250 obtained from an MX record.
25251
25252 .vitem &%timeout_A%&
25253 There was a timeout while connecting or during an SMTP session with a host not
25254 obtained from an MX record.
25255
25256 .vitem &%timeout%&
25257 There was a timeout while connecting or during an SMTP session.
25258
25259 .vitem &%tls_required%&
25260 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25261 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25262 to STARTTLS, or there was a problem setting up the TLS connection.
25263
25264 .vitem &%quota%&
25265 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25266 transport.
25267
25268 .vitem &%quota_%&<&'time'&>
25269 .cindex "quota" "error testing in retry rule"
25270 .cindex "retry" "quota error testing"
25271 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25272 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25273 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25274 for four days.
25275 .endlist
25276
25277 .cindex "mailbox" "time of last read"
25278 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25279 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25280 it should be based on the last time that the user accessed the mailbox.
25281 However, it is not always possible to determine this. Exim uses the following
25282 heuristic rules:
25283
25284 .ilist
25285 If the mailbox is a single file, the time of last access (the &"atime"&) is
25286 used. As no new messages are being delivered (because the mailbox is over
25287 quota), Exim does not access the file, so this is the time of last user access.
25288 .next
25289 .cindex "maildir format" "time of last read"
25290 For a maildir delivery, the time of last modification of the &_new_&
25291 subdirectory is used. As the mailbox is over quota, no new files are created in
25292 the &_new_& subdirectory, because no new messages are being delivered. Any
25293 change to the &_new_& subdirectory is therefore assumed to be the result of an
25294 MUA moving a new message to the &_cur_& directory when it is first read. The
25295 time that is used is therefore the last time that the user read a new message.
25296 .next
25297 For other kinds of multi-file mailbox, the time of last access cannot be
25298 obtained, so a retry rule that uses this type of error field is never matched.
25299 .endlist
25300
25301 The quota errors apply both to system-enforced quotas and to Exim's own quota
25302 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25303 when a local delivery is deferred because a partition is full (the ENOSPC
25304 error).
25305
25306
25307
25308 .section "Retry rules for specified senders" "SECID162"
25309 .cindex "retry" "rules; sender-specific"
25310 You can specify retry rules that apply only when the failing message has a
25311 specific sender. In particular, this can be used to define retry rules that
25312 apply only to bounce messages. The third item in a retry rule can be of this
25313 form:
25314 .display
25315 &`senders=`&<&'address list'&>
25316 .endd
25317 The retry timings themselves are then the fourth item. For example:
25318 .code
25319 *   rcpt_4xx   senders=:   F,1h,30m
25320 .endd
25321 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25322 host. If the address list contains white space, it must be enclosed in quotes.
25323 For example:
25324 .code
25325 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25326 .endd
25327 &*Warning*&: This facility can be unhelpful if it is used for host errors
25328 (which do not depend on the recipient). The reason is that the sender is used
25329 only to match the retry rule. Once the rule has been found for a host error,
25330 its contents are used to set a retry time for the host, and this will apply to
25331 all messages, not just those with specific senders.
25332
25333 When testing retry rules using &%-brt%&, you can supply a sender using the
25334 &%-f%& command line option, like this:
25335 .code
25336 exim -f "" -brt user@dom.ain
25337 .endd
25338 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25339 list is never matched.
25340
25341
25342
25343
25344
25345 .section "Retry parameters" "SECID163"
25346 .cindex "retry" "parameters in rules"
25347 The third (or fourth, if a senders list is present) field in a retry rule is a
25348 sequence of retry parameter sets, separated by semicolons. Each set consists of
25349 .display
25350 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25351 .endd
25352 The letter identifies the algorithm for computing a new retry time; the cutoff
25353 time is the time beyond which this algorithm no longer applies, and the
25354 arguments vary the algorithm's action. The cutoff time is measured from the
25355 time that the first failure for the domain (combined with the local part if
25356 relevant) was detected, not from the time the message was received.
25357
25358 .cindex "retry" "algorithms"
25359 .cindex "retry" "fixed intervals"
25360 .cindex "retry" "increasing intervals"
25361 .cindex "retry" "random intervals"
25362 The available algorithms are:
25363
25364 .ilist
25365 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25366 the interval.
25367 .next
25368 &'G'&: retry at geometrically increasing intervals. The first argument
25369 specifies a starting value for the interval, and the second a multiplier, which
25370 is used to increase the size of the interval at each retry.
25371 .next
25372 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25373 retry, the previous interval is multiplied by the factor in order to get a
25374 maximum for the next interval. The minimum interval is the first argument of
25375 the parameter, and an actual interval is chosen randomly between them. Such a
25376 rule has been found to be helpful in cluster configurations when all the
25377 members of the cluster restart at once, and may therefore synchronize their
25378 queue processing times.
25379 .endlist
25380
25381 When computing the next retry time, the algorithm definitions are scanned in
25382 order until one whose cutoff time has not yet passed is reached. This is then
25383 used to compute a new retry time that is later than the current time. In the
25384 case of fixed interval retries, this simply means adding the interval to the
25385 current time. For geometrically increasing intervals, retry intervals are
25386 computed from the rule's parameters until one that is greater than the previous
25387 interval is found. The main configuration variable
25388 .cindex "limit" "retry interval"
25389 .cindex "retry" "interval, maximum"
25390 .oindex "&%retry_interval_max%&"
25391 &%retry_interval_max%& limits the maximum interval between retries. It
25392 cannot be set greater than &`24h`&, which is its default value.
25393
25394 A single remote domain may have a number of hosts associated with it, and each
25395 host may have more than one IP address. Retry algorithms are selected on the
25396 basis of the domain name, but are applied to each IP address independently. If,
25397 for example, a host has two IP addresses and one is unusable, Exim will
25398 generate retry times for it and will not try to use it until its next retry
25399 time comes. Thus the good IP address is likely to be tried first most of the
25400 time.
25401
25402 .cindex "hints database" "use for retrying"
25403 Retry times are hints rather than promises. Exim does not make any attempt to
25404 run deliveries exactly at the computed times. Instead, a queue runner process
25405 starts delivery processes for delayed messages periodically, and these attempt
25406 new deliveries only for those addresses that have passed their next retry time.
25407 If a new message arrives for a deferred address, an immediate delivery attempt
25408 occurs only if the address has passed its retry time. In the absence of new
25409 messages, the minimum time between retries is the interval between queue runner
25410 processes. There is not much point in setting retry times of five minutes if
25411 your queue runners happen only once an hour, unless there are a significant
25412 number of incoming messages (which might be the case on a system that is
25413 sending everything to a smart host, for example).
25414
25415 The data in the retry hints database can be inspected by using the
25416 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25417 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25418 &'exinext'& utility script can be used to find out what the next retry times
25419 are for the hosts associated with a particular mail domain, and also for local
25420 deliveries that have been deferred.
25421
25422
25423 .section "Retry rule examples" "SECID164"
25424 Here are some example retry rules:
25425 .code
25426 alice@wonderland.fict.example quota_5d  F,7d,3h
25427 wonderland.fict.example       quota_5d
25428 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25429 lookingglass.fict.example     *         F,24h,30m;
25430 *                 refused_A   F,2h,20m;
25431 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25432 .endd
25433 The first rule sets up special handling for mail to
25434 &'alice@wonderland.fict.example'& when there is an over-quota error and the
25435 mailbox has not been read for at least 5 days. Retries continue every three
25436 hours for 7 days. The second rule handles over-quota errors for all other local
25437 parts at &'wonderland.fict.example'&; the absence of a local part has the same
25438 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
25439 fail are bounced immediately if the mailbox has not been read for at least 5
25440 days.
25441
25442 The third rule handles all other errors at &'wonderland.fict.example'&; retries
25443 happen every 15 minutes for an hour, then with geometrically increasing
25444 intervals until two days have passed since a delivery first failed. After the
25445 first hour there is a delay of one hour, then two hours, then four hours, and
25446 so on (this is a rather extreme example).
25447
25448 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
25449 They happen every 30 minutes for 24 hours only. The remaining two rules handle
25450 all other domains, with special action for connection refusal from hosts that
25451 were not obtained from an MX record.
25452
25453 The final rule in a retry configuration should always have asterisks in the
25454 first two fields so as to provide a general catch-all for any addresses that do
25455 not have their own special handling. This example tries every 15 minutes for 2
25456 hours, then with intervals starting at one hour and increasing by a factor of
25457 1.5 up to 16 hours, then every 8 hours up to 5 days.
25458
25459
25460
25461 .section "Timeout of retry data" "SECID165"
25462 .cindex "timeout" "of retry data"
25463 .oindex "&%retry_data_expire%&"
25464 .cindex "hints database" "data expiry"
25465 .cindex "retry" "timeout of data"
25466 Exim timestamps the data that it writes to its retry hints database. When it
25467 consults the data during a delivery it ignores any that is older than the value
25468 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
25469 been tried for 7 days, Exim will try to deliver to it immediately a message
25470 arrives, and if that fails, it will calculate a retry time as if it were
25471 failing for the first time.
25472
25473 This improves the behaviour for messages routed to rarely-used hosts such as MX
25474 backups. If such a host was down at one time, and happens to be down again when
25475 Exim tries a month later, using the old retry data would imply that it had been
25476 down all the time, which is not a justified assumption.
25477
25478 If a host really is permanently dead, this behaviour causes a burst of retries
25479 every now and again, but only if messages routed to it are rare. If there is a
25480 message at least once every 7 days the retry data never expires.
25481
25482
25483
25484
25485 .section "Long-term failures" "SECID166"
25486 .cindex "delivery failure, long-term"
25487 .cindex "retry" "after long-term failure"
25488 Special processing happens when an email address has been failing for so long
25489 that the cutoff time for the last algorithm is reached. For example, using the
25490 default retry rule:
25491 .code
25492 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
25493 .endd
25494 the cutoff time is four days. Reaching the retry cutoff is independent of how
25495 long any specific message has been failing; it is the length of continuous
25496 failure for the recipient address that counts.
25497
25498 When the cutoff time is reached for a local delivery, or for all the IP
25499 addresses associated with a remote delivery, a subsequent delivery failure
25500 causes Exim to give up on the address, and a bounce message is generated.
25501 In order to cater for new messages that use the failing address, a next retry
25502 time is still computed from the final algorithm, and is used as follows:
25503
25504 For local deliveries, one delivery attempt is always made for any subsequent
25505 messages. If this delivery fails, the address fails immediately. The
25506 post-cutoff retry time is not used.
25507
25508 If the delivery is remote, there are two possibilities, controlled by the
25509 .oindex "&%delay_after_cutoff%&"
25510 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
25511 default. Until the post-cutoff retry time for one of the IP addresses is
25512 reached, the failing email address is bounced immediately, without a delivery
25513 attempt taking place. After that time, one new delivery attempt is made to
25514 those IP addresses that are past their retry times, and if that still fails,
25515 the address is bounced and new retry times are computed.
25516
25517 In other words, when all the hosts for a given email address have been failing
25518 for a long time, Exim bounces rather then defers until one of the hosts' retry
25519 times is reached. Then it tries once, and bounces if that attempt fails. This
25520 behaviour ensures that few resources are wasted in repeatedly trying to deliver
25521 to a broken destination, but if the host does recover, Exim will eventually
25522 notice.
25523
25524 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25525 addresses are past their final cutoff time, Exim tries to deliver to those IP
25526 addresses that have not been tried since the message arrived. If there are
25527 no suitable IP addresses, or if they all fail, the address is bounced. In other
25528 words, it does not delay when a new message arrives, but tries the expired
25529 addresses immediately, unless they have been tried since the message arrived.
25530 If there is a continuous stream of messages for the failing domains, setting
25531 &%delay_after_cutoff%& false means that there will be many more attempts to
25532 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
25533 true.
25534
25535 .section "Deliveries that work intermittently" "SECID167"
25536 .cindex "retry" "intermittently working deliveries"
25537 Some additional logic is needed to cope with cases where a host is
25538 intermittently available, or when a message has some attribute that prevents
25539 its delivery when others to the same address get through. In this situation,
25540 because some messages are successfully delivered, the &"retry clock"& for the
25541 host or address keeps getting reset by the successful deliveries, and so
25542 failing messages remain on the queue for ever because the cutoff time is never
25543 reached.
25544
25545 Two exceptional actions are applied to prevent this happening. The first
25546 applies to errors that are related to a message rather than a remote host.
25547 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
25548 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
25549 commands, and quota failures. For this type of error, if a message's arrival
25550 time is earlier than the &"first failed"& time for the error, the earlier time
25551 is used when scanning the retry rules to decide when to try next and when to
25552 time out the address.
25553
25554 The exceptional second action applies in all cases. If a message has been on
25555 the queue for longer than the cutoff time of any applicable retry rule for a
25556 given address, a delivery is attempted for that address, even if it is not yet
25557 time, and if this delivery fails, the address is timed out. A new retry time is
25558 not computed in this case, so that other messages for the same address are
25559 considered immediately.
25560 .ecindex IIDretconf1
25561 .ecindex IIDregconf2
25562
25563
25564
25565
25566
25567
25568 . ////////////////////////////////////////////////////////////////////////////
25569 . ////////////////////////////////////////////////////////////////////////////
25570
25571 .chapter "SMTP authentication" "CHAPSMTPAUTH"
25572 .scindex IIDauthconf1 "SMTP" "authentication configuration"
25573 .scindex IIDauthconf2 "authentication"
25574 The &"authenticators"& section of Exim's run time configuration is concerned
25575 with SMTP authentication. This facility is an extension to the SMTP protocol,
25576 described in RFC 2554, which allows a client SMTP host to authenticate itself
25577 to a server. This is a common way for a server to recognize clients that are
25578 permitted to use it as a relay. SMTP authentication is not of relevance to the
25579 transfer of mail between servers that have no managerial connection with each
25580 other.
25581
25582 .cindex "AUTH" "description of"
25583 Very briefly, the way SMTP authentication works is as follows:
25584
25585 .ilist
25586 The server advertises a number of authentication &'mechanisms'& in response to
25587 the client's EHLO command.
25588 .next
25589 The client issues an AUTH command, naming a specific mechanism. The command
25590 may, optionally, contain some authentication data.
25591 .next
25592 The server may issue one or more &'challenges'&, to which the client must send
25593 appropriate responses. In simple authentication mechanisms, the challenges are
25594 just prompts for user names and passwords. The server does not have to issue
25595 any challenges &-- in some mechanisms the relevant data may all be transmitted
25596 with the AUTH command.
25597 .next
25598 The server either accepts or denies authentication.
25599 .next
25600 If authentication succeeds, the client may optionally make use of the AUTH
25601 option on the MAIL command to pass an authenticated sender in subsequent
25602 mail transactions. Authentication lasts for the remainder of the SMTP
25603 connection.
25604 .next
25605 If authentication fails, the client may give up, or it may try a different
25606 authentication mechanism, or it may try transferring mail over the
25607 unauthenticated connection.
25608 .endlist
25609
25610 If you are setting up a client, and want to know which authentication
25611 mechanisms the server supports, you can use Telnet to connect to port 25 (the
25612 SMTP port) on the server, and issue an EHLO command. The response to this
25613 includes the list of supported mechanisms. For example:
25614 .display
25615 &`$ `&&*&`telnet server.example 25`&*&
25616 &`Trying 192.168.34.25...`&
25617 &`Connected to server.example.`&
25618 &`Escape character is &#x0027;^]&#x0027;.`&
25619 &`220 server.example ESMTP Exim 4.20 ...`&
25620 &*&`ehlo client.example`&*&
25621 &`250-server.example Hello client.example [10.8.4.5]`&
25622 &`250-SIZE 52428800`&
25623 &`250-PIPELINING`&
25624 &`250-AUTH PLAIN`&
25625 &`250 HELP`&
25626 .endd
25627 The second-last line of this example output shows that the server supports
25628 authentication using the PLAIN mechanism. In Exim, the different authentication
25629 mechanisms are configured by specifying &'authenticator'& drivers. Like the
25630 routers and transports, which authenticators are included in the binary is
25631 controlled by build-time definitions. The following are currently available,
25632 included by setting
25633 .code
25634 AUTH_CRAM_MD5=yes
25635 AUTH_CYRUS_SASL=yes
25636 AUTH_DOVECOT=yes
25637 AUTH_GSASL=yes
25638 AUTH_HEIMDAL_GSSAPI=yes
25639 AUTH_PLAINTEXT=yes
25640 AUTH_SPA=yes
25641 AUTH_TLS=yes
25642 .endd
25643 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
25644 authentication mechanism (RFC 2195), and the second provides an interface to
25645 the Cyrus SASL authentication library.
25646 The third is an interface to Dovecot's authentication system, delegating the
25647 work via a socket interface.
25648 The fourth provides an interface to the GNU SASL authentication library, which
25649 provides mechanisms but typically not data sources.
25650 The fifth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
25651 supporting setting a server keytab.
25652 The sixth can be configured to support
25653 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
25654 not formally documented, but used by several MUAs. The seventh authenticator
25655 supports Microsoft's &'Secure Password Authentication'& mechanism.
25656 The eighth is an Exim authenticator but not an SMTP one;
25657 instead it can use information from a TLS negotiation.
25658
25659 The authenticators are configured using the same syntax as other drivers (see
25660 section &<<SECTfordricon>>&). If no authenticators are required, no
25661 authentication section need be present in the configuration file. Each
25662 authenticator can in principle have both server and client functions. When Exim
25663 is receiving SMTP mail, it is acting as a server; when it is sending out
25664 messages over SMTP, it is acting as a client. Authenticator configuration
25665 options are provided for use in both these circumstances.
25666
25667 To make it clear which options apply to which situation, the prefixes
25668 &%server_%& and &%client_%& are used on option names that are specific to
25669 either the server or the client function, respectively. Server and client
25670 functions are disabled if none of their options are set. If an authenticator is
25671 to be used for both server and client functions, a single definition, using
25672 both sets of options, is required. For example:
25673 .code
25674 cram:
25675   driver = cram_md5
25676   public_name = CRAM-MD5
25677   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
25678   client_name = ph10
25679   client_secret = secret2
25680 .endd
25681 The &%server_%& option is used when Exim is acting as a server, and the
25682 &%client_%& options when it is acting as a client.
25683
25684 Descriptions of the individual authenticators are given in subsequent chapters.
25685 The remainder of this chapter covers the generic options for the
25686 authenticators, followed by general discussion of the way authentication works
25687 in Exim.
25688
25689 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
25690 per-mechanism basis.  Please read carefully to determine which variables hold
25691 account labels such as usercodes and which hold passwords or other
25692 authenticating data.
25693
25694 Note that some mechanisms support two different identifiers for accounts: the
25695 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
25696 and &'authz'& are commonly encountered.  The American spelling is standard here.
25697 Conceptually, authentication data such as passwords are tied to the identifier
25698 used to authenticate; servers may have rules to permit one user to act as a
25699 second user, so that after login the session is treated as though that second
25700 user had logged in.  That second user is the &'authorization id'&.  A robust
25701 configuration might confirm that the &'authz'& field is empty or matches the
25702 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
25703 as verified data, the &'authz'& as an unverified request which the server might
25704 choose to honour.
25705
25706 A &'realm'& is a text string, typically a domain name, presented by a server
25707 to a client to help it select an account and credentials to use.  In some
25708 mechanisms, the client and server provably agree on the realm, but clients
25709 typically can not treat the realm as secure data to be blindly trusted.
25710
25711
25712
25713 .section "Generic options for authenticators" "SECID168"
25714 .cindex "authentication" "generic options"
25715 .cindex "options" "generic; for authenticators"
25716
25717 .option client_condition authenticators string&!! unset
25718 When Exim is authenticating as a client, it skips any authenticator whose
25719 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
25720 used, for example, to skip plain text authenticators when the connection is not
25721 encrypted by a setting such as:
25722 .code
25723 client_condition = ${if !eq{$tls_out_cipher}{}}
25724 .endd
25725
25726
25727 .option client_set_id authenticators string&!! unset
25728 When client authentication succeeds, this condition is expanded; the
25729 result is used in the log lines for outbound messages.
25730 Typically it will be the user name used for authentication.
25731
25732
25733 .option driver authenticators string unset
25734 This option must always be set. It specifies which of the available
25735 authenticators is to be used.
25736
25737
25738 .option public_name authenticators string unset
25739 This option specifies the name of the authentication mechanism that the driver
25740 implements, and by which it is known to the outside world. These names should
25741 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
25742 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
25743 defaults to the driver's instance name.
25744
25745
25746 .option server_advertise_condition authenticators string&!! unset
25747 When a server is about to advertise an authentication mechanism, the condition
25748 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
25749 mechanism is not advertised.
25750 If the expansion fails, the mechanism is not advertised. If the failure was not
25751 forced, and was not caused by a lookup defer, the incident is logged.
25752 See section &<<SECTauthexiser>>& below for further discussion.
25753
25754
25755 .option server_condition authenticators string&!! unset
25756 This option must be set for a &%plaintext%& server authenticator, where it
25757 is used directly to control authentication. See section &<<SECTplainserver>>&
25758 for details.
25759
25760 For the &(gsasl)& authenticator, this option is required for various
25761 mechanisms; see chapter &<<CHAPgsasl>>& for details.
25762
25763 For the other authenticators, &%server_condition%& can be used as an additional
25764 authentication or authorization mechanism that is applied after the other
25765 authenticator conditions succeed. If it is set, it is expanded when the
25766 authenticator would otherwise return a success code. If the expansion is forced
25767 to fail, authentication fails. Any other expansion failure causes a temporary
25768 error code to be returned. If the result of a successful expansion is an empty
25769 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
25770 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
25771 other result, a temporary error code is returned, with the expanded string as
25772 the error text.
25773
25774
25775 .option server_debug_print authenticators string&!! unset
25776 If this option is set and authentication debugging is enabled (see the &%-d%&
25777 command line option), the string is expanded and included in the debugging
25778 output when the authenticator is run as a server. This can help with checking
25779 out the values of variables.
25780 If expansion of the string fails, the error message is written to the debugging
25781 output, and Exim carries on processing.
25782
25783
25784 .option server_set_id authenticators string&!! unset
25785 .vindex "&$authenticated_id$&"
25786 When an Exim server successfully authenticates a client, this string is
25787 expanded using data from the authentication, and preserved for any incoming
25788 messages in the variable &$authenticated_id$&. It is also included in the log
25789 lines for incoming messages. For example, a user/password authenticator
25790 configuration might preserve the user name that was used to authenticate, and
25791 refer to it subsequently during delivery of the message.
25792 If expansion fails, the option is ignored.
25793
25794
25795 .option server_mail_auth_condition authenticators string&!! unset
25796 This option allows a server to discard authenticated sender addresses supplied
25797 as part of MAIL commands in SMTP connections that are authenticated by the
25798 driver on which &%server_mail_auth_condition%& is set. The option is not used
25799 as part of the authentication process; instead its (unexpanded) value is
25800 remembered for later use.
25801 How it is used is described in the following section.
25802
25803
25804
25805
25806
25807 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
25808 .cindex "authentication" "sender; authenticated"
25809 .cindex "AUTH" "on MAIL command"
25810 When a client supplied an AUTH= item on a MAIL command, Exim applies
25811 the following checks before accepting it as the authenticated sender of the
25812 message:
25813
25814 .ilist
25815 If the connection is not using extended SMTP (that is, HELO was used rather
25816 than EHLO), the use of AUTH= is a syntax error.
25817 .next
25818 If the value of the AUTH= parameter is &"<>"&, it is ignored.
25819 .next
25820 .vindex "&$authenticated_sender$&"
25821 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
25822 running, the value of &$authenticated_sender$& is set to the value obtained
25823 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
25824 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
25825 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
25826 given for the MAIL command.
25827 .next
25828 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
25829 is accepted and placed in &$authenticated_sender$& only if the client has
25830 authenticated.
25831 .next
25832 If the AUTH= value was accepted by either of the two previous rules, and
25833 the client has authenticated, and the authenticator has a setting for the
25834 &%server_mail_auth_condition%&, the condition is checked at this point. The
25835 valued that was saved from the authenticator is expanded. If the expansion
25836 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
25837 &$authenticated_sender$& is deleted. If the expansion yields any other value,
25838 the value of &$authenticated_sender$& is retained and passed on with the
25839 message.
25840 .endlist
25841
25842
25843 When &$authenticated_sender$& is set for a message, it is passed on to other
25844 hosts to which Exim authenticates as a client. Do not confuse this value with
25845 &$authenticated_id$&, which is a string obtained from the authentication
25846 process, and which is not usually a complete email address.
25847
25848 .vindex "&$sender_address$&"
25849 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
25850 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
25851 therefore make use of &$authenticated_sender$&. The converse is not true: the
25852 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
25853 ACL is run.
25854
25855
25856
25857 .section "Authentication on an Exim server" "SECTauthexiser"
25858 .cindex "authentication" "on an Exim server"
25859 When Exim receives an EHLO command, it advertises the public names of those
25860 authenticators that are configured as servers, subject to the following
25861 conditions:
25862
25863 .ilist
25864 The client host must match &%auth_advertise_hosts%& (default *).
25865 .next
25866 It the &%server_advertise_condition%& option is set, its expansion must not
25867 yield the empty string, &"0"&, &"no"&, or &"false"&.
25868 .endlist
25869
25870 The order in which the authenticators are defined controls the order in which
25871 the mechanisms are advertised.
25872
25873 Some mail clients (for example, some versions of Netscape) require the user to
25874 provide a name and password for authentication whenever AUTH is advertised,
25875 even though authentication may not in fact be needed (for example, Exim may be
25876 set up to allow unconditional relaying from the client by an IP address check).
25877 You can make such clients more friendly by not advertising AUTH to them.
25878 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
25879 that runs for RCPT) to relay without authentication, you should set
25880 .code
25881 auth_advertise_hosts = ! 10.9.8.0/24
25882 .endd
25883 so that no authentication mechanisms are advertised to them.
25884
25885 The &%server_advertise_condition%& controls the advertisement of individual
25886 authentication mechanisms. For example, it can be used to restrict the
25887 advertisement of a particular mechanism to encrypted connections, by a setting
25888 such as:
25889 .code
25890 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
25891 .endd
25892 .vindex "&$tls_in_cipher$&"
25893 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
25894 yields &"yes"&, which allows the advertisement to happen.
25895
25896 When an Exim server receives an AUTH command from a client, it rejects it
25897 immediately if AUTH was not advertised in response to an earlier EHLO
25898 command. This is the case if
25899
25900 .ilist
25901 The client host does not match &%auth_advertise_hosts%&; or
25902 .next
25903 No authenticators are configured with server options; or
25904 .next
25905 Expansion of &%server_advertise_condition%& blocked the advertising of all the
25906 server authenticators.
25907 .endlist
25908
25909
25910 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
25911 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
25912 AUTH is accepted from any client host.
25913
25914 If AUTH is not rejected by the ACL, Exim searches its configuration for a
25915 server authentication mechanism that was advertised in response to EHLO and
25916 that matches the one named in the AUTH command. If it finds one, it runs
25917 the appropriate authentication protocol, and authentication either succeeds or
25918 fails. If there is no matching advertised mechanism, the AUTH command is
25919 rejected with a 504 error.
25920
25921 .vindex "&$received_protocol$&"
25922 .vindex "&$sender_host_authenticated$&"
25923 When a message is received from an authenticated host, the value of
25924 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
25925 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
25926 public name) of the authenticator driver that successfully authenticated the
25927 client from which the message was received. This variable is empty if there was
25928 no successful authentication.
25929
25930
25931
25932
25933 .section "Testing server authentication" "SECID169"
25934 .cindex "authentication" "testing a server"
25935 .cindex "AUTH" "testing a server"
25936 .cindex "base64 encoding" "creating authentication test data"
25937 Exim's &%-bh%& option can be useful for testing server authentication
25938 configurations. The data for the AUTH command has to be sent using base64
25939 encoding. A quick way to produce such data for testing is the following Perl
25940 script:
25941 .code
25942 use MIME::Base64;
25943 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
25944 .endd
25945 .cindex "binary zero" "in authentication data"
25946 This interprets its argument as a Perl string, and then encodes it. The
25947 interpretation as a Perl string allows binary zeros, which are required for
25948 some kinds of authentication, to be included in the data. For example, a
25949 command line to run this script on such data might be
25950 .code
25951 encode '\0user\0password'
25952 .endd
25953 Note the use of single quotes to prevent the shell interpreting the
25954 backslashes, so that they can be interpreted by Perl to specify characters
25955 whose code value is zero.
25956
25957 &*Warning 1*&: If either of the user or password strings starts with an octal
25958 digit, you must use three zeros instead of one after the leading backslash. If
25959 you do not, the octal digit that starts your string will be incorrectly
25960 interpreted as part of the code for the first character.
25961
25962 &*Warning 2*&: If there are characters in the strings that Perl interprets
25963 specially, you must use a Perl escape to prevent them being misinterpreted. For
25964 example, a command such as
25965 .code
25966 encode '\0user@domain.com\0pas$$word'
25967 .endd
25968 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
25969
25970 If you have the &%mimencode%& command installed, another way to do produce
25971 base64-encoded strings is to run the command
25972 .code
25973 echo -e -n `\0user\0password' | mimencode
25974 .endd
25975 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
25976 in the argument, and the &%-n%& option specifies no newline at the end of its
25977 output. However, not all versions of &%echo%& recognize these options, so you
25978 should check your version before relying on this suggestion.
25979
25980
25981
25982 .section "Authentication by an Exim client" "SECID170"
25983 .cindex "authentication" "on an Exim client"
25984 The &(smtp)& transport has two options called &%hosts_require_auth%& and
25985 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
25986 announces support for authentication, and the host matches an entry in either
25987 of these options, Exim (as a client) tries to authenticate as follows:
25988
25989 .ilist
25990 For each authenticator that is configured as a client, in the order in which
25991 they are defined in the configuration, it searches the authentication
25992 mechanisms announced by the server for one whose name matches the public name
25993 of the authenticator.
25994 .next
25995 .vindex "&$host$&"
25996 .vindex "&$host_address$&"
25997 When it finds one that matches, it runs the authenticator's client code. The
25998 variables &$host$& and &$host_address$& are available for any string expansions
25999 that the client might do. They are set to the server's name and IP address. If
26000 any expansion is forced to fail, the authentication attempt is abandoned, and
26001 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26002 delivery to be deferred.
26003 .next
26004 If the result of the authentication attempt is a temporary error or a timeout,
26005 Exim abandons trying to send the message to the host for the moment. It will
26006 try again later. If there are any backup hosts available, they are tried in the
26007 usual way.
26008 .next
26009 If the response to authentication is a permanent error (5&'xx'& code), Exim
26010 carries on searching the list of authenticators and tries another one if
26011 possible. If all authentication attempts give permanent errors, or if there are
26012 no attempts because no mechanisms match (or option expansions force failure),
26013 what happens depends on whether the host matches &%hosts_require_auth%& or
26014 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26015 delivery is deferred. The error can be detected in the retry rules, and thereby
26016 turned into a permanent error if you wish. In the second case, Exim tries to
26017 deliver the message unauthenticated.
26018 .endlist
26019
26020 Note that the hostlist test for whether to do authentication can be
26021 confused if name-IP lookups change between the time the peer is decided
26022 on and the transport running.  For example, with a manualroute
26023 router given a host name, and DNS "round-robin" use by that name: if
26024 the local resolver cache times out between the router and the transport
26025 running, the transport may get an IP for the name for its authentication
26026 check which does not match the connection peer IP.
26027 No authentication will then be done, despite the names being identical.
26028
26029 For such cases use a separate transport which always authenticates.
26030
26031 .cindex "AUTH" "on MAIL command"
26032 When Exim has authenticated itself to a remote server, it adds the AUTH
26033 parameter to the MAIL commands it sends, if it has an authenticated sender for
26034 the message. If the message came from a remote host, the authenticated sender
26035 is the one that was receiving on an incoming MAIL command, provided that the
26036 incoming connection was authenticated and the &%server_mail_auth%& condition
26037 allowed the authenticated sender to be retained. If a local process calls Exim
26038 to send a message, the sender address that is built from the login name and
26039 &%qualify_domain%& is treated as authenticated. However, if the
26040 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26041 the authenticated sender that was received with the message.
26042 .ecindex IIDauthconf1
26043 .ecindex IIDauthconf2
26044
26045
26046
26047
26048
26049
26050 . ////////////////////////////////////////////////////////////////////////////
26051 . ////////////////////////////////////////////////////////////////////////////
26052
26053 .chapter "The plaintext authenticator" "CHAPplaintext"
26054 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26055 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26056 The &(plaintext)& authenticator can be configured to support the PLAIN and
26057 LOGIN authentication mechanisms, both of which transfer authentication data as
26058 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26059 security risk; you are strongly advised to insist on the use of SMTP encryption
26060 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26061 use unencrypted plain text, you should not use the same passwords for SMTP
26062 connections as you do for login accounts.
26063
26064 .section "Plaintext options" "SECID171"
26065 .cindex "options" "&(plaintext)& authenticator (server)"
26066 When configured as a server, &(plaintext)& uses the following options:
26067
26068 .option server_condition authenticators string&!! unset
26069 This is actually a global authentication option, but it must be set in order to
26070 configure the &(plaintext)& driver as a server. Its use is described below.
26071
26072 .option server_prompts plaintext string&!! unset
26073 The contents of this option, after expansion, must be a colon-separated list of
26074 prompt strings. If expansion fails, a temporary authentication rejection is
26075 given.
26076
26077 .section "Using plaintext in a server" "SECTplainserver"
26078 .cindex "AUTH" "in &(plaintext)& authenticator"
26079 .cindex "binary zero" "in &(plaintext)& authenticator"
26080 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26081         "in &(plaintext)& authenticator"
26082 .vindex "&$auth1$&, &$auth2$&, etc"
26083 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26084
26085 When running as a server, &(plaintext)& performs the authentication test by
26086 expanding a string. The data sent by the client with the AUTH command, or in
26087 response to subsequent prompts, is base64 encoded, and so may contain any byte
26088 values when decoded. If any data is supplied with the command, it is treated as
26089 a list of strings, separated by NULs (binary zeros), the first three of which
26090 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26091 (neither LOGIN nor PLAIN uses more than three strings).
26092
26093 For compatibility with previous releases of Exim, the values are also placed in
26094 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26095 variables for this purpose is now deprecated, as it can lead to confusion in
26096 string expansions that also use them for other things.
26097
26098 If there are more strings in &%server_prompts%& than the number of strings
26099 supplied with the AUTH command, the remaining prompts are used to obtain more
26100 data. Each response from the client may be a list of NUL-separated strings.
26101
26102 .vindex "&$authenticated_id$&"
26103 Once a sufficient number of data strings have been received,
26104 &%server_condition%& is expanded. If the expansion is forced to fail,
26105 authentication fails. Any other expansion failure causes a temporary error code
26106 to be returned. If the result of a successful expansion is an empty string,
26107 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26108 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26109 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26110 For any other result, a temporary error code is returned, with the expanded
26111 string as the error text
26112
26113 &*Warning*&: If you use a lookup in the expansion to find the user's
26114 password, be sure to make the authentication fail if the user is unknown.
26115 There are good and bad examples at the end of the next section.
26116
26117
26118
26119 .section "The PLAIN authentication mechanism" "SECID172"
26120 .cindex "PLAIN authentication mechanism"
26121 .cindex "authentication" "PLAIN mechanism"
26122 .cindex "binary zero" "in &(plaintext)& authenticator"
26123 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26124 sent as one item of data (that is, one combined string containing two NUL
26125 separators). The data is sent either as part of the AUTH command, or
26126 subsequently in response to an empty prompt from the server.
26127
26128 The second and third strings are a user name and a corresponding password.
26129 Using a single fixed user name and password as an example, this could be
26130 configured as follows:
26131 .code
26132 fixed_plain:
26133   driver = plaintext
26134   public_name = PLAIN
26135   server_prompts = :
26136   server_condition = \
26137     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26138   server_set_id = $auth2
26139 .endd
26140 Note that the default result strings from &%if%& (&"true"& or an empty string)
26141 are exactly what we want here, so they need not be specified. Obviously, if the
26142 password contains expansion-significant characters such as dollar, backslash,
26143 or closing brace, they have to be escaped.
26144
26145 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26146 the end of a string list are ignored). If all the data comes as part of the
26147 AUTH command, as is commonly the case, the prompt is not used. This
26148 authenticator is advertised in the response to EHLO as
26149 .code
26150 250-AUTH PLAIN
26151 .endd
26152 and a client host can authenticate itself by sending the command
26153 .code
26154 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26155 .endd
26156 As this contains three strings (more than the number of prompts), no further
26157 data is required from the client. Alternatively, the client may just send
26158 .code
26159 AUTH PLAIN
26160 .endd
26161 to initiate authentication, in which case the server replies with an empty
26162 prompt. The client must respond with the combined data string.
26163
26164 The data string is base64 encoded, as required by the RFC. This example,
26165 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26166 represents a zero byte. This is split up into three strings, the first of which
26167 is empty. The &%server_condition%& option in the authenticator checks that the
26168 second two are &`username`& and &`mysecret`& respectively.
26169
26170 Having just one fixed user name and password, as in this example, is not very
26171 realistic, though for a small organization with only a handful of
26172 authenticating clients it could make sense.
26173
26174 A more sophisticated instance of this authenticator could use the user name in
26175 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26176 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26177 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26178 This is an incorrect example:
26179 .code
26180 server_condition = \
26181   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26182 .endd
26183 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26184 which it then compares to the supplied password (&$auth3$&). Why is this example
26185 incorrect? It works fine for existing users, but consider what happens if a
26186 non-existent user name is given. The lookup fails, but as no success/failure
26187 strings are given for the lookup, it yields an empty string. Thus, to defeat
26188 the authentication, all a client has to do is to supply a non-existent user
26189 name and an empty password. The correct way of writing this test is:
26190 .code
26191 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26192   {${if eq{$value}{$auth3}}} {false}}
26193 .endd
26194 In this case, if the lookup succeeds, the result is checked; if the lookup
26195 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26196 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26197 always fails if its second argument is empty. However, the second way of
26198 writing the test makes the logic clearer.
26199
26200
26201 .section "The LOGIN authentication mechanism" "SECID173"
26202 .cindex "LOGIN authentication mechanism"
26203 .cindex "authentication" "LOGIN mechanism"
26204 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26205 in a number of programs. No data is sent with the AUTH command. Instead, a
26206 user name and password are supplied separately, in response to prompts. The
26207 plaintext authenticator can be configured to support this as in this example:
26208 .code
26209 fixed_login:
26210   driver = plaintext
26211   public_name = LOGIN
26212   server_prompts = User Name : Password
26213   server_condition = \
26214     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26215   server_set_id = $auth1
26216 .endd
26217 Because of the way plaintext operates, this authenticator accepts data supplied
26218 with the AUTH command (in contravention of the specification of LOGIN), but
26219 if the client does not supply it (as is the case for LOGIN clients), the prompt
26220 strings are used to obtain two data items.
26221
26222 Some clients are very particular about the precise text of the prompts. For
26223 example, Outlook Express is reported to recognize only &"Username:"& and
26224 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26225 strings. It uses the &%ldapauth%& expansion condition to check the user
26226 name and password by binding to an LDAP server:
26227 .code
26228 login:
26229   driver = plaintext
26230   public_name = LOGIN
26231   server_prompts = Username:: : Password::
26232   server_condition = ${if and{{ \
26233     !eq{}{$auth1} }{ \
26234     ldapauth{\
26235       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26236       pass=${quote:$auth2} \
26237       ldap://ldap.example.org/} }} }
26238   server_set_id = uid=$auth1,ou=people,o=example.org
26239 .endd
26240 We have to check that the username is not empty before using it, because LDAP
26241 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26242 operator to correctly quote the DN for authentication. However, the basic
26243 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26244 correct one to use for the password, because quoting is needed only to make
26245 the password conform to the Exim syntax. At the LDAP level, the password is an
26246 uninterpreted string.
26247
26248
26249 .section "Support for different kinds of authentication" "SECID174"
26250 A number of string expansion features are provided for the purpose of
26251 interfacing to different ways of user authentication. These include checking
26252 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26253 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26254 &<<SECTexpcond>>&.
26255
26256
26257
26258
26259 .section "Using plaintext in a client" "SECID175"
26260 .cindex "options" "&(plaintext)& authenticator (client)"
26261 The &(plaintext)& authenticator has two client options:
26262
26263 .option client_ignore_invalid_base64 plaintext boolean false
26264 If the client receives a server prompt that is not a valid base64 string,
26265 authentication is abandoned by default. However, if this option is set true,
26266 the error in the challenge is ignored and the client sends the response as
26267 usual.
26268
26269 .option client_send plaintext string&!! unset
26270 The string is a colon-separated list of authentication data strings. Each
26271 string is independently expanded before being sent to the server. The first
26272 string is sent with the AUTH command; any more strings are sent in response
26273 to prompts from the server. Before each string is expanded, the value of the
26274 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26275 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26276 way. Thus, the prompt that is received in response to sending the first string
26277 (with the AUTH command) can be used in the expansion of the second string, and
26278 so on. If an invalid base64 string is received when
26279 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26280 &$auth$&<&'n'&> variable.
26281
26282 &*Note*&: You cannot use expansion to create multiple strings, because
26283 splitting takes priority and happens first.
26284
26285 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26286 the data, further processing is applied to each string before it is sent. If
26287 there are any single circumflex characters in the string, they are converted to
26288 NULs. Should an actual circumflex be required as data, it must be doubled in
26289 the string.
26290
26291 This is an example of a client configuration that implements the PLAIN
26292 authentication mechanism with a fixed user name and password:
26293 .code
26294 fixed_plain:
26295   driver = plaintext
26296   public_name = PLAIN
26297   client_send = ^username^mysecret
26298 .endd
26299 The lack of colons means that the entire text is sent with the AUTH
26300 command, with the circumflex characters converted to NULs. A similar example
26301 that uses the LOGIN mechanism is:
26302 .code
26303 fixed_login:
26304   driver = plaintext
26305   public_name = LOGIN
26306   client_send = : username : mysecret
26307 .endd
26308 The initial colon means that the first string is empty, so no data is sent with
26309 the AUTH command itself. The remaining strings are sent in response to
26310 prompts.
26311 .ecindex IIDplaiauth1
26312 .ecindex IIDplaiauth2
26313
26314
26315
26316
26317 . ////////////////////////////////////////////////////////////////////////////
26318 . ////////////////////////////////////////////////////////////////////////////
26319
26320 .chapter "The cram_md5 authenticator" "CHID9"
26321 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26322 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26323 .cindex "CRAM-MD5 authentication mechanism"
26324 .cindex "authentication" "CRAM-MD5 mechanism"
26325 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26326 sends a challenge string to the client, and the response consists of a user
26327 name and the CRAM-MD5 digest of the challenge string combined with a secret
26328 string (password) which is known to both server and client. Thus, the secret
26329 is not sent over the network as plain text, which makes this authenticator more
26330 secure than &(plaintext)&. However, the downside is that the secret has to be
26331 available in plain text at either end.
26332
26333
26334 .section "Using cram_md5 as a server" "SECID176"
26335 .cindex "options" "&(cram_md5)& authenticator (server)"
26336 This authenticator has one server option, which must be set to configure the
26337 authenticator as a server:
26338
26339 .option server_secret cram_md5 string&!! unset
26340 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26341 When the server receives the client's response, the user name is placed in
26342 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26343 obtain the password for that user. The server then computes the CRAM-MD5 digest
26344 that the client should have sent, and checks that it received the correct
26345 string. If the expansion of &%server_secret%& is forced to fail, authentication
26346 fails. If the expansion fails for some other reason, a temporary error code is
26347 returned to the client.
26348
26349 For compatibility with previous releases of Exim, the user name is also placed
26350 in &$1$&. However, the use of this variables for this purpose is now
26351 deprecated, as it can lead to confusion in string expansions that also use
26352 numeric variables for other things.
26353
26354 For example, the following authenticator checks that the user name given by the
26355 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26356 user name, authentication fails.
26357 .code
26358 fixed_cram:
26359   driver = cram_md5
26360   public_name = CRAM-MD5
26361   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26362   server_set_id = $auth1
26363 .endd
26364 .vindex "&$authenticated_id$&"
26365 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26366 name in &$authenticated_id$&. A more typical configuration might look up the
26367 secret string in a file, using the user name as the key. For example:
26368 .code
26369 lookup_cram:
26370   driver = cram_md5
26371   public_name = CRAM-MD5
26372   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26373                   {$value}fail}
26374   server_set_id = $auth1
26375 .endd
26376 Note that this expansion explicitly forces failure if the lookup fails
26377 because &$auth1$& contains an unknown user name.
26378
26379 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26380 using the relevant libraries, you need to know the realm to specify in the
26381 lookup and then ask for the &"userPassword"& attribute for that user in that
26382 realm, with:
26383 .code
26384 cyrusless_crammd5:
26385   driver = cram_md5
26386   public_name = CRAM-MD5
26387   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26388                   dbmjz{/etc/sasldb2}{$value}fail}
26389   server_set_id = $auth1
26390 .endd
26391
26392 .section "Using cram_md5 as a client" "SECID177"
26393 .cindex "options" "&(cram_md5)& authenticator (client)"
26394 When used as a client, the &(cram_md5)& authenticator has two options:
26395
26396
26397
26398 .option client_name cram_md5 string&!! "the primary host name"
26399 This string is expanded, and the result used as the user name data when
26400 computing the response to the server's challenge.
26401
26402
26403 .option client_secret cram_md5 string&!! unset
26404 This option must be set for the authenticator to work as a client. Its value is
26405 expanded and the result used as the secret string when computing the response.
26406
26407
26408 .vindex "&$host$&"
26409 .vindex "&$host_address$&"
26410 Different user names and secrets can be used for different servers by referring
26411 to &$host$& or &$host_address$& in the options. Forced failure of either
26412 expansion string is treated as an indication that this authenticator is not
26413 prepared to handle this case. Exim moves on to the next configured client
26414 authenticator. Any other expansion failure causes Exim to give up trying to
26415 send the message to the current server.
26416
26417 A simple example configuration of a &(cram_md5)& authenticator, using fixed
26418 strings, is:
26419 .code
26420 fixed_cram:
26421   driver = cram_md5
26422   public_name = CRAM-MD5
26423   client_name = ph10
26424   client_secret = secret
26425 .endd
26426 .ecindex IIDcramauth1
26427 .ecindex IIDcramauth2
26428
26429
26430
26431 . ////////////////////////////////////////////////////////////////////////////
26432 . ////////////////////////////////////////////////////////////////////////////
26433
26434 .chapter "The cyrus_sasl authenticator" "CHID10"
26435 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
26436 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
26437 .cindex "Cyrus" "SASL library"
26438 .cindex "Kerberos"
26439 The code for this authenticator was provided by Matthew Byng-Maddick of A L
26440 Digital Ltd (&url(http://www.aldigital.co.uk)).
26441
26442 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
26443 library implementation of the RFC 2222 (&"Simple Authentication and Security
26444 Layer"&). This library supports a number of authentication mechanisms,
26445 including PLAIN and LOGIN, but also several others that Exim does not support
26446 directly. In particular, there is support for Kerberos authentication.
26447
26448 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
26449 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
26450 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
26451 name of the driver to determine which mechanism to support.
26452
26453 Where access to some kind of secret file is required, for example in GSSAPI
26454 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
26455 user, and that the Cyrus SASL library has no way of escalating privileges
26456 by default. You may also find you need to set environment variables,
26457 depending on the driver you are using.
26458
26459 The application name provided by Exim is &"exim"&, so various SASL options may
26460 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
26461 Kerberos, note that because of limitations in the GSSAPI interface,
26462 changing the server keytab might need to be communicated down to the Kerberos
26463 layer independently. The mechanism for doing so is dependent upon the Kerberos
26464 implementation.
26465
26466 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
26467 may be set to point to an alternative keytab file. Exim will pass this
26468 variable through from its own inherited environment when started as root or the
26469 Exim user. The keytab file needs to be readable by the Exim user.
26470 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
26471 environment variable.  In practice, for those releases, the Cyrus authenticator
26472 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
26473 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
26474
26475
26476 .section "Using cyrus_sasl as a server" "SECID178"
26477 The &(cyrus_sasl)& authenticator has four private options. It puts the username
26478 (on a successful authentication) into &$auth1$&. For compatibility with
26479 previous releases of Exim, the username is also placed in &$1$&. However, the
26480 use of this variable for this purpose is now deprecated, as it can lead to
26481 confusion in string expansions that also use numeric variables for other
26482 things.
26483
26484
26485 .option server_hostname cyrus_sasl string&!! "see below"
26486 This option selects the hostname that is used when communicating with the
26487 library. The default value is &`$primary_hostname`&. It is up to the underlying
26488 SASL plug-in what it does with this data.
26489
26490
26491 .option server_mech cyrus_sasl string "see below"
26492 This option selects the authentication mechanism this driver should use. The
26493 default is the value of the generic &%public_name%& option. This option allows
26494 you to use a different underlying mechanism from the advertised name. For
26495 example:
26496 .code
26497 sasl:
26498   driver = cyrus_sasl
26499   public_name = X-ANYTHING
26500   server_mech = CRAM-MD5
26501   server_set_id = $auth1
26502 .endd
26503
26504 .option server_realm cyrus_sasl string&!! unset
26505 This specifies the SASL realm that the server claims to be in.
26506
26507
26508 .option server_service cyrus_sasl string &`smtp`&
26509 This is the SASL service that the server claims to implement.
26510
26511
26512 For straightforward cases, you do not need to set any of the authenticator's
26513 private options. All you need to do is to specify an appropriate mechanism as
26514 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
26515 PLAIN, you could have two authenticators as follows:
26516 .code
26517 sasl_cram_md5:
26518   driver = cyrus_sasl
26519   public_name = CRAM-MD5
26520   server_set_id = $auth1
26521
26522 sasl_plain:
26523   driver = cyrus_sasl
26524   public_name = PLAIN
26525   server_set_id = $auth2
26526 .endd
26527 Cyrus SASL does implement the LOGIN authentication method, even though it is
26528 not a standard method. It is disabled by default in the source distribution,
26529 but it is present in many binary distributions.
26530 .ecindex IIDcyrauth1
26531 .ecindex IIDcyrauth2
26532
26533
26534
26535
26536 . ////////////////////////////////////////////////////////////////////////////
26537 . ////////////////////////////////////////////////////////////////////////////
26538 .chapter "The dovecot authenticator" "CHAPdovecot"
26539 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
26540 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
26541 This authenticator is an interface to the authentication facility of the
26542 Dovecot POP/IMAP server, which can support a number of authentication methods.
26543 Note that Dovecot must be configured to use auth-client not auth-userdb.
26544 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
26545 to use the same mechanisms for SMTP authentication. This is a server
26546 authenticator only. There is only one option:
26547
26548 .option server_socket dovecot string unset
26549
26550 This option must specify the socket that is the interface to Dovecot
26551 authentication. The &%public_name%& option must specify an authentication
26552 mechanism that Dovecot is configured to support. You can have several
26553 authenticators for different mechanisms. For example:
26554 .code
26555 dovecot_plain:
26556   driver = dovecot
26557   public_name = PLAIN
26558   server_socket = /var/run/dovecot/auth-client
26559   server_set_id = $auth1
26560
26561 dovecot_ntlm:
26562   driver = dovecot
26563   public_name = NTLM
26564   server_socket = /var/run/dovecot/auth-client
26565   server_set_id = $auth1
26566 .endd
26567 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
26568 &$received_ip_address$& (that is, the connection is local), the &"secured"&
26569 option is passed in the Dovecot authentication command. If, for a TLS
26570 connection, a client certificate has been verified, the &"valid-client-cert"&
26571 option is passed. When authentication succeeds, the identity of the user
26572 who authenticated is placed in &$auth1$&.
26573 .ecindex IIDdcotauth1
26574 .ecindex IIDdcotauth2
26575
26576
26577 . ////////////////////////////////////////////////////////////////////////////
26578 . ////////////////////////////////////////////////////////////////////////////
26579 .chapter "The gsasl authenticator" "CHAPgsasl"
26580 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
26581 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
26582 .cindex "authentication" "GNU SASL"
26583 .cindex "authentication" "SASL"
26584 .cindex "authentication" "EXTERNAL"
26585 .cindex "authentication" "ANONYMOUS"
26586 .cindex "authentication" "PLAIN"
26587 .cindex "authentication" "LOGIN"
26588 .cindex "authentication" "DIGEST-MD5"
26589 .cindex "authentication" "CRAM-MD5"
26590 .cindex "authentication" "SCRAM-SHA-1"
26591 The &(gsasl)& authenticator provides server integration for the GNU SASL
26592 library and the mechanisms it provides.  This is new as of the 4.80 release
26593 and there are a few areas where the library does not let Exim smoothly
26594 scale to handle future authentication mechanisms, so no guarantee can be
26595 made that any particular new authentication mechanism will be supported
26596 without code changes in Exim.
26597
26598
26599 .option server_channelbinding gsasl boolean false
26600 Some authentication mechanisms are able to use external context at both ends
26601 of the session to bind the authentication to that context, and fail the
26602 authentication process if that context differs.  Specifically, some TLS
26603 ciphersuites can provide identifying information about the cryptographic
26604 context.
26605
26606 This means that certificate identity and verification becomes a non-issue,
26607 as a man-in-the-middle attack will cause the correct client and server to
26608 see different identifiers and authentication will fail.
26609
26610 This is currently only supported when using the GnuTLS library.  This is
26611 only usable by mechanisms which support "channel binding"; at time of
26612 writing, that's the SCRAM family.
26613
26614 This defaults off to ensure smooth upgrade across Exim releases, in case
26615 this option causes some clients to start failing.  Some future release
26616 of Exim may switch the default to be true.
26617
26618
26619 .option server_hostname gsasl string&!! "see below"
26620 This option selects the hostname that is used when communicating with the
26621 library. The default value is &`$primary_hostname`&.
26622 Some mechanisms will use this data.
26623
26624
26625 .option server_mech gsasl string "see below"
26626 This option selects the authentication mechanism this driver should use. The
26627 default is the value of the generic &%public_name%& option. This option allows
26628 you to use a different underlying mechanism from the advertised name. For
26629 example:
26630 .code
26631 sasl:
26632   driver = gsasl
26633   public_name = X-ANYTHING
26634   server_mech = CRAM-MD5
26635   server_set_id = $auth1
26636 .endd
26637
26638
26639 .option server_password gsasl string&!! unset
26640 Various mechanisms need access to the cleartext password on the server, so
26641 that proof-of-possession can be demonstrated on the wire, without sending
26642 the password itself.
26643
26644 The data available for lookup varies per mechanism.
26645 In all cases, &$auth1$& is set to the &'authentication id'&.
26646 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
26647 if available, else the empty string.
26648 The &$auth3$& variable will always be the &'realm'& if available,
26649 else the empty string.
26650
26651 A forced failure will cause authentication to defer.
26652
26653 If using this option, it may make sense to set the &%server_condition%&
26654 option to be simply "true".
26655
26656
26657 .option server_realm gsasl string&!! unset
26658 This specifies the SASL realm that the server claims to be in.
26659 Some mechanisms will use this data.
26660
26661
26662 .option server_scram_iter gsasl string&!! unset
26663 This option provides data for the SCRAM family of mechanisms.
26664 &$auth1$& is not available at evaluation time.
26665 (This may change, as we receive feedback on use)
26666
26667
26668 .option server_scram_salt gsasl string&!! unset
26669 This option provides data for the SCRAM family of mechanisms.
26670 &$auth1$& is not available at evaluation time.
26671 (This may change, as we receive feedback on use)
26672
26673
26674 .option server_service gsasl string &`smtp`&
26675 This is the SASL service that the server claims to implement.
26676 Some mechanisms will use this data.
26677
26678
26679 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
26680 .vindex "&$auth1$&, &$auth2$&, etc"
26681 These may be set when evaluating specific options, as detailed above.
26682 They will also be set when evaluating &%server_condition%&.
26683
26684 Unless otherwise stated below, the &(gsasl)& integration will use the following
26685 meanings for these variables:
26686
26687 .ilist
26688 .vindex "&$auth1$&"
26689 &$auth1$&: the &'authentication id'&
26690 .next
26691 .vindex "&$auth2$&"
26692 &$auth2$&: the &'authorization id'&
26693 .next
26694 .vindex "&$auth3$&"
26695 &$auth3$&: the &'realm'&
26696 .endlist
26697
26698 On a per-mechanism basis:
26699
26700 .ilist
26701 .cindex "authentication" "EXTERNAL"
26702 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
26703 the &%server_condition%& option must be present.
26704 .next
26705 .cindex "authentication" "ANONYMOUS"
26706 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
26707 the &%server_condition%& option must be present.
26708 .next
26709 .cindex "authentication" "GSSAPI"
26710 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
26711 &$auth2$& will be set to the &'authorization id'&,
26712 the &%server_condition%& option must be present.
26713 .endlist
26714
26715 An &'anonymous token'& is something passed along as an unauthenticated
26716 identifier; this is analogous to FTP anonymous authentication passing an
26717 email address, or software-identifier@, as the "password".
26718
26719
26720 An example showing the password having the realm specified in the callback
26721 and demonstrating a Cyrus SASL to GSASL migration approach is:
26722 .code
26723 gsasl_cyrusless_crammd5:
26724   driver = gsasl
26725   public_name = CRAM-MD5
26726   server_realm = imap.example.org
26727   server_password = ${lookup{$auth1:$auth3:userPassword}\
26728                     dbmjz{/etc/sasldb2}{$value}fail}
26729   server_set_id = ${quote:$auth1}
26730   server_condition = yes
26731 .endd
26732
26733
26734 . ////////////////////////////////////////////////////////////////////////////
26735 . ////////////////////////////////////////////////////////////////////////////
26736
26737 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
26738 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
26739 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
26740 .cindex "authentication" "GSSAPI"
26741 .cindex "authentication" "Kerberos"
26742 The &(heimdal_gssapi)& authenticator provides server integration for the
26743 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
26744 reliably.
26745
26746 .option server_hostname heimdal_gssapi string&!! "see below"
26747 This option selects the hostname that is used, with &%server_service%&,
26748 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
26749 identifier.  The default value is &`$primary_hostname`&.
26750
26751 .option server_keytab heimdal_gssapi string&!! unset
26752 If set, then Heimdal will not use the system default keytab (typically
26753 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
26754 The value should be a pathname, with no &"file:"& prefix.
26755
26756 .option server_service heimdal_gssapi string&!! "smtp"
26757 This option specifies the service identifier used, in conjunction with
26758 &%server_hostname%&, for building the identifier for finding credentials
26759 from the keytab.
26760
26761
26762 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
26763 Beware that these variables will typically include a realm, thus will appear
26764 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
26765 not verified, so a malicious client can set it to anything.
26766
26767 The &$auth1$& field should be safely trustable as a value from the Key
26768 Distribution Center.  Note that these are not quite email addresses.
26769 Each identifier is for a role, and so the left-hand-side may include a
26770 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
26771
26772 .vindex "&$auth1$&, &$auth2$&, etc"
26773 .ilist
26774 .vindex "&$auth1$&"
26775 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
26776 .next
26777 .vindex "&$auth2$&"
26778 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
26779 authentication.  If that was empty, this will also be set to the
26780 GSS Display Name.
26781 .endlist
26782
26783
26784 . ////////////////////////////////////////////////////////////////////////////
26785 . ////////////////////////////////////////////////////////////////////////////
26786
26787 .chapter "The spa authenticator" "CHAPspa"
26788 .scindex IIDspaauth1 "&(spa)& authenticator"
26789 .scindex IIDspaauth2 "authenticators" "&(spa)&"
26790 .cindex "authentication" "Microsoft Secure Password"
26791 .cindex "authentication" "NTLM"
26792 .cindex "Microsoft Secure Password Authentication"
26793 .cindex "NTLM authentication"
26794 The &(spa)& authenticator provides client support for Microsoft's &'Secure
26795 Password Authentication'& mechanism,
26796 which is also sometimes known as NTLM (NT LanMan). The code for client side of
26797 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
26798 taken from the Samba project (&url(http://www.samba.org)). The code for the
26799 server side was subsequently contributed by Tom Kistner. The mechanism works as
26800 follows:
26801
26802 .ilist
26803 After the AUTH command has been accepted, the client sends an SPA
26804 authentication request based on the user name and optional domain.
26805 .next
26806 The server sends back a challenge.
26807 .next
26808 The client builds a challenge response which makes use of the user's password
26809 and sends it to the server, which then accepts or rejects it.
26810 .endlist
26811
26812 Encryption is used to protect the password in transit.
26813
26814
26815
26816 .section "Using spa as a server" "SECID179"
26817 .cindex "options" "&(spa)& authenticator (server)"
26818 The &(spa)& authenticator has just one server option:
26819
26820 .option server_password spa string&!! unset
26821 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
26822 This option is expanded, and the result must be the cleartext password for the
26823 authenticating user, whose name is at this point in &$auth1$&. For
26824 compatibility with previous releases of Exim, the user name is also placed in
26825 &$1$&. However, the use of this variable for this purpose is now deprecated, as
26826 it can lead to confusion in string expansions that also use numeric variables
26827 for other things. For example:
26828 .code
26829 spa:
26830   driver = spa
26831   public_name = NTLM
26832   server_password = \
26833     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
26834 .endd
26835 If the expansion is forced to fail, authentication fails. Any other expansion
26836 failure causes a temporary error code to be returned.
26837
26838
26839
26840
26841
26842 .section "Using spa as a client" "SECID180"
26843 .cindex "options" "&(spa)& authenticator (client)"
26844 The &(spa)& authenticator has the following client options:
26845
26846
26847
26848 .option client_domain spa string&!! unset
26849 This option specifies an optional domain for the authentication.
26850
26851
26852 .option client_password spa string&!! unset
26853 This option specifies the user's password, and must be set.
26854
26855
26856 .option client_username spa string&!! unset
26857 This option specifies the user name, and must be set. Here is an example of a
26858 configuration of this authenticator for use with the mail servers at
26859 &'msn.com'&:
26860 .code
26861 msn:
26862   driver = spa
26863   public_name = MSN
26864   client_username = msn/msn_username
26865   client_password = msn_plaintext_password
26866   client_domain = DOMAIN_OR_UNSET
26867 .endd
26868 .ecindex IIDspaauth1
26869 .ecindex IIDspaauth2
26870
26871
26872
26873
26874
26875 . ////////////////////////////////////////////////////////////////////////////
26876 . ////////////////////////////////////////////////////////////////////////////
26877
26878 .chapter "The tls authenticator" "CHAPtlsauth"
26879 .scindex IIDtlsauth1 "&(tls)& authenticator"
26880 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
26881 .cindex "authentication" "Client Certificate"
26882 .cindex "authentication" "X509"
26883 .cindex "Certificate-based authentication"
26884 The &(tls)& authenticator provides server support for
26885 authentication based on client certificates.
26886
26887 It is not an SMTP authentication mechanism and is not
26888 advertised by the server as part of the SMTP EHLO response.
26889 It is an Exim authenticator in the sense that it affects
26890 the protocol element of the log line, can be tested for
26891 by the &%authenticated%& ACL condition, and can set
26892 the &$authenticated_id$& variable.
26893
26894 The client must present a verifiable certificate,
26895 for which it must have been requested via the
26896 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
26897 (see &<<CHAPTLS>>&).
26898
26899 If an authenticator of this type is configured it is
26900 run before any SMTP-level communication is done,
26901 and can authenticate the connection.
26902 If it does, SMTP authentication is not offered.
26903
26904 A maximum of one authenticator of this type may be present.
26905
26906
26907 .cindex "options" "&(tls)& authenticator (server)"
26908 The &(tls)& authenticator has three server options:
26909
26910 .option server_param1 tls string&!! unset
26911 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
26912 This option is expanded after the TLS negotiation and
26913 the result is placed in &$auth1$&.
26914 If the expansion is forced to fail, authentication fails. Any other expansion
26915 failure causes a temporary error code to be returned.
26916
26917 .option server_param2 tls string&!! unset
26918 .option server_param3 tls string&!! unset
26919 As above, for &$auth2$& and &$auth3$&.
26920
26921 &%server_param1%& may also be spelled &%server_param%&.
26922
26923
26924 Example:
26925 .code
26926 tls:
26927   driver = tls
26928   server_param1 =     ${certextract {subj_altname,mail,>:} \
26929                                     {$tls_in_peercert}}
26930   server_condition =  ${if forany {$auth1} \
26931                             {!= {0} \
26932                                 {${lookup ldap{ldap:///\
26933                          mailname=${quote_ldap_dn:${lc:$item}},\
26934                          ou=users,LDAP_DC?mailid} {$value}{0} \
26935                        }    }   } }
26936   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
26937 .endd
26938 This accepts a client certificate that is verifiable against any
26939 of your configured trust-anchors
26940 (which usually means the full set of public CAs)
26941 and which has a SAN with a good account name.
26942 Note that the client cert is on the wire in-clear, including the SAN,
26943 whereas a plaintext SMTP AUTH done inside TLS is not.
26944
26945 . An alternative might use
26946 . .code
26947 .   server_param1 = ${sha256:$tls_in_peercert}
26948 . .endd
26949 . to require one of a set of specific certs that define a given account
26950 . (the verification is still required, but mostly irrelevant).
26951 . This would help for per-device use.
26952 .
26953 . However, for the future we really need support for checking a
26954 . user cert in LDAP - which probably wants a base-64 DER.
26955
26956 .ecindex IIDtlsauth1
26957 .ecindex IIDtlsauth2
26958
26959
26960 Note that because authentication is traditionally an SMTP operation,
26961 the &%authenticated%& ACL condition cannot be used in
26962 a connect- or helo-ACL.
26963
26964
26965
26966 . ////////////////////////////////////////////////////////////////////////////
26967 . ////////////////////////////////////////////////////////////////////////////
26968
26969 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
26970          "Encrypted SMTP connections"
26971 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
26972 .scindex IIDencsmtp2 "SMTP" "encryption"
26973 .cindex "TLS" "on SMTP connection"
26974 .cindex "OpenSSL"
26975 .cindex "GnuTLS"
26976 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
26977 Sockets Layer), is implemented by making use of the OpenSSL library or the
26978 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
26979 cryptographic code in the Exim distribution itself for implementing TLS. In
26980 order to use this feature you must install OpenSSL or GnuTLS, and then build a
26981 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
26982 You also need to understand the basic concepts of encryption at a managerial
26983 level, and in particular, the way that public keys, private keys, and
26984 certificates are used.
26985
26986 RFC 3207 defines how SMTP connections can make use of encryption. Once a
26987 connection is established, the client issues a STARTTLS command. If the
26988 server accepts this, the client and the server negotiate an encryption
26989 mechanism. If the negotiation succeeds, the data that subsequently passes
26990 between them is encrypted.
26991
26992 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
26993 and if so, what cipher suite is in use, whether the client supplied a
26994 certificate, and whether or not that certificate was verified. This makes it
26995 possible for an Exim server to deny or accept certain commands based on the
26996 encryption state.
26997
26998 &*Warning*&: Certain types of firewall and certain anti-virus products can
26999 disrupt TLS connections. You need to turn off SMTP scanning for these products
27000 in order to get TLS to work.
27001
27002
27003
27004 .section "Support for the legacy &""ssmtp""& (aka &""smtps""&) protocol" &&&
27005          "SECID284"
27006 .cindex "ssmtp protocol"
27007 .cindex "smtps protocol"
27008 .cindex "SMTP" "ssmtp protocol"
27009 .cindex "SMTP" "smtps protocol"
27010 Early implementations of encrypted SMTP used a different TCP port from normal
27011 SMTP, and expected an encryption negotiation to start immediately, instead of
27012 waiting for a STARTTLS command from the client using the standard SMTP
27013 port. The protocol was called &"ssmtp"& or &"smtps"&, and port 465 was
27014 allocated for this purpose.
27015
27016 This approach was abandoned when encrypted SMTP was standardized, but there are
27017 still some legacy clients that use it. Exim supports these clients by means of
27018 the &%tls_on_connect_ports%& global option. Its value must be a list of port
27019 numbers; the most common use is expected to be:
27020 .code
27021 tls_on_connect_ports = 465
27022 .endd
27023 The port numbers specified by this option apply to all SMTP connections, both
27024 via the daemon and via &'inetd'&. You still need to specify all the ports that
27025 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27026 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27027 an extra port &-- rather, it specifies different behaviour on a port that is
27028 defined elsewhere.
27029
27030 There is also a &%-tls-on-connect%& command line option. This overrides
27031 &%tls_on_connect_ports%&; it forces the legacy behaviour for all ports.
27032
27033
27034
27035
27036
27037
27038 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27039 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27040 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27041 followed later, when the first versions of GnuTLS were released. To build Exim
27042 to use GnuTLS, you need to set
27043 .code
27044 USE_GNUTLS=yes
27045 .endd
27046 in Local/Makefile, in addition to
27047 .code
27048 SUPPORT_TLS=yes
27049 .endd
27050 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27051 include files and libraries for GnuTLS can be found.
27052
27053 There are some differences in usage when using GnuTLS instead of OpenSSL:
27054
27055 .ilist
27056 The &%tls_verify_certificates%& option
27057 cannot be the path of a directory
27058 for GnuTLS versions before 3.3.6
27059 (for later versions, or OpenSSL, it can be either).
27060 .next
27061 The default value for &%tls_dhparam%& differs for historical reasons.
27062 .next
27063 .vindex "&$tls_in_peerdn$&"
27064 .vindex "&$tls_out_peerdn$&"
27065 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27066 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27067 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27068 .next
27069 OpenSSL identifies cipher suites using hyphens as separators, for example:
27070 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27071 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27072 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27073 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27074 to handle its own older variants) when processing lists of cipher suites in the
27075 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27076 option).
27077 .next
27078 The &%tls_require_ciphers%& options operate differently, as described in the
27079 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27080 .next
27081 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27082 When using OpenSSL, this option is ignored.
27083 (If an API is found to let OpenSSL be configured in this way,
27084 let the Exim Maintainers know and we'll likely use it).
27085 .next
27086 Some other recently added features may only be available in one or the other.
27087 This should be documented with the feature.  If the documentation does not
27088 explicitly state that the feature is infeasible in the other TLS
27089 implementation, then patches are welcome.
27090 .endlist
27091
27092
27093 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27094 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27095 an explicit path; if the latter, then the text about generation still applies,
27096 but not the chosen filename.
27097 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27098 See the documentation of &%tls_dhparam%& for more information.
27099
27100 GnuTLS uses D-H parameters that may take a substantial amount of time
27101 to compute. It is unreasonable to re-compute them for every TLS session.
27102 Therefore, Exim keeps this data in a file in its spool directory, called
27103 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27104 of bits requested.
27105 The file is owned by the Exim user and is readable only by
27106 its owner. Every Exim process that start up GnuTLS reads the D-H
27107 parameters from this file. If the file does not exist, the first Exim process
27108 that needs it computes the data and writes it to a temporary file which is
27109 renamed once it is complete. It does not matter if several Exim processes do
27110 this simultaneously (apart from wasting a few resources). Once a file is in
27111 place, new Exim processes immediately start using it.
27112
27113 For maximum security, the parameters that are stored in this file should be
27114 recalculated periodically, the frequency depending on your paranoia level.
27115 If you are avoiding using the fixed D-H primes published in RFCs, then you
27116 are concerned about some advanced attacks and will wish to do this; if you do
27117 not regenerate then you might as well stick to the standard primes.
27118
27119 Arranging this is easy in principle; just delete the file when you want new
27120 values to be computed. However, there may be a problem. The calculation of new
27121 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27122 If the system is not very active, &_/dev/random_& may delay returning data
27123 until enough randomness (entropy) is available. This may cause Exim to hang for
27124 a substantial amount of time, causing timeouts on incoming connections.
27125
27126 The solution is to generate the parameters externally to Exim. They are stored
27127 in &_gnutls-params-N_& in PEM format, which means that they can be
27128 generated externally using the &(certtool)& command that is part of GnuTLS.
27129
27130 To replace the parameters with new ones, instead of deleting the file
27131 and letting Exim re-create it, you can generate new parameters using
27132 &(certtool)& and, when this has been done, replace Exim's cache file by
27133 renaming. The relevant commands are something like this:
27134 .code
27135 # ls
27136 [ look for file; assume gnutls-params-2236 is the most recent ]
27137 # rm -f new-params
27138 # touch new-params
27139 # chown exim:exim new-params
27140 # chmod 0600 new-params
27141 # certtool --generate-dh-params --bits 2236 >>new-params
27142 # openssl dhparam -noout -text -in new-params | head
27143 [ check the first line, make sure it's not more than 2236;
27144   if it is, then go back to the start ("rm") and repeat
27145   until the size generated is at most the size requested ]
27146 # chmod 0400 new-params
27147 # mv new-params gnutls-params-2236
27148 .endd
27149 If Exim never has to generate the parameters itself, the possibility of
27150 stalling is removed.
27151
27152 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27153 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27154 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27155 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27156 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27157 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27158 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27159 which applies to all D-H usage, client or server.  If the value returned by
27160 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27161 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27162 limit, which is still much higher than Exim historically used.
27163
27164 The filename and bits used will change as the GnuTLS maintainers change the
27165 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27166 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27167 2432 bits, while NSS is limited to 2236 bits.
27168
27169 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27170 increase the chance of the generated prime actually being within acceptable
27171 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27172 procedure above.  There is no sane procedure available to Exim to double-check
27173 the size of the generated prime, so it might still be too large.
27174
27175
27176 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27177 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27178 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27179 There is a function in the OpenSSL library that can be passed a list of cipher
27180 suites before the cipher negotiation takes place. This specifies which ciphers
27181 are acceptable. The list is colon separated and may contain names like
27182 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27183 directly to this function call.
27184 Many systems will install the OpenSSL manual-pages, so you may have
27185 &'ciphers(1)'& available to you.
27186 The following quotation from the OpenSSL
27187 documentation specifies what forms of item are allowed in the cipher string:
27188
27189 .ilist
27190 It can consist of a single cipher suite such as RC4-SHA.
27191 .next
27192 It can represent a list of cipher suites containing a certain algorithm,
27193 or cipher suites of a certain type. For example SHA1 represents all
27194 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27195 SSL v3 algorithms.
27196 .next
27197 Lists of cipher suites can be combined in a single cipher string using
27198 the + character. This is used as a logical and operation. For example
27199 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27200 algorithms.
27201 .endlist
27202
27203 Each cipher string can be optionally preceded by one of the characters &`!`&,
27204 &`-`& or &`+`&.
27205 .ilist
27206 If &`!`& is used, the ciphers are permanently deleted from the list. The
27207 ciphers deleted can never reappear in the list even if they are explicitly
27208 stated.
27209 .next
27210 If &`-`& is used, the ciphers are deleted from the list, but some or all
27211 of the ciphers can be added again by later options.
27212 .next
27213 If &`+`& is used, the ciphers are moved to the end of the list. This
27214 option does not add any new ciphers; it just moves matching existing ones.
27215 .endlist
27216
27217 If none of these characters is present, the string is interpreted as
27218 a list of ciphers to be appended to the current preference list. If the list
27219 includes any ciphers already present they will be ignored: that is, they will
27220 not be moved to the end of the list.
27221 .endlist
27222
27223 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27224 string:
27225 .code
27226 # note single-quotes to get ! past any shell history expansion
27227 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27228 .endd
27229
27230 This example will let the library defaults be permitted on the MX port, where
27231 there's probably no identity verification anyway, but ups the ante on the
27232 submission ports where the administrator might have some influence on the
27233 choice of clients used:
27234 .code
27235 # OpenSSL variant; see man ciphers(1)
27236 tls_require_ciphers = ${if =={$received_port}{25}\
27237                            {DEFAULT}\
27238                            {HIGH:!MD5:!SHA1}}
27239 .endd
27240
27241
27242
27243 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
27244          "SECTreqciphgnu"
27245 .cindex "GnuTLS" "specifying parameters for"
27246 .cindex "TLS" "specifying ciphers (GnuTLS)"
27247 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
27248 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
27249 .cindex "TLS" "specifying protocols (GnuTLS)"
27250 .cindex "TLS" "specifying priority string (GnuTLS)"
27251 .oindex "&%tls_require_ciphers%&" "GnuTLS"
27252 The GnuTLS library allows the caller to provide a "priority string", documented
27253 as part of the &[gnutls_priority_init]& function.  This is very similar to the
27254 ciphersuite specification in OpenSSL.
27255
27256 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
27257 and controls both protocols and ciphers.
27258
27259 The &%tls_require_ciphers%& option is available both as an global option,
27260 controlling how Exim behaves as a server, and also as an option of the
27261 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
27262 the value is string expanded.  The resulting string is not an Exim list and
27263 the string is given to the GnuTLS library, so that Exim does not need to be
27264 aware of future feature enhancements of GnuTLS.
27265
27266 Documentation of the strings accepted may be found in the GnuTLS manual, under
27267 "Priority strings".  This is online as
27268 &url(http://www.gnutls.org/manual/html_node/Priority-Strings.html),
27269 but beware that this relates to GnuTLS 3, which may be newer than the version
27270 installed on your system.  If you are using GnuTLS 3,
27271 then the example code
27272 &url(http://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
27273 on that site can be used to test a given string.
27274
27275 For example:
27276 .code
27277 # Disable older versions of protocols
27278 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
27279 .endd
27280
27281 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
27282 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
27283 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
27284
27285 This example will let the library defaults be permitted on the MX port, where
27286 there's probably no identity verification anyway, and lowers security further
27287 by increasing compatibility; but this ups the ante on the submission ports
27288 where the administrator might have some influence on the choice of clients
27289 used:
27290 .code
27291 # GnuTLS variant
27292 tls_require_ciphers = ${if =={$received_port}{25}\
27293                            {NORMAL:%COMPAT}\
27294                            {SECURE128}}
27295 .endd
27296
27297
27298 .section "Configuring an Exim server to use TLS" "SECID182"
27299 .cindex "TLS" "configuring an Exim server"
27300 When Exim has been built with TLS support, it advertises the availability of
27301 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
27302 but not to any others. The default value of this option is *, which means
27303 that STARTTLS is alway advertised.  Set it to blank to never advertise;
27304 this is reasonble for systems that want to use TLS only as a client.
27305
27306 If STARTTLS is to be used you
27307 need to set some other options in order to make TLS available.
27308
27309 If a client issues a STARTTLS command and there is some configuration
27310 problem in the server, the command is rejected with a 454 error. If the client
27311 persists in trying to issue SMTP commands, all except QUIT are rejected
27312 with the error
27313 .code
27314 554 Security failure
27315 .endd
27316 If a STARTTLS command is issued within an existing TLS session, it is
27317 rejected with a 554 error code.
27318
27319 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
27320 must be set to match some hosts. The default is * which matches all hosts.
27321
27322 If this is all you do, TLS encryption will be enabled but not authentication -
27323 meaning that the peer has no assurance it is actually you he is talking to.
27324 You gain protection from a passive sniffer listening on the wire but not
27325 from someone able to intercept the communication.
27326
27327 Further protection requires some further configuration at the server end.
27328
27329 It is rumoured that all existing clients that support TLS/SSL use RSA
27330 encryption. To make this work you need to set, in the server,
27331 .code
27332 tls_certificate = /some/file/name
27333 tls_privatekey = /some/file/name
27334 .endd
27335 These options are, in fact, expanded strings, so you can make them depend on
27336 the identity of the client that is connected if you wish. The first file
27337 contains the server's X509 certificate, and the second contains the private key
27338 that goes with it. These files need to be
27339 PEM format and readable by the Exim user, and must
27340 always be given as full path names.
27341 The key must not be password-protected.
27342 They can be the same file if both the
27343 certificate and the key are contained within it. If &%tls_privatekey%& is not
27344 set, or if its expansion is forced to fail or results in an empty string, this
27345 is assumed to be the case. The certificate file may also contain intermediate
27346 certificates that need to be sent to the client to enable it to authenticate
27347 the server's certificate.
27348
27349 If you do not understand about certificates and keys, please try to find a
27350 source of this background information, which is not Exim-specific. (There are a
27351 few comments below in section &<<SECTcerandall>>&.)
27352
27353 &*Note*&: These options do not apply when Exim is operating as a client &--
27354 they apply only in the case of a server. If you need to use a certificate in an
27355 Exim client, you must set the options of the same names in an &(smtp)&
27356 transport.
27357
27358 With just these options, an Exim server will be able to use TLS. It does not
27359 require the client to have a certificate (but see below for how to insist on
27360 this). There is one other option that may be needed in other situations. If
27361 .code
27362 tls_dhparam = /some/file/name
27363 .endd
27364 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
27365 with the parameters contained in the file.
27366 Set this to &`none`& to disable use of DH entirely, by making no prime
27367 available:
27368 .code
27369 tls_dhparam = none
27370 .endd
27371 This may also be set to a string identifying a standard prime to be used for
27372 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
27373 used is &`ike23`&.  There are a few standard primes available, see the
27374 documentation for &%tls_dhparam%& for the complete list.
27375
27376 See the command
27377 .code
27378 openssl dhparam
27379 .endd
27380 for a way of generating file data.
27381
27382 The strings supplied for these three options are expanded every time a client
27383 host connects. It is therefore possible to use different certificates and keys
27384 for different hosts, if you so wish, by making use of the client's IP address
27385 in &$sender_host_address$& to control the expansion. If a string expansion is
27386 forced to fail, Exim behaves as if the option is not set.
27387
27388 .cindex "cipher" "logging"
27389 .cindex "log" "TLS cipher"
27390 .vindex "&$tls_in_cipher$&"
27391 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
27392 an incoming TLS connection. It is included in the &'Received:'& header of an
27393 incoming message (by default &-- you can, of course, change this), and it is
27394 also included in the log line that records a message's arrival, keyed by
27395 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
27396 condition can be used to test for specific cipher suites in ACLs.
27397
27398 Once TLS has been established, the ACLs that run for subsequent SMTP commands
27399 can check the name of the cipher suite and vary their actions accordingly. The
27400 cipher suite names vary, depending on which TLS library is being used. For
27401 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
27402 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
27403 documentation for more details.
27404
27405 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
27406 (again depending on the &%tls_cipher%& log selector).
27407
27408
27409 .section "Requesting and verifying client certificates" "SECID183"
27410 .cindex "certificate" "verification of client"
27411 .cindex "TLS" "client certificate verification"
27412 If you want an Exim server to request a certificate when negotiating a TLS
27413 session with a client, you must set either &%tls_verify_hosts%& or
27414 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
27415 apply to all TLS connections. For any host that matches one of these options,
27416 Exim requests a certificate as part of the setup of the TLS session. The
27417 contents of the certificate are verified by comparing it with a list of
27418 expected certificates.
27419 These may be the system default set (depending on library version),
27420 an explicit file or,
27421 depending on library version, a directory, identified by
27422 &%tls_verify_certificates%&.
27423
27424 A file can contain multiple certificates, concatenated end to end. If a
27425 directory is used
27426 (OpenSSL only),
27427 each certificate must be in a separate file, with a name (or a symbolic link)
27428 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
27429 certificate. You can compute the relevant hash by running the command
27430 .code
27431 openssl x509 -hash -noout -in /cert/file
27432 .endd
27433 where &_/cert/file_& contains a single certificate.
27434
27435 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
27436 what happens if the client does not supply a certificate, or if the certificate
27437 does not match any of the certificates in the collection named by
27438 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
27439 attempt to set up a TLS session is aborted, and the incoming connection is
27440 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
27441 session continues. ACLs that run for subsequent SMTP commands can detect the
27442 fact that no certificate was verified, and vary their actions accordingly. For
27443 example, you can insist on a certificate before accepting a message for
27444 relaying, but not when the message is destined for local delivery.
27445
27446 .vindex "&$tls_in_peerdn$&"
27447 When a client supplies a certificate (whether it verifies or not), the value of
27448 the Distinguished Name of the certificate is made available in the variable
27449 &$tls_in_peerdn$& during subsequent processing of the message.
27450
27451 .cindex "log" "distinguished name"
27452 Because it is often a long text string, it is not included in the log line or
27453 &'Received:'& header by default. You can arrange for it to be logged, keyed by
27454 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
27455 &%received_header_text%& to change the &'Received:'& header. When no
27456 certificate is supplied, &$tls_in_peerdn$& is empty.
27457
27458
27459 .section "Revoked certificates" "SECID184"
27460 .cindex "TLS" "revoked certificates"
27461 .cindex "revocation list"
27462 .cindex "certificate" "revocation list"
27463 .cindex "OCSP" "stapling"
27464 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
27465 certificates are revoked. If you have such a list, you can pass it to an Exim
27466 server using the global option called &%tls_crl%& and to an Exim client using
27467 an identically named option for the &(smtp)& transport. In each case, the value
27468 of the option is expanded and must then be the name of a file that contains a
27469 CRL in PEM format.
27470 The downside is that clients have to periodically re-download a potentially huge
27471 file from every certificate authority they know of.
27472
27473 The way with most moving parts at query time is Online Certificate
27474 Status Protocol (OCSP), where the client verifies the certificate
27475 against an OCSP server run by the CA.  This lets the CA track all
27476 usage of the certs.  It requires running software with access to the
27477 private key of the CA, to sign the responses to the OCSP queries.  OCSP
27478 is based on HTTP and can be proxied accordingly.
27479
27480 The only widespread OCSP server implementation (known to this writer)
27481 comes as part of OpenSSL and aborts on an invalid request, such as
27482 connecting to the port and then disconnecting.  This requires
27483 re-entering the passphrase each time some random client does this.
27484
27485 The third way is OCSP Stapling; in this, the server using a certificate
27486 issued by the CA periodically requests an OCSP proof of validity from
27487 the OCSP server, then serves it up inline as part of the TLS
27488 negotiation.   This approach adds no extra round trips, does not let the
27489 CA track users, scales well with number of certs issued by the CA and is
27490 resilient to temporary OCSP server failures, as long as the server
27491 starts retrying to fetch an OCSP proof some time before its current
27492 proof expires.  The downside is that it requires server support.
27493
27494 Unless Exim is built with the support disabled,
27495 or with GnuTLS earlier than version 3.3.16 / 3.4.8
27496 support for OCSP stapling is included.
27497
27498 There is a global option called &%tls_ocsp_file%&.
27499 The file specified therein is expected to be in DER format, and contain
27500 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
27501 option will be re-expanded for SNI, if the &%tls_certificate%& option
27502 contains &`tls_in_sni`&, as per other TLS options.
27503
27504 Exim does not at this time implement any support for fetching a new OCSP
27505 proof.  The burden is on the administrator to handle this, outside of
27506 Exim.  The file specified should be replaced atomically, so that the
27507 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
27508 on each connection, so a new file will be handled transparently on the
27509 next connection.
27510
27511 When built with OpenSSL Exim will check for a valid next update timestamp
27512 in the OCSP proof; if not present, or if the proof has expired, it will be
27513 ignored.
27514
27515 For the client to be able to verify the stapled OCSP the server must
27516 also supply, in its stapled information, any intermediate
27517 certificates for the chain leading to the OCSP proof from the signer
27518 of the server certificate.  There may be zero or one such. These
27519 intermediate certificates should be added to the server OCSP stapling
27520 file named by &%tls_ocsp_file%&.
27521
27522 Note that the proof only covers the terminal server certificate,
27523 not any of the chain from CA to it.
27524
27525 There is no current way to staple a proof for a client certificate.
27526
27527 .code
27528   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
27529   OCSP server is supplied.  The server URL may be included in the
27530   server certificate, if the CA is helpful.
27531
27532   One failure mode seen was the OCSP Signer cert expiring before the end
27533   of validity of the OCSP proof. The checking done by Exim/OpenSSL
27534   noted this as invalid overall, but the re-fetch script did not.
27535 .endd
27536
27537
27538
27539
27540 .section "Configuring an Exim client to use TLS" "SECID185"
27541 .cindex "cipher" "logging"
27542 .cindex "log" "TLS cipher"
27543 .cindex "log" "distinguished name"
27544 .cindex "TLS" "configuring an Exim client"
27545 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
27546 deliveries as well as to incoming, the latter one causing logging of the
27547 server certificate's DN. The remaining client configuration for TLS is all
27548 within the &(smtp)& transport.
27549
27550 It is not necessary to set any options to have TLS work in the &(smtp)&
27551 transport. If Exim is built with TLS support, and TLS is advertised by a
27552 server, the &(smtp)& transport always tries to start a TLS session. However,
27553 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
27554 transport) to a list of server hosts for which TLS should not be used.
27555
27556 If you do not want Exim to attempt to send messages unencrypted when an attempt
27557 to set up an encrypted connection fails in any way, you can set
27558 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
27559 those hosts, delivery is always deferred if an encrypted connection cannot be
27560 set up. If there are any other hosts for the address, they are tried in the
27561 usual way.
27562
27563 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
27564 the message unencrypted. It always does this if the response to STARTTLS is
27565 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
27566 session after a success response code, what happens is controlled by the
27567 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
27568 delivery to this host is deferred, and other hosts (if available) are tried. If
27569 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
27570 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
27571 negotiation fails, Exim closes the current connection (because it is in an
27572 unknown state), opens a new one to the same host, and then tries the delivery
27573 unencrypted.
27574
27575 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
27576 transport provide the client with a certificate, which is passed to the server
27577 if it requests it. If the server is Exim, it will request a certificate only if
27578 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
27579
27580 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
27581 specifies a collection of expected server certificates.
27582 These may be the system default set (depending on library version),
27583 a file or,
27584 depending on library version, a directory,
27585 must name a file or,
27586 for OpenSSL only (not GnuTLS), a directory.
27587 The client verifies the server's certificate
27588 against this collection, taking into account any revoked certificates that are
27589 in the list defined by &%tls_crl%&.
27590 Failure to verify fails the TLS connection unless either of the
27591 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
27592
27593 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
27594 certificate verification to the listed servers.  Verification either must
27595 or need not succeed respectively.
27596
27597 The &(smtp)& transport has two OCSP-related options:
27598 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
27599 is requested and required for the connection to proceed.  The default
27600 value is empty.
27601 &%hosts_request_ocsp%&; a host-list for which (additionally)
27602 a Certificate Status is requested (but not necessarily verified).  The default
27603 value is "*" meaning that requests are made unless configured
27604 otherwise.
27605
27606 The host(s) should also be in &%hosts_require_tls%&, and
27607 &%tls_verify_certificates%& configured for the transport,
27608 for OCSP to be relevant.
27609
27610 If
27611 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
27612 list of permitted cipher suites. If either of these checks fails, delivery to
27613 the current host is abandoned, and the &(smtp)& transport tries to deliver to
27614 alternative hosts, if any.
27615
27616  &*Note*&:
27617 These options must be set in the &(smtp)& transport for Exim to use TLS when it
27618 is operating as a client. Exim does not assume that a server certificate (set
27619 by the global options of the same name) should also be used when operating as a
27620 client.
27621
27622 .vindex "&$host$&"
27623 .vindex "&$host_address$&"
27624 All the TLS options in the &(smtp)& transport are expanded before use, with
27625 &$host$& and &$host_address$& containing the name and address of the server to
27626 which the client is connected. Forced failure of an expansion causes Exim to
27627 behave as if the relevant option were unset.
27628
27629 .vindex &$tls_out_bits$&
27630 .vindex &$tls_out_cipher$&
27631 .vindex &$tls_out_peerdn$&
27632 .vindex &$tls_out_sni$&
27633 Before an SMTP connection is established, the
27634 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
27635 variables are emptied. (Until the first connection, they contain the values
27636 that were set when the message was received.) If STARTTLS is subsequently
27637 successfully obeyed, these variables are set to the relevant values for the
27638 outgoing connection.
27639
27640
27641
27642 .section "Use of TLS Server Name Indication" "SECTtlssni"
27643 .cindex "TLS" "Server Name Indication"
27644 .vindex "&$tls_in_sni$&"
27645 .oindex "&%tls_in_sni%&"
27646 With TLS1.0 or above, there is an extension mechanism by which extra
27647 information can be included at various points in the protocol.  One of these
27648 extensions, documented in RFC 6066 (and before that RFC 4366) is
27649 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
27650 client in the initial handshake, so that the server can examine the servername
27651 within and possibly choose to use different certificates and keys (and more)
27652 for this session.
27653
27654 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
27655 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
27656 address.
27657
27658 With SMTP to MX, there are the same problems here as in choosing the identity
27659 against which to validate a certificate: you can't rely on insecure DNS to
27660 provide the identity which you then cryptographically verify.  So this will
27661 be of limited use in that environment.
27662
27663 With SMTP to Submission, there is a well-defined hostname which clients are
27664 connecting to and can validate certificates against.  Thus clients &*can*&
27665 choose to include this information in the TLS negotiation.  If this becomes
27666 wide-spread, then hosters can choose to present different certificates to
27667 different clients.  Or even negotiate different cipher suites.
27668
27669 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
27670 if not empty, will be sent on a TLS session as part of the handshake.  There's
27671 nothing more to it.  Choosing a sensible value not derived insecurely is the
27672 only point of caution.  The &$tls_out_sni$& variable will be set to this string
27673 for the lifetime of the client connection (including during authentication).
27674
27675 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
27676 received from a client.
27677 It can be logged with the &%log_selector%& item &`+tls_sni`&.
27678
27679 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
27680 option (prior to expansion) then the following options will be re-expanded
27681 during TLS session handshake, to permit alternative values to be chosen:
27682
27683 .ilist
27684 .vindex "&%tls_certificate%&"
27685 &%tls_certificate%&
27686 .next
27687 .vindex "&%tls_crl%&"
27688 &%tls_crl%&
27689 .next
27690 .vindex "&%tls_privatekey%&"
27691 &%tls_privatekey%&
27692 .next
27693 .vindex "&%tls_verify_certificates%&"
27694 &%tls_verify_certificates%&
27695 .next
27696 .vindex "&%tls_ocsp_file%&"
27697 &%tls_ocsp_file%&
27698 .endlist
27699
27700 Great care should be taken to deal with matters of case, various injection
27701 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
27702 can always be referenced; it is important to remember that &$tls_in_sni$& is
27703 arbitrary unverified data provided prior to authentication.
27704 Further, the initial certificate is loaded before SNI is arrived, so
27705 an expansion for &%tls_certificate%& must have a default which is used
27706 when &$tls_in_sni$& is empty.
27707
27708 The Exim developers are proceeding cautiously and so far no other TLS options
27709 are re-expanded.
27710
27711 When Exim is built against OpenSSL, OpenSSL must have been built with support
27712 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
27713 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
27714 see &`-servername`& in the output, then OpenSSL has support.
27715
27716 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
27717 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
27718 built, then you have SNI support).
27719
27720
27721
27722 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
27723          "SECTmulmessam"
27724 .cindex "multiple SMTP deliveries with TLS"
27725 .cindex "TLS" "multiple message deliveries"
27726 .new
27727 Exim sends multiple messages down the same TCP/IP connection by starting up
27728 an entirely new delivery process for each message, passing the socket from
27729 one process to the next. This implementation does not fit well with the use
27730 of TLS, because there is quite a lot of state information associated with a TLS
27731 connection, not just a socket identification. Passing all the state information
27732 to a new process is not feasible. Consequently, for sending using TLS Exim
27733 starts an additional proxy process for handling the encryption, piping the
27734 unencrypted data stream from and to the delivery processes.
27735
27736 An older mode of operation can be enabled on a per-host basis by the
27737 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
27738 this list the proxy process descibed above is not used; instead Exim
27739 .wen
27740 shuts down an existing TLS session being run by the delivery process
27741 before passing the socket to a new process. The new process may then
27742 try to start a new TLS session, and if successful, may try to re-authenticate
27743 if AUTH is in use, before sending the next message.
27744
27745 The RFC is not clear as to whether or not an SMTP session continues in clear
27746 after TLS has been shut down, or whether TLS may be restarted again later, as
27747 just described. However, if the server is Exim, this shutdown and
27748 reinitialization works. It is not known which (if any) other servers operate
27749 successfully if the client closes a TLS session and continues with unencrypted
27750 SMTP, but there are certainly some that do not work. For such servers, Exim
27751 should not pass the socket to another process, because the failure of the
27752 subsequent attempt to use it would cause Exim to record a temporary host error,
27753 and delay other deliveries to that host.
27754
27755 To test for this case, Exim sends an EHLO command to the server after
27756 closing down the TLS session. If this fails in any way, the connection is
27757 closed instead of being passed to a new delivery process, but no retry
27758 information is recorded.
27759
27760 There is also a manual override; you can set &%hosts_nopass_tls%& on the
27761 &(smtp)& transport to match those hosts for which Exim should not pass
27762 connections to new processes if TLS has been used.
27763
27764
27765
27766
27767 .section "Certificates and all that" "SECTcerandall"
27768 .cindex "certificate" "references to discussion"
27769 In order to understand fully how TLS works, you need to know about
27770 certificates, certificate signing, and certificate authorities. This is not the
27771 place to give a tutorial, especially as I do not know very much about it
27772 myself. Some helpful introduction can be found in the FAQ for the SSL addition
27773 to Apache, currently at
27774 .display
27775 &url(http://www.modssl.org/docs/2.7/ssl_faq.html#ToC24)
27776 .endd
27777 Other parts of the &'modssl'& documentation are also helpful, and have
27778 links to further files.
27779 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
27780 0-201-61598-3), contains both introductory and more in-depth descriptions.
27781 Some sample programs taken from the book are available from
27782 .display
27783 &url(http://www.rtfm.com/openssl-examples/)
27784 .endd
27785
27786
27787 .section "Certificate chains" "SECID186"
27788 The file named by &%tls_certificate%& may contain more than one
27789 certificate. This is useful in the case where the certificate that is being
27790 sent is validated by an intermediate certificate which the other end does
27791 not have. Multiple certificates must be in the correct order in the file.
27792 First the host's certificate itself, then the first intermediate
27793 certificate to validate the issuer of the host certificate, then the next
27794 intermediate certificate to validate the issuer of the first intermediate
27795 certificate, and so on, until finally (optionally) the root certificate.
27796 The root certificate must already be trusted by the recipient for
27797 validation to succeed, of course, but if it's not preinstalled, sending the
27798 root certificate along with the rest makes it available for the user to
27799 install if the receiving end is a client MUA that can interact with a user.
27800
27801 Note that certificates using MD5 are unlikely to work on today's Internet;
27802 even if your libraries allow loading them for use in Exim when acting as a
27803 server, increasingly clients will not accept such certificates.  The error
27804 diagnostics in such a case can be frustratingly vague.
27805
27806
27807
27808 .section "Self-signed certificates" "SECID187"
27809 .cindex "certificate" "self-signed"
27810 You can create a self-signed certificate using the &'req'& command provided
27811 with OpenSSL, like this:
27812 . ==== Do not shorten the duration here without reading and considering
27813 . ==== the text below.  Please leave it at 9999 days.
27814 .code
27815 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
27816             -days 9999 -nodes
27817 .endd
27818 &_file1_& and &_file2_& can be the same file; the key and the certificate are
27819 delimited and so can be identified independently. The &%-days%& option
27820 specifies a period for which the certificate is valid. The &%-nodes%& option is
27821 important: if you do not set it, the key is encrypted with a passphrase
27822 that you are prompted for, and any use that is made of the key causes more
27823 prompting for the passphrase. This is not helpful if you are going to use
27824 this certificate and key in an MTA, where prompting is not possible.
27825
27826 . ==== I expect to still be working 26 years from now.  The less technical
27827 . ==== debt I create, in terms of storing up trouble for my later years, the
27828 . ==== happier I will be then.  We really have reached the point where we
27829 . ==== should start, at the very least, provoking thought and making folks
27830 . ==== pause before proceeding, instead of leaving all the fixes until two
27831 . ==== years before 2^31 seconds after the 1970 Unix epoch.
27832 . ==== -pdp, 2012
27833 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
27834 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
27835 the above command might produce a date in the past.  Think carefully about
27836 the lifetime of the systems you're deploying, and either reduce the duration
27837 of the certificate or reconsider your platform deployment.  (At time of
27838 writing, reducing the duration is the most likely choice, but the inexorable
27839 progression of time takes us steadily towards an era where this will not
27840 be a sensible resolution).
27841
27842 A self-signed certificate made in this way is sufficient for testing, and
27843 may be adequate for all your requirements if you are mainly interested in
27844 encrypting transfers, and not in secure identification.
27845
27846 However, many clients require that the certificate presented by the server be a
27847 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
27848 certificate. In this situation, the self-signed certificate described above
27849 must be installed on the client host as a trusted root &'certification
27850 authority'& (CA), and the certificate used by Exim must be a user certificate
27851 signed with that self-signed certificate.
27852
27853 For information on creating self-signed CA certificates and using them to sign
27854 user certificates, see the &'General implementation overview'& chapter of the
27855 Open-source PKI book, available online at
27856 &url(http://ospkibook.sourceforge.net/).
27857 .ecindex IIDencsmtp1
27858 .ecindex IIDencsmtp2
27859
27860
27861
27862 . ////////////////////////////////////////////////////////////////////////////
27863 . ////////////////////////////////////////////////////////////////////////////
27864
27865 .chapter "Access control lists" "CHAPACL"
27866 .scindex IIDacl "&ACL;" "description"
27867 .cindex "control of incoming mail"
27868 .cindex "message" "controlling incoming"
27869 .cindex "policy control" "access control lists"
27870 Access Control Lists (ACLs) are defined in a separate section of the run time
27871 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
27872 name, terminated by a colon. Here is a complete ACL section that contains just
27873 one very small ACL:
27874 .code
27875 begin acl
27876 small_acl:
27877   accept   hosts = one.host.only
27878 .endd
27879 You can have as many lists as you like in the ACL section, and the order in
27880 which they appear does not matter. The lists are self-terminating.
27881
27882 The majority of ACLs are used to control Exim's behaviour when it receives
27883 certain SMTP commands. This applies both to incoming TCP/IP connections, and
27884 when a local process submits a message using SMTP by specifying the &%-bs%&
27885 option. The most common use is for controlling which recipients are accepted
27886 in incoming messages. In addition, you can define an ACL that is used to check
27887 local non-SMTP messages. The default configuration file contains an example of
27888 a realistic ACL for checking RCPT commands. This is discussed in chapter
27889 &<<CHAPdefconfil>>&.
27890
27891
27892 .section "Testing ACLs" "SECID188"
27893 The &%-bh%& command line option provides a way of testing your ACL
27894 configuration locally by running a fake SMTP session with which you interact.
27895
27896
27897 .section "Specifying when ACLs are used" "SECID189"
27898 .cindex "&ACL;" "options for specifying"
27899 In order to cause an ACL to be used, you have to name it in one of the relevant
27900 options in the main part of the configuration. These options are:
27901 .cindex "AUTH" "ACL for"
27902 .cindex "DATA" "ACLs for"
27903 .cindex "ETRN" "ACL for"
27904 .cindex "EXPN" "ACL for"
27905 .cindex "HELO" "ACL for"
27906 .cindex "EHLO" "ACL for"
27907 .cindex "DKIM" "ACL for"
27908 .cindex "MAIL" "ACL for"
27909 .cindex "QUIT, ACL for"
27910 .cindex "RCPT" "ACL for"
27911 .cindex "STARTTLS, ACL for"
27912 .cindex "VRFY" "ACL for"
27913 .cindex "SMTP" "connection, ACL for"
27914 .cindex "non-SMTP messages" "ACLs for"
27915 .cindex "MIME content scanning" "ACL for"
27916 .cindex "PRDR" "ACL for"
27917
27918 .table2 140pt
27919 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
27920 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
27921 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
27922 .irow &%acl_smtp_auth%&        "ACL for AUTH"
27923 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
27924 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
27925 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
27926 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
27927 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
27928 .irow &%acl_smtp_expn%&        "ACL for EXPN"
27929 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
27930 .irow &%acl_smtp_mail%&        "ACL for MAIL"
27931 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
27932 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
27933 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
27934 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
27935 .irow &%acl_smtp_quit%&        "ACL for QUIT"
27936 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
27937 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
27938 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
27939 .endtable
27940
27941 For example, if you set
27942 .code
27943 acl_smtp_rcpt = small_acl
27944 .endd
27945 the little ACL defined above is used whenever Exim receives a RCPT command
27946 in an SMTP dialogue. The majority of policy tests on incoming messages can be
27947 done when RCPT commands arrive. A rejection of RCPT should cause the
27948 sending MTA to give up on the recipient address contained in the RCPT
27949 command, whereas rejection at other times may cause the client MTA to keep on
27950 trying to deliver the message. It is therefore recommended that you do as much
27951 testing as possible at RCPT time.
27952
27953
27954 .section "The non-SMTP ACLs" "SECID190"
27955 .cindex "non-SMTP messages" "ACLs for"
27956 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
27957 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
27958 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
27959 the state of the SMTP connection such as encryption and authentication) are not
27960 relevant and are forbidden in these ACLs. However, the sender and recipients
27961 are known, so the &%senders%& and &%sender_domains%& conditions and the
27962 &$sender_address$& and &$recipients$& variables can be used. Variables such as
27963 &$authenticated_sender$& are also available. You can specify added header lines
27964 in any of these ACLs.
27965
27966 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
27967 non-SMTP message, before any of the message has been read. (This is the
27968 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
27969 batched SMTP input, it runs after the DATA command has been reached. The
27970 result of this ACL is ignored; it cannot be used to reject a message. If you
27971 really need to, you could set a value in an ACL variable here and reject based
27972 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
27973 controls, and in particular, it can be used to set
27974 .code
27975 control = suppress_local_fixups
27976 .endd
27977 This cannot be used in the other non-SMTP ACLs because by the time they are
27978 run, it is too late.
27979
27980 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
27981 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
27982
27983 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
27984 kind of rejection is treated as permanent, because there is no way of sending a
27985 temporary error for these kinds of message.
27986
27987
27988 .section "The SMTP connect ACL" "SECID191"
27989 .cindex "SMTP" "connection, ACL for"
27990 .oindex &%smtp_banner%&
27991 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
27992 session, after the test specified by &%host_reject_connection%& (which is now
27993 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
27994 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
27995 the message override the banner message that is otherwise specified by the
27996 &%smtp_banner%& option.
27997
27998
27999 .section "The EHLO/HELO ACL" "SECID192"
28000 .cindex "EHLO" "ACL for"
28001 .cindex "HELO" "ACL for"
28002 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28003 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28004 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28005 Note that a client may issue more than one EHLO or HELO command in an SMTP
28006 session, and indeed is required to issue a new EHLO or HELO after successfully
28007 setting up encryption following a STARTTLS command.
28008
28009 Note also that a deny neither forces the client to go away nor means that
28010 mail will be refused on the connection.  Consider checking for
28011 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28012
28013 If the command is accepted by an &%accept%& verb that has a &%message%&
28014 modifier, the message may not contain more than one line (it will be truncated
28015 at the first newline and a panic logged if it does). Such a message cannot
28016 affect the EHLO options that are listed on the second and subsequent lines of
28017 an EHLO response.
28018
28019
28020 .section "The DATA ACLs" "SECID193"
28021 .cindex "DATA" "ACLs for"
28022 Two ACLs are associated with the DATA command, because it is two-stage
28023 command, with two responses being sent to the client.
28024 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28025 is obeyed. This gives you control after all the RCPT commands, but before
28026 the message itself is received. It offers the opportunity to give a negative
28027 response to the DATA command before the data is transmitted. Header lines
28028 added by MAIL or RCPT ACLs are not visible at this time, but any that
28029 are defined here are visible when the &%acl_smtp_data%& ACL is run.
28030
28031 You cannot test the contents of the message, for example, to verify addresses
28032 in the headers, at RCPT time or when the DATA command is received. Such
28033 tests have to appear in the ACL that is run after the message itself has been
28034 received, before the final response to the DATA command is sent. This is
28035 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
28036 associated with the DATA command.
28037
28038 .cindex CHUNKING "BDAT command"
28039 .cindex BDAT "SMTP command"
28040 .cindex "RFC 3030" CHUNKING
28041 If CHUNKING was advertised and a BDAT command sequence is received,
28042 the &%acl_smtp_predata%& ACL is not run.
28043 . XXX why not?  It should be possible, for the first BDAT.
28044 The &%acl_smtp_data%& is run after the last BDAT command and all of
28045 the data specified is received.
28046
28047 For both of these ACLs, it is not possible to reject individual recipients. An
28048 error response rejects the entire message. Unfortunately, it is known that some
28049 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
28050 before or after the data) correctly &-- they keep the message on their queues
28051 and try again later, but that is their problem, though it does waste some of
28052 your resources.
28053
28054 The &%acl_smtp_data%& ACL is run after
28055 the &%acl_smtp_data_prdr%&,
28056 the &%acl_smtp_dkim%&
28057 and the &%acl_smtp_mime%& ACLs.
28058
28059 .section "The SMTP DKIM ACL" "SECTDKIMACL"
28060 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
28061 enabled (which is the default).
28062
28063 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
28064 received, and is executed for each DKIM signature found in a message.  If not
28065 otherwise specified, the default action is to accept.
28066
28067 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
28068
28069 For details on the operation of DKIM, see chapter &<<CHAPdkim>>&.
28070
28071
28072 .section "The SMTP MIME ACL" "SECID194"
28073 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
28074 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28075
28076 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28077
28078
28079 .section "The SMTP PRDR ACL" "SECTPRDRACL"
28080 .cindex "PRDR" "ACL for"
28081 .oindex "&%prdr_enable%&"
28082 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
28083 with PRDR support enabled (which is the default).
28084 It becomes active only when the PRDR feature is negotiated between
28085 client and server for a message, and more than one recipient
28086 has been accepted.
28087
28088 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
28089 has been received, and is executed once for each recipient of the message
28090 with &$local_part$& and &$domain$& valid.
28091 The test may accept, defer or deny for individual recipients.
28092 The &%acl_smtp_data%& will still be called after this ACL and
28093 can reject the message overall, even if this ACL has accepted it
28094 for some or all recipients.
28095
28096 PRDR may be used to support per-user content filtering.  Without it
28097 one must defer any recipient after the first that has a different
28098 content-filter configuration.  With PRDR, the RCPT-time check
28099 .cindex "PRDR" "variable for"
28100 for this can be disabled when the variable &$prdr_requested$&
28101 is &"yes"&.
28102 Any required difference in behaviour of the main DATA-time
28103 ACL should however depend on the PRDR-time ACL having run, as Exim
28104 will avoid doing so in some situations (e.g.  single-recipient mails).
28105
28106 See also the &%prdr_enable%& global option
28107 and the &%hosts_try_prdr%& smtp transport option.
28108
28109 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
28110 If the ACL is not defined, processing completes as if
28111 the feature was not requested by the client.
28112
28113 .section "The QUIT ACL" "SECTQUITACL"
28114 .cindex "QUIT, ACL for"
28115 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
28116 does not affect the response code to QUIT, which is always 221. Thus, the ACL
28117 does not in fact control any access.
28118 For this reason, it may only accept
28119 or warn as its final result.
28120
28121 This ACL can be used for tasks such as custom logging at the end of an SMTP
28122 session. For example, you can use ACL variables in other ACLs to count
28123 messages, recipients, etc., and log the totals at QUIT time using one or
28124 more &%logwrite%& modifiers on a &%warn%& verb.
28125
28126 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
28127 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
28128
28129 You do not need to have a final &%accept%&, but if you do, you can use a
28130 &%message%& modifier to specify custom text that is sent as part of the 221
28131 response to QUIT.
28132
28133 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
28134 failure (for example, failure to open a log file, or when Exim is bombing out
28135 because it has detected an unrecoverable error), all SMTP commands from the
28136 client are given temporary error responses until QUIT is received or the
28137 connection is closed. In these special cases, the QUIT ACL does not run.
28138
28139
28140 .section "The not-QUIT ACL" "SECTNOTQUITACL"
28141 .vindex &$acl_smtp_notquit$&
28142 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
28143 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
28144 trouble, such as being unable to write to its log files, this ACL is not run,
28145 because it might try to do things (such as write to log files) that make the
28146 situation even worse.
28147
28148 Like the QUIT ACL, this ACL is provided to make it possible to do customized
28149 logging or to gather statistics, and its outcome is ignored. The &%delay%&
28150 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
28151 and &%warn%&.
28152
28153 .vindex &$smtp_notquit_reason$&
28154 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
28155 to a string that indicates the reason for the termination of the SMTP
28156 connection. The possible values are:
28157 .table2
28158 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
28159 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
28160 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
28161 .irow &`connection-lost`&          "The SMTP connection has been lost"
28162 .irow &`data-timeout`&             "Timeout while reading message data"
28163 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
28164 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
28165 .irow &`signal-exit`&              "SIGTERM or SIGINT"
28166 .irow &`synchronization-error`&    "SMTP synchronization error"
28167 .irow &`tls-failed`&               "TLS failed to start"
28168 .endtable
28169 In most cases when an SMTP connection is closed without having received QUIT,
28170 Exim sends an SMTP response message before actually closing the connection.
28171 With the exception of the &`acl-drop`& case, the default message can be
28172 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
28173 &%drop%& verb in another ACL, it is the message from the other ACL that is
28174 used.
28175
28176
28177 .section "Finding an ACL to use" "SECID195"
28178 .cindex "&ACL;" "finding which to use"
28179 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
28180 you can use different ACLs in different circumstances. For example,
28181 .code
28182 acl_smtp_rcpt = ${if ={25}{$interface_port} \
28183                      {acl_check_rcpt} {acl_check_rcpt_submit} }
28184 .endd
28185 In the default configuration file there are some example settings for
28186 providing an RFC 4409 message submission service on port 587 and a
28187 non-standard &"smtps"& service on port 465. You can use a string
28188 expansion like this to choose an ACL for MUAs on these ports which is
28189 more appropriate for this purpose than the default ACL on port 25.
28190
28191 The expanded string does not have to be the name of an ACL in the
28192 configuration file; there are other possibilities. Having expanded the
28193 string, Exim searches for an ACL as follows:
28194
28195 .ilist
28196 If the string begins with a slash, Exim uses it as a file name, and reads its
28197 contents as an ACL. The lines are processed in the same way as lines in the
28198 Exim configuration file. In particular, continuation lines are supported, blank
28199 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
28200 If the file does not exist or cannot be read, an error occurs (typically
28201 causing a temporary failure of whatever caused the ACL to be run). For example:
28202 .code
28203 acl_smtp_data = /etc/acls/\
28204   ${lookup{$sender_host_address}lsearch\
28205   {/etc/acllist}{$value}{default}}
28206 .endd
28207 This looks up an ACL file to use on the basis of the host's IP address, falling
28208 back to a default if the lookup fails. If an ACL is successfully read from a
28209 file, it is retained in memory for the duration of the Exim process, so that it
28210 can be re-used without having to re-read the file.
28211 .next
28212 If the string does not start with a slash, and does not contain any spaces,
28213 Exim searches the ACL section of the configuration for an ACL whose name
28214 matches the string.
28215 .next
28216 If no named ACL is found, or if the string contains spaces, Exim parses
28217 the string as an inline ACL. This can save typing in cases where you just
28218 want to have something like
28219 .code
28220 acl_smtp_vrfy = accept
28221 .endd
28222 in order to allow free use of the VRFY command. Such a string may contain
28223 newlines; it is processed in the same way as an ACL that is read from a file.
28224 .endlist
28225
28226
28227
28228
28229 .section "ACL return codes" "SECID196"
28230 .cindex "&ACL;" "return codes"
28231 Except for the QUIT ACL, which does not affect the SMTP return code (see
28232 section &<<SECTQUITACL>>& above), the result of running an ACL is either
28233 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
28234 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
28235 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
28236 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
28237 This also causes a 4&'xx'& return code.
28238
28239 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
28240 &"deny"&, because there is no mechanism for passing temporary errors to the
28241 submitters of non-SMTP messages.
28242
28243
28244 ACLs that are relevant to message reception may also return &"discard"&. This
28245 has the effect of &"accept"&, but causes either the entire message or an
28246 individual recipient address to be discarded. In other words, it is a
28247 blackholing facility. Use it with care.
28248
28249 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
28250 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
28251 RCPT ACL is to discard just the one recipient address. If there are no
28252 recipients left when the message's data is received, the DATA ACL is not
28253 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
28254 remaining recipients. The &"discard"& return is not permitted for the
28255 &%acl_smtp_predata%& ACL.
28256
28257 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
28258 is done on the address and the result determines the SMTP response.
28259
28260
28261 .cindex "&[local_scan()]& function" "when all recipients discarded"
28262 The &[local_scan()]& function is always run, even if there are no remaining
28263 recipients; it may create new recipients.
28264
28265
28266
28267 .section "Unset ACL options" "SECID197"
28268 .cindex "&ACL;" "unset options"
28269 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
28270 all the same. &*Note*&: These defaults apply only when the relevant ACL is
28271 not defined at all. For any defined ACL, the default action when control
28272 reaches the end of the ACL statements is &"deny"&.
28273
28274 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
28275 these two are ACLs that are used only for their side effects. They cannot be
28276 used to accept or reject anything.
28277
28278 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
28279 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
28280 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
28281 when the ACL is not defined is &"accept"&.
28282
28283 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
28284 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
28285 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
28286 messages over an SMTP connection. For an example, see the ACL in the default
28287 configuration file.
28288
28289
28290
28291
28292 .section "Data for message ACLs" "SECID198"
28293 .cindex "&ACL;" "data for message ACL"
28294 .vindex &$domain$&
28295 .vindex &$local_part$&
28296 .vindex &$sender_address$&
28297 .vindex &$sender_host_address$&
28298 .vindex &$smtp_command$&
28299 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
28300 that contain information about the host and the message's sender (for example,
28301 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
28302 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
28303 &$local_part$& are set from the argument address. The entire SMTP command
28304 is available in &$smtp_command$&.
28305
28306 When an ACL for the AUTH parameter of MAIL is running, the variables that
28307 contain information about the host are set, but &$sender_address$& is not yet
28308 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
28309 how it is used.
28310
28311 .vindex "&$message_size$&"
28312 The &$message_size$& variable is set to the value of the SIZE parameter on
28313 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
28314 that parameter is not given. The value is updated to the true message size by
28315 the time the final DATA ACL is run (after the message data has been
28316 received).
28317
28318 .vindex "&$rcpt_count$&"
28319 .vindex "&$recipients_count$&"
28320 The &$rcpt_count$& variable increases by one for each RCPT command received.
28321 The &$recipients_count$& variable increases by one each time a RCPT command is
28322 accepted, so while an ACL for RCPT is being processed, it contains the number
28323 of previously accepted recipients. At DATA time (for both the DATA ACLs),
28324 &$rcpt_count$& contains the total number of RCPT commands, and
28325 &$recipients_count$& contains the total number of accepted recipients.
28326
28327
28328
28329
28330
28331 .section "Data for non-message ACLs" "SECTdatfornon"
28332 .cindex "&ACL;" "data for non-message ACL"
28333 .vindex &$smtp_command_argument$&
28334 .vindex &$smtp_command$&
28335 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
28336 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
28337 and the entire SMTP command is available in &$smtp_command$&.
28338 These variables can be tested using a &%condition%& condition. For example,
28339 here is an ACL for use with AUTH, which insists that either the session is
28340 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
28341 does not permit authentication methods that use cleartext passwords on
28342 unencrypted connections.
28343 .code
28344 acl_check_auth:
28345   accept encrypted = *
28346   accept condition = ${if eq{${uc:$smtp_command_argument}}\
28347                      {CRAM-MD5}}
28348   deny   message   = TLS encryption or CRAM-MD5 required
28349 .endd
28350 (Another way of applying this restriction is to arrange for the authenticators
28351 that use cleartext passwords not to be advertised when the connection is not
28352 encrypted. You can use the generic &%server_advertise_condition%& authenticator
28353 option to do this.)
28354
28355
28356
28357 .section "Format of an ACL" "SECID199"
28358 .cindex "&ACL;" "format of"
28359 .cindex "&ACL;" "verbs, definition of"
28360 An individual ACL consists of a number of statements. Each statement starts
28361 with a verb, optionally followed by a number of conditions and &"modifiers"&.
28362 Modifiers can change the way the verb operates, define error and log messages,
28363 set variables, insert delays, and vary the processing of accepted messages.
28364
28365 If all the conditions are met, the verb is obeyed. The same condition may be
28366 used (with different arguments) more than once in the same statement. This
28367 provides a means of specifying an &"and"& conjunction between conditions. For
28368 example:
28369 .code
28370 deny  dnslists = list1.example
28371       dnslists = list2.example
28372 .endd
28373 If there are no conditions, the verb is always obeyed. Exim stops evaluating
28374 the conditions and modifiers when it reaches a condition that fails. What
28375 happens then depends on the verb (and in one case, on a special modifier). Not
28376 all the conditions make sense at every testing point. For example, you cannot
28377 test a sender address in the ACL that is run for a VRFY command.
28378
28379
28380 .section "ACL verbs" "SECID200"
28381 The ACL verbs are as follows:
28382
28383 .ilist
28384 .cindex "&%accept%& ACL verb"
28385 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
28386 of the conditions are not met, what happens depends on whether &%endpass%&
28387 appears among the conditions (for syntax see below). If the failing condition
28388 is before &%endpass%&, control is passed to the next ACL statement; if it is
28389 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
28390 check a RCPT command:
28391 .code
28392 accept domains = +local_domains
28393        endpass
28394        verify = recipient
28395 .endd
28396 If the recipient domain does not match the &%domains%& condition, control
28397 passes to the next statement. If it does match, the recipient is verified, and
28398 the command is accepted if verification succeeds. However, if verification
28399 fails, the ACL yields &"deny"&, because the failing condition is after
28400 &%endpass%&.
28401
28402 The &%endpass%& feature has turned out to be confusing to many people, so its
28403 use is not recommended nowadays. It is always possible to rewrite an ACL so
28404 that &%endpass%& is not needed, and it is no longer used in the default
28405 configuration.
28406
28407 .cindex "&%message%& ACL modifier" "with &%accept%&"
28408 If a &%message%& modifier appears on an &%accept%& statement, its action
28409 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
28410 (when an &%accept%& verb either accepts or passes control to the next
28411 statement), &%message%& can be used to vary the message that is sent when an
28412 SMTP command is accepted. For example, in a RCPT ACL you could have:
28413 .display
28414 &`accept  `&<&'some conditions'&>
28415 &`        message = OK, I will allow you through today`&
28416 .endd
28417 You can specify an SMTP response code, optionally followed by an &"extended
28418 response code"& at the start of the message, but the first digit must be the
28419 same as would be sent by default, which is 2 for an &%accept%& verb.
28420
28421 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
28422 an error message that is used when access is denied. This behaviour is retained
28423 for backward compatibility, but current &"best practice"& is to avoid the use
28424 of &%endpass%&.
28425
28426
28427 .next
28428 .cindex "&%defer%& ACL verb"
28429 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
28430 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
28431 &%defer%& is the same as &%deny%&, because there is no way of sending a
28432 temporary error. For a RCPT command, &%defer%& is much the same as using a
28433 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
28434 be used in any ACL, and even for a recipient it might be a simpler approach.
28435
28436
28437 .next
28438 .cindex "&%deny%& ACL verb"
28439 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
28440 the conditions are not met, control is passed to the next ACL statement. For
28441 example,
28442 .code
28443 deny dnslists = blackholes.mail-abuse.org
28444 .endd
28445 rejects commands from hosts that are on a DNS black list.
28446
28447
28448 .next
28449 .cindex "&%discard%& ACL verb"
28450 &%discard%&: This verb behaves like &%accept%&, except that it returns
28451 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
28452 that are concerned with receiving messages. When all the conditions are true,
28453 the sending entity receives a &"success"& response. However, &%discard%& causes
28454 recipients to be discarded. If it is used in an ACL for RCPT, just the one
28455 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
28456 message's recipients are discarded. Recipients that are discarded before DATA
28457 do not appear in the log line when the &%received_recipients%& log selector is set.
28458
28459 If the &%log_message%& modifier is set when &%discard%& operates,
28460 its contents are added to the line that is automatically written to the log.
28461 The &%message%& modifier operates exactly as it does for &%accept%&.
28462
28463
28464 .next
28465 .cindex "&%drop%& ACL verb"
28466 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
28467 forcibly closed after the 5&'xx'& error message has been sent. For example:
28468 .code
28469 drop   message   = I don't take more than 20 RCPTs
28470        condition = ${if > {$rcpt_count}{20}}
28471 .endd
28472 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
28473 The connection is always dropped after sending a 550 response.
28474
28475 .next
28476 .cindex "&%require%& ACL verb"
28477 &%require%&: If all the conditions are met, control is passed to the next ACL
28478 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
28479 example, when checking a RCPT command,
28480 .code
28481 require message = Sender did not verify
28482         verify  = sender
28483 .endd
28484 passes control to subsequent statements only if the message's sender can be
28485 verified. Otherwise, it rejects the command. Note the positioning of the
28486 &%message%& modifier, before the &%verify%& condition. The reason for this is
28487 discussed in section &<<SECTcondmodproc>>&.
28488
28489 .next
28490 .cindex "&%warn%& ACL verb"
28491 &%warn%&: If all the conditions are true, a line specified by the
28492 &%log_message%& modifier is written to Exim's main log. Control always passes
28493 to the next ACL statement. If any condition is false, the log line is not
28494 written. If an identical log line is requested several times in the same
28495 message, only one copy is actually written to the log. If you want to force
28496 duplicates to be written, use the &%logwrite%& modifier instead.
28497
28498 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
28499 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
28500 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
28501 first failing condition. There is more about adding header lines in section
28502 &<<SECTaddheadacl>>&.
28503
28504 If any condition on a &%warn%& statement cannot be completed (that is, there is
28505 some sort of defer), the log line specified by &%log_message%& is not written.
28506 This does not include the case of a forced failure from a lookup, which
28507 is considered to be a successful completion. After a defer, no further
28508 conditions or modifiers in the &%warn%& statement are processed. The incident
28509 is logged, and the ACL continues to be processed, from the next statement
28510 onwards.
28511
28512
28513 .vindex "&$acl_verify_message$&"
28514 When one of the &%warn%& conditions is an address verification that fails, the
28515 text of the verification failure message is in &$acl_verify_message$&. If you
28516 want this logged, you must set it up explicitly. For example:
28517 .code
28518 warn   !verify = sender
28519        log_message = sender verify failed: $acl_verify_message
28520 .endd
28521 .endlist
28522
28523 At the end of each ACL there is an implicit unconditional &%deny%&.
28524
28525 As you can see from the examples above, the conditions and modifiers are
28526 written one to a line, with the first one on the same line as the verb, and
28527 subsequent ones on following lines. If you have a very long condition, you can
28528 continue it onto several physical lines by the usual backslash continuation
28529 mechanism. It is conventional to align the conditions vertically.
28530
28531
28532
28533 .section "ACL variables" "SECTaclvariables"
28534 .cindex "&ACL;" "variables"
28535 There are some special variables that can be set during ACL processing. They
28536 can be used to pass information between different ACLs, different invocations
28537 of the same ACL in the same SMTP connection, and between ACLs and the routers,
28538 transports, and filters that are used to deliver a message. The names of these
28539 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
28540 an underscore, but the remainder of the name can be any sequence of
28541 alphanumeric characters and underscores that you choose. There is no limit on
28542 the number of ACL variables. The two sets act as follows:
28543 .ilist
28544 The values of those variables whose names begin with &$acl_c$& persist
28545 throughout an SMTP connection. They are never reset. Thus, a value that is set
28546 while receiving one message is still available when receiving the next message
28547 on the same SMTP connection.
28548 .next
28549 The values of those variables whose names begin with &$acl_m$& persist only
28550 while a message is being received. They are reset afterwards. They are also
28551 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
28552 .endlist
28553
28554 When a message is accepted, the current values of all the ACL variables are
28555 preserved with the message and are subsequently made available at delivery
28556 time. The ACL variables are set by a modifier called &%set%&. For example:
28557 .code
28558 accept hosts = whatever
28559        set acl_m4 = some value
28560 accept authenticated = *
28561        set acl_c_auth = yes
28562 .endd
28563 &*Note*&: A leading dollar sign is not used when naming a variable that is to
28564 be set. If you want to set a variable without taking any action, you can use a
28565 &%warn%& verb without any other modifiers or conditions.
28566
28567 .oindex &%strict_acl_vars%&
28568 What happens if a syntactically valid but undefined ACL variable is
28569 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
28570 false (the default), an empty string is substituted; if it is true, an
28571 error is generated.
28572
28573 Versions of Exim before 4.64 have a limited set of numbered variables, but
28574 their names are compatible, so there is no problem with upgrading.
28575
28576
28577 .section "Condition and modifier processing" "SECTcondmodproc"
28578 .cindex "&ACL;" "conditions; processing"
28579 .cindex "&ACL;" "modifiers; processing"
28580 An exclamation mark preceding a condition negates its result. For example:
28581 .code
28582 deny   domains = *.dom.example
28583       !verify  = recipient
28584 .endd
28585 causes the ACL to return &"deny"& if the recipient domain ends in
28586 &'dom.example'& and the recipient address cannot be verified. Sometimes
28587 negation can be used on the right-hand side of a condition. For example, these
28588 two statements are equivalent:
28589 .code
28590 deny  hosts = !192.168.3.4
28591 deny !hosts =  192.168.3.4
28592 .endd
28593 However, for many conditions (&%verify%& being a good example), only left-hand
28594 side negation of the whole condition is possible.
28595
28596 The arguments of conditions and modifiers are expanded. A forced failure
28597 of an expansion causes a condition to be ignored, that is, it behaves as if the
28598 condition is true. Consider these two statements:
28599 .code
28600 accept  senders = ${lookup{$host_name}lsearch\
28601                   {/some/file}{$value}fail}
28602 accept  senders = ${lookup{$host_name}lsearch\
28603                   {/some/file}{$value}{}}
28604 .endd
28605 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
28606 the returned list is searched, but if the lookup fails the behaviour is
28607 different in the two cases. The &%fail%& in the first statement causes the
28608 condition to be ignored, leaving no further conditions. The &%accept%& verb
28609 therefore succeeds. The second statement, however, generates an empty list when
28610 the lookup fails. No sender can match an empty list, so the condition fails,
28611 and therefore the &%accept%& also fails.
28612
28613 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
28614 specify actions that are taken as the conditions for a statement are checked;
28615 others specify text for messages that are used when access is denied or a
28616 warning is generated. The &%control%& modifier affects the way an incoming
28617 message is handled.
28618
28619 The positioning of the modifiers in an ACL statement is important, because the
28620 processing of a verb ceases as soon as its outcome is known. Only those
28621 modifiers that have already been encountered will take effect. For example,
28622 consider this use of the &%message%& modifier:
28623 .code
28624 require message = Can't verify sender
28625         verify  = sender
28626         message = Can't verify recipient
28627         verify  = recipient
28628         message = This message cannot be used
28629 .endd
28630 If sender verification fails, Exim knows that the result of the statement is
28631 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
28632 so its text is used as the error message. If sender verification succeeds, but
28633 recipient verification fails, the second message is used. If recipient
28634 verification succeeds, the third message becomes &"current"&, but is never used
28635 because there are no more conditions to cause failure.
28636
28637 For the &%deny%& verb, on the other hand, it is always the last &%message%&
28638 modifier that is used, because all the conditions must be true for rejection to
28639 happen. Specifying more than one &%message%& modifier does not make sense, and
28640 the message can even be specified after all the conditions. For example:
28641 .code
28642 deny   hosts = ...
28643       !senders = *@my.domain.example
28644        message = Invalid sender from client host
28645 .endd
28646 The &"deny"& result does not happen until the end of the statement is reached,
28647 by which time Exim has set up the message.
28648
28649
28650
28651 .section "ACL modifiers" "SECTACLmodi"
28652 .cindex "&ACL;" "modifiers; list of"
28653 The ACL modifiers are as follows:
28654
28655 .vlist
28656 .vitem &*add_header*&&~=&~<&'text'&>
28657 This modifier specifies one or more header lines that are to be added to an
28658 incoming message, assuming, of course, that the message is ultimately
28659 accepted. For details, see section &<<SECTaddheadacl>>&.
28660
28661 .vitem &*continue*&&~=&~<&'text'&>
28662 .cindex "&%continue%& ACL modifier"
28663 .cindex "database" "updating in ACL"
28664 This modifier does nothing of itself, and processing of the ACL always
28665 continues with the next condition or modifier. The value of &%continue%& is in
28666 the side effects of expanding its argument. Typically this could be used to
28667 update a database. It is really just a syntactic tidiness, to avoid having to
28668 write rather ugly lines like this:
28669 .display
28670 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
28671 .endd
28672 Instead, all you need is
28673 .display
28674 &`continue = `&<&'some expansion'&>
28675 .endd
28676
28677 .vitem &*control*&&~=&~<&'text'&>
28678 .cindex "&%control%& ACL modifier"
28679 This modifier affects the subsequent processing of the SMTP connection or of an
28680 incoming message that is accepted. The effect of the first type of control
28681 lasts for the duration of the connection, whereas the effect of the second type
28682 lasts only until the current message has been received. The message-specific
28683 controls always apply to the whole message, not to individual recipients,
28684 even if the &%control%& modifier appears in a RCPT ACL.
28685
28686 As there are now quite a few controls that can be applied, they are described
28687 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
28688 in several different ways. For example:
28689
28690 . ==== As this is a nested list, any displays it contains must be indented
28691 . ==== as otherwise they are too far to the left. That comment applies only
28692 . ==== when xmlto and fop are used; formatting with sdop gets it right either
28693 . ==== way.
28694
28695 .ilist
28696 It can be at the end of an &%accept%& statement:
28697 .code
28698     accept  ...some conditions
28699             control = queue_only
28700 .endd
28701 In this case, the control is applied when this statement yields &"accept"&, in
28702 other words, when the conditions are all true.
28703
28704 .next
28705 It can be in the middle of an &%accept%& statement:
28706 .code
28707     accept  ...some conditions...
28708             control = queue_only
28709             ...some more conditions...
28710 .endd
28711 If the first set of conditions are true, the control is applied, even if the
28712 statement does not accept because one of the second set of conditions is false.
28713 In this case, some subsequent statement must yield &"accept"& for the control
28714 to be relevant.
28715
28716 .next
28717 It can be used with &%warn%& to apply the control, leaving the
28718 decision about accepting or denying to a subsequent verb. For
28719 example:
28720 .code
28721     warn    ...some conditions...
28722             control = freeze
28723     accept  ...
28724 .endd
28725 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
28726 &%logwrite%&, so it does not add anything to the message and does not write a
28727 log entry.
28728
28729 .next
28730 If you want to apply a control unconditionally, you can use it with a
28731 &%require%& verb. For example:
28732 .code
28733     require  control = no_multiline_responses
28734 .endd
28735 .endlist
28736
28737 .vitem &*delay*&&~=&~<&'time'&>
28738 .cindex "&%delay%& ACL modifier"
28739 .oindex "&%-bh%&"
28740 This modifier may appear in any ACL except notquit. It causes Exim to wait for
28741 the time interval before proceeding. However, when testing Exim using the
28742 &%-bh%& option, the delay is not actually imposed (an appropriate message is
28743 output instead). The time is given in the usual Exim notation, and the delay
28744 happens as soon as the modifier is processed. In an SMTP session, pending
28745 output is flushed before the delay is imposed.
28746
28747 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
28748 example:
28749 .code
28750 deny    ...some conditions...
28751         delay = 30s
28752 .endd
28753 The delay happens if all the conditions are true, before the statement returns
28754 &"deny"&. Compare this with:
28755 .code
28756 deny    delay = 30s
28757         ...some conditions...
28758 .endd
28759 which waits for 30s before processing the conditions. The &%delay%& modifier
28760 can also be used with &%warn%& and together with &%control%&:
28761 .code
28762 warn    ...some conditions...
28763         delay = 2m
28764         control = freeze
28765 accept  ...
28766 .endd
28767
28768 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
28769 responses to several commands are no longer buffered and sent in one packet (as
28770 they would normally be) because all output is flushed before imposing the
28771 delay. This optimization is disabled so that a number of small delays do not
28772 appear to the client as one large aggregated delay that might provoke an
28773 unwanted timeout. You can, however, disable output flushing for &%delay%& by
28774 using a &%control%& modifier to set &%no_delay_flush%&.
28775
28776
28777 .vitem &*endpass*&
28778 .cindex "&%endpass%& ACL modifier"
28779 This modifier, which has no argument, is recognized only in &%accept%& and
28780 &%discard%& statements. It marks the boundary between the conditions whose
28781 failure causes control to pass to the next statement, and the conditions whose
28782 failure causes the ACL to return &"deny"&. This concept has proved to be
28783 confusing to some people, so the use of &%endpass%& is no longer recommended as
28784 &"best practice"&. See the description of &%accept%& above for more details.
28785
28786
28787 .vitem &*log_message*&&~=&~<&'text'&>
28788 .cindex "&%log_message%& ACL modifier"
28789 This modifier sets up a message that is used as part of the log message if the
28790 ACL denies access or a &%warn%& statement's conditions are true. For example:
28791 .code
28792 require log_message = wrong cipher suite $tls_in_cipher
28793         encrypted   = DES-CBC3-SHA
28794 .endd
28795 &%log_message%& is also used when recipients are discarded by &%discard%&. For
28796 example:
28797 .display
28798 &`discard `&<&'some conditions'&>
28799 &`        log_message = Discarded $local_part@$domain because...`&
28800 .endd
28801 When access is denied, &%log_message%& adds to any underlying error message
28802 that may exist because of a condition failure. For example, while verifying a
28803 recipient address, a &':fail:'& redirection might have already set up a
28804 message.
28805
28806 The message may be defined before the conditions to which it applies, because
28807 the string expansion does not happen until Exim decides that access is to be
28808 denied. This means that any variables that are set by the condition are
28809 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
28810 variables are set after a DNS black list lookup succeeds. If the expansion of
28811 &%log_message%& fails, or if the result is an empty string, the modifier is
28812 ignored.
28813
28814 .vindex "&$acl_verify_message$&"
28815 If you want to use a &%warn%& statement to log the result of an address
28816 verification, you can use &$acl_verify_message$& to include the verification
28817 error message.
28818
28819 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
28820 the start of the logged message. If the same warning log message is requested
28821 more than once while receiving  a single email message, only one copy is
28822 actually logged. If you want to log multiple copies, use &%logwrite%& instead
28823 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
28824 is logged for a successful &%warn%& statement.
28825
28826 If &%log_message%& is not present and there is no underlying error message (for
28827 example, from the failure of address verification), but &%message%& is present,
28828 the &%message%& text is used for logging rejections. However, if any text for
28829 logging contains newlines, only the first line is logged. In the absence of
28830 both &%log_message%& and &%message%&, a default built-in message is used for
28831 logging rejections.
28832
28833
28834 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
28835 .cindex "&%log_reject_target%& ACL modifier"
28836 .cindex "logging in ACL" "specifying which log"
28837 This modifier makes it possible to specify which logs are used for messages
28838 about ACL rejections. Its argument is a colon-separated list of words that can
28839 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
28840 may be empty, in which case a rejection is not logged at all. For example, this
28841 ACL fragment writes no logging information when access is denied:
28842 .display
28843 &`deny `&<&'some conditions'&>
28844 &`     log_reject_target =`&
28845 .endd
28846 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
28847 permanent and temporary rejections. Its effect lasts for the rest of the
28848 current ACL.
28849
28850
28851 .vitem &*logwrite*&&~=&~<&'text'&>
28852 .cindex "&%logwrite%& ACL modifier"
28853 .cindex "logging in ACL" "immediate"
28854 This modifier writes a message to a log file as soon as it is encountered when
28855 processing an ACL. (Compare &%log_message%&, which, except in the case of
28856 &%warn%& and &%discard%&, is used only if the ACL statement denies
28857 access.) The &%logwrite%& modifier can be used to log special incidents in
28858 ACLs. For example:
28859 .display
28860 &`accept `&<&'some special conditions'&>
28861 &`       control  = freeze`&
28862 &`       logwrite = froze message because ...`&
28863 .endd
28864 By default, the message is written to the main log. However, it may begin
28865 with a colon, followed by a comma-separated list of log names, and then
28866 another colon, to specify exactly which logs are to be written. For
28867 example:
28868 .code
28869 logwrite = :main,reject: text for main and reject logs
28870 logwrite = :panic: text for panic log only
28871 .endd
28872
28873
28874 .vitem &*message*&&~=&~<&'text'&>
28875 .cindex "&%message%& ACL modifier"
28876 This modifier sets up a text string that is expanded and used as a response
28877 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
28878 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
28879 there is some complication if &%endpass%& is involved; see the description of
28880 &%accept%& for details.)
28881
28882 The expansion of the message happens at the time Exim decides that the ACL is
28883 to end, not at the time it processes &%message%&. If the expansion fails, or
28884 generates an empty string, the modifier is ignored. Here is an example where
28885 &%message%& must be specified first, because the ACL ends with a rejection if
28886 the &%hosts%& condition fails:
28887 .code
28888 require  message = Host not recognized
28889          hosts = 10.0.0.0/8
28890 .endd
28891 (Once a condition has failed, no further conditions or modifiers are
28892 processed.)
28893
28894 .cindex "SMTP" "error codes"
28895 .oindex "&%smtp_banner%&
28896 For ACLs that are triggered by SMTP commands, the message is returned as part
28897 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
28898 is meaningful only for SMTP, as no message is returned when a non-SMTP message
28899 is accepted. In the case of the connect ACL, accepting with a message modifier
28900 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
28901 accept message may not contain more than one line (otherwise it will be
28902 truncated at the first newline and a panic logged), and it cannot affect the
28903 EHLO options.
28904
28905 When SMTP is involved, the message may begin with an overriding response code,
28906 consisting of three digits optionally followed by an &"extended response code"&
28907 of the form &'n.n.n'&, each code being followed by a space. For example:
28908 .code
28909 deny  message = 599 1.2.3 Host not welcome
28910       hosts = 192.168.34.0/24
28911 .endd
28912 The first digit of the supplied response code must be the same as would be sent
28913 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
28914 access, but for the predata ACL, note that the default success code is 354, not
28915 2&'xx'&.
28916
28917 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
28918 the message modifier cannot override the 221 response code.
28919
28920 The text in a &%message%& modifier is literal; any quotes are taken as
28921 literals, but because the string is expanded, backslash escapes are processed
28922 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
28923 response.
28924
28925 .vindex "&$acl_verify_message$&"
28926 For ACLs that are called by an &%acl =%& ACL condition, the message is
28927 stored in &$acl_verify_message$&, from which the calling ACL may use it.
28928
28929 If &%message%& is used on a statement that verifies an address, the message
28930 specified overrides any message that is generated by the verification process.
28931 However, the original message is available in the variable
28932 &$acl_verify_message$&, so you can incorporate it into your message if you
28933 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
28934 routers to be passed back as part of the SMTP response, you should either not
28935 use a &%message%& modifier, or make use of &$acl_verify_message$&.
28936
28937 For compatibility with previous releases of Exim, a &%message%& modifier that
28938 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
28939 modifier, but this usage is now deprecated. However, &%message%& acts only when
28940 all the conditions are true, wherever it appears in an ACL command, whereas
28941 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
28942 &%warn%& in an ACL that is not concerned with receiving a message, it has no
28943 effect.
28944
28945
28946 .vitem &*queue*&&~=&~<&'text'&>
28947 This modifier specifies the use of a named queue for spool files
28948 for the message.
28949 It can only be used before the message is received (i.e. not in
28950 the DATA ACL).
28951 This could be used, for example, for known high-volume burst sources
28952 of traffic, or for quarantine of messages.
28953 Separate queue-runner processes will be needed for named queues.
28954 If the text after expansion is empty, the default queue is used.
28955
28956
28957 .vitem &*remove_header*&&~=&~<&'text'&>
28958 This modifier specifies one or more header names in a colon-separated list
28959  that are to be removed from an incoming message, assuming, of course, that
28960 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
28961
28962
28963 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
28964 .cindex "&%set%& ACL modifier"
28965 This modifier puts a value into one of the ACL variables (see section
28966 &<<SECTaclvariables>>&).
28967
28968
28969 .vitem &*udpsend*&&~=&~<&'parameters'&>
28970 This modifier sends a UDP packet, for purposes such as statistics
28971 collection or behaviour monitoring. The parameters are expanded, and
28972 the result of the expansion must be a colon-separated list consisting
28973 of a destination server, port number, and the packet contents. The
28974 server can be specified as a host name or IPv4 or IPv6 address. The
28975 separator can be changed with the usual angle bracket syntax. For
28976 example, you might want to collect information on which hosts connect
28977 when:
28978 .code
28979 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
28980              $tod_zulu $sender_host_address
28981 .endd
28982 .endlist
28983
28984
28985
28986
28987 .section "Use of the control modifier" "SECTcontrols"
28988 .cindex "&%control%& ACL modifier"
28989 The &%control%& modifier supports the following settings:
28990
28991 .vlist
28992 .vitem &*control&~=&~allow_auth_unadvertised*&
28993 This modifier allows a client host to use the SMTP AUTH command even when it
28994 has not been advertised in response to EHLO. Furthermore, because there are
28995 apparently some really broken clients that do this, Exim will accept AUTH after
28996 HELO (rather than EHLO) when this control is set. It should be used only if you
28997 really need it, and you should limit its use to those broken clients that do
28998 not work without it. For example:
28999 .code
29000 warn hosts   = 192.168.34.25
29001      control = allow_auth_unadvertised
29002 .endd
29003 Normally, when an Exim server receives an AUTH command, it checks the name of
29004 the authentication mechanism that is given in the command to ensure that it
29005 matches an advertised mechanism. When this control is set, the check that a
29006 mechanism has been advertised is bypassed. Any configured mechanism can be used
29007 by the client. This control is permitted only in the connection and HELO ACLs.
29008
29009
29010 .vitem &*control&~=&~caseful_local_part*& &&&
29011        &*control&~=&~caselower_local_part*&
29012 .cindex "&ACL;" "case of local part in"
29013 .cindex "case of local parts"
29014 .vindex "&$local_part$&"
29015 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29016 (that is, during RCPT processing). By default, the contents of &$local_part$&
29017 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29018 any uppercase letters in the original local part are restored in &$local_part$&
29019 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29020 is encountered.
29021
29022 These controls affect only the current recipient. Moreover, they apply only to
29023 local part handling that takes place directly in the ACL (for example, as a key
29024 in lookups). If a test to verify the recipient is obeyed, the case-related
29025 handling of the local part during the verification is controlled by the router
29026 configuration (see the &%caseful_local_part%& generic router option).
29027
29028 This facility could be used, for example, to add a spam score to local parts
29029 containing upper case letters. For example, using &$acl_m4$& to accumulate the
29030 spam score:
29031 .code
29032 warn  control = caseful_local_part
29033       set acl_m4 = ${eval:\
29034                      $acl_m4 + \
29035                      ${if match{$local_part}{[A-Z]}{1}{0}}\
29036                     }
29037       control = caselower_local_part
29038 .endd
29039 Notice that we put back the lower cased version afterwards, assuming that
29040 is what is wanted for subsequent tests.
29041
29042
29043 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
29044 .cindex "&ACL;" "cutthrough routing"
29045 .cindex "cutthrough" "requesting"
29046 This option requests delivery be attempted while the item is being received.
29047
29048 The option is usable in the RCPT ACL.
29049 If enabled for a message received via smtp and routed to an smtp transport,
29050 and only one transport, interface, destination host and port combination
29051 is used for all recipients of the message,
29052 then the delivery connection is made while the receiving connection is open
29053 and data is copied from one to the other.
29054
29055 An attempt to set this option for any recipient but the first
29056 for a mail will be quietly ignored.
29057 If a recipient-verify callout
29058 (with use_sender)
29059 connection is subsequently
29060 requested in the same ACL it is held open and used for
29061 any subsequent recipients and the data,
29062 otherwise one is made after the initial RCPT ACL completes.
29063
29064 Note that routers are used in verify mode,
29065 and cannot depend on content of received headers.
29066 Note also that headers cannot be
29067 modified by any of the post-data ACLs (DATA, MIME and DKIM).
29068 Headers may be modified by routers (subject to the above) and transports.
29069 .new
29070 The Received-By: header is generated as soon as the body reception starts,
29071 rather than the traditional time after the full message is received;
29072 this will affect the timestamp.
29073 .wen
29074
29075 All the usual ACLs are called; if one results in the message being
29076 rejected, all effort spent in delivery (including the costs on
29077 the ultimate destination) will be wasted.
29078 Note that in the case of data-time ACLs this includes the entire
29079 message body.
29080
29081 Cutthrough delivery is not supported via transport-filters or when DKIM signing
29082 of outgoing messages is done, because it sends data to the ultimate destination
29083 before the entire message has been received from the source.
29084 It is not supported for messages received with the SMTP PRDR
29085 or CHUNKING
29086 options in use.
29087
29088 Should the ultimate destination system positively accept or reject the mail,
29089 a corresponding indication is given to the source system and nothing is queued.
29090 If the item is successfully delivered in cutthrough mode
29091 the delivery log lines are tagged with ">>" rather than "=>" and appear
29092 before the acceptance "<=" line.
29093
29094 If there is a temporary error the item is queued for later delivery in the
29095 usual fashion.
29096 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
29097 to the control; the default value is &"spool"& and the alternate value
29098 &"pass"& copies an SMTP defer response from the target back to the initiator
29099 and does not queue the message.
29100 Note that this is independent of any recipient verify conditions in the ACL.
29101
29102 Delivery in this mode avoids the generation of a bounce mail to a
29103 (possibly faked)
29104 sender when the destination system is doing content-scan based rejection.
29105
29106
29107 .vitem &*control&~=&~debug/*&<&'options'&>
29108 .cindex "&ACL;" "enabling debug logging"
29109 .cindex "debugging" "enabling from an ACL"
29110 This control turns on debug logging, almost as though Exim had been invoked
29111 with &`-d`&, with the output going to a new logfile in the usual logs directory,
29112 by default called &'debuglog'&.
29113 The filename can be adjusted with the &'tag'& option, which
29114 may access any variables already defined.  The logging may be adjusted with
29115 the &'opts'& option, which takes the same values as the &`-d`& command-line
29116 option.
29117 Logging started this way may be stopped, and the file removed,
29118 with the &'kill'& option.
29119 Some examples (which depend on variables that don't exist in all
29120 contexts):
29121 .code
29122       control = debug
29123       control = debug/tag=.$sender_host_address
29124       control = debug/opts=+expand+acl
29125       control = debug/tag=.$message_exim_id/opts=+expand
29126       control = debug/kill
29127 .endd
29128
29129
29130 .vitem &*control&~=&~dkim_disable_verify*&
29131 .cindex "disable DKIM verify"
29132 .cindex "DKIM" "disable verify"
29133 This control turns off DKIM verification processing entirely.  For details on
29134 the operation and configuration of DKIM, see chapter &<<CHAPdkim>>&.
29135
29136
29137 .vitem &*control&~=&~dscp/*&<&'value'&>
29138 .cindex "&ACL;" "setting DSCP value"
29139 .cindex "DSCP" "inbound"
29140 This option causes the DSCP value associated with the socket for the inbound
29141 connection to be adjusted to a given value, given as one of a number of fixed
29142 strings or to numeric value.
29143 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
29144 Common values include &`throughput`&, &`mincost`&, and on newer systems
29145 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
29146
29147 The outbound packets from Exim will be marked with this value in the header
29148 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
29149 that these values will have any effect, not be stripped by networking
29150 equipment, or do much of anything without cooperation with your Network
29151 Engineer and those of all network operators between the source and destination.
29152
29153
29154 .vitem &*control&~=&~enforce_sync*& &&&
29155        &*control&~=&~no_enforce_sync*&
29156 .cindex "SMTP" "synchronization checking"
29157 .cindex "synchronization checking in SMTP"
29158 These controls make it possible to be selective about when SMTP synchronization
29159 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
29160 state of the switch (it is true by default). See the description of this option
29161 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
29162
29163 The effect of these two controls lasts for the remainder of the SMTP
29164 connection. They can appear in any ACL except the one for the non-SMTP
29165 messages. The most straightforward place to put them is in the ACL defined by
29166 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
29167 before the first synchronization check. The expected use is to turn off the
29168 synchronization checks for badly-behaved hosts that you nevertheless need to
29169 work with.
29170
29171
29172 .vitem &*control&~=&~fakedefer/*&<&'message'&>
29173 .cindex "fake defer"
29174 .cindex "defer, fake"
29175 This control works in exactly the same way as &%fakereject%& (described below)
29176 except that it causes an SMTP 450 response after the message data instead of a
29177 550 response. You must take care when using &%fakedefer%& because it causes the
29178 messages to be duplicated when the sender retries. Therefore, you should not
29179 use &%fakedefer%& if the message is to be delivered normally.
29180
29181 .vitem &*control&~=&~fakereject/*&<&'message'&>
29182 .cindex "fake rejection"
29183 .cindex "rejection, fake"
29184 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
29185 words, only when an SMTP message is being received. If Exim accepts the
29186 message, instead the final 250 response, a 550 rejection message is sent.
29187 However, Exim proceeds to deliver the message as normal. The control applies
29188 only to the current message, not to any subsequent ones that may be received in
29189 the same SMTP connection.
29190
29191 The text for the 550 response is taken from the &%control%& modifier. If no
29192 message is supplied, the following is used:
29193 .code
29194 550-Your message has been rejected but is being
29195 550-kept for evaluation.
29196 550-If it was a legitimate message, it may still be
29197 550 delivered to the target recipient(s).
29198 .endd
29199 This facility should be used with extreme caution.
29200
29201 .vitem &*control&~=&~freeze*&
29202 .cindex "frozen messages" "forcing in ACL"
29203 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29204 other words, only when a message is being received. If the message is accepted,
29205 it is placed on Exim's queue and frozen. The control applies only to the
29206 current message, not to any subsequent ones that may be received in the same
29207 SMTP connection.
29208
29209 This modifier can optionally be followed by &`/no_tell`&. If the global option
29210 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
29211 is told about the freezing), provided all the &*control=freeze*& modifiers that
29212 are obeyed for the current message have the &`/no_tell`& option.
29213
29214 .vitem &*control&~=&~no_delay_flush*&
29215 .cindex "SMTP" "output flushing, disabling for delay"
29216 Exim normally flushes SMTP output before implementing a delay in an ACL, to
29217 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29218 use. This control, as long as it is encountered before the &%delay%& modifier,
29219 disables such output flushing.
29220
29221 .vitem &*control&~=&~no_callout_flush*&
29222 .cindex "SMTP" "output flushing, disabling for callout"
29223 Exim normally flushes SMTP output before performing a callout in an ACL, to
29224 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
29225 use. This control, as long as it is encountered before the &%verify%& condition
29226 that causes the callout, disables such output flushing.
29227
29228 .vitem &*control&~=&~no_mbox_unspool*&
29229 This control is available when Exim is compiled with the content scanning
29230 extension. Content scanning may require a copy of the current message, or parts
29231 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
29232 or spam scanner. Normally, such copies are deleted when they are no longer
29233 needed. If this control is set, the copies are not deleted. The control applies
29234 only to the current message, not to any subsequent ones that may be received in
29235 the same SMTP connection. It is provided for debugging purposes and is unlikely
29236 to be useful in production.
29237
29238 .vitem &*control&~=&~no_multiline_responses*&
29239 .cindex "multiline responses, suppressing"
29240 This control is permitted for any ACL except the one for non-SMTP messages.
29241 It seems that there are broken clients in use that cannot handle multiline
29242 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
29243
29244 If this control is set, multiline SMTP responses from ACL rejections are
29245 suppressed. One way of doing this would have been to put out these responses as
29246 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
29247 (&"use multiline responses for more"& it says &-- ha!), and some of the
29248 responses might get close to that. So this facility, which is after all only a
29249 sop to broken clients, is implemented by doing two very easy things:
29250
29251 .ilist
29252 Extra information that is normally output as part of a rejection caused by
29253 sender verification failure is omitted. Only the final line (typically &"sender
29254 verification failed"&) is sent.
29255 .next
29256 If a &%message%& modifier supplies a multiline response, only the first
29257 line is output.
29258 .endlist
29259
29260 The setting of the switch can, of course, be made conditional on the
29261 calling host. Its effect lasts until the end of the SMTP connection.
29262
29263 .vitem &*control&~=&~no_pipelining*&
29264 .cindex "PIPELINING" "suppressing advertising"
29265 This control turns off the advertising of the PIPELINING extension to SMTP in
29266 the current session. To be useful, it must be obeyed before Exim sends its
29267 response to an EHLO command. Therefore, it should normally appear in an ACL
29268 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
29269 &%pipelining_advertise_hosts%&.
29270
29271 .vitem &*control&~=&~queue_only*&
29272 .oindex "&%queue_only%&"
29273 .cindex "queueing incoming messages"
29274 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
29275 other words, only when a message is being received. If the message is accepted,
29276 it is placed on Exim's queue and left there for delivery by a subsequent queue
29277 runner. No immediate delivery process is started. In other words, it has the
29278 effect as the &%queue_only%& global option. However, the control applies only
29279 to the current message, not to any subsequent ones that may be received in the
29280 same SMTP connection.
29281
29282 .vitem &*control&~=&~submission/*&<&'options'&>
29283 .cindex "message" "submission"
29284 .cindex "submission mode"
29285 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
29286 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
29287 the current message is a submission from a local MUA. In this case, Exim
29288 operates in &"submission mode"&, and applies certain fixups to the message if
29289 necessary. For example, it adds a &'Date:'& header line if one is not present.
29290 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
29291 late (the message has already been created).
29292
29293 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
29294 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
29295 submission mode; the available options for this control are described there.
29296 The control applies only to the current message, not to any subsequent ones
29297 that may be received in the same SMTP connection.
29298
29299 .vitem &*control&~=&~suppress_local_fixups*&
29300 .cindex "submission fixups, suppressing"
29301 This control applies to locally submitted (non TCP/IP) messages, and is the
29302 complement of &`control = submission`&. It disables the fixups that are
29303 normally applied to locally-submitted messages. Specifically:
29304
29305 .ilist
29306 Any &'Sender:'& header line is left alone (in this respect, it is a
29307 dynamic version of &%local_sender_retain%&).
29308 .next
29309 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
29310 .next
29311 There is no check that &'From:'& corresponds to the actual sender.
29312 .endlist ilist
29313
29314 This control may be useful when a remotely-originated message is accepted,
29315 passed to some scanning program, and then re-submitted for delivery. It can be
29316 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
29317 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
29318 data is read.
29319
29320 &*Note:*& This control applies only to the current message, not to any others
29321 that are being submitted at the same time using &%-bs%& or &%-bS%&.
29322
29323 .vitem &*control&~=&~utf8_downconvert*&
29324 This control enables conversion of UTF-8 in message addresses
29325 to a-label form.
29326 For details see section &<<SECTi18nMTA>>&.
29327 .endlist vlist
29328
29329
29330 .section "Summary of message fixup control" "SECTsummesfix"
29331 All four possibilities for message fixups can be specified:
29332
29333 .ilist
29334 Locally submitted, fixups applied: the default.
29335 .next
29336 Locally submitted, no fixups applied: use
29337 &`control = suppress_local_fixups`&.
29338 .next
29339 Remotely submitted, no fixups applied: the default.
29340 .next
29341 Remotely submitted, fixups applied: use &`control = submission`&.
29342 .endlist
29343
29344
29345
29346 .section "Adding header lines in ACLs" "SECTaddheadacl"
29347 .cindex "header lines" "adding in an ACL"
29348 .cindex "header lines" "position of added lines"
29349 .cindex "&%add_header%& ACL modifier"
29350 The &%add_header%& modifier can be used to add one or more extra header lines
29351 to an incoming message, as in this example:
29352 .code
29353 warn dnslists = sbl.spamhaus.org : \
29354                 dialup.mail-abuse.org
29355      add_header = X-blacklisted-at: $dnslist_domain
29356 .endd
29357 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29358 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29359 receiving a message). The message must ultimately be accepted for
29360 &%add_header%& to have any significant effect. You can use &%add_header%& with
29361 any ACL verb, including &%deny%& (though this is potentially useful only in a
29362 RCPT ACL).
29363
29364 Headers will not be added to the message if the modifier is used in
29365 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29366
29367 Leading and trailing newlines are removed from
29368 the data for the &%add_header%& modifier; if it then
29369 contains one or more newlines that
29370 are not followed by a space or a tab, it is assumed to contain multiple header
29371 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
29372 front of any line that is not a valid header line.
29373
29374 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29375 They are added to the message before processing the DATA and MIME ACLs.
29376 However, if an identical header line is requested more than once, only one copy
29377 is actually added to the message. Further header lines may be accumulated
29378 during the DATA and MIME ACLs, after which they are added to the message, again
29379 with duplicates suppressed. Thus, it is possible to add two identical header
29380 lines to an SMTP message, but only if one is added before DATA and one after.
29381 In the case of non-SMTP messages, new headers are accumulated during the
29382 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
29383 message is rejected after DATA or by the non-SMTP ACL, all added header lines
29384 are included in the entry that is written to the reject log.
29385
29386 .cindex "header lines" "added; visibility of"
29387 Header lines are not visible in string expansions
29388 of message headers
29389 until they are added to the
29390 message. It follows that header lines defined in the MAIL, RCPT, and predata
29391 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
29392 header lines that are added by the DATA or MIME ACLs are not visible in those
29393 ACLs. Because of this restriction, you cannot use header lines as a way of
29394 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
29395 this, you can use ACL variables, as described in section
29396 &<<SECTaclvariables>>&.
29397
29398 The list of headers yet to be added is given by the &%$headers_added%& variable.
29399
29400 The &%add_header%& modifier acts immediately as it is encountered during the
29401 processing of an ACL. Notice the difference between these two cases:
29402 .display
29403 &`accept add_header = ADDED: some text`&
29404 &`       `&<&'some condition'&>
29405
29406 &`accept `&<&'some condition'&>
29407 &`       add_header = ADDED: some text`&
29408 .endd
29409 In the first case, the header line is always added, whether or not the
29410 condition is true. In the second case, the header line is added only if the
29411 condition is true. Multiple occurrences of &%add_header%& may occur in the same
29412 ACL statement. All those that are encountered before a condition fails are
29413 honoured.
29414
29415 .cindex "&%warn%& ACL verb"
29416 For compatibility with previous versions of Exim, a &%message%& modifier for a
29417 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
29418 effect only if all the conditions are true, even if it appears before some of
29419 them. Furthermore, only the last occurrence of &%message%& is honoured. This
29420 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
29421 are present on a &%warn%& verb, both are processed according to their
29422 specifications.
29423
29424 By default, new header lines are added to a message at the end of the existing
29425 header lines. However, you can specify that any particular header line should
29426 be added right at the start (before all the &'Received:'& lines), immediately
29427 after the first block of &'Received:'& lines, or immediately before any line
29428 that is not a &'Received:'& or &'Resent-something:'& header.
29429
29430 This is done by specifying &":at_start:"&, &":after_received:"&, or
29431 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
29432 header line, respectively. (Header text cannot start with a colon, as there has
29433 to be a header name first.) For example:
29434 .code
29435 warn add_header = \
29436        :after_received:X-My-Header: something or other...
29437 .endd
29438 If more than one header line is supplied in a single &%add_header%& modifier,
29439 each one is treated independently and can therefore be placed differently. If
29440 you add more than one line at the start, or after the Received: block, they end
29441 up in reverse order.
29442
29443 &*Warning*&: This facility currently applies only to header lines that are
29444 added in an ACL. It does NOT work for header lines that are added in a
29445 system filter or in a router or transport.
29446
29447
29448
29449 .section "Removing header lines in ACLs" "SECTremoveheadacl"
29450 .cindex "header lines" "removing in an ACL"
29451 .cindex "header lines" "position of removed lines"
29452 .cindex "&%remove_header%& ACL modifier"
29453 The &%remove_header%& modifier can be used to remove one or more header lines
29454 from an incoming message, as in this example:
29455 .code
29456 warn   message        = Remove internal headers
29457        remove_header  = x-route-mail1 : x-route-mail2
29458 .endd
29459 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
29460 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
29461 receiving a message). The message must ultimately be accepted for
29462 &%remove_header%& to have any significant effect. You can use &%remove_header%&
29463 with any ACL verb, including &%deny%&, though this is really not useful for
29464 any verb that doesn't result in a delivered message.
29465
29466 Headers will not be removed from the message if the modifier is used in
29467 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
29468
29469 More than one header can be removed at the same time by using a colon separated
29470 list of header names. The header matching is case insensitive. Wildcards are
29471 not permitted, nor is list expansion performed, so you cannot use hostlists to
29472 create a list of headers, however both connection and message variable expansion
29473 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
29474 .code
29475 warn   hosts           = +internal_hosts
29476        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
29477 warn   message         = Remove internal headers
29478        remove_header   = $acl_c_ihdrs
29479 .endd
29480 Removed header lines are accumulated during the MAIL, RCPT, and predata ACLs.
29481 They are removed from the message before processing the DATA and MIME ACLs.
29482 There is no harm in attempting to remove the same header twice nor is removing
29483 a non-existent header. Further header lines to be removed may be accumulated
29484 during the DATA and MIME ACLs, after which they are removed from the message,
29485 if present. In the case of non-SMTP messages, headers to be removed are
29486 accumulated during the non-SMTP ACLs, and are removed from the message after
29487 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
29488 ACL, there really is no effect because there is no logging of what headers
29489 would have been removed.
29490
29491 .cindex "header lines" "removed; visibility of"
29492 Header lines are not visible in string expansions until the DATA phase when it
29493 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
29494 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
29495 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
29496 this restriction, you cannot use header lines as a way of controlling data
29497 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
29498 you should instead use ACL variables, as described in section
29499 &<<SECTaclvariables>>&.
29500
29501 The &%remove_header%& modifier acts immediately as it is encountered during the
29502 processing of an ACL. Notice the difference between these two cases:
29503 .display
29504 &`accept remove_header = X-Internal`&
29505 &`       `&<&'some condition'&>
29506
29507 &`accept `&<&'some condition'&>
29508 &`       remove_header = X-Internal`&
29509 .endd
29510 In the first case, the header line is always removed, whether or not the
29511 condition is true. In the second case, the header line is removed only if the
29512 condition is true. Multiple occurrences of &%remove_header%& may occur in the
29513 same ACL statement. All those that are encountered before a condition fails
29514 are honoured.
29515
29516 &*Warning*&: This facility currently applies only to header lines that are
29517 present during ACL processing. It does NOT remove header lines that are added
29518 in a system filter or in a router or transport.
29519
29520
29521
29522
29523 .section "ACL conditions" "SECTaclconditions"
29524 .cindex "&ACL;" "conditions; list of"
29525 Some of the conditions listed in this section are available only when Exim is
29526 compiled with the content-scanning extension. They are included here briefly
29527 for completeness. More detailed descriptions can be found in the discussion on
29528 content scanning in chapter &<<CHAPexiscan>>&.
29529
29530 Not all conditions are relevant in all circumstances. For example, testing
29531 senders and recipients does not make sense in an ACL that is being run as the
29532 result of the arrival of an ETRN command, and checks on message headers can be
29533 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
29534 can use the same condition (with different parameters) more than once in the
29535 same ACL statement. This provides a way of specifying an &"and"& conjunction.
29536 The conditions are as follows:
29537
29538
29539 .vlist
29540 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
29541 .cindex "&ACL;" "nested"
29542 .cindex "&ACL;" "indirect"
29543 .cindex "&ACL;" "arguments"
29544 .cindex "&%acl%& ACL condition"
29545 The possible values of the argument are the same as for the
29546 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
29547 &"accept"& the condition is true; if it returns &"deny"& the condition is
29548 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
29549 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
29550 condition false. This means that further processing of the &%warn%& verb
29551 ceases, but processing of the ACL continues.
29552
29553 If the argument is a named ACL, up to nine space-separated optional values
29554 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
29555 and $acl_narg is set to the count of values.
29556 Previous values of these variables are restored after the call returns.
29557 The name and values are expanded separately.
29558 Note that spaces in complex expansions which are used as arguments
29559 will act as argument separators.
29560
29561 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
29562 the connection is dropped. If it returns &"discard"&, the verb must be
29563 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
29564 conditions are tested.
29565
29566 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
29567 loops. This condition allows you to use different ACLs in different
29568 circumstances. For example, different ACLs can be used to handle RCPT commands
29569 for different local users or different local domains.
29570
29571 .vitem &*authenticated&~=&~*&<&'string&~list'&>
29572 .cindex "&%authenticated%& ACL condition"
29573 .cindex "authentication" "ACL checking"
29574 .cindex "&ACL;" "testing for authentication"
29575 If the SMTP connection is not authenticated, the condition is false. Otherwise,
29576 the name of the authenticator is tested against the list. To test for
29577 authentication by any authenticator, you can set
29578 .code
29579 authenticated = *
29580 .endd
29581
29582 .vitem &*condition&~=&~*&<&'string'&>
29583 .cindex "&%condition%& ACL condition"
29584 .cindex "customizing" "ACL condition"
29585 .cindex "&ACL;" "customized test"
29586 .cindex "&ACL;" "testing, customized"
29587 This feature allows you to make up custom conditions. If the result of
29588 expanding the string is an empty string, the number zero, or one of the strings
29589 &"no"& or &"false"&, the condition is false. If the result is any non-zero
29590 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
29591 any other value, some error is assumed to have occurred, and the ACL returns
29592 &"defer"&. However, if the expansion is forced to fail, the condition is
29593 ignored. The effect is to treat it as true, whether it is positive or
29594 negative.
29595
29596 .vitem &*decode&~=&~*&<&'location'&>
29597 .cindex "&%decode%& ACL condition"
29598 This condition is available only when Exim is compiled with the
29599 content-scanning extension, and it is allowed only in the ACL defined by
29600 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
29601 If all goes well, the condition is true. It is false only if there are
29602 problems such as a syntax error or a memory shortage. For more details, see
29603 chapter &<<CHAPexiscan>>&.
29604
29605 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
29606 .cindex "&%dnslists%& ACL condition"
29607 .cindex "DNS list" "in ACL"
29608 .cindex "black list (DNS)"
29609 .cindex "&ACL;" "testing a DNS list"
29610 This condition checks for entries in DNS black lists. These are also known as
29611 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
29612 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
29613 different variants of this condition to describe briefly here. See sections
29614 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
29615
29616 .vitem &*domains&~=&~*&<&'domain&~list'&>
29617 .cindex "&%domains%& ACL condition"
29618 .cindex "domain" "ACL checking"
29619 .cindex "&ACL;" "testing a recipient domain"
29620 .vindex "&$domain_data$&"
29621 This condition is relevant only after a RCPT command. It checks that the domain
29622 of the recipient address is in the domain list. If percent-hack processing is
29623 enabled, it is done before this test is done. If the check succeeds with a
29624 lookup, the result of the lookup is placed in &$domain_data$& until the next
29625 &%domains%& test.
29626
29627 &*Note carefully*& (because many people seem to fall foul of this): you cannot
29628 use &%domains%& in a DATA ACL.
29629
29630
29631 .vitem &*encrypted&~=&~*&<&'string&~list'&>
29632 .cindex "&%encrypted%& ACL condition"
29633 .cindex "encryption" "checking in an ACL"
29634 .cindex "&ACL;" "testing for encryption"
29635 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
29636 name of the cipher suite in use is tested against the list. To test for
29637 encryption without testing for any specific cipher suite(s), set
29638 .code
29639 encrypted = *
29640 .endd
29641
29642
29643 .vitem &*hosts&~=&~*&<&'host&~list'&>
29644 .cindex "&%hosts%& ACL condition"
29645 .cindex "host" "ACL checking"
29646 .cindex "&ACL;" "testing the client host"
29647 This condition tests that the calling host matches the host list. If you have
29648 name lookups or wildcarded host names and IP addresses in the same host list,
29649 you should normally put the IP addresses first. For example, you could have:
29650 .code
29651 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
29652 .endd
29653 The lookup in this example uses the host name for its key. This is implied by
29654 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
29655 and it wouldn't matter which way round you had these two items.)
29656
29657 The reason for the problem with host names lies in the left-to-right way that
29658 Exim processes lists. It can test IP addresses without doing any DNS lookups,
29659 but when it reaches an item that requires a host name, it fails if it cannot
29660 find a host name to compare with the pattern. If the above list is given in the
29661 opposite order, the &%accept%& statement fails for a host whose name cannot be
29662 found, even if its IP address is 10.9.8.7.
29663
29664 If you really do want to do the name check first, and still recognize the IP
29665 address even if the name lookup fails, you can rewrite the ACL like this:
29666 .code
29667 accept hosts = dbm;/etc/friendly/hosts
29668 accept hosts = 10.9.8.7
29669 .endd
29670 The default action on failing to find the host name is to assume that the host
29671 is not in the list, so the first &%accept%& statement fails. The second
29672 statement can then check the IP address.
29673
29674 .vindex "&$host_data$&"
29675 If a &%hosts%& condition is satisfied by means of a lookup, the result
29676 of the lookup is made available in the &$host_data$& variable. This
29677 allows you, for example, to set up a statement like this:
29678 .code
29679 deny  hosts = net-lsearch;/some/file
29680 message = $host_data
29681 .endd
29682 which gives a custom error message for each denied host.
29683
29684 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
29685 .cindex "&%local_parts%& ACL condition"
29686 .cindex "local part" "ACL checking"
29687 .cindex "&ACL;" "testing a local part"
29688 .vindex "&$local_part_data$&"
29689 This condition is relevant only after a RCPT command. It checks that the local
29690 part of the recipient address is in the list. If percent-hack processing is
29691 enabled, it is done before this test. If the check succeeds with a lookup, the
29692 result of the lookup is placed in &$local_part_data$&, which remains set until
29693 the next &%local_parts%& test.
29694
29695 .vitem &*malware&~=&~*&<&'option'&>
29696 .cindex "&%malware%& ACL condition"
29697 .cindex "&ACL;" "virus scanning"
29698 .cindex "&ACL;" "scanning for viruses"
29699 This condition is available only when Exim is compiled with the
29700 content-scanning extension. It causes the incoming message to be scanned for
29701 viruses. For details, see chapter &<<CHAPexiscan>>&.
29702
29703 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29704 .cindex "&%mime_regex%& ACL condition"
29705 .cindex "&ACL;" "testing by regex matching"
29706 This condition is available only when Exim is compiled with the
29707 content-scanning extension, and it is allowed only in the ACL defined by
29708 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
29709 with any of the regular expressions. For details, see chapter
29710 &<<CHAPexiscan>>&.
29711
29712 .vitem &*ratelimit&~=&~*&<&'parameters'&>
29713 .cindex "rate limiting"
29714 This condition can be used to limit the rate at which a user or host submits
29715 messages. Details are given in section &<<SECTratelimiting>>&.
29716
29717 .vitem &*recipients&~=&~*&<&'address&~list'&>
29718 .cindex "&%recipients%& ACL condition"
29719 .cindex "recipient" "ACL checking"
29720 .cindex "&ACL;" "testing a recipient"
29721 This condition is relevant only after a RCPT command. It checks the entire
29722 recipient address against a list of recipients.
29723
29724 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
29725 .cindex "&%regex%& ACL condition"
29726 .cindex "&ACL;" "testing by regex matching"
29727 This condition is available only when Exim is compiled with the
29728 content-scanning extension, and is available only in the DATA, MIME, and
29729 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
29730 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
29731
29732 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
29733 .cindex "&%sender_domains%& ACL condition"
29734 .cindex "sender" "ACL checking"
29735 .cindex "&ACL;" "testing a sender domain"
29736 .vindex "&$domain$&"
29737 .vindex "&$sender_address_domain$&"
29738 This condition tests the domain of the sender of the message against the given
29739 domain list. &*Note*&: The domain of the sender address is in
29740 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
29741 of this condition. This is an exception to the general rule for testing domain
29742 lists. It is done this way so that, if this condition is used in an ACL for a
29743 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
29744 influence the sender checking.
29745
29746 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29747 relaying, because sender addresses are easily, and commonly, forged.
29748
29749 .vitem &*senders&~=&~*&<&'address&~list'&>
29750 .cindex "&%senders%& ACL condition"
29751 .cindex "sender" "ACL checking"
29752 .cindex "&ACL;" "testing a sender"
29753 This condition tests the sender of the message against the given list. To test
29754 for a bounce message, which has an empty sender, set
29755 .code
29756 senders = :
29757 .endd
29758 &*Warning*&: It is a bad idea to use this condition on its own as a control on
29759 relaying, because sender addresses are easily, and commonly, forged.
29760
29761 .vitem &*spam&~=&~*&<&'username'&>
29762 .cindex "&%spam%& ACL condition"
29763 .cindex "&ACL;" "scanning for spam"
29764 This condition is available only when Exim is compiled with the
29765 content-scanning extension. It causes the incoming message to be scanned by
29766 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
29767
29768 .vitem &*verify&~=&~certificate*&
29769 .cindex "&%verify%& ACL condition"
29770 .cindex "TLS" "client certificate verification"
29771 .cindex "certificate" "verification of client"
29772 .cindex "&ACL;" "certificate verification"
29773 .cindex "&ACL;" "testing a TLS certificate"
29774 This condition is true in an SMTP session if the session is encrypted, and a
29775 certificate was received from the client, and the certificate was verified. The
29776 server requests a certificate only if the client matches &%tls_verify_hosts%&
29777 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
29778
29779 .vitem &*verify&~=&~csa*&
29780 .cindex "CSA verification"
29781 This condition checks whether the sending host (the client) is authorized to
29782 send email. Details of how this works are given in section
29783 &<<SECTverifyCSA>>&.
29784
29785 .vitem &*verify&~=&~header_names_ascii*&
29786 .cindex "&%verify%& ACL condition"
29787 .cindex "&ACL;" "verifying header names only ASCII"
29788 .cindex "header lines" "verifying header names only ASCII"
29789 .cindex "verifying" "header names only ASCII"
29790 This condition is relevant only in an ACL that is run after a message has been
29791 received, that is, in an ACL specified by &%acl_smtp_data%& or
29792 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
29793 there are no non-ASCII characters, also excluding control characters.  The
29794 allowable characters are decimal ASCII values 33 through 126.
29795
29796 Exim itself will handle headers with non-ASCII characters, but it can cause
29797 problems for downstream applications, so this option will allow their
29798 detection and rejection in the DATA ACL's.
29799
29800 .vitem &*verify&~=&~header_sender/*&<&'options'&>
29801 .cindex "&%verify%& ACL condition"
29802 .cindex "&ACL;" "verifying sender in the header"
29803 .cindex "header lines" "verifying the sender in"
29804 .cindex "sender" "verifying in header"
29805 .cindex "verifying" "sender in header"
29806 This condition is relevant only in an ACL that is run after a message has been
29807 received, that is, in an ACL specified by &%acl_smtp_data%& or
29808 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
29809 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
29810 is loosely thought of as a &"sender"& address (hence the name of the test).
29811 However, an address that appears in one of these headers need not be an address
29812 that accepts bounce messages; only sender addresses in envelopes are required
29813 to accept bounces. Therefore, if you use the callout option on this check, you
29814 might want to arrange for a non-empty address in the MAIL command.
29815
29816 Details of address verification and the options are given later, starting at
29817 section &<<SECTaddressverification>>& (callouts are described in section
29818 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
29819 condition to restrict it to bounce messages only:
29820 .code
29821 deny    senders = :
29822         message = A valid sender header is required for bounces
29823        !verify  = header_sender
29824 .endd
29825
29826 .vitem &*verify&~=&~header_syntax*&
29827 .cindex "&%verify%& ACL condition"
29828 .cindex "&ACL;" "verifying header syntax"
29829 .cindex "header lines" "verifying syntax"
29830 .cindex "verifying" "header syntax"
29831 This condition is relevant only in an ACL that is run after a message has been
29832 received, that is, in an ACL specified by &%acl_smtp_data%& or
29833 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
29834 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
29835 and &'Bcc:'&), returning true if there are no problems.
29836 Unqualified addresses (local parts without domains) are
29837 permitted only in locally generated messages and from hosts that match
29838 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
29839 appropriate.
29840
29841 Note that this condition is a syntax check only. However, a common spamming
29842 ploy used to be to send syntactically invalid headers such as
29843 .code
29844 To: @
29845 .endd
29846 and this condition can be used to reject such messages, though they are not as
29847 common as they used to be.
29848
29849 .vitem &*verify&~=&~helo*&
29850 .cindex "&%verify%& ACL condition"
29851 .cindex "&ACL;" "verifying HELO/EHLO"
29852 .cindex "HELO" "verifying"
29853 .cindex "EHLO" "verifying"
29854 .cindex "verifying" "EHLO"
29855 .cindex "verifying" "HELO"
29856 This condition is true if a HELO or EHLO command has been received from the
29857 client host, and its contents have been verified. If there has been no previous
29858 attempt to verify the HELO/EHLO contents, it is carried out when this
29859 condition is encountered. See the description of the &%helo_verify_hosts%& and
29860 &%helo_try_verify_hosts%& options for details of how to request verification
29861 independently of this condition.
29862
29863 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
29864 option), this condition is always true.
29865
29866
29867 .vitem &*verify&~=&~not_blind*&
29868 .cindex "verifying" "not blind"
29869 .cindex "bcc recipients, verifying none"
29870 This condition checks that there are no blind (bcc) recipients in the message.
29871 Every envelope recipient must appear either in a &'To:'& header line or in a
29872 &'Cc:'& header line for this condition to be true. Local parts are checked
29873 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
29874 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
29875 used only in a DATA or non-SMTP ACL.
29876
29877 There are, of course, many legitimate messages that make use of blind (bcc)
29878 recipients. This check should not be used on its own for blocking messages.
29879
29880
29881 .vitem &*verify&~=&~recipient/*&<&'options'&>
29882 .cindex "&%verify%& ACL condition"
29883 .cindex "&ACL;" "verifying recipient"
29884 .cindex "recipient" "verifying"
29885 .cindex "verifying" "recipient"
29886 .vindex "&$address_data$&"
29887 This condition is relevant only after a RCPT command. It verifies the current
29888 recipient. Details of address verification are given later, starting at section
29889 &<<SECTaddressverification>>&. After a recipient has been verified, the value
29890 of &$address_data$& is the last value that was set while routing the address.
29891 This applies even if the verification fails. When an address that is being
29892 verified is redirected to a single address, verification continues with the new
29893 address, and in that case, the subsequent value of &$address_data$& is the
29894 value for the child address.
29895
29896 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
29897 .cindex "&%verify%& ACL condition"
29898 .cindex "&ACL;" "verifying host reverse lookup"
29899 .cindex "host" "verifying reverse lookup"
29900 This condition ensures that a verified host name has been looked up from the IP
29901 address of the client host. (This may have happened already if the host name
29902 was needed for checking a host list, or if the host matched &%host_lookup%&.)
29903 Verification ensures that the host name obtained from a reverse DNS lookup, or
29904 one of its aliases, does, when it is itself looked up in the DNS, yield the
29905 original IP address.
29906
29907 There is one possible option, &`defer_ok`&.  If this is present and a
29908 DNS operation returns a temporary error, the verify condition succeeds.
29909
29910 If this condition is used for a locally generated message (that is, when there
29911 is no client host involved), it always succeeds.
29912
29913 .vitem &*verify&~=&~sender/*&<&'options'&>
29914 .cindex "&%verify%& ACL condition"
29915 .cindex "&ACL;" "verifying sender"
29916 .cindex "sender" "verifying"
29917 .cindex "verifying" "sender"
29918 This condition is relevant only after a MAIL or RCPT command, or after a
29919 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
29920 the message's sender is empty (that is, this is a bounce message), the
29921 condition is true. Otherwise, the sender address is verified.
29922
29923 .vindex "&$address_data$&"
29924 .vindex "&$sender_address_data$&"
29925 If there is data in the &$address_data$& variable at the end of routing, its
29926 value is placed in &$sender_address_data$& at the end of verification. This
29927 value can be used in subsequent conditions and modifiers in the same ACL
29928 statement. It does not persist after the end of the current statement. If you
29929 want to preserve the value for longer, you can save it in an ACL variable.
29930
29931 Details of verification are given later, starting at section
29932 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
29933 to avoid doing it more than once per message.
29934
29935 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
29936 .cindex "&%verify%& ACL condition"
29937 This is a variation of the previous option, in which a modified address is
29938 verified as a sender.
29939
29940 Note that '/' is legal in local-parts; if the address may have such
29941 (eg. is generated from the received message)
29942 they must be protected from the options parsing by doubling:
29943 .code
29944 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
29945 .endd
29946 .endlist
29947
29948
29949
29950 .section "Using DNS lists" "SECTmorednslists"
29951 .cindex "DNS list" "in ACL"
29952 .cindex "black list (DNS)"
29953 .cindex "&ACL;" "testing a DNS list"
29954 In its simplest form, the &%dnslists%& condition tests whether the calling host
29955 is on at least one of a number of DNS lists by looking up the inverted IP
29956 address in one or more DNS domains. (Note that DNS list domains are not mail
29957 domains, so the &`+`& syntax for named lists doesn't work - it is used for
29958 special options instead.) For example, if the calling host's IP
29959 address is 192.168.62.43, and the ACL statement is
29960 .code
29961 deny dnslists = blackholes.mail-abuse.org : \
29962                 dialups.mail-abuse.org
29963 .endd
29964 the following records are looked up:
29965 .code
29966 43.62.168.192.blackholes.mail-abuse.org
29967 43.62.168.192.dialups.mail-abuse.org
29968 .endd
29969 As soon as Exim finds an existing DNS record, processing of the list stops.
29970 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
29971 to test that a host is on more than one list (an &"and"& conjunction), you can
29972 use two separate conditions:
29973 .code
29974 deny dnslists = blackholes.mail-abuse.org
29975      dnslists = dialups.mail-abuse.org
29976 .endd
29977 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
29978 behaves as if the host does not match the list item, that is, as if the DNS
29979 record does not exist. If there are further items in the DNS list, they are
29980 processed.
29981
29982 This is usually the required action when &%dnslists%& is used with &%deny%&
29983 (which is the most common usage), because it prevents a DNS failure from
29984 blocking mail. However, you can change this behaviour by putting one of the
29985 following special items in the list:
29986 .display
29987 &`+include_unknown `&   behave as if the item is on the list
29988 &`+exclude_unknown `&   behave as if the item is not on the list (default)
29989 &`+defer_unknown   `&   give a temporary error
29990 .endd
29991 .cindex "&`+include_unknown`&"
29992 .cindex "&`+exclude_unknown`&"
29993 .cindex "&`+defer_unknown`&"
29994 Each of these applies to any subsequent items on the list. For example:
29995 .code
29996 deny dnslists = +defer_unknown : foo.bar.example
29997 .endd
29998 Testing the list of domains stops as soon as a match is found. If you want to
29999 warn for one list and block for another, you can use two different statements:
30000 .code
30001 deny  dnslists = blackholes.mail-abuse.org
30002 warn  message  = X-Warn: sending host is on dialups list
30003       dnslists = dialups.mail-abuse.org
30004 .endd
30005 .cindex caching "of dns lookup"
30006 .cindex DNS TTL
30007 DNS list lookups are cached by Exim for the duration of the SMTP session
30008 (but limited by the DNS return TTL value),
30009 so a lookup based on the IP address is done at most once for any incoming
30010 connection (assuming long-enough TTL).
30011 Exim does not share information between multiple incoming
30012 connections (but your local name server cache should be active).
30013
30014
30015
30016 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30017 .cindex "DNS list" "keyed by explicit IP address"
30018 By default, the IP address that is used in a DNS list lookup is the IP address
30019 of the calling host. However, you can specify another IP address by listing it
30020 after the domain name, introduced by a slash. For example:
30021 .code
30022 deny dnslists = black.list.tld/192.168.1.2
30023 .endd
30024 This feature is not very helpful with explicit IP addresses; it is intended for
30025 use with IP addresses that are looked up, for example, the IP addresses of the
30026 MX hosts or nameservers of an email sender address. For an example, see section
30027 &<<SECTmulkeyfor>>& below.
30028
30029
30030
30031
30032 .section "DNS lists keyed on domain names" "SECID202"
30033 .cindex "DNS list" "keyed by domain name"
30034 There are some lists that are keyed on domain names rather than inverted IP
30035 addresses (see for example the &'domain based zones'& link at
30036 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
30037 with these lists. You can change the name that is looked up in a DNS list by
30038 listing it after the domain name, introduced by a slash. For example,
30039 .code
30040 deny  message  = Sender's domain is listed at $dnslist_domain
30041       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
30042 .endd
30043 This particular example is useful only in ACLs that are obeyed after the
30044 RCPT or DATA commands, when a sender address is available. If (for
30045 example) the message's sender is &'user@tld.example'& the name that is looked
30046 up by this example is
30047 .code
30048 tld.example.dsn.rfc-ignorant.org
30049 .endd
30050 A single &%dnslists%& condition can contain entries for both names and IP
30051 addresses. For example:
30052 .code
30053 deny dnslists = sbl.spamhaus.org : \
30054                 dsn.rfc-ignorant.org/$sender_address_domain
30055 .endd
30056 The first item checks the sending host's IP address; the second checks a domain
30057 name. The whole condition is true if either of the DNS lookups succeeds.
30058
30059
30060
30061
30062 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
30063 .cindex "DNS list" "multiple keys for"
30064 The syntax described above for looking up explicitly-defined values (either
30065 names or IP addresses) in a DNS blacklist is a simplification. After the domain
30066 name for the DNS list, what follows the slash can in fact be a list of items.
30067 As with all lists in Exim, the default separator is a colon. However, because
30068 this is a sublist within the list of DNS blacklist domains, it is necessary
30069 either to double the separators like this:
30070 .code
30071 dnslists = black.list.tld/name.1::name.2
30072 .endd
30073 or to change the separator character, like this:
30074 .code
30075 dnslists = black.list.tld/<;name.1;name.2
30076 .endd
30077 If an item in the list is an IP address, it is inverted before the DNS
30078 blacklist domain is appended. If it is not an IP address, no inversion
30079 occurs. Consider this condition:
30080 .code
30081 dnslists = black.list.tld/<;192.168.1.2;a.domain
30082 .endd
30083 The DNS lookups that occur are:
30084 .code
30085 2.1.168.192.black.list.tld
30086 a.domain.black.list.tld
30087 .endd
30088 Once a DNS record has been found (that matches a specific IP return
30089 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
30090 are done. If there is a temporary DNS error, the rest of the sublist of domains
30091 or IP addresses is tried. A temporary error for the whole dnslists item occurs
30092 only if no other DNS lookup in this sublist succeeds. In other words, a
30093 successful lookup for any of the items in the sublist overrides a temporary
30094 error for a previous item.
30095
30096 The ability to supply a list of items after the slash is in some sense just a
30097 syntactic convenience. These two examples have the same effect:
30098 .code
30099 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
30100 dnslists = black.list.tld/a.domain::b.domain
30101 .endd
30102 However, when the data for the list is obtained from a lookup, the second form
30103 is usually much more convenient. Consider this example:
30104 .code
30105 deny message  = The mail servers for the domain \
30106                 $sender_address_domain \
30107                 are listed at $dnslist_domain ($dnslist_value); \
30108                 see $dnslist_text.
30109      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
30110                                    ${lookup dnsdb {>|mxh=\
30111                                    $sender_address_domain} }} }
30112 .endd
30113 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
30114 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
30115 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
30116 of expanding the condition might be something like this:
30117 .code
30118 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
30119 .endd
30120 Thus, this example checks whether or not the IP addresses of the sender
30121 domain's mail servers are on the Spamhaus black list.
30122
30123 The key that was used for a successful DNS list lookup is put into the variable
30124 &$dnslist_matched$& (see section &<<SECID204>>&).
30125
30126
30127
30128
30129 .section "Data returned by DNS lists" "SECID203"
30130 .cindex "DNS list" "data returned from"
30131 DNS lists are constructed using address records in the DNS. The original RBL
30132 just used the address 127.0.0.1 on the right hand side of each record, but the
30133 RBL+ list and some other lists use a number of values with different meanings.
30134 The values used on the RBL+ list are:
30135 .display
30136 127.1.0.1  RBL
30137 127.1.0.2  DUL
30138 127.1.0.3  DUL and RBL
30139 127.1.0.4  RSS
30140 127.1.0.5  RSS and RBL
30141 127.1.0.6  RSS and DUL
30142 127.1.0.7  RSS and DUL and RBL
30143 .endd
30144 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
30145 different values. Some DNS lists may return more than one address record;
30146 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
30147
30148
30149 .section "Variables set from DNS lists" "SECID204"
30150 .cindex "expansion" "variables, set from DNS list"
30151 .cindex "DNS list" "variables set from"
30152 .vindex "&$dnslist_domain$&"
30153 .vindex "&$dnslist_matched$&"
30154 .vindex "&$dnslist_text$&"
30155 .vindex "&$dnslist_value$&"
30156 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
30157 the name of the overall domain that matched (for example,
30158 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
30159 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
30160 the DNS record. When the key is an IP address, it is not reversed in
30161 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
30162 cases, for example:
30163 .code
30164 deny dnslists = spamhaus.example
30165 .endd
30166 the key is also available in another variable (in this case,
30167 &$sender_host_address$&). In more complicated cases, however, this is not true.
30168 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
30169 might generate a dnslists lookup like this:
30170 .code
30171 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
30172 .endd
30173 If this condition succeeds, the value in &$dnslist_matched$& might be
30174 &`192.168.6.7`& (for example).
30175
30176 If more than one address record is returned by the DNS lookup, all the IP
30177 addresses are included in &$dnslist_value$&, separated by commas and spaces.
30178 The variable &$dnslist_text$& contains the contents of any associated TXT
30179 record. For lists such as RBL+ the TXT record for a merged entry is often not
30180 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
30181 information.
30182
30183 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
30184 &-- although these appear before the condition in the ACL, they are not
30185 expanded until after it has failed. For example:
30186 .code
30187 deny    hosts = !+local_networks
30188         message = $sender_host_address is listed \
30189                   at $dnslist_domain
30190         dnslists = rbl-plus.mail-abuse.example
30191 .endd
30192
30193
30194
30195 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
30196 .cindex "DNS list" "matching specific returned data"
30197 You can add an equals sign and an IP address after a &%dnslists%& domain name
30198 in order to restrict its action to DNS records with a matching right hand side.
30199 For example,
30200 .code
30201 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
30202 .endd
30203 rejects only those hosts that yield 127.0.0.2. Without this additional data,
30204 any address record is considered to be a match. For the moment, we assume
30205 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
30206 describes how multiple records are handled.
30207
30208 More than one IP address may be given for checking, using a comma as a
30209 separator. These are alternatives &-- if any one of them matches, the
30210 &%dnslists%& condition is true. For example:
30211 .code
30212 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30213 .endd
30214 If you want to specify a constraining address list and also specify names or IP
30215 addresses to be looked up, the constraining address list must be specified
30216 first. For example:
30217 .code
30218 deny dnslists = dsn.rfc-ignorant.org\
30219                 =127.0.0.2/$sender_address_domain
30220 .endd
30221
30222 If the character &`&&`& is used instead of &`=`&, the comparison for each
30223 listed IP address is done by a bitwise &"and"& instead of by an equality test.
30224 In other words, the listed addresses are used as bit masks. The comparison is
30225 true if all the bits in the mask are present in the address that is being
30226 tested. For example:
30227 .code
30228 dnslists = a.b.c&0.0.0.3
30229 .endd
30230 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
30231 want to test whether one bit or another bit is present (as opposed to both
30232 being present), you must use multiple values. For example:
30233 .code
30234 dnslists = a.b.c&0.0.0.1,0.0.0.2
30235 .endd
30236 matches if the final component of the address is an odd number or two times
30237 an odd number.
30238
30239
30240
30241 .section "Negated DNS matching conditions" "SECID205"
30242 You can supply a negative list of IP addresses as part of a &%dnslists%&
30243 condition. Whereas
30244 .code
30245 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
30246 .endd
30247 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30248 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
30249 .code
30250 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
30251 .endd
30252 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
30253 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
30254 words, the result of the test is inverted if an exclamation mark appears before
30255 the &`=`& (or the &`&&`&) sign.
30256
30257 &*Note*&: This kind of negation is not the same as negation in a domain,
30258 host, or address list (which is why the syntax is different).
30259
30260 If you are using just one list, the negation syntax does not gain you much. The
30261 previous example is precisely equivalent to
30262 .code
30263 deny  dnslists = a.b.c
30264      !dnslists = a.b.c=127.0.0.2,127.0.0.3
30265 .endd
30266 However, if you are using multiple lists, the negation syntax is clearer.
30267 Consider this example:
30268 .code
30269 deny  dnslists = sbl.spamhaus.org : \
30270                  list.dsbl.org : \
30271                  dnsbl.njabl.org!=127.0.0.3 : \
30272                  relays.ordb.org
30273 .endd
30274 Using only positive lists, this would have to be:
30275 .code
30276 deny  dnslists = sbl.spamhaus.org : \
30277                  list.dsbl.org
30278 deny  dnslists = dnsbl.njabl.org
30279      !dnslists = dnsbl.njabl.org=127.0.0.3
30280 deny  dnslists = relays.ordb.org
30281 .endd
30282 which is less clear, and harder to maintain.
30283
30284
30285
30286
30287 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
30288 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
30289 thereby providing more than one IP address. When an item in a &%dnslists%& list
30290 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
30291 the match to specific results from the DNS lookup, there are two ways in which
30292 the checking can be handled. For example, consider the condition:
30293 .code
30294 dnslists = a.b.c=127.0.0.1
30295 .endd
30296 What happens if the DNS lookup for the incoming IP address yields both
30297 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
30298 condition true because at least one given value was found, or is it false
30299 because at least one of the found values was not listed? And how does this
30300 affect negated conditions? Both possibilities are provided for with the help of
30301 additional separators &`==`& and &`=&&`&.
30302
30303 .ilist
30304 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
30305 IP addresses matches one of the listed addresses. For the example above, the
30306 condition is true because 127.0.0.1 matches.
30307 .next
30308 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
30309 looked up IP addresses matches one of the listed addresses. If the condition is
30310 changed to:
30311 .code
30312 dnslists = a.b.c==127.0.0.1
30313 .endd
30314 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30315 false because 127.0.0.2 is not listed. You would need to have:
30316 .code
30317 dnslists = a.b.c==127.0.0.1,127.0.0.2
30318 .endd
30319 for the condition to be true.
30320 .endlist
30321
30322 When &`!`& is used to negate IP address matching, it inverts the result, giving
30323 the precise opposite of the behaviour above. Thus:
30324 .ilist
30325 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
30326 addresses matches one of the listed addresses. Consider:
30327 .code
30328 dnslists = a.b.c!&0.0.0.1
30329 .endd
30330 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30331 false because 127.0.0.1 matches.
30332 .next
30333 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
30334 looked up IP address that does not match. Consider:
30335 .code
30336 dnslists = a.b.c!=&0.0.0.1
30337 .endd
30338 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
30339 true, because 127.0.0.2 does not match. You would need to have:
30340 .code
30341 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
30342 .endd
30343 for the condition to be false.
30344 .endlist
30345 When the DNS lookup yields only a single IP address, there is no difference
30346 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
30347
30348
30349
30350
30351 .section "Detailed information from merged DNS lists" "SECTmordetinf"
30352 .cindex "DNS list" "information from merged"
30353 When the facility for restricting the matching IP values in a DNS list is used,
30354 the text from the TXT record that is set in &$dnslist_text$& may not reflect
30355 the true reason for rejection. This happens when lists are merged and the IP
30356 address in the A record is used to distinguish them; unfortunately there is
30357 only one TXT record. One way round this is not to use merged lists, but that
30358 can be inefficient because it requires multiple DNS lookups where one would do
30359 in the vast majority of cases when the host of interest is not on any of the
30360 lists.
30361
30362 A less inefficient way of solving this problem is available. If
30363 two domain names, comma-separated, are given, the second is used first to
30364 do an initial check, making use of any IP value restrictions that are set.
30365 If there is a match, the first domain is used, without any IP value
30366 restrictions, to get the TXT record. As a byproduct of this, there is also
30367 a check that the IP being tested is indeed on the first list. The first
30368 domain is the one that is put in &$dnslist_domain$&. For example:
30369 .code
30370 reject message  = \
30371          rejected because $sender_host_address is blacklisted \
30372          at $dnslist_domain\n$dnslist_text
30373        dnslists = \
30374          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
30375          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30376 .endd
30377 For the first blacklist item, this starts by doing a lookup in
30378 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
30379 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
30380 value, and as long as something is found, it looks for the corresponding TXT
30381 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
30382 The second blacklist item is processed similarly.
30383
30384 If you are interested in more than one merged list, the same list must be
30385 given several times, but because the results of the DNS lookups are cached,
30386 the DNS calls themselves are not repeated. For example:
30387 .code
30388 reject dnslists = \
30389          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
30390          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
30391          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
30392          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
30393 .endd
30394 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
30395 values matches (or if no record is found), this is the only lookup that is
30396 done. Only if there is a match is one of the more specific lists consulted.
30397
30398
30399
30400 .section "DNS lists and IPv6" "SECTmorednslistslast"
30401 .cindex "IPv6" "DNS black lists"
30402 .cindex "DNS list" "IPv6 usage"
30403 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
30404 nibble by nibble. For example, if the calling host's IP address is
30405 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
30406 .code
30407 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
30408   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
30409 .endd
30410 (split over two lines here to fit on the page). Unfortunately, some of the DNS
30411 lists contain wildcard records, intended for IPv4, that interact badly with
30412 IPv6. For example, the DNS entry
30413 .code
30414 *.3.some.list.example.    A    127.0.0.1
30415 .endd
30416 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
30417 Unfortunately, it also matches the entire 3::/4 IPv6 network.
30418
30419 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
30420 &%condition%& condition, as in this example:
30421 .code
30422 deny   condition = ${if isip4{$sender_host_address}}
30423        dnslists  = some.list.example
30424 .endd
30425
30426 If an explicit key is being used for a DNS lookup and it may be an IPv6
30427 address you should specify alternate list separators for both the outer
30428 (DNS list name) list and inner (lookup keys) list:
30429 .code
30430        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
30431 .endd
30432
30433 .section "Rate limiting incoming messages" "SECTratelimiting"
30434 .cindex "rate limiting" "client sending"
30435 .cindex "limiting client sending rates"
30436 .oindex "&%smtp_ratelimit_*%&"
30437 The &%ratelimit%& ACL condition can be used to measure and control the rate at
30438 which clients can send email. This is more powerful than the
30439 &%smtp_ratelimit_*%& options, because those options control the rate of
30440 commands in a single SMTP session only, whereas the &%ratelimit%& condition
30441 works across all connections (concurrent and sequential) from the same client
30442 host. The syntax of the &%ratelimit%& condition is:
30443 .display
30444 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
30445 .endd
30446 If the average client sending rate is less than &'m'& messages per time
30447 period &'p'& then the condition is false; otherwise it is true.
30448
30449 As a side-effect, the &%ratelimit%& condition sets the expansion variable
30450 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
30451 configured value of &'m'&, and &$sender_rate_period$& to the configured value
30452 of &'p'&.
30453
30454 The parameter &'p'& is the smoothing time constant, in the form of an Exim
30455 time interval, for example, &`8h`& for eight hours. A larger time constant
30456 means that it takes Exim longer to forget a client's past behaviour. The
30457 parameter &'m'& is the maximum number of messages that a client is permitted to
30458 send in each time interval. It also specifies the number of messages permitted
30459 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
30460 constant, you can allow a client to send more messages in a burst without
30461 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
30462 both small, messages must be sent at an even rate.
30463
30464 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
30465 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
30466 when deploying the &%ratelimit%& ACL condition. The script prints usage
30467 instructions when it is run with no arguments.
30468
30469 The key is used to look up the data for calculating the client's average
30470 sending rate. This data is stored in Exim's spool directory, alongside the
30471 retry and other hints databases. The default key is &$sender_host_address$&,
30472 which means Exim computes the sending rate of each client host IP address.
30473 By changing the key you can change how Exim identifies clients for the purpose
30474 of ratelimiting. For example, to limit the sending rate of each authenticated
30475 user, independent of the computer they are sending from, set the key to
30476 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
30477 example, &$authenticated_id$& is only meaningful if the client has
30478 authenticated (which you can check with the &%authenticated%& ACL condition).
30479
30480 The lookup key does not have to identify clients: If you want to limit the
30481 rate at which a recipient receives messages, you can use the key
30482 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
30483 ACL.
30484
30485 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
30486 specifies what Exim measures the rate of, for example messages or recipients
30487 or bytes. You can adjust the measurement using the &%unique=%& and/or
30488 &%count=%& options. You can also control when Exim updates the recorded rate
30489 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
30490 separated by a slash, like the other parameters. They may appear in any order.
30491
30492 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
30493 any options that alter the meaning of the stored data. The limit &'m'& is not
30494 stored, so you can alter the configured maximum rate and Exim will still
30495 remember clients' past behaviour. If you change the &%per_*%& mode or add or
30496 remove the &%unique=%& option, the lookup key changes so Exim will forget past
30497 behaviour. The lookup key is not affected by changes to the update mode and
30498 the &%count=%& option.
30499
30500
30501 .section "Ratelimit options for what is being measured" "ratoptmea"
30502 .cindex "rate limiting" "per_* options"
30503 The &%per_conn%& option limits the client's connection rate. It is not
30504 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
30505 &%acl_not_smtp_start%& ACLs.
30506
30507 The &%per_mail%& option limits the client's rate of sending messages. This is
30508 the default if none of the &%per_*%& options is specified. It can be used in
30509 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
30510 &%acl_smtp_data%&, or &%acl_not_smtp%&.
30511
30512 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
30513 the same ACLs as the &%per_mail%& option, though it is best to use this option
30514 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
30515 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
30516 in its MAIL command, which may be inaccurate or completely missing. You can
30517 follow the limit &'m'& in the configuration with K, M, or G to specify limits
30518 in kilobytes, megabytes, or gigabytes, respectively.
30519
30520 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
30521 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30522 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
30523 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
30524 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
30525 in either case the rate limiting engine will see a message with many
30526 recipients as a large high-speed burst.
30527
30528 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
30529 number of different recipients that the client has sent messages to in the
30530 last time period. That is, if the client repeatedly sends messages to the same
30531 recipient, its measured rate is not increased. This option can only be used in
30532 &%acl_smtp_rcpt%&.
30533
30534 The &%per_cmd%& option causes Exim to recompute the rate every time the
30535 condition is processed. This can be used to limit the rate of any SMTP
30536 command. If it is used in multiple ACLs it can limit the aggregate rate of
30537 multiple different commands.
30538
30539 The &%count=%& option can be used to alter how much Exim adds to the client's
30540 measured rate. For example, the &%per_byte%& option is equivalent to
30541 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
30542 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
30543 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
30544
30545 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
30546
30547
30548 .section "Ratelimit update modes" "ratoptupd"
30549 .cindex "rate limiting" "reading data without updating"
30550 You can specify one of three options with the &%ratelimit%& condition to
30551 control when its database is updated. This section describes the &%readonly%&
30552 mode, and the next section describes the &%strict%& and &%leaky%& modes.
30553
30554 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
30555 previously-computed rate to check against the limit.
30556
30557 For example, you can test the client's sending rate and deny it access (when
30558 it is too fast) in the connect ACL. If the client passes this check then it
30559 can go on to send a message, in which case its recorded rate will be updated
30560 in the MAIL ACL. Subsequent connections from the same client will check this
30561 new rate.
30562 .code
30563 acl_check_connect:
30564  deny ratelimit = 100 / 5m / readonly
30565     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
30566                   (max $sender_rate_limit)
30567 # ...
30568 acl_check_mail:
30569  warn ratelimit = 100 / 5m / strict
30570     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
30571                   (max $sender_rate_limit)
30572 .endd
30573
30574 If Exim encounters multiple &%ratelimit%& conditions with the same key when
30575 processing a message then it may increase the client's measured rate more than
30576 it should. For example, this will happen if you check the &%per_rcpt%& option
30577 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
30578 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
30579 multiple update problems by using the &%readonly%& option on later ratelimit
30580 checks.
30581
30582 The &%per_*%& options described above do not make sense in some ACLs. If you
30583 use a &%per_*%& option in an ACL where it is not normally permitted then the
30584 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
30585 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
30586 next section) so you must specify the &%readonly%& option explicitly.
30587
30588
30589 .section "Ratelimit options for handling fast clients" "ratoptfast"
30590 .cindex "rate limiting" "strict and leaky modes"
30591 If a client's average rate is greater than the maximum, the rate limiting
30592 engine can react in two possible ways, depending on the presence of the
30593 &%strict%& or &%leaky%& update modes. This is independent of the other
30594 counter-measures (such as rejecting the message) that may be specified by the
30595 rest of the ACL.
30596
30597 The &%leaky%& (default) option means that the client's recorded rate is not
30598 updated if it is above the limit. The effect of this is that Exim measures the
30599 client's average rate of successfully sent email, which cannot be greater than
30600 the maximum allowed. If the client is over the limit it may suffer some
30601 counter-measures (as specified in the ACL), but it will still be able to send
30602 email at the configured maximum rate, whatever the rate of its attempts. This
30603 is generally the better choice if you have clients that retry automatically.
30604 For example, it does not prevent a sender with an over-aggressive retry rate
30605 from getting any email through.
30606
30607 The &%strict%& option means that the client's recorded rate is always
30608 updated. The effect of this is that Exim measures the client's average rate
30609 of attempts to send email, which can be much higher than the maximum it is
30610 actually allowed. If the client is over the limit it may be subjected to
30611 counter-measures by the ACL. It must slow down and allow sufficient time to
30612 pass that its computed rate falls below the maximum before it can send email
30613 again. The time (the number of smoothing periods) it must wait and not
30614 attempt to send mail can be calculated with this formula:
30615 .code
30616         ln(peakrate/maxrate)
30617 .endd
30618
30619
30620 .section "Limiting the rate of different events" "ratoptuniq"
30621 .cindex "rate limiting" "counting unique events"
30622 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
30623 rate of different events. For example, the &%per_addr%& option uses this
30624 mechanism to count the number of different recipients that the client has
30625 sent messages to in the last time period; it is equivalent to
30626 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
30627 measure the rate that a client uses different sender addresses with the
30628 options &`per_mail/unique=$sender_address`&.
30629
30630 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
30631 has seen for that key. The whole set is thrown away when it is older than the
30632 rate smoothing period &'p'&, so each different event is counted at most once
30633 per period. In the &%leaky%& update mode, an event that causes the client to
30634 go over the limit is not added to the set, in the same way that the client's
30635 recorded rate is not updated in the same situation.
30636
30637 When you combine the &%unique=%& and &%readonly%& options, the specific
30638 &%unique=%& value is ignored, and Exim just retrieves the client's stored
30639 rate.
30640
30641 The &%unique=%& mechanism needs more space in the ratelimit database than the
30642 other &%ratelimit%& options in order to store the event set. The number of
30643 unique values is potentially as large as the rate limit, so the extra space
30644 required increases with larger limits.
30645
30646 The uniqueification is not perfect: there is a small probability that Exim
30647 will think a new event has happened before. If the sender's rate is less than
30648 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
30649 the measured rate can go above the limit, in which case Exim may under-count
30650 events by a significant margin. Fortunately, if the rate is high enough (2.7
30651 times the limit) that the false positive rate goes above 9%, then Exim will
30652 throw away the over-full event set before the measured rate falls below the
30653 limit. Therefore the only harm should be that exceptionally high sending rates
30654 are logged incorrectly; any countermeasures you configure will be as effective
30655 as intended.
30656
30657
30658 .section "Using rate limiting" "useratlim"
30659 Exim's other ACL facilities are used to define what counter-measures are taken
30660 when the rate limit is exceeded. This might be anything from logging a warning
30661 (for example, while measuring existing sending rates in order to define
30662 policy), through time delays to slow down fast senders, up to rejecting the
30663 message. For example:
30664 .code
30665 # Log all senders' rates
30666 warn ratelimit = 0 / 1h / strict
30667      log_message = Sender rate $sender_rate / $sender_rate_period
30668
30669 # Slow down fast senders; note the need to truncate $sender_rate
30670 # at the decimal point.
30671 warn ratelimit = 100 / 1h / per_rcpt / strict
30672      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
30673                    $sender_rate_limit }s
30674
30675 # Keep authenticated users under control
30676 deny authenticated = *
30677      ratelimit = 100 / 1d / strict / $authenticated_id
30678
30679 # System-wide rate limit
30680 defer message = Sorry, too busy. Try again later.
30681      ratelimit = 10 / 1s / $primary_hostname
30682
30683 # Restrict incoming rate from each host, with a default
30684 # set using a macro and special cases looked up in a table.
30685 defer message = Sender rate exceeds $sender_rate_limit \
30686                messages per $sender_rate_period
30687      ratelimit = ${lookup {$sender_host_address} \
30688                    cdb {DB/ratelimits.cdb} \
30689                    {$value} {RATELIMIT} }
30690 .endd
30691 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
30692 especially with the &%per_rcpt%& option, you may suffer from a performance
30693 bottleneck caused by locking on the ratelimit hints database. Apart from
30694 making your ACLs less complicated, you can reduce the problem by using a
30695 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
30696 this means that Exim will lose its hints data after a reboot (including retry
30697 hints, the callout cache, and ratelimit data).
30698
30699
30700
30701 .section "Address verification" "SECTaddressverification"
30702 .cindex "verifying address" "options for"
30703 .cindex "policy control" "address verification"
30704 Several of the &%verify%& conditions described in section
30705 &<<SECTaclconditions>>& cause addresses to be verified. Section
30706 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
30707 The verification conditions can be followed by options that modify the
30708 verification process. The options are separated from the keyword and from each
30709 other by slashes, and some of them contain parameters. For example:
30710 .code
30711 verify = sender/callout
30712 verify = recipient/defer_ok/callout=10s,defer_ok
30713 .endd
30714 The first stage of address verification, which always happens, is to run the
30715 address through the routers, in &"verify mode"&. Routers can detect the
30716 difference between verification and routing for delivery, and their actions can
30717 be varied by a number of generic options such as &%verify%& and &%verify_only%&
30718 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
30719 The available options are as follows:
30720
30721 .ilist
30722 If the &%callout%& option is specified, successful routing to one or more
30723 remote hosts is followed by a &"callout"& to those hosts as an additional
30724 check. Callouts and their sub-options are discussed in the next section.
30725 .next
30726 If there is a defer error while doing verification routing, the ACL
30727 normally returns &"defer"&. However, if you include &%defer_ok%& in the
30728 options, the condition is forced to be true instead. Note that this is a main
30729 verification option as well as a suboption for callouts.
30730 .next
30731 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
30732 discusses the reporting of sender address verification failures.
30733 .next
30734 The &%success_on_redirect%& option causes verification always to succeed
30735 immediately after a successful redirection. By default, if a redirection
30736 generates just one address, that address is also verified. See further
30737 discussion in section &<<SECTredirwhilveri>>&.
30738 .endlist
30739
30740 .cindex "verifying address" "differentiating failures"
30741 .vindex "&$recipient_verify_failure$&"
30742 .vindex "&$sender_verify_failure$&"
30743 .vindex "&$acl_verify_message$&"
30744 After an address verification failure, &$acl_verify_message$& contains the
30745 error message that is associated with the failure. It can be preserved by
30746 coding like this:
30747 .code
30748 warn  !verify = sender
30749        set acl_m0 = $acl_verify_message
30750 .endd
30751 If you are writing your own custom rejection message or log message when
30752 denying access, you can use this variable to include information about the
30753 verification failure.
30754
30755 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
30756 appropriate) contains one of the following words:
30757
30758 .ilist
30759 &%qualify%&: The address was unqualified (no domain), and the message
30760 was neither local nor came from an exempted host.
30761 .next
30762 &%route%&: Routing failed.
30763 .next
30764 &%mail%&: Routing succeeded, and a callout was attempted; rejection
30765 occurred at or before the MAIL command (that is, on initial
30766 connection, HELO, or MAIL).
30767 .next
30768 &%recipient%&: The RCPT command in a callout was rejected.
30769 .next
30770 &%postmaster%&: The postmaster check in a callout was rejected.
30771 .endlist
30772
30773 The main use of these variables is expected to be to distinguish between
30774 rejections of MAIL and rejections of RCPT in callouts.
30775
30776
30777
30778
30779 .section "Callout verification" "SECTcallver"
30780 .cindex "verifying address" "by callout"
30781 .cindex "callout" "verification"
30782 .cindex "SMTP" "callout verification"
30783 For non-local addresses, routing verifies the domain, but is unable to do any
30784 checking of the local part. There are situations where some means of verifying
30785 the local part is desirable. One way this can be done is to make an SMTP
30786 &'callback'& to a delivery host for the sender address or a &'callforward'& to
30787 a subsequent host for a recipient address, to see if the host accepts the
30788 address. We use the term &'callout'& to cover both cases. Note that for a
30789 sender address, the callback is not to the client host that is trying to
30790 deliver the message, but to one of the hosts that accepts incoming mail for the
30791 sender's domain.
30792
30793 Exim does not do callouts by default. If you want them to happen, you must
30794 request them by setting appropriate options on the &%verify%& condition, as
30795 described below. This facility should be used with care, because it can add a
30796 lot of resource usage to the cost of verifying an address. However, Exim does
30797 cache the results of callouts, which helps to reduce the cost. Details of
30798 caching are in section &<<SECTcallvercache>>&.
30799
30800 Recipient callouts are usually used only between hosts that are controlled by
30801 the same administration. For example, a corporate gateway host could use
30802 callouts to check for valid recipients on an internal mailserver. A successful
30803 callout does not guarantee that a real delivery to the address would succeed;
30804 on the other hand, a failing callout does guarantee that a delivery would fail.
30805
30806 If the &%callout%& option is present on a condition that verifies an address, a
30807 second stage of verification occurs if the address is successfully routed to
30808 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
30809 &(manualroute)& router, where the router specifies the hosts. However, if a
30810 router that does not set up hosts routes to an &(smtp)& transport with a
30811 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
30812 &%hosts_override%& set, its hosts are always used, whether or not the router
30813 supplies a host list.
30814 Callouts are only supported on &(smtp)& transports.
30815
30816 The port that is used is taken from the transport, if it is specified and is a
30817 remote transport. (For routers that do verification only, no transport need be
30818 specified.) Otherwise, the default SMTP port is used. If a remote transport
30819 specifies an outgoing interface, this is used; otherwise the interface is not
30820 specified. Likewise, the text that is used for the HELO command is taken from
30821 the transport's &%helo_data%& option; if there is no transport, the value of
30822 &$smtp_active_hostname$& is used.
30823
30824 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
30825 test whether a bounce message could be delivered to the sender address. The
30826 following SMTP commands are sent:
30827 .display
30828 &`HELO `&<&'local host name'&>
30829 &`MAIL FROM:<>`&
30830 &`RCPT TO:`&<&'the address to be tested'&>
30831 &`QUIT`&
30832 .endd
30833 LHLO is used instead of HELO if the transport's &%protocol%& option is
30834 set to &"lmtp"&.
30835
30836 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
30837 settings.
30838
30839 A recipient callout check is similar. By default, it also uses an empty address
30840 for the sender. This default is chosen because most hosts do not make use of
30841 the sender address when verifying a recipient. Using the same address means
30842 that a single cache entry can be used for each recipient. Some sites, however,
30843 do make use of the sender address when verifying. These are catered for by the
30844 &%use_sender%& and &%use_postmaster%& options, described in the next section.
30845
30846 If the response to the RCPT command is a 2&'xx'& code, the verification
30847 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
30848 Exim tries the next host, if any. If there is a problem with all the remote
30849 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
30850 &%callout%& option is given, in which case the condition is forced to succeed.
30851
30852 .cindex "SMTP" "output flushing, disabling for callout"
30853 A callout may take a little time. For this reason, Exim normally flushes SMTP
30854 output before performing a callout in an ACL, to avoid unexpected timeouts in
30855 clients when the SMTP PIPELINING extension is in use. The flushing can be
30856 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
30857
30858
30859
30860
30861 .section "Additional parameters for callouts" "CALLaddparcall"
30862 .cindex "callout" "additional parameters for"
30863 The &%callout%& option can be followed by an equals sign and a number of
30864 optional parameters, separated by commas. For example:
30865 .code
30866 verify = recipient/callout=10s,defer_ok
30867 .endd
30868 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
30869 separate verify options, is retained for backwards compatibility, but is now
30870 deprecated. The additional parameters for &%callout%& are as follows:
30871
30872
30873 .vlist
30874 .vitem <&'a&~time&~interval'&>
30875 .cindex "callout" "timeout, specifying"
30876 This specifies the timeout that applies for the callout attempt to each host.
30877 For example:
30878 .code
30879 verify = sender/callout=5s
30880 .endd
30881 The default is 30 seconds. The timeout is used for each response from the
30882 remote host. It is also used for the initial connection, unless overridden by
30883 the &%connect%& parameter.
30884
30885
30886 .vitem &*connect&~=&~*&<&'time&~interval'&>
30887 .cindex "callout" "connection timeout, specifying"
30888 This parameter makes it possible to set a different (usually smaller) timeout
30889 for making the SMTP connection. For example:
30890 .code
30891 verify = sender/callout=5s,connect=1s
30892 .endd
30893 If not specified, this timeout defaults to the general timeout value.
30894
30895 .vitem &*defer_ok*&
30896 .cindex "callout" "defer, action on"
30897 When this parameter is present, failure to contact any host, or any other kind
30898 of temporary error, is treated as success by the ACL. However, the cache is not
30899 updated in this circumstance.
30900
30901 .vitem &*fullpostmaster*&
30902 .cindex "callout" "full postmaster check"
30903 This operates like the &%postmaster%& option (see below), but if the check for
30904 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
30905 accordance with the specification in RFC 2821. The RFC states that the
30906 unqualified address &'postmaster'& should be accepted.
30907
30908
30909 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
30910 .cindex "callout" "sender when verifying header"
30911 When verifying addresses in header lines using the &%header_sender%&
30912 verification option, Exim behaves by default as if the addresses are envelope
30913 sender addresses from a message. Callout verification therefore tests to see
30914 whether a bounce message could be delivered, by using an empty address in the
30915 MAIL command. However, it is arguable that these addresses might never be used
30916 as envelope senders, and could therefore justifiably reject bounce messages
30917 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
30918 address to use in the MAIL command. For example:
30919 .code
30920 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
30921 .endd
30922 This parameter is available only for the &%header_sender%& verification option.
30923
30924
30925 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
30926 .cindex "callout" "overall timeout, specifying"
30927 This parameter sets an overall timeout for performing a callout verification.
30928 For example:
30929 .code
30930 verify = sender/callout=5s,maxwait=30s
30931 .endd
30932 This timeout defaults to four times the callout timeout for individual SMTP
30933 commands. The overall timeout applies when there is more than one host that can
30934 be tried. The timeout is checked before trying the next host. This prevents
30935 very long delays if there are a large number of hosts and all are timing out
30936 (for example, when network connections are timing out).
30937
30938
30939 .vitem &*no_cache*&
30940 .cindex "callout" "cache, suppressing"
30941 .cindex "caching callout, suppressing"
30942 When this parameter is given, the callout cache is neither read nor updated.
30943
30944 .vitem &*postmaster*&
30945 .cindex "callout" "postmaster; checking"
30946 When this parameter is set, a successful callout check is followed by a similar
30947 check for the local part &'postmaster'& at the same domain. If this address is
30948 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
30949 the postmaster check is recorded in a cache record; if it is a failure, this is
30950 used to fail subsequent callouts for the domain without a connection being
30951 made, until the cache record expires.
30952
30953 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
30954 The postmaster check uses an empty sender in the MAIL command by default.
30955 You can use this parameter to do a postmaster check using a different address.
30956 For example:
30957 .code
30958 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
30959 .endd
30960 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
30961 one overrides. The &%postmaster%& parameter is equivalent to this example:
30962 .code
30963 require  verify = sender/callout=postmaster_mailfrom=
30964 .endd
30965 &*Warning*&: The caching arrangements for postmaster checking do not take
30966 account of the sender address. It is assumed that either the empty address or
30967 a fixed non-empty address will be used. All that Exim remembers is that the
30968 postmaster check for the domain succeeded or failed.
30969
30970
30971 .vitem &*random*&
30972 .cindex "callout" "&""random""& check"
30973 When this parameter is set, before doing the normal callout check, Exim does a
30974 check for a &"random"& local part at the same domain. The local part is not
30975 really random &-- it is defined by the expansion of the option
30976 &%callout_random_local_part%&, which defaults to
30977 .code
30978 $primary_hostname-$tod_epoch-testing
30979 .endd
30980 The idea here is to try to determine whether the remote host accepts all local
30981 parts without checking. If it does, there is no point in doing callouts for
30982 specific local parts. If the &"random"& check succeeds, the result is saved in
30983 a cache record, and used to force the current and subsequent callout checks to
30984 succeed without a connection being made, until the cache record expires.
30985
30986 .vitem &*use_postmaster*&
30987 .cindex "callout" "sender for recipient check"
30988 This parameter applies to recipient callouts only. For example:
30989 .code
30990 deny  !verify = recipient/callout=use_postmaster
30991 .endd
30992 .vindex "&$qualify_domain$&"
30993 It causes a non-empty postmaster address to be used in the MAIL command when
30994 performing the callout for the recipient, and also for a &"random"& check if
30995 that is configured. The local part of the address is &`postmaster`& and the
30996 domain is the contents of &$qualify_domain$&.
30997
30998 .vitem &*use_sender*&
30999 This option applies to recipient callouts only. For example:
31000 .code
31001 require  verify = recipient/callout=use_sender
31002 .endd
31003 It causes the message's actual sender address to be used in the MAIL
31004 command when performing the callout, instead of an empty address. There is no
31005 need to use this option unless you know that the called hosts make use of the
31006 sender when checking recipients. If used indiscriminately, it reduces the
31007 usefulness of callout caching.
31008
31009 .new
31010 .vitem &*hold*&
31011 This option applies to recipient callouts only. For example:
31012 .code
31013 require  verify = recipient/callout=use_sender,hold
31014 .endd
31015 It causes the connection to be helod open and used for any further recipients
31016 and for eventual delivery (should that be done quickly).
31017 Doing this saves on TCP and SMTP startup costs, and TLS costs also
31018 when that is used for the connections.
31019 The advantage is only gained if there are no callout cache hits
31020 (which could be enforced by the no_cache option),
31021 if the use_sender option is used,
31022 if neither the random nor the use_postmaster option is used,
31023 and if no other callouts intervene.
31024 .wen
31025 .endlist
31026
31027 If you use any of the parameters that set a non-empty sender for the MAIL
31028 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
31029 &%use_sender%&), you should think about possible loops. Recipient checking is
31030 usually done between two hosts that are under the same management, and the host
31031 that receives the callouts is not normally configured to do callouts itself.
31032 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
31033 these circumstances.
31034
31035 However, if you use a non-empty sender address for a callout to an arbitrary
31036 host, there is the likelihood that the remote host will itself initiate a
31037 callout check back to your host. As it is checking what appears to be a message
31038 sender, it is likely to use an empty address in MAIL, thus avoiding a
31039 callout loop. However, to be on the safe side it would be best to set up your
31040 own ACLs so that they do not do sender verification checks when the recipient
31041 is the address you use for header sender or postmaster callout checking.
31042
31043 Another issue to think about when using non-empty senders for callouts is
31044 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
31045 by the sender/recipient combination; thus, for any given recipient, many more
31046 actual callouts are performed than when an empty sender or postmaster is used.
31047
31048
31049
31050
31051 .section "Callout caching" "SECTcallvercache"
31052 .cindex "hints database" "callout cache"
31053 .cindex "callout" "cache, description of"
31054 .cindex "caching" "callout"
31055 Exim caches the results of callouts in order to reduce the amount of resources
31056 used, unless you specify the &%no_cache%& parameter with the &%callout%&
31057 option. A hints database called &"callout"& is used for the cache. Two
31058 different record types are used: one records the result of a callout check for
31059 a specific address, and the other records information that applies to the
31060 entire domain (for example, that it accepts the local part &'postmaster'&).
31061
31062 When an original callout fails, a detailed SMTP error message is given about
31063 the failure. However, for subsequent failures use the cache data, this message
31064 is not available.
31065
31066 The expiry times for negative and positive address cache records are
31067 independent, and can be set by the global options &%callout_negative_expire%&
31068 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
31069
31070 If a host gives a negative response to an SMTP connection, or rejects any
31071 commands up to and including
31072 .code
31073 MAIL FROM:<>
31074 .endd
31075 (but not including the MAIL command with a non-empty address),
31076 any callout attempt is bound to fail. Exim remembers such failures in a
31077 domain cache record, which it uses to fail callouts for the domain without
31078 making new connections, until the domain record times out. There are two
31079 separate expiry times for domain cache records:
31080 &%callout_domain_negative_expire%& (default 3h) and
31081 &%callout_domain_positive_expire%& (default 7d).
31082
31083 Domain records expire when the negative expiry time is reached if callouts
31084 cannot be made for the domain, or if the postmaster check failed.
31085 Otherwise, they expire when the positive expiry time is reached. This
31086 ensures that, for example, a host that stops accepting &"random"& local parts
31087 will eventually be noticed.
31088
31089 The callout caching mechanism is based on the domain of the address that is
31090 being tested. If the domain routes to several hosts, it is assumed that their
31091 behaviour will be the same.
31092
31093
31094
31095 .section "Sender address verification reporting" "SECTsenaddver"
31096 .cindex "verifying" "suppressing error details"
31097 See section &<<SECTaddressverification>>& for a general discussion of
31098 verification. When sender verification fails in an ACL, the details of the
31099 failure are given as additional output lines before the 550 response to the
31100 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
31101 you might see:
31102 .code
31103 MAIL FROM:<xyz@abc.example>
31104 250 OK
31105 RCPT TO:<pqr@def.example>
31106 550-Verification failed for <xyz@abc.example>
31107 550-Called:   192.168.34.43
31108 550-Sent:     RCPT TO:<xyz@abc.example>
31109 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
31110 550 Sender verification failed
31111 .endd
31112 If more than one RCPT command fails in the same way, the details are given
31113 only for the first of them. However, some administrators do not want to send
31114 out this much information. You can suppress the details by adding
31115 &`/no_details`& to the ACL statement that requests sender verification. For
31116 example:
31117 .code
31118 verify = sender/no_details
31119 .endd
31120
31121 .section "Redirection while verifying" "SECTredirwhilveri"
31122 .cindex "verifying" "redirection while"
31123 .cindex "address redirection" "while verifying"
31124 A dilemma arises when a local address is redirected by aliasing or forwarding
31125 during verification: should the generated addresses themselves be verified,
31126 or should the successful expansion of the original address be enough to verify
31127 it? By default, Exim takes the following pragmatic approach:
31128
31129 .ilist
31130 When an incoming address is redirected to just one child address, verification
31131 continues with the child address, and if that fails to verify, the original
31132 verification also fails.
31133 .next
31134 When an incoming address is redirected to more than one child address,
31135 verification does not continue. A success result is returned.
31136 .endlist
31137
31138 This seems the most reasonable behaviour for the common use of aliasing as a
31139 way of redirecting different local parts to the same mailbox. It means, for
31140 example, that a pair of alias entries of the form
31141 .code
31142 A.Wol:   aw123
31143 aw123:   :fail: Gone away, no forwarding address
31144 .endd
31145 work as expected, with both local parts causing verification failure. When a
31146 redirection generates more than one address, the behaviour is more like a
31147 mailing list, where the existence of the alias itself is sufficient for
31148 verification to succeed.
31149
31150 It is possible, however, to change the default behaviour so that all successful
31151 redirections count as successful verifications, however many new addresses are
31152 generated. This is specified by the &%success_on_redirect%& verification
31153 option. For example:
31154 .code
31155 require verify = recipient/success_on_redirect/callout=10s
31156 .endd
31157 In this example, verification succeeds if a router generates a new address, and
31158 the callout does not occur, because no address was routed to a remote host.
31159
31160 When verification is being tested via the &%-bv%& option, the treatment of
31161 redirections is as just described, unless the &%-v%& or any debugging option is
31162 also specified. In that case, full verification is done for every generated
31163 address and a report is output for each of them.
31164
31165
31166
31167 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
31168 .cindex "CSA" "verifying"
31169 Client SMTP Authorization is a system that allows a site to advertise
31170 which machines are and are not permitted to send email. This is done by placing
31171 special SRV records in the DNS; these are looked up using the client's HELO
31172 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
31173 Authorization checks in Exim are performed by the ACL condition:
31174 .code
31175 verify = csa
31176 .endd
31177 This fails if the client is not authorized. If there is a DNS problem, or if no
31178 valid CSA SRV record is found, or if the client is authorized, the condition
31179 succeeds. These three cases can be distinguished using the expansion variable
31180 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
31181 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
31182 be likely to cause problems for legitimate email.
31183
31184 The error messages produced by the CSA code include slightly more
31185 detail. If &$csa_status$& is &"defer"&, this may be because of problems
31186 looking up the CSA SRV record, or problems looking up the CSA target
31187 address record. There are four reasons for &$csa_status$& being &"fail"&:
31188
31189 .ilist
31190 The client's host name is explicitly not authorized.
31191 .next
31192 The client's IP address does not match any of the CSA target IP addresses.
31193 .next
31194 The client's host name is authorized but it has no valid target IP addresses
31195 (for example, the target's addresses are IPv6 and the client is using IPv4).
31196 .next
31197 The client's host name has no CSA SRV record but a parent domain has asserted
31198 that all subdomains must be explicitly authorized.
31199 .endlist
31200
31201 The &%csa%& verification condition can take an argument which is the domain to
31202 use for the DNS query. The default is:
31203 .code
31204 verify = csa/$sender_helo_name
31205 .endd
31206 This implementation includes an extension to CSA. If the query domain
31207 is an address literal such as [192.0.2.95], or if it is a bare IP
31208 address, Exim searches for CSA SRV records in the reverse DNS as if
31209 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
31210 meaningful to say:
31211 .code
31212 verify = csa/$sender_host_address
31213 .endd
31214 In fact, this is the check that Exim performs if the client does not say HELO.
31215 This extension can be turned off by setting the main configuration option
31216 &%dns_csa_use_reverse%& to be false.
31217
31218 If a CSA SRV record is not found for the domain itself, a search
31219 is performed through its parent domains for a record which might be
31220 making assertions about subdomains. The maximum depth of this search is limited
31221 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
31222 default. Exim does not look for CSA SRV records in a top level domain, so the
31223 default settings handle HELO domains as long as seven
31224 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
31225 of legitimate HELO domains.
31226
31227 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
31228 direct SRV lookups, this is not sufficient because of the extra parent domain
31229 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
31230 addresses into lookups in the reverse DNS space. The result of a successful
31231 lookup such as:
31232 .code
31233 ${lookup dnsdb {csa=$sender_helo_name}}
31234 .endd
31235 has two space-separated fields: an authorization code and a target host name.
31236 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
31237 authorization required but absent, or &"?"& for unknown.
31238
31239
31240
31241
31242 .section "Bounce address tag validation" "SECTverifyPRVS"
31243 .cindex "BATV, verifying"
31244 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
31245 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
31246 Genuine incoming bounce messages should therefore always be addressed to
31247 recipients that have a valid tag. This scheme is a way of detecting unwanted
31248 bounce messages caused by sender address forgeries (often called &"collateral
31249 spam"&), because the recipients of such messages do not include valid tags.
31250
31251 There are two expansion items to help with the implementation of the BATV
31252 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
31253 the original envelope sender address by using a simple key to add a hash of the
31254 address and some time-based randomizing information. The &%prvs%& expansion
31255 item creates a signed address, and the &%prvscheck%& expansion item checks one.
31256 The syntax of these expansion items is described in section
31257 &<<SECTexpansionitems>>&.
31258
31259 As an example, suppose the secret per-address keys are stored in an MySQL
31260 database. A query to look up the key for an address could be defined as a macro
31261 like this:
31262 .code
31263 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
31264                 WHERE sender='${quote_mysql:$prvscheck_address}'\
31265                 }{$value}}
31266 .endd
31267 Suppose also that the senders who make use of BATV are defined by an address
31268 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
31269 use this:
31270 .code
31271 # Bounces: drop unsigned addresses for BATV senders
31272 deny message = This address does not send an unsigned reverse path
31273      senders = :
31274      recipients = +batv_senders
31275
31276 # Bounces: In case of prvs-signed address, check signature.
31277 deny message = Invalid reverse path signature.
31278      senders = :
31279      condition  = ${prvscheck {$local_part@$domain}\
31280                   {PRVSCHECK_SQL}{1}}
31281      !condition = $prvscheck_result
31282 .endd
31283 The first statement rejects recipients for bounce messages that are addressed
31284 to plain BATV sender addresses, because it is known that BATV senders do not
31285 send out messages with plain sender addresses. The second statement rejects
31286 recipients that are prvs-signed, but with invalid signatures (either because
31287 the key is wrong, or the signature has timed out).
31288
31289 A non-prvs-signed address is not rejected by the second statement, because the
31290 &%prvscheck%& expansion yields an empty string if its first argument is not a
31291 prvs-signed address, thus causing the &%condition%& condition to be false. If
31292 the first argument is a syntactically valid prvs-signed address, the yield is
31293 the third string (in this case &"1"&), whether or not the cryptographic and
31294 timeout checks succeed. The &$prvscheck_result$& variable contains the result
31295 of the checks (empty for failure, &"1"& for success).
31296
31297 There is one more issue you must consider when implementing prvs-signing:
31298 you have to ensure that the routers accept prvs-signed addresses and
31299 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
31300 router to remove the signature with a configuration along these lines:
31301 .code
31302 batv_redirect:
31303   driver = redirect
31304   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
31305 .endd
31306 This works because, if the third argument of &%prvscheck%& is empty, the result
31307 of the expansion of a prvs-signed address is the decoded value of the original
31308 address. This router should probably be the first of your routers that handles
31309 local addresses.
31310
31311 To create BATV-signed addresses in the first place, a transport of this form
31312 can be used:
31313 .code
31314 external_smtp_batv:
31315   driver = smtp
31316   return_path = ${prvs {$return_path} \
31317                        {${lookup mysql{SELECT \
31318                        secret FROM batv_prvs WHERE \
31319                        sender='${quote_mysql:$sender_address}'} \
31320                        {$value}fail}}}
31321 .endd
31322 If no key can be found for the existing return path, no signing takes place.
31323
31324
31325
31326 .section "Using an ACL to control relaying" "SECTrelaycontrol"
31327 .cindex "&ACL;" "relay control"
31328 .cindex "relaying" "control by ACL"
31329 .cindex "policy control" "relay control"
31330 An MTA is said to &'relay'& a message if it receives it from some host and
31331 delivers it directly to another host as a result of a remote address contained
31332 within it. Redirecting a local address via an alias or forward file and then
31333 passing the message on to another host is not relaying,
31334 .cindex "&""percent hack""&"
31335 but a redirection as a result of the &"percent hack"& is.
31336
31337 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
31338 A host which is acting as a gateway or an MX backup is concerned with incoming
31339 relaying from arbitrary hosts to a specific set of domains. On the other hand,
31340 a host which is acting as a smart host for a number of clients is concerned
31341 with outgoing relaying from those clients to the Internet at large. Often the
31342 same host is fulfilling both functions,
31343 . ///
31344 . as illustrated in the diagram below,
31345 . ///
31346 but in principle these two kinds of relaying are entirely independent. What is
31347 not wanted is the transmission of mail from arbitrary remote hosts through your
31348 system to arbitrary domains.
31349
31350
31351 You can implement relay control by means of suitable statements in the ACL that
31352 runs for each RCPT command. For convenience, it is often easiest to use
31353 Exim's named list facility to define the domains and hosts involved. For
31354 example, suppose you want to do the following:
31355
31356 .ilist
31357 Deliver a number of domains to mailboxes on the local host (or process them
31358 locally in some other way). Let's say these are &'my.dom1.example'& and
31359 &'my.dom2.example'&.
31360 .next
31361 Relay mail for a number of other domains for which you are the secondary MX.
31362 These might be &'friend1.example'& and &'friend2.example'&.
31363 .next
31364 Relay mail from the hosts on your local LAN, to whatever domains are involved.
31365 Suppose your LAN is 192.168.45.0/24.
31366 .endlist
31367
31368
31369 In the main part of the configuration, you put the following definitions:
31370 .code
31371 domainlist local_domains    = my.dom1.example : my.dom2.example
31372 domainlist relay_to_domains = friend1.example : friend2.example
31373 hostlist   relay_from_hosts = 192.168.45.0/24
31374 .endd
31375 Now you can use these definitions in the ACL that is run for every RCPT
31376 command:
31377 .code
31378 acl_check_rcpt:
31379   accept domains = +local_domains : +relay_to_domains
31380   accept hosts   = +relay_from_hosts
31381 .endd
31382 The first statement accepts any RCPT command that contains an address in
31383 the local or relay domains. For any other domain, control passes to the second
31384 statement, which accepts the command only if it comes from one of the relay
31385 hosts. In practice, you will probably want to make your ACL more sophisticated
31386 than this, for example, by including sender and recipient verification. The
31387 default configuration includes a more comprehensive example, which is described
31388 in chapter &<<CHAPdefconfil>>&.
31389
31390
31391
31392 .section "Checking a relay configuration" "SECTcheralcon"
31393 .cindex "relaying" "checking control of"
31394 You can check the relay characteristics of your configuration in the same way
31395 that you can test any ACL behaviour for an incoming SMTP connection, by using
31396 the &%-bh%& option to run a fake SMTP session with which you interact.
31397 .ecindex IIDacl
31398
31399
31400
31401 . ////////////////////////////////////////////////////////////////////////////
31402 . ////////////////////////////////////////////////////////////////////////////
31403
31404 .chapter "Content scanning at ACL time" "CHAPexiscan"
31405 .scindex IIDcosca "content scanning" "at ACL time"
31406 The extension of Exim to include content scanning at ACL time, formerly known
31407 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
31408 was integrated into the main source for Exim release 4.50, and Tom continues to
31409 maintain it. Most of the wording of this chapter is taken from Tom's
31410 specification.
31411
31412 It is also possible to scan the content of messages at other times. The
31413 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
31414 scanning after all the ACLs have run. A transport filter can be used to scan
31415 messages at delivery time (see the &%transport_filter%& option, described in
31416 chapter &<<CHAPtransportgeneric>>&).
31417
31418 If you want to include the ACL-time content-scanning features when you compile
31419 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
31420 &_Local/Makefile_&. When you do that, the Exim binary is built with:
31421
31422 .ilist
31423 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
31424 for all MIME parts for SMTP and non-SMTP messages, respectively.
31425 .next
31426 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
31427 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
31428 run at the end of message reception (the &%acl_smtp_data%& ACL).
31429 .next
31430 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
31431 of messages, or parts of messages, for debugging purposes.
31432 .next
31433 Additional expansion variables that are set in the new ACL and by the new
31434 conditions.
31435 .next
31436 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
31437 .endlist
31438
31439 Content-scanning is continually evolving, and new features are still being
31440 added. While such features are still unstable and liable to incompatible
31441 changes, they are made available in Exim by setting options whose names begin
31442 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
31443 this manual. You can find out about them by reading the file called
31444 &_doc/experimental.txt_&.
31445
31446 All the content-scanning facilities work on a MBOX copy of the message that is
31447 temporarily created in a file called:
31448 .display
31449 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
31450 .endd
31451 The &_.eml_& extension is a friendly hint to virus scanners that they can
31452 expect an MBOX-like structure inside that file. The file is created when the
31453 first content scanning facility is called. Subsequent calls to content
31454 scanning conditions open the same file again. The directory is recursively
31455 removed when the &%acl_smtp_data%& ACL has finished running, unless
31456 .code
31457 control = no_mbox_unspool
31458 .endd
31459 has been encountered. When the MIME ACL decodes files, they are put into the
31460 same directory by default.
31461
31462
31463
31464 .section "Scanning for viruses" "SECTscanvirus"
31465 .cindex "virus scanning"
31466 .cindex "content scanning" "for viruses"
31467 .cindex "content scanning" "the &%malware%& condition"
31468 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
31469 It supports a &"generic"& interface to scanners called via the shell, and
31470 specialized interfaces for &"daemon"& type virus scanners, which are resident
31471 in memory and thus are much faster.
31472
31473 A timeout of 2 minutes is applied to a scanner call (by default);
31474 if it expires then a defer action is taken.
31475
31476 .oindex "&%av_scanner%&"
31477 You can set the &%av_scanner%& option in the main part of the configuration
31478 to specify which scanner to use, together with any additional options that
31479 are needed. The basic syntax is as follows:
31480 .display
31481 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
31482 .endd
31483 If you do not set &%av_scanner%&, it defaults to
31484 .code
31485 av_scanner = sophie:/var/run/sophie
31486 .endd
31487 If the value of &%av_scanner%& starts with a dollar character, it is expanded
31488 before use.
31489 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
31490 The following scanner types are supported in this release:
31491
31492 .vlist
31493 .vitem &%avast%&
31494 .cindex "virus scanners" "avast"
31495 This is the scanner daemon of Avast. It has been tested with Avast Core
31496 Security (currently at version 1.1.7).
31497 You can get a trial version at &url(http://www.avast.com) or for Linux
31498 at &url(http://www.avast.com/linux-server-antivirus).
31499 This scanner type takes one option,
31500 which can be either a full path to a UNIX socket,
31501 or host and port specifiers separated by white space.
31502 The host may be a name or an IP address; the port is either a
31503 single number or a pair of numbers with a dash between.
31504 Any further options are given, on separate lines,
31505 to the daemon as options before the main scan command.
31506 For example:
31507 .code
31508 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
31509 av_scanner = avast:192.168.2.22 5036
31510 .endd
31511 If you omit the argument, the default path
31512 &_/var/run/avast/scan.sock_&
31513 is used.
31514 If you use a remote host,
31515 you need to make Exim's spool directory available to it,
31516 as the scanner is passed a file path, not file contents.
31517 For information about available commands and their options you may use
31518 .code
31519 $ socat UNIX:/var/run/avast/scan.sock STDIO:
31520     FLAGS
31521     SENSITIVITY
31522     PACK
31523 .endd
31524
31525
31526 .vitem &%aveserver%&
31527 .cindex "virus scanners" "Kaspersky"
31528 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
31529 at &url(http://www.kaspersky.com). This scanner type takes one option,
31530 which is the path to the daemon's UNIX socket. The default is shown in this
31531 example:
31532 .code
31533 av_scanner = aveserver:/var/run/aveserver
31534 .endd
31535
31536
31537 .vitem &%clamd%&
31538 .cindex "virus scanners" "clamd"
31539 This daemon-type scanner is GPL and free. You can get it at
31540 &url(http://www.clamav.net/). Some older versions of clamd do not seem to
31541 unpack MIME containers, so it used to be recommended to unpack MIME attachments
31542 in the MIME ACL. This is no longer believed to be necessary.
31543
31544 The options are a list of server specifiers, which may be
31545 a UNIX socket specification,
31546 a TCP socket specification,
31547 or a (global) option.
31548
31549 A socket specification consists of a space-separated list.
31550 For a Unix socket the first element is a full path for the socket,
31551 for a TCP socket the first element is the IP address
31552 and the second a port number,
31553 Any further elements are per-server (non-global) options.
31554 These per-server options are supported:
31555 .code
31556 retry=<timespec>        Retry on connect fail
31557 .endd
31558
31559 The &`retry`& option specifies a time after which a single retry for
31560 a failed connect is made.  The default is to not retry.
31561
31562 If a Unix socket file is specified, only one server is supported.
31563
31564 Examples:
31565 .code
31566 av_scanner = clamd:/opt/clamd/socket
31567 av_scanner = clamd:192.0.2.3 1234
31568 av_scanner = clamd:192.0.2.3 1234:local
31569 av_scanner = clamd:192.0.2.3 1234 retry=10s
31570 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
31571 .endd
31572 If the value of av_scanner points to a UNIX socket file or contains the
31573 &`local`&
31574 option, then the ClamAV interface will pass a filename containing the data
31575 to be scanned, which will should normally result in less I/O happening and be
31576 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
31577 Exim does not assume that there is a common filesystem with the remote host.
31578 There is an option WITH_OLD_CLAMAV_STREAM in &_src/EDITME_& available, should
31579 you be running a version of ClamAV prior to 0.95.
31580
31581 The final example shows that multiple TCP targets can be specified.  Exim will
31582 randomly use one for each incoming email (i.e. it load balances them).  Note
31583 that only TCP targets may be used if specifying a list of scanners; a UNIX
31584 socket cannot be mixed in with TCP targets.  If one of the servers becomes
31585 unavailable, Exim will try the remaining one(s) until it finds one that works.
31586 When a clamd server becomes unreachable, Exim will log a message.  Exim does
31587 not keep track of scanner state between multiple messages, and the scanner
31588 selection is random, so the message will get logged in the mainlog for each
31589 email that the down scanner gets chosen first (message wrapped to be readable):
31590 .code
31591 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
31592    clamd: connection to localhost, port 3310 failed
31593    (Connection refused)
31594 .endd
31595
31596 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
31597 contributing the code for this scanner.
31598
31599 .vitem &%cmdline%&
31600 .cindex "virus scanners" "command line interface"
31601 This is the keyword for the generic command line scanner interface. It can be
31602 used to attach virus scanners that are invoked from the shell. This scanner
31603 type takes 3 mandatory options:
31604
31605 .olist
31606 The full path and name of the scanner binary, with all command line options,
31607 and a placeholder (&`%s`&) for the directory to scan.
31608
31609 .next
31610 A regular expression to match against the STDOUT and STDERR output of the
31611 virus scanner. If the expression matches, a virus was found. You must make
31612 absolutely sure that this expression matches on &"virus found"&. This is called
31613 the &"trigger"& expression.
31614
31615 .next
31616 Another regular expression, containing exactly one pair of parentheses, to
31617 match the name of the virus found in the scanners output. This is called the
31618 &"name"& expression.
31619 .endlist olist
31620
31621 For example, Sophos Sweep reports a virus on a line like this:
31622 .code
31623 Virus 'W32/Magistr-B' found in file ./those.bat
31624 .endd
31625 For the trigger expression, we can match the phrase &"found in file"&. For the
31626 name expression, we want to extract the W32/Magistr-B string, so we can match
31627 for the single quotes left and right of it. Altogether, this makes the
31628 configuration setting:
31629 .code
31630 av_scanner = cmdline:\
31631              /path/to/sweep -ss -all -rec -archive %s:\
31632              found in file:'(.+)'
31633 .endd
31634 .vitem &%drweb%&
31635 .cindex "virus scanners" "DrWeb"
31636 The DrWeb daemon scanner (&url(http://www.sald.com/)) interface
31637 takes one option,
31638 either a full path to a UNIX socket,
31639 or host and port specifiers separated by white space.
31640 The host may be a name or an IP address; the port is either a
31641 single number or a pair of numbers with a dash between.
31642 For example:
31643 .code
31644 av_scanner = drweb:/var/run/drwebd.sock
31645 av_scanner = drweb:192.168.2.20 31337
31646 .endd
31647 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
31648 is used. Thanks to Alex Miller for contributing the code for this scanner.
31649
31650 .vitem &%f-protd%&
31651 .cindex "virus scanners" "f-protd"
31652 The f-protd scanner is accessed via HTTP over TCP.
31653 One argument is taken, being a space-separated hostname and port number
31654 (or port-range).
31655 For example:
31656 .code
31657 av_scanner = f-protd:localhost 10200-10204
31658 .endd
31659 If you omit the argument, the default values show above are used.
31660
31661 .new
31662 .vitem &%f-prot6d%&
31663 .cindex "virus scanners" "f-prot6d"
31664 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
31665 One argument is taken, being a space-separated hostname and port number.
31666 For example:
31667 .code
31668 av_scanner = f-prot6d:localhost 10200
31669 .endd
31670 If you omit the argument, the default values show above are used.
31671 .wen
31672
31673 .vitem &%fsecure%&
31674 .cindex "virus scanners" "F-Secure"
31675 The F-Secure daemon scanner (&url(http://www.f-secure.com)) takes one
31676 argument which is the path to a UNIX socket. For example:
31677 .code
31678 av_scanner = fsecure:/path/to/.fsav
31679 .endd
31680 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
31681 Thelmen for contributing the code for this scanner.
31682
31683 .vitem &%kavdaemon%&
31684 .cindex "virus scanners" "Kaspersky"
31685 This is the scanner daemon of Kaspersky Version 4. This version of the
31686 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
31687 scanner type takes one option, which is the path to the daemon's UNIX socket.
31688 For example:
31689 .code
31690 av_scanner = kavdaemon:/opt/AVP/AvpCtl
31691 .endd
31692 The default path is &_/var/run/AvpCtl_&.
31693
31694 .vitem &%mksd%&
31695 .cindex "virus scanners" "mksd"
31696 This is a daemon type scanner that is aimed mainly at Polish users, though some
31697 parts of documentation are now available in English. You can get it at
31698 &url(http://linux.mks.com.pl/). The only option for this scanner type is
31699 the maximum number of processes used simultaneously to scan the attachments,
31700 provided that mksd has
31701 been run with at least the same number of child processes. For example:
31702 .code
31703 av_scanner = mksd:2
31704 .endd
31705 You can safely omit this option (the default value is 1).
31706
31707 .vitem &%sock%&
31708 .cindex "virus scanners" "simple socket-connected"
31709 This is a general-purpose way of talking to simple scanner daemons
31710 running on the local machine.
31711 There are four options:
31712 an address (which may be an IP address and port, or the path of a Unix socket),
31713 a commandline to send (may include a single %s which will be replaced with
31714 the path to the mail file to be scanned),
31715 an RE to trigger on from the returned data,
31716 and an RE to extract malware_name from the returned data.
31717 For example:
31718 .code
31719 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
31720 .endd
31721 .new
31722 Note that surrounding whitespace is stripped from each option, meaning
31723 there is no way to specify a trailing newline.
31724 The socket specifier and both regular-expressions are required.
31725 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
31726 specify an empty element to get this.
31727 .wen
31728
31729 .vitem &%sophie%&
31730 .cindex "virus scanners" "Sophos and Sophie"
31731 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
31732 You can get Sophie at &url(http://www.clanfield.info/sophie/). The only option
31733 for this scanner type is the path to the UNIX socket that Sophie uses for
31734 client communication. For example:
31735 .code
31736 av_scanner = sophie:/tmp/sophie
31737 .endd
31738 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
31739 the option.
31740 .endlist
31741
31742 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
31743 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
31744 ACL.
31745
31746 The &%av_scanner%& option is expanded each time &%malware%& is called. This
31747 makes it possible to use different scanners. See further below for an example.
31748 The &%malware%& condition caches its results, so when you use it multiple times
31749 for the same message, the actual scanning process is only carried out once.
31750 However, using expandable items in &%av_scanner%& disables this caching, in
31751 which case each use of the &%malware%& condition causes a new scan of the
31752 message.
31753
31754 The &%malware%& condition takes a right-hand argument that is expanded before
31755 use and taken as a list, slash-separated by default.
31756 The first element can then be one of
31757
31758 .ilist
31759 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
31760 The condition succeeds if a virus was found, and fail otherwise. This is the
31761 recommended usage.
31762 .next
31763 &"false"& or &"0"& or an empty string, in which case no scanning is done and
31764 the condition fails immediately.
31765 .next
31766 A regular expression, in which case the message is scanned for viruses. The
31767 condition succeeds if a virus is found and its name matches the regular
31768 expression. This allows you to take special actions on certain types of virus.
31769 Note that &"/"& characters in the RE must be doubled due to the list-processing,
31770 unless the separator is changed (in the usual way).
31771 .endlist
31772
31773 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
31774 messages even if there is a problem with the virus scanner.
31775 Otherwise, such a problem causes the ACL to defer.
31776
31777 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
31778 specify a non-default timeout.  The default is two minutes.
31779 For example:
31780 .code
31781 malware = * / defer_ok / tmo=10s
31782 .endd
31783 A timeout causes the ACL to defer.
31784
31785 .vindex "&$callout_address$&"
31786 When a connection is made to the scanner the expansion variable &$callout_address$&
31787 is set to record the actual address used.
31788
31789 .vindex "&$malware_name$&"
31790 When a virus is found, the condition sets up an expansion variable called
31791 &$malware_name$& that contains the name of the virus. You can use it in a
31792 &%message%& modifier that specifies the error returned to the sender, and/or in
31793 logging data.
31794
31795 Beware the interaction of Exim's &%message_size_limit%& with any size limits
31796 imposed by your anti-virus scanner.
31797
31798 Here is a very simple scanning example:
31799 .code
31800 deny message = This message contains malware ($malware_name)
31801      malware = *
31802 .endd
31803 The next example accepts messages when there is a problem with the scanner:
31804 .code
31805 deny message = This message contains malware ($malware_name)
31806      malware = */defer_ok
31807 .endd
31808 The next example shows how to use an ACL variable to scan with both sophie and
31809 aveserver. It assumes you have set:
31810 .code
31811 av_scanner = $acl_m0
31812 .endd
31813 in the main Exim configuration.
31814 .code
31815 deny message = This message contains malware ($malware_name)
31816      set acl_m0 = sophie
31817      malware = *
31818
31819 deny message = This message contains malware ($malware_name)
31820      set acl_m0 = aveserver
31821      malware = *
31822 .endd
31823
31824
31825 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
31826 .cindex "content scanning" "for spam"
31827 .cindex "spam scanning"
31828 .cindex "SpamAssassin"
31829 .cindex "Rspamd"
31830 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
31831 score and a report for the message.
31832 Support is also provided for Rspamd.
31833
31834 For more information about installation and configuration of SpamAssassin or
31835 Rspamd refer to their respective websites at
31836 &url(http://spamassassin.apache.org) and &url(http://www.rspamd.com)
31837
31838 SpamAssassin can be installed with CPAN by running:
31839 .code
31840 perl -MCPAN -e 'install Mail::SpamAssassin'
31841 .endd
31842 SpamAssassin has its own set of configuration files. Please review its
31843 documentation to see how you can tweak it. The default installation should work
31844 nicely, however.
31845
31846 .oindex "&%spamd_address%&"
31847 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
31848 intend to use an instance running on the local host you do not need to set
31849 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
31850 you must set the &%spamd_address%& option in the global part of the Exim
31851 configuration as follows (example):
31852 .code
31853 spamd_address = 192.168.99.45 387
31854 .endd
31855 The SpamAssassin protocol relies on a TCP half-close from the client.
31856 If your SpamAssassin client side is running a Linux system with an
31857 iptables firewall, consider setting
31858 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
31859 timeout, Exim uses when waiting for a response from the SpamAssassin
31860 server (currently defaulting to 120s).  With a lower value the Linux
31861 connection tracking may consider your half-closed connection as dead too
31862 soon.
31863
31864
31865 To use Rspamd (which by default listens on all local addresses
31866 on TCP port 11333)
31867 you should add &%variant=rspamd%& after the address/port pair, for example:
31868 .code
31869 spamd_address = 127.0.0.1 11333 variant=rspamd
31870 .endd
31871
31872 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
31873 sockets. If you want to us these, supply &%spamd_address%& with an absolute
31874 file name instead of an address/port pair:
31875 .code
31876 spamd_address = /var/run/spamd_socket
31877 .endd
31878 You can have multiple &%spamd%& servers to improve scalability. These can
31879 reside on other hardware reachable over the network. To specify multiple
31880 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
31881 option, separated with colons (the separator can be changed in the usual way):
31882 .code
31883 spamd_address = 192.168.2.10 783 : \
31884                 192.168.2.11 783 : \
31885                 192.168.2.12 783
31886 .endd
31887 Up to 32 &%spamd%& servers are supported.
31888 When a server fails to respond to the connection attempt, all other
31889 servers are tried until one succeeds. If no server responds, the &%spam%&
31890 condition defers.
31891
31892 Unix and TCP socket specifications may be mixed in any order.
31893 Each element of the list is a list itself, space-separated by default
31894 and changeable in the usual way; take care to not double the separator.
31895
31896 For TCP socket specifications a host name or IP (v4 or v6, but
31897 subject to list-separator quoting rules) address can be used,
31898 and the port can be one or a dash-separated pair.
31899 In the latter case, the range is tried in strict order.
31900
31901 Elements after the first for Unix sockets, or second for TCP socket,
31902 are options.
31903 The supported options are:
31904 .code
31905 pri=<priority>      Selection priority
31906 weight=<value>      Selection bias
31907 time=<start>-<end>  Use only between these times of day
31908 retry=<timespec>    Retry on connect fail
31909 tmo=<timespec>      Connection time limit
31910 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
31911 .endd
31912
31913 The &`pri`& option specifies a priority for the server within the list,
31914 higher values being tried first.
31915 The default priority is 1.
31916
31917 The &`weight`& option specifies a selection bias.
31918 Within a priority set
31919 servers are queried in a random fashion, weighted by this value.
31920 The default value for selection bias is 1.
31921
31922 Time specifications for the &`time`& option are <hour>.<minute>.<second>
31923 in the local time zone; each element being one or more digits.
31924 Either the seconds or both minutes and seconds, plus the leading &`.`&
31925 characters, may be omitted and will be taken as zero.
31926
31927 Timeout specifications for the &`retry`& and &`tmo`& options
31928 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
31929
31930 The &`tmo`& option specifies an overall timeout for communication.
31931 The default value is two minutes.
31932
31933 The &`retry`& option specifies a time after which a single retry for
31934 a failed connect is made.
31935 The default is to not retry.
31936
31937 The &%spamd_address%& variable is expanded before use if it starts with
31938 a dollar sign. In this case, the expansion may return a string that is
31939 used as the list so that multiple spamd servers can be the result of an
31940 expansion.
31941
31942 .vindex "&$callout_address$&"
31943 When a connection is made to the server the expansion variable &$callout_address$&
31944 is set to record the actual address used.
31945
31946 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
31947 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
31948 .code
31949 deny message = This message was classified as SPAM
31950      spam = joe
31951 .endd
31952 The right-hand side of the &%spam%& condition specifies a name. This is
31953 relevant if you have set up multiple SpamAssassin profiles. If you do not want
31954 to scan using a specific profile, but rather use the SpamAssassin system-wide
31955 default profile, you can scan for an unknown name, or simply use &"nobody"&.
31956 Rspamd does not use this setting. However, you must put something on the
31957 right-hand side.
31958
31959 The name allows you to use per-domain or per-user antispam profiles in
31960 principle, but this is not straightforward in practice, because a message may
31961 have multiple recipients, not necessarily all in the same domain. Because the
31962 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
31963 read the contents of the message, the variables &$local_part$& and &$domain$&
31964 are not set.
31965 Careful enforcement of single-recipient messages
31966 (e.g. by responding with defer in the recipient ACL for all recipients
31967 after the first),
31968 or the use of PRDR,
31969 .cindex "PRDR" "use for per-user SpamAssassin profiles"
31970 are needed to use this feature.
31971
31972 The right-hand side of the &%spam%& condition is expanded before being used, so
31973 you can put lookups or conditions there. When the right-hand side evaluates to
31974 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
31975
31976
31977 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
31978 large ones may cause significant performance degradation. As most spam messages
31979 are quite small, it is recommended that you do not scan the big ones. For
31980 example:
31981 .code
31982 deny message = This message was classified as SPAM
31983      condition = ${if < {$message_size}{10K}}
31984      spam = nobody
31985 .endd
31986
31987 The &%spam%& condition returns true if the threshold specified in the user's
31988 SpamAssassin profile has been matched or exceeded. If you want to use the
31989 &%spam%& condition for its side effects (see the variables below), you can make
31990 it always return &"true"& by appending &`:true`& to the username.
31991
31992 .cindex "spam scanning" "returned variables"
31993 When the &%spam%& condition is run, it sets up a number of expansion
31994 variables.
31995 Except for &$spam_report$&,
31996 these variables are saved with the received message so are
31997 available for use at delivery time.
31998
31999 .vlist
32000 .vitem &$spam_score$&
32001 The spam score of the message, for example &"3.4"& or &"30.5"&. This is useful
32002 for inclusion in log or reject messages.
32003
32004 .vitem &$spam_score_int$&
32005 The spam score of the message, multiplied by ten, as an integer value. For
32006 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
32007 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
32008 The integer value is useful for numeric comparisons in conditions.
32009
32010 .vitem &$spam_bar$&
32011 A string consisting of a number of &"+"& or &"-"& characters, representing the
32012 integer part of the spam score value. A spam score of 4.4 would have a
32013 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
32014 headers, since MUAs can match on such strings. The maximum length of the
32015 spam bar is 50 characters.
32016
32017 .vitem &$spam_report$&
32018 A multiline text table, containing the full SpamAssassin report for the
32019 message. Useful for inclusion in headers or reject messages.
32020 This variable is only usable in a DATA-time ACL.
32021 Beware that SpamAssassin may return non-ASCII characters, especially
32022 when running in country-specific locales, which are not legal
32023 unencoded in headers.
32024
32025 .vitem &$spam_action$&
32026 For SpamAssassin either 'reject' or 'no action' depending on the
32027 spam score versus threshold.
32028 For Rspamd, the recommended action.
32029
32030 .endlist
32031
32032 The &%spam%& condition caches its results unless expansion in
32033 spamd_address was used. If you call it again with the same user name, it
32034 does not scan again, but rather returns the same values as before.
32035
32036 The &%spam%& condition returns DEFER if there is any error while running
32037 the message through SpamAssassin or if the expansion of spamd_address
32038 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
32039 statement block), append &`/defer_ok`& to the right-hand side of the
32040 spam condition, like this:
32041 .code
32042 deny message = This message was classified as SPAM
32043      spam    = joe/defer_ok
32044 .endd
32045 This causes messages to be accepted even if there is a problem with &%spamd%&.
32046
32047 Here is a longer, commented example of the use of the &%spam%&
32048 condition:
32049 .code
32050 # put headers in all messages (no matter if spam or not)
32051 warn  spam = nobody:true
32052       add_header = X-Spam-Score: $spam_score ($spam_bar)
32053       add_header = X-Spam-Report: $spam_report
32054
32055 # add second subject line with *SPAM* marker when message
32056 # is over threshold
32057 warn  spam = nobody
32058       add_header = Subject: *SPAM* $h_Subject:
32059
32060 # reject spam at high scores (> 12)
32061 deny  message = This message scored $spam_score spam points.
32062       spam = nobody:true
32063       condition = ${if >{$spam_score_int}{120}{1}{0}}
32064 .endd
32065
32066
32067
32068 .section "Scanning MIME parts" "SECTscanmimepart"
32069 .cindex "content scanning" "MIME parts"
32070 .cindex "MIME content scanning"
32071 .oindex "&%acl_smtp_mime%&"
32072 .oindex "&%acl_not_smtp_mime%&"
32073 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
32074 each MIME part of an SMTP message, including multipart types, in the sequence
32075 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
32076 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
32077 options may both refer to the same ACL if you want the same processing in both
32078 cases.
32079
32080 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
32081 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
32082 the case of a non-SMTP message. However, a MIME ACL is called only if the
32083 message contains a &'Content-Type:'& header line. When a call to a MIME
32084 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
32085 result code is sent to the client. In the case of an SMTP message, the
32086 &%acl_smtp_data%& ACL is not called when this happens.
32087
32088 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
32089 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
32090 condition to match against the raw MIME part. You can also use the
32091 &%mime_regex%& condition to match against the decoded MIME part (see section
32092 &<<SECTscanregex>>&).
32093
32094 At the start of a MIME ACL, a number of variables are set from the header
32095 information for the relevant MIME part. These are described below. The contents
32096 of the MIME part are not by default decoded into a disk file except for MIME
32097 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
32098 part into a disk file, you can use the &%decode%& condition. The general
32099 syntax is:
32100 .display
32101 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
32102 .endd
32103 The right hand side is expanded before use. After expansion,
32104 the value can be:
32105
32106 .olist
32107 &"0"& or &"false"&, in which case no decoding is done.
32108 .next
32109 The string &"default"&. In that case, the file is put in the temporary
32110 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
32111 a sequential file name consisting of the message id and a sequence number. The
32112 full path and name is available in &$mime_decoded_filename$& after decoding.
32113 .next
32114 A full path name starting with a slash. If the full name is an existing
32115 directory, it is used as a replacement for the default directory. The filename
32116 is then sequentially assigned. If the path does not exist, it is used as
32117 the full path and file name.
32118 .next
32119 If the string does not start with a slash, it is used as the
32120 filename, and the default path is then used.
32121 .endlist
32122 The &%decode%& condition normally succeeds. It is only false for syntax
32123 errors or unusual circumstances such as memory shortages. You can easily decode
32124 a file with its original, proposed filename using
32125 .code
32126 decode = $mime_filename
32127 .endd
32128 However, you should keep in mind that &$mime_filename$& might contain
32129 anything. If you place files outside of the default path, they are not
32130 automatically unlinked.
32131
32132 For RFC822 attachments (these are messages attached to messages, with a
32133 content-type of &"message/rfc822"&), the ACL is called again in the same manner
32134 as for the primary message, only that the &$mime_is_rfc822$& expansion
32135 variable is set (see below). Attached messages are always decoded to disk
32136 before being checked, and the files are unlinked once the check is done.
32137
32138 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
32139 used to match regular expressions against raw and decoded MIME parts,
32140 respectively. They are described in section &<<SECTscanregex>>&.
32141
32142 .cindex "MIME content scanning" "returned variables"
32143 The following list describes all expansion variables that are
32144 available in the MIME ACL:
32145
32146 .vlist
32147 .vitem &$mime_boundary$&
32148 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
32149 have a boundary string, which is stored in this variable. If the current part
32150 has no boundary parameter in the &'Content-Type:'& header, this variable
32151 contains the empty string.
32152
32153 .vitem &$mime_charset$&
32154 This variable contains the character set identifier, if one was found in the
32155 &'Content-Type:'& header. Examples for charset identifiers are:
32156 .code
32157 us-ascii
32158 gb2312 (Chinese)
32159 iso-8859-1
32160 .endd
32161 Please note that this value is not normalized, so you should do matches
32162 case-insensitively.
32163
32164 .vitem &$mime_content_description$&
32165 This variable contains the normalized content of the &'Content-Description:'&
32166 header. It can contain a human-readable description of the parts content. Some
32167 implementations repeat the filename for attachments here, but they are usually
32168 only used for display purposes.
32169
32170 .vitem &$mime_content_disposition$&
32171 This variable contains the normalized content of the &'Content-Disposition:'&
32172 header. You can expect strings like &"attachment"& or &"inline"& here.
32173
32174 .vitem &$mime_content_id$&
32175 This variable contains the normalized content of the &'Content-ID:'& header.
32176 This is a unique ID that can be used to reference a part from another part.
32177
32178 .vitem &$mime_content_size$&
32179 This variable is set only after the &%decode%& modifier (see above) has been
32180 successfully run. It contains the size of the decoded part in kilobytes. The
32181 size is always rounded up to full kilobytes, so only a completely empty part
32182 has a &$mime_content_size$& of zero.
32183
32184 .vitem &$mime_content_transfer_encoding$&
32185 This variable contains the normalized content of the
32186 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
32187 type. Typical values are &"base64"& and &"quoted-printable"&.
32188
32189 .vitem &$mime_content_type$&
32190 If the MIME part has a &'Content-Type:'& header, this variable contains its
32191 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
32192 are some examples of popular MIME types, as they may appear in this variable:
32193 .code
32194 text/plain
32195 text/html
32196 application/octet-stream
32197 image/jpeg
32198 audio/midi
32199 .endd
32200 If the MIME part has no &'Content-Type:'& header, this variable contains the
32201 empty string.
32202
32203 .vitem &$mime_decoded_filename$&
32204 This variable is set only after the &%decode%& modifier (see above) has been
32205 successfully run. It contains the full path and file name of the file
32206 containing the decoded data.
32207 .endlist
32208
32209 .cindex "RFC 2047"
32210 .vlist
32211 .vitem &$mime_filename$&
32212 This is perhaps the most important of the MIME variables. It contains a
32213 proposed filename for an attachment, if one was found in either the
32214 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
32215 RFC2047
32216 or RFC2231
32217 decoded, but no additional sanity checks are done.
32218  If no filename was
32219 found, this variable contains the empty string.
32220
32221 .vitem &$mime_is_coverletter$&
32222 This variable attempts to differentiate the &"cover letter"& of an e-mail from
32223 attached data. It can be used to clamp down on flashy or unnecessarily encoded
32224 content in the cover letter, while not restricting attachments at all.
32225
32226 The variable contains 1 (true) for a MIME part believed to be part of the
32227 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
32228 follows:
32229
32230 .olist
32231 The outermost MIME part of a message is always a cover letter.
32232
32233 .next
32234 If a multipart/alternative or multipart/related MIME part is a cover letter,
32235 so are all MIME subparts within that multipart.
32236
32237 .next
32238 If any other multipart is a cover letter, the first subpart is a cover letter,
32239 and the rest are attachments.
32240
32241 .next
32242 All parts contained within an attachment multipart are attachments.
32243 .endlist olist
32244
32245 As an example, the following will ban &"HTML mail"& (including that sent with
32246 alternative plain text), while allowing HTML files to be attached. HTML
32247 coverletter mail attached to non-HMTL coverletter mail will also be allowed:
32248 .code
32249 deny message = HTML mail is not accepted here
32250 !condition = $mime_is_rfc822
32251 condition = $mime_is_coverletter
32252 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
32253 .endd
32254 .vitem &$mime_is_multipart$&
32255 This variable has the value 1 (true) when the current part has the main type
32256 &"multipart"&, for example &"multipart/alternative"& or &"multipart/mixed"&.
32257 Since multipart entities only serve as containers for other parts, you may not
32258 want to carry out specific actions on them.
32259
32260 .vitem &$mime_is_rfc822$&
32261 This variable has the value 1 (true) if the current part is not a part of the
32262 checked message itself, but part of an attached message. Attached message
32263 decoding is fully recursive.
32264
32265 .vitem &$mime_part_count$&
32266 This variable is a counter that is raised for each processed MIME part. It
32267 starts at zero for the very first part (which is usually a multipart). The
32268 counter is per-message, so it is reset when processing RFC822 attachments (see
32269 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
32270 complete, so you can use it in the DATA ACL to determine the number of MIME
32271 parts of a message. For non-MIME messages, this variable contains the value -1.
32272 .endlist
32273
32274
32275
32276 .section "Scanning with regular expressions" "SECTscanregex"
32277 .cindex "content scanning" "with regular expressions"
32278 .cindex "regular expressions" "content scanning with"
32279 You can specify your own custom regular expression matches on the full body of
32280 the message, or on individual MIME parts.
32281
32282 The &%regex%& condition takes one or more regular expressions as arguments and
32283 matches them against the full message (when called in the DATA ACL) or a raw
32284 MIME part (when called in the MIME ACL). The &%regex%& condition matches
32285 linewise, with a maximum line length of 32K characters. That means you cannot
32286 have multiline matches with the &%regex%& condition.
32287
32288 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
32289 to 32K of decoded content (the whole content at once, not linewise). If the
32290 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
32291 is decoded automatically when &%mime_regex%& is executed (using default path
32292 and filename values). If the decoded data is larger than  32K, only the first
32293 32K characters are checked.
32294
32295 The regular expressions are passed as a colon-separated list. To include a
32296 literal colon, you must double it. Since the whole right-hand side string is
32297 expanded before being used, you must also escape dollar signs and backslashes
32298 with more backslashes, or use the &`\N`& facility to disable expansion.
32299 Here is a simple example that contains two regular expressions:
32300 .code
32301 deny message = contains blacklisted regex ($regex_match_string)
32302      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
32303 .endd
32304 The conditions returns true if any one of the regular expressions matches. The
32305 &$regex_match_string$& expansion variable is then set up and contains the
32306 matching regular expression.
32307 The expansion variables &$regex1$& &$regex2$& etc
32308 are set to any substrings captured by the regular expression.
32309
32310 &*Warning*&: With large messages, these conditions can be fairly
32311 CPU-intensive.
32312
32313 .ecindex IIDcosca
32314
32315
32316
32317
32318 . ////////////////////////////////////////////////////////////////////////////
32319 . ////////////////////////////////////////////////////////////////////////////
32320
32321 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
32322          "Local scan function"
32323 .scindex IIDlosca "&[local_scan()]& function" "description of"
32324 .cindex "customizing" "input scan using C function"
32325 .cindex "policy control" "by local scan function"
32326 In these days of email worms, viruses, and ever-increasing spam, some sites
32327 want to apply a lot of checking to messages before accepting them.
32328
32329 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
32330 passing messages to external virus and spam scanning software. You can also do
32331 a certain amount in Exim itself through string expansions and the &%condition%&
32332 condition in the ACL that runs after the SMTP DATA command or the ACL for
32333 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
32334
32335 To allow for further customization to a site's own requirements, there is the
32336 possibility of linking Exim with a private message scanning function, written
32337 in C. If you want to run code that is written in something other than C, you
32338 can of course use a little C stub to call it.
32339
32340 The local scan function is run once for every incoming message, at the point
32341 when Exim is just about to accept the message.
32342 It can therefore be used to control non-SMTP messages from local processes as
32343 well as messages arriving via SMTP.
32344
32345 Exim applies a timeout to calls of the local scan function, and there is an
32346 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
32347 Zero means &"no timeout"&.
32348 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
32349 before calling the local scan function, so that the most common types of crash
32350 are caught. If the timeout is exceeded or one of those signals is caught, the
32351 incoming message is rejected with a temporary error if it is an SMTP message.
32352 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
32353 code. The incident is logged on the main and reject logs.
32354
32355
32356
32357 .section "Building Exim to use a local scan function" "SECID207"
32358 .cindex "&[local_scan()]& function" "building Exim to use"
32359 To make use of the local scan function feature, you must tell Exim where your
32360 function is before building Exim, by setting LOCAL_SCAN_SOURCE in your
32361 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
32362 directory, so you might set
32363 .code
32364 LOCAL_SCAN_SOURCE=Local/local_scan.c
32365 .endd
32366 for example. The function must be called &[local_scan()]&. It is called by
32367 Exim after it has received a message, when the success return code is about to
32368 be sent. This is after all the ACLs have been run. The return code from your
32369 function controls whether the message is actually accepted or not. There is a
32370 commented template function (that just accepts the message) in the file
32371 _src/local_scan.c_.
32372
32373 If you want to make use of Exim's run time configuration file to set options
32374 for your &[local_scan()]& function, you must also set
32375 .code
32376 LOCAL_SCAN_HAS_OPTIONS=yes
32377 .endd
32378 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
32379
32380
32381
32382
32383 .section "API for local_scan()" "SECTapiforloc"
32384 .cindex "&[local_scan()]& function" "API description"
32385 You must include this line near the start of your code:
32386 .code
32387 #include "local_scan.h"
32388 .endd
32389 This header file defines a number of variables and other values, and the
32390 prototype for the function itself. Exim is coded to use unsigned char values
32391 almost exclusively, and one of the things this header defines is a shorthand
32392 for &`unsigned char`& called &`uschar`&.
32393 It also contains the following macro definitions, to simplify casting character
32394 strings and pointers to character strings:
32395 .code
32396 #define CS   (char *)
32397 #define CCS  (const char *)
32398 #define CSS  (char **)
32399 #define US   (unsigned char *)
32400 #define CUS  (const unsigned char *)
32401 #define USS  (unsigned char **)
32402 .endd
32403 The function prototype for &[local_scan()]& is:
32404 .code
32405 extern int local_scan(int fd, uschar **return_text);
32406 .endd
32407 The arguments are as follows:
32408
32409 .ilist
32410 &%fd%& is a file descriptor for the file that contains the body of the message
32411 (the -D file). The file is open for reading and writing, but updating it is not
32412 recommended. &*Warning*&: You must &'not'& close this file descriptor.
32413
32414 The descriptor is positioned at character 19 of the file, which is the first
32415 character of the body itself, because the first 19 characters are the message
32416 id followed by &`-D`& and a newline. If you rewind the file, you should use the
32417 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
32418 case this changes in some future version.
32419 .next
32420 &%return_text%& is an address which you can use to return a pointer to a text
32421 string at the end of the function. The value it points to on entry is NULL.
32422 .endlist
32423
32424 The function must return an &%int%& value which is one of the following macros:
32425
32426 .vlist
32427 .vitem &`LOCAL_SCAN_ACCEPT`&
32428 .vindex "&$local_scan_data$&"
32429 The message is accepted. If you pass back a string of text, it is saved with
32430 the message, and made available in the variable &$local_scan_data$&. No
32431 newlines are permitted (if there are any, they are turned into spaces) and the
32432 maximum length of text is 1000 characters.
32433
32434 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
32435 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32436 queued without immediate delivery, and is frozen.
32437
32438 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
32439 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
32440 queued without immediate delivery.
32441
32442 .vitem &`LOCAL_SCAN_REJECT`&
32443 The message is rejected; the returned text is used as an error message which is
32444 passed back to the sender and which is also logged. Newlines are permitted &--
32445 they cause a multiline response for SMTP rejections, but are converted to
32446 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
32447 used.
32448
32449 .vitem &`LOCAL_SCAN_TEMPREJECT`&
32450 The message is temporarily rejected; the returned text is used as an error
32451 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
32452 problem"& is used.
32453
32454 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
32455 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
32456 message is not written to the reject log. It has the effect of unsetting the
32457 &%rejected_header%& log selector for just this rejection. If
32458 &%rejected_header%& is already unset (see the discussion of the
32459 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
32460 same as LOCAL_SCAN_REJECT.
32461
32462 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
32463 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
32464 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
32465 .endlist
32466
32467 If the message is not being received by interactive SMTP, rejections are
32468 reported by writing to &%stderr%& or by sending an email, as configured by the
32469 &%-oe%& command line options.
32470
32471
32472
32473 .section "Configuration options for local_scan()" "SECTconoptloc"
32474 .cindex "&[local_scan()]& function" "configuration options"
32475 It is possible to have option settings in the main configuration file
32476 that set values in static variables in the &[local_scan()]& module. If you
32477 want to do this, you must have the line
32478 .code
32479 LOCAL_SCAN_HAS_OPTIONS=yes
32480 .endd
32481 in your &_Local/Makefile_& when you build Exim. (This line is in
32482 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
32483 file, you must define static variables to hold the option values, and a table
32484 to define them.
32485
32486 The table must be a vector called &%local_scan_options%&, of type
32487 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
32488 and a pointer to the variable that holds the value. The entries must appear in
32489 alphabetical order. Following &%local_scan_options%& you must also define a
32490 variable called &%local_scan_options_count%& that contains the number of
32491 entries in the table. Here is a short example, showing two kinds of option:
32492 .code
32493 static int my_integer_option = 42;
32494 static uschar *my_string_option = US"a default string";
32495
32496 optionlist local_scan_options[] = {
32497   { "my_integer", opt_int,       &my_integer_option },
32498   { "my_string",  opt_stringptr, &my_string_option }
32499 };
32500
32501 int local_scan_options_count =
32502   sizeof(local_scan_options)/sizeof(optionlist);
32503 .endd
32504 The values of the variables can now be changed from Exim's runtime
32505 configuration file by including a local scan section as in this example:
32506 .code
32507 begin local_scan
32508 my_integer = 99
32509 my_string = some string of text...
32510 .endd
32511 The available types of option data are as follows:
32512
32513 .vlist
32514 .vitem &*opt_bool*&
32515 This specifies a boolean (true/false) option. The address should point to a
32516 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
32517 that are defined as &"1"& and &"0"&, respectively. If you want to detect
32518 whether such a variable has been set at all, you can initialize it to
32519 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
32520 values.)
32521
32522 .vitem &*opt_fixed*&
32523 This specifies a fixed point number, such as is used for load averages.
32524 The address should point to a variable of type &`int`&. The value is stored
32525 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
32526
32527 .vitem &*opt_int*&
32528 This specifies an integer; the address should point to a variable of type
32529 &`int`&. The value may be specified in any of the integer formats accepted by
32530 Exim.
32531
32532 .vitem &*opt_mkint*&
32533 This is the same as &%opt_int%&, except that when such a value is output in a
32534 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
32535 printed with the suffix K or M.
32536
32537 .vitem &*opt_octint*&
32538 This also specifies an integer, but the value is always interpreted as an
32539 octal integer, whether or not it starts with the digit zero, and it is
32540 always output in octal.
32541
32542 .vitem &*opt_stringptr*&
32543 This specifies a string value; the address must be a pointer to a
32544 variable that points to a string (for example, of type &`uschar *`&).
32545
32546 .vitem &*opt_time*&
32547 This specifies a time interval value. The address must point to a variable of
32548 type &`int`&. The value that is placed there is a number of seconds.
32549 .endlist
32550
32551 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
32552 out the values of all the &[local_scan()]& options.
32553
32554
32555
32556 .section "Available Exim variables" "SECID208"
32557 .cindex "&[local_scan()]& function" "available Exim variables"
32558 The header &_local_scan.h_& gives you access to a number of C variables. These
32559 are the only ones that are guaranteed to be maintained from release to release.
32560 Note, however, that you can obtain the value of any Exim expansion variable,
32561 including &$recipients$&, by calling &'expand_string()'&. The exported
32562 C variables are as follows:
32563
32564 .vlist
32565 .vitem &*int&~body_linecount*&
32566 This variable contains the number of lines in the message's body.
32567 .new
32568 It is not valid if the &%spool_files_wireformat%& option is used.
32569 .wen
32570
32571 .vitem &*int&~body_zerocount*&
32572 This variable contains the number of binary zero bytes in the message's body.
32573 .new
32574 It is not valid if the &%spool_files_wireformat%& option is used.
32575 .wen
32576
32577 .vitem &*unsigned&~int&~debug_selector*&
32578 This variable is set to zero when no debugging is taking place. Otherwise, it
32579 is a bitmap of debugging selectors. Two bits are identified for use in
32580 &[local_scan()]&; they are defined as macros:
32581
32582 .ilist
32583 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
32584 testing option that is not privileged &-- any caller may set it. All the
32585 other selector bits can be set only by admin users.
32586
32587 .next
32588 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
32589 by the &`+local_scan`& debug selector. It is not included in the default set
32590 of debugging bits.
32591 .endlist ilist
32592
32593 Thus, to write to the debugging output only when &`+local_scan`& has been
32594 selected, you should use code like this:
32595 .code
32596 if ((debug_selector & D_local_scan) != 0)
32597   debug_printf("xxx", ...);
32598 .endd
32599 .vitem &*uschar&~*expand_string_message*&
32600 After a failing call to &'expand_string()'& (returned value NULL), the
32601 variable &%expand_string_message%& contains the error message, zero-terminated.
32602
32603 .vitem &*header_line&~*header_list*&
32604 A pointer to a chain of header lines. The &%header_line%& structure is
32605 discussed below.
32606
32607 .vitem &*header_line&~*header_last*&
32608 A pointer to the last of the header lines.
32609
32610 .vitem &*uschar&~*headers_charset*&
32611 The value of the &%headers_charset%& configuration option.
32612
32613 .vitem &*BOOL&~host_checking*&
32614 This variable is TRUE during a host checking session that is initiated by the
32615 &%-bh%& command line option.
32616
32617 .vitem &*uschar&~*interface_address*&
32618 The IP address of the interface that received the message, as a string. This
32619 is NULL for locally submitted messages.
32620
32621 .vitem &*int&~interface_port*&
32622 The port on which this message was received. When testing with the &%-bh%&
32623 command line option, the value of this variable is -1 unless a port has been
32624 specified via the &%-oMi%& option.
32625
32626 .vitem &*uschar&~*message_id*&
32627 This variable contains Exim's message id for the incoming message (the value of
32628 &$message_exim_id$&) as a zero-terminated string.
32629
32630 .vitem &*uschar&~*received_protocol*&
32631 The name of the protocol by which the message was received.
32632
32633 .vitem &*int&~recipients_count*&
32634 The number of accepted recipients.
32635
32636 .vitem &*recipient_item&~*recipients_list*&
32637 .cindex "recipient" "adding in local scan"
32638 .cindex "recipient" "removing in local scan"
32639 The list of accepted recipients, held in a vector of length
32640 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
32641 can add additional recipients by calling &'receive_add_recipient()'& (see
32642 below). You can delete recipients by removing them from the vector and
32643 adjusting the value in &%recipients_count%&. In particular, by setting
32644 &%recipients_count%& to zero you remove all recipients. If you then return the
32645 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
32646 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
32647 and then call &'receive_add_recipient()'& as often as needed.
32648
32649 .vitem &*uschar&~*sender_address*&
32650 The envelope sender address. For bounce messages this is the empty string.
32651
32652 .vitem &*uschar&~*sender_host_address*&
32653 The IP address of the sending host, as a string. This is NULL for
32654 locally-submitted messages.
32655
32656 .vitem &*uschar&~*sender_host_authenticated*&
32657 The name of the authentication mechanism that was used, or NULL if the message
32658 was not received over an authenticated SMTP connection.
32659
32660 .vitem &*uschar&~*sender_host_name*&
32661 The name of the sending host, if known.
32662
32663 .vitem &*int&~sender_host_port*&
32664 The port on the sending host.
32665
32666 .vitem &*BOOL&~smtp_input*&
32667 This variable is TRUE for all SMTP input, including BSMTP.
32668
32669 .vitem &*BOOL&~smtp_batched_input*&
32670 This variable is TRUE for BSMTP input.
32671
32672 .vitem &*int&~store_pool*&
32673 The contents of this variable control which pool of memory is used for new
32674 requests. See section &<<SECTmemhanloc>>& for details.
32675 .endlist
32676
32677
32678 .section "Structure of header lines" "SECID209"
32679 The &%header_line%& structure contains the members listed below.
32680 You can add additional header lines by calling the &'header_add()'& function
32681 (see below). You can cause header lines to be ignored (deleted) by setting
32682 their type to *.
32683
32684
32685 .vlist
32686 .vitem &*struct&~header_line&~*next*&
32687 A pointer to the next header line, or NULL for the last line.
32688
32689 .vitem &*int&~type*&
32690 A code identifying certain headers that Exim recognizes. The codes are printing
32691 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
32692 Notice in particular that any header line whose type is * is not transmitted
32693 with the message. This flagging is used for header lines that have been
32694 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
32695 lines.) Effectively, * means &"deleted"&.
32696
32697 .vitem &*int&~slen*&
32698 The number of characters in the header line, including the terminating and any
32699 internal newlines.
32700
32701 .vitem &*uschar&~*text*&
32702 A pointer to the text of the header. It always ends with a newline, followed by
32703 a zero byte. Internal newlines are preserved.
32704 .endlist
32705
32706
32707
32708 .section "Structure of recipient items" "SECID210"
32709 The &%recipient_item%& structure contains these members:
32710
32711 .vlist
32712 .vitem &*uschar&~*address*&
32713 This is a pointer to the recipient address as it was received.
32714
32715 .vitem &*int&~pno*&
32716 This is used in later Exim processing when top level addresses are created by
32717 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
32718 and must always contain -1 at this stage.
32719
32720 .vitem &*uschar&~*errors_to*&
32721 If this value is not NULL, bounce messages caused by failing to deliver to the
32722 recipient are sent to the address it contains. In other words, it overrides the
32723 envelope sender for this one recipient. (Compare the &%errors_to%& generic
32724 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
32725 an unqualified address, Exim qualifies it using the domain from
32726 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
32727 is NULL for all recipients.
32728 .endlist
32729
32730
32731
32732 .section "Available Exim functions" "SECID211"
32733 .cindex "&[local_scan()]& function" "available Exim functions"
32734 The header &_local_scan.h_& gives you access to a number of Exim functions.
32735 These are the only ones that are guaranteed to be maintained from release to
32736 release:
32737
32738 .vlist
32739 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
32740        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
32741
32742 This function creates a child process that runs the command specified by
32743 &%argv%&. The environment for the process is specified by &%envp%&, which can
32744 be NULL if no environment variables are to be passed. A new umask is supplied
32745 for the process in &%newumask%&.
32746
32747 Pipes to the standard input and output of the new process are set up
32748 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
32749 standard error is cloned to the standard output. If there are any file
32750 descriptors &"in the way"& in the new process, they are closed. If the final
32751 argument is TRUE, the new process is made into a process group leader.
32752
32753 The function returns the pid of the new process, or -1 if things go wrong.
32754
32755 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
32756 This function waits for a child process to terminate, or for a timeout (in
32757 seconds) to expire. A timeout value of zero means wait as long as it takes. The
32758 return value is as follows:
32759
32760 .ilist
32761 >= 0
32762
32763 The process terminated by a normal exit and the value is the process
32764 ending status.
32765
32766 .next
32767 < 0 and > &--256
32768
32769 The process was terminated by a signal and the value is the negation of the
32770 signal number.
32771
32772 .next
32773 &--256
32774
32775 The process timed out.
32776 .next
32777 &--257
32778
32779 The was some other error in wait(); &%errno%& is still set.
32780 .endlist
32781
32782 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
32783 This function provide you with a means of submitting a new message to
32784 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
32785 want, but this packages it all up for you.) The function creates a pipe,
32786 forks a subprocess that is running
32787 .code
32788 exim -t -oem -oi -f <>
32789 .endd
32790 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
32791 that is connected to the standard input. The yield of the function is the PID
32792 of the subprocess. You can then write a message to the file descriptor, with
32793 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
32794
32795 When you have finished, call &'child_close()'& to wait for the process to
32796 finish and to collect its ending status. A timeout value of zero is usually
32797 fine in this circumstance. Unless you have made a mistake with the recipient
32798 addresses, you should get a return code of zero.
32799
32800
32801 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
32802        *sender_authentication)*&
32803 This function is a more sophisticated version of &'child_open()'&. The command
32804 that it runs is:
32805 .display
32806 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
32807 .endd
32808 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
32809
32810
32811 .vitem &*void&~debug_printf(char&~*,&~...)*&
32812 This is Exim's debugging function, with arguments as for &'(printf()'&. The
32813 output is written to the standard error stream. If no debugging is selected,
32814 calls to &'debug_printf()'& have no effect. Normally, you should make calls
32815 conditional on the &`local_scan`& debug selector by coding like this:
32816 .code
32817 if ((debug_selector & D_local_scan) != 0)
32818   debug_printf("xxx", ...);
32819 .endd
32820
32821 .vitem &*uschar&~*expand_string(uschar&~*string)*&
32822 This is an interface to Exim's string expansion code. The return value is the
32823 expanded string, or NULL if there was an expansion failure.
32824 The C variable &%expand_string_message%& contains an error message after an
32825 expansion failure. If expansion does not change the string, the return value is
32826 the pointer to the input string. Otherwise, the return value points to a new
32827 block of memory that was obtained by a call to &'store_get()'&. See section
32828 &<<SECTmemhanloc>>& below for a discussion of memory handling.
32829
32830 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
32831 This function allows you to an add additional header line at the end of the
32832 existing ones. The first argument is the type, and should normally be a space
32833 character. The second argument is a format string and any number of
32834 substitution arguments as for &[sprintf()]&. You may include internal newlines
32835 if you want, and you must ensure that the string ends with a newline.
32836
32837 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
32838         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
32839 This function adds a new header line at a specified point in the header
32840 chain. The header itself is specified as for &'header_add()'&.
32841
32842 If &%name%& is NULL, the new header is added at the end of the chain if
32843 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
32844 NULL, the header lines are searched for the first non-deleted header that
32845 matches the name. If one is found, the new header is added before it if
32846 &%after%& is false. If &%after%& is true, the new header is added after the
32847 found header and any adjacent subsequent ones with the same name (even if
32848 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
32849 option controls where the header is added. If it is true, addition is at the
32850 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
32851 headers, or at the top if there are no &'Received:'& headers, you could use
32852 .code
32853 header_add_at_position(TRUE, US"Received", TRUE,
32854   ' ', "X-xxx: ...");
32855 .endd
32856 Normally, there is always at least one non-deleted &'Received:'& header, but
32857 there may not be if &%received_header_text%& expands to an empty string.
32858
32859
32860 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
32861 This function removes header lines. If &%occurrence%& is zero or negative, all
32862 occurrences of the header are removed. If occurrence is greater than zero, that
32863 particular instance of the header is removed. If no header(s) can be found that
32864 match the specification, the function does nothing.
32865
32866
32867 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
32868         int&~length,&~BOOL&~notdel)*&"
32869 This function tests whether the given header has the given name. It is not just
32870 a string comparison, because white space is permitted between the name and the
32871 colon. If the &%notdel%& argument is true, a false return is forced for all
32872 &"deleted"& headers; otherwise they are not treated specially. For example:
32873 .code
32874 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
32875 .endd
32876 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
32877 .cindex "base64 encoding" "functions for &[local_scan()]& use"
32878 This function base64-encodes a string, which is passed by address and length.
32879 The text may contain bytes of any value, including zero. The result is passed
32880 back in dynamic memory that is obtained by calling &'store_get()'&. It is
32881 zero-terminated.
32882
32883 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
32884 This function decodes a base64-encoded string. Its arguments are a
32885 zero-terminated base64-encoded string and the address of a variable that is set
32886 to point to the result, which is in dynamic memory. The length of the decoded
32887 string is the yield of the function. If the input is invalid base64 data, the
32888 yield is -1. A zero byte is added to the end of the output string to make it
32889 easy to interpret as a C string (assuming it contains no zeros of its own). The
32890 added zero byte is not included in the returned count.
32891
32892 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
32893 This function checks for a match in a domain list. Domains are always
32894 matched caselessly. The return value is one of the following:
32895 .display
32896 &`OK     `& match succeeded
32897 &`FAIL   `& match failed
32898 &`DEFER  `& match deferred
32899 .endd
32900 DEFER is usually caused by some kind of lookup defer, such as the
32901 inability to contact a database.
32902
32903 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
32904         BOOL&~caseless)*&"
32905 This function checks for a match in a local part list. The third argument
32906 controls case-sensitivity. The return values are as for
32907 &'lss_match_domain()'&.
32908
32909 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
32910         BOOL&~caseless)*&"
32911 This function checks for a match in an address list. The third argument
32912 controls the case-sensitivity of the local part match. The domain is always
32913 matched caselessly. The return values are as for &'lss_match_domain()'&.
32914
32915 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
32916         uschar&~*list)*&"
32917 This function checks for a match in a host list. The most common usage is
32918 expected to be
32919 .code
32920 lss_match_host(sender_host_name, sender_host_address, ...)
32921 .endd
32922 .vindex "&$sender_host_address$&"
32923 An empty address field matches an empty item in the host list. If the host name
32924 is NULL, the name corresponding to &$sender_host_address$& is automatically
32925 looked up if a host name is required to match an item in the list. The return
32926 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
32927 returns ERROR in the case when it had to look up a host name, but the lookup
32928 failed.
32929
32930 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
32931         *format,&~...)*&"
32932 This function writes to Exim's log files. The first argument should be zero (it
32933 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
32934 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
32935 them. It specifies to which log or logs the message is written. The remaining
32936 arguments are a format and relevant insertion arguments. The string should not
32937 contain any newlines, not even at the end.
32938
32939
32940 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
32941 This function adds an additional recipient to the message. The first argument
32942 is the recipient address. If it is unqualified (has no domain), it is qualified
32943 with the &%qualify_recipient%& domain. The second argument must always be -1.
32944
32945 This function does not allow you to specify a private &%errors_to%& address (as
32946 described with the structure of &%recipient_item%& above), because it pre-dates
32947 the addition of that field to the structure. However, it is easy to add such a
32948 value afterwards. For example:
32949 .code
32950  receive_add_recipient(US"monitor@mydom.example", -1);
32951  recipients_list[recipients_count-1].errors_to =
32952    US"postmaster@mydom.example";
32953 .endd
32954
32955 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
32956 This is a convenience function to remove a named recipient from the list of
32957 recipients. It returns true if a recipient was removed, and false if no
32958 matching recipient could be found. The argument must be a complete email
32959 address.
32960 .endlist
32961
32962
32963 .cindex "RFC 2047"
32964 .vlist
32965 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
32966   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
32967 This function decodes strings that are encoded according to RFC 2047. Typically
32968 these are the contents of header lines. First, each &"encoded word"& is decoded
32969 from the Q or B encoding into a byte-string. Then, if provided with the name of
32970 a charset encoding, and if the &[iconv()]& function is available, an attempt is
32971 made  to translate the result to the named character set. If this fails, the
32972 binary string is returned with an error message.
32973
32974 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
32975 maximum MIME word length is enforced. The third argument is the target
32976 encoding, or NULL if no translation is wanted.
32977
32978 .cindex "binary zero" "in RFC 2047 decoding"
32979 .cindex "RFC 2047" "binary zero in"
32980 If a binary zero is encountered in the decoded string, it is replaced by the
32981 contents of the &%zeroval%& argument. For use with Exim headers, the value must
32982 not be 0 because header lines are handled as zero-terminated strings.
32983
32984 The function returns the result of processing the string, zero-terminated; if
32985 &%lenptr%& is not NULL, the length of the result is set in the variable to
32986 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
32987
32988 If an error is encountered, the function returns NULL and uses the &%error%&
32989 argument to return an error message. The variable pointed to by &%error%& is
32990 set to NULL if there is no error; it may be set non-NULL even when the function
32991 returns a non-NULL value if decoding was successful, but there was a problem
32992 with translation.
32993
32994
32995 .vitem &*int&~smtp_fflush(void)*&
32996 This function is used in conjunction with &'smtp_printf()'&, as described
32997 below.
32998
32999 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33000 The arguments of this function are like &[printf()]&; it writes to the SMTP
33001 output stream. You should use this function only when there is an SMTP output
33002 stream, that is, when the incoming message is being received via interactive
33003 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33004 is FALSE. If you want to test for an incoming message from another host (as
33005 opposed to a local process that used the &%-bs%& command line option), you can
33006 test the value of &%sender_host_address%&, which is non-NULL when a remote host
33007 is involved.
33008
33009 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
33010 output function, so it can be used for all forms of SMTP connection.
33011
33012 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
33013 must start with an appropriate response code: 550 if you are going to return
33014 LOCAL_SCAN_REJECT, 451 if you are going to return
33015 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
33016 initial lines of a multi-line response, the code must be followed by a hyphen
33017 to indicate that the line is not the final response line. You must also ensure
33018 that the lines you write terminate with CRLF. For example:
33019 .code
33020 smtp_printf("550-this is some extra info\r\n");
33021 return LOCAL_SCAN_REJECT;
33022 .endd
33023 Note that you can also create multi-line responses by including newlines in
33024 the data returned via the &%return_text%& argument. The added value of using
33025 &'smtp_printf()'& is that, for instance, you could introduce delays between
33026 multiple output lines.
33027
33028 The &'smtp_printf()'& function does not return any error indication, because it
33029 does not automatically flush pending output, and therefore does not test
33030 the state of the stream. (In the main code of Exim, flushing and error
33031 detection is done when Exim is ready for the next SMTP input command.) If
33032 you want to flush the output and check for an error (for example, the
33033 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
33034 arguments. It flushes the output stream, and returns a non-zero value if there
33035 is an error.
33036
33037 .vitem &*void&~*store_get(int)*&
33038 This function accesses Exim's internal store (memory) manager. It gets a new
33039 chunk of memory whose size is given by the argument. Exim bombs out if it ever
33040 runs out of memory. See the next section for a discussion of memory handling.
33041
33042 .vitem &*void&~*store_get_perm(int)*&
33043 This function is like &'store_get()'&, but it always gets memory from the
33044 permanent pool. See the next section for a discussion of memory handling.
33045
33046 .vitem &*uschar&~*string_copy(uschar&~*string)*&
33047 See below.
33048
33049 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
33050 See below.
33051
33052 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
33053 These three functions create strings using Exim's dynamic memory facilities.
33054 The first makes a copy of an entire string. The second copies up to a maximum
33055 number of characters, indicated by the second argument. The third uses a format
33056 and insertion arguments to create a new string. In each case, the result is a
33057 pointer to a new string in the current memory pool. See the next section for
33058 more discussion.
33059 .endlist
33060
33061
33062
33063 .section "More about Exim's memory handling" "SECTmemhanloc"
33064 .cindex "&[local_scan()]& function" "memory handling"
33065 No function is provided for freeing memory, because that is never needed.
33066 The dynamic memory that Exim uses when receiving a message is automatically
33067 recycled if another message is received by the same process (this applies only
33068 to incoming SMTP connections &-- other input methods can supply only one
33069 message at a time). After receiving the last message, a reception process
33070 terminates.
33071
33072 Because it is recycled, the normal dynamic memory cannot be used for holding
33073 data that must be preserved over a number of incoming messages on the same SMTP
33074 connection. However, Exim in fact uses two pools of dynamic memory; the second
33075 one is not recycled, and can be used for this purpose.
33076
33077 If you want to allocate memory that remains available for subsequent messages
33078 in the same SMTP connection, you should set
33079 .code
33080 store_pool = POOL_PERM
33081 .endd
33082 before calling the function that does the allocation. There is no need to
33083 restore the value if you do not need to; however, if you do want to revert to
33084 the normal pool, you can either restore the previous value of &%store_pool%& or
33085 set it explicitly to POOL_MAIN.
33086
33087 The pool setting applies to all functions that get dynamic memory, including
33088 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
33089 There is also a convenience function called &'store_get_perm()'& that gets a
33090 block of memory from the permanent pool while preserving the value of
33091 &%store_pool%&.
33092 .ecindex IIDlosca
33093
33094
33095
33096
33097 . ////////////////////////////////////////////////////////////////////////////
33098 . ////////////////////////////////////////////////////////////////////////////
33099
33100 .chapter "System-wide message filtering" "CHAPsystemfilter"
33101 .scindex IIDsysfil1 "filter" "system filter"
33102 .scindex IIDsysfil2 "filtering all mail"
33103 .scindex IIDsysfil3 "system filter"
33104 The previous chapters (on ACLs and the local scan function) describe checks
33105 that can be applied to messages before they are accepted by a host. There is
33106 also a mechanism for checking messages once they have been received, but before
33107 they are delivered. This is called the &'system filter'&.
33108
33109 The system filter operates in a similar manner to users' filter files, but it
33110 is run just once per message (however many recipients the message has).
33111 It should not normally be used as a substitute for routing, because &%deliver%&
33112 commands in a system router provide new envelope recipient addresses.
33113 The system filter must be an Exim filter. It cannot be a Sieve filter.
33114
33115 The system filter is run at the start of a delivery attempt, before any routing
33116 is done. If a message fails to be completely delivered at the first attempt,
33117 the system filter is run again at the start of every retry.
33118 If you want your filter to do something only once per message, you can make use
33119 of the &%first_delivery%& condition in an &%if%& command in the filter to
33120 prevent it happening on retries.
33121
33122 .vindex "&$domain$&"
33123 .vindex "&$local_part$&"
33124 &*Warning*&: Because the system filter runs just once, variables that are
33125 specific to individual recipient addresses, such as &$local_part$& and
33126 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
33127 you want to run a centrally-specified filter for each recipient address
33128 independently, you can do so by setting up a suitable &(redirect)& router, as
33129 described in section &<<SECTperaddfil>>& below.
33130
33131
33132 .section "Specifying a system filter" "SECID212"
33133 .cindex "uid (user id)" "system filter"
33134 .cindex "gid (group id)" "system filter"
33135 The name of the file that contains the system filter must be specified by
33136 setting &%system_filter%&. If you want the filter to run under a uid and gid
33137 other than root, you must also set &%system_filter_user%& and
33138 &%system_filter_group%& as appropriate. For example:
33139 .code
33140 system_filter = /etc/mail/exim.filter
33141 system_filter_user = exim
33142 .endd
33143 If a system filter generates any deliveries directly to files or pipes (via the
33144 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
33145 specified by setting &%system_filter_file_transport%& and
33146 &%system_filter_pipe_transport%&, respectively. Similarly,
33147 &%system_filter_reply_transport%& must be set to handle any messages generated
33148 by the &%reply%& command.
33149
33150
33151 .section "Testing a system filter" "SECID213"
33152 You can run simple tests of a system filter in the same way as for a user
33153 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
33154 are permitted only in system filters are recognized.
33155
33156 If you want to test the combined effect of a system filter and a user filter,
33157 you can use both &%-bF%& and &%-bf%& on the same command line.
33158
33159
33160
33161 .section "Contents of a system filter" "SECID214"
33162 The language used to specify system filters is the same as for users' filter
33163 files. It is described in the separate end-user document &'Exim's interface to
33164 mail filtering'&. However, there are some additional features that are
33165 available only in system filters; these are described in subsequent sections.
33166 If they are encountered in a user's filter file or when testing with &%-bf%&,
33167 they cause errors.
33168
33169 .cindex "frozen messages" "manual thaw; testing in filter"
33170 There are two special conditions which, though available in users' filter
33171 files, are designed for use in system filters. The condition &%first_delivery%&
33172 is true only for the first attempt at delivering a message, and
33173 &%manually_thawed%& is true only if the message has been frozen, and
33174 subsequently thawed by an admin user. An explicit forced delivery counts as a
33175 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
33176
33177 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
33178 specify an &"unseen"& (non-significant) delivery, and that delivery does not
33179 succeed, it will not be tried again.
33180 If you want Exim to retry an unseen delivery until it succeeds, you should
33181 arrange to set it up every time the filter runs.
33182
33183 When a system filter finishes running, the values of the variables &$n0$& &--
33184 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
33185 users' filter files. Thus a system filter can, for example, set up &"scores"&
33186 to which users' filter files can refer.
33187
33188
33189
33190 .section "Additional variable for system filters" "SECID215"
33191 .vindex "&$recipients$&"
33192 The expansion variable &$recipients$&, containing a list of all the recipients
33193 of the message (separated by commas and white space), is available in system
33194 filters. It is not available in users' filters for privacy reasons.
33195
33196
33197
33198 .section "Defer, freeze, and fail commands for system filters" "SECID216"
33199 .cindex "freezing messages"
33200 .cindex "message" "freezing"
33201 .cindex "message" "forced failure"
33202 .cindex "&%fail%&" "in system filter"
33203 .cindex "&%freeze%& in system filter"
33204 .cindex "&%defer%& in system filter"
33205 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
33206 always available in system filters, but are not normally enabled in users'
33207 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
33208 for the &(redirect)& router.) These commands can optionally be followed by the
33209 word &%text%& and a string containing an error message, for example:
33210 .code
33211 fail text "this message looks like spam to me"
33212 .endd
33213 The keyword &%text%& is optional if the next character is a double quote.
33214
33215 The &%defer%& command defers delivery of the original recipients of the
33216 message. The &%fail%& command causes all the original recipients to be failed,
33217 and a bounce message to be created. The &%freeze%& command suspends all
33218 delivery attempts for the original recipients. In all cases, any new deliveries
33219 that are specified by the filter are attempted as normal after the filter has
33220 run.
33221
33222 The &%freeze%& command is ignored if the message has been manually unfrozen and
33223 not manually frozen since. This means that automatic freezing by a system
33224 filter can be used as a way of checking out suspicious messages. If a message
33225 is found to be all right, manually unfreezing it allows it to be delivered.
33226
33227 .cindex "log" "&%fail%& command log line"
33228 .cindex "&%fail%&" "log line; reducing"
33229 The text given with a fail command is used as part of the bounce message as
33230 well as being written to the log. If the message is quite long, this can fill
33231 up a lot of log space when such failures are common. To reduce the size of the
33232 log message, Exim interprets the text in a special way if it starts with the
33233 two characters &`<<`& and contains &`>>`& later. The text between these two
33234 strings is written to the log, and the rest of the text is used in the bounce
33235 message. For example:
33236 .code
33237 fail "<<filter test 1>>Your message is rejected \
33238      because it contains attachments that we are \
33239      not prepared to receive."
33240 .endd
33241
33242 .cindex "loop" "caused by &%fail%&"
33243 Take great care with the &%fail%& command when basing the decision to fail on
33244 the contents of the message, because the bounce message will of course include
33245 the contents of the original message and will therefore trigger the &%fail%&
33246 command again (causing a mail loop) unless steps are taken to prevent this.
33247 Testing the &%error_message%& condition is one way to prevent this. You could
33248 use, for example
33249 .code
33250 if $message_body contains "this is spam" and not error_message
33251 then fail text "spam is not wanted here" endif
33252 .endd
33253 though of course that might let through unwanted bounce messages. The
33254 alternative is clever checking of the body and/or headers to detect bounces
33255 generated by the filter.
33256
33257 The interpretation of a system filter file ceases after a
33258 &%defer%&,
33259 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
33260 set up earlier in the filter file are honoured, so you can use a sequence such
33261 as
33262 .code
33263 mail ...
33264 freeze
33265 .endd
33266 to send a specified message when the system filter is freezing (or deferring or
33267 failing) a message. The normal deliveries for the message do not, of course,
33268 take place.
33269
33270
33271
33272 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
33273 .cindex "header lines" "adding; in system filter"
33274 .cindex "header lines" "removing; in system filter"
33275 .cindex "filter" "header lines; adding/removing"
33276 Two filter commands that are available only in system filters are:
33277 .code
33278 headers add <string>
33279 headers remove <string>
33280 .endd
33281 The argument for the &%headers add%& is a string that is expanded and then
33282 added to the end of the message's headers. It is the responsibility of the
33283 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
33284 space is ignored, and if the string is otherwise empty, or if the expansion is
33285 forced to fail, the command has no effect.
33286
33287 You can use &"\n"& within the string, followed by white space, to specify
33288 continued header lines. More than one header may be added in one command by
33289 including &"\n"& within the string without any following white space. For
33290 example:
33291 .code
33292 headers add "X-header-1: ....\n  \
33293              continuation of X-header-1 ...\n\
33294              X-header-2: ...."
33295 .endd
33296 Note that the header line continuation white space after the first newline must
33297 be placed before the backslash that continues the input string, because white
33298 space after input continuations is ignored.
33299
33300 The argument for &%headers remove%& is a colon-separated list of header names.
33301 This command applies only to those headers that are stored with the message;
33302 those that are added at delivery time (such as &'Envelope-To:'& and
33303 &'Return-Path:'&) cannot be removed by this means. If there is more than one
33304 header with the same name, they are all removed.
33305
33306 The &%headers%& command in a system filter makes an immediate change to the set
33307 of header lines that was received with the message (with possible additions
33308 from ACL processing). Subsequent commands in the system filter operate on the
33309 modified set, which also forms the basis for subsequent message delivery.
33310 Unless further modified during routing or transporting, this set of headers is
33311 used for all recipients of the message.
33312
33313 During routing and transporting, the variables that refer to the contents of
33314 header lines refer only to those lines that are in this set. Thus, header lines
33315 that are added by a system filter are visible to users' filter files and to all
33316 routers and transports. This contrasts with the manipulation of header lines by
33317 routers and transports, which is not immediate, but which instead is saved up
33318 until the message is actually being written (see section
33319 &<<SECTheadersaddrem>>&).
33320
33321 If the message is not delivered at the first attempt, header lines that were
33322 added by the system filter are stored with the message, and so are still
33323 present at the next delivery attempt. Header lines that were removed are still
33324 present, but marked &"deleted"& so that they are not transported with the
33325 message. For this reason, it is usual to make the &%headers%& command
33326 conditional on &%first_delivery%& so that the set of header lines is not
33327 modified more than once.
33328
33329 Because header modification in a system filter acts immediately, you have to
33330 use an indirect approach if you want to modify the contents of a header line.
33331 For example:
33332 .code
33333 headers add "Old-Subject: $h_subject:"
33334 headers remove "Subject"
33335 headers add "Subject: new subject (was: $h_old-subject:)"
33336 headers remove "Old-Subject"
33337 .endd
33338
33339
33340
33341 .section "Setting an errors address in a system filter" "SECID217"
33342 .cindex "envelope sender"
33343 In a system filter, if a &%deliver%& command is followed by
33344 .code
33345 errors_to <some address>
33346 .endd
33347 in order to change the envelope sender (and hence the error reporting) for that
33348 delivery, any address may be specified. (In a user filter, only the current
33349 user's address can be set.) For example, if some mail is being monitored, you
33350 might use
33351 .code
33352 unseen deliver monitor@spying.example errors_to root@local.example
33353 .endd
33354 to take a copy which would not be sent back to the normal error reporting
33355 address if its delivery failed.
33356
33357
33358
33359 .section "Per-address filtering" "SECTperaddfil"
33360 .vindex "&$domain$&"
33361 .vindex "&$local_part$&"
33362 In contrast to the system filter, which is run just once per message for each
33363 delivery attempt, it is also possible to set up a system-wide filtering
33364 operation that runs once for each recipient address. In this case, variables
33365 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
33366 filter file could be made dependent on them. This is an example of a router
33367 which implements such a filter:
33368 .code
33369 central_filter:
33370   check_local_user
33371   driver = redirect
33372   domains = +local_domains
33373   file = /central/filters/$local_part
33374   no_verify
33375   allow_filter
33376   allow_freeze
33377 .endd
33378 The filter is run in a separate process under its own uid. Therefore, either
33379 &%check_local_user%& must be set (as above), in which case the filter is run as
33380 the local user, or the &%user%& option must be used to specify which user to
33381 use. If both are set, &%user%& overrides.
33382
33383 Care should be taken to ensure that none of the commands in the filter file
33384 specify a significant delivery if the message is to go on to be delivered to
33385 its intended recipient. The router will not then claim to have dealt with the
33386 address, so it will be passed on to subsequent routers to be delivered in the
33387 normal way.
33388 .ecindex IIDsysfil1
33389 .ecindex IIDsysfil2
33390 .ecindex IIDsysfil3
33391
33392
33393
33394
33395
33396
33397 . ////////////////////////////////////////////////////////////////////////////
33398 . ////////////////////////////////////////////////////////////////////////////
33399
33400 .chapter "Message processing" "CHAPmsgproc"
33401 .scindex IIDmesproc "message" "general processing"
33402 Exim performs various transformations on the sender and recipient addresses of
33403 all messages that it handles, and also on the messages' header lines. Some of
33404 these are optional and configurable, while others always take place. All of
33405 this processing, except rewriting as a result of routing, and the addition or
33406 removal of header lines while delivering, happens when a message is received,
33407 before it is placed on Exim's queue.
33408
33409 Some of the automatic processing takes place by default only for
33410 &"locally-originated"& messages. This adjective is used to describe messages
33411 that are not received over TCP/IP, but instead are passed to an Exim process on
33412 its standard input. This includes the interactive &"local SMTP"& case that is
33413 set up by the &%-bs%& command line option.
33414
33415 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
33416 or ::1) are not considered to be locally-originated. Exim does not treat the
33417 loopback interface specially in any way.
33418
33419 If you want the loopback interface to be treated specially, you must ensure
33420 that there are appropriate entries in your ACLs.
33421
33422
33423
33424
33425 .section "Submission mode for non-local messages" "SECTsubmodnon"
33426 .cindex "message" "submission"
33427 .cindex "submission mode"
33428 Processing that happens automatically for locally-originated messages (unless
33429 &%suppress_local_fixups%& is set) can also be requested for messages that are
33430 received over TCP/IP. The term &"submission mode"& is used to describe this
33431 state. Submission mode is set by the modifier
33432 .code
33433 control = submission
33434 .endd
33435 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
33436 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
33437 a local submission, and is normally used when the source of the message is
33438 known to be an MUA running on a client host (as opposed to an MTA). For
33439 example, to set submission mode for messages originating on the IPv4 loopback
33440 interface, you could include the following in the MAIL ACL:
33441 .code
33442 warn  hosts = 127.0.0.1
33443       control = submission
33444 .endd
33445 .cindex "&%sender_retain%& submission option"
33446 There are some options that can be used when setting submission mode. A slash
33447 is used to separate options. For example:
33448 .code
33449 control = submission/sender_retain
33450 .endd
33451 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
33452 true and &%local_from_check%& false for the current incoming message. The first
33453 of these allows an existing &'Sender:'& header in the message to remain, and
33454 the second suppresses the check to ensure that &'From:'& matches the
33455 authenticated sender. With this setting, Exim still fixes up messages by adding
33456 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
33457 attempt to check sender authenticity in header lines.
33458
33459 When &%sender_retain%& is not set, a submission mode setting may specify a
33460 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
33461 example:
33462 .code
33463 control = submission/domain=some.domain
33464 .endd
33465 The domain may be empty. How this value is used is described in sections
33466 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
33467 that allows you to specify the user's full name for inclusion in a created
33468 &'Sender:'& or &'From:'& header line. For example:
33469 .code
33470 accept authenticated = *
33471        control = submission/domain=wonderland.example/\
33472                             name=${lookup {$authenticated_id} \
33473                                    lsearch {/etc/exim/namelist}}
33474 .endd
33475 Because the name may contain any characters, including slashes, the &%name%&
33476 option must be given last. The remainder of the string is used as the name. For
33477 the example above, if &_/etc/exim/namelist_& contains:
33478 .code
33479 bigegg:  Humpty Dumpty
33480 .endd
33481 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
33482 line would be:
33483 .code
33484 Sender: Humpty Dumpty <bigegg@wonderland.example>
33485 .endd
33486 .cindex "return path" "in submission mode"
33487 By default, submission mode forces the return path to the same address as is
33488 used to create the &'Sender:'& header. However, if &%sender_retain%& is
33489 specified, the return path is also left unchanged.
33490
33491 &*Note*&: The changes caused by submission mode take effect after the predata
33492 ACL. This means that any sender checks performed before the fix-ups use the
33493 untrusted sender address specified by the user, not the trusted sender address
33494 specified by submission mode. Although this might be slightly unexpected, it
33495 does mean that you can configure ACL checks to spot that a user is trying to
33496 spoof another's address.
33497
33498 .section "Line endings" "SECTlineendings"
33499 .cindex "line endings"
33500 .cindex "carriage return"
33501 .cindex "linefeed"
33502 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
33503 linefeed) is the line ending for messages transmitted over the Internet using
33504 SMTP over TCP/IP. However, within individual operating systems, different
33505 conventions are used. For example, Unix-like systems use just LF, but others
33506 use CRLF or just CR.
33507
33508 Exim was designed for Unix-like systems, and internally, it stores messages
33509 using the system's convention of a single LF as a line terminator. When
33510 receiving a message, all line endings are translated to this standard format.
33511 Originally, it was thought that programs that passed messages directly to an
33512 MTA within an operating system would use that system's convention. Experience
33513 has shown that this is not the case; for example, there are Unix applications
33514 that use CRLF in this circumstance. For this reason, and for compatibility with
33515 other MTAs, the way Exim handles line endings for all messages is now as
33516 follows:
33517
33518 .ilist
33519 LF not preceded by CR is treated as a line ending.
33520 .next
33521 CR is treated as a line ending; if it is immediately followed by LF, the LF
33522 is ignored.
33523 .next
33524 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
33525 nor a local message in the state where a line containing only a dot is a
33526 terminator.
33527 .next
33528 If a bare CR is encountered within a header line, an extra space is added after
33529 the line terminator so as not to end the header line. The reasoning behind this
33530 is that bare CRs in header lines are most likely either to be mistakes, or
33531 people trying to play silly games.
33532 .next
33533 If the first header line received in a message ends with CRLF, a subsequent
33534 bare LF in a header line is treated in the same way as a bare CR in a header
33535 line.
33536 .endlist
33537
33538
33539
33540
33541
33542 .section "Unqualified addresses" "SECID218"
33543 .cindex "unqualified addresses"
33544 .cindex "address" "qualification"
33545 By default, Exim expects every envelope address it receives from an external
33546 host to be fully qualified. Unqualified addresses cause negative responses to
33547 SMTP commands. However, because SMTP is used as a means of transporting
33548 messages from MUAs running on personal workstations, there is sometimes a
33549 requirement to accept unqualified addresses from specific hosts or IP networks.
33550
33551 Exim has two options that separately control which hosts may send unqualified
33552 sender or recipient addresses in SMTP commands, namely
33553 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
33554 cases, if an unqualified address is accepted, it is qualified by adding the
33555 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
33556
33557 .oindex "&%qualify_domain%&"
33558 .oindex "&%qualify_recipient%&"
33559 Unqualified addresses in header lines are automatically qualified for messages
33560 that are locally originated, unless the &%-bnq%& option is given on the command
33561 line. For messages received over SMTP, unqualified addresses in header lines
33562 are qualified only if unqualified addresses are permitted in SMTP commands. In
33563 other words, such qualification is also controlled by
33564 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
33565
33566
33567
33568
33569 .section "The UUCP From line" "SECID219"
33570 .cindex "&""From""& line"
33571 .cindex "UUCP" "&""From""& line"
33572 .cindex "sender" "address"
33573 .oindex "&%uucp_from_pattern%&"
33574 .oindex "&%uucp_from_sender%&"
33575 .cindex "envelope sender"
33576 .cindex "Sendmail compatibility" "&""From""& line"
33577 Messages that have come from UUCP (and some other applications) often begin
33578 with a line containing the envelope sender and a timestamp, following the word
33579 &"From"&. Examples of two common formats are:
33580 .code
33581 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
33582 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
33583 .endd
33584 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
33585 Exim recognizes such lines at the start of messages that are submitted to it
33586 via the command line (that is, on the standard input). It does not recognize
33587 such lines in incoming SMTP messages, unless the sending host matches
33588 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
33589 and &%ignore_fromline_local%& is set. The recognition is controlled by a
33590 regular expression that is defined by the &%uucp_from_pattern%& option, whose
33591 default value matches the two common cases shown above and puts the address
33592 that follows &"From"& into &$1$&.
33593
33594 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
33595 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
33596 a trusted user, the message's sender address is constructed by expanding the
33597 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
33598 then parsed as an RFC 2822 address. If there is no domain, the local part is
33599 qualified with &%qualify_domain%& unless it is the empty string. However, if
33600 the command line &%-f%& option is used, it overrides the &"From"& line.
33601
33602 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
33603 sender address is not changed. This is also the case for incoming SMTP messages
33604 that are permitted to contain &"From"& lines.
33605
33606 Only one &"From"& line is recognized. If there is more than one, the second is
33607 treated as a data line that starts the body of the message, as it is not valid
33608 as a header line. This also happens if a &"From"& line is present in an
33609 incoming SMTP message from a source that is not permitted to send them.
33610
33611
33612
33613 .section "Resent- header lines" "SECID220"
33614 .cindex "&%Resent-%& header lines"
33615 .cindex "header lines" "Resent-"
33616 RFC 2822 makes provision for sets of header lines starting with the string
33617 &`Resent-`& to be added to a message when it is resent by the original
33618 recipient to somebody else. These headers are &'Resent-Date:'&,
33619 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
33620 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
33621
33622 .blockquote
33623 &'Resent fields are strictly informational. They MUST NOT be used in the normal
33624 processing of replies or other such automatic actions on messages.'&
33625 .endblockquote
33626
33627 This leaves things a bit vague as far as other processing actions such as
33628 address rewriting are concerned. Exim treats &%Resent-%& header lines as
33629 follows:
33630
33631 .ilist
33632 A &'Resent-From:'& line that just contains the login id of the submitting user
33633 is automatically rewritten in the same way as &'From:'& (see below).
33634 .next
33635 If there's a rewriting rule for a particular header line, it is also applied to
33636 &%Resent-%& header lines of the same type. For example, a rule that rewrites
33637 &'From:'& also rewrites &'Resent-From:'&.
33638 .next
33639 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
33640 also removed.
33641 .next
33642 For a locally-submitted message,
33643 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
33644 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
33645 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
33646 included in log lines in this case.
33647 .next
33648 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
33649 &%Resent-%& header lines are present.
33650 .endlist
33651
33652
33653
33654
33655 .section "The Auto-Submitted: header line" "SECID221"
33656 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
33657 includes the header line:
33658 .code
33659 Auto-Submitted: auto-replied
33660 .endd
33661
33662 .section "The Bcc: header line" "SECID222"
33663 .cindex "&'Bcc:'& header line"
33664 If Exim is called with the &%-t%& option, to take recipient addresses from a
33665 message's header, it removes any &'Bcc:'& header line that may exist (after
33666 extracting its addresses). If &%-t%& is not present on the command line, any
33667 existing &'Bcc:'& is not removed.
33668
33669
33670 .section "The Date: header line" "SECID223"
33671 .cindex "&'Date:'& header line"
33672 .cindex "header lines" "Date:"
33673 If a locally-generated or submission-mode message has no &'Date:'& header line,
33674 Exim adds one, using the current date and time, unless the
33675 &%suppress_local_fixups%& control has been specified.
33676
33677 .section "The Delivery-date: header line" "SECID224"
33678 .cindex "&'Delivery-date:'& header line"
33679 .oindex "&%delivery_date_remove%&"
33680 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
33681 set. Exim can be configured to add them to the final delivery of messages. (See
33682 the generic &%delivery_date_add%& transport option.) They should not be present
33683 in messages in transit. If the &%delivery_date_remove%& configuration option is
33684 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
33685 messages.
33686
33687
33688 .section "The Envelope-to: header line" "SECID225"
33689 .cindex "&'Envelope-to:'& header line"
33690 .cindex "header lines" "Envelope-to:"
33691 .oindex "&%envelope_to_remove%&"
33692 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
33693 Exim can be configured to add them to the final delivery of messages. (See the
33694 generic &%envelope_to_add%& transport option.) They should not be present in
33695 messages in transit. If the &%envelope_to_remove%& configuration option is set
33696 (the default), Exim removes &'Envelope-to:'& header lines from incoming
33697 messages.
33698
33699
33700 .section "The From: header line" "SECTthefrohea"
33701 .cindex "&'From:'& header line"
33702 .cindex "header lines" "From:"
33703 .cindex "Sendmail compatibility" "&""From""& line"
33704 .cindex "message" "submission"
33705 .cindex "submission mode"
33706 If a submission-mode message does not contain a &'From:'& header line, Exim
33707 adds one if either of the following conditions is true:
33708
33709 .ilist
33710 The envelope sender address is not empty (that is, this is not a bounce
33711 message). The added header line copies the envelope sender address.
33712 .next
33713 .vindex "&$authenticated_id$&"
33714 The SMTP session is authenticated and &$authenticated_id$& is not empty.
33715 .olist
33716 .vindex "&$qualify_domain$&"
33717 If no domain is specified by the submission control, the local part is
33718 &$authenticated_id$& and the domain is &$qualify_domain$&.
33719 .next
33720 If a non-empty domain is specified by the submission control, the local
33721 part is &$authenticated_id$&, and the domain is the specified domain.
33722 .next
33723 If an empty domain is specified by the submission control,
33724 &$authenticated_id$& is assumed to be the complete address.
33725 .endlist
33726 .endlist
33727
33728 A non-empty envelope sender takes precedence.
33729
33730 If a locally-generated incoming message does not contain a &'From:'& header
33731 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
33732 containing the sender's address. The calling user's login name and full name
33733 are used to construct the address, as described in section &<<SECTconstr>>&.
33734 They are obtained from the password data by calling &[getpwuid()]& (but see the
33735 &%unknown_login%& configuration option). The address is qualified with
33736 &%qualify_domain%&.
33737
33738 For compatibility with Sendmail, if an incoming, non-SMTP message has a
33739 &'From:'& header line containing just the unqualified login name of the calling
33740 user, this is replaced by an address containing the user's login name and full
33741 name as described in section &<<SECTconstr>>&.
33742
33743
33744 .section "The Message-ID: header line" "SECID226"
33745 .cindex "&'Message-ID:'& header line"
33746 .cindex "header lines" "Message-ID:"
33747 .cindex "message" "submission"
33748 .oindex "&%message_id_header_text%&"
33749 If a locally-generated or submission-mode incoming message does not contain a
33750 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
33751 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
33752 to the message. If there are any &'Resent-:'& headers in the message, it
33753 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
33754 message id, preceded by the letter E to ensure it starts with a letter, and
33755 followed by @ and the primary host name. Additional information can be included
33756 in this header line by setting the &%message_id_header_text%& and/or
33757 &%message_id_header_domain%& options.
33758
33759
33760 .section "The Received: header line" "SECID227"
33761 .cindex "&'Received:'& header line"
33762 .cindex "header lines" "Received:"
33763 A &'Received:'& header line is added at the start of every message. The
33764 contents are defined by the &%received_header_text%& configuration option, and
33765 Exim automatically adds a semicolon and a timestamp to the configured string.
33766
33767 The &'Received:'& header is generated as soon as the message's header lines
33768 have been received. At this stage, the timestamp in the &'Received:'& header
33769 line is the time that the message started to be received. This is the value
33770 that is seen by the DATA ACL and by the &[local_scan()]& function.
33771
33772 Once a message is accepted, the timestamp in the &'Received:'& header line is
33773 changed to the time of acceptance, which is (apart from a small delay while the
33774 -H spool file is written) the earliest time at which delivery could start.
33775
33776
33777 .section "The References: header line" "SECID228"
33778 .cindex "&'References:'& header line"
33779 .cindex "header lines" "References:"
33780 Messages created by the &(autoreply)& transport include a &'References:'&
33781 header line. This is constructed according to the rules that are described in
33782 section 3.64 of RFC 2822 (which states that replies should contain such a
33783 header line), and section 3.14 of RFC 3834 (which states that automatic
33784 responses are not different in this respect). However, because some mail
33785 processing software does not cope well with very long header lines, no more
33786 than 12 message IDs are copied from the &'References:'& header line in the
33787 incoming message. If there are more than 12, the first one and then the final
33788 11 are copied, before adding the message ID of the incoming message.
33789
33790
33791
33792 .section "The Return-path: header line" "SECID229"
33793 .cindex "&'Return-path:'& header line"
33794 .cindex "header lines" "Return-path:"
33795 .oindex "&%return_path_remove%&"
33796 &'Return-path:'& header lines are defined as something an MTA may insert when
33797 it does the final delivery of messages. (See the generic &%return_path_add%&
33798 transport option.) Therefore, they should not be present in messages in
33799 transit. If the &%return_path_remove%& configuration option is set (the
33800 default), Exim removes &'Return-path:'& header lines from incoming messages.
33801
33802
33803
33804 .section "The Sender: header line" "SECTthesenhea"
33805 .cindex "&'Sender:'& header line"
33806 .cindex "message" "submission"
33807 .cindex "header lines" "Sender:"
33808 For a locally-originated message from an untrusted user, Exim may remove an
33809 existing &'Sender:'& header line, and it may add a new one. You can modify
33810 these actions by setting the &%local_sender_retain%& option true, the
33811 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
33812 control setting.
33813
33814 When a local message is received from an untrusted user and
33815 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
33816 control has not been set, a check is made to see if the address given in the
33817 &'From:'& header line is the correct (local) sender of the message. The address
33818 that is expected has the login name as the local part and the value of
33819 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
33820 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
33821 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
33822 line is added to the message.
33823
33824 If you set &%local_from_check%& false, this checking does not occur. However,
33825 the removal of an existing &'Sender:'& line still happens, unless you also set
33826 &%local_sender_retain%& to be true. It is not possible to set both of these
33827 options true at the same time.
33828
33829 .cindex "submission mode"
33830 By default, no processing of &'Sender:'& header lines is done for messages
33831 received over TCP/IP or for messages submitted by trusted users. However, when
33832 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
33833 not specified on the submission control, the following processing takes place:
33834
33835 .vindex "&$authenticated_id$&"
33836 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
33837 authenticated, and &$authenticated_id$& is not empty, a sender address is
33838 created as follows:
33839
33840 .ilist
33841 .vindex "&$qualify_domain$&"
33842 If no domain is specified by the submission control, the local part is
33843 &$authenticated_id$& and the domain is &$qualify_domain$&.
33844 .next
33845 If a non-empty domain is specified by the submission control, the local part
33846 is &$authenticated_id$&, and the domain is the specified domain.
33847 .next
33848 If an empty domain is specified by the submission control,
33849 &$authenticated_id$& is assumed to be the complete address.
33850 .endlist
33851
33852 This address is compared with the address in the &'From:'& header line. If they
33853 are different, a &'Sender:'& header line containing the created address is
33854 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
33855 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
33856
33857 .cindex "return path" "created from &'Sender:'&"
33858 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
33859 the message (the envelope sender address) is changed to be the same address,
33860 except in the case of submission mode when &%sender_retain%& is specified.
33861
33862
33863
33864 .section "Adding and removing header lines in routers and transports" &&&
33865          "SECTheadersaddrem"
33866 .cindex "header lines" "adding; in router or transport"
33867 .cindex "header lines" "removing; in router or transport"
33868 When a message is delivered, the addition and removal of header lines can be
33869 specified in a system filter, or on any of the routers and transports that
33870 process the message. Section &<<SECTaddremheasys>>& contains details about
33871 modifying headers in a system filter. Header lines can also be added in an ACL
33872 as a message is received (see section &<<SECTaddheadacl>>&).
33873
33874 In contrast to what happens in a system filter, header modifications that are
33875 specified on routers and transports apply only to the particular recipient
33876 addresses that are being processed by those routers and transports. These
33877 changes do not actually take place until a copy of the message is being
33878 transported. Therefore, they do not affect the basic set of header lines, and
33879 they do not affect the values of the variables that refer to header lines.
33880
33881 &*Note*&: In particular, this means that any expansions in the configuration of
33882 the transport cannot refer to the modified header lines, because such
33883 expansions all occur before the message is actually transported.
33884
33885 For both routers and transports, the argument of a &%headers_add%&
33886 option must be in the form of one or more RFC 2822 header lines, separated by
33887 newlines (coded as &"\n"&). For example:
33888 .code
33889 headers_add = X-added-header: added by $primary_hostname\n\
33890               X-added-second: another added header line
33891 .endd
33892 Exim does not check the syntax of these added header lines.
33893
33894 Multiple &%headers_add%& options for a single router or transport can be
33895 specified; the values will append to a single list of header lines.
33896 Each header-line is separately expanded.
33897
33898 The argument of a &%headers_remove%& option must consist of a colon-separated
33899 list of header names. This is confusing, because header names themselves are
33900 often terminated by colons. In this case, the colons are the list separators,
33901 not part of the names. For example:
33902 .code
33903 headers_remove = return-receipt-to:acknowledge-to
33904 .endd
33905
33906 Multiple &%headers_remove%& options for a single router or transport can be
33907 specified; the arguments will append to a single header-names list.
33908 Each item is separately expanded.
33909 Note that colons in complex expansions which are used to
33910 form all or part of a &%headers_remove%& list
33911 will act as list separators.
33912
33913 When &%headers_add%& or &%headers_remove%& is specified on a router,
33914 items are expanded at routing time,
33915 and then associated with all addresses that are
33916 accepted by that router, and also with any new addresses that it generates. If
33917 an address passes through several routers as a result of aliasing or
33918 forwarding, the changes are cumulative.
33919
33920 .oindex "&%unseen%&"
33921 However, this does not apply to multiple routers that result from the use of
33922 the &%unseen%& option. Any header modifications that were specified by the
33923 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
33924
33925 Addresses that end up with different &%headers_add%& or &%headers_remove%&
33926 settings cannot be delivered together in a batch, so a transport is always
33927 dealing with a set of addresses that have the same header-processing
33928 requirements.
33929
33930 The transport starts by writing the original set of header lines that arrived
33931 with the message, possibly modified by the system filter. As it writes out
33932 these lines, it consults the list of header names that were attached to the
33933 recipient address(es) by &%headers_remove%& options in routers, and it also
33934 consults the transport's own &%headers_remove%& option. Header lines whose
33935 names are on either of these lists are not written out. If there are multiple
33936 instances of any listed header, they are all skipped.
33937
33938 After the remaining original header lines have been written, new header
33939 lines that were specified by routers' &%headers_add%& options are written, in
33940 the order in which they were attached to the address. These are followed by any
33941 header lines specified by the transport's &%headers_add%& option.
33942
33943 This way of handling header line modifications in routers and transports has
33944 the following consequences:
33945
33946 .ilist
33947 The original set of header lines, possibly modified by the system filter,
33948 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
33949 to it, at all times.
33950 .next
33951 Header lines that are added by a router's
33952 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
33953 expansion syntax in subsequent routers or the transport.
33954 .next
33955 Conversely, header lines that are specified for removal by &%headers_remove%&
33956 in a router remain visible to subsequent routers and the transport.
33957 .next
33958 Headers added to an address by &%headers_add%& in a router cannot be removed by
33959 a later router or by a transport.
33960 .next
33961 An added header can refer to the contents of an original header that is to be
33962 removed, even it has the same name as the added header. For example:
33963 .code
33964 headers_remove = subject
33965 headers_add = Subject: new subject (was: $h_subject:)
33966 .endd
33967 .endlist
33968
33969 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
33970 for a &(redirect)& router that has the &%one_time%& option set.
33971
33972
33973
33974
33975
33976 .section "Constructed addresses" "SECTconstr"
33977 .cindex "address" "constructed"
33978 .cindex "constructed address"
33979 When Exim constructs a sender address for a locally-generated message, it uses
33980 the form
33981 .display
33982 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
33983 .endd
33984 For example:
33985 .code
33986 Zaphod Beeblebrox <zaphod@end.univ.example>
33987 .endd
33988 The user name is obtained from the &%-F%& command line option if set, or
33989 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
33990 &"gecos"& field from the password entry. If the &"gecos"& field contains an
33991 ampersand character, this is replaced by the login name with the first letter
33992 upper cased, as is conventional in a number of operating systems. See the
33993 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
33994 The &%unknown_username%& option can be used to specify user names in cases when
33995 there is no password file entry.
33996
33997 .cindex "RFC 2047"
33998 In all cases, the user name is made to conform to RFC 2822 by quoting all or
33999 parts of it if necessary. In addition, if it contains any non-printing
34000 characters, it is encoded as described in RFC 2047, which defines a way of
34001 including non-ASCII characters in header lines. The value of the
34002 &%headers_charset%& option specifies the name of the encoding that is used (the
34003 characters are assumed to be in this encoding). The setting of
34004 &%print_topbitchars%& controls whether characters with the top bit set (that
34005 is, with codes greater than 127) count as printing characters or not.
34006
34007
34008
34009 .section "Case of local parts" "SECID230"
34010 .cindex "case of local parts"
34011 .cindex "local part" "case of"
34012 RFC 2822 states that the case of letters in the local parts of addresses cannot
34013 be assumed to be non-significant. Exim preserves the case of local parts of
34014 addresses, but by default it uses a lower-cased form when it is routing,
34015 because on most Unix systems, usernames are in lower case and case-insensitive
34016 routing is required. However, any particular router can be made to use the
34017 original case for local parts by setting the &%caseful_local_part%& generic
34018 router option.
34019
34020 .cindex "mixed-case login names"
34021 If you must have mixed-case user names on your system, the best way to proceed,
34022 assuming you want case-independent handling of incoming email, is to set up
34023 your first router to convert incoming local parts in your domains to the
34024 correct case by means of a file lookup. For example:
34025 .code
34026 correct_case:
34027   driver = redirect
34028   domains = +local_domains
34029   data = ${lookup{$local_part}cdb\
34030               {/etc/usercased.cdb}{$value}fail}\
34031               @$domain
34032 .endd
34033 For this router, the local part is forced to lower case by the default action
34034 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
34035 up a new local part in the correct case. If you then set &%caseful_local_part%&
34036 on any subsequent routers which process your domains, they will operate on
34037 local parts with the correct case in a case-sensitive manner.
34038
34039
34040
34041 .section "Dots in local parts" "SECID231"
34042 .cindex "dot" "in local part"
34043 .cindex "local part" "dots in"
34044 RFC 2822 forbids empty components in local parts. That is, an unquoted local
34045 part may not begin or end with a dot, nor have two consecutive dots in the
34046 middle. However, it seems that many MTAs do not enforce this, so Exim permits
34047 empty components for compatibility.
34048
34049
34050
34051 .section "Rewriting addresses" "SECID232"
34052 .cindex "rewriting" "addresses"
34053 Rewriting of sender and recipient addresses, and addresses in headers, can
34054 happen automatically, or as the result of configuration options, as described
34055 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
34056 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
34057
34058 Automatic rewriting includes qualification, as mentioned above. The other case
34059 in which it can happen is when an incomplete non-local domain is given. The
34060 routing process may cause this to be expanded into the full domain name. For
34061 example, a header such as
34062 .code
34063 To: hare@teaparty
34064 .endd
34065 might get rewritten as
34066 .code
34067 To: hare@teaparty.wonderland.fict.example
34068 .endd
34069 Rewriting as a result of routing is the one kind of message processing that
34070 does not happen at input time, as it cannot be done until the address has
34071 been routed.
34072
34073 Strictly, one should not do &'any'& deliveries of a message until all its
34074 addresses have been routed, in case any of the headers get changed as a
34075 result of routing. However, doing this in practice would hold up many
34076 deliveries for unreasonable amounts of time, just because one address could not
34077 immediately be routed. Exim therefore does not delay other deliveries when
34078 routing of one or more addresses is deferred.
34079 .ecindex IIDmesproc
34080
34081
34082
34083 . ////////////////////////////////////////////////////////////////////////////
34084 . ////////////////////////////////////////////////////////////////////////////
34085
34086 .chapter "SMTP processing" "CHAPSMTP"
34087 .scindex IIDsmtpproc1 "SMTP" "processing details"
34088 .scindex IIDsmtpproc2 "LMTP" "processing details"
34089 Exim supports a number of different ways of using the SMTP protocol, and its
34090 LMTP variant, which is an interactive protocol for transferring messages into a
34091 closed mail store application. This chapter contains details of how SMTP is
34092 processed. For incoming mail, the following are available:
34093
34094 .ilist
34095 SMTP over TCP/IP (Exim daemon or &'inetd'&);
34096 .next
34097 SMTP over the standard input and output (the &%-bs%& option);
34098 .next
34099 Batched SMTP on the standard input (the &%-bS%& option).
34100 .endlist
34101
34102 For mail delivery, the following are available:
34103
34104 .ilist
34105 SMTP over TCP/IP (the &(smtp)& transport);
34106 .next
34107 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
34108 &"lmtp"&);
34109 .next
34110 LMTP over a pipe to a process running in the local host (the &(lmtp)&
34111 transport);
34112 .next
34113 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
34114 the &%use_bsmtp%& option set).
34115 .endlist
34116
34117 &'Batched SMTP'& is the name for a process in which batches of messages are
34118 stored in or read from files (or pipes), in a format in which SMTP commands are
34119 used to contain the envelope information.
34120
34121
34122
34123 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
34124 .cindex "SMTP" "outgoing over TCP/IP"
34125 .cindex "outgoing SMTP over TCP/IP"
34126 .cindex "LMTP" "over TCP/IP"
34127 .cindex "outgoing LMTP over TCP/IP"
34128 .cindex "EHLO"
34129 .cindex "HELO"
34130 .cindex "SIZE option on MAIL command"
34131 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
34132 The &%protocol%& option selects which protocol is to be used, but the actual
34133 processing is the same in both cases.
34134
34135 If, in response to its EHLO command, Exim is told that the SIZE
34136 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
34137 command. The value of <&'n'&> is the message size plus the value of the
34138 &%size_addition%& option (default 1024) to allow for additions to the message
34139 such as per-transport header lines, or changes made in a
34140 .cindex "transport" "filter"
34141 .cindex "filter" "transport filter"
34142 transport filter. If &%size_addition%& is set negative, the use of SIZE is
34143 suppressed.
34144
34145 If the remote server advertises support for PIPELINING, Exim uses the
34146 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
34147 required for the transaction.
34148
34149 If the remote server advertises support for the STARTTLS command, and Exim
34150 was built to support TLS encryption, it tries to start a TLS session unless the
34151 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
34152 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
34153 is called for verification.
34154
34155 If the remote server advertises support for the AUTH command, Exim scans
34156 the authenticators configuration for any suitable client settings, as described
34157 in chapter &<<CHAPSMTPAUTH>>&.
34158
34159 .cindex "carriage return"
34160 .cindex "linefeed"
34161 Responses from the remote host are supposed to be terminated by CR followed by
34162 LF. However, there are known to be hosts that do not send CR characters, so in
34163 order to be able to interwork with such hosts, Exim treats LF on its own as a
34164 line terminator.
34165
34166 If a message contains a number of different addresses, all those with the same
34167 characteristics (for example, the same envelope sender) that resolve to the
34168 same set of hosts, in the same order, are sent in a single SMTP transaction,
34169 even if they are for different domains, unless there are more than the setting
34170 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
34171 they are split into groups containing no more than &%max_rcpt%&s addresses
34172 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
34173 in parallel sessions. The order of hosts with identical MX values is not
34174 significant when checking whether addresses can be batched in this way.
34175
34176 When the &(smtp)& transport suffers a temporary failure that is not
34177 message-related, Exim updates its transport-specific database, which contains
34178 records indexed by host name that remember which messages are waiting for each
34179 particular host. It also updates the retry database with new retry times.
34180
34181 .cindex "hints database" "retry keys"
34182 Exim's retry hints are based on host name plus IP address, so if one address of
34183 a multi-homed host is broken, it will soon be skipped most of the time.
34184 See the next section for more detail about error handling.
34185
34186 .cindex "SMTP" "passed connection"
34187 .cindex "SMTP" "batching over TCP/IP"
34188 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
34189 looks in the hints database for the transport to see if there are any queued
34190 messages waiting for the host to which it is connected. If it finds one, it
34191 creates a new Exim process using the &%-MC%& option (which can only be used by
34192 a process running as root or the Exim user) and passes the TCP/IP socket to it
34193 so that it can deliver another message using the same socket. The new process
34194 does only those deliveries that are routed to the connected host, and may in
34195 turn pass the socket on to a third process, and so on.
34196
34197 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
34198 limit the number of messages sent down a single TCP/IP connection.
34199
34200 .cindex "asterisk" "after IP address"
34201 The second and subsequent messages delivered down an existing connection are
34202 identified in the main log by the addition of an asterisk after the closing
34203 square bracket of the IP address.
34204
34205
34206
34207
34208 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
34209 .cindex "error" "in outgoing SMTP"
34210 .cindex "SMTP" "errors in outgoing"
34211 .cindex "host" "error"
34212 Three different kinds of error are recognized for outgoing SMTP: host errors,
34213 message errors, and recipient errors.
34214
34215 .vlist
34216 .vitem "&*Host errors*&"
34217 A host error is not associated with a particular message or with a
34218 particular recipient of a message. The host errors are:
34219
34220 .ilist
34221 Connection refused or timed out,
34222 .next
34223 Any error response code on connection,
34224 .next
34225 Any error response code to EHLO or HELO,
34226 .next
34227 Loss of connection at any time, except after &"."&,
34228 .next
34229 I/O errors at any time,
34230 .next
34231 Timeouts during the session, other than in response to MAIL, RCPT or
34232 the &"."& at the end of the data.
34233 .endlist ilist
34234
34235 For a host error, a permanent error response on connection, or in response to
34236 EHLO, causes all addresses routed to the host to be failed. Any other host
34237 error causes all addresses to be deferred, and retry data to be created for the
34238 host. It is not tried again, for any message, until its retry time arrives. If
34239 the current set of addresses are not all delivered in this run (to some
34240 alternative host), the message is added to the list of those waiting for this
34241 host, so if it is still undelivered when a subsequent successful delivery is
34242 made to the host, it will be sent down the same SMTP connection.
34243
34244 .vitem "&*Message errors*&"
34245 .cindex "message" "error"
34246 A message error is associated with a particular message when sent to a
34247 particular host, but not with a particular recipient of the message. The
34248 message errors are:
34249
34250 .ilist
34251 Any error response code to MAIL, DATA, or the &"."& that terminates
34252 the data,
34253 .next
34254 Timeout after MAIL,
34255 .next
34256 Timeout or loss of connection after the &"."& that terminates the data. A
34257 timeout after the DATA command itself is treated as a host error, as is loss of
34258 connection at any other time.
34259 .endlist ilist
34260
34261 For a message error, a permanent error response (5&'xx'&) causes all addresses
34262 to be failed, and a delivery error report to be returned to the sender. A
34263 temporary error response (4&'xx'&), or one of the timeouts, causes all
34264 addresses to be deferred. Retry data is not created for the host, but instead,
34265 a retry record for the combination of host plus message id is created. The
34266 message is not added to the list of those waiting for this host. This ensures
34267 that the failing message will not be sent to this host again until the retry
34268 time arrives. However, other messages that are routed to the host are not
34269 affected, so if it is some property of the message that is causing the error,
34270 it will not stop the delivery of other mail.
34271
34272 If the remote host specified support for the SIZE parameter in its response
34273 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
34274 over-large message will cause a message error because the error arrives as a
34275 response to MAIL.
34276
34277 .vitem "&*Recipient errors*&"
34278 .cindex "recipient" "error"
34279 A recipient error is associated with a particular recipient of a message. The
34280 recipient errors are:
34281
34282 .ilist
34283 Any error response to RCPT,
34284 .next
34285 Timeout after RCPT.
34286 .endlist
34287
34288 For a recipient error, a permanent error response (5&'xx'&) causes the
34289 recipient address to be failed, and a bounce message to be returned to the
34290 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
34291 address to be deferred, and routing retry data to be created for it. This is
34292 used to delay processing of the address in subsequent queue runs, until its
34293 routing retry time arrives. This applies to all messages, but because it
34294 operates only in queue runs, one attempt will be made to deliver a new message
34295 to the failing address before the delay starts to operate. This ensures that,
34296 if the failure is really related to the message rather than the recipient
34297 (&"message too big for this recipient"& is a possible example), other messages
34298 have a chance of getting delivered. If a delivery to the address does succeed,
34299 the retry information gets cleared, so all stuck messages get tried again, and
34300 the retry clock is reset.
34301
34302 The message is not added to the list of those waiting for this host. Use of the
34303 host for other messages is unaffected, and except in the case of a timeout,
34304 other recipients are processed independently, and may be successfully delivered
34305 in the current SMTP session. After a timeout it is of course impossible to
34306 proceed with the session, so all addresses get deferred. However, those other
34307 than the one that failed do not suffer any subsequent retry delays. Therefore,
34308 if one recipient is causing trouble, the others have a chance of getting
34309 through when a subsequent delivery attempt occurs before the failing
34310 recipient's retry time.
34311 .endlist
34312
34313 In all cases, if there are other hosts (or IP addresses) available for the
34314 current set of addresses (for example, from multiple MX records), they are
34315 tried in this run for any undelivered addresses, subject of course to their
34316 own retry data. In other words, recipient error retry data does not take effect
34317 until the next delivery attempt.
34318
34319 Some hosts have been observed to give temporary error responses to every
34320 MAIL command at certain times (&"insufficient space"& has been seen). It
34321 would be nice if such circumstances could be recognized, and defer data for the
34322 host itself created, but this is not possible within the current Exim design.
34323 What actually happens is that retry data for every (host, message) combination
34324 is created.
34325
34326 The reason that timeouts after MAIL and RCPT are treated specially is that
34327 these can sometimes arise as a result of the remote host's verification
34328 procedures. Exim makes this assumption, and treats them as if a temporary error
34329 response had been received. A timeout after &"."& is treated specially because
34330 it is known that some broken implementations fail to recognize the end of the
34331 message if the last character of the last line is a binary zero. Thus, it is
34332 helpful to treat this case as a message error.
34333
34334 Timeouts at other times are treated as host errors, assuming a problem with the
34335 host, or the connection to it. If a timeout after MAIL, RCPT,
34336 or &"."& is really a connection problem, the assumption is that at the next try
34337 the timeout is likely to occur at some other point in the dialogue, causing it
34338 then to be treated as a host error.
34339
34340 There is experimental evidence that some MTAs drop the connection after the
34341 terminating &"."& if they do not like the contents of the message for some
34342 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
34343 should be given. That is why Exim treats this case as a message rather than a
34344 host error, in order not to delay other messages to the same host.
34345
34346
34347
34348
34349 .section "Incoming SMTP messages over TCP/IP" "SECID233"
34350 .cindex "SMTP" "incoming over TCP/IP"
34351 .cindex "incoming SMTP over TCP/IP"
34352 .cindex "inetd"
34353 .cindex "daemon"
34354 Incoming SMTP messages can be accepted in one of two ways: by running a
34355 listening daemon, or by using &'inetd'&. In the latter case, the entry in
34356 &_/etc/inetd.conf_& should be like this:
34357 .code
34358 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
34359 .endd
34360 Exim distinguishes between this case and the case of a locally running user
34361 agent using the &%-bs%& option by checking whether or not the standard input is
34362 a socket. When it is, either the port must be privileged (less than 1024), or
34363 the caller must be root or the Exim user. If any other user passes a socket
34364 with an unprivileged port number, Exim prints a message on the standard error
34365 stream and exits with an error code.
34366
34367 By default, Exim does not make a log entry when a remote host connects or
34368 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
34369 unexpected. It can be made to write such log entries by setting the
34370 &%smtp_connection%& log selector.
34371
34372 .cindex "carriage return"
34373 .cindex "linefeed"
34374 Commands from the remote host are supposed to be terminated by CR followed by
34375 LF. However, there are known to be hosts that do not send CR characters. In
34376 order to be able to interwork with such hosts, Exim treats LF on its own as a
34377 line terminator.
34378 Furthermore, because common code is used for receiving messages from all
34379 sources, a CR on its own is also interpreted as a line terminator. However, the
34380 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
34381
34382 .cindex "EHLO" "invalid data"
34383 .cindex "HELO" "invalid data"
34384 One area that sometimes gives rise to problems concerns the EHLO or
34385 HELO commands. Some clients send syntactically invalid versions of these
34386 commands, which Exim rejects by default. (This is nothing to do with verifying
34387 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
34388 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
34389 match the broken hosts that send invalid commands.
34390
34391 .cindex "SIZE option on MAIL command"
34392 .cindex "MAIL" "SIZE option"
34393 The amount of disk space available is checked whenever SIZE is received on
34394 a MAIL command, independently of whether &%message_size_limit%& or
34395 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
34396 false. A temporary error is given if there is not enough space. If
34397 &%check_spool_space%& is set, the check is for that amount of space plus the
34398 value given with SIZE, that is, it checks that the addition of the incoming
34399 message will not reduce the space below the threshold.
34400
34401 When a message is successfully received, Exim includes the local message id in
34402 its response to the final &"."& that terminates the data. If the remote host
34403 logs this text it can help with tracing what has happened to a message.
34404
34405 The Exim daemon can limit the number of simultaneous incoming connections it is
34406 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
34407 number of simultaneous incoming connections from a single remote host (see the
34408 &%smtp_accept_max_per_host%& option). Additional connection attempts are
34409 rejected using the SMTP temporary error code 421.
34410
34411 The Exim daemon does not rely on the SIGCHLD signal to detect when a
34412 subprocess has finished, as this can get lost at busy times. Instead, it looks
34413 for completed subprocesses every time it wakes up. Provided there are other
34414 things happening (new incoming calls, starts of queue runs), completed
34415 processes will be noticed and tidied away. On very quiet systems you may
34416 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
34417 it will be noticed when the daemon next wakes up.
34418
34419 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
34420 and can also be set up to reject SMTP calls from non-reserved hosts at times of
34421 high system load &-- for details see the &%smtp_accept_reserve%&,
34422 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
34423 applies in both the daemon and &'inetd'& cases.
34424
34425 Exim normally starts a delivery process for each message received, though this
34426 can be varied by means of the &%-odq%& command line option and the
34427 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
34428 number of simultaneously running delivery processes started in this way from
34429 SMTP input can be limited by the &%smtp_accept_queue%& and
34430 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
34431 subsequently received messages are just put on the input queue without starting
34432 a delivery process.
34433
34434 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
34435 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
34436 started up from the &'inetd'& daemon, because in that case each connection is
34437 handled by an entirely independent Exim process. Control by load average is,
34438 however, available with &'inetd'&.
34439
34440 Exim can be configured to verify addresses in incoming SMTP commands as they
34441 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
34442 to rewrite addresses at this time &-- before any syntax checking is done. See
34443 section &<<SECTrewriteS>>&.
34444
34445 Exim can also be configured to limit the rate at which a client host submits
34446 MAIL and RCPT commands in a single SMTP session. See the
34447 &%smtp_ratelimit_hosts%& option.
34448
34449
34450
34451 .section "Unrecognized SMTP commands" "SECID234"
34452 .cindex "SMTP" "unrecognized commands"
34453 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
34454 commands during a single SMTP connection, it drops the connection after sending
34455 the error response to the last command. The default value for
34456 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
34457 abuse that subvert web servers into making connections to SMTP ports; in these
34458 circumstances, a number of non-SMTP lines are sent first.
34459
34460
34461 .section "Syntax and protocol errors in SMTP commands" "SECID235"
34462 .cindex "SMTP" "syntax errors"
34463 .cindex "SMTP" "protocol errors"
34464 A syntax error is detected if an SMTP command is recognized, but there is
34465 something syntactically wrong with its data, for example, a malformed email
34466 address in a RCPT command. Protocol errors include invalid command
34467 sequencing such as RCPT before MAIL. If Exim receives more than
34468 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
34469 drops the connection after sending the error response to the last command. The
34470 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
34471 broken clients that loop sending bad commands (yes, it has been seen).
34472
34473
34474
34475 .section "Use of non-mail SMTP commands" "SECID236"
34476 .cindex "SMTP" "non-mail commands"
34477 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
34478 DATA. Exim counts such commands, and drops the connection if there are too
34479 many of them in a single SMTP session. This action catches some
34480 denial-of-service attempts and things like repeated failing AUTHs, or a mad
34481 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
34482 defines what &"too many"& means. Its default value is 10.
34483
34484 When a new message is expected, one occurrence of RSET is not counted. This
34485 allows a client to send one RSET between messages (this is not necessary,
34486 but some clients do it). Exim also allows one uncounted occurrence of HELO
34487 or EHLO, and one occurrence of STARTTLS between messages. After
34488 starting up a TLS session, another EHLO is expected, and so it too is not
34489 counted.
34490
34491 The first occurrence of AUTH in a connection, or immediately following
34492 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
34493 RCPT, DATA, and QUIT are counted.
34494
34495 You can control which hosts are subject to the limit set by
34496 &%smtp_accept_max_nonmail%& by setting
34497 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
34498 the limit apply to all hosts. This option means that you can exclude any
34499 specific badly-behaved hosts that you have to live with.
34500
34501
34502
34503
34504 .section "The VRFY and EXPN commands" "SECID237"
34505 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
34506 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
34507 appropriate) in order to decide whether the command should be accepted or not.
34508
34509 .cindex "VRFY" "processing"
34510 When no ACL is defined for VRFY, or if it rejects without
34511 setting an explicit response code, the command is accepted
34512 (with a 252 SMTP response code)
34513 in order to support awkward clients that do a VRFY before every RCPT.
34514 When VRFY is accepted, it runs exactly the same code as when Exim is
34515 called with the &%-bv%& option, and returns 250/451/550
34516 SMTP response codes.
34517
34518 .cindex "EXPN" "processing"
34519 If no ACL for EXPN is defined, the command is rejected.
34520 When EXPN is accepted, a single-level expansion of the address is done.
34521 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
34522 than a verification (the &%-bv%& option). If an unqualified local part is given
34523 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
34524 of VRFY and EXPN commands are logged on the main and reject logs, and
34525 VRFY verification failures are logged on the main log for consistency with
34526 RCPT failures.
34527
34528
34529
34530 .section "The ETRN command" "SECTETRN"
34531 .cindex "ETRN" "processing"
34532 RFC 1985 describes an SMTP command called ETRN that is designed to
34533 overcome the security problems of the TURN command (which has fallen into
34534 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
34535 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
34536 should be accepted or not. If no ACL is defined, the command is rejected.
34537
34538 The ETRN command is concerned with &"releasing"& messages that are awaiting
34539 delivery to certain hosts. As Exim does not organize its message queue by host,
34540 the only form of ETRN that is supported by default is the one where the
34541 text starts with the &"#"& prefix, in which case the remainder of the text is
34542 specific to the SMTP server. A valid ETRN command causes a run of Exim with
34543 the &%-R%& option to happen, with the remainder of the ETRN text as its
34544 argument. For example,
34545 .code
34546 ETRN #brigadoon
34547 .endd
34548 runs the command
34549 .code
34550 exim -R brigadoon
34551 .endd
34552 which causes a delivery attempt on all messages with undelivered addresses
34553 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
34554 default), Exim prevents the simultaneous execution of more than one queue run
34555 for the same argument string as a result of an ETRN command. This stops
34556 a misbehaving client from starting more than one queue runner at once.
34557
34558 .cindex "hints database" "ETRN serialization"
34559 Exim implements the serialization by means of a hints database in which a
34560 record is written whenever a process is started by ETRN, and deleted when
34561 the process completes. However, Exim does not keep the SMTP session waiting for
34562 the ETRN process to complete. Once ETRN is accepted, the client is sent
34563 a &"success"& return code. Obviously there is scope for hints records to get
34564 left lying around if there is a system or program crash. To guard against this,
34565 Exim ignores any records that are more than six hours old.
34566
34567 .oindex "&%smtp_etrn_command%&"
34568 For more control over what ETRN does, the &%smtp_etrn_command%& option can
34569 used. This specifies a command that is run whenever ETRN is received,
34570 whatever the form of its argument. For
34571 example:
34572 .code
34573 smtp_etrn_command = /etc/etrn_command $domain \
34574                     $sender_host_address
34575 .endd
34576 .vindex "&$domain$&"
34577 The string is split up into arguments which are independently expanded. The
34578 expansion variable &$domain$& is set to the argument of the ETRN command,
34579 and no syntax checking is done on the contents of this argument. Exim does not
34580 wait for the command to complete, so its status code is not checked. Exim runs
34581 under its own uid and gid when receiving incoming SMTP, so it is not possible
34582 for it to change them before running the command.
34583
34584
34585
34586 .section "Incoming local SMTP" "SECID238"
34587 .cindex "SMTP" "local incoming"
34588 Some user agents use SMTP to pass messages to their local MTA using the
34589 standard input and output, as opposed to passing the envelope on the command
34590 line and writing the message to the standard input. This is supported by the
34591 &%-bs%& option. This form of SMTP is handled in the same way as incoming
34592 messages over TCP/IP (including the use of ACLs), except that the envelope
34593 sender given in a MAIL command is ignored unless the caller is trusted. In
34594 an ACL you can detect this form of SMTP input by testing for an empty host
34595 identification. It is common to have this as the first line in the ACL that
34596 runs for RCPT commands:
34597 .code
34598 accept hosts = :
34599 .endd
34600 This accepts SMTP messages from local processes without doing any other tests.
34601
34602
34603
34604 .section "Outgoing batched SMTP" "SECTbatchSMTP"
34605 .cindex "SMTP" "batched outgoing"
34606 .cindex "batched SMTP output"
34607 Both the &(appendfile)& and &(pipe)& transports can be used for handling
34608 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
34609 be output in BSMTP format. No SMTP responses are possible for this form of
34610 delivery. All it is doing is using SMTP commands as a way of transmitting the
34611 envelope along with the message.
34612
34613 The message is written to the file or pipe preceded by the SMTP commands
34614 MAIL and RCPT, and followed by a line containing a single dot. Lines in
34615 the message that start with a dot have an extra dot added. The SMTP command
34616 HELO is not normally used. If it is required, the &%message_prefix%& option
34617 can be used to specify it.
34618
34619 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
34620 one recipient address at a time by default. However, you can arrange for them
34621 to handle several addresses at once by setting the &%batch_max%& option. When
34622 this is done for BSMTP, messages may contain multiple RCPT commands. See
34623 chapter &<<CHAPbatching>>& for more details.
34624
34625 .vindex "&$host$&"
34626 When one or more addresses are routed to a BSMTP transport by a router that
34627 sets up a host list, the name of the first host on the list is available to the
34628 transport in the variable &$host$&. Here is an example of such a transport and
34629 router:
34630 .code
34631 begin routers
34632 route_append:
34633   driver = manualroute
34634   transport = smtp_appendfile
34635   route_list = domain.example  batch.host.example
34636
34637 begin transports
34638 smtp_appendfile:
34639   driver = appendfile
34640   directory = /var/bsmtp/$host
34641   batch_max = 1000
34642   use_bsmtp
34643   user = exim
34644 .endd
34645 This causes messages addressed to &'domain.example'& to be written in BSMTP
34646 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
34647 message (unless there are more than 1000 recipients).
34648
34649
34650
34651 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
34652 .cindex "SMTP" "batched incoming"
34653 .cindex "batched SMTP input"
34654 The &%-bS%& command line option causes Exim to accept one or more messages by
34655 reading SMTP on the standard input, but to generate no responses. If the caller
34656 is trusted, the senders in the MAIL commands are believed; otherwise the
34657 sender is always the caller of Exim. Unqualified senders and receivers are not
34658 rejected (there seems little point) but instead just get qualified. HELO
34659 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
34660 as NOOP; QUIT quits.
34661
34662 Minimal policy checking is done for BSMTP input. Only the non-SMTP
34663 ACL is run in the same way as for non-SMTP local input.
34664
34665 If an error is detected while reading a message, including a missing &"."& at
34666 the end, Exim gives up immediately. It writes details of the error to the
34667 standard output in a stylized way that the calling program should be able to
34668 make some use of automatically, for example:
34669 .code
34670 554 Unexpected end of file
34671 Transaction started in line 10
34672 Error detected in line 14
34673 .endd
34674 It writes a more verbose version, for human consumption, to the standard error
34675 file, for example:
34676 .code
34677 An error was detected while processing a file of BSMTP input.
34678 The error message was:
34679
34680 501 '>' missing at end of address
34681
34682 The SMTP transaction started in line 10.
34683 The error was detected in line 12.
34684 The SMTP command at fault was:
34685
34686 rcpt to:<malformed@in.com.plete
34687
34688 1 previous message was successfully processed.
34689 The rest of the batch was abandoned.
34690 .endd
34691 The return code from Exim is zero only if there were no errors. It is 1 if some
34692 messages were accepted before an error was detected, and 2 if no messages were
34693 accepted.
34694 .ecindex IIDsmtpproc1
34695 .ecindex IIDsmtpproc2
34696
34697
34698
34699 . ////////////////////////////////////////////////////////////////////////////
34700 . ////////////////////////////////////////////////////////////////////////////
34701
34702 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
34703          "Customizing messages"
34704 When a message fails to be delivered, or remains on the queue for more than a
34705 configured amount of time, Exim sends a message to the original sender, or
34706 to an alternative configured address. The text of these messages is built into
34707 the code of Exim, but it is possible to change it, either by adding a single
34708 string, or by replacing each of the paragraphs by text supplied in a file.
34709
34710 The &'From:'& and &'To:'& header lines are automatically generated; you can
34711 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
34712 option. Exim also adds the line
34713 .code
34714 Auto-Submitted: auto-generated
34715 .endd
34716 to all warning and bounce messages,
34717
34718
34719 .section "Customizing bounce messages" "SECID239"
34720 .cindex "customizing" "bounce message"
34721 .cindex "bounce message" "customizing"
34722 If &%bounce_message_text%& is set, its contents are included in the default
34723 message immediately after &"This message was created automatically by mail
34724 delivery software."& The string is not expanded. It is not used if
34725 &%bounce_message_file%& is set.
34726
34727 When &%bounce_message_file%& is set, it must point to a template file for
34728 constructing error messages. The file consists of a series of text items,
34729 separated by lines consisting of exactly four asterisks. If the file cannot be
34730 opened, default text is used and a message is written to the main and panic
34731 logs. If any text item in the file is empty, default text is used for that
34732 item.
34733
34734 .vindex "&$bounce_recipient$&"
34735 .vindex "&$bounce_return_size_limit$&"
34736 Each item of text that is read from the file is expanded, and there are two
34737 expansion variables which can be of use here: &$bounce_recipient$& is set to
34738 the recipient of an error message while it is being created, and
34739 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
34740 option, rounded to a whole number.
34741
34742 The items must appear in the file in the following order:
34743
34744 .ilist
34745 The first item is included in the headers, and should include at least a
34746 &'Subject:'& header. Exim does not check the syntax of these headers.
34747 .next
34748 The second item forms the start of the error message. After it, Exim lists the
34749 failing addresses with their error messages.
34750 .next
34751 The third item is used to introduce any text from pipe transports that is to be
34752 returned to the sender. It is omitted if there is no such text.
34753 .next
34754 The fourth, fifth and sixth items will be ignored and may be empty.
34755 The fields exist for back-compatibility
34756 .endlist
34757
34758 The default state (&%bounce_message_file%& unset) is equivalent to the
34759 following file, in which the sixth item is empty. The &'Subject:'& and some
34760 other lines have been split in order to fit them on the page:
34761 .code
34762 Subject: Mail delivery failed
34763   ${if eq{$sender_address}{$bounce_recipient}
34764   {: returning message to sender}}
34765 ****
34766 This message was created automatically by mail delivery software.
34767
34768 A message ${if eq{$sender_address}{$bounce_recipient}
34769   {that you sent }{sent by
34770
34771 <$sender_address>
34772
34773 }}could not be delivered to all of its recipients.
34774 This is a permanent error. The following address(es) failed:
34775 ****
34776 The following text was generated during the delivery attempt(s):
34777 ****
34778 ------ This is a copy of the message, including all the headers.
34779   ------
34780 ****
34781 ------ The body of the message is $message_size characters long;
34782   only the first
34783 ------ $bounce_return_size_limit or so are included here.
34784 ****
34785 .endd
34786 .section "Customizing warning messages" "SECTcustwarn"
34787 .cindex "customizing" "warning message"
34788 .cindex "warning of delay" "customizing the message"
34789 The option &%warn_message_file%& can be pointed at a template file for use when
34790 warnings about message delays are created. In this case there are only three
34791 text sections:
34792
34793 .ilist
34794 The first item is included in the headers, and should include at least a
34795 &'Subject:'& header. Exim does not check the syntax of these headers.
34796 .next
34797 The second item forms the start of the warning message. After it, Exim lists
34798 the delayed addresses.
34799 .next
34800 The third item then ends the message.
34801 .endlist
34802
34803 The default state is equivalent to the following file, except that some lines
34804 have been split here, in order to fit them on the page:
34805 .code
34806 Subject: Warning: message $message_exim_id delayed
34807   $warn_message_delay
34808 ****
34809 This message was created automatically by mail delivery software.
34810
34811 A message ${if eq{$sender_address}{$warn_message_recipients}
34812 {that you sent }{sent by
34813
34814 <$sender_address>
34815
34816 }}has not been delivered to all of its recipients after
34817 more than $warn_message_delay on the queue on $primary_hostname.
34818
34819 The message identifier is:     $message_exim_id
34820 The subject of the message is: $h_subject
34821 The date of the message is:    $h_date
34822
34823 The following address(es) have not yet been delivered:
34824 ****
34825 No action is required on your part. Delivery attempts will
34826 continue for some time, and this warning may be repeated at
34827 intervals if the message remains undelivered. Eventually the
34828 mail delivery software will give up, and when that happens,
34829 the message will be returned to you.
34830 .endd
34831 .vindex "&$warn_message_delay$&"
34832 .vindex "&$warn_message_recipients$&"
34833 However, in the default state the subject and date lines are omitted if no
34834 appropriate headers exist. During the expansion of this file,
34835 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
34836 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
34837 of recipients for the warning message. There may be more than one if there are
34838 multiple addresses with different &%errors_to%& settings on the routers that
34839 handled them.
34840
34841
34842
34843
34844 . ////////////////////////////////////////////////////////////////////////////
34845 . ////////////////////////////////////////////////////////////////////////////
34846
34847 .chapter "Some common configuration settings" "CHAPcomconreq"
34848 This chapter discusses some configuration settings that seem to be fairly
34849 common. More examples and discussion can be found in the Exim book.
34850
34851
34852
34853 .section "Sending mail to a smart host" "SECID240"
34854 .cindex "smart host" "example router"
34855 If you want to send all mail for non-local domains to a &"smart host"&, you
34856 should replace the default &(dnslookup)& router with a router which does the
34857 routing explicitly:
34858 .code
34859 send_to_smart_host:
34860   driver = manualroute
34861   route_list = !+local_domains smart.host.name
34862   transport = remote_smtp
34863 .endd
34864 You can use the smart host's IP address instead of the name if you wish.
34865 If you are using Exim only to submit messages to a smart host, and not for
34866 receiving incoming messages, you can arrange for it to do the submission
34867 synchronously by setting the &%mua_wrapper%& option (see chapter
34868 &<<CHAPnonqueueing>>&).
34869
34870
34871
34872
34873 .section "Using Exim to handle mailing lists" "SECTmailinglists"
34874 .cindex "mailing lists"
34875 Exim can be used to run simple mailing lists, but for large and/or complicated
34876 requirements, the use of additional specialized mailing list software such as
34877 Majordomo or Mailman is recommended.
34878
34879 The &(redirect)& router can be used to handle mailing lists where each list
34880 is maintained in a separate file, which can therefore be managed by an
34881 independent manager. The &%domains%& router option can be used to run these
34882 lists in a separate domain from normal mail. For example:
34883 .code
34884 lists:
34885   driver = redirect
34886   domains = lists.example
34887   file = /usr/lists/$local_part
34888   forbid_pipe
34889   forbid_file
34890   errors_to = $local_part-request@lists.example
34891   no_more
34892 .endd
34893 This router is skipped for domains other than &'lists.example'&. For addresses
34894 in that domain, it looks for a file that matches the local part. If there is no
34895 such file, the router declines, but because &%no_more%& is set, no subsequent
34896 routers are tried, and so the whole delivery fails.
34897
34898 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
34899 expanded into a file name or a pipe delivery, which is usually inappropriate in
34900 a mailing list.
34901
34902 .oindex "&%errors_to%&"
34903 The &%errors_to%& option specifies that any delivery errors caused by addresses
34904 taken from a mailing list are to be sent to the given address rather than the
34905 original sender of the message. However, before acting on this, Exim verifies
34906 the error address, and ignores it if verification fails.
34907
34908 For example, using the configuration above, mail sent to
34909 &'dicts@lists.example'& is passed on to those addresses contained in
34910 &_/usr/lists/dicts_&, with error reports directed to
34911 &'dicts-request@lists.example'&, provided that this address can be verified.
34912 There could be a file called &_/usr/lists/dicts-request_& containing
34913 the address(es) of this particular list's manager(s), but other approaches,
34914 such as setting up an earlier router (possibly using the &%local_part_prefix%&
34915 or &%local_part_suffix%& options) to handle addresses of the form
34916 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
34917
34918
34919
34920 .section "Syntax errors in mailing lists" "SECID241"
34921 .cindex "mailing lists" "syntax errors in"
34922 If an entry in redirection data contains a syntax error, Exim normally defers
34923 delivery of the original address. That means that a syntax error in a mailing
34924 list holds up all deliveries to the list. This may not be appropriate when a
34925 list is being maintained automatically from data supplied by users, and the
34926 addresses are not rigorously checked.
34927
34928 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
34929 entries that fail to parse, noting the incident in the log. If in addition
34930 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
34931 whenever a broken address is skipped. It is usually appropriate to set
34932 &%syntax_errors_to%& to the same address as &%errors_to%&.
34933
34934
34935
34936 .section "Re-expansion of mailing lists" "SECID242"
34937 .cindex "mailing lists" "re-expansion of"
34938 Exim remembers every individual address to which a message has been delivered,
34939 in order to avoid duplication, but it normally stores only the original
34940 recipient addresses with a message. If all the deliveries to a mailing list
34941 cannot be done at the first attempt, the mailing list is re-expanded when the
34942 delivery is next tried. This means that alterations to the list are taken into
34943 account at each delivery attempt, so addresses that have been added to
34944 the list since the message arrived will therefore receive a copy of the
34945 message, even though it pre-dates their subscription.
34946
34947 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
34948 on the &(redirect)& router. If this is done, any addresses generated by the
34949 router that fail to deliver at the first attempt are added to the message as
34950 &"top level"& addresses, and the parent address that generated them is marked
34951 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
34952 subsequent delivery attempts. The disadvantage of this is that if any of the
34953 failing addresses are incorrect, correcting them in the file has no effect on
34954 pre-existing messages.
34955
34956 The original top-level address is remembered with each of the generated
34957 addresses, and is output in any log messages. However, any intermediate parent
34958 addresses are not recorded. This makes a difference to the log only if the
34959 &%all_parents%& selector is set, but for mailing lists there is normally only
34960 one level of expansion anyway.
34961
34962
34963
34964 .section "Closed mailing lists" "SECID243"
34965 .cindex "mailing lists" "closed"
34966 The examples so far have assumed open mailing lists, to which anybody may
34967 send mail. It is also possible to set up closed lists, where mail is accepted
34968 from specified senders only. This is done by making use of the generic
34969 &%senders%& option to restrict the router that handles the list.
34970
34971 The following example uses the same file as a list of recipients and as a list
34972 of permitted senders. It requires three routers:
34973 .code
34974 lists_request:
34975   driver = redirect
34976   domains = lists.example
34977   local_part_suffix = -request
34978   file = /usr/lists/$local_part$local_part_suffix
34979   no_more
34980
34981 lists_post:
34982   driver = redirect
34983   domains = lists.example
34984   senders = ${if exists {/usr/lists/$local_part}\
34985              {lsearch;/usr/lists/$local_part}{*}}
34986   file = /usr/lists/$local_part
34987   forbid_pipe
34988   forbid_file
34989   errors_to = $local_part-request@lists.example
34990   no_more
34991
34992 lists_closed:
34993   driver = redirect
34994   domains = lists.example
34995   allow_fail
34996   data = :fail: $local_part@lists.example is a closed mailing list
34997 .endd
34998 All three routers have the same &%domains%& setting, so for any other domains,
34999 they are all skipped. The first router runs only if the local part ends in
35000 &%-request%&. It handles messages to the list manager(s) by means of an open
35001 mailing list.
35002
35003 The second router runs only if the &%senders%& precondition is satisfied. It
35004 checks for the existence of a list that corresponds to the local part, and then
35005 checks that the sender is on the list by means of a linear search. It is
35006 necessary to check for the existence of the file before trying to search it,
35007 because otherwise Exim thinks there is a configuration error. If the file does
35008 not exist, the expansion of &%senders%& is *, which matches all senders. This
35009 means that the router runs, but because there is no list, declines, and
35010 &%no_more%& ensures that no further routers are run. The address fails with an
35011 &"unrouteable address"& error.
35012
35013 The third router runs only if the second router is skipped, which happens when
35014 a mailing list exists, but the sender is not on it. This router forcibly fails
35015 the address, giving a suitable error message.
35016
35017
35018
35019
35020 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
35021 .cindex "VERP"
35022 .cindex "Variable Envelope Return Paths"
35023 .cindex "envelope sender"
35024 Variable Envelope Return Paths &-- see &url(http://cr.yp.to/proto/verp.txt) &--
35025 are a way of helping mailing list administrators discover which subscription
35026 address is the cause of a particular delivery failure. The idea is to encode
35027 the original recipient address in the outgoing envelope sender address, so that
35028 if the message is forwarded by another host and then subsequently bounces, the
35029 original recipient can be extracted from the recipient address of the bounce.
35030
35031 .oindex &%errors_to%&
35032 .oindex &%return_path%&
35033 Envelope sender addresses can be modified by Exim using two different
35034 facilities: the &%errors_to%& option on a router (as shown in previous mailing
35035 list examples), or the &%return_path%& option on a transport. The second of
35036 these is effective only if the message is successfully delivered to another
35037 host; it is not used for errors detected on the local host (see the description
35038 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
35039 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
35040 .code
35041 verp_smtp:
35042   driver = smtp
35043   max_rcpt = 1
35044   return_path = \
35045     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35046       {$1-request+$local_part=$domain@your.dom.example}fail}
35047 .endd
35048 This has the effect of rewriting the return path (envelope sender) on outgoing
35049 SMTP messages, if the local part of the original return path ends in
35050 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
35051 local part and domain of the recipient into the return path. Suppose, for
35052 example, that a message whose return path has been set to
35053 &'somelist-request@your.dom.example'& is sent to
35054 &'subscriber@other.dom.example'&. In the transport, the return path is
35055 rewritten as
35056 .code
35057 somelist-request+subscriber=other.dom.example@your.dom.example
35058 .endd
35059 .vindex "&$local_part$&"
35060 For this to work, you must tell Exim to send multiple copies of messages that
35061 have more than one recipient, so that each copy has just one recipient. This is
35062 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
35063 might be sent to several different recipients in the same domain, in which case
35064 &$local_part$& is not available in the transport, because it is not unique.
35065
35066 Unless your host is doing nothing but mailing list deliveries, you should
35067 probably use a separate transport for the VERP deliveries, so as not to use
35068 extra resources in making one-per-recipient copies for other deliveries. This
35069 can easily be done by expanding the &%transport%& option in the router:
35070 .code
35071 dnslookup:
35072   driver = dnslookup
35073   domains = ! +local_domains
35074   transport = \
35075     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
35076       {verp_smtp}{remote_smtp}}
35077   no_more
35078 .endd
35079 If you want to change the return path using &%errors_to%& in a router instead
35080 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
35081 routers that handle mailing list addresses. This will ensure that all delivery
35082 errors, including those detected on the local host, are sent to the VERP
35083 address.
35084
35085 On a host that does no local deliveries and has no manual routing, only the
35086 &(dnslookup)& router needs to be changed. A special transport is not needed for
35087 SMTP deliveries. Every mailing list recipient has its own return path value,
35088 and so Exim must hand them to the transport one at a time. Here is an example
35089 of a &(dnslookup)& router that implements VERP:
35090 .code
35091 verp_dnslookup:
35092   driver = dnslookup
35093   domains = ! +local_domains
35094   transport = remote_smtp
35095   errors_to = \
35096     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
35097      {$1-request+$local_part=$domain@your.dom.example}fail}
35098   no_more
35099 .endd
35100 Before you start sending out messages with VERPed return paths, you must also
35101 configure Exim to accept the bounce messages that come back to those paths.
35102 Typically this is done by setting a &%local_part_suffix%& option for a
35103 router, and using this to route the messages to wherever you want to handle
35104 them.
35105
35106 The overhead incurred in using VERP depends very much on the size of the
35107 message, the number of recipient addresses that resolve to the same remote
35108 host, and the speed of the connection over which the message is being sent. If
35109 a lot of addresses resolve to the same host and the connection is slow, sending
35110 a separate copy of the message for each address may take substantially longer
35111 than sending a single copy with many recipients (for which VERP cannot be
35112 used).
35113
35114
35115
35116
35117
35118
35119 .section "Virtual domains" "SECTvirtualdomains"
35120 .cindex "virtual domains"
35121 .cindex "domain" "virtual"
35122 The phrase &'virtual domain'& is unfortunately used with two rather different
35123 meanings:
35124
35125 .ilist
35126 A domain for which there are no real mailboxes; all valid local parts are
35127 aliases for other email addresses. Common examples are organizational
35128 top-level domains and &"vanity"& domains.
35129 .next
35130 One of a number of independent domains that are all handled by the same host,
35131 with mailboxes on that host, but where the mailbox owners do not necessarily
35132 have login accounts on that host.
35133 .endlist
35134
35135 The first usage is probably more common, and does seem more &"virtual"& than
35136 the second. This kind of domain can be handled in Exim with a straightforward
35137 aliasing router. One approach is to create a separate alias file for each
35138 virtual domain. Exim can test for the existence of the alias file to determine
35139 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
35140 to a router of this form:
35141 .code
35142 virtual:
35143   driver = redirect
35144   domains = dsearch;/etc/mail/virtual
35145   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
35146   no_more
35147 .endd
35148 The &%domains%& option specifies that the router is to be skipped, unless there
35149 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
35150 domain that is being processed. When the router runs, it looks up the local
35151 part in the file to find a new address (or list of addresses). The &%no_more%&
35152 setting ensures that if the lookup fails (leading to &%data%& being an empty
35153 string), Exim gives up on the address without trying any subsequent routers.
35154
35155 This one router can handle all the virtual domains because the alias file names
35156 follow a fixed pattern. Permissions can be arranged so that appropriate people
35157 can edit the different alias files. A successful aliasing operation results in
35158 a new envelope recipient address, which is then routed from scratch.
35159
35160 The other kind of &"virtual"& domain can also be handled in a straightforward
35161 way. One approach is to create a file for each domain containing a list of
35162 valid local parts, and use it in a router like this:
35163 .code
35164 my_domains:
35165   driver = accept
35166   domains = dsearch;/etc/mail/domains
35167   local_parts = lsearch;/etc/mail/domains/$domain
35168   transport = my_mailboxes
35169 .endd
35170 The address is accepted if there is a file for the domain, and the local part
35171 can be found in the file. The &%domains%& option is used to check for the
35172 file's existence because &%domains%& is tested before the &%local_parts%&
35173 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
35174 because that option is tested after &%local_parts%&. The transport is as
35175 follows:
35176 .code
35177 my_mailboxes:
35178   driver = appendfile
35179   file = /var/mail/$domain/$local_part
35180   user = mail
35181 .endd
35182 This uses a directory of mailboxes for each domain. The &%user%& setting is
35183 required, to specify which uid is to be used for writing to the mailboxes.
35184
35185 The configuration shown here is just one example of how you might support this
35186 requirement. There are many other ways this kind of configuration can be set
35187 up, for example, by using a database instead of separate files to hold all the
35188 information about the domains.
35189
35190
35191
35192 .section "Multiple user mailboxes" "SECTmulbox"
35193 .cindex "multiple mailboxes"
35194 .cindex "mailbox" "multiple"
35195 .cindex "local part" "prefix"
35196 .cindex "local part" "suffix"
35197 Heavy email users often want to operate with multiple mailboxes, into which
35198 incoming mail is automatically sorted. A popular way of handling this is to
35199 allow users to use multiple sender addresses, so that replies can easily be
35200 identified. Users are permitted to add prefixes or suffixes to their local
35201 parts for this purpose. The wildcard facility of the generic router options
35202 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
35203 example, consider this router:
35204 .code
35205 userforward:
35206   driver = redirect
35207   check_local_user
35208   file = $home/.forward
35209   local_part_suffix = -*
35210   local_part_suffix_optional
35211   allow_filter
35212 .endd
35213 .vindex "&$local_part_suffix$&"
35214 It runs a user's &_.forward_& file for all local parts of the form
35215 &'username-*'&. Within the filter file the user can distinguish different
35216 cases by testing the variable &$local_part_suffix$&. For example:
35217 .code
35218 if $local_part_suffix contains -special then
35219 save /home/$local_part/Mail/special
35220 endif
35221 .endd
35222 If the filter file does not exist, or does not deal with such addresses, they
35223 fall through to subsequent routers, and, assuming no subsequent use of the
35224 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
35225 control over which suffixes are valid.
35226
35227 Alternatively, a suffix can be used to trigger the use of a different
35228 &_.forward_& file &-- which is the way a similar facility is implemented in
35229 another MTA:
35230 .code
35231 userforward:
35232   driver = redirect
35233   check_local_user
35234   file = $home/.forward$local_part_suffix
35235   local_part_suffix = -*
35236   local_part_suffix_optional
35237   allow_filter
35238 .endd
35239 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
35240 example, &_.forward-special_& is used. Once again, if the appropriate file
35241 does not exist, or does not deal with the address, it is passed on to
35242 subsequent routers, which could, if required, look for an unqualified
35243 &_.forward_& file to use as a default.
35244
35245
35246
35247 .section "Simplified vacation processing" "SECID244"
35248 .cindex "vacation processing"
35249 The traditional way of running the &'vacation'& program is for a user to set up
35250 a pipe command in a &_.forward_& file
35251 (see section &<<SECTspecitredli>>& for syntax details).
35252 This is prone to error by inexperienced users. There are two features of Exim
35253 that can be used to make this process simpler for users:
35254
35255 .ilist
35256 A local part prefix such as &"vacation-"& can be specified on a router which
35257 can cause the message to be delivered directly to the &'vacation'& program, or
35258 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
35259 &_.forward_& file are then much simpler. For example:
35260 .code
35261 spqr, vacation-spqr
35262 .endd
35263 .next
35264 The &%require_files%& generic router option can be used to trigger a
35265 vacation delivery by checking for the existence of a certain file in the
35266 user's home directory. The &%unseen%& generic option should also be used, to
35267 ensure that the original delivery also proceeds. In this case, all the user has
35268 to do is to create a file called, say, &_.vacation_&, containing a vacation
35269 message.
35270 .endlist
35271
35272 Another advantage of both these methods is that they both work even when the
35273 use of arbitrary pipes by users is locked out.
35274
35275
35276
35277 .section "Taking copies of mail" "SECID245"
35278 .cindex "message" "copying every"
35279 Some installations have policies that require archive copies of all messages to
35280 be made. A single copy of each message can easily be taken by an appropriate
35281 command in a system filter, which could, for example, use a different file for
35282 each day's messages.
35283
35284 There is also a shadow transport mechanism that can be used to take copies of
35285 messages that are successfully delivered by local transports, one copy per
35286 delivery. This could be used, &'inter alia'&, to implement automatic
35287 notification of delivery by sites that insist on doing such things.
35288
35289
35290
35291 .section "Intermittently connected hosts" "SECID246"
35292 .cindex "intermittently connected hosts"
35293 It has become quite common (because it is cheaper) for hosts to connect to the
35294 Internet periodically rather than remain connected all the time. The normal
35295 arrangement is that mail for such hosts accumulates on a system that is
35296 permanently connected.
35297
35298 Exim was designed for use on permanently connected hosts, and so it is not
35299 particularly well-suited to use in an intermittently connected environment.
35300 Nevertheless there are some features that can be used.
35301
35302
35303 .section "Exim on the upstream server host" "SECID247"
35304 It is tempting to arrange for incoming mail for the intermittently connected
35305 host to remain on Exim's queue until the client connects. However, this
35306 approach does not scale very well. Two different kinds of waiting message are
35307 being mixed up in the same queue &-- those that cannot be delivered because of
35308 some temporary problem, and those that are waiting for their destination host
35309 to connect. This makes it hard to manage the queue, as well as wasting
35310 resources, because each queue runner scans the entire queue.
35311
35312 A better approach is to separate off those messages that are waiting for an
35313 intermittently connected host. This can be done by delivering these messages
35314 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
35315 format, from where they are transmitted by other software when their
35316 destination connects. This makes it easy to collect all the mail for one host
35317 in a single directory, and to apply local timeout rules on a per-message basis
35318 if required.
35319
35320 On a very small scale, leaving the mail on Exim's queue can be made to work. If
35321 you are doing this, you should configure Exim with a long retry period for the
35322 intermittent host. For example:
35323 .code
35324 cheshire.wonderland.fict.example    *   F,5d,24h
35325 .endd
35326 This stops a lot of failed delivery attempts from occurring, but Exim remembers
35327 which messages it has queued up for that host. Once the intermittent host comes
35328 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
35329 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
35330 causes all the queued up messages to be delivered, often down a single SMTP
35331 connection. While the host remains connected, any new messages get delivered
35332 immediately.
35333
35334 If the connecting hosts do not have fixed IP addresses, that is, if a host is
35335 issued with a different IP address each time it connects, Exim's retry
35336 mechanisms on the holding host get confused, because the IP address is normally
35337 used as part of the key string for holding retry information. This can be
35338 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
35339 Since this has disadvantages for permanently connected hosts, it is best to
35340 arrange a separate transport for the intermittently connected ones.
35341
35342
35343
35344 .section "Exim on the intermittently connected client host" "SECID248"
35345 The value of &%smtp_accept_queue_per_connection%& should probably be
35346 increased, or even set to zero (that is, disabled) on the intermittently
35347 connected host, so that all incoming messages down a single connection get
35348 delivered immediately.
35349
35350 .cindex "SMTP" "passed connection"
35351 .cindex "SMTP" "multiple deliveries"
35352 .cindex "multiple SMTP deliveries"
35353 Mail waiting to be sent from an intermittently connected host will probably
35354 not have been routed, because without a connection DNS lookups are not
35355 possible. This means that if a normal queue run is done at connection time,
35356 each message is likely to be sent in a separate SMTP session. This can be
35357 avoided by starting the queue run with a command line option beginning with
35358 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
35359 first pass, routing is done but no deliveries take place. The second pass is a
35360 normal queue run; since all the messages have been previously routed, those
35361 destined for the same host are likely to get sent as multiple deliveries in a
35362 single SMTP connection.
35363
35364
35365
35366 . ////////////////////////////////////////////////////////////////////////////
35367 . ////////////////////////////////////////////////////////////////////////////
35368
35369 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
35370          "Exim as a non-queueing client"
35371 .cindex "client, non-queueing"
35372 .cindex "smart host" "suppressing queueing"
35373 On a personal computer, it is a common requirement for all
35374 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
35375 configured to operate that way, for all the popular operating systems.
35376 However, there are some MUAs for Unix-like systems that cannot be so
35377 configured: they submit messages using the command line interface of
35378 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
35379 messages this way.
35380
35381 If the personal computer runs continuously, there is no problem, because it can
35382 run a conventional MTA that handles delivery to the smart host, and deal with
35383 any delays via its queueing mechanism. However, if the computer does not run
35384 continuously or runs different operating systems at different times, queueing
35385 email is not desirable.
35386
35387 There is therefore a requirement for something that can provide the
35388 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
35389 any queueing or retrying facilities. Furthermore, the delivery to the smart
35390 host should be synchronous, so that if it fails, the sending MUA is immediately
35391 informed. In other words, we want something that extends an MUA that submits
35392 to a local MTA via the command line so that it behaves like one that submits
35393 to a remote smart host using TCP/SMTP.
35394
35395 There are a number of applications (for example, there is one called &'ssmtp'&)
35396 that do this job. However, people have found them to be lacking in various
35397 ways. For instance, you might want to allow aliasing and forwarding to be done
35398 before sending a message to the smart host.
35399
35400 Exim already had the necessary infrastructure for doing this job. Just a few
35401 tweaks were needed to make it behave as required, though it is somewhat of an
35402 overkill to use a fully-featured MTA for this purpose.
35403
35404 .oindex "&%mua_wrapper%&"
35405 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
35406 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
35407 assumes that it is being used to &"wrap"& a command-line MUA in the manner
35408 just described. As well as setting &%mua_wrapper%&, you also need to provide a
35409 compatible router and transport configuration. Typically there will be just one
35410 router and one transport, sending everything to a smart host.
35411
35412 When run in MUA wrapping mode, the behaviour of Exim changes in the
35413 following ways:
35414
35415 .ilist
35416 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
35417 In other words, the only way to submit messages is via the command line.
35418 .next
35419 Each message is synchronously delivered as soon as it is received (&%-odi%& is
35420 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
35421 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
35422 does not finish until the delivery attempt is complete. If the delivery is
35423 successful, a zero return code is given.
35424 .next
35425 Address redirection is permitted, but the final routing for all addresses must
35426 be to the same remote transport, and to the same list of hosts. Furthermore,
35427 the return address (envelope sender) must be the same for all recipients, as
35428 must any added or deleted header lines. In other words, it must be possible to
35429 deliver the message in a single SMTP transaction, however many recipients there
35430 are.
35431 .next
35432 If these conditions are not met, or if routing any address results in a
35433 failure or defer status, or if Exim is unable to deliver all the recipients
35434 successfully to one of the smart hosts, delivery of the entire message fails.
35435 .next
35436 Because no queueing is allowed, all failures are treated as permanent; there
35437 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
35438 smart host. Furthermore, because only a single yes/no response can be given to
35439 the caller, it is not possible to deliver to some recipients and not others. If
35440 there is an error (temporary or permanent) for any recipient, all are failed.
35441 .next
35442 If more than one smart host is listed, Exim will try another host after a
35443 connection failure or a timeout, in the normal way. However, if this kind of
35444 failure happens for all the hosts, the delivery fails.
35445 .next
35446 When delivery fails, an error message is written to the standard error stream
35447 (as well as to Exim's log), and Exim exits to the caller with a return code
35448 value 1. The message is expunged from Exim's spool files. No bounce messages
35449 are ever generated.
35450 .next
35451 No retry data is maintained, and any retry rules are ignored.
35452 .next
35453 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
35454 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
35455 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
35456 .endlist
35457
35458 The overall effect is that Exim makes a single synchronous attempt to deliver
35459 the message, failing if there is any kind of problem. Because no local
35460 deliveries are done and no daemon can be run, Exim does not need root
35461 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
35462 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
35463 the advantages and disadvantages of running without root privilege.
35464
35465
35466
35467
35468 . ////////////////////////////////////////////////////////////////////////////
35469 . ////////////////////////////////////////////////////////////////////////////
35470
35471 .chapter "Log files" "CHAPlog"
35472 .scindex IIDloggen "log" "general description"
35473 .cindex "log" "types of"
35474 Exim writes three different logs, referred to as the main log, the reject log,
35475 and the panic log:
35476
35477 .ilist
35478 .cindex "main log"
35479 The main log records the arrival of each message and each delivery in a single
35480 line in each case. The format is as compact as possible, in an attempt to keep
35481 down the size of log files. Two-character flag sequences make it easy to pick
35482 out these lines. A number of other events are recorded in the main log. Some of
35483 them are optional, in which case the &%log_selector%& option controls whether
35484 they are included or not. A Perl script called &'eximstats'&, which does simple
35485 analysis of main log files, is provided in the Exim distribution (see section
35486 &<<SECTmailstat>>&).
35487 .next
35488 .cindex "reject log"
35489 The reject log records information from messages that are rejected as a result
35490 of a configuration option (that is, for policy reasons).
35491 The first line of each rejection is a copy of the line that is also written to
35492 the main log. Then, if the message's header has been read at the time the log
35493 is written, its contents are written to this log. Only the original header
35494 lines are available; header lines added by ACLs are not logged. You can use the
35495 reject log to check that your policy controls are working correctly; on a busy
35496 host this may be easier than scanning the main log for rejection messages. You
35497 can suppress the writing of the reject log by setting &%write_rejectlog%&
35498 false.
35499 .next
35500 .cindex "panic log"
35501 .cindex "system log"
35502 When certain serious errors occur, Exim writes entries to its panic log. If the
35503 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
35504 are usually written to the main log as well, but can get lost amid the mass of
35505 other entries. The panic log should be empty under normal circumstances. It is
35506 therefore a good idea to check it (or to have a &'cron'& script check it)
35507 regularly, in order to become aware of any problems. When Exim cannot open its
35508 panic log, it tries as a last resort to write to the system log (syslog). This
35509 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
35510 message itself is written at priority LOG_CRIT.
35511 .endlist
35512
35513 Every log line starts with a timestamp, in the format shown in the following
35514 example. Note that many of the examples shown in this chapter are line-wrapped.
35515 In the log file, this would be all on one line:
35516 .code
35517 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
35518   by QUIT
35519 .endd
35520 By default, the timestamps are in the local timezone. There are two
35521 ways of changing this:
35522
35523 .ilist
35524 You can set the &%timezone%& option to a different time zone; in particular, if
35525 you set
35526 .code
35527 timezone = UTC
35528 .endd
35529 the timestamps will be in UTC (aka GMT).
35530 .next
35531 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
35532 example:
35533 .code
35534 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
35535 .endd
35536 .endlist
35537
35538 .cindex "log" "process ids in"
35539 .cindex "pid (process id)" "in log lines"
35540 Exim does not include its process id in log lines by default, but you can
35541 request that it does so by specifying the &`pid`& log selector (see section
35542 &<<SECTlogselector>>&). When this is set, the process id is output, in square
35543 brackets, immediately after the time and date.
35544
35545
35546
35547
35548 .section "Where the logs are written" "SECTwhelogwri"
35549 .cindex "log" "destination"
35550 .cindex "log" "to file"
35551 .cindex "log" "to syslog"
35552 .cindex "syslog"
35553 The logs may be written to local files, or to syslog, or both. However, it
35554 should be noted that many syslog implementations use UDP as a transport, and
35555 are therefore unreliable in the sense that messages are not guaranteed to
35556 arrive at the loghost, nor is the ordering of messages necessarily maintained.
35557 It has also been reported that on large log files (tens of megabytes) you may
35558 need to tweak syslog to prevent it syncing the file with each write &-- on
35559 Linux this has been seen to make syslog take 90% plus of CPU time.
35560
35561 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
35562 &_Local/Makefile_& or by setting &%log_file_path%& in the run time
35563 configuration. This latter string is expanded, so it can contain, for example,
35564 references to the host name:
35565 .code
35566 log_file_path = /var/log/$primary_hostname/exim_%slog
35567 .endd
35568 It is generally advisable, however, to set the string in &_Local/Makefile_&
35569 rather than at run time, because then the setting is available right from the
35570 start of Exim's execution. Otherwise, if there's something it wants to log
35571 before it has read the configuration file (for example, an error in the
35572 configuration file) it will not use the path you want, and may not be able to
35573 log at all.
35574
35575 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
35576 list, currently limited to at most two items. This is one option where the
35577 facility for changing a list separator may not be used. The list must always be
35578 colon-separated. If an item in the list is &"syslog"& then syslog is used;
35579 otherwise the item must either be an absolute path, containing &`%s`& at the
35580 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
35581 implying the use of a default path.
35582
35583 When Exim encounters an empty item in the list, it searches the list defined by
35584 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
35585 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
35586 mean &"use the path specified at build time"&. It no such item exists, log
35587 files are written in the &_log_& subdirectory of the spool directory. This is
35588 equivalent to the setting:
35589 .code
35590 log_file_path = $spool_directory/log/%slog
35591 .endd
35592 If you do not specify anything at build time or run time,
35593 or if you unset the option at run time (i.e. &`log_file_path = `&),
35594 that is where the logs are written.
35595
35596 A log file path may also contain &`%D`& or &`%M`& if datestamped log file names
35597 are in use &-- see section &<<SECTdatlogfil>>& below.
35598
35599 Here are some examples of possible settings:
35600 .display
35601 &`LOG_FILE_PATH=syslog                    `& syslog only
35602 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
35603 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
35604 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
35605 .endd
35606 If there are more than two paths in the list, the first is used and a panic
35607 error is logged.
35608
35609
35610
35611 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
35612 .cindex "log" "cycling local files"
35613 .cindex "cycling logs"
35614 .cindex "&'exicyclog'&"
35615 .cindex "log" "local files; writing to"
35616 Some operating systems provide centralized and standardized methods for cycling
35617 log files. For those that do not, a utility script called &'exicyclog'& is
35618 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
35619 main and reject logs each time it is called. The maximum number of old logs to
35620 keep can be set. It is suggested this script is run as a daily &'cron'& job.
35621
35622 An Exim delivery process opens the main log when it first needs to write to it,
35623 and it keeps the file open in case subsequent entries are required &-- for
35624 example, if a number of different deliveries are being done for the same
35625 message. However, remote SMTP deliveries can take a long time, and this means
35626 that the file may be kept open long after it is renamed if &'exicyclog'& or
35627 something similar is being used to rename log files on a regular basis. To
35628 ensure that a switch of log files is noticed as soon as possible, Exim calls
35629 &[stat()]& on the main log's name before reusing an open file, and if the file
35630 does not exist, or its inode has changed, the old file is closed and Exim
35631 tries to open the main log from scratch. Thus, an old log file may remain open
35632 for quite some time, but no Exim processes should write to it once it has been
35633 renamed.
35634
35635
35636
35637 .section "Datestamped log files" "SECTdatlogfil"
35638 .cindex "log" "datestamped files"
35639 Instead of cycling the main and reject log files by renaming them
35640 periodically, some sites like to use files whose names contain a datestamp,
35641 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
35642 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
35643 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
35644 point where the datestamp is required. For example:
35645 .code
35646 log_file_path = /var/spool/exim/log/%slog-%D
35647 log_file_path = /var/log/exim-%s-%D.log
35648 log_file_path = /var/spool/exim/log/%D-%slog
35649 log_file_path = /var/log/exim/%s.%M
35650 .endd
35651 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
35652 examples of names generated by the above examples:
35653 .code
35654 /var/spool/exim/log/mainlog-20021225
35655 /var/log/exim-reject-20021225.log
35656 /var/spool/exim/log/20021225-mainlog
35657 /var/log/exim/main.200212
35658 .endd
35659 When this form of log file is specified, Exim automatically switches to new
35660 files at midnight. It does not make any attempt to compress old logs; you
35661 will need to write your own script if you require this. You should not
35662 run &'exicyclog'& with this form of logging.
35663
35664 The location of the panic log is also determined by &%log_file_path%&, but it
35665 is not datestamped, because rotation of the panic log does not make sense.
35666 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
35667 the string. In addition, if it immediately follows a slash, a following
35668 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
35669 character is removed. Thus, the four examples above would give these panic
35670 log names:
35671 .code
35672 /var/spool/exim/log/paniclog
35673 /var/log/exim-panic.log
35674 /var/spool/exim/log/paniclog
35675 /var/log/exim/panic
35676 .endd
35677
35678
35679 .section "Logging to syslog" "SECID249"
35680 .cindex "log" "syslog; writing to"
35681 The use of syslog does not change what Exim logs or the format of its messages,
35682 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
35683 Exim's log lines are omitted when these lines are sent to syslog. Apart from
35684 that, the same strings are written to syslog as to log files. The syslog
35685 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
35686 by default, but you can change these by setting the &%syslog_facility%& and
35687 &%syslog_processname%& options, respectively. If Exim was compiled with
35688 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
35689 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
35690 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
35691 the time and host name to each line.
35692 The three log streams are mapped onto syslog priorities as follows:
35693
35694 .ilist
35695 &'mainlog'& is mapped to LOG_INFO
35696 .next
35697 &'rejectlog'& is mapped to LOG_NOTICE
35698 .next
35699 &'paniclog'& is mapped to LOG_ALERT
35700 .endlist
35701
35702 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
35703 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
35704 these are routed by syslog to the same place. You can suppress this duplication
35705 by setting &%syslog_duplication%& false.
35706
35707 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
35708 entries contain multiple lines when headers are included. To cope with both
35709 these cases, entries written to syslog are split into separate &[syslog()]&
35710 calls at each internal newline, and also after a maximum of
35711 870 data characters. (This allows for a total syslog line length of 1024, when
35712 additions such as timestamps are added.) If you are running a syslog
35713 replacement that can handle lines longer than the 1024 characters allowed by
35714 RFC 3164, you should set
35715 .code
35716 SYSLOG_LONG_LINES=yes
35717 .endd
35718 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
35719 lines, but it still splits at internal newlines in &'reject'& log entries.
35720
35721 To make it easy to re-assemble split lines later, each component of a split
35722 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
35723 where <&'n'&> is the component number and <&'m'&> is the total number of
35724 components in the entry. The / delimiter is used when the line was split
35725 because it was too long; if it was split because of an internal newline, the \
35726 delimiter is used. For example, supposing the length limit to be 50 instead of
35727 870, the following would be the result of a typical rejection message to
35728 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
35729 name, and pid as added by syslog:
35730 .code
35731 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
35732 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
35733 [3/5]  when scanning for sender: missing or malformed lo
35734 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
35735 [5/5] mple>)
35736 .endd
35737 The same error might cause the following lines to be written to &"rejectlog"&
35738 (LOG_NOTICE):
35739 .code
35740 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
35741 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
35742 [3/18] er when scanning for sender: missing or malformed
35743 [4/18]  local part in "<>" (envelope sender is <ph10@cam
35744 [5\18] .example>)
35745 [6\18] Recipients: ph10@some.domain.cam.example
35746 [7\18] P Received: from [127.0.0.1] (ident=ph10)
35747 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
35748 [9\18]        id 16RdAL-0006pc-00
35749 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
35750 [11\18] 09:43 +0100
35751 [12\18] F From: <>
35752 [13\18]   Subject: this is a test header
35753 [18\18]   X-something: this is another header
35754 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
35755 [16\18] le>
35756 [17\18] B Bcc:
35757 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
35758 .endd
35759 Log lines that are neither too long nor contain newlines are written to syslog
35760 without modification.
35761
35762 If only syslog is being used, the Exim monitor is unable to provide a log tail
35763 display, unless syslog is routing &'mainlog'& to a file on the local host and
35764 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
35765 where it is.
35766
35767
35768
35769 .section "Log line flags" "SECID250"
35770 One line is written to the main log for each message received, and for each
35771 successful, unsuccessful, and delayed delivery. These lines can readily be
35772 picked out by the distinctive two-character flags that immediately follow the
35773 timestamp. The flags are:
35774 .display
35775 &`<=`&     message arrival
35776 &`(=`&     message fakereject
35777 &`=>`&     normal message delivery
35778 &`->`&     additional address in same delivery
35779 &`>>`&     cutthrough message delivery
35780 &`*>`&     delivery suppressed by &%-N%&
35781 &`**`&     delivery failed; address bounced
35782 &`==`&     delivery deferred; temporary problem
35783 .endd
35784
35785
35786 .section "Logging message reception" "SECID251"
35787 .cindex "log" "reception line"
35788 The format of the single-line entry in the main log that is written for every
35789 message received is shown in the basic example below, which is split over
35790 several lines in order to fit it on the page:
35791 .code
35792 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
35793   H=mailer.fict.example [192.168.123.123] U=exim
35794   P=smtp S=5678 id=<incoming message id>
35795 .endd
35796 The address immediately following &"<="& is the envelope sender address. A
35797 bounce message is shown with the sender address &"<>"&, and if it is locally
35798 generated, this is followed by an item of the form
35799 .code
35800 R=<message id>
35801 .endd
35802 which is a reference to the message that caused the bounce to be sent.
35803
35804 .cindex "HELO"
35805 .cindex "EHLO"
35806 For messages from other hosts, the H and U fields identify the remote host and
35807 record the RFC 1413 identity of the user that sent the message, if one was
35808 received. The number given in square brackets is the IP address of the sending
35809 host. If there is a single, unparenthesized  host name in the H field, as
35810 above, it has been verified to correspond to the IP address (see the
35811 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
35812 by the remote host in the SMTP HELO or EHLO command, and has not been
35813 verified. If verification yields a different name to that given for HELO or
35814 EHLO, the verified name appears first, followed by the HELO or EHLO
35815 name in parentheses.
35816
35817 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
35818 without brackets, in the HELO or EHLO command, leading to entries in
35819 the log containing text like these examples:
35820 .code
35821 H=(10.21.32.43) [192.168.8.34]
35822 H=([10.21.32.43]) [192.168.8.34]
35823 .endd
35824 This can be confusing. Only the final address in square brackets can be relied
35825 on.
35826
35827 For locally generated messages (that is, messages not received over TCP/IP),
35828 the H field is omitted, and the U field contains the login name of the caller
35829 of Exim.
35830
35831 .cindex "authentication" "logging"
35832 .cindex "AUTH" "logging"
35833 For all messages, the P field specifies the protocol used to receive the
35834 message. This is the value that is stored in &$received_protocol$&. In the case
35835 of incoming SMTP messages, the value indicates whether or not any SMTP
35836 extensions (ESMTP), encryption, or authentication were used. If the SMTP
35837 session was encrypted, there is an additional X field that records the cipher
35838 suite that was used.
35839
35840 .cindex log protocol
35841 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
35842 hosts that have authenticated themselves using the SMTP AUTH command. The first
35843 value is used when the SMTP connection was encrypted (&"secure"&). In this case
35844 there is an additional item A= followed by the name of the authenticator that
35845 was used. If an authenticated identification was set up by the authenticator's
35846 &%server_set_id%& option, this is logged too, separated by a colon from the
35847 authenticator name.
35848
35849 .cindex "size" "of message"
35850 The id field records the existing message id, if present. The size of the
35851 received message is given by the S field. When the message is delivered,
35852 headers may be removed or added, so that the size of delivered copies of the
35853 message may not correspond with this value (and indeed may be different to each
35854 other).
35855
35856 The &%log_selector%& option can be used to request the logging of additional
35857 data when a message is received. See section &<<SECTlogselector>>& below.
35858
35859
35860
35861 .section "Logging deliveries" "SECID252"
35862 .cindex "log" "delivery line"
35863 The format of the single-line entry in the main log that is written for every
35864 delivery is shown in one of the examples below, for local and remote
35865 deliveries, respectively. Each example has been split into multiple lines in order
35866 to fit it on the page:
35867 .code
35868 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
35869   <marv@hitch.fict.example> R=localuser T=local_delivery
35870 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
35871   monk@holistic.fict.example R=dnslookup T=remote_smtp
35872   H=holistic.fict.example [192.168.234.234]
35873 .endd
35874 For ordinary local deliveries, the original address is given in angle brackets
35875 after the final delivery address, which might be a pipe or a file. If
35876 intermediate address(es) exist between the original and the final address, the
35877 last of these is given in parentheses after the final address. The R and T
35878 fields record the router and transport that were used to process the address.
35879
35880 If SMTP AUTH was used for the delivery there is an additional item A=
35881 followed by the name of the authenticator that was used.
35882 If an authenticated identification was set up by the authenticator's &%client_set_id%&
35883 option, this is logged too, separated by a colon from the authenticator name.
35884
35885 If a shadow transport was run after a successful local delivery, the log line
35886 for the successful delivery has an item added on the end, of the form
35887 .display
35888 &`ST=<`&&'shadow transport name'&&`>`&
35889 .endd
35890 If the shadow transport did not succeed, the error message is put in
35891 parentheses afterwards.
35892
35893 .cindex "asterisk" "after IP address"
35894 When more than one address is included in a single delivery (for example, two
35895 SMTP RCPT commands in one transaction) the second and subsequent addresses are
35896 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
35897 down a single SMTP connection, an asterisk follows the IP address in the log
35898 lines for the second and subsequent messages.
35899 .new
35900 When two or more messages are delivered down a single TLS connection, the
35901 DNS and some TLS-related information logged for the first message delivered
35902 will not be present in the log lines for the second and subsequent messages.
35903 TLS cipher information is still available.
35904 .wen
35905
35906 .cindex "delivery" "cutthrough; logging"
35907 .cindex "cutthrough" "logging"
35908 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
35909 line precedes the reception line, since cutthrough waits for a possible
35910 rejection from the destination in case it can reject the sourced item.
35911
35912 The generation of a reply message by a filter file gets logged as a
35913 &"delivery"& to the addressee, preceded by &">"&.
35914
35915 The &%log_selector%& option can be used to request the logging of additional
35916 data when a message is delivered. See section &<<SECTlogselector>>& below.
35917
35918
35919 .section "Discarded deliveries" "SECID253"
35920 .cindex "discarded messages"
35921 .cindex "message" "discarded"
35922 .cindex "delivery" "discarded; logging"
35923 When a message is discarded as a result of the command &"seen finish"& being
35924 obeyed in a filter file which generates no deliveries, a log entry of the form
35925 .code
35926 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
35927   <low.club@bridge.example> R=userforward
35928 .endd
35929 is written, to record why no deliveries are logged. When a message is discarded
35930 because it is aliased to &":blackhole:"& the log line is like this:
35931 .code
35932 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
35933   <hole@nowhere.example> R=blackhole_router
35934 .endd
35935
35936
35937 .section "Deferred deliveries" "SECID254"
35938 When a delivery is deferred, a line of the following form is logged:
35939 .code
35940 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
35941   R=dnslookup T=smtp defer (146): Connection refused
35942 .endd
35943 In the case of remote deliveries, the error is the one that was given for the
35944 last IP address that was tried. Details of individual SMTP failures are also
35945 written to the log, so the above line would be preceded by something like
35946 .code
35947 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
35948   mail1.endrest.example [192.168.239.239]: Connection refused
35949 .endd
35950 When a deferred address is skipped because its retry time has not been reached,
35951 a message is written to the log, but this can be suppressed by setting an
35952 appropriate value in &%log_selector%&.
35953
35954
35955
35956 .section "Delivery failures" "SECID255"
35957 .cindex "delivery" "failure; logging"
35958 If a delivery fails because an address cannot be routed, a line of the
35959 following form is logged:
35960 .code
35961 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
35962   <jim@trek99.example>: unknown mail domain
35963 .endd
35964 If a delivery fails at transport time, the router and transport are shown, and
35965 the response from the remote host is included, as in this example:
35966 .code
35967 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
35968   R=dnslookup T=remote_smtp: SMTP error from remote mailer
35969   after pipelined RCPT TO:<ace400@pb.example>: host
35970   pbmail3.py.example [192.168.63.111]: 553 5.3.0
35971   <ace400@pb.example>...Addressee unknown
35972 .endd
35973 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
35974 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
35975 disabling PIPELINING. The log lines for all forms of delivery failure are
35976 flagged with &`**`&.
35977
35978
35979
35980 .section "Fake deliveries" "SECID256"
35981 .cindex "delivery" "fake; logging"
35982 If a delivery does not actually take place because the &%-N%& option has been
35983 used to suppress it, a normal delivery line is written to the log, except that
35984 &"=>"& is replaced by &"*>"&.
35985
35986
35987
35988 .section "Completion" "SECID257"
35989 A line of the form
35990 .code
35991 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
35992 .endd
35993 is written to the main log when a message is about to be removed from the spool
35994 at the end of its processing.
35995
35996
35997
35998
35999 .section "Summary of Fields in Log Lines" "SECID258"
36000 .cindex "log" "summary of fields"
36001 A summary of the field identifiers that are used in log lines is shown in
36002 the following table:
36003 .display
36004 &`A   `&        authenticator name (and optional id and sender)
36005 &`C   `&        SMTP confirmation on delivery
36006 &`    `&        command list for &"no mail in SMTP session"&
36007 &`CV  `&        certificate verification status
36008 &`D   `&        duration of &"no mail in SMTP session"&
36009 &`DN  `&        distinguished name from peer certificate
36010 &`DS  `&        DNSSEC secured lookups
36011 &`DT  `&        on &`=>`& lines: time taken for a delivery
36012 &`F   `&        sender address (on delivery lines)
36013 &`H   `&        host name and IP address
36014 &`I   `&        local interface used
36015 &`K   `&        CHUNKING extension used
36016 &`id  `&        message id for incoming message
36017 &`M8S `&        8BITMIME status for incoming message
36018 &`P   `&        on &`<=`& lines: protocol used
36019 &`    `&        on &`=>`& and &`**`& lines: return path
36020 &`PRDR`&        PRDR extension used
36021 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
36022 &`Q   `&        alternate queue name
36023 &`QT  `&        on &`=>`& lines: time spent on queue so far
36024 &`    `&        on &"Completed"& lines: time spent on queue
36025 &`R   `&        on &`<=`& lines: reference for local bounce
36026 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
36027 &`S   `&        size of message in bytes
36028 &`SNI `&        server name indication from TLS client hello
36029 &`ST  `&        shadow transport name
36030 &`T   `&        on &`<=`& lines: message subject (topic)
36031 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
36032 &`U   `&        local user or RFC 1413 identity
36033 &`X   `&        TLS cipher suite
36034 .endd
36035
36036
36037 .section "Other log entries" "SECID259"
36038 Various other types of log entry are written from time to time. Most should be
36039 self-explanatory. Among the more common are:
36040
36041 .ilist
36042 .cindex "retry" "time not reached"
36043 &'retry time not reached'&&~&~An address previously suffered a temporary error
36044 during routing or local delivery, and the time to retry has not yet arrived.
36045 This message is not written to an individual message log file unless it happens
36046 during the first delivery attempt.
36047 .next
36048 &'retry time not reached for any host'&&~&~An address previously suffered
36049 temporary errors during remote delivery, and the retry time has not yet arrived
36050 for any of the hosts to which it is routed.
36051 .next
36052 .cindex "spool directory" "file locked"
36053 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
36054 some other Exim process is already working on the message. This can be quite
36055 common if queue running processes are started at frequent intervals. The
36056 &'exiwhat'& utility script can be used to find out what Exim processes are
36057 doing.
36058 .next
36059 .cindex "error" "ignored"
36060 &'error ignored'&&~&~There are several circumstances that give rise to this
36061 message:
36062 .olist
36063 Exim failed to deliver a bounce message whose age was greater than
36064 &%ignore_bounce_errors_after%&. The bounce was discarded.
36065 .next
36066 A filter file set up a delivery using the &"noerror"& option, and the delivery
36067 failed. The delivery was discarded.
36068 .next
36069 A delivery set up by a router configured with
36070 . ==== As this is a nested list, any displays it contains must be indented
36071 . ==== as otherwise they are too far to the left.
36072 .code
36073     errors_to = <>
36074 .endd
36075 failed. The delivery was discarded.
36076 .endlist olist
36077 .endlist ilist
36078
36079
36080
36081
36082
36083 .section "Reducing or increasing what is logged" "SECTlogselector"
36084 .cindex "log" "selectors"
36085 By setting the &%log_selector%& global option, you can disable some of Exim's
36086 default logging, or you can request additional logging. The value of
36087 &%log_selector%& is made up of names preceded by plus or minus characters. For
36088 example:
36089 .code
36090 log_selector = +arguments -retry_defer
36091 .endd
36092 The list of optional log items is in the following table, with the default
36093 selection marked by asterisks:
36094 .display
36095 &` 8bitmime                   `&  received 8BITMIME status
36096 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
36097 &` address_rewrite            `&  address rewriting
36098 &` all_parents                `&  all parents in => lines
36099 &` arguments                  `&  command line arguments
36100 &`*connection_reject          `&  connection rejections
36101 &`*delay_delivery             `&  immediate delivery delayed
36102 &` deliver_time               `&  time taken to perform delivery
36103 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
36104 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
36105 &` dnssec                     `&  DNSSEC secured lookups
36106 &`*etrn                       `&  ETRN commands
36107 &`*host_lookup_failed         `&  as it says
36108 &` ident_timeout              `&  timeout for ident connection
36109 &` incoming_interface         `&  local interface on <= and => lines
36110 &` incoming_port              `&  remote port on <= lines
36111 &`*lost_incoming_connection   `&  as it says (includes timeouts)
36112 &` outgoing_interface         `&  local interface on => lines
36113 &` outgoing_port              `&  add remote port to => lines
36114 &`*queue_run                  `&  start and end queue runs
36115 &` queue_time                 `&  time on queue for one recipient
36116 &` queue_time_overall         `&  time on queue for whole message
36117 &` pid                        `&  Exim process id
36118 &` proxy                      `&  proxy address on <= and => lines
36119 &` received_recipients        `&  recipients on <= lines
36120 &` received_sender            `&  sender on <= lines
36121 &`*rejected_header            `&  header contents on reject log
36122 &`*retry_defer                `&  &"retry time not reached"&
36123 &` return_path_on_delivery    `&  put return path on => and ** lines
36124 &` sender_on_delivery         `&  add sender to => lines
36125 &`*sender_verify_fail         `&  sender verification failures
36126 &`*size_reject                `&  rejection because too big
36127 &`*skip_delivery              `&  delivery skipped in a queue run
36128 &`*smtp_confirmation          `&  SMTP confirmation on => lines
36129 &` smtp_connection            `&  incoming SMTP connections
36130 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
36131 &` smtp_mailauth              `&  AUTH argument to MAIL commands
36132 &` smtp_no_mail               `&  session with no MAIL commands
36133 &` smtp_protocol_error        `&  SMTP protocol errors
36134 &` smtp_syntax_error          `&  SMTP syntax errors
36135 &` subject                    `&  contents of &'Subject:'& on <= lines
36136 &`*tls_certificate_verified   `&  certificate verification status
36137 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
36138 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
36139 &` tls_sni                    `&  TLS SNI on <= lines
36140 &` unknown_in_list            `&  DNS lookup failed in list match
36141
36142 &` all                        `&  all of the above
36143 .endd
36144 See also the &%slow_lookup_log%& main configuration option,
36145 section &<<SECID99>>&
36146
36147 More details on each of these items follows:
36148
36149 .ilist
36150 .cindex "8BITMIME"
36151 .cindex "log" "8BITMIME"
36152 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
36153 which may help in tracking down interoperability issues with ancient MTAs
36154 that are not 8bit clean.  This is added to the &"<="& line, tagged with
36155 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
36156 &`7BIT`& and &`8BITMIME`& respectively.
36157 .next
36158 .cindex "&%warn%& ACL verb" "log when skipping"
36159 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
36160 its conditions cannot be evaluated, a log line to this effect is written if
36161 this log selector is set.
36162 .next
36163 .cindex "log" "rewriting"
36164 .cindex "rewriting" "logging"
36165 &%address_rewrite%&: This applies both to global rewrites and per-transport
36166 rewrites, but not to rewrites in filters run as an unprivileged user (because
36167 such users cannot access the log).
36168 .next
36169 .cindex "log" "full parentage"
36170 &%all_parents%&: Normally only the original and final addresses are logged on
36171 delivery lines; with this selector, intermediate parents are given in
36172 parentheses between them.
36173 .next
36174 .cindex "log" "Exim arguments"
36175 .cindex "Exim arguments, logging"
36176 &%arguments%&: This causes Exim to write the arguments with which it was called
36177 to the main log, preceded by the current working directory. This is a debugging
36178 feature, added to make it easier to find out how certain MUAs call
36179 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
36180 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
36181 that are empty or that contain white space are quoted. Non-printing characters
36182 are shown as escape sequences. This facility cannot log unrecognized arguments,
36183 because the arguments are checked before the configuration file is read. The
36184 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
36185 between the caller and Exim.
36186 .next
36187 .cindex "log" "connection rejections"
36188 &%connection_reject%&: A log entry is written whenever an incoming SMTP
36189 connection is rejected, for whatever reason.
36190 .next
36191 .cindex "log" "delayed delivery"
36192 .cindex "delayed delivery, logging"
36193 &%delay_delivery%&: A log entry is written whenever a delivery process is not
36194 started for an incoming message because the load is too high or too many
36195 messages were received on one connection. Logging does not occur if no delivery
36196 process is started because &%queue_only%& is set or &%-odq%& was used.
36197 .next
36198 .cindex "log" "delivery duration"
36199 &%deliver_time%&: For each delivery, the amount of real time it has taken to
36200 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
36201 .next
36202 .cindex "log" "message size on delivery"
36203 .cindex "size" "of message"
36204 &%delivery_size%&: For each delivery, the size of message delivered is added to
36205 the &"=>"& line, tagged with S=.
36206 .next
36207 .cindex "log" "dnslist defer"
36208 .cindex "DNS list" "logging defer"
36209 .cindex "black list (DNS)"
36210 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
36211 DNS black list suffers a temporary error.
36212 .next
36213 .cindex log dnssec
36214 .cindex dnssec logging
36215 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
36216 dns lookups gave secure results a tag of DS is added.
36217 For acceptance this covers the reverse and forward lookups for host name verification.
36218 It does not cover helo-name verification.
36219 For delivery this covers the SRV, MX, A and/or AAAA lookups.
36220 .next
36221 .cindex "log" "ETRN commands"
36222 .cindex "ETRN" "logging"
36223 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
36224 is run to determine whether or not it is actually accepted. An invalid ETRN
36225 command, or one received within a message transaction is not logged by this
36226 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
36227 .next
36228 .cindex "log" "host lookup failure"
36229 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
36230 any addresses, or when a lookup of an IP address fails to find a host name, a
36231 log line is written. This logging does not apply to direct DNS lookups when
36232 routing email addresses, but it does apply to &"byname"& lookups.
36233 .next
36234 .cindex "log" "ident timeout"
36235 .cindex "RFC 1413" "logging timeout"
36236 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
36237 client's ident port times out.
36238 .next
36239 .cindex "log" "incoming interface"
36240 .cindex "log" "local interface"
36241 .cindex "log" "local address and port"
36242 .cindex "TCP/IP" "logging local address and port"
36243 .cindex "interface" "logging"
36244 &%incoming_interface%&: The interface on which a message was received is added
36245 to the &"<="& line as an IP address in square brackets, tagged by I= and
36246 followed by a colon and the port number. The local interface and port are also
36247 added to other SMTP log lines, for example &"SMTP connection from"&, to
36248 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
36249 The latter can be disabled by turning off the &%outgoing_interface%& option.
36250 .next
36251 .cindex log "incoming proxy address"
36252 .cindex proxy "logging proxy address"
36253 .cindex "TCP/IP" "logging proxy address"
36254 &%proxy%&: The internal (closest to the system running Exim) IP address
36255 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
36256 on a proxied connection
36257 or the &"=>"& line for a message delivered on a proxied connection.
36258 See &<<SECTproxyInbound>>& for more information.
36259 .next
36260 .cindex "log" "incoming remote port"
36261 .cindex "port" "logging remote"
36262 .cindex "TCP/IP" "logging incoming remote port"
36263 .vindex "&$sender_fullhost$&"
36264 .vindex "&$sender_rcvhost$&"
36265 &%incoming_port%&: The remote port number from which a message was received is
36266 added to log entries and &'Received:'& header lines, following the IP address
36267 in square brackets, and separated from it by a colon. This is implemented by
36268 changing the value that is put in the &$sender_fullhost$& and
36269 &$sender_rcvhost$& variables. Recording the remote port number has become more
36270 important with the widening use of NAT (see RFC 2505).
36271 .next
36272 .cindex "log" "dropped connection"
36273 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
36274 connection is unexpectedly dropped.
36275 .next
36276 .cindex "log" "outgoing interface"
36277 .cindex "log" "local interface"
36278 .cindex "log" "local address and port"
36279 .cindex "TCP/IP" "logging local address and port"
36280 .cindex "interface" "logging"
36281 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
36282 interface on which a message was sent is added to delivery lines as an I= tag
36283 followed by IP address in square brackets. You can disable this by turning
36284 off the &%outgoing_interface%& option.
36285 .next
36286 .cindex "log" "outgoing remote port"
36287 .cindex "port" "logging outgoint remote"
36288 .cindex "TCP/IP" "logging outgoing remote port"
36289 &%outgoing_port%&: The remote port number is added to delivery log lines (those
36290 containing => tags) following the IP address.
36291 The local port is also added if &%incoming_interface%& and
36292 &%outgoing_interface%& are both enabled.
36293 This option is not included in the default setting, because for most ordinary
36294 configurations, the remote port number is always 25 (the SMTP port), and the
36295 local port is a random ephemeral port.
36296 .next
36297 .cindex "log" "process ids in"
36298 .cindex "pid (process id)" "in log lines"
36299 &%pid%&: The current process id is added to every log line, in square brackets,
36300 immediately after the time and date.
36301 .next
36302 .cindex "log" "queue run"
36303 .cindex "queue runner" "logging"
36304 &%queue_run%&: The start and end of every queue run are logged.
36305 .next
36306 .cindex "log" "queue time"
36307 &%queue_time%&: The amount of time the message has been in the queue on the
36308 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
36309 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
36310 includes reception time as well as the delivery time for the current address.
36311 This means that it may be longer than the difference between the arrival and
36312 delivery log line times, because the arrival log line is not written until the
36313 message has been successfully received.
36314 .next
36315 &%queue_time_overall%&: The amount of time the message has been in the queue on
36316 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
36317 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
36318 message, so it includes reception time as well as the total delivery time.
36319 .next
36320 .cindex "log" "recipients"
36321 &%received_recipients%&: The recipients of a message are listed in the main log
36322 as soon as the message is received. The list appears at the end of the log line
36323 that is written when a message is received, preceded by the word &"for"&. The
36324 addresses are listed after they have been qualified, but before any rewriting
36325 has taken place.
36326 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
36327 in the list.
36328 .next
36329 .cindex "log" "sender reception"
36330 &%received_sender%&: The unrewritten original sender of a message is added to
36331 the end of the log line that records the message's arrival, after the word
36332 &"from"& (before the recipients if &%received_recipients%& is also set).
36333 .next
36334 .cindex "log" "header lines for rejection"
36335 &%rejected_header%&: If a message's header has been received at the time a
36336 rejection is written to the reject log, the complete header is added to the
36337 log. Header logging can be turned off individually for messages that are
36338 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
36339 .next
36340 .cindex "log" "retry defer"
36341 &%retry_defer%&: A log line is written if a delivery is deferred because a
36342 retry time has not yet been reached. However, this &"retry time not reached"&
36343 message is always omitted from individual message logs after the first delivery
36344 attempt.
36345 .next
36346 .cindex "log" "return path"
36347 &%return_path_on_delivery%&: The return path that is being transmitted with
36348 the message is included in delivery and bounce lines, using the tag P=.
36349 This is omitted if no delivery actually happens, for example, if routing fails,
36350 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
36351 .next
36352 .cindex "log" "sender on delivery"
36353 &%sender_on_delivery%&: The message's sender address is added to every delivery
36354 and bounce line, tagged by F= (for &"from"&).
36355 This is the original sender that was received with the message; it is not
36356 necessarily the same as the outgoing return path.
36357 .next
36358 .cindex "log" "sender verify failure"
36359 &%sender_verify_fail%&: If this selector is unset, the separate log line that
36360 gives details of a sender verification failure is not written. Log lines for
36361 the rejection of SMTP commands contain just &"sender verify failed"&, so some
36362 detail is lost.
36363 .next
36364 .cindex "log" "size rejection"
36365 &%size_reject%&: A log line is written whenever a message is rejected because
36366 it is too big.
36367 .next
36368 .cindex "log" "frozen messages; skipped"
36369 .cindex "frozen messages" "logging skipping"
36370 &%skip_delivery%&: A log line is written whenever a message is skipped during a
36371 queue run because it is frozen or because another process is already delivering
36372 it.
36373 .cindex "&""spool file is locked""&"
36374 The message that is written is &"spool file is locked"&.
36375 .next
36376 .cindex "log" "smtp confirmation"
36377 .cindex "SMTP" "logging confirmation"
36378 .cindex "LMTP" "logging confirmation"
36379 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
36380 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
36381 A number of MTAs (including Exim) return an identifying string in this
36382 response.
36383 .next
36384 .cindex "log" "SMTP connections"
36385 .cindex "SMTP" "logging connections"
36386 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
36387 established or closed, unless the connection is from a host that matches
36388 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
36389 only when the closure is unexpected.) This applies to connections from local
36390 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
36391 dropped in the middle of a message, a log line is always written, whether or
36392 not this selector is set, but otherwise nothing is written at the start and end
36393 of connections unless this selector is enabled.
36394
36395 For TCP/IP connections to an Exim daemon, the current number of connections is
36396 included in the log message for each new connection, but note that the count is
36397 reset if the daemon is restarted.
36398 Also, because connections are closed (and the closure is logged) in
36399 subprocesses, the count may not include connections that have been closed but
36400 whose termination the daemon has not yet noticed. Thus, while it is possible to
36401 match up the opening and closing of connections in the log, the value of the
36402 logged counts may not be entirely accurate.
36403 .next
36404 .cindex "log" "SMTP transaction; incomplete"
36405 .cindex "SMTP" "logging incomplete transactions"
36406 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
36407 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
36408 and the message sender plus any accepted recipients are included in the log
36409 line. This can provide evidence of dictionary attacks.
36410 .next
36411 .cindex "log" "non-MAIL SMTP sessions"
36412 .cindex "MAIL" "logging session without"
36413 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
36414 connection terminates without having issued a MAIL command. This includes both
36415 the case when the connection is dropped, and the case when QUIT is used. It
36416 does not include cases where the connection is rejected right at the start (by
36417 an ACL, or because there are too many connections, or whatever). These cases
36418 already have their own log lines.
36419
36420 The log line that is written contains the identity of the client in the usual
36421 way, followed by D= and a time, which records the duration of the connection.
36422 If the connection was authenticated, this fact is logged exactly as it is for
36423 an incoming message, with an A= item. If the connection was encrypted, CV=,
36424 DN=, and X= items may appear as they do for an incoming message, controlled by
36425 the same logging options.
36426
36427 Finally, if any SMTP commands were issued during the connection, a C= item
36428 is added to the line, listing the commands that were used. For example,
36429 .code
36430 C=EHLO,QUIT
36431 .endd
36432 shows that the client issued QUIT straight after EHLO. If there were fewer
36433 than 20 commands, they are all listed. If there were more than 20 commands,
36434 the last 20 are listed, preceded by &"..."&. However, with the default
36435 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
36436 have been aborted before 20 non-mail commands are processed.
36437 .next
36438 &%smtp_mailauth%&: A third subfield with the authenticated sender,
36439 colon-separated, is appended to the A= item for a message arrival or delivery
36440 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
36441 was accepted or used.
36442 .next
36443 .cindex "log" "SMTP protocol error"
36444 .cindex "SMTP" "logging protocol error"
36445 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
36446 encountered. Exim does not have perfect detection of all protocol errors
36447 because of transmission delays and the use of pipelining. If PIPELINING has
36448 been advertised to a client, an Exim server assumes that the client will use
36449 it, and therefore it does not count &"expected"& errors (for example, RCPT
36450 received after rejecting MAIL) as protocol errors.
36451 .next
36452 .cindex "SMTP" "logging syntax errors"
36453 .cindex "SMTP" "syntax errors; logging"
36454 .cindex "SMTP" "unknown command; logging"
36455 .cindex "log" "unknown SMTP command"
36456 .cindex "log" "SMTP syntax error"
36457 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
36458 encountered. An unrecognized command is treated as a syntax error. For an
36459 external connection, the host identity is given; for an internal connection
36460 using &%-bs%& the sender identification (normally the calling user) is given.
36461 .next
36462 .cindex "log" "subject"
36463 .cindex "subject, logging"
36464 &%subject%&: The subject of the message is added to the arrival log line,
36465 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
36466 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
36467 specifies whether characters with values greater than 127 should be logged
36468 unchanged, or whether they should be rendered as escape sequences.
36469 .next
36470 .cindex "log" "certificate verification"
36471 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
36472 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
36473 verified, and &`CV=no`& if not.
36474 .next
36475 .cindex "log" "TLS cipher"
36476 .cindex "TLS" "logging cipher"
36477 &%tls_cipher%&: When a message is sent or received over an encrypted
36478 connection, the cipher suite used is added to the log line, preceded by X=.
36479 .next
36480 .cindex "log" "TLS peer DN"
36481 .cindex "TLS" "logging peer DN"
36482 &%tls_peerdn%&: When a message is sent or received over an encrypted
36483 connection, and a certificate is supplied by the remote host, the peer DN is
36484 added to the log line, preceded by DN=.
36485 .next
36486 .cindex "log" "TLS SNI"
36487 .cindex "TLS" "logging SNI"
36488 &%tls_sni%&: When a message is received over an encrypted connection, and
36489 the remote host provided the Server Name Indication extension, the SNI is
36490 added to the log line, preceded by SNI=.
36491 .next
36492 .cindex "log" "DNS failure in list"
36493 &%unknown_in_list%&: This setting causes a log entry to be written when the
36494 result of a list match is failure because a DNS lookup failed.
36495 .endlist
36496
36497
36498 .section "Message log" "SECID260"
36499 .cindex "message" "log file for"
36500 .cindex "log" "message log; description of"
36501 .cindex "&_msglog_& directory"
36502 .oindex "&%preserve_message_logs%&"
36503 In addition to the general log files, Exim writes a log file for each message
36504 that it handles. The names of these per-message logs are the message ids, and
36505 they are kept in the &_msglog_& sub-directory of the spool directory. Each
36506 message log contains copies of the log lines that apply to the message. This
36507 makes it easier to inspect the status of an individual message without having
36508 to search the main log. A message log is deleted when processing of the message
36509 is complete, unless &%preserve_message_logs%& is set, but this should be used
36510 only with great care because they can fill up your disk very quickly.
36511
36512 On a heavily loaded system, it may be desirable to disable the use of
36513 per-message logs, in order to reduce disk I/O. This can be done by setting the
36514 &%message_logs%& option false.
36515 .ecindex IIDloggen
36516
36517
36518
36519
36520 . ////////////////////////////////////////////////////////////////////////////
36521 . ////////////////////////////////////////////////////////////////////////////
36522
36523 .chapter "Exim utilities" "CHAPutils"
36524 .scindex IIDutils "utilities"
36525 A number of utility scripts and programs are supplied with Exim and are
36526 described in this chapter. There is also the Exim Monitor, which is covered in
36527 the next chapter. The utilities described here are:
36528
36529 .itable none 0 0 3  7* left  15* left  40* left
36530 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
36531   "list what Exim processes are doing"
36532 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
36533 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
36534 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
36535 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
36536                                                 various criteria"
36537 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
36538 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
36539   "extract statistics from the log"
36540 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
36541   "check address acceptance from given IP"
36542 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
36543 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
36544 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
36545 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
36546 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
36547 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
36548 .endtable
36549
36550 Another utility that might be of use to sites with many MTAs is Tom Kistner's
36551 &'exilog'&. It provides log visualizations across multiple Exim servers. See
36552 &url(http://duncanthrax.net/exilog/) for details.
36553
36554
36555
36556
36557 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
36558 .cindex "&'exiwhat'&"
36559 .cindex "process, querying"
36560 .cindex "SIGUSR1"
36561 On operating systems that can restart a system call after receiving a signal
36562 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
36563 a line describing what it is doing to the file &_exim-process.info_& in the
36564 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
36565 processes it can find, having first emptied the file. It then waits for one
36566 second to allow the Exim processes to react before displaying the results. In
36567 order to run &'exiwhat'& successfully you have to have sufficient privilege to
36568 send the signal to the Exim processes, so it is normally run as root.
36569
36570 &*Warning*&: This is not an efficient process. It is intended for occasional
36571 use by system administrators. It is not sensible, for example, to set up a
36572 script that sends SIGUSR1 signals to Exim processes at short intervals.
36573
36574
36575 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
36576 varies in different operating systems. Not only are different options used,
36577 but the format of the output is different. For this reason, there are some
36578 system configuration options that configure exactly how &'exiwhat'& works. If
36579 it doesn't seem to be working for you, check the following compile-time
36580 options:
36581 .display
36582 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
36583 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
36584 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
36585 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
36586 .endd
36587 An example of typical output from &'exiwhat'& is
36588 .code
36589 164 daemon: -q1h, listening on port 25
36590 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
36591 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
36592   [10.19.42.42] (editor@ref.example)
36593 10592 handling incoming call from [192.168.243.242]
36594 10628 accepting a local non-SMTP message
36595 .endd
36596 The first number in the output line is the process number. The third line has
36597 been split here, in order to fit it on the page.
36598
36599
36600
36601 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
36602 .cindex "&'exiqgrep'&"
36603 .cindex "queue" "grepping"
36604 This utility is a Perl script contributed by Matt Hubbard. It runs
36605 .code
36606 exim -bpu
36607 .endd
36608 or (in case &*-a*& switch is specified)
36609 .code
36610 exim -bp
36611 .endd
36612 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
36613 contain alternate exim configuration the queue management might be using.
36614
36615 to obtain a queue listing, and then greps the output to select messages
36616 that match given criteria. The following selection options are available:
36617
36618 .vlist
36619 .vitem &*-f*&&~<&'regex'&>
36620 Match the sender address using a case-insensitive search. The field that is
36621 tested is enclosed in angle brackets, so you can test for bounce messages with
36622 .code
36623 exiqgrep -f '^<>$'
36624 .endd
36625 .vitem &*-r*&&~<&'regex'&>
36626 Match a recipient address using a case-insensitive search. The field that is
36627 tested is not enclosed in angle brackets.
36628
36629 .vitem &*-s*&&~<&'regex'&>
36630 Match against the size field.
36631
36632 .vitem &*-y*&&~<&'seconds'&>
36633 Match messages that are younger than the given time.
36634
36635 .vitem &*-o*&&~<&'seconds'&>
36636 Match messages that are older than the given time.
36637
36638 .vitem &*-z*&
36639 Match only frozen messages.
36640
36641 .vitem &*-x*&
36642 Match only non-frozen messages.
36643 .endlist
36644
36645 The following options control the format of the output:
36646
36647 .vlist
36648 .vitem &*-c*&
36649 Display only the count of matching messages.
36650
36651 .vitem &*-l*&
36652 Long format &-- display the full message information as output by Exim. This is
36653 the default.
36654
36655 .vitem &*-i*&
36656 Display message ids only.
36657
36658 .vitem &*-b*&
36659 Brief format &-- one line per message.
36660
36661 .vitem &*-R*&
36662 Display messages in reverse order.
36663
36664 .vitem &*-a*&
36665 Include delivered recipients in queue listing.
36666 .endlist
36667
36668 There is one more option, &%-h%&, which outputs a list of options.
36669
36670
36671
36672 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
36673 .cindex "&'exiqsumm'&"
36674 .cindex "queue" "summary"
36675 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
36676 -bp`& and produces a summary of the messages on the queue. Thus, you use it by
36677 running a command such as
36678 .code
36679 exim -bp | exiqsumm
36680 .endd
36681 The output consists of one line for each domain that has messages waiting for
36682 it, as in the following example:
36683 .code
36684 3   2322   74m   66m  msn.com.example
36685 .endd
36686 Each line lists the number of pending deliveries for a domain, their total
36687 volume, and the length of time that the oldest and the newest messages have
36688 been waiting. Note that the number of pending deliveries is greater than the
36689 number of messages when messages have more than one recipient.
36690
36691 A summary line is output at the end. By default the output is sorted on the
36692 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
36693 the output to be sorted by oldest message and by count of messages,
36694 respectively. There are also three options that split the messages for each
36695 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
36696 separates frozen messages, and &%-s%& separates messages according to their
36697 sender.
36698
36699 The output of &'exim -bp'& contains the original addresses in the message, so
36700 this also applies to the output from &'exiqsumm'&. No domains from addresses
36701 generated by aliasing or forwarding are included (unless the &%one_time%&
36702 option of the &(redirect)& router has been used to convert them into &"top
36703 level"& addresses).
36704
36705
36706
36707
36708 .section "Extracting specific information from the log (exigrep)" &&&
36709          "SECTextspeinf"
36710 .cindex "&'exigrep'&"
36711 .cindex "log" "extracts; grepping for"
36712 The &'exigrep'& utility is a Perl script that searches one or more main log
36713 files for entries that match a given pattern. When it finds a match, it
36714 extracts all the log entries for the relevant message, not just those that
36715 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
36716 given message, or all mail for a given user, or for a given host, for example.
36717 The input files can be in Exim log format or syslog format.
36718 If a matching log line is not associated with a specific message, it is
36719 included in &'exigrep'&'s output without any additional lines. The usage is:
36720 .display
36721 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
36722 .endd
36723 If no log file names are given on the command line, the standard input is read.
36724
36725 The &%-t%& argument specifies a number of seconds. It adds an additional
36726 condition for message selection. Messages that are complete are shown only if
36727 they spent more than <&'n'&> seconds on the queue.
36728
36729 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
36730 makes it case-sensitive. This may give a performance improvement when searching
36731 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
36732 option; with &%-I%& they do not. In both cases it is possible to change the
36733 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
36734
36735 The &%-l%& option means &"literal"&, that is, treat all characters in the
36736 pattern as standing for themselves. Otherwise the pattern must be a Perl
36737 regular expression.
36738
36739 The &%-v%& option inverts the matching condition. That is, a line is selected
36740 if it does &'not'& match the pattern.
36741
36742 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
36743 that are generated as a result/response to a message that &'exigrep'& matched
36744 normally.
36745
36746 Example of &%-M%&:
36747 user_a sends a message to user_b, which generates a bounce back to user_b. If
36748 &'exigrep'& is used to search for &"user_a"&, only the first message will be
36749 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
36750 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
36751 when searching for &"user_a"& will show both messages since the bounce is
36752 &"related"& to or a &"result"& of the first message that was found by the
36753 search term.
36754
36755 If the location of a &'zcat'& command is known from the definition of
36756 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
36757 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
36758 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
36759 autodetection of some well known compression extensions.
36760
36761
36762 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
36763 .cindex "&'exipick'&"
36764 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
36765 lists messages from the queue according to a variety of criteria. For details
36766 of &'exipick'&'s facilities, run &'exipick'& with
36767 the &%--help%& option.
36768
36769
36770 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
36771 .cindex "log" "cycling local files"
36772 .cindex "cycling logs"
36773 .cindex "&'exicyclog'&"
36774 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
36775 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
36776 you are using log files with datestamps in their names (see section
36777 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
36778 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
36779 There are two command line options for &'exicyclog'&:
36780 .ilist
36781 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
36782 default that is set when Exim is built. The default default is 10.
36783 .next
36784 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
36785 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
36786 overriding the script's default, which is to find the setting from Exim's
36787 configuration.
36788 .endlist
36789
36790 Each time &'exicyclog'& is run the file names get &"shuffled down"& by one. If
36791 the main log file name is &_mainlog_& (the default) then when &'exicyclog'& is
36792 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
36793 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
36794 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
36795 logs are handled similarly.
36796
36797 If the limit is greater than 99, the script uses 3-digit numbers such as
36798 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
36799 to one that is greater, or &'vice versa'&, you will have to fix the names of
36800 any existing log files.
36801
36802 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
36803 the end are deleted. All files with numbers greater than 01 are compressed,
36804 using a compression command which is configured by the COMPRESS_COMMAND
36805 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
36806 root &%crontab%& entry of the form
36807 .code
36808 1 0 * * * su exim -c /usr/exim/bin/exicyclog
36809 .endd
36810 assuming you have used the name &"exim"& for the Exim user. You can run
36811 &'exicyclog'& as root if you wish, but there is no need.
36812
36813
36814
36815 .section "Mail statistics (eximstats)" "SECTmailstat"
36816 .cindex "statistics"
36817 .cindex "&'eximstats'&"
36818 A Perl script called &'eximstats'& is provided for extracting statistical
36819 information from log files. The output is either plain text, or HTML.
36820 Exim log files are also supported by the &'Lire'& system produced by the
36821 LogReport Foundation &url(http://www.logreport.org).
36822
36823 The &'eximstats'& script has been hacked about quite a bit over time. The
36824 latest version is the result of some extensive revision by Steve Campbell. A
36825 lot of information is given by default, but there are options for suppressing
36826 various parts of it. Following any options, the arguments to the script are a
36827 list of files, which should be main log files. For example:
36828 .code
36829 eximstats -nr /var/spool/exim/log/mainlog.01
36830 .endd
36831 By default, &'eximstats'& extracts information about the number and volume of
36832 messages received from or delivered to various hosts. The information is sorted
36833 both by message count and by volume, and the top fifty hosts in each category
36834 are listed on the standard output. Similar information, based on email
36835 addresses or domains instead of hosts can be requested by means of various
36836 options. For messages delivered and received locally, similar statistics are
36837 also produced per user.
36838
36839 The output also includes total counts and statistics about delivery errors, and
36840 histograms showing the number of messages received and deliveries made in each
36841 hour of the day. A delivery with more than one address in its envelope (for
36842 example, an SMTP transaction with more than one RCPT command) is counted
36843 as a single delivery by &'eximstats'&.
36844
36845 Though normally more deliveries than receipts are reported (as messages may
36846 have multiple recipients), it is possible for &'eximstats'& to report more
36847 messages received than delivered, even though the queue is empty at the start
36848 and end of the period in question. If an incoming message contains no valid
36849 recipients, no deliveries are recorded for it. A bounce message is handled as
36850 an entirely separate message.
36851
36852 &'eximstats'& always outputs a grand total summary giving the volume and number
36853 of messages received and deliveries made, and the number of hosts involved in
36854 each case. It also outputs the number of messages that were delayed (that is,
36855 not completely delivered at the first attempt), and the number that had at
36856 least one address that failed.
36857
36858 The remainder of the output is in sections that can be independently disabled
36859 or modified by various options. It consists of a summary of deliveries by
36860 transport, histograms of messages received and delivered per time interval
36861 (default per hour), information about the time messages spent on the queue,
36862 a list of relayed messages, lists of the top fifty sending hosts, local
36863 senders, destination hosts, and destination local users by count and by volume,
36864 and a list of delivery errors that occurred.
36865
36866 The relay information lists messages that were actually relayed, that is, they
36867 came from a remote host and were directly delivered to some other remote host,
36868 without being processed (for example, for aliasing or forwarding) locally.
36869
36870 There are quite a few options for &'eximstats'& to control exactly what it
36871 outputs. These are documented in the Perl script itself, and can be extracted
36872 by running the command &(perldoc)& on the script. For example:
36873 .code
36874 perldoc /usr/exim/bin/eximstats
36875 .endd
36876
36877 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
36878 .cindex "&'exim_checkaccess'&"
36879 .cindex "policy control" "checking access"
36880 .cindex "checking access"
36881 The &%-bh%& command line argument allows you to run a fake SMTP session with
36882 debugging output, in order to check what Exim is doing when it is applying
36883 policy controls to incoming SMTP mail. However, not everybody is sufficiently
36884 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
36885 sometimes you just want to answer the question &"Does this address have
36886 access?"& without bothering with any further details.
36887
36888 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
36889 two arguments, an IP address and an email address:
36890 .code
36891 exim_checkaccess 10.9.8.7 A.User@a.domain.example
36892 .endd
36893 The utility runs a call to Exim with the &%-bh%& option, to test whether the
36894 given email address would be accepted in a RCPT command in a TCP/IP
36895 connection from the host with the given IP address. The output of the utility
36896 is either the word &"accepted"&, or the SMTP error response, for example:
36897 .code
36898 Rejected:
36899 550 Relay not permitted
36900 .endd
36901 When running this test, the utility uses &`<>`& as the envelope sender address
36902 for the MAIL command, but you can change this by providing additional
36903 options. These are passed directly to the Exim command. For example, to specify
36904 that the test is to be run with the sender address &'himself@there.example'&
36905 you can use:
36906 .code
36907 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
36908                  -f himself@there.example
36909 .endd
36910 Note that these additional Exim command line items must be given after the two
36911 mandatory arguments.
36912
36913 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
36914 while running its checks. You can run checks that include callouts by using
36915 &%-bhc%&, but this is not yet available in a &"packaged"& form.
36916
36917
36918
36919 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
36920 .cindex "DBM" "building dbm files"
36921 .cindex "building DBM files"
36922 .cindex "&'exim_dbmbuild'&"
36923 .cindex "lower casing"
36924 .cindex "binary zero" "in lookup key"
36925 The &'exim_dbmbuild'& program reads an input file containing keys and data in
36926 the format used by the &(lsearch)& lookup (see section
36927 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
36928 names as keys and the remainder of the information as data. The lower-casing
36929 can be prevented by calling the program with the &%-nolc%& option.
36930
36931 A terminating zero is included as part of the key string. This is expected by
36932 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
36933 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
36934 strings or the data strings. The &(dbmnz)& lookup type can be used with such
36935 files.
36936
36937 The program requires two arguments: the name of the input file (which can be a
36938 single hyphen to indicate the standard input), and the name of the output file.
36939 It creates the output under a temporary name, and then renames it if all went
36940 well.
36941
36942 .cindex "USE_DB"
36943 If the native DB interface is in use (USE_DB is set in a compile-time
36944 configuration file &-- this is common in free versions of Unix) the two file
36945 names must be different, because in this mode the Berkeley DB functions create
36946 a single output file using exactly the name given. For example,
36947 .code
36948 exim_dbmbuild /etc/aliases /etc/aliases.db
36949 .endd
36950 reads the system alias file and creates a DBM version of it in
36951 &_/etc/aliases.db_&.
36952
36953 In systems that use the &'ndbm'& routines (mostly proprietary versions of
36954 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
36955 environment, the suffixes are added to the second argument of
36956 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
36957 when the Berkeley functions are used in compatibility mode (though this is not
36958 recommended), because in that case it adds a &_.db_& suffix to the file name.
36959
36960 If a duplicate key is encountered, the program outputs a warning, and when it
36961 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
36962 option is used. By default, only the first of a set of duplicates is used &--
36963 this makes it compatible with &(lsearch)& lookups. There is an option
36964 &%-lastdup%& which causes it to use the data for the last duplicate instead.
36965 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
36966 &%stderr%&. For other errors, where it doesn't actually make a new file, the
36967 return code is 2.
36968
36969
36970
36971
36972 .section "Finding individual retry times (exinext)" "SECTfinindret"
36973 .cindex "retry" "times"
36974 .cindex "&'exinext'&"
36975 A utility called &'exinext'& (mostly a Perl script) provides the ability to
36976 fish specific information out of the retry database. Given a mail domain (or a
36977 complete address), it looks up the hosts for that domain, and outputs any retry
36978 information for the hosts or for the domain. At present, the retry information
36979 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
36980 output. For example:
36981 .code
36982 $ exinext piglet@milne.fict.example
36983 kanga.milne.example:192.168.8.1 error 146: Connection refused
36984   first failed: 21-Feb-1996 14:57:34
36985   last tried:   21-Feb-1996 14:57:34
36986   next try at:  21-Feb-1996 15:02:34
36987 roo.milne.example:192.168.8.3 error 146: Connection refused
36988   first failed: 20-Jan-1996 13:12:08
36989   last tried:   21-Feb-1996 11:42:03
36990   next try at:  21-Feb-1996 19:42:03
36991   past final cutoff time
36992 .endd
36993 You can also give &'exinext'& a local part, without a domain, and it
36994 will give any retry information for that local part in your default domain.
36995 A message id can be used to obtain retry information pertaining to a specific
36996 message. This exists only when an attempt to deliver a message to a remote host
36997 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
36998 &'exinext'& is not particularly efficient, but then it is not expected to be
36999 run very often.
37000
37001 The &'exinext'& utility calls Exim to find out information such as the location
37002 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
37003 passed on to the &'exim'& commands. The first specifies an alternate Exim
37004 configuration file, and the second sets macros for use within the configuration
37005 file. These features are mainly to help in testing, but might also be useful in
37006 environments where more than one configuration file is in use.
37007
37008
37009
37010 .section "Hints database maintenance" "SECThindatmai"
37011 .cindex "hints database" "maintenance"
37012 .cindex "maintaining Exim's hints database"
37013 Three utility programs are provided for maintaining the DBM files that Exim
37014 uses to contain its delivery hint information. Each program requires two
37015 arguments. The first specifies the name of Exim's spool directory, and the
37016 second is the name of the database it is to operate on. These are as follows:
37017
37018 .ilist
37019 &'retry'&: the database of retry information
37020 .next
37021 &'wait-'&<&'transport name'&>: databases of information about messages waiting
37022 for remote hosts
37023 .next
37024 &'callout'&: the callout cache
37025 .next
37026 &'ratelimit'&: the data for implementing the ratelimit ACL condition
37027 .next
37028 &'misc'&: other hints data
37029 .endlist
37030
37031 The &'misc'& database is used for
37032
37033 .ilist
37034 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
37035 .next
37036 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
37037 &(smtp)& transport)
37038 .next
37039 Limiting the concurrency of specific transports (when &%max_parallel%& is set
37040 in a transport)
37041 .endlist
37042
37043
37044
37045 .section "exim_dumpdb" "SECID261"
37046 .cindex "&'exim_dumpdb'&"
37047 The entire contents of a database are written to the standard output by the
37048 &'exim_dumpdb'& program, which has no options or arguments other than the
37049 spool and database names. For example, to dump the retry database:
37050 .code
37051 exim_dumpdb /var/spool/exim retry
37052 .endd
37053 Two lines of output are produced for each entry:
37054 .code
37055 T:mail.ref.example:192.168.242.242 146 77 Connection refused
37056 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
37057 .endd
37058 The first item on the first line is the key of the record. It starts with one
37059 of the letters R, or T, depending on whether it refers to a routing or
37060 transport retry. For a local delivery, the next part is the local address; for
37061 a remote delivery it is the name of the remote host, followed by its failing IP
37062 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
37063 transport). If the remote port is not the standard one (port 25), it is added
37064 to the IP address. Then there follows an error code, an additional error code,
37065 and a textual description of the error.
37066
37067 The three times on the second line are the time of first failure, the time of
37068 the last delivery attempt, and the computed time for the next attempt. The line
37069 ends with an asterisk if the cutoff time for the last retry rule has been
37070 exceeded.
37071
37072 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
37073 consists of a host name followed by a list of ids for messages that are or were
37074 waiting to be delivered to that host. If there are a very large number for any
37075 one host, continuation records, with a sequence number added to the host name,
37076 may be seen. The data in these records is often out of date, because a message
37077 may be routed to several alternative hosts, and Exim makes no effort to keep
37078 cross-references.
37079
37080
37081
37082 .section "exim_tidydb" "SECID262"
37083 .cindex "&'exim_tidydb'&"
37084 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
37085 database. If run with no options, it removes all records that are more than 30
37086 days old. The age is calculated from the date and time that the record was last
37087 updated. Note that, in the case of the retry database, it is &'not'& the time
37088 since the first delivery failure. Information about a host that has been down
37089 for more than 30 days will remain in the database, provided that the record is
37090 updated sufficiently often.
37091
37092 The cutoff date can be altered by means of the &%-t%& option, which must be
37093 followed by a time. For example, to remove all records older than a week from
37094 the retry database:
37095 .code
37096 exim_tidydb -t 7d /var/spool/exim retry
37097 .endd
37098 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
37099 message ids. In the former these appear as data in records keyed by host &--
37100 they were messages that were waiting for that host &-- and in the latter they
37101 are the keys for retry information for messages that have suffered certain
37102 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
37103 message ids in database records are those of messages that are still on the
37104 queue. Message ids for messages that no longer exist are removed from
37105 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
37106 For the &'retry'& database, records whose keys are non-existent message ids are
37107 removed. The &'exim_tidydb'& utility outputs comments on the standard output
37108 whenever it removes information from the database.
37109
37110 Certain records are automatically removed by Exim when they are no longer
37111 needed, but others are not. For example, if all the MX hosts for a domain are
37112 down, a retry record is created for each one. If the primary MX host comes back
37113 first, its record is removed when Exim successfully delivers to it, but the
37114 records for the others remain because Exim has not tried to use those hosts.
37115
37116 It is important, therefore, to run &'exim_tidydb'& periodically on all the
37117 hints databases. You should do this at a quiet time of day, because it requires
37118 a database to be locked (and therefore inaccessible to Exim) while it does its
37119 work. Removing records from a DBM file does not normally make the file smaller,
37120 but all the common DBM libraries are able to re-use the space that is released.
37121 After an initial phase of increasing in size, the databases normally reach a
37122 point at which they no longer get any bigger, as long as they are regularly
37123 tidied.
37124
37125 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
37126 databases is likely to keep on increasing.
37127
37128
37129
37130
37131 .section "exim_fixdb" "SECID263"
37132 .cindex "&'exim_fixdb'&"
37133 The &'exim_fixdb'& program is a utility for interactively modifying databases.
37134 Its main use is for testing Exim, but it might also be occasionally useful for
37135 getting round problems in a live system. It has no options, and its interface
37136 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
37137 key of a database record can then be entered, and the data for that record is
37138 displayed.
37139
37140 If &"d"& is typed at the next prompt, the entire record is deleted. For all
37141 except the &'retry'& database, that is the only operation that can be carried
37142 out. For the &'retry'& database, each field is output preceded by a number, and
37143 data for individual fields can be changed by typing the field number followed
37144 by new data, for example:
37145 .code
37146 > 4 951102:1000
37147 .endd
37148 resets the time of the next delivery attempt. Time values are given as a
37149 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
37150 used as optional separators.
37151
37152
37153
37154
37155 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
37156 .cindex "mailbox" "maintenance"
37157 .cindex "&'exim_lock'&"
37158 .cindex "locking mailboxes"
37159 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
37160 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
37161 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
37162 a user agent while investigating a problem. The utility requires the name of
37163 the file as its first argument. If the locking is successful, the second
37164 argument is run as a command (using C's &[system()]& function); if there is no
37165 second argument, the value of the SHELL environment variable is used; if this
37166 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
37167 is unlocked and the utility ends. The following options are available:
37168
37169 .vlist
37170 .vitem &%-fcntl%&
37171 Use &[fcntl()]& locking on the open mailbox.
37172
37173 .vitem &%-flock%&
37174 Use &[flock()]& locking on the open mailbox, provided the operating system
37175 supports it.
37176
37177 .vitem &%-interval%&
37178 This must be followed by a number, which is a number of seconds; it sets the
37179 interval to sleep between retries (default 3).
37180
37181 .vitem &%-lockfile%&
37182 Create a lock file before opening the mailbox.
37183
37184 .vitem &%-mbx%&
37185 Lock the mailbox using MBX rules.
37186
37187 .vitem &%-q%&
37188 Suppress verification output.
37189
37190 .vitem &%-retries%&
37191 This must be followed by a number; it sets the number of times to try to get
37192 the lock (default 10).
37193
37194 .vitem &%-restore_time%&
37195 This option causes &%exim_lock%& to restore the modified and read times to the
37196 locked file before exiting. This allows you to access a locked mailbox (for
37197 example, to take a backup copy) without disturbing the times that the user
37198 subsequently sees.
37199
37200 .vitem &%-timeout%&
37201 This must be followed by a number, which is a number of seconds; it sets a
37202 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
37203 default), a non-blocking call is used.
37204
37205 .vitem &%-v%&
37206 Generate verbose output.
37207 .endlist
37208
37209 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
37210 default is to create a lock file and also to use &[fcntl()]& locking on the
37211 mailbox, which is the same as Exim's default. The use of &%-flock%& or
37212 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
37213 requires that the directory containing the file be writeable. Locking by lock
37214 file does not last for ever; Exim assumes that a lock file is expired if it is
37215 more than 30 minutes old.
37216
37217 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
37218 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
37219 to be taken out on the open mailbox, and an exclusive lock on the file
37220 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
37221 number of the mailbox file. When the locking is released, if an exclusive lock
37222 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
37223
37224 The default output contains verification of the locking that takes place. The
37225 &%-v%& option causes some additional information to be given. The &%-q%& option
37226 suppresses all output except error messages.
37227
37228 A command such as
37229 .code
37230 exim_lock /var/spool/mail/spqr
37231 .endd
37232 runs an interactive shell while the file is locked, whereas
37233 .display
37234 &`exim_lock -q /var/spool/mail/spqr <<End`&
37235 <&'some commands'&>
37236 &`End`&
37237 .endd
37238 runs a specific non-interactive sequence of commands while the file is locked,
37239 suppressing all verification output. A single command can be run by a command
37240 such as
37241 .code
37242 exim_lock -q /var/spool/mail/spqr \
37243   "cp /var/spool/mail/spqr /some/where"
37244 .endd
37245 Note that if a command is supplied, it must be entirely contained within the
37246 second argument &-- hence the quotes.
37247 .ecindex IIDutils
37248
37249
37250 . ////////////////////////////////////////////////////////////////////////////
37251 . ////////////////////////////////////////////////////////////////////////////
37252
37253 .chapter "The Exim monitor" "CHAPeximon"
37254 .scindex IIDeximon "Exim monitor" "description"
37255 .cindex "X-windows"
37256 .cindex "&'eximon'&"
37257 .cindex "Local/eximon.conf"
37258 .cindex "&_exim_monitor/EDITME_&"
37259 The Exim monitor is an application which displays in an X window information
37260 about the state of Exim's queue and what Exim is doing. An admin user can
37261 perform certain operations on messages from this GUI interface; however all
37262 such facilities are also available from the command line, and indeed, the
37263 monitor itself makes use of the command line to perform any actions requested.
37264
37265
37266
37267 .section "Running the monitor" "SECID264"
37268 The monitor is started by running the script called &'eximon'&. This is a shell
37269 script that sets up a number of environment variables, and then runs the
37270 binary called &_eximon.bin_&. The default appearance of the monitor window can
37271 be changed by editing the &_Local/eximon.conf_& file created by editing
37272 &_exim_monitor/EDITME_&. Comments in that file describe what the various
37273 parameters are for.
37274
37275 The parameters that get built into the &'eximon'& script can be overridden for
37276 a particular invocation by setting up environment variables of the same names,
37277 preceded by &`EXIMON_`&. For example, a shell command such as
37278 .code
37279 EXIMON_LOG_DEPTH=400 eximon
37280 .endd
37281 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
37282 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
37283 overrides the Exim log file configuration. This makes it possible to have
37284 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
37285 syslog messages are routed to a file on the local host.
37286
37287 X resources can be used to change the appearance of the window in the normal
37288 way. For example, a resource setting of the form
37289 .code
37290 Eximon*background: gray94
37291 .endd
37292 changes the colour of the background to light grey rather than white. The
37293 stripcharts are drawn with both the data lines and the reference lines in
37294 black. This means that the reference lines are not visible when on top of the
37295 data. However, their colour can be changed by setting a resource called
37296 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
37297 For example, if your X server is running Unix, you could set up lighter
37298 reference lines in the stripcharts by obeying
37299 .code
37300 xrdb -merge <<End
37301 Eximon*highlight: gray
37302 End
37303 .endd
37304 .cindex "admin user"
37305 In order to see the contents of messages on the queue, and to operate on them,
37306 &'eximon'& must either be run as root or by an admin user.
37307
37308 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
37309 contain X11 resource parameters interpreted by the X11 library.  In addition,
37310 if the first parameter starts with the string "gdb" then it is removed and the
37311 binary is invoked under gdb (the parameter is used as the gdb command-name, so
37312 versioned variants of gdb can be invoked).
37313
37314 The monitor's window is divided into three parts. The first contains one or
37315 more stripcharts and two action buttons, the second contains a &"tail"& of the
37316 main log file, and the third is a display of the queue of messages awaiting
37317 delivery, with two more action buttons. The following sections describe these
37318 different parts of the display.
37319
37320
37321
37322
37323 .section "The stripcharts" "SECID265"
37324 .cindex "stripchart"
37325 The first stripchart is always a count of messages on the queue. Its name can
37326 be configured by setting QUEUE_STRIPCHART_NAME in the
37327 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
37328 configuration script by regular expression matches on log file entries, making
37329 it possible to display, for example, counts of messages delivered to certain
37330 hosts or using certain transports. The supplied defaults display counts of
37331 received and delivered messages, and of local and SMTP deliveries. The default
37332 period between stripchart updates is one minute; this can be adjusted by a
37333 parameter in the &_Local/eximon.conf_& file.
37334
37335 The stripchart displays rescale themselves automatically as the value they are
37336 displaying changes. There are always 10 horizontal lines in each chart; the
37337 title string indicates the value of each division when it is greater than one.
37338 For example, &"x2"& means that each division represents a value of 2.
37339
37340 It is also possible to have a stripchart which shows the percentage fullness of
37341 a particular disk partition, which is useful when local deliveries are confined
37342 to a single partition.
37343
37344 .cindex "&%statvfs%& function"
37345 This relies on the availability of the &[statvfs()]& function or equivalent in
37346 the operating system. Most, but not all versions of Unix that support Exim have
37347 this. For this particular stripchart, the top of the chart always represents
37348 100%, and the scale is given as &"x10%"&. This chart is configured by setting
37349 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
37350 &_Local/eximon.conf_& file.
37351
37352
37353
37354
37355 .section "Main action buttons" "SECID266"
37356 .cindex "size" "of monitor window"
37357 .cindex "Exim monitor" "window size"
37358 .cindex "window size"
37359 Below the stripcharts there is an action button for quitting the monitor. Next
37360 to this is another button marked &"Size"&. They are placed here so that
37361 shrinking the window to its default minimum size leaves just the queue count
37362 stripchart and these two buttons visible. Pressing the &"Size"& button causes
37363 the window to expand to its maximum size, unless it is already at the maximum,
37364 in which case it is reduced to its minimum.
37365
37366 When expanding to the maximum, if the window cannot be fully seen where it
37367 currently is, it is moved back to where it was the last time it was at full
37368 size. When it is expanding from its minimum size, the old position is
37369 remembered, and next time it is reduced to the minimum it is moved back there.
37370
37371 The idea is that you can keep a reduced window just showing one or two
37372 stripcharts at a convenient place on your screen, easily expand it to show
37373 the full window when required, and just as easily put it back to what it was.
37374 The idea is copied from what the &'twm'& window manager does for its
37375 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
37376 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
37377
37378 Normally, the monitor starts up with the window at its full size, but it can be
37379 built so that it starts up with the window at its smallest size, by setting
37380 START_SMALL=yes in &_Local/eximon.conf_&.
37381
37382
37383
37384 .section "The log display" "SECID267"
37385 .cindex "log" "tail of; in monitor"
37386 The second section of the window is an area in which a display of the tail of
37387 the main log is maintained.
37388 To save space on the screen, the timestamp on each log line is shortened by
37389 removing the date and, if &%log_timezone%& is set, the timezone.
37390 The log tail is not available when the only destination for logging data is
37391 syslog, unless the syslog lines are routed to a local file whose name is passed
37392 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
37393
37394 The log sub-window has a scroll bar at its lefthand side which can be used to
37395 move back to look at earlier text, and the up and down arrow keys also have a
37396 scrolling effect. The amount of log that is kept depends on the setting of
37397 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
37398 to use. When this is full, the earlier 50% of data is discarded &-- this is
37399 much more efficient than throwing it away line by line. The sub-window also has
37400 a horizontal scroll bar for accessing the ends of long log lines. This is the
37401 only means of horizontal scrolling; the right and left arrow keys are not
37402 available. Text can be cut from this part of the window using the mouse in the
37403 normal way. The size of this subwindow is controlled by parameters in the
37404 configuration file &_Local/eximon.conf_&.
37405
37406 Searches of the text in the log window can be carried out by means of the ^R
37407 and ^S keystrokes, which default to a reverse and a forward search,
37408 respectively. The search covers only the text that is displayed in the window.
37409 It cannot go further back up the log.
37410
37411 The point from which the search starts is indicated by a caret marker. This is
37412 normally at the end of the text in the window, but can be positioned explicitly
37413 by pointing and clicking with the left mouse button, and is moved automatically
37414 by a successful search. If new text arrives in the window when it is scrolled
37415 back, the caret remains where it is, but if the window is not scrolled back,
37416 the caret is moved to the end of the new text.
37417
37418 Pressing ^R or ^S pops up a window into which the search text can be typed.
37419 There are buttons for selecting forward or reverse searching, for carrying out
37420 the search, and for cancelling. If the &"Search"& button is pressed, the search
37421 happens and the window remains so that further searches can be done. If the
37422 &"Return"& key is pressed, a single search is done and the window is closed. If
37423 ^C is typed the search is cancelled.
37424
37425 The searching facility is implemented using the facilities of the Athena text
37426 widget. By default this pops up a window containing both &"search"& and
37427 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
37428 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
37429 However, the linkers in BSDI and HP-UX seem unable to handle an externally
37430 provided version of &%TextPop%& when the remaining parts of the text widget
37431 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
37432 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
37433 on these systems, at the expense of having unwanted items in the search popup
37434 window.
37435
37436
37437
37438 .section "The queue display" "SECID268"
37439 .cindex "queue" "display in monitor"
37440 The bottom section of the monitor window contains a list of all messages that
37441 are on the queue, which includes those currently being received or delivered,
37442 as well as those awaiting delivery. The size of this subwindow is controlled by
37443 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
37444 at which it is updated is controlled by another parameter in the same file &--
37445 the default is 5 minutes, since queue scans can be quite expensive. However,
37446 there is an &"Update"& action button just above the display which can be used
37447 to force an update of the queue display at any time.
37448
37449 When a host is down for some time, a lot of pending mail can build up for it,
37450 and this can make it hard to deal with other messages on the queue. To help
37451 with this situation there is a button next to &"Update"& called &"Hide"&. If
37452 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
37453 type anything in here and press &"Return"&, the text is added to a chain of
37454 such texts, and if every undelivered address in a message matches at least one
37455 of the texts, the message is not displayed.
37456
37457 If there is an address that does not match any of the texts, all the addresses
37458 are displayed as normal. The matching happens on the ends of addresses so, for
37459 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
37460 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
37461 has been set up, a button called &"Unhide"& is displayed. If pressed, it
37462 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
37463 a hide request is automatically cancelled after one hour.
37464
37465 While the dialogue box is displayed, you can't press any buttons or do anything
37466 else to the monitor window. For this reason, if you want to cut text from the
37467 queue display to use in the dialogue box, you have to do the cutting before
37468 pressing the &"Hide"& button.
37469
37470 The queue display contains, for each unhidden queued message, the length of
37471 time it has been on the queue, the size of the message, the message id, the
37472 message sender, and the first undelivered recipient, all on one line. If it is
37473 a bounce message, the sender is shown as &"<>"&. If there is more than one
37474 recipient to which the message has not yet been delivered, subsequent ones are
37475 listed on additional lines, up to a maximum configured number, following which
37476 an ellipsis is displayed. Recipients that have already received the message are
37477 not shown.
37478
37479 .cindex "frozen messages" "display"
37480 If a message is frozen, an asterisk is displayed at the left-hand side.
37481
37482 The queue display has a vertical scroll bar, and can also be scrolled by means
37483 of the arrow keys. Text can be cut from it using the mouse in the normal way.
37484 The text searching facilities, as described above for the log window, are also
37485 available, but the caret is always moved to the end of the text when the queue
37486 display is updated.
37487
37488
37489
37490 .section "The queue menu" "SECID269"
37491 .cindex "queue" "menu in monitor"
37492 If the &%shift%& key is held down and the left button is clicked when the mouse
37493 pointer is over the text for any message, an action menu pops up, and the first
37494 line of the queue display for the message is highlighted. This does not affect
37495 any selected text.
37496
37497 If you want to use some other event for popping up the menu, you can set the
37498 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
37499 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
37500 value set in this parameter is a standard X event description. For example, to
37501 run eximon using &%ctrl%& rather than &%shift%& you could use
37502 .code
37503 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
37504 .endd
37505 The title of the menu is the message id, and it contains entries which act as
37506 follows:
37507
37508 .ilist
37509 &'message log'&: The contents of the message log for the message are displayed
37510 in a new text window.
37511 .next
37512 &'headers'&: Information from the spool file that contains the envelope
37513 information and headers is displayed in a new text window. See chapter
37514 &<<CHAPspool>>& for a description of the format of spool files.
37515 .next
37516 &'body'&: The contents of the spool file containing the body of the message are
37517 displayed in a new text window. There is a default limit of 20,000 bytes to the
37518 amount of data displayed. This can be changed by setting the BODY_MAX
37519 option at compile time, or the EXIMON_BODY_MAX option at run time.
37520 .next
37521 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
37522 delivery of the message. This causes an automatic thaw if the message is
37523 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
37524 a new text window. The delivery is run in a separate process, to avoid holding
37525 up the monitor while the delivery proceeds.
37526 .next
37527 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
37528 that the message be frozen.
37529 .next
37530 .cindex "thawing messages"
37531 .cindex "unfreezing messages"
37532 .cindex "frozen messages" "thawing"
37533 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
37534 that the message be thawed.
37535 .next
37536 .cindex "delivery" "forcing failure"
37537 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
37538 that Exim gives up trying to deliver the message. A bounce message is generated
37539 for any remaining undelivered addresses.
37540 .next
37541 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
37542 that the message be deleted from the system without generating a bounce
37543 message.
37544 .next
37545 &'add recipient'&: A dialog box is displayed into which a recipient address can
37546 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37547 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37548 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37549 causes a call to Exim to be made using the &%-Mar%& option to request that an
37550 additional recipient be added to the message, unless the entry box is empty, in
37551 which case no action is taken.
37552 .next
37553 &'mark delivered'&: A dialog box is displayed into which a recipient address
37554 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
37555 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
37556 Otherwise it must be entered as a fully qualified address. Pressing RETURN
37557 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
37558 recipient address as already delivered, unless the entry box is empty, in which
37559 case no action is taken.
37560 .next
37561 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
37562 mark all recipient addresses as already delivered.
37563 .next
37564 &'edit sender'&: A dialog box is displayed initialized with the current
37565 sender's address. Pressing RETURN causes a call to Exim to be made using the
37566 &%-Mes%& option to replace the sender address, unless the entry box is empty,
37567 in which case no action is taken. If you want to set an empty sender (as in
37568 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
37569 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
37570 the address is qualified with that domain.
37571 .endlist
37572
37573 When a delivery is forced, a window showing the &%-v%& output is displayed. In
37574 other cases when a call to Exim is made, if there is any output from Exim (in
37575 particular, if the command fails) a window containing the command and the
37576 output is displayed. Otherwise, the results of the action are normally apparent
37577 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
37578 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
37579 if no output is generated.
37580
37581 The queue display is automatically updated for actions such as freezing and
37582 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
37583 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
37584 force an update of the display after one of these actions.
37585
37586 In any text window that is displayed as result of a menu action, the normal
37587 cut-and-paste facility is available, and searching can be carried out using ^R
37588 and ^S, as described above for the log tail window.
37589 .ecindex IIDeximon
37590
37591
37592
37593
37594
37595 . ////////////////////////////////////////////////////////////////////////////
37596 . ////////////////////////////////////////////////////////////////////////////
37597
37598 .chapter "Security considerations" "CHAPsecurity"
37599 .scindex IIDsecurcon "security" "discussion of"
37600 This chapter discusses a number of issues concerned with security, some of
37601 which are also covered in other parts of this manual.
37602
37603 For reasons that this author does not understand, some people have promoted
37604 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
37605 existence of this chapter in the documentation. However, the intent of the
37606 chapter is simply to describe the way Exim works in relation to certain
37607 security concerns, not to make any specific claims about the effectiveness of
37608 its security as compared with other MTAs.
37609
37610 What follows is a description of the way Exim is supposed to be. Best efforts
37611 have been made to try to ensure that the code agrees with the theory, but an
37612 absence of bugs can never be guaranteed. Any that are reported will get fixed
37613 as soon as possible.
37614
37615
37616 .section "Building a more &""hardened""& Exim" "SECID286"
37617 .cindex "security" "build-time features"
37618 There are a number of build-time options that can be set in &_Local/Makefile_&
37619 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
37620 Exim administrator who does not have the root password, or by someone who has
37621 penetrated the Exim (but not the root) account. These options are as follows:
37622
37623 .ilist
37624 ALT_CONFIG_PREFIX can be set to a string that is required to match the
37625 start of any file names used with the &%-C%& option. When it is set, these file
37626 names are also not allowed to contain the sequence &"/../"&. (However, if the
37627 value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
37628 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
37629 default setting for &%ALT_CONFIG_PREFIX%&.
37630
37631 If the permitted configuration files are confined to a directory to
37632 which only root has access, this guards against someone who has broken
37633 into the Exim account from running a privileged Exim with an arbitrary
37634 configuration file, and using it to break into other accounts.
37635 .next
37636
37637 If a non-trusted configuration file (i.e. not the default configuration file
37638 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
37639 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
37640 the next item), then root privilege is retained only if the caller of Exim is
37641 root. This locks out the possibility of testing a configuration using &%-C%&
37642 right through message reception and delivery, even if the caller is root. The
37643 reception works, but by that time, Exim is running as the Exim user, so when
37644 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
37645 privilege to be lost. However, root can test reception and delivery using two
37646 separate commands.
37647
37648 .next
37649 The WHITELIST_D_MACROS build option declares some macros to be safe to override
37650 with &%-D%& if the real uid is one of root, the Exim run-time user or the
37651 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
37652 requiring the run-time value supplied to &%-D%& to match a regex that errs on
37653 the restrictive side.  Requiring build-time selection of safe macros is onerous
37654 but this option is intended solely as a transition mechanism to permit
37655 previously-working configurations to continue to work after release 4.73.
37656 .next
37657 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
37658 is disabled.
37659 .next
37660 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
37661 never to be used for any deliveries. This is like the &%never_users%& runtime
37662 option, but it cannot be overridden; the runtime option adds additional users
37663 to the list. The default setting is &"root"&; this prevents a non-root user who
37664 is permitted to modify the runtime file from using Exim as a way to get root.
37665 .endlist
37666
37667
37668
37669 .section "Root privilege" "SECID270"
37670 .cindex "setuid"
37671 .cindex "root privilege"
37672 The Exim binary is normally setuid to root, which means that it gains root
37673 privilege (runs as root) when it starts execution. In some special cases (for
37674 example, when the daemon is not in use and there are no local deliveries), it
37675 may be possible to run Exim setuid to some user other than root. This is
37676 discussed in the next section. However, in most installations, root privilege
37677 is required for two things:
37678
37679 .ilist
37680 To set up a socket connected to the standard SMTP port (25) when initialising
37681 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
37682 not required.
37683 .next
37684 To be able to change uid and gid in order to read users' &_.forward_& files and
37685 perform local deliveries as the receiving user or as specified in the
37686 configuration.
37687 .endlist
37688
37689 It is not necessary to be root to do any of the other things Exim does, such as
37690 receiving messages and delivering them externally over SMTP, and it is
37691 obviously more secure if Exim does not run as root except when necessary.
37692 For this reason, a user and group for Exim to use must be defined in
37693 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
37694 group"&. Their values can be changed by the run time configuration, though this
37695 is not recommended. Often a user called &'exim'& is used, but some sites use
37696 &'mail'& or another user name altogether.
37697
37698 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
37699 abdication; the process cannot regain root afterwards. Prior to release 4.00,
37700 &[seteuid()]& was used in some circumstances, but this is no longer the case.
37701
37702 After a new Exim process has interpreted its command line options, it changes
37703 uid and gid in the following cases:
37704
37705 .ilist
37706 .oindex "&%-C%&"
37707 .oindex "&%-D%&"
37708 If the &%-C%& option is used to specify an alternate configuration file, or if
37709 the &%-D%& option is used to define macro values for the configuration, and the
37710 calling process is not running as root, the uid and gid are changed to those of
37711 the calling process.
37712 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
37713 option may not be used at all.
37714 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
37715 can be supplied if the calling process is running as root, the Exim run-time
37716 user or CONFIGURE_OWNER, if defined.
37717 .next
37718 .oindex "&%-be%&"
37719 .oindex "&%-bf%&"
37720 .oindex "&%-bF%&"
37721 If the expansion test option (&%-be%&) or one of the filter testing options
37722 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
37723 calling process.
37724 .next
37725 If the process is not a daemon process or a queue runner process or a delivery
37726 process or a process for testing address routing (started with &%-bt%&), the
37727 uid and gid are changed to the Exim user and group. This means that Exim always
37728 runs under its own uid and gid when receiving messages. This also applies when
37729 testing address verification
37730 .oindex "&%-bv%&"
37731 .oindex "&%-bh%&"
37732 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
37733 option).
37734 .next
37735 For a daemon, queue runner, delivery, or address testing process, the uid
37736 remains as root at this stage, but the gid is changed to the Exim group.
37737 .endlist
37738
37739 The processes that initially retain root privilege behave as follows:
37740
37741 .ilist
37742 A daemon process changes the gid to the Exim group and the uid to the Exim
37743 user after setting up one or more listening sockets. The &[initgroups()]&
37744 function is called, so that if the Exim user is in any additional groups, they
37745 will be used during message reception.
37746 .next
37747 A queue runner process retains root privilege throughout its execution. Its
37748 job is to fork a controlled sequence of delivery processes.
37749 .next
37750 A delivery process retains root privilege throughout most of its execution,
37751 but any actual deliveries (that is, the transports themselves) are run in
37752 subprocesses which always change to a non-root uid and gid. For local
37753 deliveries this is typically the uid and gid of the owner of the mailbox; for
37754 remote deliveries, the Exim uid and gid are used. Once all the delivery
37755 subprocesses have been run, a delivery process changes to the Exim uid and gid
37756 while doing post-delivery tidying up such as updating the retry database and
37757 generating bounce and warning messages.
37758
37759 While the recipient addresses in a message are being routed, the delivery
37760 process runs as root. However, if a user's filter file has to be processed,
37761 this is done in a subprocess that runs under the individual user's uid and
37762 gid. A system filter is run as root unless &%system_filter_user%& is set.
37763 .next
37764 A process that is testing addresses (the &%-bt%& option) runs as root so that
37765 the routing is done in the same environment as a message delivery.
37766 .endlist
37767
37768
37769
37770
37771 .section "Running Exim without privilege" "SECTrunexiwitpri"
37772 .cindex "privilege, running without"
37773 .cindex "unprivileged running"
37774 .cindex "root privilege" "running without"
37775 Some installations like to run Exim in an unprivileged state for more of its
37776 operation, for added security. Support for this mode of operation is provided
37777 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
37778 gid are changed to the Exim user and group at the start of a delivery process
37779 (and also queue runner and address testing processes). This means that address
37780 routing is no longer run as root, and the deliveries themselves cannot change
37781 to any other uid.
37782
37783 .cindex SIGHUP
37784 .cindex "daemon" "restarting"
37785 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
37786 that the daemon can still be started in the usual way, and it can respond
37787 correctly to SIGHUP because the re-invocation regains root privilege.
37788
37789 An alternative approach is to make Exim setuid to the Exim user and also setgid
37790 to the Exim group. If you do this, the daemon must be started from a root
37791 process. (Calling Exim from a root process makes it behave in the way it does
37792 when it is setuid root.) However, the daemon cannot restart itself after a
37793 SIGHUP signal because it cannot regain privilege.
37794
37795 It is still useful to set &%deliver_drop_privilege%& in this case, because it
37796 stops Exim from trying to re-invoke itself to do a delivery after a message has
37797 been received. Such a re-invocation is a waste of resources because it has no
37798 effect.
37799
37800 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
37801 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
37802 to the Exim user seems a clean approach, but there is one complication:
37803
37804 In this style of operation, Exim is running with the real uid and gid set to
37805 those of the calling process, and the effective uid/gid set to Exim's values.
37806 Ideally, any association with the calling process' uid/gid should be dropped,
37807 that is, the real uid/gid should be reset to the effective values so as to
37808 discard any privileges that the caller may have. While some operating systems
37809 have a function that permits this action for a non-root effective uid, quite a
37810 number of them do not. Because of this lack of standardization, Exim does not
37811 address this problem at this time.
37812
37813 For this reason, the recommended approach for &"mostly unprivileged"& running
37814 is to keep the Exim binary setuid to root, and to set
37815 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
37816 be used in the most straightforward way.
37817
37818 If you configure Exim not to run delivery processes as root, there are a
37819 number of restrictions on what you can do:
37820
37821 .ilist
37822 You can deliver only as the Exim user/group. You should  explicitly use the
37823 &%user%& and &%group%& options to override routers or local transports that
37824 normally deliver as the recipient. This makes sure that configurations that
37825 work in this mode function the same way in normal mode. Any implicit or
37826 explicit specification of another user causes an error.
37827 .next
37828 Use of &_.forward_& files is severely restricted, such that it is usually
37829 not worthwhile to include them in the configuration.
37830 .next
37831 Users who wish to use &_.forward_& would have to make their home directory and
37832 the file itself accessible to the Exim user. Pipe and append-to-file entries,
37833 and their equivalents in Exim filters, cannot be used. While they could be
37834 enabled in the Exim user's name, that would be insecure and not very useful.
37835 .next
37836 Unless the local user mailboxes are all owned by the Exim user (possible in
37837 some POP3 or IMAP-only environments):
37838
37839 .olist
37840 They must be owned by the Exim group and be writeable by that group. This
37841 implies you must set &%mode%& in the appendfile configuration, as well as the
37842 mode of the mailbox files themselves.
37843 .next
37844 You must set &%no_check_owner%&, since most or all of the files will not be
37845 owned by the Exim user.
37846 .next
37847 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
37848 on a newly created mailbox when unprivileged. This also implies that new
37849 mailboxes need to be created manually.
37850 .endlist olist
37851 .endlist ilist
37852
37853
37854 These restrictions severely restrict what can be done in local deliveries.
37855 However, there are no restrictions on remote deliveries. If you are running a
37856 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
37857 gives more security at essentially no cost.
37858
37859 If you are using the &%mua_wrapper%& facility (see chapter
37860 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
37861
37862
37863
37864
37865 .section "Delivering to local files" "SECID271"
37866 Full details of the checks applied by &(appendfile)& before it writes to a file
37867 are given in chapter &<<CHAPappendfile>>&.
37868
37869
37870
37871 .section "Running local commands" "SECTsecconslocalcmds"
37872 .cindex "security" "local commands"
37873 .cindex "security" "command injection attacks"
37874 There are a number of ways in which an administrator can configure Exim to run
37875 commands based upon received, untrustworthy, data. Further, in some
37876 configurations a user who can control a &_.forward_& file can also arrange to
37877 run commands. Configuration to check includes, but is not limited to:
37878
37879 .ilist
37880 Use of &%use_shell%& in the pipe transport: various forms of shell command
37881 injection may be possible with this option present. It is dangerous and should
37882 be used only with considerable caution. Consider constraints which whitelist
37883 allowed characters in a variable which is to be used in a pipe transport that
37884 has &%use_shell%& enabled.
37885 .next
37886 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
37887 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
37888 &_.forward_& files in a redirect router. If Exim is running on a central mail
37889 hub to which ordinary users do not have shell access, but home directories are
37890 NFS mounted (for instance) then administrators should review the list of these
37891 forbid options available, and should bear in mind that the options that may
37892 need forbidding can change as new features are added between releases.
37893 .next
37894 The &%${run...}%& expansion item does not use a shell by default, but
37895 administrators can configure use of &_/bin/sh_& as part of the command.
37896 Such invocations should be viewed with prejudicial suspicion.
37897 .next
37898 Administrators who use embedded Perl are advised to explore how Perl's
37899 taint checking might apply to their usage.
37900 .next
37901 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
37902 administrators are well advised to view its use with suspicion, in case (for
37903 instance) it allows a local-part to contain embedded Exim directives.
37904 .next
37905 Use of &%${match_local_part...}%& and friends becomes more dangerous if
37906 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
37907 each can reference arbitrary lists and files, rather than just being a list
37908 of opaque strings.
37909 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
37910 real-world security vulnerabilities caused by its use with untrustworthy data
37911 injected in, for SQL injection attacks.
37912 Consider the use of the &%inlisti%& expansion condition instead.
37913 .endlist
37914
37915
37916
37917
37918 .section "Trust in configuration data" "SECTsecconfdata"
37919 .cindex "security" "data sources"
37920 .cindex "security" "regular expressions"
37921 .cindex "regular expressions" "security"
37922 .cindex "PCRE" "security"
37923 If configuration data for Exim can come from untrustworthy sources, there
37924 are some issues to be aware of:
37925
37926 .ilist
37927 Use of &%${expand...}%& may provide a path for shell injection attacks.
37928 .next
37929 Letting untrusted data provide a regular expression is unwise.
37930 .next
37931 Using &%${match...}%& to apply a fixed regular expression against untrusted
37932 data may result in pathological behaviour within PCRE.  Be aware of what
37933 "backtracking" means and consider options for being more strict with a regular
37934 expression. Avenues to explore include limiting what can match (avoiding &`.`&
37935 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
37936 possessive quantifiers or just not using regular expressions against untrusted
37937 data.
37938 .next
37939 It can be important to correctly use &%${quote:...}%&,
37940 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
37941 items to ensure that data is correctly constructed.
37942 .next
37943 Some lookups might return multiple results, even though normal usage is only
37944 expected to yield one result.
37945 .endlist
37946
37947
37948
37949
37950 .section "IPv4 source routing" "SECID272"
37951 .cindex "source routing" "in IP packets"
37952 .cindex "IP source routing"
37953 Many operating systems suppress IP source-routed packets in the kernel, but
37954 some cannot be made to do this, so Exim does its own check. It logs incoming
37955 IPv4 source-routed TCP calls, and then drops them. Things are all different in
37956 IPv6. No special checking is currently done.
37957
37958
37959
37960 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
37961 Support for these SMTP commands is disabled by default. If required, they can
37962 be enabled by defining suitable ACLs.
37963
37964
37965
37966
37967 .section "Privileged users" "SECID274"
37968 .cindex "trusted users"
37969 .cindex "admin user"
37970 .cindex "privileged user"
37971 .cindex "user" "trusted"
37972 .cindex "user" "admin"
37973 Exim recognizes two sets of users with special privileges. Trusted users are
37974 able to submit new messages to Exim locally, but supply their own sender
37975 addresses and information about a sending host. For other users submitting
37976 local messages, Exim sets up the sender address from the uid, and doesn't
37977 permit a remote host to be specified.
37978
37979 .oindex "&%-f%&"
37980 However, an untrusted user is permitted to use the &%-f%& command line option
37981 in the special form &%-f <>%& to indicate that a delivery failure for the
37982 message should not cause an error report. This affects the message's envelope,
37983 but it does not affect the &'Sender:'& header. Untrusted users may also be
37984 permitted to use specific forms of address with the &%-f%& option by setting
37985 the &%untrusted_set_sender%& option.
37986
37987 Trusted users are used to run processes that receive mail messages from some
37988 other mail domain and pass them on to Exim for delivery either locally, or over
37989 the Internet. Exim trusts a caller that is running as root, as the Exim user,
37990 as any user listed in the &%trusted_users%& configuration option, or under any
37991 group listed in the &%trusted_groups%& option.
37992
37993 Admin users are permitted to do things to the messages on Exim's queue. They
37994 can freeze or thaw messages, cause them to be returned to their senders, remove
37995 them entirely, or modify them in various ways. In addition, admin users can run
37996 the Exim monitor and see all the information it is capable of providing, which
37997 includes the contents of files on the spool.
37998
37999 .oindex "&%-M%&"
38000 .oindex "&%-q%&"
38001 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
38002 delivery of messages on its queue is restricted to admin users. This
38003 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
38004 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
38005 queue is also restricted to admin users. This restriction can be relaxed by
38006 setting &%no_queue_list_requires_admin%&.
38007
38008 Exim recognizes an admin user if the calling process is running as root or as
38009 the Exim user or if any of the groups associated with the calling process is
38010 the Exim group. It is not necessary actually to be running under the Exim
38011 group. However, if admin users who are not root or the Exim user are to access
38012 the contents of files on the spool via the Exim monitor (which runs
38013 unprivileged), Exim must be built to allow group read access to its spool
38014 files.
38015
38016 .new
38017 By default, regular users are trusted to perform basic testing and
38018 introspection commands, as themselves.  This setting can be tightened by
38019 setting the &%commandline_checks_require_admin%& option.
38020 This affects most of the checking options,
38021 such as &%-be%& and anything else &%-b*%&.
38022 .wen
38023
38024
38025 .section "Spool files" "SECID275"
38026 .cindex "spool directory" "files"
38027 Exim's spool directory and everything it contains is owned by the Exim user and
38028 set to the Exim group. The mode for spool files is defined in the
38029 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
38030 any user who is a member of the Exim group can access these files.
38031
38032
38033
38034 .section "Use of argv[0]" "SECID276"
38035 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
38036 of specific strings, Exim assumes certain options. For example, calling Exim
38037 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
38038 to calling it with the option &%-bS%&. There are no security implications in
38039 this.
38040
38041
38042
38043 .section "Use of %f formatting" "SECID277"
38044 The only use made of &"%f"& by Exim is in formatting load average values. These
38045 are actually stored in integer variables as 1000 times the load average.
38046 Consequently, their range is limited and so therefore is the length of the
38047 converted output.
38048
38049
38050
38051 .section "Embedded Exim path" "SECID278"
38052 Exim uses its own path name, which is embedded in the code, only when it needs
38053 to re-exec in order to regain root privilege. Therefore, it is not root when it
38054 does so. If some bug allowed the path to get overwritten, it would lead to an
38055 arbitrary program's being run as exim, not as root.
38056
38057
38058
38059 .section "Dynamic module directory" "SECTdynmoddir"
38060 Any dynamically loadable modules must be installed into the directory
38061 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
38062 loading it.
38063
38064
38065 .section "Use of sprintf()" "SECID279"
38066 .cindex "&[sprintf()]&"
38067 A large number of occurrences of &"sprintf"& in the code are actually calls to
38068 &'string_sprintf()'&, a function that returns the result in malloc'd store.
38069 The intermediate formatting is done into a large fixed buffer by a function
38070 that runs through the format string itself, and checks the length of each
38071 conversion before performing it, thus preventing buffer overruns.
38072
38073 The remaining uses of &[sprintf()]& happen in controlled circumstances where
38074 the output buffer is known to be sufficiently long to contain the converted
38075 string.
38076
38077
38078
38079 .section "Use of debug_printf() and log_write()" "SECID280"
38080 Arbitrary strings are passed to both these functions, but they do their
38081 formatting by calling the function &'string_vformat()'&, which runs through
38082 the format string itself, and checks the length of each conversion.
38083
38084
38085
38086 .section "Use of strcat() and strcpy()" "SECID281"
38087 These are used only in cases where the output buffer is known to be large
38088 enough to hold the result.
38089 .ecindex IIDsecurcon
38090
38091
38092
38093
38094 . ////////////////////////////////////////////////////////////////////////////
38095 . ////////////////////////////////////////////////////////////////////////////
38096
38097 .chapter "Format of spool files" "CHAPspool"
38098 .scindex IIDforspo1 "format" "spool files"
38099 .scindex IIDforspo2 "spool directory" "format of files"
38100 .scindex IIDforspo3 "spool files" "format of"
38101 .cindex "spool files" "editing"
38102 A message on Exim's queue consists of two files, whose names are the message id
38103 followed by -D and -H, respectively. The data portion of the message is kept in
38104 the -D file on its own. The message's envelope, status, and headers are all
38105 kept in the -H file, whose format is described in this chapter. Each of these
38106 two files contains the final component of its own name as its first line. This
38107 is insurance against disk crashes where the directory is lost but the files
38108 themselves are recoverable.
38109
38110 Some people are tempted into editing -D files in order to modify messages. You
38111 need to be extremely careful if you do this; it is not recommended and you are
38112 on your own if you do it. Here are some of the pitfalls:
38113
38114 .ilist
38115 You must ensure that Exim does not try to deliver the message while you are
38116 fiddling with it. The safest way is to take out a write lock on the -D file,
38117 which is what Exim itself does, using &[fcntl()]&. If you update the file in
38118 place, the lock will be retained. If you write a new file and rename it, the
38119 lock will be lost at the instant of rename.
38120 .next
38121 .vindex "&$body_linecount$&"
38122 If you change the number of lines in the file, the value of
38123 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
38124 cause incomplete transmission of messages or undeliverable messages.
38125 .next
38126 If the message is in MIME format, you must take care not to break it.
38127 .next
38128 If the message is cryptographically signed, any change will invalidate the
38129 signature.
38130 .endlist
38131 All in all, modifying -D files is fraught with danger.
38132
38133 Files whose names end with -J may also be seen in the &_input_& directory (or
38134 its subdirectories when &%split_spool_directory%& is set). These are journal
38135 files, used to record addresses to which the message has been delivered during
38136 the course of a delivery attempt. If there are still undelivered recipients at
38137 the end, the -H file is updated, and the -J file is deleted. If, however, there
38138 is some kind of crash (for example, a power outage) before this happens, the -J
38139 file remains in existence. When Exim next processes the message, it notices the
38140 -J file and uses it to update the -H file before starting the next delivery
38141 attempt.
38142
38143 .new
38144 Files whose names end with -K or .eml may also be seen in the spool.
38145 These are temporaries used for DKIM or malware processing, when that is used.
38146 They should be tidied up by normal operations; any old ones are probably
38147 relics of crashes and can be removed.
38148 .wen
38149
38150 .section "Format of the -H file" "SECID282"
38151 .cindex "uid (user id)" "in spool file"
38152 .cindex "gid (group id)" "in spool file"
38153 The second line of the -H file contains the login name for the uid of the
38154 process that called Exim to read the message, followed by the numerical uid and
38155 gid. For a locally generated message, this is normally the user who sent the
38156 message. For a message received over TCP/IP via the daemon, it is
38157 normally the Exim user.
38158
38159 The third line of the file contains the address of the message's sender as
38160 transmitted in the envelope, contained in angle brackets. The sender address is
38161 empty for bounce messages. For incoming SMTP mail, the sender address is given
38162 in the MAIL command. For locally generated mail, the sender address is
38163 created by Exim from the login name of the current user and the configured
38164 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
38165 leading &"From&~"& line if the caller is trusted, or if the supplied address is
38166 &"<>"& or an address that matches &%untrusted_set_senders%&.
38167
38168 The fourth line contains two numbers. The first is the time that the message
38169 was received, in the conventional Unix form &-- the number of seconds since the
38170 start of the epoch. The second number is a count of the number of messages
38171 warning of delayed delivery that have been sent to the sender.
38172
38173 There follow a number of lines starting with a hyphen. These can appear in any
38174 order, and are omitted when not relevant:
38175
38176 .vlist
38177 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
38178 This item is obsolete, and is not generated from Exim release 4.61 onwards;
38179 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
38180 recognized, to provide backward compatibility. In the old format, a line of
38181 this form is present for every ACL variable that is not empty. The number
38182 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
38183 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
38184 the data string for the variable. The string itself starts at the beginning of
38185 the next line, and is followed by a newline character. It may contain internal
38186 newlines.
38187
38188 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
38189 A line of this form is present for every ACL connection variable that is
38190 defined. Note that there is a space between &%-aclc%& and the rest of the name.
38191 The length is the length of the data string for the variable. The string itself
38192 starts at the beginning of the next line, and is followed by a newline
38193 character. It may contain internal newlines.
38194
38195 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
38196 A line of this form is present for every ACL message variable that is defined.
38197 Note that there is a space between &%-aclm%& and the rest of the name. The
38198 length is the length of the data string for the variable. The string itself
38199 starts at the beginning of the next line, and is followed by a newline
38200 character. It may contain internal newlines.
38201
38202 .vitem "&%-active_hostname%&&~<&'hostname'&>"
38203 This is present if, when the message was received over SMTP, the value of
38204 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
38205
38206 .vitem &%-allow_unqualified_recipient%&
38207 This is present if unqualified recipient addresses are permitted in header
38208 lines (to stop such addresses from being qualified if rewriting occurs at
38209 transport time). Local messages that were input using &%-bnq%& and remote
38210 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
38211
38212 .vitem &%-allow_unqualified_sender%&
38213 This is present if unqualified sender addresses are permitted in header lines
38214 (to stop such addresses from being qualified if rewriting occurs at transport
38215 time). Local messages that were input using &%-bnq%& and remote messages from
38216 hosts that match &%sender_unqualified_hosts%& set this flag.
38217
38218 .vitem "&%-auth_id%&&~<&'text'&>"
38219 The id information for a message received on an authenticated SMTP connection
38220 &-- the value of the &$authenticated_id$& variable.
38221
38222 .vitem "&%-auth_sender%&&~<&'address'&>"
38223 The address of an authenticated sender &-- the value of the
38224 &$authenticated_sender$& variable.
38225
38226 .vitem "&%-body_linecount%&&~<&'number'&>"
38227 This records the number of lines in the body of the message, and is
38228 present unless &%-spool_file_wireformat%& is.
38229
38230 .vitem "&%-body_zerocount%&&~<&'number'&>"
38231 This records the number of binary zero bytes in the body of the message, and is
38232 present if the number is greater than zero.
38233
38234 .vitem &%-deliver_firsttime%&
38235 This is written when a new message is first added to the spool. When the spool
38236 file is updated after a deferral, it is omitted.
38237
38238 .vitem "&%-frozen%&&~<&'time'&>"
38239 .cindex "frozen messages" "spool data"
38240 The message is frozen, and the freezing happened at <&'time'&>.
38241
38242 .vitem "&%-helo_name%&&~<&'text'&>"
38243 This records the host name as specified by a remote host in a HELO or EHLO
38244 command.
38245
38246 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
38247 This records the IP address of the host from which the message was received and
38248 the remote port number that was used. It is omitted for locally generated
38249 messages.
38250
38251 .vitem "&%-host_auth%&&~<&'text'&>"
38252 If the message was received on an authenticated SMTP connection, this records
38253 the name of the authenticator &-- the value of the
38254 &$sender_host_authenticated$& variable.
38255
38256 .vitem &%-host_lookup_failed%&
38257 This is present if an attempt to look up the sending host's name from its IP
38258 address failed. It corresponds to the &$host_lookup_failed$& variable.
38259
38260 .vitem "&%-host_name%&&~<&'text'&>"
38261 .cindex "reverse DNS lookup"
38262 .cindex "DNS" "reverse lookup"
38263 This records the name of the remote host from which the message was received,
38264 if the host name was looked up from the IP address when the message was being
38265 received. It is not present if no reverse lookup was done.
38266
38267 .vitem "&%-ident%&&~<&'text'&>"
38268 For locally submitted messages, this records the login of the originating user,
38269 unless it was a trusted user and the &%-oMt%& option was used to specify an
38270 ident value. For messages received over TCP/IP, this records the ident string
38271 supplied by the remote host, if any.
38272
38273 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
38274 This records the IP address of the local interface and the port number through
38275 which a message was received from a remote host. It is omitted for locally
38276 generated messages.
38277
38278 .vitem &%-local%&
38279 The message is from a local sender.
38280
38281 .vitem &%-localerror%&
38282 The message is a locally-generated bounce message.
38283
38284 .vitem "&%-local_scan%&&~<&'string'&>"
38285 This records the data string that was returned by the &[local_scan()]& function
38286 when the message was received &-- the value of the &$local_scan_data$&
38287 variable. It is omitted if no data was returned.
38288
38289 .vitem &%-manual_thaw%&
38290 The message was frozen but has been thawed manually, that is, by an explicit
38291 Exim command rather than via the auto-thaw process.
38292
38293 .vitem &%-N%&
38294 A testing delivery process was started using the &%-N%& option to suppress any
38295 actual deliveries, but delivery was deferred. At any further delivery attempts,
38296 &%-N%& is assumed.
38297
38298 .vitem &%-received_protocol%&
38299 This records the value of the &$received_protocol$& variable, which contains
38300 the name of the protocol by which the message was received.
38301
38302 .vitem &%-sender_set_untrusted%&
38303 The envelope sender of this message was set by an untrusted local caller (used
38304 to ensure that the caller is displayed in queue listings).
38305
38306 .vitem "&%-spam_score_int%&&~<&'number'&>"
38307 If a message was scanned by SpamAssassin, this is present. It records the value
38308 of &$spam_score_int$&.
38309
38310 .new
38311 .vitem &%-spool_file_wireformat%&
38312 The -D file for this message is in wire-format (for ESMTP CHUNKING)
38313 rather than Unix-format.
38314 The line-ending is CRLF rather than newline.
38315 There is still, however, no leading-dot-stuffing.
38316 .wen
38317
38318 .vitem &%-tls_certificate_verified%&
38319 A TLS certificate was received from the client that sent this message, and the
38320 certificate was verified by the server.
38321
38322 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
38323 When the message was received over an encrypted connection, this records the
38324 name of the cipher suite that was used.
38325
38326 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
38327 When the message was received over an encrypted connection, and a certificate
38328 was received from the client, this records the Distinguished Name from that
38329 certificate.
38330 .endlist
38331
38332 Following the options there is a list of those addresses to which the message
38333 is not to be delivered. This set of addresses is initialized from the command
38334 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
38335 is set; otherwise it starts out empty. Whenever a successful delivery is made,
38336 the address is added to this set. The addresses are kept internally as a
38337 balanced binary tree, and it is a representation of that tree which is written
38338 to the spool file. If an address is expanded via an alias or forward file, the
38339 original address is added to the tree when deliveries to all its child
38340 addresses are complete.
38341
38342 If the tree is empty, there is a single line in the spool file containing just
38343 the text &"XX"&. Otherwise, each line consists of two letters, which are either
38344 Y or N, followed by an address. The address is the value for the node of the
38345 tree, and the letters indicate whether the node has a left branch and/or a
38346 right branch attached to it, respectively. If branches exist, they immediately
38347 follow. Here is an example of a three-node tree:
38348 .code
38349 YY darcy@austen.fict.example
38350 NN alice@wonderland.fict.example
38351 NN editor@thesaurus.ref.example
38352 .endd
38353 After the non-recipients tree, there is a list of the message's recipients.
38354 This is a simple list, preceded by a count. It includes all the original
38355 recipients of the message, including those to whom the message has already been
38356 delivered. In the simplest case, the list contains one address per line. For
38357 example:
38358 .code
38359 4
38360 editor@thesaurus.ref.example
38361 darcy@austen.fict.example
38362 rdo@foundation
38363 alice@wonderland.fict.example
38364 .endd
38365 However, when a child address has been added to the top-level addresses as a
38366 result of the use of the &%one_time%& option on a &(redirect)& router, each
38367 line is of the following form:
38368 .display
38369 <&'top-level address'&> <&'errors_to address'&> &&&
38370   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
38371 .endd
38372 The 01 flag bit indicates the presence of the three other fields that follow
38373 the top-level address. Other bits may be used in future to support additional
38374 fields. The <&'parent number'&> is the offset in the recipients list of the
38375 original parent of the &"one time"& address. The first two fields are the
38376 envelope sender that is associated with this address and its length. If the
38377 length is zero, there is no special envelope sender (there are then two space
38378 characters in the line). A non-empty field can arise from a &(redirect)& router
38379 that has an &%errors_to%& setting.
38380
38381
38382 A blank line separates the envelope and status information from the headers
38383 which follow. A header may occupy several lines of the file, and to save effort
38384 when reading it in, each header is preceded by a number and an identifying
38385 character. The number is the number of characters in the header, including any
38386 embedded newlines and the terminating newline. The character is one of the
38387 following:
38388
38389 .table2 50pt
38390 .row <&'blank'&>         "header in which Exim has no special interest"
38391 .row &`B`&               "&'Bcc:'& header"
38392 .row &`C`&               "&'Cc:'& header"
38393 .row &`F`&               "&'From:'& header"
38394 .row &`I`&               "&'Message-id:'& header"
38395 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
38396 .row &`R`&               "&'Reply-To:'& header"
38397 .row &`S`&               "&'Sender:'& header"
38398 .row &`T`&               "&'To:'& header"
38399 .row &`*`&               "replaced or deleted header"
38400 .endtable
38401
38402 Deleted or replaced (rewritten) headers remain in the spool file for debugging
38403 purposes. They are not transmitted when the message is delivered. Here is a
38404 typical set of headers:
38405 .code
38406 111P Received: by hobbit.fict.example with local (Exim 4.00)
38407 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
38408 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
38409 038* X-rewrote-sender: bb@hobbit.fict.example
38410 042* From: Bilbo Baggins <bb@hobbit.fict.example>
38411 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
38412 099* To: alice@wonderland.fict.example, rdo@foundation,
38413 darcy@austen.fict.example, editor@thesaurus.ref.example
38414 104T To: alice@wonderland.fict.example, rdo@foundation.example,
38415 darcy@austen.fict.example, editor@thesaurus.ref.example
38416 038  Date: Fri, 11 May 2001 10:28:59 +0100
38417 .endd
38418 The asterisked headers indicate that the envelope sender, &'From:'& header, and
38419 &'To:'& header have been rewritten, the last one because routing expanded the
38420 unqualified domain &'foundation'&.
38421 .ecindex IIDforspo1
38422 .ecindex IIDforspo2
38423 .ecindex IIDforspo3
38424
38425 .new
38426 .section "Format of the -D file" "SECID282a"
38427 The data file is traditionally in Unix-standard format: lines are ended with
38428 an ASCII newline character.
38429 However, when the &%spool_wireformat%& main option is used some -D files
38430 can have an alternate format.
38431 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
38432 The -D file lines (not including the first name-component line) are
38433 suitable for direct copying to the wire when transmitting using the
38434 ESMTP CHUNKING option, meaning lower processing overhead.
38435 Lines are terminated with an ASCII CRLF pair.
38436 There is no dot-stuffing (and no dot-termination).
38437 .wen
38438
38439 . ////////////////////////////////////////////////////////////////////////////
38440 . ////////////////////////////////////////////////////////////////////////////
38441
38442 .chapter "Support for DKIM (DomainKeys Identified Mail)" "CHAPdkim" &&&
38443          "DKIM Support"
38444 .cindex "DKIM"
38445
38446 DKIM is a mechanism by which messages sent by some entity can be provably
38447 linked to a domain which that entity controls.  It permits reputation to
38448 be tracked on a per-domain basis, rather than merely upon source IP address.
38449 DKIM is documented in RFC 4871.
38450
38451 DKIM support is compiled into Exim by default if TLS support is present.
38452 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
38453
38454 Exim's DKIM implementation allows for
38455 .olist
38456 Signing outgoing messages: This function is implemented in the SMTP transport.
38457 It can co-exist with all other Exim features
38458 (including transport filters)
38459 except cutthrough delivery.
38460 .next
38461 Verifying signatures in incoming messages: This is implemented by an additional
38462 ACL (acl_smtp_dkim), which can be called several times per message, with
38463 different signature contexts.
38464 .endlist
38465
38466 In typical Exim style, the verification implementation does not include any
38467 default "policy". Instead it enables you to build your own policy using
38468 Exim's standard controls.
38469
38470 Please note that verification of DKIM signatures in incoming mail is turned
38471 on by default for logging purposes. For each signature in incoming email,
38472 exim will log a line displaying the most important signature details, and the
38473 signature status. Here is an example (with line-breaks added for clarity):
38474 .code
38475 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
38476     d=facebookmail.com s=q1-2009b
38477     c=relaxed/relaxed a=rsa-sha1
38478     i=@facebookmail.com t=1252484542 [verification succeeded]
38479 .endd
38480 You might want to turn off DKIM verification processing entirely for internal
38481 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
38482 control modifier. This should typically be done in the RCPT ACL, at points
38483 where you accept mail from relay sources (internal hosts or authenticated
38484 senders).
38485
38486
38487 .section "Signing outgoing messages" "SECDKIMSIGN"
38488 .cindex "DKIM" "signing"
38489
38490 Signing is enabled by setting private options on the SMTP transport.
38491 These options take (expandable) strings as arguments.
38492
38493 .option dkim_domain smtp string list&!! unset
38494 The domain(s) you want to sign with.
38495 .new
38496 After expansion, this can be a list.
38497 Each element in turn is put into the &%$dkim_domain%& expansion variable
38498 while expanding the remaining signing options.
38499 .wen
38500 If it is empty after expansion, DKIM signing is not done.
38501
38502 .option dkim_selector smtp string&!! unset
38503 This sets the key selector string.
38504 You can use the &%$dkim_domain%& expansion variable to look up a matching selector.
38505 The result is put in the expansion
38506 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
38507 option along with &%$dkim_domain%&.
38508 If the option is empty after expansion, DKIM signing is not done.
38509
38510 .option dkim_private_key smtp string&!! unset
38511 This sets the private key to use.
38512 You can use the &%$dkim_domain%& and
38513 &%$dkim_selector%& expansion variables to determine the private key to use.
38514 The result can either
38515 .ilist
38516 be a valid RSA private key in ASCII armor, including line breaks.
38517 .next
38518 start with a slash, in which case it is treated as a file that contains
38519 the private key.
38520 .next
38521 be "0", "false" or the empty string, in which case the message will not
38522 be signed. This case will not result in an error, even if &%dkim_strict%&
38523 is set.
38524 .endlist
38525 If the option is empty after expansion, DKIM signing is not done.
38526
38527 .option dkim_canon smtp string&!! unset
38528 This option sets the canonicalization method used when signing a message.
38529 The DKIM RFC currently supports two methods: "simple" and "relaxed".
38530 The option defaults to "relaxed" when unset. Note: the current implementation
38531 only supports using the same canonicalization method for both headers and body.
38532
38533 .option dkim_strict smtp string&!! unset
38534 This  option  defines  how  Exim  behaves  when  signing a message that
38535 should be signed fails for some reason.  When the expansion evaluates to
38536 either "1" or "true", Exim will defer. Otherwise Exim will send the message
38537 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
38538 variables here.
38539
38540 .option dkim_sign_headers smtp string&!! unset
38541 If set, this option must expand to (or be specified as) a colon-separated
38542 list of header names. Headers with these names will be included in the message
38543 signature.
38544 When unspecified, the header names recommended in RFC4871 will be used.
38545
38546
38547 .section "Verifying DKIM signatures in incoming mail" "SECID514"
38548 .cindex "DKIM" "verification"
38549
38550 Verification of DKIM signatures in SMTP incoming email is implemented via the
38551 &%acl_smtp_dkim%& ACL. By default, this ACL is called once for each
38552 syntactically(!) correct signature in the incoming message.
38553 A missing ACL definition defaults to accept.
38554 If any ACL call does not accept, the message is not accepted.
38555 If a cutthrough delivery was in progress for the message it is
38556 summarily dropped (having wasted the transmission effort).
38557
38558 To evaluate the signature in the ACL a large number of expansion variables
38559 containing the signature status and its details are set up during the
38560 runtime of the ACL.
38561
38562 Calling the ACL only for existing signatures is not sufficient to build
38563 more advanced policies. For that reason, the global option
38564 &%dkim_verify_signers%&, and a global expansion variable
38565 &%$dkim_signers%& exist.
38566
38567 The global option &%dkim_verify_signers%& can be set to a colon-separated
38568 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
38569 called. It is expanded when the message has been received. At this point,
38570 the expansion variable &%$dkim_signers%& already contains a colon-separated
38571 list of signer domains and identities for the message. When
38572 &%dkim_verify_signers%& is not specified in the main configuration,
38573 it defaults as:
38574 .code
38575 dkim_verify_signers = $dkim_signers
38576 .endd
38577 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
38578 DKIM signature in the message. Current DKIM verifiers may want to explicitly
38579 call the ACL for known domains or identities. This would be achieved as follows:
38580 .code
38581 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
38582 .endd
38583 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
38584 and "ebay.com", plus all domains and identities that have signatures in the message.
38585 You can also be more creative in constructing your policy. For example:
38586 .code
38587 dkim_verify_signers = $sender_address_domain:$dkim_signers
38588 .endd
38589
38590 If a domain or identity is listed several times in the (expanded) value of
38591 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
38592
38593
38594 Inside the &%acl_smtp_dkim%&, the following expansion variables are
38595 available (from most to least important):
38596
38597
38598 .vlist
38599 .vitem &%$dkim_cur_signer%&
38600 The signer that is being evaluated in this ACL run. This can be a domain or
38601 an identity. This is one of the list items from the expanded main option
38602 &%dkim_verify_signers%& (see above).
38603
38604 .vitem &%$dkim_verify_status%&
38605 A string describing the general status of the signature. One of
38606 .ilist
38607 &%none%&: There is no signature in the message for the current domain or
38608 identity (as reflected by &%$dkim_cur_signer%&).
38609 .next
38610 &%invalid%&: The signature could not be verified due to a processing error.
38611 More detail is available in &%$dkim_verify_reason%&.
38612 .next
38613 &%fail%&: Verification of the signature failed.  More detail is
38614 available in &%$dkim_verify_reason%&.
38615 .next
38616 &%pass%&: The signature passed verification. It is valid.
38617 .endlist
38618
38619 .vitem &%$dkim_verify_reason%&
38620 A string giving a little bit more detail when &%$dkim_verify_status%& is either
38621 "fail" or "invalid". One of
38622 .ilist
38623 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
38624 key for the domain could not be retrieved. This may be a temporary problem.
38625 .next
38626 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
38627 record for the domain is syntactically invalid.
38628 .next
38629 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
38630 body hash does not match the one specified in the signature header. This
38631 means that the message body was modified in transit.
38632 .next
38633 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
38634 could not be verified. This may mean that headers were modified,
38635 re-written or otherwise changed in a way which is incompatible with
38636 DKIM verification. It may of course also mean that the signature is forged.
38637 .endlist
38638
38639 .vitem &%$dkim_domain%&
38640 The signing domain. IMPORTANT: This variable is only populated if there is
38641 an actual signature in the message for the current domain or identity (as
38642 reflected by &%$dkim_cur_signer%&).
38643
38644 .vitem &%$dkim_identity%&
38645 The signing identity, if present. IMPORTANT: This variable is only populated
38646 if there is an actual signature in the message for the current domain or
38647 identity (as reflected by &%$dkim_cur_signer%&).
38648
38649 .vitem &%$dkim_selector%&
38650 The key record selector string.
38651
38652 .vitem &%$dkim_algo%&
38653 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
38654
38655 .vitem &%$dkim_canon_body%&
38656 The body canonicalization method. One of 'relaxed' or 'simple'.
38657
38658 .vitem &%$dkim_canon_headers%&
38659 The header canonicalization method. One of 'relaxed' or 'simple'.
38660
38661 .vitem &%$dkim_copiedheaders%&
38662 A transcript of headers and their values which are included in the signature
38663 (copied from the 'z=' tag of the signature).
38664 Note that RFC6376 requires that verification fail if the From: header is
38665 not included in the signature.  Exim does not enforce this; sites wishing
38666 strict enforcement should code the check explicitly.
38667
38668 .vitem &%$dkim_bodylength%&
38669 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
38670 limit was set by the signer, "9999999999999" is returned. This makes sure
38671 that this variable always expands to an integer value.
38672
38673 .vitem &%$dkim_created%&
38674 UNIX timestamp reflecting the date and time when the signature was created.
38675 When this was not specified by the signer, "0" is returned.
38676
38677 .vitem &%$dkim_expires%&
38678 UNIX timestamp reflecting the date and time when the signer wants the
38679 signature to be treated as "expired". When this was not specified by the
38680 signer, "9999999999999" is returned. This makes it possible to do useful
38681 integer size comparisons against this value.
38682
38683 .vitem &%$dkim_headernames%&
38684 A colon-separated list of names of headers included in the signature.
38685
38686 .vitem &%$dkim_key_testing%&
38687 "1" if the key record has the "testing" flag set, "0" if not.
38688
38689 .vitem &%$dkim_key_nosubdomains%&
38690 "1" if the key record forbids subdomaining, "0" otherwise.
38691
38692 .vitem &%$dkim_key_srvtype%&
38693 Service type (tag s=) from the key record. Defaults to "*" if not specified
38694 in the key record.
38695
38696 .vitem &%$dkim_key_granularity%&
38697 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
38698 in the key record.
38699
38700 .vitem &%$dkim_key_notes%&
38701 Notes from the key record (tag n=).
38702
38703 .vitem &%$dkim_key_length%&
38704 Number of bits in the key.
38705 .endlist
38706
38707 In addition, two ACL conditions are provided:
38708
38709 .vlist
38710 .vitem &%dkim_signers%&
38711 ACL condition that checks a colon-separated list of domains or identities
38712 for a match against the domain or identity that the ACL is currently verifying
38713 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
38714 verb to a group of domains or identities. For example:
38715
38716 .code
38717 # Warn when Mail purportedly from GMail has no gmail signature
38718 warn log_message = GMail sender without gmail.com DKIM signature
38719      sender_domains = gmail.com
38720      dkim_signers = gmail.com
38721      dkim_status = none
38722 .endd
38723
38724 Note that the above does not check for a total lack of DKIM signing;
38725 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
38726
38727 .vitem &%dkim_status%&
38728 ACL condition that checks a colon-separated list of possible DKIM verification
38729 results against the actual result of verification. This is typically used
38730 to restrict an ACL verb to a list of verification outcomes, for example:
38731
38732 .code
38733 deny message = Mail from Paypal with invalid/missing signature
38734      sender_domains = paypal.com:paypal.de
38735      dkim_signers = paypal.com:paypal.de
38736      dkim_status = none:invalid:fail
38737 .endd
38738
38739 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
38740 see the documentation of the &%$dkim_verify_status%& expansion variable above
38741 for more information of what they mean.
38742 .endlist
38743
38744 . ////////////////////////////////////////////////////////////////////////////
38745 . ////////////////////////////////////////////////////////////////////////////
38746
38747 .chapter "Proxies" "CHAPproxies" &&&
38748          "Proxy support"
38749 .cindex "proxy support"
38750 .cindex "proxy" "access via"
38751
38752 A proxy is an intermediate system through which communication is passed.
38753 Proxies may provide a security, availability or load-distribution function.
38754
38755
38756 .section "Inbound proxies" SECTproxyInbound
38757 .cindex proxy inbound
38758 .cindex proxy "server side"
38759 .cindex proxy "Proxy protocol"
38760 .cindex "Proxy protocol" proxy
38761
38762 Exim has support for receiving inbound SMTP connections via a proxy
38763 that uses &"Proxy Protocol"& to speak to it.
38764 To include this support, include &"SUPPORT_PROXY=yes"&
38765 in Local/Makefile.
38766
38767 It was built on specifications from:
38768 (&url(http://haproxy.1wt.eu/download/1.5/doc/proxy-protocol.txt)).
38769 That URL was revised in May 2014 to version 2 spec:
38770 (&url(http://git.1wt.eu/web?p=haproxy.git;a=commitdiff;h=afb768340c9d7e50d8e)).
38771
38772 The purpose of this facility is so that an application load balancer,
38773 such as HAProxy, can sit in front of several Exim servers
38774 to distribute load.
38775 Exim uses the local protocol communication with the proxy to obtain
38776 the remote SMTP system IP address and port information.
38777 There is no logging if a host passes or
38778 fails Proxy Protocol negotiation, but it can easily be determined and
38779 recorded in an ACL (example is below).
38780
38781 Use of a proxy is enabled by setting the &%hosts_proxy%&
38782 main configuration option to a hostlist; connections from these
38783 hosts will use Proxy Protocol.
38784 Exim supports both version 1 and version 2 of the Proxy Protocol and
38785 automatically determines which version is in use.
38786
38787 The Proxy Protocol header is the first data received on a TCP connection
38788 and is inserted before any TLS-on-connect handshake from the client; Exim
38789 negotiates TLS between Exim-as-server and the remote client, not between
38790 Exim and the proxy server.
38791
38792 The following expansion variables are usable
38793 (&"internal"& and &"external"& here refer to the interfaces
38794 of the proxy):
38795 .display
38796 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
38797 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
38798 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
38799 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
38800 &'proxy_session            '& boolean: SMTP connection via proxy
38801 .endd
38802 If &$proxy_session$& is set but &$proxy_external_address$& is empty
38803 there was a protocol error.
38804
38805 Since the real connections are all coming from the proxy, and the
38806 per host connection tracking is done before Proxy Protocol is
38807 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
38808 handle all of the parallel volume you expect per inbound proxy.
38809 With the option set so high, you lose the ability
38810 to protect your server from many connections from one IP.
38811 In order to prevent your server from overload, you
38812 need to add a per connection ratelimit to your connect ACL.
38813 A possible solution is:
38814 .display
38815   # Set max number of connections per host
38816   LIMIT   = 5
38817   # Or do some kind of IP lookup in a flat file or database
38818   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
38819
38820   defer   message        = Too many connections from this IP right now
38821           ratelimit      = LIMIT / 5s / per_conn / strict
38822 .endd
38823
38824
38825
38826 .section "Outbound proxies" SECTproxySOCKS
38827 .cindex proxy outbound
38828 .cindex proxy "client side"
38829 .cindex proxy SOCKS
38830 .cindex SOCKS proxy
38831 Exim has support for sending outbound SMTP via a proxy
38832 using a protocol called SOCKS5 (defined by RFC1928).
38833 The support can be optionally included by defining SUPPORT_SOCKS=yes in
38834 Local/Makefile.
38835
38836 Use of a proxy is enabled by setting the &%socks_proxy%& option
38837 on an smtp transport.
38838 The option value is expanded and should then be a list
38839 (colon-separated by default) of proxy specifiers.
38840 Each proxy specifier is a list
38841 (space-separated by default) where the initial element
38842 is an IP address and any subsequent elements are options.
38843
38844 Options are a string <name>=<value>.
38845 The list of options is in the following table:
38846 .display
38847 &'auth   '& authentication method
38848 &'name   '& authentication username
38849 &'pass   '& authentication password
38850 &'port   '& tcp port
38851 &'tmo    '& connection timeout
38852 &'pri    '& priority
38853 &'weight '& selection bias
38854 .endd
38855
38856 More details on each of these options follows:
38857
38858 .ilist
38859 .cindex authentication "to proxy"
38860 .cindex proxy authentication
38861 &%auth%&: Either &"none"& (default) or &"name"&.
38862 Using &"name"& selects username/password authentication per RFC 1929
38863 for access to the proxy.
38864 Default is &"none"&.
38865 .next
38866 &%name%&: sets the username for the &"name"& authentication method.
38867 Default is empty.
38868 .next
38869 &%pass%&: sets the password for the &"name"& authentication method.
38870 Default is empty.
38871 .next
38872 &%port%&: the TCP port number to use for the connection to the proxy.
38873 Default is 1080.
38874 .next
38875 &%tmo%&: sets a connection timeout in seconds for this proxy.
38876 Default is 5.
38877 .next
38878 &%pri%&: specifies a priority for the proxy within the list,
38879 higher values being tried first.
38880 The default priority is 1.
38881 .next
38882 &%weight%&: specifies a selection bias.
38883 Within a priority set servers are queried in a random fashion,
38884 weighted by this value.
38885 The default value for selection bias is 1.
38886 .endlist
38887
38888 Proxies from the list are tried according to their priority
38889 and weight settings until one responds.  The timeout for the
38890 overall connection applies to the set of proxied attempts.
38891
38892 .section Logging SECTproxyLog
38893 To log the (local) IP of a proxy in the incoming or delivery logline,
38894 add &"+proxy"& to the &%log_selector%& option.
38895 This will add a component tagged with &"PRX="& to the line.
38896
38897 . ////////////////////////////////////////////////////////////////////////////
38898 . ////////////////////////////////////////////////////////////////////////////
38899
38900 .chapter "Internationalisation" "CHAPi18n" &&&
38901          "Internationalisation""
38902 .cindex internationalisation "email address"
38903 .cindex EAI
38904 .cindex i18n
38905 .cindex UTF-8 "mail name handling"
38906
38907 Exim has support for Internationalised mail names.
38908 To include this it must be built with SUPPORT_I18N and the libidn library.
38909 Standards supported are RFCs 2060, 5890, 6530 and 6533.
38910
38911 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
38912 instead of it) then IDNA2008 is supported; this adds an extra library
38913 requirement, upon libidn2.
38914
38915 .section "MTA operations" SECTi18nMTA
38916 .cindex SMTPUTF8 "ESMTP option"
38917 The main configuration option &%smtputf8_advertise_hosts%& specifies
38918 a host list.  If this matches the sending host and
38919 accept_8bitmime is true (the default) then the ESMTP option
38920 SMTPUTF8 will be advertised.
38921
38922 If the sender specifies the SMTPUTF8 option on a MAIL command
38923 international handling for the message is enabled and
38924 the expansion variable &$message_smtputf8$& will have value TRUE.
38925
38926 The option &%allow_utf8_domains%& is set to true for this
38927 message. All DNS lookups are converted to a-label form
38928 whatever the setting of &%allow_utf8_domains%&
38929 when Exim is built with SUPPORT_I18N.
38930
38931 Both localparts and domain are maintained as the original
38932 UTF-8 form internally; any comparison or regular-expression use will
38933 require appropriate care.  Filenames created, eg. by
38934 the appendfile transport, will have UTF-8 names.
38935
38936 HELO names sent by the smtp transport will have any UTF-8
38937 components expanded to a-label form,
38938 and any certificate name checks will be done using the a-label
38939 form of the name.
38940
38941 .cindex log protocol
38942 .cindex SMTPUTF8 logging
38943 Log lines and Received-by: header lines will acquire a "utf8"
38944 prefix on the protocol element, eg. utf8esmtp.
38945
38946 The following expansion operators can be used:
38947 .code
38948 ${utf8_domain_to_alabel:str}
38949 ${utf8_domain_from_alabel:str}
38950 ${utf8_localpart_to_alabel:str}
38951 ${utf8_localpart_from_alabel:str}
38952 .endd
38953
38954 ACLs may use the following modifier:
38955 .display
38956 control = utf8_downconvert
38957 control = utf8_downconvert/<value>
38958 .endd
38959 This sets a flag requiring that addresses are converted to
38960 a-label form before smtp delivery, for use in a
38961 Message Submission Agent context.
38962 If a value is appended it may be:
38963 .display
38964 &`1  `& (default) mandatory downconversion
38965 &`0  `& no downconversion
38966 &`-1 `& if SMTPUTF8 not supported by destination host
38967 .endd
38968
38969 If mua_wrapper is set, the utf8_downconvert control
38970 is initially set to -1.
38971
38972
38973 There is no explicit support for VRFY and EXPN.
38974 Configurations supporting these should inspect
38975 &$smtp_command_argument$& for an SMTPUTF8 argument.
38976
38977 There is no support for LMTP on Unix sockets.
38978 Using the "lmtp" protocol option on an smtp transport,
38979 for LMTP over TCP, should work as expected.
38980
38981 There is no support for DSN unitext handling,
38982 and no provision for converting logging from or to UTF-8.
38983
38984
38985
38986 .section "MDA operations" SECTi18nMDA
38987 To aid in constructing names suitable for IMAP folders
38988 the following expansion operator can be used:
38989 .code
38990 ${imapfolder {<string>} {<sep>} {<specials>}}
38991 .endd
38992
38993 The string is converted from the charset specified by
38994 the "headers charset" command (in a filter file)
38995 or &%headers_charset%& main configuration option (otherwise),
38996 to the
38997 modified UTF-7 encoding specified by RFC 2060,
38998 with the following exception: All occurences of <sep>
38999 (which has to be a single character)
39000 are replaced with periods ("."), and all periods and slashes that are not
39001 <sep> and are not in the <specials> string are BASE64 encoded.
39002
39003 The third argument can be omitted, defaulting to an empty string.
39004 The second argument can be omitted, defaulting to "/".
39005
39006 This is the encoding used by Courier for Maildir names on disk, and followed
39007 by many other IMAP servers.
39008
39009 Examples:
39010 .display
39011 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
39012 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
39013 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
39014 .endd
39015
39016 Note that the source charset setting is vital, and also that characters
39017 must be representable in UTF-16.
39018
39019
39020 . ////////////////////////////////////////////////////////////////////////////
39021 . ////////////////////////////////////////////////////////////////////////////
39022
39023 .chapter "Events" "CHAPevents" &&&
39024          "Events"
39025 .cindex events
39026
39027 The events mechanism in Exim can be used to intercept processing at a number
39028 of points.  It was originally invented to give a way to do customised logging
39029 actions (for example, to a database) but can also be used to modify some
39030 processing actions.
39031
39032 Most installations will never need to use Events.
39033 The support can be left out of a build by defining DISABLE_EVENT=yes
39034 in &_Local/Makefile_&.
39035
39036 There are two major classes of events: main and transport.
39037 The main configuration option &%event_action%& controls reception events;
39038 a transport option &%event_action%& controls delivery events.
39039
39040 Both options are a string which is expanded when the event fires.
39041 An example might look like:
39042 .cindex logging custom
39043 .code
39044 event_action = ${if eq {msg:delivery}{$event_name} \
39045 {${lookup pgsql {SELECT * FROM record_Delivery( \
39046     '${quote_pgsql:$sender_address_domain}',\
39047     '${quote_pgsql:${lc:$sender_address_local_part}}', \
39048     '${quote_pgsql:$domain}', \
39049     '${quote_pgsql:${lc:$local_part}}', \
39050     '${quote_pgsql:$host_address}', \
39051     '${quote_pgsql:${lc:$host}}', \
39052     '${quote_pgsql:$message_exim_id}')}} \
39053 } {}}
39054 .endd
39055
39056 Events have names which correspond to the point in process at which they fire.
39057 The name is placed in the variable &$event_name$& and the event action
39058 expansion must check this, as it will be called for every possible event type.
39059
39060 The current list of events is:
39061 .display
39062 &`msg:complete           after    main       `& per message
39063 &`msg:delivery           after    transport  `& per recipient
39064 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
39065 &`msg:rcpt:defer         after    transport  `& per recipient
39066 &`msg:host:defer         after    transport  `& per attempt
39067 &`msg:fail:delivery      after    transport  `& per recipient
39068 &`msg:fail:internal      after    main       `& per recipient
39069 &`tcp:connect            before   transport  `& per connection
39070 &`tcp:close              after    transport  `& per connection
39071 &`tls:cert               before   both       `& per certificate in verification chain
39072 &`smtp:connect           after    transport  `& per connection
39073 .endd
39074 New event types may be added in future.
39075
39076 The event name is a colon-separated list, defining the type of
39077 event in a tree of possibilities.  It may be used as a list
39078 or just matched on as a whole.  There will be no spaces in the name.
39079
39080 The second column in the table above describes whether the event fires
39081 before or after the action is associates with.  Those which fire before
39082 can be used to affect that action (more on this below).
39083
39084 .new
39085 The third column in the table above says what section of the configumration
39086 should define the event action.
39087 .wen
39088
39089 An additional variable, &$event_data$&, is filled with information varying
39090 with the event type:
39091 .display
39092 &`msg:delivery         `& smtp confirmation message
39093 &`msg:rcpt:host:defer  `& error string
39094 &`msg:rcpt:defer       `& error string
39095 &`msg:host:defer       `& error string
39096 &`tls:cert             `& verification chain depth
39097 &`smtp:connect         `& smtp banner
39098 .endd
39099
39100 The :defer events populate one extra variable: &$event_defer_errno$&.
39101
39102 For complex operations an ACL expansion can be used in &%event_action%&
39103 however due to the multiple contexts that Exim operates in during
39104 the course of its processing:
39105 .ilist
39106 variables set in transport events will not be visible outside that
39107 transport call
39108 .next
39109 acl_m variables in a server context are lost on a new connection,
39110 and after smtp helo/ehlo/mail/starttls/rset commands
39111 .endlist
39112 Using an ACL expansion with the logwrite modifier can be
39113 a useful way of writing to the main log.
39114
39115 The expansion of the event_action option should normally
39116 return an empty string.  Should it return anything else the
39117 following will be forced:
39118 .display
39119 &`msg:delivery     `&  (ignored)
39120 &`msg:host:defer   `&  (ignored)
39121 &`msg:fail:delivery`&  (ignored)
39122 &`tcp:connect      `&  do not connect
39123 &`tcp:close        `&  (ignored)
39124 &`tls:cert         `&  refuse verification
39125 &`smtp:connect     `&  close connection
39126 .endd
39127 No other use is made of the result string.
39128
39129 For a tcp:connect event, if the connection is being made to a proxy
39130 then the address and port variables will be that of the proxy and not
39131 the target system.
39132
39133 For tls:cert events, if GnuTLS is in use this will trigger only per
39134 chain element received on the connection.
39135 For OpenSSL it will trigger for every chain element including those
39136 loaded locally.
39137
39138 . ////////////////////////////////////////////////////////////////////////////
39139 . ////////////////////////////////////////////////////////////////////////////
39140
39141 .chapter "Adding new drivers or lookup types" "CHID13" &&&
39142          "Adding drivers or lookups"
39143 .cindex "adding drivers"
39144 .cindex "new drivers, adding"
39145 .cindex "drivers" "adding new"
39146 The following actions have to be taken in order to add a new router, transport,
39147 authenticator, or lookup type to Exim:
39148
39149 .olist
39150 Choose a name for the driver or lookup type that does not conflict with any
39151 existing name; I will use &"newdriver"& in what follows.
39152 .next
39153 Add to &_src/EDITME_& the line:
39154 .display
39155 <&'type'&>&`_NEWDRIVER=yes`&
39156 .endd
39157 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
39158 code is not to be included in the binary by default, comment this line out. You
39159 should also add any relevant comments about the driver or lookup type.
39160 .next
39161 Add to &_src/config.h.defaults_& the line:
39162 .code
39163 #define <type>_NEWDRIVER
39164 .endd
39165 .next
39166 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
39167 and create a table entry as is done for all the other drivers and lookup types.
39168 .next
39169 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
39170 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
39171 Add your &`NEWDRIVER`& to that list.
39172 As long as the dynamic module would be named &_newdriver.so_&, you can use the
39173 simple form that most lookups have.
39174 .next
39175 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
39176 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
39177 driver or lookup type and add it to the definition of OBJ.
39178 .next
39179 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
39180 &_src_&.
39181 .next
39182 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
39183 as for other drivers and lookups.
39184 .endlist
39185
39186 Then all you need to do is write the code! A good way to start is to make a
39187 proforma by copying an existing module of the same type, globally changing all
39188 occurrences of the name, and cutting out most of the code. Note that any
39189 options you create must be listed in alphabetical order, because the tables are
39190 searched using a binary chop procedure.
39191
39192 There is a &_README_& file in each of the sub-directories of &_src_& describing
39193 the interface that is expected.
39194
39195
39196
39197
39198 . ////////////////////////////////////////////////////////////////////////////
39199 . ////////////////////////////////////////////////////////////////////////////
39200
39201 . /////////////////////////////////////////////////////////////////////////////
39202 . These lines are processing instructions for the Simple DocBook Processor that
39203 . Philip Hazel has developed as a less cumbersome way of making PostScript and
39204 . PDFs than using xmlto and fop. They will be ignored by all other XML
39205 . processors.
39206 . /////////////////////////////////////////////////////////////////////////////
39207
39208 .literal xml
39209 <?sdop
39210   format="newpage"
39211   foot_right_recto="&chaptertitle;"
39212   foot_right_verso="&chaptertitle;"
39213 ?>
39214 .literal off
39215
39216 .makeindex "Options index"   "option"
39217 .makeindex "Variables index" "variable"
39218 .makeindex "Concept index"   "concept"
39219
39220
39221 . /////////////////////////////////////////////////////////////////////////////
39222 . /////////////////////////////////////////////////////////////////////////////